MDL-59287 calendar_events: Update modules to create all events.
[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 define('CHOICE_EVENT_TYPE_OPEN', 'open');
46 define('CHOICE_EVENT_TYPE_CLOSE', 'close');
48 /** @global array $CHOICE_PUBLISH */
49 global $CHOICE_PUBLISH;
50 $CHOICE_PUBLISH = array (CHOICE_PUBLISH_ANONYMOUS  => get_string('publishanonymous', 'choice'),
51                          CHOICE_PUBLISH_NAMES      => get_string('publishnames', 'choice'));
53 /** @global array $CHOICE_SHOWRESULTS */
54 global $CHOICE_SHOWRESULTS;
55 $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT          => get_string('publishnot', 'choice'),
56                          CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'),
57                          CHOICE_SHOWRESULTS_AFTER_CLOSE  => get_string('publishafterclose', 'choice'),
58                          CHOICE_SHOWRESULTS_ALWAYS       => get_string('publishalways', 'choice'));
60 /** @global array $CHOICE_DISPLAY */
61 global $CHOICE_DISPLAY;
62 $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL   => get_string('displayhorizontal', 'choice'),
63                          CHOICE_DISPLAY_VERTICAL     => get_string('displayvertical','choice'));
65 /// Standard functions /////////////////////////////////////////////////////////
67 /**
68  * @global object
69  * @param object $course
70  * @param object $user
71  * @param object $mod
72  * @param object $choice
73  * @return object|null
74  */
75 function choice_user_outline($course, $user, $mod, $choice) {
76     global $DB;
77     if ($answer = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id))) {
78         $result = new stdClass();
79         $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'";
80         $result->time = $answer->timemodified;
81         return $result;
82     }
83     return NULL;
84 }
86 /**
87  * Callback for the "Complete" report - prints the activity summary for the given user
88  *
89  * @param object $course
90  * @param object $user
91  * @param object $mod
92  * @param object $choice
93  */
94 function choice_user_complete($course, $user, $mod, $choice) {
95     global $DB;
96     if ($answers = $DB->get_records('choice_answers', array("choiceid" => $choice->id, "userid" => $user->id))) {
97         $info = [];
98         foreach ($answers as $answer) {
99             $info[] = "'" . format_string(choice_get_option_text($choice, $answer->optionid)) . "'";
100         }
101         core_collator::asort($info);
102         echo get_string("answered", "choice") . ": ". join(', ', $info) . ". " .
103                 get_string("updated", '', userdate($answer->timemodified));
104     } else {
105         print_string("notanswered", "choice");
106     }
109 /**
110  * Given an object containing all the necessary data,
111  * (defined by the form in mod_form.php) this function
112  * will create a new instance and return the id number
113  * of the new instance.
114  *
115  * @global object
116  * @param object $choice
117  * @return int
118  */
119 function choice_add_instance($choice) {
120     global $DB, $CFG;
121     require_once($CFG->dirroot.'/mod/choice/locallib.php');
123     $choice->timemodified = time();
125     //insert answers
126     $choice->id = $DB->insert_record("choice", $choice);
127     foreach ($choice->option as $key => $value) {
128         $value = trim($value);
129         if (isset($value) && $value <> '') {
130             $option = new stdClass();
131             $option->text = $value;
132             $option->choiceid = $choice->id;
133             if (isset($choice->limit[$key])) {
134                 $option->maxanswers = $choice->limit[$key];
135             }
136             $option->timemodified = time();
137             $DB->insert_record("choice_options", $option);
138         }
139     }
141     // Add calendar events if necessary.
142     choice_set_events($choice);
143     if (!empty($choice->completionexpected)) {
144         \core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id,
145                 $choice->completionexpected);
146     }
148     return $choice->id;
151 /**
152  * Given an object containing all the necessary data,
153  * (defined by the form in mod_form.php) this function
154  * will update an existing instance with new data.
155  *
156  * @global object
157  * @param object $choice
158  * @return bool
159  */
160 function choice_update_instance($choice) {
161     global $DB, $CFG;
162     require_once($CFG->dirroot.'/mod/choice/locallib.php');
164     $choice->id = $choice->instance;
165     $choice->timemodified = time();
167     //update, delete or insert answers
168     foreach ($choice->option as $key => $value) {
169         $value = trim($value);
170         $option = new stdClass();
171         $option->text = $value;
172         $option->choiceid = $choice->id;
173         if (isset($choice->limit[$key])) {
174             $option->maxanswers = $choice->limit[$key];
175         }
176         $option->timemodified = time();
177         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
178             $option->id=$choice->optionid[$key];
179             if (isset($value) && $value <> '') {
180                 $DB->update_record("choice_options", $option);
181             } else {
182                 // Remove the empty (unused) option.
183                 $DB->delete_records("choice_options", array("id" => $option->id));
184                 // Delete any answers associated with this option.
185                 $DB->delete_records("choice_answers", array("choiceid" => $choice->id, "optionid" => $option->id));
186             }
187         } else {
188             if (isset($value) && $value <> '') {
189                 $DB->insert_record("choice_options", $option);
190             }
191         }
192     }
194     // Add calendar events if necessary.
195     choice_set_events($choice);
196     $completionexpected = (!empty($choice->completionexpected)) ? $choice->completionexpected : null;
197     \core_completion\api::update_completion_date_event($choice->coursemodule, 'choice', $choice->id, $completionexpected);
199     return $DB->update_record('choice', $choice);
203 /**
204  * @global object
205  * @param object $choice
206  * @param object $user
207  * @param object $coursemodule
208  * @param array $allresponses
209  * @return array
210  */
211 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
212     global $DB;
214     $cdisplay = array('options'=>array());
216     $cdisplay['limitanswers'] = true;
217     $context = context_module::instance($coursemodule->id);
219     foreach ($choice->option as $optionid => $text) {
220         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
221             $option = new stdClass;
222             $option->attributes = new stdClass;
223             $option->attributes->value = $optionid;
224             $option->text = format_string($text);
225             $option->maxanswers = $choice->maxanswers[$optionid];
226             $option->displaylayout = $choice->display;
228             if (isset($allresponses[$optionid])) {
229                 $option->countanswers = count($allresponses[$optionid]);
230             } else {
231                 $option->countanswers = 0;
232             }
233             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
234                 $option->attributes->checked = true;
235             }
236             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
237                 $option->attributes->disabled = true;
238             }
239             $cdisplay['options'][] = $option;
240         }
241     }
243     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
245     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
246         $cdisplay['allowupdate'] = true;
247     }
249     if ($choice->showpreview && $choice->timeopen > time()) {
250         $cdisplay['previewonly'] = true;
251     }
253     return $cdisplay;
256 /**
257  * Modifies responses of other users adding the option $newoptionid to them
258  *
259  * @param array $userids list of users to add option to (must be users without any answers yet)
260  * @param array $answerids list of existing attempt ids of users (will be either appended or
261  *      substituted with the newoptionid, depending on $choice->allowmultiple)
262  * @param int $newoptionid
263  * @param stdClass $choice choice object, result of {@link choice_get_choice()}
264  * @param stdClass $cm
265  * @param stdClass $course
266  */
267 function choice_modify_responses($userids, $answerids, $newoptionid, $choice, $cm, $course) {
268     // Get all existing responses and the list of non-respondents.
269     $groupmode = groups_get_activity_groupmode($cm);
270     $onlyactive = $choice->includeinactive ? false : true;
271     $allresponses = choice_get_response_data($choice, $cm, $groupmode, $onlyactive);
273     // Check that the option value is valid.
274     if (!$newoptionid || !isset($choice->option[$newoptionid])) {
275         return;
276     }
278     // First add responses for users who did not make any choice yet.
279     foreach ($userids as $userid) {
280         if (isset($allresponses[0][$userid])) {
281             choice_user_submit_response($newoptionid, $choice, $userid, $course, $cm);
282         }
283     }
285     // Create the list of all options already selected by each user.
286     $optionsbyuser = []; // Mapping userid=>array of chosen choice options.
287     $usersbyanswer = []; // Mapping answerid=>userid (which answer belongs to each user).
288     foreach ($allresponses as $optionid => $responses) {
289         if ($optionid > 0) {
290             foreach ($responses as $userid => $userresponse) {
291                 $optionsbyuser += [$userid => []];
292                 $optionsbyuser[$userid][] = $optionid;
293                 $usersbyanswer[$userresponse->answerid] = $userid;
294             }
295         }
296     }
298     // Go through the list of submitted attemptids and find which users answers need to be updated.
299     foreach ($answerids as $answerid) {
300         if (isset($usersbyanswer[$answerid])) {
301             $userid = $usersbyanswer[$answerid];
302             if (!in_array($newoptionid, $optionsbyuser[$userid])) {
303                 $options = $choice->allowmultiple ?
304                         array_merge($optionsbyuser[$userid], [$newoptionid]) : $newoptionid;
305                 choice_user_submit_response($options, $choice, $userid, $course, $cm);
306             }
307         }
308     }
311 /**
312  * Process user submitted answers for a choice,
313  * and either updating them or saving new answers.
314  *
315  * @param int $formanswer users submitted answers.
316  * @param object $choice the selected choice.
317  * @param int $userid user identifier.
318  * @param object $course current course.
319  * @param object $cm course context.
320  * @return void
321  */
322 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
323     global $DB, $CFG, $USER;
324     require_once($CFG->libdir.'/completionlib.php');
326     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
328     if (empty($formanswer)) {
329         print_error('atleastoneoption', 'choice', $continueurl);
330     }
332     if (is_array($formanswer)) {
333         if (!$choice->allowmultiple) {
334             print_error('multiplenotallowederror', 'choice', $continueurl);
335         }
336         $formanswers = $formanswer;
337     } else {
338         $formanswers = array($formanswer);
339     }
341     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
342     foreach ($formanswers as $key => $val) {
343         if (!isset($options[$val])) {
344             print_error('cannotsubmit', 'choice', $continueurl);
345         }
346     }
347     // Start lock to prevent synchronous access to the same data
348     // before it's updated, if using limits.
349     if ($choice->limitanswers) {
350         $timeout = 10;
351         $locktype = 'mod_choice_choice_user_submit_response';
352         // Limiting access to this choice.
353         $resouce = 'choiceid:' . $choice->id;
354         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
356         // Opening the lock.
357         $choicelock = $lockfactory->get_lock($resouce, $timeout, MINSECS);
358         if (!$choicelock) {
359             print_error('cannotsubmit', 'choice', $continueurl);
360         }
361     }
363     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
364     $context = context_module::instance($cm->id);
366     $choicesexceeded = false;
367     $countanswers = array();
368     foreach ($formanswers as $val) {
369         $countanswers[$val] = 0;
370     }
371     if($choice->limitanswers) {
372         // Find out whether groups are being used and enabled
373         if (groups_get_activity_groupmode($cm) > 0) {
374             $currentgroup = groups_get_activity_group($cm);
375         } else {
376             $currentgroup = 0;
377         }
379         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
381         if($currentgroup) {
382             // If groups are being used, retrieve responses only for users in
383             // current group
384             global $CFG;
386             $params['groupid'] = $currentgroup;
387             $sql = "SELECT ca.*
388                       FROM {choice_answers} ca
389                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
390                      WHERE optionid $insql
391                        AND gm.groupid= :groupid";
392         } else {
393             // Groups are not used, retrieve all answers for this option ID
394             $sql = "SELECT ca.*
395                       FROM {choice_answers} ca
396                      WHERE optionid $insql";
397         }
399         $answers = $DB->get_records_sql($sql, $params);
400         if ($answers) {
401             foreach ($answers as $a) { //only return enrolled users.
402                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
403                     $countanswers[$a->optionid]++;
404                 }
405             }
406         }
407         foreach ($countanswers as $opt => $count) {
408             if ($count >= $choice->maxanswers[$opt]) {
409                 $choicesexceeded = true;
410                 break;
411             }
412         }
413     }
415     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
416     $answersnapshots = array();
417     $deletedanswersnapshots = array();
418     if (!($choice->limitanswers && $choicesexceeded)) {
419         if ($current) {
420             // Update an existing answer.
421             $existingchoices = array();
422             foreach ($current as $c) {
423                 if (in_array($c->optionid, $formanswers)) {
424                     $existingchoices[] = $c->optionid;
425                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
426                 } else {
427                     $deletedanswersnapshots[] = $c;
428                     $DB->delete_records('choice_answers', array('id' => $c->id));
429                 }
430             }
432             // Add new ones.
433             foreach ($formanswers as $f) {
434                 if (!in_array($f, $existingchoices)) {
435                     $newanswer = new stdClass();
436                     $newanswer->optionid = $f;
437                     $newanswer->choiceid = $choice->id;
438                     $newanswer->userid = $userid;
439                     $newanswer->timemodified = time();
440                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
441                     $answersnapshots[] = $newanswer;
442                 }
443             }
444         } else {
445             // Add new answer.
446             foreach ($formanswers as $answer) {
447                 $newanswer = new stdClass();
448                 $newanswer->choiceid = $choice->id;
449                 $newanswer->userid = $userid;
450                 $newanswer->optionid = $answer;
451                 $newanswer->timemodified = time();
452                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
453                 $answersnapshots[] = $newanswer;
454             }
456             // Update completion state
457             $completion = new completion_info($course);
458             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
459                 $completion->update_state($cm, COMPLETION_COMPLETE);
460             }
461         }
462     } else {
463         // Check to see if current choice already selected - if not display error.
464         $currentids = array_keys($current);
466         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
467             // Release lock before error.
468             $choicelock->release();
469             print_error('choicefull', 'choice', $continueurl);
470         }
471     }
473     // Release lock.
474     if (isset($choicelock)) {
475         $choicelock->release();
476     }
478     // Trigger events.
479     foreach ($deletedanswersnapshots as $answer) {
480         \mod_choice\event\answer_deleted::create_from_object($answer, $choice, $cm, $course)->trigger();
481     }
482     foreach ($answersnapshots as $answer) {
483         \mod_choice\event\answer_created::create_from_object($answer, $choice, $cm, $course)->trigger();
484     }
487 /**
488  * @param array $user
489  * @param object $cm
490  * @return void Output is echo'd
491  */
492 function choice_show_reportlink($user, $cm) {
493     $userschosen = array();
494     foreach($user as $optionid => $userlist) {
495         if ($optionid) {
496             $userschosen = array_merge($userschosen, array_keys($userlist));
497         }
498     }
499     $responsecount = count(array_unique($userschosen));
501     echo '<div class="reportlink">';
502     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
503     echo '</div>';
506 /**
507  * @global object
508  * @param object $choice
509  * @param object $course
510  * @param object $coursemodule
511  * @param array $allresponses
513  *  * @param bool $allresponses
514  * @return object
515  */
516 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
517     global $OUTPUT;
519     $display = clone($choice);
520     $display->coursemoduleid = $cm->id;
521     $display->courseid = $course->id;
523     if (!empty($choice->showunanswered)) {
524         $choice->option[0] = get_string('notanswered', 'choice');
525         $choice->maxanswers[0] = 0;
526     }
528     // Remove from the list of non-respondents the users who do not have access to this activity.
529     if (!empty($display->showunanswered) && $allresponses[0]) {
530         $info = new \core_availability\info_module(cm_info::create($cm));
531         $allresponses[0] = $info->filter_user_list($allresponses[0]);
532     }
534     //overwrite options value;
535     $display->options = array();
536     $allusers = [];
537     foreach ($choice->option as $optionid => $optiontext) {
538         $display->options[$optionid] = new stdClass;
539         $display->options[$optionid]->text = format_string($optiontext, true,
540             ['context' => context_module::instance($cm->id)]);
541         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
543         if (array_key_exists($optionid, $allresponses)) {
544             $display->options[$optionid]->user = $allresponses[$optionid];
545             $allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
546         }
547     }
548     unset($display->option);
549     unset($display->maxanswers);
551     $display->numberofuser = count(array_unique($allusers));
552     $context = context_module::instance($cm->id);
553     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
554     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
555     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
557     if (empty($allresponses)) {
558         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
559         return false;
560     }
562     return $display;
565 /**
566  * @global object
567  * @param array $attemptids
568  * @param object $choice Choice main table row
569  * @param object $cm Course-module object
570  * @param object $course Course object
571  * @return bool
572  */
573 function choice_delete_responses($attemptids, $choice, $cm, $course) {
574     global $DB, $CFG, $USER;
575     require_once($CFG->libdir.'/completionlib.php');
577     if(!is_array($attemptids) || empty($attemptids)) {
578         return false;
579     }
581     foreach($attemptids as $num => $attemptid) {
582         if(empty($attemptid)) {
583             unset($attemptids[$num]);
584         }
585     }
587     $completion = new completion_info($course);
588     foreach($attemptids as $attemptid) {
589         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
590             // Trigger the event answer deleted.
591             \mod_choice\event\answer_deleted::create_from_object($todelete, $choice, $cm, $course)->trigger();
592             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
593         }
594     }
596     // Update completion state.
597     if ($completion->is_enabled($cm) && $choice->completionsubmit) {
598         $completion->update_state($cm, COMPLETION_INCOMPLETE);
599     }
601     return true;
605 /**
606  * Given an ID of an instance of this module,
607  * this function will permanently delete the instance
608  * and any data that depends on it.
609  *
610  * @global object
611  * @param int $id
612  * @return bool
613  */
614 function choice_delete_instance($id) {
615     global $DB;
617     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
618         return false;
619     }
621     $result = true;
623     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
624         $result = false;
625     }
627     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
628         $result = false;
629     }
631     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
632         $result = false;
633     }
634     // Remove old calendar events.
635     if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
636         $result = false;
637     }
639     return $result;
642 /**
643  * Returns text string which is the answer that matches the id
644  *
645  * @global object
646  * @param object $choice
647  * @param int $id
648  * @return string
649  */
650 function choice_get_option_text($choice, $id) {
651     global $DB;
653     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
654         return $result->text;
655     } else {
656         return get_string("notanswered", "choice");
657     }
660 /**
661  * Gets a full choice record
662  *
663  * @global object
664  * @param int $choiceid
665  * @return object|bool The choice or false
666  */
667 function choice_get_choice($choiceid) {
668     global $DB;
670     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
671         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
672             foreach ($options as $option) {
673                 $choice->option[$option->id] = $option->text;
674                 $choice->maxanswers[$option->id] = $option->maxanswers;
675             }
676             return $choice;
677         }
678     }
679     return false;
682 /**
683  * List the actions that correspond to a view of this module.
684  * This is used by the participation report.
685  *
686  * Note: This is not used by new logging system. Event with
687  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
688  *       be considered as view action.
689  *
690  * @return array
691  */
692 function choice_get_view_actions() {
693     return array('view','view all','report');
696 /**
697  * List the actions that correspond to a post of this module.
698  * This is used by the participation report.
699  *
700  * Note: This is not used by new logging system. Event with
701  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
702  *       will be considered as post action.
703  *
704  * @return array
705  */
706 function choice_get_post_actions() {
707     return array('choose','choose again');
711 /**
712  * Implementation of the function for printing the form elements that control
713  * whether the course reset functionality affects the choice.
714  *
715  * @param object $mform form passed by reference
716  */
717 function choice_reset_course_form_definition(&$mform) {
718     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
719     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
722 /**
723  * Course reset form defaults.
724  *
725  * @return array
726  */
727 function choice_reset_course_form_defaults($course) {
728     return array('reset_choice'=>1);
731 /**
732  * Actual implementation of the reset course functionality, delete all the
733  * choice responses for course $data->courseid.
734  *
735  * @global object
736  * @global object
737  * @param object $data the data submitted from the reset course.
738  * @return array status array
739  */
740 function choice_reset_userdata($data) {
741     global $CFG, $DB;
743     $componentstr = get_string('modulenameplural', 'choice');
744     $status = array();
746     if (!empty($data->reset_choice)) {
747         $choicessql = "SELECT ch.id
748                        FROM {choice} ch
749                        WHERE ch.course=?";
751         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
752         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
753     }
755     /// updating dates - shift may be negative too
756     if ($data->timeshift) {
757         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
758         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
759     }
761     return $status;
764 /**
765  * @global object
766  * @global object
767  * @global object
768  * @uses CONTEXT_MODULE
769  * @param object $choice
770  * @param object $cm
771  * @param int $groupmode
772  * @param bool $onlyactive Whether to get response data for active users only.
773  * @return array
774  */
775 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
776     global $CFG, $USER, $DB;
778     $context = context_module::instance($cm->id);
780 /// Get the current group
781     if ($groupmode > 0) {
782         $currentgroup = groups_get_activity_group($cm);
783     } else {
784         $currentgroup = 0;
785     }
787 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
788     $allresponses = array();
790 /// First get all the users who have access here
791 /// To start with we assume they are all "unanswered" then move them later
792     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
793             user_picture::fields('u', array('idnumber')), null, 0, 0, $onlyactive);
795 /// Get all the recorded responses for this choice
796     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
798 /// Use the responses to move users into the correct column
800     if ($rawresponses) {
801         $answeredusers = array();
802         foreach ($rawresponses as $response) {
803             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
804                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
805                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
806                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
807                 $answeredusers[] = $response->userid;
808             }
809         }
810         foreach ($answeredusers as $answereduser) {
811             unset($allresponses[0][$answereduser]);
812         }
813     }
814     return $allresponses;
817 /**
818  * Returns all other caps used in module
819  *
820  * @return array
821  */
822 function choice_get_extra_capabilities() {
823     return array('moodle/site:accessallgroups');
826 /**
827  * @uses FEATURE_GROUPS
828  * @uses FEATURE_GROUPINGS
829  * @uses FEATURE_MOD_INTRO
830  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
831  * @uses FEATURE_GRADE_HAS_GRADE
832  * @uses FEATURE_GRADE_OUTCOMES
833  * @param string $feature FEATURE_xx constant for requested feature
834  * @return mixed True if module supports feature, null if doesn't know
835  */
836 function choice_supports($feature) {
837     switch($feature) {
838         case FEATURE_GROUPS:                  return true;
839         case FEATURE_GROUPINGS:               return true;
840         case FEATURE_MOD_INTRO:               return true;
841         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
842         case FEATURE_COMPLETION_HAS_RULES:    return true;
843         case FEATURE_GRADE_HAS_GRADE:         return false;
844         case FEATURE_GRADE_OUTCOMES:          return false;
845         case FEATURE_BACKUP_MOODLE2:          return true;
846         case FEATURE_SHOW_DESCRIPTION:        return true;
848         default: return null;
849     }
852 /**
853  * Adds module specific settings to the settings block
854  *
855  * @param settings_navigation $settings The settings navigation object
856  * @param navigation_node $choicenode The node to add module settings to
857  */
858 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
859     global $PAGE;
861     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
863         $groupmode = groups_get_activity_groupmode($PAGE->cm);
864         if ($groupmode) {
865             groups_get_activity_group($PAGE->cm, true);
866         }
868         $choice = choice_get_choice($PAGE->cm->instance);
870         // Check if we want to include responses from inactive users.
871         $onlyactive = $choice->includeinactive ? false : true;
873         // Big function, approx 6 SQL calls per user.
874         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
876         $allusers = [];
877         foreach($allresponses as $optionid => $userlist) {
878             if ($optionid) {
879                 $allusers = array_merge($allusers, array_keys($userlist));
880             }
881         }
882         $responsecount = count(array_unique($allusers));
883         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
884     }
887 /**
888  * Obtains the automatic completion state for this choice based on any conditions
889  * in forum settings.
890  *
891  * @param object $course Course
892  * @param object $cm Course-module
893  * @param int $userid User ID
894  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
895  * @return bool True if completed, false if not, $type if conditions not set.
896  */
897 function choice_get_completion_state($course, $cm, $userid, $type) {
898     global $CFG,$DB;
900     // Get choice details
901     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
902             MUST_EXIST);
904     // If completion option is enabled, evaluate it and return true/false
905     if($choice->completionsubmit) {
906         return $DB->record_exists('choice_answers', array(
907                 'choiceid'=>$choice->id, 'userid'=>$userid));
908     } else {
909         // Completion option is not enabled so just return $type
910         return $type;
911     }
914 /**
915  * Return a list of page types
916  * @param string $pagetype current page type
917  * @param stdClass $parentcontext Block's parent context
918  * @param stdClass $currentcontext Current context of block
919  */
920 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
921     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
922     return $module_pagetype;
925 /**
926  * Prints choice summaries on MyMoodle Page
927  *
928  * Prints choice name, due date and attempt information on
929  * choice activities that have a deadline that has not already passed
930  * and it is available for completing.
931  *
932  * @deprecated since 3.3
933  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
934  * @uses CONTEXT_MODULE
935  * @param array $courses An array of course objects to get choice instances from.
936  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
937  */
938 function choice_print_overview($courses, &$htmlarray) {
939     global $USER, $DB, $OUTPUT;
941     debugging('The function choice_print_overview() is now deprecated.', DEBUG_DEVELOPER);
943     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
944         return;
945     }
946     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
947         return;
948     }
950     $now = time();
951     foreach ($choices as $choice) {
952         if ($choice->timeclose != 0                                      // If this choice is scheduled.
953             and $choice->timeclose >= $now                               // And the deadline has not passed.
954             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
956             // Visibility.
957             $class = (!$choice->visible) ? 'dimmed' : '';
959             // Link to activity.
960             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
961             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
962             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
964              // Deadline.
965             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
967             // Display relevant info based on permissions.
968             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
969                 $attempts = $DB->count_records_sql('SELECT COUNT(DISTINCT userid) FROM {choice_answers} WHERE choiceid = ?',
970                     [$choice->id]);
971                 $url = new moodle_url('/mod/choice/report.php', ['id' => $choice->coursemodule]);
972                 $str .= $OUTPUT->box(html_writer::link($url, get_string('viewallresponses', 'choice', $attempts)), 'info');
974             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
975                 // See if the user has submitted anything.
976                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
977                 if ($answers > 0) {
978                     // User has already selected an answer, nothing to show.
979                     $str = '';
980                 } else {
981                     // User has not made a selection yet.
982                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
983                 }
984             } else {
985                 // Does not have permission to do anything on this choice activity.
986                 $str = '';
987             }
989             // Make sure we have something to display.
990             if (!empty($str)) {
991                 // Generate the containing div.
992                 $str = $OUTPUT->box($str, 'choice overview');
994                 if (empty($htmlarray[$choice->course]['choice'])) {
995                     $htmlarray[$choice->course]['choice'] = $str;
996                 } else {
997                     $htmlarray[$choice->course]['choice'] .= $str;
998                 }
999             }
1000         }
1001     }
1002     return;
1006 /**
1007  * Get my responses on a given choice.
1008  *
1009  * @param stdClass $choice Choice record
1010  * @return array of choice answers records
1011  * @since  Moodle 3.0
1012  */
1013 function choice_get_my_response($choice) {
1014     global $DB, $USER;
1015     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
1019 /**
1020  * Get all the responses on a given choice.
1021  *
1022  * @param stdClass $choice Choice record
1023  * @return array of choice answers records
1024  * @since  Moodle 3.0
1025  */
1026 function choice_get_all_responses($choice) {
1027     global $DB;
1028     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
1032 /**
1033  * Return true if we are allowd to view the choice results.
1034  *
1035  * @param stdClass $choice Choice record
1036  * @param rows|null $current my choice responses
1037  * @param bool|null $choiceopen if the choice is open
1038  * @return bool true if we can view the results, false otherwise.
1039  * @since  Moodle 3.0
1040  */
1041 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
1043     if (is_null($choiceopen)) {
1044         $timenow = time();
1046         if ($choice->timeopen != 0 && $timenow < $choice->timeopen) {
1047             // If the choice is not available, we can't see the results.
1048             return false;
1049         }
1051         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
1052             $choiceopen = false;
1053         } else {
1054             $choiceopen = true;
1055         }
1056     }
1057     if (empty($current)) {
1058         $current = choice_get_my_response($choice);
1059     }
1061     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
1062        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
1063        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
1064         return true;
1065     }
1066     return false;
1069 /**
1070  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1071  *
1072  * @param  stdClass $choice     choice object
1073  * @param  stdClass $course     course object
1074  * @param  stdClass $cm         course module object
1075  * @param  stdClass $context    context object
1076  * @since Moodle 3.0
1077  */
1078 function choice_view($choice, $course, $cm, $context) {
1080     // Trigger course_module_viewed event.
1081     $params = array(
1082         'context' => $context,
1083         'objectid' => $choice->id
1084     );
1086     $event = \mod_choice\event\course_module_viewed::create($params);
1087     $event->add_record_snapshot('course_modules', $cm);
1088     $event->add_record_snapshot('course', $course);
1089     $event->add_record_snapshot('choice', $choice);
1090     $event->trigger();
1092     // Completion.
1093     $completion = new completion_info($course);
1094     $completion->set_module_viewed($cm);
1097 /**
1098  * Check if a choice is available for the current user.
1099  *
1100  * @param  stdClass  $choice            choice record
1101  * @return array                       status (available or not and possible warnings)
1102  */
1103 function choice_get_availability_status($choice) {
1104     $available = true;
1105     $warnings = array();
1107     $timenow = time();
1109     if (!empty($choice->timeopen) && ($choice->timeopen > $timenow)) {
1110         $available = false;
1111         $warnings['notopenyet'] = userdate($choice->timeopen);
1112     } else if (!empty($choice->timeclose) && ($timenow > $choice->timeclose)) {
1113         $available = false;
1114         $warnings['expired'] = userdate($choice->timeclose);
1115     }
1116     if (!$choice->allowupdate && choice_get_my_response($choice)) {
1117         $available = false;
1118         $warnings['choicesaved'] = '';
1119     }
1121     // Choice is available.
1122     return array($available, $warnings);
1125 /**
1126  * This standard function will check all instances of this module
1127  * and make sure there are up-to-date events created for each of them.
1128  * If courseid = 0, then every choice event in the site is checked, else
1129  * only choice events belonging to the course specified are checked.
1130  * This function is used, in its new format, by restore_refresh_events()
1131  *
1132  * @param int $courseid
1133  * @param int|stdClass $instance Choice module instance or ID.
1134  * @param int|stdClass $cm Course module object or ID (not used in this module).
1135  * @return bool
1136  */
1137 function choice_refresh_events($courseid = 0, $instance = null, $cm = null) {
1138     global $DB, $CFG;
1139     require_once($CFG->dirroot.'/mod/choice/locallib.php');
1141     // If we have instance information then we can just update the one event instead of updating all events.
1142     if (isset($instance)) {
1143         if (!is_object($instance)) {
1144             $instance = $DB->get_record('choice', array('id' => $instance), '*', MUST_EXIST);
1145         }
1146         choice_set_events($instance);
1147         return true;
1148     }
1150     if ($courseid) {
1151         if (! $choices = $DB->get_records("choice", array("course" => $courseid))) {
1152             return true;
1153         }
1154     } else {
1155         if (! $choices = $DB->get_records("choice")) {
1156             return true;
1157         }
1158     }
1160     foreach ($choices as $choice) {
1161         choice_set_events($choice);
1162     }
1163     return true;
1166 /**
1167  * Check if the module has any update that affects the current user since a given time.
1168  *
1169  * @param  cm_info $cm course module data
1170  * @param  int $from the time to check updates from
1171  * @param  array $filter  if we need to check only specific updates
1172  * @return stdClass an object with the different type of areas indicating if they were updated or not
1173  * @since Moodle 3.2
1174  */
1175 function choice_check_updates_since(cm_info $cm, $from, $filter = array()) {
1176     global $DB;
1178     $updates = new stdClass();
1179     $choice = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1180     list($available, $warnings) = choice_get_availability_status($choice);
1181     if (!$available) {
1182         return $updates;
1183     }
1185     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
1187     if (!choice_can_view_results($choice)) {
1188         return $updates;
1189     }
1190     // Check if there are new responses in the choice.
1191     $updates->answers = (object) array('updated' => false);
1192     $select = 'choiceid = :id AND timemodified > :since';
1193     $params = array('id' => $choice->id, 'since' => $from);
1194     $answers = $DB->get_records_select('choice_answers', $select, $params, '', 'id');
1195     if (!empty($answers)) {
1196         $updates->answers->updated = true;
1197         $updates->answers->itemids = array_keys($answers);
1198     }
1200     return $updates;
1203 /**
1204  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1205  *
1206  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1207  * is not displayed on the block.
1208  *
1209  * @param calendar_event $event
1210  * @param \core_calendar\action_factory $factory
1211  * @return \core_calendar\local\event\entities\action_interface|null
1212  */
1213 function mod_choice_core_calendar_provide_event_action(calendar_event $event,
1214                                                        \core_calendar\action_factory $factory) {
1216     $cm = get_fast_modinfo($event->courseid)->instances['choice'][$event->instance];
1217     $now = time();
1219     if (!empty($cm->customdata['timeclose']) && $cm->customdata['timeclose'] < $now) {
1220         // The choice has closed so the user can no longer submit anything.
1221         return null;
1222     }
1224     // The choice is actionable if we don't have a start time or the start time is
1225     // in the past.
1226     $actionable = (empty($cm->customdata['timeopen']) || $cm->customdata['timeopen'] <= $now);
1228     if ($actionable && choice_get_my_response((object)['id' => $event->instance])) {
1229         // There is no action if the user has already submitted their choice.
1230         return null;
1231     }
1233     return $factory->create_instance(
1234         get_string('viewchoices', 'choice'),
1235         new \moodle_url('/mod/choice/view.php', array('id' => $cm->id)),
1236         1,
1237         $actionable
1238     );
1241 /**
1242  * Get icon mapping for font-awesome.
1243  */
1244 function mod_choice_get_fontawesome_icon_map() {
1245     return [
1246         'mod_choice:row' => 'fa-info',
1247         'mod_choice:column' => 'fa-columns',
1248     ];
1251 /**
1252  * Add a get_coursemodule_info function in case any choice type wants to add 'extra' information
1253  * for the course (see resource).
1254  *
1255  * Given a course_module object, this function returns any "extra" information that may be needed
1256  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
1257  *
1258  * @param stdClass $coursemodule The coursemodule object (record).
1259  * @return cached_cm_info An object on information that the courses
1260  *                        will know about (most noticeably, an icon).
1261  */
1262 function choice_get_coursemodule_info($coursemodule) {
1263     global $DB;
1265     $dbparams = ['id' => $coursemodule->instance];
1266     $fields = 'id, name, intro, introformat, completionsubmit, timeopen, timeclose';
1267     if (!$choice = $DB->get_record('choice', $dbparams, $fields)) {
1268         return false;
1269     }
1271     $result = new cached_cm_info();
1272     $result->name = $choice->name;
1274     if ($coursemodule->showdescription) {
1275         // Convert intro to html. Do not filter cached version, filters run at display time.
1276         $result->content = format_module_intro('choice', $choice, $coursemodule->id, false);
1277     }
1279     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
1280     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
1281         $result->customdata['customcompletionrules']['completionsubmit'] = $choice->completionsubmit;
1282     }
1283     // Populate some other values that can be used in calendar or on dashboard.
1284     if ($choice->timeopen) {
1285         $result->customdata['timeopen'] = $choice->timeopen;
1286     }
1287     if ($choice->timeclose) {
1288         $result->customdata['timeclose'] = $choice->timeclose;
1289     }
1291     return $result;
1294 /**
1295  * Callback which returns human-readable strings describing the active completion custom rules for the module instance.
1296  *
1297  * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']
1298  * @return array $descriptions the array of descriptions for the custom rules.
1299  */
1300 function mod_choice_get_completion_active_rule_descriptions($cm) {
1301     // Values will be present in cm_info, and we assume these are up to date.
1302     if (empty($cm->customdata['customcompletionrules'])
1303         || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) {
1304         return [];
1305     }
1307     $descriptions = [];
1308     foreach ($cm->customdata['customcompletionrules'] as $key => $val) {
1309         switch ($key) {
1310             case 'completionsubmit':
1311                 if (empty($val)) {
1312                     continue;
1313                 }
1314                 $descriptions[] = get_string('completionsubmit', 'choice');
1315                 break;
1316             default:
1317                 break;
1318         }
1319     }
1320     return $descriptions;