include/validations.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2008 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 require_once dirname(__FILE__) . '/../classes/xdb.php';
  25
  26 /**
  27  * Iterator class, that lists objects through the database
  28  */
  29 class ValidateIterator extends XOrgDBIterator
  30 {
  31     // {{{ constuctor
  32
  33     public function __construct ()
  34     {
  35         parent::__construct('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests ORDER BY stamp', MYSQL_NUM);
  36     }
  37
  38     // }}}
  39     // {{{ function next()
  40
  41     public function next ()
  42     {
  43         if (list($result, $stamp) = parent::next()) {
  44             $result = unserialize($result);
  45             $result->stamp = $stamp;
  46             return($result);
  47         } else {
  48             return null;
  49         }
  50     }
  51
  52     // }}}
  53 }
  54
  55 /** classe "virtuelle" à dériver pour chaque nouvelle implémentation
  56  */
  57 abstract class Validate
  58 {
  59     // {{{ properties
  60
  61     public $uid;
  62     public $prenom;
  63     public $nom;
  64     public $promo;
  65     public $sexe;
  66     public $bestalias;
  67     public $forlife;
  68
  69     public $stamp;
  70     public $unique;
  71     // enable the refuse button
  72     public $refuse = true;
  73
  74     public $type;
  75     public $comments = Array();
  76     // the validations rules : comments for admins
  77     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";
  78
  79     // }}}
  80     // {{{ constructor
  81
  82     /** constructeur
  83      * @param       $_uid       user id
  84      * @param       $_unique    requête pouvant être multiple ou non
  85      * @param       $_type      type de la donnée comme dans le champ type de x4dat.requests
  86      */
  87     public function __construct($_uid, $_unique, $_type)
  88     {
  89         $this->uid    = $_uid;
  90         $this->stamp  = date('YmdHis');
  91         $this->unique = $_unique;
  92         $this->type   = $_type;
  93         $res = XDB::query(
  94                 "SELECT  u.prenom, u.nom, u.promo, FIND_IN_SET('femme', u.flags) AS sexe, a.alias, b.alias
  95                    FROM  auth_user_md5 AS u
  96              INNER JOIN  aliases       AS a ON ( u.user_id=a.id AND a.type='a_vie' )
  97              INNER JOIN  aliases       AS b ON ( u.user_id=b.id AND b.type!='homonyme' AND FIND_IN_SET('bestalias', b.flags) )
  98                   WHERE  u.user_id={?}", $_uid);
  99         list($this->prenom, $this->nom, $this->promo, $this->sexe, $this->forlife, $this->bestalias) = $res->fetchOneRow();
 100     }
 101
 102     // }}}
 103     // {{{ function submit()
 104
 105     /** fonction à utiliser pour envoyer les données à la modération
 106      * cette fonction supprimme les doublons sur un couple ($user,$type) si $this->unique est vrai
 107      */
 108     public function submit()
 109     {
 110         if ($this->unique) {
 111             XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}', $this->uid, $this->type);
 112         }
 113
 114         $this->stamp = date('YmdHis');
 115         XDB::execute('INSERT INTO requests (user_id, type, data, stamp) VALUES ({?}, {?}, {?}, {?})',
 116                 $this->uid, $this->type, $this, $this->stamp);
 117
 118         global $globals;
 119         update_NbValid();
 120         return true;
 121     }
 122
 123     // }}}
 124     // {{{ function update()
 125
 126     protected function update()
 127     {
 128         XDB::execute('UPDATE requests SET data={?}, stamp=stamp
 129                        WHERE user_id={?} AND type={?} AND stamp={?}',
 130                      $this, $this->uid, $this->type, $this->stamp);
 131         return true;
 132     }
 133
 134     // }}}
 135     // {{{ function clean()
 136
 137     /** fonction à utiliser pour nettoyer l'entrée de la requête dans la table requests
 138      * attention, tout est supprimé si c'est un unique
 139      */
 140     public function clean()
 141     {
 142         if ($this->unique) {
 143             $success = XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}',
 144                                     $this->uid, $this->type);
 145         } else {
 146             $success =  XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?} AND stamp={?}',
 147                                       $this->uid, $this->type, $this->stamp);
 148         }
 149         update_NbValid();
 150         return $success;
 151     }
 152
 153     // }}}
 154     // {{{ function handle_formu()
 155
 156     /** fonction à réaliser en cas de validation du formulaire
 157      */
 158     public function handle_formu()
 159     {
 160         if (Env::has('delete')) {
 161             $this->clean();
 162             $this->trigSuccess('Requête supprimée');
 163             return true;
 164         }
 165
 166         // mise à jour des informations
 167         if (Env::has('edit')) {
 168             if ($this->handle_editor()) {
 169                 $this->update();
 170                 $this->trigSuccess('Requête mise à jour');
 171                 return true;
 172             }
 173             return false;
 174         }
 175
 176         // ajout d'un commentaire
 177         if (Env::has('hold') && Env::has('comm')) {
 178             $formid = Env::i('formid');
 179             foreach ($this->comments as $comment) {
 180                 if ($comment[2] === $formid) {
 181                     return true;
 182                 }
 183             }
 184             if (!strlen(trim(Env::v('comm')))) {
 185                 return true;
 186             }
 187             $this->comments[] = Array(S::v('bestalias'), Env::v('comm'), $formid);
 188
 189             // envoi d'un mail à hotliners
 190             global $globals;
 191             $mailer = new PlMailer();
 192             $mailer->setSubject("Commentaires de validation {$this->type}");
 193             $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 194             $mailer->addTo($globals->core->admin_email);
 195
 196             $body = "Validation {$this->type} pour {$this->prenom} {$this->nom}\n\n"
 197               . S::v('bestalias')." a ajouté le commentaire :\n\n"
 198               . Env::v('comm')."\n\n"
 199               . "cf la discussion sur : ".$globals->baseurl."/admin/validate";
 200
 201             $mailer->setTxtBody(wordwrap($body));
 202             $mailer->send();
 203
 204             $this->update();
 205             $this->trigSuccess('Commentaire ajouté');
 206             return true;
 207         }
 208
 209         if (Env::has('accept')) {
 210             if ($this->commit()) {
 211                 $this->sendmail(true);
 212                 $this->clean();
 213                 $this->trigSuccess('Mail de validation envoyé');
 214                 return true;
 215             } else {
 216                 $this->trigError('Erreur lors de la validation');
 217                 return false;
 218             }
 219         }
 220
 221         if (Env::has('refuse')) {
 222             if (Env::v('comm')) {
 223                 $this->sendmail(false);
 224                 $this->clean();
 225                 $this->trigSuccess('Mail de refus envoyé');
 226                 return true;
 227             } else {
 228                 $this->trigError('pas de motivation pour le refus !!!');
 229             }
 230         }
 231
 232         return false;
 233     }
 234
 235     // }}}
 236     // {{{ function sendmail
 237
 238     protected function sendmail($isok)
 239     {
 240         global $globals;
 241         $mailer = new PlMailer();
 242         $mailer->setSubject($this->_mail_subj());
 243         $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
 244         $mailer->addTo("\"{$this->prenom} {$this->nom}\" <{$this->bestalias}@{$globals->mail->domain}>");
 245         $mailer->addCc("validation+{$this->type}@{$globals->mail->domain}");
 246
 247         $body = ($this->sexe ? "Chère camarade,\n\n" : "Cher camarade,\n\n")
 248               . $this->_mail_body($isok)
 249               . (Env::has('comm') ? "\n\n".Env::v('comm') : '')
 250               . "\n\nCordialement,\n\n-- \nL'équipe de Polytechnique.org\n";
 251
 252         $mailer->setTxtBody(wordwrap($body));
 253         $mailer->send();
 254     }
 255
 256     // }}}
 257     // {{{ function trig()
 258
 259     protected function trigError($msg)
 260     {
 261         Platal::page()->trigError($msg);
 262     }
 263
 264     protected function trigWarning($msg)
 265     {
 266         Platal::page()->trigWarning($msg);
 267     }
 268
 269     protected function trigSuccess($msg)
 270     {
 271         Platal::page()->trigSuccess($msg);
 272     }
 273
 274     // }}}
 275     // {{{ function get_typed_request()
 276
 277     /** fonction statique qui renvoie la requête de l'utilisateur d'id $uidau timestamp $t
 278      * @param   $uid    l'id de l'utilisateur concerné
 279      * @param   $type   le type de la requête
 280      * @param   $stamp  le timestamp de la requête
 281      *
 282      * XXX fonction "statique" XXX
 283      * à utiliser uniquement pour récupérer un objet dans la BD avec Validate::get_typed_request(...)
 284      */
 285     static public function get_typed_request($uid, $type, $stamp = -1)
 286     {
 287         if ($stamp == -1) {
 288             $res = XDB::query('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 289         } else {
 290             $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);
 291         }
 292         if ($result = $res->fetchOneCell()) {
 293             $result = unserialize($result);
 294         } else {
 295             $result = false;
 296         }
 297         return($result);
 298     }
 299
 300     // }}}
 301     // {{{ function get_request_by_id()
 302
 303     static public function get_request_by_id($id)
 304     {
 305         list($uid, $type, $stamp) = explode('_', $id, 3);
 306         return Validate::get_typed_request($uid, $type, $stamp);
 307     }
 308
 309     // }}}
 310     // {{{ function get_typed_requests()
 311
 312     /** same as get_typed_request() but return an array of objects
 313      */
 314     static public function get_typed_requests($uid, $type)
 315     {
 316         $res = XDB::iterRow('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 317         $array = array();
 318         while (list($data) = $res->next()) {
 319             $array[] = unserialize($data);
 320         }
 321         return $array;
 322     }
 323
 324     // }}}
 325     // {{{ function get_typed_requests_count()
 326
 327     /** same as get_typed_requests() but return the count of available requests.
 328      */
 329     static public function get_typed_requests_count($uid, $type)
 330     {
 331         $res = XDB::query('SELECT COUNT(data) FROM requests WHERE user_id={?} and type={?}', $uid, $type);
 332         return $res->fetchOneCell();
 333     }
 334
 335     // }}}
 336     // {{{ function _mail_body
 337
 338     abstract protected function _mail_body($isok);
 339
 340     // }}}
 341     // {{{ function _mail_subj
 342
 343     abstract protected function _mail_subj();
 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($r);
 377         }
 378         return $answers_table[$this->type];
 379     }
 380
 381     // }}}
 382     // {{{ function id()
 383
 384     public function id()
 385     {
 386         return $this->uid . '_' . $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 }
 399
 400 foreach (glob(dirname(__FILE__).'/validations/*.inc.php') as $file) {
 401     require_once($file);
 402 }
 403
 404 /* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 foldmethod=marker enc=utf-8: */
 405 ?>