82fa4d3a904fd3ba2c7493dbba27451fb71980d8
[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     global $DB;
90     if ($groups = $DB->get_records('groups', array('courseid'=>$courseid, 'name'=>$name))) {
91         return key($groups);
92     }
93     return false;
94 }
96 /**
97  * Returns the groupingid of a grouping with the name specified for the course.
98  * Grouping names should be unique in course
99  *
100  * @category group
101  * @param int $courseid The id of the course
102  * @param string $name name of group (without magic quotes)
103  * @return int $groupid
104  */
105 function groups_get_grouping_by_name($courseid, $name) {
106     global $DB;
107     if ($groupings = $DB->get_records('groupings', array('courseid'=>$courseid, 'name'=>$name))) {
108         return key($groupings);
109     }
110     return false;
113 /**
114  * Get the group object
115  *
116  * @category group
117  * @param int $groupid ID of the group.
118  * @param string $fields (default is all fields)
119  * @param int $strictness (IGNORE_MISSING - default)
120  * @return stdGlass group object
121  */
122 function groups_get_group($groupid, $fields='*', $strictness=IGNORE_MISSING) {
123     global $DB;
124     return $DB->get_record('groups', array('id'=>$groupid), $fields, $strictness);
127 /**
128  * Get the grouping object
129  *
130  * @category group
131  * @param int $groupingid ID of the group.
132  * @param string $fields
133  * @param int $strictness (IGNORE_MISSING - default)
134  * @return stdClass group object
135  */
136 function groups_get_grouping($groupingid, $fields='*', $strictness=IGNORE_MISSING) {
137     global $DB;
138     return $DB->get_record('groupings', array('id'=>$groupingid), $fields, $strictness);
141 /**
142  * Gets array of all groups in a specified course.
143  *
144  * @category group
145  * @param int $courseid The id of the course.
146  * @param mixed $userid optional user id or array of ids, returns only groups of the user.
147  * @param int $groupingid optional returns only groups in the specified grouping.
148  * @param string $fields
149  * @return array Returns an array of the group objects (userid field returned if array in $userid)
150  */
151 function groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*') {
152     global $DB;
154     if (empty($userid)) {
155         $userfrom  = "";
156         $userwhere = "";
157         $params = array();
159     } else {
160         list($usql, $params) = $DB->get_in_or_equal($userid);
161         $userfrom  = ", {groups_members} gm";
162         $userwhere = "AND g.id = gm.groupid AND gm.userid $usql";
163     }
165     if (!empty($groupingid)) {
166         $groupingfrom  = ", {groupings_groups} gg";
167         $groupingwhere = "AND g.id = gg.groupid AND gg.groupingid = ?";
168         $params[] = $groupingid;
169     } else {
170         $groupingfrom  = "";
171         $groupingwhere = "";
172     }
174     array_unshift($params, $courseid);
176     return $DB->get_records_sql("SELECT $fields
177                                    FROM {groups} g $userfrom $groupingfrom
178                                   WHERE g.courseid = ? $userwhere $groupingwhere
179                                ORDER BY name ASC", $params);
182 /**
183  * Returns info about user's groups in course.
184  *
185  * @category group
186  * @param int $courseid
187  * @param int $userid $USER if not specified
188  * @return array Array[groupingid][groupid] including grouping id 0 which means all groups
189  */
190 function groups_get_user_groups($courseid, $userid=0) {
191     global $USER, $DB;
193     if (empty($userid)) {
194         $userid = $USER->id;
195     }
197     $sql = "SELECT g.id, gg.groupingid
198               FROM {groups} g
199                    JOIN {groups_members} gm   ON gm.groupid = g.id
200               LEFT JOIN {groupings_groups} gg ON gg.groupid = g.id
201              WHERE gm.userid = ? AND g.courseid = ?";
202     $params = array($userid, $courseid);
204     $rs = $DB->get_recordset_sql($sql, $params);
206     if (!$rs->valid()) {
207         $rs->close(); // Not going to iterate (but exit), close rs
208         return array('0' => array());
209     }
211     $result    = array();
212     $allgroups = array();
214     foreach ($rs as $group) {
215         $allgroups[$group->id] = $group->id;
216         if (is_null($group->groupingid)) {
217             continue;
218         }
219         if (!array_key_exists($group->groupingid, $result)) {
220             $result[$group->groupingid] = array();
221         }
222         $result[$group->groupingid][$group->id] = $group->id;
223     }
224     $rs->close();
226     $result['0'] = array_keys($allgroups); // all groups
228     return $result;
231 /**
232  * Gets an array of all groupings in a specified course.
233  *
234  * @category group
235  * @param int $courseid return only groupings in this with this courseid
236  * @return array|bool Returns an array of the grouping objects or false if no records
237  * or an error occurred.
238  */
239 function groups_get_all_groupings($courseid) {
240     global $CFG, $DB;
242     return $DB->get_records_sql("SELECT *
243                                    FROM {groupings}
244                                   WHERE courseid = ?
245                                ORDER BY name ASC", array($courseid));
250 /**
251  * Determines if the user is a member of the given group.
252  *
253  * If $userid is null, use the global object.
254  *
255  * @category group
256  * @param int $groupid The group to check for membership.
257  * @param int $userid The user to check against the group.
258  * @return bool True if the user is a member, false otherwise.
259  */
260 function groups_is_member($groupid, $userid=null) {
261     global $USER, $DB;
263     if (!$userid) {
264         $userid = $USER->id;
265     }
267     return $DB->record_exists('groups_members', array('groupid'=>$groupid, 'userid'=>$userid));
270 /**
271  * Determines if current or specified is member of any active group in activity
272  *
273  * @category group
274  * @staticvar array $cache
275  * @param cm_info $cm course module object
276  * @param int $userid id of user, null means $USER->id
277  * @return bool true if user member of at least one group used in activity
278  */
279 function groups_has_membership($cm, $userid=null) {
280     global $CFG, $USER, $DB;
282     static $cache = array();
284     if (empty($userid)) {
285         $userid = $USER->id;
286     }
288     $cachekey = $userid.'|'.$cm->course.'|'.$cm->groupingid;
289     if (isset($cache[$cachekey])) {
290         return($cache[$cachekey]);
291     }
293     if ($cm->groupingid) {
294         // find out if member of any group in selected activity grouping
295         $sql = "SELECT 'x'
296                   FROM {groups_members} gm, {groupings_groups} gg
297                  WHERE gm.userid = ? AND gm.groupid = gg.groupid AND gg.groupingid = ?";
298         $params = array($userid, $cm->groupingid);
300     } else {
301         // no grouping used - check all groups in course
302         $sql = "SELECT 'x'
303                   FROM {groups_members} gm, {groups} g
304                  WHERE gm.userid = ? AND gm.groupid = g.id AND g.courseid = ?";
305         $params = array($userid, $cm->course);
306     }
308     $cache[$cachekey] = $DB->record_exists_sql($sql, $params);
310     return $cache[$cachekey];
313 /**
314  * Returns the users in the specified group.
315  *
316  * @category group
317  * @param int $groupid The groupid to get the users for
318  * @param int $fields The fields to return
319  * @param int $sort optional sorting of returned users
320  * @return array|bool Returns an array of the users for the specified
321  * group or false if no users or an error returned.
322  */
323 function groups_get_members($groupid, $fields='u.*', $sort='lastname ASC') {
324     global $DB;
326     return $DB->get_records_sql("SELECT $fields
327                                    FROM {user} u, {groups_members} gm
328                                   WHERE u.id = gm.userid AND gm.groupid = ?
329                                ORDER BY $sort", array($groupid));
333 /**
334  * Returns the users in the specified grouping.
335  *
336  * @category group
337  * @param int $groupingid The groupingid to get the users for
338  * @param string $fields The fields to return
339  * @param string $sort optional sorting of returned users
340  * @return array|bool Returns an array of the users for the specified
341  * group or false if no users or an error returned.
342  */
343 function groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC') {
344     global $DB;
346     return $DB->get_records_sql("SELECT $fields
347                                    FROM {user} u
348                                      INNER JOIN {groups_members} gm ON u.id = gm.userid
349                                      INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
350                                   WHERE  gg.groupingid = ?
351                                ORDER BY $sort", array($groupingid));
354 /**
355  * Returns effective groupmode used in course
356  *
357  * @category group
358  * @param stdClass $course course object.
359  * @return int group mode
360  */
361 function groups_get_course_groupmode($course) {
362     return $course->groupmode;
365 /**
366  * Returns effective groupmode used in activity, course setting
367  * overrides activity setting if groupmodeforce enabled.
368  *
369  * @category group
370  * @param cm_info $cm the course module object. Only the ->course and ->groupmode need to be set.
371  * @param stdClass $course object optional course object to improve perf
372  * @return int group mode
373  */
374 function groups_get_activity_groupmode($cm, $course=null) {
375     global $COURSE, $DB;
377     // get course object (reuse COURSE if possible)
378     if (isset($course->id) and $course->id == $cm->course) {
379         //ok
380     } else if ($cm->course == $COURSE->id) {
381         $course = $COURSE;
382     } else {
383         if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
384             print_error('invalidcourseid');
385         }
386     }
388     return empty($course->groupmodeforce) ? $cm->groupmode : $course->groupmode;
391 /**
392  * Print group menu selector for course level.
393  *
394  * @category group
395  * @param stdClass $course course object
396  * @param mixed $urlroot return address. Accepts either a string or a moodle_url
397  * @param bool $return return as string instead of printing
398  * @return mixed void or string depending on $return param
399  */
400 function groups_print_course_menu($course, $urlroot, $return=false) {
401     global $USER, $OUTPUT;
403     if (!$groupmode = $course->groupmode) {
404         if ($return) {
405             return '';
406         } else {
407             return;
408         }
409     }
411     $context = get_context_instance(CONTEXT_COURSE, $course->id);
412     $aag = has_capability('moodle/site:accessallgroups', $context);
414     if ($groupmode == VISIBLEGROUPS or $aag) {
415         $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
416     } else {
417         $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
418     }
420     $activegroup = groups_get_course_group($course, true, $allowedgroups);
422     $groupsmenu = array();
423     if (!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) {
424         $groupsmenu[0] = get_string('allparticipants');
425     }
427     if ($allowedgroups) {
428         foreach ($allowedgroups as $group) {
429             $groupsmenu[$group->id] = format_string($group->name);
430         }
431     }
433     if ($groupmode == VISIBLEGROUPS) {
434         $grouplabel = get_string('groupsvisible');
435     } else {
436         $grouplabel = get_string('groupsseparate');
437     }
439     if ($aag and $course->defaultgroupingid) {
440         if ($grouping = groups_get_grouping($course->defaultgroupingid)) {
441             $grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
442         }
443     }
445     if (count($groupsmenu) == 1) {
446         $groupname = reset($groupsmenu);
447         $output = $grouplabel.': '.$groupname;
448     } else {
449         $select = new single_select(new moodle_url($urlroot), 'group', $groupsmenu, $activegroup, null, 'selectgroup');
450         $select->label = $grouplabel;
451         $output = $OUTPUT->render($select);
452     }
454     $output = '<div class="groupselector">'.$output.'</div>';
456     if ($return) {
457         return $output;
458     } else {
459         echo $output;
460     }
463 /**
464  * Print group menu selector for activity.
465  *
466  * @category group
467  * @param stdClass $cm course module object
468  * @param string|moodle_url $urlroot return address that users get to if they choose an option;
469  *   should include any parameters needed, e.g. "$CFG->wwwroot/mod/forum/view.php?id=34"
470  * @param bool $return return as string instead of printing
471  * @param bool $hideallparticipants If true, this prevents the 'All participants'
472  *   option from appearing in cases where it normally would. This is intended for
473  *   use only by activities that cannot display all groups together. (Note that
474  *   selecting this option does not prevent groups_get_activity_group from
475  *   returning 0; it will still do that if the user has chosen 'all participants'
476  *   in another activity, or not chosen anything.)
477  * @return mixed void or string depending on $return param
478  */
479 function groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false) {
480     global $USER, $OUTPUT;
482     if ($urlroot instanceof moodle_url) {
483         // no changes necessary
485     } else {
486         if (strpos($urlroot, 'http') !== 0) { // Will also work for https
487             // Display error if urlroot is not absolute (this causes the non-JS version to break)
488             debugging('groups_print_activity_menu requires absolute URL for ' .
489                       '$urlroot, not <tt>' . s($urlroot) . '</tt>. Example: ' .
490                       'groups_print_activity_menu($cm, $CFG->wwwroot . \'/mod/mymodule/view.php?id=13\');',
491                       DEBUG_DEVELOPER);
492         }
493         $urlroot = new moodle_url($urlroot);
494     }
496     if (!$groupmode = groups_get_activity_groupmode($cm)) {
497         if ($return) {
498             return '';
499         } else {
500             return;
501         }
502     }
504     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
505     $aag = has_capability('moodle/site:accessallgroups', $context);
507     if ($groupmode == VISIBLEGROUPS or $aag) {
508         $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid); // any group in grouping
509     } else {
510         $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid); // only assigned groups
511     }
513     $activegroup = groups_get_activity_group($cm, true, $allowedgroups);
515     $groupsmenu = array();
516     if ((!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) and !$hideallparticipants) {
517         $groupsmenu[0] = get_string('allparticipants');
518     }
520     if ($allowedgroups) {
521         foreach ($allowedgroups as $group) {
522             $groupsmenu[$group->id] = format_string($group->name);
523         }
524     }
526     if ($groupmode == VISIBLEGROUPS) {
527         $grouplabel = get_string('groupsvisible');
528     } else {
529         $grouplabel = get_string('groupsseparate');
530     }
532     if ($aag and $cm->groupingid) {
533         if ($grouping = groups_get_grouping($cm->groupingid)) {
534             $grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
535         }
536     }
538     if (count($groupsmenu) == 1) {
539         $groupname = reset($groupsmenu);
540         $output = $grouplabel.': '.$groupname;
541     } else {
542         $select = new single_select($urlroot, 'group', $groupsmenu, $activegroup, null, 'selectgroup');
543         $select->label = $grouplabel;
544         $output = $OUTPUT->render($select);
545     }
547     $output = '<div class="groupselector">'.$output.'</div>';
549     if ($return) {
550         return $output;
551     } else {
552         echo $output;
553     }
556 /**
557  * Returns group active in course, changes the group by default if 'group' page param present
558  *
559  * @category group
560  * @param stdClass $course course bject
561  * @param bool $update change active group if group param submitted
562  * @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_course_menu())
563  * @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
564  */
565 function groups_get_course_group($course, $update=false, $allowedgroups=null) {
566     global $USER, $SESSION;
568     if (!$groupmode = $course->groupmode) {
569         // NOGROUPS used
570         return false;
571     }
573     $context = get_context_instance(CONTEXT_COURSE, $course->id);
574     if (has_capability('moodle/site:accessallgroups', $context)) {
575         $groupmode = 'aag';
576     }
578     if (!is_array($allowedgroups)) {
579         if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
580             $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
581         } else {
582             $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
583         }
584     }
586     _group_verify_activegroup($course->id, $groupmode, $course->defaultgroupingid, $allowedgroups);
588     // set new active group if requested
589     $changegroup = optional_param('group', -1, PARAM_INT);
590     if ($update and $changegroup != -1) {
592         if ($changegroup == 0) {
593             // do not allow changing to all groups without accessallgroups capability
594             if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
595                 $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = 0;
596             }
598         } else {
599             if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
600                 $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = $changegroup;
601             }
602         }
603     }
605     return $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
608 /**
609  * Returns group active in activity, changes the group by default if 'group' page param present
610  *
611  * @category group
612  * @param stdClass $cm course module object
613  * @param bool $update change active group if group param submitted
614  * @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_activity_menu())
615  * @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
616  */
617 function groups_get_activity_group($cm, $update=false, $allowedgroups=null) {
618     global $USER, $SESSION;
620     if (!$groupmode = groups_get_activity_groupmode($cm)) {
621         // NOGROUPS used
622         return false;
623     }
625     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
626     if (has_capability('moodle/site:accessallgroups', $context)) {
627         $groupmode = 'aag';
628     }
630     if (!is_array($allowedgroups)) {
631         if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
632             $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
633         } else {
634             $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
635         }
636     }
638     _group_verify_activegroup($cm->course, $groupmode, $cm->groupingid, $allowedgroups);
640     // set new active group if requested
641     $changegroup = optional_param('group', -1, PARAM_INT);
642     if ($update and $changegroup != -1) {
644         if ($changegroup == 0) {
645             // allgroups visible only in VISIBLEGROUPS or when accessallgroups
646             if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
647                 $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = 0;
648             }
650         } else {
651             if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
652                 $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = $changegroup;
653             }
654         }
655     }
657     return $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid];
660 /**
661  * Gets a list of groups that the user is allowed to access within the
662  * specified activity.
663  *
664  * @category group
665  * @param stdClass $cm Course-module
666  * @param int $userid User ID (defaults to current user)
667  * @return array An array of group objects, or false if none
668  */
669 function groups_get_activity_allowed_groups($cm,$userid=0) {
670     // Use current user by default
671     global $USER;
672     if(!$userid) {
673         $userid=$USER->id;
674     }
676     // Get groupmode for activity, taking into account course settings
677     $groupmode=groups_get_activity_groupmode($cm);
679     // If visible groups mode, or user has the accessallgroups capability,
680     // then they can access all groups for the activity...
681     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
682     if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
683         return groups_get_all_groups($cm->course, 0, $cm->groupingid);
684     } else {
685         // ...otherwise they can only access groups they belong to
686         return groups_get_all_groups($cm->course, $userid, $cm->groupingid);
687     }
690 /**
691  * Determine if a course module is currently visible to a user
692  *
693  * $USER If $userid is null, use the global object.
694  *
695  * @category group
696  * @param stdClass $cm The course module
697  * @param int $userid The user to check against the group.
698  * @return bool True if the user can view the course module, false otherwise.
699  */
700 function groups_course_module_visible($cm, $userid=null) {
701     global $CFG, $USER;
703     if (empty($userid)) {
704         $userid = $USER->id;
705     }
706     if (empty($CFG->enablegroupmembersonly)) {
707         return true;
708     }
709     if (empty($cm->groupmembersonly)) {
710         return true;
711     }
712     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id), $userid) or groups_has_membership($cm, $userid)) {
713         return true;
714     }
715     return false;
718 /**
719  * Internal method, sets up $SESSION->activegroup and verifies previous value
720  *
721  * @param int $courseid
722  * @param int|string $groupmode SEPARATEGROUPS, VISIBLEGROUPS or 'aag' (access all groups)
723  * @param int $groupingid 0 means all groups
724  * @param array $allowedgroups list of groups user can see
725  */
726 function _group_verify_activegroup($courseid, $groupmode, $groupingid, array $allowedgroups) {
727     global $SESSION, $USER;
729     // init activegroup array if necessary
730     if (!isset($SESSION->activegroup)) {
731         $SESSION->activegroup = array();
732     }
733     if (!array_key_exists($courseid, $SESSION->activegroup)) {
734         $SESSION->activegroup[$courseid] = array(SEPARATEGROUPS=>array(), VISIBLEGROUPS=>array(), 'aag'=>array());
735     }
737     // make sure that the current group info is ok
738     if (array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode]) and !array_key_exists($SESSION->activegroup[$courseid][$groupmode][$groupingid], $allowedgroups)) {
739         // active group does not exist anymore or is 0
740         if ($SESSION->activegroup[$courseid][$groupmode][$groupingid] > 0 or $groupmode == SEPARATEGROUPS) {
741             // do not do this if all groups selected and groupmode is not separate
742             unset($SESSION->activegroup[$courseid][$groupmode][$groupingid]);
743         }
744     }
746     // set up defaults if necessary
747     if (!array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode])) {
748         if ($groupmode == 'aag') {
749             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = 0; // all groups by default if user has accessallgroups
751         } else if ($allowedgroups) {
752             if ($groupmode != SEPARATEGROUPS and $mygroups = groups_get_all_groups($courseid, $USER->id, $groupingid)) {
753                 $firstgroup = reset($mygroups);
754             } else {
755                 $firstgroup = reset($allowedgroups);
756             }
757             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = $firstgroup->id;
759         } else {
760             // this happen when user not assigned into group in SEPARATEGROUPS mode or groups do not exist yet
761             // mod authors must add extra checks for this when SEPARATEGROUPS mode used (such as when posting to forum)
762             $SESSION->activegroup[$courseid][$groupmode][$groupingid] = 0;
763         }
764     }