Merge branch 'MDL-27164-master' of git://github.com/micaherne/moodle
[moodle.git] / group / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Extra library for groups and groupings.
20  *
21  * @copyright 2006 The Open University, J.White AT open.ac.uk, Petr Skoda (skodak)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package   core_group
24  */
26 /*
27  * INTERNAL FUNCTIONS - to be used by moodle core only
28  * require_once $CFG->dirroot.'/group/lib.php' must be used
29  */
31 /**
32  * Adds a specified user to a group
33  *
34  * @param mixed $grouporid  The group id or group object
35  * @param mixed $userorid   The user id or user object
36  * @param string $component Optional component name e.g. 'enrol_imsenterprise'
37  * @param int $itemid Optional itemid associated with component
38  * @return bool True if user added successfully or the user is already a
39  * member of the group, false otherwise.
40  */
41 function groups_add_member($grouporid, $userorid, $component=null, $itemid=0) {
42     global $DB;
44     if (is_object($userorid)) {
45         $userid = $userorid->id;
46         $user   = $userorid;
47         if (!isset($user->deleted)) {
48             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
49         }
50     } else {
51         $userid = $userorid;
52         $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
53     }
55     if ($user->deleted) {
56         return false;
57     }
59     if (is_object($grouporid)) {
60         $groupid = $grouporid->id;
61         $group   = $grouporid;
62     } else {
63         $groupid = $grouporid;
64         $group = $DB->get_record('groups', array('id'=>$groupid), '*', MUST_EXIST);
65     }
67     //check if the user a participant of the group course
68     if (!is_enrolled(context_course::instance($group->courseid), $userid)) {
69         return false;
70     }
72     if (groups_is_member($groupid, $userid)) {
73         return true;
74     }
76     $member = new stdClass();
77     $member->groupid   = $groupid;
78     $member->userid    = $userid;
79     $member->timeadded = time();
80     $member->component = '';
81     $member->itemid = 0;
83     // Check the component exists if specified
84     if (!empty($component)) {
85         $dir = get_component_directory($component);
86         if ($dir && is_dir($dir)) {
87             // Component exists and can be used
88             $member->component = $component;
89             $member->itemid = $itemid;
90         } else {
91             throw new coding_exception('Invalid call to groups_add_member(). An invalid component was specified');
92         }
93     }
95     if ($itemid !== 0 && empty($member->component)) {
96         // An itemid can only be specified if a valid component was found
97         throw new coding_exception('Invalid call to groups_add_member(). A component must be specified if an itemid is given');
98     }
100     $DB->insert_record('groups_members', $member);
102     //update group info
103     $DB->set_field('groups', 'timemodified', $member->timeadded, array('id'=>$groupid));
105     //trigger groups events
106     $eventdata = new stdClass();
107     $eventdata->groupid = $groupid;
108     $eventdata->userid  = $userid;
109     $eventdata->component = $member->component;
110     $eventdata->itemid = $member->itemid;
111     events_trigger('groups_member_added', $eventdata);
113     return true;
116 /**
117  * Checks whether the current user is permitted (using the normal UI) to
118  * remove a specific group member, assuming that they have access to remove
119  * group members in general.
120  *
121  * For automatically-created group member entries, this checks with the
122  * relevant plugin to see whether it is permitted. The default, if the plugin
123  * doesn't provide a function, is true.
124  *
125  * For other entries (and any which have already been deleted/don't exist) it
126  * just returns true.
127  *
128  * @param mixed $grouporid The group id or group object
129  * @param mixed $userorid The user id or user object
130  * @return bool True if permitted, false otherwise
131  */
132 function groups_remove_member_allowed($grouporid, $userorid) {
133     global $DB;
135     if (is_object($userorid)) {
136         $userid = $userorid->id;
137     } else {
138         $userid = $userorid;
139     }
140     if (is_object($grouporid)) {
141         $groupid = $grouporid->id;
142     } else {
143         $groupid = $grouporid;
144     }
146     // Get entry
147     if (!($entry = $DB->get_record('groups_members',
148             array('groupid' => $groupid, 'userid' => $userid), '*', IGNORE_MISSING))) {
149         // If the entry does not exist, they are allowed to remove it (this
150         // is consistent with groups_remove_member below).
151         return true;
152     }
154     // If the entry does not have a component value, they can remove it
155     if (empty($entry->component)) {
156         return true;
157     }
159     // It has a component value, so we need to call a plugin function (if it
160     // exists); the default is to allow removal
161     return component_callback($entry->component, 'allow_group_member_remove',
162             array($entry->itemid, $entry->groupid, $entry->userid), true);
165 /**
166  * Deletes the link between the specified user and group.
167  *
168  * @param mixed $grouporid  The group id or group object
169  * @param mixed $userorid   The user id or user object
170  * @return bool True if deletion was successful, false otherwise
171  */
172 function groups_remove_member($grouporid, $userorid) {
173     global $DB;
175     if (is_object($userorid)) {
176         $userid = $userorid->id;
177         $user   = $userorid;
178     } else {
179         $userid = $userorid;
180         $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
181     }
183     if (is_object($grouporid)) {
184         $groupid = $grouporid->id;
185         $group   = $grouporid;
186     } else {
187         $groupid = $grouporid;
188         $group = $DB->get_record('groups', array('id'=>$groupid), '*', MUST_EXIST);
189     }
191     if (!groups_is_member($groupid, $userid)) {
192         return true;
193     }
195     $DB->delete_records('groups_members', array('groupid'=>$groupid, 'userid'=>$userid));
197     //update group info
198     $DB->set_field('groups', 'timemodified', time(), array('id'=>$groupid));
200     //trigger groups events
201     $eventdata = new stdClass();
202     $eventdata->groupid = $groupid;
203     $eventdata->userid  = $userid;
204     events_trigger('groups_member_removed', $eventdata);
206     return true;
209 /**
210  * Add a new group
211  *
212  * @param stdClass $data group properties
213  * @param stdClass $editform
214  * @param array $editoroptions
215  * @return id of group or false if error
216  */
217 function groups_create_group($data, $editform = false, $editoroptions = false) {
218     global $CFG, $DB;
220     //check that courseid exists
221     $course = $DB->get_record('course', array('id' => $data->courseid), '*', MUST_EXIST);
222     $context = context_course::instance($course->id);
224     $data->timecreated  = time();
225     $data->timemodified = $data->timecreated;
226     $data->name         = trim($data->name);
227     if (isset($data->idnumber)) {
228         $data->idnumber = trim($data->idnumber);
229         if (groups_get_group_by_idnumber($course->id, $data->idnumber)) {
230             throw new moodle_exception('idnumbertaken');
231         }
232     }
234     if ($editform and $editoroptions) {
235         $data->description = $data->description_editor['text'];
236         $data->descriptionformat = $data->description_editor['format'];
237     }
239     $data->id = $DB->insert_record('groups', $data);
241     if ($editform and $editoroptions) {
242         // Update description from editor with fixed files
243         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $context, 'group', 'description', $data->id);
244         $upd = new stdClass();
245         $upd->id                = $data->id;
246         $upd->description       = $data->description;
247         $upd->descriptionformat = $data->descriptionformat;
248         $DB->update_record('groups', $upd);
249     }
251     $group = $DB->get_record('groups', array('id'=>$data->id));
253     if ($editform) {
254         groups_update_group_icon($group, $data, $editform);
255     }
257     // Invalidate the grouping cache for the course
258     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($course->id));
260     //trigger groups events
261     events_trigger('groups_group_created', $group);
263     return $group->id;
266 /**
267  * Add a new grouping
268  *
269  * @param stdClass $data grouping properties
270  * @param array $editoroptions
271  * @return id of grouping or false if error
272  */
273 function groups_create_grouping($data, $editoroptions=null) {
274     global $DB;
276     $data->timecreated  = time();
277     $data->timemodified = $data->timecreated;
278     $data->name         = trim($data->name);
279     if (isset($data->idnumber)) {
280         $data->idnumber = trim($data->idnumber);
281         if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
282             throw new moodle_exception('idnumbertaken');
283         }
284     }
286     if ($editoroptions !== null) {
287         $data->description = $data->description_editor['text'];
288         $data->descriptionformat = $data->description_editor['format'];
289     }
291     $id = $DB->insert_record('groupings', $data);
293     //trigger groups events
294     $data->id = $id;
296     if ($editoroptions !== null) {
297         $description = new stdClass;
298         $description->id = $data->id;
299         $description->description_editor = $data->description_editor;
300         $description = file_postupdate_standard_editor($description, 'description', $editoroptions, $editoroptions['context'], 'grouping', 'description', $description->id);
301         $DB->update_record('groupings', $description);
302     }
304     // Invalidate the grouping cache for the course
305     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
307     events_trigger('groups_grouping_created', $data);
309     return $id;
312 /**
313  * Update the group icon from form data
314  *
315  * @param stdClass $group group information
316  * @param stdClass $data
317  * @param stdClass $editform
318  */
319 function groups_update_group_icon($group, $data, $editform) {
320     global $CFG, $DB;
321     require_once("$CFG->libdir/gdlib.php");
323     $fs = get_file_storage();
324     $context = context_course::instance($group->courseid, MUST_EXIST);
326     //TODO: it would make sense to allow picture deleting too (skodak)
327     if (!empty($CFG->gdversion)) {
328         if ($iconfile = $editform->save_temp_file('imagefile')) {
329             if (process_new_icon($context, 'group', 'icon', $group->id, $iconfile)) {
330                 $DB->set_field('groups', 'picture', 1, array('id'=>$group->id));
331                 $group->picture = 1;
332             } else {
333                 $fs->delete_area_files($context->id, 'group', 'icon', $group->id);
334                 $DB->set_field('groups', 'picture', 0, array('id'=>$group->id));
335                 $group->picture = 0;
336             }
337             @unlink($iconfile);
338             // Invalidate the group data as we've updated the group record.
339             cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($group->courseid));
340         }
341     }
344 /**
345  * Update group
346  *
347  * @param stdClass $data group properties (with magic quotes)
348  * @param stdClass $editform
349  * @param array $editoroptions
350  * @return bool true or exception
351  */
352 function groups_update_group($data, $editform = false, $editoroptions = false) {
353     global $CFG, $DB;
355     $context = context_course::instance($data->courseid);
357     $data->timemodified = time();
358     $data->name         = trim($data->name);
359     if (isset($data->idnumber)) {
360         $data->idnumber = trim($data->idnumber);
361         if (($existing = groups_get_group_by_idnumber($data->courseid, $data->idnumber)) && $existing->id != $data->id) {
362             throw new moodle_exception('idnumbertaken');
363         }
364     }
366     if ($editform and $editoroptions) {
367         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $context, 'group', 'description', $data->id);
368     }
370     $DB->update_record('groups', $data);
372     // Invalidate the group data.
373     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
375     $group = $DB->get_record('groups', array('id'=>$data->id));
377     if ($editform) {
378         groups_update_group_icon($group, $data, $editform);
379     }
381     //trigger groups events
382     events_trigger('groups_group_updated', $group);
385     return true;
388 /**
389  * Update grouping
390  *
391  * @param stdClass $data grouping properties (with magic quotes)
392  * @param array $editoroptions
393  * @return bool true or exception
394  */
395 function groups_update_grouping($data, $editoroptions=null) {
396     global $DB;
397     $data->timemodified = time();
398     $data->name         = trim($data->name);
399     if (isset($data->idnumber)) {
400         $data->idnumber = trim($data->idnumber);
401         if (($existing = groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) && $existing->id != $data->id) {
402             throw new moodle_exception('idnumbertaken');
403         }
404     }
405     if ($editoroptions !== null) {
406         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $editoroptions['context'], 'grouping', 'description', $data->id);
407     }
408     $DB->update_record('groupings', $data);
410     // Invalidate the group data.
411     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
413     //trigger groups events
414     events_trigger('groups_grouping_updated', $data);
416     return true;
419 /**
420  * Delete a group best effort, first removing members and links with courses and groupings.
421  * Removes group avatar too.
422  *
423  * @param mixed $grouporid The id of group to delete or full group object
424  * @return bool True if deletion was successful, false otherwise
425  */
426 function groups_delete_group($grouporid) {
427     global $CFG, $DB;
428     require_once("$CFG->libdir/gdlib.php");
430     if (is_object($grouporid)) {
431         $groupid = $grouporid->id;
432         $group   = $grouporid;
433     } else {
434         $groupid = $grouporid;
435         if (!$group = $DB->get_record('groups', array('id'=>$groupid))) {
436             //silently ignore attempts to delete missing already deleted groups ;-)
437             return true;
438         }
439     }
441     // delete group calendar events
442     $DB->delete_records('event', array('groupid'=>$groupid));
443     //first delete usage in groupings_groups
444     $DB->delete_records('groupings_groups', array('groupid'=>$groupid));
445     //delete members
446     $DB->delete_records('groups_members', array('groupid'=>$groupid));
447     //group itself last
448     $DB->delete_records('groups', array('id'=>$groupid));
450     // Delete all files associated with this group
451     $context = context_course::instance($group->courseid);
452     $fs = get_file_storage();
453     $fs->delete_area_files($context->id, 'group', 'description', $groupid);
454     $fs->delete_area_files($context->id, 'group', 'icon', $groupid);
456     // Invalidate the grouping cache for the course
457     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($group->courseid));
459     //trigger groups events
460     events_trigger('groups_group_deleted', $group);
462     return true;
465 /**
466  * Delete grouping
467  *
468  * @param int $groupingorid
469  * @return bool success
470  */
471 function groups_delete_grouping($groupingorid) {
472     global $DB;
474     if (is_object($groupingorid)) {
475         $groupingid = $groupingorid->id;
476         $grouping   = $groupingorid;
477     } else {
478         $groupingid = $groupingorid;
479         if (!$grouping = $DB->get_record('groupings', array('id'=>$groupingorid))) {
480             //silently ignore attempts to delete missing already deleted groupings ;-)
481             return true;
482         }
483     }
485     //first delete usage in groupings_groups
486     $DB->delete_records('groupings_groups', array('groupingid'=>$groupingid));
487     // remove the default groupingid from course
488     $DB->set_field('course', 'defaultgroupingid', 0, array('defaultgroupingid'=>$groupingid));
489     // remove the groupingid from all course modules
490     $DB->set_field('course_modules', 'groupingid', 0, array('groupingid'=>$groupingid));
491     //group itself last
492     $DB->delete_records('groupings', array('id'=>$groupingid));
494     $context = context_course::instance($grouping->courseid);
495     $fs = get_file_storage();
496     $files = $fs->get_area_files($context->id, 'grouping', 'description', $groupingid);
497     foreach ($files as $file) {
498         $file->delete();
499     }
501     // Invalidate the grouping cache for the course
502     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($grouping->courseid));
504     //trigger groups events
505     events_trigger('groups_grouping_deleted', $grouping);
507     return true;
510 /**
511  * Remove all users (or one user) from all groups in course
512  *
513  * @param int $courseid
514  * @param int $userid 0 means all users
515  * @param bool $showfeedback
516  * @return bool success
517  */
518 function groups_delete_group_members($courseid, $userid=0, $showfeedback=false) {
519     global $DB, $OUTPUT;
521     if (is_bool($userid)) {
522         debugging('Incorrect userid function parameter');
523         return false;
524     }
526     $params = array('courseid'=>$courseid);
528     if ($userid) {
529         $usersql = "AND userid = :userid";
530         $params['userid'] = $userid;
531     } else {
532         $usersql = "";
533     }
535     $groupssql = "SELECT id FROM {groups} g WHERE g.courseid = :courseid";
536     $DB->delete_records_select('groups_members', "groupid IN ($groupssql) $usersql", $params);
538     //trigger groups events
539     $eventdata = new stdClass();
540     $eventdata->courseid = $courseid;
541     $eventdata->userid   = $userid;
542     events_trigger('groups_members_removed', $eventdata);
544     if ($showfeedback) {
545         echo $OUTPUT->notification(get_string('deleted').' - '.get_string('groupmembers', 'group'), 'notifysuccess');
546     }
548     return true;
551 /**
552  * Remove all groups from all groupings in course
553  *
554  * @param int $courseid
555  * @param bool $showfeedback
556  * @return bool success
557  */
558 function groups_delete_groupings_groups($courseid, $showfeedback=false) {
559     global $DB, $OUTPUT;
561     $groupssql = "SELECT id FROM {groups} g WHERE g.courseid = ?";
562     $DB->delete_records_select('groupings_groups', "groupid IN ($groupssql)", array($courseid));
564     // Invalidate the grouping cache for the course
565     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
567     //trigger groups events
568     events_trigger('groups_groupings_groups_removed', $courseid);
570     // no need to show any feedback here - we delete usually first groupings and then groups
572     return true;
575 /**
576  * Delete all groups from course
577  *
578  * @param int $courseid
579  * @param bool $showfeedback
580  * @return bool success
581  */
582 function groups_delete_groups($courseid, $showfeedback=false) {
583     global $CFG, $DB, $OUTPUT;
585     // delete any uses of groups
586     // Any associated files are deleted as part of groups_delete_groupings_groups
587     groups_delete_groupings_groups($courseid, $showfeedback);
588     groups_delete_group_members($courseid, 0, $showfeedback);
590     // delete group pictures and descriptions
591     $context = context_course::instance($courseid);
592     $fs = get_file_storage();
593     $fs->delete_area_files($context->id, 'group');
595     // delete group calendar events
596     $groupssql = "SELECT id FROM {groups} g WHERE g.courseid = ?";
597     $DB->delete_records_select('event', "groupid IN ($groupssql)", array($courseid));
599     $context = context_course::instance($courseid);
600     $fs = get_file_storage();
601     $fs->delete_area_files($context->id, 'group');
603     $DB->delete_records('groups', array('courseid'=>$courseid));
605     // Invalidate the grouping cache for the course
606     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
608     // trigger groups events
609     events_trigger('groups_groups_deleted', $courseid);
611     if ($showfeedback) {
612         echo $OUTPUT->notification(get_string('deleted').' - '.get_string('groups', 'group'), 'notifysuccess');
613     }
615     return true;
618 /**
619  * Delete all groupings from course
620  *
621  * @param int $courseid
622  * @param bool $showfeedback
623  * @return bool success
624  */
625 function groups_delete_groupings($courseid, $showfeedback=false) {
626     global $DB, $OUTPUT;
628     // delete any uses of groupings
629     $sql = "DELETE FROM {groupings_groups}
630              WHERE groupingid in (SELECT id FROM {groupings} g WHERE g.courseid = ?)";
631     $DB->execute($sql, array($courseid));
633     // remove the default groupingid from course
634     $DB->set_field('course', 'defaultgroupingid', 0, array('id'=>$courseid));
635     // remove the groupingid from all course modules
636     $DB->set_field('course_modules', 'groupingid', 0, array('course'=>$courseid));
638     // Delete all files associated with groupings for this course
639     $context = context_course::instance($courseid);
640     $fs = get_file_storage();
641     $fs->delete_area_files($context->id, 'grouping');
643     $DB->delete_records('groupings', array('courseid'=>$courseid));
645     // Invalidate the grouping cache for the course
646     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
648     // trigger groups events
649     events_trigger('groups_groupings_deleted', $courseid);
651     if ($showfeedback) {
652         echo $OUTPUT->notification(get_string('deleted').' - '.get_string('groupings', 'group'), 'notifysuccess');
653     }
655     return true;
658 /* =================================== */
659 /* various functions used by groups UI */
660 /* =================================== */
662 /**
663  * Obtains a list of the possible roles that group members might come from,
664  * on a course. Generally this includes only profile roles.
665  *
666  * @param context $context Context of course
667  * @return Array of role ID integers, or false if error/none.
668  */
669 function groups_get_possible_roles($context) {
670     $roles = get_profile_roles($context);
671     return array_keys($roles);
675 /**
676  * Gets potential group members for grouping
677  *
678  * @param int $courseid The id of the course
679  * @param int $roleid The role to select users from
680  * @param int $cohortid restrict to cohort id
681  * @param string $orderby The column to sort users by
682  * @return array An array of the users
683  */
684 function groups_get_potential_members($courseid, $roleid = null, $cohortid = null, $orderby = 'lastname ASC, firstname ASC') {
685     global $DB;
687     $context = context_course::instance($courseid);
689     // we are looking for all users with this role assigned in this context or higher
690     $listofcontexts = get_related_contexts_string($context);
692     list($esql, $params) = get_enrolled_sql($context);
694     if ($roleid) {
695         $params['roleid'] = $roleid;
696         $where = "WHERE u.id IN (SELECT userid
697                                    FROM {role_assignments}
698                                   WHERE roleid = :roleid AND contextid $listofcontexts)";
699     } else {
700         $where = "";
701     }
703     if ($cohortid) {
704         $cohortjoin = "JOIN {cohort_members} cm ON (cm.userid = u.id AND cm.cohortid = :cohortid)";
705         $params['cohortid'] = $cohortid;
706     } else {
707         $cohortjoin = "";
708     }
710     $sql = "SELECT u.id, u.username, u.firstname, u.lastname, u.idnumber
711               FROM {user} u
712               JOIN ($esql) e ON e.id = u.id
713        $cohortjoin
714             $where
715           ORDER BY $orderby";
717     return $DB->get_records_sql($sql, $params);
721 /**
722  * Parse a group name for characters to replace
723  *
724  * @param string $format The format a group name will follow
725  * @param int $groupnumber The number of the group to be used in the parsed format string
726  * @return string the parsed format string
727  */
728 function groups_parse_name($format, $groupnumber) {
729     if (strstr($format, '@') !== false) { // Convert $groupnumber to a character series
730         $letter = 'A';
731         for($i=0; $i<$groupnumber; $i++) {
732             $letter++;
733         }
734         $str = str_replace('@', $letter, $format);
735     } else {
736         $str = str_replace('#', $groupnumber+1, $format);
737     }
738     return($str);
741 /**
742  * Assigns group into grouping
743  *
744  * @param int groupingid
745  * @param int groupid
746  * @param int $timeadded  The time the group was added to the grouping.
747  * @param bool $invalidatecache If set to true the course group cache will be invalidated as well.
748  * @return bool true or exception
749  */
750 function groups_assign_grouping($groupingid, $groupid, $timeadded = null, $invalidatecache = true) {
751     global $DB;
753     if ($DB->record_exists('groupings_groups', array('groupingid'=>$groupingid, 'groupid'=>$groupid))) {
754         return true;
755     }
756     $assign = new stdClass();
757     $assign->groupingid = $groupingid;
758     $assign->groupid    = $groupid;
759     if ($timeadded != null) {
760         $assign->timeadded = (integer)$timeadded;
761     } else {
762         $assign->timeadded = time();
763     }
764     $DB->insert_record('groupings_groups', $assign);
766     if ($invalidatecache) {
767         // Invalidate the grouping cache for the course
768         $courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
769         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
770     }
772     return true;
775 /**
776  * Unassigns group from grouping
777  *
778  * @param int groupingid
779  * @param int groupid
780  * @param bool $invalidatecache If set to true the course group cache will be invalidated as well.
781  * @return bool success
782  */
783 function groups_unassign_grouping($groupingid, $groupid, $invalidatecache = true) {
784     global $DB;
785     $DB->delete_records('groupings_groups', array('groupingid'=>$groupingid, 'groupid'=>$groupid));
787     if ($invalidatecache) {
788         // Invalidate the grouping cache for the course
789         $courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
790         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
791     }
793     return true;
796 /**
797  * Lists users in a group based on their role on the course.
798  * Returns false if there's an error or there are no users in the group.
799  * Otherwise returns an array of role ID => role data, where role data includes:
800  * (role) $id, $shortname, $name
801  * $users: array of objects for each user which include the specified fields
802  * Users who do not have a role are stored in the returned array with key '-'
803  * and pseudo-role details (including a name, 'No role'). Users with multiple
804  * roles, same deal with key '*' and name 'Multiple roles'. You can find out
805  * which roles each has by looking in the $roles array of the user object.
806  *
807  * @param int $groupid
808  * @param int $courseid Course ID (should match the group's course)
809  * @param string $fields List of fields from user table prefixed with u, default 'u.*'
810  * @param string $sort SQL ORDER BY clause, default (when null passed) is what comes from users_order_by_sql.
811  * @param string $extrawheretest extra SQL conditions ANDed with the existing where clause.
812  * @param array $whereorsortparams any parameters required by $extrawheretest (named parameters).
813  * @return array Complex array as described above
814  */
815 function groups_get_members_by_role($groupid, $courseid, $fields='u.*',
816         $sort=null, $extrawheretest='', $whereorsortparams=array()) {
817     global $CFG, $DB;
819     // Retrieve information about all users and their roles on the course or
820     // parent ('related') contexts
821     $context = context_course::instance($courseid);
823     if ($extrawheretest) {
824         $extrawheretest = ' AND ' . $extrawheretest;
825     }
827     if (is_null($sort)) {
828         list($sort, $sortparams) = users_order_by_sql('u');
829         $whereorsortparams = array_merge($whereorsortparams, $sortparams);
830     }
832     $sql = "SELECT r.id AS roleid, u.id AS userid, $fields
833               FROM {groups_members} gm
834               JOIN {user} u ON u.id = gm.userid
835          LEFT JOIN {role_assignments} ra ON (ra.userid = u.id AND ra.contextid ".get_related_contexts_string($context).")
836          LEFT JOIN {role} r ON r.id = ra.roleid
837              WHERE gm.groupid=:mgroupid
838                    ".$extrawheretest."
839           ORDER BY r.sortorder, $sort";
840     $whereorsortparams['mgroupid'] = $groupid;
841     $rs = $DB->get_recordset_sql($sql, $whereorsortparams);
843     return groups_calculate_role_people($rs, $context);
846 /**
847  * Internal function used by groups_get_members_by_role to handle the
848  * results of a database query that includes a list of users and possible
849  * roles on a course.
850  *
851  * @param moodle_recordset $rs The record set (may be false)
852  * @param int $context ID of course context
853  * @return array As described in groups_get_members_by_role
854  */
855 function groups_calculate_role_people($rs, $context) {
856     global $CFG, $DB;
858     if (!$rs) {
859         return array();
860     }
862     $allroles = role_fix_names(get_all_roles($context), $context);
864     // Array of all involved roles
865     $roles = array();
866     // Array of all retrieved users
867     $users = array();
868     // Fill arrays
869     foreach ($rs as $rec) {
870         // Create information about user if this is a new one
871         if (!array_key_exists($rec->userid, $users)) {
872             // User data includes all the optional fields, but not any of the
873             // stuff we added to get the role details
874             $userdata = clone($rec);
875             unset($userdata->roleid);
876             unset($userdata->roleshortname);
877             unset($userdata->rolename);
878             unset($userdata->userid);
879             $userdata->id = $rec->userid;
881             // Make an array to hold the list of roles for this user
882             $userdata->roles = array();
883             $users[$rec->userid] = $userdata;
884         }
885         // If user has a role...
886         if (!is_null($rec->roleid)) {
887             // Create information about role if this is a new one
888             if (!array_key_exists($rec->roleid, $roles)) {
889                 $role = $allroles[$rec->roleid];
890                 $roledata = new stdClass();
891                 $roledata->id        = $role->id;
892                 $roledata->shortname = $role->shortname;
893                 $roledata->name      = $role->localname;
894                 $roledata->users = array();
895                 $roles[$roledata->id] = $roledata;
896             }
897             // Record that user has role
898             $users[$rec->userid]->roles[$rec->roleid] = $roles[$rec->roleid];
899         }
900     }
901     $rs->close();
903     // Return false if there weren't any users
904     if (count($users) == 0) {
905         return false;
906     }
908     // Add pseudo-role for multiple roles
909     $roledata = new stdClass();
910     $roledata->name = get_string('multipleroles','role');
911     $roledata->users = array();
912     $roles['*'] = $roledata;
914     $roledata = new stdClass();
915     $roledata->name = get_string('noroles','role');
916     $roledata->users = array();
917     $roles[0] = $roledata;
919     // Now we rearrange the data to store users by role
920     foreach ($users as $userid=>$userdata) {
921         $rolecount = count($userdata->roles);
922         if ($rolecount == 0) {
923             // does not have any roles
924             $roleid = 0;
925         } else if($rolecount > 1) {
926             $roleid = '*';
927         } else {
928             $userrole = reset($userdata->roles);
929             $roleid = $userrole->id;
930         }
931         $roles[$roleid]->users[$userid] = $userdata;
932     }
934     // Delete roles not used
935     foreach ($roles as $key=>$roledata) {
936         if (count($roledata->users)===0) {
937             unset($roles[$key]);
938         }
939     }
941     // Return list of roles containing their users
942     return $roles;