/lib/enrollib.php
PHP | 2327 lines | 1292 code | 302 blank | 733 comment | 236 complexity | a1b7184a9727ce5936ae2896ad219b47 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, LGPL-2.1, Apache-2.0, BSD-3-Clause, AGPL-3.0
Large files files are truncated, but you can click here to view the full file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * This library includes the basic parts of enrol api.
- * It is available on each page.
- *
- * @package core
- * @subpackage enrol
- * @copyright 2010 Petr Skoda {@link http://skodak.org}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- /** Course enrol instance enabled. (used in enrol->status) */
- define('ENROL_INSTANCE_ENABLED', 0);
- /** Course enrol instance disabled, user may enter course if other enrol instance enabled. (used in enrol->status)*/
- define('ENROL_INSTANCE_DISABLED', 1);
- /** User is active participant (used in user_enrolments->status)*/
- define('ENROL_USER_ACTIVE', 0);
- /** User participation in course is suspended (used in user_enrolments->status) */
- define('ENROL_USER_SUSPENDED', 1);
- /** @deprecated - enrol caching was reworked, use ENROL_MAX_TIMESTAMP instead */
- define('ENROL_REQUIRE_LOGIN_CACHE_PERIOD', 1800);
- /** The timestamp indicating forever */
- define('ENROL_MAX_TIMESTAMP', 2147483647);
- /** When user disappears from external source, the enrolment is completely removed */
- define('ENROL_EXT_REMOVED_UNENROL', 0);
- /** When user disappears from external source, the enrolment is kept as is - one way sync */
- define('ENROL_EXT_REMOVED_KEEP', 1);
- /** @deprecated since 2.4 not used any more, migrate plugin to new restore methods */
- define('ENROL_RESTORE_TYPE', 'enrolrestore');
- /**
- * When user disappears from external source, user enrolment is suspended, roles are kept as is.
- * In some cases user needs a role with some capability to be visible in UI - suc has in gradebook,
- * assignments, etc.
- */
- define('ENROL_EXT_REMOVED_SUSPEND', 2);
- /**
- * When user disappears from external source, the enrolment is suspended and roles assigned
- * by enrol instance are removed. Please note that user may "disappear" from gradebook and other areas.
- * */
- define('ENROL_EXT_REMOVED_SUSPENDNOROLES', 3);
- /**
- * Returns instances of enrol plugins
- * @param bool $enabled return enabled only
- * @return array of enrol plugins name=>instance
- */
- function enrol_get_plugins($enabled) {
- global $CFG;
- $result = array();
- if ($enabled) {
- // sorted by enabled plugin order
- $enabled = explode(',', $CFG->enrol_plugins_enabled);
- $plugins = array();
- foreach ($enabled as $plugin) {
- $plugins[$plugin] = "$CFG->dirroot/enrol/$plugin";
- }
- } else {
- // sorted alphabetically
- $plugins = core_component::get_plugin_list('enrol');
- ksort($plugins);
- }
- foreach ($plugins as $plugin=>$location) {
- if (!file_exists("$location/lib.php")) {
- continue;
- }
- include_once("$location/lib.php");
- $class = "enrol_{$plugin}_plugin";
- if (!class_exists($class)) {
- continue;
- }
- $result[$plugin] = new $class();
- }
- return $result;
- }
- /**
- * Returns instance of enrol plugin
- * @param string $name name of enrol plugin ('manual', 'guest', ...)
- * @return enrol_plugin
- */
- function enrol_get_plugin($name) {
- global $CFG;
- $name = clean_param($name, PARAM_PLUGIN);
- if (empty($name)) {
- // ignore malformed or missing plugin names completely
- return null;
- }
- $location = "$CFG->dirroot/enrol/$name";
- if (!file_exists("$location/lib.php")) {
- return null;
- }
- include_once("$location/lib.php");
- $class = "enrol_{$name}_plugin";
- if (!class_exists($class)) {
- return null;
- }
- return new $class();
- }
- /**
- * Returns enrolment instances in given course.
- * @param int $courseid
- * @param bool $enabled
- * @return array of enrol instances
- */
- function enrol_get_instances($courseid, $enabled) {
- global $DB, $CFG;
- if (!$enabled) {
- return $DB->get_records('enrol', array('courseid'=>$courseid), 'sortorder,id');
- }
- $result = $DB->get_records('enrol', array('courseid'=>$courseid, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder,id');
- $enabled = explode(',', $CFG->enrol_plugins_enabled);
- foreach ($result as $key=>$instance) {
- if (!in_array($instance->enrol, $enabled)) {
- unset($result[$key]);
- continue;
- }
- if (!file_exists("$CFG->dirroot/enrol/$instance->enrol/lib.php")) {
- // broken plugin
- unset($result[$key]);
- continue;
- }
- }
- return $result;
- }
- /**
- * Checks if a given plugin is in the list of enabled enrolment plugins.
- *
- * @param string $enrol Enrolment plugin name
- * @return boolean Whether the plugin is enabled
- */
- function enrol_is_enabled($enrol) {
- global $CFG;
- if (empty($CFG->enrol_plugins_enabled)) {
- return false;
- }
- return in_array($enrol, explode(',', $CFG->enrol_plugins_enabled));
- }
- /**
- * Check all the login enrolment information for the given user object
- * by querying the enrolment plugins
- *
- * This function may be very slow, use only once after log-in or login-as.
- *
- * @param stdClass $user
- * @return void
- */
- function enrol_check_plugins($user) {
- global $CFG;
- if (empty($user->id) or isguestuser($user)) {
- // shortcut - there is no enrolment work for guests and not-logged-in users
- return;
- }
- // originally there was a broken admin test, but accidentally it was non-functional in 2.2,
- // which proved it was actually not necessary.
- static $inprogress = array(); // To prevent this function being called more than once in an invocation
- if (!empty($inprogress[$user->id])) {
- return;
- }
- $inprogress[$user->id] = true; // Set the flag
- $enabled = enrol_get_plugins(true);
- foreach($enabled as $enrol) {
- $enrol->sync_user_enrolments($user);
- }
- unset($inprogress[$user->id]); // Unset the flag
- }
- /**
- * Do these two students share any course?
- *
- * The courses has to be visible and enrolments has to be active,
- * timestart and timeend restrictions are ignored.
- *
- * This function calls {@see enrol_get_shared_courses()} setting checkexistsonly
- * to true.
- *
- * @param stdClass|int $user1
- * @param stdClass|int $user2
- * @return bool
- */
- function enrol_sharing_course($user1, $user2) {
- return enrol_get_shared_courses($user1, $user2, false, true);
- }
- /**
- * Returns any courses shared by the two users
- *
- * The courses has to be visible and enrolments has to be active,
- * timestart and timeend restrictions are ignored.
- *
- * @global moodle_database $DB
- * @param stdClass|int $user1
- * @param stdClass|int $user2
- * @param bool $preloadcontexts If set to true contexts for the returned courses
- * will be preloaded.
- * @param bool $checkexistsonly If set to true then this function will return true
- * if the users share any courses and false if not.
- * @return array|bool An array of courses that both users are enrolled in OR if
- * $checkexistsonly set returns true if the users share any courses
- * and false if not.
- */
- function enrol_get_shared_courses($user1, $user2, $preloadcontexts = false, $checkexistsonly = false) {
- global $DB, $CFG;
- $user1 = isset($user1->id) ? $user1->id : $user1;
- $user2 = isset($user2->id) ? $user2->id : $user2;
- if (empty($user1) or empty($user2)) {
- return false;
- }
- if (!$plugins = explode(',', $CFG->enrol_plugins_enabled)) {
- return false;
- }
- list($plugins, $params) = $DB->get_in_or_equal($plugins, SQL_PARAMS_NAMED, 'ee');
- $params['enabled'] = ENROL_INSTANCE_ENABLED;
- $params['active1'] = ENROL_USER_ACTIVE;
- $params['active2'] = ENROL_USER_ACTIVE;
- $params['user1'] = $user1;
- $params['user2'] = $user2;
- $ctxselect = '';
- $ctxjoin = '';
- if ($preloadcontexts) {
- $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
- $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
- $params['contextlevel'] = CONTEXT_COURSE;
- }
- $sql = "SELECT c.* $ctxselect
- FROM {course} c
- JOIN (
- SELECT DISTINCT c.id
- FROM {enrol} e
- JOIN {user_enrolments} ue1 ON (ue1.enrolid = e.id AND ue1.status = :active1 AND ue1.userid = :user1)
- JOIN {user_enrolments} ue2 ON (ue2.enrolid = e.id AND ue2.status = :active2 AND ue2.userid = :user2)
- JOIN {course} c ON (c.id = e.courseid AND c.visible = 1)
- WHERE e.status = :enabled AND e.enrol $plugins
- ) ec ON ec.id = c.id
- $ctxjoin";
- if ($checkexistsonly) {
- return $DB->record_exists_sql($sql, $params);
- } else {
- $courses = $DB->get_records_sql($sql, $params);
- if ($preloadcontexts) {
- array_map('context_helper::preload_from_record', $courses);
- }
- return $courses;
- }
- }
- /**
- * This function adds necessary enrol plugins UI into the course edit form.
- *
- * @param MoodleQuickForm $mform
- * @param object $data course edit form data
- * @param object $context context of existing course or parent category if course does not exist
- * @return void
- */
- function enrol_course_edit_form(MoodleQuickForm $mform, $data, $context) {
- $plugins = enrol_get_plugins(true);
- if (!empty($data->id)) {
- $instances = enrol_get_instances($data->id, false);
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- $plugin = $plugins[$instance->enrol];
- $plugin->course_edit_form($instance, $mform, $data, $context);
- }
- } else {
- foreach ($plugins as $plugin) {
- $plugin->course_edit_form(NULL, $mform, $data, $context);
- }
- }
- }
- /**
- * Validate course edit form data
- *
- * @param array $data raw form data
- * @param object $context context of existing course or parent category if course does not exist
- * @return array errors array
- */
- function enrol_course_edit_validation(array $data, $context) {
- $errors = array();
- $plugins = enrol_get_plugins(true);
- if (!empty($data['id'])) {
- $instances = enrol_get_instances($data['id'], false);
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- $plugin = $plugins[$instance->enrol];
- $errors = array_merge($errors, $plugin->course_edit_validation($instance, $data, $context));
- }
- } else {
- foreach ($plugins as $plugin) {
- $errors = array_merge($errors, $plugin->course_edit_validation(NULL, $data, $context));
- }
- }
- return $errors;
- }
- /**
- * Update enrol instances after course edit form submission
- * @param bool $inserted true means new course added, false course already existed
- * @param object $course
- * @param object $data form data
- * @return void
- */
- function enrol_course_updated($inserted, $course, $data) {
- global $DB, $CFG;
- $plugins = enrol_get_plugins(true);
- foreach ($plugins as $plugin) {
- $plugin->course_updated($inserted, $course, $data);
- }
- }
- /**
- * Add navigation nodes
- * @param navigation_node $coursenode
- * @param object $course
- * @return void
- */
- function enrol_add_course_navigation(navigation_node $coursenode, $course) {
- global $CFG;
- $coursecontext = context_course::instance($course->id);
- $instances = enrol_get_instances($course->id, true);
- $plugins = enrol_get_plugins(true);
- // we do not want to break all course pages if there is some borked enrol plugin, right?
- foreach ($instances as $k=>$instance) {
- if (!isset($plugins[$instance->enrol])) {
- unset($instances[$k]);
- }
- }
- $usersnode = $coursenode->add(get_string('users'), null, navigation_node::TYPE_CONTAINER, null, 'users');
- if ($course->id != SITEID) {
- // list all participants - allows assigning roles, groups, etc.
- if (has_capability('moodle/course:enrolreview', $coursecontext)) {
- $url = new moodle_url('/enrol/users.php', array('id'=>$course->id));
- $usersnode->add(get_string('enrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'review', new pix_icon('i/enrolusers', ''));
- }
- // manage enrol plugin instances
- if (has_capability('moodle/course:enrolconfig', $coursecontext) or has_capability('moodle/course:enrolreview', $coursecontext)) {
- $url = new moodle_url('/enrol/instances.php', array('id'=>$course->id));
- } else {
- $url = NULL;
- }
- $instancesnode = $usersnode->add(get_string('enrolmentinstances', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'manageinstances');
- // each instance decides how to configure itself or how many other nav items are exposed
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- $plugins[$instance->enrol]->add_course_navigation($instancesnode, $instance);
- }
- if (!$url) {
- $instancesnode->trim_if_empty();
- }
- }
- // Manage groups in this course or even frontpage
- if (($course->groupmode || !$course->groupmodeforce) && has_capability('moodle/course:managegroups', $coursecontext)) {
- $url = new moodle_url('/group/index.php', array('id'=>$course->id));
- $usersnode->add(get_string('groups'), $url, navigation_node::TYPE_SETTING, null, 'groups', new pix_icon('i/group', ''));
- }
- if (has_any_capability(array( 'moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:review'), $coursecontext)) {
- // Override roles
- if (has_capability('moodle/role:review', $coursecontext)) {
- $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$coursecontext->id));
- } else {
- $url = NULL;
- }
- $permissionsnode = $usersnode->add(get_string('permissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'override');
- // Add assign or override roles if allowed
- if ($course->id == SITEID or (!empty($CFG->adminsassignrolesincourse) and is_siteadmin())) {
- if (has_capability('moodle/role:assign', $coursecontext)) {
- $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$coursecontext->id));
- $permissionsnode->add(get_string('assignedroles', 'role'), $url, navigation_node::TYPE_SETTING, null, 'roles', new pix_icon('i/assignroles', ''));
- }
- }
- // Check role permissions
- if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $coursecontext)) {
- $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$coursecontext->id));
- $permissionsnode->add(get_string('checkpermissions', 'role'), $url, navigation_node::TYPE_SETTING, null, 'permissions', new pix_icon('i/checkpermissions', ''));
- }
- }
- // Deal somehow with users that are not enrolled but still got a role somehow
- if ($course->id != SITEID) {
- //TODO, create some new UI for role assignments at course level
- if (has_capability('moodle/role:assign', $coursecontext)) {
- $url = new moodle_url('/enrol/otherusers.php', array('id'=>$course->id));
- $usersnode->add(get_string('notenrolledusers', 'enrol'), $url, navigation_node::TYPE_SETTING, null, 'otherusers', new pix_icon('i/assignroles', ''));
- }
- }
- // just in case nothing was actually added
- $usersnode->trim_if_empty();
- if ($course->id != SITEID) {
- if (isguestuser() or !isloggedin()) {
- // guest account can not be enrolled - no links for them
- } else if (is_enrolled($coursecontext)) {
- // unenrol link if possible
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- $plugin = $plugins[$instance->enrol];
- if ($unenrollink = $plugin->get_unenrolself_link($instance)) {
- $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
- $coursenode->add(get_string('unenrolme', 'core_enrol', $shortname), $unenrollink, navigation_node::TYPE_SETTING, null, 'unenrolself', new pix_icon('i/user', ''));
- break;
- //TODO. deal with multiple unenrol links - not likely case, but still...
- }
- }
- } else {
- // enrol link if possible
- if (is_viewing($coursecontext)) {
- // better not show any enrol link, this is intended for managers and inspectors
- } else {
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- $plugin = $plugins[$instance->enrol];
- if ($plugin->show_enrolme_link($instance)) {
- $url = new moodle_url('/enrol/index.php', array('id'=>$course->id));
- $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
- $coursenode->add(get_string('enrolme', 'core_enrol', $shortname), $url, navigation_node::TYPE_SETTING, null, 'enrolself', new pix_icon('i/user', ''));
- break;
- }
- }
- }
- }
- }
- }
- /**
- * Returns list of courses current $USER is enrolled in and can access
- *
- * - $fields is an array of field names to ADD
- * so name the fields you really need, which will
- * be added and uniq'd
- *
- * @param string|array $fields
- * @param string $sort
- * @param int $limit max number of courses
- * @return array
- */
- function enrol_get_my_courses($fields = NULL, $sort = 'visible DESC,sortorder ASC', $limit = 0) {
- global $DB, $USER;
- // Guest account does not have any courses
- if (isguestuser() or !isloggedin()) {
- return(array());
- }
- $basefields = array('id', 'category', 'sortorder',
- 'shortname', 'fullname', 'idnumber',
- 'startdate', 'visible',
- 'groupmode', 'groupmodeforce', 'cacherev');
- if (empty($fields)) {
- $fields = $basefields;
- } else if (is_string($fields)) {
- // turn the fields from a string to an array
- $fields = explode(',', $fields);
- $fields = array_map('trim', $fields);
- $fields = array_unique(array_merge($basefields, $fields));
- } else if (is_array($fields)) {
- $fields = array_unique(array_merge($basefields, $fields));
- } else {
- throw new coding_exception('Invalid $fileds parameter in enrol_get_my_courses()');
- }
- if (in_array('*', $fields)) {
- $fields = array('*');
- }
- $orderby = "";
- $sort = trim($sort);
- if (!empty($sort)) {
- $rawsorts = explode(',', $sort);
- $sorts = array();
- foreach ($rawsorts as $rawsort) {
- $rawsort = trim($rawsort);
- if (strpos($rawsort, 'c.') === 0) {
- $rawsort = substr($rawsort, 2);
- }
- $sorts[] = trim($rawsort);
- }
- $sort = 'c.'.implode(',c.', $sorts);
- $orderby = "ORDER BY $sort";
- }
- $wheres = array("c.id <> :siteid");
- $params = array('siteid'=>SITEID);
- if (isset($USER->loginascontext) and $USER->loginascontext->contextlevel == CONTEXT_COURSE) {
- // list _only_ this course - anything else is asking for trouble...
- $wheres[] = "courseid = :loginas";
- $params['loginas'] = $USER->loginascontext->instanceid;
- }
- $coursefields = 'c.' .join(',c.', $fields);
- $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
- $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
- $params['contextlevel'] = CONTEXT_COURSE;
- $wheres = implode(" AND ", $wheres);
- //note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why we have the subselect there
- $sql = "SELECT $coursefields $ccselect
- FROM {course} c
- JOIN (SELECT DISTINCT e.courseid
- FROM {enrol} e
- JOIN {user_enrolments} ue ON (ue.enrolid = e.id AND ue.userid = :userid)
- WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
- ) en ON (en.courseid = c.id)
- $ccjoin
- WHERE $wheres
- $orderby";
- $params['userid'] = $USER->id;
- $params['active'] = ENROL_USER_ACTIVE;
- $params['enabled'] = ENROL_INSTANCE_ENABLED;
- $params['now1'] = round(time(), -2); // improves db caching
- $params['now2'] = $params['now1'];
- $courses = $DB->get_records_sql($sql, $params, 0, $limit);
- // preload contexts and check visibility
- foreach ($courses as $id=>$course) {
- context_helper::preload_from_record($course);
- if (!$course->visible) {
- if (!$context = context_course::instance($id, IGNORE_MISSING)) {
- unset($courses[$id]);
- continue;
- }
- if (!has_capability('moodle/course:viewhiddencourses', $context)) {
- unset($courses[$id]);
- continue;
- }
- }
- $courses[$id] = $course;
- }
- //wow! Is that really all? :-D
- return $courses;
- }
- /**
- * Returns course enrolment information icons.
- *
- * @param object $course
- * @param array $instances enrol instances of this course, improves performance
- * @return array of pix_icon
- */
- function enrol_get_course_info_icons($course, array $instances = NULL) {
- $icons = array();
- if (is_null($instances)) {
- $instances = enrol_get_instances($course->id, true);
- }
- $plugins = enrol_get_plugins(true);
- foreach ($plugins as $name => $plugin) {
- $pis = array();
- foreach ($instances as $instance) {
- if ($instance->status != ENROL_INSTANCE_ENABLED or $instance->courseid != $course->id) {
- debugging('Invalid instances parameter submitted in enrol_get_info_icons()');
- continue;
- }
- if ($instance->enrol == $name) {
- $pis[$instance->id] = $instance;
- }
- }
- if ($pis) {
- $icons = array_merge($icons, $plugin->get_info_icons($pis));
- }
- }
- return $icons;
- }
- /**
- * Returns course enrolment detailed information.
- *
- * @param object $course
- * @return array of html fragments - can be used to construct lists
- */
- function enrol_get_course_description_texts($course) {
- $lines = array();
- $instances = enrol_get_instances($course->id, true);
- $plugins = enrol_get_plugins(true);
- foreach ($instances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- //weird
- continue;
- }
- $plugin = $plugins[$instance->enrol];
- $text = $plugin->get_description_text($instance);
- if ($text !== NULL) {
- $lines[] = $text;
- }
- }
- return $lines;
- }
- /**
- * Returns list of courses user is enrolled into.
- * (Note: use enrol_get_all_users_courses if you want to use the list wihtout any cap checks )
- *
- * - $fields is an array of fieldnames to ADD
- * so name the fields you really need, which will
- * be added and uniq'd
- *
- * @param int $userid
- * @param bool $onlyactive return only active enrolments in courses user may see
- * @param string|array $fields
- * @param string $sort
- * @return array
- */
- function enrol_get_users_courses($userid, $onlyactive = false, $fields = NULL, $sort = 'visible DESC,sortorder ASC') {
- global $DB;
- $courses = enrol_get_all_users_courses($userid, $onlyactive, $fields, $sort);
- // preload contexts and check visibility
- if ($onlyactive) {
- foreach ($courses as $id=>$course) {
- context_helper::preload_from_record($course);
- if (!$course->visible) {
- if (!$context = context_course::instance($id)) {
- unset($courses[$id]);
- continue;
- }
- if (!has_capability('moodle/course:viewhiddencourses', $context, $userid)) {
- unset($courses[$id]);
- continue;
- }
- }
- }
- }
- return $courses;
- }
- /**
- * Can user access at least one enrolled course?
- *
- * Cheat if necessary, but find out as fast as possible!
- *
- * @param int|stdClass $user null means use current user
- * @return bool
- */
- function enrol_user_sees_own_courses($user = null) {
- global $USER;
- if ($user === null) {
- $user = $USER;
- }
- $userid = is_object($user) ? $user->id : $user;
- // Guest account does not have any courses
- if (isguestuser($userid) or empty($userid)) {
- return false;
- }
- // Let's cheat here if this is the current user,
- // if user accessed any course recently, then most probably
- // we do not need to query the database at all.
- if ($USER->id == $userid) {
- if (!empty($USER->enrol['enrolled'])) {
- foreach ($USER->enrol['enrolled'] as $until) {
- if ($until > time()) {
- return true;
- }
- }
- }
- }
- // Now the slow way.
- $courses = enrol_get_all_users_courses($userid, true);
- foreach($courses as $course) {
- if ($course->visible) {
- return true;
- }
- context_helper::preload_from_record($course);
- $context = context_course::instance($course->id);
- if (has_capability('moodle/course:viewhiddencourses', $context, $user)) {
- return true;
- }
- }
- return false;
- }
- /**
- * Returns list of courses user is enrolled into without any capability checks
- * - $fields is an array of fieldnames to ADD
- * so name the fields you really need, which will
- * be added and uniq'd
- *
- * @param int $userid
- * @param bool $onlyactive return only active enrolments in courses user may see
- * @param string|array $fields
- * @param string $sort
- * @return array
- */
- function enrol_get_all_users_courses($userid, $onlyactive = false, $fields = NULL, $sort = 'visible DESC,sortorder ASC') {
- global $DB;
- // Guest account does not have any courses
- if (isguestuser($userid) or empty($userid)) {
- return(array());
- }
- $basefields = array('id', 'category', 'sortorder',
- 'shortname', 'fullname', 'idnumber',
- 'startdate', 'visible',
- 'groupmode', 'groupmodeforce');
- if (empty($fields)) {
- $fields = $basefields;
- } else if (is_string($fields)) {
- // turn the fields from a string to an array
- $fields = explode(',', $fields);
- $fields = array_map('trim', $fields);
- $fields = array_unique(array_merge($basefields, $fields));
- } else if (is_array($fields)) {
- $fields = array_unique(array_merge($basefields, $fields));
- } else {
- throw new coding_exception('Invalid $fileds parameter in enrol_get_my_courses()');
- }
- if (in_array('*', $fields)) {
- $fields = array('*');
- }
- $orderby = "";
- $sort = trim($sort);
- if (!empty($sort)) {
- $rawsorts = explode(',', $sort);
- $sorts = array();
- foreach ($rawsorts as $rawsort) {
- $rawsort = trim($rawsort);
- if (strpos($rawsort, 'c.') === 0) {
- $rawsort = substr($rawsort, 2);
- }
- $sorts[] = trim($rawsort);
- }
- $sort = 'c.'.implode(',c.', $sorts);
- $orderby = "ORDER BY $sort";
- }
- $params = array('siteid'=>SITEID);
- if ($onlyactive) {
- $subwhere = "WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
- $params['now1'] = round(time(), -2); // improves db caching
- $params['now2'] = $params['now1'];
- $params['active'] = ENROL_USER_ACTIVE;
- $params['enabled'] = ENROL_INSTANCE_ENABLED;
- } else {
- $subwhere = "";
- }
- $coursefields = 'c.' .join(',c.', $fields);
- $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
- $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
- $params['contextlevel'] = CONTEXT_COURSE;
- //note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why we have the subselect there
- $sql = "SELECT $coursefields $ccselect
- FROM {course} c
- JOIN (SELECT DISTINCT e.courseid
- FROM {enrol} e
- JOIN {user_enrolments} ue ON (ue.enrolid = e.id AND ue.userid = :userid)
- $subwhere
- ) en ON (en.courseid = c.id)
- $ccjoin
- WHERE c.id <> :siteid
- $orderby";
- $params['userid'] = $userid;
- $courses = $DB->get_records_sql($sql, $params);
- return $courses;
- }
- /**
- * Called when user is about to be deleted.
- * @param object $user
- * @return void
- */
- function enrol_user_delete($user) {
- global $DB;
- $plugins = enrol_get_plugins(true);
- foreach ($plugins as $plugin) {
- $plugin->user_delete($user);
- }
- // force cleanup of all broken enrolments
- $DB->delete_records('user_enrolments', array('userid'=>$user->id));
- }
- /**
- * Called when course is about to be deleted.
- * @param stdClass $course
- * @return void
- */
- function enrol_course_delete($course) {
- global $DB;
- $instances = enrol_get_instances($course->id, false);
- $plugins = enrol_get_plugins(true);
- foreach ($instances as $instance) {
- if (isset($plugins[$instance->enrol])) {
- $plugins[$instance->enrol]->delete_instance($instance);
- }
- // low level delete in case plugin did not do it
- $DB->delete_records('user_enrolments', array('enrolid'=>$instance->id));
- $DB->delete_records('role_assignments', array('itemid'=>$instance->id, 'component'=>'enrol_'.$instance->enrol));
- $DB->delete_records('user_enrolments', array('enrolid'=>$instance->id));
- $DB->delete_records('enrol', array('id'=>$instance->id));
- }
- }
- /**
- * Try to enrol user via default internal auth plugin.
- *
- * For now this is always using the manual enrol plugin...
- *
- * @param $courseid
- * @param $userid
- * @param $roleid
- * @param $timestart
- * @param $timeend
- * @return bool success
- */
- function enrol_try_internal_enrol($courseid, $userid, $roleid = null, $timestart = 0, $timeend = 0) {
- global $DB;
- //note: this is hardcoded to manual plugin for now
- if (!enrol_is_enabled('manual')) {
- return false;
- }
- if (!$enrol = enrol_get_plugin('manual')) {
- return false;
- }
- if (!$instances = $DB->get_records('enrol', array('enrol'=>'manual', 'courseid'=>$courseid, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder,id ASC')) {
- return false;
- }
- $instance = reset($instances);
- $enrol->enrol_user($instance, $userid, $roleid, $timestart, $timeend);
- return true;
- }
- /**
- * Is there a chance users might self enrol
- * @param int $courseid
- * @return bool
- */
- function enrol_selfenrol_available($courseid) {
- $result = false;
- $plugins = enrol_get_plugins(true);
- $enrolinstances = enrol_get_instances($courseid, true);
- foreach($enrolinstances as $instance) {
- if (!isset($plugins[$instance->enrol])) {
- continue;
- }
- if ($instance->enrol === 'guest') {
- // blacklist known temporary guest plugins
- continue;
- }
- if ($plugins[$instance->enrol]->show_enrolme_link($instance)) {
- $result = true;
- break;
- }
- }
- return $result;
- }
- /**
- * This function returns the end of current active user enrolment.
- *
- * It deals correctly with multiple overlapping user enrolments.
- *
- * @param int $courseid
- * @param int $userid
- * @return int|bool timestamp when active enrolment ends, false means no active enrolment now, 0 means never
- */
- function enrol_get_enrolment_end($courseid, $userid) {
- global $DB;
- $sql = "SELECT ue.*
- FROM {user_enrolments} ue
- JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
- JOIN {user} u ON u.id = ue.userid
- WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0";
- $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE, 'userid'=>$userid, 'courseid'=>$courseid);
- if (!$enrolments = $DB->get_records_sql($sql, $params)) {
- return false;
- }
- $changes = array();
- foreach ($enrolments as $ue) {
- $start = (int)$ue->timestart;
- $end = (int)$ue->timeend;
- if ($end != 0 and $end < $start) {
- debugging('Invalid enrolment start or end in user_enrolment id:'.$ue->id);
- continue;
- }
- if (isset($changes[$start])) {
- $changes[$start] = $changes[$start] + 1;
- } else {
- $changes[$start] = 1;
- }
- if ($end === 0) {
- // no end
- } else if (isset($changes[$end])) {
- $changes[$end] = $changes[$end] - 1;
- } else {
- $changes[$end] = -1;
- }
- }
- // let's sort then enrolment starts&ends and go through them chronologically,
- // looking for current status and the next future end of enrolment
- ksort($changes);
- $now = time();
- $current = 0;
- $present = null;
- foreach ($changes as $time => $change) {
- if ($time > $now) {
- if ($present === null) {
- // we have just went past current time
- $present = $current;
- if ($present < 1) {
- // no enrolment active
- return false;
- }
- }
- if ($present !== null) {
- // we are already in the future - look for possible end
- if ($current + $change < 1) {
- return $time;
- }
- }
- }
- $current += $change;
- }
- if ($current > 0) {
- return 0;
- } else {
- return false;
- }
- }
- /**
- * Is current user accessing course via this enrolment method?
- *
- * This is intended for operations that are going to affect enrol instances.
- *
- * @param stdClass $instance enrol instance
- * @return bool
- */
- function enrol_accessing_via_instance(stdClass $instance) {
- global $DB, $USER;
- if (empty($instance->id)) {
- return false;
- }
- if (is_siteadmin()) {
- // Admins may go anywhere.
- return false;
- }
- return $DB->record_exists('user_enrolments', array('userid'=>$USER->id, 'enrolid'=>$instance->id));
- }
- /**
- * All enrol plugins should be based on this class,
- * this is also the main source of documentation.
- */
- abstract class enrol_plugin {
- protected $config = null;
- /**
- * Returns name of this enrol plugin
- * @return string
- */
- public function get_name() {
- // second word in class is always enrol name, sorry, no fancy plugin names with _
- $words = explode('_', get_class($this));
- return $words[1];
- }
- /**
- * Returns localised name of enrol instance
- *
- * @param object $instance (null is accepted too)
- * @return string
- */
- public function get_instance_name($instance) {
- if (empty($instance->name)) {
- $enrol = $this->get_name();
- return get_string('pluginname', 'enrol_'.$enrol);
- } else {
- $context = context_course::instance($instance->courseid);
- return format_string($instance->name, true, array('context'=>$context));
- }
- }
- /**
- * Returns optional enrolment information icons.
- *
- * This is used in course list for quick overview of enrolment options.
- *
- * We are not using single instance parameter because sometimes
- * we might want to prevent icon repetition when multiple instances
- * of one type exist. One instance may also produce several icons.
- *
- * @param array $instances all enrol instances of this type in one course
- * @return array of pix_icon
- */
- public function get_info_icons(array $instances) {
- return array();
- }
- /**
- * Returns optional enrolment instance description text.
- *
- * This is used in detailed course information.
- *
- *
- * @param object $instance
- * @return string short html text
- */
- public function get_description_text($instance) {
- return null;
- }
- /**
- * Makes sure config is loaded and cached.
- * @return void
- */
- protected function load_config() {
- if (!isset($this->config)) {
- $name = $this->get_name();
- $this->config = get_config("enrol_$name");
- }
- }
- /**
- * Returns plugin config value
- * @param string $name
- * @param string $default value if config does not exist yet
- * @return string value or default
- */
- public function get_config($name, $default = NULL) {
- $this->load_config();
- return isset($this->config->$name) ? $this->config->$name : $default;
- }
- /**
- * Sets plugin config value
- * @param string $name name of config
- * @param string $value string config value, null means delete
- * @return string value
- */
- public function set_config($name, $value) {
- $pluginname = $this->get_name();
- $this->load_config();
- if ($value === NULL) {
- unset($this->config->$name);
- } else {
- $this->config->$name = $value;
- }
- set_config($name, $value, "enrol_$pluginname");
- }
- /**
- * Does this plugin assign protected roles are can they be manually removed?
- * @return bool - false means anybody may tweak roles, it does not use itemid and component when assigning roles
- */
- public function roles_protected() {
- return true;
- }
- /**
- * Does this plugin allow manual enrolments?
- *
- * @param stdClass $instance course enrol instance
- * All plugins allowing this must implement 'enrol/xxx:enrol' capability
- *
- * @return bool - true means user with 'enrol/xxx:enrol' may enrol others freely, false means nobody may add more enrolments manually
- */
- public function allow_enrol(stdClass $instance) {
- return false;
- }
- /**
- * Does this plugin allow manual unenrolment of all users?
- * All plugins allowing this must implement 'enrol/xxx:unenrol' capability
- *
- * @param stdClass $instance course enrol instance
- * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol others freely, false means nobody may touch user_enrolments
- */
- public function allow_unenrol(stdClass $instance) {
- return false;
- }
- /**
- * Does this plugin allow manual unenrolment of a specific user?
- * All plugins allowing this must implement 'enrol/xxx:unenrol' capability
- *
- * This is useful especially for synchronisation plugins that
- * do suspend instead of full unenrolment.
- *
- * @param stdClass $instance course enrol instance
- * @param stdClass $ue record from user_enrolments table, specifies user
- *
- * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
- */
- public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
- return $this->allow_unenrol($instance);
- }
- /**
- * Does this plugin allow manual changes in user_enrolments table?
- *
- * All plugins allowing this must implement 'enrol/xxx:manage' capability
- *
- * @param stdClass $instance course enrol instance
- * @return bool - true means it is possible to change enrol period and status in user_enrolments table
- */
- public function allow_manage(stdClass $instance) {
- return false;
- }
- /**
- * Does this plugin support some way to user to self enrol?
- *
- * @param stdClass $instance course enrol instance
- *
- * @return bool - true means show "Enrol me in this course" link in course UI
- */
- public function show_enrolme_link(stdClass $instance) {
- return false;
- }
- /**
- * Attempt to automatically enrol current user in course without any interaction,
- * calling code has to make sure the plugin and instance are active.
- *
- * This should return either a timestamp in the future or false.
- *
- * @param stdClass $instance course enrol instance
- * @return bool|int false means not enrolled, integer means timeend
- */
- public function try_autoenrol(stdClass $instance) {
- global $USER;
- return false;
- }
- /**
- * Attempt to automatically gain temporary guest access to course,
- * calling code has to make sure the plugin and instance are active.
- *
- * This should return either a timestamp in the future or false.
- *
- * @param stdClass $instance course enrol instance
- * @return bool|int false means no guest access, integer means timeend
- */
- public function try_guestaccess(stdClass $instance) {
- global $USER;
- return false;
- }
- /**
- * Enrol user into course via enrol instance.
- *
- * @param stdClass $instance
- * @param int $userid
- * @param int $roleid optional role id
- * @param int $timestart 0 means unknown
- * @param int $timeend 0 means forever
- * @param int $status default to ENROL_USER_ACTIVE for new enrolments, no change by default in updates
- * @param bool $recovergrades restore grade history
- * @return void
- */
- public function enrol_user(stdClass $instance, $userid, $roleid = null, $timestart = 0, $timeend = 0, $status = null, $recovergrades = null) {
- global $DB, $USER, $CFG; // CFG necessary!!!
- if ($instance->courseid == SITEID) {
- throw new coding_exception('invalid attempt to enrol into frontpage course!');
- }
- $name = $this->get_name();
- $courseid = $instance->courseid;
- if ($instance->enrol !== $name) {
- throw new coding_exception('invalid enrol instance!');
- }
- $context = context_course::instance($instance->courseid, MUST_EXIST);
- if (!isset($recovergrades)) {
- $recovergrades = $CFG->recovergradesdefault;
- }
- $inserted = false;
- $updated = false;
- if ($ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
- //only update if timestart or timeend or status are different.
- if ($ue->timestart != $timestart or $ue->timeend != $timeend or (!is_null($status) and $ue->status != $status)) {
- $this->update_user_enrol($instance, $userid, $status, $timestart, $timeend);
- }
- } else {
- $ue = new stdClass();
- $ue->enrolid = $instance->id;
- $ue->status = is_null($status) ? ENROL_USER_ACTIVE : $status;
- $ue->userid = $userid;
- $ue->timestart = $timestart;
- $ue->timeend = $timeend;
- $ue->modifierid = $USER->id;
- $ue->timecreated = time();
- $ue->timemodified = $ue->timecreated;
- $ue->id = $DB->insert_record('user_enrolments', $ue);
- $inserted = true;
- }
- if ($inserted) {
- // Trigger event.
- $event = \core\event\user_enrolment_created::create(
- array(
- 'objectid' => $ue->id,
- 'courseid' => $courseid,
- 'context' => $context,
- 'relateduserid' => $ue->userid,
- 'other' => array('enrol' => $name)
- )
- );
- $event->trigger();
- }
- if ($roleid) {
- // this must be done after the enrolment event so that the role_assigned event is triggered afterwards
- if ($this->roles_protected()) {
- role_assign($roleid, $userid, $context->id, 'enrol_'.$name, $instance->id);
- } else {
- role_assign($roleid, $userid, $context->id);
- }
- }
- // Recover old grades if present.
- if ($recovergrades) {
- require_once("$CFG->libdir/gradelib.php");
- grade_recover_history_grades($userid, $courseid);
- }
- // reset current user enrolment caching
- if ($userid == $USER->id) {
- if (isset($USER->enrol['enrolled'][$courseid])) {
- unset($USER->enrol['enrolled'][$courseid]);
- }
- if (isset($USER->enrol['tempguest'][$courseid])) {
- unset($USER->enrol['tempguest'][$courseid]);
- remove_temp_course_roles($context);
- }
- }
- }
- /**
- * Store user_enrolments changes and trigger event.
- *
- * @param stdClass $instance
- * @param int $userid
- * @param int $status
- * @param int $timestart
- * @param int $timeend
- * @return void
- */
- public function update_user_enrol(stdClass $instance, $userid, $status = NULL, $timestart = NULL, $timeend = NULL) {
- global $DB, $USER;
- $name = $this->get_name();
- if ($instance->enrol !== $name) {
- throw new coding_exception('invalid enrol instance!');
- }
- if (!$ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
- // weird, user not enrolled
- return;
- }
- $modified = false;
- if (isset($status) and $ue->status != $status) {
- $ue->status = $status;
- $modified = true;
- }
- if (isset($timestart) and $ue->timestart != $timestart) {
- $ue->timestart = $timestart;
- $modified = true;
- }
- if (isset($timeend) and $ue->timeend != $timeend) {
- $ue->timeend = $timeend;
- $modified = true;
- }
- if (!$modified) {
- // no change
- return;
- }
- $ue->modifierid = $USER->id;
- $DB->update_record('user_enrolments', $ue);
- context_course::instance($instance->courseid)->mark_dirty(); // reset enrol caches
- // Invalidate core_access cache for get_suspended_userids.
- cache_helper::invalidate_by_definition('core', 'suspended_userids', array(), array($instance->courseid));
- // Trigger event.
- $event = \core\event\user_enrolment_updated::create(
- array(
- 'objectid' => $ue->id,
- 'courseid' => $instance->courseid,
- 'context' => context_course::instance($instance->courseid),
- 'relateduserid' => $ue->userid,
- 'other' => array('enrol' => $name)
- )
- );
- $event->trigger();
- }
- /**
- * Unenrol user from course,
- * the last unenrolment removes all remaining roles.
- *
- * @param stdClass $instance
- * @param int $userid
- * @return void
- */
- public function unenrol_user(stdClass $instance, $userid) {
- global $CFG, $USER, $DB;
- require_once("$CFG->dirroot/group/lib.php");
- $name = $this->get_name();
- $courseid = $instance->courseid;
- if ($instance->enrol !== $name) {
- throw new coding_exception('invalid enrol instance!');
- }
- $context = context_course::instance($instance->courseid, MUST_EXIST);
- if (!$ue = $DB->get_record('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
- // weird, user not enrolled
- return;
- }
- // Remove all users groups linked to this enrolment instance.
- if ($gms = $DB->get_records('groups_members', array('userid'=>$userid, 'component'=>'enrol_'.$name, 'itemid'=>$instance->id))) {
- foreach ($gms as $gm) {
- groups_remove_member($gm->groupid, $gm->userid);
- }
- }
- role_unassign_all(array('userid'=>$userid, 'contextid'=>$context->id, 'component'=>'enrol_'.$name, 'itemid'=>$instance->id));
- $DB->delete_records('user_enrolments', array('id'=>$ue->id));
- // add extra info and trigger event
- $ue->courseid = $courseid;
- $ue->enrol = $name;
- $sql = "SELECT 'x'
- FROM {user_enrolments} ue
- JOIN {enrol} e ON (e.id = ue.enrolid)
- WHERE ue.userid = :userid AND e.courseid = :courseid";
- if ($DB->record_exists_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid))) {
- $ue->lastenrol = false;
- } …
Large files files are truncated, but you can click here to view the full file