forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathenrollib.php
3268 lines (2851 loc) · 117 KB
/
enrollib.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/>.
/**
* This library includes the basic parts of enrol api.
* It is available on each page.
*
* @package core
* @subpackage enrol
* @copyright 2010 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/** Course enrol instance enabled. (used in enrol->status) */
define('ENROL_INSTANCE_ENABLED', 0);
/** Course enrol instance disabled, user may enter course if other enrol instance enabled. (used in enrol->status)*/
define('ENROL_INSTANCE_DISABLED', 1);
/** User is active participant (used in user_enrolments->status)*/
define('ENROL_USER_ACTIVE', 0);
/** User participation in course is suspended (used in user_enrolments->status) */
define('ENROL_USER_SUSPENDED', 1);
/** @deprecated - enrol caching was reworked, use ENROL_MAX_TIMESTAMP instead */
define('ENROL_REQUIRE_LOGIN_CACHE_PERIOD', 1800);
/** The timestamp indicating forever */
define('ENROL_MAX_TIMESTAMP', 2147483647);
/** When user disappears from external source, the enrolment is completely removed */
define('ENROL_EXT_REMOVED_UNENROL', 0);
/** When user disappears from external source, the enrolment is kept as is - one way sync */
define('ENROL_EXT_REMOVED_KEEP', 1);
/** @deprecated since 2.4 not used any more, migrate plugin to new restore methods */
define('ENROL_RESTORE_TYPE', 'enrolrestore');
/**
* When user disappears from external source, user enrolment is suspended, roles are kept as is.
* In some cases user needs a role with some capability to be visible in UI - suc has in gradebook,
* assignments, etc.
*/
define('ENROL_EXT_REMOVED_SUSPEND', 2);
/**
* When user disappears from external source, the enrolment is suspended and roles assigned
* by enrol instance are removed. Please note that user may "disappear" from gradebook and other areas.
* */
define('ENROL_EXT_REMOVED_SUSPENDNOROLES', 3);
/**
* Do not send email.
*/
define('ENROL_DO_NOT_SEND_EMAIL', 0);
/**
* Send email from course contact.
*/
define('ENROL_SEND_EMAIL_FROM_COURSE_CONTACT', 1);
/**
* Send email from enrolment key holder.
*/
define('ENROL_SEND_EMAIL_FROM_KEY_HOLDER', 2);
/**
* Send email from no reply address.
*/
define('ENROL_SEND_EMAIL_FROM_NOREPLY', 3);
/** Edit enrolment action. */
define('ENROL_ACTION_EDIT', 'editenrolment');
/** Unenrol action. */
define('ENROL_ACTION_UNENROL', 'unenrol');
/**
* Returns instances of enrol plugins
* @param bool $enabled return enabled only
* @return array of enrol plugins name=>instance
*/
function enrol_get_plugins($enabled) {
global $CFG;
$result = array();
if ($enabled) {
// sorted by enabled plugin order
$enabled = explode(',', $CFG->enrol_plugins_enabled);
$plugins = array();
foreach ($enabled as $plugin) {
$plugins[$plugin] = "$CFG->dirroot/enrol/$plugin";
}
} else {
// sorted alphabetically
$plugins = core_component::get_plugin_list('enrol');
ksort($plugins);
}
foreach ($plugins as $plugin=>$location) {
$class = "enrol_{$plugin}_plugin";
if (!class_exists($class)) {
if (!file_exists("$location/lib.php")) {
continue;
}
include_once("$location/lib.php");
if (!class_exists($class)) {
continue;
}
}
$result[$plugin] = new $class();
}
return $result;
}
/**
* Returns instance of enrol plugin
* @param string $name name of enrol plugin ('manual', 'guest', ...)
* @return enrol_plugin
*/
function enrol_get_plugin($name) {
global $CFG;
$name = clean_param($name, PARAM_PLUGIN);
if (empty($name)) {
// ignore malformed or missing plugin names completely
return null;
}
$location = "$CFG->dirroot/enrol/$name";
$class = "enrol_{$name}_plugin";
if (!class_exists($class)) {
if (!file_exists("$location/lib.php")) {
return null;
}
include_once("$location/lib.php");
if (!class_exists($class)) {
return null;
}
}
return new $class();
}
/**
* Returns enrolment instances in given course.
* @param int $courseid
* @param bool $enabled
* @return array of enrol instances
*/
function enrol_get_instances($courseid, $enabled) {
global $DB, $CFG;
if (!$enabled) {
return $DB->get_records('enrol', array('courseid'=>$courseid), 'sortorder,id');
}
$result = $DB->get_records('enrol', array('courseid'=>$courseid, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder,id');
$enabled = explode(',', $CFG->enrol_plugins_enabled);
foreach ($result as $key=>$instance) {
if (!in_array($instance->enrol, $enabled)) {
unset($result[$key]);
continue;
}
if (!file_exists("$CFG->dirroot/enrol/$instance->enrol/lib.php")) {
// broken plugin
unset($result[$key]);
continue;
}
}
return $result;
}
/**
* Checks if a given plugin is in the list of enabled enrolment plugins.
*
* @param string $enrol Enrolment plugin name
* @return boolean Whether the plugin is enabled
*/
function enrol_is_enabled($enrol) {
global $CFG;
if (empty($CFG->enrol_plugins_enabled)) {
return false;
}
return in_array($enrol, explode(',', $CFG->enrol_plugins_enabled));
}
/**
* Check all the login enrolment information for the given user object
* by querying the enrolment plugins
*
* This function may be very slow, use only once after log-in or login-as.
*
* @param stdClass $user
* @return void
*/
function enrol_check_plugins($user) {
global $CFG;
if (empty($user->id) or isguestuser($user)) {
// shortcut - there is no enrolment work for guests and not-logged-in users
return;
}
// originally there was a broken admin test, but accidentally it was non-functional in 2.2,
// which proved it was actually not necessary.
static $inprogress = array(); // To prevent this function being called more than once in an invocation
if (!empty($inprogress[$user->id])) {
return;
}
$inprogress[$user->id] = true; // Set the flag
$enabled = enrol_get_plugins(true);
foreach($enabled as $enrol) {
$enrol->sync_user_enrolments($user);
}
unset($inprogress[$user->id]); // Unset the flag
}
/**
* Do these two students share any course?
*
* The courses has to be visible and enrolments has to be active,
* timestart and timeend restrictions are ignored.
*
* This function calls {@see enrol_get_shared_courses()} setting checkexistsonly
* to true.
*
* @param stdClass|int $user1
* @param stdClass|int $user2
* @return bool
*/
function enrol_sharing_course($user1, $user2) {
return enrol_get_shared_courses($user1, $user2, false, true);
}
/**
* Returns any courses shared by the two users
*
* The courses has to be visible and enrolments has to be active,
* timestart and timeend restrictions are ignored.
*
* @global moodle_database $DB
* @param stdClass|int $user1
* @param stdClass|int $user2
* @param bool $preloadcontexts If set to true contexts for the returned courses
* will be preloaded.
* @param bool $checkexistsonly If set to true then this function will return true
* if the users share any courses and false if not.
* @return array|bool An array of courses that both users are enrolled in OR if
* $checkexistsonly set returns true if the users share any courses
* and false if not.
*/
function enrol_get_shared_courses($user1, $user2, $preloadcontexts = false, $checkexistsonly = false) {
global $DB, $CFG;
$user1 = isset($user1->id) ? $user1->id : $user1;
$user2 = isset($user2->id) ? $user2->id : $user2;
if (empty($user1) or empty($user2)) {
return false;
}
if (!$plugins = explode(',', $CFG->enrol_plugins_enabled)) {
return false;
}
list($plugins1, $params1) = $DB->get_in_or_equal($plugins, SQL_PARAMS_NAMED, 'ee1');
list($plugins2, $params2) = $DB->get_in_or_equal($plugins, SQL_PARAMS_NAMED, 'ee2');
$params = array_merge($params1, $params2);
$params['enabled1'] = ENROL_INSTANCE_ENABLED;
$params['enabled2'] = ENROL_INSTANCE_ENABLED;
$params['active1'] = ENROL_USER_ACTIVE;
$params['active2'] = ENROL_USER_ACTIVE;
$params['user1'] = $user1;
$params['user2'] = $user2;
$ctxselect = '';
$ctxjoin = '';
if ($preloadcontexts) {
$ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
$ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
$params['contextlevel'] = CONTEXT_COURSE;
}
$sql = "SELECT c.* $ctxselect
FROM {course} c
JOIN (
SELECT DISTINCT c.id
FROM {course} c
JOIN {enrol} e1 ON (c.id = e1.courseid AND e1.status = :enabled1 AND e1.enrol $plugins1)
JOIN {user_enrolments} ue1 ON (ue1.enrolid = e1.id AND ue1.status = :active1 AND ue1.userid = :user1)
JOIN {enrol} e2 ON (c.id = e2.courseid AND e2.status = :enabled2 AND e2.enrol $plugins2)
JOIN {user_enrolments} ue2 ON (ue2.enrolid = e2.id AND ue2.status = :active2 AND ue2.userid = :user2)
WHERE c.visible = 1
) ec ON ec.id = c.id
$ctxjoin";
if ($checkexistsonly) {
return $DB->record_exists_sql($sql, $params);
} else {
$courses = $DB->get_records_sql($sql, $params);
if ($preloadcontexts) {
array_map('context_helper::preload_from_record', $courses);
}
return $courses;
}
}
/**
* This function adds necessary enrol plugins UI into the course edit form.
*
* @param MoodleQuickForm $mform
* @param object $data course edit form data
* @param object $context context of existing course or parent category if course does not exist
* @return void
*/
function enrol_course_edit_form(MoodleQuickForm $mform, $data, $context) {
$plugins = enrol_get_plugins(true);
if (!empty($data->id)) {
$instances = enrol_get_instances($data->id, false);
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
continue;
}
$plugin = $plugins[$instance->enrol];
$plugin->course_edit_form($instance, $mform, $data, $context);
}
} else {
foreach ($plugins as $plugin) {
$plugin->course_edit_form(NULL, $mform, $data, $context);
}
}
}
/**
* Validate course edit form data
*
* @param array $data raw form data
* @param object $context context of existing course or parent category if course does not exist
* @return array errors array
*/
function enrol_course_edit_validation(array $data, $context) {
$errors = array();
$plugins = enrol_get_plugins(true);
if (!empty($data['id'])) {
$instances = enrol_get_instances($data['id'], false);
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
continue;
}
$plugin = $plugins[$instance->enrol];
$errors = array_merge($errors, $plugin->course_edit_validation($instance, $data, $context));
}
} else {
foreach ($plugins as $plugin) {
$errors = array_merge($errors, $plugin->course_edit_validation(NULL, $data, $context));
}
}
return $errors;
}
/**
* Update enrol instances after course edit form submission
* @param bool $inserted true means new course added, false course already existed
* @param object $course
* @param object $data form data
* @return void
*/
function enrol_course_updated($inserted, $course, $data) {
global $DB, $CFG;
$plugins = enrol_get_plugins(true);
foreach ($plugins as $plugin) {
$plugin->course_updated($inserted, $course, $data);
}
}
/**
* Add navigation nodes
* @param navigation_node $coursenode
* @param object $course
* @return void
*/
function enrol_add_course_navigation(navigation_node $coursenode, $course) {
global $CFG;
$coursecontext = context_course::instance($course->id);
$instances = enrol_get_instances($course->id, true);
$plugins = enrol_get_plugins(true);
// we do not want to break all course pages if there is some borked enrol plugin, right?
foreach ($instances as $k=>$instance) {
if (!isset($plugins[$instance->enrol])) {
unset($instances[$k]);
}
}
$usersnode = $coursenode->add(get_string('users'), null, navigation_node::TYPE_CONTAINER, null, 'users');
if ($course->id != SITEID) {
// list all participants - allows assigning roles, groups, etc.
if (has_capability('moodle/course:enrolreview', $coursecontext)) {
$url = new moodle_url('/user/index.php', array('id'=>$course->id));
$usersnode->add(get_string('enrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'review', new pix_icon('i/enrolusers', ''));
}
// manage enrol plugin instances
if (has_capability('moodle/course:enrolconfig', $coursecontext) or has_capability('moodle/course:enrolreview', $coursecontext)) {
$url = new moodle_url('/enrol/instances.php', array('id'=>$course->id));
} else {
$url = NULL;
}
$instancesnode = $usersnode->add(get_string('enrolmentinstances', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'manageinstances');
// each instance decides how to configure itself or how many other nav items are exposed
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
continue;
}
$plugins[$instance->enrol]->add_course_navigation($instancesnode, $instance);
}
if (!$url) {
$instancesnode->trim_if_empty();
}
}
// Manage groups in this course or even frontpage
if (($course->groupmode || !$course->groupmodeforce) && has_capability('moodle/course:managegroups', $coursecontext)) {
$url = new moodle_url('/group/index.php', array('id'=>$course->id));
$usersnode->add(get_string('groups'), $url, navigation_node::TYPE_SETTING, null, 'groups', new pix_icon('i/group', ''));
}
if (has_any_capability(array( 'moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:review'), $coursecontext)) {
// Override roles
if (has_capability('moodle/role:review', $coursecontext)) {
$url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$coursecontext->id));
} else {
$url = NULL;
}
$permissionsnode = $usersnode->add(get_string('permissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'override');
// Add assign or override roles if allowed
if ($course->id == SITEID or (!empty($CFG->adminsassignrolesincourse) and is_siteadmin())) {
if (has_capability('moodle/role:assign', $coursecontext)) {
$url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$coursecontext->id));
$permissionsnode->add(get_string('assignedroles', 'role'), $url, navigation_node::TYPE_SETTING, null, 'roles', new pix_icon('i/assignroles', ''));
}
}
// Check role permissions
if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override'), $coursecontext)) {
$url = new moodle_url('/admin/roles/check.php', array('contextid'=>$coursecontext->id));
$permissionsnode->add(get_string('checkpermissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'permissions', new pix_icon('i/checkpermissions', ''));
}
}
// Deal somehow with users that are not enrolled but still got a role somehow
if ($course->id != SITEID) {
//TODO, create some new UI for role assignments at course level
if (has_capability('moodle/course:reviewotherusers', $coursecontext)) {
$url = new moodle_url('/enrol/otherusers.php', array('id'=>$course->id));
$usersnode->add(get_string('notenrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'otherusers', new pix_icon('i/assignroles', ''));
}
}
// just in case nothing was actually added
$usersnode->trim_if_empty();
if ($course->id != SITEID) {
if (isguestuser() or !isloggedin()) {
// guest account can not be enrolled - no links for them
} else if (is_enrolled($coursecontext)) {
// unenrol link if possible
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
continue;
}
$plugin = $plugins[$instance->enrol];
if ($unenrollink = $plugin->get_unenrolself_link($instance)) {
$shortname = format_string($course->shortname, true, array('context' => $coursecontext));
$coursenode->add(get_string('unenrolme', 'core_enrol', $shortname), $unenrollink, navigation_node::TYPE_SETTING, null, 'unenrolself', new pix_icon('i/user', ''));
break;
//TODO. deal with multiple unenrol links - not likely case, but still...
}
}
} else {
// enrol link if possible
if (is_viewing($coursecontext)) {
// better not show any enrol link, this is intended for managers and inspectors
} else {
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
continue;
}
$plugin = $plugins[$instance->enrol];
if ($plugin->show_enrolme_link($instance)) {
$url = new moodle_url('/enrol/index.php', array('id'=>$course->id));
$shortname = format_string($course->shortname, true, array('context' => $coursecontext));
$coursenode->add(get_string('enrolme', 'core_enrol', $shortname), $url, navigation_node::TYPE_SETTING, null, 'enrolself', new pix_icon('i/user', ''));
break;
}
}
}
}
}
}
/**
* Returns list of courses current $USER is enrolled in and can access
*
* The $fields param is a list of field names to ADD so name just the fields you really need,
* which will be added and uniq'd.
*
* If $allaccessible is true, this will additionally return courses that the current user is not
* enrolled in, but can access because they are open to the user for other reasons (course view
* permission, currently viewing course as a guest, or course allows guest access without
* password).
*
* @param string|array $fields Extra fields to be returned (array or comma-separated list).
* @param string|null $sort Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort.
* Allowed prefixes for sort fields are: "ul" for the user_lastaccess table, "c" for the courses table,
* "ue" for the user_enrolments table.
* @param int $limit max number of courses
* @param array $courseids the list of course ids to filter by
* @param bool $allaccessible Include courses user is not enrolled in, but can access
* @param int $offset Offset the result set by this number
* @param array $excludecourses IDs of hidden courses to exclude from search
* @return array
*/
function enrol_get_my_courses($fields = null, $sort = null, $limit = 0, $courseids = [], $allaccessible = false,
$offset = 0, $excludecourses = []) {
global $DB, $USER, $CFG;
// Re-Arrange the course sorting according to the admin settings.
$sort = enrol_get_courses_sortingsql($sort);
// Guest account does not have any enrolled courses.
if (!$allaccessible && (isguestuser() or !isloggedin())) {
return array();
}
$basefields = [
'id', 'category', 'sortorder',
'shortname', 'fullname', 'idnumber',
'startdate', 'visible',
'groupmode', 'groupmodeforce', 'cacherev',
'showactivitydates', 'showcompletionconditions',
];
if (empty($fields)) {
$fields = $basefields;
} else if (is_string($fields)) {
// turn the fields from a string to an array
$fields = explode(',', $fields);
$fields = array_map('trim', $fields);
$fields = array_unique(array_merge($basefields, $fields));
} else if (is_array($fields)) {
$fields = array_unique(array_merge($basefields, $fields));
} else {
throw new coding_exception('Invalid $fields parameter in enrol_get_my_courses()');
}
if (in_array('*', $fields)) {
$fields = array('*');
}
$orderby = "";
$sort = trim($sort);
$sorttimeaccess = false;
$allowedsortprefixes = array('c', 'ul', 'ue');
if (!empty($sort)) {
$rawsorts = explode(',', $sort);
$sorts = array();
foreach ($rawsorts as $rawsort) {
$rawsort = trim($rawsort);
if (preg_match('/^ul\.(\S*)\s(asc|desc)/i', $rawsort, $matches)) {
if (strcasecmp($matches[2], 'asc') == 0) {
$sorts[] = 'COALESCE(ul.' . $matches[1] . ', 0) ASC';
} else {
$sorts[] = 'COALESCE(ul.' . $matches[1] . ', 0) DESC';
}
$sorttimeaccess = true;
} else if (strpos($rawsort, '.') !== false) {
$prefix = explode('.', $rawsort);
if (in_array($prefix[0], $allowedsortprefixes)) {
$sorts[] = trim($rawsort);
} else {
throw new coding_exception('Invalid $sort parameter in enrol_get_my_courses()');
}
} else {
$sorts[] = 'c.'.trim($rawsort);
}
}
$sort = implode(',', $sorts);
$orderby = "ORDER BY $sort";
}
$wheres = array("c.id <> :siteid");
$params = array('siteid'=>SITEID);
if (isset($USER->loginascontext) and $USER->loginascontext->contextlevel == CONTEXT_COURSE) {
// list _only_ this course - anything else is asking for trouble...
$wheres[] = "courseid = :loginas";
$params['loginas'] = $USER->loginascontext->instanceid;
}
$coursefields = 'c.' .join(',c.', $fields);
$ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
$ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
$params['contextlevel'] = CONTEXT_COURSE;
$wheres = implode(" AND ", $wheres);
$timeaccessselect = "";
$timeaccessjoin = "";
if (!empty($courseids)) {
list($courseidssql, $courseidsparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
$wheres = sprintf("%s AND c.id %s", $wheres, $courseidssql);
$params = array_merge($params, $courseidsparams);
}
if (!empty($excludecourses)) {
list($courseidssql, $courseidsparams) = $DB->get_in_or_equal($excludecourses, SQL_PARAMS_NAMED, 'param', false);
$wheres = sprintf("%s AND c.id %s", $wheres, $courseidssql);
$params = array_merge($params, $courseidsparams);
}
$courseidsql = "";
// Logged-in, non-guest users get their enrolled courses.
if (!isguestuser() && isloggedin()) {
$courseidsql .= "
SELECT DISTINCT e.courseid
FROM {enrol} e
JOIN {user_enrolments} ue ON (ue.enrolid = e.id AND ue.userid = :userid1)
WHERE ue.status = :active AND e.status = :enabled AND ue.timestart <= :now1
AND (ue.timeend = 0 OR ue.timeend > :now2)";
$params['userid1'] = $USER->id;
$params['active'] = ENROL_USER_ACTIVE;
$params['enabled'] = ENROL_INSTANCE_ENABLED;
$params['now1'] = $params['now2'] = time();
if ($sorttimeaccess) {
$params['userid2'] = $USER->id;
$timeaccessselect = ', ul.timeaccess as lastaccessed';
$timeaccessjoin = "LEFT JOIN {user_lastaccess} ul ON (ul.courseid = c.id AND ul.userid = :userid2)";
}
}
// When including non-enrolled but accessible courses...
if ($allaccessible) {
if (is_siteadmin()) {
// Site admins can access all courses.
$courseidsql = "SELECT DISTINCT c2.id AS courseid FROM {course} c2";
} else {
// If we used the enrolment as well, then this will be UNIONed.
if ($courseidsql) {
$courseidsql .= " UNION ";
}
// Include courses with guest access and no password.
$courseidsql .= "
SELECT DISTINCT e.courseid
FROM {enrol} e
WHERE e.enrol = 'guest' AND e.password = :emptypass AND e.status = :enabled2";
$params['emptypass'] = '';
$params['enabled2'] = ENROL_INSTANCE_ENABLED;
// Include courses where the current user is currently using guest access (may include
// those which require a password).
$courseids = [];
$accessdata = get_user_accessdata($USER->id);
foreach ($accessdata['ra'] as $contextpath => $roles) {
if (array_key_exists($CFG->guestroleid, $roles)) {
// Work out the course id from context path.
$context = context::instance_by_id(preg_replace('~^.*/~', '', $contextpath));
if ($context instanceof context_course) {
$courseids[$context->instanceid] = true;
}
}
}
// Include courses where the current user has moodle/course:view capability.
$courses = get_user_capability_course('moodle/course:view', null, false);
if (!$courses) {
$courses = [];
}
foreach ($courses as $course) {
$courseids[$course->id] = true;
}
// If there are any in either category, list them individually.
if ($courseids) {
list ($allowedsql, $allowedparams) = $DB->get_in_or_equal(
array_keys($courseids), SQL_PARAMS_NAMED);
$courseidsql .= "
UNION
SELECT DISTINCT c3.id AS courseid
FROM {course} c3
WHERE c3.id $allowedsql";
$params = array_merge($params, $allowedparams);
}
}
}
// Note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why
// we have the subselect there.
$sql = "SELECT $coursefields $ccselect $timeaccessselect
FROM {course} c
JOIN ($courseidsql) en ON (en.courseid = c.id)
$timeaccessjoin
$ccjoin
WHERE $wheres
$orderby";
$courses = $DB->get_records_sql($sql, $params, $offset, $limit);
// preload contexts and check visibility
foreach ($courses as $id=>$course) {
context_helper::preload_from_record($course);
if (!$course->visible) {
if (!$context = context_course::instance($id, IGNORE_MISSING)) {
unset($courses[$id]);
continue;
}
if (!has_capability('moodle/course:viewhiddencourses', $context)) {
unset($courses[$id]);
continue;
}
}
$courses[$id] = $course;
}
//wow! Is that really all? :-D
return $courses;
}
/**
* Returns course enrolment information icons.
*
* @param object $course
* @param array $instances enrol instances of this course, improves performance
* @return array of pix_icon
*/
function enrol_get_course_info_icons($course, array $instances = NULL) {
$icons = array();
if (is_null($instances)) {
$instances = enrol_get_instances($course->id, true);
}
$plugins = enrol_get_plugins(true);
foreach ($plugins as $name => $plugin) {
$pis = array();
foreach ($instances as $instance) {
if ($instance->status != ENROL_INSTANCE_ENABLED or $instance->courseid != $course->id) {
debugging('Invalid instances parameter submitted in enrol_get_info_icons()');
continue;
}
if ($instance->enrol == $name) {
$pis[$instance->id] = $instance;
}
}
if ($pis) {
$icons = array_merge($icons, $plugin->get_info_icons($pis));
}
}
return $icons;
}
/**
* Returns SQL ORDER arguments which reflect the admin settings to sort my courses.
*
* @param string|null $sort SQL ORDER arguments which were originally requested (optionally).
* @return string SQL ORDER arguments.
*/
function enrol_get_courses_sortingsql($sort = null) {
global $CFG;
// Prepare the visible SQL fragment as empty.
$visible = '';
// Only create a visible SQL fragment if the caller didn't already pass a sort order which contains the visible field.
if ($sort === null || strpos($sort, 'visible') === false) {
// If the admin did not explicitly want to have shown and hidden courses sorted as one list, we will sort hidden
// courses to the end of the course list.
if (!isset($CFG->navsortmycourseshiddenlast) || $CFG->navsortmycourseshiddenlast == true) {
$visible = 'visible DESC, ';
}
}
// Only create a sortorder SQL fragment if the caller didn't already pass one.
if ($sort === null) {
// If the admin has configured a course sort order, we will use this.
if (!empty($CFG->navsortmycoursessort)) {
$sort = $CFG->navsortmycoursessort . ' ASC';
// Otherwise we will fall back to the sortorder sorting.
} else {
$sort = 'sortorder ASC';
}
}
return $visible . $sort;
}
/**
* Returns course enrolment detailed information.
*
* @param object $course
* @return array of html fragments - can be used to construct lists
*/
function enrol_get_course_description_texts($course) {
$lines = array();
$instances = enrol_get_instances($course->id, true);
$plugins = enrol_get_plugins(true);
foreach ($instances as $instance) {
if (!isset($plugins[$instance->enrol])) {
//weird
continue;
}
$plugin = $plugins[$instance->enrol];
$text = $plugin->get_description_text($instance);
if ($text !== NULL) {
$lines[] = $text;
}
}
return $lines;
}
/**
* Returns list of courses user is enrolled into.
*
* Note: Use {@link enrol_get_all_users_courses()} if you need the list without any capability checks.
*
* The $fields param is a list of field names to ADD so name just the fields you really need,
* which will be added and uniq'd.
*
* @param int $userid User whose courses are returned, defaults to the current user.
* @param bool $onlyactive Return only active enrolments in courses user may see.
* @param string|array $fields Extra fields to be returned (array or comma-separated list).
* @param string|null $sort Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort.
* @return array
*/
function enrol_get_users_courses($userid, $onlyactive = false, $fields = null, $sort = null) {
global $DB;
$courses = enrol_get_all_users_courses($userid, $onlyactive, $fields, $sort);
// preload contexts and check visibility
if ($onlyactive) {
foreach ($courses as $id=>$course) {
context_helper::preload_from_record($course);
if (!$course->visible) {
if (!$context = context_course::instance($id)) {
unset($courses[$id]);
continue;
}
if (!has_capability('moodle/course:viewhiddencourses', $context, $userid)) {
unset($courses[$id]);
continue;
}
}
}
}
return $courses;
}
/**
* Returns list of roles per users into course.
*
* @param int $courseid Course id.
* @return array Array[$userid][$roleid] = role_assignment.
*/
function enrol_get_course_users_roles(int $courseid) : array {
global $DB;
$context = context_course::instance($courseid);
$roles = array();
$records = $DB->get_recordset('role_assignments', array('contextid' => $context->id));
foreach ($records as $record) {
if (isset($roles[$record->userid]) === false) {
$roles[$record->userid] = array();
}
$roles[$record->userid][$record->roleid] = $record;
}
$records->close();
return $roles;
}
/**
* Can user access at least one enrolled course?
*
* Cheat if necessary, but find out as fast as possible!
*
* @param int|stdClass $user null means use current user
* @return bool
*/
function enrol_user_sees_own_courses($user = null) {
global $USER;
if ($user === null) {
$user = $USER;
}
$userid = is_object($user) ? $user->id : $user;
// Guest account does not have any courses
if (isguestuser($userid) or empty($userid)) {
return false;
}
// Let's cheat here if this is the current user,
// if user accessed any course recently, then most probably
// we do not need to query the database at all.
if ($USER->id == $userid) {
if (!empty($USER->enrol['enrolled'])) {
foreach ($USER->enrol['enrolled'] as $until) {
if ($until > time()) {
return true;
}
}
}
}
// Now the slow way.
$courses = enrol_get_all_users_courses($userid, true);
foreach($courses as $course) {
if ($course->visible) {
return true;
}
context_helper::preload_from_record($course);
$context = context_course::instance($course->id);
if (has_capability('moodle/course:viewhiddencourses', $context, $user)) {
return true;
}
}
return false;
}
/**
* Returns list of courses user is enrolled into without performing any capability checks.
*
* The $fields param is a list of field names to ADD so name just the fields you really need,
* which will be added and uniq'd.
*
* @param int $userid User whose courses are returned, defaults to the current user.
* @param bool $onlyactive Return only active enrolments in courses user may see.
* @param string|array $fields Extra fields to be returned (array or comma-separated list).
* @param string|null $sort Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort.
* @return array
*/
function enrol_get_all_users_courses($userid, $onlyactive = false, $fields = null, $sort = null) {
global $DB;
// Re-Arrange the course sorting according to the admin settings.
$sort = enrol_get_courses_sortingsql($sort);
// Guest account does not have any courses
if (isguestuser($userid) or empty($userid)) {
return(array());
}
$basefields = array('id', 'category', 'sortorder',