e23eb1adaa2b04b353975f5bc491ad14187cc77e
[moodle.git] / lib / enrollib.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  * This library includes the basic parts of enrol api.
20  * It is available on each page.
21  *
22  * @package    core
23  * @subpackage enrol
24  * @copyright  2010 Petr Skoda {@link http://skodak.org}
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /** Course enrol instance enabled. (used in enrol->status) */
31 define('ENROL_INSTANCE_ENABLED', 0);
33 /** Course enrol instance disabled, user may enter course if other enrol instance enabled. (used in enrol->status)*/
34 define('ENROL_INSTANCE_DISABLED', 1);
36 /** User is active participant (used in user_enrolments->status)*/
37 define('ENROL_USER_ACTIVE', 0);
39 /** User participation in course is suspended (used in user_enrolments->status) */
40 define('ENROL_USER_SUSPENDED', 1);
42 /** @deprecated - enrol caching was reworked, use ENROL_MAX_TIMESTAMP instead */
43 define('ENROL_REQUIRE_LOGIN_CACHE_PERIOD', 1800);
45 /** The timestamp indicating forever */
46 define('ENROL_MAX_TIMESTAMP', 2147483647);
48 /** When user disappears from external source, the enrolment is completely removed */
49 define('ENROL_EXT_REMOVED_UNENROL', 0);
51 /** When user disappears from external source, the enrolment is kept as is - one way sync */
52 define('ENROL_EXT_REMOVED_KEEP', 1);
54 /** @deprecated since 2.4 not used any more, migrate plugin to new restore methods */
55 define('ENROL_RESTORE_TYPE', 'enrolrestore');
57 /**
58  * When user disappears from external source, user enrolment is suspended, roles are kept as is.
59  * In some cases user needs a role with some capability to be visible in UI - suc has in gradebook,
60  * assignments, etc.
61  */
62 define('ENROL_EXT_REMOVED_SUSPEND', 2);
64 /**
65  * When user disappears from external source, the enrolment is suspended and roles assigned
66  * by enrol instance are removed. Please note that user may "disappear" from gradebook and other areas.
67  * */
68 define('ENROL_EXT_REMOVED_SUSPENDNOROLES', 3);
70 /**
71  * Do not send email.
72  */
73 define('ENROL_DO_NOT_SEND_EMAIL', 0);
75 /**
76  * Send email from course contact.
77  */
78 define('ENROL_SEND_EMAIL_FROM_COURSE_CONTACT', 1);
80 /**
81  * Send email from enrolment key holder.
82  */
83 define('ENROL_SEND_EMAIL_FROM_KEY_HOLDER', 2);
85 /**
86  * Send email from no reply address.
87  */
88 define('ENROL_SEND_EMAIL_FROM_NOREPLY', 3);
90 /** Edit enrolment action. */
91 define('ENROL_ACTION_EDIT', 'editenrolment');
93 /** Unenrol action. */
94 define('ENROL_ACTION_UNENROL', 'unenrol');
96 /**
97  * Returns instances of enrol plugins
98  * @param bool $enabled return enabled only
99  * @return array of enrol plugins name=>instance
100  */
101 function enrol_get_plugins($enabled) {
102     global $CFG;
104     $result = array();
106     if ($enabled) {
107         // sorted by enabled plugin order
108         $enabled = explode(',', $CFG->enrol_plugins_enabled);
109         $plugins = array();
110         foreach ($enabled as $plugin) {
111             $plugins[$plugin] = "$CFG->dirroot/enrol/$plugin";
112         }
113     } else {
114         // sorted alphabetically
115         $plugins = core_component::get_plugin_list('enrol');
116         ksort($plugins);
117     }
119     foreach ($plugins as $plugin=>$location) {
120         $class = "enrol_{$plugin}_plugin";
121         if (!class_exists($class)) {
122             if (!file_exists("$location/lib.php")) {
123                 continue;
124             }
125             include_once("$location/lib.php");
126             if (!class_exists($class)) {
127                 continue;
128             }
129         }
131         $result[$plugin] = new $class();
132     }
134     return $result;
137 /**
138  * Returns instance of enrol plugin
139  * @param  string $name name of enrol plugin ('manual', 'guest', ...)
140  * @return enrol_plugin
141  */
142 function enrol_get_plugin($name) {
143     global $CFG;
145     $name = clean_param($name, PARAM_PLUGIN);
147     if (empty($name)) {
148         // ignore malformed or missing plugin names completely
149         return null;
150     }
152     $location = "$CFG->dirroot/enrol/$name";
154     $class = "enrol_{$name}_plugin";
155     if (!class_exists($class)) {
156         if (!file_exists("$location/lib.php")) {
157             return null;
158         }
159         include_once("$location/lib.php");
160         if (!class_exists($class)) {
161             return null;
162         }
163     }
165     return new $class();
168 /**
169  * Returns enrolment instances in given course.
170  * @param int $courseid
171  * @param bool $enabled
172  * @return array of enrol instances
173  */
174 function enrol_get_instances($courseid, $enabled) {
175     global $DB, $CFG;
177     if (!$enabled) {
178         return $DB->get_records('enrol', array('courseid'=>$courseid), 'sortorder,id');
179     }
181     $result = $DB->get_records('enrol', array('courseid'=>$courseid, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder,id');
183     $enabled = explode(',', $CFG->enrol_plugins_enabled);
184     foreach ($result as $key=>$instance) {
185         if (!in_array($instance->enrol, $enabled)) {
186             unset($result[$key]);
187             continue;
188         }
189         if (!file_exists("$CFG->dirroot/enrol/$instance->enrol/lib.php")) {
190             // broken plugin
191             unset($result[$key]);
192             continue;
193         }
194     }
196     return $result;
199 /**
200  * Checks if a given plugin is in the list of enabled enrolment plugins.
201  *
202  * @param string $enrol Enrolment plugin name
203  * @return boolean Whether the plugin is enabled
204  */
205 function enrol_is_enabled($enrol) {
206     global $CFG;
208     if (empty($CFG->enrol_plugins_enabled)) {
209         return false;
210     }
211     return in_array($enrol, explode(',', $CFG->enrol_plugins_enabled));
214 /**
215  * Check all the login enrolment information for the given user object
216  * by querying the enrolment plugins
217  *
218  * This function may be very slow, use only once after log-in or login-as.
219  *
220  * @param stdClass $user
221  * @return void
222  */
223 function enrol_check_plugins($user) {
224     global $CFG;
226     if (empty($user->id) or isguestuser($user)) {
227         // shortcut - there is no enrolment work for guests and not-logged-in users
228         return;
229     }
231     // originally there was a broken admin test, but accidentally it was non-functional in 2.2,
232     // which proved it was actually not necessary.
234     static $inprogress = array();  // To prevent this function being called more than once in an invocation
236     if (!empty($inprogress[$user->id])) {
237         return;
238     }
240     $inprogress[$user->id] = true;  // Set the flag
242     $enabled = enrol_get_plugins(true);
244     foreach($enabled as $enrol) {
245         $enrol->sync_user_enrolments($user);
246     }
248     unset($inprogress[$user->id]);  // Unset the flag
251 /**
252  * Do these two students share any course?
253  *
254  * The courses has to be visible and enrolments has to be active,
255  * timestart and timeend restrictions are ignored.
256  *
257  * This function calls {@see enrol_get_shared_courses()} setting checkexistsonly
258  * to true.
259  *
260  * @param stdClass|int $user1
261  * @param stdClass|int $user2
262  * @return bool
263  */
264 function enrol_sharing_course($user1, $user2) {
265     return enrol_get_shared_courses($user1, $user2, false, true);
268 /**
269  * Returns any courses shared by the two users
270  *
271  * The courses has to be visible and enrolments has to be active,
272  * timestart and timeend restrictions are ignored.
273  *
274  * @global moodle_database $DB
275  * @param stdClass|int $user1
276  * @param stdClass|int $user2
277  * @param bool $preloadcontexts If set to true contexts for the returned courses
278  *              will be preloaded.
279  * @param bool $checkexistsonly If set to true then this function will return true
280  *              if the users share any courses and false if not.
281  * @return array|bool An array of courses that both users are enrolled in OR if
282  *              $checkexistsonly set returns true if the users share any courses
283  *              and false if not.
284  */
285 function enrol_get_shared_courses($user1, $user2, $preloadcontexts = false, $checkexistsonly = false) {
286     global $DB, $CFG;
288     $user1 = isset($user1->id) ? $user1->id : $user1;
289     $user2 = isset($user2->id) ? $user2->id : $user2;
291     if (empty($user1) or empty($user2)) {
292         return false;
293     }
295     if (!$plugins = explode(',', $CFG->enrol_plugins_enabled)) {
296         return false;
297     }
299     list($plugins1, $params1) = $DB->get_in_or_equal($plugins, SQL_PARAMS_NAMED, 'ee1');
300     list($plugins2, $params2) = $DB->get_in_or_equal($plugins, SQL_PARAMS_NAMED, 'ee2');
301     $params = array_merge($params1, $params2);
302     $params['enabled1'] = ENROL_INSTANCE_ENABLED;
303     $params['enabled2'] = ENROL_INSTANCE_ENABLED;
304     $params['active1'] = ENROL_USER_ACTIVE;
305     $params['active2'] = ENROL_USER_ACTIVE;
306     $params['user1']   = $user1;
307     $params['user2']   = $user2;
309     $ctxselect = '';
310     $ctxjoin = '';
311     if ($preloadcontexts) {
312         $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
313         $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
314         $params['contextlevel'] = CONTEXT_COURSE;
315     }
317     $sql = "SELECT c.* $ctxselect
318               FROM {course} c
319               JOIN (
320                 SELECT DISTINCT c.id
321                   FROM {course} c
322                   JOIN {enrol} e1 ON (c.id = e1.courseid AND e1.status = :enabled1 AND e1.enrol $plugins1)
323                   JOIN {user_enrolments} ue1 ON (ue1.enrolid = e1.id AND ue1.status = :active1 AND ue1.userid = :user1)
324                   JOIN {enrol} e2 ON (c.id = e2.courseid AND e2.status = :enabled2 AND e2.enrol $plugins2)
325                   JOIN {user_enrolments} ue2 ON (ue2.enrolid = e2.id AND ue2.status = :active2 AND ue2.userid = :user2)
326                  WHERE c.visible = 1
327               ) ec ON ec.id = c.id
328               $ctxjoin";
330     if ($checkexistsonly) {
331         return $DB->record_exists_sql($sql, $params);
332     } else {
333         $courses = $DB->get_records_sql($sql, $params);
334         if ($preloadcontexts) {
335             array_map('context_helper::preload_from_record', $courses);
336         }
337         return $courses;
338     }
341 /**
342  * This function adds necessary enrol plugins UI into the course edit form.
343  *
344  * @param MoodleQuickForm $mform
345  * @param object $data course edit form data
346  * @param object $context context of existing course or parent category if course does not exist
347  * @return void
348  */
349 function enrol_course_edit_form(MoodleQuickForm $mform, $data, $context) {
350     $plugins = enrol_get_plugins(true);
351     if (!empty($data->id)) {
352         $instances = enrol_get_instances($data->id, false);
353         foreach ($instances as $instance) {
354             if (!isset($plugins[$instance->enrol])) {
355                 continue;
356             }
357             $plugin = $plugins[$instance->enrol];
358             $plugin->course_edit_form($instance, $mform, $data, $context);
359         }
360     } else {
361         foreach ($plugins as $plugin) {
362             $plugin->course_edit_form(NULL, $mform, $data, $context);
363         }
364     }
367 /**
368  * Validate course edit form data
369  *
370  * @param array $data raw form data
371  * @param object $context context of existing course or parent category if course does not exist
372  * @return array errors array
373  */
374 function enrol_course_edit_validation(array $data, $context) {
375     $errors = array();
376     $plugins = enrol_get_plugins(true);
378     if (!empty($data['id'])) {
379         $instances = enrol_get_instances($data['id'], false);
380         foreach ($instances as $instance) {
381             if (!isset($plugins[$instance->enrol])) {
382                 continue;
383             }
384             $plugin = $plugins[$instance->enrol];
385             $errors = array_merge($errors, $plugin->course_edit_validation($instance, $data, $context));
386         }
387     } else {
388         foreach ($plugins as $plugin) {
389             $errors = array_merge($errors, $plugin->course_edit_validation(NULL, $data, $context));
390         }
391     }
393     return $errors;
396 /**
397  * Update enrol instances after course edit form submission
398  * @param bool $inserted true means new course added, false course already existed
399  * @param object $course
400  * @param object $data form data
401  * @return void
402  */
403 function enrol_course_updated($inserted, $course, $data) {
404     global $DB, $CFG;
406     $plugins = enrol_get_plugins(true);
408     foreach ($plugins as $plugin) {
409         $plugin->course_updated($inserted, $course, $data);
410     }
413 /**
414  * Add navigation nodes
415  * @param navigation_node $coursenode
416  * @param object $course
417  * @return void
418  */
419 function enrol_add_course_navigation(navigation_node $coursenode, $course) {
420     global $CFG;
422     $coursecontext = context_course::instance($course->id);
424     $instances = enrol_get_instances($course->id, true);
425     $plugins   = enrol_get_plugins(true);
427     // we do not want to break all course pages if there is some borked enrol plugin, right?
428     foreach ($instances as $k=>$instance) {
429         if (!isset($plugins[$instance->enrol])) {
430             unset($instances[$k]);
431         }
432     }
434     $usersnode = $coursenode->add(get_string('users'), null, navigation_node::TYPE_CONTAINER, null, 'users');
436     if ($course->id != SITEID) {
437         // list all participants - allows assigning roles, groups, etc.
438         if (has_capability('moodle/course:enrolreview', $coursecontext)) {
439             $url = new moodle_url('/user/index.php', array('id'=>$course->id));
440             $usersnode->add(get_string('enrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'review', new pix_icon('i/enrolusers', ''));
441         }
443         // manage enrol plugin instances
444         if (has_capability('moodle/course:enrolconfig', $coursecontext) or has_capability('moodle/course:enrolreview', $coursecontext)) {
445             $url = new moodle_url('/enrol/instances.php', array('id'=>$course->id));
446         } else {
447             $url = NULL;
448         }
449         $instancesnode = $usersnode->add(get_string('enrolmentinstances', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'manageinstances');
451         // each instance decides how to configure itself or how many other nav items are exposed
452         foreach ($instances as $instance) {
453             if (!isset($plugins[$instance->enrol])) {
454                 continue;
455             }
456             $plugins[$instance->enrol]->add_course_navigation($instancesnode, $instance);
457         }
459         if (!$url) {
460             $instancesnode->trim_if_empty();
461         }
462     }
464     // Manage groups in this course or even frontpage
465     if (($course->groupmode || !$course->groupmodeforce) && has_capability('moodle/course:managegroups', $coursecontext)) {
466         $url = new moodle_url('/group/index.php', array('id'=>$course->id));
467         $usersnode->add(get_string('groups'), $url, navigation_node::TYPE_SETTING, null, 'groups', new pix_icon('i/group', ''));
468     }
470      if (has_any_capability(array( 'moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:review'), $coursecontext)) {
471         // Override roles
472         if (has_capability('moodle/role:review', $coursecontext)) {
473             $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$coursecontext->id));
474         } else {
475             $url = NULL;
476         }
477         $permissionsnode = $usersnode->add(get_string('permissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'override');
479         // Add assign or override roles if allowed
480         if ($course->id == SITEID or (!empty($CFG->adminsassignrolesincourse) and is_siteadmin())) {
481             if (has_capability('moodle/role:assign', $coursecontext)) {
482                 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$coursecontext->id));
483                 $permissionsnode->add(get_string('assignedroles', 'role'), $url, navigation_node::TYPE_SETTING, null, 'roles', new pix_icon('i/assignroles', ''));
484             }
485         }
486         // Check role permissions
487         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override'), $coursecontext)) {
488             $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$coursecontext->id));
489             $permissionsnode->add(get_string('checkpermissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'permissions', new pix_icon('i/checkpermissions', ''));
490         }
491      }
493      // Deal somehow with users that are not enrolled but still got a role somehow
494     if ($course->id != SITEID) {
495         //TODO, create some new UI for role assignments at course level
496         if (has_capability('moodle/course:reviewotherusers', $coursecontext)) {
497             $url = new moodle_url('/enrol/otherusers.php', array('id'=>$course->id));
498             $usersnode->add(get_string('notenrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'otherusers', new pix_icon('i/assignroles', ''));
499         }
500     }
502     // just in case nothing was actually added
503     $usersnode->trim_if_empty();
505     if ($course->id != SITEID) {
506         if (isguestuser() or !isloggedin()) {
507             // guest account can not be enrolled - no links for them
508         } else if (is_enrolled($coursecontext)) {
509             // unenrol link if possible
510             foreach ($instances as $instance) {
511                 if (!isset($plugins[$instance->enrol])) {
512                     continue;
513                 }
514                 $plugin = $plugins[$instance->enrol];
515                 if ($unenrollink = $plugin->get_unenrolself_link($instance)) {
516                     $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
517                     $coursenode->add(get_string('unenrolme', 'core_enrol', $shortname), $unenrollink, navigation_node::TYPE_SETTING, null, 'unenrolself', new pix_icon('i/user', ''));
518                     break;
519                     //TODO. deal with multiple unenrol links - not likely case, but still...
520                 }
521             }
522         } else {
523             // enrol link if possible
524             if (is_viewing($coursecontext)) {
525                 // better not show any enrol link, this is intended for managers and inspectors
526             } else {
527                 foreach ($instances as $instance) {
528                     if (!isset($plugins[$instance->enrol])) {
529                         continue;
530                     }
531                     $plugin = $plugins[$instance->enrol];
532                     if ($plugin->show_enrolme_link($instance)) {
533                         $url = new moodle_url('/enrol/index.php', array('id'=>$course->id));
534                         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
535                         $coursenode->add(get_string('enrolme', 'core_enrol', $shortname), $url, navigation_node::TYPE_SETTING, null, 'enrolself', new pix_icon('i/user', ''));
536                         break;
537                     }
538                 }
539             }
540         }
541     }
544 /**
545  * Returns list of courses current $USER is enrolled in and can access
546  *
547  * - $fields is an array of field names to ADD
548  *   so name the fields you really need, which will
549  *   be added and uniq'd
550  *
551  * If $allaccessible is true, this will additionally return courses that the current user is not
552  * enrolled in, but can access because they are open to the user for other reasons (course view
553  * permission, currently viewing course as a guest, or course allows guest access without
554  * password).
555  *
556  * @param string|array $fields
557  * @param string $sort
558  * @param int $limit max number of courses
559  * @param array $courseids the list of course ids to filter by
560  * @param bool $allaccessible Include courses user is not enrolled in, but can access
561  * @return array
562  */
563 function enrol_get_my_courses($fields = null, $sort = 'visible DESC,sortorder ASC',
564           $limit = 0, $courseids = [], $allaccessible = false) {
565     global $DB, $USER, $CFG;
567     // Guest account does not have any enrolled courses.
568     if (!$allaccessible && (isguestuser() or !isloggedin())) {
569         return array();
570     }
572     $basefields = array('id', 'category', 'sortorder',
573                         'shortname', 'fullname', 'idnumber',
574                         'startdate', 'visible',
575                         'groupmode', 'groupmodeforce', 'cacherev');
577     if (empty($fields)) {
578         $fields = $basefields;
579     } else if (is_string($fields)) {
580         // turn the fields from a string to an array
581         $fields = explode(',', $fields);
582         $fields = array_map('trim', $fields);
583         $fields = array_unique(array_merge($basefields, $fields));
584     } else if (is_array($fields)) {
585         $fields = array_unique(array_merge($basefields, $fields));
586     } else {
587         throw new coding_exception('Invalid $fileds parameter in enrol_get_my_courses()');
588     }
589     if (in_array('*', $fields)) {
590         $fields = array('*');
591     }
593     $orderby = "";
594     $sort    = trim($sort);
595     if (!empty($sort)) {
596         $rawsorts = explode(',', $sort);
597         $sorts = array();
598         foreach ($rawsorts as $rawsort) {
599             $rawsort = trim($rawsort);
600             if (strpos($rawsort, 'c.') === 0) {
601                 $rawsort = substr($rawsort, 2);
602             }
603             $sorts[] = trim($rawsort);
604         }
605         $sort = 'c.'.implode(',c.', $sorts);
606         $orderby = "ORDER BY $sort";
607     }
609     $wheres = array("c.id <> :siteid");
610     $params = array('siteid'=>SITEID);
612     if (isset($USER->loginascontext) and $USER->loginascontext->contextlevel == CONTEXT_COURSE) {
613         // list _only_ this course - anything else is asking for trouble...
614         $wheres[] = "courseid = :loginas";
615         $params['loginas'] = $USER->loginascontext->instanceid;
616     }
618     $coursefields = 'c.' .join(',c.', $fields);
619     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
620     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
621     $params['contextlevel'] = CONTEXT_COURSE;
622     $wheres = implode(" AND ", $wheres);
624     if (!empty($courseids)) {
625         list($courseidssql, $courseidsparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED);
626         $wheres = sprintf("%s AND c.id %s", $wheres, $courseidssql);
627         $params = array_merge($params, $courseidsparams);
628     }
630     $courseidsql = "";
631     // Logged-in, non-guest users get their enrolled courses.
632     if (!isguestuser() && isloggedin()) {
633         $courseidsql .= "
634                 SELECT DISTINCT e.courseid
635                   FROM {enrol} e
636                   JOIN {user_enrolments} ue ON (ue.enrolid = e.id AND ue.userid = :userid)
637                  WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1
638                        AND (ue.timeend = 0 OR ue.timeend > :now2)";
639         $params['userid'] = $USER->id;
640         $params['active'] = ENROL_USER_ACTIVE;
641         $params['enabled'] = ENROL_INSTANCE_ENABLED;
642         $params['now1'] = round(time(), -2); // Improves db caching.
643         $params['now2'] = $params['now1'];
644     }
646     // When including non-enrolled but accessible courses...
647     if ($allaccessible) {
648         if (is_siteadmin()) {
649             // Site admins can access all courses.
650             $courseidsql = "SELECT DISTINCT c2.id AS courseid FROM {course} c2";
651         } else {
652             // If we used the enrolment as well, then this will be UNIONed.
653             if ($courseidsql) {
654                 $courseidsql .= " UNION ";
655             }
657             // Include courses with guest access and no password.
658             $courseidsql .= "
659                     SELECT DISTINCT e.courseid
660                       FROM {enrol} e
661                      WHERE e.enrol = 'guest' AND e.password = '' AND e.status = :enabled2";
662             $params['enabled2'] = ENROL_INSTANCE_ENABLED;
664             // Include courses where the current user is currently using guest access (may include
665             // those which require a password).
666             $courseids = [];
667             $accessdata = get_user_accessdata($USER->id);
668             foreach ($accessdata['ra'] as $contextpath => $roles) {
669                 if (array_key_exists($CFG->guestroleid, $roles)) {
670                     // Work out the course id from context path.
671                     $context = context::instance_by_id(preg_replace('~^.*/~', '', $contextpath));
672                     if ($context instanceof context_course) {
673                         $courseids[$context->instanceid] = true;
674                     }
675                 }
676             }
678             // Include courses where the current user has moodle/course:view capability.
679             $courses = get_user_capability_course('moodle/course:view', null, false);
680             if (!$courses) {
681                 $courses = [];
682             }
683             foreach ($courses as $course) {
684                 $courseids[$course->id] = true;
685             }
687             // If there are any in either category, list them individually.
688             if ($courseids) {
689                 list ($allowedsql, $allowedparams) = $DB->get_in_or_equal(
690                         array_keys($courseids), SQL_PARAMS_NAMED);
691                 $courseidsql .= "
692                         UNION
693                        SELECT DISTINCT c3.id AS courseid
694                          FROM {course} c3
695                         WHERE c3.id $allowedsql";
696                 $params = array_merge($params, $allowedparams);
697             }
698         }
699     }
701     // Note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why
702     // we have the subselect there.
703     $sql = "SELECT $coursefields $ccselect
704               FROM {course} c
705               JOIN ($courseidsql) en ON (en.courseid = c.id)
706            $ccjoin
707              WHERE $wheres
708           $orderby";
710     $courses = $DB->get_records_sql($sql, $params, 0, $limit);
712     // preload contexts and check visibility
713     foreach ($courses as $id=>$course) {
714         context_helper::preload_from_record($course);
715         if (!$course->visible) {
716             if (!$context = context_course::instance($id, IGNORE_MISSING)) {
717                 unset($courses[$id]);
718                 continue;
719             }
720             if (!has_capability('moodle/course:viewhiddencourses', $context)) {
721                 unset($courses[$id]);
722                 continue;
723             }
724         }
725         $courses[$id] = $course;
726     }
728     //wow! Is that really all? :-D
730     return $courses;
733 /**
734  * Returns course enrolment information icons.
735  *
736  * @param object $course
737  * @param array $instances enrol instances of this course, improves performance
738  * @return array of pix_icon
739  */
740 function enrol_get_course_info_icons($course, array $instances = NULL) {
741     $icons = array();
742     if (is_null($instances)) {
743         $instances = enrol_get_instances($course->id, true);
744     }
745     $plugins = enrol_get_plugins(true);
746     foreach ($plugins as $name => $plugin) {
747         $pis = array();
748         foreach ($instances as $instance) {
749             if ($instance->status != ENROL_INSTANCE_ENABLED or $instance->courseid != $course->id) {
750                 debugging('Invalid instances parameter submitted in enrol_get_info_icons()');
751                 continue;
752             }
753             if ($instance->enrol == $name) {
754                 $pis[$instance->id] = $instance;
755             }
756         }
757         if ($pis) {
758             $icons = array_merge($icons, $plugin->get_info_icons($pis));
759         }
760     }
761     return $icons;
764 /**
765  * Returns course enrolment detailed information.
766  *
767  * @param object $course
768  * @return array of html fragments - can be used to construct lists
769  */
770 function enrol_get_course_description_texts($course) {
771     $lines = array();
772     $instances = enrol_get_instances($course->id, true);
773     $plugins = enrol_get_plugins(true);
774     foreach ($instances as $instance) {
775         if (!isset($plugins[$instance->enrol])) {
776             //weird
777             continue;
778         }
779         $plugin = $plugins[$instance->enrol];
780         $text = $plugin->get_description_text($instance);
781         if ($text !== NULL) {
782             $lines[] = $text;
783         }
784     }
785     return $lines;
788 /**
789  * Returns list of courses user is enrolled into.
790  * (Note: use enrol_get_all_users_courses if you want to use the list wihtout any cap checks )
791  *
792  * - $fields is an array of fieldnames to ADD
793  *   so name the fields you really need, which will
794  *   be added and uniq'd
795  *
796  * @param int $userid
797  * @param bool $onlyactive return only active enrolments in courses user may see
798  * @param string|array $fields
799  * @param string $sort
800  * @return array
801  */
802 function enrol_get_users_courses($userid, $onlyactive = false, $fields = NULL, $sort = 'visible DESC,sortorder ASC') {
803     global $DB;
805     $courses = enrol_get_all_users_courses($userid, $onlyactive, $fields, $sort);
807     // preload contexts and check visibility
808     if ($onlyactive) {
809         foreach ($courses as $id=>$course) {
810             context_helper::preload_from_record($course);
811             if (!$course->visible) {
812                 if (!$context = context_course::instance($id)) {
813                     unset($courses[$id]);
814                     continue;
815                 }
816                 if (!has_capability('moodle/course:viewhiddencourses', $context, $userid)) {
817                     unset($courses[$id]);
818                     continue;
819                 }
820             }
821         }
822     }
824     return $courses;
828 /**
829  * Can user access at least one enrolled course?
830  *
831  * Cheat if necessary, but find out as fast as possible!
832  *
833  * @param int|stdClass $user null means use current user
834  * @return bool
835  */
836 function enrol_user_sees_own_courses($user = null) {
837     global $USER;
839     if ($user === null) {
840         $user = $USER;
841     }
842     $userid = is_object($user) ? $user->id : $user;
844     // Guest account does not have any courses
845     if (isguestuser($userid) or empty($userid)) {
846         return false;
847     }
849     // Let's cheat here if this is the current user,
850     // if user accessed any course recently, then most probably
851     // we do not need to query the database at all.
852     if ($USER->id == $userid) {
853         if (!empty($USER->enrol['enrolled'])) {
854             foreach ($USER->enrol['enrolled'] as $until) {
855                 if ($until > time()) {
856                     return true;
857                 }
858             }
859         }
860     }
862     // Now the slow way.
863     $courses = enrol_get_all_users_courses($userid, true);
864     foreach($courses as $course) {
865         if ($course->visible) {
866             return true;
867         }
868         context_helper::preload_from_record($course);
869         $context = context_course::instance($course->id);
870         if (has_capability('moodle/course:viewhiddencourses', $context, $user)) {
871             return true;
872         }
873     }
875     return false;
878 /**
879  * Returns list of courses user is enrolled into without any capability checks
880  * - $fields is an array of fieldnames to ADD
881  *   so name the fields you really need, which will
882  *   be added and uniq'd
883  *
884  * @param int $userid
885  * @param bool $onlyactive return only active enrolments in courses user may see
886  * @param string|array $fields
887  * @param string $sort
888  * @return array
889  */
890 function enrol_get_all_users_courses($userid, $onlyactive = false, $fields = NULL, $sort = 'visible DESC,sortorder ASC') {
891     global $DB;
893     // Guest account does not have any courses
894     if (isguestuser($userid) or empty($userid)) {
895         return(array());
896     }
898     $basefields = array('id', 'category', 'sortorder',
899             'shortname', 'fullname', 'idnumber',
900             'startdate', 'visible',
901             'defaultgroupingid',
902             'groupmode', 'groupmodeforce');
904     if (empty($fields)) {
905         $fields = $basefields;
906     } else if (is_string($fields)) {
907         // turn the fields from a string to an array
908         $fields = explode(',', $fields);
909         $fields = array_map('trim', $fields);
910         $fields = array_unique(array_merge($basefields, $fields));
911     } else if (is_array($fields)) {
912         $fields = array_unique(array_merge($basefields, $fields));
913     } else {
914         throw new coding_exception('Invalid $fileds parameter in enrol_get_my_courses()');
915     }
916     if (in_array('*', $fields)) {
917         $fields = array('*');
918     }
920     $orderby = "";
921     $sort    = trim($sort);
922     if (!empty($sort)) {
923         $rawsorts = explode(',', $sort);
924         $sorts = array();
925         foreach ($rawsorts as $rawsort) {
926             $rawsort = trim($rawsort);
927             if (strpos($rawsort, 'c.') === 0) {
928                 $rawsort = substr($rawsort, 2);
929             }
930             $sorts[] = trim($rawsort);
931         }
932         $sort = 'c.'.implode(',c.', $sorts);
933         $orderby = "ORDER BY $sort";
934     }
936     $params = array('siteid'=>SITEID);
938     if ($onlyactive) {
939         $subwhere = "WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
940         $params['now1']    = round(time(), -2); // improves db caching
941         $params['now2']    = $params['now1'];
942         $params['active']  = ENROL_USER_ACTIVE;
943         $params['enabled'] = ENROL_INSTANCE_ENABLED;
944     } else {
945         $subwhere = "";
946     }
948     $coursefields = 'c.' .join(',c.', $fields);
949     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
950     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
951     $params['contextlevel'] = CONTEXT_COURSE;
953     //note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why we have the subselect there
954     $sql = "SELECT $coursefields $ccselect
955               FROM {course} c
956               JOIN (SELECT DISTINCT e.courseid
957                       FROM {enrol} e
958                       JOIN {user_enrolments} ue ON (ue.enrolid = e.id AND ue.userid = :userid)
959                  $subwhere
960                    ) en ON (en.courseid = c.id)
961            $ccjoin
962              WHERE c.id <> :siteid
963           $orderby";
964     $params['userid']  = $userid;
966     $courses = $DB->get_records_sql($sql, $params);
968     return $courses;
973 /**
974  * Called when user is about to be deleted.
975  * @param object $user
976  * @return void
977  */
978 function enrol_user_delete($user) {
979     global $DB;
981     $plugins = enrol_get_plugins(true);
982     foreach ($plugins as $plugin) {
983         $plugin->user_delete($user);
984     }
986     // force cleanup of all broken enrolments
987     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
990 /**
991  * Called when course is about to be deleted.
992  * @param stdClass $course
993  * @return void
994  */
995 function enrol_course_delete($course) {
996     global $DB;
998     $instances = enrol_get_instances($course->id, false);
999     $plugins = enrol_get_plugins(true);
1000     foreach ($instances as $instance) {
1001         if (isset($plugins[$instance->enrol])) {
1002             $plugins[$instance->enrol]->delete_instance($instance);
1003         }
1004         // low level delete in case plugin did not do it
1005         $DB->delete_records('user_enrolments', array('enrolid'=>$instance->id));
1006         $DB->delete_records('role_assignments', array('itemid'=>$instance->id, 'component'=>'enrol_'.$instance->enrol));
1007         $DB->delete_records('user_enrolments', array('enrolid'=>$instance->id));
1008         $DB->delete_records('enrol', array('id'=>$instance->id));
1009     }
1012 /**
1013  * Try to enrol user via default internal auth plugin.
1014  *
1015  * For now this is always using the manual enrol plugin...
1016  *
1017  * @param $courseid
1018  * @param $userid
1019  * @param $roleid
1020  * @param $timestart
1021  * @param $timeend
1022  * @return bool success
1023  */
1024 function enrol_try_internal_enrol($courseid, $userid, $roleid = null, $timestart = 0, $timeend = 0) {
1025     global $DB;
1027     //note: this is hardcoded to manual plugin for now
1029     if (!enrol_is_enabled('manual')) {
1030         return false;
1031     }
1033     if (!$enrol = enrol_get_plugin('manual')) {
1034         return false;
1035     }
1036     if (!$instances = $DB->get_records('enrol', array('enrol'=>'manual', 'courseid'=>$courseid, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder,id ASC')) {
1037         return false;
1038     }
1039     $instance = reset($instances);
1041     $enrol->enrol_user($instance, $userid, $roleid, $timestart, $timeend);
1043     return true;
1046 /**
1047  * Is there a chance users might self enrol
1048  * @param int $courseid
1049  * @return bool
1050  */
1051 function enrol_selfenrol_available($courseid) {
1052     $result = false;
1054     $plugins = enrol_get_plugins(true);
1055     $enrolinstances = enrol_get_instances($courseid, true);
1056     foreach($enrolinstances as $instance) {
1057         if (!isset($plugins[$instance->enrol])) {
1058             continue;
1059         }
1060         if ($instance->enrol === 'guest') {
1061             // blacklist known temporary guest plugins
1062             continue;
1063         }
1064         if ($plugins[$instance->enrol]->show_enrolme_link($instance)) {
1065             $result = true;
1066             break;
1067         }
1068     }
1070     return $result;
1073 /**
1074  * This function returns the end of current active user enrolment.
1075  *
1076  * It deals correctly with multiple overlapping user enrolments.
1077  *
1078  * @param int $courseid
1079  * @param int $userid
1080  * @return int|bool timestamp when active enrolment ends, false means no active enrolment now, 0 means never
1081  */
1082 function enrol_get_enrolment_end($courseid, $userid) {
1083     global $DB;
1085     $sql = "SELECT ue.*
1086               FROM {user_enrolments} ue
1087               JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
1088               JOIN {user} u ON u.id = ue.userid
1089              WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0";
1090     $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE, 'userid'=>$userid, 'courseid'=>$courseid);
1092     if (!$enrolments = $DB->get_records_sql($sql, $params)) {
1093         return false;
1094     }
1096     $changes = array();
1098     foreach ($enrolments as $ue) {
1099         $start = (int)$ue->timestart;
1100         $end = (int)$ue->timeend;
1101         if ($end != 0 and $end < $start) {
1102             debugging('Invalid enrolment start or end in user_enrolment id:'.$ue->id);
1103             continue;
1104         }
1105         if (isset($changes[$start])) {
1106             $changes[$start] = $changes[$start] + 1;
1107         } else {
1108             $changes[$start] = 1;
1109         }
1110         if ($end === 0) {
1111             // no end
1112         } else if (isset($changes[$end])) {
1113             $changes[$end] = $changes[$end] - 1;
1114         } else {
1115             $changes[$end] = -1;
1116         }
1117     }
1119     // let's sort then enrolment starts&ends and go through them chronologically,
1120     // looking for current status and the next future end of enrolment
1121     ksort($changes);
1123     $now = time();
1124     $current = 0;
1125     $present = null;
1127     foreach ($changes as $time => $change) {
1128         if ($time > $now) {
1129             if ($present === null) {
1130                 // we have just went past current time
1131                 $present = $current;
1132                 if ($present < 1) {
1133                     // no enrolment active
1134                     return false;
1135                 }
1136             }
1137             if ($present !== null) {
1138                 // we are already in the future - look for possible end
1139                 if ($current + $change < 1) {
1140                     return $time;
1141                 }
1142             }
1143         }
1144         $current += $change;
1145     }
1147     if ($current > 0) {
1148         return 0;
1149     } else {
1150         return false;
1151     }
1154 /**
1155  * Is current user accessing course via this enrolment method?
1156  *
1157  * This is intended for operations that are going to affect enrol instances.
1158  *
1159  * @param stdClass $instance enrol instance
1160  * @return bool
1161  */
1162 function enrol_accessing_via_instance(stdClass $instance) {
1163     global $DB, $USER;
1165     if (empty($instance->id)) {
1166         return false;
1167     }
1169     if (is_siteadmin()) {
1170         // Admins may go anywhere.
1171         return false;
1172     }
1174     return $DB->record_exists('user_enrolments', array('userid'=>$USER->id, 'enrolid'=>$instance->id));
1177 /**
1178  * Returns true if user is enrolled (is participating) in course
1179  * this is intended for students and teachers.
1180  *
1181  * Since 2.2 the result for active enrolments and current user are cached.
1182  *
1183  * @param context $context
1184  * @param int|stdClass $user if null $USER is used, otherwise user object or id expected
1185  * @param string $withcapability extra capability name
1186  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1187  * @return bool
1188  */
1189 function is_enrolled(context $context, $user = null, $withcapability = '', $onlyactive = false) {
1190     global $USER, $DB;
1192     // First find the course context.
1193     $coursecontext = $context->get_course_context();
1195     // Make sure there is a real user specified.
1196     if ($user === null) {
1197         $userid = isset($USER->id) ? $USER->id : 0;
1198     } else {
1199         $userid = is_object($user) ? $user->id : $user;
1200     }
1202     if (empty($userid)) {
1203         // Not-logged-in!
1204         return false;
1205     } else if (isguestuser($userid)) {
1206         // Guest account can not be enrolled anywhere.
1207         return false;
1208     }
1210     // Note everybody participates on frontpage, so for other contexts...
1211     if ($coursecontext->instanceid != SITEID) {
1212         // Try cached info first - the enrolled flag is set only when active enrolment present.
1213         if ($USER->id == $userid) {
1214             $coursecontext->reload_if_dirty();
1215             if (isset($USER->enrol['enrolled'][$coursecontext->instanceid])) {
1216                 if ($USER->enrol['enrolled'][$coursecontext->instanceid] > time()) {
1217                     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
1218                         return false;
1219                     }
1220                     return true;
1221                 }
1222             }
1223         }
1225         if ($onlyactive) {
1226             // Look for active enrolments only.
1227             $until = enrol_get_enrolment_end($coursecontext->instanceid, $userid);
1229             if ($until === false) {
1230                 return false;
1231             }
1233             if ($USER->id == $userid) {
1234                 if ($until == 0) {
1235                     $until = ENROL_MAX_TIMESTAMP;
1236                 }
1237                 $USER->enrol['enrolled'][$coursecontext->instanceid] = $until;
1238                 if (isset($USER->enrol['tempguest'][$coursecontext->instanceid])) {
1239                     unset($USER->enrol['tempguest'][$coursecontext->instanceid]);
1240                     remove_temp_course_roles($coursecontext);
1241                 }
1242             }
1244         } else {
1245             // Any enrolment is good for us here, even outdated, disabled or inactive.
1246             $sql = "SELECT 'x'
1247                       FROM {user_enrolments} ue
1248                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
1249                       JOIN {user} u ON u.id = ue.userid
1250                      WHERE ue.userid = :userid AND u.deleted = 0";
1251             $params = array('userid' => $userid, 'courseid' => $coursecontext->instanceid);
1252             if (!$DB->record_exists_sql($sql, $params)) {
1253                 return false;
1254             }
1255         }
1256     }
1258     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
1259         return false;
1260     }
1262     return true;
1265 /**
1266  * Returns an array of joins, wheres and params that will limit the group of
1267  * users to only those enrolled and with given capability (if specified).
1268  *
1269  * Note this join will return duplicate rows for users who have been enrolled
1270  * several times (e.g. as manual enrolment, and as self enrolment). You may
1271  * need to use a SELECT DISTINCT in your query (see get_enrolled_sql for example).
1272  *
1273  * @param context $context
1274  * @param string $prefix optional, a prefix to the user id column
1275  * @param string|array $capability optional, may include a capability name, or array of names.
1276  *      If an array is provided then this is the equivalent of a logical 'OR',
1277  *      i.e. the user needs to have one of these capabilities.
1278  * @param int $group optional, 0 indicates no current group, otherwise the group id
1279  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1280  * @param bool $onlysuspended inverse of onlyactive, consider only suspended enrolments
1281  * @param int $enrolid The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.
1282  * @return \core\dml\sql_join Contains joins, wheres, params
1283  */
1284 function get_enrolled_with_capabilities_join(context $context, $prefix = '', $capability = '', $group = 0,
1285         $onlyactive = false, $onlysuspended = false, $enrolid = 0) {
1286     $uid = $prefix . 'u.id';
1287     $joins = array();
1288     $wheres = array();
1290     $enrolledjoin = get_enrolled_join($context, $uid, $onlyactive, $onlysuspended, $enrolid);
1291     $joins[] = $enrolledjoin->joins;
1292     $wheres[] = $enrolledjoin->wheres;
1293     $params = $enrolledjoin->params;
1295     if (!empty($capability)) {
1296         $capjoin = get_with_capability_join($context, $capability, $uid);
1297         $joins[] = $capjoin->joins;
1298         $wheres[] = $capjoin->wheres;
1299         $params = array_merge($params, $capjoin->params);
1300     }
1302     if ($group) {
1303         $groupjoin = groups_get_members_join($group, $uid);
1304         $joins[] = $groupjoin->joins;
1305         $params = array_merge($params, $groupjoin->params);
1306     }
1308     $joins = implode("\n", $joins);
1309     $wheres[] = "{$prefix}u.deleted = 0";
1310     $wheres = implode(" AND ", $wheres);
1312     return new \core\dml\sql_join($joins, $wheres, $params);
1315 /**
1316  * Returns array with sql code and parameters returning all ids
1317  * of users enrolled into course.
1318  *
1319  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
1320  *
1321  * @param context $context
1322  * @param string $withcapability
1323  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
1324  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1325  * @param bool $onlysuspended inverse of onlyactive, consider only suspended enrolments
1326  * @param int $enrolid The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.
1327  * @return array list($sql, $params)
1328  */
1329 function get_enrolled_sql(context $context, $withcapability = '', $groupid = 0, $onlyactive = false, $onlysuspended = false,
1330                           $enrolid = 0) {
1332     // Use unique prefix just in case somebody makes some SQL magic with the result.
1333     static $i = 0;
1334     $i++;
1335     $prefix = 'eu' . $i . '_';
1337     $capjoin = get_enrolled_with_capabilities_join(
1338             $context, $prefix, $withcapability, $groupid, $onlyactive, $onlysuspended, $enrolid);
1340     $sql = "SELECT DISTINCT {$prefix}u.id
1341               FROM {user} {$prefix}u
1342             $capjoin->joins
1343              WHERE $capjoin->wheres";
1345     return array($sql, $capjoin->params);
1348 /**
1349  * Returns array with sql joins and parameters returning all ids
1350  * of users enrolled into course.
1351  *
1352  * This function is using 'ej[0-9]+_' prefix for table names and parameters.
1353  *
1354  * @throws coding_exception
1355  *
1356  * @param context $context
1357  * @param string $useridcolumn User id column used the calling query, e.g. u.id
1358  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1359  * @param bool $onlysuspended inverse of onlyactive, consider only suspended enrolments
1360  * @param int $enrolid The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.
1361  * @return \core\dml\sql_join Contains joins, wheres, params
1362  */
1363 function get_enrolled_join(context $context, $useridcolumn, $onlyactive = false, $onlysuspended = false, $enrolid = 0) {
1364     // Use unique prefix just in case somebody makes some SQL magic with the result.
1365     static $i = 0;
1366     $i++;
1367     $prefix = 'ej' . $i . '_';
1369     // First find the course context.
1370     $coursecontext = $context->get_course_context();
1372     $isfrontpage = ($coursecontext->instanceid == SITEID);
1374     if ($onlyactive && $onlysuspended) {
1375         throw new coding_exception("Both onlyactive and onlysuspended are set, this is probably not what you want!");
1376     }
1377     if ($isfrontpage && $onlysuspended) {
1378         throw new coding_exception("onlysuspended is not supported on frontpage; please add your own early-exit!");
1379     }
1381     $joins  = array();
1382     $wheres = array();
1383     $params = array();
1385     $wheres[] = "1 = 1"; // Prevent broken where clauses later on.
1387     // Note all users are "enrolled" on the frontpage, but for others...
1388     if (!$isfrontpage) {
1389         $where1 = "{$prefix}ue.status = :{$prefix}active AND {$prefix}e.status = :{$prefix}enabled";
1390         $where2 = "{$prefix}ue.timestart < :{$prefix}now1 AND ({$prefix}ue.timeend = 0 OR {$prefix}ue.timeend > :{$prefix}now2)";
1392         $enrolconditions = array(
1393             "{$prefix}e.id = {$prefix}ue.enrolid",
1394             "{$prefix}e.courseid = :{$prefix}courseid",
1395         );
1396         if ($enrolid) {
1397             $enrolconditions[] = "{$prefix}e.id = :{$prefix}enrolid";
1398             $params[$prefix . 'enrolid'] = $enrolid;
1399         }
1400         $enrolconditionssql = implode(" AND ", $enrolconditions);
1401         $ejoin = "JOIN {enrol} {$prefix}e ON ($enrolconditionssql)";
1403         $params[$prefix.'courseid'] = $coursecontext->instanceid;
1405         if (!$onlysuspended) {
1406             $joins[] = "JOIN {user_enrolments} {$prefix}ue ON {$prefix}ue.userid = $useridcolumn";
1407             $joins[] = $ejoin;
1408             if ($onlyactive) {
1409                 $wheres[] = "$where1 AND $where2";
1410             }
1411         } else {
1412             // Suspended only where there is enrolment but ALL are suspended.
1413             // Consider multiple enrols where one is not suspended or plain role_assign.
1414             $enrolselect = "SELECT DISTINCT {$prefix}ue.userid FROM {user_enrolments} {$prefix}ue $ejoin WHERE $where1 AND $where2";
1415             $joins[] = "JOIN {user_enrolments} {$prefix}ue1 ON {$prefix}ue1.userid = $useridcolumn";
1416             $enrolconditions = array(
1417                 "{$prefix}e1.id = {$prefix}ue1.enrolid",
1418                 "{$prefix}e1.courseid = :{$prefix}_e1_courseid",
1419             );
1420             if ($enrolid) {
1421                 $enrolconditions[] = "{$prefix}e1.id = :{$prefix}e1.enrolid";
1422                 $params[$prefix . 'e1.enrolid'] = $enrolid;
1423             }
1424             $enrolconditionssql = implode(" AND ", $enrolconditions);
1425             $joins[] = "JOIN {enrol} {$prefix}e1 ON ($enrolconditionssql)";
1426             $params["{$prefix}_e1_courseid"] = $coursecontext->instanceid;
1427             $wheres[] = "$useridcolumn NOT IN ($enrolselect)";
1428         }
1430         if ($onlyactive || $onlysuspended) {
1431             $now = round(time(), -2); // Rounding helps caching in DB.
1432             $params = array_merge($params, array($prefix . 'enabled' => ENROL_INSTANCE_ENABLED,
1433                     $prefix . 'active' => ENROL_USER_ACTIVE,
1434                     $prefix . 'now1' => $now, $prefix . 'now2' => $now));
1435         }
1436     }
1438     $joins = implode("\n", $joins);
1439     $wheres = implode(" AND ", $wheres);
1441     return new \core\dml\sql_join($joins, $wheres, $params);
1444 /**
1445  * Returns list of users enrolled into course.
1446  *
1447  * @param context $context
1448  * @param string $withcapability
1449  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
1450  * @param string $userfields requested user record fields
1451  * @param string $orderby
1452  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1453  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1454  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1455  * @return array of user records
1456  */
1457 function get_enrolled_users(context $context, $withcapability = '', $groupid = 0, $userfields = 'u.*', $orderby = null,
1458         $limitfrom = 0, $limitnum = 0, $onlyactive = false) {
1459     global $DB;
1461     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid, $onlyactive);
1462     $sql = "SELECT $userfields
1463               FROM {user} u
1464               JOIN ($esql) je ON je.id = u.id
1465              WHERE u.deleted = 0";
1467     if ($orderby) {
1468         $sql = "$sql ORDER BY $orderby";
1469     } else {
1470         list($sort, $sortparams) = users_order_by_sql('u');
1471         $sql = "$sql ORDER BY $sort";
1472         $params = array_merge($params, $sortparams);
1473     }
1475     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
1478 /**
1479  * Counts list of users enrolled into course (as per above function)
1480  *
1481  * @param context $context
1482  * @param string $withcapability
1483  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
1484  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1485  * @return array of user records
1486  */
1487 function count_enrolled_users(context $context, $withcapability = '', $groupid = 0, $onlyactive = false) {
1488     global $DB;
1490     $capjoin = get_enrolled_with_capabilities_join(
1491             $context, '', $withcapability, $groupid, $onlyactive);
1493     $sql = "SELECT count(u.id)
1494               FROM {user} u
1495             $capjoin->joins
1496              WHERE $capjoin->wheres AND u.deleted = 0";
1498     return $DB->count_records_sql($sql, $capjoin->params);
1501 /**
1502  * Send welcome email "from" options.
1503  *
1504  * @return array list of from options
1505  */
1506 function enrol_send_welcome_email_options() {
1507     return [
1508         ENROL_DO_NOT_SEND_EMAIL                 => get_string('no'),
1509         ENROL_SEND_EMAIL_FROM_COURSE_CONTACT    => get_string('sendfromcoursecontact', 'enrol'),
1510         ENROL_SEND_EMAIL_FROM_KEY_HOLDER        => get_string('sendfromkeyholder', 'enrol'),
1511         ENROL_SEND_EMAIL_FROM_NOREPLY           => get_string('sendfromnoreply', 'enrol')
1512     ];
1515 /**
1516  * Serve the user enrolment form as a fragment.
1517  *
1518  * @param array $args List of named arguments for the fragment loader.
1519  * @return string
1520  */
1521 function enrol_output_fragment_user_enrolment_form($args) {
1522     global $CFG, $DB;
1524     $args = (object) $args;
1525     $context = $args->context;
1526     require_capability('moodle/course:enrolreview', $context);
1528     $ueid = $args->ueid;
1529     $userenrolment = $DB->get_record('user_enrolments', ['id' => $ueid], '*', MUST_EXIST);
1530     $customdata = [
1531         'ue' => $userenrolment,
1532         'modal' => true,
1533     ];
1535     // Set the data if applicable.
1536     $data = [];
1537     if (isset($args->formdata)) {
1538         $serialiseddata = json_decode($args->formdata);
1539         parse_str($serialiseddata, $data);
1540     }
1542     require_once("$CFG->dirroot/enrol/editenrolment_form.php");
1543     $mform = new \enrol_user_enrolment_form(null, $customdata, 'post', '', null, true, $data);
1545     if (!empty($data)) {
1546         $mform->set_data($data);
1547         $mform->is_validated();
1548     }
1550     return $mform->render();
1553 /**
1554  * Returns the course where a user enrolment belong to.
1555  *
1556  * @param int $ueid user_enrolments id
1557  * @return stdClass
1558  */
1559 function enrol_get_course_by_user_enrolment_id($ueid) {
1560     global $DB;
1561     $sql = "SELECT c.* FROM {user_enrolments} ue
1562               JOIN {enrol} e ON e.id = ue.enrolid
1563               JOIN {course} c ON c.id = e.courseid
1564              WHERE ue.id = :ueid";
1565     return $DB->get_record_sql($sql, array('ueid' => $ueid));
1568 /**
1569  * Return all users enrolled in a course.
1570  *
1571  * @param int $courseid Course id or false if using $uefilter (user enrolment ids may belong to different courses)
1572  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1573  * @param array $usersfilter Limit the results obtained to this list of user ids. $uefilter compatibility not guaranteed.
1574  * @param array $uefilter Limit the results obtained to this list of user enrolment ids. $usersfilter compatibility not guaranteed.
1575  * @return stdClass[]
1576  */
1577 function enrol_get_course_users($courseid = false, $onlyactive = false, $usersfilter = array(), $uefilter = array()) {
1578     global $DB;
1580     if (!$courseid && !$usersfilter && !$uefilter) {
1581         throw new \coding_exception('You should specify at least 1 filter: courseid, users or user enrolments');
1582     }
1584     $sql = "SELECT ue.id AS ueid, ue.status AS uestatus, ue.enrolid AS ueenrolid, ue.timestart AS uetimestart,
1585              ue.timeend AS uetimeend, ue.modifierid AS uemodifierid, ue.timecreated AS uetimecreated,
1586              ue.timemodified AS uetimemodified,
1587              u.* FROM {user_enrolments} ue
1588               JOIN {enrol} e ON e.id = ue.enrolid
1589               JOIN {user} u ON ue.userid = u.id
1590              WHERE ";
1591     $params = array();
1593     if ($courseid) {
1594         $conditions[] = "e.courseid = :courseid";
1595         $params['courseid'] = $courseid;
1596     }
1598     if ($onlyactive) {
1599         $conditions[] = "ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND " .
1600             "(ue.timeend = 0 OR ue.timeend > :now2)";
1601         // Improves db caching.
1602         $params['now1']    = round(time(), -2);
1603         $params['now2']    = $params['now1'];
1604         $params['active']  = ENROL_USER_ACTIVE;
1605         $params['enabled'] = ENROL_INSTANCE_ENABLED;
1606     }
1608     if ($usersfilter) {
1609         list($usersql, $userparams) = $DB->get_in_or_equal($usersfilter, SQL_PARAMS_NAMED);
1610         $conditions[] = "ue.userid $usersql";
1611         $params = $params + $userparams;
1612     }
1614     if ($uefilter) {
1615         list($uesql, $ueparams) = $DB->get_in_or_equal($uefilter, SQL_PARAMS_NAMED);
1616         $conditions[] = "ue.id $uesql";
1617         $params = $params + $ueparams;
1618     }
1620     return $DB->get_records_sql($sql . ' ' . implode(' AND ', $conditions), $params);
1623 /**
1624  * Enrolment plugins abstract class.
1625  *
1626  * All enrol plugins should be based on this class,
1627  * this is also the main source of documentation.
1628  *
1629  * @copyright  2010 Petr Skoda {@link http://skodak.org}
1630  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1631  */
1632 abstract class enrol_plugin {
1633     protected $config = null;
1635     /**
1636      * Returns name of this enrol plugin
1637      * @return string
1638      */
1639     public function get_name() {
1640         // second word in class is always enrol name, sorry, no fancy plugin names with _
1641         $words = explode('_', get_class($this));
1642         return $words[1];
1643     }
1645     /**
1646      * Returns localised name of enrol instance
1647      *
1648      * @param object $instance (null is accepted too)
1649      * @return string
1650      */
1651     public function get_instance_name($instance) {
1652         if (empty($instance->name)) {
1653             $enrol = $this->get_name();
1654             return get_string('pluginname', 'enrol_'.$enrol);
1655         } else {
1656             $context = context_course::instance($instance->courseid);
1657             return format_string($instance->name, true, array('context'=>$context));
1658         }
1659     }
1661     /**
1662      * Returns optional enrolment information icons.
1663      *
1664      * This is used in course list for quick overview of enrolment options.
1665      *
1666      * We are not using single instance parameter because sometimes
1667      * we might want to prevent icon repetition when multiple instances
1668      * of one type exist. One instance may also produce several icons.
1669      *
1670      * @param array $instances all enrol instances of this type in one course
1671      * @return array of pix_icon
1672      */
1673     public function get_info_icons(array $instances) {
1674         return array();
1675     }
1677     /**
1678      * Returns optional enrolment instance description text.
1679      *
1680      * This is used in detailed course information.
1681      *
1682      *
1683      * @param object $instance
1684      * @return string short html text
1685      */
1686     public function get_description_text($instance) {
1687         return null;
1688     }
1690     /**
1691      * Makes sure config is loaded and cached.
1692      * @return void
1693      */
1694     protected function load_config() {
1695         if (!isset($this->config)) {
1696             $name = $this->get_name();
1697             $this->config = get_config("enrol_$name");
1698         }
1699     }
1701     /**
1702      * Returns plugin config value
1703      * @param  string $name
1704      * @param  string $default value if config does not exist yet
1705      * @return string value or default
1706      */
1707     public function get_config($name, $default = NULL) {
1708         $this->load_config();
1709         return isset($this->config->$name) ? $this->config->$name : $default;
1710     }
1712     /**
1713      * Sets plugin config value
1714      * @param  string $name name of config
1715      * @param  string $value string config value, null means delete
1716      * @return string value
1717      */
1718     public function set_config($name, $value) {
1719         $pluginname = $this->get_name();
1720         $this->load_config();
1721         if ($value === NULL) {
1722             unset($this->config->$name);
1723         } else {
1724             $this->config->$name = $value;
1725         }
1726         set_config($name, $value, "enrol_$pluginname");
1727     }
1729     /**
1730      * Does this plugin assign protected roles are can they be manually removed?
1731      * @return bool - false means anybody may tweak roles, it does not use itemid and component when assigning roles
1732      */
1733     public function roles_protected() {
1734         return true;
1735     }
1737     /**
1738      * Does this plugin allow manual enrolments?
1739      *
1740      * @param stdClass $instance course enrol instance
1741      * All plugins allowing this must implement 'enrol/xxx:enrol' capability
1742      *
1743      * @return bool - true means user with 'enrol/xxx:enrol' may enrol others freely, false means nobody may add more enrolments manually
1744      */
1745     public function allow_enrol(stdClass $instance) {
1746         return false;
1747     }
1749     /**
1750      * Does this plugin allow manual unenrolment of all users?
1751      * All plugins allowing this must implement 'enrol/xxx:unenrol' capability
1752      *
1753      * @param stdClass $instance course enrol instance
1754      * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol others freely, false means nobody may touch user_enrolments
1755      */
1756     public function allow_unenrol(stdClass $instance) {
1757         return false;
1758     }
1760     /**
1761      * Does this plugin allow manual unenrolment of a specific user?
1762      * All plugins allowing this must implement 'enrol/xxx:unenrol' capability
1763      *
1764      * This is useful especially for synchronisation plugins that
1765      * do suspend instead of full unenrolment.
1766      *
1767      * @param stdClass $instance course enrol instance
1768      * @param stdClass $ue record from user_enrolments table, specifies user
1769      *
1770      * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
1771      */
1772     public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
1773         return $this->allow_unenrol($instance);
1774     }
1776     /**
1777      * Does this plugin allow manual changes in user_enrolments table?
1778      *
1779      * All plugins allowing this must implement 'enrol/xxx:manage' capability
1780      *
1781      * @param stdClass $instance course enrol instance
1782      * @return bool - true means it is possible to change enrol period and status in user_enrolments table
1783      */
1784     public function allow_manage(stdClass $instance) {
1785         return false;
1786     }
1788     /**
1789      * Does this plugin support some way to user to self enrol?
1790      *
1791      * @param stdClass $instance course enrol instance
1792      *
1793      * @return bool - true means show "Enrol me in this course" link in course UI
1794      */
1795     public function show_enrolme_link(stdClass $instance) {
1796         return false;
1797     }
1799     /**
1800      * Attempt to automatically enrol current user in course without any interaction,
1801      * calling code has to make sure the plugin and instance are active.
1802      *
1803      * This should return either a timestamp in the future or false.
1804      *
1805      * @param stdClass $instance course enrol instance
1806      * @return bool|int false means not enrolled, integer means timeend
1807      */
1808     public function try_autoenrol(stdClass $instance) {
1809         global $USER;
1811         return false;
1812     }
1814     /**
1815      * Attempt to automatically gain temporary guest access to course,
1816      * calling code has to make sure the plugin and instance are active.
1817      *
1818      * This should return either a timestamp in the future or false.
1819      *
1820      * @param stdClass $instance course enrol instance
1821      * @return bool|int false means no guest access, integer means timeend
1822      */
1823     public function try_guestaccess(stdClass $instance) {
1824         global $USER;
1826         return false;
1827     }
1829     /**
1830      * Enrol user into course via enrol instance.
1831      *
1832      * @param stdClass $instance
1833      * @param int $userid
1834      * @param int $roleid optional role id
1835      * @param int $timestart 0 means unknown
1836      * @param int $timeend 0 means forever
1837      * @param int $status default to ENROL_USER_ACTIVE for new enrolments, no change by default in updates
1838      * @param bool $recovergrades restore grade history
1839      * @return void
1840      */
1841     public function enrol_user(stdClass $instance, $userid, $roleid = null, $timestart = 0, $timeend = 0, $status = null, $recovergrades = null) {
1842         global $DB, $USER, $CFG; // CFG necessary!!!
1844         if ($instance->courseid == SITEID) {
1845             throw new coding_exception('invalid attempt to enrol into frontpage course!');
1846         }
1848         $name = $this->get_name();
1849         $courseid = $instance->courseid;
1851         if ($instance->enrol !== $name) {
1852             throw new coding_exception('invalid enrol instance!');
1853         }
1854         $context = context_course::instance($instance->courseid, MUST_EXIST);
1855         if (!isset($recovergrades)) {
1856             $recovergrades = $CFG->recovergradesdefault;
1857         }
1859         $inserted = false;
1860         $updated  = false;
1861         if ($ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
1862             //only update if timestart or timeend or status are different.
1863             if ($ue->timestart != $timestart or $ue->timeend != $timeend or (!is_null($status) and $ue->status != $status)) {
1864                 $this->update_user_enrol($instance, $userid, $status, $timestart, $timeend);
1865             }
1866         } else {
1867             $ue = new stdClass();
1868             $ue->enrolid      = $instance->id;
1869             $ue->status       = is_null($status) ? ENROL_USER_ACTIVE : $status;
1870             $ue->userid       = $userid;
1871             $ue->timestart    = $timestart;
1872             $ue->timeend      = $timeend;
1873             $ue->modifierid   = $USER->id;
1874             $ue->timecreated  = time();
1875             $ue->timemodified = $ue->timecreated;
1876             $ue->id = $DB->insert_record('user_enrolments', $ue);
1878             $inserted = true;
1879         }
1881         if ($inserted) {
1882             // Trigger event.
1883             $event = \core\event\user_enrolment_created::create(
1884                     array(
1885                         'objectid' => $ue->id,
1886                         'courseid' => $courseid,
1887                         'context' => $context,
1888                         'relateduserid' => $ue->userid,
1889                         'other' => array('enrol' => $name)
1890                         )
1891                     );
1892             $event->trigger();
1893             // Check if course contacts cache needs to be cleared.
1894             require_once($CFG->libdir . '/coursecatlib.php');
1895             coursecat::user_enrolment_changed($courseid, $ue->userid,
1896                     $ue->status, $ue->timestart, $ue->timeend);
1897         }
1899         if ($roleid) {
1900             // this must be done after the enrolment event so that the role_assigned event is triggered afterwards
1901             if ($this->roles_protected()) {
1902                 role_assign($roleid, $userid, $context->id, 'enrol_'.$name, $instance->id);
1903             } else {
1904                 role_assign($roleid, $userid, $context->id);
1905             }
1906         }
1908         // Recover old grades if present.
1909         if ($recovergrades) {
1910             require_once("$CFG->libdir/gradelib.php");
1911             grade_recover_history_grades($userid, $courseid);
1912         }
1914         // reset current user enrolment caching
1915         if ($userid == $USER->id) {
1916             if (isset($USER->enrol['enrolled'][$courseid])) {
1917                 unset($USER->enrol['enrolled'][$courseid]);
1918             }
1919             if (isset($USER->enrol['tempguest'][$courseid])) {
1920                 unset($USER->enrol['tempguest'][$courseid]);
1921                 remove_temp_course_roles($context);
1922             }
1923         }
1924     }
1926     /**
1927      * Store user_enrolments changes and trigger event.
1928      *
1929      * @param stdClass $instance
1930      * @param int $userid
1931      * @param int $status
1932      * @param int $timestart
1933      * @param int $timeend
1934      * @return void
1935      */
1936     public function update_user_enrol(stdClass $instance, $userid, $status = NULL, $timestart = NULL, $timeend = NULL) {
1937         global $DB, $USER, $CFG;
1939         $name = $this->get_name();
1941         if ($instance->enrol !== $name) {
1942             throw new coding_exception('invalid enrol instance!');
1943         }
1945         if (!$ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
1946             // weird, user not enrolled
1947             return;
1948         }
1950         $modified = false;
1951         if (isset($status) and $ue->status != $status) {
1952             $ue->status = $status;
1953             $modified = true;
1954         }
1955         if (isset($timestart) and $ue->timestart != $timestart) {
1956             $ue->timestart = $timestart;
1957             $modified = true;
1958         }
1959         if (isset($timeend) and $ue->timeend != $timeend) {
1960             $ue->timeend = $timeend;
1961             $modified = true;
1962         }
1964         if (!$modified) {
1965             // no change
1966             return;
1967         }
1969         $ue->modifierid = $USER->id;
1970         $ue->timemodified = time();
1971         $DB->update_record('user_enrolments', $ue);
1972         context_course::instance($instance->courseid)->mark_dirty(); // reset enrol caches
1974         // Invalidate core_access cache for get_suspended_userids.
1975         cache_helper::invalidate_by_definition('core', 'suspended_userids', array(), array($instance->courseid));
1977         // Trigger event.
1978         $event = \core\event\user_enrolment_updated::create(
1979                 array(
1980                     'objectid' => $ue->id,
1981                     'courseid' => $instance->courseid,
1982                     'context' => context_course::instance($instance->courseid),
1983                     'relateduserid' => $ue->userid,
1984                     'other' => array('enrol' => $name)
1985                     )
1986                 );
1987         $event->trigger();
1989         require_once($CFG->libdir . '/coursecatlib.php');
1990         coursecat::user_enrolment_changed($instance->courseid, $ue->userid,
1991                 $ue->status, $ue->timestart, $ue->timeend);
1992     }
1994     /**
1995      * Unenrol user from course,
1996      * the last unenrolment removes all remaining roles.
1997      *
1998      * @param stdClass $instance
1999      * @param int $userid
2000      * @return void
2001      */
2002     public function unenrol_user(stdClass $instance, $userid) {
2003         global $CFG, $USER, $DB;
2004         require_once("$CFG->dirroot/group/lib.php");
2006         $name = $this->get_name();
2007         $courseid = $instance->courseid;
2009         if ($instance->enrol !== $name) {
2010             throw new coding_exception('invalid enrol instance!');
2011         }
2012         $context = context_course::instance($instance->courseid, MUST_EXIST);
2014         if (!$ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
2015             // weird, user not enrolled
2016             return;
2017         }
2019         // Remove all users groups linked to this enrolment instance.
2020         if ($gms = $DB->get_records('groups_members', array('userid'=>$userid, 'component'=>'enrol_'.$name, 'itemid'=>$instance->id))) {
2021             foreach ($gms as $gm) {
2022                 groups_remove_member($gm->groupid, $gm->userid);
2023             }
2024         }
2026         role_unassign_all(array('userid'=>$userid, 'contextid'=>$context->id, 'component'=>'enrol_'.$name, 'itemid'=>$instance->id));
2027         $DB->delete_records('user_enrolments', array('id'=>$ue->id));
2029         // add extra info and trigger event
2030         $ue->courseid  = $courseid;
2031         $ue->enrol     = $name;
2033         $sql = "SELECT 'x'
2034                   FROM {user_enrolments} ue
2035                   JOIN {enrol} e ON (e.id = ue.enrolid)
2036                  WHERE ue.userid = :userid AND e.courseid = :courseid";
2037         if ($DB->record_exists_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid))) {
2038             $ue->lastenrol = false;
2040         } else {
2041             // the big cleanup IS necessary!
2042             require_once("$CFG->libdir/gradelib.php");
2044             // remove all remaining roles
2045             role_unassign_all(array('userid'=>$userid, 'contextid'=>$context->id), true, false);
2047             //clean up ALL invisible user data from course if this is the last enrolment - groups, grades, etc.
2048             groups_delete_group_members($courseid, $userid);
2050             grade_user_unenrol($courseid, $userid);
2052             $DB->delete_records('user_lastaccess', array('userid'=>$userid, 'courseid'=>$courseid));
2054             $ue->lastenrol = true; // means user not enrolled any more
2055         }
2056         // Trigger event.
2057         $event = \core\event\user_enrolment_deleted::create(
2058                 array(
2059                     'courseid' => $courseid,
2060                     'context' => $context,
2061                     'relateduserid' => $ue->userid,
2062                     'objectid' => $ue->id,
2063                     'other' => array(
2064                         'userenrolment' => (array)$ue,
2065                         'enrol' => $name
2066                         )
2067                     )
2068                 );
2069         $event->trigger();
2070         // reset all enrol caches
2071         $context->mark_dirty();
2073         // Check if courrse contacts cache needs to be cleared.
2074         require_once($CFG->libdir . '/coursecatlib.php');
2075         coursecat::user_enrolment_changed($courseid, $ue->userid, ENROL_USER_SUSPENDED);
2077         // reset current user enrolment caching
2078         if ($userid == $USER->id) {
2079             if (isset($USER->enrol['enrolled'][$courseid])) {
2080                 unset($USER->enrol['enrolled'][$courseid]);
2081             }
2082             if (isset($USER->enrol['tempguest'][$courseid])) {
2083                 unset($USER->enrol['tempguest'][$courseid]);
2084                 remove_temp_course_roles($context);
2085             }
2086         }
2087     }
2089     /**
2090      * Forces synchronisation of user enrolments.
2091      *
2092      * This is important especially for external enrol plugins,
2093      * this function is called for all enabled enrol plugins
2094      * right after every user login.
2095      *
2096      * @param object $user user record
2097      * @return void
2098      */
2099     public function sync_user_enrolments($user) {
2100         // override if necessary
2101     }
2103     /**
2104      * This returns false for backwards compatibility, but it is really recommended.
2105      *
2106      * @since Moodle 3.1
2107      * @return boolean
2108      */
2109     public function use_standard_editing_ui() {
2110         return false;
2111     }
2113     /**
2114      * Return whether or not, given the current state, it is possible to add a new instance
2115      * of this enrolment plugin to the course.
2116      *
2117      * Default implementation is just for backwards compatibility.
2118      *
2119      * @param int $courseid
2120      * @return boolean
2121      */
2122     public function can_add_instance($courseid) {
2123         $link = $this->get_newinstance_link($courseid);
2124         return !empty($link);
2125     }
2127     /**
2128      * Return whether or not, given the current state, it is possible to edit an instance
2129      * of this enrolment plugin in the course. Used by the standard editing UI
2130      * to generate a link to the edit instance form if editing is allowed.
2131      *
2132      * @param stdClass $instance
2133      * @return boolean
2134      */
2135     public function can_edit_instance($instance) {
2136         $context = context_course::instance($instance->courseid);
2138         return has_capability('enrol/' . $instance->enrol . ':config', $context);
2139     }
2141     /**
2142      * Returns link to page which may be used to add new instance of enrolment plugin in course.
2143      * @param int $courseid
2144      * @return moodle_url page url
2145      */
2146     public function get_newinstance_link($courseid) {
2147         // override for most plugins, check if instance already exists in cases only one instance is supported
2148         return NULL;
2149     }
2151     /**
2152      * @deprecated since Moodle 2.8 MDL-35864 - please use can_delete_instance() instead.
2153      */
2154     public function instance_deleteable($instance) {
2155         throw new coding_exception('Function enrol_plugin::instance_deleteable() is deprecated, use
2156                 enrol_plugin::can_delete_instance() instead');
2157     }
2159     /**
2160      * Is it possible to delete enrol instance via standard UI?
2161      *
2162      * @param stdClass  $instance
2163      * @return bool
2164      */
2165     public function can_delete_instance($instance) {
2166         return false;
2167     }
2169     /**
2170      * Is it possible to hide/show enrol instance via standard UI?
2171      *
2172      * @param stdClass $instance
2173      * @return bool
2174      */
2175     public function can_hide_show_instance($instance) {
2176         debugging("The enrolment plugin '".$this->get_name()."' should override the function can_hide_show_instance().", DEBUG_DEVELOPER);
2177         return true;
2178     }
2180     /**
2181      * Returns link to manual enrol UI if exists.
2182      * Does the access control tests automatically.
2183      *
2184      * @param object $instance
2185      * @return moodle_url
2186      */
2187     public function get_manual_enrol_link($instance) {
2188         return NULL;
2189     }
2191     /**
2192      * Returns list of unenrol links for all enrol instances in course.
2193      *
2194      * @param int $instance
2195      * @return moodle_url or NULL if self unenrolment not supported
2196      */
2197     public function get_unenrolself_link($instance) {
2198         global $USER, $CFG, $DB;
2200         $name = $this->get_name();
2201         if ($instance->enrol !== $name) {
2202             throw new coding_exception('invalid enrol instance!');
2203         }
2205         if ($instance->courseid == SITEID) {
2206             return NULL;
2207         }
2209         if (!enrol_is_enabled($name)) {
2210             return NULL;
2211         }
2213         if ($instance->status != ENROL_INSTANCE_ENABLED) {
2214             return NULL;
2215         }
2217         if (!file_exists("$CFG->dirroot/enrol/$name/unenrolself.php")) {
2218             return NULL;
2219         }
2221         $context = context_course::instance($instance->courseid, MUST_EXIST);
2223         if (!has_capability("enrol/$name:unenrolself", $context)) {
2224             return NULL;
2225         }
2227         if (!$DB->record_exists('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$USER->id, 'status'=>ENROL_USER_ACTIVE))) {
2228             return NULL;
2229         }
2231         return new moodle_url("/enrol/$name/unenrolself.php", array('enrolid'=>$instance->id));
2232     }
2234     /**
2235      * Adds enrol instance UI to course edit form
2236      *
2237      * @param object $instance enrol instance or null if does not exist yet
2238      * @param MoodleQuickForm $mform
2239      * @param object $data
2240      * @param object $context context of existing course or parent category if course does not exist
2241      * @return void
2242      */
2243     public function course_edit_form($instance, MoodleQuickForm $mform, $data, $context) {
2244         // override - usually at least enable/disable switch, has to add own form header
2245     }
2247     /**
2248      * Adds form elements to add/edit instance form.
2249      *
2250      * @since Moodle 3.1
2251      * @param object $instance enrol instance or null if does not exist yet
2252      * @param MoodleQuickForm $mform
2253      * @param context $context
2254      * @return void
2255      */
2256     public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
2257         // Do nothing by default.
2258     }
2260     /**
2261      * Perform custom validation of the data used to edit the instance.
2262      *
2263      * @since Moodle 3.1
2264      * @param array $data array of ("fieldname"=>value) of submitted data
2265      * @param array $files array of uploaded files "element_name"=>tmp_file_path
2266      * @param object $instance The instance data loaded from the DB.
2267      * @param context $context The context of the instance we are editing
2268      * @return array of "element_name"=>"error_description" if there are errors,
2269      *         or an empty array if everything is OK.
2270      */
2271     public function edit_instance_validation($data, $files, $instance, $context) {
2272         // No errors by default.
2273         debugging('enrol_plugin::edit_instance_validation() is missing. This plugin has no validation!', DEBUG_DEVELOPER);
2274         return array();
2275     }
2277     /**
2278      * Validates course edit form data
2279      *
2280      * @param object $instance enrol instance or null if does not exist yet
2281      * @param array $data
2282      * @param object $context context of existing course or parent category if course does not exist
2283      * @return array errors array
2284      */
2285     public function course_edit_validation($instance, array $data, $context) {
2286         return array();
2287     }
2289     /**
2290      * Called after updating/inserting course.
2291      *
2292      * @param bool $inserted true if course just inserted
2293      * @param object $course
2294      * @param object $data form data
2295      * @return void
2296      */
2297     public function course_updated($inserted, $course, $data) {
2298         if ($inserted) {
2299             if ($this->get_config('defaultenrol')) {
2300                 $this->add_default_instance($course);
2301             }
2302         }
2303     }
2305     /**
2306      * Add new instance of enrol plugin.
2307      * @param object $course
2308      * @param array instance fields
2309      * @return int id of new instance, null if can not be created
2310      */
2311     public function add_instance($course, array $fields = NULL) {
2312         global $DB;
2314         if ($course->id == SITEID) {
2315             throw new coding_exception('Invalid request to add enrol instance to frontpage.');
2316         }
2318         $instance = new stdClass();
2319         $instance->enrol          = $this->get_name();
2320         $instance->status         = ENROL_INSTANCE_ENABLED;
2321         $instance->courseid       = $course->id;
2322         $instance->enrolstartdate = 0;
2323         $instance->enrolenddate   = 0;
2324         $instance->timemodified   = time();
2325         $instance->timecreated    = $instance->timemodified;
2326         $instance->sortorder      = $DB->get_field('enrol', 'COALESCE(MAX(sortorder), -1) + 1', array('courseid'=>$course->id));
2328         $fields = (array)$fields;
2329         unset($fields['enrol']);
2330         unset($fields['courseid']);
2331         unset($fields['sortorder']);
2332         foreach($fields as $field=>$value) {
2333             $instance->$field = $value;
2334         }
2336         $instance->id = $DB->insert_record('enrol', $instance);
2338         \core\event\enrol_instance_created::create_from_record($instance)->trigger();
2340         return $instance->id;
2341     }
2343     /**
2344      * Update instance of enrol plugin.
2345      *
2346      * @since Moodle 3.1
2347      * @param stdClass $instance
2348      * @param stdClass $data modified instance fields
2349      * @return boolean
2350      */
2351     public function update_instance($instance, $data) {
2352         global $DB;
2353         $properties = array('status', 'name', 'password', 'customint1', 'customint2', 'customint3',
2354                             'customint4', 'customint5', 'customint6', 'customint7', 'customint8',
2355                             'customchar1', 'customchar2', 'customchar3', 'customdec1', 'customdec2',
2356                             'customtext1', 'customtext2', 'customtext3', 'customtext4', 'roleid',
2357                             'enrolperiod', 'expirynotify', 'notifyall', 'expirythreshold',
2358                             'enrolstartdate', 'enrolenddate', 'cost', 'currency');
2360         foreach ($properties as $key) {
2361             if (isset($data->$key)) {
2362                 $instance->$key = $data->$key;
2363             }
2364         }
2365         $instance->timemodified = time();
2367         $update = $DB->update_record('enrol', $instance);
2368         if ($update) {
2369             \core\event\enrol_instance_updated::create_from_record($instance)->trigger();
2370         }
2371         return $update;
2372     }
2374     /**
2375      * Add new instance of enrol plugin with default settings,
2376      * called when adding new instance manually or when adding new course.
2377      *
2378      * Not all plugins support this.
2379      *
2380      * @param object $course
2381      * @return int id of new instance or null if no default supported
2382      */
2383     public function add_default_instance($course) {
2384         return null;
2385     }
2387     /**
2388      * Update instance status
2389      *
2390      * Override when plugin needs to do some action when enabled or disabled.
2391      *
2392      * @param stdClass $instance
2393      * @param int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
2394      * @return void
2395      */
2396     public function update_status($instance, $newstatus) {
2397         global $DB;
2399         $instance->status = $newstatus;
2400         $DB->update_record('enrol', $instance);
2402         $context = context_course::instance($instance->courseid);
2403         \core\event\enrol_instance_updated::create_from_record($instance)->trigger();
2405         // Invalidate all enrol caches.
2406         $context->mark_dirty();
2407     }
2409     /**
2410      * Delete course enrol plugin instance, unenrol all users.
2411      * @param object $instance
2412      * @return void
2413      */
2414     public function delete_instance($instance) {
2415         global $DB;
2417         $name = $this->get_name();
2418         if ($instance->enrol !== $name) {
2419             throw new coding_exception('invalid enrol instance!');
2420         }
2422         //first unenrol all users
2423         $participants = $DB->get_recordset('user_enrolments', array('enrolid'=>$instance->id));
2424         foreach ($participants as $participant) {
2425             $this->unenrol_user($instance, $participant->userid);
2426         }
2427         $participants->close();
2429         // now clean up all remainders that were not removed correctly
2430         $DB->delete_records('groups_members', array('itemid'=>$instance->id, 'component'=>'enrol_'.$name));
2431         $DB->delete_records('role_assignments', array('itemid'=>$instance->id, 'component'=>'enrol_'.$name));
2432         $DB->delete_records('user_enrolments', array('enrolid'=>$instance->id));
2434         // finally drop the enrol row
2435         $DB->delete_records('enrol', array('id'=>$instance->id));
2437         $context = context_course::instance($instance->courseid);
2438         \core\event\enrol_instance_deleted::create_from_record($instance)->trigger();
2440         // Invalidate all enrol caches.
2441         $context->mark_dirty();
2442     }
2444     /**
2445      * Creates course enrol form, checks if form submitted
2446      * and enrols user if necessary. It can also redirect.
2447      *
2448      * @param stdClass $instance
2449      * @return string html text, usually a form in a text box
2450      */
2451     public function enrol_page_hook(stdClass $instance) {
2452         return null;
2453     }
2455     /**
2456      * Checks if user can self enrol.
2457      *
2458      * @param stdClass $instance enrolment instance
2459      * @param bool $checkuserenrolment if true will check if user enrolment is inactive.
2460      *             used by navigation to improve performance.
2461      * @return bool|string true if successful, else error message or false
2462      */
2463     public function can_self_enrol(stdClass $instance, $checkuserenrolment = true) {
2464         return false;
2465     }
2467     /**
2468      * Return information for enrolment instance containing list of parameters required
2469      * for enrolment, name of enrolment plugin etc.
2470      *
2471      * @param stdClass $instance enrolment instance
2472      * @return array instance info.
2473      */
2474     public function get_enrol_info(stdClass $instance) {
2475         return null;
2476     }
2478     /**
2479      * Adds navigation links into course admin block.
2480      *
2481      * By defaults looks for manage links only.
2482      *
2483      * @param navigation_node $instancesnode
2484      * @param stdClass $instance
2485      * @return void
2486      */
2487     public function add_course_navigation($instancesnode, stdClass $instance) {
2488         if ($this->use_standard_editing_ui()) {
2489             $context = context_course::instance($instance->courseid);
2490             $cap = 'enrol/' . $instance->enrol . ':config';
2491             if (has_capability($cap, $context)) {
2492                 $linkparams = array('courseid' => $instance->courseid, 'id' => $instance->id, 'type' => $instance->enrol);
2493                 $managelink = new moodle_url('/enrol/editinstance.php', $linkparams);
2494                 $instancesnode->add($this->get_instance_name($instance), $managelink, navigation_node::TYPE_SETTING);
2495             }
2496         }
2497     }
2499     /**
2500      * Returns edit icons for the page with list of instances
2501      * @param stdClass $instance
2502      * @return array
2503      */
2504     public function get_action_icons(stdClass $instance) {
2505         global $OUTPUT;
2507         $icons = array();
2508         if ($this->use_standard_editing_ui()) {
2509             $linkparams = array('courseid' => $instance->courseid, 'id' => $instance->id, 'type' => $instance->enrol);
2510             $editlink = new moodle_url("/enrol/editinstance.php", $linkparams);
2511             $icons[] = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', get_string('edit'), 'core',
2512                 array('class' => 'iconsmall')));
2513         }
2514         return $icons;
2515     }
2517     /**
2518      * Reads version.php and determines if it is necessary
2519      * to execute the cron job now.
2520      * @return bool
2521      */
2522     public function is_cron_required() {
2523         global $CFG;
2525         $name = $this->get_name();
2526         $versionfile = "$CFG->dirroot/enrol/$name/version.php";
2527         $plugin = new stdClass();
2528         include($versionfile);
2529         if (empty($plugin->cron)) {
2530             return false;
2531         }
2532         $lastexecuted = $this->get_config('lastcron', 0);
2533         if ($lastexecuted + $plugin->cron < time()) {
2534             return true;
2535         } else {
2536             return false;
2537         }
2538     }
2540     /**
2541      * Called for all enabled enrol plugins that returned true from is_cron_required().
2542      * @return void
2543      */
2544     public function cron() {
2545     }
2547     /**
2548      * Called when user is about to be deleted
2549      * @param object $user
2550      * @return void
2551      */
2552     public function user_delete($user) {
2553         global $DB;
2555         $sql = "SELECT e.*
2556                   FROM {enrol} e
2557                   JOIN {user_enrolments} ue ON (ue.enrolid = e.id)
2558                  WHERE e.enrol = :name AND ue.userid = :userid";
2559         $params = array('name'=>$this->get_name(), 'userid'=>$user->id);
2561         $rs = $DB->get_recordset_sql($sql, $params);
2562         foreach($rs as $instance) {
2563             $this->unenrol_user($instance, $user->id);
2564         }
2565         $rs->close();
2566     }
2568     /**
2569      * Returns an enrol_user_button that takes the user to a page where they are able to
2570      * enrol users into the managers course through this plugin.
2571      *
2572      * Optional: If the plugin supports manual enrolments it can choose to override this
2573      * otherwise it shouldn't
2574      *
2575      * @param course_enrolment_manager $manager
2576      * @return enrol_user_button|false
2577      */
2578     public function get_manual_enrol_button(course_enrolment_manager $manager) {
2579         return false;
2580     }
2582     /**
2583      * Gets an array of the user enrolment actions
2584      *
2585      * @param course_enrolment_manager $manager
2586      * @param stdClass $ue
2587      * @return array An array of user_enrolment_actions
2588      */
2589     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
2590         return array();
2591     }
2593     /**
2594      * Returns true if the plugin has one or more bulk operations that can be performed on
2595      * user enrolments.
2596      *
2597      * @param course_enrolment_manager $manager
2598      * @return bool
2599      */
2600     public function has_bulk_operations(course_enrolment_manager $manager) {
2601        return false;
2602     }
2604     /**
2605      * Return an array of enrol_bulk_enrolment_operation objects that define
2606      * the bulk actions that can be performed on user enrolments by the plugin.
2607      *
2608      * @param course_enrolment_manager $manager
2609      * @return array
2610      */
2611     public function get_bulk_operations(course_enrolment_manager $manager) {
2612         return array();
2613     }
2615     /**
2616      * Do any enrolments need expiration processing.
2617      *
2618      * Plugins that want to call this functionality must implement 'expiredaction' config setting.
2619      *
2620      * @param progress_trace $trace
2621      * @param int $courseid one course, empty mean all
2622      * @return bool true if any data processed, false if not
2623      */
2624     public function process_expirations(progress_trace $trace, $courseid = null) {
2625         global $DB;
2627         $name = $this->get_name();
2628         if (!enrol_is_enabled($name)) {
2629             $trace->finished();
2630             return false;
2631         }
2633         $processed = false;
2634         $params = array();
2635         $coursesql = "";
2636         if ($courseid) {
2637             $coursesql = "AND e.courseid = :courseid";
2638         }
2640         // Deal with expired accounts.
2641         $action = $this->get_config('expiredaction', ENROL_EXT_REMOVED_KEEP);
2643         if ($action == ENROL_EXT_REMOVED_UNENROL) {
2644             $instances = array();
2645             $sql = "SELECT ue.*, e.courseid, c.id AS contextid
2646                       FROM {user_enrolments} ue
2647                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = :enrol)
2648                       JOIN {context} c ON (c.instanceid = e.courseid AND c.contextlevel = :courselevel)
2649                      WHERE ue.timeend > 0 AND ue.timeend < :now $coursesql";
2650             $params = array('now'=>time(), 'courselevel'=>CONTEXT_COURSE, 'enrol'=>$name, 'courseid'=>$courseid);
2652             $rs = $DB->get_recordset_sql($sql, $params);
2653             foreach ($rs as $ue) {
2654                 if (!$processed) {
2655                     $trace->output("Starting processing of enrol_$name expirations...");
2656                     $processed = true;
2657                 }
2658                 if (empty($instances[$ue->enrolid])) {
2659                     $instances[$ue->enrolid] = $DB->get_record('enrol', array('id'=>$ue->enrolid));
2660                 }
2661                 $instance = $instances[$ue->enrolid];
2662                 if (!$this->roles_protected()) {
2663                     // Let's just guess what extra roles are supposed to be removed.
2664                     if ($instance->roleid) {
2665                         role_unassign($instance->roleid, $ue->userid, $ue->contextid);
2666                     }
2667                 }
2668                 // The unenrol cleans up all subcontexts if this is the only course enrolment for this user.
2669                 $this->unenrol_user($instance, $ue->userid);
2670                 $trace->output("Unenrolling expired user $ue->userid from course $instance->courseid", 1);
2671             }
2672             $rs->close();
2673             unset($instances);
2675         } else if ($action == ENROL_EXT_REMOVED_SUSPENDNOROLES or $action == ENROL_EXT_REMOVED_SUSPEND) {
2676             $instances = array();
2677             $sql = "SELECT ue.*, e.courseid, c.id AS contextid
2678                       FROM {user_enrolments} ue
2679                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = :enrol)
2680                       JOIN {context} c ON (c.instanceid = e.courseid AND c.contextlevel = :courselevel)
2681                      WHERE ue.timeend > 0 AND ue.timeend < :now
2682                            AND ue.status = :useractive $coursesql";
2683             $params = array('now'=>time(), 'courselevel'=>CONTEXT_COURSE, 'useractive'=>ENROL_USER_ACTIVE, 'enrol'=>$name, 'courseid'=>$courseid);
2684             $rs = $DB->get_recordset_sql($sql, $params);
2685             foreach ($rs as $ue) {
2686                 if (!$processed) {
2687                     $trace->output("Starting processing of enrol_$name expirations...");
2688                     $processed = true;
2689                 }
2690                 if (empty($instances[$ue->enrolid])) {
2691                     $instances[$ue->enrolid] = $DB->get_record('enrol', array('id'=>$ue->enrolid));
2692                 }
2693                 $instance = $instances[$ue->enrolid];
2695                 if ($action == ENROL_EXT_REMOVED_SUSPENDNOROLES) {
2696                     if (!$this->roles_protected()) {
2697                         // Let's just guess what roles should be removed.
2698                         $count = $DB->count_records('role_assignments', array('userid'=>$ue->userid, 'contextid'=>$ue->contextid));
2699                         if ($count == 1) {
2700                             role_unassign_all(array('userid'=>$ue->userid, 'contextid'=>$ue->contextid, 'component'=>'', 'itemid'=>0));
2702                         } else if ($count > 1 and $instance->roleid) {
2703                             role_unassign($instance->roleid, $ue->userid, $ue->contextid, '', 0);
2704                         }
2705                     }
2706                     // In any case remove all roles that belong to this instance and user.
2707                     role_unassign_all(array('userid'=>$ue->userid, 'contextid'=>$ue->contextid, 'component'=>'enrol_'.$name, 'itemid'=>$instance->id), true);
2708                     // Final cleanup of subcontexts if there are no more course roles.
2709                     if (0 == $DB->count_records('role_assignments', array('userid'=>$ue->userid, 'contextid'=>$ue->contextid))) {
2710                         role_unassign_all(array('userid'=>$ue->userid, 'contextid'=>$ue->contextid, 'component'=>'', 'itemid'=>0), true);
2711                     }
2712                 }
2714                 $this->update_user_enrol($instance, $ue->userid, ENROL_USER_SUSPENDED);
2715                 $trace->output("Suspending expired user $ue->userid in course $instance->courseid", 1);
2716             }
2717             $rs->close();
2718             unset($instances);
2720         } else {
2721             // ENROL_EXT_REMOVED_KEEP means no changes.
2722         }
2724         if ($processed) {
2725             $trace->output("...finished processing of enrol_$name expirations");
2726         } else {
2727             $trace->output("No expired enrol_$name enrolments detected");
2728         }
2729         $trace->finished();
2731         return $processed;
2732     }
2734     /**
2735      * Send expiry notifications.
2736      *
2737      * Plugin that wants to have expiry notification MUST implement following:
2738      * - expirynotifyhour plugin setting,
2739      * - configuration options in instance edit form (expirynotify, notifyall and expirythreshold),
2740      * - notification strings (expirymessageenrollersubject, expirymessageenrollerbody,
2741      *   expirymessageenrolledsubject and expirymessageenrolledbody),
2742      * - expiry_notification provider in db/messages.php,
2743      * - upgrade code that sets default thresholds for existing courses (should be 1 day),
2744      * - something that calls this method, such as cron.
2745      *
2746      * @param progress_trace $trace (accepts bool for backwards compatibility only)
2747      */
2748     public function send_expiry_notifications($trace) {
2749         global $DB, $CFG;
2751         $name = $this->get_name();
2752         if (!enrol_is_enabled($name)) {
2753             $trace->finished();
2754             return;
2755         }
2757         // Unfortunately this may take a long time, it should not be interrupted,
2758         // otherwise users get duplicate notification.
2760         core_php_time_limit::raise();
2761         raise_memory_limit(MEMORY_HUGE);
2764         $expirynotifylast = $this->get_config('expirynotifylast', 0);
2765         $expirynotifyhour = $this->get_config('expirynotifyhour');
2766         if (is_null($expirynotifyhour)) {
2767             debugging("send_expiry_notifications() in $name enrolment plugin needs expirynotifyhour setting");
2768             $trace->finished();
2769             return;
2770         }
2772         if (!($trace instanceof progress_trace)) {
2773             $trace = $trace ? new text_progress_trace() : new null_progress_trace();
2774             debugging('enrol_plugin::send_expiry_notifications() now expects progress_trace instance as parameter!', DEBUG_DEVELOPER);
2775         }
2777         $timenow = time();
2778         $notifytime = usergetmidnight($timenow, $CFG->timezone) + ($expirynotifyhour * 3600);
2780         if ($expirynotifylast > $notifytime) {
2781             $trace->output($name.' enrolment expiry notifications were already sent today at '.userdate($expirynotifylast, '', $CFG->timezone).'.');
2782             $trace->finished();
2783             return;
2785         } else if ($timenow < $notifytime) {
2786             $trace->output($name.' enrolment expiry notifications will be sent at '.userdate($notifytime, '', $CFG->timezone).'.');
2787             $trace->finished();
2788             return;
2789         }
2791         $trace->output('Processing '.$name.' enrolment expiration notifications...');
2793         // Notify users responsible for enrolment once every day.
2794         $sql = "SELECT ue.*, e.expirynotify, e.notifyall, e.expirythreshold, e.courseid, c.fullname
2795                   FROM {user_enrolments} ue
2796                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = :name AND e.expirynotify > 0 AND e.status = :enabled)
2797                   JOIN {course} c ON (c.id = e.courseid)
2798                   JOIN {user} u ON (u.id = ue.userid AND u.deleted = 0 AND u.suspended = 0)
2799                  WHERE ue.status = :active AND ue.timeend > 0 AND ue.timeend > :now1 AND ue.timeend < (e.expirythreshold + :now2)
2800               ORDER BY ue.enrolid ASC, u.lastname ASC, u.firstname ASC, u.id ASC";
2801         $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE, 'now1'=>$timenow, 'now2'=>$timenow, 'name'=>$name);
2803         $rs = $DB->get_recordset_sql($sql, $params);
2805         $lastenrollid = 0;
2806         $users = array();
2808         foreach($rs as $ue) {
2809             if ($lastenrollid and $lastenrollid != $ue->enrolid) {
2810                 $this->notify_expiry_enroller($lastenrollid, $users, $trace);
2811                 $users = array();
2812             }
2813             $lastenrollid = $ue->enrolid;
2815             $enroller = $this->get_enroller($ue->enrolid);
2816             $context = context_course::instance($ue->courseid);
2818             $user = $DB->get_record('user', array('id'=>$ue->userid));
2820             $users[] = array('fullname'=>fullname($user, has_capability('moodle/site:viewfullnames', $context, $enroller)), 'timeend'=>$ue->timeend);
2822             if (!$ue->notifyall) {
2823                 continue;
2824             }
2826             if ($ue->timeend - $ue->expirythreshold + 86400 < $timenow) {
2827                 // Notify enrolled users only once at the start of the threshold.
2828                 $trace->output("user $ue->userid was already notified that enrolment in course $ue->courseid expires on ".userdate($ue->timeend, '', $CFG->timezone), 1);
2829                 continue;
2830             }
2832             $this->notify_expiry_enrolled($user, $ue, $trace);
2833         }
2834         $rs->close();
2836         if ($lastenrollid and $users) {
2837             $this->notify_expiry_enroller($lastenrollid, $users, $trace);
2838         }
2840         $trace->output('...notification processing finished.');
2841         $trace->finished();
2843         $this->set_config('expirynotifylast', $timenow);
2844     }
2846     /**
2847      * Returns the user who is responsible for enrolments for given instance.
2848      *
2849      * Override if plugin knows anybody better than admin.
2850      *
2851      * @param int $instanceid enrolment instance id
2852      * @return stdClass user record
2853      */
2854     protected function get_enroller($instanceid) {
2855         return get_admin();
2856     }
2858     /**
2859      * Notify user about incoming expiration of their enrolment,
2860      * it is called only if notification of enrolled users (aka students) is enabled in course.
2861      *
2862      * This is executed only once for each expiring enrolment right
2863      * at the start of the expiration threshold.
2864      *
2865      * @param stdClass $user
2866      * @param stdClass $ue
2867      * @param progress_trace $trace
2868      */
2869     protected function notify_expiry_enrolled($user, $ue, progress_trace $trace) {
2870         global $CFG;
2872         $name = $this->get_name();
2874         $oldforcelang = force_current_language($user->lang);
2876         $enroller = $this->get_enroller($ue->enrolid);
2877         $context = context_course::instance($ue->courseid);
2879         $a = new stdClass();
2880         $a->course   = format_string($ue->fullname, true, array('context'=>$context));
2881         $a->user     = fullname($user, true);
2882         $a->timeend  = userdate($ue->timeend, '', $user->timezone);
2883         $a->enroller = fullname($enroller, has_capability('moodle/site:viewfullnames', $context, $user));
2885         $subject = get_string('expirymessageenrolledsubject', 'enrol_'.$name, $a);
2886         $body = get_string('expirymessageenrolledbody', 'enrol_'.$name, $a);
2888         $message = new \core\message\message();
2889         $message->courseid          = $ue->courseid;
2890         $message->notification      = 1;
2891         $message->component         = 'enrol_'.$name;
2892         $message->name              = 'expiry_notification';
2893         $message->userfrom          = $enroller;
2894         $message->userto            = $user;
2895         $message->subject           = $subject;
2896         $message->fullmessage       = $body;
2897         $message->fullmessageformat = FORMAT_MARKDOWN;
2898         $message->fullmessagehtml   = markdown_to_html($body);
2899         $message->smallmessage      = $subject;
2900         $message->contexturlname    = $a->course;
2901         $message->contexturl        = (string)new moodle_url('/course/view.php', array('id'=>$ue->courseid));
2903         if (message_send($message)) {
2904             $trace->output("notifying user $ue->userid that enrolment in course $ue->courseid expires on ".userdate($ue->timeend, '', $CFG->timezone), 1);
2905         } else {
2906             $trace->output("error notifying user $ue->userid that enrolment in course $ue->courseid expires on ".userdate($ue->timeend, '', $CFG->timezone), 1);
2907         }
2909         force_current_language($oldforcelang);
2910     }
2912     /**
2913      * Notify person responsible for enrolments that some user enrolments will be expired soon,
2914      * it is called only if notification of enrollers (aka teachers) is enabled in course.
2915      *
2916      * This is called repeatedly every day for each course if there are any pending expiration
2917      * in the expiration threshold.
2918      *
2919      * @param int $eid
2920      * @param array $users
2921      * @param progress_trace $trace
2922      */
2923     protected function notify_expiry_enroller($eid, $users, progress_trace $trace) {
2924         global $DB;
2926         $name = $this->get_name();
2928         $instance = $DB->get_record('enrol', array('id'=>$eid, 'enrol'=>$name));
2929         $context = context_course::instance($instance->courseid);
2930         $course = $DB->get_record('course', array('id'=>$instance->courseid));
2932         $enroller = $this->get_enroller($instance->id);
2933         $admin = get_admin();
2935         $oldforcelang = force_current_language($enroller->lang);
2937         foreach($users as $key=>$info) {
2938             $users[$key] = '* '.$info['fullname'].' - '.userdate($info['timeend'], '', $enroller->timezone);
2939         }
2941         $a = new stdClass();
2942         $a->course    = format_string($course->fullname, true, array('context'=>$context));
2943         $a->threshold = get_string('numdays', '', $instance->expirythreshold / (60*60*24));
2944         $a->users     = implode("\n", $users);
2945         $a->extendurl = (string)new moodle_url('/user/index.php', array('id'=>$instance->courseid));
2947         $subject = get_string('expirymessageenrollersubject', 'enrol_'.$name, $a);
2948         $body = get_string('expirymessageenrollerbody', 'enrol_'.$name, $a);
2950         $message = new \core\message\message();
2951         $message->courseid          = $course->id;
2952         $message->notification      = 1;
2953         $message->component         = 'enrol_'.$name;
2954         $message->name              = 'expiry_notification';
2955         $message->userfrom          = $admin;
2956         $message->userto            = $enroller;
2957         $message->subject           = $subject;
2958         $message->fullmessage       = $body;
2959         $message->fullmessageformat = FORMAT_MARKDOWN;
2960         $message->fullmessagehtml   = markdown_to_html($body);
2961         $message->smallmessage      = $subject;
2962         $message->contexturlname    = $a->course;
2963         $message->contexturl        = $a->extendurl;
2965         if (message_send($message)) {
2966             $trace->output("notifying user $enroller->id about all expiring $name enrolments in course $instance->courseid", 1);
2967         } else {
2968             $trace->output("error notifying user $enroller->id about all expiring $name enrolments in course $instance->courseid", 1);
2969         }
2971         force_current_language($oldforcelang);
2972     }
2974     /**
2975      * Backup execution step hook to annotate custom fields.
2976      *
2977      * @param backup_enrolments_execution_step $step
2978      * @param stdClass $enrol
2979      */
2980     public function backup_annotate_custom_fields(backup_enrolments_execution_step $step, stdClass $enrol) {
2981         // Override as necessary to annotate custom fields in the enrol table.
2982     }
2984     /**
2985      * Automatic enrol sync executed during restore.
2986      * Useful for automatic sync by course->idnumber or course category.
2987      * @param stdClass $course course record
2988      */
2989     public function restore_sync_course($course) {
2990         // Override if necessary.
2991     }
2993     /**
2994      * Restore instance and map settings.
2995      *
2996      * @param restore_enrolments_structure_step $step
2997      * @param stdClass $data
2998      * @param stdClass $course
2999      * @param int $oldid
3000      */
3001     public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
3002         // Do not call this from overridden methods, restore and set new id there.
3003         $step->set_mapping('enrol', $oldid, 0);
3004     }
3006     /**
3007      * Restore user enrolment.
3008      *
3009      * @param restore_enrolments_structure_step $step
3010      * @param stdClass $data
3011      * @param stdClass $instance
3012      * @param int $oldinstancestatus
3013      * @param int $userid
3014      */
3015     public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
3016         // Override as necessary if plugin supports restore of enrolments.
3017     }
3019     /**
3020      * Restore role assignment.
3021      *
3022      * @param stdClass $instance
3023      * @param int $roleid
3024      * @param int $userid
3025      * @param int $contextid
3026      */
3027     public function restore_role_assignment($instance, $roleid, $userid, $contextid) {
3028         // No role assignment by default, override if necessary.
3029     }
3031     /**
3032      * Restore user group membership.
3033      * @param stdClass $instance
3034      * @param int $groupid
3035      * @param int $userid
3036      */
3037     public function restore_group_member($instance, $groupid, $userid) {
3038         // Implement if you want to restore protected group memberships,
3039         // usually this is not necessary because plugins should be able to recreate the memberships automatically.
3040     }
3042     /**
3043      * Returns defaults for new instances.
3044      * @since Moodle 3.1
3045      * @return array
3046      */
3047     public function get_instance_defaults() {
3048         return array();
3049     }
3051     /**
3052      * Validate a list of parameter names and types.
3053      * @since Moodle 3.1
3054      *
3055      * @param array $data array of ("fieldname"=>value) of submitted data
3056      * @param array $rules array of ("fieldname"=>PARAM_X types - or "fieldname"=>array( list of valid options )
3057      * @return array of "element_name"=>"error_description" if there are errors,
3058      *         or an empty array if everything is OK.
3059      */
3060     public function validate_param_types($data, $rules) {
3061         $errors = array();
3062         $invalidstr = get_string('invaliddata', 'error');
3063         foreach ($rules as $fieldname => $rule) {
3064             if (is_array($rule)) {
3065                 if (!in_array($data[$fieldname], $rule)) {
3066                     $errors[$fieldname] = $invalidstr;
3067                 }
3068             } else {
3069                 if ($data[$fieldname] != clean_param($data[$fieldname], $rule)) {
3070                     $errors[$fieldname] = $invalidstr;
3071                 }
3072             }
3073         }
3074         return $errors;
3075     }