Merge remote branch 'origin/master' into account
[platal.git] / modules / survey / survey.inc.php
index a28580a..5c6a109 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2007 Polytechnique.org                              *
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -26,7 +26,7 @@ class Survey
     const MODE_ALL    = 0;
     const MODE_XANON  = 1;
     const MODE_XIDENT = 2;
-    private static $longModes = array(self::MODE_ALL    => "sondage ouvert &#224; tout le monde, anonyme",
+    private static $longModes = array(self::MODE_ALL    => "sondage ouvert à tout le monde, anonyme",
                                       self::MODE_XANON  => "sondage restreint aux polytechniciens, anonyme",
                                       self::MODE_XIDENT => "sondage restreint aux polytechniciens, non anonyme");
     private static $shortModes = array(self::MODE_ALL    => "tout le monde, anonyme",
@@ -39,11 +39,11 @@ class Survey
 
     private static $types = array('text'          => 'Texte court',
                                   'textarea'      => 'Texte long',
-                                  'num'           => 'Num&#233;rique',
-                                  'radio'         => 'Choix multiples (une r&#233;ponse)',
-                                  'checkbox'      => 'Choix multiples (plusieurs r&#233;ponses)',
-                                  'radiotable'    => 'Questions multiples &#224; choix multiples (une r&#233;ponse)',
-                                  'checkboxtable' => 'Questions multiples &#224; choix mutliples (plusieurs r&#233;ponses)');
+                                  'num'           => 'Numérique',
+                                  'radio'         => 'Choix multiples (une réponse)',
+                                  'checkbox'      => 'Choix multiples (plusieurs réponses)',
+                                  'radiotable'    => 'Questions multiples à choix multiples (une réponse)',
+                                  'checkboxtable' => 'Questions multiples à choix mutliples (plusieurs réponses)');
 
     public static function getTypes()
     {
@@ -83,6 +83,7 @@ class Survey
         if ($this->mode == self::MODE_ALL) {
             $args['promos'] = '';
         }
+        $args['promos'] = str_replace(' ', '', $args['promos']);
         $this->promos  = ($args['promos'] == '' || preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))? $args['promos'] : '#';
     }
     // }}}
@@ -181,54 +182,58 @@ class Survey
         $csv_output = '';
         $csv = fopen('var://csv_output', 'w');
         $line = ($this->isMode(self::MODE_XIDENT))? array('id', 'Nom', 'Prenom', 'Promo') : array('id');
+        $qids = array();
         for ($qid = 0; $qid < $nbq; $qid++) {
-            $line[] = $this->questions[$qid]->getCSVColumn(); // the fist line contains the questions
+            $qids[$qid] = count($line); // stores the first id of a question (in case of questions with subquestions)
+            array_splice($line, count($line), 0, $this->questions[$qid]->getCSVColumns()); // the first line contains the questions
         }
+        $nbf = count($line);
         $users = array();
         if ($this->isMode(self::MODE_XIDENT)) { // if the mode is non anonymous
-            $sql = 'SELECT v.id AS vid, a.nom, a.prenom, a.promo
-                      FROM survey_votes AS v
-                INNER JOIN auth_user_md5 AS a
-                        ON a.user_id=v.user_id
-                     WHERE v.survey_id={?}
-                  ORDER BY vid ASC;';
-            $res = XDB::iterator($sql, $this->id); // retrieves all users data
-            for ($u = $res->next(); $u != null; $u = $res->next()) {
-                $users[$u['vid']] = array('nom' => $u['nom'], 'prenom' => $u['prenom'], 'promo' => $u['promo']);
-            }
+            $users = User::getBulkUsersWithUIDs(XDB::fetchAllAssoc('vid', 'SELECT  v.id AS vid, v.user_id
+                                                                             FROM  survey_votes AS v
+                                                                            WHERE  v.survey_id = {?}
+                                                                         ORDER BY  vid ASC',
+                                                                    $this->id));
         }
-        $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer
+        $sql = 'SELECT v.id AS vid, a.question_id AS qid, a.answer AS answer
                   FROM survey_votes AS v
              LEFT JOIN survey_answers AS a
                     ON a.vote_id=v.id
                  WHERE v.survey_id={?}
-              ORDER BY vid ASC, qid ASC;';
+              ORDER BY vid ASC, qid ASC, answer ASC;';
         $res = XDB::iterator($sql, $this->id); // retrieves all answers from database
-        $cur = $res->next();
         $vid = -1;
         $vid_ = 0;
-        $first = ($this->isMode(self::MODE_XIDENT))? 4 : 1;
-        while ($cur != null) {
+        while (($cur = $res->next()) != null) {
             if ($vid != $cur['vid']) { // if the vote id changes, then starts a new line
                 fputcsv($csv, $line, $sep, $enc); // stores the former line into $csv_output
                 $vid = $cur['vid'];
-                $line = array_fill(0, $first + $nbq, ''); // creates an array full of empty string
+                $line = array_fill(0, $nbf, ''); // creates an array full of empty string
                 $line[0] = $vid_; // the first field is a 'clean' vote id (not the one stored in database)
                 if ($this->isMode(self::MODE_XIDENT)) { // if the mode is non anonymous
-                    if (array_key_exists($vid, $users) && is_array($users[$vid])) { // and if the user data can be found
-                        $line[1] = $users[$vid]['nom']; // adds the user data (in the first fields of the line)
-                        $line[2] = $users[$vid]['prenom'];
-                        $line[3] = $users[$vid]['promo'];
+                    if (array_key_exists($vid, $users)) { // and if the user data can be found
+                        $line[1] = $users[$vid]->lastName(); // adds the user data (in the first fields of the line)
+                        $line[2] = $users[$vid]->firstName();;
+                        $line[3] = $users[$vid]->promo();
                     }
                 }
                 $vid_++;
             }
-            $fid = $first + $cur['qid']; // computes the field id
-            if ($line[$fid] != '') {  // if this field already contains something
-                $line[$fid] .= $asep; // then adds a separator before adding the new answer
+            $ans = $this->questions[$cur['qid']]->formatAnswer($cur['answer']); // formats the current answer
+            if (!is_null($ans)) {
+                if (is_array($ans)) {
+                    $fid = $qids[$cur['qid']] + $ans['id']; // computes the field id
+                    $a = $ans['answer'];
+                } else {
+                    $fid = $qids[$cur['qid']];
+                    $a = $ans;
+                }
+                if ($line[$fid] != '') {  // if this field already contains something
+                    $line[$fid] .= $asep; // then adds a separator before adding the new answer
+                }
+                $line[$fid] .= $a; // adds the current answer to the correct field
             }
-            $line[$fid] .= $cur['answer']; // adds the current answer to the correct field
-            $cur = $res->next(); // gets next answer
         }
         fputcsv($csv, $line, $sep, $enc); // stores the last line into $csv_output
         return $csv_output;
@@ -300,8 +305,8 @@ class Survey
 
     // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
     private static $errorMessages = array(
-        "datepassed"  => "la date de fin de sondage est d&#233;j&#224; d&#233;pass&#233;e : vous devez pr&#233;ciser une date future",
-        "promoformat" => "les restrictions &#224; certaines promotions sont mal formatt&#233;es"
+        "datepassed"  => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
+        "promoformat" => "les restrictions à certaines promotions sont mal formattées"
     );
 
     public function checkSyntax()
@@ -336,8 +341,9 @@ class Survey
             return null;
         }
         $sql = 'SELECT id, title, end, mode
-                  FROM survey_surveys
-                 WHERE '.$where.';';
+                  FROM surveys
+                 WHERE '.$where.'
+              ORDER BY end DESC;';
         if ($tpl) {
             return XDB::iterator($sql);
         } else {
@@ -350,7 +356,7 @@ class Survey
     public static function retrieveSurvey($sid)
     {
         $sql = 'SELECT questions, title, description, end, mode, promos
-                  FROM survey_surveys
+                  FROM surveys
                  WHERE id={?}';
         $res = XDB::query($sql, $sid);
         $data = $res->fetchOneAssoc();
@@ -366,7 +372,7 @@ class Survey
     public static function retrieveSurveyInfo($sid)
     {
         $sql = 'SELECT title, description, end, mode, promos
-                  FROM survey_surveys
+                  FROM surveys
                  WHERE id={?}';
         $res = XDB::query($sql, $sid);
         return $res->fetchOneAssoc();
@@ -395,7 +401,7 @@ class Survey
     public function proposeSurvey()
     {
         require_once 'validations.inc.php';
-        $surveyreq = new SurveyReq($this->title, $this->description, $this->end, $this->mode, $this->promos, $this->questions, S::v('uid'));
+        $surveyreq = new SurveyReq($this->title, $this->description, $this->end, $this->mode, $this->promos, $this->questions, S::user());
         return $surveyreq->submit();
     }
     // }}}
@@ -404,7 +410,7 @@ class Survey
     public function updateSurvey()
     {
         if ($this->valid) {
-            $sql = 'UPDATE survey_surveys
+            $sql = 'UPDATE surveys
                        SET questions={?},
                            title={?},
                            description={?},
@@ -456,7 +462,7 @@ class Survey
     public static function deleteSurvey($sid)
     {
         $sql = 'DELETE s.*, v.*, a.*
-                  FROM survey_surveys AS s
+                  FROM surveys AS s
              LEFT JOIN survey_votes AS v
                     ON v.survey_id=s.id
              LEFT JOIN survey_answers AS a
@@ -501,11 +507,6 @@ abstract class SurveyQuestion
     }
 
     abstract protected function getQuestionType();
-
-    protected function getQuestion()
-    {
-        return $this->question;
-    }
     // }}}
 
     // {{{ function toArray() : converts to array
@@ -532,7 +533,12 @@ abstract class SurveyQuestion
     // {{{ functions regarding the results of a survey
     abstract public function getResultArray($sid, $qid);
 
-    public function getCSVColumn()
+    public function formatAnswer($ans)
+    {
+        return $ans;
+    }
+
+    public function getCSVColumns()
     {
         return $this->question;
     }
@@ -634,18 +640,13 @@ abstract class SurveyList extends SurveyQuestion
         return $res->fetchAllAssoc();
     }
 
-    public function getCSVColumn()
+    public function formatAnswer($ans)
     {
-        $r = parent::getCSVColumn();
-        if (empty($this->choices)) {
-            return $r;
-        }
-        $r .= ' [0 => '.$this->choices[0];
-        for ($k = 1; $k < count($this->choices); $k++) {
-            $r .= ', '.$k.' => '.$this->choices[$k];
+        if (array_key_exists($ans, $this->choices)) {
+            return $this->choices[$ans];
+        } else {
+            return null;
         }
-        $r .= ']';
-        return $r;
     }
 }
 // }}}
@@ -732,24 +733,27 @@ abstract class SurveyTable extends SurveyList
         return $result;
     }
 
-    public function getCSVColumn()
+    public function formatAnswer($ans)
     {
-        $r = $this->getQuestion() . ' (format "sous-question:choix") ';
-        if (!empty($this->subquestions)) {
-            $r .= ' [sous-questions : 0 =>'.$this->subquestions[0];
-            for ($k = 1; $k < count($this->subquestions); $k++) {
-                $r .= ', '.$k.' => '.$this->subquestions[$k];
-            }
-            $r .= ']';
+        list($q, $c) = explode(':', $ans);
+        if (array_key_exists($q, $this->subquestions) && array_key_exists($c, $this->choices)) {
+            return array('id' => $q, 'answer' => $this->choices[$c]);
+        } else {
+            return null;
         }
-        if (!empty($this->choices)) {
-            $r .= ' [choix : 0 => '.$this->choices[0];
-            for ($k = 1; $k < count($this->choices); $k++) {
-                $r .= ', '.$k.' => '.$this->choices[$k];
-            }
-            $r .= ']';
+    }
+
+    public function getCSVColumns()
+    {
+        $q = parent::getCSVColumns();
+        if (empty($this->subquestions)) {
+            return $q;
+        }
+        $a = array();
+        for ($k = 0; $k < count($this->subquestions); $k++) {
+            $a[$k] = $q.' : '.$this->subquestions[$k];
         }
-        return $r;
+        return $a;
     }
 }
 // }}}
@@ -809,5 +813,5 @@ class SurveyCheckboxTable extends SurveyTable
 // }}}
 // }}}
 
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8:
 ?>