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