Merge branch 'MDL-55611-master' of git://github.com/danpoltawski/moodle
[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     $editoroptions = feedback_get_editor_options();
115     // process the custom wysiwyg editor in page_after_submit
116     if ($draftitemid = $feedback->page_after_submit_editor['itemid']) {
117         $feedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
118                                                     'mod_feedback', 'page_after_submit',
119                                                     0, $editoroptions,
120                                                     $feedback->page_after_submit_editor['text']);
122         $feedback->page_after_submitformat = $feedback->page_after_submit_editor['format'];
123     }
124     $DB->update_record('feedback', $feedback);
126     return $feedbackid;
129 /**
130  * this will update a given instance
131  *
132  * @global object
133  * @param object $feedback the object given by mod_feedback_mod_form
134  * @return boolean
135  */
136 function feedback_update_instance($feedback) {
137     global $DB;
139     $feedback->timemodified = time();
140     $feedback->id = $feedback->instance;
142     if (empty($feedback->site_after_submit)) {
143         $feedback->site_after_submit = '';
144     }
146     //save the feedback into the db
147     $DB->update_record("feedback", $feedback);
149     //create or update the new events
150     feedback_set_events($feedback);
152     $context = context_module::instance($feedback->coursemodule);
154     $editoroptions = feedback_get_editor_options();
156     // process the custom wysiwyg editor in page_after_submit
157     if ($draftitemid = $feedback->page_after_submit_editor['itemid']) {
158         $feedback->page_after_submit = file_save_draft_area_files($draftitemid, $context->id,
159                                                     'mod_feedback', 'page_after_submit',
160                                                     0, $editoroptions,
161                                                     $feedback->page_after_submit_editor['text']);
163         $feedback->page_after_submitformat = $feedback->page_after_submit_editor['format'];
164     }
165     $DB->update_record('feedback', $feedback);
167     return true;
170 /**
171  * Serves the files included in feedback items like label. Implements needed access control ;-)
172  *
173  * There are two situations in general where the files will be sent.
174  * 1) filearea = item, 2) filearea = template
175  *
176  * @package  mod_feedback
177  * @category files
178  * @param stdClass $course course object
179  * @param stdClass $cm course module object
180  * @param stdClass $context context object
181  * @param string $filearea file area
182  * @param array $args extra arguments
183  * @param bool $forcedownload whether or not force download
184  * @param array $options additional options affecting the file serving
185  * @return bool false if file not found, does not return if found - justsend the file
186  */
187 function feedback_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
188     global $CFG, $DB;
190     if ($filearea === 'item' or $filearea === 'template') {
191         $itemid = (int)array_shift($args);
192         //get the item what includes the file
193         if (!$item = $DB->get_record('feedback_item', array('id'=>$itemid))) {
194             return false;
195         }
196         $feedbackid = $item->feedback;
197         $templateid = $item->template;
198     }
200     if ($filearea === 'page_after_submit' or $filearea === 'item') {
201         if (! $feedback = $DB->get_record("feedback", array("id"=>$cm->instance))) {
202             return false;
203         }
205         $feedbackid = $feedback->id;
207         //if the filearea is "item" so we check the permissions like view/complete the feedback
208         $canload = false;
209         //first check whether the user has the complete capability
210         if (has_capability('mod/feedback:complete', $context)) {
211             $canload = true;
212         }
214         //now we check whether the user has the view capability
215         if (has_capability('mod/feedback:view', $context)) {
216             $canload = true;
217         }
219         //if the feedback is on frontpage and anonymous and the fullanonymous is allowed
220         //so the file can be loaded too.
221         if (isset($CFG->feedback_allowfullanonymous)
222                     AND $CFG->feedback_allowfullanonymous
223                     AND $course->id == SITEID
224                     AND $feedback->anonymous == FEEDBACK_ANONYMOUS_YES ) {
225             $canload = true;
226         }
228         if (!$canload) {
229             return false;
230         }
231     } else if ($filearea === 'template') { //now we check files in templates
232         if (!$template = $DB->get_record('feedback_template', array('id'=>$templateid))) {
233             return false;
234         }
236         //if the file is not public so the capability edititems has to be there
237         if (!$template->ispublic) {
238             if (!has_capability('mod/feedback:edititems', $context)) {
239                 return false;
240             }
241         } else { //on public templates, at least the user has to be logged in
242             if (!isloggedin()) {
243                 return false;
244             }
245         }
246     } else {
247         return false;
248     }
250     if ($context->contextlevel == CONTEXT_MODULE) {
251         if ($filearea !== 'item' and $filearea !== 'page_after_submit') {
252             return false;
253         }
254     }
256     if ($context->contextlevel == CONTEXT_COURSE || $context->contextlevel == CONTEXT_SYSTEM) {
257         if ($filearea !== 'template') {
258             return false;
259         }
260     }
262     $relativepath = implode('/', $args);
263     if ($filearea === 'page_after_submit') {
264         $fullpath = "/{$context->id}/mod_feedback/$filearea/$relativepath";
265     } else {
266         $fullpath = "/{$context->id}/mod_feedback/$filearea/{$item->id}/$relativepath";
267     }
269     $fs = get_file_storage();
271     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
272         return false;
273     }
275     // finally send the file
276     send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
278     return false;
281 /**
282  * this will delete a given instance.
283  * all referenced data also will be deleted
284  *
285  * @global object
286  * @param int $id the instanceid of feedback
287  * @return boolean
288  */
289 function feedback_delete_instance($id) {
290     global $DB;
292     //get all referenced items
293     $feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$id));
295     //deleting all referenced items and values
296     if (is_array($feedbackitems)) {
297         foreach ($feedbackitems as $feedbackitem) {
298             $DB->delete_records("feedback_value", array("item"=>$feedbackitem->id));
299             $DB->delete_records("feedback_valuetmp", array("item"=>$feedbackitem->id));
300         }
301         if ($delitems = $DB->get_records("feedback_item", array("feedback"=>$id))) {
302             foreach ($delitems as $delitem) {
303                 feedback_delete_item($delitem->id, false);
304             }
305         }
306     }
308     //deleting the completeds
309     $DB->delete_records("feedback_completed", array("feedback"=>$id));
311     //deleting the unfinished completeds
312     $DB->delete_records("feedback_completedtmp", array("feedback"=>$id));
314     //deleting old events
315     $DB->delete_records('event', array('modulename'=>'feedback', 'instance'=>$id));
316     return $DB->delete_records("feedback", array("id"=>$id));
319 /**
320  * Return a small object with summary information about what a
321  * user has done with a given particular instance of this module
322  * Used for user activity reports.
323  * $return->time = the time they did it
324  * $return->info = a short text description
325  *
326  * @param stdClass $course
327  * @param stdClass $user
328  * @param cm_info|stdClass $mod
329  * @param stdClass $feedback
330  * @return stdClass
331  */
332 function feedback_user_outline($course, $user, $mod, $feedback) {
333     global $DB;
334     $outline = (object)['info' => '', 'time' => 0];
335     if ($feedback->anonymous != FEEDBACK_ANONYMOUS_NO) {
336         // Do not disclose any user info if feedback is anonymous.
337         return $outline;
338     }
339     $params = array('userid' => $user->id, 'feedback' => $feedback->id,
340         'anonymous_response' => FEEDBACK_ANONYMOUS_NO);
341     $status = null;
342     $context = context_module::instance($mod->id);
343     if ($completed = $DB->get_record('feedback_completed', $params)) {
344         // User has completed feedback.
345         $outline->info = get_string('completed', 'feedback');
346         $outline->time = $completed->timemodified;
347     } else if ($completedtmp = $DB->get_record('feedback_completedtmp', $params)) {
348         // User has started but not completed feedback.
349         $outline->info = get_string('started', 'feedback');
350         $outline->time = $completedtmp->timemodified;
351     } else if (has_capability('mod/feedback:complete', $context, $user)) {
352         // User has not started feedback but has capability to do so.
353         $outline->info = get_string('not_started', 'feedback');
354     }
356     return $outline;
359 /**
360  * Returns all users who has completed a specified feedback since a given time
361  * many thanks to Manolescu Dorel, who contributed these two functions
362  *
363  * @global object
364  * @global object
365  * @global object
366  * @global object
367  * @uses CONTEXT_MODULE
368  * @param array $activities Passed by reference
369  * @param int $index Passed by reference
370  * @param int $timemodified Timestamp
371  * @param int $courseid
372  * @param int $cmid
373  * @param int $userid
374  * @param int $groupid
375  * @return void
376  */
377 function feedback_get_recent_mod_activity(&$activities, &$index,
378                                           $timemodified, $courseid,
379                                           $cmid, $userid="", $groupid="") {
381     global $CFG, $COURSE, $USER, $DB;
383     if ($COURSE->id == $courseid) {
384         $course = $COURSE;
385     } else {
386         $course = $DB->get_record('course', array('id'=>$courseid));
387     }
389     $modinfo = get_fast_modinfo($course);
391     $cm = $modinfo->cms[$cmid];
393     $sqlargs = array();
395     $userfields = user_picture::fields('u', null, 'useridagain');
396     $sql = " SELECT fk . * , fc . * , $userfields
397                 FROM {feedback_completed} fc
398                     JOIN {feedback} fk ON fk.id = fc.feedback
399                     JOIN {user} u ON u.id = fc.userid ";
401     if ($groupid) {
402         $sql .= " JOIN {groups_members} gm ON  gm.userid=u.id ";
403     }
405     $sql .= " WHERE fc.timemodified > ?
406                 AND fk.id = ?
407                 AND fc.anonymous_response = ?";
408     $sqlargs[] = $timemodified;
409     $sqlargs[] = $cm->instance;
410     $sqlargs[] = FEEDBACK_ANONYMOUS_NO;
412     if ($userid) {
413         $sql .= " AND u.id = ? ";
414         $sqlargs[] = $userid;
415     }
417     if ($groupid) {
418         $sql .= " AND gm.groupid = ? ";
419         $sqlargs[] = $groupid;
420     }
422     if (!$feedbackitems = $DB->get_records_sql($sql, $sqlargs)) {
423         return;
424     }
426     $cm_context = context_module::instance($cm->id);
428     if (!has_capability('mod/feedback:view', $cm_context)) {
429         return;
430     }
432     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
433     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
434     $groupmode       = groups_get_activity_groupmode($cm, $course);
436     $aname = format_string($cm->name, true);
437     foreach ($feedbackitems as $feedbackitem) {
438         if ($feedbackitem->userid != $USER->id) {
440             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
441                 $usersgroups = groups_get_all_groups($course->id,
442                                                      $feedbackitem->userid,
443                                                      $cm->groupingid);
444                 if (!is_array($usersgroups)) {
445                     continue;
446                 }
447                 $usersgroups = array_keys($usersgroups);
448                 $intersect = array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid));
449                 if (empty($intersect)) {
450                     continue;
451                 }
452             }
453         }
455         $tmpactivity = new stdClass();
457         $tmpactivity->type      = 'feedback';
458         $tmpactivity->cmid      = $cm->id;
459         $tmpactivity->name      = $aname;
460         $tmpactivity->sectionnum= $cm->sectionnum;
461         $tmpactivity->timestamp = $feedbackitem->timemodified;
463         $tmpactivity->content = new stdClass();
464         $tmpactivity->content->feedbackid = $feedbackitem->id;
465         $tmpactivity->content->feedbackuserid = $feedbackitem->userid;
467         $tmpactivity->user = user_picture::unalias($feedbackitem, null, 'useridagain');
468         $tmpactivity->user->fullname = fullname($feedbackitem, $viewfullnames);
470         $activities[$index++] = $tmpactivity;
471     }
473     return;
476 /**
477  * Prints all users who has completed a specified feedback since a given time
478  * many thanks to Manolescu Dorel, who contributed these two functions
479  *
480  * @global object
481  * @param object $activity
482  * @param int $courseid
483  * @param string $detail
484  * @param array $modnames
485  * @return void Output is echo'd
486  */
487 function feedback_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
488     global $CFG, $OUTPUT;
490     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
492     echo "<tr><td class=\"userpicture\" valign=\"top\">";
493     echo $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid));
494     echo "</td><td>";
496     if ($detail) {
497         $modname = $modnames[$activity->type];
498         echo '<div class="title">';
499         echo $OUTPUT->image_icon('icon', $modname, $activity->type);
500         echo "<a href=\"$CFG->wwwroot/mod/feedback/view.php?id={$activity->cmid}\">{$activity->name}</a>";
501         echo '</div>';
502     }
504     echo '<div class="title">';
505     echo '</div>';
507     echo '<div class="user">';
508     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
509          ."{$activity->user->fullname}</a> - ".userdate($activity->timestamp);
510     echo '</div>';
512     echo "</td></tr></table>";
514     return;
517 /**
518  * Obtains the automatic completion state for this feedback based on the condition
519  * in feedback settings.
520  *
521  * @param object $course Course
522  * @param object $cm Course-module
523  * @param int $userid User ID
524  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
525  * @return bool True if completed, false if not, $type if conditions not set.
526  */
527 function feedback_get_completion_state($course, $cm, $userid, $type) {
528     global $CFG, $DB;
530     // Get feedback details
531     $feedback = $DB->get_record('feedback', array('id'=>$cm->instance), '*', MUST_EXIST);
533     // If completion option is enabled, evaluate it and return true/false
534     if ($feedback->completionsubmit) {
535         $params = array('userid'=>$userid, 'feedback'=>$feedback->id);
536         return $DB->record_exists('feedback_completed', $params);
537     } else {
538         // Completion option is not enabled so just return $type
539         return $type;
540     }
543 /**
544  * Print a detailed representation of what a  user has done with
545  * a given particular instance of this module, for user activity reports.
546  *
547  * @param stdClass $course
548  * @param stdClass $user
549  * @param cm_info|stdClass $mod
550  * @param stdClass $feedback
551  */
552 function feedback_user_complete($course, $user, $mod, $feedback) {
553     global $DB;
554     if ($feedback->anonymous != FEEDBACK_ANONYMOUS_NO) {
555         // Do not disclose any user info if feedback is anonymous.
556         return;
557     }
558     $params = array('userid' => $user->id, 'feedback' => $feedback->id,
559         'anonymous_response' => FEEDBACK_ANONYMOUS_NO);
560     $url = $status = null;
561     $context = context_module::instance($mod->id);
562     if ($completed = $DB->get_record('feedback_completed', $params)) {
563         // User has completed feedback.
564         if (has_capability('mod/feedback:viewreports', $context)) {
565             $url = new moodle_url('/mod/feedback/show_entries.php',
566                 ['id' => $mod->id, 'userid' => $user->id,
567                     'showcompleted' => $completed->id]);
568         }
569         $status = get_string('completedon', 'feedback', userdate($completed->timemodified));
570     } else if ($completedtmp = $DB->get_record('feedback_completedtmp', $params)) {
571         // User has started but not completed feedback.
572         $status = get_string('startedon', 'feedback', userdate($completedtmp->timemodified));
573     } else if (has_capability('mod/feedback:complete', $context, $user)) {
574         // User has not started feedback but has capability to do so.
575         $status = get_string('not_started', 'feedback');
576     }
578     if ($url && $status) {
579         echo html_writer::link($url, $status);
580     } else if ($status) {
581         echo html_writer::div($status);
582     }
585 /**
586  * @return bool true
587  */
588 function feedback_cron () {
589     return true;
592 /**
593  * @return bool false
594  */
595 function feedback_scale_used ($feedbackid, $scaleid) {
596     return false;
599 /**
600  * Checks if scale is being used by any instance of feedback
601  *
602  * This is used to find out if scale used anywhere
603  * @param $scaleid int
604  * @return boolean True if the scale is used by any assignment
605  */
606 function feedback_scale_used_anywhere($scaleid) {
607     return false;
610 /**
611  * List the actions that correspond to a view of this module.
612  * This is used by the participation report.
613  *
614  * Note: This is not used by new logging system. Event with
615  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
616  *       be considered as view action.
617  *
618  * @return array
619  */
620 function feedback_get_view_actions() {
621     return array('view', 'view all');
624 /**
625  * List the actions that correspond to a post of this module.
626  * This is used by the participation report.
627  *
628  * Note: This is not used by new logging system. Event with
629  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
630  *       will be considered as post action.
631  *
632  * @return array
633  */
634 function feedback_get_post_actions() {
635     return array('submit');
638 /**
639  * This function is used by the reset_course_userdata function in moodlelib.
640  * This function will remove all responses from the specified feedback
641  * and clean up any related data.
642  *
643  * @global object
644  * @global object
645  * @uses FEEDBACK_RESETFORM_RESET
646  * @uses FEEDBACK_RESETFORM_DROP
647  * @param object $data the data submitted from the reset course.
648  * @return array status array
649  */
650 function feedback_reset_userdata($data) {
651     global $CFG, $DB;
653     $resetfeedbacks = array();
654     $dropfeedbacks = array();
655     $status = array();
656     $componentstr = get_string('modulenameplural', 'feedback');
658     //get the relevant entries from $data
659     foreach ($data as $key => $value) {
660         switch(true) {
661             case substr($key, 0, strlen(FEEDBACK_RESETFORM_RESET)) == FEEDBACK_RESETFORM_RESET:
662                 if ($value == 1) {
663                     $templist = explode('_', $key);
664                     if (isset($templist[3])) {
665                         $resetfeedbacks[] = intval($templist[3]);
666                     }
667                 }
668             break;
669             case substr($key, 0, strlen(FEEDBACK_RESETFORM_DROP)) == FEEDBACK_RESETFORM_DROP:
670                 if ($value == 1) {
671                     $templist = explode('_', $key);
672                     if (isset($templist[3])) {
673                         $dropfeedbacks[] = intval($templist[3]);
674                     }
675                 }
676             break;
677         }
678     }
680     //reset the selected feedbacks
681     foreach ($resetfeedbacks as $id) {
682         $feedback = $DB->get_record('feedback', array('id'=>$id));
683         feedback_delete_all_completeds($feedback);
684         $status[] = array('component'=>$componentstr.':'.$feedback->name,
685                         'item'=>get_string('resetting_data', 'feedback'),
686                         'error'=>false);
687     }
689     // Updating dates - shift may be negative too.
690     if ($data->timeshift) {
691         $shifterror = !shift_course_mod_dates('feedback', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid);
692         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => $shifterror);
693     }
695     return $status;
698 /**
699  * Called by course/reset.php
700  *
701  * @global object
702  * @uses FEEDBACK_RESETFORM_RESET
703  * @param object $mform form passed by reference
704  */
705 function feedback_reset_course_form_definition(&$mform) {
706     global $COURSE, $DB;
708     $mform->addElement('header', 'feedbackheader', get_string('modulenameplural', 'feedback'));
710     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$COURSE->id), 'name')) {
711         return;
712     }
714     $mform->addElement('static', 'hint', get_string('resetting_data', 'feedback'));
715     foreach ($feedbacks as $feedback) {
716         $mform->addElement('checkbox', FEEDBACK_RESETFORM_RESET.$feedback->id, $feedback->name);
717     }
720 /**
721  * Course reset form defaults.
722  *
723  * @global object
724  * @uses FEEDBACK_RESETFORM_RESET
725  * @param object $course
726  */
727 function feedback_reset_course_form_defaults($course) {
728     global $DB;
730     $return = array();
731     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')) {
732         return;
733     }
734     foreach ($feedbacks as $feedback) {
735         $return[FEEDBACK_RESETFORM_RESET.$feedback->id] = true;
736     }
737     return $return;
740 /**
741  * Called by course/reset.php and shows the formdata by coursereset.
742  * it prints checkboxes for each feedback available at the given course
743  * there are two checkboxes:
744  * 1) delete userdata and keep the feedback
745  * 2) delete userdata and drop the feedback
746  *
747  * @global object
748  * @uses FEEDBACK_RESETFORM_RESET
749  * @uses FEEDBACK_RESETFORM_DROP
750  * @param object $course
751  * @return void
752  */
753 function feedback_reset_course_form($course) {
754     global $DB, $OUTPUT;
756     echo get_string('resetting_feedbacks', 'feedback'); echo ':<br />';
757     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')) {
758         return;
759     }
761     foreach ($feedbacks as $feedback) {
762         echo '<p>';
763         echo get_string('name', 'feedback').': '.$feedback->name.'<br />';
764         echo html_writer::checkbox(FEEDBACK_RESETFORM_RESET.$feedback->id,
765                                 1, true,
766                                 get_string('resetting_data', 'feedback'));
767         echo '<br />';
768         echo html_writer::checkbox(FEEDBACK_RESETFORM_DROP.$feedback->id,
769                                 1, false,
770                                 get_string('drop_feedback', 'feedback'));
771         echo '</p>';
772     }
775 /**
776  * This gets an array with default options for the editor
777  *
778  * @return array the options
779  */
780 function feedback_get_editor_options() {
781     return array('maxfiles' => EDITOR_UNLIMITED_FILES,
782                 'trusttext'=>true);
785 /**
786  * This creates new events given as timeopen and closeopen by $feedback.
787  *
788  * @global object
789  * @param object $feedback
790  * @return void
791  */
792 function feedback_set_events($feedback) {
793     global $DB, $CFG;
795     // Include calendar/lib.php.
796     require_once($CFG->dirroot.'/calendar/lib.php');
798     // Get CMID if not sent as part of $feedback.
799     if (!isset($feedback->coursemodule)) {
800         $cm = get_coursemodule_from_instance('feedback', $feedback->id, $feedback->course);
801         $feedback->coursemodule = $cm->id;
802     }
804     // Feedback start calendar events.
805     $eventid = $DB->get_field('event', 'id',
806             array('modulename' => 'feedback', 'instance' => $feedback->id, 'eventtype' => FEEDBACK_EVENT_TYPE_OPEN));
808     if (isset($feedback->timeopen) && $feedback->timeopen > 0) {
809         $event = new stdClass();
810         $event->eventtype    = FEEDBACK_EVENT_TYPE_OPEN;
811         $event->type         = empty($feedback->timeclose) ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
812         $event->name         = get_string('calendarstart', 'feedback', $feedback->name);
813         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
814         $event->timestart    = $feedback->timeopen;
815         $event->timesort     = $feedback->timeopen;
816         $event->visible      = instance_is_visible('feedback', $feedback);
817         $event->timeduration = 0;
818         if ($eventid) {
819             // Calendar event exists so update it.
820             $event->id = $eventid;
821             $calendarevent = calendar_event::load($event->id);
822             $calendarevent->update($event);
823         } else {
824             // Event doesn't exist so create one.
825             $event->courseid     = $feedback->course;
826             $event->groupid      = 0;
827             $event->userid       = 0;
828             $event->modulename   = 'feedback';
829             $event->instance     = $feedback->id;
830             $event->eventtype    = FEEDBACK_EVENT_TYPE_OPEN;
831             calendar_event::create($event);
832         }
833     } else if ($eventid) {
834         // Calendar event is on longer needed.
835         $calendarevent = calendar_event::load($eventid);
836         $calendarevent->delete();
837     }
839     // Feedback close calendar events.
840     $eventid = $DB->get_field('event', 'id',
841             array('modulename' => 'feedback', 'instance' => $feedback->id, 'eventtype' => FEEDBACK_EVENT_TYPE_CLOSE));
843     if (isset($feedback->timeclose) && $feedback->timeclose > 0) {
844         $event = new stdClass();
845         $event->type         = CALENDAR_EVENT_TYPE_ACTION;
846         $event->eventtype    = FEEDBACK_EVENT_TYPE_CLOSE;
847         $event->name         = get_string('calendarend', 'feedback', $feedback->name);
848         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
849         $event->timestart    = $feedback->timeclose;
850         $event->timesort     = $feedback->timeclose;
851         $event->visible      = instance_is_visible('feedback', $feedback);
852         $event->timeduration = 0;
853         if ($eventid) {
854             // Calendar event exists so update it.
855             $event->id = $eventid;
856             $calendarevent = calendar_event::load($event->id);
857             $calendarevent->update($event);
858         } else {
859             // Event doesn't exist so create one.
860             $event->courseid     = $feedback->course;
861             $event->groupid      = 0;
862             $event->userid       = 0;
863             $event->modulename   = 'feedback';
864             $event->instance     = $feedback->id;
865             calendar_event::create($event);
866         }
867     } else if ($eventid) {
868         // Calendar event is on longer needed.
869         $calendarevent = calendar_event::load($eventid);
870         $calendarevent->delete();
871     }
874 /**
875  * This standard function will check all instances of this module
876  * and make sure there are up-to-date events created for each of them.
877  * If courseid = 0, then every feedback event in the site is checked, else
878  * only feedback events belonging to the course specified are checked.
879  * This function is used, in its new format, by restore_refresh_events()
880  *
881  * @param int $courseid
882  * @return bool
883  */
884 function feedback_refresh_events($courseid = 0) {
885     global $DB;
887     if ($courseid) {
888         if (! $feedbacks = $DB->get_records("feedback", array("course" => $courseid))) {
889             return true;
890         }
891     } else {
892         if (! $feedbacks = $DB->get_records("feedback")) {
893             return true;
894         }
895     }
897     foreach ($feedbacks as $feedback) {
898         feedback_set_events($feedback);
899     }
900     return true;
903 /**
904  * this function is called by {@link feedback_delete_userdata()}
905  * it drops the feedback-instance from the course_module table
906  *
907  * @global object
908  * @param int $id the id from the coursemodule
909  * @return boolean
910  */
911 function feedback_delete_course_module($id) {
912     global $DB;
914     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
915         return true;
916     }
917     return $DB->delete_records('course_modules', array('id'=>$cm->id));
922 ////////////////////////////////////////////////
923 //functions to handle capabilities
924 ////////////////////////////////////////////////
926 /**
927  * returns the context-id related to the given coursemodule-id
928  *
929  * @deprecated since 3.1
930  * @staticvar object $context
931  * @param int $cmid the coursemodule-id
932  * @return object $context
933  */
934 function feedback_get_context($cmid) {
935     debugging('Function feedback_get_context() is deprecated because it was not used.',
936             DEBUG_DEVELOPER);
937     static $context;
939     if (isset($context)) {
940         return $context;
941     }
943     $context = context_module::instance($cmid);
944     return $context;
947 /**
948  *  returns true if the current role is faked by switching role feature
949  *
950  * @global object
951  * @return boolean
952  */
953 function feedback_check_is_switchrole() {
954     global $USER;
955     if (isset($USER->switchrole) AND
956             is_array($USER->switchrole) AND
957             count($USER->switchrole) > 0) {
959         return true;
960     }
961     return false;
964 /**
965  * count users which have not completed the feedback
966  *
967  * @global object
968  * @uses CONTEXT_MODULE
969  * @param cm_info $cm Course-module object
970  * @param int $group single groupid
971  * @param string $sort
972  * @param int $startpage
973  * @param int $pagecount
974  * @return object the userrecords
975  */
976 function feedback_get_incomplete_users(cm_info $cm,
977                                        $group = false,
978                                        $sort = '',
979                                        $startpage = false,
980                                        $pagecount = false) {
982     global $DB;
984     $context = context_module::instance($cm->id);
986     //first get all user who can complete this feedback
987     $cap = 'mod/feedback:complete';
988     $fields = 'u.id, u.username';
989     if (!$allusers = get_users_by_capability($context,
990                                             $cap,
991                                             $fields,
992                                             $sort,
993                                             '',
994                                             '',
995                                             $group,
996                                             '',
997                                             true)) {
998         return false;
999     }
1000     // Filter users that are not in the correct group/grouping.
1001     $info = new \core_availability\info_module($cm);
1002     $allusers = $info->filter_user_list($allusers);
1004     $allusers = array_keys($allusers);
1006     //now get all completeds
1007     $params = array('feedback'=>$cm->instance);
1008     if (!$completedusers = $DB->get_records_menu('feedback_completed', $params, '', 'id, userid')) {
1009         return $allusers;
1010     }
1012     //now strike all completedusers from allusers
1013     $allusers = array_diff($allusers, $completedusers);
1015     //for paging I use array_slice()
1016     if ($startpage !== false AND $pagecount !== false) {
1017         $allusers = array_slice($allusers, $startpage, $pagecount);
1018     }
1020     return $allusers;
1023 /**
1024  * count users which have not completed the feedback
1025  *
1026  * @global object
1027  * @param object $cm
1028  * @param int $group single groupid
1029  * @return int count of userrecords
1030  */
1031 function feedback_count_incomplete_users($cm, $group = false) {
1032     if ($allusers = feedback_get_incomplete_users($cm, $group)) {
1033         return count($allusers);
1034     }
1035     return 0;
1038 /**
1039  * count users which have completed a feedback
1040  *
1041  * @global object
1042  * @uses FEEDBACK_ANONYMOUS_NO
1043  * @param object $cm
1044  * @param int $group single groupid
1045  * @return int count of userrecords
1046  */
1047 function feedback_count_complete_users($cm, $group = false) {
1048     global $DB;
1050     $params = array(FEEDBACK_ANONYMOUS_NO, $cm->instance);
1052     $fromgroup = '';
1053     $wheregroup = '';
1054     if ($group) {
1055         $fromgroup = ', {groups_members} g';
1056         $wheregroup = ' AND g.groupid = ? AND g.userid = c.userid';
1057         $params[] = $group;
1058     }
1060     $sql = 'SELECT COUNT(u.id) FROM {user} u, {feedback_completed} c'.$fromgroup.'
1061               WHERE anonymous_response = ? AND u.id = c.userid AND c.feedback = ?
1062               '.$wheregroup;
1064     return $DB->count_records_sql($sql, $params);
1068 /**
1069  * get users which have completed a feedback
1070  *
1071  * @global object
1072  * @uses CONTEXT_MODULE
1073  * @uses FEEDBACK_ANONYMOUS_NO
1074  * @param object $cm
1075  * @param int $group single groupid
1076  * @param string $where a sql where condition (must end with " AND ")
1077  * @param array parameters used in $where
1078  * @param string $sort a table field
1079  * @param int $startpage
1080  * @param int $pagecount
1081  * @return object the userrecords
1082  */
1083 function feedback_get_complete_users($cm,
1084                                      $group = false,
1085                                      $where = '',
1086                                      array $params = null,
1087                                      $sort = '',
1088                                      $startpage = false,
1089                                      $pagecount = false) {
1091     global $DB;
1093     $context = context_module::instance($cm->id);
1095     $params = (array)$params;
1097     $params['anon'] = FEEDBACK_ANONYMOUS_NO;
1098     $params['instance'] = $cm->instance;
1100     $fromgroup = '';
1101     $wheregroup = '';
1102     if ($group) {
1103         $fromgroup = ', {groups_members} g';
1104         $wheregroup = ' AND g.groupid = :group AND g.userid = c.userid';
1105         $params['group'] = $group;
1106     }
1108     if ($sort) {
1109         $sortsql = ' ORDER BY '.$sort;
1110     } else {
1111         $sortsql = '';
1112     }
1114     $ufields = user_picture::fields('u');
1115     $sql = 'SELECT DISTINCT '.$ufields.', c.timemodified as completed_timemodified
1116             FROM {user} u, {feedback_completed} c '.$fromgroup.'
1117             WHERE '.$where.' anonymous_response = :anon
1118                 AND u.id = c.userid
1119                 AND c.feedback = :instance
1120               '.$wheregroup.$sortsql;
1122     if ($startpage === false OR $pagecount === false) {
1123         $startpage = false;
1124         $pagecount = false;
1125     }
1126     return $DB->get_records_sql($sql, $params, $startpage, $pagecount);
1129 /**
1130  * get users which have the viewreports-capability
1131  *
1132  * @uses CONTEXT_MODULE
1133  * @param int $cmid
1134  * @param mixed $groups single groupid or array of groupids - group(s) user is in
1135  * @return object the userrecords
1136  */
1137 function feedback_get_viewreports_users($cmid, $groups = false) {
1139     $context = context_module::instance($cmid);
1141     //description of the call below:
1142     //get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='',
1143     //                          $limitnum='', $groups='', $exceptions='', $doanything=true)
1144     return get_users_by_capability($context,
1145                             'mod/feedback:viewreports',
1146                             '',
1147                             'lastname',
1148                             '',
1149                             '',
1150                             $groups,
1151                             '',
1152                             false);
1155 /**
1156  * get users which have the receivemail-capability
1157  *
1158  * @uses CONTEXT_MODULE
1159  * @param int $cmid
1160  * @param mixed $groups single groupid or array of groupids - group(s) user is in
1161  * @return object the userrecords
1162  */
1163 function feedback_get_receivemail_users($cmid, $groups = false) {
1165     $context = context_module::instance($cmid);
1167     //description of the call below:
1168     //get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='',
1169     //                          $limitnum='', $groups='', $exceptions='', $doanything=true)
1170     return get_users_by_capability($context,
1171                             'mod/feedback:receivemail',
1172                             '',
1173                             'lastname',
1174                             '',
1175                             '',
1176                             $groups,
1177                             '',
1178                             false);
1181 ////////////////////////////////////////////////
1182 //functions to handle the templates
1183 ////////////////////////////////////////////////
1184 ////////////////////////////////////////////////
1186 /**
1187  * creates a new template-record.
1188  *
1189  * @global object
1190  * @param int $courseid
1191  * @param string $name the name of template shown in the templatelist
1192  * @param int $ispublic 0:privat 1:public
1193  * @return int the new templateid
1194  */
1195 function feedback_create_template($courseid, $name, $ispublic = 0) {
1196     global $DB;
1198     $templ = new stdClass();
1199     $templ->course   = ($ispublic ? 0 : $courseid);
1200     $templ->name     = $name;
1201     $templ->ispublic = $ispublic;
1203     $templid = $DB->insert_record('feedback_template', $templ);
1204     return $DB->get_record('feedback_template', array('id'=>$templid));
1207 /**
1208  * creates new template items.
1209  * all items will be copied and the attribute feedback will be set to 0
1210  * and the attribute template will be set to the new templateid
1211  *
1212  * @global object
1213  * @uses CONTEXT_MODULE
1214  * @uses CONTEXT_COURSE
1215  * @param object $feedback
1216  * @param string $name the name of template shown in the templatelist
1217  * @param int $ispublic 0:privat 1:public
1218  * @return boolean
1219  */
1220 function feedback_save_as_template($feedback, $name, $ispublic = 0) {
1221     global $DB;
1222     $fs = get_file_storage();
1224     if (!$feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
1225         return false;
1226     }
1228     if (!$newtempl = feedback_create_template($feedback->course, $name, $ispublic)) {
1229         return false;
1230     }
1232     //files in the template_item are in the context of the current course or
1233     //if the template is public the files are in the system context
1234     //files in the feedback_item are in the feedback_context of the feedback
1235     if ($ispublic) {
1236         $s_context = context_system::instance();
1237     } else {
1238         $s_context = context_course::instance($newtempl->course);
1239     }
1240     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
1241     $f_context = context_module::instance($cm->id);
1243     //create items of this new template
1244     //depend items we are storing temporary in an mapping list array(new id => dependitem)
1245     //we also store a mapping of all items array(oldid => newid)
1246     $dependitemsmap = array();
1247     $itembackup = array();
1248     foreach ($feedbackitems as $item) {
1250         $t_item = clone($item);
1252         unset($t_item->id);
1253         $t_item->feedback = 0;
1254         $t_item->template     = $newtempl->id;
1255         $t_item->id = $DB->insert_record('feedback_item', $t_item);
1256         //copy all included files to the feedback_template filearea
1257         $itemfiles = $fs->get_area_files($f_context->id,
1258                                     'mod_feedback',
1259                                     'item',
1260                                     $item->id,
1261                                     "id",
1262                                     false);
1263         if ($itemfiles) {
1264             foreach ($itemfiles as $ifile) {
1265                 $file_record = new stdClass();
1266                 $file_record->contextid = $s_context->id;
1267                 $file_record->component = 'mod_feedback';
1268                 $file_record->filearea = 'template';
1269                 $file_record->itemid = $t_item->id;
1270                 $fs->create_file_from_storedfile($file_record, $ifile);
1271             }
1272         }
1274         $itembackup[$item->id] = $t_item->id;
1275         if ($t_item->dependitem) {
1276             $dependitemsmap[$t_item->id] = $t_item->dependitem;
1277         }
1279     }
1281     //remapping the dependency
1282     foreach ($dependitemsmap as $key => $dependitem) {
1283         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1284         $newitem->dependitem = $itembackup[$newitem->dependitem];
1285         $DB->update_record('feedback_item', $newitem);
1286     }
1288     return true;
1291 /**
1292  * deletes all feedback_items related to the given template id
1293  *
1294  * @global object
1295  * @uses CONTEXT_COURSE
1296  * @param object $template the template
1297  * @return void
1298  */
1299 function feedback_delete_template($template) {
1300     global $DB;
1302     //deleting the files from the item is done by feedback_delete_item
1303     if ($t_items = $DB->get_records("feedback_item", array("template"=>$template->id))) {
1304         foreach ($t_items as $t_item) {
1305             feedback_delete_item($t_item->id, false, $template);
1306         }
1307     }
1308     $DB->delete_records("feedback_template", array("id"=>$template->id));
1311 /**
1312  * creates new feedback_item-records from template.
1313  * if $deleteold is set true so the existing items of the given feedback will be deleted
1314  * if $deleteold is set false so the new items will be appanded to the old items
1315  *
1316  * @global object
1317  * @uses CONTEXT_COURSE
1318  * @uses CONTEXT_MODULE
1319  * @param object $feedback
1320  * @param int $templateid
1321  * @param boolean $deleteold
1322  */
1323 function feedback_items_from_template($feedback, $templateid, $deleteold = false) {
1324     global $DB, $CFG;
1326     require_once($CFG->libdir.'/completionlib.php');
1328     $fs = get_file_storage();
1330     if (!$template = $DB->get_record('feedback_template', array('id'=>$templateid))) {
1331         return false;
1332     }
1333     //get all templateitems
1334     if (!$templitems = $DB->get_records('feedback_item', array('template'=>$templateid))) {
1335         return false;
1336     }
1338     //files in the template_item are in the context of the current course
1339     //files in the feedback_item are in the feedback_context of the feedback
1340     if ($template->ispublic) {
1341         $s_context = context_system::instance();
1342     } else {
1343         $s_context = context_course::instance($feedback->course);
1344     }
1345     $course = $DB->get_record('course', array('id'=>$feedback->course));
1346     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
1347     $f_context = context_module::instance($cm->id);
1349     //if deleteold then delete all old items before
1350     //get all items
1351     if ($deleteold) {
1352         if ($feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
1353             //delete all items of this feedback
1354             foreach ($feedbackitems as $item) {
1355                 feedback_delete_item($item->id, false);
1356             }
1358             $params = array('feedback'=>$feedback->id);
1359             if ($completeds = $DB->get_records('feedback_completed', $params)) {
1360                 $completion = new completion_info($course);
1361                 foreach ($completeds as $completed) {
1362                     // Update completion state
1363                     if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
1364                         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1365                     }
1366                     $DB->delete_records('feedback_completed', array('id'=>$completed->id));
1367                 }
1368             }
1369             $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedback->id));
1370         }
1371         $positionoffset = 0;
1372     } else {
1373         //if the old items are kept the new items will be appended
1374         //therefor the new position has an offset
1375         $positionoffset = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
1376     }
1378     //create items of this new template
1379     //depend items we are storing temporary in an mapping list array(new id => dependitem)
1380     //we also store a mapping of all items array(oldid => newid)
1381     $dependitemsmap = array();
1382     $itembackup = array();
1383     foreach ($templitems as $t_item) {
1384         $item = clone($t_item);
1385         unset($item->id);
1386         $item->feedback = $feedback->id;
1387         $item->template = 0;
1388         $item->position = $item->position + $positionoffset;
1390         $item->id = $DB->insert_record('feedback_item', $item);
1392         //moving the files to the new item
1393         $templatefiles = $fs->get_area_files($s_context->id,
1394                                         'mod_feedback',
1395                                         'template',
1396                                         $t_item->id,
1397                                         "id",
1398                                         false);
1399         if ($templatefiles) {
1400             foreach ($templatefiles as $tfile) {
1401                 $file_record = new stdClass();
1402                 $file_record->contextid = $f_context->id;
1403                 $file_record->component = 'mod_feedback';
1404                 $file_record->filearea = 'item';
1405                 $file_record->itemid = $item->id;
1406                 $fs->create_file_from_storedfile($file_record, $tfile);
1407             }
1408         }
1410         $itembackup[$t_item->id] = $item->id;
1411         if ($item->dependitem) {
1412             $dependitemsmap[$item->id] = $item->dependitem;
1413         }
1414     }
1416     //remapping the dependency
1417     foreach ($dependitemsmap as $key => $dependitem) {
1418         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1419         $newitem->dependitem = $itembackup[$newitem->dependitem];
1420         $DB->update_record('feedback_item', $newitem);
1421     }
1424 /**
1425  * get the list of available templates.
1426  * if the $onlyown param is set true so only templates from own course will be served
1427  * this is important for droping templates
1428  *
1429  * @global object
1430  * @param object $course
1431  * @param string $onlyownorpublic
1432  * @return array the template recordsets
1433  */
1434 function feedback_get_template_list($course, $onlyownorpublic = '') {
1435     global $DB, $CFG;
1437     switch($onlyownorpublic) {
1438         case '':
1439             $templates = $DB->get_records_select('feedback_template',
1440                                                  'course = ? OR ispublic = 1',
1441                                                  array($course->id),
1442                                                  'name');
1443             break;
1444         case 'own':
1445             $templates = $DB->get_records('feedback_template',
1446                                           array('course'=>$course->id),
1447                                           'name');
1448             break;
1449         case 'public':
1450             $templates = $DB->get_records('feedback_template', array('ispublic'=>1), 'name');
1451             break;
1452     }
1453     return $templates;
1456 ////////////////////////////////////////////////
1457 //Handling der Items
1458 ////////////////////////////////////////////////
1459 ////////////////////////////////////////////////
1461 /**
1462  * load the lib.php from item-plugin-dir and returns the instance of the itemclass
1463  *
1464  * @param string $typ
1465  * @return feedback_item_base the instance of itemclass
1466  */
1467 function feedback_get_item_class($typ) {
1468     global $CFG;
1470     //get the class of item-typ
1471     $itemclass = 'feedback_item_'.$typ;
1472     //get the instance of item-class
1473     if (!class_exists($itemclass)) {
1474         require_once($CFG->dirroot.'/mod/feedback/item/'.$typ.'/lib.php');
1475     }
1476     return new $itemclass();
1479 /**
1480  * load the available item plugins from given subdirectory of $CFG->dirroot
1481  * the default is "mod/feedback/item"
1482  *
1483  * @global object
1484  * @param string $dir the subdir
1485  * @return array pluginnames as string
1486  */
1487 function feedback_load_feedback_items($dir = 'mod/feedback/item') {
1488     global $CFG;
1489     $names = get_list_of_plugins($dir);
1490     $ret_names = array();
1492     foreach ($names as $name) {
1493         require_once($CFG->dirroot.'/'.$dir.'/'.$name.'/lib.php');
1494         if (class_exists('feedback_item_'.$name)) {
1495             $ret_names[] = $name;
1496         }
1497     }
1498     return $ret_names;
1501 /**
1502  * load the available item plugins to use as dropdown-options
1503  *
1504  * @global object
1505  * @return array pluginnames as string
1506  */
1507 function feedback_load_feedback_items_options() {
1508     global $CFG;
1510     $feedback_options = array("pagebreak" => get_string('add_pagebreak', 'feedback'));
1512     if (!$feedback_names = feedback_load_feedback_items('mod/feedback/item')) {
1513         return array();
1514     }
1516     foreach ($feedback_names as $fn) {
1517         $feedback_options[$fn] = get_string($fn, 'feedback');
1518     }
1519     asort($feedback_options);
1520     return $feedback_options;
1523 /**
1524  * load the available items for the depend item dropdown list shown in the edit_item form
1525  *
1526  * @global object
1527  * @param object $feedback
1528  * @param object $item the item of the edit_item form
1529  * @return array all items except the item $item, labels and pagebreaks
1530  */
1531 function feedback_get_depend_candidates_for_item($feedback, $item) {
1532     global $DB;
1533     //all items for dependitem
1534     $where = "feedback = ? AND typ != 'pagebreak' AND hasvalue = 1";
1535     $params = array($feedback->id);
1536     if (isset($item->id) AND $item->id) {
1537         $where .= ' AND id != ?';
1538         $params[] = $item->id;
1539     }
1540     $dependitems = array(0 => get_string('choose'));
1541     $feedbackitems = $DB->get_records_select_menu('feedback_item',
1542                                                   $where,
1543                                                   $params,
1544                                                   'position',
1545                                                   'id, label');
1547     if (!$feedbackitems) {
1548         return $dependitems;
1549     }
1550     //adding the choose-option
1551     foreach ($feedbackitems as $key => $val) {
1552         if (trim(strval($val)) !== '') {
1553             $dependitems[$key] = format_string($val);
1554         }
1555     }
1556     return $dependitems;
1559 /**
1560  * creates a new item-record
1561  *
1562  * @deprecated since 3.1
1563  * @param object $data the data from edit_item_form
1564  * @return int the new itemid
1565  */
1566 function feedback_create_item($data) {
1567     debugging('Function feedback_create_item() is deprecated because it was not used.',
1568             DEBUG_DEVELOPER);
1569     global $DB;
1571     $item = new stdClass();
1572     $item->feedback = $data->feedbackid;
1574     $item->template=0;
1575     if (isset($data->templateid)) {
1576             $item->template = intval($data->templateid);
1577     }
1579     $itemname = trim($data->itemname);
1580     $item->name = ($itemname ? $data->itemname : get_string('no_itemname', 'feedback'));
1582     if (!empty($data->itemlabel)) {
1583         $item->label = trim($data->itemlabel);
1584     } else {
1585         $item->label = get_string('no_itemlabel', 'feedback');
1586     }
1588     $itemobj = feedback_get_item_class($data->typ);
1589     $item->presentation = ''; //the date comes from postupdate() of the itemobj
1591     $item->hasvalue = $itemobj->get_hasvalue();
1593     $item->typ = $data->typ;
1594     $item->position = $data->position;
1596     $item->required=0;
1597     if (!empty($data->required)) {
1598         $item->required = $data->required;
1599     }
1601     $item->id = $DB->insert_record('feedback_item', $item);
1603     //move all itemdata to the data
1604     $data->id = $item->id;
1605     $data->feedback = $item->feedback;
1606     $data->name = $item->name;
1607     $data->label = $item->label;
1608     $data->required = $item->required;
1609     return $itemobj->postupdate($data);
1612 /**
1613  * save the changes of a given item.
1614  *
1615  * @global object
1616  * @param object $item
1617  * @return boolean
1618  */
1619 function feedback_update_item($item) {
1620     global $DB;
1621     return $DB->update_record("feedback_item", $item);
1624 /**
1625  * deletes an item and also deletes all related values
1626  *
1627  * @global object
1628  * @uses CONTEXT_MODULE
1629  * @param int $itemid
1630  * @param boolean $renumber should the kept items renumbered Yes/No
1631  * @param object $template if the template is given so the items are bound to it
1632  * @return void
1633  */
1634 function feedback_delete_item($itemid, $renumber = true, $template = false) {
1635     global $DB;
1637     $item = $DB->get_record('feedback_item', array('id'=>$itemid));
1639     //deleting the files from the item
1640     $fs = get_file_storage();
1642     if ($template) {
1643         if ($template->ispublic) {
1644             $context = context_system::instance();
1645         } else {
1646             $context = context_course::instance($template->course);
1647         }
1648         $templatefiles = $fs->get_area_files($context->id,
1649                                     'mod_feedback',
1650                                     'template',
1651                                     $item->id,
1652                                     "id",
1653                                     false);
1655         if ($templatefiles) {
1656             $fs->delete_area_files($context->id, 'mod_feedback', 'template', $item->id);
1657         }
1658     } else {
1659         if (!$cm = get_coursemodule_from_instance('feedback', $item->feedback)) {
1660             return false;
1661         }
1662         $context = context_module::instance($cm->id);
1664         $itemfiles = $fs->get_area_files($context->id,
1665                                     'mod_feedback',
1666                                     'item',
1667                                     $item->id,
1668                                     "id", false);
1670         if ($itemfiles) {
1671             $fs->delete_area_files($context->id, 'mod_feedback', 'item', $item->id);
1672         }
1673     }
1675     $DB->delete_records("feedback_value", array("item"=>$itemid));
1676     $DB->delete_records("feedback_valuetmp", array("item"=>$itemid));
1678     //remove all depends
1679     $DB->set_field('feedback_item', 'dependvalue', '', array('dependitem'=>$itemid));
1680     $DB->set_field('feedback_item', 'dependitem', 0, array('dependitem'=>$itemid));
1682     $DB->delete_records("feedback_item", array("id"=>$itemid));
1683     if ($renumber) {
1684         feedback_renumber_items($item->feedback);
1685     }
1688 /**
1689  * deletes all items of the given feedbackid
1690  *
1691  * @global object
1692  * @param int $feedbackid
1693  * @return void
1694  */
1695 function feedback_delete_all_items($feedbackid) {
1696     global $DB, $CFG;
1697     require_once($CFG->libdir.'/completionlib.php');
1699     if (!$feedback = $DB->get_record('feedback', array('id'=>$feedbackid))) {
1700         return false;
1701     }
1703     if (!$cm = get_coursemodule_from_instance('feedback', $feedback->id)) {
1704         return false;
1705     }
1707     if (!$course = $DB->get_record('course', array('id'=>$feedback->course))) {
1708         return false;
1709     }
1711     if (!$items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid))) {
1712         return;
1713     }
1714     foreach ($items as $item) {
1715         feedback_delete_item($item->id, false);
1716     }
1717     if ($completeds = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
1718         $completion = new completion_info($course);
1719         foreach ($completeds as $completed) {
1720             // Update completion state
1721             if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
1722                 $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1723             }
1724             $DB->delete_records('feedback_completed', array('id'=>$completed->id));
1725         }
1726     }
1728     $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedbackid));
1732 /**
1733  * this function toggled the item-attribute required (yes/no)
1734  *
1735  * @global object
1736  * @param object $item
1737  * @return boolean
1738  */
1739 function feedback_switch_item_required($item) {
1740     global $DB, $CFG;
1742     $itemobj = feedback_get_item_class($item->typ);
1744     if ($itemobj->can_switch_require()) {
1745         $new_require_val = (int)!(bool)$item->required;
1746         $params = array('id'=>$item->id);
1747         $DB->set_field('feedback_item', 'required', $new_require_val, $params);
1748     }
1749     return true;
1752 /**
1753  * renumbers all items of the given feedbackid
1754  *
1755  * @global object
1756  * @param int $feedbackid
1757  * @return void
1758  */
1759 function feedback_renumber_items($feedbackid) {
1760     global $DB;
1762     $items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid), 'position');
1763     $pos = 1;
1764     if ($items) {
1765         foreach ($items as $item) {
1766             $DB->set_field('feedback_item', 'position', $pos, array('id'=>$item->id));
1767             $pos++;
1768         }
1769     }
1772 /**
1773  * this decreases the position of the given item
1774  *
1775  * @global object
1776  * @param object $item
1777  * @return bool
1778  */
1779 function feedback_moveup_item($item) {
1780     global $DB;
1782     if ($item->position == 1) {
1783         return true;
1784     }
1786     $params = array('feedback'=>$item->feedback);
1787     if (!$items = $DB->get_records('feedback_item', $params, 'position')) {
1788         return false;
1789     }
1791     $itembefore = null;
1792     foreach ($items as $i) {
1793         if ($i->id == $item->id) {
1794             if (is_null($itembefore)) {
1795                 return true;
1796             }
1797             $itembefore->position = $item->position;
1798             $item->position--;
1799             feedback_update_item($itembefore);
1800             feedback_update_item($item);
1801             feedback_renumber_items($item->feedback);
1802             return true;
1803         }
1804         $itembefore = $i;
1805     }
1806     return false;
1809 /**
1810  * this increased the position of the given item
1811  *
1812  * @global object
1813  * @param object $item
1814  * @return bool
1815  */
1816 function feedback_movedown_item($item) {
1817     global $DB;
1819     $params = array('feedback'=>$item->feedback);
1820     if (!$items = $DB->get_records('feedback_item', $params, 'position')) {
1821         return false;
1822     }
1824     $movedownitem = null;
1825     foreach ($items as $i) {
1826         if (!is_null($movedownitem) AND $movedownitem->id == $item->id) {
1827             $movedownitem->position = $i->position;
1828             $i->position--;
1829             feedback_update_item($movedownitem);
1830             feedback_update_item($i);
1831             feedback_renumber_items($item->feedback);
1832             return true;
1833         }
1834         $movedownitem = $i;
1835     }
1836     return false;
1839 /**
1840  * here the position of the given item will be set to the value in $pos
1841  *
1842  * @global object
1843  * @param object $moveitem
1844  * @param int $pos
1845  * @return boolean
1846  */
1847 function feedback_move_item($moveitem, $pos) {
1848     global $DB;
1850     $params = array('feedback'=>$moveitem->feedback);
1851     if (!$allitems = $DB->get_records('feedback_item', $params, 'position')) {
1852         return false;
1853     }
1854     if (is_array($allitems)) {
1855         $index = 1;
1856         foreach ($allitems as $item) {
1857             if ($index == $pos) {
1858                 $index++;
1859             }
1860             if ($item->id == $moveitem->id) {
1861                 $moveitem->position = $pos;
1862                 feedback_update_item($moveitem);
1863                 continue;
1864             }
1865             $item->position = $index;
1866             feedback_update_item($item);
1867             $index++;
1868         }
1869         return true;
1870     }
1871     return false;
1874 /**
1875  * prints the given item as a preview.
1876  * each item-class has an own print_item_preview function implemented.
1877  *
1878  * @deprecated since Moodle 3.1
1879  * @global object
1880  * @param object $item the item what we want to print out
1881  * @return void
1882  */
1883 function feedback_print_item_preview($item) {
1884     debugging('Function feedback_print_item_preview() is deprecated and does nothing. '
1885             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1888 /**
1889  * prints the given item in the completion form.
1890  * each item-class has an own print_item_complete function implemented.
1891  *
1892  * @deprecated since Moodle 3.1
1893  * @param object $item the item what we want to print out
1894  * @param mixed $value the value
1895  * @param boolean $highlightrequire if this set true and the value are false on completing so the item will be highlighted
1896  * @return void
1897  */
1898 function feedback_print_item_complete($item, $value = false, $highlightrequire = false) {
1899     debugging('Function feedback_print_item_complete() is deprecated and does nothing. '
1900             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1903 /**
1904  * prints the given item in the show entries page.
1905  * each item-class has an own print_item_show_value function implemented.
1906  *
1907  * @deprecated since Moodle 3.1
1908  * @param object $item the item what we want to print out
1909  * @param mixed $value
1910  * @return void
1911  */
1912 function feedback_print_item_show_value($item, $value = false) {
1913     debugging('Function feedback_print_item_show_value() is deprecated and does nothing. '
1914             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
1917 /**
1918  * if the user completes a feedback and there is a pagebreak so the values are saved temporary.
1919  * the values are not saved permanently until the user click on save button
1920  *
1921  * @global object
1922  * @param object $feedbackcompleted
1923  * @return object temporary saved completed-record
1924  */
1925 function feedback_set_tmp_values($feedbackcompleted) {
1926     global $DB;
1927     debugging('Function feedback_set_tmp_values() is deprecated and since it is '
1928             . 'no longer used in mod_feedback', DEBUG_DEVELOPER);
1930     //first we create a completedtmp
1931     $tmpcpl = new stdClass();
1932     foreach ($feedbackcompleted as $key => $value) {
1933         $tmpcpl->{$key} = $value;
1934     }
1935     unset($tmpcpl->id);
1936     $tmpcpl->timemodified = time();
1937     $tmpcpl->id = $DB->insert_record('feedback_completedtmp', $tmpcpl);
1938     //get all values of original-completed
1939     if (!$values = $DB->get_records('feedback_value', array('completed'=>$feedbackcompleted->id))) {
1940         return;
1941     }
1942     foreach ($values as $value) {
1943         unset($value->id);
1944         $value->completed = $tmpcpl->id;
1945         $DB->insert_record('feedback_valuetmp', $value);
1946     }
1947     return $tmpcpl;
1950 /**
1951  * this saves the temporary saved values permanently
1952  *
1953  * @global object
1954  * @param object $feedbackcompletedtmp the temporary completed
1955  * @param object $feedbackcompleted the target completed
1956  * @return int the id of the completed
1957  */
1958 function feedback_save_tmp_values($feedbackcompletedtmp, $feedbackcompleted) {
1959     global $DB;
1961     $tmpcplid = $feedbackcompletedtmp->id;
1962     if ($feedbackcompleted) {
1963         //first drop all existing values
1964         $DB->delete_records('feedback_value', array('completed'=>$feedbackcompleted->id));
1965         //update the current completed
1966         $feedbackcompleted->timemodified = time();
1967         $DB->update_record('feedback_completed', $feedbackcompleted);
1968     } else {
1969         $feedbackcompleted = clone($feedbackcompletedtmp);
1970         $feedbackcompleted->id = '';
1971         $feedbackcompleted->timemodified = time();
1972         $feedbackcompleted->id = $DB->insert_record('feedback_completed', $feedbackcompleted);
1973     }
1975     $allitems = $DB->get_records('feedback_item', array('feedback' => $feedbackcompleted->feedback));
1977     //save all the new values from feedback_valuetmp
1978     //get all values of tmp-completed
1979     $params = array('completed'=>$feedbackcompletedtmp->id);
1980     $values = $DB->get_records('feedback_valuetmp', $params);
1981     foreach ($values as $value) {
1982         //check if there are depend items
1983         $item = $DB->get_record('feedback_item', array('id'=>$value->item));
1984         if ($item->dependitem > 0 && isset($allitems[$item->dependitem])) {
1985             $check = feedback_compare_item_value($tmpcplid,
1986                                         $allitems[$item->dependitem],
1987                                         $item->dependvalue,
1988                                         true);
1989         } else {
1990             $check = true;
1991         }
1992         if ($check) {
1993             unset($value->id);
1994             $value->completed = $feedbackcompleted->id;
1995             $DB->insert_record('feedback_value', $value);
1996         }
1997     }
1998     //drop all the tmpvalues
1999     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
2000     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
2002     // Trigger event for the delete action we performed.
2003     $cm = get_coursemodule_from_instance('feedback', $feedbackcompleted->feedback);
2004     $event = \mod_feedback\event\response_submitted::create_from_record($feedbackcompleted, $cm);
2005     $event->trigger();
2006     return $feedbackcompleted->id;
2010 /**
2011  * deletes the given temporary completed and all related temporary values
2012  *
2013  * @deprecated since Moodle 3.1
2014  *
2015  * @param int $tmpcplid
2016  * @return void
2017  */
2018 function feedback_delete_completedtmp($tmpcplid) {
2019     global $DB;
2021     debugging('Function feedback_delete_completedtmp() is deprecated because it is no longer used',
2022             DEBUG_DEVELOPER);
2024     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
2025     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
2028 ////////////////////////////////////////////////
2029 ////////////////////////////////////////////////
2030 ////////////////////////////////////////////////
2031 //functions to handle the pagebreaks
2032 ////////////////////////////////////////////////
2034 /**
2035  * this creates a pagebreak.
2036  * a pagebreak is a special kind of item
2037  *
2038  * @global object
2039  * @param int $feedbackid
2040  * @return mixed false if there already is a pagebreak on last position or the id of the pagebreak-item
2041  */
2042 function feedback_create_pagebreak($feedbackid) {
2043     global $DB;
2045     //check if there already is a pagebreak on the last position
2046     $lastposition = $DB->count_records('feedback_item', array('feedback'=>$feedbackid));
2047     if ($lastposition == feedback_get_last_break_position($feedbackid)) {
2048         return false;
2049     }
2051     $item = new stdClass();
2052     $item->feedback = $feedbackid;
2054     $item->template=0;
2056     $item->name = '';
2058     $item->presentation = '';
2059     $item->hasvalue = 0;
2061     $item->typ = 'pagebreak';
2062     $item->position = $lastposition + 1;
2064     $item->required=0;
2066     return $DB->insert_record('feedback_item', $item);
2069 /**
2070  * get all positions of pagebreaks in the given feedback
2071  *
2072  * @global object
2073  * @param int $feedbackid
2074  * @return array all ordered pagebreak positions
2075  */
2076 function feedback_get_all_break_positions($feedbackid) {
2077     global $DB;
2079     $params = array('typ'=>'pagebreak', 'feedback'=>$feedbackid);
2080     $allbreaks = $DB->get_records_menu('feedback_item', $params, 'position', 'id, position');
2081     if (!$allbreaks) {
2082         return false;
2083     }
2084     return array_values($allbreaks);
2087 /**
2088  * get the position of the last pagebreak
2089  *
2090  * @param int $feedbackid
2091  * @return int the position of the last pagebreak
2092  */
2093 function feedback_get_last_break_position($feedbackid) {
2094     if (!$allbreaks = feedback_get_all_break_positions($feedbackid)) {
2095         return false;
2096     }
2097     return $allbreaks[count($allbreaks) - 1];
2100 /**
2101  * this returns the position where the user can continue the completing.
2102  *
2103  * @deprecated since Moodle 3.1
2104  * @global object
2105  * @global object
2106  * @global object
2107  * @param int $feedbackid
2108  * @param int $courseid
2109  * @param string $guestid this id will be saved temporary and is unique
2110  * @return int the position to continue
2111  */
2112 function feedback_get_page_to_continue($feedbackid, $courseid = false, $guestid = false) {
2113     global $CFG, $USER, $DB;
2115     debugging('Function feedback_get_page_to_continue() is deprecated and since it is '
2116             . 'no longer used in mod_feedback', DEBUG_DEVELOPER);
2118     //is there any break?
2120     if (!$allbreaks = feedback_get_all_break_positions($feedbackid)) {
2121         return false;
2122     }
2124     $params = array();
2125     if ($courseid) {
2126         $courseselect = "AND fv.course_id = :courseid";
2127         $params['courseid'] = $courseid;
2128     } else {
2129         $courseselect = '';
2130     }
2132     if ($guestid) {
2133         $userselect = "AND fc.guestid = :guestid";
2134         $usergroup = "GROUP BY fc.guestid";
2135         $params['guestid'] = $guestid;
2136     } else {
2137         $userselect = "AND fc.userid = :userid";
2138         $usergroup = "GROUP BY fc.userid";
2139         $params['userid'] = $USER->id;
2140     }
2142     $sql =  "SELECT MAX(fi.position)
2143                FROM {feedback_completedtmp} fc, {feedback_valuetmp} fv, {feedback_item} fi
2144               WHERE fc.id = fv.completed
2145                     $userselect
2146                     AND fc.feedback = :feedbackid
2147                     $courseselect
2148                     AND fi.id = fv.item
2149          $usergroup";
2150     $params['feedbackid'] = $feedbackid;
2152     $lastpos = $DB->get_field_sql($sql, $params);
2154     //the index of found pagebreak is the searched pagenumber
2155     foreach ($allbreaks as $pagenr => $br) {
2156         if ($lastpos < $br) {
2157             return $pagenr;
2158         }
2159     }
2160     return count($allbreaks);
2163 ////////////////////////////////////////////////
2164 ////////////////////////////////////////////////
2165 ////////////////////////////////////////////////
2166 //functions to handle the values
2167 ////////////////////////////////////////////////
2169 /**
2170  * cleans the userinput while submitting the form.
2171  *
2172  * @deprecated since Moodle 3.1
2173  * @param mixed $value
2174  * @return mixed
2175  */
2176 function feedback_clean_input_value($item, $value) {
2177     debugging('Function feedback_clean_input_value() is deprecated and does nothing. '
2178             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
2181 /**
2182  * this saves the values of an completed.
2183  * if the param $tmp is set true so the values are saved temporary in table feedback_valuetmp.
2184  * if there is already a completed and the userid is set so the values are updated.
2185  * on all other things new value records will be created.
2186  *
2187  * @deprecated since Moodle 3.1
2188  *
2189  * @param int $usrid
2190  * @param boolean $tmp
2191  * @return mixed false on error or the completeid
2192  */
2193 function feedback_save_values($usrid, $tmp = false) {
2194     global $DB;
2196     debugging('Function feedback_save_values() was deprecated because it did not have '.
2197             'enough arguments, was not suitable for non-temporary table and was taking '.
2198             'data directly from input', DEBUG_DEVELOPER);
2200     $completedid = optional_param('completedid', 0, PARAM_INT);
2201     $tmpstr = $tmp ? 'tmp' : '';
2202     $time = time();
2203     $timemodified = mktime(0, 0, 0, date('m', $time), date('d', $time), date('Y', $time));
2205     if ($usrid == 0) {
2206         return feedback_create_values($usrid, $timemodified, $tmp);
2207     }
2208     $completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid));
2209     if (!$completed) {
2210         return feedback_create_values($usrid, $timemodified, $tmp);
2211     } else {
2212         $completed->timemodified = $timemodified;
2213         return feedback_update_values($completed, $tmp);
2214     }
2217 /**
2218  * this saves the values from anonymous user such as guest on the main-site
2219  *
2220  * @deprecated since Moodle 3.1
2221  *
2222  * @param string $guestid the unique guestidentifier
2223  * @return mixed false on error or the completeid
2224  */
2225 function feedback_save_guest_values($guestid) {
2226     global $DB;
2228     debugging('Function feedback_save_guest_values() was deprecated because it did not have '.
2229             'enough arguments, was not suitable for non-temporary table and was taking '.
2230             'data directly from input', DEBUG_DEVELOPER);
2232     $completedid = optional_param('completedid', false, PARAM_INT);
2234     $timemodified = time();
2235     if (!$completed = $DB->get_record('feedback_completedtmp', array('id'=>$completedid))) {
2236         return feedback_create_values(0, $timemodified, true, $guestid);
2237     } else {
2238         $completed->timemodified = $timemodified;
2239         return feedback_update_values($completed, true);
2240     }
2243 /**
2244  * get the value from the given item related to the given completed.
2245  * the value can come as temporary or as permanently value. the deciding is done by $tmp
2246  *
2247  * @global object
2248  * @param int $completeid
2249  * @param int $itemid
2250  * @param boolean $tmp
2251  * @return mixed the value, the type depends on plugin-definition
2252  */
2253 function feedback_get_item_value($completedid, $itemid, $tmp = false) {
2254     global $DB;
2256     $tmpstr = $tmp ? 'tmp' : '';
2257     $params = array('completed'=>$completedid, 'item'=>$itemid);
2258     return $DB->get_field('feedback_value'.$tmpstr, 'value', $params);
2261 /**
2262  * compares the value of the itemid related to the completedid with the dependvalue.
2263  * this is used if a depend item is set.
2264  * the value can come as temporary or as permanently value. the deciding is done by $tmp.
2265  *
2266  * @param int $completedid
2267  * @param stdClass|int $item
2268  * @param mixed $dependvalue
2269  * @param bool $tmp
2270  * @return bool
2271  */
2272 function feedback_compare_item_value($completedid, $item, $dependvalue, $tmp = false) {
2273     global $DB;
2275     if (is_int($item)) {
2276         $item = $DB->get_record('feedback_item', array('id' => $item));
2277     }
2279     $dbvalue = feedback_get_item_value($completedid, $item->id, $tmp);
2281     $itemobj = feedback_get_item_class($item->typ);
2282     return $itemobj->compare_value($item, $dbvalue, $dependvalue); //true or false
2285 /**
2286  * this function checks the correctness of values.
2287  * the rules for this are implemented in the class of each item.
2288  * it can be the required attribute or the value self e.g. numeric.
2289  * the params first/lastitem are given to determine the visible range between pagebreaks.
2290  *
2291  * @global object
2292  * @param int $firstitem the position of firstitem for checking
2293  * @param int $lastitem the position of lastitem for checking
2294  * @return boolean
2295  */
2296 function feedback_check_values($firstitem, $lastitem) {
2297     debugging('Function feedback_check_values() is deprecated and does nothing. '
2298             . 'Items must implement complete_form_element()', DEBUG_DEVELOPER);
2299     return true;
2302 /**
2303  * this function create a complete-record and the related value-records.
2304  * depending on the $tmp (true/false) the values are saved temporary or permanently
2305  *
2306  * @deprecated since Moodle 3.1
2307  *
2308  * @param int $userid
2309  * @param int $timemodified
2310  * @param boolean $tmp
2311  * @param string $guestid a unique identifier to save temporary data
2312  * @return mixed false on error or the completedid
2313  */
2314 function feedback_create_values($usrid, $timemodified, $tmp = false, $guestid = false) {
2315     global $DB;
2317     debugging('Function feedback_create_values() was deprecated because it did not have '.
2318             'enough arguments, was not suitable for non-temporary table and was taking '.
2319             'data directly from input', DEBUG_DEVELOPER);
2321     $tmpstr = $tmp ? 'tmp' : '';
2322     //first we create a new completed record
2323     $completed = new stdClass();
2324     $completed->feedback           = $feedbackid;
2325     $completed->userid             = $usrid;
2326     $completed->guestid            = $guestid;
2327     $completed->timemodified       = $timemodified;
2328     $completed->anonymous_response = $anonymous_response;
2330     $completedid = $DB->insert_record('feedback_completed'.$tmpstr, $completed);
2332     $completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid));
2334     //the keys are in the form like abc_xxx
2335     //with explode we make an array with(abc, xxx) and (abc=typ und xxx=itemnr)
2337     //get the items of the feedback
2338     if (!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2339         return false;
2340     }
2341     foreach ($allitems as $item) {
2342         if (!$item->hasvalue) {
2343             continue;
2344         }
2345         //get the class of item-typ
2346         $itemobj = feedback_get_item_class($item->typ);
2348         $keyname = $item->typ.'_'.$item->id;
2350         if ($item->typ === 'multichoice') {
2351             $itemvalue = optional_param_array($keyname, null, PARAM_INT);
2352         } else {
2353             $itemvalue = optional_param($keyname, null, PARAM_NOTAGS);
2354         }
2356         if (is_null($itemvalue)) {
2357             continue;
2358         }
2360         $value = new stdClass();
2361         $value->item = $item->id;
2362         $value->completed = $completed->id;
2363         $value->course_id = $courseid;
2365         //the kind of values can be absolutely different
2366         //so we run create_value directly by the item-class
2367         $value->value = $itemobj->create_value($itemvalue);
2368         $DB->insert_record('feedback_value'.$tmpstr, $value);
2369     }
2370     return $completed->id;
2373 /**
2374  * this function updates a complete-record and the related value-records.
2375  * depending on the $tmp (true/false) the values are saved temporary or permanently
2376  *
2377  * @global object
2378  * @param object $completed
2379  * @param boolean $tmp
2380  * @return int the completedid
2381  */
2382 function feedback_update_values($completed, $tmp = false) {
2383     global $DB;
2385     debugging('Function feedback_update_values() was deprecated because it did not have '.
2386             'enough arguments, was not suitable for non-temporary table and was taking '.
2387             'data directly from input', DEBUG_DEVELOPER);
2389     $courseid = optional_param('courseid', false, PARAM_INT);
2390     $tmpstr = $tmp ? 'tmp' : '';
2392     $DB->update_record('feedback_completed'.$tmpstr, $completed);
2393     //get the values of this completed
2394     $values = $DB->get_records('feedback_value'.$tmpstr, array('completed'=>$completed->id));
2396     //get the items of the feedback
2397     if (!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2398         return false;
2399     }
2400     foreach ($allitems as $item) {
2401         if (!$item->hasvalue) {
2402             continue;
2403         }
2404         //get the class of item-typ
2405         $itemobj = feedback_get_item_class($item->typ);
2407         $keyname = $item->typ.'_'.$item->id;
2409         if ($item->typ === 'multichoice') {
2410             $itemvalue = optional_param_array($keyname, null, PARAM_INT);
2411         } else {
2412             $itemvalue = optional_param($keyname, null, PARAM_NOTAGS);
2413         }
2415         //is the itemvalue set (could be a subset of items because pagebreak)?
2416         if (is_null($itemvalue)) {
2417             continue;
2418         }
2420         $newvalue = new stdClass();
2421         $newvalue->item = $item->id;
2422         $newvalue->completed = $completed->id;
2423         $newvalue->course_id = $courseid;
2425         //the kind of values can be absolutely different
2426         //so we run create_value directly by the item-class
2427         $newvalue->value = $itemobj->create_value($itemvalue);
2429         //check, if we have to create or update the value
2430         $exist = false;
2431         foreach ($values as $value) {
2432             if ($value->item == $newvalue->item) {
2433                 $newvalue->id = $value->id;
2434                 $exist = true;
2435                 break;
2436             }
2437         }
2438         if ($exist) {
2439             $DB->update_record('feedback_value'.$tmpstr, $newvalue);
2440         } else {
2441             $DB->insert_record('feedback_value'.$tmpstr, $newvalue);
2442         }
2443     }
2445     return $completed->id;
2448 /**
2449  * get the values of an item depending on the given groupid.
2450  * if the feedback is anonymous so the values are shuffled
2451  *
2452  * @global object
2453  * @global object
2454  * @param object $item
2455  * @param int $groupid
2456  * @param int $courseid
2457  * @param bool $ignore_empty if this is set true so empty values are not delivered
2458  * @return array the value-records
2459  */
2460 function feedback_get_group_values($item,
2461                                    $groupid = false,
2462                                    $courseid = false,
2463                                    $ignore_empty = false) {
2465     global $CFG, $DB;
2467     //if the groupid is given?
2468     if (intval($groupid) > 0) {
2469         $params = array();
2470         if ($ignore_empty) {
2471             $value = $DB->sql_compare_text('fbv.value');
2472             $ignore_empty_select = "AND $value != :emptyvalue AND $value != :zerovalue";
2473             $params += array('emptyvalue' => '', 'zerovalue' => '0');
2474         } else {
2475             $ignore_empty_select = "";
2476         }
2478         $query = 'SELECT fbv .  *
2479                     FROM {feedback_value} fbv, {feedback_completed} fbc, {groups_members} gm
2480                    WHERE fbv.item = :itemid
2481                          AND fbv.completed = fbc.id
2482                          AND fbc.userid = gm.userid
2483                          '.$ignore_empty_select.'
2484                          AND gm.groupid = :groupid
2485                 ORDER BY fbc.timemodified';
2486         $params += array('itemid' => $item->id, 'groupid' => $groupid);
2487         $values = $DB->get_records_sql($query, $params);
2489     } else {
2490         $params = array();
2491         if ($ignore_empty) {
2492             $value = $DB->sql_compare_text('value');
2493             $ignore_empty_select = "AND $value != :emptyvalue AND $value != :zerovalue";
2494             $params += array('emptyvalue' => '', 'zerovalue' => '0');
2495         } else {
2496             $ignore_empty_select = "";
2497         }
2499         if ($courseid) {
2500             $select = "item = :itemid AND course_id = :courseid ".$ignore_empty_select;
2501             $params += array('itemid' => $item->id, 'courseid' => $courseid);
2502             $values = $DB->get_records_select('feedback_value', $select, $params);
2503         } else {
2504             $select = "item = :itemid ".$ignore_empty_select;
2505             $params += array('itemid' => $item->id);
2506             $values = $DB->get_records_select('feedback_value', $select, $params);
2507         }
2508     }
2509     $params = array('id'=>$item->feedback);
2510     if ($DB->get_field('feedback', 'anonymous', $params) == FEEDBACK_ANONYMOUS_YES) {
2511         if (is_array($values)) {
2512             shuffle($values);
2513         }
2514     }
2515     return $values;
2518 /**
2519  * check for multiple_submit = false.
2520  * if the feedback is global so the courseid must be given
2521  *
2522  * @global object
2523  * @global object
2524  * @param int $feedbackid
2525  * @param int $courseid
2526  * @return boolean true if the feedback already is submitted otherwise false
2527  */
2528 function feedback_is_already_submitted($feedbackid, $courseid = false) {
2529     global $USER, $DB;
2531     if (!isloggedin() || isguestuser()) {
2532         return false;
2533     }
2535     $params = array('userid' => $USER->id, 'feedback' => $feedbackid);
2536     if ($courseid) {
2537         $params['courseid'] = $courseid;
2538     }
2539     return $DB->record_exists('feedback_completed', $params);
2542 /**
2543  * if the completion of a feedback will be continued eg.
2544  * by pagebreak or by multiple submit so the complete must be found.
2545  * if the param $tmp is set true so all things are related to temporary completeds
2546  *
2547  * @deprecated since Moodle 3.1
2548  * @param int $feedbackid
2549  * @param boolean $tmp
2550  * @param int $courseid
2551  * @param string $guestid
2552  * @return int the id of the found completed
2553  */
2554 function feedback_get_current_completed($feedbackid,
2555                                         $tmp = false,
2556                                         $courseid = false,
2557                                         $guestid = false) {
2559     debugging('Function feedback_get_current_completed() is deprecated. Please use either '.
2560             'feedback_get_current_completed_tmp() or feedback_get_last_completed()',
2561             DEBUG_DEVELOPER);
2563     global $USER, $CFG, $DB;
2565     $tmpstr = $tmp ? 'tmp' : '';
2567     if (!$courseid) {
2568         if ($guestid) {
2569             $params = array('feedback'=>$feedbackid, 'guestid'=>$guestid);
2570             return $DB->get_record('feedback_completed'.$tmpstr, $params);
2571         } else {
2572             $params = array('feedback'=>$feedbackid, 'userid'=>$USER->id);
2573             return $DB->get_record('feedback_completed'.$tmpstr, $params);
2574         }
2575     }
2577     $params = array();
2579     if ($guestid) {
2580         $userselect = "AND fc.guestid = :guestid";
2581         $params['guestid'] = $guestid;
2582     } else {
2583         $userselect = "AND fc.userid = :userid";
2584         $params['userid'] = $USER->id;
2585     }
2586     //if courseid is set the feedback is global.
2587     //there can be more than one completed on one feedback
2588     $sql =  "SELECT DISTINCT fc.*
2589                FROM {feedback_value{$tmpstr}} fv, {feedback_completed{$tmpstr}} fc
2590               WHERE fv.course_id = :courseid
2591                     AND fv.completed = fc.id
2592                     $userselect
2593                     AND fc.feedback = :feedbackid";
2594     $params['courseid']   = intval($courseid);
2595     $params['feedbackid'] = $feedbackid;
2597     if (!$sqlresult = $DB->get_records_sql($sql, $params)) {
2598         return false;
2599     }
2600     foreach ($sqlresult as $r) {
2601         return $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$r->id));
2602     }
2605 /**
2606  * get the completeds depending on the given groupid.
2607  *
2608  * @global object
2609  * @global object
2610  * @param object $feedback
2611  * @param int $groupid
2612  * @param int $courseid
2613  * @return mixed array of found completeds otherwise false
2614  */
2615 function feedback_get_completeds_group($feedback, $groupid = false, $courseid = false) {
2616     global $CFG, $DB;
2618     if (intval($groupid) > 0) {
2619         $query = "SELECT fbc.*
2620                     FROM {feedback_completed} fbc, {groups_members} gm
2621                    WHERE fbc.feedback = ?
2622                          AND gm.groupid = ?
2623                          AND fbc.userid = gm.userid";
2624         if ($values = $DB->get_records_sql($query, array($feedback->id, $groupid))) {
2625             return $values;
2626         } else {
2627             return false;
2628         }
2629     } else {
2630         if ($courseid) {
2631             $query = "SELECT DISTINCT fbc.*
2632                         FROM {feedback_completed} fbc, {feedback_value} fbv
2633                         WHERE fbc.id = fbv.completed
2634                             AND fbc.feedback = ?
2635                             AND fbv.course_id = ?
2636                         ORDER BY random_response";
2637             if ($values = $DB->get_records_sql($query, array($feedback->id, $courseid))) {
2638                 return $values;
2639             } else {
2640                 return false;
2641             }
2642         } else {
2643             if ($values = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
2644                 return $values;
2645             } else {
2646                 return false;
2647             }
2648         }
2649     }
2652 /**
2653  * get the count of completeds depending on the given groupid.
2654  *
2655  * @global object
2656  * @global object
2657  * @param object $feedback
2658  * @param int $groupid
2659  * @param int $courseid
2660  * @return mixed count of completeds or false
2661  */
2662 function feedback_get_completeds_group_count($feedback, $groupid = false, $courseid = false) {
2663     global $CFG, $DB;
2665     if ($courseid > 0 AND !$groupid <= 0) {
2666         $sql = "SELECT id, COUNT(item) AS ci
2667                   FROM {feedback_value}
2668                  WHERE course_id  = ?
2669               GROUP BY item ORDER BY ci DESC";
2670         if ($foundrecs = $DB->get_records_sql($sql, array($courseid))) {
2671             $foundrecs = array_values($foundrecs);
2672             return $foundrecs[0]->ci;
2673         }
2674         return false;
2675     }
2676     if ($values = feedback_get_completeds_group($feedback, $groupid)) {
2677         return count($values);
2678     } else {
2679         return false;
2680     }
2683 /**
2684  * deletes all completed-recordsets from a feedback.
2685  * all related data such as values also will be deleted
2686  *
2687  * @param stdClass|int $feedback
2688  * @param stdClass|cm_info $cm
2689  * @param stdClass $course
2690  * @return void
2691  */
2692 function feedback_delete_all_completeds($feedback, $cm = null, $course = null) {
2693     global $DB;
2695     if (is_int($feedback)) {
2696         $feedback = $DB->get_record('feedback', array('id' => $feedback));
2697     }
2699     if (!$completeds = $DB->get_records('feedback_completed', array('feedback' => $feedback->id))) {
2700         return;
2701     }
2703     if (!$course && !($course = $DB->get_record('course', array('id' => $feedback->course)))) {
2704         return false;
2705     }
2707     if (!$cm && !($cm = get_coursemodule_from_instance('feedback', $feedback->id))) {
2708         return false;
2709     }
2711     foreach ($completeds as $completed) {
2712         feedback_delete_completed($completed, $feedback, $cm, $course);
2713     }
2716 /**
2717  * deletes a completed given by completedid.
2718  * all related data such values or tracking data also will be deleted
2719  *
2720  * @param int|stdClass $completed
2721  * @param stdClass $feedback
2722  * @param stdClass|cm_info $cm
2723  * @param stdClass $course
2724  * @return boolean
2725  */
2726 function feedback_delete_completed($completed, $feedback = null, $cm = null, $course = null) {
2727     global $DB, $CFG;
2728     require_once($CFG->libdir.'/completionlib.php');
2730     if (!isset($completed->id)) {
2731         if (!$completed = $DB->get_record('feedback_completed', array('id' => $completed))) {
2732             return false;
2733         }
2734     }
2736     if (!$feedback && !($feedback = $DB->get_record('feedback', array('id' => $completed->feedback)))) {
2737         return false;
2738     }
2740     if (!$course && !($course = $DB->get_record('course', array('id' => $feedback->course)))) {
2741         return false;
2742     }
2744     if (!$cm && !($cm = get_coursemodule_from_instance('feedback', $feedback->id))) {
2745         return false;
2746     }
2748     //first we delete all related values
2749     $DB->delete_records('feedback_value', array('completed' => $completed->id));
2751     // Update completion state
2752     $completion = new completion_info($course);
2753     if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
2754         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
2755     }
2756     // Last we delete the completed-record.
2757     $return = $DB->delete_records('feedback_completed', array('id' => $completed->id));
2759     // Trigger event for the delete action we performed.
2760     $event = \mod_feedback\event\response_deleted::create_from_record($completed, $cm, $feedback);
2761     $event->trigger();
2763     return $return;
2766 ////////////////////////////////////////////////
2767 ////////////////////////////////////////////////
2768 ////////////////////////////////////////////////
2769 //functions to handle sitecourse mapping
2770 ////////////////////////////////////////////////
2772 /**
2773  * checks if the course and the feedback is in the table feedback_sitecourse_map.
2774  *
2775  * @deprecated since 3.1
2776  * @param int $feedbackid
2777  * @param int $courseid
2778  * @return int the count of records
2779  */
2780 function feedback_is_course_in_sitecourse_map($feedbackid, $courseid) {
2781     debugging('Function feedback_is_course_in_sitecourse_map() is deprecated because it was not used.',
2782             DEBUG_DEVELOPER);
2783     global $DB;
2784     $params = array('feedbackid'=>$feedbackid, 'courseid'=>$courseid);
2785     return $DB->count_records('feedback_sitecourse_map', $params);
2788 /**
2789  * checks if the feedback is in the table feedback_sitecourse_map.
2790  *
2791  * @deprecated since 3.1
2792  * @param int $feedbackid
2793  * @return boolean
2794  */
2795 function feedback_is_feedback_in_sitecourse_map($feedbackid) {
2796     debugging('Function feedback_is_feedback_in_sitecourse_map() is deprecated because it was not used.',
2797             DEBUG_DEVELOPER);
2798     global $DB;
2799     return $DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$feedbackid));
2802 /**
2803  * gets the feedbacks from table feedback_sitecourse_map.
2804  * this is used to show the global feedbacks on the feedback block
2805  * all feedbacks with the following criteria will be selected:<br />
2806  *
2807  * 1) all feedbacks which id are listed together with the courseid in sitecoursemap and<br />
2808  * 2) all feedbacks which not are listed in sitecoursemap
2809  *
2810  * @global object
2811  * @param int $courseid
2812  * @return array the feedback-records
2813  */
2814 function feedback_get_feedbacks_from_sitecourse_map($courseid) {
2815     global $DB;
2817     //first get all feedbacks listed in sitecourse_map with named courseid
2818     $sql = "SELECT f.id AS id,
2819                    cm.id AS cmid,
2820                    f.name AS name,
2821                    f.timeopen AS timeopen,
2822                    f.timeclose AS timeclose
2823             FROM {feedback} f, {course_modules} cm, {feedback_sitecourse_map} sm, {modules} m
2824             WHERE f.id = cm.instance
2825                    AND f.course = '".SITEID."'
2826                    AND m.id = cm.module
2827                    AND m.name = 'feedback'
2828                    AND sm.courseid = ?
2829                    AND sm.feedbackid = f.id";
2831     if (!$feedbacks1 = $DB->get_records_sql($sql, array($courseid))) {
2832         $feedbacks1 = array();
2833     }
2835     //second get all feedbacks not listed in sitecourse_map
2836     $feedbacks2 = array();
2837     $sql = "SELECT f.id AS id,
2838                    cm.id AS cmid,
2839                    f.name AS name,
2840                    f.timeopen AS timeopen,
2841                    f.timeclose AS timeclose
2842             FROM {feedback} f, {course_modules} cm, {modules} m
2843             WHERE f.id = cm.instance
2844                    AND f.course = '".SITEID."'
2845                    AND m.id = cm.module
2846                    AND m.name = 'feedback'";
2847     if (!$allfeedbacks = $DB->get_records_sql($sql)) {
2848         $allfeedbacks = array();
2849     }
2850     foreach ($allfeedbacks as $a) {
2851         if (!$DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$a->id))) {
2852             $feedbacks2[] = $a;
2853         }
2854     }
2856     $feedbacks = array_merge($feedbacks1, $feedbacks2);
2857     $modinfo = get_fast_modinfo(SITEID);
2858     return array_filter($feedbacks, function($f) use ($modinfo) {
2859         return ($cm = $modinfo->get_cm($f->cmid)) && $cm->uservisible;
2860     });
2864 /**
2865  * Gets the courses from table feedback_sitecourse_map
2866  *
2867  * @param int $feedbackid
2868  * @return array the course-records
2869  */
2870 function feedback_get_courses_from_sitecourse_map($feedbackid) {
2871     global $DB;
2873     $sql = "SELECT c.id, c.fullname, c.shortname
2874               FROM {feedback_sitecourse_map} f, {course} c
2875              WHERE c.id = f.courseid
2876                    AND f.feedbackid = ?
2877           ORDER BY c.fullname";
2879     return $DB->get_records_sql($sql, array($feedbackid));
2883 /**
2884  * Updates the course mapping for the feedback
2885  *
2886  * @param stdClass $feedback
2887  * @param array $courses array of course ids
2888  */
2889 function feedback_update_sitecourse_map($feedback, $courses) {
2890     global $DB;
2891     if (empty($courses)) {
2892         $courses = array();
2893     }
2894     $currentmapping = $DB->get_fieldset_select('feedback_sitecourse_map', 'courseid', 'feedbackid=?', array($feedback->id));
2895     foreach (array_diff($courses, $currentmapping) as $courseid) {
2896         $DB->insert_record('feedback_sitecourse_map', array('feedbackid' => $feedback->id, 'courseid' => $courseid));
2897     }
2898     foreach (array_diff($currentmapping, $courses) as $courseid) {
2899         $DB->delete_records('feedback_sitecourse_map', array('feedbackid' => $feedback->id, 'courseid' => $courseid));
2900     }
2901     // TODO MDL-53574 add events.
2904 /**
2905  * removes non existing courses or feedbacks from sitecourse_map.
2906  * it shouldn't be called all too often
2907  * a good place for it could be the mapcourse.php or unmapcourse.php
2908  *
2909  * @deprecated since 3.1
2910  * @global object
2911  * @return void
2912  */
2913 function feedback_clean_up_sitecourse_map() {
2914     global $DB;
2915     debugging('Function feedback_clean_up_sitecourse_map() is deprecated because it was not used.',
2916             DEBUG_DEVELOPER);
2918     $maps = $DB->get_records('feedback_sitecourse_map');
2919     foreach ($maps as $map) {
2920         if (!$DB->get_record('course', array('id'=>$map->courseid))) {
2921             $params = array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid);
2922             $DB->delete_records('feedback_sitecourse_map', $params);
2923             continue;
2924         }
2925         if (!$DB->get_record('feedback', array('id'=>$map->feedbackid))) {
2926             $params = array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid);
2927             $DB->delete_records('feedback_sitecourse_map', $params);
2928             continue;
2929         }
2931     }
2934 ////////////////////////////////////////////////
2935 ////////////////////////////////////////////////
2936 ////////////////////////////////////////////////
2937 //not relatable functions
2938 ////////////////////////////////////////////////
2940 /**
2941  * prints the option items of a selection-input item (dropdownlist).
2942  * @deprecated since 3.1
2943  * @param int $startval the first value of the list
2944  * @param int $endval the last value of the list
2945  * @param int $selectval which item should be selected
2946  * @param int $interval the stepsize from the first to the last value
2947  * @return void
2948  */
2949 function feedback_print_numeric_option_list($startval, $endval, $selectval = '', $interval = 1) {
2950     debugging('Function feedback_print_numeric_option_list() is deprecated because it was not used.',
2951             DEBUG_DEVELOPER);
2952     for ($i = $startval; $i <= $endval; $i += $interval) {
2953         if ($selectval == ($i)) {
2954             $selected = 'selected="selected"';
2955         } else {
2956             $selected = '';
2957         }
2958         echo '<option '.$selected.'>'.$i.'</option>';
2959     }
2962 /**
2963  * sends an email to the teachers of the course where the given feedback is placed.
2964  *
2965  * @global object
2966  * @global object
2967  * @uses FEEDBACK_ANONYMOUS_NO
2968  * @uses FORMAT_PLAIN
2969  * @param object $cm the coursemodule-record
2970  * @param object $feedback
2971  * @param object $course
2972  * @param stdClass|int $user
2973  * @return void
2974  */
2975 function feedback_send_email($cm, $feedback, $course, $user) {
2976     global $CFG, $DB;
2978     if ($feedback->email_notification == 0) {  // No need to do anything
2979         return;
2980     }
2982     if (is_int($user)) {
2983         $user = $DB->get_record('user', array('id' => $user));
2984     }
2986     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
2987         $groupmode =  $cm->groupmode;
2988     } else {
2989         $groupmode = $course->groupmode;
2990     }
2992     if ($groupmode == SEPARATEGROUPS) {
2993         $groups = $DB->get_records_sql_menu("SELECT g.name, g.id
2994                                                FROM {groups} g, {groups_members} m
2995                                               WHERE g.courseid = ?
2996                                                     AND g.id = m.groupid
2997                                                     AND m.userid = ?
2998                                            ORDER BY name ASC", array($course->id, $user->id));
2999         $groups = array_values($groups);
3001         $teachers = feedback_get_receivemail_users($cm->id, $groups);
3002     } else {
3003         $teachers = feedback_get_receivemail_users($cm->id);
3004     }
3006     if ($teachers) {
3008         $strfeedbacks = get_string('modulenameplural', 'feedback');
3009         $strfeedback  = get_string('modulename', 'feedback');
3011         if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
3012             $printusername = fullname($user);
3013         } else {
3014             $printusername = get_string('anonymous_user', 'feedback');
3015         }
3017         foreach ($teachers as $teacher) {
3018             $info = new stdClass();
3019             $info->username = $printusername;
3020             $info->feedback = format_string($feedback->name, true);
3021             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries.php?'.
3022                             'id='.$cm->id.'&'.
3023                             'userid=' . $user->id;
3025             $a = array('username' => $info->username, 'feedbackname' => $feedback->name);
3027             $postsubject = get_string('feedbackcompleted', 'feedback', $a);
3028             $posttext = feedback_send_email_text($info, $course);
3030             if ($teacher->mailformat == 1) {
3031                 $posthtml = feedback_send_email_html($info, $course, $cm);
3032             } else {
3033                 $posthtml = '';
3034             }
3036             if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
3037                 $eventdata = new \core\message\message();
3038                 $eventdata->courseid         = $course->id;
3039                 $eventdata->name             = 'submission';
3040                 $eventdata->component        = 'mod_feedback';
3041                 $eventdata->userfrom         = $user;
3042                 $eventdata->userto           = $teacher;
3043                 $eventdata->subject          = $postsubject;
3044                 $eventdata->fullmessage      = $posttext;
3045                 $eventdata->fullmessageformat = FORMAT_PLAIN;
3046                 $eventdata->fullmessagehtml  = $posthtml;
3047                 $eventdata->smallmessage     = '';
3048                 $eventdata->courseid         = $course->id;
3049                 $eventdata->contexturl       = $info->url;
3050                 $eventdata->contexturlname   = $info->feedback;
3051                 message_send($eventdata);
3052             } else {
3053                 $eventdata = new \core\message\message();
3054                 $eventdata->courseid         = $course->id;
3055                 $eventdata->name             = 'submission';
3056                 $eventdata->component        = 'mod_feedback';
3057                 $eventdata->userfrom         = $teacher;
3058                 $eventdata->userto           = $teacher;
3059                 $eventdata->subject          = $postsubject;
3060                 $eventdata->fullmessage      = $posttext;
3061                 $eventdata->fullmessageformat = FORMAT_PLAIN;
3062                 $eventdata->fullmessagehtml  = $posthtml;
3063                 $eventdata->smallmessage     = '';
3064                 $eventdata->courseid         = $course->id;
3065                 $eventdata->contexturl       = $info->url;
3066                 $eventdata->contexturlname   = $info->feedback;
3067                 message_send($eventdata);
3068             }
3069         }
3070     }
3073 /**
3074  * sends an email to the teachers of the course where the given feedback is placed.
3075  *
3076  * @global object
3077  * @uses FORMAT_PLAIN
3078  * @param object $cm the coursemodule-record
3079  * @param object $feedback
3080  * @param object $course
3081  * @return void
3082  */
3083 function feedback_send_email_anonym($cm, $feedback, $course) {
3084     global $CFG;
3086     if ($feedback->email_notification == 0) { // No need to do anything
3087         return;
3088     }
3090     $teachers = feedback_get_receivemail_users($cm->id);
3092     if ($teachers) {
3094         $strfeedbacks = get_string('modulenameplural', 'feedback');
3095         $strfeedback  = get_string('modulename', 'feedback');
3096         $printusername = get_string('anonymous_user', 'feedback');
3098         foreach ($teachers as $teacher) {
3099             $info = new stdClass();
3100             $info->username = $printusername;
3101             $info->feedback = format_string($feedback->name, true);
3102             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries.php?id=' . $cm->id;
3104             $a = array('username' => $info->username, 'feedbackname' => $feedback->name);
3106             $postsubject = get_string('feedbackcompleted', 'feedback', $a);
3107             $posttext = feedback_send_email_text($info, $course);
3109             if ($teacher->mailformat == 1) {
3110                 $posthtml = feedback_send_email_html($info, $course, $cm);
3111             } else {
3112                 $posthtml = '';
3113             }
3115             $eventdata = new \core\message\message();
3116             $eventdata->courseid         = $course->id;
3117             $eventdata->name             = 'submission';
3118             $eventdata->component        = 'mod_feedback';
3119             $eventdata->userfrom         = $teacher;
3120             $eventdata->userto           = $teacher;
3121             $eventdata->subject          = $postsubject;
3122             $eventdata->fullmessage      = $posttext;
3123             $eventdata->fullmessageformat = FORMAT_PLAIN;
3124             $eventdata->fullmessagehtml  = $posthtml;
3125             $eventdata->smallmessage     = '';
3126             $eventdata->courseid         = $course->id;
3127             $eventdata->contexturl       = $info->url;
3128             $eventdata->contexturlname   = $info->feedback;
3129             message_send($eventdata);
3130         }
3131     }
3134 /**
3135  * send the text-part of the email
3136  *
3137  * @param object $info includes some infos about the feedback you want to send
3138  * @param object $course
3139  * @return string the text you want to post
3140  */
3141 function feedback_send_email_text($info, $course) {
3142     $coursecontext = context_course::instance($course->id);
3143     $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
3144     $posttext  = $courseshortname.' -> '.get_string('modulenameplural', 'feedback').' -> '.
3145                     $info->feedback."\n";
3146     $posttext .= '---------------------------------------------------------------------'."\n";
3147     $posttext .= get_string("emailteachermail", "feedback", $info)."\n";
3148     $posttext .= '---------------------------------------------------------------------'."\n";
3149     return $posttext;
3153 /**
3154  * send the html-part of the email
3155  *
3156  * @global object
3157  * @param object $info includes some infos about the feedback you want to send
3158  * @param object $course
3159  * @return string the text you want to post
3160  */
3161 function feedback_send_email_html($info, $course, $cm) {
3162     global $CFG;
3163     $coursecontext = context_course::instance($course->id);
3164     $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
3165     $course_url = $CFG->wwwroot.'/course/view.php?id='.$course->id;
3166     $feedback_all_url = $CFG->wwwroot.'/mod/feedback/index.php?id='.$course->id;
3167     $feedback_url = $CFG->wwwroot.'/mod/feedback/view.php?id='.$cm->id;
3169     $posthtml = '<p><font face="sans-serif">'.
3170             '<a href="'.$course_url.'">'.$courseshortname.'</a> ->'.
3171             '<a href="'.$feedback_all_url.'">'.get_string('modulenameplural', 'feedback').'</a> ->'.
3172             '<a href="'.$feedback_url.'">'.$info->feedback.'</a></font></p>';
3173     $posthtml .= '<hr /><font face="sans-serif">';
3174     $posthtml .= '<p>'.get_string('emailteachermailhtml', 'feedback', $info).'</p>';
3175     $posthtml .= '</font><hr />';
3176     return $posthtml;
3179 /**
3180  * @param string $url
3181  * @return string
3182  */
3183 function feedback_encode_target_url($url) {
3184     if (strpos($url, '?')) {
3185         list($part1, $part2) = explode('?', $url, 2); //maximal 2 parts
3186         return $part1 . '?' . htmlentities($part2);
3187     } else {
3188         return $url;
3189     }
3192 /**
3193  * Adds module specific settings to the settings block
3194  *
3195  * @param settings_navigation $settings The settings navigation object
3196  * @param navigation_node $feedbacknode The node to add module settings to
3197  */
3198 function feedback_extend_settings_navigation(settings_navigation $settings,
3199                                              navigation_node $feedbacknode) {
3201     global $PAGE;
3203     if (!$context = context_module::instance($PAGE->cm->id, IGNORE_MISSING)) {
3204         print_error('badcontext');
3205     }
3207     if (has_capability('mod/feedback:edititems', $context)) {
3208         $questionnode = $feedbacknode->add(get_string('questions', 'feedback'));
3210         $questionnode->add(get_string('edit_items', 'feedback'),
3211                     new moodle_url('/mod/feedback/edit.php',
3212                                     array('id' => $PAGE->cm->id,
3213                                           'do_show' => 'edit')));
3215         $questionnode->add(get_string('export_questions', 'feedback'),
3216                     new moodle_url('/mod/feedback/export.php',
3217                                     array('id' => $PAGE->cm->id,
3218                                           'action' => 'exportfile')));
3220         $questionnode->add(get_string('import_questions', 'feedback'),
3221                     new moodle_url('/mod/feedback/import.php',
3222                                     array('id' => $PAGE->cm->id)));
3224         $questionnode->add(get_string('templates', 'feedback'),
3225                     new moodle_url('/mod/feedback/edit.php',
3226                                     array('id' => $PAGE->cm->id,
3227                                           'do_show' => 'templates')));
3228     }
3230     if (has_capability('mod/feedback:mapcourse', $context) && $PAGE->course->id == SITEID) {
3231         $feedbacknode->add(get_string('mappedcourses', 'feedback'),
3232                     new moodle_url('/mod/feedback/mapcourse.php',
3233                                     array('id' => $PAGE->cm->id)));
3234     }
3236     if (has_capability('mod/feedback:viewreports', $context)) {
3237         $feedback = $PAGE->activityrecord;
3238         if ($feedback->course == SITEID) {
3239             $feedbacknode->add(get_string('analysis', 'feedback'),
3240                     new moodle_url('/mod/feedback/analysis_course.php',
3241                                     array('id' => $PAGE->cm->id)));
3242         } else {
3243             $feedbacknode->add(get_string('analysis', 'feedback'),
3244                     new moodle_url('/mod/feedback/analysis.php',
3245                                     array('id' => $PAGE->cm->id)));
3246         }
3248         $feedbacknode->add(get_string('show_entries', 'feedback'),
3249                     new moodle_url('/mod/feedback/show_entries.php',
3250                                     array('id' => $PAGE->cm->id)));
3252         if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO AND $feedback->course != SITEID) {
3253             $feedbacknode->add(get_string('show_nonrespondents', 'feedback'),
3254                         new moodle_url('/mod/feedback/show_nonrespondents.php',
3255                                         array('id' => $PAGE->cm->id)));
3256         }
3257     }
3260 function feedback_init_feedback_session() {
3261     //initialize the feedback-Session - not nice at all!!
3262     global $SESSION;
3263     if (!empty($SESSION)) {
3264         if (!isset($SESSION->feedback) OR !is_object($SESSION->feedback)) {
3265             $SESSION->feedback = new stdClass();
3266         }
3267     }
3270 /**
3271  * Return a list of page types
3272  * @param string $pagetype current page type
3273  * @param stdClass $parentcontext Block's parent context
3274  * @param stdClass $currentcontext Current context of block
3275  */
3276 function feedback_page_type_list($pagetype, $parentcontext, $currentcontext) {
3277     $module_pagetype = array('mod-feedback-*'=>get_string('page-mod-feedback-x', 'feedback'));
3278     return $module_pagetype;
3281 /**
3282  * Move save the items of the given $feedback in the order of $itemlist.
3283  * @param string $itemlist a comma separated list with item ids
3284  * @param stdClass $feedback
3285  * @return bool true if success
3286  */
3287 function feedback_ajax_saveitemorder($itemlist, $feedback) {
3288     global $DB;
3290     $result = true;
3291     $position = 0;
3292     foreach ($itemlist as $itemid) {
3293         $position++;
3294         $result = $result && $DB->set_field('feedback_item',
3295                                             'position',
3296                                             $position,
3297                                             array('id'=>$itemid, 'feedback'=>$feedback->id));
3298     }
3299     return $result;
3302 /**
3303  * Checks if current user is able to view feedback on this course.
3304  *
3305  * @param stdClass $feedback
3306  * @param context_module $context
3307  * @param int $courseid
3308  * @return bool
3309  */
3310 function feedback_can_view_analysis($feedback, $context, $courseid = false) {
3311     if (has_capability('mod/feedback:viewreports', $context)) {
3312         return true;
3313     }
3315     if (intval($feedback->publish_stats) != 1 ||
3316             !has_capability('mod/feedback:viewanalysepage', $context)) {
3317         return false;
3318     }
3320     if (!isloggedin() || isguestuser()) {
3321         // There is no tracking for the guests, assume that they can view analysis if condition above is satisfied.
3322         return $feedback->course == SITEID;
3323     }
3325     return feedback_is_already_submitted($feedback->id, $courseid);
3328 /**
3329  * Get icon mapping for font-awesome.
3330  */
3331 function mod_feedback_get_fontawesome_icon_map() {
3332     return [
3333         'mod_feedback:required' => 'fa-exclamation-circle',
3334         'mod_feedback:notrequired' => 'fa-question-circle-o',
3335     ];
3338 /**
3339  * Check if the module has any update that affects the current user since a given time.
3340  *
3341  * @param  cm_info $cm course module data
3342  * @param  int $from the time to check updates from
3343  * @param  array $filter if we need to check only specific updates
3344  * @return stdClass an object with the different type of areas indicating if they were updated or not
3345  * @since Moodle 3.3
3346  */
3347 function feedback_check_updates_since(cm_info $cm, $from, $filter = array()) {
3348     global $DB, $USER, $CFG;
3350     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
3352     // Check for new attempts.
3353     $updates->attemptsfinished = (object) array('updated' => false);
3354     $updates->attemptsunfinished = (object) array('updated' => false);
3355     $select = 'feedback = ? AND userid = ? AND timemodified > ?';
3356     $params = array($cm->instance, $USER->id, $from);
3358     $attemptsfinished = $DB->get_records_select('feedback_completed', $select, $params, '', 'id');
3359     if (!empty($attemptsfinished)) {
3360         $updates->attemptsfinished->updated = true;
3361         $updates->attemptsfinished->itemids = array_keys($attemptsfinished);
3362     }
3363     $attemptsunfinished = $DB->get_records_select('feedback_completedtmp', $select, $params, '', 'id');
3364     if (!empty($attemptsunfinished)) {
3365         $updates->attemptsunfinished->updated = true;
3366         $updates->attemptsunfinished->itemids = array_keys($attemptsunfinished);
3367     }
3369     // Now, teachers should see other students updates.
3370     if (has_capability('mod/feedback:viewreports', $cm->context)) {
3371         $select = 'feedback = ? AND timemodified > ?';
3372         $params = array($cm->instance, $from);
3374         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
3375             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
3376             if (empty($groupusers)) {
3377                 return $updates;
3378             }
3379             list($insql, $inparams) = $DB->get_in_or_equal($groupusers);
3380             $select .= ' AND userid ' . $insql;
3381             $params = array_merge($params, $inparams);
3382         }
3384         $updates->userattemptsfinished = (object) array('updated' => false);
3385         $attemptsfinished = $DB->get_records_select('feedback_completed', $select, $params, '', 'id');
3386         if (!empty($attemptsfinished)) {
3387             $updates->userattemptsfinished->updated = true;
3388             $updates->userattemptsfinished->itemids = array_keys($attemptsfinished);
3389         }
3391         $updates->userattemptsunfinished = (object) array('updated' => false);
3392         $attemptsunfinished = $DB->get_records_select('feedback_completedtmp', $select, $params, '', 'id');
3393         if (!empty($attemptsunfinished)) {
3394             $updates->userattemptsunfinished->updated = true;
3395             $updates->userattemptsunfinished->itemids = array_keys($attemptsunfinished);
3396         }
3397     }
3399     return $updates;
3402 /**
3403  * Handles creating actions for events.
3404  *
3405  * @param calendar_event $event
3406  * @param \core_calendar\action_factory $factory
3407  * @return \core_calendar\local\event\value_objects\action|\core_calendar\local\interfaces\action_interface|null
3408  */
3409 function mod_feedback_core_calendar_provide_event_action(calendar_event $event,
3410                                                          \core_calendar\action_factory $factory) {
3411     global $DB;
3413     $cm = get_fast_modinfo($event->courseid)->instances['feedback'][$event->instance];
3414     $feedback = $DB->get_record('feedback', ['id' => $event->instance], 'id, timeopen, timeclose');
3416     $now = time();
3417     if ($feedback->timeopen && $feedback->timeclose) {
3418         $actionable = ($now >= $feedback->timeopen) && ($now <= $feedback->timeclose);
3419     } else if ($feedback->timeclose) {
3420         $actionable = $now < $feedback->timeclose;
3421     } else if ($feedback->timeopen) {
3422         $actionable = $now >= $feedback->timeopen;
3423     } else {
3424         $actionable = true;
3425     }
3427     return $factory->create_instance(
3428         get_string('answerquestions', 'feedback'),
3429         new \moodle_url('/mod/feedback/view.php', ['id' => $cm->id]),
3430         1,
3431         $actionable
3432     );