MDL-51569 mod_choice: Check choice availability prior to do any action
[moodle.git] / mod / choice / view.php
1 <?php
3 require_once("../../config.php");
4 require_once("lib.php");
5 require_once($CFG->libdir . '/completionlib.php');
7 $id         = required_param('id', PARAM_INT);                 // Course Module ID
8 $action     = optional_param('action', '', PARAM_ALPHA);
9 $attemptids = optional_param_array('attemptid', array(), PARAM_INT); // array of attempt ids for delete action
10 $notify     = optional_param('notify', '', PARAM_ALPHA);
12 $url = new moodle_url('/mod/choice/view.php', array('id'=>$id));
13 if ($action !== '') {
14     $url->param('action', $action);
15 }
16 $PAGE->set_url($url);
18 if (! $cm = get_coursemodule_from_id('choice', $id)) {
19     print_error('invalidcoursemodule');
20 }
22 if (! $course = $DB->get_record("course", array("id" => $cm->course))) {
23     print_error('coursemisconf');
24 }
26 require_course_login($course, false, $cm);
28 if (!$choice = choice_get_choice($cm->instance)) {
29     print_error('invalidcoursemodule');
30 }
32 $strchoice = get_string('modulename', 'choice');
33 $strchoices = get_string('modulenameplural', 'choice');
35 $context = context_module::instance($cm->id);
37 list($choiceavailable, $warnings) = choice_get_availability_status($choice);
39 if ($action == 'delchoice' and confirm_sesskey() and is_enrolled($context, NULL, 'mod/choice:choose') and $choice->allowupdate
40         and $choiceavailable) {
41     $answercount = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
42     if ($answercount > 0) {
43         $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
45         // Update completion state
46         $completion = new completion_info($course);
47         if ($completion->is_enabled($cm) && $choice->completionsubmit) {
48             $completion->update_state($cm, COMPLETION_INCOMPLETE);
49         }
50         redirect("view.php?id=$cm->id");
51     }
52 }
54 $PAGE->set_title($choice->name);
55 $PAGE->set_heading($course->fullname);
57 /// Submit any new data if there is any
58 if (data_submitted() && is_enrolled($context, NULL, 'mod/choice:choose') && confirm_sesskey()) {
59     $timenow = time();
60     if (has_capability('mod/choice:deleteresponses', $context) && $action == 'delete') {
61         //some responses need to be deleted
62         choice_delete_responses($attemptids, $choice, $cm, $course); //delete responses.
63         redirect("view.php?id=$cm->id");
64     }
66     // Redirection after all POSTs breaks block editing, we need to be more specific!
67     if ($choice->allowmultiple) {
68         $answer = optional_param_array('answer', array(), PARAM_INT);
69     } else {
70         $answer = optional_param('answer', '', PARAM_INT);
71     }
73     if (!$choiceavailable) {
74         $reason = current(array_keys($warnings));
75         throw new moodle_exception($reason, 'choice', '', $warnings[$reason]);
76     }
78     if ($answer) {
79         choice_user_submit_response($answer, $choice, $USER->id, $course, $cm);
80         redirect(new moodle_url('/mod/choice/view.php',
81             array('id' => $cm->id, 'notify' => 'choicesaved', 'sesskey' => sesskey())));
82     } else if (empty($answer) and $action === 'makechoice') {
83         // We cannot use the 'makechoice' alone because there might be some legacy renderers without it,
84         // outdated renderers will not get the 'mustchoose' message - bad luck.
85         redirect(new moodle_url('/mod/choice/view.php',
86             array('id' => $cm->id, 'notify' => 'mustchooseone', 'sesskey' => sesskey())));
87     }
88 }
90 // Completion and trigger events.
91 choice_view($choice, $course, $cm, $context);
93 echo $OUTPUT->header();
94 echo $OUTPUT->heading(format_string($choice->name), 2, null);
96 if ($notify and confirm_sesskey()) {
97     if ($notify === 'choicesaved') {
98         echo $OUTPUT->notification(get_string('choicesaved', 'choice'), 'notifysuccess');
99     } else if ($notify === 'mustchooseone') {
100         echo $OUTPUT->notification(get_string('mustchooseone', 'choice'), 'notifyproblem');
101     }
104 /// Display the choice and possibly results
105 $eventdata = array();
106 $eventdata['objectid'] = $choice->id;
107 $eventdata['context'] = $context;
109 /// Check to see if groups are being used in this choice
110 $groupmode = groups_get_activity_groupmode($cm);
112 if ($groupmode) {
113     groups_get_activity_group($cm, true);
114     groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/choice/view.php?id='.$id);
117 // Check if we want to include responses from inactive users.
118 $onlyactive = $choice->includeinactive ? false : true;
120 $allresponses = choice_get_response_data($choice, $cm, $groupmode, $onlyactive);   // Big function, approx 6 SQL calls per user.
123 if (has_capability('mod/choice:readresponses', $context)) {
124     choice_show_reportlink($allresponses, $cm);
127 echo '<div class="clearer"></div>';
129 if ($choice->intro) {
130     echo $OUTPUT->box(format_module_intro('choice', $choice, $cm->id), 'generalbox', 'intro');
133 $timenow = time();
134 $current = choice_get_my_response($choice);
135 //if user has already made a selection, and they are not allowed to update it or if choice is not open, show their selected answer.
136 if (isloggedin() && (!empty($current)) &&
137     (empty($choice->allowupdate) || ($timenow > $choice->timeclose)) ) {
138     $choicetexts = array();
139     foreach ($current as $c) {
140         $choicetexts[] = format_string(choice_get_option_text($choice, $c->optionid));
141     }
142     echo $OUTPUT->box(get_string("yourselection", "choice", userdate($choice->timeopen)).": ".implode('; ', $choicetexts), 'generalbox', 'yourselection');
145 /// Print the form
146 $choiceopen = true;
147 if ($choice->timeclose !=0) {
148     if ($choice->timeopen > $timenow ) {
149         if ($choice->showpreview) {
150             echo $OUTPUT->box(get_string('previewonly', 'choice', userdate($choice->timeopen)), 'generalbox alert');
151         } else {
152             echo $OUTPUT->box(get_string("notopenyet", "choice", userdate($choice->timeopen)), "generalbox notopenyet");
153             echo $OUTPUT->footer();
154             exit;
155         }
156     } else if ($timenow > $choice->timeclose) {
157         echo $OUTPUT->box(get_string("expired", "choice", userdate($choice->timeclose)), "generalbox expired");
158         $choiceopen = false;
159     }
162 if ( (!$current or $choice->allowupdate) and $choiceopen and is_enrolled($context, NULL, 'mod/choice:choose')) {
163 // They haven't made their choice yet or updates allowed and choice is open
165     $options = choice_prepare_options($choice, $USER, $cm, $allresponses);
166     $renderer = $PAGE->get_renderer('mod_choice');
167     echo $renderer->display_options($options, $cm->id, $choice->display, $choice->allowmultiple);
168     $choiceformshown = true;
169 } else {
170     $choiceformshown = false;
173 if (!$choiceformshown) {
174     $sitecontext = context_system::instance();
176     if (isguestuser()) {
177         // Guest account
178         echo $OUTPUT->confirm(get_string('noguestchoose', 'choice').'<br /><br />'.get_string('liketologin'),
179                      get_login_url(), new moodle_url('/course/view.php', array('id'=>$course->id)));
180     } else if (!is_enrolled($context)) {
181         // Only people enrolled can make a choice
182         $SESSION->wantsurl = qualified_me();
183         $SESSION->enrolcancel = get_local_referer(false);
185         $coursecontext = context_course::instance($course->id);
186         $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
188         echo $OUTPUT->box_start('generalbox', 'notice');
189         echo '<p align="center">'. get_string('notenrolledchoose', 'choice') .'</p>';
190         echo $OUTPUT->container_start('continuebutton');
191         echo $OUTPUT->single_button(new moodle_url('/enrol/index.php?', array('id'=>$course->id)), get_string('enrolme', 'core_enrol', $courseshortname));
192         echo $OUTPUT->container_end();
193         echo $OUTPUT->box_end();
195     }
198 // print the results at the bottom of the screen
199 if (choice_can_view_results($choice, $current, $choiceopen)) {
201     if (!empty($choice->showunanswered)) {
202         $choice->option[0] = get_string('notanswered', 'choice');
203         $choice->maxanswers[0] = 0;
204     }
205     $results = prepare_choice_show_results($choice, $course, $cm, $allresponses);
206     $renderer = $PAGE->get_renderer('mod_choice');
207     echo $renderer->display_result($results);
209 } else if (!$choiceformshown) {
210     echo $OUTPUT->box(get_string('noresultsviewable', 'choice'));
213 echo $OUTPUT->footer();