2 /***************************************************************************
3 * Copyright (C) 2003-2011 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 $this->load('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é.", 'survey');
62 $this->load('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.", 'survey');
66 } elseif ($survey->isEnded()) {
67 return $this->show_error($page, "Le sondage ".$survey->getTitle()." est terminé.", 'survey');
69 if (!$this->check_surveyPerms($page, $survey)) {
72 if (Post
::has('survey_submit')) { // checks if the survey has already been filled in
73 // admins can see the survey but not vote
74 if (!$this->check_surveyPerms($page, $survey, false
, false
)) {
78 if (!$survey->isMode(Survey
::MODE_ALL
)) { // if survey is restriced to alumni
80 if ($survey->hasVoted($uid)) { // checks whether the user has already voted
81 return $this->show_error($page, "Tu as déjà voté à ce sondage.", 'survey');
84 $survey->vote($uid, Post
::v('survey'.$id)); // performs vote
85 $this->show_success($page, "Ta réponse a bien été prise en compte. Merci d'avoir participé à ce sondage.", 'survey');
86 } else { // offers to fill in the survey
87 if ($survey->isMode(Survey
::MODE_ALL
) ||
!$survey->hasVoted(S
::v('uid'))) {
88 $page->assign('survey_votemode', true
);
90 $page->assign('survey_warning', "Tu as déjà voté à ce sondage.");
92 //$page->assign('survey_id', $id);
93 $this->show_survey($page, $survey);
98 // {{{ function handler_result() : show the results of the votes to a survey
99 function handler_result($page, $id = -1, $show = 'all')
103 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'survey');
105 $this->load('survey.inc.php');
106 $survey = Survey
::retrieveSurvey($id); // retrieves the survey object structure
107 if ($survey == null ||
!$survey->isValid()) {
108 return $this->show_error($page, "Sondage ".$id." introuvable.", 'survey');
109 } elseif (!$survey->isEnded() && !$survey->canSeeEarlyResults(S
::user())) {
110 return $this->show_error($page, "Le sondage ".$survey->getTitle()." n'est pas encore terminé.", 'survey');
112 if (!$survey->canSeeEarlyResults(S
::user()) && !$this->check_surveyPerms($page, $survey)) {
115 if ($show == 'csv') {
116 pl_content_headers("text/csv");
117 header('Content-Disposition: attachment; filename="'.addslashes($survey->getTitle()).'.csv"');
118 echo $survey->toCSV();
121 $page->assign('survey_resultmode', true
);
122 $this->show_survey($page, $survey);
127 // {{{ function handler_admin() : index of admin mode
128 function handler_admin(&$page, $id = -1)
130 $this->load('survey.inc.php');
131 $this->clear_session();
133 $page->changeTpl('survey/admin.tpl');
134 $page->assign('survey_waiting', Survey
::retrieveList('w'));
135 $page->assign('survey_current', Survey
::retrieveList('c'));
136 $page->assign('survey_old', Survey
::retrieveList('o'));
137 $page->assign('survey_modes', Survey
::getModes(false
));
140 $survey = Survey
::retrieveSurvey($id); // retrieves all survey object structure
141 if ($survey == null
) {
142 $this->show_error($page, "Sondage ".$id." introuvable.", 'survey/admin');
144 $page->assign('survey_adminmode', true
);
145 $this->show_survey($page, $survey);
150 // {{{ function handler_adminEdit() : edits a survey in admin mode
151 function handler_adminEdit(&$page, $id = -1, $req = -1)
153 if ($id == -1 ||
($id == 'req' && $req == -1)) {
154 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'survey/admin');
156 $this->load('survey.inc.php');
157 $this->clear_session(); // cleans session (in case there would have been a problem before)
159 $survey = Survey
::retrieveSurveyReq($req);
160 if ($survey == null
) {
161 return $this->show_error($page, "Sondage introuvable.", 'survey/admin');
163 $this->store_session($survey, $req, true
);
166 $survey = Survey
::retrieveSurvey($id); // retrieves the survey in database
167 if ($survey == null
) {
168 return $this->show_error($page, "Sondage ".$id." introuvable.", 'survey/admin');
170 $this->store_session($survey, $id);
172 $this->handler_edit($page, 'show'); // calls handler_edit, but in admin mode since 'survey_id' is in session
176 // {{{ function handler_adminValidate() : validates a survey (admin mode)
177 function handler_adminValidate(&$page, $id = -1)
179 $id = Post
::i('survey_id', $id);
180 if (Post
::has('survey_cancel')) { // if the admin cancels the validation, returns to the admin index
181 $this->clear_session();
182 return $this->handler_admin(&$page, $id);
185 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'survey/admin');
188 $this->load('survey.inc.php');
189 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
190 if ($surveyInfo == null
) {
191 return $this->show_error($page, "Sondage ".$id." introuvable.", 'survey/admin');
193 if (Post
::has('survey_submit')) { // needs a confirmation before validation
194 if (Survey
::validateSurvey($id)) { // validates the survey (in the database)
195 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été validé, les votes sont maintenant ouverts.", 'survey/admin');
197 $this->show_error($page, '', 'survey/admin');
199 } else { // asks for a confirmation
200 $this->show_confirm($page, "Êtes-vous certain de vouloir valider le sondage \"".$surveyInfo['title']."\" ? "
201 ."Les votes seront immédiatement ouverts.", 'admin/valid', array('id' => $id));
206 // {{{ function handler_adminDelete() : deletes a survey (admin mode)
207 function handler_adminDelete(&$page, $id = -1)
209 $id = Post
::i('survey_id', $id);
210 if (Post
::has('survey_cancel')) { // if the admin cancels the suppression, returns to the admin index
211 return $this->handler_admin(&$page, $id);
214 return $this->show_error($page, "Un identifiant de sondage doit être précisé.", 'survey/admin');
217 $this->load('survey.inc.php');
218 $surveyInfo = Survey
::retrieveSurveyInfo($id); // retrieves information about the survey (does not retrieve and unserialize the object structure)
219 if ($surveyInfo == null
) {
220 return $this->show_error($page, "Sondage ".$id." introuvable.", 'survey/admin');
222 if (Post
::has('survey_submit')) { // needs a confirmation before suppression
223 if (Survey
::deleteSurvey($id)) { // deletes survey in database
224 $this->show_success($page, "Le sondage \"".$surveyInfo['title']."\" a bien été supprimé, ainsi que tous les votes le concernant.", 'survey/admin');
226 $this->show_error($page, '', 'survey/admin');
228 } else { // asks for a confirmation
229 $this->show_confirm($page, "Êtes-vous certain de vouloir supprimer le sondage \"".$surveyInfo['title']."\" ?", 'admin/del', array('id' => $id));
234 // {{{ function handler_edit() : edits a survey (in normal mode unless called by handler_adminEdit() )
235 function handler_edit(&$page, $action = 'show', $qid = 'root')
237 $this->load('survey.inc.php');
238 $action = Post
::v('survey_action', $action);
239 $qid = Post
::v('survey_qid', $qid);
240 if (Post
::has('survey_cancel')) { // after cancelling changes, shows the survey
241 if (S
::has('survey')) {
243 } else { // unless no editing has been done at all (shows to the surveys index page)
244 return $this->handler_index($page);
247 $page->assign('survey_editmode', true
);
248 if (S
::has('survey_id')) { // if 'survey_id' is in session, it means we are modifying a survey in admin mode
249 $page->assign('survey_updatemode', true
);
251 if ($action == 'show' && !S
::has('survey')) {
254 if ($action == 'question') { // {{{ modifies an existing question
255 if (Post
::has('survey_submit')) { // if the form has been submitted, makes the modifications
256 $survey = unserialize(S
::v('survey'));
257 $args = Post
::v('survey_question');
258 if (!$survey->editQuestion($qid, $args)) { // update the survey object structure
259 return $this->show_error($page, '', 'survey/edit');
261 $this->show_survey($page, $survey);
262 $this->store_session($survey);
263 } else { // if a form has not been submitted, shows modification form
264 $survey = unserialize(S
::v('survey'));
265 $current = $survey->toArray($qid); // gets the current parameters of the question
266 if ($current == null
) {
267 return $this->show_error($page, '', 'survey/edit');
269 $this->show_form($page, $action, $qid, $current['type'], $current);
271 } elseif ($action == 'new') { // {{{ create a new survey : actually store the root question
272 if (Post
::has('survey_submit')) { // if the form has been submitted, creates the survey
273 $this->clear_session();
274 $survey = new Survey(Post
::v('survey_question')); // creates the object structure
275 $this->show_survey($page, $survey);
276 $this->store_session($survey);
278 $this->clear_session();
279 $this->show_form($page, $action, 'root', 'newsurvey');
281 } elseif ($action == 'add') { // {{{ adds a new question
282 if (Post
::has('survey_submit')) { // if the form has been submitted, adds the question
283 $survey = unserialize(S
::v('survey'));
284 if (!$survey->addQuestion($qid, $survey->factory(Post
::v('survey_type'), Post
::v('survey_question')))) {
285 return $this->show_error($page, '', 'survey/edit');
287 $this->show_survey($page, $survey);
288 $this->store_session($survey);
290 $this->show_form($page, $action, $qid);
292 } elseif ($action == 'del') { // {{{ deletes a question
293 if (Post
::has('survey_submit')) { // if a confirmation has been sent, deletes the question
294 $survey = unserialize(S
::v('survey'));
295 if (!$survey->delQuestion(Post
::v('survey_qid'))) { // deletes the node in the survey object structure
296 return $this->show_error($page, '', 'survey/edit');
298 $this->show_survey($page, $survey);
299 $this->store_session($survey);
300 } else { // if user has not confirmed, shows a confirmation form
301 $survey = unserialize(S
::v('survey'));
302 $current = $survey->toArray($qid); // needed to get the title of the question to delete (more user-friendly than an id)
303 if ($current == null
) {
304 return $this->show_error($page, '', 'survey/edit');
306 $this->show_confirm($page, 'Êtes-vous certain de vouloir supprimer la question intitulé "'.$current['question'].'" ? '
307 .'Attention, cela supprimera en même temps toutes les questions qui dépendent de celle-ci.',
308 'edit', array('action' => 'del', 'qid' => $qid));
310 } elseif ($action == 'show') { // {{{ simply shows the survey in its current state
311 $this->show_survey($page, unserialize(S
::v('survey'))); // }}}
312 } elseif ($action == 'valid') { // {{{ validates the proposition, i.e stores the proposition in the database
313 // but an admin will still need to validate the survey before it is activated
314 if (Post
::has('survey_submit')) { // needs a confirmation before storing the proposition
315 $survey = unserialize(S
::v('survey'));
316 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
317 $link = (S
::has('survey_validate'))?
'admin/validate' : 'survey/admin';
318 if ($survey->updateSurvey()) { // updates the database according the new survey object structure
319 $this->show_success($page, "Les modifications sur le sondage ont bien été enregistrées.", $link);
321 $this->show_error($page, '', $link);
323 } else { // if no 'survey_id' is in session, we are indeed proposing a new survey
324 if ($survey->proposeSurvey()) { // stores the survey object structure in database
325 $this->show_success($page, "Votre proposition de sondage a bien été enregistrée,
326 elle est en attente de validation par un administrateur du site.", 'survey');
328 $this->show_error($page, '', 'survey');
331 $this->clear_session();
332 } else { // asks for a confirmation if it has not been sent
333 $survey = unserialize(S
::v('survey'));
334 $errors = $survey->checkSyntax();
335 if (!is_null($errors)) {
336 $this->show_error($page, "", 'survey/edit', $errors);
338 if (S
::has('survey_id')) {
339 $this->show_confirm($page, "Veuillez confirmer l'enregistrement des modifications apportées à ce sondage.", 'edit', array('action' => 'valid'));
341 $this->show_confirm($page, "Veuillez confirmer l'envoi de cette proposition de sondage.", 'edit', array('action' => 'valid'));
345 } elseif ($action == 'cancel') { // {{{ cancels the creation/modification of a survey
346 if (Post
::has('survey_submit')) { // needs a confirmation
347 if (S
::has('survey_id')) { // only possible when modifying a survey in admin mode
348 if (S
::has('survey_validate')) { // if a link has been supplied, uses it
349 $this->clear_session();
350 return $this->show_success($page, "Les modifications effectuées ont été annulées", 'admin/validate');
351 } else { // else shows the admin index
352 $this->clear_session();
353 return $this->handler_admin($page);
356 $this->clear_session();
357 return $this->handler_index($page); // else shows the 'normal' index
359 } else { // asks for a confirmation if it has not been sent
360 $this->show_confirm(&$page, "Êtes-vous certain de vouloir annuler totalement l'édition de ce sondage ? Attention, "
361 ."toutes les données éditées jusque là seront définitivement perdues.",
362 'edit', array('action' => $action));
368 // {{{ function handler_ajax() : some ajax in editing a new question (for now, there may be a little more later)
369 function handler_ajax(&$page, $type)
371 $this->load('survey.inc.php');
372 pl_content_headers("text/html");
373 if (Survey
::isType($type)) { // when type has been chosen, the form is updated to fit exactly the type of question chosen
374 $page->changeTpl('survey/edit_new.tpl', NO_SKIN
);
375 $page->assign('survey_types', Survey
::getTypes());
376 $page->assign('survey_type', $type);
381 // {{{ function clear_session() : clears the data stored in session
382 function clear_session()
385 S
::kill('survey_id');
386 S
::kill('survey_validate');
390 // {{{ function store_session() : serializes and stores survey (and survey_id) in session
391 function store_session($survey, $survey_id = -1, $survey_validate = false
)
393 $_SESSION['survey'] = serialize($survey);
394 if ($survey_id != -1) {
395 $_SESSION['survey_id'] = $survey_id;
397 if ($survey_validate) {
398 $_SESSION['survey_validate'] = true
;
403 // {{{ function check_surveyPerms() : checks the particular surveys access permissions
404 function check_surveyPerms(&$page, $survey, $silent = false
, $admin_allowed = true
)
406 $this->load('survey.inc.php');
407 if ($survey->isMode(Survey
::MODE_ALL
)) { // if the survey is not reserved to alumni
413 $profile = S
::user()->profile();
419 foreach ($profile->yearspromo() as $p) {
420 if ($survey->checkPromo($p)) {
428 if (S
::admin() && $admin_allowed) {
430 $page->trigWarning('Tu as accès à ce sondage car tu es administrateur du site.');
435 $page->kill("Tu n'as pas accès à ce sondage car il est réservé à d'autres promotions.");
441 // {{{ function show_survey() : calls the template to display a survey, for editing, voting, or consulting the results
442 function show_survey(&$page, $survey)
444 $page->changeTpl('survey/show_root.tpl');
445 $page->assign('survey', $survey->toArray());
446 $page->assign('survey_modes', Survey
::getModes());
450 // {{{ function show_form() : calls the template to display the editing form
451 function show_form(&$page, $action, $qid, $type = 'new', $current = null
)
453 $page->changeTpl('survey/edit_survey.tpl');
454 $page->assign('survey_action', $action);
455 $page->assign('survey_qid', $qid);
456 $page->assign('survey_formaction', './survey/edit');
457 $page->assign('survey_type', $type);
458 if (!is_null($current) && is_array($current)) {
459 $page->assign('survey_current', $current);
460 } elseif ($type == 'new') {
461 $page->addJsLink('ajax.js');
462 $page->assign('survey_types', Survey
::getTypes());
464 if ($type == 'root' ||
$type == 'newsurvey') {
465 $page->assign('survey_modes', Survey
::getModes());
470 // {{{ function show_confirm() : calls the template to display a confirm form
471 function show_confirm(&$page, $message, $formaction, $formhidden = null
)
473 $page->changeTpl('survey/confirm.tpl');
474 $page->assign('survey_message', $message);
475 $page->assign('survey_formaction', './survey/'.$formaction);
476 $page->assign('survey_formhidden', $formhidden);
480 // {{{ function show_error() : calls the template to display an error message
481 function show_error(&$page, $message, $link = "", $errArray = null
)
483 $page->changeTpl('survey/error.tpl');
484 $page->assign('survey_message', $message);
485 $page->assign('survey_link', $link); // 'return' link to let the user leave the page
486 if (!is_null($errArray)) {
487 $page->assign('survey_errors', $errArray);
493 // {{{ function show_success() : calls the template to display a success message
494 function show_success(&$page, $message = "", $link = "")
496 $page->changeTpl('survey/success.tpl');
497 $page->assign('survey_message', $message);
498 $page->assign('survey_link', $link); // 'return' link to let the user leave the page
503 // vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8: