MDL-41192 course: Added property-read cm_info::effectivegroupmode
[moodle.git] / lib / grouplib.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  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
20  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  * @package    core_group
22  */
24 defined('MOODLE_INTERNAL') || die();
26 /**
27  * Groups not used in course or activity
28  */
29 define('NOGROUPS', 0);
31 /**
32  * Groups used, users do not see other groups
33  */
34 define('SEPARATEGROUPS', 1);
36 /**
37  * Groups used, students see other groups
38  */
39 define('VISIBLEGROUPS', 2);
42 /**
43  * Determines if a group with a given groupid exists.
44  *
45  * @category group
46  * @param int $groupid The groupid to check for
47  * @return bool True if the group exists, false otherwise or if an error
48  * occurred.
49  */
50 function groups_group_exists($groupid) {
51     global $DB;
52     return $DB->record_exists('groups', array('id'=>$groupid));
53 }
55 /**
56  * Gets the name of a group with a specified id
57  *
58  * @category group
59  * @param int $groupid The id of the group
60  * @return string The name of the group
61  */
62 function groups_get_group_name($groupid) {
63     global $DB;
64     return $DB->get_field('groups', 'name', array('id'=>$groupid));
65 }
67 /**
68  * Gets the name of a grouping with a specified id
69  *
70  * @category group
71  * @param int $groupingid The id of the grouping
72  * @return string The name of the grouping
73  */
74 function groups_get_grouping_name($groupingid) {
75     global $DB;
76     return $DB->get_field('groupings', 'name', array('id'=>$groupingid));
77 }
79 /**
80  * Returns the groupid of a group with the name specified for the course.
81  * Group names should be unique in course
82  *
83  * @category group
84  * @param int $courseid The id of the course
85  * @param string $name name of group (without magic quotes)
86  * @return int $groupid
87  */
88 function groups_get_group_by_name($courseid, $name) {
89     $data = groups_get_course_data($courseid);
90     foreach ($data->groups as $group) {
91         if ($group->name == $name) {
92             return $group->id;
93         }
94     }
95     return false;
96 }
98 /**
99  * Returns the groupid of a group with the idnumber specified for the course.
100  * Group idnumbers should be unique within course
101  *
102  * @category group
103  * @param int $courseid The id of the course
104  * @param string $idnumber idnumber of group
105  * @return group object
106  */
107 function groups_get_group_by_idnumber($courseid, $idnumber) {
108     if (empty($idnumber)) {
109         return false;
110     }
111     $data = groups_get_course_data($courseid);
112     foreach ($data->groups as $group) {
113         if ($group->idnumber == $idnumber) {
114             return $group;
115         }
116     }
117     return false;
120 /**
121  * Returns the groupingid of a grouping with the name specified for the course.
122  * Grouping names should be unique in course
123  *
124  * @category group
125  * @param int $courseid The id of the course
126  * @param string $name name of group (without magic quotes)
127  * @return int $groupid
128  */
129 function groups_get_grouping_by_name($courseid, $name) {
130     $data = groups_get_course_data($courseid);
131     foreach ($data->groupings as $grouping) {
132         if ($grouping->name == $name) {
133             return $grouping->id;
134         }
135     }
136     return false;
139 /**
140  * Returns the groupingid of a grouping with the idnumber specified for the course.
141  * Grouping names should be unique within course
142  *
143  * @category group
144  * @param int $courseid The id of the course
145  * @param string $idnumber idnumber of the group
146  * @return grouping object
147  */
148 function groups_get_grouping_by_idnumber($courseid, $idnumber) {
149     if (empty($idnumber)) {
150         return false;
151     }
152     $data = groups_get_course_data($courseid);
153     foreach ($data->groupings as $grouping) {
154         if ($grouping->idnumber == $idnumber) {
155             return $grouping;
156         }
157     }
158     return false;
161 /**
162  * Get the group object
163  *
164  * @category group
165  * @param int $groupid ID of the group.
166  * @param string $fields (default is all fields)
167  * @param int $strictness (IGNORE_MISSING - default)
168  * @return stdGlass group object
169  */
170 function groups_get_group($groupid, $fields='*', $strictness=IGNORE_MISSING) {
171     global $DB;
172     return $DB->get_record('groups', array('id'=>$groupid), $fields, $strictness);
175 /**
176  * Get the grouping object
177  *
178  * @category group
179  * @param int $groupingid ID of the group.
180  * @param string $fields
181  * @param int $strictness (IGNORE_MISSING - default)
182  * @return stdClass group object
183  */
184 function groups_get_grouping($groupingid, $fields='*', $strictness=IGNORE_MISSING) {
185     global $DB;
186     return $DB->get_record('groupings', array('id'=>$groupingid), $fields, $strictness);
189 /**
190  * Gets array of all groups in a specified course.
191  *
192  * @category group
193  * @param int $courseid The id of the course.
194  * @param mixed $userid optional user id or array of ids, returns only groups of the user.
195  * @param int $groupingid optional returns only groups in the specified grouping.
196  * @param string $fields
197  * @return array Returns an array of the group objects (userid field returned if array in $userid)
198  */
199 function groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*') {
200     global $DB;
202     // We need to check that we each field in the fields list belongs to the group table and that it has not being
203     // aliased. If its something else we need to avoid the cache and run the query as who knows whats going on.
204     $knownfields = true;
205     if ($fields !== 'g.*') {
206         $fieldbits = explode(',', $fields);
207         foreach ($fieldbits as $bit) {
208             $bit = trim($bit);
209             if (strpos($bit, 'g.') !== 0 or stripos($bit, ' AS ') !== false) {
210                 $knownfields = false;
211                 break;
212             }
213         }
214     }
216     if (empty($userid) && $knownfields) {
217         // We can use the cache.
218         $data = groups_get_course_data($courseid);
219         if (empty($groupingid)) {
220             // All groups.. Easy!
221             $groups = $data->groups;
222         } else {
223             $groups = array();
224             foreach ($data->mappings as $mapping) {
225                 if ($mapping->groupingid != $groupingid) {
226                     continue;
227                 }
228                 if (isset($data->groups[$mapping->groupid])) {
229                     $groups[$mapping->groupid] = $data->groups[$mapping->groupid];
230                 }
231             }
232         }
233         // Yay! We could use the cache. One more query saved.
234         return $groups;
235     }
238     if (empty($userid)) {
239         $userfrom  = "";
240         $userwhere = "";
241         $params = array();
243     } else {
244         list($usql, $params) = $DB->get_in_or_equal($userid);
245         $userfrom  = ", {groups_members} gm";
246         $userwhere = "AND g.id = gm.groupid AND gm.userid $usql";
247     }
249     if (!empty($groupingid)) {
250         $groupingfrom  = ", {groupings_groups} gg";
251         $groupingwhere = "AND g.id = gg.groupid AND gg.groupingid = ?";
252         $params[] = $groupingid;
253     } else {
254         $groupingfrom  = "";
255         $groupingwhere = "";
256     }
258     array_unshift($params, $courseid);
260     return $DB->get_records_sql("SELECT $fields
261                                    FROM {groups} g $userfrom $groupingfrom
262                                   WHERE g.courseid = ? $userwhere $groupingwhere
263                                ORDER BY name ASC", $params);
267 /**
268  * Gets array of all groups in current user.
269  *
270  * @since Moodle 2.5
271  * @category group
272  * @return array Returns an array of the group objects.
273  */
274 function groups_get_my_groups() {
275     global $DB, $USER;
276     return $DB->get_records_sql("SELECT *
277                                    FROM {groups_members} gm
278                                    JOIN {groups} g
279                                     ON g.id = gm.groupid
280                                   WHERE gm.userid = ?
281                                    ORDER BY name ASC", array($USER->id));
284 /**
285  * Returns info about user's groups in course.
286  *
287  * @category group
288  * @param int $courseid
289  * @param int $userid $USER if not specified
290  * @return array Array[groupingid][groupid] including grouping id 0 which means all groups
291  */
292 function groups_get_user_groups($courseid, $userid=0) {
293     global $USER, $DB;
295     if (empty($userid)) {
296         $userid = $USER->id;
297     }
299     $sql = "SELECT g.id, gg.groupingid
300               FROM {groups} g
301                    JOIN {groups_members} gm   ON gm.groupid = g.id
302               LEFT JOIN {groupings_groups} gg ON gg.groupid = g.id
303              WHERE gm.userid = ? AND g.courseid = ?";
304     $params = array($userid, $courseid);
306     $rs = $DB->get_recordset_sql($sql, $params);
308     if (!$rs->valid()) {
309         $rs->close(); // Not going to iterate (but exit), close rs
310         return array('0' => array());
311     }
313     $result    = array();
314     $allgroups = array();
316     foreach ($rs as $group) {
317         $allgroups[$group->id] = $group->id;
318         if (is_null($group->groupingid)) {
319             continue;
320         }
321         if (!array_key_exists($group->groupingid, $result)) {
322             $result[$group->groupingid] = array();
323         }
324         $result[$group->groupingid][$group->id] = $group->id;
325     }
326     $rs->close();
328     $result['0'] = array_keys($allgroups); // all groups
330     return $result;
333 /**
334  * Gets an array of all groupings in a specified course. This value is cached
335  * for a single course (so you can call it repeatedly for the same course
336  * without a performance penalty).
337  *
338  * @category group
339  * @param int $courseid return all groupings from course with this courseid
340  * @return array Returns an array of the grouping objects (empty if none)
341  */
342 function groups_get_all_groupings($courseid) {
343     $data = groups_get_course_data($courseid);
344     return $data->groupings;
347 /**
348  * Determines if the user is a member of the given group.
349  *
350  * If $userid is null, use the global object.
351  *
352  * @category group
353  * @param int $groupid The group to check for membership.
354  * @param int $userid The user to check against the group.
355  * @return bool True if the user is a member, false otherwise.
356  */
357 function groups_is_member($groupid, $userid=null) {
358     global $USER, $DB;
360     if (!$userid) {
361         $userid = $USER->id;
362     }
364     return $DB->record_exists('groups_members', array('groupid'=>$groupid, 'userid'=>$userid));
367 /**
368  * Determines if current or specified is member of any active group in activity
369  *
370  * @category group
371  * @staticvar array $cache
372  * @param cm_info $cm course module object
373  * @param int $userid id of user, null means $USER->id
374  * @return bool true if user member of at least one group used in activity
375  */
376 function groups_has_membership($cm, $userid=null) {
377     global $CFG, $USER, $DB;
379     static $cache = array();
381     if (empty($userid)) {
382         $userid = $USER->id;
383     }
385     $cachekey = $userid.'|'.$cm->course.'|'.$cm->groupingid;
386     if (isset($cache[$cachekey])) {
387         return($cache[$cachekey]);
388     }
390     if ($cm->groupingid) {
391         // find out if member of any group in selected activity grouping
392         $sql = "SELECT 'x'
393                   FROM {groups_members} gm, {groupings_groups} gg
394                  WHERE gm.userid = ? AND gm.groupid = gg.groupid AND gg.groupingid = ?";
395         $params = array($userid, $cm->groupingid);
397     } else {
398         // no grouping used - check all groups in course
399         $sql = "SELECT 'x'
400                   FROM {groups_members} gm, {groups} g
401                  WHERE gm.userid = ? AND gm.groupid = g.id AND g.courseid = ?";
402         $params = array($userid, $cm->course);
403     }
405     $cache[$cachekey] = $DB->record_exists_sql($sql, $params);
407     return $cache[$cachekey];
410 /**
411  * Returns the users in the specified group.
412  *
413  * @category group
414  * @param int $groupid The groupid to get the users for
415  * @param int $fields The fields to return
416  * @param int $sort optional sorting of returned users
417  * @return array|bool Returns an array of the users for the specified
418  * group or false if no users or an error returned.
419  */
420 function groups_get_members($groupid, $fields='u.*', $sort='lastname ASC') {
421     global $DB;
423     return $DB->get_records_sql("SELECT $fields
424                                    FROM {user} u, {groups_members} gm
425                                   WHERE u.id = gm.userid AND gm.groupid = ?
426                                ORDER BY $sort", array($groupid));
430 /**
431  * Returns the users in the specified grouping.
432  *
433  * @category group
434  * @param int $groupingid The groupingid to get the users for
435  * @param string $fields The fields to return
436  * @param string $sort optional sorting of returned users
437  * @return array|bool Returns an array of the users for the specified
438  * group or false if no users or an error returned.
439  */
440 function groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC') {
441     global $DB;
443     return $DB->get_records_sql("SELECT $fields
444                                    FROM {user} u
445                                      INNER JOIN {groups_members} gm ON u.id = gm.userid
446                                      INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
447                                   WHERE  gg.groupingid = ?
448                                ORDER BY $sort", array($groupingid));
451 /**
452  * Returns effective groupmode used in course
453  *
454  * @category group
455  * @param stdClass $course course object.
456  * @return int group mode
457  */
458 function groups_get_course_groupmode($course) {
459     return $course->groupmode;
462 /**
463  * Returns effective groupmode used in activity, course setting
464  * overrides activity setting if groupmodeforce enabled.
465  *
466  * If $cm is an instance of cm_info it is easier to use $cm->effectivegroupmode
467  *
468  * @category group
469  * @param cm_info|stdClass $cm the course module object. Only the ->course and ->groupmode need to be set.
470  * @param stdClass $course object optional course object to improve perf
471  * @return int group mode
472  */
473 function groups_get_activity_groupmode($cm, $course=null) {
474     if ($cm instanceof cm_info) {
475         return $cm->effectivegroupmode;
476     }
477     if (isset($course->id) and $course->id == $cm->course) {
478         //ok
479     } else {
480         // Get course object (reuse $COURSE if possible).
481         $course = get_course($cm->course, false);
482     }
484     return empty($course->groupmodeforce) ? $cm->groupmode : $course->groupmode;
487 /**
488  * Print group menu selector for course level.
489  *
490  * @category group
491  * @param stdClass $course course object
492  * @param mixed $urlroot return address. Accepts either a string or a moodle_url
493  * @param bool $return return as string instead of printing
494  * @return mixed void or string depending on $return param
495  */
496 function groups_print_course_menu($course, $urlroot, $return=false) {
497     global $USER, $OUTPUT;
499     if (!$groupmode = $course->groupmode) {
500         if ($return) {
501             return '';
502         } else {
503             return;
504         }
505     }
507     $context = context_course::instance($course->id);
508     $aag = has_capability('moodle/site:accessallgroups', $context);
510     if ($groupmode == VISIBLEGROUPS or $aag) {
511         $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
512     } else {
513         $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
514     }
516     $activegroup = groups_get_course_group($course, true, $allowedgroups);
518     $groupsmenu = array();
519     if (!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) {
520         $groupsmenu[0] = get_string('allparticipants');
521     }
523     if ($allowedgroups) {
524         foreach ($allowedgroups as $group) {
525             $groupsmenu[$group->id] = format_string($group->name);
526         }
527     }
529     if ($groupmode == VISIBLEGROUPS) {
530         $grouplabel = get_string('groupsvisible');
531     } else {
532         $grouplabel = get_string('groupsseparate');
533     }
535     if ($aag and $course->defaultgroupingid) {
536         if ($grouping = groups_get_grouping($course->defaultgroupingid)) {
537             $grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
538         }
539     }
541     if (count($groupsmenu) == 1) {
542         $groupname = reset($groupsmenu);
543         $output = $grouplabel.': '.$groupname;
544     } else {
545         $select = new single_select(new moodle_url($urlroot), 'group', $groupsmenu, $activegroup, null, 'selectgroup');
546         $select->label = $grouplabel;
547         $output = $OUTPUT->render($select);
548     }
550     $output = '<div class="groupselector">'.$output.'</div>';
552     if ($return) {
553         return $output;
554     } else {
555         echo $output;
556     }
559 /**
560  * Print group menu selector for activity.
561  *
562  * @category group
563  * @param stdClass $cm course module object
564  * @param string|moodle_url $urlroot return address that users get to if they choose an option;
565  *   should include any parameters needed, e.g. "$CFG->wwwroot/mod/forum/view.php?id=34"
566  * @param bool $return return as string instead of printing
567  * @param bool $hideallparticipants If true, this prevents the 'All participants'
568  *   option from appearing in cases where it normally would. This is intended for
569  *   use only by activities that cannot display all groups together. (Note that
570  *   selecting this option does not prevent groups_get_activity_group from
571  *   returning 0; it will still do that if the user has chosen 'all participants'
572  *   in another activity, or not chosen anything.)
573  * @return mixed void or string depending on $return param
574  */
575 function groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false) {
576     global $USER, $OUTPUT;
578     if ($urlroot instanceof moodle_url) {
579         // no changes necessary
581     } else {
582         if (strpos($urlroot, 'http') !== 0) { // Will also work for https
583             // Display error if urlroot is not absolute (this causes the non-JS version to break)
584             debugging('groups_print_activity_menu requires absolute URL for ' .
585                       '$urlroot, not <tt>' . s($urlroot) . '</tt>. Example: ' .
586                       'groups_print_activity_menu($cm, $CFG->wwwroot . \'/mod/mymodule/view.php?id=13\');',
587                       DEBUG_DEVELOPER);
588         }
589         $urlroot = new moodle_url($urlroot);
590     }
592     if (!$groupmode = groups_get_activity_groupmode($cm)) {
593         if ($return) {
594             return '';
595         } else {
596             return;
597         }
598     }
600     $context = context_module::instance($cm->id);
601     $aag = has_capability('moodle/site:accessallgroups', $context);
603     if ($groupmode == VISIBLEGROUPS or $aag) {
604         $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid); // any group in grouping
605     } else {
606         $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid); // only assigned groups
607     }
609     $activegroup = groups_get_activity_group($cm, true, $allowedgroups);
611     $groupsmenu = array();
612     if ((!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) and !$hideallparticipants) {
613         $groupsmenu[0] = get_string('allparticipants');
614     }
616     if ($allowedgroups) {
617         foreach ($allowedgroups as $group) {
618             $groupsmenu[$group->id] = format_string($group->name);
619         }
620     }
622     if ($groupmode == VISIBLEGROUPS) {
623         $grouplabel = get_string('groupsvisible');
624     } else {
625         $grouplabel = get_string('groupsseparate');
626     }
628     if ($aag and $cm->groupingid) {
629         if ($grouping = groups_get_grouping($cm->groupingid)) {
630             $grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
631         }
632     }
634     if (count($groupsmenu) == 1) {
635         $groupname = reset($groupsmenu);
636         $output = $grouplabel.': '.$groupname;
637     } else {
638         $select = new single_select($urlroot, 'group', $groupsmenu, $activegroup, null, 'selectgroup');
639         $select->label = $grouplabel;
640         $output = $OUTPUT->render($select);
641     }
643     $output = '<div class="groupselector">'.$output.'</div>';
645     if ($return) {
646         return $output;
647     } else {
648         echo $output;
649     }
652 /**
653  * Returns group active in course, changes the group by default if 'group' page param present
654  *
655  * @category group
656  * @param stdClass $course course bject
657  * @param bool $update change active group if group param submitted
658  * @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_course_menu())
659  * @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
660  */
661 function groups_get_course_group($course, $update=false, $allowedgroups=null) {
662     global $USER, $SESSION;
664     if (!$groupmode = $course->groupmode) {
665         // NOGROUPS used
666         return false;
667     }
669     $context = context_course::instance($course->id);
670     if (has_capability('moodle/site:accessallgroups', $context)) {
671         $groupmode = 'aag';
672     }
674     if (!is_array($allowedgroups)) {
675         if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
676             $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
677         } else {
678             $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
679         }
680     }
682     _group_verify_activegroup($course->id, $groupmode, $course->defaultgroupingid, $allowedgroups);
684     // set new active group if requested
685     $changegroup = optional_param('group', -1, PARAM_INT);
686     if ($update and $changegroup != -1) {
688         if ($changegroup == 0) {
689             // do not allow changing to all groups without accessallgroups capability
690             if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
691                 $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = 0;
692             }
694         } else {
695             if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
696                 $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = $changegroup;
697             }
698         }
699     }
701     return $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
704 /**
705  * Returns group active in activity, changes the group by default if 'group' page param present
706  *
707  * @category group
708  * @param stdClass $cm course module object
709  * @param bool $update change active group if group param submitted
710  * @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_activity_menu())
711  * @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
712  */
713 function groups_get_activity_group($cm, $update=false, $allowedgroups=null) {
714     global $USER, $SESSION;
716     if (!$groupmode = groups_get_activity_groupmode($cm)) {
717         // NOGROUPS used
718         return false;
719     }
721     $context = context_module::instance($cm->id);
722     if (has_capability('moodle/site:accessallgroups', $context)) {
723         $groupmode = 'aag';
724     }
726     if (!is_array($allowedgroups)) {
727         if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
728             $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
729         } else {
730             $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
731         }
732     }
734     _group_verify_activegroup($cm->course, $groupmode, $cm->groupingid, $allowedgroups);
736     // set new active group if requested
737     $changegroup = optional_param('group', -1, PARAM_INT);
738     if ($update and $changegroup != -1) {
740         if ($changegroup == 0) {
741             // allgroups visible only in VISIBLEGROUPS or when accessallgroups
742             if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
743                 $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = 0;
744             }
746         } else {
747             if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
748                 $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = $changegroup;
749             }
750         }
751     }
753     return $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid];
756 /**
757  * Gets a list of groups that the user is allowed to access within the
758  * specified activity.
759  *
760  * @category group
761  * @param stdClass $cm Course-module
762  * @param int $userid User ID (defaults to current user)
763  * @return array An array of group objects, or false if none
764  */
765 function groups_get_activity_allowed_groups($cm,$userid=0) {
766     // Use current user by default
767     global $USER;
768     if(!$userid) {
769         $userid=$USER->id;
770     }
772     // Get groupmode for activity, taking into account course settings
773     $groupmode=groups_get_activity_groupmode($cm);
775     // If visible groups mode, or user has the accessallgroups capability,
776     // then they can access all groups for the activity...
777     $context = context_module::instance($cm->id);
778     if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context, $userid)) {
779         return groups_get_all_groups($cm->course, 0, $cm->groupingid);
780     } else {
781         // ...otherwise they can only access groups they belong to
782         return groups_get_all_groups($cm->course, $userid, $cm->groupingid);
783     }
786 /**
787  * Determine if a course module is currently visible to a user
788  *
789  * $USER If $userid is null, use the global object.
790  *
791  * @category group
792  * @param stdClass $cm The course module
793  * @param int $userid The user to check against the group.
794  * @return bool True if the user can view the course module, false otherwise.
795  */
796 function groups_course_module_visible($cm, $userid=null) {
797     global $CFG, $USER;
799     if (empty($userid)) {
800         $userid = $USER->id;
801     }
802     if (empty($CFG->enablegroupmembersonly)) {
803         return true;
804     }
805     if (empty($cm->groupmembersonly)) {
806         return true;
807     }
808     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id), $userid) or groups_has_membership($cm, $userid)) {
809         return true;
810     }
811     return false;
814 /**
815  * Determine if a given group is visible to user or not in a given context.
816  *
817  * @since Moodle 2.6
818  * @param int      $groupid Group id to test. 0 for all groups.
819  * @param stdClass $course  Course object.
820  * @param stdClass $cm      Course module object.
821  * @param int      $userid  user id to test against. Defaults to $USER.
822  * @return boolean true if visible, false otherwise
823  */
824 function groups_group_visible($groupid, $course, $cm = null, $userid = null) {
825     global $USER;
827     if (empty($userid)) {
828         $userid = $USER->id;
829     }
831     $groupmode = empty($cm) ? groups_get_course_groupmode($course) : groups_get_activity_groupmode($cm, $course);
832     if ($groupmode == NOGROUPS || $groupmode == VISIBLEGROUPS) {
833         // Groups are not used, or everything is visible, no need to go any further.
834         return true;
835     }
837     $context = empty($cm) ? context_course::instance($course->id) : context_module::instance($cm->id);
838     if (has_capability('moodle/site:accessallgroups', $context, $userid)) {
839         // User can see everything. Groupid = 0 is handled here as well.
840         return true;
841     } else if ($groupid != 0) {
842         // Group mode is separate, and user doesn't have access all groups capability. Check if user can see requested group.
843         $groups = empty($cm) ? groups_get_all_groups($course->id, $userid) : groups_get_activity_allowed_groups($cm, $userid);
844         if (array_key_exists($groupid, $groups)) {
845             // User can see the group.
846             return true;
847         }
848     }
849     return false;
852 /**
853  * Internal method, sets up $SESSION->activegroup and verifies previous value
854  *
855  * @param int $courseid
856  * @param int|string $groupmode SEPARATEGROUPS, VISIBLEGROUPS or 'aag' (access all groups)
857  * @param int $groupingid 0 means all groups
858  * @param array $allowedgroups list of groups user can see
859  */
860 function _group_verify_activegroup($courseid, $groupmode, $groupingid, array $allowedgroups) {
861     global $SESSION, $USER;
863     // init activegroup array if necessary
864     if (!isset($SESSION->activegroup)) {
865         $SESSION->activegroup = array();
866     }
867     if (!array_key_exists($courseid, $SESSION->activegroup)) {
868         $SESSION->activegroup[$courseid] = array(SEPARATEGROUPS=>array(), VISIBLEGROUPS=>array(), 'aag'=>array());
869     }
871     // make sure that the current group info is ok
872     if (array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode]) and !array_key_exists($SESSION->activegroup[$courseid][$groupmode][$groupingid], $allowedgroups)) {
873         // active group does not exist anymore or is 0
874         if ($SESSION->activegroup[$courseid][$groupmode][$groupingid] > 0 or $groupmode == SEPARATEGROUPS) {
875             // do not do this if all groups selected and groupmode is not separate
876             unset($SESSION->activegroup[$courseid][$groupmode][$groupingid]);
877         }
878     }
880     // set up defaults if necessary
881     if (!array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode])) {
882         if ($groupmode == 'aag') {
883             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = 0; // all groups by default if user has accessallgroups
885         } else if ($allowedgroups) {
886             if ($groupmode != SEPARATEGROUPS and $mygroups = groups_get_all_groups($courseid, $USER->id, $groupingid)) {
887                 $firstgroup = reset($mygroups);
888             } else {
889                 $firstgroup = reset($allowedgroups);
890             }
891             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = $firstgroup->id;
893         } else {
894             // this happen when user not assigned into group in SEPARATEGROUPS mode or groups do not exist yet
895             // mod authors must add extra checks for this when SEPARATEGROUPS mode used (such as when posting to forum)
896             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = 0;
897         }
898     }
901 /**
902  * Caches group data for a particular course to speed up subsequent requests.
903  *
904  * @param int $courseid The course id to cache data for.
905  * @param cache $cache The cache if it has already been initialised. If not a new one will be created.
906  * @return stdClass A data object containing groups, groupings, and mappings.
907  */
908 function groups_cache_groupdata($courseid, cache $cache = null) {
909     global $DB;
911     if ($cache === null) {
912         // Initialise a cache if we wern't given one.
913         $cache = cache::make('core', 'groupdata');
914     }
916     // Get the groups that belong to the course.
917     $groups = $DB->get_records('groups', array('courseid' => $courseid), 'name ASC');
918     // Get the groupings that belong to the course.
919     $groupings = $DB->get_records('groupings', array('courseid' => $courseid), 'name ASC');
921     if (!is_array($groups)) {
922         $groups = array();
923     }
925     if (!is_array($groupings)) {
926         $groupings = array();
927     }
929     if (!empty($groupings)) {
930         // Finally get the mappings between the two.
931         $mappings = $DB->get_records_list('groupings_groups', 'groupingid', array_keys($groupings), '', 'id,groupingid,groupid');
932     } else {
933         $mappings = array();
934     }
936     // Prepare the data array.
937     $data = new stdClass;
938     $data->groups = $groups;
939     $data->groupings = $groupings;
940     $data->mappings = $mappings;
941     // Cache the data.
942     $cache->set($courseid, $data);
943     // Finally return it so it can be used if desired.
944     return $data;
947 /**
948  * Gets group data for a course.
949  *
950  * This returns an object with the following properties:
951  *   - groups : An array of all the groups in the course.
952  *   - groupings : An array of all the groupings within the course.
953  *   - mappings : An array of group to grouping mappings.
954  *
955  * @param int $courseid The course id to get data for.
956  * @param cache $cache The cache if it has already been initialised. If not a new one will be created.
957  * @return stdClass
958  */
959 function groups_get_course_data($courseid, cache $cache = null) {
960     if ($cache === null) {
961         // Initialise a cache if we wern't given one.
962         $cache = cache::make('core', 'groupdata');
963     }
964     // Try to retrieve it from the cache.
965     $data = $cache->get($courseid);
966     if ($data === false) {
967         $data = groups_cache_groupdata($courseid, $cache);
968     }
969     return $data;