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 SurveyModule
extends PLModule
24 // {{{ function handlers() : registers the different handlers
28 'survey' => $this->make_hook('index', AUTH_PUBLIC
),
29 'survey/vote' => $this->make_hook('vote', AUTH_PUBLIC
),
30 'survey/result' => $this->make_hook('result', AUTH_PUBLIC
),
31 'survey/edit' => $this->make_hook('edit', AUTH_COOKIE
),
32 'survey/ajax' => $this->make_hook('ajax', AUTH_COOKIE
),
33 'survey/admin' => $this->make_hook('admin', AUTH_MDP
, 'admin'),
34 'survey/admin/edit' => $this->make_hook('adminEdit', AUTH_MDP
, 'admin'),
35 'survey/admin/valid' => $this->make_hook('adminValidate', AUTH_MDP
, 'admin'),
36 'survey/admin/del' => $this->make_hook('adminDelete', AUTH_MDP
, 'admin'),
41 // {{{ function handler_index() : lists all available surveys
42 function handler_index(&$page, $action = null
)
44 require_once dirname(__FILE__
).'/survey/survey.inc.php';
45 $page->changeTpl('survey/index.tpl');
46 $page->assign('survey_current', Survey
::retrieveList('c'));
47 $page->assign('survey_old', Survey
::retrieveList('o'));
48 $page->assign('survey_modes', Survey
::getModes(false
));
52 // {{{ function handler_vote() : handles the vote to a survey
53 function handler_vote(&$page, $id = -1)
55 if (Post
::has('survey_cancel')) { // if the user cancels, returns to index
56 return $this->handler_index(&$page);
60 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", '');
62 require_once dirname(__FILE__
).'/survey/survey.inc.php';
63 $survey = Survey
::retrieveSurvey($id); // retrieves the survey object structure
64 if ($survey == null ||
!$survey->isValid()) {
65 return $this->show_error($page, "Sondage ".$id." introuvable.", '');
66 } elseif ($survey->isEnded()) {
67 return $this->show_error($page, "Le sondage ".$survey->getTitle()." est terminé.");
69 if (!$this->check_surveyPerms($page, $survey)) {
72 if (Post
::has('survey_submit')) { // checks if the survey has already been filled in
74 if (!$survey->isMode(Survey
::MODE_ALL
)) { // if survey is restriced to alumni
76 if ($survey->hasVoted($uid)) { // checks whether the user has already voted
77 return $this->show_error($page, "Tu as déjà voté à ce sondage.");
80 $survey->vote($uid, Post
::v('survey'.$id)); // performs vote
81 $this->show_success($page, "Ta réponse a bien été prise en compte. Merci d'avoir participé à ce sondage.", '');
82 } else { // offers to fill in the survey
83 if ($survey->isMode(Survey
::MODE_ALL
) ||
!$survey->hasVoted(S
::v('uid'))) {
84 $page->assign('survey_votemode', true
);
86 $page->assign('survey_warning', "Tu as déjà voté à ce sondage.");
88 //$page->assign('survey_id', $id);
89 $this->show_survey($page, $survey);
94 // {{{ function handler_result() : show the results of the votes to a survey
95 function handler_result($page, $id = -1, $show = 'all')
99 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", '');
101 require_once dirname(__FILE__
).'/survey/survey.inc.php';
102 $survey = Survey
::retrieveSurvey($id); // retrieves the survey object structure
103 if ($survey == null ||
!$survey->isValid()) {
104 return $this->show_error($page, "Sondage ".$id." introuvable.", '');
105 } elseif (!$survey->isEnded()) {
106 return $this->show_error($page, "Le sondage ".$survey->getTitle()." n'est pas encore terminé.");
108 if (!$this->check_surveyPerms($page, $survey)) {
111 if ($show == 'csv') {
112 header('Content-Type: text/csv; charset="UTF-8"');
113 echo $survey->toCSV();
116 $page->assign('survey_resultmode', true
);
117 $this->show_survey($page, $survey);
122 // {{{ function handler_admin() : index of admin mode
123 function handler_admin(&$page, $id = -1)
125 require_once dirname(__FILE__
).'/survey/survey.inc.php';
126 $this->clear_session();
128 $page->changeTpl('survey/admin.tpl');
129 $page->assign('survey_waiting', Survey
::retrieveList('w'));
130 $page->assign('survey_current', Survey
::retrieveList('c'));
131 $page->assign('survey_old', Survey
::retrieveList('o'));
132 $page->assign('survey_modes', Survey
::getModes(false
));
135 $survey = Survey
::retrieveSurvey($id); // retrieves all survey object structure
136 if ($survey == null
) {
137 $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
139 $page->assign('survey_adminmode', true
);
140 $this->show_survey($page, $survey);
145 // {{{ function handler_adminEdit() : edits a survey in admin mode
146 function handler_adminEdit(&$page, $id = -1)
149 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
152 require_once dirname(__FILE__
).'/survey/survey.inc.php';
153 $survey = Survey
::retrieveSurvey($id); // retrieves the survey in database
154 $this->clear_session(); // cleans session (in case there would have been a problem before)
155 $this->store_session($survey, $id);
156 $this->handler_edit($page, 'show'); // calls handler_edit, but in admin mode since 'survey_id' is in session
160 // {{{ function handler_adminValidate() : validates a survey (admin mode)
161 function handler_adminValidate(&$page, $id = -1)
163 $id = Post
::i('survey_id', $id);
164 if (Post
::has('survey_cancel')) { // if the admin cancels the validation, returns to the admin index
165 $this->clear_session();
166 return $this->handler_admin(&$page, $id);
169 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
172 require_once dirname(__FILE__
).'/survey/survey.inc.php';
173 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
174 if ($surveyInfo == null
) {
175 return $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
177 if (Post
::has('survey_submit')) { // needs a confirmation before validation
178 if (Survey
::validateSurvey($id)) { // validates the survey (in the database)
179 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été validé, les votes sont maintenant ouverts.", 'admin');
181 $this->show_error($page, '', 'admin');
183 } else { // asks for a confirmation
184 $this->show_confirm($page, "Êtes-vous certain de vouloir valider le sondage \"".$surveyInfo['title']."\" ? "
185 ."Les votes seront immédiatement ouverts.", 'admin/valid', array('id' => $id));
190 // {{{ function handler_adminDelete() : deletes a survey (admin mode)
191 function handler_adminDelete(&$page, $id = -1)
193 $id = Post
::i('survey_id', $id);
194 if (Post
::has('survey_cancel')) { // if the admin cancels the suppression, returns to the admin index
195 return $this->handler_admin(&$page, $id);
198 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
201 require_once dirname(__FILE__
).'/survey/survey.inc.php';
202 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
203 if ($surveyInfo == null
) {
204 return $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
206 if (Post
::has('survey_submit')) { // needs a confirmation before suppression
207 if (Survey
::deleteSurvey($id)) { // deletes survey in database
208 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été supprimé, ainsi que tous les votes le concernant.", 'admin');
210 $this->show_error($page, '', 'admin');
212 } else { // asks for a confirmation
213 $this->show_confirm($page, "Êtes-vous certain de vouloir supprimer le sondage \"".$surveyInfo['title']."\" ?", 'admin/del', array('id' => $id));
218 // {{{ function handler_edit() : edits a survey (in normal mode unless called by handler_adminEdit() )
219 function handler_edit(&$page, $action = 'show', $qid = 'root')
221 require_once dirname(__FILE__
).'/survey/survey.inc.php';
222 $action = Post
::v('survey_action', $action);
223 $qid = Post
::v('survey_qid', $qid);
224 if (Post
::has('survey_cancel')) { // after cancelling changes, shows the survey
225 if (S
::has('survey')) {
227 } else { // unless no editing has been done at all (shows to the surveys index page)
228 return $this->handler_index($page);
231 $page->assign('survey_editmode', true
);
232 if (S
::has('survey_id')) { // if 'survey_id' is in session, it means we are modifying a survey in admin mode
233 $page->assign('survey_updatemode', true
);
235 if ($action == 'show' && !S
::has('survey')) {
238 if ($action == 'question') { // {{{ modifies an existing question
239 if (Post
::has('survey_submit')) { // if the form has been submitted, makes the modifications
240 $survey = unserialize(S
::v('survey'));
241 $args = Post
::v('survey_question');
242 if (!$survey->editQuestion($qid, $args)) { // update the survey object structure
243 return $this->show_error($page, '', 'edit');
245 $this->show_survey($page, $survey);
246 $this->store_session($survey);
247 } else { // if a form has not been submitted, shows modification form
248 $survey = unserialize(S
::v('survey'));
249 $current = $survey->toArray($qid); // gets the current parameters of the question
250 if ($current == null
) {
251 return $this->show_error($page, '', 'edit');
253 $this->show_form($page, $action, $qid, $current['type'], $current);
255 } elseif ($action == 'new') { // {{{ create a new survey : actually store the root question
256 if (Post
::has('survey_submit')) { // if the form has been submitted, creates the survey
257 $this->clear_session();
258 $survey = new Survey(Post
::v('survey_question')); // creates the object structure
259 $this->show_survey($page, $survey);
260 $this->store_session($survey);
262 $this->clear_session();
263 $this->show_form($page, $action, 'root', 'root');
265 } elseif ($action == 'add') { // {{{ adds a new question
266 if (Post
::has('survey_submit')) { // if the form has been submitted, adds the question
267 $survey = unserialize(S
::v('survey'));
268 if (!$survey->addQuestion($qid, $survey->factory(Post
::v('survey_type'), Post
::v('survey_question')))) {
269 return $this->show_error($page, '', 'edit');
271 $this->show_survey($page, $survey);
272 $this->store_session($survey);
274 $this->show_form($page, $action, $qid);
276 } elseif ($action == 'del') { // {{{ deletes a question
277 if (Post
::has('survey_submit')) { // if a confirmation has been sent, deletes the question
278 $survey = unserialize(S
::v('survey'));
279 if (!$survey->delQuestion(Post
::v('survey_qid'))) { // deletes the node in the survey object structure
280 return $this->show_error($page, '', 'edit');
282 $this->show_survey($page, $survey);
283 $this->store_session($survey);
284 } else { // if user has not confirmed, shows a confirmation form
285 $survey = unserialize(S
::v('survey'));
286 $current = $survey->toArray($qid); // needed to get the title of the question to delete (more user-friendly than an id)
287 if ($current == null
) {
288 return $this->show_error($page, '', 'edit');
290 $this->show_confirm($page, 'Êtes-vous certain de vouloir supprimer la question intitulé "'.$current['question'].'" ? '
291 .'Attention, cela supprimera en même temps toutes les questions qui dépendent de celle-ci.',
292 'edit', array('action' => 'del', 'qid' => $qid));
294 } elseif ($action == 'show') { // {{{ simply shows the survey in its current state
295 $this->show_survey($page, unserialize(S
::v('survey'))); // }}}
296 } elseif ($action == 'valid') { // {{{ validates the proposition, i.e stores the proposition in the database
297 // but an admin will still need to validate the survey before it is activated
298 if (Post
::has('survey_submit')) { // needs a confirmation before storing the proposition
299 $survey = unserialize(S
::v('survey'));
300 if (S
::has('survey_id')) { // if 'survey_id' is in session, we are modifying an existing survey (in admin mode) instead of proposing a new one
301 if ($survey->updateSurvey()) { // updates the database according the new survey object structure
302 $this->show_success($page, "Les modifications sur le sondage ont bien été enregistrées.", 'admin');
304 $this->show_error($page, '', 'admin');
306 } else { // if no 'survey_id' is in session, we are indeed proposing a new survey
307 if ($survey->proposeSurvey()) { // stores the survey object structure in database
308 $this->show_success($page, "Votre proposition de sondage a bien été enregistrée,
309 elle est en attent de validation par un administrateur du site.", '');
311 $this->show_error($page);
314 $this->clear_session();
315 } else { // asks for a confirmation if it has not been sent
316 $survey = unserialize(S
::v('survey'));
317 $errors = $survey->checkSyntax();
318 if (!is_null($errors)) {
319 $this->show_error($page, "", 'edit', $errors);
321 if (S
::has('survey_id')) {
322 $this->show_confirm($page, "Veuillez confirmer l'enregistrement des modifications apportées à ce sondage", 'edit', array('action' => 'valid'));
324 $this->show_confirm($page, "Veuillez confirmer l'envoi de cette proposition de sondage.", 'edit', array('action' => 'valid'));
328 } elseif ($action == 'cancel') { // {{{ cancels the creation/modification of a survey
329 if (Post
::has('survey_submit')) { // needs a confirmation
330 if (S
::has('survey_id')) { // only possible when modifying a survey in admin mode, still this should be considered again,
331 $this->clear_session(); // maybe some name with "admin" in it, "survey_adminid" or anything that might not be confusing.
332 return $this->handler_admin($page); // in this case, shows the admin index
334 $this->clear_session(); // cleans session
335 return $this->handler_index($page); // else shows the 'normal' index
337 } else { // asks for a confirmation if it has not been sent
338 $this->show_confirm(&$page, "Êtes-vous certain de vouloir annuler totalement l'édition de ce sondage ? Attention, "
339 ."toutes les données éditées jusque lâ seront définitivement perdues.",
340 'edit', array('action' => $action));
346 // {{{ function handler_ajax() : some ajax in editing a new question (for now, there may be a little more later)
347 function handler_ajax(&$page, $type)
349 require_once dirname(__FILE__
).'/survey/survey.inc.php';
350 header('Content-Type: text/html; charset="UTF-8"');
351 if (Survey
::isType($type)) { // when type has been chosen, the form is updated to fit exactly the type of question chosen
352 $page->changeTpl('survey/edit_new.tpl', NO_SKIN
);
353 $page->assign('survey_types', Survey
::getTypes());
354 $page->assign('survey_type', $type);
359 // {{{ function clear_session() : clears the data stored in session
360 function clear_session()
363 S
::kill('survey_id');
367 // {{{ function store_session() : serializes and stores survey (and survey_id) in session
368 function store_session($survey, $survey_id = -1)
370 $_SESSION['survey'] = serialize($survey);
371 if ($survey_id != -1) {
372 $_SESSION['survey_id'] = $survey_id;
377 // {{{ function check_surveyPerms() : checks the particular surveys access permissions
378 function check_surveyPerms(&$page, $survey)
380 require_once dirname(__FILE__
).'/survey/survey.inc.php';
381 if (!$survey->isMode(Survey
::MODE_ALL
)) { // if the survey is reserved to alumni
383 if (!call_user_func(array($globals->session
, 'doAuth'))) { // checks authentification
385 $platal->force_login($page);
387 if (!$survey->checkPromo(S
::v('promo'))) { // checks promotion
388 $this->show_error($page, "Tu n'as pas accès à ce sondage car il est réservé à d'autres promotions.");
396 // {{{ function show_survey() : calls the template to display a survey, for editing, voting, or consulting the results
397 function show_survey(&$page, $survey)
399 $page->changeTpl('survey/show_root.tpl');
400 $page->assign('survey', $survey->toArray());
401 $page->assign('survey_modes', Survey
::getModes());
405 // {{{ function show_form() : calls the template to display the editing form
406 function show_form(&$page, $action, $qid, $type = 'new', $current = null
)
408 $page->changeTpl('survey/edit_survey.tpl');
409 $page->assign('survey_action', $action);
410 $page->assign('survey_qid', $qid);
411 $page->assign('survey_formaction', './survey/edit');
412 $page->assign('survey_type', $type);
413 if (!is_null($current) && is_array($current)) {
414 $page->assign('survey_current', $current);
415 } elseif ($type == 'new') {
416 $page->addJsLink('ajax.js');
417 $page->assign('survey_types', Survey
::getTypes());
419 if ($type == 'root') {
420 $page->assign('survey_modes', Survey
::getModes());
425 // {{{ function show_confirm() : calls the template to display a confirm form
426 function show_confirm(&$page, $message, $formaction, $formhidden = null
)
428 $page->changeTpl('survey/confirm.tpl');
429 $page->assign('survey_message', $message);
430 $page->assign('survey_formaction', './survey/'.$formaction);
431 $page->assign('survey_formhidden', $formhidden);
435 // {{{ function show_error() : calls the template to display an error message
436 function show_error(&$page, $message, $link = "", $errArray = null
)
438 $page->changeTpl('survey/error.tpl');
439 $page->assign('survey_message', $message);
440 $page->assign('survey_link', './survey/'.$link); // 'return' link to let the user leave the page
441 if (!is_null($errArray)) {
442 $page->assign('survey_errors', $errArray);
447 // {{{ function show_success() : calls the template to display a success message
448 function show_success(&$page, $message = "", $link = "")
450 $page->changeTpl('survey/success.tpl');
451 $page->assign('survey_message', $message);
452 $page->assign('survey_link', './survey/'.$link); // 'return' link to let the user leave the page
457 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: