include/validations.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2009 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         $res = XDB::query("SELECT  promo
  89                              FROM  profile_display
  90                             WHERE  pid={?}", $this->user->id());
  91         $this->promo = $res->fetchOneCell();
  92     }
  93
  94     // }}}
  95     // {{{ function submit()
  96
  97     /** fonction à utiliser pour envoyer les données à la modération
  98      * cette fonction supprimme les doublons sur un couple ($user,$type) si $this->unique est vrai
  99      */
 100     public function submit()
 101     {
 102         if ($this->unique) {
 103             XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}', $this->user->id(), $this->type);
 104         }
 105
 106         $this->stamp = date('YmdHis');
 107         XDB::execute('INSERT INTO requests (user_id, type, data, stamp) VALUES ({?}, {?}, {?}, {?})',
 108                 $this->user->id(), $this->type, $this, $this->stamp);
 109
 110         global $globals;
 111         $globals->updateNbValid();
 112         return true;
 113     }
 114
 115     // }}}
 116     // {{{ function update()
 117
 118     protected function update()
 119     {
 120         XDB::execute('UPDATE requests SET data={?}, stamp=stamp
 121                        WHERE user_id={?} AND type={?} AND stamp={?}',
 122                      $this, $this->user->id(), $this->type, $this->stamp);
 123         return true;
 124     }
 125
 126     // }}}
 127     // {{{ function clean()
 128
 129     /** fonction à utiliser pour nettoyer l'entrée de la requête dans la table requests
 130      * attention, tout est supprimé si c'est un unique
 131      */
 132     public function clean()
 133     {
 134         global $globals;
 135
 136         if ($this->unique) {
 137             $success = XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}',
 138                                     $this->user->id(), $this->type);
 139         } else {
 140             $success =  XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?} AND stamp={?}',
 141                                       $this->user->id(), $this->type, $this->stamp);
 142         }
 143         $globals->updateNbValid();
 144         return $success;
 145     }
 146
 147     // }}}
 148     // {{{ function handle_formu()
 149
 150     /** fonction à réaliser en cas de validation du formulaire
 151      */
 152     public function handle_formu()
 153     {
 154         if (Env::has('delete')) {
 155             $this->clean();
 156             $this->trigSuccess('Requête supprimée');
 157             return true;
 158         }
 159
 160         // mise à jour des informations
 161         if (Env::has('edit')) {
 162             if ($this->handle_editor()) {
 163                 $this->update();
 164                 $this->trigSuccess('Requête mise à jour');
 165                 return true;
 166             }
 167             return false;
 168         }
 169
 170         // ajout d'un commentaire
 171         if (Env::has('hold') && Env::has('comm')) {
 172             $formid = Env::i('formid');
 173             foreach ($this->comments as $comment) {
 174                 if ($comment[2] === $formid) {
 175                     return true;
 176                 }
 177             }
 178             if (!strlen(trim(Env::v('comm')))) {
 179                 return true;
 180             }
 181             $this->comments[] = Array(S::user()->login(), Env::v('comm'), $formid);
 182
 183             // envoi d'un mail à hotliners
 184             global $globals;
 185             $mailer = new PlMailer();
 186             $mailer->setSubject("Commentaires de validation {$this->type}");
 187             $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 188             $mailer->addTo($globals->core->admin_email);
 189
 190             $body = "Validation {$this->type} pour {$this->user->login()}\n\n"
 191               . S::user()->login() . " a ajouté le commentaire :\n\n"
 192               . Env::v('comm') . "\n\n"
 193               . "cf la discussion sur : " . $globals->baseurl . "/admin/validate";
 194
 195             $mailer->setTxtBody(wordwrap($body));
 196             $mailer->send();
 197
 198             $this->update();
 199             $this->trigSuccess('Commentaire ajouté');
 200             return true;
 201         }
 202
 203         if (Env::has('accept')) {
 204             if ($this->commit()) {
 205                 $this->sendmail(true);
 206                 $this->clean();
 207                 $this->trigSuccess('Email de validation envoyé');
 208                 return true;
 209             } else {
 210                 $this->trigError('Erreur lors de la validation');
 211                 return false;
 212             }
 213         }
 214
 215         if (Env::has('refuse')) {
 216             if (Env::v('comm')) {
 217                 $this->sendmail(false);
 218                 $this->clean();
 219                 $this->trigSuccess('Email de refus envoyé');
 220                 return true;
 221             } else {
 222                 $this->trigError('Pas de motivation pour le refus&nbsp;!!!');
 223             }
 224         }
 225
 226         return false;
 227     }
 228
 229     // }}}
 230     // {{{ function sendmail
 231
 232     protected function sendmail($isok)
 233     {
 234         global $globals;
 235         $mailer = new PlMailer();
 236         $mailer->setSubject($this->_mail_subj());
 237         $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 238         $mailer->addTo("\"{$this->user->fullName()}\" <{$this->user->bestEmail()}>");
 239         $mailer->addCc("validation+{$this->type}@{$globals->mail->domain}");
 240
 241         $body = ($this->user->isFemale() ? "Chère camarade,\n\n" : "Cher camarade,\n\n")
 242               . $this->_mail_body($isok)
 243               . (Env::has('comm') ? "\n\n" . Env::v('comm') : '')
 244               . "\n\nCordialement,\n-- \nL'équipe de Polytechnique.org\n"
 245               . $this->_mail_ps($isok);
 246
 247         $mailer->setTxtBody(wordwrap($body));
 248         $mailer->send();
 249     }
 250
 251     // }}}
 252     // {{{ function trig()
 253
 254     protected function trigError($msg)
 255     {
 256         Platal::page()->trigError($msg);
 257     }
 258
 259     protected function trigWarning($msg)
 260     {
 261         Platal::page()->trigWarning($msg);
 262     }
 263
 264     protected function trigSuccess($msg)
 265     {
 266         Platal::page()->trigSuccess($msg);
 267     }
 268
 269     // }}}
 270     // {{{ function get_typed_request()
 271
 272     /** fonction statique qui renvoie la requête de l'utilisateur d'id $uidau timestamp $t
 273      * @param   $uid    l'id de l'utilisateur concerné
 274      * @param   $type   le type de la requête
 275      * @param   $stamp  le timestamp de la requête
 276      *
 277      * XXX fonction "statique" XXX
 278      * à utiliser uniquement pour récupérer un objet dans la BD avec Validate::get_typed_request(...)
 279      */
 280     static public function get_typed_request($uid, $type, $stamp = -1)
 281     {
 282         if ($stamp == -1) {
 283             $res = XDB::query('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 284         } else {
 285             $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);
 286         }
 287         if ($result = $res->fetchOneCell()) {
 288             $result = Validate::unserialize($result);
 289         } else {
 290             $result = false;
 291         }
 292         return($result);
 293     }
 294
 295     // }}}
 296     // {{{ function get_request_by_id()
 297
 298     static public function get_request_by_id($id)
 299     {
 300         list($uid, $type, $stamp) = explode('_', $id, 3);
 301         return Validate::get_typed_request($uid, $type, $stamp);
 302     }
 303
 304     // }}}
 305     // {{{ function get_typed_requests()
 306
 307     /** same as get_typed_request() but return an array of objects
 308      */
 309     static public function get_typed_requests($uid, $type)
 310     {
 311         $res = XDB::iterRow('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 312         $array = array();
 313         while (list($data) = $res->next()) {
 314             $array[] = Validate::unserialize($data);
 315         }
 316         return $array;
 317     }
 318
 319     // }}}
 320     // {{{ function get_typed_requests_count()
 321
 322     /** same as get_typed_requests() but return the count of available requests.
 323      */
 324     static public function get_typed_requests_count($uid, $type)
 325     {
 326         $res = XDB::query('SELECT COUNT(data) FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 327         return $res->fetchOneCell();
 328     }
 329
 330     // }}}
 331     // {{{ function _mail_body
 332
 333     abstract protected function _mail_body($isok);
 334
 335     // }}}
 336     // {{{ function _mail_subj
 337
 338     abstract protected function _mail_subj();
 339
 340     // }}}
 341     // {{{ function _mail_ps
 342
 343     protected function _mail_ps($isok)
 344     {
 345         return '';
 346     }
 347
 348     // }}}
 349     // {{{ function commit()
 350
 351     /** fonction à utiliser pour insérer les données dans x4dat
 352      */
 353     abstract public function commit();
 354
 355     // }}}
 356     // {{{ function formu()
 357
 358     /** nom du template qui contient le formulaire */
 359     abstract public function formu();
 360
 361     // }}}
 362     // {{{ function editor()
 363
 364     /** nom du formulaire d'édition */
 365     public function editor()
 366     {
 367         return null;
 368     }
 369
 370     // }}}
 371     // {{{ function answers()
 372
 373     /** automatic answers table for this type of validation */
 374     public function answers()
 375     {
 376         static $answers_table;
 377         if (!isset($answers_table[$this->type])) {
 378             $r = XDB::query("SELECT id, title, answer FROM requests_answers WHERE category = {?}", $this->type);
 379             $answers_table[$this->type] = $r->fetchAllAssoc();
 380         }
 381         return $answers_table[$this->type];
 382     }
 383
 384     // }}}
 385     // {{{ function id()
 386
 387     public function id()
 388     {
 389         return $this->user->id() . '_' . $this->type . '_' . $this->stamp;
 390     }
 391
 392     // }}}
 393     // {{{ function ruleText()
 394
 395     public function ruleText()
 396     {
 397         return str_replace('\'', '\\\'', $this->rules);
 398     }
 399
 400     // }}}
 401     // {{{ function unserialize()
 402     public static function unserialize($data)
 403     {
 404         $obj = unserialize($data);
 405         /* XXX: Temporary for hruid migration */
 406         if (!isset($obj->user) || !is_object($obj)) {
 407             $obj->user =& User::get($obj->forlife);
 408         }
 409         /* XXX: End temporary block */
 410         return $obj;
 411     }
 412 }
 413
 414 foreach (glob(dirname(__FILE__).'/validations/*.inc.php') as $file) {
 415     require_once($file);
 416 }
 417
 418 /* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 foldmethod=marker enc=utf-8: */
 419 ?>