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