2 /***************************************************************************
3 * Copyright (C) 2003-2009 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 define('SIZE_MAX', 32768);
25 require_once $globals->spoolroot
. '/core/classes/xdb.php';
28 * Iterator class, that lists objects through the database
30 class ValidateIterator
extends XOrgDBIterator
34 public function __construct ()
36 parent
::__construct('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests ORDER BY stamp', MYSQL_NUM
);
40 // {{{ function next()
42 public function next ()
44 if (list($result, $stamp) = parent
::next()) {
45 $result = Validate
::unserialize($result);
46 $result->stamp
= $stamp;
56 /** classe "virtuelle" à dériver pour chaque nouvelle implémentation
58 abstract class Validate
66 // enable the refuse button
67 public $refuse = true
;
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";
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
82 public function __construct(User
&$_user, $_unique, $_type)
84 $this->user
= &$_user;
85 $this->stamp
= date('YmdHis');
86 $this->unique
= $_unique;
91 // {{{ function submit()
93 /** fonction à utiliser pour envoyer les données à la modération
94 * cette fonction supprimme les doublons sur un couple ($user,$type) si $this->unique est vrai
96 public function submit()
99 XDB
::execute('DELETE FROM requests WHERE user_id={?} AND type={?}', $this->user
->id(), $this->type
);
102 $this->stamp
= date('YmdHis');
103 XDB
::execute('INSERT INTO requests (user_id, type, data, stamp) VALUES ({?}, {?}, {?}, {?})',
104 $this->user
->id(), $this->type
, $this, $this->stamp
);
107 $globals->updateNbValid();
112 // {{{ function update()
114 protected function update()
116 XDB
::execute('UPDATE requests SET data={?}, stamp=stamp
117 WHERE user_id={?} AND type={?} AND stamp={?}',
118 $this, $this->user
->id(), $this->type
, $this->stamp
);
123 // {{{ function clean()
125 /** fonction à utiliser pour nettoyer l'entrée de la requête dans la table requests
126 * attention, tout est supprimé si c'est un unique
128 public function clean()
133 $success = XDB
::execute('DELETE FROM requests WHERE user_id={?} AND type={?}',
134 $this->user
->id(), $this->type
);
136 $success = XDB
::execute('DELETE FROM requests WHERE user_id={?} AND type={?} AND stamp={?}',
137 $this->user
->id(), $this->type
, $this->stamp
);
139 $globals->updateNbValid();
144 // {{{ function handle_formu()
146 /** fonction à réaliser en cas de validation du formulaire
148 public function handle_formu()
150 if (Env
::has('delete')) {
152 $this->trigSuccess('Requête supprimée');
156 // mise à jour des informations
157 if (Env
::has('edit')) {
158 if ($this->handle_editor()) {
160 $this->trigSuccess('Requête mise à jour');
166 // ajout d'un commentaire
167 if (Env
::has('hold') && Env
::has('comm')) {
168 $formid = Env
::i('formid');
169 foreach ($this->comments
as $comment) {
170 if ($comment[2] === $formid) {
174 if (!strlen(trim(Env
::v('comm')))) {
177 $this->comments
[] = Array(S
::user()->login(), Env
::v('comm'), $formid);
179 // envoi d'un mail à hotliners
181 $mailer = new PlMailer();
182 $mailer->setSubject("Commentaires de validation {$this->type}");
183 $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
184 $mailer->addTo($globals->core
->admin_email
);
186 $body = "Validation {$this->type} pour {$this->user->login()}\n\n"
187 . S
::user()->login() . " a ajouté le commentaire :\n\n"
188 . Env
::v('comm') . "\n\n"
189 . "cf la discussion sur : " . $globals->baseurl
. "/admin/validate";
191 $mailer->setTxtBody(wordwrap($body));
195 $this->trigSuccess('Commentaire ajouté');
199 if (Env
::has('accept')) {
200 if ($this->commit()) {
201 $this->sendmail(true
);
203 $this->trigSuccess('Email de validation envoyé');
206 $this->trigError('Erreur lors de la validation');
211 if (Env
::has('refuse')) {
212 if (Env
::v('comm')) {
213 $this->sendmail(false
);
215 $this->trigSuccess('Email de refus envoyé');
218 $this->trigError('Pas de motivation pour le refus !!!');
226 // {{{ function sendmail
228 protected function sendmail($isok)
231 $mailer = new PlMailer();
232 $mailer->setSubject($this->_mail_subj());
233 $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
234 $mailer->addTo("\"{$this->user->fullName()}\" <{$this->user->bestEmail()}>");
235 $mailer->addCc("validation+{$this->type}@{$globals->mail->domain}");
237 $body = ($this->user
->isFemale() ?
"Chère camarade,\n\n" : "Cher camarade,\n\n")
238 . $this->_mail_body($isok)
239 . (Env
::has('comm') ?
"\n\n" . Env
::v('comm') : '')
240 . "\n\nCordialement,\n-- \nL'équipe de Polytechnique.org\n"
241 . $this->_mail_ps($isok);
243 $mailer->setTxtBody(wordwrap($body));
248 // {{{ function trig()
250 protected function trigError($msg)
252 Platal
::page()->trigError($msg);
255 protected function trigWarning($msg)
257 Platal
::page()->trigWarning($msg);
260 protected function trigSuccess($msg)
262 Platal
::page()->trigSuccess($msg);
266 // {{{ function get_typed_request()
268 /** fonction statique qui renvoie la requête de l'utilisateur d'id $uidau timestamp $t
269 * @param $uid l'id de l'utilisateur concerné
270 * @param $type le type de la requête
271 * @param $stamp le timestamp de la requête
273 * XXX fonction "statique" XXX
274 * à utiliser uniquement pour récupérer un objet dans la BD avec Validate::get_typed_request(...)
276 static public function get_typed_request($uid, $type, $stamp = -1)
279 $res = XDB
::query('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
281 $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 if ($result = $res->fetchOneCell()) {
284 $result = Validate
::unserialize($result);
292 // {{{ function get_request_by_id()
294 static public function get_request_by_id($id)
296 list($uid, $type, $stamp) = explode('_', $id, 3);
297 return Validate
::get_typed_request($uid, $type, $stamp);
301 // {{{ function get_typed_requests()
303 /** same as get_typed_request() but return an array of objects
305 static public function get_typed_requests($uid, $type)
307 $res = XDB
::iterRow('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
309 while (list($data) = $res->next()) {
310 $array[] = Validate
::unserialize($data);
316 // {{{ function get_typed_requests_count()
318 /** same as get_typed_requests() but return the count of available requests.
320 static public function get_typed_requests_count($uid, $type)
322 $res = XDB
::query('SELECT COUNT(data) FROM requests WHERE user_id={?} and type={?}', $uid, $type);
323 return $res->fetchOneCell();
327 // {{{ function _mail_body
329 abstract protected function _mail_body($isok);
332 // {{{ function _mail_subj
334 abstract protected function _mail_subj();
337 // {{{ function _mail_ps
339 protected function _mail_ps($isok)
345 // {{{ function commit()
347 /** fonction à utiliser pour insérer les données dans x4dat
349 abstract public function commit();
352 // {{{ function formu()
354 /** nom du template qui contient le formulaire */
355 abstract public function formu();
358 // {{{ function editor()
360 /** nom du formulaire d'édition */
361 public function editor()
367 // {{{ function answers()
369 /** automatic answers table for this type of validation */
370 public function answers()
372 static $answers_table;
373 if (!isset($answers_table[$this->type
])) {
374 $r = XDB
::query("SELECT id, title, answer FROM requests_answers WHERE category = {?}", $this->type
);
375 $answers_table[$this->type
] = $r->fetchAllAssoc();
377 return $answers_table[$this->type
];
385 return $this->user
->id() . '_' . $this->type
. '_' . $this->stamp
;
389 // {{{ function ruleText()
391 public function ruleText()
393 return str_replace('\'', '\\\'', $this->rules
);
397 // {{{ function unserialize()
398 public static function unserialize($data)
400 $obj = unserialize($data);
401 /* XXX: Temporary for hruid migration */
402 if (!isset($obj->user
) ||
!is_object($obj)) {
403 $obj->user
=& User
::get($obj->forlife
);
405 /* XXX: End temporary block */
410 foreach (glob(dirname(__FILE__
).'/validations/*.inc.php') as $file) {
414 /* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 foldmethod=marker enc=utf-8: */