MDL-51569 mod_choice: Validate the submitted optionid
[moodle.git] / mod / choice / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package   mod_choice
20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 /** @global int $CHOICE_COLUMN_HEIGHT */
25 global $CHOICE_COLUMN_HEIGHT;
26 $CHOICE_COLUMN_HEIGHT = 300;
28 /** @global int $CHOICE_COLUMN_WIDTH */
29 global $CHOICE_COLUMN_WIDTH;
30 $CHOICE_COLUMN_WIDTH = 300;
32 define('CHOICE_PUBLISH_ANONYMOUS', '0');
33 define('CHOICE_PUBLISH_NAMES',     '1');
35 define('CHOICE_SHOWRESULTS_NOT',          '0');
36 define('CHOICE_SHOWRESULTS_AFTER_ANSWER', '1');
37 define('CHOICE_SHOWRESULTS_AFTER_CLOSE',  '2');
38 define('CHOICE_SHOWRESULTS_ALWAYS',       '3');
40 define('CHOICE_DISPLAY_HORIZONTAL',  '0');
41 define('CHOICE_DISPLAY_VERTICAL',    '1');
43 /** @global array $CHOICE_PUBLISH */
44 global $CHOICE_PUBLISH;
45 $CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS  => get_string('publishanonymous', 'choice'),
46                          CHOICE_PUBLISH_NAMES      => get_string('publishnames', 'choice'));
48 /** @global array $CHOICE_SHOWRESULTS */
49 global $CHOICE_SHOWRESULTS;
50 $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT          => get_string('publishnot', 'choice'),
51                          CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
52                          CHOICE_SHOWRESULTS_AFTER_CLOSE  => get_string('publishafterclose', 'choice'),
53                          CHOICE_SHOWRESULTS_ALWAYS       => get_string('publishalways', 'choice'));
55 /** @global array $CHOICE_DISPLAY */
56 global $CHOICE_DISPLAY;
57 $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL   => get_string('displayhorizontal', 'choice'),
58                          CHOICE_DISPLAY_VERTICAL     => get_string('displayvertical','choice'));
60 /// Standard functions /////////////////////////////////////////////////////////
62 /**
63  * @global object
64  * @param object $course
65  * @param object $user
66  * @param object $mod
67  * @param object $choice
68  * @return object|null
69  */
70 function choice_user_outline($course, $user, $mod, $choice) {
71     global $DB;
72     if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
73         $result = new stdClass();
74         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
75         $result->time = $answer->timemodified;
76         return $result;
77     }
78     return NULL;
79 }
81 /**
82  * @global object
83  * @param object $course
84  * @param object $user
85  * @param object $mod
86  * @param object $choice
87  * @return string|void
88  */
89 function choice_user_complete($course, $user, $mod, $choice) {
90     global $DB;
91     if ($answer = $DB->get_record('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
92         $result = new stdClass();
93         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
94         $result->time = $answer->timemodified;
95         echo get_string("answered", "choice").": $result->info. ".get_string("updated", '', userdate($result->time));
96     } else {
97         print_string("notanswered", "choice");
98     }
99 }
101 /**
102  * Given an object containing all the necessary data,
103  * (defined by the form in mod_form.php) this function
104  * will create a new instance and return the id number
105  * of the new instance.
106  *
107  * @global object
108  * @param object $choice
109  * @return int
110  */
111 function choice_add_instance($choice) {
112     global $DB;
114     $choice->timemodified = time();
116     if (empty($choice->timerestrict)) {
117         $choice->timeopen = 0;
118         $choice->timeclose = 0;
119     }
121     //insert answers
122     $choice->id = $DB->insert_record("choice", $choice);
123     foreach ($choice->option as $key => $value) {
124         $value = trim($value);
125         if (isset($value) && $value <> '') {
126             $option = new stdClass();
127             $option->text = $value;
128             $option->choiceid = $choice->id;
129             if (isset($choice->limit[$key])) {
130                 $option->maxanswers = $choice->limit[$key];
131             }
132             $option->timemodified = time();
133             $DB->insert_record("choice_options", $option);
134         }
135     }
137     return $choice->id;
140 /**
141  * Given an object containing all the necessary data,
142  * (defined by the form in mod_form.php) this function
143  * will update an existing instance with new data.
144  *
145  * @global object
146  * @param object $choice
147  * @return bool
148  */
149 function choice_update_instance($choice) {
150     global $DB;
152     $choice->id = $choice->instance;
153     $choice->timemodified = time();
156     if (empty($choice->timerestrict)) {
157         $choice->timeopen = 0;
158         $choice->timeclose = 0;
159     }
161     //update, delete or insert answers
162     foreach ($choice->option as $key => $value) {
163         $value = trim($value);
164         $option = new stdClass();
165         $option->text = $value;
166         $option->choiceid = $choice->id;
167         if (isset($choice->limit[$key])) {
168             $option->maxanswers = $choice->limit[$key];
169         }
170         $option->timemodified = time();
171         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
172             $option->id=$choice->optionid[$key];
173             if (isset($value) && $value <> '') {
174                 $DB->update_record("choice_options", $option);
175             } else { //empty old option - needs to be deleted.
176                 $DB->delete_records("choice_options", array("id"=>$option->id));
177             }
178         } else {
179             if (isset($value) && $value <> '') {
180                 $DB->insert_record("choice_options", $option);
181             }
182         }
183     }
185     return $DB->update_record('choice', $choice);
189 /**
190  * @global object
191  * @param object $choice
192  * @param object $user
193  * @param object $coursemodule
194  * @param array $allresponses
195  * @return array
196  */
197 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
198     global $DB;
200     $cdisplay = array('options'=>array());
202     $cdisplay['limitanswers'] = true;
203     $context = context_module::instance($coursemodule->id);
205     foreach ($choice->option as $optionid => $text) {
206         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
207             $option = new stdClass;
208             $option->attributes = new stdClass;
209             $option->attributes->value = $optionid;
210             $option->text = format_string($text);
211             $option->maxanswers = $choice->maxanswers[$optionid];
212             $option->displaylayout = $choice->display;
214             if (isset($allresponses[$optionid])) {
215                 $option->countanswers = count($allresponses[$optionid]);
216             } else {
217                 $option->countanswers = 0;
218             }
219             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
220                 $option->attributes->checked = true;
221             }
222             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
223                 $option->attributes->disabled = true;
224             }
225             $cdisplay['options'][] = $option;
226         }
227     }
229     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
231     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
232         $cdisplay['allowupdate'] = true;
233     }
235     if ($choice->showpreview && $choice->timeopen > time()) {
236         $cdisplay['previewonly'] = true;
237     }
239     return $cdisplay;
242 /**
243  * Process user submitted answers for a choice,
244  * and either updating them or saving new answers.
245  *
246  * @param int $formanswer users submitted answers.
247  * @param object $choice the selected choice.
248  * @param int $userid user identifier.
249  * @param object $course current course.
250  * @param object $cm course context.
251  * @return void
252  */
253 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
254     global $DB, $CFG;
255     require_once($CFG->libdir.'/completionlib.php');
257     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
259     if (empty($formanswer)) {
260         print_error('atleastoneoption', 'choice', $continueurl);
261     }
263     if (is_array($formanswer)) {
264         if (!$choice->allowmultiple) {
265             print_error('multiplenotallowederror', 'choice', $continueurl);
266         }
267         $formanswers = $formanswer;
268     } else {
269         $formanswers = array($formanswer);
270     }
272     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
273     foreach ($formanswers as $key => $val) {
274         if (!isset($options[$val])) {
275             print_error('cannotsubmit', 'choice', $continueurl);
276         }
277     }
278     // Start lock to prevent synchronous access to the same data
279     // before it's updated, if using limits.
280     if ($choice->limitanswers) {
281         $timeout = 10;
282         $locktype = 'mod_choice_choice_user_submit_response';
283         // Limiting access to this choice.
284         $resouce = 'choiceid:' . $choice->id;
285         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
287         // Opening the lock.
288         $choicelock = $lockfactory->get_lock($resouce, $timeout);
289         if (!$choicelock) {
290             print_error('cannotsubmit', 'choice', $continueurl);
291         }
292     }
294     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
295     $context = context_module::instance($cm->id);
297     $choicesexceeded = false;
298     $countanswers = array();
299     foreach ($formanswers as $val) {
300         $countanswers[$val] = 0;
301     }
302     if($choice->limitanswers) {
303         // Find out whether groups are being used and enabled
304         if (groups_get_activity_groupmode($cm) > 0) {
305             $currentgroup = groups_get_activity_group($cm);
306         } else {
307             $currentgroup = 0;
308         }
310         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
312         if($currentgroup) {
313             // If groups are being used, retrieve responses only for users in
314             // current group
315             global $CFG;
317             $params['groupid'] = $currentgroup;
318             $sql = "SELECT ca.*
319                       FROM {choice_answers} ca
320                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
321                      WHERE optionid $insql
322                        AND gm.groupid= :groupid";
323         } else {
324             // Groups are not used, retrieve all answers for this option ID
325             $sql = "SELECT ca.*
326                       FROM {choice_answers} ca
327                      WHERE optionid $insql";
328         }
330         $answers = $DB->get_records_sql($sql, $params);
331         if ($answers) {
332             foreach ($answers as $a) { //only return enrolled users.
333                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
334                     $countanswers[$a->optionid]++;
335                 }
336             }
337         }
338         foreach ($countanswers as $opt => $count) {
339             if ($count >= $choice->maxanswers[$opt]) {
340                 $choicesexceeded = true;
341                 break;
342             }
343         }
344     }
346     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
347     if (!($choice->limitanswers && $choicesexceeded)) {
348         $answersnapshots = array();
349         if ($current) {
350             // Update an existing answer.
351             $existingchoices = array();
352             foreach ($current as $c) {
353                 if (in_array($c->optionid, $formanswers)) {
354                     $existingchoices[] = $c->optionid;
355                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
356                     $answersnapshots[] = $c;
357                 } else {
358                     $DB->delete_records('choice_answers', array('id' => $c->id));
359                 }
360             }
362             // Add new ones.
363             foreach ($formanswers as $f) {
364                 if (!in_array($f, $existingchoices)) {
365                     $newanswer = new stdClass();
366                     $newanswer->optionid = $f;
367                     $newanswer->choiceid = $choice->id;
368                     $newanswer->userid = $userid;
369                     $newanswer->timemodified = time();
370                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
371                     $answersnapshots[] = $newanswer;
372                 }
373             }
375             // Initialised as true, meaning we updated the answer.
376             $answerupdated = true;
377         } else {
378             // Add new answer.
379             foreach ($formanswers as $answer) {
380                 $newanswer = new stdClass();
381                 $newanswer->choiceid = $choice->id;
382                 $newanswer->userid = $userid;
383                 $newanswer->optionid = $answer;
384                 $newanswer->timemodified = time();
385                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
386                 $answersnapshots[] = $newanswer;
387             }
389             // Update completion state
390             $completion = new completion_info($course);
391             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
392                 $completion->update_state($cm, COMPLETION_COMPLETE);
393             }
395             // Initalised as false, meaning we submitted a new answer.
396             $answerupdated = false;
397         }
398     } else {
399         // Check to see if current choice already selected - if not display error.
400         $currentids = array_keys($current);
402         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
403             // Release lock before error.
404             $choicelock->release();
405             print_error('choicefull', 'choice', $continueurl);
406         }
407     }
409     // Release lock.
410     if (isset($choicelock)) {
411         $choicelock->release();
412     }
414     // Now record completed event.
415     if (isset($answerupdated)) {
416         $eventdata = array();
417         $eventdata['context'] = $context;
418         $eventdata['objectid'] = $choice->id;
419         $eventdata['userid'] = $userid;
420         $eventdata['courseid'] = $course->id;
421         $eventdata['other'] = array();
422         $eventdata['other']['choiceid'] = $choice->id;
424         if ($answerupdated) {
425             $eventdata['other']['optionid'] = $formanswer;
426             $event = \mod_choice\event\answer_updated::create($eventdata);
427         } else {
428             $eventdata['other']['optionid'] = $formanswers;
429             $event = \mod_choice\event\answer_submitted::create($eventdata);
430         }
431         $event->add_record_snapshot('course', $course);
432         $event->add_record_snapshot('course_modules', $cm);
433         $event->add_record_snapshot('choice', $choice);
434         foreach ($answersnapshots as $record) {
435             $event->add_record_snapshot('choice_answers', $record);
436         }
437         $event->trigger();
438     }
441 /**
442  * @param array $user
443  * @param object $cm
444  * @return void Output is echo'd
445  */
446 function choice_show_reportlink($user, $cm) {
447     $userschosen = array();
448     foreach($user as $optionid => $userlist) {
449         if ($optionid) {
450             $userschosen = array_merge($userschosen, array_keys($userlist));
451         }
452     }
453     $responsecount = count(array_unique($userschosen));
455     echo '<div class="reportlink">';
456     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
457     echo '</div>';
460 /**
461  * @global object
462  * @param object $choice
463  * @param object $course
464  * @param object $coursemodule
465  * @param array $allresponses
467  *  * @param bool $allresponses
468  * @return object
469  */
470 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
471     global $OUTPUT;
473     $display = clone($choice);
474     $display->coursemoduleid = $cm->id;
475     $display->courseid = $course->id;
477     //overwrite options value;
478     $display->options = array();
479     $totaluser = 0;
480     foreach ($choice->option as $optionid => $optiontext) {
481         $display->options[$optionid] = new stdClass;
482         $display->options[$optionid]->text = $optiontext;
483         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
485         if (array_key_exists($optionid, $allresponses)) {
486             $display->options[$optionid]->user = $allresponses[$optionid];
487             $totaluser += count($allresponses[$optionid]);
488         }
489     }
490     unset($display->option);
491     unset($display->maxanswers);
493     $display->numberofuser = $totaluser;
494     $context = context_module::instance($cm->id);
495     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
496     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
497     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
499     if (empty($allresponses)) {
500         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
501         return false;
502     }
504     return $display;
507 /**
508  * @global object
509  * @param array $attemptids
510  * @param object $choice Choice main table row
511  * @param object $cm Course-module object
512  * @param object $course Course object
513  * @return bool
514  */
515 function choice_delete_responses($attemptids, $choice, $cm, $course) {
516     global $DB, $CFG;
517     require_once($CFG->libdir.'/completionlib.php');
519     if(!is_array($attemptids) || empty($attemptids)) {
520         return false;
521     }
523     foreach($attemptids as $num => $attemptid) {
524         if(empty($attemptid)) {
525             unset($attemptids[$num]);
526         }
527     }
529     $completion = new completion_info($course);
530     foreach($attemptids as $attemptid) {
531         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
532             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
533             // Update completion state
534             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
535                 $completion->update_state($cm, COMPLETION_INCOMPLETE, $attemptid);
536             }
537         }
538     }
539     return true;
543 /**
544  * Given an ID of an instance of this module,
545  * this function will permanently delete the instance
546  * and any data that depends on it.
547  *
548  * @global object
549  * @param int $id
550  * @return bool
551  */
552 function choice_delete_instance($id) {
553     global $DB;
555     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
556         return false;
557     }
559     $result = true;
561     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
562         $result = false;
563     }
565     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
566         $result = false;
567     }
569     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
570         $result = false;
571     }
573     return $result;
576 /**
577  * Returns text string which is the answer that matches the id
578  *
579  * @global object
580  * @param object $choice
581  * @param int $id
582  * @return string
583  */
584 function choice_get_option_text($choice, $id) {
585     global $DB;
587     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
588         return $result->text;
589     } else {
590         return get_string("notanswered", "choice");
591     }
594 /**
595  * Gets a full choice record
596  *
597  * @global object
598  * @param int $choiceid
599  * @return object|bool The choice or false
600  */
601 function choice_get_choice($choiceid) {
602     global $DB;
604     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
605         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
606             foreach ($options as $option) {
607                 $choice->option[$option->id] = $option->text;
608                 $choice->maxanswers[$option->id] = $option->maxanswers;
609             }
610             return $choice;
611         }
612     }
613     return false;
616 /**
617  * List the actions that correspond to a view of this module.
618  * This is used by the participation report.
619  *
620  * Note: This is not used by new logging system. Event with
621  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
622  *       be considered as view action.
623  *
624  * @return array
625  */
626 function choice_get_view_actions() {
627     return array('view','view all','report');
630 /**
631  * List the actions that correspond to a post of this module.
632  * This is used by the participation report.
633  *
634  * Note: This is not used by new logging system. Event with
635  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
636  *       will be considered as post action.
637  *
638  * @return array
639  */
640 function choice_get_post_actions() {
641     return array('choose','choose again');
645 /**
646  * Implementation of the function for printing the form elements that control
647  * whether the course reset functionality affects the choice.
648  *
649  * @param object $mform form passed by reference
650  */
651 function choice_reset_course_form_definition(&$mform) {
652     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
653     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
656 /**
657  * Course reset form defaults.
658  *
659  * @return array
660  */
661 function choice_reset_course_form_defaults($course) {
662     return array('reset_choice'=>1);
665 /**
666  * Actual implementation of the reset course functionality, delete all the
667  * choice responses for course $data->courseid.
668  *
669  * @global object
670  * @global object
671  * @param object $data the data submitted from the reset course.
672  * @return array status array
673  */
674 function choice_reset_userdata($data) {
675     global $CFG, $DB;
677     $componentstr = get_string('modulenameplural', 'choice');
678     $status = array();
680     if (!empty($data->reset_choice)) {
681         $choicessql = "SELECT ch.id
682                        FROM {choice} ch
683                        WHERE ch.course=?";
685         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
686         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
687     }
689     /// updating dates - shift may be negative too
690     if ($data->timeshift) {
691         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
692         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
693     }
695     return $status;
698 /**
699  * @global object
700  * @global object
701  * @global object
702  * @uses CONTEXT_MODULE
703  * @param object $choice
704  * @param object $cm
705  * @param int $groupmode
706  * @param bool $onlyactive Whether to get response data for active users only.
707  * @return array
708  */
709 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
710     global $CFG, $USER, $DB;
712     $context = context_module::instance($cm->id);
714 /// Get the current group
715     if ($groupmode > 0) {
716         $currentgroup = groups_get_activity_group($cm);
717     } else {
718         $currentgroup = 0;
719     }
721 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
722     $allresponses = array();
724 /// First get all the users who have access here
725 /// To start with we assume they are all "unanswered" then move them later
726     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
727             user_picture::fields('u', array('idnumber')), null, 0, 0, $onlyactive);
729 /// Get all the recorded responses for this choice
730     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
732 /// Use the responses to move users into the correct column
734     if ($rawresponses) {
735         $answeredusers = array();
736         foreach ($rawresponses as $response) {
737             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
738                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
739                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
740                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
741                 $answeredusers[] = $response->userid;
742             }
743         }
744         foreach ($answeredusers as $answereduser) {
745             unset($allresponses[0][$answereduser]);
746         }
747     }
748     return $allresponses;
751 /**
752  * Returns all other caps used in module
753  *
754  * @return array
755  */
756 function choice_get_extra_capabilities() {
757     return array('moodle/site:accessallgroups');
760 /**
761  * @uses FEATURE_GROUPS
762  * @uses FEATURE_GROUPINGS
763  * @uses FEATURE_MOD_INTRO
764  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
765  * @uses FEATURE_GRADE_HAS_GRADE
766  * @uses FEATURE_GRADE_OUTCOMES
767  * @param string $feature FEATURE_xx constant for requested feature
768  * @return mixed True if module supports feature, null if doesn't know
769  */
770 function choice_supports($feature) {
771     switch($feature) {
772         case FEATURE_GROUPS:                  return true;
773         case FEATURE_GROUPINGS:               return true;
774         case FEATURE_MOD_INTRO:               return true;
775         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
776         case FEATURE_COMPLETION_HAS_RULES:    return true;
777         case FEATURE_GRADE_HAS_GRADE:         return false;
778         case FEATURE_GRADE_OUTCOMES:          return false;
779         case FEATURE_BACKUP_MOODLE2:          return true;
780         case FEATURE_SHOW_DESCRIPTION:        return true;
782         default: return null;
783     }
786 /**
787  * Adds module specific settings to the settings block
788  *
789  * @param settings_navigation $settings The settings navigation object
790  * @param navigation_node $choicenode The node to add module settings to
791  */
792 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
793     global $PAGE;
795     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
797         $groupmode = groups_get_activity_groupmode($PAGE->cm);
798         if ($groupmode) {
799             groups_get_activity_group($PAGE->cm, true);
800         }
802         $choice = choice_get_choice($PAGE->cm->instance);
804         // Check if we want to include responses from inactive users.
805         $onlyactive = $choice->includeinactive ? false : true;
807         // Big function, approx 6 SQL calls per user.
808         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
810         $responsecount =0;
811         foreach($allresponses as $optionid => $userlist) {
812             if ($optionid) {
813                 $responsecount += count($userlist);
814             }
815         }
816         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
817     }
820 /**
821  * Obtains the automatic completion state for this choice based on any conditions
822  * in forum settings.
823  *
824  * @param object $course Course
825  * @param object $cm Course-module
826  * @param int $userid User ID
827  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
828  * @return bool True if completed, false if not, $type if conditions not set.
829  */
830 function choice_get_completion_state($course, $cm, $userid, $type) {
831     global $CFG,$DB;
833     // Get choice details
834     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
835             MUST_EXIST);
837     // If completion option is enabled, evaluate it and return true/false
838     if($choice->completionsubmit) {
839         return $DB->record_exists('choice_answers', array(
840                 'choiceid'=>$choice->id, 'userid'=>$userid));
841     } else {
842         // Completion option is not enabled so just return $type
843         return $type;
844     }
847 /**
848  * Return a list of page types
849  * @param string $pagetype current page type
850  * @param stdClass $parentcontext Block's parent context
851  * @param stdClass $currentcontext Current context of block
852  */
853 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
854     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
855     return $module_pagetype;
858 /**
859  * Prints choice summaries on MyMoodle Page
860  *
861  * Prints choice name, due date and attempt information on
862  * choice activities that have a deadline that has not already passed
863  * and it is available for completing.
864  * @uses CONTEXT_MODULE
865  * @param array $courses An array of course objects to get choice instances from.
866  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
867  */
868 function choice_print_overview($courses, &$htmlarray) {
869     global $USER, $DB, $OUTPUT;
871     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
872         return;
873     }
874     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
875         return;
876     }
878     $now = time();
879     foreach ($choices as $choice) {
880         if ($choice->timeclose != 0                                      // If this choice is scheduled.
881             and $choice->timeclose >= $now                               // And the deadline has not passed.
882             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
884             // Visibility.
885             $class = (!$choice->visible) ? 'dimmed' : '';
887             // Link to activity.
888             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
889             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
890             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
892              // Deadline.
893             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
895             // Display relevant info based on permissions.
896             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
897                 $attempts = $DB->count_records('choice_answers', array('choiceid' => $choice->id));
898                 $str .= $OUTPUT->box(get_string('viewallresponses', 'choice', $attempts), 'info');
900             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
901                 // See if the user has submitted anything.
902                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
903                 if ($answers > 0) {
904                     // User has already selected an answer, nothing to show.
905                     $str = '';
906                 } else {
907                     // User has not made a selection yet.
908                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
909                 }
910             } else {
911                 // Does not have permission to do anything on this choice activity.
912                 $str = '';
913             }
915             // Make sure we have something to display.
916             if (!empty($str)) {
917                 // Generate the containing div.
918                 $str = $OUTPUT->box($str, 'choice overview');
920                 if (empty($htmlarray[$choice->course]['choice'])) {
921                     $htmlarray[$choice->course]['choice'] = $str;
922                 } else {
923                     $htmlarray[$choice->course]['choice'] .= $str;
924                 }
925             }
926         }
927     }
928     return;
932 /**
933  * Get my responses on a given choice.
934  *
935  * @param stdClass $choice Choice record
936  * @return array of choice answers records
937  * @since  Moodle 3.0
938  */
939 function choice_get_my_response($choice) {
940     global $DB, $USER;
941     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
945 /**
946  * Get all the responses on a given choice.
947  *
948  * @param stdClass $choice Choice record
949  * @return array of choice answers records
950  * @since  Moodle 3.0
951  */
952 function choice_get_all_responses($choice) {
953     global $DB;
954     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
958 /**
959  * Return true if we are allowd to view the choice results.
960  *
961  * @param stdClass $choice Choice record
962  * @param rows|null $current my choice responses
963  * @param bool|null $choiceopen if the choice is open
964  * @return bool true if we can view the results, false otherwise.
965  * @since  Moodle 3.0
966  */
967 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
969     if (is_null($choiceopen)) {
970         $timenow = time();
971         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
972             $choiceopen = false;
973         } else {
974             $choiceopen = true;
975         }
976     }
977     if (empty($current)) {
978         $current = choice_get_my_response($choice);
979     }
981     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
982        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
983        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
984         return true;
985     }
986     return false;
989 /**
990  * Mark the activity completed (if required) and trigger the course_module_viewed event.
991  *
992  * @param  stdClass $choice     choice object
993  * @param  stdClass $course     course object
994  * @param  stdClass $cm         course module object
995  * @param  stdClass $context    context object
996  * @since Moodle 3.0
997  */
998 function choice_view($choice, $course, $cm, $context) {
1000     // Trigger course_module_viewed event.
1001     $params = array(
1002         'context' => $context,
1003         'objectid' => $choice->id
1004     );
1006     $event = \mod_choice\event\course_module_viewed::create($params);
1007     $event->add_record_snapshot('course_modules', $cm);
1008     $event->add_record_snapshot('course', $course);
1009     $event->add_record_snapshot('choice', $choice);
1010     $event->trigger();
1012     // Completion.
1013     $completion = new completion_info($course);
1014     $completion->set_module_viewed($cm);
1017 /**
1018  * Check if a choice is available for the current user.
1019  *
1020  * @param  stdClass  $choice            choice record
1021  * @return array                       status (available or not and possible warnings)
1022  */
1023 function choice_get_availability_status($choice) {
1024     $available = true;
1025     $warnings = array();
1027     if ($choice->timeclose != 0) {
1028         $timenow = time();
1030         if ($choice->timeopen > $timenow) {
1031             $available = false;
1032             $warnings['notopenyet'] = userdate($choice->timeopen);
1033         } else if ($timenow > $choice->timeclose) {
1034             $available = false;
1035             $warnings['expired'] = userdate($choice->timeclose);
1036         }
1037     }
1039     // Choice is available.
1040     return array($available, $warnings);