58ad781da5d6d665319f1a3a96b7b2aefc540dc8
[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);
144     return $choice->id;
147 /**
148  * Given an object containing all the necessary data,
149  * (defined by the form in mod_form.php) this function
150  * will update an existing instance with new data.
151  *
152  * @global object
153  * @param object $choice
154  * @return bool
155  */
156 function choice_update_instance($choice) {
157     global $DB, $CFG;
158     require_once($CFG->dirroot.'/mod/choice/locallib.php');
160     $choice->id = $choice->instance;
161     $choice->timemodified = time();
163     //update, delete or insert answers
164     foreach ($choice->option as $key => $value) {
165         $value = trim($value);
166         $option = new stdClass();
167         $option->text = $value;
168         $option->choiceid = $choice->id;
169         if (isset($choice->limit[$key])) {
170             $option->maxanswers = $choice->limit[$key];
171         }
172         $option->timemodified = time();
173         if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record
174             $option->id=$choice->optionid[$key];
175             if (isset($value) && $value <> '') {
176                 $DB->update_record("choice_options", $option);
177             } else {
178                 // Remove the empty (unused) option.
179                 $DB->delete_records("choice_options", array("id" => $option->id));
180                 // Delete any answers associated with this option.
181                 $DB->delete_records("choice_answers", array("choiceid" => $choice->id, "optionid" => $option->id));
182             }
183         } else {
184             if (isset($value) && $value <> '') {
185                 $DB->insert_record("choice_options", $option);
186             }
187         }
188     }
190     // Add calendar events if necessary.
191     choice_set_events($choice);
193     return $DB->update_record('choice', $choice);
197 /**
198  * @global object
199  * @param object $choice
200  * @param object $user
201  * @param object $coursemodule
202  * @param array $allresponses
203  * @return array
204  */
205 function choice_prepare_options($choice, $user, $coursemodule, $allresponses) {
206     global $DB;
208     $cdisplay = array('options'=>array());
210     $cdisplay['limitanswers'] = true;
211     $context = context_module::instance($coursemodule->id);
213     foreach ($choice->option as $optionid => $text) {
214         if (isset($text)) { //make sure there are no dud entries in the db with blank text values.
215             $option = new stdClass;
216             $option->attributes = new stdClass;
217             $option->attributes->value = $optionid;
218             $option->text = format_string($text);
219             $option->maxanswers = $choice->maxanswers[$optionid];
220             $option->displaylayout = $choice->display;
222             if (isset($allresponses[$optionid])) {
223                 $option->countanswers = count($allresponses[$optionid]);
224             } else {
225                 $option->countanswers = 0;
226             }
227             if ($DB->record_exists('choice_answers', array('choiceid' => $choice->id, 'userid' => $user->id, 'optionid' => $optionid))) {
228                 $option->attributes->checked = true;
229             }
230             if ( $choice->limitanswers && ($option->countanswers >= $option->maxanswers) && empty($option->attributes->checked)) {
231                 $option->attributes->disabled = true;
232             }
233             $cdisplay['options'][] = $option;
234         }
235     }
237     $cdisplay['hascapability'] = is_enrolled($context, NULL, 'mod/choice:choose'); //only enrolled users are allowed to make a choice
239     if ($choice->allowupdate && $DB->record_exists('choice_answers', array('choiceid'=> $choice->id, 'userid'=> $user->id))) {
240         $cdisplay['allowupdate'] = true;
241     }
243     if ($choice->showpreview && $choice->timeopen > time()) {
244         $cdisplay['previewonly'] = true;
245     }
247     return $cdisplay;
250 /**
251  * Modifies responses of other users adding the option $newoptionid to them
252  *
253  * @param array $userids list of users to add option to (must be users without any answers yet)
254  * @param array $answerids list of existing attempt ids of users (will be either appended or
255  *      substituted with the newoptionid, depending on $choice->allowmultiple)
256  * @param int $newoptionid
257  * @param stdClass $choice choice object, result of {@link choice_get_choice()}
258  * @param stdClass $cm
259  * @param stdClass $course
260  */
261 function choice_modify_responses($userids, $answerids, $newoptionid, $choice, $cm, $course) {
262     // Get all existing responses and the list of non-respondents.
263     $groupmode = groups_get_activity_groupmode($cm);
264     $onlyactive = $choice->includeinactive ? false : true;
265     $allresponses = choice_get_response_data($choice, $cm, $groupmode, $onlyactive);
267     // Check that the option value is valid.
268     if (!$newoptionid || !isset($choice->option[$newoptionid])) {
269         return;
270     }
272     // First add responses for users who did not make any choice yet.
273     foreach ($userids as $userid) {
274         if (isset($allresponses[0][$userid])) {
275             choice_user_submit_response($newoptionid, $choice, $userid, $course, $cm);
276         }
277     }
279     // Create the list of all options already selected by each user.
280     $optionsbyuser = []; // Mapping userid=>array of chosen choice options.
281     $usersbyanswer = []; // Mapping answerid=>userid (which answer belongs to each user).
282     foreach ($allresponses as $optionid => $responses) {
283         if ($optionid > 0) {
284             foreach ($responses as $userid => $userresponse) {
285                 $optionsbyuser += [$userid => []];
286                 $optionsbyuser[$userid][] = $optionid;
287                 $usersbyanswer[$userresponse->answerid] = $userid;
288             }
289         }
290     }
292     // Go through the list of submitted attemptids and find which users answers need to be updated.
293     foreach ($answerids as $answerid) {
294         if (isset($usersbyanswer[$answerid])) {
295             $userid = $usersbyanswer[$answerid];
296             if (!in_array($newoptionid, $optionsbyuser[$userid])) {
297                 $options = $choice->allowmultiple ?
298                         array_merge($optionsbyuser[$userid], [$newoptionid]) : $newoptionid;
299                 choice_user_submit_response($options, $choice, $userid, $course, $cm);
300             }
301         }
302     }
305 /**
306  * Process user submitted answers for a choice,
307  * and either updating them or saving new answers.
308  *
309  * @param int $formanswer users submitted answers.
310  * @param object $choice the selected choice.
311  * @param int $userid user identifier.
312  * @param object $course current course.
313  * @param object $cm course context.
314  * @return void
315  */
316 function choice_user_submit_response($formanswer, $choice, $userid, $course, $cm) {
317     global $DB, $CFG, $USER;
318     require_once($CFG->libdir.'/completionlib.php');
320     $continueurl = new moodle_url('/mod/choice/view.php', array('id' => $cm->id));
322     if (empty($formanswer)) {
323         print_error('atleastoneoption', 'choice', $continueurl);
324     }
326     if (is_array($formanswer)) {
327         if (!$choice->allowmultiple) {
328             print_error('multiplenotallowederror', 'choice', $continueurl);
329         }
330         $formanswers = $formanswer;
331     } else {
332         $formanswers = array($formanswer);
333     }
335     $options = $DB->get_records('choice_options', array('choiceid' => $choice->id), '', 'id');
336     foreach ($formanswers as $key => $val) {
337         if (!isset($options[$val])) {
338             print_error('cannotsubmit', 'choice', $continueurl);
339         }
340     }
341     // Start lock to prevent synchronous access to the same data
342     // before it's updated, if using limits.
343     if ($choice->limitanswers) {
344         $timeout = 10;
345         $locktype = 'mod_choice_choice_user_submit_response';
346         // Limiting access to this choice.
347         $resouce = 'choiceid:' . $choice->id;
348         $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);
350         // Opening the lock.
351         $choicelock = $lockfactory->get_lock($resouce, $timeout, MINSECS);
352         if (!$choicelock) {
353             print_error('cannotsubmit', 'choice', $continueurl);
354         }
355     }
357     $current = $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $userid));
358     $context = context_module::instance($cm->id);
360     $choicesexceeded = false;
361     $countanswers = array();
362     foreach ($formanswers as $val) {
363         $countanswers[$val] = 0;
364     }
365     if($choice->limitanswers) {
366         // Find out whether groups are being used and enabled
367         if (groups_get_activity_groupmode($cm) > 0) {
368             $currentgroup = groups_get_activity_group($cm);
369         } else {
370             $currentgroup = 0;
371         }
373         list ($insql, $params) = $DB->get_in_or_equal($formanswers, SQL_PARAMS_NAMED);
375         if($currentgroup) {
376             // If groups are being used, retrieve responses only for users in
377             // current group
378             global $CFG;
380             $params['groupid'] = $currentgroup;
381             $sql = "SELECT ca.*
382                       FROM {choice_answers} ca
383                 INNER JOIN {groups_members} gm ON ca.userid=gm.userid
384                      WHERE optionid $insql
385                        AND gm.groupid= :groupid";
386         } else {
387             // Groups are not used, retrieve all answers for this option ID
388             $sql = "SELECT ca.*
389                       FROM {choice_answers} ca
390                      WHERE optionid $insql";
391         }
393         $answers = $DB->get_records_sql($sql, $params);
394         if ($answers) {
395             foreach ($answers as $a) { //only return enrolled users.
396                 if (is_enrolled($context, $a->userid, 'mod/choice:choose')) {
397                     $countanswers[$a->optionid]++;
398                 }
399             }
400         }
401         foreach ($countanswers as $opt => $count) {
402             if ($count >= $choice->maxanswers[$opt]) {
403                 $choicesexceeded = true;
404                 break;
405             }
406         }
407     }
409     // Check the user hasn't exceeded the maximum selections for the choice(s) they have selected.
410     $answersnapshots = array();
411     $deletedanswersnapshots = array();
412     if (!($choice->limitanswers && $choicesexceeded)) {
413         if ($current) {
414             // Update an existing answer.
415             $existingchoices = array();
416             foreach ($current as $c) {
417                 if (in_array($c->optionid, $formanswers)) {
418                     $existingchoices[] = $c->optionid;
419                     $DB->set_field('choice_answers', 'timemodified', time(), array('id' => $c->id));
420                 } else {
421                     $deletedanswersnapshots[] = $c;
422                     $DB->delete_records('choice_answers', array('id' => $c->id));
423                 }
424             }
426             // Add new ones.
427             foreach ($formanswers as $f) {
428                 if (!in_array($f, $existingchoices)) {
429                     $newanswer = new stdClass();
430                     $newanswer->optionid = $f;
431                     $newanswer->choiceid = $choice->id;
432                     $newanswer->userid = $userid;
433                     $newanswer->timemodified = time();
434                     $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
435                     $answersnapshots[] = $newanswer;
436                 }
437             }
438         } else {
439             // Add new answer.
440             foreach ($formanswers as $answer) {
441                 $newanswer = new stdClass();
442                 $newanswer->choiceid = $choice->id;
443                 $newanswer->userid = $userid;
444                 $newanswer->optionid = $answer;
445                 $newanswer->timemodified = time();
446                 $newanswer->id = $DB->insert_record("choice_answers", $newanswer);
447                 $answersnapshots[] = $newanswer;
448             }
450             // Update completion state
451             $completion = new completion_info($course);
452             if ($completion->is_enabled($cm) && $choice->completionsubmit) {
453                 $completion->update_state($cm, COMPLETION_COMPLETE);
454             }
455         }
456     } else {
457         // Check to see if current choice already selected - if not display error.
458         $currentids = array_keys($current);
460         if (array_diff($currentids, $formanswers) || array_diff($formanswers, $currentids) ) {
461             // Release lock before error.
462             $choicelock->release();
463             print_error('choicefull', 'choice', $continueurl);
464         }
465     }
467     // Release lock.
468     if (isset($choicelock)) {
469         $choicelock->release();
470     }
472     // Trigger events.
473     foreach ($deletedanswersnapshots as $answer) {
474         \mod_choice\event\answer_deleted::create_from_object($answer, $choice, $cm, $course)->trigger();
475     }
476     foreach ($answersnapshots as $answer) {
477         \mod_choice\event\answer_created::create_from_object($answer, $choice, $cm, $course)->trigger();
478     }
481 /**
482  * @param array $user
483  * @param object $cm
484  * @return void Output is echo'd
485  */
486 function choice_show_reportlink($user, $cm) {
487     $userschosen = array();
488     foreach($user as $optionid => $userlist) {
489         if ($optionid) {
490             $userschosen = array_merge($userschosen, array_keys($userlist));
491         }
492     }
493     $responsecount = count(array_unique($userschosen));
495     echo '<div class="reportlink">';
496     echo "<a href=\"report.php?id=$cm->id\">".get_string("viewallresponses", "choice", $responsecount)."</a>";
497     echo '</div>';
500 /**
501  * @global object
502  * @param object $choice
503  * @param object $course
504  * @param object $coursemodule
505  * @param array $allresponses
507  *  * @param bool $allresponses
508  * @return object
509  */
510 function prepare_choice_show_results($choice, $course, $cm, $allresponses) {
511     global $OUTPUT;
513     $display = clone($choice);
514     $display->coursemoduleid = $cm->id;
515     $display->courseid = $course->id;
517     if (!empty($choice->showunanswered)) {
518         $choice->option[0] = get_string('notanswered', 'choice');
519         $choice->maxanswers[0] = 0;
520     }
522     // Remove from the list of non-respondents the users who do not have access to this activity.
523     if (!empty($display->showunanswered) && $allresponses[0]) {
524         $info = new \core_availability\info_module(cm_info::create($cm));
525         $allresponses[0] = $info->filter_user_list($allresponses[0]);
526     }
528     //overwrite options value;
529     $display->options = array();
530     $allusers = [];
531     foreach ($choice->option as $optionid => $optiontext) {
532         $display->options[$optionid] = new stdClass;
533         $display->options[$optionid]->text = format_string($optiontext, true,
534             ['context' => context_module::instance($cm->id)]);
535         $display->options[$optionid]->maxanswer = $choice->maxanswers[$optionid];
537         if (array_key_exists($optionid, $allresponses)) {
538             $display->options[$optionid]->user = $allresponses[$optionid];
539             $allusers = array_merge($allusers, array_keys($allresponses[$optionid]));
540         }
541     }
542     unset($display->option);
543     unset($display->maxanswers);
545     $display->numberofuser = count(array_unique($allusers));
546     $context = context_module::instance($cm->id);
547     $display->viewresponsecapability = has_capability('mod/choice:readresponses', $context);
548     $display->deleterepsonsecapability = has_capability('mod/choice:deleteresponses',$context);
549     $display->fullnamecapability = has_capability('moodle/site:viewfullnames', $context);
551     if (empty($allresponses)) {
552         echo $OUTPUT->heading(get_string("nousersyet"), 3, null);
553         return false;
554     }
556     return $display;
559 /**
560  * @global object
561  * @param array $attemptids
562  * @param object $choice Choice main table row
563  * @param object $cm Course-module object
564  * @param object $course Course object
565  * @return bool
566  */
567 function choice_delete_responses($attemptids, $choice, $cm, $course) {
568     global $DB, $CFG, $USER;
569     require_once($CFG->libdir.'/completionlib.php');
571     if(!is_array($attemptids) || empty($attemptids)) {
572         return false;
573     }
575     foreach($attemptids as $num => $attemptid) {
576         if(empty($attemptid)) {
577             unset($attemptids[$num]);
578         }
579     }
581     $completion = new completion_info($course);
582     foreach($attemptids as $attemptid) {
583         if ($todelete = $DB->get_record('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid))) {
584             // Trigger the event answer deleted.
585             \mod_choice\event\answer_deleted::create_from_object($todelete, $choice, $cm, $course)->trigger();
586             $DB->delete_records('choice_answers', array('choiceid' => $choice->id, 'id' => $attemptid));
587         }
588     }
590     // Update completion state.
591     if ($completion->is_enabled($cm) && $choice->completionsubmit) {
592         $completion->update_state($cm, COMPLETION_INCOMPLETE);
593     }
595     return true;
599 /**
600  * Given an ID of an instance of this module,
601  * this function will permanently delete the instance
602  * and any data that depends on it.
603  *
604  * @global object
605  * @param int $id
606  * @return bool
607  */
608 function choice_delete_instance($id) {
609     global $DB;
611     if (! $choice = $DB->get_record("choice", array("id"=>"$id"))) {
612         return false;
613     }
615     $result = true;
617     if (! $DB->delete_records("choice_answers", array("choiceid"=>"$choice->id"))) {
618         $result = false;
619     }
621     if (! $DB->delete_records("choice_options", array("choiceid"=>"$choice->id"))) {
622         $result = false;
623     }
625     if (! $DB->delete_records("choice", array("id"=>"$choice->id"))) {
626         $result = false;
627     }
628     // Remove old calendar events.
629     if (! $DB->delete_records('event', array('modulename' => 'choice', 'instance' => $choice->id))) {
630         $result = false;
631     }
633     return $result;
636 /**
637  * Returns text string which is the answer that matches the id
638  *
639  * @global object
640  * @param object $choice
641  * @param int $id
642  * @return string
643  */
644 function choice_get_option_text($choice, $id) {
645     global $DB;
647     if ($result = $DB->get_record("choice_options", array("id" => $id))) {
648         return $result->text;
649     } else {
650         return get_string("notanswered", "choice");
651     }
654 /**
655  * Gets a full choice record
656  *
657  * @global object
658  * @param int $choiceid
659  * @return object|bool The choice or false
660  */
661 function choice_get_choice($choiceid) {
662     global $DB;
664     if ($choice = $DB->get_record("choice", array("id" => $choiceid))) {
665         if ($options = $DB->get_records("choice_options", array("choiceid" => $choiceid), "id")) {
666             foreach ($options as $option) {
667                 $choice->option[$option->id] = $option->text;
668                 $choice->maxanswers[$option->id] = $option->maxanswers;
669             }
670             return $choice;
671         }
672     }
673     return false;
676 /**
677  * List the actions that correspond to a view of this module.
678  * This is used by the participation report.
679  *
680  * Note: This is not used by new logging system. Event with
681  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
682  *       be considered as view action.
683  *
684  * @return array
685  */
686 function choice_get_view_actions() {
687     return array('view','view all','report');
690 /**
691  * List the actions that correspond to a post of this module.
692  * This is used by the participation report.
693  *
694  * Note: This is not used by new logging system. Event with
695  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
696  *       will be considered as post action.
697  *
698  * @return array
699  */
700 function choice_get_post_actions() {
701     return array('choose','choose again');
705 /**
706  * Implementation of the function for printing the form elements that control
707  * whether the course reset functionality affects the choice.
708  *
709  * @param object $mform form passed by reference
710  */
711 function choice_reset_course_form_definition(&$mform) {
712     $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice'));
713     $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice'));
716 /**
717  * Course reset form defaults.
718  *
719  * @return array
720  */
721 function choice_reset_course_form_defaults($course) {
722     return array('reset_choice'=>1);
725 /**
726  * Actual implementation of the reset course functionality, delete all the
727  * choice responses for course $data->courseid.
728  *
729  * @global object
730  * @global object
731  * @param object $data the data submitted from the reset course.
732  * @return array status array
733  */
734 function choice_reset_userdata($data) {
735     global $CFG, $DB;
737     $componentstr = get_string('modulenameplural', 'choice');
738     $status = array();
740     if (!empty($data->reset_choice)) {
741         $choicessql = "SELECT ch.id
742                        FROM {choice} ch
743                        WHERE ch.course=?";
745         $DB->delete_records_select('choice_answers', "choiceid IN ($choicessql)", array($data->courseid));
746         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false);
747     }
749     /// updating dates - shift may be negative too
750     if ($data->timeshift) {
751         shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
752         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
753     }
755     return $status;
758 /**
759  * @global object
760  * @global object
761  * @global object
762  * @uses CONTEXT_MODULE
763  * @param object $choice
764  * @param object $cm
765  * @param int $groupmode
766  * @param bool $onlyactive Whether to get response data for active users only.
767  * @return array
768  */
769 function choice_get_response_data($choice, $cm, $groupmode, $onlyactive) {
770     global $CFG, $USER, $DB;
772     $context = context_module::instance($cm->id);
774 /// Get the current group
775     if ($groupmode > 0) {
776         $currentgroup = groups_get_activity_group($cm);
777     } else {
778         $currentgroup = 0;
779     }
781 /// Initialise the returned array, which is a matrix:  $allresponses[responseid][userid] = responseobject
782     $allresponses = array();
784 /// First get all the users who have access here
785 /// To start with we assume they are all "unanswered" then move them later
786     $allresponses[0] = get_enrolled_users($context, 'mod/choice:choose', $currentgroup,
787             user_picture::fields('u', array('idnumber')), null, 0, 0, $onlyactive);
789 /// Get all the recorded responses for this choice
790     $rawresponses = $DB->get_records('choice_answers', array('choiceid' => $choice->id));
792 /// Use the responses to move users into the correct column
794     if ($rawresponses) {
795         $answeredusers = array();
796         foreach ($rawresponses as $response) {
797             if (isset($allresponses[0][$response->userid])) {   // This person is enrolled and in correct group
798                 $allresponses[0][$response->userid]->timemodified = $response->timemodified;
799                 $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]);
800                 $allresponses[$response->optionid][$response->userid]->answerid = $response->id;
801                 $answeredusers[] = $response->userid;
802             }
803         }
804         foreach ($answeredusers as $answereduser) {
805             unset($allresponses[0][$answereduser]);
806         }
807     }
808     return $allresponses;
811 /**
812  * Returns all other caps used in module
813  *
814  * @return array
815  */
816 function choice_get_extra_capabilities() {
817     return array('moodle/site:accessallgroups');
820 /**
821  * @uses FEATURE_GROUPS
822  * @uses FEATURE_GROUPINGS
823  * @uses FEATURE_MOD_INTRO
824  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
825  * @uses FEATURE_GRADE_HAS_GRADE
826  * @uses FEATURE_GRADE_OUTCOMES
827  * @param string $feature FEATURE_xx constant for requested feature
828  * @return mixed True if module supports feature, null if doesn't know
829  */
830 function choice_supports($feature) {
831     switch($feature) {
832         case FEATURE_GROUPS:                  return true;
833         case FEATURE_GROUPINGS:               return true;
834         case FEATURE_MOD_INTRO:               return true;
835         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
836         case FEATURE_COMPLETION_HAS_RULES:    return true;
837         case FEATURE_GRADE_HAS_GRADE:         return false;
838         case FEATURE_GRADE_OUTCOMES:          return false;
839         case FEATURE_BACKUP_MOODLE2:          return true;
840         case FEATURE_SHOW_DESCRIPTION:        return true;
842         default: return null;
843     }
846 /**
847  * Adds module specific settings to the settings block
848  *
849  * @param settings_navigation $settings The settings navigation object
850  * @param navigation_node $choicenode The node to add module settings to
851  */
852 function choice_extend_settings_navigation(settings_navigation $settings, navigation_node $choicenode) {
853     global $PAGE;
855     if (has_capability('mod/choice:readresponses', $PAGE->cm->context)) {
857         $groupmode = groups_get_activity_groupmode($PAGE->cm);
858         if ($groupmode) {
859             groups_get_activity_group($PAGE->cm, true);
860         }
862         $choice = choice_get_choice($PAGE->cm->instance);
864         // Check if we want to include responses from inactive users.
865         $onlyactive = $choice->includeinactive ? false : true;
867         // Big function, approx 6 SQL calls per user.
868         $allresponses = choice_get_response_data($choice, $PAGE->cm, $groupmode, $onlyactive);
870         $allusers = [];
871         foreach($allresponses as $optionid => $userlist) {
872             if ($optionid) {
873                 $allusers = array_merge($allusers, array_keys($userlist));
874             }
875         }
876         $responsecount = count(array_unique($allusers));
877         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
878     }
881 /**
882  * Obtains the automatic completion state for this choice based on any conditions
883  * in forum settings.
884  *
885  * @param object $course Course
886  * @param object $cm Course-module
887  * @param int $userid User ID
888  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
889  * @return bool True if completed, false if not, $type if conditions not set.
890  */
891 function choice_get_completion_state($course, $cm, $userid, $type) {
892     global $CFG,$DB;
894     // Get choice details
895     $choice = $DB->get_record('choice', array('id'=>$cm->instance), '*',
896             MUST_EXIST);
898     // If completion option is enabled, evaluate it and return true/false
899     if($choice->completionsubmit) {
900         return $DB->record_exists('choice_answers', array(
901                 'choiceid'=>$choice->id, 'userid'=>$userid));
902     } else {
903         // Completion option is not enabled so just return $type
904         return $type;
905     }
908 /**
909  * Return a list of page types
910  * @param string $pagetype current page type
911  * @param stdClass $parentcontext Block's parent context
912  * @param stdClass $currentcontext Current context of block
913  */
914 function choice_page_type_list($pagetype, $parentcontext, $currentcontext) {
915     $module_pagetype = array('mod-choice-*'=>get_string('page-mod-choice-x', 'choice'));
916     return $module_pagetype;
919 /**
920  * Prints choice summaries on MyMoodle Page
921  *
922  * Prints choice name, due date and attempt information on
923  * choice activities that have a deadline that has not already passed
924  * and it is available for completing.
925  *
926  * @deprecated since 3.3
927  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
928  * @uses CONTEXT_MODULE
929  * @param array $courses An array of course objects to get choice instances from.
930  * @param array $htmlarray Store overview output array( course ID => 'choice' => HTML output )
931  */
932 function choice_print_overview($courses, &$htmlarray) {
933     global $USER, $DB, $OUTPUT;
935     debugging('The function choice_print_overview() is now deprecated.', DEBUG_DEVELOPER);
937     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
938         return;
939     }
940     if (!$choices = get_all_instances_in_courses('choice', $courses)) {
941         return;
942     }
944     $now = time();
945     foreach ($choices as $choice) {
946         if ($choice->timeclose != 0                                      // If this choice is scheduled.
947             and $choice->timeclose >= $now                               // And the deadline has not passed.
948             and ($choice->timeopen == 0 or $choice->timeopen <= $now)) { // And the choice is available.
950             // Visibility.
951             $class = (!$choice->visible) ? 'dimmed' : '';
953             // Link to activity.
954             $url = new moodle_url('/mod/choice/view.php', array('id' => $choice->coursemodule));
955             $url = html_writer::link($url, format_string($choice->name), array('class' => $class));
956             $str = $OUTPUT->box(get_string('choiceactivityname', 'choice', $url), 'name');
958              // Deadline.
959             $str .= $OUTPUT->box(get_string('choicecloseson', 'choice', userdate($choice->timeclose)), 'info');
961             // Display relevant info based on permissions.
962             if (has_capability('mod/choice:readresponses', context_module::instance($choice->coursemodule))) {
963                 $attempts = $DB->count_records_sql('SELECT COUNT(DISTINCT userid) FROM {choice_answers} WHERE choiceid = ?',
964                     [$choice->id]);
965                 $url = new moodle_url('/mod/choice/report.php', ['id' => $choice->coursemodule]);
966                 $str .= $OUTPUT->box(html_writer::link($url, get_string('viewallresponses', 'choice', $attempts)), 'info');
968             } else if (has_capability('mod/choice:choose', context_module::instance($choice->coursemodule))) {
969                 // See if the user has submitted anything.
970                 $answers = $DB->count_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
971                 if ($answers > 0) {
972                     // User has already selected an answer, nothing to show.
973                     $str = '';
974                 } else {
975                     // User has not made a selection yet.
976                     $str .= $OUTPUT->box(get_string('notanswered', 'choice'), 'info');
977                 }
978             } else {
979                 // Does not have permission to do anything on this choice activity.
980                 $str = '';
981             }
983             // Make sure we have something to display.
984             if (!empty($str)) {
985                 // Generate the containing div.
986                 $str = $OUTPUT->box($str, 'choice overview');
988                 if (empty($htmlarray[$choice->course]['choice'])) {
989                     $htmlarray[$choice->course]['choice'] = $str;
990                 } else {
991                     $htmlarray[$choice->course]['choice'] .= $str;
992                 }
993             }
994         }
995     }
996     return;
1000 /**
1001  * Get my responses on a given choice.
1002  *
1003  * @param stdClass $choice Choice record
1004  * @return array of choice answers records
1005  * @since  Moodle 3.0
1006  */
1007 function choice_get_my_response($choice) {
1008     global $DB, $USER;
1009     return $DB->get_records('choice_answers', array('choiceid' => $choice->id, 'userid' => $USER->id));
1013 /**
1014  * Get all the responses on a given choice.
1015  *
1016  * @param stdClass $choice Choice record
1017  * @return array of choice answers records
1018  * @since  Moodle 3.0
1019  */
1020 function choice_get_all_responses($choice) {
1021     global $DB;
1022     return $DB->get_records('choice_answers', array('choiceid' => $choice->id));
1026 /**
1027  * Return true if we are allowd to view the choice results.
1028  *
1029  * @param stdClass $choice Choice record
1030  * @param rows|null $current my choice responses
1031  * @param bool|null $choiceopen if the choice is open
1032  * @return bool true if we can view the results, false otherwise.
1033  * @since  Moodle 3.0
1034  */
1035 function choice_can_view_results($choice, $current = null, $choiceopen = null) {
1037     if (is_null($choiceopen)) {
1038         $timenow = time();
1040         if ($choice->timeopen != 0 && $timenow < $choice->timeopen) {
1041             // If the choice is not available, we can't see the results.
1042             return false;
1043         }
1045         if ($choice->timeclose != 0 && $timenow > $choice->timeclose) {
1046             $choiceopen = false;
1047         } else {
1048             $choiceopen = true;
1049         }
1050     }
1051     if (empty($current)) {
1052         $current = choice_get_my_response($choice);
1053     }
1055     if ($choice->showresults == CHOICE_SHOWRESULTS_ALWAYS or
1056        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_ANSWER and !empty($current)) or
1057        ($choice->showresults == CHOICE_SHOWRESULTS_AFTER_CLOSE and !$choiceopen)) {
1058         return true;
1059     }
1060     return false;
1063 /**
1064  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1065  *
1066  * @param  stdClass $choice     choice object
1067  * @param  stdClass $course     course object
1068  * @param  stdClass $cm         course module object
1069  * @param  stdClass $context    context object
1070  * @since Moodle 3.0
1071  */
1072 function choice_view($choice, $course, $cm, $context) {
1074     // Trigger course_module_viewed event.
1075     $params = array(
1076         'context' => $context,
1077         'objectid' => $choice->id
1078     );
1080     $event = \mod_choice\event\course_module_viewed::create($params);
1081     $event->add_record_snapshot('course_modules', $cm);
1082     $event->add_record_snapshot('course', $course);
1083     $event->add_record_snapshot('choice', $choice);
1084     $event->trigger();
1086     // Completion.
1087     $completion = new completion_info($course);
1088     $completion->set_module_viewed($cm);
1091 /**
1092  * Check if a choice is available for the current user.
1093  *
1094  * @param  stdClass  $choice            choice record
1095  * @return array                       status (available or not and possible warnings)
1096  */
1097 function choice_get_availability_status($choice) {
1098     $available = true;
1099     $warnings = array();
1101     $timenow = time();
1103     if (!empty($choice->timeopen) && ($choice->timeopen > $timenow)) {
1104         $available = false;
1105         $warnings['notopenyet'] = userdate($choice->timeopen);
1106     } else if (!empty($choice->timeclose) && ($timenow > $choice->timeclose)) {
1107         $available = false;
1108         $warnings['expired'] = userdate($choice->timeclose);
1109     }
1110     if (!$choice->allowupdate && choice_get_my_response($choice)) {
1111         $available = false;
1112         $warnings['choicesaved'] = '';
1113     }
1115     // Choice is available.
1116     return array($available, $warnings);
1119 /**
1120  * This standard function will check all instances of this module
1121  * and make sure there are up-to-date events created for each of them.
1122  * If courseid = 0, then every chat event in the site is checked, else
1123  * only chat events belonging to the course specified are checked.
1124  * This function is used, in its new format, by restore_refresh_events()
1125  *
1126  * @param int $courseid
1127  * @return bool
1128  */
1129 function choice_refresh_events($courseid = 0) {
1130     global $DB, $CFG;
1131     require_once($CFG->dirroot.'/mod/choice/locallib.php');
1133     if ($courseid) {
1134         if (! $choices = $DB->get_records("choice", array("course" => $courseid))) {
1135             return true;
1136         }
1137     } else {
1138         if (! $choices = $DB->get_records("choice")) {
1139             return true;
1140         }
1141     }
1143     foreach ($choices as $choice) {
1144         choice_set_events($choice);
1145     }
1146     return true;
1149 /**
1150  * Check if the module has any update that affects the current user since a given time.
1151  *
1152  * @param  cm_info $cm course module data
1153  * @param  int $from the time to check updates from
1154  * @param  array $filter  if we need to check only specific updates
1155  * @return stdClass an object with the different type of areas indicating if they were updated or not
1156  * @since Moodle 3.2
1157  */
1158 function choice_check_updates_since(cm_info $cm, $from, $filter = array()) {
1159     global $DB;
1161     $updates = new stdClass();
1162     $choice = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1163     list($available, $warnings) = choice_get_availability_status($choice);
1164     if (!$available) {
1165         return $updates;
1166     }
1168     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
1170     if (!choice_can_view_results($choice)) {
1171         return $updates;
1172     }
1173     // Check if there are new responses in the choice.
1174     $updates->answers = (object) array('updated' => false);
1175     $select = 'choiceid = :id AND timemodified > :since';
1176     $params = array('id' => $choice->id, 'since' => $from);
1177     $answers = $DB->get_records_select('choice_answers', $select, $params, '', 'id');
1178     if (!empty($answers)) {
1179         $updates->answers->updated = true;
1180         $updates->answers->itemids = array_keys($answers);
1181     }
1183     return $updates;
1186 /**
1187  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1188  *
1189  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1190  * is not displayed on the block.
1191  *
1192  * @param calendar_event $event
1193  * @param \core_calendar\action_factory $factory
1194  * @return \core_calendar\local\event\entities\action_interface|null
1195  */
1196 function mod_choice_core_calendar_provide_event_action(calendar_event $event,
1197                                                        \core_calendar\action_factory $factory) {
1199     $cm = get_fast_modinfo($event->courseid)->instances['choice'][$event->instance];
1200     $now = time();
1202     if (!empty($cm->customdata['timeclose']) && $cm->customdata['timeclose'] < $now) {
1203         // The choice has closed so the user can no longer submit anything.
1204         return null;
1205     }
1207     // The choice is actionable if we don't have a start time or the start time is
1208     // in the past.
1209     $actionable = (empty($cm->customdata['timeopen']) || $cm->customdata['timeopen'] <= $now);
1211     if ($actionable && choice_get_my_response((object)['id' => $event->instance])) {
1212         // There is no action if the user has already submitted their choice.
1213         return null;
1214     }
1216     return $factory->create_instance(
1217         get_string('viewchoices', 'choice'),
1218         new \moodle_url('/mod/choice/view.php', array('id' => $cm->id)),
1219         1,
1220         $actionable
1221     );
1224 /**
1225  * Get icon mapping for font-awesome.
1226  */
1227 function mod_choice_get_fontawesome_icon_map() {
1228     return [
1229         'mod_choice:row' => 'fa-info',
1230         'mod_choice:column' => 'fa-columns',
1231     ];
1234 /**
1235  * Add a get_coursemodule_info function in case any choice type wants to add 'extra' information
1236  * for the course (see resource).
1237  *
1238  * Given a course_module object, this function returns any "extra" information that may be needed
1239  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
1240  *
1241  * @param stdClass $coursemodule The coursemodule object (record).
1242  * @return cached_cm_info An object on information that the courses
1243  *                        will know about (most noticeably, an icon).
1244  */
1245 function choice_get_coursemodule_info($coursemodule) {
1246     global $DB;
1248     $dbparams = ['id' => $coursemodule->instance];
1249     $fields = 'id, name, intro, introformat, completionsubmit, timeopen, timeclose';
1250     if (!$choice = $DB->get_record('choice', $dbparams, $fields)) {
1251         return false;
1252     }
1254     $result = new cached_cm_info();
1255     $result->name = $choice->name;
1257     if ($coursemodule->showdescription) {
1258         // Convert intro to html. Do not filter cached version, filters run at display time.
1259         $result->content = format_module_intro('choice', $choice, $coursemodule->id, false);
1260     }
1262     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
1263     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
1264         $result->customdata['customcompletionrules']['completionsubmit'] = $choice->completionsubmit;
1265     }
1266     // Populate some other values that can be used in calendar or on dashboard.
1267     if ($choice->timeopen) {
1268         $result->customdata['timeopen'] = $choice->timeopen;
1269     }
1270     if ($choice->timeclose) {
1271         $result->customdata['timeclose'] = $choice->timeclose;
1272     }
1274     return $result;
1277 /**
1278  * Callback which returns human-readable strings describing the active completion custom rules for the module instance.
1279  *
1280  * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']
1281  * @return array $descriptions the array of descriptions for the custom rules.
1282  */
1283 function mod_choice_get_completion_active_rule_descriptions($cm) {
1284     // Values will be present in cm_info, and we assume these are up to date.
1285     if (empty($cm->customdata['customcompletionrules'])
1286         || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) {
1287         return [];
1288     }
1290     $descriptions = [];
1291     foreach ($cm->customdata['customcompletionrules'] as $key => $val) {
1292         switch ($key) {
1293             case 'completionsubmit':
1294                 if (empty($val)) {
1295                     continue;
1296                 }
1297                 $descriptions[] = get_string('completionsubmit', 'choice');
1298                 break;
1299             default:
1300                 break;
1301         }
1302     }
1303     return $descriptions;