include/validations.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 define('SIZE_MAX', 32768);
  23
  24 global $globals;
  25 require_once $globals->spoolroot . '/core/classes/xdb.php';
  26
  27 /**
  28  * Iterator class, that lists objects through the database
  29  */
  30 class ValidateIterator extends XOrgDBIterator
  31 {
  32     // {{{ constuctor
  33
  34     public function __construct ()
  35     {
  36         parent::__construct('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests ORDER BY stamp', MYSQL_NUM);
  37     }
  38
  39     // }}}
  40     // {{{ function next()
  41
  42     public function next ()
  43     {
  44         if (list($result, $stamp) = parent::next()) {
  45             $result = Validate::unserialize($result);
  46             $result->stamp = $stamp;
  47             return($result);
  48         } else {
  49             return null;
  50         }
  51     }
  52
  53     // }}}
  54 }
  55
  56 /** classe "virtuelle" à dériver pour chaque nouvelle implémentation
  57  */
  58 abstract class Validate
  59 {
  60     // {{{ properties
  61
  62     public $user;
  63
  64     public $stamp;
  65     public $unique;
  66     // enable the refuse button
  67     public $refuse = true;
  68
  69     public $type;
  70     public $comments = Array();
  71     // the validations rules : comments for admins
  72     public $rules = "Mieux vaut laisser une demande de validation à un autre admin que de valider une requête illégale ou que de refuser une demande légitime";
  73
  74     // }}}
  75     // {{{ constructor
  76
  77     /** constructeur
  78      * @param       $_user      user object
  79      * @param       $_unique    requête pouvant être multiple ou non
  80      * @param       $_type      type de la donnée comme dans le champ type de x4dat.requests
  81      */
  82     public function __construct(User &$_user, $_unique, $_type)
  83     {
  84         $this->user   = &$_user;
  85         $this->stamp  = date('YmdHis');
  86         $this->unique = $_unique;
  87         $this->type   = $_type;
  88         $this->promo  = $this->user->promo();
  89     }
  90
  91     // }}}
  92     // {{{ function submit()
  93
  94     /** fonction à utiliser pour envoyer les données à la modération
  95      * cette fonction supprimme les doublons sur un couple ($user,$type) si $this->unique est vrai
  96      */
  97     public function submit()
  98     {
  99         if ($this->unique) {
 100             XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}', $this->user->id(), $this->type);
 101         }
 102
 103         $this->stamp = date('YmdHis');
 104         XDB::execute('INSERT INTO requests (user_id, type, data, stamp) VALUES ({?}, {?}, {?}, {?})',
 105                 $this->user->id(), $this->type, $this, $this->stamp);
 106
 107         global $globals;
 108         $globals->updateNbValid();
 109         return true;
 110     }
 111
 112     // }}}
 113     // {{{ function update()
 114
 115     protected function update()
 116     {
 117         XDB::execute('UPDATE requests SET data={?}, stamp=stamp
 118                        WHERE user_id={?} AND type={?} AND stamp={?}',
 119                      $this, $this->user->id(), $this->type, $this->stamp);
 120         return true;
 121     }
 122
 123     // }}}
 124     // {{{ function clean()
 125
 126     /** fonction à utiliser pour nettoyer l'entrée de la requête dans la table requests
 127      * attention, tout est supprimé si c'est un unique
 128      */
 129     public function clean()
 130     {
 131         global $globals;
 132
 133         if ($this->unique) {
 134             $success = XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}',
 135                                     $this->user->id(), $this->type);
 136         } else {
 137             $success =  XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?} AND stamp={?}',
 138                                       $this->user->id(), $this->type, $this->stamp);
 139         }
 140         $globals->updateNbValid();
 141         return $success;
 142     }
 143
 144     // }}}
 145     // {{{ function handle_formu()
 146
 147     /** fonction à réaliser en cas de validation du formulaire
 148      */
 149     public function handle_formu()
 150     {
 151         if (Env::has('delete')) {
 152             $this->clean();
 153             $this->trigSuccess('Requête supprimée');
 154             return true;
 155         }
 156
 157         // mise à jour des informations
 158         if (Env::has('edit')) {
 159             if ($this->handle_editor()) {
 160                 $this->update();
 161                 $this->trigSuccess('Requête mise à jour');
 162                 return true;
 163             }
 164             return false;
 165         }
 166
 167         // ajout d'un commentaire
 168         if (Env::has('hold') && Env::has('comm')) {
 169             $formid = Env::i('formid');
 170             foreach ($this->comments as $comment) {
 171                 if ($comment[2] === $formid) {
 172                     return true;
 173                 }
 174             }
 175             if (!strlen(trim(Env::v('comm')))) {
 176                 return true;
 177             }
 178             $this->comments[] = Array(S::user()->login(), Env::v('comm'), $formid);
 179
 180             // envoi d'un mail à hotliners
 181             global $globals;
 182             $mailer = new PlMailer();
 183             $mailer->setSubject("Commentaires de validation {$this->type}");
 184             $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 185             $mailer->addTo($globals->core->admin_email);
 186
 187             $body = "Validation {$this->type} pour {$this->user->login()}\n\n"
 188               . S::user()->login() . " a ajouté le commentaire :\n\n"
 189               . Env::v('comm') . "\n\n"
 190               . "cf la discussion sur : " . $globals->baseurl . "/admin/validate";
 191
 192             $mailer->setTxtBody(wordwrap($body));
 193             $mailer->send();
 194
 195             $this->update();
 196             $this->trigSuccess('Commentaire ajouté');
 197             return true;
 198         }
 199
 200         if (Env::has('accept')) {
 201             if ($this->commit()) {
 202                 $this->sendmail(true);
 203                 $this->clean();
 204                 $this->trigSuccess('Email de validation envoyé');
 205                 return true;
 206             } else {
 207                 $this->trigError('Erreur lors de la validation');
 208                 return false;
 209             }
 210         }
 211
 212         if (Env::has('refuse')) {
 213             if (Env::v('comm')) {
 214                 $this->sendmail(false);
 215                 $this->clean();
 216                 $this->trigSuccess('Email de refus envoyé');
 217                 return true;
 218             } else {
 219                 $this->trigError('Pas de motivation pour le refus&nbsp;!!!');
 220             }
 221         }
 222
 223         return false;
 224     }
 225
 226     // }}}
 227     // {{{ function sendmail
 228
 229     protected function sendmail($isok)
 230     {
 231         global $globals;
 232         $mailer = new PlMailer();
 233         $mailer->setSubject($this->_mail_subj());
 234         $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 235         $mailer->addTo("\"{$this->user->fullName()}\" <{$this->user->bestEmail()}>");
 236         $mailer->addCc("validation+{$this->type}@{$globals->mail->domain}");
 237
 238         $body = ($this->user->isFemale() ? "Chère camarade,\n\n" : "Cher camarade,\n\n")
 239               . $this->_mail_body($isok)
 240               . (Env::has('comm') ? "\n\n" . Env::v('comm') : '')
 241               . "\n\nCordialement,\n-- \nL'équipe de Polytechnique.org\n"
 242               . $this->_mail_ps($isok);
 243
 244         $mailer->setTxtBody(wordwrap($body));
 245         $mailer->send();
 246     }
 247
 248     // }}}
 249     // {{{ function trig()
 250
 251     protected function trigError($msg)
 252     {
 253         Platal::page()->trigError($msg);
 254     }
 255
 256     protected function trigWarning($msg)
 257     {
 258         Platal::page()->trigWarning($msg);
 259     }
 260
 261     protected function trigSuccess($msg)
 262     {
 263         Platal::page()->trigSuccess($msg);
 264     }
 265
 266     // }}}
 267     // {{{ function get_typed_request()
 268
 269     /** fonction statique qui renvoie la requête de l'utilisateur d'id $uidau timestamp $t
 270      * @param   $uid    l'id de l'utilisateur concerné
 271      * @param   $type   le type de la requête
 272      * @param   $stamp  le timestamp de la requête
 273      *
 274      * XXX fonction "statique" XXX
 275      * à utiliser uniquement pour récupérer un objet dans la BD avec Validate::get_typed_request(...)
 276      */
 277     static public function get_typed_request($uid, $type, $stamp = -1)
 278     {
 279         if ($stamp == -1) {
 280             $res = XDB::query('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 281         } else {
 282             $res = XDB::query('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests WHERE user_id={?} AND type={?} and stamp={?}', $uid, $type, $stamp);
 283         }
 284         if ($result = $res->fetchOneCell()) {
 285             $result = Validate::unserialize($result);
 286         } else {
 287             $result = false;
 288         }
 289         return($result);
 290     }
 291
 292     // }}}
 293     // {{{ function get_request_by_id()
 294
 295     static public function get_request_by_id($id)
 296     {
 297         list($uid, $type, $stamp) = explode('_', $id, 3);
 298         return Validate::get_typed_request($uid, $type, $stamp);
 299     }
 300
 301     // }}}
 302     // {{{ function get_typed_requests()
 303
 304     /** same as get_typed_request() but return an array of objects
 305      */
 306     static public function get_typed_requests($uid, $type)
 307     {
 308         $res = XDB::iterRow('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 309         $array = array();
 310         while (list($data) = $res->next()) {
 311             $array[] = Validate::unserialize($data);
 312         }
 313         return $array;
 314     }
 315
 316     // }}}
 317     // {{{ function get_typed_requests_count()
 318
 319     /** same as get_typed_requests() but return the count of available requests.
 320      */
 321     static public function get_typed_requests_count($uid, $type)
 322     {
 323         $res = XDB::query('SELECT COUNT(data) FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 324         return $res->fetchOneCell();
 325     }
 326
 327     // }}}
 328     // {{{ function _mail_body
 329
 330     abstract protected function _mail_body($isok);
 331
 332     // }}}
 333     // {{{ function _mail_subj
 334
 335     abstract protected function _mail_subj();
 336
 337     // }}}
 338     // {{{ function _mail_ps
 339
 340     protected function _mail_ps($isok)
 341     {
 342         return '';
 343     }
 344
 345     // }}}
 346     // {{{ function commit()
 347
 348     /** fonction à utiliser pour insérer les données dans x4dat
 349      */
 350     abstract public function commit();
 351
 352     // }}}
 353     // {{{ function formu()
 354
 355     /** nom du template qui contient le formulaire */
 356     abstract public function formu();
 357
 358     // }}}
 359     // {{{ function editor()
 360
 361     /** nom du formulaire d'édition */
 362     public function editor()
 363     {
 364         return null;
 365     }
 366
 367     // }}}
 368     // {{{ function answers()
 369
 370     /** automatic answers table for this type of validation */
 371     public function answers()
 372     {
 373         static $answers_table;
 374         if (!isset($answers_table[$this->type])) {
 375             $r = XDB::query("SELECT id, title, answer FROM requests_answers WHERE category = {?}", $this->type);
 376             $answers_table[$this->type] = $r->fetchAllAssoc();
 377         }
 378         return $answers_table[$this->type];
 379     }
 380
 381     // }}}
 382     // {{{ function id()
 383
 384     public function id()
 385     {
 386         return $this->user->id() . '_' . $this->type . '_' . $this->stamp;
 387     }
 388
 389     // }}}
 390     // {{{ function ruleText()
 391
 392     public function ruleText()
 393     {
 394         return str_replace('\'', '\\\'', $this->rules);
 395     }
 396
 397     // }}}
 398     // {{{ function unserialize()
 399     public static function unserialize($data)
 400     {
 401         $obj = unserialize($data);
 402         /* XXX: Temporary for hruid migration */
 403         if (!isset($obj->user) || !is_object($obj)) {
 404             $obj->user =& User::get($obj->forlife);
 405         }
 406         /* XXX: End temporary block */
 407         return $obj;
 408     }
 409 }
 410
 411 foreach (glob(dirname(__FILE__).'/validations/*.inc.php') as $file) {
 412     require_once($file);
 413 }
 414
 415 /* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 foldmethod=marker enc=utf-8: */
 416 ?>