forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
grouplib.php
1135 lines (991 loc) · 38.3 KB
/
grouplib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core_group
*/
defined('MOODLE_INTERNAL') || die();
/**
* Groups not used in course or activity
*/
define('NOGROUPS', 0);
/**
* Groups used, users do not see other groups
*/
define('SEPARATEGROUPS', 1);
/**
* Groups used, students see other groups
*/
define('VISIBLEGROUPS', 2);
/**
* Determines if a group with a given groupid exists.
*
* @category group
* @param int $groupid The groupid to check for
* @return bool True if the group exists, false otherwise or if an error
* occurred.
*/
function groups_group_exists($groupid) {
global $DB;
return $DB->record_exists('groups', array('id'=>$groupid));
}
/**
* Gets the name of a group with a specified id
*
* @category group
* @param int $groupid The id of the group
* @return string The name of the group
*/
function groups_get_group_name($groupid) {
global $DB;
return $DB->get_field('groups', 'name', array('id'=>$groupid));
}
/**
* Gets the name of a grouping with a specified id
*
* @category group
* @param int $groupingid The id of the grouping
* @return string The name of the grouping
*/
function groups_get_grouping_name($groupingid) {
global $DB;
return $DB->get_field('groupings', 'name', array('id'=>$groupingid));
}
/**
* Returns the groupid of a group with the name specified for the course.
* Group names should be unique in course
*
* @category group
* @param int $courseid The id of the course
* @param string $name name of group (without magic quotes)
* @return int $groupid
*/
function groups_get_group_by_name($courseid, $name) {
$data = groups_get_course_data($courseid);
foreach ($data->groups as $group) {
if ($group->name == $name) {
return $group->id;
}
}
return false;
}
/**
* Returns the groupid of a group with the idnumber specified for the course.
* Group idnumbers should be unique within course
*
* @category group
* @param int $courseid The id of the course
* @param string $idnumber idnumber of group
* @return group object
*/
function groups_get_group_by_idnumber($courseid, $idnumber) {
if (empty($idnumber)) {
return false;
}
$data = groups_get_course_data($courseid);
foreach ($data->groups as $group) {
if ($group->idnumber == $idnumber) {
return $group;
}
}
return false;
}
/**
* Returns the groupingid of a grouping with the name specified for the course.
* Grouping names should be unique in course
*
* @category group
* @param int $courseid The id of the course
* @param string $name name of group (without magic quotes)
* @return int $groupid
*/
function groups_get_grouping_by_name($courseid, $name) {
$data = groups_get_course_data($courseid);
foreach ($data->groupings as $grouping) {
if ($grouping->name == $name) {
return $grouping->id;
}
}
return false;
}
/**
* Returns the groupingid of a grouping with the idnumber specified for the course.
* Grouping names should be unique within course
*
* @category group
* @param int $courseid The id of the course
* @param string $idnumber idnumber of the group
* @return grouping object
*/
function groups_get_grouping_by_idnumber($courseid, $idnumber) {
if (empty($idnumber)) {
return false;
}
$data = groups_get_course_data($courseid);
foreach ($data->groupings as $grouping) {
if ($grouping->idnumber == $idnumber) {
return $grouping;
}
}
return false;
}
/**
* Get the group object
*
* @category group
* @param int $groupid ID of the group.
* @param string $fields (default is all fields)
* @param int $strictness (IGNORE_MISSING - default)
* @return stdGlass group object
*/
function groups_get_group($groupid, $fields='*', $strictness=IGNORE_MISSING) {
global $DB;
return $DB->get_record('groups', array('id'=>$groupid), $fields, $strictness);
}
/**
* Get the grouping object
*
* @category group
* @param int $groupingid ID of the group.
* @param string $fields
* @param int $strictness (IGNORE_MISSING - default)
* @return stdClass group object
*/
function groups_get_grouping($groupingid, $fields='*', $strictness=IGNORE_MISSING) {
global $DB;
return $DB->get_record('groupings', array('id'=>$groupingid), $fields, $strictness);
}
/**
* Gets array of all groups in a specified course.
*
* @category group
* @param int $courseid The id of the course.
* @param mixed $userid optional user id or array of ids, returns only groups of the user.
* @param int $groupingid optional returns only groups in the specified grouping.
* @param string $fields
* @return array Returns an array of the group objects (userid field returned if array in $userid)
*/
function groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*') {
global $DB;
// We need to check that we each field in the fields list belongs to the group table and that it has not being
// aliased. If its something else we need to avoid the cache and run the query as who knows whats going on.
$knownfields = true;
if ($fields !== 'g.*') {
// Quickly check if the first field is no longer g.id as using the
// cache will return an array indexed differently than when expect
if (strpos($fields, 'g.*') !== 0 && strpos($fields, 'g.id') !== 0) {
$knownfields = false;
} else {
$fieldbits = explode(',', $fields);
foreach ($fieldbits as $bit) {
$bit = trim($bit);
if (strpos($bit, 'g.') !== 0 or stripos($bit, ' AS ') !== false) {
$knownfields = false;
break;
}
}
}
}
if (empty($userid) && $knownfields) {
// We can use the cache.
$data = groups_get_course_data($courseid);
if (empty($groupingid)) {
// All groups.. Easy!
$groups = $data->groups;
} else {
$groups = array();
foreach ($data->mappings as $mapping) {
if ($mapping->groupingid != $groupingid) {
continue;
}
if (isset($data->groups[$mapping->groupid])) {
$groups[$mapping->groupid] = $data->groups[$mapping->groupid];
}
}
}
// Yay! We could use the cache. One more query saved.
return $groups;
}
if (empty($userid)) {
$userfrom = "";
$userwhere = "";
$params = array();
} else {
list($usql, $params) = $DB->get_in_or_equal($userid);
$userfrom = ", {groups_members} gm";
$userwhere = "AND g.id = gm.groupid AND gm.userid $usql";
}
if (!empty($groupingid)) {
$groupingfrom = ", {groupings_groups} gg";
$groupingwhere = "AND g.id = gg.groupid AND gg.groupingid = ?";
$params[] = $groupingid;
} else {
$groupingfrom = "";
$groupingwhere = "";
}
array_unshift($params, $courseid);
return $DB->get_records_sql("SELECT $fields
FROM {groups} g $userfrom $groupingfrom
WHERE g.courseid = ? $userwhere $groupingwhere
ORDER BY name ASC", $params);
}
/**
* Gets array of all groups in current user.
*
* @since Moodle 2.5
* @category group
* @return array Returns an array of the group objects.
*/
function groups_get_my_groups() {
global $DB, $USER;
return $DB->get_records_sql("SELECT *
FROM {groups_members} gm
JOIN {groups} g
ON g.id = gm.groupid
WHERE gm.userid = ?
ORDER BY name ASC", array($USER->id));
}
/**
* Returns info about user's groups in course.
*
* @category group
* @param int $courseid
* @param int $userid $USER if not specified
* @return array Array[groupingid][groupid] including grouping id 0 which means all groups
*/
function groups_get_user_groups($courseid, $userid=0) {
global $USER, $DB;
if (empty($userid)) {
$userid = $USER->id;
}
$sql = "SELECT g.id, gg.groupingid
FROM {groups} g
JOIN {groups_members} gm ON gm.groupid = g.id
LEFT JOIN {groupings_groups} gg ON gg.groupid = g.id
WHERE gm.userid = ? AND g.courseid = ?";
$params = array($userid, $courseid);
$rs = $DB->get_recordset_sql($sql, $params);
if (!$rs->valid()) {
$rs->close(); // Not going to iterate (but exit), close rs
return array('0' => array());
}
$result = array();
$allgroups = array();
foreach ($rs as $group) {
$allgroups[$group->id] = $group->id;
if (is_null($group->groupingid)) {
continue;
}
if (!array_key_exists($group->groupingid, $result)) {
$result[$group->groupingid] = array();
}
$result[$group->groupingid][$group->id] = $group->id;
}
$rs->close();
$result['0'] = array_keys($allgroups); // all groups
return $result;
}
/**
* Gets an array of all groupings in a specified course. This value is cached
* for a single course (so you can call it repeatedly for the same course
* without a performance penalty).
*
* @category group
* @param int $courseid return all groupings from course with this courseid
* @return array Returns an array of the grouping objects (empty if none)
*/
function groups_get_all_groupings($courseid) {
$data = groups_get_course_data($courseid);
return $data->groupings;
}
/**
* Determines if the user is a member of the given group.
*
* If $userid is null, use the global object.
*
* @category group
* @param int $groupid The group to check for membership.
* @param int $userid The user to check against the group.
* @return bool True if the user is a member, false otherwise.
*/
function groups_is_member($groupid, $userid=null) {
global $USER, $DB;
if (!$userid) {
$userid = $USER->id;
}
return $DB->record_exists('groups_members', array('groupid'=>$groupid, 'userid'=>$userid));
}
/**
* Determines if current or specified is member of any active group in activity
*
* @category group
* @staticvar array $cache
* @param stdClass|cm_info $cm course module object
* @param int $userid id of user, null means $USER->id
* @return bool true if user member of at least one group used in activity
*/
function groups_has_membership($cm, $userid=null) {
global $CFG, $USER, $DB;
static $cache = array();
if (empty($userid)) {
$userid = $USER->id;
}
$cachekey = $userid.'|'.$cm->course.'|'.$cm->groupingid;
if (isset($cache[$cachekey])) {
return($cache[$cachekey]);
}
if ($cm->groupingid) {
// find out if member of any group in selected activity grouping
$sql = "SELECT 'x'
FROM {groups_members} gm, {groupings_groups} gg
WHERE gm.userid = ? AND gm.groupid = gg.groupid AND gg.groupingid = ?";
$params = array($userid, $cm->groupingid);
} else {
// no grouping used - check all groups in course
$sql = "SELECT 'x'
FROM {groups_members} gm, {groups} g
WHERE gm.userid = ? AND gm.groupid = g.id AND g.courseid = ?";
$params = array($userid, $cm->course);
}
$cache[$cachekey] = $DB->record_exists_sql($sql, $params);
return $cache[$cachekey];
}
/**
* Returns the users in the specified group.
*
* @category group
* @param int $groupid The groupid to get the users for
* @param int $fields The fields to return
* @param int $sort optional sorting of returned users
* @return array|bool Returns an array of the users for the specified
* group or false if no users or an error returned.
*/
function groups_get_members($groupid, $fields='u.*', $sort='lastname ASC') {
global $DB;
return $DB->get_records_sql("SELECT $fields
FROM {user} u, {groups_members} gm
WHERE u.id = gm.userid AND gm.groupid = ?
ORDER BY $sort", array($groupid));
}
/**
* Returns the users in the specified grouping.
*
* @category group
* @param int $groupingid The groupingid to get the users for
* @param string $fields The fields to return
* @param string $sort optional sorting of returned users
* @return array|bool Returns an array of the users for the specified
* group or false if no users or an error returned.
*/
function groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC') {
global $DB;
return $DB->get_records_sql("SELECT $fields
FROM {user} u
INNER JOIN {groups_members} gm ON u.id = gm.userid
INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
WHERE gg.groupingid = ?
ORDER BY $sort", array($groupingid));
}
/**
* Returns effective groupmode used in course
*
* @category group
* @param stdClass $course course object.
* @return int group mode
*/
function groups_get_course_groupmode($course) {
return $course->groupmode;
}
/**
* Returns effective groupmode used in activity, course setting
* overrides activity setting if groupmodeforce enabled.
*
* If $cm is an instance of cm_info it is easier to use $cm->effectivegroupmode
*
* @category group
* @param cm_info|stdClass $cm the course module object. Only the ->course and ->groupmode need to be set.
* @param stdClass $course object optional course object to improve perf
* @return int group mode
*/
function groups_get_activity_groupmode($cm, $course=null) {
if ($cm instanceof cm_info) {
return $cm->effectivegroupmode;
}
if (isset($course->id) and $course->id == $cm->course) {
//ok
} else {
// Get course object (reuse $COURSE if possible).
$course = get_course($cm->course, false);
}
return empty($course->groupmodeforce) ? $cm->groupmode : $course->groupmode;
}
/**
* Print group menu selector for course level.
*
* @category group
* @param stdClass $course course object
* @param mixed $urlroot return address. Accepts either a string or a moodle_url
* @param bool $return return as string instead of printing
* @return mixed void or string depending on $return param
*/
function groups_print_course_menu($course, $urlroot, $return=false) {
global $USER, $OUTPUT;
if (!$groupmode = $course->groupmode) {
if ($return) {
return '';
} else {
return;
}
}
$context = context_course::instance($course->id);
$aag = has_capability('moodle/site:accessallgroups', $context);
$usergroups = array();
if ($groupmode == VISIBLEGROUPS or $aag) {
$allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
// Get user's own groups and put to the top.
$usergroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
} else {
$allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
}
$activegroup = groups_get_course_group($course, true, $allowedgroups);
$groupsmenu = array();
if (!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) {
$groupsmenu[0] = get_string('allparticipants');
}
$groupsmenu += groups_sort_menu_options($allowedgroups, $usergroups);
if ($groupmode == VISIBLEGROUPS) {
$grouplabel = get_string('groupsvisible');
} else {
$grouplabel = get_string('groupsseparate');
}
if ($aag and $course->defaultgroupingid) {
if ($grouping = groups_get_grouping($course->defaultgroupingid)) {
$grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
}
}
if (count($groupsmenu) == 1) {
$groupname = reset($groupsmenu);
$output = $grouplabel.': '.$groupname;
} else {
$select = new single_select(new moodle_url($urlroot), 'group', $groupsmenu, $activegroup, null, 'selectgroup');
$select->label = $grouplabel;
$output = $OUTPUT->render($select);
}
$output = '<div class="groupselector">'.$output.'</div>';
if ($return) {
return $output;
} else {
echo $output;
}
}
/**
* Turn an array of groups into an array of menu options.
* @param array $groups of group objects.
* @return array groupid => formatted group name.
*/
function groups_list_to_menu($groups) {
$groupsmenu = array();
foreach ($groups as $group) {
$groupsmenu[$group->id] = format_string($group->name);
}
return $groupsmenu;
}
/**
* Takes user's allowed groups and own groups and formats for use in group selector menu
* If user has allowed groups + own groups will add to an optgroup
* Own groups are removed from allowed groups
* @param array $allowedgroups All groups user is allowed to see
* @param array $usergroups Groups user belongs to
* @return array
*/
function groups_sort_menu_options($allowedgroups, $usergroups) {
$useroptions = array();
if ($usergroups) {
$useroptions = groups_list_to_menu($usergroups);
// Remove user groups from other groups list.
foreach ($usergroups as $group) {
unset($allowedgroups[$group->id]);
}
}
$allowedoptions = array();
if ($allowedgroups) {
$allowedoptions = groups_list_to_menu($allowedgroups);
}
if ($useroptions && $allowedoptions) {
return array(
1 => array(get_string('mygroups', 'group') => $useroptions),
2 => array(get_string('othergroups', 'group') => $allowedoptions)
);
} else if ($useroptions) {
return $useroptions;
} else {
return $allowedoptions;
}
}
/**
* Generates html to print menu selector for course level, listing all groups.
* Note: This api does not do any group mode check use groups_print_course_menu() instead if you want proper checks.
*
* @param stdclass $course course object.
* @param string|moodle_url $urlroot return address. Accepts either a string or a moodle_url.
* @param bool $update set this to true to update current active group based on the group param.
* @param int $activegroup Change group active to this group if $update set to true.
*
* @return string html or void
*/
function groups_allgroups_course_menu($course, $urlroot, $update = false, $activegroup = 0) {
global $SESSION, $OUTPUT, $USER;
$groupmode = groups_get_course_groupmode($course);
$context = context_course::instance($course->id);
$groupsmenu = array();
if (has_capability('moodle/site:accessallgroups', $context)) {
$groupsmenu[0] = get_string('allparticipants');
$allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
} else {
$allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
}
$groupsmenu += groups_list_to_menu($allowedgroups);
if ($update) {
// Init activegroup array if necessary.
if (!isset($SESSION->activegroup)) {
$SESSION->activegroup = array();
}
if (!isset($SESSION->activegroup[$course->id])) {
$SESSION->activegroup[$course->id] = array(SEPARATEGROUPS => array(), VISIBLEGROUPS => array(), 'aag' => array());
}
if (empty($groupsmenu[$activegroup])) {
$activegroup = key($groupsmenu); // Force set to one of accessible groups.
}
$SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = $activegroup;
}
$grouplabel = get_string('groups');
if (count($groupsmenu) == 0) {
return '';
} else if (count($groupsmenu) == 1) {
$groupname = reset($groupsmenu);
$output = $grouplabel.': '.$groupname;
} else {
$select = new single_select(new moodle_url($urlroot), 'group', $groupsmenu, $activegroup, null, 'selectgroup');
$select->label = $grouplabel;
$output = $OUTPUT->render($select);
}
return $output;
}
/**
* Print group menu selector for activity.
*
* @category group
* @param stdClass|cm_info $cm course module object
* @param string|moodle_url $urlroot return address that users get to if they choose an option;
* should include any parameters needed, e.g. "$CFG->wwwroot/mod/forum/view.php?id=34"
* @param bool $return return as string instead of printing
* @param bool $hideallparticipants If true, this prevents the 'All participants'
* option from appearing in cases where it normally would. This is intended for
* use only by activities that cannot display all groups together. (Note that
* selecting this option does not prevent groups_get_activity_group from
* returning 0; it will still do that if the user has chosen 'all participants'
* in another activity, or not chosen anything.)
* @return mixed void or string depending on $return param
*/
function groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false) {
global $USER, $OUTPUT;
if ($urlroot instanceof moodle_url) {
// no changes necessary
} else {
if (strpos($urlroot, 'http') !== 0) { // Will also work for https
// Display error if urlroot is not absolute (this causes the non-JS version to break)
debugging('groups_print_activity_menu requires absolute URL for ' .
'$urlroot, not <tt>' . s($urlroot) . '</tt>. Example: ' .
'groups_print_activity_menu($cm, $CFG->wwwroot . \'/mod/mymodule/view.php?id=13\');',
DEBUG_DEVELOPER);
}
$urlroot = new moodle_url($urlroot);
}
if (!$groupmode = groups_get_activity_groupmode($cm)) {
if ($return) {
return '';
} else {
return;
}
}
$context = context_module::instance($cm->id);
$aag = has_capability('moodle/site:accessallgroups', $context);
$usergroups = array();
if ($groupmode == VISIBLEGROUPS or $aag) {
$allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid); // any group in grouping
// Get user's own groups and put to the top.
$usergroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
} else {
$allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid); // only assigned groups
}
$activegroup = groups_get_activity_group($cm, true, $allowedgroups);
$groupsmenu = array();
if ((!$allowedgroups or $groupmode == VISIBLEGROUPS or $aag) and !$hideallparticipants) {
$groupsmenu[0] = get_string('allparticipants');
}
$groupsmenu += groups_sort_menu_options($allowedgroups, $usergroups);
if ($groupmode == VISIBLEGROUPS) {
$grouplabel = get_string('groupsvisible');
} else {
$grouplabel = get_string('groupsseparate');
}
if ($aag and $cm->groupingid) {
if ($grouping = groups_get_grouping($cm->groupingid)) {
$grouplabel = $grouplabel . ' (' . format_string($grouping->name) . ')';
}
}
if (count($groupsmenu) == 1) {
$groupname = reset($groupsmenu);
$output = $grouplabel.': '.$groupname;
} else {
$select = new single_select($urlroot, 'group', $groupsmenu, $activegroup, null, 'selectgroup');
$select->label = $grouplabel;
$output = $OUTPUT->render($select);
}
$output = '<div class="groupselector">'.$output.'</div>';
if ($return) {
return $output;
} else {
echo $output;
}
}
/**
* Returns group active in course, changes the group by default if 'group' page param present
*
* @category group
* @param stdClass $course course bject
* @param bool $update change active group if group param submitted
* @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_course_menu())
* @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
*/
function groups_get_course_group($course, $update=false, $allowedgroups=null) {
global $USER, $SESSION;
if (!$groupmode = $course->groupmode) {
// NOGROUPS used
return false;
}
$context = context_course::instance($course->id);
if (has_capability('moodle/site:accessallgroups', $context)) {
$groupmode = 'aag';
}
if (!is_array($allowedgroups)) {
if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
$allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid);
} else {
$allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid);
}
}
_group_verify_activegroup($course->id, $groupmode, $course->defaultgroupingid, $allowedgroups);
// set new active group if requested
$changegroup = optional_param('group', -1, PARAM_INT);
if ($update and $changegroup != -1) {
if ($changegroup == 0) {
// do not allow changing to all groups without accessallgroups capability
if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
$SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = 0;
}
} else {
if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
$SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid] = $changegroup;
}
}
}
return $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
}
/**
* Returns group active in activity, changes the group by default if 'group' page param present
*
* @category group
* @param stdClass|cm_info $cm course module object
* @param bool $update change active group if group param submitted
* @param array $allowedgroups list of groups user may access (INTERNAL, to be used only from groups_print_activity_menu())
* @return mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode)
*/
function groups_get_activity_group($cm, $update=false, $allowedgroups=null) {
global $USER, $SESSION;
if (!$groupmode = groups_get_activity_groupmode($cm)) {
// NOGROUPS used
return false;
}
$context = context_module::instance($cm->id);
if (has_capability('moodle/site:accessallgroups', $context)) {
$groupmode = 'aag';
}
if (!is_array($allowedgroups)) {
if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
$allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
} else {
$allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
}
}
_group_verify_activegroup($cm->course, $groupmode, $cm->groupingid, $allowedgroups);
// set new active group if requested
$changegroup = optional_param('group', -1, PARAM_INT);
if ($update and $changegroup != -1) {
if ($changegroup == 0) {
// allgroups visible only in VISIBLEGROUPS or when accessallgroups
if ($groupmode == VISIBLEGROUPS or $groupmode === 'aag') {
$SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = 0;
}
} else {
if ($allowedgroups and array_key_exists($changegroup, $allowedgroups)) {
$SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid] = $changegroup;
}
}
}
return $SESSION->activegroup[$cm->course][$groupmode][$cm->groupingid];
}
/**
* Gets a list of groups that the user is allowed to access within the
* specified activity.
*
* @category group
* @param stdClass|cm_info $cm Course-module
* @param int $userid User ID (defaults to current user)
* @return array An array of group objects, or false if none
*/
function groups_get_activity_allowed_groups($cm,$userid=0) {
// Use current user by default
global $USER;
if(!$userid) {
$userid=$USER->id;
}
// Get groupmode for activity, taking into account course settings
$groupmode=groups_get_activity_groupmode($cm);
// If visible groups mode, or user has the accessallgroups capability,
// then they can access all groups for the activity...
$context = context_module::instance($cm->id);
if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context, $userid)) {
return groups_get_all_groups($cm->course, 0, $cm->groupingid);
} else {
// ...otherwise they can only access groups they belong to
return groups_get_all_groups($cm->course, $userid, $cm->groupingid);
}
}
/**
* Determine if a given group is visible to user or not in a given context.
*
* @since Moodle 2.6
* @param int $groupid Group id to test. 0 for all groups.
* @param stdClass $course Course object.
* @param stdClass $cm Course module object.
* @param int $userid user id to test against. Defaults to $USER.
* @return boolean true if visible, false otherwise
*/
function groups_group_visible($groupid, $course, $cm = null, $userid = null) {
global $USER;
if (empty($userid)) {
$userid = $USER->id;
}
$groupmode = empty($cm) ? groups_get_course_groupmode($course) : groups_get_activity_groupmode($cm, $course);
if ($groupmode == NOGROUPS || $groupmode == VISIBLEGROUPS) {
// Groups are not used, or everything is visible, no need to go any further.
return true;
}
$context = empty($cm) ? context_course::instance($course->id) : context_module::instance($cm->id);
if (has_capability('moodle/site:accessallgroups', $context, $userid)) {
// User can see everything. Groupid = 0 is handled here as well.
return true;
} else if ($groupid != 0) {
// Group mode is separate, and user doesn't have access all groups capability. Check if user can see requested group.
$groups = empty($cm) ? groups_get_all_groups($course->id, $userid) : groups_get_activity_allowed_groups($cm, $userid);
if (array_key_exists($groupid, $groups)) {
// User can see the group.
return true;
}
}
return false;
}
/**
* Get sql and parameters that will return user ids for a group
*
* @param int $groupid
* @return array($sql, $params)
*/
function groups_get_members_ids_sql($groupid) {
$groupjoin = groups_get_members_join($groupid, 'u.id');
$sql = "SELECT DISTINCT u.id
FROM {user} u
$groupjoin->joins
WHERE u.deleted = 0";
return array($sql, $groupjoin->params);
}
/**
* Get sql join to return users in a group
*
* @param int $groupid
* @param string $useridcolumn The column of the user id from the calling SQL, e.g. u.id
* @return \core\dml\sql_join Contains joins, wheres, params
*/
function groups_get_members_join($groupid, $useridcolumn) {
// Use unique prefix just in case somebody makes some SQL magic with the result.
static $i = 0;
$i++;
$prefix = 'gm' . $i . '_';
$join = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = $useridcolumn AND {$prefix}gm.groupid = :{$prefix}gmid)";
$param = array("{$prefix}gmid" => $groupid);
return new \core\dml\sql_join($join, '', $param);
}
/**
* Internal method, sets up $SESSION->activegroup and verifies previous value
*
* @param int $courseid
* @param int|string $groupmode SEPARATEGROUPS, VISIBLEGROUPS or 'aag' (access all groups)
* @param int $groupingid 0 means all groups
* @param array $allowedgroups list of groups user can see
*/
function _group_verify_activegroup($courseid, $groupmode, $groupingid, array $allowedgroups) {
global $SESSION, $USER;
// init activegroup array if necessary
if (!isset($SESSION->activegroup)) {
$SESSION->activegroup = array();
}
if (!array_key_exists($courseid, $SESSION->activegroup)) {
$SESSION->activegroup[$courseid] = array(SEPARATEGROUPS=>array(), VISIBLEGROUPS=>array(), 'aag'=>array());
}
// make sure that the current group info is ok
if (array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode]) and !array_key_exists($SESSION->activegroup[$courseid][$groupmode][$groupingid], $allowedgroups)) {
// active group does not exist anymore or is 0
if ($SESSION->activegroup[$courseid][$groupmode][$groupingid] > 0 or $groupmode == SEPARATEGROUPS) {
// do not do this if all groups selected and groupmode is not separate
unset($SESSION->activegroup[$courseid][$groupmode][$groupingid]);
}
}
// set up defaults if necessary
if (!array_key_exists($groupingid, $SESSION->activegroup[$courseid][$groupmode])) {
if ($groupmode == 'aag') {