724647a51ec4913bf40b0519664b9e530ac193db
[moodle.git] / mod / feedback / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library of functions and constants for module feedback
19  * includes the main-part of feedback-functions
20  *
21  * @package mod_feedback
22  * @copyright Andreas Grabs
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /** Include eventslib.php */
29 require_once($CFG->libdir.'/eventslib.php');
30 // Include forms lib.
31 require_once($CFG->libdir.'/formslib.php');
33 define('FEEDBACK_ANONYMOUS_YES', 1);
34 define('FEEDBACK_ANONYMOUS_NO', 2);
35 define('FEEDBACK_MIN_ANONYMOUS_COUNT_IN_GROUP', 2);
36 define('FEEDBACK_DECIMAL', '.');
37 define('FEEDBACK_THOUSAND', ',');
38 define('FEEDBACK_RESETFORM_RESET', 'feedback_reset_data_');
39 define('FEEDBACK_RESETFORM_DROP', 'feedback_drop_feedback_');
40 define('FEEDBACK_MAX_PIX_LENGTH', '400'); //max. Breite des grafischen Balkens in der Auswertung
41 define('FEEDBACK_DEFAULT_PAGE_COUNT', 20);
43 // Event types.
44 define('FEEDBACK_EVENT_TYPE_OPEN', 'open');
45 define('FEEDBACK_EVENT_TYPE_CLOSE', 'close');
47 /**
48  * Returns all other caps used in module.
49  *
50  * @return array
51  */
52 function feedback_get_extra_capabilities() {
53     return array('moodle/site:accessallgroups');
54 }
56 /**
57  * @uses FEATURE_GROUPS
58  * @uses FEATURE_GROUPINGS
59  * @uses FEATURE_MOD_INTRO
60  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
61  * @uses FEATURE_GRADE_HAS_GRADE
62  * @uses FEATURE_GRADE_OUTCOMES
63  * @param string $feature FEATURE_xx constant for requested feature
64  * @return mixed True if module supports feature, null if doesn't know
65  */
66 function feedback_supports($feature) {
67     switch($feature) {
68         case FEATURE_GROUPS:                  return true;
69         case FEATURE_GROUPINGS:               return true;
70         case FEATURE_MOD_INTRO:               return true;
71         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
72         case FEATURE_COMPLETION_HAS_RULES:    return true;
73         case FEATURE_GRADE_HAS_GRADE:         return false;
74         case FEATURE_GRADE_OUTCOMES:          return false;
75         case FEATURE_BACKUP_MOODLE2:          return true;
76         case FEATURE_SHOW_DESCRIPTION:        return true;
78         default: return null;
79     }
80 }
82 /**
83  * this will create a new instance and return the id number
84  * of the new instance.
85  *
86  * @global object
87  * @param object $feedback the object given by mod_feedback_mod_form
88  * @return int
89  */
90 function feedback_add_instance($feedback) {
91     global $DB;
93     $feedback->timemodified = time();
94     $feedback->id = '';
96     if (empty($feedback->site_after_submit)) {
97         $feedback->site_after_submit = '';
98     }
100     //saving the feedback in db
101     $feedbackid = $DB->insert_record("feedback", $feedback);
103     $feedback->id = $feedbackid;
105     feedback_set_events($feedback);
107     if (!isset($feedback->coursemodule)) {
108         $cm = get_coursemodule_from_id('feedback', $feedback->id);
109         $feedback->coursemodule = $cm->id;
110     }
111     $context = context_module::instance($feedback->coursemodule);
113     if (!empty($feedback->completionexpected)) {
114         \core_completion\api::update_completion_date_event($feedback->coursemodule, 'feedback', $feedback->id,
115                 $feedback->completionexpected);
116     }
118     $editoroptions = feedback_get_editor_options();
120     // process the custom wysiwyg editor in page_after_submit
121     if ($draftitemid = $feedback->page_after_submit_editor['itemid']) {
122         $feedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
123                                                     'mod_feedback', 'page_after_submit',
124                                                     0, $editoroptions,
125                                                     $feedback->page_after_submit_editor['text']);
127         $feedback->page_after_submitformat = $feedback->page_after_submit_editor['format'];
128     }
129     $DB->update_record('feedback', $feedback);
131     return $feedbackid;
134 /**
135  * this will update a given instance
136  *
137  * @global object
138  * @param object $feedback the object given by mod_feedback_mod_form
139  * @return boolean
140  */
141 function feedback_update_instance($feedback) {
142     global $DB;
144     $feedback->timemodified = time();
145     $feedback->id = $feedback->instance;
147     if (empty($feedback->site_after_submit)) {
148         $feedback->site_after_submit = '';
149     }
151     //save the feedback into the db
152     $DB->update_record("feedback", $feedback);
154     //create or update the new events
155     feedback_set_events($feedback);
156     $completionexpected = (!empty($feedback->completionexpected)) ? $feedback->completionexpected : null;
157     \core_completion\api::update_completion_date_event($feedback->coursemodule, 'feedback', $feedback->id, $completionexpected);
159     $context = context_module::instance($feedback->coursemodule);
161     $editoroptions = feedback_get_editor_options();
163     // process the custom wysiwyg editor in page_after_submit
164     if ($draftitemid = $feedback->page_after_submit_editor['itemid']) {
165         $feedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
166                                                     'mod_feedback', 'page_after_submit',
167                                                     0, $editoroptions,
168                                                     $feedback->page_after_submit_editor['text']);
170         $feedback->page_after_submitformat = $feedback->page_after_submit_editor['format'];
171     }
172     $DB->update_record('feedback', $feedback);
174     return true;
177 /**
178  * Serves the files included in feedback items like label. Implements needed access control ;-)
179  *
180  * There are two situations in general where the files will be sent.
181  * 1) filearea = item, 2) filearea = template
182  *
183  * @package  mod_feedback
184  * @category files
185  * @param stdClass $course course object
186  * @param stdClass $cm course module object
187  * @param stdClass $context context object
188  * @param string $filearea file area
189  * @param array $args extra arguments
190  * @param bool $forcedownload whether or not force download
191  * @param array $options additional options affecting the file serving
192  * @return bool false if file not found, does not return if found - justsend the file
193  */
194 function feedback_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
195     global $CFG, $DB;
197     if ($filearea === 'item' or $filearea === 'template') {
198         $itemid = (int)array_shift($args);
199         //get the item what includes the file
200         if (!$item = $DB->get_record('feedback_item', array('id'=>$itemid))) {
201             return false;
202         }
203         $feedbackid = $item->feedback;
204         $templateid = $item->template;
205     }
207     if ($filearea === 'page_after_submit' or $filearea === 'item') {
208         if (! $feedback = $DB->get_record("feedback", array("id"=>$cm->instance))) {
209             return false;
210         }
212         $feedbackid = $feedback->id;
214         //if the filearea is "item" so we check the permissions like view/complete the feedback
215         $canload = false;
216         //first check whether the user has the complete capability
217         if (has_capability('mod/feedback:complete', $context)) {
218             $canload = true;
219         }
221         //now we check whether the user has the view capability
222         if (has_capability('mod/feedback:view', $context)) {
223             $canload = true;
224         }
226         //if the feedback is on frontpage and anonymous and the fullanonymous is allowed
227         //so the file can be loaded too.
228         if (isset($CFG->feedback_allowfullanonymous)
229                     AND $CFG->feedback_allowfullanonymous
230                     AND $course->id == SITEID
231                     AND $feedback->anonymous == FEEDBACK_ANONYMOUS_YES ) {
232             $canload = true;
233         }
235         if (!$canload) {
236             return false;
237         }
238     } else if ($filearea === 'template') { //now we check files in templates
239         if (!$template = $DB->get_record('feedback_template', array('id'=>$templateid))) {
240             return false;
241         }
243         //if the file is not public so the capability edititems has to be there
244         if (!$template->ispublic) {
245             if (!has_capability('mod/feedback:edititems', $context)) {
246                 return false;
247             }
248         } else { //on public templates, at least the user has to be logged in
249             if (!isloggedin()) {
250                 return false;
251             }
252         }
253     } else {
254         return false;
255     }
257     if ($context->contextlevel == CONTEXT_MODULE) {
258         if ($filearea !== 'item' and $filearea !== 'page_after_submit') {
259             return false;
260         }
261     }
263     if ($context->contextlevel == CONTEXT_COURSE || $context->contextlevel == CONTEXT_SYSTEM) {
264         if ($filearea !== 'template') {
265             return false;
266         }
267     }
269     $relativepath = implode('/', $args);
270     if ($filearea === 'page_after_submit') {
271         $fullpath = "/{$context->id}/mod_feedback/$filearea/$relativepath";
272     } else {
273         $fullpath = "/{$context->id}/mod_feedback/$filearea/{$item->id}/$relativepath";
274     }
276     $fs = get_file_storage();
278     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
279         return false;
280     }
282     // finally send the file
283     send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
285     return false;
288 /**
289  * this will delete a given instance.
290  * all referenced data also will be deleted
291  *
292  * @global object
293  * @param int $id the instanceid of feedback
294  * @return boolean
295  */
296 function feedback_delete_instance($id) {
297     global $DB;
299     //get all referenced items
300     $feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$id));
302     //deleting all referenced items and values
303     if (is_array($feedbackitems)) {
304         foreach ($feedbackitems as $feedbackitem) {
305             $DB->delete_records("feedback_value", array("item"=>$feedbackitem->id));
306             $DB->delete_records("feedback_valuetmp", array("item"=>$feedbackitem->id));
307         }
308         if ($delitems = $DB->get_records("feedback_item", array("feedback"=>$id))) {
309             foreach ($delitems as $delitem) {
310                 feedback_delete_item($delitem->id, false);
311             }
312         }
313     }
315     //deleting the completeds
316     $DB->delete_records("feedback_completed", array("feedback"=>$id));
318     //deleting the unfinished completeds
319     $DB->delete_records("feedback_completedtmp", array("feedback"=>$id));
321     //deleting old events
322     $DB->delete_records('event', array('modulename'=>'feedback', 'instance'=>$id));
323     return $DB->delete_records("feedback", array("id"=>$id));
326 /**
327  * Return a small object with summary information about what a
328  * user has done with a given particular instance of this module
329  * Used for user activity reports.
330  * $return->time = the time they did it
331  * $return->info = a short text description
332  *
333  * @param stdClass $course
334  * @param stdClass $user
335  * @param cm_info|stdClass $mod
336  * @param stdClass $feedback
337  * @return stdClass
338  */
339 function feedback_user_outline($course, $user, $mod, $feedback) {
340     global $DB;
341     $outline = (object)['info' => '', 'time' => 0];
342     if ($feedback->anonymous != FEEDBACK_ANONYMOUS_NO) {
343         // Do not disclose any user info if feedback is anonymous.
344         return $outline;
345     }
346     $params = array('userid' => $user->id, 'feedback' => $feedback->id,
347         'anonymous_response' => FEEDBACK_ANONYMOUS_NO);
348     $status = null;
349     $context = context_module::instance($mod->id);
350     if ($completed = $DB->get_record('feedback_completed', $params)) {
351         // User has completed feedback.
352         $outline->info = get_string('completed', 'feedback');
353         $outline->time = $completed->timemodified;
354     } else if ($completedtmp = $DB->get_record('feedback_completedtmp', $params)) {
355         // User has started but not completed feedback.
356         $outline->info = get_string('started', 'feedback');
357         $outline->time = $completedtmp->timemodified;
358     } else if (has_capability('mod/feedback:complete', $context, $user)) {
359         // User has not started feedback but has capability to do so.
360         $outline->info = get_string('not_started', 'feedback');
361     }
363     return $outline;
366 /**
367  * Returns all users who has completed a specified feedback since a given time
368  * many thanks to Manolescu Dorel, who contributed these two functions
369  *
370  * @global object
371  * @global object
372  * @global object
373  * @global object
374  * @uses CONTEXT_MODULE
375  * @param array $activities Passed by reference
376  * @param int $index Passed by reference
377  * @param int $timemodified Timestamp
378  * @param int $courseid
379  * @param int $cmid
380  * @param int $userid
381  * @param int $groupid
382  * @return void
383  */
384 function feedback_get_recent_mod_activity(&$activities, &$index,
385                                           $timemodified, $courseid,
386                                           $cmid, $userid="", $groupid="") {
388     global $CFG, $COURSE, $USER, $DB;
390     if ($COURSE->id == $courseid) {
391         $course = $COURSE;
392     } else {
393         $course = $DB->get_record('course', array('id'=>$courseid));
394     }
396     $modinfo = get_fast_modinfo($course);
398     $cm = $modinfo->cms[$cmid];
400     $sqlargs = array();
402     $userfields = user_picture::fields('u', null, 'useridagain');
403     $sql = " SELECT fk . * , fc . * , $userfields
404                 FROM {feedback_completed} fc
405                     JOIN {feedback} fk ON fk.id = fc.feedback
406                     JOIN {user} u ON u.id = fc.userid ";
408     if ($groupid) {
409         $sql .= " JOIN {groups_members} gm ON  gm.userid=u.id ";
410     }
412     $sql .= " WHERE fc.timemodified > ?
413                 AND fk.id = ?
414                 AND fc.anonymous_response = ?";
415     $sqlargs[] = $timemodified;
416     $sqlargs[] = $cm->instance;
417     $sqlargs[] = FEEDBACK_ANONYMOUS_NO;
419     if ($userid) {
420         $sql .= " AND u.id = ? ";
421         $sqlargs[] = $userid;
422     }
424     if ($groupid) {
425         $sql .= " AND gm.groupid = ? ";
426         $sqlargs[] = $groupid;
427     }
429     if (!$feedbackitems = $DB->get_records_sql($sql, $sqlargs)) {
430         return;
431     }
433     $cm_context = context_module::instance($cm->id);
435     if (!has_capability('mod/feedback:view', $cm_context)) {
436         return;
437     }
439     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
440     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
441     $groupmode       = groups_get_activity_groupmode($cm, $course);
443     $aname = format_string($cm->name, true);
444     foreach ($feedbackitems as $feedbackitem) {
445         if ($feedbackitem->userid != $USER->id) {
447             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
448                 $usersgroups = groups_get_all_groups($course->id,
449                                                      $feedbackitem->userid,
450                                                      $cm->groupingid);
451                 if (!is_array($usersgroups)) {
452                     continue;
453                 }
454                 $usersgroups = array_keys($usersgroups);
455                 $intersect = array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid));
456                 if (empty($intersect)) {
457                     continue;
458                 }
459             }
460         }
462         $tmpactivity = new stdClass();
464         $tmpactivity->type      = 'feedback';
465         $tmpactivity->cmid      = $cm->id;
466         $tmpactivity->name      = $aname;
467         $tmpactivity->sectionnum= $cm->sectionnum;
468         $tmpactivity->timestamp = $feedbackitem->timemodified;
470         $tmpactivity->content = new stdClass();
471         $tmpactivity->content->feedbackid = $feedbackitem->id;
472         $tmpactivity->content->feedbackuserid = $feedbackitem->userid;
474         $tmpactivity->user = user_picture::unalias($feedbackitem, null, 'useridagain');
475         $tmpactivity->user->fullname = fullname($feedbackitem, $viewfullnames);
477         $activities[$index++] = $tmpactivity;
478     }
480     return;
483 /**
484  * Prints all users who has completed a specified feedback since a given time
485  * many thanks to Manolescu Dorel, who contributed these two functions
486  *
487  * @global object
488  * @param object $activity
489  * @param int $courseid
490  * @param string $detail
491  * @param array $modnames
492  * @return void Output is echo'd
493  */
494 function feedback_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
495     global $CFG, $OUTPUT;
497     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
499     echo "<tr><td class=\"userpicture\" valign=\"top\">";
500     echo $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid));
501     echo "</td><td>";
503     if ($detail) {
504         $modname = $modnames[$activity->type];
505         echo '<div class="title">';
506         echo $OUTPUT->image_icon('icon', $modname, $activity->type);
507         echo "<a href=\"$CFG->wwwroot/mod/feedback/view.php?id={$activity->cmid}\">{$activity->name}</a>";
508         echo '</div>';
509     }
511     echo '<div class="title">';
512     echo '</div>';
514     echo '<div class="user">';
515     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
516          ."{$activity->user->fullname}</a> - ".userdate($activity->timestamp);
517     echo '</div>';
519     echo "</td></tr></table>";
521     return;
524 /**
525  * Obtains the automatic completion state for this feedback based on the condition
526  * in feedback settings.
527  *
528  * @param object $course Course
529  * @param object $cm Course-module
530  * @param int $userid User ID
531  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
532  * @return bool True if completed, false if not, $type if conditions not set.
533  */
534 function feedback_get_completion_state($course, $cm, $userid, $type) {
535     global $CFG, $DB;
537     // Get feedback details
538     $feedback = $DB->get_record('feedback', array('id'=>$cm->instance), '*', MUST_EXIST);
540     // If completion option is enabled, evaluate it and return true/false
541     if ($feedback->completionsubmit) {
542         $params = array('userid'=>$userid, 'feedback'=>$feedback->id);
543         return $DB->record_exists('feedback_completed', $params);
544     } else {
545         // Completion option is not enabled so just return $type
546         return $type;
547     }
550 /**
551  * Print a detailed representation of what a  user has done with
552  * a given particular instance of this module, for user activity reports.
553  *
554  * @param stdClass $course
555  * @param stdClass $user
556  * @param cm_info|stdClass $mod
557  * @param stdClass $feedback
558  */
559 function feedback_user_complete($course, $user, $mod, $feedback) {
560     global $DB;
561     if ($feedback->anonymous != FEEDBACK_ANONYMOUS_NO) {
562         // Do not disclose any user info if feedback is anonymous.
563         return;
564     }
565     $params = array('userid' => $user->id, 'feedback' => $feedback->id,
566         'anonymous_response' => FEEDBACK_ANONYMOUS_NO);
567     $url = $status = null;
568     $context = context_module::instance($mod->id);
569     if ($completed = $DB->get_record('feedback_completed', $params)) {
570         // User has completed feedback.
571         if (has_capability('mod/feedback:viewreports', $context)) {
572             $url = new moodle_url('/mod/feedback/show_entries.php',
573                 ['id' => $mod->id, 'userid' => $user->id,
574                     'showcompleted' => $completed->id]);
575         }
576         $status = get_string('completedon', 'feedback', userdate($completed->timemodified));
577     } else if ($completedtmp = $DB->get_record('feedback_completedtmp', $params)) {
578         // User has started but not completed feedback.
579         $status = get_string('startedon', 'feedback', userdate($completedtmp->timemodified));
580     } else if (has_capability('mod/feedback:complete', $context, $user)) {
581         // User has not started feedback but has capability to do so.
582         $status = get_string('not_started', 'feedback');
583     }
585     if ($url && $status) {
586         echo html_writer::link($url, $status);
587     } else if ($status) {
588         echo html_writer::div($status);
589     }
592 /**
593  * @return bool true
594  */
595 function feedback_cron () {
596     return true;
599 /**
600  * @return bool false
601  */
602 function feedback_scale_used ($feedbackid, $scaleid) {
603     return false;
606 /**
607  * Checks if scale is being used by any instance of feedback
608  *
609  * This is used to find out if scale used anywhere
610  * @param $scaleid int
611  * @return boolean True if the scale is used by any assignment
612  */
613 function feedback_scale_used_anywhere($scaleid) {
614     return false;
617 /**
618  * List the actions that correspond to a view of this module.
619  * This is used by the participation report.
620  *
621  * Note: This is not used by new logging system. Event with
622  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
623  *       be considered as view action.
624  *
625  * @return array
626  */
627 function feedback_get_view_actions() {
628     return array('view', 'view all');
631 /**
632  * List the actions that correspond to a post of this module.
633  * This is used by the participation report.
634  *
635  * Note: This is not used by new logging system. Event with
636  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
637  *       will be considered as post action.
638  *
639  * @return array
640  */
641 function feedback_get_post_actions() {
642     return array('submit');
645 /**
646  * This function is used by the reset_course_userdata function in moodlelib.
647  * This function will remove all responses from the specified feedback
648  * and clean up any related data.
649  *
650  * @global object
651  * @global object
652  * @uses FEEDBACK_RESETFORM_RESET
653  * @uses FEEDBACK_RESETFORM_DROP
654  * @param object $data the data submitted from the reset course.
655  * @return array status array
656  */
657 function feedback_reset_userdata($data) {
658     global $CFG, $DB;
660     $resetfeedbacks = array();
661     $dropfeedbacks = array();
662     $status = array();
663     $componentstr = get_string('modulenameplural', 'feedback');
665     //get the relevant entries from $data
666     foreach ($data as $key => $value) {
667         switch(true) {
668             case substr($key, 0, strlen(FEEDBACK_RESETFORM_RESET)) == FEEDBACK_RESETFORM_RESET:
669                 if ($value == 1) {
670                     $templist = explode('_', $key);
671                     if (isset($templist[3])) {
672                         $resetfeedbacks[] = intval($templist[3]);
673                     }
674                 }
675             break;
676             case substr($key, 0, strlen(FEEDBACK_RESETFORM_DROP)) == FEEDBACK_RESETFORM_DROP:
677                 if ($value == 1) {
678                     $templist = explode('_', $key);
679                     if (isset($templist[3])) {
680                         $dropfeedbacks[] = intval($templist[3]);
681                     }
682                 }
683             break;
684         }
685     }
687     //reset the selected feedbacks
688     foreach ($resetfeedbacks as $id) {
689         $feedback = $DB->get_record('feedback', array('id'=>$id));
690         feedback_delete_all_completeds($feedback);
691         $status[] = array('component'=>$componentstr.':'.$feedback->name,
692                         'item'=>get_string('resetting_data', 'feedback'),
693                         'error'=>false);
694     }
696     // Updating dates - shift may be negative too.
697     if ($data->timeshift) {
698         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
699         // See MDL-9367.
700         $shifterror = !shift_course_mod_dates('feedback', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
701         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => $shifterror);
702     }
704     return $status;
707 /**
708  * Called by course/reset.php
709  *
710  * @global object
711  * @uses FEEDBACK_RESETFORM_RESET
712  * @param object $mform form passed by reference
713  */
714 function feedback_reset_course_form_definition(&$mform) {
715     global $COURSE, $DB;
717     $mform->addElement('header', 'feedbackheader', get_string('modulenameplural', 'feedback'));
719     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$COURSE->id), 'name')) {
720         return;
721     }
723     $mform->addElement('static', 'hint', get_string('resetting_data', 'feedback'));
724     foreach ($feedbacks as $feedback) {
725         $mform->addElement('checkbox', FEEDBACK_RESETFORM_RESET.$feedback->id, $feedback->name);
726     }
729 /**
730  * Course reset form defaults.
731  *
732  * @global object
733  * @uses FEEDBACK_RESETFORM_RESET
734  * @param object $course
735  */
736 function feedback_reset_course_form_defaults($course) {
737     global $DB;
739     $return = array();
740     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')) {
741         return;
742     }
743     foreach ($feedbacks as $feedback) {
744         $return[FEEDBACK_RESETFORM_RESET.$feedback->id] = true;
745     }
746     return $return;
749 /**
750  * Called by course/reset.php and shows the formdata by coursereset.
751  * it prints checkboxes for each feedback available at the given course
752  * there are two checkboxes:
753  * 1) delete userdata and keep the feedback
754  * 2) delete userdata and drop the feedback
755  *
756  * @global object
757  * @uses FEEDBACK_RESETFORM_RESET
758  * @uses FEEDBACK_RESETFORM_DROP
759  * @param object $course
760  * @return void
761  */
762 function feedback_reset_course_form($course) {
763     global $DB, $OUTPUT;
765     echo get_string('resetting_feedbacks', 'feedback'); echo ':<br />';
766     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')) {
767         return;
768     }
770     foreach ($feedbacks as $feedback) {
771         echo '<p>';
772         echo get_string('name', 'feedback').': '.$feedback->name.'<br />';
773         echo html_writer::checkbox(FEEDBACK_RESETFORM_RESET.$feedback->id,
774                                 1, true,
775                                 get_string('resetting_data', 'feedback'));
776         echo '<br />';
777         echo html_writer::checkbox(FEEDBACK_RESETFORM_DROP.$feedback->id,
778                                 1, false,
779                                 get_string('drop_feedback', 'feedback'));
780         echo '</p>';
781     }
784 /**
785  * This gets an array with default options for the editor
786  *
787  * @return array the options
788  */
789 function feedback_get_editor_options() {
790     return array('maxfiles' => EDITOR_UNLIMITED_FILES,
791                 'trusttext'=>true);
794 /**
795  * This creates new events given as timeopen and closeopen by $feedback.
796  *
797  * @global object
798  * @param object $feedback
799  * @return void
800  */
801 function feedback_set_events($feedback) {
802     global $DB, $CFG;
804     // Include calendar/lib.php.
805     require_once($CFG->dirroot.'/calendar/lib.php');
807     // Get CMID if not sent as part of $feedback.
808     if (!isset($feedback->coursemodule)) {
809         $cm = get_coursemodule_from_instance('feedback', $feedback->id, $feedback->course);
810         $feedback->coursemodule = $cm->id;
811     }
813     // Feedback start calendar events.
814     $eventid = $DB->get_field('event', 'id',
815             array('modulename' => 'feedback', 'instance' => $feedback->id, 'eventtype' => FEEDBACK_EVENT_TYPE_OPEN));
817     if (isset($feedback->timeopen) && $feedback->timeopen > 0) {
818         $event = new stdClass();
819         $event->eventtype    = FEEDBACK_EVENT_TYPE_OPEN;
820         $event->type         = empty($feedback->timeclose) ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
821         $event->name         = get_string('calendarstart', 'feedback', $feedback->name);
822         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
823         $event->timestart    = $feedback->timeopen;
824         $event->timesort     = $feedback->timeopen;
825         $event->visible      = instance_is_visible('feedback', $feedback);
826         $event->timeduration = 0;
827         if ($eventid) {
828             // Calendar event exists so update it.
829             $event->id = $eventid;
830             $calendarevent = calendar_event::load($event->id);
831             $calendarevent->update($event);
832         } else {
833             // Event doesn't exist so create one.
834             $event->courseid     = $feedback->course;
835             $event->groupid      = 0;
836             $event->userid       = 0;
837             $event->modulename   = 'feedback';
838             $event->instance     = $feedback->id;
839             $event->eventtype    = FEEDBACK_EVENT_TYPE_OPEN;
840             calendar_event::create($event);
841         }
842     } else if ($eventid) {
843         // Calendar event is on longer needed.
844         $calendarevent = calendar_event::load($eventid);
845         $calendarevent->delete();
846     }
848     // Feedback close calendar events.
849     $eventid = $DB->get_field('event', 'id',
850             array('modulename' => 'feedback', 'instance' => $feedback->id, 'eventtype' => FEEDBACK_EVENT_TYPE_CLOSE));
852     if (isset($feedback->timeclose) && $feedback->timeclose > 0) {
853         $event = new stdClass();
854         $event->type         = CALENDAR_EVENT_TYPE_ACTION;
855         $event->eventtype    = FEEDBACK_EVENT_TYPE_CLOSE;
856         $event->name         = get_string('calendarend', 'feedback', $feedback->name);
857         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
858         $event->timestart    = $feedback->timeclose;
859         $event->timesort     = $feedback->timeclose;
860         $event->visible      = instance_is_visible('feedback', $feedback);
861         $event->timeduration = 0;
862         if ($eventid) {
863             // Calendar event exists so update it.
864             $event->id = $eventid;
865             $calendarevent = calendar_event::load($event->id);
866             $calendarevent->update($event);
867         } else {
868             // Event doesn't exist so create one.
869             $event->courseid     = $feedback->course;
870             $event->groupid      = 0;
871             $event->userid       = 0;
872             $event->modulename   = 'feedback';
873             $event->instance     = $feedback->id;
874             calendar_event::create($event);
875         }
876     } else if ($eventid) {
877         // Calendar event is on longer needed.
878         $calendarevent = calendar_event::load($eventid);
879         $calendarevent->delete();
880     }
883 /**
884  * This standard function will check all instances of this module
885  * and make sure there are up-to-date events created for each of them.
886  * If courseid = 0, then every feedback event in the site is checked, else
887  * only feedback events belonging to the course specified are checked.
888  * This function is used, in its new format, by restore_refresh_events()
889  *
890  * @param int $courseid
891  * @param int|stdClass $instance Feedback module instance or ID.
892  * @param int|stdClass $cm Course module object or ID (not used in this module).
893  * @return bool
894  */
895 function feedback_refresh_events($courseid = 0, $instance = null, $cm = null) {
896     global $DB;
898     // If we have instance information then we can just update the one event instead of updating all events.
899     if (isset($instance)) {
900         if (!is_object($instance)) {
901             $instance = $DB->get_record('feedback', array('id' => $instance), '*', MUST_EXIST);
902         }
903         feedback_set_events($instance);
904         return true;
905     }
907     if ($courseid) {
908         if (! $feedbacks = $DB->get_records("feedback", array("course" => $courseid))) {
909             return true;
910         }
911     } else {
912         if (! $feedbacks = $DB->get_records("feedback")) {
913             return true;
914         }
915     }
917     foreach ($feedbacks as $feedback) {
918         feedback_set_events($feedback);
919     }
920     return true;
923 /**
924  * this function is called by {@link feedback_delete_userdata()}
925  * it drops the feedback-instance from the course_module table
926  *
927  * @global object
928  * @param int $id the id from the coursemodule
929  * @return boolean
930  */
931 function feedback_delete_course_module($id) {
932     global $DB;
934     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
935         return true;
936     }
937     return $DB->delete_records('course_modules', array('id'=>$cm->id));
942 ////////////////////////////////////////////////
943 //functions to handle capabilities
944 ////////////////////////////////////////////////
946 /**
947  * returns the context-id related to the given coursemodule-id
948  *
949  * @deprecated since 3.1
950  * @staticvar object $context
951  * @param int $cmid the coursemodule-id
952  * @return object $context
953  */
954 function feedback_get_context($cmid) {
955     debugging('Function feedback_get_context() is deprecated because it was not used.',
956             DEBUG_DEVELOPER);
957     static $context;
959     if (isset($context)) {
960         return $context;
961     }
963     $context = context_module::instance($cmid);
964     return $context;
967 /**
968  *  returns true if the current role is faked by switching role feature
969  *
970  * @global object
971  * @return boolean
972  */
973 function feedback_check_is_switchrole() {
974     global $USER;
975     if (isset($USER->switchrole) AND
976             is_array($USER->switchrole) AND
977             count($USER->switchrole) > 0) {
979         return true;
980     }
981     return false;
984 /**
985  * count users which have not completed the feedback
986  *
987  * @global object
988  * @uses CONTEXT_MODULE
989  * @param cm_info $cm Course-module object
990  * @param int $group single groupid
991  * @param string $sort
992  * @param int $startpage
993  * @param int $pagecount
994  * @param bool $includestatus to return if the user started or not the feedback among the complete user record
995  * @return array array of user ids or user objects when $includestatus set to true
996  */
997 function feedback_get_incomplete_users(cm_info $cm,
998                                        $group = false,
999                                        $sort = '',
1000                                        $startpage = false,
1001                                        $pagecount = false,
1002                                        $includestatus = false) {
1004     global $DB;
1006     $context = context_module::instance($cm->id);
1008     //first get all user who can complete this feedback
1009     $cap = 'mod/feedback:complete';
1010     $allnames = get_all_user_name_fields(true, 'u');
1011     $fields = 'u.id, ' . $allnames . ', u.picture, u.email, u.imagealt';
1012     if (!$allusers = get_users_by_capability($context,
1013                                             $cap,
1014                                             $fields,
1015                                             $sort,
1016                                             '',
1017                                             '',
1018                                             $group,
1019                                             '',
1020                                             true)) {
1021         return false;
1022     }
1023     // Filter users that are not in the correct group/grouping.
1024     $info = new \core_availability\info_module($cm);
1025     $allusersrecords = $info->filter_user_list($allusers);
1027     $allusers = array_keys($allusersrecords);
1029     //now get all completeds
1030     $params = array('feedback'=>$cm->instance);
1031     if ($completedusers = $DB->get_records_menu('feedback_completed', $params, '', 'id, userid')) {
1032         // Now strike all completedusers from allusers.
1033         $allusers = array_diff($allusers, $completedusers);
1034     }
1036     //for paging I use array_slice()
1037     if ($startpage !== false AND $pagecount !== false) {
1038         $allusers = array_slice($allusers, $startpage, $pagecount);
1039     }
1041     // Check if we should return the full users objects.
1042     if ($includestatus) {
1043         $userrecords = [];
1044         $startedusers = $DB->get_records_menu('feedback_completedtmp', ['feedback' => $cm->instance], '', 'id, userid');
1045         $startedusers = array_flip($startedusers);
1046         foreach ($allusers as $userid) {
1047             $allusersrecords[$userid]->feedbackstarted = isset($startedusers[$userid]);
1048             $userrecords[] = $allusersrecords[$userid];
1049         }
1050         return $userrecords;
1051     } else {    // Return just user ids.
1052         return $allusers;
1053     }
1056 /**
1057  * count users which have not completed the feedback
1058  *
1059  * @global object
1060  * @param object $cm
1061  * @param int $group single groupid
1062  * @return int count of userrecords
1063  */
1064 function feedback_count_incomplete_users($cm, $group = false) {
1065     if ($allusers = feedback_get_incomplete_users($cm, $group)) {
1066         return count($allusers);
1067     }
1068     return 0;
1071 /**
1072  * count users which have completed a feedback
1073  *
1074  * @global object
1075  * @uses FEEDBACK_ANONYMOUS_NO
1076  * @param object $cm
1077  * @param int $group single groupid
1078  * @return int count of userrecords
1079  */
1080 function feedback_count_complete_users($cm, $group = false) {
1081     global $DB;
1083     $params = array(FEEDBACK_ANONYMOUS_NO, $cm->instance);
1085     $fromgroup = '';
1086     $wheregroup = '';
1087     if ($group) {
1088         $fromgroup = ', {groups_members} g';
1089         $wheregroup = ' AND g.groupid = ? AND g.userid = c.userid';
1090         $params[] = $group;
1091     }
1093     $sql = 'SELECT COUNT(u.id) FROM {user} u, {feedback_completed} c'.$fromgroup.'
1094               WHERE anonymous_response = ? AND u.id = c.userid AND c.feedback = ?
1095               '.$wheregroup;
1097     return $DB->count_records_sql($sql, $params);
1101 /**
1102  * get users which have completed a feedback
1103  *
1104  * @global object
1105  * @uses CONTEXT_MODULE
1106  * @uses FEEDBACK_ANONYMOUS_NO
1107  * @param object $cm
1108  * @param int $group single groupid
1109  * @param string $where a sql where condition (must end with " AND ")
1110  * @param array parameters used in $where
1111  * @param string $sort a table field
1112  * @param int $startpage
1113  * @param int $pagecount
1114  * @return object the userrecords
1115  */
1116 function feedback_get_complete_users($cm,
1117                                      $group = false,
1118                                      $where = '',
1119                                      array $params = null,
1120                                      $sort = '',
1121                                      $startpage = false,
1122                                      $pagecount = false) {
1124     global $DB;
1126     $context = context_module::instance($cm->id);
1128     $params = (array)$params;
1130     $params['anon'] = FEEDBACK_ANONYMOUS_NO;
1131     $params['instance'] = $cm->instance;
1133     $fromgroup = '';
1134     $wheregroup = '';
1135     if ($group) {
1136         $fromgroup = ', {groups_members} g';
1137         $wheregroup = ' AND g.groupid = :group AND g.userid = c.userid';
1138         $params['group'] = $group;
1139     }
1141     if ($sort) {
1142         $sortsql = ' ORDER BY '.$sort;
1143     } else {
1144         $sortsql = '';
1145     }
1147     $ufields = user_picture::fields('u');
1148     $sql = 'SELECT DISTINCT '.$ufields.', c.timemodified as completed_timemodified
1149             FROM {user} u, {feedback_completed} c '.$fromgroup.'
1150             WHERE '.$where.' anonymous_response = :anon
1151                 AND u.id = c.userid
1152                 AND c.feedback = :instance
1153               '.$wheregroup.$sortsql;
1155     if ($startpage === false OR $pagecount === false) {
1156         $startpage = false;
1157         $pagecount = false;
1158     }
1159     return $DB->get_records_sql($sql, $params, $startpage, $pagecount);
1162 /**
1163  * get users which have the viewreports-capability
1164  *
1165  * @uses CONTEXT_MODULE
1166  * @param int $cmid
1167  * @param mixed $groups single groupid or array of groupids - group(s) user is in
1168  * @return object the userrecords
1169  */
1170 function feedback_get_viewreports_users($cmid, $groups = false) {
1172     $context = context_module::instance($cmid);
1174     //description of the call below:
1175     //get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='',
1176     //                          $limitnum='', $groups='', $exceptions='', $doanything=true)
1177     return get_users_by_capability($context,
1178                             'mod/feedback:viewreports',
1179                             '',
1180                             'lastname',
1181                             '',
1182                             '',
1183                             $groups,
1184                             '',
1185                             false);
1188 /**
1189  * get users which have the receivemail-capability
1190  *
1191  * @uses CONTEXT_MODULE
1192  * @param int $cmid
1193  * @param mixed $groups single groupid or array of groupids - group(s) user is in
1194  * @return object the userrecords
1195  */
1196 function feedback_get_receivemail_users($cmid, $groups = false) {
1198     $context = context_module::instance($cmid);
1200     //description of the call below:
1201     //get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='',
1202     //                          $limitnum='', $groups='', $exceptions='', $doanything=true)
1203     return get_users_by_capability($context,
1204                             'mod/feedback:receivemail',
1205                             '',
1206                             'lastname',
1207                             '',
1208                             '',
1209                             $groups,
1210                             '',
1211                             false);
1214 ////////////////////////////////////////////////
1215 //functions to handle the templates
1216 ////////////////////////////////////////////////
1217 ////////////////////////////////////////////////
1219 /**
1220  * creates a new template-record.
1221  *
1222  * @global object
1223  * @param int $courseid
1224  * @param string $name the name of template shown in the templatelist
1225  * @param int $ispublic 0:privat 1:public
1226  * @return int the new templateid
1227  */
1228 function feedback_create_template($courseid, $name, $ispublic = 0) {
1229     global $DB;
1231     $templ = new stdClass();
1232     $templ->course   = ($ispublic ? 0 : $courseid);
1233     $templ->name     = $name;
1234     $templ->ispublic = $ispublic;
1236     $templid = $DB->insert_record('feedback_template', $templ);
1237     return $DB->get_record('feedback_template', array('id'=>$templid));
1240 /**
1241  * creates new template items.
1242  * all items will be copied and the attribute feedback will be set to 0
1243  * and the attribute template will be set to the new templateid
1244  *
1245  * @global object
1246  * @uses CONTEXT_MODULE
1247  * @uses CONTEXT_COURSE
1248  * @param object $feedback
1249  * @param string $name the name of template shown in the templatelist
1250  * @param int $ispublic 0:privat 1:public
1251  * @return boolean
1252  */
1253 function feedback_save_as_template($feedback, $name, $ispublic = 0) {
1254     global $DB;
1255     $fs = get_file_storage();
1257     if (!$feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
1258         return false;
1259     }
1261     if (!$newtempl = feedback_create_template($feedback->course, $name, $ispublic)) {
1262         return false;
1263     }
1265     //files in the template_item are in the context of the current course or
1266     //if the template is public the files are in the system context
1267     //files in the feedback_item are in the feedback_context of the feedback
1268     if ($ispublic) {
1269         $s_context = context_system::instance();
1270     } else {
1271         $s_context = context_course::instance($newtempl->course);
1272     }
1273     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
1274     $f_context = context_module::instance($cm->id);
1276     //create items of this new template
1277     //depend items we are storing temporary in an mapping list array(new id => dependitem)
1278     //we also store a mapping of all items array(oldid => newid)
1279     $dependitemsmap = array();
1280     $itembackup = array();
1281     foreach ($feedbackitems as $item) {
1283         $t_item = clone($item);
1285         unset($t_item->id);
1286         $t_item->feedback = 0;
1287         $t_item->template     = $newtempl->id;
1288         $t_item->id = $DB->insert_record('feedback_item', $t_item);
1289         //copy all included files to the feedback_template filearea
1290         $itemfiles = $fs->get_area_files($f_context->id,
1291                                     'mod_feedback',
1292                                     'item',
1293                                     $item->id,
1294                                     "id",
1295                                     false);
1296         if ($itemfiles) {
1297             foreach ($itemfiles as $ifile) {
1298                 $file_record = new stdClass();
1299                 $file_record->contextid = $s_context->id;
1300                 $file_record->component = 'mod_feedback';
1301                 $file_record->filearea = 'template';
1302                 $file_record->itemid = $t_item->id;
1303                 $fs->create_file_from_storedfile($file_record, $ifile);
1304             }
1305         }
1307         $itembackup[$item->id] = $t_item->id;
1308         if ($t_item->dependitem) {
1309             $dependitemsmap[$t_item->id] = $t_item->dependitem;
1310         }
1312     }
1314     //remapping the dependency
1315     foreach ($dependitemsmap as $key => $dependitem) {
1316         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1317         $newitem->dependitem = $itembackup[$newitem->dependitem];
1318         $DB->update_record('feedback_item', $newitem);
1319     }
1321     return true;
1324 /**
1325  * deletes all feedback_items related to the given template id
1326  *
1327  * @global object
1328  * @uses CONTEXT_COURSE
1329  * @param object $template the template
1330  * @return void
1331  */
1332 function feedback_delete_template($template) {
1333     global $DB;
1335     //deleting the files from the item is done by feedback_delete_item
1336     if ($t_items = $DB->get_records("feedback_item", array("template"=>$template->id))) {
1337         foreach ($t_items as $t_item) {
1338             feedback_delete_item($t_item->id, false, $template);
1339         }
1340     }
1341     $DB->delete_records("feedback_template", array("id"=>$template->id));
1344 /**
1345  * creates new feedback_item-records from template.
1346  * if $deleteold is set true so the existing items of the given feedback will be deleted
1347  * if $deleteold is set false so the new items will be appanded to the old items
1348  *
1349  * @global object
1350  * @uses CONTEXT_COURSE
1351  * @uses CONTEXT_MODULE
1352  * @param object $feedback
1353  * @param int $templateid
1354  * @param boolean $deleteold
1355  */
1356 function feedback_items_from_template($feedback, $templateid, $deleteold = false) {
1357     global $DB, $CFG;
1359     require_once($CFG->libdir.'/completionlib.php');
1361     $fs = get_file_storage();
1363     if (!$template = $DB->get_record('feedback_template', array('id'=>$templateid))) {
1364         return false;
1365     }
1366     //get all templateitems
1367     if (!$templitems = $DB->get_records('feedback_item', array('template'=>$templateid))) {
1368         return false;
1369     }
1371     //files in the template_item are in the context of the current course
1372     //files in the feedback_item are in the feedback_context of the feedback
1373     if ($template->ispublic) {
1374         $s_context = context_system::instance();
1375     } else {
1376         $s_context = context_course::instance($feedback->course);
1377     }
1378     $course = $DB->get_record('course', array('id'=>$feedback->course));
1379     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
1380     $f_context = context_module::instance($cm->id);
1382     //if deleteold then delete all old items before
1383     //get all items
1384     if ($deleteold) {
1385         if ($feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
1386             //delete all items of this feedback
1387             foreach ($feedbackitems as $item) {
1388                 feedback_delete_item($item->id, false);
1389             }
1391             $params = array('feedback'=>$feedback->id);
1392             if ($completeds = $DB->get_records('feedback_completed', $params)) {
1393                 $completion = new completion_info($course);
1394                 foreach ($completeds as $completed) {
1395                     $DB->delete_records('feedback_completed', array('id' => $completed->id));
1396                     // Update completion state
1397                     if ($completion->is_enabled($cm) && $cm->completion == COMPLETION_TRACKING_AUTOMATIC &&
1398                             $feedback->completionsubmit) {
1399                         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1400                     }
1401                 }
1402             }
1403             $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedback->id));
1404         }
1405         $positionoffset = 0;
1406     } else {
1407         //if the old items are kept the new items will be appended
1408         //therefor the new position has an offset
1409         $positionoffset = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
1410     }
1412     //create items of this new template
1413     //depend items we are storing temporary in an mapping list array(new id => dependitem)
1414     //we also store a mapping of all items array(oldid => newid)
1415     $dependitemsmap = array();
1416     $itembackup = array();
1417     foreach ($templitems as $t_item) {
1418         $item = clone($t_item);
1419         unset($item->id);
1420         $item->feedback = $feedback->id;
1421         $item->template = 0;
1422         $item->position = $item->position + $positionoffset;
1424         $item->id = $DB->insert_record('feedback_item', $item);
1426         //moving the files to the new item
1427         $templatefiles = $fs->get_area_files($s_context->id,
1428                                         'mod_feedback',
1429                                         'template',
1430                                         $t_item->id,
1431                                         "id",
1432                                         false);
1433         if ($templatefiles) {
1434             foreach ($templatefiles as $tfile) {
1435                 $file_record = new stdClass();
1436                 $file_record->contextid = $f_context->id;
1437                 $file_record->component = 'mod_feedback';
1438                 $file_record->filearea = 'item';
1439                 $file_record->itemid = $item->id;
1440                 $fs->create_file_from_storedfile($file_record, $tfile);
1441             }
1442         }
1444         $itembackup[$t_item->id] = $item->id;
1445         if ($item->dependitem) {
1446             $dependitemsmap[$item->id] = $item->dependitem;
1447         }
1448     }
1450     //remapping the dependency
1451     foreach ($dependitemsmap as $key => $dependitem) {
1452         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1453         $newitem->dependitem = $itembackup[$newitem->dependitem];
1454         $DB->update_record('feedback_item', $newitem);
1455     }
1458 /**
1459  * get the list of available templates.
1460  * if the $onlyown param is set true so only templates from own course will be served
1461  * this is important for droping templates
1462  *
1463  * @global object
1464  * @param object $course
1465  * @param string $onlyownorpublic
1466  * @return array the template recordsets
1467  */
1468 function feedback_get_template_list($course, $onlyownorpublic = '') {
1469     global $DB, $CFG;
1471     switch($onlyownorpublic) {
1472         case '':
1473             $templates = $DB->get_records_select('feedback_template',
1474                                                  'course = ? OR ispublic = 1',
1475                                                  array($course->id),
1476                                                  'name');
1477             break;
1478         case 'own':
1479             $templates = $DB->get_records('feedback_template',
1480                                           array('course'=>$course->id),
1481                                           'name');
1482             break;
1483         case 'public':
1484             $templates = $DB->get_records('feedback_template', array('ispublic'=>1), 'name');
1485             break;
1486     }
1487     return $templates;
1490 ////////////////////////////////////////////////
1491 //Handling der Items
1492 ////////////////////////////////////////////////
1493 ////////////////////////////////////////////////
1495 /**
1496  * load the lib.php from item-plugin-dir and returns the instance of the itemclass
1497  *
1498  * @param string $typ
1499  * @return feedback_item_base the instance of itemclass
1500  */
1501 function feedback_get_item_class($typ) {
1502     global $CFG;
1504     //get the class of item-typ
1505     $itemclass = 'feedback_item_'.$typ;
1506     //get the instance of item-class
1507     if (!class_exists($itemclass)) {
1508         require_once($CFG->dirroot.'/mod/feedback/item/'.$typ.'/lib.php');
1509     }
1510     return new $itemclass();
1513 /**
1514  * load the available item plugins from given subdirectory of $CFG->dirroot
1515  * the default is "mod/feedback/item"
1516  *
1517  * @global object
1518  * @param string $dir the subdir
1519  * @return array pluginnames as string
1520  */
1521 function feedback_load_feedback_items($dir = 'mod/feedback/item') {
1522     global $CFG;
1523     $names = get_list_of_plugins($dir);
1524     $ret_names = array();
1526     foreach ($names as $name) {
1527         require_once($CFG->dirroot.'/'.$dir.'/'.$name.'/lib.php');
1528         if (class_exists('feedback_item_'.$name)) {
1529             $ret_names[] = $name;
1530         }
1531     }
1532     return $ret_names;
1535 /**
1536  * load the available item plugins to use as dropdown-options
1537  *
1538  * @global object
1539  * @return array pluginnames as string
1540  */
1541 function feedback_load_feedback_items_options() {
1542     global $CFG;
1544     $feedback_options = array("pagebreak" => get_string('add_pagebreak', 'feedback'));
1546     if (!$feedback_names = feedback_load_feedback_items('mod/feedback/item')) {
1547         return array();
1548     }
1550     foreach ($feedback_names as $fn) {
1551         $feedback_options[$fn] = get_string($fn, 'feedback');
1552     }
1553     asort($feedback_options);
1554     return $feedback_options;
1557 /**
1558  * load the available items for the depend item dropdown list shown in the edit_item form
1559  *
1560  * @global object
1561  * @param object $feedback
1562  * @param object $item the item of the edit_item form
1563  * @return array all items except the item $item, labels and pagebreaks
1564  */
1565 function feedback_get_depend_candidates_for_item($feedback, $item) {
1566     global $DB;
1567     //all items for dependitem
1568     $where = "feedback = ? AND typ != 'pagebreak' AND hasvalue = 1";
1569     $params = array($feedback->id);
1570     if (isset($item->id) AND $item->id) {
1571         $where .= ' AND id != ?';
1572         $params[] = $item->id;
1573     }
1574     $dependitems = array(0 => get_string('choose'));
1575     $feedbackitems = $DB->get_records_select_menu('feedback_item',
1576                                                   $where,
1577                                                   $params,
1578                                                   'position',
1579                                                   'id, label');
1581     if (!$feedbackitems) {
1582         return $dependitems;
1583     }
1584     //adding the choose-option
1585     foreach ($feedbackitems as $key => $val) {
1586         if (trim(strval($val)) !== '') {
1587             $dependitems[$key] = format_string($val);
1588         }
1589     }
1590     return $dependitems;
1593 /**
1594  * creates a new item-record
1595  *
1596  * @deprecated since 3.1
1597  * @param object $data the data from edit_item_form
1598  * @return int the new itemid
1599  */
1600 function feedback_create_item($data) {
1601     debugging('Function feedback_create_item() is deprecated because it was not used.',
1602             DEBUG_DEVELOPER);
1603     global $DB;
1605     $item = new stdClass();
1606     $item->feedback = $data->feedbackid;
1608     $item->template=0;
1609     if (isset($data->templateid)) {
1610             $item->template = intval($data->templateid);
1611     }
1613     $itemname = trim($data->itemname);
1614     $item->name = ($itemname ? $data->itemname : get_string('no_itemname', 'feedback'));
1616     if (!empty($data->itemlabel)) {
1617         $item->label = trim($data->itemlabel);
1618     } else {
1619         $item->label = get_string('no_itemlabel', 'feedback');
1620     }
1622     $itemobj = feedback_get_item_class($data->typ);
1623     $item->presentation = ''; //the date comes from postupdate() of the itemobj
1625     $item->hasvalue = $itemobj->get_hasvalue();
1627     $item->typ = $data->typ;
1628     $item->position = $data->position;
1630     $item->required=0;
1631     if (!empty($data->required)) {
1632         $item->required = $data->required;
1633     }
1635     $item->id = $DB->insert_record('feedback_item', $item);
1637     //move all itemdata to the data
1638     $data->id = $item->id;
1639     $data->feedback = $item->feedback;
1640     $data->name = $item->name;
1641     $data->label = $item->label;
1642     $data->required = $item->required;
1643     return $itemobj->postupdate($data);
1646 /**
1647  * save the changes of a given item.
1648  *
1649  * @global object
1650  * @param object $item
1651  * @return boolean
1652  */
1653 function feedback_update_item($item) {
1654     global $DB;
1655     return $DB->update_record("feedback_item", $item);
1658 /**
1659  * deletes an item and also deletes all related values
1660  *
1661  * @global object
1662  * @uses CONTEXT_MODULE
1663  * @param int $itemid
1664  * @param boolean $renumber should the kept items renumbered Yes/No
1665  * @param object $template if the template is given so the items are bound to it
1666  * @return void
1667  */
1668 function feedback_delete_item($itemid, $renumber = true, $template = false) {
1669     global $DB;
1671     $item = $DB->get_record('feedback_item', array('id'=>$itemid));
1673     //deleting the files from the item
1674     $fs = get_file_storage();
1676     if ($template) {
1677         if ($template->ispublic) {
1678             $context = context_system::instance();
1679         } else {
1680             $context = context_course::instance($template->course);
1681         }
1682         $templatefiles = $fs->get_area_files($context->id,
1683                                     'mod_feedback',
1684                                     'template',
1685                                     $item->id,
1686                                     "id",
1687                                     false);
1689         if ($templatefiles) {
1690             $fs->delete_area_files($context->id, 'mod_feedback', 'template', $item->id);
1691         }
1692     } else {
1693         if (!$cm = get_coursemodule_from_instance('feedback', $item->feedback)) {
1694             return false;
1695         }
1696         $context = context_module::instance($cm->id);
1698         $itemfiles = $fs->get_area_files($context->id,
1699                                     'mod_feedback',
1700                                     'item',
1701                                     $item->id,
1702                                     "id", false);
1704         if ($itemfiles) {
1705             $fs->delete_area_files($context->id, 'mod_feedback', 'item', $item->id);
1706         }
1707     }
1709     $DB->delete_records("feedback_value", array("item"=>$itemid));
1710     $DB->delete_records("feedback_valuetmp", array("item"=>$itemid));
1712     //remove all depends
1713     $DB->set_field('feedback_item', 'dependvalue', '', array('dependitem'=>$itemid));
1714     $DB->set_field('feedback_item', 'dependitem', 0, array('dependitem'=>$itemid));
1716     $DB->delete_records("feedback_item", array("id"=>$itemid));
1717     if ($renumber) {
1718         feedback_renumber_items($item->feedback);
1719     }
1722 /**
1723  * deletes all items of the given feedbackid
1724  *
1725  * @global object
1726  * @param int $feedbackid
1727  * @return void
1728  */
1729 function feedback_delete_all_items($feedbackid) {
1730     global $DB, $CFG;
1731     require_once($CFG->libdir.'/completionlib.php');
1733     if (!$feedback = $DB->get_record('feedback', array('id'=>$feedbackid))) {
1734         return false;
1735     }
1737     if (!$cm = get_coursemodule_from_instance('feedback', $feedback->id)) {
1738         return false;
1739     }
1741     if (!$course = $DB->get_record('course', array('id'=>$feedback->course))) {
1742         return false;
1743     }
1745     if (!$items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid))) {
1746         return;
1747     }
1748     foreach ($items as $item) {
1749         feedback_delete_item($item->id, false);
1750     }
1751     if ($completeds = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
1752         $completion = new completion_info($course);
1753         foreach ($completeds as $completed) {
1754             $DB->delete_records('feedback_completed', array('id' => $completed->id));
1755             // Update completion state
1756             if ($completion->is_enabled($cm) && $cm->completion == COMPLETION_TRACKING_AUTOMATIC &&
1757                     $feedback->completionsubmit) {
1758                 $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1759             }
1760         }
1761     }
1763     $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedbackid));
1767 /**
1768  * this function toggled the item-attribute required (yes/no)
1769  *
1770  * @global object
1771  * @param object $item
1772  * @return boolean
1773  */
1774 function feedback_switch_item_required($item) {
1775     global $DB, $CFG;
1777     $itemobj = feedback_get_item_class($item->typ);
1779     if ($itemobj->can_switch_require()) {
1780         $new_require_val = (int)!(bool)$item->required;
1781         $params = array('id'=>$item->id);
1782         $DB->set_field('feedback_item', 'required', $new_require_val, $params);
1783     }
1784     return true;
1787 /**
1788  * renumbers all items of the given feedbackid
1789  *
1790  * @global object
1791  * @param int $feedbackid
1792  * @return void
1793  */
1794 function feedback_renumber_items($feedbackid) {
1795     global $DB;
1797     $items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid), 'position');
1798     $pos = 1;
1799     if ($items) {
1800         foreach ($items as $item) {
1801             $DB->set_field('feedback_item', 'position', $pos, array('id'=>$item->id));
1802             $pos++;
1803         }
1804     }
1807 /**
1808  * this decreases the position of the given item
1809  *
1810  * @global object
1811  * @param object $item
1812  * @return bool
1813  */
1814 function feedback_moveup_item($item) {
1815     global $DB;
1817     if ($item->position == 1) {
1818         return true;
1819     }
1821     $params = array('feedback'=>$item->feedback);
1822     if (!$items = $DB->get_records('feedback_item', $params, 'position')) {
1823         return false;
1824     }
1826     $itembefore = null;
1827     foreach ($items as $i) {
1828         if ($i->id == $item->id) {
1829             if (is_null($itembefore)) {
1830                 return true;
1831             }
1832             $itembefore->position = $item->position;
1833             $item->position--;
1834             feedback_update_item($itembefore);
1835             feedback_update_item($item);
1836             feedback_renumber_items($item->feedback);
1837             return true;
1838         }
1839         $itembefore = $i;
1840     }
1841     return false;
1844 /**
1845  * this increased the position of the given item
1846  *
1847  * @global object
1848  * @param object $item
1849  * @return bool
1850  */
1851 function feedback_movedown_item($item) {
1852     global $DB;
1854     $params = array('feedback'=>$item->feedback);
1855     if (!$items = $DB->get_records('feedback_item', $params, 'position')) {
1856         return false;
1857     }
1859     $movedownitem = null;
1860     foreach ($items as $i) {
1861         if (!is_null($movedownitem) AND $movedownitem->id == $item->id) {
1862             $movedownitem->position = $i->position;
1863             $i->position--;
1864             feedback_update_item($movedownitem);
1865             feedback_update_item($i);
1866             feedback_renumber_items($item->feedback);
1867             return true;
1868         }
1869         $movedownitem = $i;
1870     }
1871     return false;
1874 /**
1875  * here the position of the given item will be set to the value in $pos
1876  *
1877  * @global object
1878  * @param object $moveitem
1879  * @param int $pos
1880  * @return boolean
1881  */
1882 function feedback_move_item($moveitem, $pos) {
1883     global $DB;
1885     $params = array('feedback'=>$moveitem->feedback);
1886     if (!$allitems = $DB->get_records('feedback_item', $params, 'position')) {
1887         return false;
1888     }
1889     if (is_array($allitems)) {
1890         $index = 1;
1891         foreach ($allitems as $item) {
1892             if ($index == $pos) {
1893                 $index++;
1894             }
1895             if ($item->id == $moveitem->id) {
1896                 $moveitem->position = $pos;
1897                 feedback_update_item($moveitem);
1898                 continue;
1899             }
1900             $item->position = $index;
1901             feedback_update_item($item);
1902             $index++;
1903         }
1904         return true;
1905     }
1906     return false;
1909 /**
1910  * prints the given item as a preview.
1911  * each item-class has an own print_item_preview function implemented.
1912  *
1913  * @deprecated since Moodle 3.1
1914  * @global object
1915  * @param object $item the item what we want to print out
1916  * @return void
1917  */
1918 function feedback_print_item_preview($item) {
1919     debugging('Function feedback_print_item_preview() is deprecated and does nothing. '
1920             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1923 /**
1924  * prints the given item in the completion form.
1925  * each item-class has an own print_item_complete function implemented.
1926  *
1927  * @deprecated since Moodle 3.1
1928  * @param object $item the item what we want to print out
1929  * @param mixed $value the value
1930  * @param boolean $highlightrequire if this set true and the value are false on completing so the item will be highlighted
1931  * @return void
1932  */
1933 function feedback_print_item_complete($item, $value = false, $highlightrequire = false) {
1934     debugging('Function feedback_print_item_complete() is deprecated and does nothing. '
1935             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1938 /**
1939  * prints the given item in the show entries page.
1940  * each item-class has an own print_item_show_value function implemented.
1941  *
1942  * @deprecated since Moodle 3.1
1943  * @param object $item the item what we want to print out
1944  * @param mixed $value
1945  * @return void
1946  */
1947 function feedback_print_item_show_value($item, $value = false) {
1948     debugging('Function feedback_print_item_show_value() is deprecated and does nothing. '
1949             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1952 /**
1953  * if the user completes a feedback and there is a pagebreak so the values are saved temporary.
1954  * the values are not saved permanently until the user click on save button
1955  *
1956  * @global object
1957  * @param object $feedbackcompleted
1958  * @return object temporary saved completed-record
1959  */
1960 function feedback_set_tmp_values($feedbackcompleted) {
1961     global $DB;
1963     //first we create a completedtmp
1964     $tmpcpl = new stdClass();
1965     foreach ($feedbackcompleted as $key => $value) {
1966         $tmpcpl->{$key} = $value;
1967     }
1968     unset($tmpcpl->id);
1969     $tmpcpl->timemodified = time();
1970     $tmpcpl->id = $DB->insert_record('feedback_completedtmp', $tmpcpl);
1971     //get all values of original-completed
1972     if (!$values = $DB->get_records('feedback_value', array('completed'=>$feedbackcompleted->id))) {
1973         return;
1974     }
1975     foreach ($values as $value) {
1976         unset($value->id);
1977         $value->completed = $tmpcpl->id;
1978         $DB->insert_record('feedback_valuetmp', $value);
1979     }
1980     return $tmpcpl;
1983 /**
1984  * this saves the temporary saved values permanently
1985  *
1986  * @global object
1987  * @param object $feedbackcompletedtmp the temporary completed
1988  * @param object $feedbackcompleted the target completed
1989  * @return int the id of the completed
1990  */
1991 function feedback_save_tmp_values($feedbackcompletedtmp, $feedbackcompleted) {
1992     global $DB;
1994     $tmpcplid = $feedbackcompletedtmp->id;
1995     if ($feedbackcompleted) {
1996         //first drop all existing values
1997         $DB->delete_records('feedback_value', array('completed'=>$feedbackcompleted->id));
1998         //update the current completed
1999         $feedbackcompleted->timemodified = time();
2000         $DB->update_record('feedback_completed', $feedbackcompleted);
2001     } else {
2002         $feedbackcompleted = clone($feedbackcompletedtmp);
2003         $feedbackcompleted->id = '';
2004         $feedbackcompleted->timemodified = time();
2005         $feedbackcompleted->id = $DB->insert_record('feedback_completed', $feedbackcompleted);
2006     }
2008     $allitems = $DB->get_records('feedback_item', array('feedback' => $feedbackcompleted->feedback));
2010     //save all the new values from feedback_valuetmp
2011     //get all values of tmp-completed
2012     $params = array('completed'=>$feedbackcompletedtmp->id);
2013     $values = $DB->get_records('feedback_valuetmp', $params);
2014     foreach ($values as $value) {
2015         //check if there are depend items
2016         $item = $DB->get_record('feedback_item', array('id'=>$value->item));
2017         if ($item->dependitem > 0 && isset($allitems[$item->dependitem])) {
2018             $check = feedback_compare_item_value($tmpcplid,
2019                                         $allitems[$item->dependitem],
2020                                         $item->dependvalue,
2021                                         true);
2022         } else {
2023             $check = true;
2024         }
2025         if ($check) {
2026             unset($value->id);
2027             $value->completed = $feedbackcompleted->id;
2028             $DB->insert_record('feedback_value', $value);
2029         }
2030     }
2031     //drop all the tmpvalues
2032     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
2033     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
2035     // Trigger event for the delete action we performed.
2036     $cm = get_coursemodule_from_instance('feedback', $feedbackcompleted->feedback);
2037     $event = \mod_feedback\event\response_submitted::create_from_record($feedbackcompleted, $cm);
2038     $event->trigger();
2039     return $feedbackcompleted->id;
2043 /**
2044  * deletes the given temporary completed and all related temporary values
2045  *
2046  * @deprecated since Moodle 3.1
2047  *
2048  * @param int $tmpcplid
2049  * @return void
2050  */
2051 function feedback_delete_completedtmp($tmpcplid) {
2052     global $DB;
2054     debugging('Function feedback_delete_completedtmp() is deprecated because it is no longer used',
2055             DEBUG_DEVELOPER);
2057     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
2058     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
2061 ////////////////////////////////////////////////
2062 ////////////////////////////////////////////////
2063 ////////////////////////////////////////////////
2064 //functions to handle the pagebreaks
2065 ////////////////////////////////////////////////
2067 /**
2068  * this creates a pagebreak.
2069  * a pagebreak is a special kind of item
2070  *
2071  * @global object
2072  * @param int $feedbackid
2073  * @return mixed false if there already is a pagebreak on last position or the id of the pagebreak-item
2074  */
2075 function feedback_create_pagebreak($feedbackid) {
2076     global $DB;
2078     //check if there already is a pagebreak on the last position
2079     $lastposition = $DB->count_records('feedback_item', array('feedback'=>$feedbackid));
2080     if ($lastposition == feedback_get_last_break_position($feedbackid)) {
2081         return false;
2082     }
2084     $item = new stdClass();
2085     $item->feedback = $feedbackid;
2087     $item->template=0;
2089     $item->name = '';
2091     $item->presentation = '';
2092     $item->hasvalue = 0;
2094     $item->typ = 'pagebreak';
2095     $item->position = $lastposition + 1;
2097     $item->required=0;
2099     return $DB->insert_record('feedback_item', $item);
2102 /**
2103  * get all positions of pagebreaks in the given feedback
2104  *
2105  * @global object
2106  * @param int $feedbackid
2107  * @return array all ordered pagebreak positions
2108  */
2109 function feedback_get_all_break_positions($feedbackid) {
2110     global $DB;
2112     $params = array('typ'=>'pagebreak', 'feedback'=>$feedbackid);
2113     $allbreaks = $DB->get_records_menu('feedback_item', $params, 'position', 'id, position');
2114     if (!$allbreaks) {
2115         return false;
2116     }
2117     return array_values($allbreaks);
2120 /**
2121  * get the position of the last pagebreak
2122  *
2123  * @param int $feedbackid
2124  * @return int the position of the last pagebreak
2125  */
2126 function feedback_get_last_break_position($feedbackid) {
2127     if (!$allbreaks = feedback_get_all_break_positions($feedbackid)) {
2128         return false;
2129     }
2130     return $allbreaks[count($allbreaks) - 1];
2133 /**
2134  * this returns the position where the user can continue the completing.
2135  *
2136  * @deprecated since Moodle 3.1
2137  * @global object
2138  * @global object
2139  * @global object
2140  * @param int $feedbackid
2141  * @param int $courseid
2142  * @param string $guestid this id will be saved temporary and is unique
2143  * @return int the position to continue
2144  */
2145 function feedback_get_page_to_continue($feedbackid, $courseid = false, $guestid = false) {
2146     global $CFG, $USER, $DB;
2148     debugging('Function feedback_get_page_to_continue() is deprecated and since it is '
2149             . 'no longer used in mod_feedback', DEBUG_DEVELOPER);
2151     //is there any break?
2153     if (!$allbreaks = feedback_get_all_break_positions($feedbackid)) {
2154         return false;
2155     }
2157     $params = array();
2158     if ($courseid) {
2159         $courseselect = "AND fv.course_id = :courseid";
2160         $params['courseid'] = $courseid;
2161     } else {
2162         $courseselect = '';
2163     }
2165     if ($guestid) {
2166         $userselect = "AND fc.guestid = :guestid";
2167         $usergroup = "GROUP BY fc.guestid";
2168         $params['guestid'] = $guestid;
2169     } else {
2170         $userselect = "AND fc.userid = :userid";
2171         $usergroup = "GROUP BY fc.userid";
2172         $params['userid'] = $USER->id;
2173     }
2175     $sql =  "SELECT MAX(fi.position)
2176                FROM {feedback_completedtmp} fc, {feedback_valuetmp} fv, {feedback_item} fi
2177               WHERE fc.id = fv.completed
2178                     $userselect
2179                     AND fc.feedback = :feedbackid
2180                     $courseselect
2181                     AND fi.id = fv.item
2182          $usergroup";
2183     $params['feedbackid'] = $feedbackid;
2185     $lastpos = $DB->get_field_sql($sql, $params);
2187     //the index of found pagebreak is the searched pagenumber
2188     foreach ($allbreaks as $pagenr => $br) {
2189         if ($lastpos < $br) {
2190             return $pagenr;
2191         }
2192     }
2193     return count($allbreaks);
2196 ////////////////////////////////////////////////
2197 ////////////////////////////////////////////////
2198 ////////////////////////////////////////////////
2199 //functions to handle the values
2200 ////////////////////////////////////////////////
2202 /**
2203  * cleans the userinput while submitting the form.
2204  *
2205  * @deprecated since Moodle 3.1
2206  * @param mixed $value
2207  * @return mixed
2208  */
2209 function feedback_clean_input_value($item, $value) {
2210     debugging('Function feedback_clean_input_value() is deprecated and does nothing. '
2211             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
2214 /**
2215  * this saves the values of an completed.
2216  * if the param $tmp is set true so the values are saved temporary in table feedback_valuetmp.
2217  * if there is already a completed and the userid is set so the values are updated.
2218  * on all other things new value records will be created.
2219  *
2220  * @deprecated since Moodle 3.1
2221  *
2222  * @param int $usrid
2223  * @param boolean $tmp
2224  * @return mixed false on error or the completeid
2225  */
2226 function feedback_save_values($usrid, $tmp = false) {
2227     global $DB;
2229     debugging('Function feedback_save_values() was deprecated because it did not have '.
2230             'enough arguments, was not suitable for non-temporary table and was taking '.
2231             'data directly from input', DEBUG_DEVELOPER);
2233     $completedid = optional_param('completedid', 0, PARAM_INT);
2234     $tmpstr = $tmp ? 'tmp' : '';
2235     $time = time();
2236     $timemodified = mktime(0, 0, 0, date('m', $time), date('d', $time), date('Y', $time));
2238     if ($usrid == 0) {
2239         return feedback_create_values($usrid, $timemodified, $tmp);
2240     }
2241     $completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid));
2242     if (!$completed) {
2243         return feedback_create_values($usrid, $timemodified, $tmp);
2244     } else {
2245         $completed->timemodified = $timemodified;
2246         return feedback_update_values($completed, $tmp);
2247     }
2250 /**
2251  * this saves the values from anonymous user such as guest on the main-site
2252  *
2253  * @deprecated since Moodle 3.1
2254  *
2255  * @param string $guestid the unique guestidentifier
2256  * @return mixed false on error or the completeid
2257  */
2258 function feedback_save_guest_values($guestid) {
2259     global $DB;
2261     debugging('Function feedback_save_guest_values() was deprecated because it did not have '.
2262             'enough arguments, was not suitable for non-temporary table and was taking '.
2263             'data directly from input', DEBUG_DEVELOPER);
2265     $completedid = optional_param('completedid', false, PARAM_INT);
2267     $timemodified = time();
2268     if (!$completed = $DB->get_record('feedback_completedtmp', array('id'=>$completedid))) {
2269         return feedback_create_values(0, $timemodified, true, $guestid);
2270     } else {
2271         $completed->timemodified = $timemodified;
2272         return feedback_update_values($completed, true);
2273     }
2276 /**
2277  * get the value from the given item related to the given completed.
2278  * the value can come as temporary or as permanently value. the deciding is done by $tmp
2279  *
2280  * @global object
2281  * @param int $completeid
2282  * @param int $itemid
2283  * @param boolean $tmp
2284  * @return mixed the value, the type depends on plugin-definition
2285  */
2286 function feedback_get_item_value($completedid, $itemid, $tmp = false) {
2287     global $DB;
2289     $tmpstr = $tmp ? 'tmp' : '';
2290     $params = array('completed'=>$completedid, 'item'=>$itemid);
2291     return $DB->get_field('feedback_value'.$tmpstr, 'value', $params);
2294 /**
2295  * compares the value of the itemid related to the completedid with the dependvalue.
2296  * this is used if a depend item is set.
2297  * the value can come as temporary or as permanently value. the deciding is done by $tmp.
2298  *
2299  * @param int $completedid
2300  * @param stdClass|int $item
2301  * @param mixed $dependvalue
2302  * @param bool $tmp
2303  * @return bool
2304  */
2305 function feedback_compare_item_value($completedid, $item, $dependvalue, $tmp = false) {
2306     global $DB;
2308     if (is_int($item)) {
2309         $item = $DB->get_record('feedback_item', array('id' => $item));
2310     }
2312     $dbvalue = feedback_get_item_value($completedid, $item->id, $tmp);
2314     $itemobj = feedback_get_item_class($item->typ);
2315     return $itemobj->compare_value($item, $dbvalue, $dependvalue); //true or false
2318 /**
2319  * this function checks the correctness of values.
2320  * the rules for this are implemented in the class of each item.
2321  * it can be the required attribute or the value self e.g. numeric.
2322  * the params first/lastitem are given to determine the visible range between pagebreaks.
2323  *
2324  * @global object
2325  * @param int $firstitem the position of firstitem for checking
2326  * @param int $lastitem the position of lastitem for checking
2327  * @return boolean
2328  */
2329 function feedback_check_values($firstitem, $lastitem) {
2330     debugging('Function feedback_check_values() is deprecated and does nothing. '
2331             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
2332     return true;
2335 /**
2336  * this function create a complete-record and the related value-records.
2337  * depending on the $tmp (true/false) the values are saved temporary or permanently
2338  *
2339  * @deprecated since Moodle 3.1
2340  *
2341  * @param int $userid
2342  * @param int $timemodified
2343  * @param boolean $tmp
2344  * @param string $guestid a unique identifier to save temporary data
2345  * @return mixed false on error or the completedid
2346  */
2347 function feedback_create_values($usrid, $timemodified, $tmp = false, $guestid = false) {
2348     global $DB;
2350     debugging('Function feedback_create_values() was deprecated because it did not have '.
2351             'enough arguments, was not suitable for non-temporary table and was taking '.
2352             'data directly from input', DEBUG_DEVELOPER);
2354     $tmpstr = $tmp ? 'tmp' : '';
2355     //first we create a new completed record
2356     $completed = new stdClass();
2357     $completed->feedback           = $feedbackid;
2358     $completed->userid             = $usrid;
2359     $completed->guestid            = $guestid;
2360     $completed->timemodified       = $timemodified;
2361     $completed->anonymous_response = $anonymous_response;
2363     $completedid = $DB->insert_record('feedback_completed'.$tmpstr, $completed);
2365     $completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid));
2367     //the keys are in the form like abc_xxx
2368     //with explode we make an array with(abc, xxx) and (abc=typ und xxx=itemnr)
2370     //get the items of the feedback
2371     if (!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2372         return false;
2373     }
2374     foreach ($allitems as $item) {
2375         if (!$item->hasvalue) {
2376             continue;
2377         }
2378         //get the class of item-typ
2379         $itemobj = feedback_get_item_class($item->typ);
2381         $keyname = $item->typ.'_'.$item->id;
2383         if ($item->typ === 'multichoice') {
2384             $itemvalue = optional_param_array($keyname, null, PARAM_INT);
2385         } else {
2386             $itemvalue = optional_param($keyname, null, PARAM_NOTAGS);
2387         }
2389         if (is_null($itemvalue)) {
2390             continue;
2391         }
2393         $value = new stdClass();
2394         $value->item = $item->id;
2395         $value->completed = $completed->id;
2396         $value->course_id = $courseid;
2398         //the kind of values can be absolutely different
2399         //so we run create_value directly by the item-class
2400         $value->value = $itemobj->create_value($itemvalue);
2401         $DB->insert_record('feedback_value'.$tmpstr, $value);
2402     }
2403     return $completed->id;
2406 /**
2407  * this function updates a complete-record and the related value-records.
2408  * depending on the $tmp (true/false) the values are saved temporary or permanently
2409  *
2410  * @global object
2411  * @param object $completed
2412  * @param boolean $tmp
2413  * @return int the completedid
2414  */
2415 function feedback_update_values($completed, $tmp = false) {
2416     global $DB;
2418     debugging('Function feedback_update_values() was deprecated because it did not have '.
2419             'enough arguments, was not suitable for non-temporary table and was taking '.
2420             'data directly from input', DEBUG_DEVELOPER);
2422     $courseid = optional_param('courseid', false, PARAM_INT);
2423     $tmpstr = $tmp ? 'tmp' : '';
2425     $DB->update_record('feedback_completed'.$tmpstr, $completed);
2426     //get the values of this completed
2427     $values = $DB->get_records('feedback_value'.$tmpstr, array('completed'=>$completed->id));
2429     //get the items of the feedback
2430     if (!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2431         return false;
2432     }
2433     foreach ($allitems as $item) {
2434         if (!$item->hasvalue) {
2435             continue;
2436         }
2437         //get the class of item-typ
2438         $itemobj = feedback_get_item_class($item->typ);
2440         $keyname = $item->typ.'_'.$item->id;
2442         if ($item->typ === 'multichoice') {
2443             $itemvalue = optional_param_array($keyname, null, PARAM_INT);
2444         } else {
2445             $itemvalue = optional_param($keyname, null, PARAM_NOTAGS);
2446         }
2448         //is the itemvalue set (could be a subset of items because pagebreak)?
2449         if (is_null($itemvalue)) {
2450             continue;
2451         }
2453         $newvalue = new stdClass();
2454         $newvalue->item = $item->id;
2455         $newvalue->completed = $completed->id;
2456         $newvalue->course_id = $courseid;
2458         //the kind of values can be absolutely different
2459         //so we run create_value directly by the item-class
2460         $newvalue->value = $itemobj->create_value($itemvalue);
2462         //check, if we have to create or update the value
2463         $exist = false;
2464         foreach ($values as $value) {
2465             if ($value->item == $newvalue->item) {
2466                 $newvalue->id = $value->id;
2467                 $exist = true;
2468                 break;
2469             }
2470         }
2471         if ($exist) {
2472             $DB->update_record('feedback_value'.$tmpstr, $newvalue);
2473         } else {
2474             $DB->insert_record('feedback_value'.$tmpstr, $newvalue);
2475         }
2476     }
2478     return $completed->id;
2481 /**
2482  * get the values of an item depending on the given groupid.
2483  * if the feedback is anonymous so the values are shuffled
2484  *
2485  * @global object
2486  * @global object
2487  * @param object $item
2488  * @param int $groupid
2489  * @param int $courseid
2490  * @param bool $ignore_empty if this is set true so empty values are not delivered
2491  * @return array the value-records
2492  */
2493 function feedback_get_group_values($item,
2494                                    $groupid = false,
2495                                    $courseid = false,
2496                                    $ignore_empty = false) {
2498     global $CFG, $DB;
2500     //if the groupid is given?
2501     if (intval($groupid) > 0) {
2502         $params = array();
2503         if ($ignore_empty) {
2504             $value = $DB->sql_compare_text('fbv.value');
2505             $ignore_empty_select = "AND $value != :emptyvalue AND $value != :zerovalue";
2506             $params += array('emptyvalue' => '', 'zerovalue' => '0');
2507         } else {
2508             $ignore_empty_select = "";
2509         }
2511         $query = 'SELECT fbv .  *
2512                     FROM {feedback_value} fbv, {feedback_completed} fbc, {groups_members} gm
2513                    WHERE fbv.item = :itemid
2514                          AND fbv.completed = fbc.id
2515                          AND fbc.userid = gm.userid
2516                          '.$ignore_empty_select.'
2517                          AND gm.groupid = :groupid
2518                 ORDER BY fbc.timemodified';
2519         $params += array('itemid' => $item->id, 'groupid' => $groupid);
2520         $values = $DB->get_records_sql($query, $params);
2522     } else {
2523         $params = array();
2524         if ($ignore_empty) {
2525             $value = $DB->sql_compare_text('value');
2526             $ignore_empty_select = "AND $value != :emptyvalue AND $value != :zerovalue";
2527             $params += array('emptyvalue' => '', 'zerovalue' => '0');
2528         } else {
2529             $ignore_empty_select = "";
2530         }
2532         if ($courseid) {
2533             $select = "item = :itemid AND course_id = :courseid ".$ignore_empty_select;
2534             $params += array('itemid' => $item->id, 'courseid' => $courseid);
2535             $values = $DB->get_records_select('feedback_value', $select, $params);
2536         } else {
2537             $select = "item = :itemid ".$ignore_empty_select;
2538             $params += array('itemid' => $item->id);
2539             $values = $DB->get_records_select('feedback_value', $select, $params);
2540         }
2541     }
2542     $params = array('id'=>$item->feedback);
2543     if ($DB->get_field('feedback', 'anonymous', $params) == FEEDBACK_ANONYMOUS_YES) {
2544         if (is_array($values)) {
2545             shuffle($values);
2546         }
2547     }
2548     return $values;
2551 /**
2552  * check for multiple_submit = false.
2553  * if the feedback is global so the courseid must be given
2554  *
2555  * @global object
2556  * @global object
2557  * @param int $feedbackid
2558  * @param int $courseid
2559  * @return boolean true if the feedback already is submitted otherwise false
2560  */
2561 function feedback_is_already_submitted($feedbackid, $courseid = false) {
2562     global $USER, $DB;
2564     if (!isloggedin() || isguestuser()) {
2565         return false;
2566     }
2568     $params = array('userid' => $USER->id, 'feedback' => $feedbackid);
2569     if ($courseid) {
2570         $params['courseid'] = $courseid;
2571     }
2572     return $DB->record_exists('feedback_completed', $params);
2575 /**
2576  * if the completion of a feedback will be continued eg.
2577  * by pagebreak or by multiple submit so the complete must be found.
2578  * if the param $tmp is set true so all things are related to temporary completeds
2579  *
2580  * @deprecated since Moodle 3.1
2581  * @param int $feedbackid
2582  * @param boolean $tmp
2583  * @param int $courseid
2584  * @param string $guestid
2585  * @return int the id of the found completed
2586  */
2587 function feedback_get_current_completed($feedbackid,
2588                                         $tmp = false,
2589                                         $courseid = false,
2590                                         $guestid = false) {
2592     debugging('Function feedback_get_current_completed() is deprecated. Please use either '.
2593             'feedback_get_current_completed_tmp() or feedback_get_last_completed()',
2594             DEBUG_DEVELOPER);
2596     global $USER, $CFG, $DB;
2598     $tmpstr = $tmp ? 'tmp' : '';
2600     if (!$courseid) {
2601         if ($guestid) {
2602             $params = array('feedback'=>$feedbackid, 'guestid'=>$guestid);
2603             return $DB->get_record('feedback_completed'.$tmpstr, $params);
2604         } else {
2605             $params = array('feedback'=>$feedbackid, 'userid'=>$USER->id);
2606             return $DB->get_record('feedback_completed'.$tmpstr, $params);
2607         }
2608     }
2610     $params = array();
2612     if ($guestid) {
2613         $userselect = "AND fc.guestid = :guestid";
2614         $params['guestid'] = $guestid;
2615     } else {
2616         $userselect = "AND fc.userid = :userid";
2617         $params['userid'] = $USER->id;
2618     }
2619     //if courseid is set the feedback is global.
2620     //there can be more than one completed on one feedback
2621     $sql =  "SELECT DISTINCT fc.*
2622                FROM {feedback_value{$tmpstr}} fv, {feedback_completed{$tmpstr}} fc
2623               WHERE fv.course_id = :courseid
2624                     AND fv.completed = fc.id
2625                     $userselect
2626                     AND fc.feedback = :feedbackid";
2627     $params['courseid']   = intval($courseid);
2628     $params['feedbackid'] = $feedbackid;
2630     if (!$sqlresult = $DB->get_records_sql($sql, $params)) {
2631         return false;
2632     }
2633     foreach ($sqlresult as $r) {
2634         return $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$r->id));
2635     }
2638 /**
2639  * get the completeds depending on the given groupid.
2640  *
2641  * @global object
2642  * @global object
2643  * @param object $feedback
2644  * @param int $groupid
2645  * @param int $courseid
2646  * @return mixed array of found completeds otherwise false
2647  */
2648 function feedback_get_completeds_group($feedback, $groupid = false, $courseid = false) {
2649     global $CFG, $DB;
2651     if (intval($groupid) > 0) {
2652         $query = "SELECT fbc.*
2653                     FROM {feedback_completed} fbc, {groups_members} gm
2654                    WHERE fbc.feedback = ?
2655                          AND gm.groupid = ?
2656                          AND fbc.userid = gm.userid";
2657         if ($values = $DB->get_records_sql($query, array($feedback->id, $groupid))) {
2658             return $values;
2659         } else {
2660             return false;
2661         }
2662     } else {
2663         if ($courseid) {
2664             $query = "SELECT DISTINCT fbc.*
2665                         FROM {feedback_completed} fbc, {feedback_value} fbv
2666                         WHERE fbc.id = fbv.completed
2667                             AND fbc.feedback = ?
2668                             AND fbv.course_id = ?
2669                         ORDER BY random_response";
2670             if ($values = $DB->get_records_sql($query, array($feedback->id, $courseid))) {
2671                 return $values;
2672             } else {
2673                 return false;
2674             }
2675         } else {
2676             if ($values = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
2677                 return $values;
2678             } else {
2679                 return false;
2680             }
2681         }
2682     }
2685 /**
2686  * get the count of completeds depending on the given groupid.
2687  *
2688  * @global object
2689  * @global object
2690  * @param object $feedback
2691  * @param int $groupid
2692  * @param int $courseid
2693  * @return mixed count of completeds or false
2694  */
2695 function feedback_get_completeds_group_count($feedback, $groupid = false, $courseid = false) {
2696     global $CFG, $DB;
2698     if ($courseid > 0 AND !$groupid <= 0) {
2699         $sql = "SELECT id, COUNT(item) AS ci
2700                   FROM {feedback_value}
2701                  WHERE course_id  = ?
2702               GROUP BY item ORDER BY ci DESC";
2703         if ($foundrecs = $DB->get_records_sql($sql, array($courseid))) {
2704             $foundrecs = array_values($foundrecs);
2705             return $foundrecs[0]->ci;
2706         }
2707         return false;
2708     }
2709     if ($values = feedback_get_completeds_group($feedback, $groupid)) {
2710         return count($values);
2711     } else {
2712         return false;
2713     }
2716 /**
2717  * deletes all completed-recordsets from a feedback.
2718  * all related data such as values also will be deleted
2719  *
2720  * @param stdClass|int $feedback
2721  * @param stdClass|cm_info $cm
2722  * @param stdClass $course
2723  * @return void
2724  */
2725 function feedback_delete_all_completeds($feedback, $cm = null, $course = null) {
2726     global $DB;
2728     if (is_int($feedback)) {
2729         $feedback = $DB->get_record('feedback', array('id' => $feedback));
2730     }
2732     if (!$completeds = $DB->get_records('feedback_completed', array('feedback' => $feedback->id))) {
2733         return;
2734     }
2736     if (!$course && !($course = $DB->get_record('course', array('id' => $feedback->course)))) {
2737         return false;
2738     }
2740     if (!$cm && !($cm = get_coursemodule_from_instance('feedback', $feedback->id))) {
2741         return false;
2742     }
2744     foreach ($completeds as $completed) {
2745         feedback_delete_completed($completed, $feedback, $cm, $course);
2746     }
2749 /**
2750  * deletes a completed given by completedid.
2751  * all related data such values or tracking data also will be deleted
2752  *
2753  * @param int|stdClass $completed
2754  * @param stdClass $feedback
2755  * @param stdClass|cm_info $cm
2756  * @param stdClass $course
2757  * @return boolean
2758  */
2759 function feedback_delete_completed($completed, $feedback = null, $cm = null, $course = null) {
2760     global $DB, $CFG;
2761     require_once($CFG->libdir.'/completionlib.php');
2763     if (!isset($completed->id)) {
2764         if (!$completed = $DB->get_record('feedback_completed', array('id' => $completed))) {
2765             return false;
2766         }
2767     }
2769     if (!$feedback && !($feedback = $DB->get_record('feedback', array('id' => $completed->feedback)))) {
2770         return false;
2771     }
2773     if (!$course && !($course = $DB->get_record('course', array('id' => $feedback->course)))) {
2774         return false;
2775     }
2777     if (!$cm && !($cm = get_coursemodule_from_instance('feedback', $feedback->id))) {
2778         return false;
2779     }
2781     //first we delete all related values
2782     $DB->delete_records('feedback_value', array('completed' => $completed->id));
2784     // Delete the completed record.
2785     $return = $DB->delete_records('feedback_completed', array('id' => $completed->id));
2787     // Update completion state
2788     $completion = new completion_info($course);
2789     if ($completion->is_enabled($cm) && $cm->completion == COMPLETION_TRACKING_AUTOMATIC && $feedback->completionsubmit) {
2790         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
2791     }
2792     // Trigger event for the delete action we performed.
2793     $event = \mod_feedback\event\response_deleted::create_from_record($completed, $cm, $feedback);
2794     $event->trigger();
2796     return $return;
2799 ////////////////////////////////////////////////
2800 ////////////////////////////////////////////////
2801 ////////////////////////////////////////////////
2802 //functions to handle sitecourse mapping
2803 ////////////////////////////////////////////////
2805 /**
2806  * checks if the course and the feedback is in the table feedback_sitecourse_map.
2807  *
2808  * @deprecated since 3.1
2809  * @param int $feedbackid
2810  * @param int $courseid
2811  * @return int the count of records
2812  */
2813 function feedback_is_course_in_sitecourse_map($feedbackid, $courseid) {
2814     debugging('Function feedback_is_course_in_sitecourse_map() is deprecated because it was not used.',
2815             DEBUG_DEVELOPER);
2816     global $DB;
2817     $params = array('feedbackid'=>$feedbackid, 'courseid'=>$courseid);
2818     return $DB->count_records('feedback_sitecourse_map', $params);
2821 /**
2822  * checks if the feedback is in the table feedback_sitecourse_map.
2823  *
2824  * @deprecated since 3.1
2825  * @param int $feedbackid
2826  * @return boolean
2827  */
2828 function feedback_is_feedback_in_sitecourse_map($feedbackid) {
2829     debugging('Function feedback_is_feedback_in_sitecourse_map() is deprecated because it was not used.',
2830             DEBUG_DEVELOPER);
2831     global $DB;
2832     return $DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$feedbackid));
2835 /**
2836  * gets the feedbacks from table feedback_sitecourse_map.
2837  * this is used to show the global feedbacks on the feedback block
2838  * all feedbacks with the following criteria will be selected:<br />
2839  *
2840  * 1) all feedbacks which id are listed together with the courseid in sitecoursemap and<br />
2841  * 2) all feedbacks which not are listed in sitecoursemap
2842  *
2843  * @global object
2844  * @param int $courseid
2845  * @return array the feedback-records
2846  */
2847 function feedback_get_feedbacks_from_sitecourse_map($courseid) {
2848     global $DB;
2850     //first get all feedbacks listed in sitecourse_map with named courseid
2851     $sql = "SELECT f.id AS id,
2852                    cm.id AS cmid,
2853                    f.name AS name,
2854                    f.timeopen AS timeopen,
2855                    f.timeclose AS timeclose
2856             FROM {feedback} f, {course_modules} cm, {feedback_sitecourse_map} sm, {modules} m
2857             WHERE f.id = cm.instance
2858                    AND f.course = '".SITEID."'
2859                    AND m.id = cm.module
2860                    AND m.name = 'feedback'
2861                    AND sm.courseid = ?
2862                    AND sm.feedbackid = f.id";
2864     if (!$feedbacks1 = $DB->get_records_sql($sql, array($courseid))) {
2865         $feedbacks1 = array();
2866     }
2868     //second get all feedbacks not listed in sitecourse_map
2869     $feedbacks2 = array();
2870     $sql = "SELECT f.id AS id,
2871                    cm.id AS cmid,
2872                    f.name AS name,
2873                    f.timeopen AS timeopen,
2874                    f.timeclose AS timeclose
2875             FROM {feedback} f, {course_modules} cm, {modules} m
2876             WHERE f.id = cm.instance
2877                    AND f.course = '".SITEID."'
2878                    AND m.id = cm.module
2879                    AND m.name = 'feedback'";
2880     if (!$allfeedbacks = $DB->get_records_sql($sql)) {
2881         $allfeedbacks = array();
2882     }
2883     foreach ($allfeedbacks as $a) {
2884         if (!$DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$a->id))) {
2885             $feedbacks2[] = $a;
2886         }
2887     }
2889     $feedbacks = array_merge($feedbacks1, $feedbacks2);
2890     $modinfo = get_fast_modinfo(SITEID);
2891     return array_filter($feedbacks, function($f) use ($modinfo) {
2892         return ($cm = $modinfo->get_cm($f->cmid)) && $cm->uservisible;
2893     });
2897 /**
2898  * Gets the courses from table feedback_sitecourse_map
2899  *
2900  * @param int $feedbackid
2901  * @return array the course-records
2902  */
2903 function feedback_get_courses_from_sitecourse_map($feedbackid) {
2904     global $DB;
2906     $sql = "SELECT c.id, c.fullname, c.shortname
2907               FROM {feedback_sitecourse_map} f, {course} c
2908              WHERE c.id = f.courseid
2909                    AND f.feedbackid = ?
2910           ORDER BY c.fullname";
2912     return $DB->get_records_sql($sql, array($feedbackid));
2916 /**
2917  * Updates the course mapping for the feedback
2918  *
2919  * @param stdClass $feedback
2920  * @param array $courses array of course ids
2921  */
2922 function feedback_update_sitecourse_map($feedback, $courses) {
2923     global $DB;
2924     if (empty($courses)) {
2925         $courses = array();
2926     }
2927     $currentmapping = $DB->get_fieldset_select('feedback_sitecourse_map', 'courseid', 'feedbackid=?', array($feedback->id));
2928     foreach (array_diff($courses, $currentmapping) as $courseid) {
2929         $DB->insert_record('feedback_sitecourse_map', array('feedbackid' => $feedback->id, 'courseid' => $courseid));
2930     }
2931     foreach (array_diff($currentmapping, $courses) as $courseid) {
2932         $DB->delete_records('feedback_sitecourse_map', array('feedbackid' => $feedback->id, 'courseid' => $courseid));
2933     }
2934     // TODO MDL-53574 add events.
2937 /**
2938  * removes non existing courses or feedbacks from sitecourse_map.
2939  * it shouldn't be called all too often
2940  * a good place for it could be the mapcourse.php or unmapcourse.php
2941  *
2942  * @deprecated since 3.1
2943  * @global object
2944  * @return void
2945  */
2946 function feedback_clean_up_sitecourse_map() {
2947     global $DB;
2948     debugging('Function feedback_clean_up_sitecourse_map() is deprecated because it was not used.',
2949             DEBUG_DEVELOPER);
2951     $maps = $DB->get_records('feedback_sitecourse_map');
2952     foreach ($maps as $map) {
2953         if (!$DB->get_record('course', array('id'=>$map->courseid))) {
2954             $params = array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid);
2955             $DB->delete_records('feedback_sitecourse_map', $params);
2956             continue;
2957         }
2958         if (!$DB->get_record('feedback', array('id'=>$map->feedbackid))) {
2959             $params = array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid);
2960             $DB->delete_records('feedback_sitecourse_map', $params);
2961             continue;
2962         }
2964     }
2967 ////////////////////////////////////////////////
2968 ////////////////////////////////////////////////
2969 ////////////////////////////////////////////////
2970 //not relatable functions
2971 ////////////////////////////////////////////////
2973 /**
2974  * prints the option items of a selection-input item (dropdownlist).
2975  * @deprecated since 3.1
2976  * @param int $startval the first value of the list
2977  * @param int $endval the last value of the list
2978  * @param int $selectval which item should be selected
2979  * @param int $interval the stepsize from the first to the last value
2980  * @return void
2981  */
2982 function feedback_print_numeric_option_list($startval, $endval, $selectval = '', $interval = 1) {
2983     debugging('Function feedback_print_numeric_option_list() is deprecated because it was not used.',
2984             DEBUG_DEVELOPER);
2985     for ($i = $startval; $i <= $endval; $i += $interval) {
2986         if ($selectval == ($i)) {
2987             $selected = 'selected="selected"';
2988         } else {
2989             $selected = '';
2990         }
2991         echo '<option '.$selected.'>'.$i.'</option>';
2992     }
2995 /**
2996  * sends an email to the teachers of the course where the given feedback is placed.
2997  *
2998  * @global object
2999  * @global object
3000  * @uses FEEDBACK_ANONYMOUS_NO
3001  * @uses FORMAT_PLAIN
3002  * @param object $cm the coursemodule-record
3003  * @param object $feedback
3004  * @param object $course
3005  * @param stdClass|int $user
3006  * @param stdClass $completed record from feedback_completed if known
3007  * @return void
3008  */
3009 function feedback_send_email($cm, $feedback, $course, $user, $completed = null) {
3010     global $CFG, $DB;
3012     if ($feedback->email_notification == 0) {  // No need to do anything
3013         return;
3014     }
3016     if (is_int($user)) {
3017         $user = $DB->get_record('user', array('id' => $user));
3018     }
3020     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
3021         $groupmode =  $cm->groupmode;
3022     } else {
3023         $groupmode = $course->groupmode;
3024     }
3026     if ($groupmode == SEPARATEGROUPS) {
3027         $groups = $DB->get_records_sql_menu("SELECT g.name, g.id
3028                                                FROM {groups} g, {groups_members} m
3029                                               WHERE g.courseid = ?
3030                                                     AND g.id = m.groupid
3031                                                     AND m.userid = ?
3032                                            ORDER BY name ASC", array($course->id, $user->id));
3033         $groups = array_values($groups);
3035         $teachers = feedback_get_receivemail_users($cm->id, $groups);
3036     } else {
3037         $teachers = feedback_get_receivemail_users($cm->id);
3038     }
3040     if ($teachers) {
3042         $strfeedbacks = get_string('modulenameplural', 'feedback');
3043         $strfeedback  = get_string('modulename', 'feedback');
3045         if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
3046             $printusername = fullname($user);
3047         } else {
3048             $printusername = get_string('anonymous_user', 'feedback');
3049         }
3051         foreach ($teachers as $teacher) {
3052             $info = new stdClass();
3053             $info->username = $printusername;
3054             $info->feedback = format_string($feedback->name, true);
3055             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries.php?'.
3056                             'id='.$cm->id.'&'.
3057                             'userid=' . $user->id;
3058             if ($completed) {
3059                 $info->url .= '&showcompleted=' . $completed->id;
3060                 if ($feedback->course == SITEID) {
3061                     // Course where feedback was completed (for site feedbacks only).
3062                     $info->url .= '&courseid=' . $completed->courseid;
3063                 }
3064             }
3066             $a = array('username' => $info->username, 'feedbackname' => $feedback->name);
3068             $postsubject = get_string('feedbackcompleted', 'feedback', $a);
3069             $posttext = feedback_send_email_text($info, $course);
3071             if ($teacher->mailformat == 1) {
3072                 $posthtml = feedback_send_email_html($info, $course, $cm);
3073             } else {
3074                 $posthtml = '';
3075             }
3077             if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
3078                 $eventdata = new \core\message\message();
3079                 $eventdata->courseid         = $course->id;
3080                 $eventdata->name             = 'submission';
3081                 $eventdata->component        = 'mod_feedback';
3082                 $eventdata->userfrom         = $user;
3083                 $eventdata->userto           = $teacher;
3084                 $eventdata->subject          = $postsubject;
3085                 $eventdata->fullmessage      = $posttext;
3086                 $eventdata->fullmessageformat = FORMAT_PLAIN;
3087                 $eventdata->fullmessagehtml  = $posthtml;
3088                 $eventdata->smallmessage     = '';
3089                 $eventdata->courseid         = $course->id;
3090                 $eventdata->contexturl       = $info->url;
3091                 $eventdata->contexturlname   = $info->feedback;
3092                 message_send($eventdata);
3093             } else {
3094                 $eventdata = new \core\message\message();
3095                 $eventdata->courseid         = $course->id;
3096                 $eventdata->name             = 'submission';
3097                 $eventdata->component        = 'mod_feedback';
3098                 $eventdata->userfrom         = $teacher;
3099                 $eventdata->userto           = $teacher;
3100                 $eventdata->subject          = $postsubject;
3101                 $eventdata->fullmessage      = $posttext;
3102                 $eventdata->fullmessageformat = FORMAT_PLAIN;
3103                 $eventdata->fullmessagehtml  = $posthtml;
3104                 $eventdata->smallmessage     = '';
3105                 $eventdata->courseid         = $course->id;
3106                 $eventdata->contexturl       = $info->url;
3107                 $eventdata->contexturlname   = $info->feedback;
3108                 message_send($eventdata);
3109             }
3110         }
3111     }
3114 /**
3115  * sends an email to the teachers of the course where the given feedback is placed.
3116  *
3117  * @global object
3118  * @uses FORMAT_PLAIN
3119  * @param object $cm the coursemodule-record
3120  * @param object $feedback
3121  * @param object $course
3122  * @return void
3123  */
3124 function feedback_send_email_anonym($cm, $feedback, $course) {
3125     global $CFG;
3127     if ($feedback->email_notification == 0) { // No need to do anything
3128         return;
3129     }
3131     $teachers = feedback_get_receivemail_users($cm->id);
3133     if ($teachers) {
3135         $strfeedbacks = get_string('modulenameplural', 'feedback');
3136         $strfeedback  = get_string('modulename', 'feedback');
3137         $printusername = get_string('anonymous_user', 'feedback');
3139         foreach ($teachers as $teacher) {
3140             $info = new stdClass();
3141             $info->username = $printusername;
3142             $info->feedback = format_string($feedback->name, true);
3143             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries.php?id=' . $cm->id;
3145             $a = array('username' => $info->username, 'feedbackname' => $feedback->name);
3147             $postsubject = get_string('feedbackcompleted', 'feedback', $a);
3148             $posttext = feedback_send_email_text($info, $course);
3150             if ($teacher->mailformat == 1) {
3151                 $posthtml = feedback_send_email_html($info, $course, $cm);
3152             } else {
3153                 $posthtml = '';
3154             }
3156             $eventdata = new \core\message\message();
3157             $eventdata->courseid         = $course->id;
3158             $eventdata->name             = 'submission';
3159             $eventdata->component        = 'mod_feedback';
3160             $eventdata->userfrom         = $teacher;
3161             $eventdata->userto           = $teacher;
3162             $eventdata->subject          = $postsubject;
3163             $eventdata->fullmessage      = $posttext;
3164             $eventdata->fullmessageformat = FORMAT_PLAIN;
3165             $eventdata->fullmessagehtml  = $posthtml;
3166             $eventdata->smallmessage     = '';
3167             $eventdata->courseid         = $course->id;
3168             $eventdata->contexturl       = $info->url;
3169             $eventdata->contexturlname   = $info->feedback;
3170             message_send($eventdata);
3171         }
3172     }
3175 /**
3176  * send the text-part of the email
3177  *
3178  * @param object $info includes some infos about the feedback you want to send
3179  * @param object $course
3180  * @return string the text you want to post
3181  */
3182 function feedback_send_email_text($info, $course) {
3183     $coursecontext = context_course::instance($course->id);
3184     $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
3185     $posttext  = $courseshortname.' -> '.get_string('modulenameplural', 'feedback').' -> '.
3186                     $info->feedback."\n";
3187     $posttext .= '---------------------------------------------------------------------'."\n";
3188     $posttext .= get_string("emailteachermail", "feedback", $info)."\n";
3189     $posttext .= '---------------------------------------------------------------------'."\n";
3190     return $posttext;
3194 /**
3195  * send the html-part of the email
3196  *
3197  * @global object
3198  * @param object $info includes some infos about the feedback you want to send
3199  * @param object $course
3200  * @return string the text you want to post
3201  */
3202 function feedback_send_email_html($info, $course, $cm) {
3203     global $CFG;
3204     $coursecontext = context_course::instance($course->id);
3205     $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
3206     $course_url = $CFG->wwwroot.'/course/view.php?id='.$course->id;
3207     $feedback_all_url = $CFG->wwwroot.'/mod/feedback/index.php?id='.$course->id;
3208     $feedback_url = $CFG->wwwroot.'/mod/feedback/view.php?id='.$cm->id;
3210     $posthtml = '<p><font face="sans-serif">'.
3211             '<a href="'.$course_url.'">'.$courseshortname.'</a> ->'.
3212             '<a href="'.$feedback_all_url.'">'.get_string('modulenameplural', 'feedback').'</a> ->'.
3213             '<a href="'.$feedback_url.'">'.$info->feedback.'</a></font></p>';
3214     $posthtml .= '<hr /><font face="sans-serif">';
3215     $posthtml .= '<p>'.get_string('emailteachermailhtml', 'feedback', $info).'</p>';
3216     $posthtml .= '</font><hr />';
3217     return $posthtml;
3220 /**
3221  * @param string $url
3222  * @return string
3223  */
3224 function feedback_encode_target_url($url) {
3225     if (strpos($url, '?')) {
3226         list($part1, $part2) = explode('?', $url, 2); //maximal 2 parts
3227         return $part1 . '?' . htmlentities($part2);
3228     } else {
3229         return $url;
3230     }
3233 /**
3234  * Adds module specific settings to the settings block
3235  *
3236  * @param settings_navigation $settings The settings navigation object
3237  * @param navigation_node $feedbacknode The node to add module settings to
3238  */
3239 function feedback_extend_settings_navigation(settings_navigation $settings,
3240                                              navigation_node $feedbacknode) {
3242     global $PAGE;
3244     if (!$context = context_module::instance($PAGE->cm->id, IGNORE_MISSING)) {
3245         print_error('badcontext');
3246     }
3248     if (has_capability('mod/feedback:edititems', $context)) {
3249         $questionnode = $feedbacknode->add(get_string('questions', 'feedback'));
3251         $questionnode->add(get_string('edit_items', 'feedback'),
3252                     new moodle_url('/mod/feedback/edit.php',
3253                                     array('id' => $PAGE->cm->id,
3254                                           'do_show' => 'edit')));
3256         $questionnode->add(get_string('export_questions', 'feedback'),
3257                     new moodle_url('/mod/feedback/export.php',
3258                                     array('id' => $PAGE->cm->id,
3259                                           'action' => 'exportfile')));
3261         $questionnode->add(get_string('import_questions', 'feedback'),
3262                     new moodle_url('/mod/feedback/import.php',
3263                                     array('id' => $PAGE->cm->id)));
3265         $questionnode->add(get_string('templates', 'feedback'),
3266                     new moodle_url('/mod/feedback/edit.php',
3267                                     array('id' => $PAGE->cm->id,
3268                                           'do_show' => 'templates')));
3269     }
3271     if (has_capability('mod/feedback:mapcourse', $context) && $PAGE->course->id == SITEID) {
3272         $feedbacknode->add(get_string('mappedcourses', 'feedback'),
3273                     new moodle_url('/mod/feedback/mapcourse.php',
3274                                     array('id' => $PAGE->cm->id)));
3275     }
3277     if (has_capability('mod/feedback:viewreports', $context)) {
3278         $feedback = $PAGE->activityrecord;
3279         if ($feedback->course == SITEID) {
3280             $feedbacknode->add(get_string('analysis', 'feedback'),
3281                     new moodle_url('/mod/feedback/analysis_course.php',
3282                                     array('id' => $PAGE->cm->id)));
3283         } else {
3284             $feedbacknode->add(get_string('analysis', 'feedback'),
3285                     new moodle_url('/mod/feedback/analysis.php',
3286                                     array('id' => $PAGE->cm->id)));
3287         }
3289         $feedbacknode->add(get_string('show_entries', 'feedback'),
3290                     new moodle_url('/mod/feedback/show_entries.php',
3291                                     array('id' => $PAGE->cm->id)));
3293         if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO AND $feedback->course != SITEID) {
3294             $feedbacknode->add(get_string('show_nonrespondents', 'feedback'),
3295                         new moodle_url('/mod/feedback/show_nonrespondents.php',
3296                                         array('id' => $PAGE->cm->id)));
3297         }
3298     }
3301 function feedback_init_feedback_session() {
3302     //initialize the feedback-Session - not nice at all!!
3303     global $SESSION;
3304     if (!empty($SESSION)) {
3305         if (!isset($SESSION->feedback) OR !is_object($SESSION->feedback)) {
3306             $SESSION->feedback = new stdClass();
3307         }
3308     }
3311 /**
3312  * Return a list of page types
3313  * @param string $pagetype current page type
3314  * @param stdClass $parentcontext Block's parent context
3315  * @param stdClass $currentcontext Current context of block
3316  */
3317 function feedback_page_type_list($pagetype, $parentcontext, $currentcontext) {
3318     $module_pagetype = array('mod-feedback-*'=>get_string('page-mod-feedback-x', 'feedback'));
3319     return $module_pagetype;
3322 /**
3323  * Move save the items of the given $feedback in the order of $itemlist.
3324  * @param string $itemlist a comma separated list with item ids
3325  * @param stdClass $feedback
3326  * @return bool true if success
3327  */
3328 function feedback_ajax_saveitemorder($itemlist, $feedback) {
3329     global $DB;
3331     $result = true;
3332     $position = 0;
3333     foreach ($itemlist as $itemid) {
3334         $position++;
3335         $result = $result && $DB->set_field('feedback_item',
3336                                             'position',
3337                                             $position,
3338                                             array('id'=>$itemid, 'feedback'=>$feedback->id));
3339     }
3340     return $result;
3343 /**
3344  * Checks if current user is able to view feedback on this course.
3345  *
3346  * @param stdClass $feedback
3347  * @param context_module $context
3348  * @param int $courseid
3349  * @return bool
3350  */
3351 function feedback_can_view_analysis($feedback, $context, $courseid = false) {
3352     if (has_capability('mod/feedback:viewreports', $context)) {
3353         return true;
3354     }
3356     if (intval($feedback->publish_stats) != 1 ||
3357             !has_capability('mod/feedback:viewanalysepage', $context)) {
3358         return false;
3359     }
3361     if (!isloggedin() || isguestuser()) {
3362         // There is no tracking for the guests, assume that they can view analysis if condition above is satisfied.
3363         return $feedback->course == SITEID;
3364     }
3366     return feedback_is_already_submitted($feedback->id, $courseid);
3369 /**
3370  * Get icon mapping for font-awesome.
3371  */
3372 function mod_feedback_get_fontawesome_icon_map() {
3373     return [
3374         'mod_feedback:required' => 'fa-exclamation-circle',
3375         'mod_feedback:notrequired' => 'fa-question-circle-o',
3376     ];
3379 /**
3380  * Check if the module has any update that affects the current user since a given time.
3381  *
3382  * @param  cm_info $cm course module data
3383  * @param  int $from the time to check updates from
3384  * @param  array $filter if we need to check only specific updates
3385  * @return stdClass an object with the different type of areas indicating if they were updated or not
3386  * @since Moodle 3.3
3387  */
3388 function feedback_check_updates_since(cm_info $cm, $from, $filter = array()) {
3389     global $DB, $USER, $CFG;
3391     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
3393     // Check for new attempts.
3394     $updates->attemptsfinished = (object) array('updated' => false);
3395     $updates->attemptsunfinished = (object) array('updated' => false);
3396     $select = 'feedback = ? AND userid = ? AND timemodified > ?';
3397     $params = array($cm->instance, $USER->id, $from);
3399     $attemptsfinished = $DB->get_records_select('feedback_completed', $select, $params, '', 'id');
3400     if (!empty($attemptsfinished)) {
3401         $updates->attemptsfinished->updated = true;
3402         $updates->attemptsfinished->itemids = array_keys($attemptsfinished);
3403     }
3404     $attemptsunfinished = $DB->get_records_select('feedback_completedtmp', $select, $params, '', 'id');
3405     if (!empty($attemptsunfinished)) {
3406         $updates->attemptsunfinished->updated = true;
3407         $updates->attemptsunfinished->itemids = array_keys($attemptsunfinished);
3408     }
3410     // Now, teachers should see other students updates.
3411     if (has_capability('mod/feedback:viewreports', $cm->context)) {
3412         $select = 'feedback = ? AND timemodified > ?';
3413         $params = array($cm->instance, $from);
3415         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
3416             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
3417             if (empty($groupusers)) {
3418                 return $updates;
3419             }
3420             list($insql, $inparams) = $DB->get_in_or_equal($groupusers);
3421             $select .= ' AND userid ' . $insql;
3422             $params = array_merge($params, $inparams);
3423         }
3425         $updates->userattemptsfinished = (object) array('updated' => false);
3426         $attemptsfinished = $DB->get_records_select('feedback_completed', $select, $params, '', 'id');
3427         if (!empty($attemptsfinished)) {
3428             $updates->userattemptsfinished->updated = true;
3429             $updates->userattemptsfinished->itemids = array_keys($attemptsfinished);
3430         }
3432         $updates->userattemptsunfinished = (object) array('updated' => false);
3433         $attemptsunfinished = $DB->get_records_select('feedback_completedtmp', $select, $params, '', 'id');
3434         if (!empty($attemptsunfinished)) {
3435             $updates->userattemptsunfinished->updated = true;
3436             $updates->userattemptsunfinished->itemids = array_keys($attemptsunfinished);
3437         }
3438     }
3440     return $updates;
3443 /**
3444  * This function receives a calendar event and returns the action associated with it, or null if there is none.
3445  *
3446  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
3447  * is not displayed on the block.
3448  *
3449  * @param calendar_event $event
3450  * @param \core_calendar\action_factory $factory
3451  * @return \core_calendar\local\event\entities\action_interface|null
3452  */
3453 function mod_feedback_core_calendar_provide_event_action(calendar_event $event,
3454                                                          \core_calendar\action_factory $factory) {
3456     $cm = get_fast_modinfo($event->courseid)->instances['feedback'][$event->instance];
3457     $feedbackcompletion = new mod_feedback_completion(null, $cm, 0);
3459     if (!empty($cm->customdata['timeclose']) && $cm->customdata['timeclose'] < time()) {
3460         // Feedback is already closed, do not display it even if it was never submitted.
3461         return null;
3462     }
3464     if (!$feedbackcompletion->can_complete()) {
3465         // The user can't complete the feedback so there is no action for them.
3466         return null;
3467     }
3469     // The feedback is actionable if it does not have timeopen or timeopen is in the past.
3470     $actionable = $feedbackcompletion->is_open();
3472     if ($actionable && $feedbackcompletion->is_already_submitted()) {
3473         // There is no need to display anything if the user has already submitted the feedback.
3474         return null;
3475     }
3477     return $factory->create_instance(
3478         get_string('answerquestions', 'feedback'),
3479         new \moodle_url('/mod/feedback/view.php', ['id' => $cm->id]),
3480         1,
3481         $actionable
3482     );
3485 /**
3486  * Add a get_coursemodule_info function in case any feedback type wants to add 'extra' information
3487  * for the course (see resource).
3488  *
3489  * Given a course_module object, this function returns any "extra" information that may be needed
3490  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
3491  *
3492  * @param stdClass $coursemodule The coursemodule object (record).
3493  * @return cached_cm_info An object on information that the courses
3494  *                        will know about (most noticeably, an icon).
3495  */
3496 function feedback_get_coursemodule_info($coursemodule) {
3497     global $DB;
3499     $dbparams = ['id' => $coursemodule->instance];
3500     $fields = 'id, name, intro, introformat, completionsubmit, timeopen, timeclose, anonymous';
3501     if (!$feedback = $DB->get_record('feedback', $dbparams, $fields)) {
3502         return false;
3503     }
3505     $result = new cached_cm_info();
3506     $result->name = $feedback->name;
3508     if ($coursemodule->showdescription) {
3509         // Convert intro to html. Do not filter cached version, filters run at display time.
3510         $result->content = format_module_intro('feedback', $feedback, $coursemodule->id, false);
3511     }
3513     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
3514     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
3515         $result->customdata['customcompletionrules']['completionsubmit'] = $feedback->completionsubmit;
3516     }
3517     // Populate some other values that can be used in calendar or on dashboard.
3518     if ($feedback->timeopen) {
3519         $result->customdata['timeopen'] = $feedback->timeopen;
3520     }
3521     if ($feedback->timeclose) {
3522         $result->customdata['timeclose'] = $feedback->timeclose;
3523     }
3524     if ($feedback->anonymous) {
3525         $result->customdata['anonymous'] = $feedback->anonymous;
3526     }
3528     return $result;
3531 /**
3532  * Callback which returns human-readable strings describing the active completion custom rules for the module instance.
3533  *
3534  * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']
3535  * @return array $descriptions the array of descriptions for the custom rules.
3536  */
3537 function mod_feedback_get_completion_active_rule_descriptions($cm) {
3538     // Values will be present in cm_info, and we assume these are up to date.
3539     if (empty($cm->customdata['customcompletionrules'])
3540         || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) {
3541         return [];
3542     }
3544     $descriptions = [];
3545     foreach ($cm->customdata['customcompletionrules'] as $key => $val) {
3546         switch ($key) {
3547             case 'completionsubmit':
3548                 if (empty($val)) {
3549                     continue;
3550                 }
3551                 $descriptions[] = get_string('completionsubmit', 'feedback');
3552                 break;
3553             default:
3554                 break;
3555         }
3556     }
3557     return $descriptions;
3560 /**
3561  * This function calculates the minimum and maximum cutoff values for the timestart of
3562  * the given event.
3563  *
3564  * It will return an array with two values, the first being the minimum cutoff value and
3565  * the second being the maximum cutoff value. Either or both values can be null, which
3566  * indicates there is no minimum or maximum, respectively.
3567  *
3568  * If a cutoff is required then the function must return an array containing the cutoff
3569  * timestamp and error string to display to the user if the cutoff value is violated.
3570  *
3571  * A minimum and maximum cutoff return value will look like:
3572  * [
3573  *     [1505704373, 'The due date must be after the sbumission start date'],
3574  *     [1506741172, 'The due date must be before the cutoff date']
3575  * ]
3576  *
3577  * @param calendar_event $event The calendar event to get the time range for
3578  * @param stdClass $instance The module instance to get the range from
3579  * @return array
3580  */
3581 function mod_feedback_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $instance) {
3582     $mindate = null;
3583     $maxdate = null;
3585     if ($event->eventtype == FEEDBACK_EVENT_TYPE_OPEN) {
3586         // The start time of the open event can't be equal to or after the
3587         // close time of the choice activity.
3588         if (!empty($instance->timeclose)) {
3589             $maxdate = [
3590                 $instance->timeclose,
3591                 get_string('openafterclose', 'feedback')
3592             ];
3593         }
3594     } else if ($event->eventtype == FEEDBACK_EVENT_TYPE_CLOSE) {
3595         // The start time of the close event can't be equal to or earlier than the
3596         // open time of the choice activity.
3597         if (!empty($instance->timeopen)) {
3598             $mindate = [
3599                 $instance->timeopen,
3600                 get_string('closebeforeopen', 'feedback')
3601             ];
3602         }
3603     }
3605     return [$mindate, $maxdate];
3608 /**
3609  * This function will update the feedback module according to the
3610  * event that has been modified.
3611  *
3612  * It will set the timeopen or timeclose value of the feedback instance
3613  * according to the type of event provided.
3614  *
3615  * @throws \moodle_exception
3616  * @param \calendar_event $event
3617  * @param stdClass $feedback The module instance to get the range from
3618  */
3619 function mod_feedback_core_calendar_event_timestart_updated(\calendar_event $event, \stdClass $feedback) {
3620     global $CFG, $DB;
3622     if (empty($event->instance) || $event->modulename != 'feedback') {
3623         return;
3624     }
3626     if ($event->instance != $feedback->id) {
3627         return;
3628     }
3630     if (!in_array($event->eventtype, [FEEDBACK_EVENT_TYPE_OPEN, FEEDBACK_EVENT_TYPE_CLOSE])) {
3631         return;
3632     }
3634     $courseid = $event->courseid;
3635     $modulename = $event->modulename;
3636     $instanceid = $event->instance;
3637     $modified = false;
3639     $coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid];
3640     $context = context_module::instance($coursemodule->id);
3642     // The user does not have the capability to modify this activity.
3643     if (!has_capability('moodle/course:manageactivities', $context)) {
3644         return;
3645     }
3647     if ($event->eventtype == FEEDBACK_EVENT_TYPE_OPEN) {
3648         // If the event is for the feedback activity opening then we should
3649         // set the start time of the feedback activity to be the new start
3650         // time of the event.
3651         if ($feedback->timeopen != $event->timestart) {
3652             $feedback->timeopen = $event->timestart;
3653             $feedback->timemodified = time();
3654             $modified = true;
3655         }
3656     } else if ($event->eventtype == FEEDBACK_EVENT_TYPE_CLOSE) {
3657         // If the event is for the feedback activity closing then we should
3658         // set the end time of the feedback activity to be the new start
3659         // time of the event.
3660         if ($feedback->timeclose != $event->timestart) {
3661             $feedback->timeclose = $event->timestart;
3662             $modified = true;
3663         }
3664     }
3666     if ($modified) {
3667         $feedback->timemodified = time();
3668         $DB->update_record('feedback', $feedback);
3669         $event = \core\event\course_module_updated::create_from_cm($coursemodule, $context);
3670         $event->trigger();
3671     }