mirror of
https://github.com/moodle/moodle.git
synced 2025-08-07 01:46:45 +02:00
7a7b8a1f19
Includes option to convert all enrolments to enrol_manual instances, support for mapping of custom fields and fixes for several other problems. This does not include support for custom enrol tables, it will be addressed in another issue.
470 lines
18 KiB
PHP
470 lines
18 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Self enrolment plugin.
|
|
*
|
|
* @package enrol_self
|
|
* @copyright 2010 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* Self enrolment plugin implementation.
|
|
* @author Petr Skoda
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class enrol_self_plugin extends enrol_plugin {
|
|
|
|
/**
|
|
* 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) {
|
|
$key = false;
|
|
$nokey = false;
|
|
foreach ($instances as $instance) {
|
|
if ($instance->password or $instance->customint1) {
|
|
$key = true;
|
|
} else {
|
|
$nokey = true;
|
|
}
|
|
}
|
|
$icons = array();
|
|
if ($nokey) {
|
|
$icons[] = new pix_icon('withoutkey', get_string('pluginname', 'enrol_self'), 'enrol_self');
|
|
}
|
|
if ($key) {
|
|
$icons[] = new pix_icon('withkey', get_string('pluginname', 'enrol_self'), 'enrol_self');
|
|
}
|
|
return $icons;
|
|
}
|
|
|
|
/**
|
|
* Returns localised name of enrol instance
|
|
*
|
|
* @param stdClass $instance (null is accepted too)
|
|
* @return string
|
|
*/
|
|
public function get_instance_name($instance) {
|
|
global $DB;
|
|
|
|
if (empty($instance->name)) {
|
|
if (!empty($instance->roleid) and $role = $DB->get_record('role', array('id'=>$instance->roleid))) {
|
|
$role = ' (' . role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING)) . ')';
|
|
} else {
|
|
$role = '';
|
|
}
|
|
$enrol = $this->get_name();
|
|
return get_string('pluginname', 'enrol_'.$enrol) . $role;
|
|
} else {
|
|
return format_string($instance->name);
|
|
}
|
|
}
|
|
|
|
public function roles_protected() {
|
|
// Users may tweak the roles later.
|
|
return false;
|
|
}
|
|
|
|
public function allow_unenrol(stdClass $instance) {
|
|
// Users with unenrol cap may unenrol other users manually manually.
|
|
return true;
|
|
}
|
|
|
|
public function allow_manage(stdClass $instance) {
|
|
// Users with manage cap may tweak period and status.
|
|
return true;
|
|
}
|
|
|
|
public function show_enrolme_link(stdClass $instance) {
|
|
global $CFG, $USER;
|
|
|
|
if ($instance->status != ENROL_INSTANCE_ENABLED) {
|
|
return false;
|
|
}
|
|
if ($instance->customint5) {
|
|
require_once("$CFG->dirroot/cohort/lib.php");
|
|
return cohort_is_member($instance->customint5, $USER->id);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Sets up navigation entries.
|
|
*
|
|
* @param stdClass $instancesnode
|
|
* @param stdClass $instance
|
|
* @return void
|
|
*/
|
|
public function add_course_navigation($instancesnode, stdClass $instance) {
|
|
if ($instance->enrol !== 'self') {
|
|
throw new coding_exception('Invalid enrol instance type!');
|
|
}
|
|
|
|
$context = context_course::instance($instance->courseid);
|
|
if (has_capability('enrol/self:config', $context)) {
|
|
$managelink = new moodle_url('/enrol/self/edit.php', array('courseid'=>$instance->courseid, 'id'=>$instance->id));
|
|
$instancesnode->add($this->get_instance_name($instance), $managelink, navigation_node::TYPE_SETTING);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns edit icons for the page with list of instances
|
|
* @param stdClass $instance
|
|
* @return array
|
|
*/
|
|
public function get_action_icons(stdClass $instance) {
|
|
global $OUTPUT;
|
|
|
|
if ($instance->enrol !== 'self') {
|
|
throw new coding_exception('invalid enrol instance!');
|
|
}
|
|
$context = context_course::instance($instance->courseid);
|
|
|
|
$icons = array();
|
|
|
|
if (has_capability('enrol/self:config', $context)) {
|
|
$editlink = new moodle_url("/enrol/self/edit.php", array('courseid'=>$instance->courseid, 'id'=>$instance->id));
|
|
$icons[] = $OUTPUT->action_icon($editlink, new pix_icon('i/edit', get_string('edit'), 'core', array('class'=>'icon')));
|
|
}
|
|
|
|
return $icons;
|
|
}
|
|
|
|
/**
|
|
* Returns link to page which may be used to add new instance of enrolment plugin in course.
|
|
* @param int $courseid
|
|
* @return moodle_url page url
|
|
*/
|
|
public function get_newinstance_link($courseid) {
|
|
$context = context_course::instance($courseid, MUST_EXIST);
|
|
|
|
if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/self:config', $context)) {
|
|
return NULL;
|
|
}
|
|
// Multiple instances supported - different roles with different password.
|
|
return new moodle_url('/enrol/self/edit.php', array('courseid'=>$courseid));
|
|
}
|
|
|
|
/**
|
|
* Creates course enrol form, checks if form submitted
|
|
* and enrols user if necessary. It can also redirect.
|
|
*
|
|
* @param stdClass $instance
|
|
* @return string html text, usually a form in a text box
|
|
*/
|
|
public function enrol_page_hook(stdClass $instance) {
|
|
global $CFG, $OUTPUT, $SESSION, $USER, $DB;
|
|
|
|
if (isguestuser()) {
|
|
// Can not enrol guest!!
|
|
return null;
|
|
}
|
|
if ($DB->record_exists('user_enrolments', array('userid'=>$USER->id, 'enrolid'=>$instance->id))) {
|
|
//TODO: maybe we should tell them they are already enrolled, but can not access the course
|
|
return null;
|
|
}
|
|
|
|
if ($instance->enrolstartdate != 0 and $instance->enrolstartdate > time()) {
|
|
//TODO: inform that we can not enrol yet
|
|
return null;
|
|
}
|
|
|
|
if ($instance->enrolenddate != 0 and $instance->enrolenddate < time()) {
|
|
//TODO: inform that enrolment is not possible any more
|
|
return null;
|
|
}
|
|
|
|
if ($instance->customint5) {
|
|
require_once("$CFG->dirroot/cohort/lib.php");
|
|
if (!cohort_is_member($instance->customint5, $USER->id)) {
|
|
$cohort = $DB->get_record('cohort', array('id'=>$instance->customint5));
|
|
if (!$cohort) {
|
|
return null;
|
|
}
|
|
$a = format_string($cohort->name, true, array('context'=>context::instance_by_id($cohort->contextid)));
|
|
return $OUTPUT->box(markdown_to_html(get_string('cohortnonmemberinfo', 'enrol_self', $a)));
|
|
}
|
|
}
|
|
|
|
require_once("$CFG->dirroot/enrol/self/locallib.php");
|
|
require_once("$CFG->dirroot/group/lib.php");
|
|
|
|
$form = new enrol_self_enrol_form(NULL, $instance);
|
|
$instanceid = optional_param('instance', 0, PARAM_INT);
|
|
|
|
if ($instance->id == $instanceid) {
|
|
if ($data = $form->get_data()) {
|
|
$enrol = enrol_get_plugin('self');
|
|
$timestart = time();
|
|
if ($instance->enrolperiod) {
|
|
$timeend = $timestart + $instance->enrolperiod;
|
|
} else {
|
|
$timeend = 0;
|
|
}
|
|
|
|
$this->enrol_user($instance, $USER->id, $instance->roleid, $timestart, $timeend);
|
|
add_to_log($instance->courseid, 'course', 'enrol', '../enrol/users.php?id='.$instance->courseid, $instance->courseid); //TODO: There should be userid somewhere!
|
|
|
|
if ($instance->password and $instance->customint1 and $data->enrolpassword !== $instance->password) {
|
|
// it must be a group enrolment, let's assign group too
|
|
$groups = $DB->get_records('groups', array('courseid'=>$instance->courseid), 'id', 'id, enrolmentkey');
|
|
foreach ($groups as $group) {
|
|
if (empty($group->enrolmentkey)) {
|
|
continue;
|
|
}
|
|
if ($group->enrolmentkey === $data->enrolpassword) {
|
|
groups_add_member($group->id, $USER->id);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
// Send welcome message.
|
|
if ($instance->customint4) {
|
|
$this->email_welcome_message($instance, $USER);
|
|
}
|
|
}
|
|
}
|
|
|
|
ob_start();
|
|
$form->display();
|
|
$output = ob_get_clean();
|
|
|
|
return $OUTPUT->box($output);
|
|
}
|
|
|
|
/**
|
|
* Add new instance of enrol plugin with default settings.
|
|
* @param stdClass $course
|
|
* @return int id of new instance
|
|
*/
|
|
public function add_default_instance($course) {
|
|
$fields = array('customint1' => $this->get_config('groupkey'),
|
|
'customint2' => $this->get_config('longtimenosee'),
|
|
'customint3' => $this->get_config('maxenrolled'),
|
|
'customint4' => $this->get_config('sendcoursewelcomemessage'),
|
|
'customint5' => 0,
|
|
'enrolperiod' => $this->get_config('enrolperiod', 0),
|
|
'status' => $this->get_config('status'),
|
|
'roleid' => $this->get_config('roleid', 0));
|
|
|
|
if ($this->get_config('requirepassword')) {
|
|
$fields['password'] = generate_password(20);
|
|
}
|
|
|
|
return $this->add_instance($course, $fields);
|
|
}
|
|
|
|
/**
|
|
* Send welcome email to specified user.
|
|
*
|
|
* @param stdClass $instance
|
|
* @param stdClass $user user record
|
|
* @return void
|
|
*/
|
|
protected function email_welcome_message($instance, $user) {
|
|
global $CFG, $DB;
|
|
|
|
$course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
|
|
$context = context_course::instance($course->id);
|
|
|
|
$a = new stdClass();
|
|
$a->coursename = format_string($course->fullname, true, array('context'=>$context));
|
|
$a->profileurl = "$CFG->wwwroot/user/view.php?id=$user->id&course=$course->id";
|
|
|
|
if (trim($instance->customtext1) !== '') {
|
|
$message = $instance->customtext1;
|
|
$message = str_replace('{$a->coursename}', $a->coursename, $message);
|
|
$message = str_replace('{$a->profileurl}', $a->profileurl, $message);
|
|
if (strpos($message, '<') === false) {
|
|
// Plain text only.
|
|
$messagetext = $message;
|
|
$messagehtml = text_to_html($messagetext, null, false, true);
|
|
} else {
|
|
// This is most probably the tag/newline soup known as FORMAT_MOODLE.
|
|
$messagehtml = format_text($message, FORMAT_MOODLE, array('context'=>$context, 'para'=>false, 'newlines'=>true, 'filter'=>true));
|
|
$messagetext = html_to_text($messagehtml);
|
|
}
|
|
} else {
|
|
$messagetext = get_string('welcometocoursetext', 'enrol_self', $a);
|
|
$messagehtml = text_to_html($messagetext, null, false, true);
|
|
}
|
|
|
|
$subject = get_string('welcometocourse', 'enrol_self', format_string($course->fullname, true, array('context'=>$context)));
|
|
|
|
$rusers = array();
|
|
if (!empty($CFG->coursecontact)) {
|
|
$croles = explode(',', $CFG->coursecontact);
|
|
$rusers = get_role_users($croles, $context, true, '', 'r.sortorder ASC, u.lastname ASC');
|
|
}
|
|
if ($rusers) {
|
|
$contact = reset($rusers);
|
|
} else {
|
|
$contact = generate_email_supportuser();
|
|
}
|
|
|
|
// Directly emailing welcome message rather than using messaging.
|
|
email_to_user($user, $contact, $subject, $messagetext, $messagehtml);
|
|
}
|
|
|
|
/**
|
|
* Enrol self cron support.
|
|
* @return void
|
|
*/
|
|
public function cron() {
|
|
global $DB;
|
|
|
|
if (!enrol_is_enabled('self')) {
|
|
return;
|
|
}
|
|
|
|
$plugin = enrol_get_plugin('self');
|
|
|
|
$now = time();
|
|
|
|
// Note: the logic of self enrolment guarantees that user logged in at least once (=== u.lastaccess set)
|
|
// and that user accessed course at least once too (=== user_lastaccess record exists).
|
|
|
|
// First deal with users that did not log in for a really long time.
|
|
$sql = "SELECT e.*, ue.userid
|
|
FROM {user_enrolments} ue
|
|
JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
|
|
JOIN {user} u ON u.id = ue.userid
|
|
WHERE :now - u.lastaccess > e.customint2";
|
|
$rs = $DB->get_recordset_sql($sql, array('now'=>$now));
|
|
foreach ($rs as $instance) {
|
|
$userid = $instance->userid;
|
|
unset($instance->userid);
|
|
$plugin->unenrol_user($instance, $userid);
|
|
mtrace("unenrolling user $userid from course $instance->courseid as they have did not log in for $instance->customint2 days");
|
|
}
|
|
$rs->close();
|
|
|
|
// Now unenrol from course user did not visit for a long time.
|
|
$sql = "SELECT e.*, ue.userid
|
|
FROM {user_enrolments} ue
|
|
JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
|
|
JOIN {user_lastaccess} ul ON (ul.userid = ue.userid AND ul.courseid = e.courseid)
|
|
WHERE :now - ul.timeaccess > e.customint2";
|
|
$rs = $DB->get_recordset_sql($sql, array('now'=>$now));
|
|
foreach ($rs as $instance) {
|
|
$userid = $instance->userid;
|
|
unset($instance->userid);
|
|
$plugin->unenrol_user($instance, $userid);
|
|
mtrace("unenrolling user $userid from course $instance->courseid as they have did not access course for $instance->customint2 days");
|
|
}
|
|
$rs->close();
|
|
|
|
flush();
|
|
}
|
|
|
|
/**
|
|
* Gets an array of the user enrolment actions.
|
|
*
|
|
* @param course_enrolment_manager $manager
|
|
* @param stdClass $ue A user enrolment object
|
|
* @return array An array of user_enrolment_actions
|
|
*/
|
|
public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
|
|
$actions = array();
|
|
$context = $manager->get_context();
|
|
$instance = $ue->enrolmentinstance;
|
|
$params = $manager->get_moodlepage()->url->params();
|
|
$params['ue'] = $ue->id;
|
|
if ($this->allow_unenrol($instance) && has_capability("enrol/self:unenrol", $context)) {
|
|
$url = new moodle_url('/enrol/unenroluser.php', $params);
|
|
$actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
|
|
}
|
|
if ($this->allow_manage($instance) && has_capability("enrol/self:manage", $context)) {
|
|
$url = new moodle_url('/enrol/self/editenrolment.php', $params);
|
|
$actions[] = new user_enrolment_action(new pix_icon('t/edit', ''), get_string('edit'), $url, array('class'=>'editenrollink', 'rel'=>$ue->id));
|
|
}
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* Restore instance and map settings.
|
|
*
|
|
* @param restore_enrolments_structure_step $step
|
|
* @param stdClass $data
|
|
* @param stdClass $course
|
|
* @param int $oldid
|
|
*/
|
|
public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
|
|
global $DB;
|
|
if ($step->get_task()->get_target() == backup::TARGET_NEW_COURSE) {
|
|
$merge = false;
|
|
} else {
|
|
$merge = array(
|
|
'courseid' => $data->courseid,
|
|
'enrol' => $this->get_name(),
|
|
'roleid' => $data->roleid,
|
|
);
|
|
}
|
|
if ($merge and $instances = $DB->get_records('enrol', $merge, 'id')) {
|
|
$instance = reset($instances);
|
|
$instanceid = $instance->id;
|
|
} else {
|
|
if (!empty($data->customint5)) {
|
|
if ($step->get_task()->is_samesite()) {
|
|
// Keep cohort restriction unchanged - we are on the same site.
|
|
} else {
|
|
// Use some id that can not exist in order to prevent self enrolment,
|
|
// because we do not know what cohort it is in this site.
|
|
$data->customint5 = -1;
|
|
}
|
|
}
|
|
$instanceid = $this->add_instance($course, (array)$data);
|
|
}
|
|
$step->set_mapping('enrol', $oldid, $instanceid);
|
|
}
|
|
|
|
/**
|
|
* Restore user enrolment.
|
|
*
|
|
* @param restore_enrolments_structure_step $step
|
|
* @param stdClass $data
|
|
* @param stdClass $instance
|
|
* @param int $oldinstancestatus
|
|
* @param int $userid
|
|
*/
|
|
public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
|
|
$this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
|
|
}
|
|
|
|
/**
|
|
* Restore role assignment.
|
|
*
|
|
* @param stdClass $instance
|
|
* @param int $roleid
|
|
* @param int $userid
|
|
* @param int $contextid
|
|
*/
|
|
public function restore_role_assignment($instance, $roleid, $userid, $contextid) {
|
|
// This is necessary only because we may migrate other types to this instance,
|
|
// we do not use component in manual or self enrol.
|
|
role_assign($roleid, $userid, $contextid, '', 0);
|
|
}
|
|
}
|