mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
399 lines
15 KiB
PHP
399 lines
15 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
|
|
* @subpackage 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 object $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, get_context_instance(CONTEXT_COURSE, $instance->courseid)) . ')';
|
|
} 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) {
|
|
return ($instance->status == ENROL_INSTANCE_ENABLED);
|
|
}
|
|
|
|
/**
|
|
* Sets up navigation entries.
|
|
*
|
|
* @param object $instance
|
|
* @return void
|
|
*/
|
|
public function add_course_navigation($instancesnode, stdClass $instance) {
|
|
if ($instance->enrol !== 'self') {
|
|
throw new coding_exception('Invalid enrol instance type!');
|
|
}
|
|
|
|
$context = get_context_instance(CONTEXT_COURSE, $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 = get_context_instance(CONTEXT_COURSE, $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 = get_context_instance(CONTEXT_COURSE, $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->customint3 > 0) {
|
|
// max enrol limit specified
|
|
$count = $DB->count_records('user_enrolments', array('enrolid'=>$instance->id));
|
|
if ($count >= $instance->customint3) {
|
|
// bad luck, no more self enrolments here
|
|
return $OUTPUT->notification(get_string('maxenrolledreached', 'enrol_self'));
|
|
}
|
|
}
|
|
|
|
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); //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
|
|
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 object $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'),
|
|
'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 object $instance
|
|
* @param object $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);
|
|
|
|
$a = new stdClass();
|
|
$a->coursename = format_string($course->fullname);
|
|
$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);
|
|
} else {
|
|
$message = get_string('welcometocoursetext', 'enrol_self', $a);
|
|
}
|
|
|
|
$subject = get_string('welcometocourse', 'enrol_self', format_string($course->fullname));
|
|
|
|
$context = get_context_instance(CONTEXT_COURSE, $course->id);
|
|
$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 = get_admin();
|
|
}
|
|
|
|
//directly emailing welcome message rather than using messaging
|
|
email_to_user($user, $contact, $subject, $message);
|
|
}
|
|
|
|
/**
|
|
* 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/self/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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Indicates API features that the enrol plugin supports.
|
|
*
|
|
* @param string $feature
|
|
* @return mixed True if yes (some features may use other values)
|
|
*/
|
|
function enrol_self_supports($feature) {
|
|
switch($feature) {
|
|
case ENROL_RESTORE_TYPE: return ENROL_RESTORE_EXACT;
|
|
|
|
default: return null;
|
|
}
|
|
}
|