2 /***************************************************************************
3 * Copyright (C) 2003-2007 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 // {{{ class Survey : root of any survey, contains all questions
25 // {{{ static properties and functions, regarding survey modes and question types
28 const MODE_XIDENT
= 2;
29 private static $longModes = array(self
::MODE_ALL
=> "sondage ouvert à tout le monde, anonyme",
30 self
::MODE_XANON
=> "sondage restreint aux polytechniciens, anonyme",
31 self
::MODE_XIDENT
=> "sondage restreint aux polytechniciens, non anonyme");
32 private static $shortModes = array(self
::MODE_ALL
=> "tout le monde, anonyme",
33 self
::MODE_XANON
=> "polytechniciens, anonyme",
34 self
::MODE_XIDENT
=> "polytechniciens, non anonyme");
36 public static function getModes($long = true
) {
37 return ($long)? self
::$longModes : self
::$shortModes;
40 private static $types = array('text' => 'texte court',
41 'textarea' => 'texte long',
42 'num' => 'numérique',
44 'checkbox' => 'checkbox');
46 public static function getTypes()
51 public static function isType($t)
53 return array_key_exists($t, self
::$types);
57 // {{{ properties, constructor and basic methods
67 public function __construct($args, $id = -1, $valid = false
, $questions = null
)
71 $this->valid
= $valid;
72 $this->questions
= ($questions == null
)?
array() : $questions;
75 public function update($args)
77 $this->title
= $args['title'];
78 $this->description
= $args['description'];
79 if (preg_match('#^\d{2}/\d{2}/\d{4}$#', $args['end'])) {
80 $this->end
= preg_replace('#^(\d{2})/(\d{2})/(\d{4})$#', '\3-\2-\1', $args['end']);
82 $this->end
= (preg_match('#^\d{4}-\d{2}-\d{2}$#', $args['end']))?
$args['end'] : '#';
84 $this->mode
= (isset($args['mode']))?
$args['mode'] : self
::MODE_ALL
;
85 if ($this->mode
== self
::MODE_ALL
) {
88 $this->promos
= ($args['promos'] == '' ||
preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))?
$args['promos'] : '#';
92 // {{{ functions to access general information
93 public function isMode($mode)
95 return ($this->mode
== $mode);
98 public function checkPromo($promo)
100 if ($this->promos
== '') {
103 $promos = explode('|', $this->promos
);
104 foreach ($promos as $p) {
105 if ((preg_match('#^\d{4}$#', $p) && $p == $promo) ||
106 (preg_match('#^\d{4}-$#', $p) && intval(substr($p, 0, 4)) <= $promo) ||
107 (preg_match('#^-\d{4}$#', $p) && intval(substr($p, 1)) >= $promo) ||
108 (preg_match('#^\d{4}-\d{4}$#', $p) && intval(substr($p, 0, 4)) <= $promo && intval(substr($p, 5)) >= $promo)) {
115 public function isValid()
120 public function isEnded()
122 return (strtotime($this->end
) - time() <= 0);
125 public function getTitle()
131 // {{{ function toArray() : converts a question (or the whole survey) to array, with results if the survey is ended
132 public function toArray($i = 'all')
134 if ($i != 'all' && $i != 'root') { // if a specific question is requested, then just returns this question converted to array
136 if (array_key_exists($i, $this->questions
)) {
137 return $this->questions
[$i]->toArray();
141 } else { // else returns the root converted to array in any case
142 $a = array('title' => $this->title
,
143 'description' => $this->description
,
145 'mode' => $this->mode
,
146 'promos' => $this->promos
,
147 'valid' => $this->valid
,
149 if ($this->id
!= -1) {
150 $a['id'] = $this->id
;
152 if ($this->isEnded()) { // if the survey is ended, then adds here the number of votes
153 $sql = 'SELECT COUNT(id)
155 WHERE survey_id={?};';
156 $tot = XDB
::query($sql, $this->id
);
157 $a['votes'] = $tot->fetchOneCell();
159 if ($i == 'all' && count($this->questions
) > 0) { // if the whole survey is requested, then returns all the questions converted to array
161 for ($k = 0; $k < count($this->questions
); $k++
) {
162 $q = $this->questions
[$k]->toArray();
164 if ($this->isEnded()) { // if the survey is ended, then adds here the results of this question
165 $sql = $this->questions
[$k]->buildResultRequest();
167 $q['result'] = XDB
::iterator($sql, $this->id
, $k);
172 $a['questions'] = $qArr;
179 // {{{ function toCSV() : builds a CSV file containing all the results of the survey
180 public function toCSV($sep = ',', $enc = '"', $asep='|')
182 $nbq = count($this->questions
);
183 //require_once dirname(__FILE__) . '/../../classes/varstream.php';
187 $csv = fopen('var://csv_output', 'w');
188 $line = ($this->isMode(self
::MODE_XIDENT
))?
array('id', 'Nom', 'Prenom', 'Promo') : array('id');
189 for ($qid = 0; $qid < $nbq; $qid++
) {
190 $line[] = $this->questions
[$qid]->getCSVColumn(); // the fist line contains the questions
193 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
194 $sql = 'SELECT v.id AS vid, a.nom, a.prenom, a.promo
195 FROM survey_votes AS v
196 INNER JOIN auth_user_md5 AS a
197 ON a.user_id=v.user_id
198 WHERE v.survey_id={?}
200 $res = XDB
::iterator($sql, $this->id
); // retrieves all users data
201 for ($u = $res->next(); $u != null
; $u = $res->next()) {
202 $users[$u['vid']] = array('nom' => $u['nom'], 'prenom' => $u['prenom'], 'promo' => $u['promo']);
205 $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer
206 FROM survey_votes AS v
207 LEFT JOIN survey_answers AS a
209 WHERE v.survey_id={?}
210 ORDER BY vid ASC, qid ASC;';
211 $res = XDB
::iterator($sql, $this->id
); // retrieves all answers from database
215 $first = ($this->isMode(self
::MODE_XIDENT
))?
4 : 1;
216 while ($cur != null
) {
217 if ($vid != $cur['vid']) { // if the vote id changes, then starts a new line
218 fputcsv($csv, $line, $sep, $enc); // stores the former line into $csv_output
220 $line = array_fill(0, $first +
$nbq, ''); // creates an array full of empty string
221 $line[0] = $vid_; // the first field is a 'clean' vote id (not the one stored in database)
222 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
223 if (array_key_exists($vid, $users) && is_array($users[$vid])) { // and if the user data can be found
224 $line[1] = $users[$vid]['nom']; // adds the user data (in the first fields of the line)
225 $line[2] = $users[$vid]['prenom'];
226 $line[3] = $users[$vid]['promo'];
231 $fid = $first +
$cur['qid']; // computes the field id
232 if ($line[$fid] != '') { // if this field already contains something
233 $line[$fid] .= $asep; // then adds a separator before adding the new answer
235 $line[$fid] .= $cur['answer']; // adds the current answer to the correct field
236 $cur = $res->next(); // gets next answer
238 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
243 // {{{ function factory($type, $args) : builds a question according to the given type
244 public function factory($t, $args)
248 return new SurveyText($args);
250 return new SurveyTextarea($args);
252 return new SurveyNum($args);
254 return new SurveyRadio($args);
256 return new SurveyCheckbox($args);
258 return new SurveyPersonal($args);
265 // {{{ questions manipulation functions
266 public function addQuestion($i, $c)
269 if ($this->valid ||
$i > count($this->questions
)) {
272 array_splice($this->questions
, $i, 0, array($c));
277 public function delQuestion($i)
280 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
283 array_splice($this->questions
, $i, 1);
288 public function editQuestion($i, $a)
294 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
297 $this->questions
[$i]->update($a);
304 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
305 private static $errorMessages = array(
306 "dateformat" => "la date de fin de sondage est mal formattée : elle doit respecter la syntaxe dd/mm/aaaa",
307 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
308 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
311 public function checkSyntax()
314 if (!preg_match('#^\d{4}-\d{2}-\d{2}$#', $this->end
)) {
315 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["dateformat"]);
317 // checks that the end date given is not already passed
318 // (unless the survey has already been validated : an admin can have a validated survey expired)
319 if (!$this->valid
&& $this->isEnded()) {
320 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
323 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
324 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
326 return (empty($rArr))? null
: $rArr;
330 // {{{ functions that manipulate surveys in database
331 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
332 public static function retrieveList($type, $tpl = true
)
341 $where = 'valid=1 AND end > NOW()';
345 $where = 'valid=1 AND end <= NOW()';
350 $sql = 'SELECT id, title, end, mode
354 return XDB
::iterator($sql);
356 return XDB
::iterRow($sql);
361 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
362 public static function retrieveSurvey($sid)
364 $sql = 'SELECT questions, title, description, end, mode, promos, valid
367 $res = XDB
::query($sql, $sid);
368 $data = $res->fetchOneAssoc();
369 if (is_null($data) ||
!is_array($data)) {
372 $survey = new Survey($data, $sid, (boolean
) $data['valid'], unserialize($data['questions']));
377 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
378 public static function retrieveSurveyInfo($sid)
380 $sql = 'SELECT title, description, end, mode, promos, valid
383 $res = XDB
::query($sql, $sid);
384 return $res->fetchOneAssoc();
388 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
389 public function proposeSurvey()
391 $sql = 'INSERT INTO survey_surveys
400 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, S
::v('uid'), $this->end
, $this->mode
, $this->promos
);
404 // {{{ function updateSurvey() : updates a survey in database (before validation)
405 public function updateSurvey()
407 if ($this->id
== -1) {
410 $sql = 'UPDATE survey_surveys
418 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
422 // {{{ static function validateSurvey() : validates a survey
423 public static function validateSurvey($sid)
425 $sql = 'UPDATE survey_surveys
428 return XDB
::execute($sql, $sid);
432 // {{{ functions vote() and hasVoted() : handles vote to a survey
433 public function vote($uid, $args)
435 XDB
::execute('INSERT INTO survey_votes
436 SET survey_id={?}, user_id={?};', $this->id
, $uid); // notes the user as having voted
437 $vid = XDB
::insertId();
438 for ($i = 0; $i < count($this->questions
); $i++
) {
439 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
440 if (!is_null($ans) && is_array($ans)) {
441 foreach ($ans as $a) {
442 XDB
::execute('INSERT INTO survey_answers
445 answer = {?}', $vid, $i, $a);
451 public function hasVoted($uid)
453 $res = XDB
::query('SELECT id
455 WHERE survey_id={?} AND user_id={?};', $this->id
, $uid); // checks whether the user has already voted
456 return ($res->numRows() != 0);
460 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
461 public static function deleteSurvey($sid)
463 $sql = 'DELETE s.*, v.*, a.*
464 FROM survey_surveys AS s
465 LEFT JOIN survey_votes AS v
467 LEFT JOIN survey_answers AS a
470 return XDB
::execute($sql, $sid);
474 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
475 public static function purgeVotes($sid)
477 $sql = 'DELETE v.*, a.*
478 FROM survey_votes AS v
479 LEFT JOIN survey_answers AS a
481 WHERE v.survey_id={?};';
482 return XDB
::execute($sql, $sid);
490 // {{{ abstract class SurveyQuestion
491 abstract class SurveyQuestion
493 // {{{ common properties, constructor, and basic methods
497 public function __construct($args)
499 $this->update($args);
502 public function update($a)
504 $this->question
= $a['question'];
505 $this->comment
= $a['comment'];
508 abstract protected function getQuestionType();
511 // {{{ function toArray() : converts to array
512 public function toArray()
514 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
518 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
519 protected function checkSyntax()
525 // {{{ function checkAnswer : returns a correctly formatted answer (or nothing empty string if error)
526 public function checkAnswer($ans)
532 // {{{ functions regarding the results of a survey
533 public function buildResultRequest()
538 public function getCSVColumn()
540 return $this->question
;
546 // {{{ abstract class SurveySimple and its derived classes : "opended" questions
547 // {{{ abstract class SurveySimple extends SurveyQuestion
548 abstract class SurveySimple
extends SurveyQuestion
550 public function checkAnswer($ans)
555 public function buildResultRequest()
557 $sql = 'SELECT answer
559 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
568 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
569 class SurveyText
extends SurveySimple
571 public function getQuestionType()
578 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
579 class SurveyTextarea
extends SurveySimple
581 public function getQuestionType()
588 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
589 class SurveyNum
extends SurveySimple
591 public function checkAnswer($ans)
593 return array(intval($ans));
596 protected function getQuestionType()
604 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
605 // {{{ abstract class SurveyList extends SurveyQuestion
606 abstract class SurveyList
extends SurveyQuestion
610 public function update($args)
612 parent
::update($args);
613 $this->choices
= explode('|', $args['options']);
616 public function toArray()
618 $rArr = parent
::toArray();
619 $rArr['choices'] = $this->choices
;
620 $rArr['options'] = implode('|', $this->choices
);
624 public function buildResultRequest()
626 $sql = 'SELECT answer, COUNT(id) AS count
628 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
630 GROUP BY answer ASC';
634 public function getCSVColumn()
636 $r = parent
::getCSVColumn();
637 if (empty($this->choices
)) {
640 $r .= ' [0 => '.$this->choices
[0];
641 for ($k = 1; $k < count($this->choices
); $k++
) {
642 $r .= ', '.$k.' => '.$this->choices
[$k];
650 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
651 class SurveyRadio
extends SurveyList
653 public function checkAnswer($ans)
655 return (array_key_exists($ans, $this->choices
))?
array($ans) : null
;
658 protected function getQuestionType()
665 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
666 class SurveyCheckbox
extends SurveyList
668 public function checkAnswer($ans)
671 foreach ($ans as $a) {
673 if (array_key_exists($a, $this->choices
)) {
677 return (count($rep) == 0)? null
: $rep;
680 protected function getQuestionType()
688 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: