2 /***************************************************************************
3 * Copyright (C) 2003-2014 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 = User
::getBulkUsersWithUIDs(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 $line[1] = $users[$vid]->lastName(); // adds the user data (in the first fields of the line)
225 $line[2] = $users[$vid]->firstName();;
226 $line[3] = $users[$vid]->promo();
231 $ans = $this->questions
[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
232 if (!is_null($ans)) {
233 if (is_array($ans)) {
234 $fid = $qids[$cur['qid']] +
$ans['id']; // computes the field id
237 $fid = $qids[$cur['qid']];
240 if ($line[$fid] != '') { // if this field already contains something
241 $line[$fid] .= $asep; // then adds a separator before adding the new answer
243 $line[$fid] .= $a; // adds the current answer to the correct field
246 fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
251 // {{{ function factory($type, $args) : builds a question according to the given type
252 public function factory($t, $args)
256 return new SurveyText($args);
258 return new SurveyTextarea($args);
260 return new SurveyNum($args);
262 return new SurveyRadio($args);
264 return new SurveyCheckbox($args);
266 return new SurveyRadioTable($args);
267 case 'checkboxtable':
268 return new SurveyCheckboxTable($args);
275 // {{{ questions manipulation functions
276 public function addQuestion($i, $c)
279 if ($this->valid ||
$i > count($this->questions
)) {
282 array_splice($this->questions
, $i, 0, array($c));
287 public function delQuestion($i)
290 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
293 array_splice($this->questions
, $i, 1);
298 public function editQuestion($i, $a)
304 if ($this->valid ||
!array_key_exists($i, $this->questions
)) {
307 $this->questions
[$i]->update($a);
314 // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
315 private static $errorMessages = array(
316 "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
317 "promoformat" => "les restrictions à certaines promotions sont mal formattées"
320 public function checkSyntax()
323 // checks that the end date given is not already passed
324 // (unless the survey has already been validated : an admin can have a validated survey expired)
325 if (!$this->valid
&& $this->isEnded()) {
326 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["datepassed"]);
328 if ($this->promos
!= '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos
)) {
329 $rArr[] = array('question' => 'root', 'error' => self
::$errorMessages["promoformat"]);
331 return (empty($rArr))? null
: $rArr;
335 // {{{ functions that manipulate surveys in database
336 // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
337 public static function retrieveList($type, $tpl = true
)
342 $where = 'end > NOW()';
346 $where = 'end <= NOW()';
351 $sql = 'SELECT id, title, end, mode
356 return XDB
::iterator($sql);
358 return XDB
::iterRow($sql);
363 // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
364 public static function retrieveSurvey($sid)
366 $sql = 'SELECT questions, title, description, end, mode, promos, uid
369 $res = XDB
::query($sql, $sid);
370 $data = $res->fetchOneAssoc();
371 if (is_null($data) ||
!is_array($data)) {
374 $survey = new Survey($data, $sid, true
, unserialize($data['questions']));
379 // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
380 public static function retrieveSurveyInfo($sid)
382 $sql = 'SELECT title, description, end, mode, promos
385 $res = XDB
::query($sql, $sid);
386 return $res->fetchOneAssoc();
390 // {{{ static function retrieveSurveyReq() : gets a survey request to validate
391 public static function retrieveSurveyReq($id)
393 $surveyreq = Validate
::get_request_by_id($id);
394 if ($surveyreq == null
) {
397 $data = array('title' => $surveyreq->title
,
398 'description' => $surveyreq->description
,
399 'end' => $surveyreq->end
,
400 'mode' => $surveyreq->mode
,
401 'promos' => $surveyreq->promos
);
402 $survey = new Survey($data, $id, false
, $surveyreq->questions
);
407 // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
408 public function proposeSurvey()
410 $surveyreq = new SurveyReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
, S
::user());
411 return $surveyreq->submit();
415 // {{{ function updateSurvey() : updates a survey in database (before validation)
416 public function updateSurvey()
419 $sql = 'UPDATE surveys
427 return XDB
::execute($sql, serialize($this->questions
), $this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->id
);
429 $surveyreq = Validate
::get_request_by_id($this->id
);
430 if ($surveyreq == null
) {
433 return $surveyreq->updateReq($this->title
, $this->description
, $this->end
, $this->mode
, $this->promos
, $this->questions
);
438 // {{{ functions vote() and hasVoted() : handles vote to a survey
439 public function vote($uid, $args)
441 XDB
::execute('INSERT INTO survey_votes
442 SET survey_id = {?}, uid = {?}',
443 $this->id
, ($uid == 0) ? null
: $uid); // notes the user as having voted
444 $vid = XDB
::insertId();
445 for ($i = 0; $i < count($this->questions
); $i++
) {
446 $ans = $this->questions
[$i]->checkAnswer($args[$i]);
447 if (!is_null($ans) && is_array($ans)) {
448 foreach ($ans as $a) {
449 XDB
::execute('INSERT INTO survey_answers
452 answer = {?}', $vid, $i, $a);
458 public function hasVoted($uid)
460 $res = XDB
::query('SELECT id
462 WHERE survey_id = {?} AND uid = {?};', $this->id
, $uid); // checks whether the user has already voted
463 return ($res->numRows() != 0);
467 // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
468 public static function deleteSurvey($sid)
470 $sql = 'DELETE s.*, v.*, a.*
472 LEFT JOIN survey_votes AS v
474 LEFT JOIN survey_answers AS a
477 return XDB
::execute($sql, $sid);
481 // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
482 public static function purgeVotes($sid)
484 $sql = 'DELETE v.*, a.*
485 FROM survey_votes AS v
486 LEFT JOIN survey_answers AS a
488 WHERE v.survey_id={?};';
489 return XDB
::execute($sql, $sid);
497 // {{{ abstract class SurveyQuestion
498 abstract class SurveyQuestion
500 // {{{ common properties, constructor, and basic methods
504 public function __construct($args)
506 $this->update($args);
509 public function update($a)
511 $this->question
= $a['question'];
512 $this->comment
= $a['comment'];
515 abstract protected function getQuestionType();
518 // {{{ function toArray() : converts to array
519 public function toArray()
521 return array('type' => $this->getQuestionType(), 'question' => $this->question
, 'comment' => $this->comment
);
525 // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
526 protected function checkSyntax()
532 // {{{ function checkAnswer : returns a correct answer (or a null value if error)
533 public function checkAnswer($ans)
539 // {{{ functions regarding the results of a survey
540 abstract public function getResultArray($sid, $qid);
542 public function formatAnswer($ans)
547 public function getCSVColumns()
549 return $this->question
;
555 // {{{ abstract class SurveySimple and its derived classes : "open" questions
556 // {{{ abstract class SurveySimple extends SurveyQuestion
557 abstract class SurveySimple
extends SurveyQuestion
559 public function checkAnswer($ans)
564 public function getResultArray($sid, $qid)
566 $sql = 'SELECT answer
568 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
572 $res = XDB
::query($sql, $sid, $qid);
573 return $res->fetchAllAssoc();
578 // {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
579 class SurveyText
extends SurveySimple
581 public function getQuestionType()
588 // {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
589 class SurveyTextarea
extends SurveySimple
591 public function getQuestionType()
598 // {{{ class SurveyNum extends SurveySimple : allows numerical answers
599 class SurveyNum
extends SurveySimple
601 public function checkAnswer($ans)
603 return array(intval($ans));
606 protected function getQuestionType()
614 // {{{ abstract class SurveyList and its derived classes : restricted questions that allows only a list of possible answers
615 // {{{ abstract class SurveyList extends SurveyQuestion
616 abstract class SurveyList
extends SurveyQuestion
620 public function update($args)
622 parent
::update($args);
623 $this->choices
= array();
624 foreach ($args['choices'] as $val) {
625 if (trim($val) ||
trim($val) == '0') {
626 $this->choices
[] = $val;
631 public function toArray()
633 $rArr = parent
::toArray();
634 $rArr['choices'] = $this->choices
;
638 public function getResultArray($sid, $qid)
640 $sql = 'SELECT answer, COUNT(id) AS count
642 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
644 GROUP BY answer ASC';
645 $res = XDB
::query($sql, $sid, $qid);
646 return $res->fetchAllAssoc();
649 public function formatAnswer($ans)
651 if (array_key_exists($ans, $this->choices
)) {
652 return $this->choices
[$ans];
660 // {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
661 class SurveyRadio
extends SurveyList
663 public function checkAnswer($ans)
666 return (array_key_exists($a, $this->choices
))?
array($a) : null
;
669 protected function getQuestionType()
676 // {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
677 class SurveyCheckbox
extends SurveyList
679 public function checkAnswer($ans)
682 foreach ($ans as $a) {
684 if (array_key_exists($a, $this->choices
)) {
688 return (count($rep) == 0)? null
: $rep;
691 protected function getQuestionType()
699 // {{{ abstract class SurveyTable and its derived classes : table question, each column represents a choice, each line represents a question
700 // {{{ abstract class SurveyTable extends SurveyList
701 abstract class SurveyTable
extends SurveyList
703 protected $subquestions;
705 public function update($args)
707 parent
::update($args);
708 $this->subquestions
= array();
709 foreach ($args['subquestions'] as $val) {
710 if (trim($val) ||
trim($val) == '0') {
711 $this->subquestions
[] = $val;
716 public function toArray()
718 $rArr = parent
::toArray();
719 $rArr['subquestions'] = $this->subquestions
;
723 public function getResultArray($sid, $qid)
725 $sql = 'SELECT answer, COUNT(id) AS count
727 WHERE vote_id IN (SELECT id FROM survey_votes WHERE survey_id={?})
729 GROUP BY answer ASC';
730 $res = XDB
::iterator($sql, $sid, $qid);
732 for ($i = 0; $i < count($this->subquestions
); $i++
) {
733 $result[$i] = array_fill(0, count($this->choices
), 0);
735 while ($r = $res->next()) {
736 list($i, $j) = explode(':', $r['answer']);
737 $result[$i][$j] = $r['count'];
742 public function formatAnswer($ans)
744 list($q, $c) = explode(':', $ans);
745 if (array_key_exists($q, $this->subquestions
) && array_key_exists($c, $this->choices
)) {
746 return array('id' => $q, 'answer' => $this->choices
[$c]);
752 public function getCSVColumns()
754 $q = parent
::getCSVColumns();
755 if (empty($this->subquestions
)) {
759 for ($k = 0; $k < count($this->subquestions
); $k++
) {
760 $a[$k] = $q.' : '.$this->subquestions
[$k];
767 // {{{ class SurveyRadioTable extends SurveyTable : SurveyTable with radio type choices
768 class SurveyRadioTable
extends SurveyTable
770 public function checkAnswer($ans)
773 foreach ($ans as $k => $a) {
774 if (!array_key_exists($k, $this->subquestions
)) {
778 if (array_key_exists($a, $this->choices
)) {
779 $rep[] = $k . ':' . $a;
782 return (count($rep) == 0)? null
: $rep;
785 protected function getQuestionType()
793 // {{{ class SurveyCheckboxTable extends SurveyTable : SurveyTable with checkbox type choices
794 class SurveyCheckboxTable
extends SurveyTable
796 public function checkAnswer($ans)
799 foreach ($ans as $k => $aa) {
800 if (!array_key_exists($k, $this->subquestions
)) {
803 foreach ($aa as $a) {
805 if (array_key_exists($a, $this->choices
)) {
806 $rep[] = $k . ':' . $a;
810 return (count($rep) == 0)? null
: $rep;
813 protected function getQuestionType()
815 return "checkboxtable";
822 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: