MDL-63280 core: minor changes after review
[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     $context = context_course::instance($group->courseid);
69     if (!is_enrolled($context, $userid)) {
70         return false;
71     }
73     if (groups_is_member($groupid, $userid)) {
74         return true;
75     }
77     $member = new stdClass();
78     $member->groupid   = $groupid;
79     $member->userid    = $userid;
80     $member->timeadded = time();
81     $member->component = '';
82     $member->itemid = 0;
84     // Check the component exists if specified
85     if (!empty($component)) {
86         $dir = core_component::get_component_directory($component);
87         if ($dir && is_dir($dir)) {
88             // Component exists and can be used
89             $member->component = $component;
90             $member->itemid = $itemid;
91         } else {
92             throw new coding_exception('Invalid call to groups_add_member(). An invalid component was specified');
93         }
94     }
96     if ($itemid !== 0 && empty($member->component)) {
97         // An itemid can only be specified if a valid component was found
98         throw new coding_exception('Invalid call to groups_add_member(). A component must be specified if an itemid is given');
99     }
101     $DB->insert_record('groups_members', $member);
103     // Update group info, and group object.
104     $DB->set_field('groups', 'timemodified', $member->timeadded, array('id'=>$groupid));
105     $group->timemodified = $member->timeadded;
107     // Invalidate the group and grouping cache for users.
108     cache_helper::invalidate_by_definition('core', 'user_group_groupings', array(), array($userid));
110     // Trigger group event.
111     $params = array(
112         'context' => $context,
113         'objectid' => $groupid,
114         'relateduserid' => $userid,
115         'other' => array(
116             'component' => $member->component,
117             'itemid' => $member->itemid
118         )
119     );
120     $event = \core\event\group_member_added::create($params);
121     $event->add_record_snapshot('groups', $group);
122     $event->trigger();
124     return true;
127 /**
128  * Checks whether the current user is permitted (using the normal UI) to
129  * remove a specific group member, assuming that they have access to remove
130  * group members in general.
131  *
132  * For automatically-created group member entries, this checks with the
133  * relevant plugin to see whether it is permitted. The default, if the plugin
134  * doesn't provide a function, is true.
135  *
136  * For other entries (and any which have already been deleted/don't exist) it
137  * just returns true.
138  *
139  * @param mixed $grouporid The group id or group object
140  * @param mixed $userorid The user id or user object
141  * @return bool True if permitted, false otherwise
142  */
143 function groups_remove_member_allowed($grouporid, $userorid) {
144     global $DB;
146     if (is_object($userorid)) {
147         $userid = $userorid->id;
148     } else {
149         $userid = $userorid;
150     }
151     if (is_object($grouporid)) {
152         $groupid = $grouporid->id;
153     } else {
154         $groupid = $grouporid;
155     }
157     // Get entry
158     if (!($entry = $DB->get_record('groups_members',
159             array('groupid' => $groupid, 'userid' => $userid), '*', IGNORE_MISSING))) {
160         // If the entry does not exist, they are allowed to remove it (this
161         // is consistent with groups_remove_member below).
162         return true;
163     }
165     // If the entry does not have a component value, they can remove it
166     if (empty($entry->component)) {
167         return true;
168     }
170     // It has a component value, so we need to call a plugin function (if it
171     // exists); the default is to allow removal
172     return component_callback($entry->component, 'allow_group_member_remove',
173             array($entry->itemid, $entry->groupid, $entry->userid), true);
176 /**
177  * Deletes the link between the specified user and group.
178  *
179  * @param mixed $grouporid  The group id or group object
180  * @param mixed $userorid   The user id or user object
181  * @return bool True if deletion was successful, false otherwise
182  */
183 function groups_remove_member($grouporid, $userorid) {
184     global $DB;
186     if (is_object($userorid)) {
187         $userid = $userorid->id;
188     } else {
189         $userid = $userorid;
190     }
192     if (is_object($grouporid)) {
193         $groupid = $grouporid->id;
194         $group   = $grouporid;
195     } else {
196         $groupid = $grouporid;
197         $group = $DB->get_record('groups', array('id'=>$groupid), '*', MUST_EXIST);
198     }
200     if (!groups_is_member($groupid, $userid)) {
201         return true;
202     }
204     $DB->delete_records('groups_members', array('groupid'=>$groupid, 'userid'=>$userid));
206     // Update group info.
207     $time = time();
208     $DB->set_field('groups', 'timemodified', $time, array('id' => $groupid));
209     $group->timemodified = $time;
211     // Invalidate the group and grouping cache for users.
212     cache_helper::invalidate_by_definition('core', 'user_group_groupings', array(), array($userid));
214     // Trigger group event.
215     $params = array(
216         'context' => context_course::instance($group->courseid),
217         'objectid' => $groupid,
218         'relateduserid' => $userid
219     );
220     $event = \core\event\group_member_removed::create($params);
221     $event->add_record_snapshot('groups', $group);
222     $event->trigger();
224     return true;
227 /**
228  * Add a new group
229  *
230  * @param stdClass $data group properties
231  * @param stdClass $editform
232  * @param array $editoroptions
233  * @return id of group or false if error
234  */
235 function groups_create_group($data, $editform = false, $editoroptions = false) {
236     global $CFG, $DB, $USER;
238     //check that courseid exists
239     $course = $DB->get_record('course', array('id' => $data->courseid), '*', MUST_EXIST);
240     $context = context_course::instance($course->id);
242     $data->timecreated  = time();
243     $data->timemodified = $data->timecreated;
244     $data->name         = trim($data->name);
245     if (isset($data->idnumber)) {
246         $data->idnumber = trim($data->idnumber);
247         if (groups_get_group_by_idnumber($course->id, $data->idnumber)) {
248             throw new moodle_exception('idnumbertaken');
249         }
250     }
252     if ($editform and $editoroptions) {
253         $data->description = $data->description_editor['text'];
254         $data->descriptionformat = $data->description_editor['format'];
255     }
257     $data->id = $DB->insert_record('groups', $data);
259     if ($editform and $editoroptions) {
260         // Update description from editor with fixed files
261         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $context, 'group', 'description', $data->id);
262         $upd = new stdClass();
263         $upd->id                = $data->id;
264         $upd->description       = $data->description;
265         $upd->descriptionformat = $data->descriptionformat;
266         $DB->update_record('groups', $upd);
267     }
269     $group = $DB->get_record('groups', array('id'=>$data->id));
271     if ($editform) {
272         groups_update_group_icon($group, $data, $editform);
273     }
275     // Invalidate the grouping cache for the course
276     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($course->id));
278     // Group conversation messaging.
279     if (\core_message\api::can_create_group_conversation($USER->id, $context)) {
280         if (!empty($data->enablemessaging)) {
281             \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $context->id, $group->name, 1);
282         }
283     }
285     // Trigger group event.
286     $params = array(
287         'context' => $context,
288         'objectid' => $group->id
289     );
290     $event = \core\event\group_created::create($params);
291     $event->add_record_snapshot('groups', $group);
292     $event->trigger();
294     return $group->id;
297 /**
298  * Add a new grouping
299  *
300  * @param stdClass $data grouping properties
301  * @param array $editoroptions
302  * @return id of grouping or false if error
303  */
304 function groups_create_grouping($data, $editoroptions=null) {
305     global $DB;
307     $data->timecreated  = time();
308     $data->timemodified = $data->timecreated;
309     $data->name         = trim($data->name);
310     if (isset($data->idnumber)) {
311         $data->idnumber = trim($data->idnumber);
312         if (groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) {
313             throw new moodle_exception('idnumbertaken');
314         }
315     }
317     if ($editoroptions !== null) {
318         $data->description = $data->description_editor['text'];
319         $data->descriptionformat = $data->description_editor['format'];
320     }
322     $id = $DB->insert_record('groupings', $data);
323     $data->id = $id;
325     if ($editoroptions !== null) {
326         $description = new stdClass;
327         $description->id = $data->id;
328         $description->description_editor = $data->description_editor;
329         $description = file_postupdate_standard_editor($description, 'description', $editoroptions, $editoroptions['context'], 'grouping', 'description', $description->id);
330         $DB->update_record('groupings', $description);
331     }
333     // Invalidate the grouping cache for the course
334     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
336     // Trigger group event.
337     $params = array(
338         'context' => context_course::instance($data->courseid),
339         'objectid' => $id
340     );
341     $event = \core\event\grouping_created::create($params);
342     $event->trigger();
344     return $id;
347 /**
348  * Update the group icon from form data
349  *
350  * @param stdClass $group group information
351  * @param stdClass $data
352  * @param stdClass $editform
353  */
354 function groups_update_group_icon($group, $data, $editform) {
355     global $CFG, $DB;
356     require_once("$CFG->libdir/gdlib.php");
358     $fs = get_file_storage();
359     $context = context_course::instance($group->courseid, MUST_EXIST);
360     $newpicture = $group->picture;
362     if (!empty($data->deletepicture)) {
363         $fs->delete_area_files($context->id, 'group', 'icon', $group->id);
364         $newpicture = 0;
365     } else if ($iconfile = $editform->save_temp_file('imagefile')) {
366         if ($rev = process_new_icon($context, 'group', 'icon', $group->id, $iconfile)) {
367             $newpicture = $rev;
368         } else {
369             $fs->delete_area_files($context->id, 'group', 'icon', $group->id);
370             $newpicture = 0;
371         }
372         @unlink($iconfile);
373     }
375     if ($newpicture != $group->picture) {
376         $DB->set_field('groups', 'picture', $newpicture, array('id' => $group->id));
377         $group->picture = $newpicture;
379         // Invalidate the group data as we've updated the group record.
380         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($group->courseid));
381     }
384 /**
385  * Update group
386  *
387  * @param stdClass $data group properties (with magic quotes)
388  * @param stdClass $editform
389  * @param array $editoroptions
390  * @return bool true or exception
391  */
392 function groups_update_group($data, $editform = false, $editoroptions = false) {
393     global $CFG, $DB, $USER;
395     $context = context_course::instance($data->courseid);
397     $data->timemodified = time();
398     if (isset($data->name)) {
399         $data->name = trim($data->name);
400     }
401     if (isset($data->idnumber)) {
402         $data->idnumber = trim($data->idnumber);
403         if (($existing = groups_get_group_by_idnumber($data->courseid, $data->idnumber)) && $existing->id != $data->id) {
404             throw new moodle_exception('idnumbertaken');
405         }
406     }
408     if ($editform and $editoroptions) {
409         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $context, 'group', 'description', $data->id);
410     }
412     $DB->update_record('groups', $data);
414     // Invalidate the group data.
415     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
417     $group = $DB->get_record('groups', array('id'=>$data->id));
419     if ($editform) {
420         groups_update_group_icon($group, $data, $editform);
421     }
423     // Group conversation messaging.
424     if (\core_message\api::can_create_group_conversation($USER->id, $context)) {
425         if ($conversationarea = \core_message\api::get_conversation_area('core_group', 'groups', $group->id, $context->id)) {
426             if ($data->enablemessaging && $data->enablemessaging != $conversationarea->enabled) {
427                 \core_message\api::enable_conversation_area($conversationarea->id);
428             }
429             if (!$data->enablemessaging && $data->enablemessaging != $conversationarea->enabled) {
430                 \core_message\api::disable_conversation_area($conversationarea->id);
431             }
432             \core_message\api::update_conversation_name($conversationarea->conversationid, $group->name);
433         } else {
434             if (!empty($data->enablemessaging)) {
435                 \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $context->id, $group->name, 1);
436             }
437         }
438     }
440     // Trigger group event.
441     $params = array(
442         'context' => $context,
443         'objectid' => $group->id
444     );
445     $event = \core\event\group_updated::create($params);
446     $event->add_record_snapshot('groups', $group);
447     $event->trigger();
449     return true;
452 /**
453  * Update grouping
454  *
455  * @param stdClass $data grouping properties (with magic quotes)
456  * @param array $editoroptions
457  * @return bool true or exception
458  */
459 function groups_update_grouping($data, $editoroptions=null) {
460     global $DB;
461     $data->timemodified = time();
462     if (isset($data->name)) {
463         $data->name = trim($data->name);
464     }
465     if (isset($data->idnumber)) {
466         $data->idnumber = trim($data->idnumber);
467         if (($existing = groups_get_grouping_by_idnumber($data->courseid, $data->idnumber)) && $existing->id != $data->id) {
468             throw new moodle_exception('idnumbertaken');
469         }
470     }
471     if ($editoroptions !== null) {
472         $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $editoroptions['context'], 'grouping', 'description', $data->id);
473     }
474     $DB->update_record('groupings', $data);
476     // Invalidate the group data.
477     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($data->courseid));
479     // Trigger group event.
480     $params = array(
481         'context' => context_course::instance($data->courseid),
482         'objectid' => $data->id
483     );
484     $event = \core\event\grouping_updated::create($params);
485     $event->trigger();
487     return true;
490 /**
491  * Delete a group best effort, first removing members and links with courses and groupings.
492  * Removes group avatar too.
493  *
494  * @param mixed $grouporid The id of group to delete or full group object
495  * @return bool True if deletion was successful, false otherwise
496  */
497 function groups_delete_group($grouporid) {
498     global $CFG, $DB;
499     require_once("$CFG->libdir/gdlib.php");
501     if (is_object($grouporid)) {
502         $groupid = $grouporid->id;
503         $group   = $grouporid;
504     } else {
505         $groupid = $grouporid;
506         if (!$group = $DB->get_record('groups', array('id'=>$groupid))) {
507             //silently ignore attempts to delete missing already deleted groups ;-)
508             return true;
509         }
510     }
512     // delete group calendar events
513     $DB->delete_records('event', array('groupid'=>$groupid));
514     //first delete usage in groupings_groups
515     $DB->delete_records('groupings_groups', array('groupid'=>$groupid));
516     //delete members
517     $DB->delete_records('groups_members', array('groupid'=>$groupid));
518     //group itself last
519     $DB->delete_records('groups', array('id'=>$groupid));
521     // Delete all files associated with this group
522     $context = context_course::instance($group->courseid);
523     $fs = get_file_storage();
524     $fs->delete_area_files($context->id, 'group', 'description', $groupid);
525     $fs->delete_area_files($context->id, 'group', 'icon', $groupid);
527     // Invalidate the grouping cache for the course
528     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($group->courseid));
529     // Purge the group and grouping cache for users.
530     cache_helper::purge_by_definition('core', 'user_group_groupings');
532     // Trigger group event.
533     $params = array(
534         'context' => $context,
535         'objectid' => $groupid
536     );
537     $event = \core\event\group_deleted::create($params);
538     $event->add_record_snapshot('groups', $group);
539     $event->trigger();
541     return true;
544 /**
545  * Delete grouping
546  *
547  * @param int $groupingorid
548  * @return bool success
549  */
550 function groups_delete_grouping($groupingorid) {
551     global $DB;
553     if (is_object($groupingorid)) {
554         $groupingid = $groupingorid->id;
555         $grouping   = $groupingorid;
556     } else {
557         $groupingid = $groupingorid;
558         if (!$grouping = $DB->get_record('groupings', array('id'=>$groupingorid))) {
559             //silently ignore attempts to delete missing already deleted groupings ;-)
560             return true;
561         }
562     }
564     //first delete usage in groupings_groups
565     $DB->delete_records('groupings_groups', array('groupingid'=>$groupingid));
566     // remove the default groupingid from course
567     $DB->set_field('course', 'defaultgroupingid', 0, array('defaultgroupingid'=>$groupingid));
568     // remove the groupingid from all course modules
569     $DB->set_field('course_modules', 'groupingid', 0, array('groupingid'=>$groupingid));
570     //group itself last
571     $DB->delete_records('groupings', array('id'=>$groupingid));
573     $context = context_course::instance($grouping->courseid);
574     $fs = get_file_storage();
575     $files = $fs->get_area_files($context->id, 'grouping', 'description', $groupingid);
576     foreach ($files as $file) {
577         $file->delete();
578     }
580     // Invalidate the grouping cache for the course
581     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($grouping->courseid));
582     // Purge the group and grouping cache for users.
583     cache_helper::purge_by_definition('core', 'user_group_groupings');
585     // Trigger group event.
586     $params = array(
587         'context' => $context,
588         'objectid' => $groupingid
589     );
590     $event = \core\event\grouping_deleted::create($params);
591     $event->add_record_snapshot('groupings', $grouping);
592     $event->trigger();
594     return true;
597 /**
598  * Remove all users (or one user) from all groups in course
599  *
600  * @param int $courseid
601  * @param int $userid 0 means all users
602  * @param bool $unused - formerly $showfeedback, is no longer used.
603  * @return bool success
604  */
605 function groups_delete_group_members($courseid, $userid=0, $unused=false) {
606     global $DB, $OUTPUT;
608     // Get the users in the course which are in a group.
609     $sql = "SELECT gm.id as gmid, gm.userid, g.*
610               FROM {groups_members} gm
611         INNER JOIN {groups} g
612                 ON gm.groupid = g.id
613              WHERE g.courseid = :courseid";
614     $params = array();
615     $params['courseid'] = $courseid;
616     // Check if we want to delete a specific user.
617     if ($userid) {
618         $sql .= " AND gm.userid = :userid";
619         $params['userid'] = $userid;
620     }
621     $rs = $DB->get_recordset_sql($sql, $params);
622     foreach ($rs as $usergroup) {
623         groups_remove_member($usergroup, $usergroup->userid);
624     }
625     $rs->close();
627     return true;
630 /**
631  * Remove all groups from all groupings in course
632  *
633  * @param int $courseid
634  * @param bool $showfeedback
635  * @return bool success
636  */
637 function groups_delete_groupings_groups($courseid, $showfeedback=false) {
638     global $DB, $OUTPUT;
640     $groupssql = "SELECT id FROM {groups} g WHERE g.courseid = ?";
641     $results = $DB->get_recordset_select('groupings_groups', "groupid IN ($groupssql)",
642         array($courseid), '', 'groupid, groupingid');
644     foreach ($results as $result) {
645         groups_unassign_grouping($result->groupingid, $result->groupid, false);
646     }
647     $results->close();
649     // Invalidate the grouping cache for the course
650     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
651     // Purge the group and grouping cache for users.
652     cache_helper::purge_by_definition('core', 'user_group_groupings');
654     // no need to show any feedback here - we delete usually first groupings and then groups
656     return true;
659 /**
660  * Delete all groups from course
661  *
662  * @param int $courseid
663  * @param bool $showfeedback
664  * @return bool success
665  */
666 function groups_delete_groups($courseid, $showfeedback=false) {
667     global $CFG, $DB, $OUTPUT;
669     $groups = $DB->get_recordset('groups', array('courseid' => $courseid));
670     foreach ($groups as $group) {
671         groups_delete_group($group);
672     }
673     $groups->close();
675     // Invalidate the grouping cache for the course
676     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
677     // Purge the group and grouping cache for users.
678     cache_helper::purge_by_definition('core', 'user_group_groupings');
680     if ($showfeedback) {
681         echo $OUTPUT->notification(get_string('deleted').' - '.get_string('groups', 'group'), 'notifysuccess');
682     }
684     return true;
687 /**
688  * Delete all groupings from course
689  *
690  * @param int $courseid
691  * @param bool $showfeedback
692  * @return bool success
693  */
694 function groups_delete_groupings($courseid, $showfeedback=false) {
695     global $DB, $OUTPUT;
697     $groupings = $DB->get_recordset_select('groupings', 'courseid = ?', array($courseid));
698     foreach ($groupings as $grouping) {
699         groups_delete_grouping($grouping);
700     }
701     $groupings->close();
703     // Invalidate the grouping cache for the course.
704     cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
705     // Purge the group and grouping cache for users.
706     cache_helper::purge_by_definition('core', 'user_group_groupings');
708     if ($showfeedback) {
709         echo $OUTPUT->notification(get_string('deleted').' - '.get_string('groupings', 'group'), 'notifysuccess');
710     }
712     return true;
715 /* =================================== */
716 /* various functions used by groups UI */
717 /* =================================== */
719 /**
720  * Obtains a list of the possible roles that group members might come from,
721  * on a course. Generally this includes only profile roles.
722  *
723  * @param context $context Context of course
724  * @return Array of role ID integers, or false if error/none.
725  */
726 function groups_get_possible_roles($context) {
727     $roles = get_profile_roles($context);
728     return array_keys($roles);
732 /**
733  * Gets potential group members for grouping
734  *
735  * @param int $courseid The id of the course
736  * @param int $roleid The role to select users from
737  * @param mixed $source restrict to cohort, grouping or group id
738  * @param string $orderby The column to sort users by
739  * @param int $notingroup restrict to users not in existing groups
740  * @param bool $onlyactiveenrolments restrict to users who have an active enrolment in the course
741  * @return array An array of the users
742  */
743 function groups_get_potential_members($courseid, $roleid = null, $source = null,
744                                       $orderby = 'lastname ASC, firstname ASC',
745                                       $notingroup = null, $onlyactiveenrolments = false) {
746     global $DB;
748     $context = context_course::instance($courseid);
750     list($esql, $params) = get_enrolled_sql($context, '', 0, $onlyactiveenrolments);
752     $notingroupsql = "";
753     if ($notingroup) {
754         // We want to eliminate users that are already associated with a course group.
755         $notingroupsql = "u.id NOT IN (SELECT userid
756                                          FROM {groups_members}
757                                         WHERE groupid IN (SELECT id
758                                                             FROM {groups}
759                                                            WHERE courseid = :courseid))";
760         $params['courseid'] = $courseid;
761     }
763     if ($roleid) {
764         // We are looking for all users with this role assigned in this context or higher.
765         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true),
766                                                                        SQL_PARAMS_NAMED,
767                                                                        'relatedctx');
769         $params = array_merge($params, $relatedctxparams, array('roleid' => $roleid));
770         $where = "WHERE u.id IN (SELECT userid
771                                    FROM {role_assignments}
772                                   WHERE roleid = :roleid AND contextid $relatedctxsql)";
773         $where .= $notingroup ? "AND $notingroupsql" : "";
774     } else if ($notingroup) {
775         $where = "WHERE $notingroupsql";
776     } else {
777         $where = "";
778     }
780     $sourcejoin = "";
781     if (is_int($source)) {
782         $sourcejoin .= "JOIN {cohort_members} cm ON (cm.userid = u.id AND cm.cohortid = :cohortid) ";
783         $params['cohortid'] = $source;
784     } else {
785         // Auto-create groups from an existing cohort membership.
786         if (isset($source['cohortid'])) {
787             $sourcejoin .= "JOIN {cohort_members} cm ON (cm.userid = u.id AND cm.cohortid = :cohortid) ";
788             $params['cohortid'] = $source['cohortid'];
789         }
790         // Auto-create groups from an existing group membership.
791         if (isset($source['groupid'])) {
792             $sourcejoin .= "JOIN {groups_members} gp ON (gp.userid = u.id AND gp.groupid = :groupid) ";
793             $params['groupid'] = $source['groupid'];
794         }
795         // Auto-create groups from an existing grouping membership.
796         if (isset($source['groupingid'])) {
797             $sourcejoin .= "JOIN {groupings_groups} gg ON gg.groupingid = :groupingid ";
798             $sourcejoin .= "JOIN {groups_members} gm ON (gm.userid = u.id AND gm.groupid = gg.groupid) ";
799             $params['groupingid'] = $source['groupingid'];
800         }
801     }
803     $allusernamefields = get_all_user_name_fields(true, 'u');
804     $sql = "SELECT DISTINCT u.id, u.username, $allusernamefields, u.idnumber
805               FROM {user} u
806               JOIN ($esql) e ON e.id = u.id
807        $sourcejoin
808             $where
809           ORDER BY $orderby";
811     return $DB->get_records_sql($sql, $params);
815 /**
816  * Parse a group name for characters to replace
817  *
818  * @param string $format The format a group name will follow
819  * @param int $groupnumber The number of the group to be used in the parsed format string
820  * @return string the parsed format string
821  */
822 function groups_parse_name($format, $groupnumber) {
823     if (strstr($format, '@') !== false) { // Convert $groupnumber to a character series
824         $letter = 'A';
825         for($i=0; $i<$groupnumber; $i++) {
826             $letter++;
827         }
828         $str = str_replace('@', $letter, $format);
829     } else {
830         $str = str_replace('#', $groupnumber+1, $format);
831     }
832     return($str);
835 /**
836  * Assigns group into grouping
837  *
838  * @param int groupingid
839  * @param int groupid
840  * @param int $timeadded  The time the group was added to the grouping.
841  * @param bool $invalidatecache If set to true the course group cache and the user group cache will be invalidated as well.
842  * @return bool true or exception
843  */
844 function groups_assign_grouping($groupingid, $groupid, $timeadded = null, $invalidatecache = true) {
845     global $DB;
847     if ($DB->record_exists('groupings_groups', array('groupingid'=>$groupingid, 'groupid'=>$groupid))) {
848         return true;
849     }
850     $assign = new stdClass();
851     $assign->groupingid = $groupingid;
852     $assign->groupid    = $groupid;
853     if ($timeadded != null) {
854         $assign->timeadded = (integer)$timeadded;
855     } else {
856         $assign->timeadded = time();
857     }
858     $DB->insert_record('groupings_groups', $assign);
860     $courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
861     if ($invalidatecache) {
862         // Invalidate the grouping cache for the course
863         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
864         // Purge the group and grouping cache for users.
865         cache_helper::purge_by_definition('core', 'user_group_groupings');
866     }
868     // Trigger event.
869     $params = array(
870         'context' => context_course::instance($courseid),
871         'objectid' => $groupingid,
872         'other' => array('groupid' => $groupid)
873     );
874     $event = \core\event\grouping_group_assigned::create($params);
875     $event->trigger();
877     return true;
880 /**
881  * Unassigns group from grouping
882  *
883  * @param int groupingid
884  * @param int groupid
885  * @param bool $invalidatecache If set to true the course group cache and the user group cache will be invalidated as well.
886  * @return bool success
887  */
888 function groups_unassign_grouping($groupingid, $groupid, $invalidatecache = true) {
889     global $DB;
890     $DB->delete_records('groupings_groups', array('groupingid'=>$groupingid, 'groupid'=>$groupid));
892     $courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
893     if ($invalidatecache) {
894         // Invalidate the grouping cache for the course
895         cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
896         // Purge the group and grouping cache for users.
897         cache_helper::purge_by_definition('core', 'user_group_groupings');
898     }
900     // Trigger event.
901     $params = array(
902         'context' => context_course::instance($courseid),
903         'objectid' => $groupingid,
904         'other' => array('groupid' => $groupid)
905     );
906     $event = \core\event\grouping_group_unassigned::create($params);
907     $event->trigger();
909     return true;
912 /**
913  * Lists users in a group based on their role on the course.
914  * Returns false if there's an error or there are no users in the group.
915  * Otherwise returns an array of role ID => role data, where role data includes:
916  * (role) $id, $shortname, $name
917  * $users: array of objects for each user which include the specified fields
918  * Users who do not have a role are stored in the returned array with key '-'
919  * and pseudo-role details (including a name, 'No role'). Users with multiple
920  * roles, same deal with key '*' and name 'Multiple roles'. You can find out
921  * which roles each has by looking in the $roles array of the user object.
922  *
923  * @param int $groupid
924  * @param int $courseid Course ID (should match the group's course)
925  * @param string $fields List of fields from user table prefixed with u, default 'u.*'
926  * @param string $sort SQL ORDER BY clause, default (when null passed) is what comes from users_order_by_sql.
927  * @param string $extrawheretest extra SQL conditions ANDed with the existing where clause.
928  * @param array $whereorsortparams any parameters required by $extrawheretest (named parameters).
929  * @return array Complex array as described above
930  */
931 function groups_get_members_by_role($groupid, $courseid, $fields='u.*',
932         $sort=null, $extrawheretest='', $whereorsortparams=array()) {
933     global $DB;
935     // Retrieve information about all users and their roles on the course or
936     // parent ('related') contexts
937     $context = context_course::instance($courseid);
939     // We are looking for all users with this role assigned in this context or higher.
940     list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
942     if ($extrawheretest) {
943         $extrawheretest = ' AND ' . $extrawheretest;
944     }
946     if (is_null($sort)) {
947         list($sort, $sortparams) = users_order_by_sql('u');
948         $whereorsortparams = array_merge($whereorsortparams, $sortparams);
949     }
951     $sql = "SELECT r.id AS roleid, u.id AS userid, $fields
952               FROM {groups_members} gm
953               JOIN {user} u ON u.id = gm.userid
954          LEFT JOIN {role_assignments} ra ON (ra.userid = u.id AND ra.contextid $relatedctxsql)
955          LEFT JOIN {role} r ON r.id = ra.roleid
956              WHERE gm.groupid=:mgroupid
957                    ".$extrawheretest."
958           ORDER BY r.sortorder, $sort";
959     $whereorsortparams = array_merge($whereorsortparams, $relatedctxparams, array('mgroupid' => $groupid));
960     $rs = $DB->get_recordset_sql($sql, $whereorsortparams);
962     return groups_calculate_role_people($rs, $context);
965 /**
966  * Internal function used by groups_get_members_by_role to handle the
967  * results of a database query that includes a list of users and possible
968  * roles on a course.
969  *
970  * @param moodle_recordset $rs The record set (may be false)
971  * @param int $context ID of course context
972  * @return array As described in groups_get_members_by_role
973  */
974 function groups_calculate_role_people($rs, $context) {
975     global $CFG, $DB;
977     if (!$rs) {
978         return array();
979     }
981     $allroles = role_fix_names(get_all_roles($context), $context);
982     $visibleroles = get_viewable_roles($context);
984     // Array of all involved roles
985     $roles = array();
986     // Array of all retrieved users
987     $users = array();
988     // Fill arrays
989     foreach ($rs as $rec) {
990         // Create information about user if this is a new one
991         if (!array_key_exists($rec->userid, $users)) {
992             // User data includes all the optional fields, but not any of the
993             // stuff we added to get the role details
994             $userdata = clone($rec);
995             unset($userdata->roleid);
996             unset($userdata->roleshortname);
997             unset($userdata->rolename);
998             unset($userdata->userid);
999             $userdata->id = $rec->userid;
1001             // Make an array to hold the list of roles for this user
1002             $userdata->roles = array();
1003             $users[$rec->userid] = $userdata;
1004         }
1005         // If user has a role...
1006         if (!is_null($rec->roleid)) {
1007             // Create information about role if this is a new one
1008             if (!array_key_exists($rec->roleid, $roles)) {
1009                 $role = $allroles[$rec->roleid];
1010                 $roledata = new stdClass();
1011                 $roledata->id        = $role->id;
1012                 $roledata->shortname = $role->shortname;
1013                 $roledata->name      = $role->localname;
1014                 $roledata->users = array();
1015                 $roles[$roledata->id] = $roledata;
1016             }
1017             // Record that user has role
1018             $users[$rec->userid]->roles[$rec->roleid] = $roles[$rec->roleid];
1019         }
1020     }
1021     $rs->close();
1023     // Return false if there weren't any users
1024     if (count($users) == 0) {
1025         return false;
1026     }
1028     // Add pseudo-role for multiple roles
1029     $roledata = new stdClass();
1030     $roledata->name = get_string('multipleroles','role');
1031     $roledata->users = array();
1032     $roles['*'] = $roledata;
1034     $roledata = new stdClass();
1035     $roledata->name = get_string('noroles','role');
1036     $roledata->users = array();
1037     $roles[0] = $roledata;
1039     // Now we rearrange the data to store users by role
1040     foreach ($users as $userid=>$userdata) {
1041         $visibleuserroles = array_intersect_key($userdata->roles, $visibleroles);
1042         $rolecount = count($visibleuserroles);
1043         if ($rolecount == 0) {
1044             // does not have any roles
1045             $roleid = 0;
1046         } else if($rolecount > 1) {
1047             $roleid = '*';
1048         } else {
1049             $userrole = reset($visibleuserroles);
1050             $roleid = $userrole->id;
1051         }
1052         $roles[$roleid]->users[$userid] = $userdata;
1053     }
1055     // Delete roles not used
1056     foreach ($roles as $key=>$roledata) {
1057         if (count($roledata->users)===0) {
1058             unset($roles[$key]);
1059         }
1060     }
1062     // Return list of roles containing their users
1063     return $roles;
1066 /**
1067  * Synchronises enrolments with the group membership
1068  *
1069  * Designed for enrolment methods provide automatic synchronisation between enrolled users
1070  * and group membership, such as enrol_cohort and enrol_meta .
1071  *
1072  * @param string $enrolname name of enrolment method without prefix
1073  * @param int $courseid course id where sync needs to be performed (0 for all courses)
1074  * @param string $gidfield name of the field in 'enrol' table that stores group id
1075  * @return array Returns the list of removed and added users. Each record contains fields:
1076  *                  userid, enrolid, courseid, groupid, groupname
1077  */
1078 function groups_sync_with_enrolment($enrolname, $courseid = 0, $gidfield = 'customint2') {
1079     global $DB;
1080     $onecourse = $courseid ? "AND e.courseid = :courseid" : "";
1081     $params = array(
1082         'enrolname' => $enrolname,
1083         'component' => 'enrol_'.$enrolname,
1084         'courseid' => $courseid
1085     );
1087     $affectedusers = array(
1088         'removed' => array(),
1089         'added' => array()
1090     );
1092     // Remove invalid.
1093     $sql = "SELECT ue.userid, ue.enrolid, e.courseid, g.id AS groupid, g.name AS groupname
1094               FROM {groups_members} gm
1095               JOIN {groups} g ON (g.id = gm.groupid)
1096               JOIN {enrol} e ON (e.enrol = :enrolname AND e.courseid = g.courseid $onecourse)
1097               JOIN {user_enrolments} ue ON (ue.userid = gm.userid AND ue.enrolid = e.id)
1098              WHERE gm.component=:component AND gm.itemid = e.id AND g.id <> e.{$gidfield}";
1100     $rs = $DB->get_recordset_sql($sql, $params);
1101     foreach ($rs as $gm) {
1102         groups_remove_member($gm->groupid, $gm->userid);
1103         $affectedusers['removed'][] = $gm;
1104     }
1105     $rs->close();
1107     // Add missing.
1108     $sql = "SELECT ue.userid, ue.enrolid, e.courseid, g.id AS groupid, g.name AS groupname
1109               FROM {user_enrolments} ue
1110               JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = :enrolname $onecourse)
1111               JOIN {groups} g ON (g.courseid = e.courseid AND g.id = e.{$gidfield})
1112               JOIN {user} u ON (u.id = ue.userid AND u.deleted = 0)
1113          LEFT JOIN {groups_members} gm ON (gm.groupid = g.id AND gm.userid = ue.userid)
1114              WHERE gm.id IS NULL";
1116     $rs = $DB->get_recordset_sql($sql, $params);
1117     foreach ($rs as $ue) {
1118         groups_add_member($ue->groupid, $ue->userid, 'enrol_'.$enrolname, $ue->enrolid);
1119         $affectedusers['added'][] = $ue;
1120     }
1121     $rs->close();
1123     return $affectedusers;
1126 /**
1127  * Callback for inplace editable API.
1128  *
1129  * @param string $itemtype - Only user_groups is supported.
1130  * @param string $itemid - Userid and groupid separated by a :
1131  * @param string $newvalue - json encoded list of groupids.
1132  * @return \core\output\inplace_editable
1133  */
1134 function core_group_inplace_editable($itemtype, $itemid, $newvalue) {
1135     if ($itemtype === 'user_groups') {
1136         return \core_group\output\user_groups_editable::update($itemid, $newvalue);
1137     }