MDL-55253 mod_choice: prevent direct script access to lib files.
[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 defined('MOODLE_INTERNAL') || die();
26 /** @global int $CHOICE_COLUMN_HEIGHT */
27 global $CHOICE_COLUMN_HEIGHT;
28 $CHOICE_COLUMN_HEIGHT = 300;
30 /** @global int $CHOICE_COLUMN_WIDTH */
31 global $CHOICE_COLUMN_WIDTH;
32 $CHOICE_COLUMN_WIDTH = 300;
34 define('CHOICE_PUBLISH_ANONYMOUS', '0');
35 define('CHOICE_PUBLISH_NAMES',     '1');
37 define('CHOICE_SHOWRESULTS_NOT',          '0');
38 define('CHOICE_SHOWRESULTS_AFTER_ANSWER', '1');
39 define('CHOICE_SHOWRESULTS_AFTER_CLOSE',  '2');
40 define('CHOICE_SHOWRESULTS_ALWAYS',       '3');
42 define('CHOICE_DISPLAY_HORIZONTAL',  '0');
43 define('CHOICE_DISPLAY_VERTICAL',    '1');
45 /** @global array $CHOICE_PUBLISH */
46 global $CHOICE_PUBLISH;
47 $CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS  => get_string('publishanonymous', 'choice'),
48                          CHOICE_PUBLISH_NAMES      => get_string('publishnames', 'choice'));
50 /** @global array $CHOICE_SHOWRESULTS */
51 global $CHOICE_SHOWRESULTS;
52 $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT          => get_string('publishnot', 'choice'),
53                          CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
54                          CHOICE_SHOWRESULTS_AFTER_CLOSE  => get_string('publishafterclose', 'choice'),
55                          CHOICE_SHOWRESULTS_ALWAYS       => get_string('publishalways', 'choice'));
57 /** @global array $CHOICE_DISPLAY */
58 global $CHOICE_DISPLAY;
59 $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL   => get_string('displayhorizontal', 'choice'),
60                          CHOICE_DISPLAY_VERTICAL     => get_string('displayvertical','choice'));
62 /// Standard functions /////////////////////////////////////////////////////////
64 /**
65  * @global object
66  * @param object $course
67  * @param object $user
68  * @param object $mod
69  * @param object $choice
70  * @return object|null
71  */
72 function choice_user_outline($course, $user, $mod, $choice) {
73     global $DB;
74     if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
75         $result = new stdClass();
76         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
77         $result->time = $answer->timemodified;
78         return $result;
79     }
80     return NULL;
81 }
83 /**
84  * Callback for the "Complete" report - prints the activity summary for the given user
85  *
86  * @param object $course
87  * @param object $user
88  * @param object $mod
89  * @param object $choice
90  */
91 function choice_user_complete($course, $user, $mod, $choice) {
92     global $DB;
93     if ($answers = $DB->get_records('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
94         $info = [];
95         foreach ($answers as $answer) {
96             $info[] = "'" . format_string(choice_get_option_text($choice, $answer->optionid)) . "'";
97         }
98         core_collator::asort($info);
99         echo get_string("answered", "choice") . ": ". join(', ', $info) . ". " .
100                 get_string("updated", '', userdate($answer->timemodified));
101     } else {
102         print_string("notanswered", "choice");
103     }
106 /**
107  * Given an object containing all the necessary data,
108  * (defined by the form in mod_form.php) this function
109  * will create a new instance and return the id number
110  * of the new instance.
111  *
112  * @global object
113  * @param object $choice
114  * @return int
115  */
116 function choice_add_instance($choice) {
117     global $DB, $CFG;
118     require_once($CFG->dirroot.'/mod/choice/locallib.php');
120     $choice->timemodified = time();
122     if (empty($choice->timerestrict)) {
123         $choice->timeopen = 0;
124         $choice->timeclose = 0;
125     }
127     //insert answers
128     $choice->id = $DB->insert_record("choice", $choice);
129     foreach ($choice->option as $key => $value) {
130         $value = trim($value);
131         if (isset($value) && $value <> '') {
132             $option = new stdClass();
133             $option->text = $value;
134             $option->choiceid = $choice->id;
135             if (isset($choice->limit[$key])) {
136                 $option->maxanswers = $choice->limit[$key];
137             }
138             $option->timemodified = time();
139             $DB->insert_record("choice_options", $option);
140         }
141     }
143     // Add calendar events if necessary.
144     choice_set_events($choice);
146     return $choice->id;
149 /**
150  * Given an object containing all the necessary data,
151  * (defined by the form in mod_form.php) this function
152  * will update an existing instance with new data.
153  *
154  * @global object
155  * @param object $choice
156  * @return bool
157  */
158 function choice_update_instance($choice) {
159     global $DB, $CFG;
160     require_once($CFG->dirroot.'/mod/choice/locallib.php');
162     $choice->id = $choice->instance;
163     $choice->timemodified = time();
166     if (empty($choice->timerestrict)) {
167         $choice->timeopen = 0;
168         $choice->timeclose = 0;
169     }
171     //update, delete or insert answers
172     foreach ($choice->option as $key => $value) {
173         $value = trim($value);
174         $option = new stdClass();
175         $option->text = $value;
176         $option->choiceid = $choice->id;
177         if (isset($choice->limit[$key])) {
178             $option->maxanswers = $choice->limit[$key];
179         }
180         $option->timemodified = time();
181         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
182             $option->id=$choice->optionid[$key];
183             if (isset($value) && $value <> '') {
184                 $DB->update_record("choice_options", $option);
185             } else {
186                 // Remove the empty (unused) option.
187                 $DB->delete_records("choice_options", array("id" => $option->id));
188                 // Delete any answers associated with this option.
189                 $DB->delete_records("choice_answers", array("choiceid" => $choice->id, "optionid" => $option->id));
190             }
191         } else {
192             if (isset($value) && $value <> '') {
193                 $DB->insert_record("choice_options", $option);
194             }
195         }
196     }
198     // Add calendar events if necessary.
199     choice_set_events($choice);
201     return $DB->update_record('choice', $choice);
205 /**
206  * @global object
207  * @param object $choice
208  * @param object $user
209  * @param object $coursemodule
210  * @param array $allresponses
211  * @return array
212  */
213 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
214     global $DB;
216     $cdisplay = array('options'=>array());
218     $cdisplay['limitanswers'] = true;
219     $context = context_module::instance($coursemodule->id);
221     foreach ($choice->option as $optionid => $text) {
222         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
223             $option = new stdClass;
224             $option->attributes = new stdClass;
225             $option->attributes->value = $optionid;
226             $option->text = format_string($text);
227             $option->maxanswers = $choice->maxanswers[$optionid];
228             $option->displaylayout = $choice->display;
230             if (isset($allresponses[$optionid])) {
231                 $option->countanswers = count($allresponses[$optionid]);
232             } else {
233                 $option->countanswers = 0;
234             }
235             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
236                 $option->attributes->checked = true;
237             }
238             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
239                 $option->attributes->disabled = true;
240             }
241             $cdisplay['options'][] = $option;
242         }
243     }
245     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
247     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
248         $cdisplay['allowupdate'] = true;
249     }
251     if ($choice->showpreview && $choice->timeopen > time()) {
252         $cdisplay['previewonly'] = true;
253     }
255     return $cdisplay;
258 /**
259  * Process user submitted answers for a choice,
260  * and either updating them or saving new answers.
261  *
262  * @param int $formanswer users submitted answers.
263  * @param object $choice the selected choice.
264  * @param int $userid user identifier.
265  * @param object $course current course.
266  * @param object $cm course context.
267  * @return void
268  */
269 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
270     global $DB, $CFG;
271     require_once($CFG->libdir.'/completionlib.php');
273     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
275     if (empty($formanswer)) {
276         print_error('atleastoneoption', 'choice', $continueurl);
277     }
279     if (is_array($formanswer)) {
280         if (!$choice->allowmultiple) {
281             print_error('multiplenotallowederror', 'choice', $continueurl);
282         }
283         $formanswers = $formanswer;
284     } else {
285         $formanswers = array($formanswer);
286     }
288     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
289     foreach ($formanswers as $key => $val) {
290         if (!isset($options[$val])) {
291             print_error('cannotsubmit', 'choice', $continueurl);
292         }
293     }
294     // Start lock to prevent synchronous access to the same data
295     // before it's updated, if using limits.
296     if ($choice->limitanswers) {
297         $timeout = 10;
298         $locktype = 'mod_choice_choice_user_submit_response';
299         // Limiting access to this choice.
300         $resouce = 'choiceid:' . $choice->id;
301         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
303         // Opening the lock.
304         $choicelock = $lockfactory->get_lock($resouce, $timeout);
305         if (!$choicelock) {
306             print_error('cannotsubmit', 'choice', $continueurl);
307         }
308     }
310     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
311     $context = context_module::instance($cm->id);
313     $choicesexceeded = false;
314     $countanswers = array();
315     foreach ($formanswers as $val) {
316         $countanswers[$val] = 0;
317     }
318     if($choice->limitanswers) {
319         // Find out whether groups are being used and enabled
320         if (groups_get_activity_groupmode($cm) > 0) {
321             $currentgroup = groups_get_activity_group($cm);
322         } else {
323             $currentgroup = 0;
324         }
326         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
328         if($currentgroup) {
329             // If groups are being used, retrieve responses only for users in
330             // current group
331             global $CFG;
333             $params['groupid'] = $currentgroup;
334             $sql = "SELECT ca.*
335                       FROM {choice_answers} ca
336                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
337                      WHERE optionid $insql
338                        AND gm.groupid= :groupid";
339         } else {
340             // Groups are not used, retrieve all answers for this option ID
341             $sql = "SELECT ca.*
342                       FROM {choice_answers} ca
343                      WHERE optionid $insql";
344         }
346         $answers = $DB->get_records_sql($sql, $params);
347         if ($answers) {
348             foreach ($answers as $a) { //only return enrolled users.
349                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
350                     $countanswers[$a->optionid]++;
351                 }
352             }
353         }
354         foreach ($countanswers as $opt => $count) {
355             if ($count >= $choice->maxanswers[$opt]) {
356                 $choicesexceeded = true;
357                 break;
358             }
359         }
360     }
362     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
363     if (!($choice->limitanswers && $choicesexceeded)) {
364         $answersnapshots = array();
365         if ($current) {
366             // Update an existing answer.
367             $existingchoices = array();
368             foreach ($current as $c) {
369                 if (in_array($c->optionid, $formanswers)) {
370                     $existingchoices[] = $c->optionid;
371                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
372                     $answersnapshots[] = $c;
373                 } else {
374                     $DB->delete_records('choice_answers', array('id' => $c->id));
375                 }
376             }
378             // Add new ones.
379             foreach ($formanswers as $f) {
380                 if (!in_array($f, $existingchoices)) {
381                     $newanswer = new stdClass();
382                     $newanswer->optionid = $f;
383                     $newanswer->choiceid = $choice->id;
384                     $newanswer->userid = $userid;
385                     $newanswer->timemodified = time();
386                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
387                     $answersnapshots[] = $newanswer;
388                 }
389             }
391             // Initialised as true, meaning we updated the answer.
392             $answerupdated = true;
393         } else {
394             // Add new answer.
395             foreach ($formanswers as $answer) {
396                 $newanswer = new stdClass();
397                 $newanswer->choiceid = $choice->id;
398                 $newanswer->userid = $userid;
399                 $newanswer->optionid = $answer;
400                 $newanswer->timemodified = time();
401                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
402                 $answersnapshots[] = $newanswer;
403             }
405             // Update completion state
406             $completion = new completion_info($course);
407             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
408                 $completion->update_state($cm, COMPLETION_COMPLETE);
409             }
411             // Initalised as false, meaning we submitted a new answer.
412             $answerupdated = false;
413         }
414     } else {
415         // Check to see if current choice already selected - if not display error.
416         $currentids = array_keys($current);
418         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
419             // Release lock before error.
420             $choicelock->release();
421             print_error('choicefull', 'choice', $continueurl);
422         }
423     }
425     // Release lock.
426     if (isset($choicelock)) {
427         $choicelock->release();
428     }
430     // Now record completed event.
431     if (isset($answerupdated)) {
432         $eventdata = array();
433         $eventdata['context'] = $context;
434         $eventdata['objectid'] = $choice->id;
435         $eventdata['userid'] = $userid;
436         $eventdata['courseid'] = $course->id;
437         $eventdata['other'] = array();
438         $eventdata['other']['choiceid'] = $choice->id;
440         if ($answerupdated) {
441             $eventdata['other']['optionid'] = $formanswer;
442             $event = \mod_choice\event\answer_updated::create($eventdata);
443         } else {
444             $eventdata['other']['optionid'] = $formanswers;
445             $event = \mod_choice\event\answer_submitted::create($eventdata);
446         }
447         $event->add_record_snapshot('course', $course);
448         $event->add_record_snapshot('course_modules', $cm);
449         $event->add_record_snapshot('choice', $choice);
450         foreach ($answersnapshots as $record) {
451             $event->add_record_snapshot('choice_answers', $record);
452         }
453         $event->trigger();
454     }
457 /**
458  * @param array $user
459  * @param object $cm
460  * @return void Output is echo'd
461  */
462 function choice_show_reportlink($user, $cm) {
463     $userschosen = array();
464     foreach($user as $optionid => $userlist) {
465         if ($optionid) {
466             $userschosen = array_merge($userschosen, array_keys($userlist));
467         }
468     }
469     $responsecount = count(array_unique($userschosen));
471     echo '<div class="reportlink">';
472     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
473     echo '</div>';
476 /**
477  * @global object
478  * @param object $choice
479  * @param object $course
480  * @param object $coursemodule
481  * @param array $allresponses
483  *  * @param bool $allresponses
484  * @return object
485  */
486 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
487     global $OUTPUT;
489     $display = clone($choice);
490     $display->coursemoduleid = $cm->id;
491     $display->courseid = $course->id;
493     //overwrite options value;
494     $display->options = array();
495     $allusers = [];
496     foreach ($choice->option as $optionid => $optiontext) {
497         $display->options[$optionid] = new stdClass;
498         $display->options[$optionid]->text = $optiontext;
499         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
501         if (array_key_exists($optionid, $allresponses)) {
502             $display->options[$optionid]->user = $allresponses[$optionid];
503             $allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
504         }
505     }
506     unset($display->option);
507     unset($display->maxanswers);
509     $display->numberofuser = count(array_unique($allusers));
510     $context = context_module::instance($cm->id);
511     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
512     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
513     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
515     if (empty($allresponses)) {
516         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
517         return false;
518     }
520     return $display;
523 /**
524  * @global object
525  * @param array $attemptids
526  * @param object $choice Choice main table row
527  * @param object $cm Course-module object
528  * @param object $course Course object
529  * @return bool
530  */
531 function choice_delete_responses($attemptids, $choice, $cm, $course) {
532     global $DB, $CFG, $USER;
533     require_once($CFG->libdir.'/completionlib.php');
535     if(!is_array($attemptids) || empty($attemptids)) {
536         return false;
537     }
539     foreach($attemptids as $num => $attemptid) {
540         if(empty($attemptid)) {
541             unset($attemptids[$num]);
542         }
543     }
545     $context = context_module::instance($cm->id);
546     $completion = new completion_info($course);
547     foreach($attemptids as $attemptid) {
548         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
549             // Trigger the event answer deleted.
550             $eventdata = array();
551             $eventdata['objectid'] = $todelete->id;
552             $eventdata['context'] = $context;
553             $eventdata['userid'] = $USER->id;
554             $eventdata['courseid'] = $course->id;
555             $eventdata['relateduserid'] = $todelete->userid;
556             $eventdata['other'] = array();
557             $eventdata['other']['choiceid'] = $choice->id;
558             $eventdata['other']['optionid'] = $todelete->optionid;
559             $event = \mod_choice\event\answer_deleted::create($eventdata);
560             $event->add_record_snapshot('course', $course);
561             $event->add_record_snapshot('course_modules', $cm);
562             $event->add_record_snapshot('choice', $choice);
563             $event->add_record_snapshot('choice_answers', $todelete);
564             $event->trigger();
566             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
567         }
568     }
570     // Update completion state.
571     if ($completion->is_enabled($cm) && $choice->completionsubmit) {
572         $completion->update_state($cm, COMPLETION_INCOMPLETE);
573     }
575     return true;
579 /**
580  * Given an ID of an instance of this module,
581  * this function will permanently delete the instance
582  * and any data that depends on it.
583  *
584  * @global object
585  * @param int $id
586  * @return bool
587  */
588 function choice_delete_instance($id) {
589     global $DB;
591     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
592         return false;
593     }
595     $result = true;
597     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
598         $result = false;
599     }
601     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
602         $result = false;
603     }
605     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
606         $result = false;
607     }
608     // Remove old calendar events.
609     if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
610         $result = false;
611     }
613     return $result;
616 /**
617  * Returns text string which is the answer that matches the id
618  *
619  * @global object
620  * @param object $choice
621  * @param int $id
622  * @return string
623  */
624 function choice_get_option_text($choice, $id) {
625     global $DB;
627     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
628         return $result->text;
629     } else {
630         return get_string("notanswered", "choice");
631     }
634 /**
635  * Gets a full choice record
636  *
637  * @global object
638  * @param int $choiceid
639  * @return object|bool The choice or false
640  */
641 function choice_get_choice($choiceid) {
642     global $DB;
644     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
645         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
646             foreach ($options as $option) {
647                 $choice->option[$option->id] = $option->text;
648                 $choice->maxanswers[$option->id] = $option->maxanswers;
649             }
650             return $choice;
651         }
652     }
653     return false;
656 /**
657  * List the actions that correspond to a view of this module.
658  * This is used by the participation report.
659  *
660  * Note: This is not used by new logging system. Event with
661  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
662  *       be considered as view action.
663  *
664  * @return array
665  */
666 function choice_get_view_actions() {
667     return array('view','view all','report');
670 /**
671  * List the actions that correspond to a post of this module.
672  * This is used by the participation report.
673  *
674  * Note: This is not used by new logging system. Event with
675  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
676  *       will be considered as post action.
677  *
678  * @return array
679  */
680 function choice_get_post_actions() {
681     return array('choose','choose again');
685 /**
686  * Implementation of the function for printing the form elements that control
687  * whether the course reset functionality affects the choice.
688  *
689  * @param object $mform form passed by reference
690  */
691 function choice_reset_course_form_definition(&$mform) {
692     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
693     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
696 /**
697  * Course reset form defaults.
698  *
699  * @return array
700  */
701 function choice_reset_course_form_defaults($course) {
702     return array('reset_choice'=>1);
705 /**
706  * Actual implementation of the reset course functionality, delete all the
707  * choice responses for course $data->courseid.
708  *
709  * @global object
710  * @global object
711  * @param object $data the data submitted from the reset course.
712  * @return array status array
713  */
714 function choice_reset_userdata($data) {
715     global $CFG, $DB;
717     $componentstr = get_string('modulenameplural', 'choice');
718     $status = array();
720     if (!empty($data->reset_choice)) {
721         $choicessql = "SELECT ch.id
722                        FROM {choice} ch
723                        WHERE ch.course=?";
725         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
726         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
727     }
729     /// updating dates - shift may be negative too
730     if ($data->timeshift) {
731         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
732         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
733     }
735     return $status;
738 /**
739  * @global object
740  * @global object
741  * @global object
742  * @uses CONTEXT_MODULE
743  * @param object $choice
744  * @param object $cm
745  * @param int $groupmode
746  * @param bool $onlyactive Whether to get response data for active users only.
747  * @return array
748  */
749 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
750     global $CFG, $USER, $DB;
752     $context = context_module::instance($cm->id);
754 /// Get the current group
755     if ($groupmode > 0) {
756         $currentgroup = groups_get_activity_group($cm);
757     } else {
758         $currentgroup = 0;
759     }
761 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
762     $allresponses = array();
764 /// First get all the users who have access here
765 /// To start with we assume they are all "unanswered" then move them later
766     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
767             user_picture::fields('u', array('idnumber')), null, 0, 0, $onlyactive);
769 /// Get all the recorded responses for this choice
770     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
772 /// Use the responses to move users into the correct column
774     if ($rawresponses) {
775         $answeredusers = array();
776         foreach ($rawresponses as $response) {
777             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
778                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
779                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
780                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
781                 $answeredusers[] = $response->userid;
782             }
783         }
784         foreach ($answeredusers as $answereduser) {
785             unset($allresponses[0][$answereduser]);
786         }
787     }
788     return $allresponses;
791 /**
792  * Returns all other caps used in module
793  *
794  * @return array
795  */
796 function choice_get_extra_capabilities() {
797     return array('moodle/site:accessallgroups');
800 /**
801  * @uses FEATURE_GROUPS
802  * @uses FEATURE_GROUPINGS
803  * @uses FEATURE_MOD_INTRO
804  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
805  * @uses FEATURE_GRADE_HAS_GRADE
806  * @uses FEATURE_GRADE_OUTCOMES
807  * @param string $feature FEATURE_xx constant for requested feature
808  * @return mixed True if module supports feature, null if doesn't know
809  */
810 function choice_supports($feature) {
811     switch($feature) {
812         case FEATURE_GROUPS:                  return true;
813         case FEATURE_GROUPINGS:               return true;
814         case FEATURE_MOD_INTRO:               return true;
815         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
816         case FEATURE_COMPLETION_HAS_RULES:    return true;
817         case FEATURE_GRADE_HAS_GRADE:         return false;
818         case FEATURE_GRADE_OUTCOMES:          return false;
819         case FEATURE_BACKUP_MOODLE2:          return true;
820         case FEATURE_SHOW_DESCRIPTION:        return true;
822         default: return null;
823     }
826 /**
827  * Adds module specific settings to the settings block
828  *
829  * @param settings_navigation $settings The settings navigation object
830  * @param navigation_node $choicenode The node to add module settings to
831  */
832 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
833     global $PAGE;
835     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
837         $groupmode = groups_get_activity_groupmode($PAGE->cm);
838         if ($groupmode) {
839             groups_get_activity_group($PAGE->cm, true);
840         }
842         $choice = choice_get_choice($PAGE->cm->instance);
844         // Check if we want to include responses from inactive users.
845         $onlyactive = $choice->includeinactive ? false : true;
847         // Big function, approx 6 SQL calls per user.
848         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
850         $allusers = [];
851         foreach($allresponses as $optionid => $userlist) {
852             if ($optionid) {
853                 $allusers = array_merge($allusers, array_keys($userlist));
854             }
855         }
856         $responsecount = count(array_unique($allusers));
857         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
858     }
861 /**
862  * Obtains the automatic completion state for this choice based on any conditions
863  * in forum settings.
864  *
865  * @param object $course Course
866  * @param object $cm Course-module
867  * @param int $userid User ID
868  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
869  * @return bool True if completed, false if not, $type if conditions not set.
870  */
871 function choice_get_completion_state($course, $cm, $userid, $type) {
872     global $CFG,$DB;
874     // Get choice details
875     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
876             MUST_EXIST);
878     // If completion option is enabled, evaluate it and return true/false
879     if($choice->completionsubmit) {
880         return $DB->record_exists('choice_answers', array(
881                 'choiceid'=>$choice->id, 'userid'=>$userid));
882     } else {
883         // Completion option is not enabled so just return $type
884         return $type;
885     }
888 /**
889  * Return a list of page types
890  * @param string $pagetype current page type
891  * @param stdClass $parentcontext Block's parent context
892  * @param stdClass $currentcontext Current context of block
893  */
894 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
895     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
896     return $module_pagetype;
899 /**
900  * Prints choice summaries on MyMoodle Page
901  *
902  * Prints choice name, due date and attempt information on
903  * choice activities that have a deadline that has not already passed
904  * and it is available for completing.
905  * @uses CONTEXT_MODULE
906  * @param array $courses An array of course objects to get choice instances from.
907  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
908  */
909 function choice_print_overview($courses, &$htmlarray) {
910     global $USER, $DB, $OUTPUT;
912     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
913         return;
914     }
915     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
916         return;
917     }
919     $now = time();
920     foreach ($choices as $choice) {
921         if ($choice->timeclose != 0                                      // If this choice is scheduled.
922             and $choice->timeclose >= $now                               // And the deadline has not passed.
923             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
925             // Visibility.
926             $class = (!$choice->visible) ? 'dimmed' : '';
928             // Link to activity.
929             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
930             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
931             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
933              // Deadline.
934             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
936             // Display relevant info based on permissions.
937             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
938                 $attempts = $DB->count_records_sql('SELECT COUNT(DISTINCT userid) FROM {choice_answers} WHERE choiceid = ?',
939                     [$choice->id]);
940                 $url = new moodle_url('/mod/choice/report.php', ['id' => $choice->coursemodule]);
941                 $str .= $OUTPUT->box(html_writer::link($url, get_string('viewallresponses', 'choice', $attempts)), 'info');
943             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
944                 // See if the user has submitted anything.
945                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
946                 if ($answers > 0) {
947                     // User has already selected an answer, nothing to show.
948                     $str = '';
949                 } else {
950                     // User has not made a selection yet.
951                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
952                 }
953             } else {
954                 // Does not have permission to do anything on this choice activity.
955                 $str = '';
956             }
958             // Make sure we have something to display.
959             if (!empty($str)) {
960                 // Generate the containing div.
961                 $str = $OUTPUT->box($str, 'choice overview');
963                 if (empty($htmlarray[$choice->course]['choice'])) {
964                     $htmlarray[$choice->course]['choice'] = $str;
965                 } else {
966                     $htmlarray[$choice->course]['choice'] .= $str;
967                 }
968             }
969         }
970     }
971     return;
975 /**
976  * Get my responses on a given choice.
977  *
978  * @param stdClass $choice Choice record
979  * @return array of choice answers records
980  * @since  Moodle 3.0
981  */
982 function choice_get_my_response($choice) {
983     global $DB, $USER;
984     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
988 /**
989  * Get all the responses on a given choice.
990  *
991  * @param stdClass $choice Choice record
992  * @return array of choice answers records
993  * @since  Moodle 3.0
994  */
995 function choice_get_all_responses($choice) {
996     global $DB;
997     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
1001 /**
1002  * Return true if we are allowd to view the choice results.
1003  *
1004  * @param stdClass $choice Choice record
1005  * @param rows|null $current my choice responses
1006  * @param bool|null $choiceopen if the choice is open
1007  * @return bool true if we can view the results, false otherwise.
1008  * @since  Moodle 3.0
1009  */
1010 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
1012     if (is_null($choiceopen)) {
1013         $timenow = time();
1014         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
1015             $choiceopen = false;
1016         } else {
1017             $choiceopen = true;
1018         }
1019     }
1020     if (empty($current)) {
1021         $current = choice_get_my_response($choice);
1022     }
1024     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
1025        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
1026        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
1027         return true;
1028     }
1029     return false;
1032 /**
1033  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1034  *
1035  * @param  stdClass $choice     choice object
1036  * @param  stdClass $course     course object
1037  * @param  stdClass $cm         course module object
1038  * @param  stdClass $context    context object
1039  * @since Moodle 3.0
1040  */
1041 function choice_view($choice, $course, $cm, $context) {
1043     // Trigger course_module_viewed event.
1044     $params = array(
1045         'context' => $context,
1046         'objectid' => $choice->id
1047     );
1049     $event = \mod_choice\event\course_module_viewed::create($params);
1050     $event->add_record_snapshot('course_modules', $cm);
1051     $event->add_record_snapshot('course', $course);
1052     $event->add_record_snapshot('choice', $choice);
1053     $event->trigger();
1055     // Completion.
1056     $completion = new completion_info($course);
1057     $completion->set_module_viewed($cm);
1060 /**
1061  * Check if a choice is available for the current user.
1062  *
1063  * @param  stdClass  $choice            choice record
1064  * @return array                       status (available or not and possible warnings)
1065  */
1066 function choice_get_availability_status($choice) {
1067     $available = true;
1068     $warnings = array();
1070     if ($choice->timeclose != 0) {
1071         $timenow = time();
1073         if ($choice->timeopen > $timenow) {
1074             $available = false;
1075             $warnings['notopenyet'] = userdate($choice->timeopen);
1076         } else if ($timenow > $choice->timeclose) {
1077             $available = false;
1078             $warnings['expired'] = userdate($choice->timeclose);
1079         }
1080     }
1081     if (!$choice->allowupdate && choice_get_my_response($choice)) {
1082         $available = false;
1083         $warnings['choicesaved'] = '';
1084     }
1086     // Choice is available.
1087     return array($available, $warnings);
1090 /**
1091  * This standard function will check all instances of this module
1092  * and make sure there are up-to-date events created for each of them.
1093  * If courseid = 0, then every chat event in the site is checked, else
1094  * only chat events belonging to the course specified are checked.
1095  * This function is used, in its new format, by restore_refresh_events()
1096  *
1097  * @param int $courseid
1098  * @return bool
1099  */
1100 function choice_refresh_events($courseid = 0) {
1101     global $DB, $CFG;
1102     require_once($CFG->dirroot.'/mod/choice/locallib.php');
1104     if ($courseid) {
1105         if (! $choices = $DB->get_records("choice", array("course" => $courseid))) {
1106             return true;
1107         }
1108     } else {
1109         if (! $choices = $DB->get_records("choice")) {
1110             return true;
1111         }
1112     }
1114     foreach ($choices as $choice) {
1115         choice_set_events($choice);
1116     }
1117     return true;