2 /***************************************************************************
3 * Copyright (C) 2003-2013 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',
43 'radio' => 'Choix multiples (une réponse)',
44 'checkbox' => 'Choix multiples (plusieurs réponses)',
45 'radiotable' => 'Questions multiples à choix multiples (une réponse)',
46 'checkboxtable' => 'Questions multiples à choix mutliples (plusieurs réponses)');
48 public static function getTypes()
53 public static function isType($t)
55 return array_key_exists($t, self
::$types);
59 // {{{ properties, constructor and basic methods
70 public function __construct($args, $id = -1, $valid = false
, $questions = null
)
74 $this->valid
= $valid;
75 $this->questions
= ($questions == null
)?
array() : $questions;
78 public function update($args)
80 $this->title
= $args['title'];
81 $this->description
= $args['description'];
82 $this->end
= $args['end'];
83 $this->mode
= (isset($args['mode']))?
$args['mode'] : self
::MODE_ALL
;
84 $this->creator
= $args['uid'];
85 if ($this->mode
== self
::MODE_ALL
) {
88 $args['promos'] = str_replace(' ', '', $args['promos']);
89 $this->promos
= ($args['promos'] == '' ||
preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))?
$args['promos'] : '#';
92 public function canSeeEarlyResults(User
$user)
94 return $user->id() == $this->creator ||
$user->checkPerms('admin');
98 // {{{ functions to access general information
99 public function isMode($mode)
101 return ($this->mode
== $mode);
104 public function checkPromo($promo)
106 if ($this->promos
== '') {
109 $promos = explode(',', $this->promos
);
110 foreach ($promos as $p) {
111 if ((preg_match('#^\d{4}$#', $p) && $p == $promo) ||
112 (preg_match('#^\d{4}-$#', $p) && intval(substr($p, 0, 4)) <= $promo) ||
113 (preg_match('#^-\d{4}$#', $p) && intval(substr($p, 1)) >= $promo) ||
114 (preg_match('#^\d{4}-\d{4}$#', $p) &&
115 (intval(substr($p, 0, 4)) <= $promo && intval(substr($p, 5)) >= $promo ||
116 intval(substr($p, 0, 4)) >= $promo && intval(substr($p, 5)) <= $promo ))) {
123 public function isValid()
128 public function isEnded()
130 return (strtotime($this->end
) - time() <= 0);
133 public function getTitle()
139 // {{{ function toArray() : converts a question (or the whole survey) to array, with results if the survey is ended
140 public function toArray($i = 'all')
142 if ($i != 'all' && $i != 'root') { // if a specific question is requested, then just returns this question converted to array
144 if (array_key_exists($i, $this->questions
)) {
145 return $this->questions
[$i]->toArray();
149 } else { // else returns the root converted to array in any case
150 $a = array('title' => $this->title
,
151 'description' => $this->description
,
153 'mode' => $this->mode
,
154 'promos' => $this->promos
,
155 'valid' => $this->valid
,
157 if ($this->id
!= -1) {
158 $a['id'] = $this->id
;
160 if ($this->isEnded()) { // if the survey is ended, then adds here the number of votes
161 $sql = 'SELECT COUNT(id)
163 WHERE survey_id={?};';
164 $tot = XDB
::query($sql, $this->id
);
165 $a['votes'] = $tot->fetchOneCell();
167 if ($i == 'all' && count($this->questions
) > 0) { // if the whole survey is requested, then returns all the questions converted to array
169 for ($k = 0; $k < count($this->questions
); $k++
) {
170 $q = $this->questions
[$k]->toArray();
172 if ($this->isEnded()) { // if the survey is ended, then adds here the results of this question
173 $q['result'] = $this->questions
[$k]->getResultArray($this->id
, $k);
177 $a['questions'] = $qArr;
184 // {{{ function toCSV() : builds a CSV file containing all the results of the survey
185 public function toCSV($sep = ',', $enc = '"', $asep='|')
187 $nbq = count($this->questions
);
188 //require_once dirname(__FILE__) . '/../../classes/varstream.php';
192 $csv = fopen('var://csv_output', 'w');
193 $line = ($this->isMode(self
::MODE_XIDENT
))?
array('id', 'Nom', 'Prenom', 'Promo') : array('id');
195 for ($qid = 0; $qid < $nbq; $qid++
) {
196 $qids[$qid] = count($line); // stores the first id of a question (in case of questions with subquestions)
197 array_splice($line, count($line), 0, $this->questions
[$qid]->getCSVColumns()); // the first line contains the questions
201 if ($this->isMode(self
::MODE_XIDENT
)) { // if the mode is non anonymous
202 $users = XDB
::fetchAllAssoc('vid', 'SELECT v.id AS vid, v.uid
203 FROM survey_votes AS v
204 WHERE v.survey_id = {?}
208 $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer AS answer
209 FROM survey_votes AS v
210 INNER JOIN survey_answers AS a ON a.vote_id=v.id
211 WHERE v.survey_id={?}
212 ORDER BY vid ASC, qid ASC, answer ASC';
213 $res = XDB
::iterator($sql, $this->id
); // retrieves all answers from database
216 while (($cur = $res->next()) != 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, $nbf, ''); // 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)) { // and if the user data can be found
224 $user=PlUser
::getWithUID($users[$vid]);
225 $line[1] = $user->lastName(); // adds the user data (in the first fields of the line)
226 $line[2] = $user->firstName();
227 $line[3] = $user->promo();
232 $ans = $this->questions
[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
233 if (!is_null($ans)) {
234 if (is_array($ans)) {
235 $fid = $qids[$cur['qid']] +
$ans['id']; // computes the field id
238 $fid = $qids[$cur['qid']];
241 if ($line[$fid] != '') { // if this field already contains something
242 $line[$fid] .= $asep; // then adds a separator before adding the new answer
244 $line[$fid] .= $a; // adds the current answer to the correct field
247 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
252 // {{{ function factory($type, $args) : builds a question according to the given type
253 public function factory($t, $args)
257 return new SurveyText($args);
259 return new SurveyTextarea($args);
261 return new SurveyNum($args);
263 return new SurveyRadio($args);
265 return new SurveyCheckbox($args);
267 return new SurveyRadioTable($args);
268 case 'checkboxtable':
269 return new SurveyCheckboxTable($args);
276 // {{{ questions manipulation functions
277 public function addQuestion($i, $c)
280 if ($this->valid ||
$i > count($this->questions
)) {
283 array_splice($this->questions
, $i, 0, array($c));
288 public function delQuestion($i)
291 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
294 array_splice($this->questions
, $i, 1);
299 public function editQuestion($i, $a)
305 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
308 $this->questions
[$i]->update($a);
315 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
316 private static $errorMessages = array(
317 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
318 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
321 public function checkSyntax()
324 // checks that the end date given is not already passed
325 // (unless the survey has already been validated : an admin can have a validated survey expired)
326 if (!$this->valid
&& $this->isEnded()) {
327 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
329 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
330 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
332 return (empty($rArr))? null
: $rArr;
336 // {{{ functions that manipulate surveys in database
337 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
338 public static function retrieveList($type, $tpl = true
)
343 $where = 'end > NOW()';
347 $where = 'end <= NOW()';
352 if (!S
::user()->checkPerms(PERMS_USER
)) {
353 $where .= XDB
::format(' AND mode = {?}', self
::MODE_ALL
);
355 $sql = 'SELECT id, title, uid, end, mode
360 return XDB
::iterator($sql);
362 return XDB
::iterRow($sql);
367 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
368 public static function retrieveSurvey($sid)
370 $sql = 'SELECT questions, title, description, end, mode, promos, uid
373 $res = XDB
::query($sql, $sid);
374 $data = $res->fetchOneAssoc();
375 if (is_null($data) ||
!is_array($data)) {
378 $survey = new Survey($data, $sid, true
, unserialize($data['questions']));
383 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
384 public static function retrieveSurveyInfo($sid)
386 $sql = 'SELECT title, description, end, mode, promos
389 $res = XDB
::query($sql, $sid);
390 return $res->fetchOneAssoc();
394 // {{{ static function retrieveSurveyReq() : gets a survey request to validate
395 public static function retrieveSurveyReq($id)
397 $surveyreq = Validate
::get_request_by_id($id);
398 if ($surveyreq == null
) {
401 $data = array('title' => $surveyreq->title
,
402 'description' => $surveyreq->description
,
403 'end' => $surveyreq->end
,
404 'mode' => $surveyreq->mode
,
405 'promos' => $surveyreq->promos
);
406 $survey = new Survey($data, $id, false
, $surveyreq->questions
);
411 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
412 public function proposeSurvey()
414 $surveyreq = new SurveyReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
, S
::user());
415 return $surveyreq->submit();
419 // {{{ function updateSurvey() : updates a survey in database (before validation)
420 public function updateSurvey()
423 $sql = 'UPDATE surveys
431 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
433 $surveyreq = Validate
::get_request_by_id($this->id
);
434 if ($surveyreq == null
) {
437 return $surveyreq->updateReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
);
442 // {{{ functions vote() and hasVoted() : handles vote to a survey
443 public function vote($uid, $args)
445 XDB
::execute('INSERT INTO survey_votes
446 SET survey_id = {?}, uid = {?}',
447 $this->id
, ($uid == 0) ? null
: $uid); // notes the user as having voted
448 $vid = XDB
::insertId();
449 for ($i = 0; $i < count($this->questions
); $i++
) {
450 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
451 if (!is_null($ans) && is_array($ans)) {
452 foreach ($ans as $a) {
453 XDB
::execute('INSERT INTO survey_answers
456 answer = {?}', $vid, $i, $a);
462 public function hasVoted($uid)
464 $res = XDB
::query('SELECT id
466 WHERE survey_id = {?} AND uid = {?};', $this->id
, $uid); // checks whether the user has already voted
467 return ($res->numRows() != 0);
471 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
472 public static function deleteSurvey($sid)
474 $sql = 'DELETE s.*, v.*, a.*
476 LEFT JOIN survey_votes AS v
478 LEFT JOIN survey_answers AS a
481 return XDB
::execute($sql, $sid);
485 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
486 public static function purgeVotes($sid)
488 $sql = 'DELETE v.*, a.*
489 FROM survey_votes AS v
490 LEFT JOIN survey_answers AS a
492 WHERE v.survey_id={?};';
493 return XDB
::execute($sql, $sid);
501 // {{{ abstract class SurveyQuestion
502 abstract class SurveyQuestion
504 // {{{ common properties, constructor, and basic methods
508 public function __construct($args)
510 $this->update($args);
513 public function update($a)
515 $this->question
= $a['question'];
516 $this->comment
= $a['comment'];
519 abstract protected function getQuestionType();
522 // {{{ function toArray() : converts to array
523 public function toArray()
525 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
529 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
530 protected function checkSyntax()
536 // {{{ function checkAnswer : returns a correct answer (or a null value if error)
537 public function checkAnswer($ans)
543 // {{{ functions regarding the results of a survey
544 abstract public function getResultArray($sid, $qid);
546 public function formatAnswer($ans)
551 public function getCSVColumns()
553 return $this->question
;
559 // {{{ abstract class SurveySimple and its derived classes : "open" questions
560 // {{{ abstract class SurveySimple extends SurveyQuestion
561 abstract class SurveySimple
extends SurveyQuestion
563 public function checkAnswer($ans)
568 public function getResultArray($sid, $qid)
570 $sql = 'SELECT answer
572 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
576 $res = XDB
::query($sql, $sid, $qid);
577 return $res->fetchAllAssoc();
582 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
583 class SurveyText
extends SurveySimple
585 public function getQuestionType()
592 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
593 class SurveyTextarea
extends SurveySimple
595 public function getQuestionType()
602 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
603 class SurveyNum
extends SurveySimple
605 public function checkAnswer($ans)
607 return array(intval($ans));
610 protected function getQuestionType()
618 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
619 // {{{ abstract class SurveyList extends SurveyQuestion
620 abstract class SurveyList
extends SurveyQuestion
624 public function update($args)
626 parent
::update($args);
627 $this->choices
= array();
628 foreach ($args['choices'] as $val) {
629 if (trim($val) ||
trim($val) == '0') {
630 $this->choices
[] = $val;
635 public function toArray()
637 $rArr = parent
::toArray();
638 $rArr['choices'] = $this->choices
;
642 public function getResultArray($sid, $qid)
644 $sql = 'SELECT answer, COUNT(id) AS count
646 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
648 GROUP BY answer ASC';
649 $res = XDB
::query($sql, $sid, $qid);
650 return $res->fetchAllAssoc();
653 public function formatAnswer($ans)
655 if (array_key_exists($ans, $this->choices
)) {
656 return $this->choices
[$ans];
664 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
665 class SurveyRadio
extends SurveyList
667 public function checkAnswer($ans)
670 return (array_key_exists($a, $this->choices
))?
array($a) : null
;
673 protected function getQuestionType()
680 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
681 class SurveyCheckbox
extends SurveyList
683 public function checkAnswer($ans)
686 foreach ($ans as $a) {
688 if (array_key_exists($a, $this->choices
)) {
692 return (count($rep) == 0)? null
: $rep;
695 protected function getQuestionType()
703 // {{{ abstract class SurveyTable and its derived classes : table question, each column represents a choice, each line represents a question
704 // {{{ abstract class SurveyTable extends SurveyList
705 abstract class SurveyTable
extends SurveyList
707 protected $subquestions;
709 public function update($args)
711 parent
::update($args);
712 $this->subquestions
= array();
713 foreach ($args['subquestions'] as $val) {
714 if (trim($val) ||
trim($val) == '0') {
715 $this->subquestions
[] = $val;
720 public function toArray()
722 $rArr = parent
::toArray();
723 $rArr['subquestions'] = $this->subquestions
;
727 public function getResultArray($sid, $qid)
729 $sql = 'SELECT answer, COUNT(id) AS count
731 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
733 GROUP BY answer ASC';
734 $res = XDB
::iterator($sql, $sid, $qid);
736 for ($i = 0; $i < count($this->subquestions
); $i++
) {
737 $result[$i] = array_fill(0, count($this->choices
), 0);
739 while ($r = $res->next()) {
740 list($i, $j) = explode(':', $r['answer']);
741 $result[$i][$j] = $r['count'];
746 public function formatAnswer($ans)
748 list($q, $c) = explode(':', $ans);
749 if (array_key_exists($q, $this->subquestions
) && array_key_exists($c, $this->choices
)) {
750 return array('id' => $q, 'answer' => $this->choices
[$c]);
756 public function getCSVColumns()
758 $q = parent
::getCSVColumns();
759 if (empty($this->subquestions
)) {
763 for ($k = 0; $k < count($this->subquestions
); $k++
) {
764 $a[$k] = $q.' : '.$this->subquestions
[$k];
771 // {{{ class SurveyRadioTable extends SurveyTable : SurveyTable with radio type choices
772 class SurveyRadioTable
extends SurveyTable
774 public function checkAnswer($ans)
777 foreach ($ans as $k => $a) {
778 if (!array_key_exists($k, $this->subquestions
)) {
782 if (array_key_exists($a, $this->choices
)) {
783 $rep[] = $k . ':' . $a;
786 return (count($rep) == 0)? null
: $rep;
789 protected function getQuestionType()
797 // {{{ class SurveyCheckboxTable extends SurveyTable : SurveyTable with checkbox type choices
798 class SurveyCheckboxTable
extends SurveyTable
800 public function checkAnswer($ans)
803 foreach ($ans as $k => $aa) {
804 if (!array_key_exists($k, $this->subquestions
)) {
807 foreach ($aa as $a) {
809 if (array_key_exists($a, $this->choices
)) {
810 $rep[] = $k . ':' . $a;
814 return (count($rep) == 0)? null
: $rep;
817 protected function getQuestionType()
819 return "checkboxtable";
826 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: