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, $qid = '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 $page->assign('survey_resultmode', true
);
112 $this->show_survey($page, $survey);
116 // {{{ function handler_admin() : index of admin mode
117 function handler_admin(&$page, $id = -1)
119 require_once dirname(__FILE__
).'/survey/survey.inc.php';
120 $this->clear_session();
122 $page->changeTpl('survey/admin.tpl');
123 $page->assign('survey_waiting', Survey
::retrieveList('w'));
124 $page->assign('survey_current', Survey
::retrieveList('c'));
125 $page->assign('survey_old', Survey
::retrieveList('o'));
126 $page->assign('survey_modes', Survey
::getModes(false
));
128 $survey = Survey
::retrieveSurvey($id); // retrieves all survey object structure
129 if ($survey == null
) {
130 $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
132 $page->assign('survey_adminmode', true
);
133 $this->show_survey($page, $survey);
138 // {{{ function handler_adminEdit() : edits a survey in admin mode
139 function handler_adminEdit(&$page, $id = -1)
142 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
144 require_once dirname(__FILE__
).'/survey/survey.inc.php';
145 $survey = Survey
::retrieveSurvey($id); // retrieves the survey in database
146 $this->clear_session(); // cleans session (in case there would have been a problem before)
147 $this->store_session($survey, $id);
148 $this->handler_edit($page, 'show'); // calls handler_edit, but in admin mode since 'survey_id' is in session
152 // {{{ function handler_adminValidate() : validates a survey (admin mode)
153 function handler_adminValidate(&$page, $id = -1)
155 $id = Post
::i('survey_id', $id);
156 if (Post
::has('survey_cancel')) { // if the admin cancels the validation, returns to the admin index
157 $this->clear_session();
158 return $this->handler_admin(&$page, $id);
161 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
163 require_once dirname(__FILE__
).'/survey/survey.inc.php';
164 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
165 if ($surveyInfo == null
) {
166 return $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
168 if (Post
::has('survey_submit')) { // needs a confirmation before validation
169 if (Survey
::validateSurvey($id)) { // validates the survey (in the database)
170 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été validé, les votes sont maintenant ouverts.", 'admin');
172 $this->show_error($page, '', 'admin');
174 } else { // asks for a confirmation
175 $this->show_confirm($page, "Êtes-vous certain de vouloir valider le sondage \"".$surveyInfo['title']."\" ? "
176 ."Les votes seront immédiatement ouverts.", 'admin/valid', array('id' => $id));
181 // {{{ function handler_adminDelete() : deletes a survey (admin mode)
182 function handler_adminDelete(&$page, $id = -1)
184 $id = Post
::i('survey_id', $id);
185 if (Post
::has('survey_cancel')) { // if the admin cancels the suppression, returns to the admin index
186 return $this->handler_admin(&$page, $id);
189 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'admin');
191 require_once dirname(__FILE__
).'/survey/survey.inc.php';
192 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
193 if ($surveyInfo == null
) {
194 return $this->show_error($page, "Sondage ".$id." introuvable.", 'admin');
196 if (Post
::has('survey_submit')) { // needs a confirmation before suppression
197 if (Survey
::deleteSurvey($id)) { // deletes survey in database
198 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été supprimé, ainsi que tous les votes le concernant.", 'admin');
200 $this->show_error($page, '', 'admin');
202 } else { // asks for a confirmation
203 $this->show_confirm($page, "Êtes-vous certain de vouloir supprimer le sondage \"".$surveyInfo['title']."\" ?", 'admin/del', array('id' => $id));
208 // {{{ function handler_edit() : edits a survey (in normal mode unless called by handler_adminEdit() )
209 function handler_edit(&$page, $action = 'show', $qid = 'root')
211 require_once dirname(__FILE__
).'/survey/survey.inc.php';
212 $action = Post
::v('survey_action', $action);
213 $qid = Post
::v('survey_qid', $qid);
214 if (Post
::has('survey_cancel')) { // after cancelling changes, shows the survey
215 if (S
::has('survey')) {
217 } else { // unless no editing has been done at all (shows to the surveys index page)
218 return $this->handler_index($page);
221 $page->assign('survey_editmode', true
);
222 if (S
::has('survey_id')) { // if 'survey_id' is in session, it means we are modifying a survey in admin mode
223 $page->assign('survey_updatemode', true
);
225 if ($action == 'show' && !S
::has('survey')) {
228 if ($action == 'question') { // {{{ modifies an existing question
229 if (Post
::has('survey_submit')) { // if the form has been submitted, makes the modifications
230 $survey = unserialize(S
::v('survey'));
231 $args = Post
::v('survey_question');
232 if (!$survey->editQuestion($qid, $args)) { // update the survey object structure
233 return $this->show_error($page, '', 'edit');
235 $this->show_survey($page, $survey);
236 $this->store_session($survey);
237 } else { // if a form has not been submitted, shows modification form
238 $survey = unserialize(S
::v('survey'));
239 $current = $survey->toArray($qid); // gets the current parameters of the question
240 if ($current == null
) {
241 return $this->show_error($page, '', 'edit');
243 $this->show_form($page, $action, $qid, $current['type'], $current);
245 } elseif ($action == 'new') { // {{{ create a new survey : actually store the root question
246 if (Post
::has('survey_submit')) { // if the form has been submitted, creates the survey
247 $this->clear_session();
248 $survey = new Survey(Post
::v('survey_question')); // creates the object structure
249 $this->show_survey($page, $survey);
250 $this->store_session($survey);
252 $this->clear_session();
253 $this->show_form($page, $action, 'root', 'root');
255 } elseif ($action == 'add') { // {{{ adds a new question
256 if (Post
::has('survey_submit')) { // if the form has been submitted, adds the question
257 $survey = unserialize(S
::v('survey'));
258 if (!$survey->addQuestion($qid, $survey->factory(Post
::v('survey_type'), Post
::v('survey_question')))) {
259 return $this->show_error($page, '', 'edit');
261 $this->show_survey($page, $survey);
262 $this->store_session($survey);
264 $this->show_form($page, $action, $qid);
266 } elseif ($action == 'del') { // {{{ deletes a question
267 if (Post
::has('survey_submit')) { // if a confirmation has been sent, deletes the question
268 $survey = unserialize(S
::v('survey'));
269 if (!$survey->delQuestion(Post
::v('survey_qid'))) { // deletes the node in the survey object structure
270 return $this->show_error($page, '', 'edit');
272 $this->show_survey($page, $survey);
273 $this->store_session($survey);
274 } else { // if user has not confirmed, shows a confirmation form
275 $survey = unserialize(S
::v('survey'));
276 $current = $survey->toArray($qid); // needed to get the title of the question to delete (more user-friendly than an id)
277 if ($current == null
) {
278 return $this->show_error($page, '', 'edit');
280 $this->show_confirm($page, 'Êtes-vous certain de vouloir supprimer la question intitulé "'.$current['question'].'" ? '
281 .'Attention, cela supprimera en même temps toutes les questions qui dépendent de celle-ci.',
282 'edit', array('action' => 'del', 'qid' => $qid));
284 } elseif ($action == 'show') { // {{{ simply shows the survey in its current state
285 $this->show_survey($page, unserialize(S
::v('survey'))); // }}}
286 } elseif ($action == 'valid') { // {{{ validates the proposition, i.e stores the proposition in the database
287 // but an admin will still need to validate the survey before it is activated
288 if (Post
::has('survey_submit')) { // needs a confirmation before storing the proposition
289 $survey = unserialize(S
::v('survey'));
290 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
291 if ($survey->updateSurvey()) { // updates the database according the new survey object structure
292 $this->show_success($page, "Les modifications sur le sondage ont bien été enregistrées.", 'admin');
294 $this->show_error($page, '', 'admin');
296 } else { // if no 'survey_id' is in session, we are indeed proposing a new survey
297 if ($survey->proposeSurvey()) { // stores the survey object structure in database
298 $this->show_success($page, "Votre proposition de sondage a bien été enregistrée,
299 elle est en attent de validation par un administrateur du site.", '');
301 $this->show_error($page);
304 $this->clear_session();
305 } else { // asks for a confirmation if it has not been sent
306 $survey = unserialize(S
::v('survey'));
307 $errors = $survey->checkSyntax();
308 if (!is_null($errors)) {
309 $this->show_error($page, "", 'edit', $errors);
311 if (S
::has('survey_id')) {
312 $this->show_confirm($page, "Veuillez confirmer l'enregistrement des modifications apportées à ce sondage", 'edit', array('action' => 'valid'));
314 $this->show_confirm($page, "Veuillez confirmer l'envoi de cette proposition de sondage.", 'edit', array('action' => 'valid'));
318 } elseif ($action == 'cancel') { // {{{ cancels the creation/modification of a survey
319 if (Post
::has('survey_submit')) { // needs a confirmation
320 if (S
::has('survey_id')) { // only possible when modifying a survey in admin mode, still this should be considered again,
321 $this->clear_session(); // maybe some name with "admin" in it, "survey_adminid" or anything that might not be confusing.
322 return $this->handler_admin($page); // in this case, shows the admin index
324 $this->clear_session(); // cleans session
325 return $this->handler_index($page); // else shows the 'normal' index
327 } else { // asks for a confirmation if it has not been sent
328 $this->show_confirm(&$page, "Êtes-vous certain de vouloir annuler totalement l'édition de ce sondage ? Attention, "
329 ."toutes les données éditées jusque lâ seront définitivement perdues.",
330 'edit', array('action' => $action));
336 // {{{ function handler_ajax() : some ajax in editing a new question (for now, there may be a little more later)
337 function handler_ajax(&$page, $type)
339 require_once dirname(__FILE__
).'/survey/survey.inc.php';
340 header('Content-Type: text/html; charset="UTF-8"');
341 if (Survey
::isType($type)) { // when type has been chosen, the form is updated to fit exactly the type of question chosen
342 $page->changeTpl('survey/edit_new.tpl', NO_SKIN
);
343 $page->assign('survey_types', Survey
::getTypes());
344 $page->assign('survey_type', $type);
349 // {{{ function clear_session() : clears the data stored in session
350 function clear_session()
353 S
::kill('survey_id');
357 // {{{ function store_session() : serializes and stores survey (and survey_id) in session
358 function store_session($survey, $survey_id = -1)
360 $_SESSION['survey'] = serialize($survey);
361 if ($survey_id != -1) {
362 $_SESSION['survey_id'] = $survey_id;
367 // {{{ function check_surveyPerms() : checks the particular surveys access permissions
368 function check_surveyPerms(&$page, $survey)
370 require_once dirname(__FILE__
).'/survey/survey.inc.php';
371 if (!$survey->isMode(Survey
::MODE_ALL
)) { // if the survey is reserved to alumni
373 if (!call_user_func(array($globals->session
, 'doAuth'))) { // checks authentification
375 $platal->force_login($page);
377 if (!$survey->checkPromo(S
::v('promo'))) { // checks promotion
378 $this->show_error($page, "Tu n'as pas accès à ce sondage car il est réservé à d'autres promotions.");
386 // {{{ function show_survey() : calls the template to display a survey, for editing, voting, or consulting the results
387 function show_survey(&$page, $survey)
389 $page->changeTpl('survey/show_root.tpl');
390 $page->assign('survey', $survey->toArray());
391 $page->assign('survey_modes', Survey
::getModes());
395 // {{{ function show_form() : calls the template to display the editing form
396 function show_form(&$page, $action, $qid, $type = 'new', $current = null
)
398 $page->changeTpl('survey/edit_survey.tpl');
399 $page->assign('survey_action', $action);
400 $page->assign('survey_qid', $qid);
401 $page->assign('survey_formaction', './survey/edit');
402 $page->assign('survey_type', $type);
403 if (!is_null($current) && is_array($current)) {
404 $page->assign('survey_current', $current);
405 } elseif ($type == 'new') {
406 $page->addJsLink('ajax.js');
407 $page->assign('survey_types', Survey
::getTypes());
409 if ($type == 'root') {
410 $page->assign('survey_modes', Survey
::getModes());
415 // {{{ function show_confirm() : calls the template to display a confirm form
416 function show_confirm(&$page, $message, $formaction, $formhidden = null
)
418 $page->changeTpl('survey/confirm.tpl');
419 $page->assign('survey_message', $message);
420 $page->assign('survey_formaction', './survey/'.$formaction);
421 $page->assign('survey_formhidden', $formhidden);
425 // {{{ function show_error() : calls the template to display an error message
426 function show_error(&$page, $message, $link = "", $errArray = null
)
428 $page->changeTpl('survey/error.tpl');
429 $page->assign('survey_message', $message);
430 $page->assign('survey_link', './survey/'.$link); // 'return' link to let the user leave the page
431 if (!is_null($errArray)) {
432 $page->assign('survey_errors', $errArray);
437 // {{{ function show_success() : calls the template to display a success message
438 function show_success(&$page, $message = "", $link = "")
440 $page->changeTpl('survey/success.tpl');
441 $page->assign('survey_message', $message);
442 $page->assign('survey_link', './survey/'.$link); // 'return' link to let the user leave the page
447 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: