MDL-24698 hopefully fixed all completion_info problems
[moodle.git] / mod / feedback / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module feedback
20  * includes the main-part of feedback-functions
21  *
22  * @package mod-feedback
23  * @copyright Andreas Grabs
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 /** Include eventslib.php */
28 require_once($CFG->libdir.'/eventslib.php');
29 /** Include calendar/lib.php */
30 require_once($CFG->dirroot.'/calendar/lib.php');
32 define('FEEDBACK_ANONYMOUS_YES', 1);
33 define('FEEDBACK_ANONYMOUS_NO', 2);
34 define('FEEDBACK_MIN_ANONYMOUS_COUNT_IN_GROUP', 2);
35 define('FEEDBACK_DECIMAL', '.');
36 define('FEEDBACK_THOUSAND', ',');
37 define('FEEDBACK_RESETFORM_RESET', 'feedback_reset_data_');
38 define('FEEDBACK_RESETFORM_DROP', 'feedback_drop_feedback_');
39 define('FEEDBACK_MAX_PIX_LENGTH', '400'); //max. Breite des grafischen Balkens in der Auswertung
40 define('FEEDBACK_DEFAULT_PAGE_COUNT', 20);
42 /**
43  * @uses FEATURE_GROUPS
44  * @uses FEATURE_GROUPINGS
45  * @uses FEATURE_GROUPMEMBERSONLY
46  * @uses FEATURE_MOD_INTRO
47  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
48  * @uses FEATURE_GRADE_HAS_GRADE
49  * @uses FEATURE_GRADE_OUTCOMES
50  * @param string $feature FEATURE_xx constant for requested feature
51  * @return mixed True if module supports feature, null if doesn't know
52  */
53 function feedback_supports($feature) {
54     switch($feature) {
55         case FEATURE_GROUPS:                  return true;
56         case FEATURE_GROUPINGS:               return true;
57         case FEATURE_GROUPMEMBERSONLY:        return true;
58         case FEATURE_MOD_INTRO:               return true;
59         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
60         case FEATURE_COMPLETION_HAS_RULES:    return true;
61         case FEATURE_GRADE_HAS_GRADE:         return false;
62         case FEATURE_GRADE_OUTCOMES:          return false;
63         case FEATURE_BACKUP_MOODLE2:          return true;
65         default: return null;
66     }
67 }
69 /**
70  * this will create a new instance and return the id number
71  * of the new instance.
72  *
73  * @global object
74  * @param object $feedback the object given by mod_feedback_mod_form
75  * @return int
76  */
77 function feedback_add_instance($feedback) {
78     global $DB;
80     $feedback->timemodified = time();
81     $feedback->id = '';
83     //check if openenable and/or closeenable is set and set correctly to save in db
84     if(empty($feedback->openenable)) {
85         $feedback->timeopen = 0;
86     }
87     if(empty($feedback->closeenable)) {
88         $feedback->timeclose = 0;
89     }
90     if(empty($feedback->site_after_submit)) {
91         $feedback->site_after_submit = '';
92     }
94     //saving the feedback in db
95     $feedbackid = $DB->insert_record("feedback", $feedback);
97     $feedback->id = $feedbackid;
99     feedback_set_events($feedback);
101     return $feedbackid;
104 /**
105  * this will update a given instance
106  *
107  * @global object
108  * @param object $feedback the object given by mod_feedback_mod_form
109  * @return boolean
110  */
111 function feedback_update_instance($feedback) {
112     global $DB;
114     $feedback->timemodified = time();
115     $feedback->id = $feedback->instance;
117     //check if openenable and/or closeenable is set and set correctly to save in db
118     if(empty($feedback->openenable)) {
119         $feedback->timeopen = 0;
120     }
121     if(empty($feedback->closeenable)) {
122         $feedback->timeclose = 0;
123     }
124     if(empty($feedback->site_after_submit)) {
125         $feedback->site_after_submit = '';
126     }
128     //save the feedback into the db
129     $DB->update_record("feedback", $feedback);
131     //create or update the new events
132     feedback_set_events($feedback);
134     return true;
137 /**
138  * Serves the files included in feedback items like label. Implements needed access control ;-)
139  *
140  * @param object $course
141  * @param object $cm
142  * @param object $context
143  * @param string $filearea
144  * @param array $args
145  * @param bool $forcedownload
146  * @return bool false if file not found, does not return if found - justsend the file
147  */
148 function feedback_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
149     global $CFG, $DB;
151     require_login($course, false, $cm);
153     $itemid = (int)array_shift($args);
155     require_course_login($course, true, $cm);
157     if (!$item = $DB->get_record('feedback_item', array('id'=>$itemid))) {
158         return false;
159     }
161     if (!has_capability('mod/feedback:view', $context)) {
162         return false;
163     }
165     if ($context->contextlevel == CONTEXT_MODULE) {
166         if ($filearea !== 'item') {
167             return false;
168         }
170         if ($item->feedback == $cm->instance) {
171             $filecontext = $context;
172         } else {
173             return false;
174         }
175     }
177     if ($context->contextlevel == CONTEXT_COURSE) {
178         if ($filearea !== 'template') {
179             return false;
180         }
181     }
183     $relativepath = implode('/', $args);
184     $fullpath = "/$context->id/mod_feedback/$filearea/$itemid/$relativepath";
186     $fs = get_file_storage();
187     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
188         return false;
189     }
191     // finally send the file
192     send_stored_file($file, 0, 0, true); // download MUST be forced - security!
194     return false;
198 /**
199  * this will delete a given instance.
200  * all referenced data also will be deleted
201  *
202  * @global object
203  * @param int $id the instanceid of feedback
204  * @return boolean
205  */
206 function feedback_delete_instance($id) {
207     global $DB;
209     //get all referenced items
210     $feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$id));
212     //deleting all referenced items and values
213     if (is_array($feedbackitems)){
214         foreach($feedbackitems as $feedbackitem){
215             $DB->delete_records("feedback_value", array("item"=>$feedbackitem->id));
216             $DB->delete_records("feedback_valuetmp", array("item"=>$feedbackitem->id));
217         }
218         if($delitems = $DB->get_records("feedback_item", array("feedback"=>$id))) {
219             foreach($delitems as $delitem) {
220                 feedback_delete_item($delitem->id, false);
221             }
222         }
223     }
225     //deleting the referenced tracking data
226     $DB->delete_records('feedback_tracking', array('feedback'=>$id));
228     //deleting the completeds
229     $DB->delete_records("feedback_completed", array("feedback"=>$id));
231     //deleting the unfinished completeds
232     $DB->delete_records("feedback_completedtmp", array("feedback"=>$id));
234     //deleting old events
235     $DB->delete_records('event', array('modulename'=>'feedback', 'instance'=>$id));
236     return $DB->delete_records("feedback", array("id"=>$id));
239 /**
240  * this is called after deleting all instances if the course will be deleted.
241  * only templates have to be deleted
242  *
243  * @global object
244  * @param object $course
245  * @return boolean
246  */
247 function feedback_delete_course($course) {
248     global $DB;
250     //delete all templates of given course
251     return $DB->delete_records('feedback_template', array('course'=>$course->id));
254 /**
255  * Return a small object with summary information about what a
256  * user has done with a given particular instance of this module
257  * Used for user activity reports.
258  * $return->time = the time they did it
259  * $return->info = a short text description
260  *
261  * @param object $course
262  * @param object $user
263  * @param object $mod
264  * @param object $feedback
265  * @return object
266  */
267 function feedback_user_outline($course, $user, $mod, $feedback) {
268     return null;
271 /**
272  * Returns all users who has completed a specified feedback since a given time
273  * many thanks to Manolescu Dorel, who contributed these two functions
274  *
275  * @global object
276  * @global object
277  * @global object
278  * @global object
279  * @uses CONTEXT_MODULE
280  * @param array $activities Passed by reference
281  * @param int $index Passed by reference
282  * @param int $timemodified Timestamp
283  * @param int $courseid
284  * @param int $cmid
285  * @param int $userid
286  * @param int $groupid
287  * @return void
288  */
289 function feedback_get_recent_mod_activity(&$activities, &$index, $timemodified, $courseid, $cmid, $userid="", $groupid="")  {
290     global $CFG, $COURSE, $USER, $DB;
292     if ($COURSE->id == $courseid) {
293         $course = $COURSE;
294     } else {
295         $course = $DB->get_record('course', array('id'=>$courseid));
296     }
298     $modinfo =& get_fast_modinfo($course);
300     $cm = $modinfo->cms[$cmid];
302     $sqlargs = array();
304     //TODO: user user_picture::fields;
305     $sql = " SELECT fk . * , fc . * , u.firstname, u.lastname, u.email, u.picture, u.email
306                                             FROM {feedback_completed} fc
307                                                 JOIN {feedback} fk ON fk.id = fc.feedback
308                                                 JOIN {user} u ON u.id = fc.userid ";
310     if ($groupid) {
311         $sql .= " JOIN {groups_members} gm ON  gm.userid=u.id ";
312     }
314     $sql .= " WHERE fc.timemodified > ? AND fk.id = ? ";
315     $sqlargs[] = $timemodified;
316     $sqlargs[] = $cm->instace;
318     if ($userid) {
319         $sql .= " AND u.id = ? ";
320         $sqlargs[] = $userid;
321     }
323     if ($groupid) {
324         $sql .= " AND gm.groupid = ? ";
325         $sqlargs[] = $groupid;
326     }
328     if (!$feedbackitems = $DB->get_records_sql($sql, $sqlargs)) {
329         return;
330     }
332     $cm_context      = get_context_instance(CONTEXT_MODULE, $cm->id);
333     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
334     $viewfullnames   = has_capability('moodle/site:viewfullnames', $cm_context);
335     $groupmode       = groups_get_activity_groupmode($cm, $course);
337     if (is_null($modinfo->groups)) {
338         $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
339     }
341     $aname = format_string($cm->name,true);
342     foreach ($feedbackitems as $feedbackitem) {
343         if ($feedbackitem->userid != $USER->id) {
345             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
346                 $usersgroups = groups_get_all_groups($course->id, $feedbackitem->userid, $cm->groupingid);
347                 if (!is_array($usersgroups)) {
348                     continue;
349                 }
350                 $usersgroups = array_keys($usersgroups);
351                 $intersect = array_intersect($usersgroups, $modinfo->groups[$cm->id]);
352                 if (empty($intersect)) {
353                     continue;
354                 }
355             }
356        }
358         $tmpactivity = new stdClass();
360         $tmpactivity->type      = 'feedback';
361         $tmpactivity->cmid      = $cm->id;
362         $tmpactivity->name      = $aname;
363         $tmpactivity->sectionnum= $cm->sectionnum;
364         $tmpactivity->timestamp = $feedbackitem->timemodified;
366         $tmpactivity->content->feedbackid = $feedbackitem->id;
367         $tmpactivity->content->feedbackuserid = $feedbackitem->userid;
369         //TODO: add all necessary user fields, this is not enough for user_picture
370         $tmpactivity->user->userid   = $feedbackitem->userid;
371         $tmpactivity->user->fullname = fullname($feedbackitem, $viewfullnames);
372         $tmpactivity->user->picture  = $feedbackitem->picture;
374         $activities[$index++] = $tmpactivity;
375     }
377   return;
380 /**
381  * Prints all users who has completed a specified feedback since a given time
382  * many thanks to Manolescu Dorel, who contributed these two functions
383  *
384  * @global object
385  * @param object $activity
386  * @param int $courseid
387  * @param string $detail
388  * @param array $modnames
389  * @return void Output is echo'd
390  */
391 function feedback_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
392     global $CFG, $OUTPUT;
394     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
396     echo "<tr><td class=\"userpicture\" valign=\"top\">";
397     echo $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid));
398     echo "</td><td>";
400     if ($detail) {
401         $modname = $modnames[$activity->type];
402         echo '<div class="title">';
403         echo "<img src=\"" . $OUTPUT->pix_url('icon', $activity->type) . "\" ".
404              "class=\"icon\" alt=\"$modname\" />";
405         echo "<a href=\"$CFG->wwwroot/mod/feedback/view.php?id={$activity->cmid}\">{$activity->name}</a>";
406         echo '</div>';
407     }
409     echo '<div class="title">';
410     echo '</div>';
412     echo '<div class="user">';
413     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->userid}&amp;course=$courseid\">"
414          ."{$activity->user->fullname}</a> - ".userdate($activity->timestamp);
415     echo '</div>';
417     echo "</td></tr></table>";
419     return;
422 /**
423  * Obtains the automatic completion state for this feedback based on the condition
424  * in feedback settings.
425  *
426  * @param object $course Course
427  * @param object $cm Course-module
428  * @param int $userid User ID
429  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
430  * @return bool True if completed, false if not, $type if conditions not set.
431  */
432 function feedback_get_completion_state($course, $cm, $userid, $type) {
433     global $CFG, $DB;
435     // Get feedback details
436     $feedback = $DB->get_record('feedback', array('id'=>$cm->instance), '*', MUST_EXIST);
438     // If completion option is enabled, evaluate it and return true/false
439     if($feedback->completionsubmit) {
440         return $DB->record_exists('feedback_tracking', array('userid'=>$userid, 'feedback'=>$feedback->id));
441     } else {
442         // Completion option is not enabled so just return $type
443         return $type;
444     }
448 /**
449  * Print a detailed representation of what a  user has done with
450  * a given particular instance of this module, for user activity reports.
451  *
452  * @param object $course
453  * @param object $user
454  * @param object $mod
455  * @param object $feedback
456  * @return bool
457  */
458 function feedback_user_complete($course, $user, $mod, $feedback) {
459     return true;
462 /**
463  * @return bool true
464  */
465 function feedback_cron () {
466     return true;
469 /**
470  * @return bool false
471  */
472 function feedback_get_participants($feedbackid) {
473     return false;
477 /**
478  * @return bool false
479  */
480 function feedback_scale_used ($feedbackid,$scaleid) {
481     return false;
484 /**
485  * Checks if scale is being used by any instance of feedback
486  *
487  * This is used to find out if scale used anywhere
488  * @param $scaleid int
489  * @return boolean True if the scale is used by any assignment
490  */
491 function feedback_scale_used_anywhere($scaleid) {
492     return false;
495 /**
496  * This function is used by the reset_course_userdata function in moodlelib.
497  * This function will remove all responses from the specified feedback
498  * and clean up any related data.
499  *
500  * @global object
501  * @global object
502  * @uses FEEDBACK_RESETFORM_RESET
503  * @uses FEEDBACK_RESETFORM_DROP
504  * @param object $data the data submitted from the reset course.
505  * @return array status array
506  */
507 function feedback_reset_userdata($data) {
508     global $CFG, $DB;
510     $resetfeedbacks = array();
511     $dropfeedbacks = array();
512     $status = array();
513     $componentstr = get_string('modulenameplural', 'feedback');
515     //get the relevant entries from $data
516     foreach($data as $key => $value) {
517         switch(true) {
518             case substr($key, 0, strlen(FEEDBACK_RESETFORM_RESET)) == FEEDBACK_RESETFORM_RESET:
519                 if($value == 1) {
520                     $templist = explode('_', $key);
521                     if(isset($templist[3]))$resetfeedbacks[] = intval($templist[3]);
522                 }
523             break;
524             case substr($key, 0, strlen(FEEDBACK_RESETFORM_DROP)) == FEEDBACK_RESETFORM_DROP:
525                 if($value == 1) {
526                     $templist = explode('_', $key);
527                     if(isset($templist[3]))$dropfeedbacks[] = intval($templist[3]);
528                 }
529             break;
530         }
531     }
533     //reset the selected feedbacks
534     foreach($resetfeedbacks as $id) {
535         $feedback = $DB->get_record('feedback', array('id'=>$id));
536         feedback_delete_all_completeds($id);
537         $status[] = array('component'=>$componentstr.':'.$feedback->name, 'item'=>get_string('resetting_data','feedback'), 'error'=>false);
538     }
540     //drop the selected feedbacks
541     // foreach($dropfeedbacks as $id) {
542         // $cm = get_coursemodule_from_instance('feedback', $id);
543         // feedback_delete_instance($id);
544         // feedback_delete_course_module($cm->id);
545         // $status[] = array('component'=>$componentstr, 'item'=>get_string('drop_feedback','feedback'), 'error'=>false);
546     // }
547     return $status;
550 /**
551  * Called by course/reset.php
552  *
553  * @global object
554  * @uses FEEDBACK_RESETFORM_RESET
555  * @param object $mform form passed by reference
556  */
557 function feedback_reset_course_form_definition(&$mform) {
558     global $COURSE, $DB;
560     $mform->addElement('header', 'feedbackheader', get_string('modulenameplural', 'feedback'));
562     if(!$feedbacks = $DB->get_records('feedback', array('course'=>$COURSE->id), 'name')){
563         return;
564     }
566     $mform->addElement('static', 'hint', get_string('resetting_data','feedback'));
567     foreach($feedbacks as $feedback) {
568         $mform->addElement('checkbox', FEEDBACK_RESETFORM_RESET.$feedback->id, $feedback->name);
569         // $mform->addElement('checkbox', FEEDBACK_RESETFORM_DROP.$feedback->id, get_string('drop_feedback','feedback'));
570     }
573 /**
574  * Course reset form defaults.
575  *
576  * @global object
577  * @uses FEEDBACK_RESETFORM_RESET
578  * @param object $course
579  */
580 function feedback_reset_course_form_defaults($course) {
581     global $DB;
583     $return = array();
584     if(!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')){
585         return;
586     }
587     foreach($feedbacks as $feedback) {
588         $return[FEEDBACK_RESETFORM_RESET.$feedback->id] = true;
589         // $return[FEEDBACK_RESETFORM_DROP.$feedback->id] = false;
590     }
591     return $return;
594 /**
595  * Called by course/reset.php and shows the formdata by coursereset.
596  * it prints checkboxes for each feedback available at the given course
597  * there are two checkboxes: 1) delete userdata and keep the feedback 2) delete userdata and drop the feedback
598  *
599  * @global object
600  * @uses FEEDBACK_RESETFORM_RESET
601  * @uses FEEDBACK_RESETFORM_DROP
602  * @param object $course
603  * @return void
604  */
605 function feedback_reset_course_form($course) {
606     global $DB, $OUTPUT;
608     echo get_string('resetting_feedbacks', 'feedback'); echo ':<br />';
609     if (!$feedbacks = $DB->get_records('feedback', array('course'=>$course->id), 'name')) {
610         return;
611     }
613     foreach($feedbacks as $feedback) {
614         echo '<p>';
615         echo get_string('name','feedback').': '.$feedback->name.'<br />';
616         echo html_writer::checkbox(FEEDBACK_RESETFORM_RESET.$feedback->id, 1, true, get_string('resetting_data','feedback'));
617         echo '<br />';
618         echo html_writer::checkbox(FEEDBACK_RESETFORM_DROP.$feedback->id, 1, false, get_string('drop_feedback','feedback'));
619         echo '</p>';
620     }
623 /**
624  * This creates new events given as timeopen and closeopen by $feedback.
625  *
626  * @global object
627  * @param object $feedback
628  * @return void
629  */
630 function feedback_set_events($feedback) {
631     global $DB;
633     // adding the feedback to the eventtable (I have seen this at quiz-module)
634     $DB->delete_records('event', array('modulename'=>'feedback', 'instance'=>$feedback->id));
636     if (!isset($feedback->coursemodule)) {
637         $cm = get_coursemodule_from_id('feedback', $feedback->id);
638         $feedback->coursemodule = $cm->id;
639     }
641     // the open-event
642     if($feedback->timeopen > 0) {
643         $event = NULL;
644         $event->name         = get_string('start', 'feedback').' '.$feedback->name;
645         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
646         $event->courseid     = $feedback->course;
647         $event->groupid      = 0;
648         $event->userid       = 0;
649         $event->modulename   = 'feedback';
650         $event->instance     = $feedback->id;
651         $event->eventtype    = 'open';
652         $event->timestart    = $feedback->timeopen;
653         $event->visible      = instance_is_visible('feedback', $feedback);
654         if($feedback->timeclose > 0) {
655             $event->timeduration = ($feedback->timeclose - $feedback->timeopen);
656         } else {
657             $event->timeduration = 0;
658         }
660         calendar_event::create($event);
661     }
663     // the close-event
664     if($feedback->timeclose > 0) {
665         $event = NULL;
666         $event->name         = get_string('stop', 'feedback').' '.$feedback->name;
667         $event->description  = format_module_intro('feedback', $feedback, $feedback->coursemodule);
668         $event->courseid     = $feedback->course;
669         $event->groupid      = 0;
670         $event->userid       = 0;
671         $event->modulename   = 'feedback';
672         $event->instance     = $feedback->id;
673         $event->eventtype    = 'close';
674         $event->timestart    = $feedback->timeclose;
675         $event->visible      = instance_is_visible('feedback', $feedback);
676         $event->timeduration = 0;
678         calendar_event::create($event);
679     }
682 /**
683  *  this function is called by {@link feedback_delete_userdata()}
684  *  it drops the feedback-instance from the course_module table
685  *
686  * @global object
687  *  @param int $id the id from the coursemodule
688  *  @return boolean
689  */
690 function feedback_delete_course_module($id) {
691     global $DB;
693     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
694         return true;
695     }
696     return $DB->delete_records('course_modules', array('id'=>$cm->id));
701 ////////////////////////////////////////////////
702 //functions to handle capabilities
703 ////////////////////////////////////////////////
705 /**
706  *  returns the context-id related to the given coursemodule-id
707  *
708  * @staticvar object $context
709  *  @param int $cmid the coursemodule-id
710  *  @return object $context
711  */
712 function feedback_get_context($cmid) {
713     static $context;
715     if(isset($context)) return $context;
717     if (!$context = get_context_instance(CONTEXT_MODULE, $cmid)) {
718             print_error('badcontext');
719     }
720     return $context;
723 /**
724  *  returns true if the current role is faked by switching role feature
725  *
726  * @global object
727  *  @return boolean
728  */
729 function feedback_check_is_switchrole(){
730     global $USER;
731     if(isset($USER->switchrole) AND is_array($USER->switchrole) AND count($USER->switchrole) > 0) {
732         return true;
733     }
734     return false;
737 /**
738  * count users which have not completed the feedback
739  *
740  * @global object
741  * @uses CONTEXT_MODULE
742  * @param object $cm
743  * @param int $group single groupid
744  * @param string $sort
745  * @param int $startpage
746  * @param int $pagecount
747  * @return object the userrecords
748  */
749 function feedback_get_incomplete_users($cm, $group = false, $sort = '', $startpage = false, $pagecount = false) {
750     global $DB;
752     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
754     //first get all user who can complete this feedback
755     $cap = 'mod/feedback:complete';
756     $fields = 'u.id, u.username';
757     if(!$allusers = get_users_by_capability($context, $cap, $fields, $sort, '', '', $group, '', true)) {
758         return false;
759     }
760     $allusers = array_keys($allusers);
762     //now get all completeds
763     if(!$completedusers = $DB->get_records_menu('feedback_completed', array('feedback'=>$cm->instance), '', 'userid,id')){
764         return $allusers;
765     }
766     $completedusers = array_keys($completedusers);
768     //now strike all completedusers from allusers
769     $allusers = array_diff($allusers, $completedusers);
771     //for paging I use array_slice()
772     if($startpage !== false AND $pagecount !== false) {
773         $allusers = array_slice($allusers, $startpage, $pagecount);
774     }
776     return $allusers;
779 /**
780  * count users which have not completed the feedback
781  *
782  * @global object
783  * @param object $cm
784  * @param int $group single groupid
785  * @return int count of userrecords
786  */
787 function feedback_count_incomplete_users($cm, $group = false) {
788     if($allusers = feedback_get_incomplete_users($cm, $group)) {
789         return count($allusers);
790     }
791     return 0;
794 /**
795  * count users which have completed a feedback
796  *
797  * @global object
798  * @uses FEEDBACK_ANONYMOUS_NO
799  * @param object $cm
800  * @param int $group single groupid
801  * @return int count of userrecords
802  */
803 function feedback_count_complete_users($cm, $group = false) {
804     global $DB;
806     $params = array(FEEDBACK_ANONYMOUS_NO, $cm->instance);
808     $fromgroup = '';
809     $wheregroup = '';
810     if($group) {
811         $fromgroup = ', {groups_members} g';
812         $wheregroup = ' AND g.groupid = ? AND g.userid = c.userid';
813         $params[] = $group;
814     }
816     $sql = 'SELECT COUNT(u.id) FROM {user} u, {feedback_completed} c'.$fromgroup.'
817               WHERE anonymous_response = ? AND u.id = c.userid AND c.feedback = ?
818               '.$wheregroup;
819               ;
821     return $DB->count_records_sql($sql, $params);
825 /**
826  * get users which have completed a feedback
827  *
828  * @global object
829  * @uses CONTEXT_MODULE
830  * @uses FEEDBACK_ANONYMOUS_NO
831  * @param object $cm
832  * @param int $group single groupid
833  * @param string $where a sql where condition (must end with " AND ")
834  * @param array parameters used in $where
835  * @param string $sort a table field
836  * @param int $startpage
837  * @param int $pagecount
838  * @return object the userrecords
839  */
840 function feedback_get_complete_users($cm, $group = false, $where = '', array $params = NULL, $sort = '', $startpage = false, $pagecount = false) {
841     global $DB;
843     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
844             print_error('badcontext');
845     }
847     $params = (array)$params;
849     $params['anon'] = FEEDBACK_ANONYMOUS_NO;
850     $params['instance'] = $cm->instance;
852     $fromgroup = '';
853     $wheregroup = '';
854     if ($group) {
855         $fromgroup = ', {groups_members} g';
856         $wheregroup = ' AND g.groupid = :group AND g.userid = c.userid';
857         $params['group'] = $group;
858     }
860     if ($sort) {
861         $sortsql = ' ORDER BY '.$sort;
862     } else {
863         $sortsql = '';
864     }
866     $ufields = user_picture::fields('u');
867     $sql = 'SELECT DISTINCT '.$ufields.' FROM {user} u, {feedback_completed} c '.$fromgroup.'
868               WHERE '.$where.' anonymous_response = :anon AND u.id = c.userid AND c.feedback = :instance
869               '.$wheregroup.$sortsql;
871     if ($startpage === false OR $pagecount === false) {
872         $startpage = false;
873         $pagecount = false;
874     }
875     return $DB->get_records_sql($sql, $params, $startpage, $pagecount);
878 /**
879  * get users which have the viewreports-capability
880  *
881  * @uses CONTEXT_MODULE
882  * @param int $cmid
883  * @param mixed $groups single groupid or array of groupids - group(s) user is in
884  * @return object the userrecords
885  */
886 function feedback_get_viewreports_users($cmid, $groups = false) {
888     if (!$context = get_context_instance(CONTEXT_MODULE, $cmid)) {
889             print_error('badcontext');
890     }
892     //description of the call below: get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='', $limitnum='', $groups='', $exceptions='', $doanything=true)
893     return get_users_by_capability($context, 'mod/feedback:viewreports', '', 'lastname', '', '', $groups, '', false);
896 /**
897  * get users which have the receivemail-capability
898  *
899  * @uses CONTEXT_MODULE
900  * @param int $cmid
901  * @param mixed $groups single groupid or array of groupids - group(s) user is in
902  * @return object the userrecords
903  */
904 function feedback_get_receivemail_users($cmid, $groups = false) {
906     if (!$context = get_context_instance(CONTEXT_MODULE, $cmid)) {
907             print_error('badcontext');
908     }
910     //description of the call below: get_users_by_capability($context, $capability, $fields='', $sort='', $limitfrom='', $limitnum='', $groups='', $exceptions='', $doanything=true)
911     return get_users_by_capability($context, 'mod/feedback:receivemail', '', 'lastname', '', '', $groups, '', false);
914 ////////////////////////////////////////////////
915 //functions to handle the templates
916 ////////////////////////////////////////////////
917 ////////////////////////////////////////////////
919 /**
920  * creates a new template-record.
921  *
922  * @global object
923  * @param int $courseid
924  * @param string $name the name of template shown in the templatelist
925  * @param int $ispublic 0:privat 1:public
926  * @return int the new templateid
927  */
928 function feedback_create_template($courseid, $name, $ispublic = 0) {
929     global $DB;
931     $templ = new stdClass();
932     $templ->course   = $courseid;
933     $templ->name     = $name;
934     $templ->ispublic = $ispublic;
936     $templid = $DB->insert_record('feedback_template', $templ);
937     return $DB->get_record('feedback_template', array('id'=>$templid));
940 /**
941  * creates new template items.
942  * all items will be copied and the attribute feedback will be set to 0
943  * and the attribute template will be set to the new templateid
944  *
945  * @global object
946  * @uses CONTEXT_MODULE
947  * @uses CONTEXT_COURSE
948  * @param object $feedback
949  * @param string $name the name of template shown in the templatelist
950  * @param int $ispublic 0:privat 1:public
951  * @return boolean
952  */
953 function feedback_save_as_template($feedback, $name, $ispublic = 0) {
954     global $DB;
955     $fs = get_file_storage();
957     if (!$feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
958         return false;
959     }
961     if (!$newtempl = feedback_create_template($feedback->course, $name, $ispublic)) {
962         return false;
963     }
965     //files in the template_item are in the context of the current course
966     //files in the feedback_item are in the feedback_context of the feedback
967     $c_context = get_context_instance(CONTEXT_COURSE, $newtempl->course);
968     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
969     $f_context = get_context_instance(CONTEXT_MODULE, $cm->id);
971     //create items of this new template
972     //depend items we are storing temporary in an mapping list array(new id => dependitem)
973     //we also store a mapping of all items array(oldid => newid)
974     $dependitemsmap = array();
975     $itembackup = array();
976     foreach($feedbackitems as $item) {
978         $t_item = clone($item);
980         unset($t_item->id);
981         $t_item->feedback = 0;
982         $t_item->template     = $newtempl->id;
983         $t_item->id = $DB->insert_record('feedback_item', $t_item);
984         //copy all included files to the feedback_template filearea
985         if ($itemfiles = $fs->get_area_files($f_context->id, 'mod_feedback', 'item', $item->id, "id", false)) {
986             foreach($itemfiles as $ifile) {
987                 $file_record = new stdClass();
988                 $file_record->contextid = $c_context->id;
989                 $file_record->component = 'mod_feedback';
990                 $file_record->filearea = 'template';
991                 $file_record->itemid = $t_item->id;
992                 $fs->create_file_from_storedfile($file_record, $ifile);
993             }
994         }
996         $itembackup[$item->id] = $t_item->id;
997         if($t_item->dependitem) {
998             $dependitemsmap[$t_item->id] = $t_item->dependitem;
999         }
1001     }
1003     //remapping the dependency
1004     foreach($dependitemsmap as $key => $dependitem) {
1005         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1006         $newitem->dependitem = $itembackup[$newitem->dependitem];
1007         $DB->update_record('feedback_item', $newitem);
1008     }
1010     return true;
1013 /**
1014  * deletes all feedback_items related to the given template id
1015  *
1016  * @global object
1017  * @uses CONTEXT_COURSE
1018  * @param int $id the templateid
1019  * @return void
1020  */
1021 function feedback_delete_template($id) {
1022     global $DB;
1024     $template = $DB->get_record("feedback_template", array("id"=>$id));
1026     //deleting the files from the item
1027     $fs = get_file_storage();
1028     $context = get_context_instance(CONTEXT_COURSE, $template->course);
1031     if($t_items = $DB->get_records("feedback_item", array("template"=>$id))) {
1032         foreach($t_items as $t_item) {
1033             if ($templatefiles = $fs->get_area_files($context->id, 'mod_feedback', 'template', $t_item->id, "id", false)) {
1034                 $fs->delete_area_files($context->id, 'mod_feedback', 'template', $t_item->id);
1035             }
1036         }
1037     }
1038     $DB->delete_records("feedback_template", array("id"=>$id));
1041 /**
1042  * creates new feedback_item-records from template.
1043  * if $deleteold is set true so the existing items of the given feedback will be deleted
1044  * if $deleteold is set false so the new items will be appanded to the old items
1045  *
1046  * @global object
1047  * @uses CONTEXT_COURSE
1048  * @uses CONTEXT_MODULE
1049  * @param object $feedback
1050  * @param int $templateid
1051  * @param boolean $deleteold
1052  */
1053 function feedback_items_from_template($feedback, $templateid, $deleteold = false) {
1054     global $DB, $CFG;
1056     require_once($CFG->libdir.'/completionlib.php');
1058     $fs = get_file_storage();
1060     //get all templateitems
1061     if(!$templitems = $DB->get_records('feedback_item', array('template'=>$templateid))) {
1062         return false;
1063     }
1065     //files in the template_item are in the context of the current course
1066     //files in the feedback_item are in the feedback_context of the feedback
1067     $c_context = get_context_instance(CONTEXT_COURSE, $feedback->course);
1068     $course = $DB->get_record('course', array('id'=>$feedback->course));
1069     $cm = get_coursemodule_from_instance('feedback', $feedback->id);
1070     $f_context = get_context_instance(CONTEXT_MODULE, $cm->id);
1072     //if deleteold then delete all old items before
1073     //get all items
1074     if($deleteold) {
1075         if($feedbackitems = $DB->get_records('feedback_item', array('feedback'=>$feedback->id))) {
1076             //delete all items of this feedback
1077             foreach($feedbackitems as $item) {
1078                 feedback_delete_item($item->id, false);
1079             }
1080             //delete tracking-data
1081             $DB->delete_records('feedback_tracking', array('feedback'=>$feedback->id));
1083             if($completeds = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
1084                 $completion = new completion_info($course);
1085                 foreach($completeds as $completed) {
1086                     // Update completion state
1087                     if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
1088                         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1089                     }
1090                     $DB->delete_records('feedback_completed', array('id'=>$completed->id));
1091                 }
1092             }
1093             $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedback->id));
1094         }
1095         $positionoffset = 0;
1096     } else {
1097         //if the old items are kept the new items will be appended
1098         //therefor the new position has an offset
1099         $positionoffset = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
1100     }
1102     //create items of this new template
1103     //depend items we are storing temporary in an mapping list array(new id => dependitem)
1104     //we also store a mapping of all items array(oldid => newid)
1105     $dependitemsmap = array();
1106     $itembackup = array();
1107     foreach($templitems as $t_item) {
1108         $item = clone($t_item);
1109         unset($item->id);
1110         $item->feedback = $feedback->id;
1111         $item->template = 0;
1112         $item->position = $item->position + $positionoffset;
1114         $item->id = $DB->insert_record('feedback_item', $item);
1116         //TODO: moving the files to the new items
1117         if ($templatefiles = $fs->get_area_files($c_context->id, 'mod_feedback', 'template', $t_item->id, "id", false)) {
1118             foreach($templatefiles as $tfile) {
1119                 $file_record = new stdClass();
1120                 $file_record->contextid = $f_context->id;
1121                 $file_record->component = 'mod_feedback';
1122                 $file_record->filearea = 'item';
1123                 $file_record->itemid = $item->id;
1124                 $fs->create_file_from_storedfile($file_record, $tfile);
1125             }
1126         }
1128         $itembackup[$t_item->id] = $item->id;
1129         if($item->dependitem) {
1130             $dependitemsmap[$item->id] = $item->dependitem;
1131         }
1132     }
1134     //remapping the dependency
1135     foreach($dependitemsmap as $key => $dependitem) {
1136         $newitem = $DB->get_record('feedback_item', array('id'=>$key));
1137         $newitem->dependitem = $itembackup[$newitem->dependitem];
1138         $DB->update_record('feedback_item', $newitem);
1139     }
1142 /**
1143  * get the list of available templates.
1144  * if the $onlyown param is set true so only templates from own course will be served
1145  * this is important for droping templates
1146  *
1147  * @global object
1148  * @param object $course
1149  * @param boolean $onlyown
1150  * @return array the template recordsets
1151  */
1152 function feedback_get_template_list($course, $onlyown = false) {
1153     global $DB;
1155     if ($onlyown) {
1156         $templates = $DB->get_records('feedback_template', array('course'=>$course->id));
1157     } else {
1158         $templates = $DB->get_records_select('feedback_template', 'course = ? OR ispublic = 1', array($course->id));
1159     }
1160     return $templates;
1163 ////////////////////////////////////////////////
1164 //Handling der Items
1165 ////////////////////////////////////////////////
1166 ////////////////////////////////////////////////
1168 /**
1169  * load the lib.php from item-plugin-dir and returns the instance of the itemclass
1170  *
1171  * @global object
1172  * @param object $item
1173  * @return object the instanz of itemclass
1174  */
1175 function feedback_get_item_class($typ) {
1176     global $CFG;
1178     //get the class of item-typ
1179     $itemclass = 'feedback_item_'.$typ;
1180     //get the instance of item-class
1181     if (!class_exists($itemclass)) {
1182         require_once($CFG->dirroot.'/mod/feedback/item/'.$typ.'/lib.php');
1183     }
1184     return new $itemclass();
1187 /**
1188  * load the available item plugins from given subdirectory of $CFG->dirroot
1189  * the default is "mod/feedback/item"
1190  *
1191  * @global object
1192  * @param string $dir the subdir
1193  * @return array pluginnames as string
1194  */
1195 function feedback_load_feedback_items($dir = 'mod/feedback/item') {
1196     global $CFG;
1197     $names = get_list_of_plugins($dir);
1198     $ret_names = array();
1200     foreach($names as $name) {
1201         require_once($CFG->dirroot.'/'.$dir.'/'.$name.'/lib.php');
1202         if(class_exists('feedback_item_'.$name)) {
1203           $ret_names[] = $name;
1204         }
1205     }
1206     return $ret_names;
1209 /**
1210  * load the available item plugins to use as dropdown-options
1211  *
1212  * @global object
1213  * @return array pluginnames as string
1214  */
1215 function feedback_load_feedback_items_options() {
1216     global $CFG;
1218     $feedback_options = array("pagebreak" => get_string('add_pagebreak', 'feedback'));
1220     if (!$feedback_names = feedback_load_feedback_items('mod/feedback/item')) {
1221         return array();
1222     }
1224     foreach($feedback_names as $fn) {
1225         $feedback_options[$fn] = get_string($fn,'feedback');
1226     }
1227     asort($feedback_options);
1228     $feedback_options = array_merge( array(' ' => get_string('select')), $feedback_options );
1229     return $feedback_options;
1232 /**
1233  * load the available items for the depend item dropdown list shown in the edit_item form
1234  *
1235  * @global object
1236  * @param object $feedback
1237  * @param object $item the item of the edit_item form
1238  * @return array all items except the item $item, labels and pagebreaks
1239  */
1240 function feedback_get_depend_candidates_for_item($feedback, $item) {
1241     global $DB;
1242     //all items for dependitem
1243     $where = "feedback = ? AND typ != 'pagebreak' AND hasvalue = 1";
1244     $params = array($feedback->id);
1245     if(isset($item->id) AND $item->id) {
1246         $where .= ' AND id != ?';
1247         $params[] = $item->id;
1248     }
1249     $dependitems = array(0 => get_string('choose'));
1250     if(!$feedbackitems = $DB->get_records_select_menu('feedback_item', $where, $params, 'position', 'id, label')) {
1251         return $dependitems;
1252     }
1253     //adding the choose-option
1254     foreach($feedbackitems as $key=>$val) {
1255         $dependitems[$key] = $val;
1256     }
1257     return $dependitems;
1260 /**
1261  * creates a new item-record
1262  *
1263  * @global object
1264  * @param object $data the data from edit_item_form
1265  * @return int the new itemid
1266  */
1267 function feedback_create_item($data) {
1268     global $DB;
1270     $item = new stdClass();
1271     $item->feedback = $data->feedbackid;
1273     $item->template=0;
1274     if (isset($data->templateid)) {
1275             $item->template = intval($data->templateid);
1276     }
1278     $itemname = trim($data->itemname);
1279     $item->name = ($itemname ? $data->itemname : get_string('no_itemname', 'feedback'));
1281     if (!empty($data->itemlabel)) {
1282         $item->label = trim($data->itemlabel);
1283     } else {
1284         $item->label = get_string('no_itemlabel', 'feedback');
1285     }
1287     $itemobj = feedback_get_item_class($data->typ);
1288     // $item->presentation = $itemobj->get_presentation($data);
1289     $item->presentation = ''; //the date comes from postupdate() of the itemobj
1291     $item->hasvalue = $itemobj->get_hasvalue();
1293     $item->typ = $data->typ;
1294     $item->position = $data->position;
1296     $item->required=0;
1297     if (!empty($data->required)) {
1298         $item->required = $data->required;
1299     }
1301     $item->id = $DB->insert_record('feedback_item', $item);
1303     //move all itemdata to the data
1304     $data->id = $item->id;
1305     $data->feedback = $item->feedback;
1306     $data->name = $item->name;
1307     $data->label = $item->label;
1308     $data->required = $item->required;
1309     return $itemobj->postupdate($data);
1312 /**
1313  * save the changes of a given item.
1314  *
1315  * @global object
1316  * @param object $item
1317  * @return boolean
1318  */
1319 function feedback_update_item($item){
1320     global $DB;
1321     return $DB->update_record("feedback_item", $item);
1324 /**
1325  * deletes an item and also deletes all related values
1326  *
1327  * @global object
1328  * @uses CONTEXT_MODULE
1329  * @param int $itemid
1330  * @param boolean $renumber should the kept items renumbered Yes/No
1331  * @return void
1332  */
1333 function feedback_delete_item($itemid, $renumber = true){
1334     global $DB;
1337     $item = $DB->get_record('feedback_item', array('id'=>$itemid));
1339     //deleting the files from the item
1340     $fs = get_file_storage();
1341     if (!$cm = get_coursemodule_from_instance('feedback', $item->feedback)) {
1342         return false;
1343     }
1344     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1346     if ($itemfiles = $fs->get_area_files($context->id, 'mod_feedback', 'item', $item->id, "id", false)) {
1347         $fs->delete_area_files($context->id, 'mod_feedback', 'item', $item->id);
1348     }
1350     $DB->delete_records("feedback_value", array("item"=>$itemid));
1351     $DB->delete_records("feedback_valuetmp", array("item"=>$itemid));
1353     //remove all depends
1354     $DB->set_field('feedback_item', 'dependvalue', '', array('dependitem'=>$itemid));
1355     $DB->set_field('feedback_item', 'dependitem', 0, array('dependitem'=>$itemid));
1357     $DB->delete_records("feedback_item", array("id"=>$itemid));
1358     if($renumber) {
1359         feedback_renumber_items($item->feedback);
1360     }
1363 /**
1364  * deletes all items of the given feedbackid
1365  *
1366  * @global object
1367  * @param int $feedbackid
1368  * @return void
1369  */
1370 function feedback_delete_all_items($feedbackid){
1371     global $DB, $CFG;
1372     require_once($CFG->libdir.'/completionlib.php');
1374     if(!$feedback = $DB->get_record('feedback', array('id'=>$feedbackid))) {
1375         return false;
1376     }
1378     if (!$cm = get_coursemodule_from_instance('feedback', $feedback->id)) {
1379         return false;
1380     }
1382     if(!$course = $DB->get_record('course', array('id'=>$feedback->course))) {
1383         return false;
1384     }
1386     if(!$items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid))) {
1387         return;
1388     }
1389     foreach($items as $item) {
1390         feedback_delete_item($item->id, false);
1391     }
1392     // $DB->delete_records('feedback_completed', array('feedback'=>$feedbackid));
1393     if($completeds = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
1394         $completion = new completion_info($course);
1395         foreach($completeds as $completed) {
1396             // Update completion state
1397             if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
1398                 $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
1399             }
1400             $DB->delete_records('feedback_completed', array('id'=>$completed->id));
1401         }
1402     }
1404     $DB->delete_records('feedback_completedtmp', array('feedback'=>$feedbackid));
1408 /**
1409  * this function toggled the item-attribute required (yes/no)
1410  *
1411  * @global object
1412  * @param object $item
1413  * @return boolean
1414  */
1415 function feedback_switch_item_required($item) {
1416     global $DB, $CFG;
1418     $itemobj = feedback_get_item_class($item->typ);
1420     if($itemobj->can_switch_require()) {
1421         $DB->set_field('feedback_item', 'required', (int)!(bool)$item->required, array('id'=>$item->id));
1422     }
1423     return true;
1426 /**
1427  * renumbers all items of the given feedbackid
1428  *
1429  * @global object
1430  * @param int $feedbackid
1431  * @return void
1432  */
1433 function feedback_renumber_items($feedbackid){
1434     global $DB;
1436     $items = $DB->get_records('feedback_item', array('feedback'=>$feedbackid), 'position');
1437     $pos = 1;
1438     if($items) {
1439         foreach($items as $item){
1440             $DB->set_field('feedback_item', 'position', $pos, array('id'=>$item->id));
1441             $pos++;
1442         }
1443     }
1446 /**
1447  * this decreases the position of the given item
1448  *
1449  * @global object
1450  * @param object $item
1451  * @return bool
1452  */
1453 function feedback_moveup_item($item){
1454     global $DB;
1456     if($item->position == 1) {
1457         return true;
1458     }
1460     if(!$items = $DB->get_records('feedback_item', array('feedback'=>$item->feedback), 'position')) {
1461         return false;
1462     }
1464     $itembefore = null;
1465     foreach($items as $i) {
1466         if($i->id == $item->id) {
1467             if(is_null($itembefore)) {
1468                 return true;
1469             }
1470             $itembefore->position = $item->position;
1471             $item->position--;
1472             feedback_update_item($itembefore);
1473             feedback_update_item($item);
1474             feedback_renumber_items($item->feedback);
1475             return true;
1476         }
1477         $itembefore = $i;
1478     }
1479     return false;
1482 /**
1483  * this increased the position of the given item
1484  *
1485  * @global object
1486  * @param object $item
1487  * @return bool
1488  */
1489 function feedback_movedown_item($item){
1490     global $DB;
1492     if(!$items = $DB->get_records('feedback_item', array('feedback'=>$item->feedback), 'position')) {
1493         return false;
1494     }
1496     $movedownitem = null;
1497     foreach($items as $i) {
1498         if(!is_null($movedownitem) AND $movedownitem->id == $item->id) {
1499             $movedownitem->position = $i->position;
1500             $i->position--;
1501             feedback_update_item($movedownitem);
1502             feedback_update_item($i);
1503             feedback_renumber_items($item->feedback);
1504             return true;
1505         }
1506         $movedownitem = $i;
1507     }
1508     return false;
1511 /**
1512  * here the position of the given item will be set to the value in $pos
1513  *
1514  * @global object
1515  * @param object $moveitem
1516  * @param int $pos
1517  * @return boolean
1518  */
1519 function feedback_move_item($moveitem, $pos){
1520     global $DB;
1522     if (!$allitems = $DB->get_records('feedback_item', array('feedback'=>$moveitem->feedback), 'position')) {
1523         return false;
1524     }
1525     if (is_array($allitems)) {
1526         $index = 1;
1527         foreach($allitems as $item) {
1528             if($index == $pos) {
1529                 $index++;
1530             }
1531             if($item->id == $moveitem->id) {
1532                 $moveitem->position = $pos;
1533                 feedback_update_item($moveitem);
1534                 continue;
1535             }
1536             $item->position = $index;
1537             feedback_update_item($item);
1538             $index++;
1539         }
1540         return true;
1541     }
1542     return false;
1545 /**
1546  * prints the given item as a preview.
1547  * each item-class has an own print_item_preview function implemented.
1548  *
1549  * @global object
1550  * @param object $item the item what we want to print out
1551  * @return void
1552  */
1553 function feedback_print_item_preview($item){
1554     global $CFG;
1555     if($item->typ == 'pagebreak') {
1556         return;
1557     }
1558     //get the instance of the item-class
1559     $itemobj = feedback_get_item_class($item->typ);
1560     $itemobj->print_item_preview($item);
1563 /**
1564  * prints the given item in the completion form.
1565  * each item-class has an own print_item_complete function implemented.
1566  *
1567  * @param object $item the item what we want to print out
1568  * @param mixed $value the value
1569  * @param boolean $highlightrequire if this set true and the value are false on completing so the item will be highlighted
1570  * @return void
1571  */
1572 function feedback_print_item_complete($item, $value = false, $highlightrequire = false){
1573     global $CFG;
1574     if($item->typ == 'pagebreak') {
1575         return;
1576     }
1578     //get the instance of the item-class
1579     $itemobj = feedback_get_item_class($item->typ);
1580     $itemobj->print_item_complete($item, $value, $highlightrequire);
1583 /**
1584  * prints the given item in the show entries page.
1585  * each item-class has an own print_item_show_value function implemented.
1586  *
1587  * @param object $item the item what we want to print out
1588  * @param mixed $value
1589  * @return void
1590  */
1591 function feedback_print_item_show_value($item, $value = false){
1592     global $CFG;
1593     if($item->typ == 'pagebreak') {
1594         return;
1595     }
1597     //get the instance of the item-class
1598     $itemobj = feedback_get_item_class($item->typ);
1599     $itemobj->print_item_show_value($item, $value);
1602 /**
1603  * if the user completes a feedback and there is a pagebreak so the values are saved temporary.
1604  * the values are not saved permanently until the user click on save button
1605  *
1606  * @global object
1607  * @param object $feedbackcompleted
1608  * @return object temporary saved completed-record
1609  */
1610 function feedback_set_tmp_values($feedbackcompleted) {
1611     global $DB;
1613     //first we create a completedtmp
1614     $tmpcpl = new stdClass();
1615     foreach($feedbackcompleted as $key => $value) {
1616         $tmpcpl->{$key} = $value;
1617     }
1618     // $tmpcpl = $feedbackcompleted;
1619     unset($tmpcpl->id);
1620     $tmpcpl->timemodified = time();
1621     $tmpcpl->id = $DB->insert_record('feedback_completedtmp', $tmpcpl);
1622     //get all values of original-completed
1623     if(!$values = $DB->get_records('feedback_value', array('completed'=>$feedbackcompleted->id))) {
1624         return;
1625     }
1626     foreach($values as $value) {
1627         unset($value->id);
1628         $value->completed = $tmpcpl->id;
1629         $DB->insert_record('feedback_valuetmp', $value);
1630     }
1631     return $tmpcpl;
1634 /**
1635  * this saves the temporary saved values permanently
1636  *
1637  * @global object
1638  * @param object $feedbackcompletedtmp the temporary completed
1639  * @param object $feedbackcompleted the target completed
1640  * @param int $userid
1641  * @return int the id of the completed
1642  */
1643 function feedback_save_tmp_values($feedbackcompletedtmp, $feedbackcompleted, $userid) {
1644     global $DB;
1646     $tmpcplid = $feedbackcompletedtmp->id;
1647     if($feedbackcompleted) {
1648         //first drop all existing values
1649         $DB->delete_records('feedback_value', array('completed'=>$feedbackcompleted->id));
1650         //update the current completed
1651         $feedbackcompleted->timemodified = time();
1652         $DB->update_record('feedback_completed', $feedbackcompleted);
1653     }else {
1654         $feedbackcompleted = clone($feedbackcompletedtmp);
1655         $feedbackcompleted->id = '';
1656         $feedbackcompleted->userid = $userid;
1657         $feedbackcompleted->timemodified = time();
1658         $feedbackcompleted->id = $DB->insert_record('feedback_completed', $feedbackcompleted);
1659     }
1661     //save all the new values from feedback_valuetmp
1662     //get all values of tmp-completed
1663     if(!$values = $DB->get_records('feedback_valuetmp', array('completed'=>$feedbackcompletedtmp->id))) {
1664         return false;
1665     }
1666     foreach($values as $value) {
1667         //check if there are depend items
1668         $item = $DB->get_record('feedback_item', array('id'=>$value->item));
1669         if($item->dependitem > 0) {
1670             $check = feedback_compare_item_value($tmpcplid, $item->dependitem, $item->dependvalue, true);
1671         }else {
1672             $check = true;
1673         }
1674         if($check) {
1675             unset($value->id);
1676             $value->completed = $feedbackcompleted->id;
1677             $DB->insert_record('feedback_value', $value);
1678         }
1679     }
1680     //drop all the tmpvalues
1681     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
1682     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
1683     return $feedbackcompleted->id;
1687 /**
1688  * deletes the given temporary completed and all related temporary values
1689  *
1690  * @global object
1691  * @param int $tmpcplid
1692  * @return void
1693  */
1694 function feedback_delete_completedtmp($tmpcplid) {
1695     global $DB;
1697     $DB->delete_records('feedback_valuetmp', array('completed'=>$tmpcplid));
1698     $DB->delete_records('feedback_completedtmp', array('id'=>$tmpcplid));
1701 ////////////////////////////////////////////////
1702 ////////////////////////////////////////////////
1703 ////////////////////////////////////////////////
1704 //functions to handle the pagebreaks
1705 ////////////////////////////////////////////////
1707 /**
1708  * this creates a pagebreak.
1709  * a pagebreak is a special kind of item
1710  *
1711  * @global object
1712  * @param int $feedbackid
1713  * @return mixed false if there already is a pagebreak on last position or the id of the pagebreak-item
1714  */
1715 function feedback_create_pagebreak($feedbackid) {
1716     global $DB;
1718     //check if there already is a pagebreak on the last position
1719     $lastposition = $DB->count_records('feedback_item', array('feedback'=>$feedbackid));
1720     if($lastposition == feedback_get_last_break_position($feedbackid)) {
1721         return false;
1722     }
1724     $item = new stdClass();
1725     $item->feedback = $feedbackid;
1727     $item->template=0;
1729     $item->name = '';
1731     $item->presentation = '';
1732     $item->hasvalue = 0;
1734     $item->typ = 'pagebreak';
1735     $item->position = $lastposition + 1;
1737     $item->required=0;
1739     return $DB->insert_record('feedback_item', $item);
1742 /**
1743  * get all positions of pagebreaks in the given feedback
1744  *
1745  * @global object
1746  * @param int $feedbackid
1747  * @return array all ordered pagebreak positions
1748  */
1749 function feedback_get_all_break_positions($feedbackid) {
1750     global $DB;
1752     if(!$allbreaks = $DB->get_records_menu('feedback_item', array('typ'=>'pagebreak', 'feedback'=>$feedbackid), 'position', 'id, position')) return false;
1753     return array_values($allbreaks);
1756 /**
1757  * get the position of the last pagebreak
1758  *
1759  * @param int $feedbackid
1760  * @return int the position of the last pagebreak
1761  */
1762 function feedback_get_last_break_position($feedbackid) {
1763     if(!$allbreaks = feedback_get_all_break_positions($feedbackid)) {
1764         return false;
1765     }
1766     return $allbreaks[count($allbreaks) - 1];
1769 /**
1770  * this returns the position where the user can continue the completing.
1771  *
1772  * @global object
1773  * @global object
1774  * @global object
1775  * @param int $feedbackid
1776  * @param int $courseid
1777  * @param string $guestid this id will be saved temporary and is unique
1778  * @return int the position to continue
1779  */
1780 function feedback_get_page_to_continue($feedbackid, $courseid = false, $guestid = false) {
1781     global $CFG, $USER, $DB;
1783     //is there any break?
1785     if(!$allbreaks = feedback_get_all_break_positions($feedbackid)) return false;
1787     $params = array();
1788     if($courseid) {
1789         $courseselect = "fv.course_id = :courseid";
1790         $params['courseid'] = $courseid;
1791     }else {
1792         $courseselect = "1";
1793     }
1795     if($guestid) {
1796         $userselect = "AND fc.guestid = :guestid";
1797         $usergroup = "GROUP BY fc.guestid";
1798         $params['guestid'] = $guestid;
1799     }else {
1800         $userselect = "AND fc.userid = :userid";
1801         $usergroup = "GROUP BY fc.userid";
1802         $params['userid'] = $USER->id;
1803     }
1805     $sql =  "SELECT MAX(fi.position)
1806                FROM {feedback_completedtmp} fc, {feedback_valuetmp} fv, {feedback_item} fi
1807               WHERE fc.id = fv.completed
1808                     $userselect
1809                     AND fc.feedback = :feedbackid
1810                     AND $courseselect
1811                     AND fi.id = fv.item
1812          $usergroup";
1813     $params['feedbackid'] = $feedbackid;
1815     $lastpos = $DB->get_field_sql($sql, $params);
1817     //the index of found pagebreak is the searched pagenumber
1818     foreach($allbreaks as $pagenr => $br) {
1819         if($lastpos < $br) return $pagenr;
1820     }
1821     return count($allbreaks);
1824 ////////////////////////////////////////////////
1825 ////////////////////////////////////////////////
1826 ////////////////////////////////////////////////
1827 //functions to handle the values
1828 ////////////////////////////////////////////////
1830 /**
1831  * this saves the values of an completed.
1832  * if the param $tmp is set true so the values are saved temporary in table feedback_valuetmp.
1833  * if there is already a completed and the userid is set so the values are updated.
1834  * on all other things new value records will be created.
1835  *
1836  * @global object
1837  * @param int $userid
1838  * @param boolean $tmp
1839  * @return mixed false on error or the completeid
1840  */
1841 function feedback_save_values($usrid, $tmp = false) {
1842     global $DB;
1844     $completedid = optional_param('completedid', false, PARAM_INT);
1846     $tmpstr = $tmp ? 'tmp' : '';
1847     $time = time();
1848     $timemodified = mktime(0, 0, 0, date('m', $time),date('d', $time),date('Y', $time));
1850     if($usrid == 0) {
1851         return feedback_create_values($usrid, $timemodified, $tmp);
1852     }
1853     if(!$completedid or !$completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid))) {
1854         return feedback_create_values($usrid, $timemodified, $tmp);
1855     }else{
1856         $completed->timemodified = $timemodified;
1857         return feedback_update_values($completed, $tmp);
1858     }
1861 /**
1862  * this saves the values from anonymous user such as guest on the main-site
1863  *
1864  * @global object
1865  * @param string $guestid the unique guestidentifier
1866  * @return mixed false on error or the completeid
1867  */
1868 function feedback_save_guest_values($guestid) {
1869     global $DB;
1871     $completedid = optional_param('completedid', false, PARAM_INT);
1873     $timemodified = time();
1874     if(!$completed = $DB->get_record('feedback_completedtmp', array('id'=>$completedid))) {
1875         return feedback_create_values(0, $timemodified, true, $guestid);
1876     }else {
1877         $completed->timemodified = $timemodified;
1878         return feedback_update_values($completed, true);
1879     }
1882 /**
1883  * get the value from the given item related to the given completed.
1884  * the value can come as temporary or as permanently value. the deciding is done by $tmp
1885  *
1886  * @global object
1887  * @param int $completeid
1888  * @param int $itemid
1889  * @param boolean $tmp
1890  * @return mixed the value, the type depends on plugin-definition
1891  */
1892 function feedback_get_item_value($completedid, $itemid, $tmp = false) {
1893     global $DB;
1895     $tmpstr = $tmp ? 'tmp' : '';
1896     return $DB->get_field('feedback_value'.$tmpstr, 'value', array('completed'=>$completedid, 'item'=>$itemid));
1899 /**
1900  * compares the value of the itemid related to the completedid with the dependvalue.
1901  * this is used if a depend item is set.
1902  * the value can come as temporary or as permanently value. the deciding is done by $tmp.
1903  *
1904  * @global object
1905  * @global object
1906  * @param int $completeid
1907  * @param int $itemid
1908  * @param mixed $dependvalue
1909  * @param boolean $tmp
1910  * @return bool
1911  */
1912 function feedback_compare_item_value($completedid, $itemid, $dependvalue, $tmp = false) {
1913     global $DB, $CFG;
1915     $dbvalue = feedback_get_item_value($completedid, $itemid, $tmp);
1917     //get the class of the given item-typ
1918     $item = $DB->get_record('feedback_item', array('id'=>$itemid));
1920     //get the instance of the item-class
1921     $itemobj = feedback_get_item_class($item->typ);
1922     return $itemobj->compare_value($item, $dbvalue, $dependvalue); //true or false
1925 /**
1926  * this function checks the correctness of values.
1927  * the rules for this are implemented in the class of each item.
1928  * it can be the required attribute or the value self e.g. numeric.
1929  * the params first/lastitem are given to determine the visible range between pagebreaks.
1930  *
1931  * @global object
1932  * @param int $firstitem the position of firstitem for checking
1933  * @param int $lastitem the position of lastitem for checking
1934  * @return boolean
1935  */
1936 function feedback_check_values($firstitem, $lastitem) {
1937     global $DB, $CFG;
1939     $feedbackid = optional_param('feedbackid', 0, PARAM_INT);
1941     //get all items between the first- and lastitem
1942     $select = "feedback = ?
1943                     AND position >= ?
1944                     AND position <= ?
1945                     AND hasvalue = 1";
1946     $params = array($feedbackid, $firstitem, $lastitem);
1947     if(!$feedbackitems = $DB->get_records_select('feedback_item', $select, $params)) {
1948         //if no values are given so no values can be wrong ;-)
1949         return true;
1950     }
1952     foreach($feedbackitems as $item) {
1953         //the name of the input field of the completeform is given in a special form:
1954         //<item-typ>_<item-id> eg. numeric_234
1955         //this is the key to get the value for the correct item
1956         $formvalname = $item->typ . '_' . $item->id;
1958         $value = optional_param($formvalname, NULL, PARAM_RAW);
1960         //check if the value is set
1961         if(is_null($value) AND $item->required == 1) {
1962             return false;
1963         }
1965         //get the instance of the item-class
1966         $itemobj = feedback_get_item_class($item->typ);
1968         //now we let check the value by the item-class
1969         if(!$itemobj->check_value($value, $item)) {
1970             return false;
1971         }
1972     }
1973     //if no wrong values so we can return true
1974     return true;
1977 /**
1978  * this function create a complete-record and the related value-records.
1979  * depending on the $tmp (true/false) the values are saved temporary or permanently
1980  *
1981  * @global object
1982  * @param int $userid
1983  * @param int $timemodified
1984  * @param boolean $tmp
1985  * @param string $guestid a unique identifier to save temporary data
1986  * @return mixed false on error or the completedid
1987  */
1988 function feedback_create_values($usrid, $timemodified, $tmp = false, $guestid = false){
1989     global $DB;
1991     $feedbackid = optional_param('feedbackid', false, PARAM_INT);
1992     $anonymous_response = optional_param('anonymous_response', false, PARAM_INT);
1993     $courseid = optional_param('courseid', false, PARAM_INT);
1995     $tmpstr = $tmp ? 'tmp' : '';
1996     //first we create a new completed record
1997     $completed = new stdClass();
1998     $completed->feedback           = $feedbackid;
1999     $completed->userid             = $usrid;
2000     $completed->guestid            = $guestid;
2001     $completed->timemodified       = $timemodified;
2002     $completed->anonymous_response = $anonymous_response;
2004     $completedid = $DB->insert_record('feedback_completed'.$tmpstr, $completed);
2006     $completed = $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$completedid));
2008     //the keys are in the form like abc_xxx
2009     //with explode we make an array with(abc, xxx) and (abc=typ und xxx=itemnr)
2011     //get the items of the feedback
2012     if(!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2013         return false;
2014     }
2015     foreach($allitems as $item) {
2016         $keyname = $item->typ.'_'.$item->id;
2017         $itemvalue = optional_param($keyname, NULL, PARAM_RAW);
2018         if(is_null($itemvalue)) {
2019             continue;
2020         }
2021         $value = new stdClass();
2022         $value->item = $item->id;
2023         $value->completed = $completed->id;
2024         $value->course_id = $courseid;
2026         //get the class of item-typ
2027         $itemobj = feedback_get_item_class($item->typ);
2029         //the kind of values can be absolutely different so we run create_value directly by the item-class
2030         $value->value = $itemobj->create_value($itemvalue);
2031         $DB->insert_record('feedback_value'.$tmpstr, $value);
2032     }
2033     return $completed->id;
2036 /**
2037  * this function updates a complete-record and the related value-records.
2038  * depending on the $tmp (true/false) the values are saved temporary or permanently
2039  *
2040  * @global object
2041  * @param object $completed
2042  * @param boolean $tmp
2043  * @return int the completedid
2044  */
2045 function feedback_update_values($completed, $tmp = false) {
2046     global $DB;
2047     $courseid = optional_param('courseid', false, PARAM_INT);
2049     $tmpstr = $tmp ? 'tmp' : '';
2051     $DB->update_record('feedback_completed'.$tmpstr, $completed);
2052     //get the values of this completed
2053     $values = $DB->get_records('feedback_value'.$tmpstr, array('completed'=>$completed->id));
2055     //get the items of the feedback
2056     if(!$allitems = $DB->get_records('feedback_item', array('feedback'=>$completed->feedback))) {
2057         return false;
2058     }
2059     foreach($allitems as $item) {
2060         $keyname = $item->typ.'_'.$item->id;
2061         $itemvalue = optional_param($keyname, NULL, PARAM_RAW);
2062         //is the itemvalue set (could be a subset of items because pagebreak)?
2063         if(is_null($itemvalue)) {
2064             continue;
2065         }
2067         $newvalue = new stdClass();
2068         $newvalue->item = $item->id;
2069         $newvalue->completed = $completed->id;
2070         $newvalue->course_id = $courseid;
2072         //get the class of item-typ
2073         $itemobj = feedback_get_item_class($item->typ);
2074         //the kind of values can be absolutely different so we run create_value directly by the item-class
2075         $newvalue->value = $itemobj->create_value($itemvalue);
2077         //check, if we have to create or update the value
2078         $exist = false;
2079         foreach($values as $value){
2080             if($value->item == $newvalue->item){
2081                 $newvalue->id = $value->id;
2082                 $exist = true;
2083                 break;
2084             }
2085         }
2086         if($exist){
2087             $DB->update_record('feedback_value'.$tmpstr, $newvalue);
2088         }else {
2089             $DB->insert_record('feedback_value'.$tmpstr, $newvalue);
2090         }
2091     }
2093     return $completed->id;
2096 /**
2097  * get the values of an item depending on the given groupid.
2098  * if the feedback is anonymous so the values are shuffled
2099  *
2100  * @global object
2101  * @global object
2102  * @param object $item
2103  * @param int $groupid
2104  * @param int $courseid
2105  * @param bool $ignore_empty if this is set true so empty values are not delivered
2106  * @return array the value-records
2107  */
2108 function feedback_get_group_values($item, $groupid = false, $courseid = false, $ignore_empty = false){
2109     global $CFG, $DB;
2111     //if the groupid is given?
2112     if (intval($groupid) > 0) {
2113         if($ignore_empty) {
2114             $ignore_empty_select = "AND fbc.value != ''";
2115         }
2116         else {
2117             $ignore_empty_select = "";
2118         }
2120         $query = 'SELECT fbv .  *
2121                     FROM {feedback_value} fbv, {feedback_completed} fbc, {groups_members} gm
2122                    WHERE fbv.item = ?
2123                          AND fbv.completed = fbc.id
2124                          AND fbc.userid = gm.userid
2125                          '.$ignore_empty_select.'
2126                          AND gm.groupid = ?
2127                 ORDER BY fbc.timemodified';
2128         $values = $DB->get_records_sql($query, array($item->id, $groupid));
2130     } else {
2131         if($ignore_empty) {
2132             $ignore_empty_select = "AND value != ''";
2133         }
2134         else {
2135             $ignore_empty_select = "";
2136         }
2138         if ($courseid) {
2139             $values = $DB->get_records_select('feedback_value', "item = ? AND course_id = ? ".$ignore_empty_select, array($item->id, $courseid));
2140         } else {
2141             $values = $DB->get_records_select('feedback_value', "item = ? ".$ignore_empty_select, array($item->id));
2142         }
2143     }
2144     if ($DB->get_field('feedback', 'anonymous', array('id'=>$item->feedback)) == FEEDBACK_ANONYMOUS_YES) {
2145         if(is_array($values))
2146             shuffle($values);
2147     }
2148     return $values;
2151 /**
2152  * check for multiple_submit = false.
2153  * if the feedback is global so the courseid must be given
2154  *
2155  * @global object
2156  * @global object
2157  * @param int $feedbackid
2158  * @param int $courseid
2159  * @return boolean true if the feedback already is submitted otherwise false
2160  */
2161 function feedback_is_already_submitted($feedbackid, $courseid = false) {
2162     global $USER, $DB;
2164     if (!$trackings = $DB->get_records_menu('feedback_tracking', array('userid'=>$USER->id, 'feedback'=>$feedbackid), '', 'id, completed')) {
2165         return false;
2166     }
2168     if($courseid) {
2169         $select = 'completed IN ('.implode(',',$trackings).') AND course_id = ?';
2170         if(!$values = $DB->get_records_select('feedback_value', $select, array($courseid))) {
2171             return false;
2172         }
2173     }
2175     return true;
2178 /**
2179  * if the completion of a feedback will be continued eg. by pagebreak or by multiple submit so the complete must be found.
2180  * if the param $tmp is set true so all things are related to temporary completeds
2181  *
2182  * @global object
2183  * @global object
2184  * @global object
2185  * @param int $feedbackid
2186  * @param boolean $tmp
2187  * @param int $courseid
2188  * @param string $guestid
2189  * @return int the id of the found completed
2190  */
2191 function feedback_get_current_completed($feedbackid, $tmp = false, $courseid = false, $guestid = false) {
2192     global $USER, $CFG, $DB;
2194     $tmpstr = $tmp ? 'tmp' : '';
2196     if(!$courseid) {
2197         if($guestid) {
2198             return $DB->get_record('feedback_completed'.$tmpstr, array('feedback'=>$feedbackid, 'guestid'=>$guestid));
2199         }else {
2200             return $DB->get_record('feedback_completed'.$tmpstr, array('feedback'=>$feedbackid, 'userid'=>$USER->id));
2201         }
2202     }
2204     $params = array();
2206     if ($guestid) {
2207         $userselect = "AND fc.guestid = :guestid";
2208         $params['guestid'] = $guestid;
2209     }else {
2210         $userselect = "AND fc.userid = :userid";
2211         $params['userid'] = $USER->id;
2212     }
2213     //if courseid is set the feedback is global. there can be more than one completed on one feedback
2214     $sql =  "SELECT DISTINCT fc.*
2215                FROM {feedback_value{$tmpstr}} fv, {feedback_completed{$tmpstr}} fc
2216               WHERE fv.course_id = :courseid
2217                     AND fv.completed = fc.id
2218                     $userselect
2219                     AND fc.feedback = :feedbackid";
2220     $params['courseid']   = intval($courseid);
2221     $params['feedbackid'] = $feedbackid;
2223     if (!$sqlresult = $DB->get_records_sql($sql, $params)) {
2224         return false;
2225     }
2226     foreach($sqlresult as $r) {
2227         return $DB->get_record('feedback_completed'.$tmpstr, array('id'=>$r->id));
2228     }
2231 /**
2232  * get the completeds depending on the given groupid.
2233  *
2234  * @global object
2235  * @global object
2236  * @param object $feedback
2237  * @param int $groupid
2238  * @param int $courseid
2239  * @return mixed array of found completeds otherwise false
2240  */
2241 function feedback_get_completeds_group($feedback, $groupid = false, $courseid = false) {
2242     global $CFG, $DB;
2244     if (intval($groupid) > 0){
2245         $query = "SELECT fbc.*
2246                     FROM {feedback_completed} fbc, {groups_members} gm
2247                    WHERE fbc.feedback = ?
2248                          AND gm.groupid = ?
2249                          AND fbc.userid = gm.userid";
2250         if ($values = $DB->get_records_sql($query, array($feedback->id, $groupid))) {
2251             return $values;
2252         } else {
2253             return false;
2254         }
2255     } else {
2256         if($courseid) {
2257             $query = "SELECT DISTINCT fbc.*
2258                         FROM {feedback_completed} fbc, {feedback_value} fbv
2259                         WHERE fbc.id = fbv.completed
2260                             AND fbc.feedback = ?
2261                             AND fbv.course_id = ?
2262                         ORDER BY random_response";
2263             if ($values = $DB->get_records_sql($query, array($feedback->id, $courseid))) {
2264                 return $values;
2265             } else {
2266                 return false;
2267             }
2268         }else {
2269             if ($values = $DB->get_records('feedback_completed', array('feedback'=>$feedback->id))) {
2270                 return $values;
2271             } else {
2272                 return false;
2273             }
2274         }
2275     }
2278 /**
2279  * get the count of completeds depending on the given groupid.
2280  *
2281  * @global object
2282  * @global object
2283  * @param object $feedback
2284  * @param int $groupid
2285  * @param int $courseid
2286  * @return mixed count of completeds or false
2287  */
2288 function feedback_get_completeds_group_count($feedback, $groupid = false, $courseid = false) {
2289     global $CFG, $DB;
2291     if ($courseid > 0 AND !$groupid <= 0) {
2292         $sql = "SELECT id, COUNT(item) AS ci
2293                   FROM {feedback_value}
2294                  WHERE course_id  = ?
2295               GROUP BY item ORDER BY ci DESC";
2296         if ($foundrecs = $DB->get_records_sql($sql, array($courseid))) {
2297             $foundrecs = array_values($foundrecs);
2298             return $foundrecs[0]->ci;
2299         }
2300         return false;
2301     }
2302     if($values = feedback_get_completeds_group($feedback, $groupid)) {
2303         return sizeof($values);
2304     }else {
2305         return false;
2306     }
2309 /**
2310  * deletes all completed-recordsets from a feedback.
2311  * all related data such as values also will be deleted
2312  *
2313  * @global object
2314  * @param int $feedbackid
2315  * @return void
2316  */
2317 function feedback_delete_all_completeds($feedbackid) {
2318     global $DB;
2320     if (!$completeds = $DB->get_records('feedback_completed', array('feedback'=>$feedbackid))) {
2321         return;
2322     }
2323     foreach($completeds as $completed) {
2324         feedback_delete_completed($completed->id);
2325     }
2328 /**
2329  * deletes a completed given by completedid.
2330  * all related data such values or tracking data also will be deleted
2331  *
2332  * @global object
2333  * @param int $completedid
2334  * @return boolean
2335  */
2336 function feedback_delete_completed($completedid) {
2337     global $DB, $CFG;
2338     require_once($CFG->libdir.'/completionlib.php');
2340     if (!$completed = $DB->get_record('feedback_completed', array('id'=>$completedid))) {
2341         return false;
2342     }
2344     if (!$feedback = $DB->get_record('feedback', array('id'=>$completed->feedback))) {
2345         return false;
2346     }
2348     if (!$course = $DB->get_record('course', array('id'=>$feedback->course))) {
2349         return false;
2350     }
2352     if (!$cm = get_coursemodule_from_instance('feedback', $feedback->id)) {
2353         return false;
2354     }
2356     //first we delete all related values
2357     $DB->delete_records('feedback_value', array('completed'=>$completed->id));
2359     //now we delete all tracking data
2360     if($tracking = $DB->get_record('feedback_tracking', array('completed'=>$completed->id, 'feedback'=>$completed->feedback))) {
2361         $DB->delete_records('feedback_tracking', array('completed'=>$completed->id));
2362     }
2364     // Update completion state
2365     $completion = new completion_info($course);
2366     if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
2367         $completion->update_state($cm, COMPLETION_INCOMPLETE, $completed->userid);
2368     }
2369     //last we delete the completed-record
2370     return $DB->delete_records('feedback_completed', array('id'=>$completed->id));
2373 ////////////////////////////////////////////////
2374 ////////////////////////////////////////////////
2375 ////////////////////////////////////////////////
2376 //functions to handle sitecourse mapping
2377 ////////////////////////////////////////////////
2379 /**
2380  * checks if the course and the feedback is in the table feedback_sitecourse_map.
2381  *
2382  * @global object
2383  * @param int $feedbackid
2384  * @param int $courseid
2385  * @return int the count of records
2386  */
2387 function feedback_is_course_in_sitecourse_map($feedbackid, $courseid) {
2388     global $DB;
2389     return $DB->count_records('feedback_sitecourse_map', array('feedbackid'=>$feedbackid, 'courseid'=>$courseid));
2392 /**
2393  * checks if the feedback is in the table feedback_sitecourse_map.
2394  *
2395  * @global object
2396  * @param int $feedbackid
2397  * @return boolean
2398  */
2399 function feedback_is_feedback_in_sitecourse_map($feedbackid) {
2400     global $DB;
2401     return $DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$feedbackid));
2404 /**
2405  * gets the feedbacks from table feedback_sitecourse_map.
2406  * this is used to show the global feedbacks on the feedback block
2407  * all feedbacks with the following criteria will be selected:<br />
2408  *
2409  * 1) all feedbacks which id are listed together with the courseid in sitecoursemap and<br />
2410  * 2) all feedbacks which not are listed in sitecoursemap
2411  *
2412  * @global object
2413  * @param int $courseid
2414  * @return array the feedback-records
2415  */
2416 function feedback_get_feedbacks_from_sitecourse_map($courseid) {
2417     global $DB;
2419     //first get all feedbacks listed in sitecourse_map with named courseid
2420     $sql = "SELECT f.id AS id, cm.id AS cmid, f.name AS name, f.timeopen AS timeopen, f.timeclose AS timeclose
2421               FROM {feedback} f, {course_modules} cm, {feedback_sitecourse_map} sm, {modules} m
2422              WHERE f.id = cm.instance
2423                    AND f.course = '".SITEID."'
2424                    AND m.id = cm.module
2425                    AND m.name = 'feedback'
2426                    AND sm.courseid = ?
2427                    AND sm.feedbackid = f.id";
2429     if (!$feedbacks1 = $DB->get_records_sql($sql, array($courseid))) {
2430         $feedbacks1 = array();
2431     }
2433     //second get all feedbacks not listed in sitecourse_map
2434     $feedbacks2 = array();
2435     $sql = "SELECT f.id AS id, cm.id AS cmid, f.name AS name, f.timeopen AS timeopen, f.timeclose AS timeclose
2436               FROM {feedback} f, {course_modules} cm, {modules} m
2437              WHERE f.id = cm.instance
2438                    AND f.course = '".SITEID."'
2439                    AND m.id = cm.module
2440                    AND m.name = 'feedback'";
2441     if (!$allfeedbacks = $DB->get_records_sql($sql)) {
2442         $allfeedbacks = array();
2443     }
2444     foreach($allfeedbacks as $a) {
2445         if(!$DB->record_exists('feedback_sitecourse_map', array('feedbackid'=>$a->id))) {
2446             $feedbacks2[] = $a;
2447         }
2448     }
2450     return array_merge($feedbacks1, $feedbacks2);
2454 /**
2455  * gets the courses from table feedback_sitecourse_map.
2456  *
2457  * @global object
2458  * @param int $feedbackid
2459  * @return array the course-records
2460  */
2461 function feedback_get_courses_from_sitecourse_map($feedbackid) {
2462     global $DB;
2464     $sql = "SELECT f.id, f.courseid, c.fullname, c.shortname
2465               FROM {feedback_sitecourse_map} f, {course} c
2466              WHERE c.id = f.courseid
2467                    AND f.feedbackid = ?
2468           ORDER BY c.fullname";
2470     return $DB->get_records_sql($sql, array($feedbackid));
2474 /**
2475  * removes non existing courses or feedbacks from sitecourse_map.
2476  * it shouldn't be called all too often
2477  * a good place for it could be the mapcourse.php or unmapcourse.php
2478  *
2479  * @global object
2480  * @return void
2481  */
2482 function feedback_clean_up_sitecourse_map() {
2483     global $DB;
2485     $maps = $DB->get_records('feedback_sitecourse_map');
2486     foreach($maps as $map) {
2487         if (!$DB->get_record('course', array('id'=>$map->courseid))) {
2488             $DB->delete_records('feedback_sitecourse_map', array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid));
2489             continue;
2490         }
2491         if (!$DB->get_record('feedback', array('id'=>$map->feedbackid))) {
2492             $DB->delete_records('feedback_sitecourse_map', array('courseid'=>$map->courseid, 'feedbackid'=>$map->feedbackid));
2493             continue;
2494         }
2496     }
2499 ////////////////////////////////////////////////
2500 ////////////////////////////////////////////////
2501 ////////////////////////////////////////////////
2502 //not relatable functions
2503 ////////////////////////////////////////////////
2505 /**
2506  * prints the option items of a selection-input item (dropdownlist).
2507  * @param int $startval the first value of the list
2508  * @param int $endval the last value of the list
2509  * @param int $selectval which item should be selected
2510  * @param int $interval the stepsize from the first to the last value
2511  * @return void
2512  */
2513 function feedback_print_numeric_option_list($startval, $endval, $selectval = '', $interval = 1){
2514     for($i = $startval; $i <= $endval; $i += $interval){
2515         if($selectval == ($i)){
2516             $selected = 'selected="selected"';
2517         }else{
2518             $selected = '';
2519         }
2520         echo '<option '.$selected.'>'.$i.'</option>';
2521     }
2524 /**
2525  * sends an email to the teachers of the course where the given feedback is placed.
2526  *
2527  * @global object
2528  * @global object
2529  * @uses FEEDBACK_ANONYMOUS_NO
2530  * @uses FORMAT_PLAIN
2531  * @param object $cm the coursemodule-record
2532  * @param object $feedback
2533  * @param object $course
2534  * @param int $userid
2535  * @return void
2536  */
2537 function feedback_send_email($cm, $feedback, $course, $userid) {
2538     global $CFG, $DB;
2540     if ($feedback->email_notification == 0) {  // No need to do anything
2541         return;
2542     }
2544     $user = $DB->get_record('user', array('id'=>$userid));
2546     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
2547         $groupmode =  $cm->groupmode;
2548     } else {
2549         $groupmode = $course->groupmode;
2550     }
2552     if ($groupmode == SEPARATEGROUPS) {
2553         $groups = $DB->get_records_sql_menu("SELECT g.name, g.id
2554                                                FROM {groups} g, {groups_members} m
2555                                               WHERE g.courseid = ?
2556                                                     AND g.id = m.groupid
2557                                                     AND m.userid = ?
2558                                            ORDER BY name ASC", array($course->id, $userid));
2559         $groups = array_values($groups);
2561         $teachers = feedback_get_receivemail_users($cm->id, $groups);
2562     } else {
2563         $teachers = feedback_get_receivemail_users($cm->id);
2564     }
2566     if ($teachers) {
2568         $strfeedbacks = get_string('modulenameplural', 'feedback');
2569         $strfeedback  = get_string('modulename', 'feedback');
2570         $strcompleted  = get_string('completed', 'feedback');
2571         $printusername = $feedback->anonymous == FEEDBACK_ANONYMOUS_NO ? fullname($user) : get_string('anonymous_user', 'feedback');
2573         foreach ($teachers as $teacher) {
2574             $info = new stdClass();
2575             $info->username = $printusername;
2576             $info->feedback = format_string($feedback->name,true);
2577             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries.php?id='.$cm->id.'&userid='.$userid.'&do_show=showentries';
2579             $postsubject = $strcompleted.': '.$info->username.' -> '.$feedback->name;
2580             $posttext = feedback_send_email_text($info, $course);
2581             $posthtml = ($teacher->mailformat == 1) ? feedback_send_email_html($info, $course, $cm) : '';
2583             if($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
2584                 $eventdata = new stdClass();
2585                 $eventdata->name             = 'feedback';
2586                 $eventdata->component        = 'mod';
2587                 $eventdata->userfrom         = $user;
2588                 $eventdata->userto           = $teacher;
2589                 $eventdata->subject          = $postsubject;
2590                 $eventdata->fullmessage      = $posttext;
2591                 $eventdata->fullmessageformat = FORMAT_PLAIN;
2592                 $eventdata->fullmessagehtml  = $posthtml;
2593                 $eventdata->smallmessage     = '';
2594                 message_send($eventdata);
2595             }else {
2596                 $eventdata = new stdClass();
2597                 $eventdata->name             = 'feedback';
2598                 $eventdata->component        = 'mod';
2599                 $eventdata->userfrom         = $teacher;
2600                 $eventdata->userto           = $teacher;
2601                 $eventdata->subject          = $postsubject;
2602                 $eventdata->fullmessage      = $posttext;
2603                 $eventdata->fullmessageformat = FORMAT_PLAIN;
2604                 $eventdata->fullmessagehtml  = $posthtml;
2605                 $eventdata->smallmessage     = '';
2606                 message_send($eventdata);
2607             }
2608         }
2609     }
2612 /**
2613  * sends an email to the teachers of the course where the given feedback is placed.
2614  *
2615  * @global object
2616  * @uses FORMAT_PLAIN
2617  * @param object $cm the coursemodule-record
2618  * @param object $feedback
2619  * @param object $course
2620  * @return void
2621  */
2622 function feedback_send_email_anonym($cm, $feedback, $course) {
2623     global $CFG;
2625     if ($feedback->email_notification == 0) {             // No need to do anything
2626         return;
2627     }
2629     $teachers = feedback_get_receivemail_users($cm->id);
2631     if ($teachers) {
2633         $strfeedbacks = get_string('modulenameplural', 'feedback');
2634         $strfeedback  = get_string('modulename', 'feedback');
2635         $strcompleted  = get_string('completed', 'feedback');
2636         $printusername = get_string('anonymous_user', 'feedback');
2638         foreach ($teachers as $teacher) {
2639             $info = new stdClass();
2640             $info->username = $printusername;
2641             $info->feedback = format_string($feedback->name,true);
2642             $info->url = $CFG->wwwroot.'/mod/feedback/show_entries_anonym.php?id='.$cm->id;
2644             $postsubject = $strcompleted.': '.$info->username.' -> '.$feedback->name;
2645             $posttext = feedback_send_email_text($info, $course);
2646             $posthtml = ($teacher->mailformat == 1) ? feedback_send_email_html($info, $course, $cm) : '';
2648             $eventdata = new stdClass();
2649             $eventdata->name             = 'feedback';
2650             $eventdata->component        = 'mod';
2651             $eventdata->userfrom         = $teacher;
2652             $eventdata->userto           = $teacher;
2653             $eventdata->subject          = $postsubject;
2654             $eventdata->fullmessage      = $posttext;
2655             $eventdata->fullmessageformat = FORMAT_PLAIN;
2656             $eventdata->fullmessagehtml  = $posthtml;
2657             $eventdata->smallmessage     = '';
2658             message_send($eventdata);
2659         }
2660     }
2663 /**
2664  * send the text-part of the email
2665  *
2666  * @param object $info includes some infos about the feedback you want to send
2667  * @param object $course
2668  * @return string the text you want to post
2669  */
2670 function feedback_send_email_text($info, $course) {
2671     $posttext  = $course->shortname.' -> '.get_string('modulenameplural', 'feedback').' -> '.
2672                     $info->feedback."\n";
2673     $posttext .= '---------------------------------------------------------------------'."\n";
2674     $posttext .= get_string("emailteachermail", "feedback", $info)."\n";
2675     $posttext .= '---------------------------------------------------------------------'."\n";
2676     return $posttext;
2680 /**
2681  * send the html-part of the email
2682  *
2683  * @global object
2684  * @param object $info includes some infos about the feedback you want to send
2685  * @param object $course
2686  * @return string the text you want to post
2687  */
2688 function feedback_send_email_html($info, $course, $cm) {
2689     global $CFG;
2690     $posthtml  = '<p><font face="sans-serif">'.
2691                 '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$course->shortname.'</a> ->'.
2692                 '<a href="'.$CFG->wwwroot.'/mod/feedback/index.php?id='.$course->id.'">'.get_string('modulenameplural', 'feedback').'</a> ->'.
2693                 '<a href="'.$CFG->wwwroot.'/mod/feedback/view.php?id='.$cm->id.'">'.$info->feedback.'</a></font></p>';
2694     $posthtml .= '<hr /><font face="sans-serif">';
2695     $posthtml .= '<p>'.get_string('emailteachermailhtml', 'feedback', $info).'</p>';
2696     $posthtml .= '</font><hr />';
2697     return $posthtml;
2700 /**
2701  * print some errors to inform users about this.
2702  *
2703  * @global object
2704  * @return void
2705  */
2706 function feedback_print_errors() {
2708     global $SESSION, $OUTPUT;
2710     feedback_init_feedback_session();
2712     if(empty($SESSION->feedback->errors)) {
2713         return;
2714     }
2716     echo $OUTPUT->box_start('generalbox errorboxcontent boxaligncenter boxwidthnormal');
2717     echo $OUTPUT->heading(get_string('handling_error', 'feedback'));
2719     echo '<p align="center"><b><font color="black"><pre>';
2720     print_r($SESSION->feedback->errors) . "\n";
2721     echo '</pre></font></b></p>';
2723     echo $OUTPUT->box_end();
2724     echo '<br /><br />';
2725     $SESSION->feedback->errors = array(); //remove errors
2728 /**
2729  * @param string $url
2730  * @return string
2731  */
2732 function feedback_encode_target_url($url) {
2733     if (strpos($url, '?')) {
2734         list($part1, $part2) = explode('?', $url, 2); //maximal 2 parts
2735         return $part1 . '?' . htmlentities($part2);
2736     } else {
2737         return $url;
2738     }
2741 /**
2742  * Adds module specific settings to the settings block
2743  *
2744  * @param settings_navigation $settings The settings navigation object
2745  * @param navigation_node $feedbacknode The node to add module settings to
2746  */
2747 function feedback_extend_settings_navigation(settings_navigation $settings, navigation_node $feedbacknode) {
2748     global $PAGE, $DB;
2750     if (!$context = get_context_instance(CONTEXT_MODULE, $PAGE->cm->id)) {
2751         print_error('badcontext');
2752     }
2754     if (has_capability('mod/feedback:edititems', $context)) {
2755         $questionnode = $feedbacknode->add(get_string('questions', 'feedback'));
2756         $questionnode->add(get_string('edit_items', 'feedback'), new moodle_url('/mod/feedback/edit.php', array('id'=>$PAGE->cm->id, 'do_show'=>'edit')));
2757         $questionnode->add(get_string('export_questions', 'feedback'), new moodle_url('/mod/feedback/export.php', array('id'=>$PAGE->cm->id, 'action'=>'exportfile')));
2758         $questionnode->add(get_string('import_questions', 'feedback'), new moodle_url('/mod/feedback/import.php', array('id'=>$PAGE->cm->id)));
2759         $questionnode->add(get_string('templates', 'feedback'), new moodle_url('/mod/feedback/edit.php', array('id'=>$PAGE->cm->id, 'do_show'=>'templates')));
2760     }
2762     if (has_capability('mod/feedback:viewreports', $context)) {
2763         $feedback = $DB->get_record('feedback', array('id'=>$PAGE->cm->instance));
2764         if($feedback->course == SITEID){
2765             $feedbacknode->add(get_string('analysis', 'feedback'), new moodle_url('/mod/feedback/analysis_course.php', array('id'=>$PAGE->cm->id, 'course'=>$PAGE->course->id,'do_show'=>'analysis')));
2766         }else {
2767             $feedbacknode->add(get_string('analysis', 'feedback'), new moodle_url('/mod/feedback/analysis.php', array('id'=>$PAGE->cm->id, 'course'=>$PAGE->course->id,'do_show'=>'analysis')));
2768         }
2770         $feedbacknode->add(get_string('show_entries', 'feedback'), new moodle_url('/mod/feedback/show_entries.php', array('id'=>$PAGE->cm->id, 'do_show'=>'showentries')));
2771     }
2774 function feedback_init_feedback_session() {
2775     //initialize the feedback-Session - not nice at all!!
2776     global $SESSION;
2777     if (!empty($SESSION)) {
2778         if (!isset($SESSION->feedback) OR !is_object($SESSION->feedback)) {
2779             $SESSION->feedback = new stdClass();
2780         }
2781     }