6dca20b70cf0cf69e08d6f78a706efa83a3bb80e
[moodle.git] / enrol / self / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Self enrolment plugin.
19  *
20  * @package    enrol_self
21  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Self enrolment plugin implementation.
27  * @author Petr Skoda
28  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
30 class enrol_self_plugin extends enrol_plugin {
32     protected $lasternoller = null;
33     protected $lasternollerinstanceid = 0;
35     /**
36      * Returns optional enrolment information icons.
37      *
38      * This is used in course list for quick overview of enrolment options.
39      *
40      * We are not using single instance parameter because sometimes
41      * we might want to prevent icon repetition when multiple instances
42      * of one type exist. One instance may also produce several icons.
43      *
44      * @param array $instances all enrol instances of this type in one course
45      * @return array of pix_icon
46      */
47     public function get_info_icons(array $instances) {
48         $key = false;
49         $nokey = false;
50         foreach ($instances as $instance) {
51             if ($this->can_self_enrol($instance, false) !== true) {
52                 // User can not enrol himself.
53                 // Note that we do not check here if user is already enrolled for performance reasons -
54                 // such check would execute extra queries for each course in the list of courses and
55                 // would hide self-enrolment icons from guests.
56                 continue;
57             }
58             if ($instance->password or $instance->customint1) {
59                 $key = true;
60             } else {
61                 $nokey = true;
62             }
63         }
64         $icons = array();
65         if ($nokey) {
66             $icons[] = new pix_icon('withoutkey', get_string('pluginname', 'enrol_self'), 'enrol_self');
67         }
68         if ($key) {
69             $icons[] = new pix_icon('withkey', get_string('pluginname', 'enrol_self'), 'enrol_self');
70         }
71         return $icons;
72     }
74     /**
75      * Returns localised name of enrol instance
76      *
77      * @param stdClass $instance (null is accepted too)
78      * @return string
79      */
80     public function get_instance_name($instance) {
81         global $DB;
83         if (empty($instance->name)) {
84             if (!empty($instance->roleid) and $role = $DB->get_record('role', array('id'=>$instance->roleid))) {
85                 $role = ' (' . role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING)) . ')';
86             } else {
87                 $role = '';
88             }
89             $enrol = $this->get_name();
90             return get_string('pluginname', 'enrol_'.$enrol) . $role;
91         } else {
92             return format_string($instance->name);
93         }
94     }
96     public function roles_protected() {
97         // Users may tweak the roles later.
98         return false;
99     }
101     public function allow_unenrol(stdClass $instance) {
102         // Users with unenrol cap may unenrol other users manually manually.
103         return true;
104     }
106     public function allow_manage(stdClass $instance) {
107         // Users with manage cap may tweak period and status.
108         return true;
109     }
111     public function show_enrolme_link(stdClass $instance) {
113         if (true !== $this->can_self_enrol($instance, false)) {
114             return false;
115         }
117         return true;
118     }
120     /**
121      * Sets up navigation entries.
122      *
123      * @param stdClass $instancesnode
124      * @param stdClass $instance
125      * @return void
126      */
127     public function add_course_navigation($instancesnode, stdClass $instance) {
128         if ($instance->enrol !== 'self') {
129              throw new coding_exception('Invalid enrol instance type!');
130         }
132         $context = context_course::instance($instance->courseid);
133         if (has_capability('enrol/self:config', $context)) {
134             $managelink = new moodle_url('/enrol/self/edit.php', array('courseid'=>$instance->courseid, 'id'=>$instance->id));
135             $instancesnode->add($this->get_instance_name($instance), $managelink, navigation_node::TYPE_SETTING);
136         }
137     }
139     /**
140      * Returns edit icons for the page with list of instances
141      * @param stdClass $instance
142      * @return array
143      */
144     public function get_action_icons(stdClass $instance) {
145         global $OUTPUT;
147         if ($instance->enrol !== 'self') {
148             throw new coding_exception('invalid enrol instance!');
149         }
150         $context = context_course::instance($instance->courseid);
152         $icons = array();
154         if (has_capability('enrol/self:config', $context)) {
155             $editlink = new moodle_url("/enrol/self/edit.php", array('courseid'=>$instance->courseid, 'id'=>$instance->id));
156             $icons[] = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', get_string('edit'), 'core',
157                 array('class' => 'iconsmall')));
158         }
160         return $icons;
161     }
163     /**
164      * Returns link to page which may be used to add new instance of enrolment plugin in course.
165      * @param int $courseid
166      * @return moodle_url page url
167      */
168     public function get_newinstance_link($courseid) {
169         $context = context_course::instance($courseid, MUST_EXIST);
171         if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/self:config', $context)) {
172             return NULL;
173         }
174         // Multiple instances supported - different roles with different password.
175         return new moodle_url('/enrol/self/edit.php', array('courseid'=>$courseid));
176     }
178     /**
179      * Self enrol user to course
180      *
181      * @param stdClass $instance enrolment instance
182      * @param stdClass $data data needed for enrolment.
183      * @return bool|array true if enroled else eddor code and messege
184      */
185     public function enrol_self(stdClass $instance, $data = null) {
186         global $DB, $USER, $CFG;
188         // Don't enrol user if password is not passed when required.
189         if ($instance->password && !isset($data->enrolpassword)) {
190             return;
191         }
193         $timestart = time();
194         if ($instance->enrolperiod) {
195             $timeend = $timestart + $instance->enrolperiod;
196         } else {
197             $timeend = 0;
198         }
200         $this->enrol_user($instance, $USER->id, $instance->roleid, $timestart, $timeend);
202         if ($instance->password and $instance->customint1 and $data->enrolpassword !== $instance->password) {
203             // It must be a group enrolment, let's assign group too.
204             $groups = $DB->get_records('groups', array('courseid'=>$instance->courseid), 'id', 'id, enrolmentkey');
205             foreach ($groups as $group) {
206                 if (empty($group->enrolmentkey)) {
207                     continue;
208                 }
209                 if ($group->enrolmentkey === $data->enrolpassword) {
210                     // Add user to group.
211                     require_once($CFG->dirroot.'/group/lib.php');
212                     groups_add_member($group->id, $USER->id);
213                     break;
214                 }
215             }
216         }
217         // Send welcome message.
218         if ($instance->customint4) {
219             $this->email_welcome_message($instance, $USER);
220         }
221     }
223     /**
224      * Creates course enrol form, checks if form submitted
225      * and enrols user if necessary. It can also redirect.
226      *
227      * @param stdClass $instance
228      * @return string html text, usually a form in a text box
229      */
230     public function enrol_page_hook(stdClass $instance) {
231         global $CFG, $OUTPUT, $USER;
233         require_once("$CFG->dirroot/enrol/self/locallib.php");
235         $enrolstatus = $this->can_self_enrol($instance);
237         if (true === $enrolstatus) {
238             // This user can self enrol using this instance.
239             $form = new enrol_self_enrol_form(NULL, $instance);
240             $instanceid = optional_param('instance', 0, PARAM_INT);
241             if ($instance->id == $instanceid) {
242                 if ($data = $form->get_data()) {
243                     $this->enrol_self($instance, $data);
244                 }
245             }
246         } else {
247             // This user can not self enrol using this instance. Using an empty form to keep
248             // the UI consistent with other enrolment plugins that returns a form.
249             $data = new stdClass();
250             $data->header = $this->get_instance_name($instance);
251             $data->info = $enrolstatus;
252             $form = new enrol_self_empty_form(null, $data);
253         }
255         ob_start();
256         $form->display();
257         $output = ob_get_clean();
258         return $OUTPUT->box($output);
259     }
261     /**
262      * Checks if user can self enrol.
263      *
264      * @param stdClass $instance enrolment instance
265      * @param bool $checkuserenrolment if true will check if user enrolment is inactive.
266      *             used by navigation to improve performance.
267      * @return bool|string true if successful, else error message or false.
268      */
269     public function can_self_enrol(stdClass $instance, $checkuserenrolment = true) {
270         global $CFG, $DB, $OUTPUT, $USER;
272         if ($checkuserenrolment) {
273             if (isguestuser()) {
274                 // Can not enrol guest.
275                 return get_string('noguestaccess', 'enrol') . $OUTPUT->continue_button(get_login_url());
276             }
277             // Check if user is already enroled.
278             if ($DB->get_record('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
279                 return get_string('canntenrol', 'enrol_self');
280             }
281         }
283         if ($instance->status != ENROL_INSTANCE_ENABLED) {
284             return get_string('canntenrol', 'enrol_self');
285         }
287         if ($instance->enrolstartdate != 0 and $instance->enrolstartdate > time()) {
288             return get_string('canntenrol', 'enrol_self');
289         }
291         if ($instance->enrolenddate != 0 and $instance->enrolenddate < time()) {
292             return get_string('canntenrol', 'enrol_self');
293         }
295         if (!$instance->customint6) {
296             // New enrols not allowed.
297             return get_string('canntenrol', 'enrol_self');
298         }
300         if ($DB->record_exists('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
301             return get_string('canntenrol', 'enrol_self');
302         }
304         if ($instance->customint3 > 0) {
305             // Max enrol limit specified.
306             $count = $DB->count_records('user_enrolments', array('enrolid' => $instance->id));
307             if ($count >= $instance->customint3) {
308                 // Bad luck, no more self enrolments here.
309                 return get_string('maxenrolledreached', 'enrol_self');
310             }
311         }
313         if ($instance->customint5) {
314             require_once("$CFG->dirroot/cohort/lib.php");
315             if (!cohort_is_member($instance->customint5, $USER->id)) {
316                 $cohort = $DB->get_record('cohort', array('id' => $instance->customint5));
317                 if (!$cohort) {
318                     return null;
319                 }
320                 $a = format_string($cohort->name, true, array('context' => context::instance_by_id($cohort->contextid)));
321                 return markdown_to_html(get_string('cohortnonmemberinfo', 'enrol_self', $a));
322             }
323         }
325         return true;
326     }
328     /**
329      * Return information for enrolment instance containing list of parameters required
330      * for enrolment, name of enrolment plugin etc.
331      *
332      * @param stdClass $instance enrolment instance
333      * @return stdClass instance info.
334      */
335     public function get_enrol_info(stdClass $instance) {
337         $instanceinfo = new stdClass();
338         $instanceinfo->id = $instance->id;
339         $instanceinfo->courseid = $instance->courseid;
340         $instanceinfo->type = $this->get_name();
341         $instanceinfo->name = $this->get_instance_name($instance);
342         $instanceinfo->status = $this->can_self_enrol($instance);
344         if ($instance->password) {
345             $instanceinfo->requiredparam = new stdClass();
346             $instanceinfo->requiredparam->enrolpassword = get_string('password', 'enrol_self');
347         }
349         // If enrolment is possible and password is required then return ws function name to get more information.
350         if ((true === $instanceinfo->status) && $instance->password) {
351             $instanceinfo->wsfunction = 'enrol_self_get_instance_info';
352         }
353         return $instanceinfo;
354     }
356     /**
357      * Add new instance of enrol plugin with default settings.
358      * @param stdClass $course
359      * @return int id of new instance
360      */
361     public function add_default_instance($course) {
362         $fields = $this->get_instance_defaults();
364         if ($this->get_config('requirepassword')) {
365             $fields['password'] = generate_password(20);
366         }
368         return $this->add_instance($course, $fields);
369     }
371     /**
372      * Returns defaults for new instances.
373      * @return array
374      */
375     public function get_instance_defaults() {
376         $expirynotify = $this->get_config('expirynotify');
377         if ($expirynotify == 2) {
378             $expirynotify = 1;
379             $notifyall = 1;
380         } else {
381             $notifyall = 0;
382         }
384         $fields = array();
385         $fields['status']          = $this->get_config('status');
386         $fields['roleid']          = $this->get_config('roleid');
387         $fields['enrolperiod']     = $this->get_config('enrolperiod');
388         $fields['expirynotify']    = $expirynotify;
389         $fields['notifyall']       = $notifyall;
390         $fields['expirythreshold'] = $this->get_config('expirythreshold');
391         $fields['customint1']      = $this->get_config('groupkey');
392         $fields['customint2']      = $this->get_config('longtimenosee');
393         $fields['customint3']      = $this->get_config('maxenrolled');
394         $fields['customint4']      = $this->get_config('sendcoursewelcomemessage');
395         $fields['customint5']      = 0;
396         $fields['customint6']      = $this->get_config('newenrols');
398         return $fields;
399     }
401     /**
402      * Send welcome email to specified user.
403      *
404      * @param stdClass $instance
405      * @param stdClass $user user record
406      * @return void
407      */
408     protected function email_welcome_message($instance, $user) {
409         global $CFG, $DB;
411         $course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
412         $context = context_course::instance($course->id);
414         $a = new stdClass();
415         $a->coursename = format_string($course->fullname, true, array('context'=>$context));
416         $a->profileurl = "$CFG->wwwroot/user/view.php?id=$user->id&course=$course->id";
418         if (trim($instance->customtext1) !== '') {
419             $message = $instance->customtext1;
420             $key = array('{$a->coursename}', '{$a->profileurl}', '{$a->fullname}', '{$a->email}');
421             $value = array($a->coursename, $a->profileurl, fullname($user), $user->email);
422             $message = str_replace($key, $value, $message);
423             if (strpos($message, '<') === false) {
424                 // Plain text only.
425                 $messagetext = $message;
426                 $messagehtml = text_to_html($messagetext, null, false, true);
427             } else {
428                 // This is most probably the tag/newline soup known as FORMAT_MOODLE.
429                 $messagehtml = format_text($message, FORMAT_MOODLE, array('context'=>$context, 'para'=>false, 'newlines'=>true, 'filter'=>true));
430                 $messagetext = html_to_text($messagehtml);
431             }
432         } else {
433             $messagetext = get_string('welcometocoursetext', 'enrol_self', $a);
434             $messagehtml = text_to_html($messagetext, null, false, true);
435         }
437         $subject = get_string('welcometocourse', 'enrol_self', format_string($course->fullname, true, array('context'=>$context)));
439         $rusers = array();
440         if (!empty($CFG->coursecontact)) {
441             $croles = explode(',', $CFG->coursecontact);
442             list($sort, $sortparams) = users_order_by_sql('u');
443             // We only use the first user.
444             $i = 0;
445             do {
446                 $rusers = get_role_users($croles[$i], $context, true, '',
447                     'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
448                 $i++;
449             } while (empty($rusers) && !empty($croles[$i]));
450         }
451         if ($rusers) {
452             $contact = reset($rusers);
453         } else {
454             $contact = core_user::get_support_user();
455         }
457         // Directly emailing welcome message rather than using messaging.
458         email_to_user($user, $contact, $subject, $messagetext, $messagehtml);
459     }
461     /**
462      * Enrol self cron support.
463      * @return void
464      */
465     public function cron() {
466         $trace = new text_progress_trace();
467         $this->sync($trace, null);
468         $this->send_expiry_notifications($trace);
469     }
471     /**
472      * Sync all meta course links.
473      *
474      * @param progress_trace $trace
475      * @param int $courseid one course, empty mean all
476      * @return int 0 means ok, 1 means error, 2 means plugin disabled
477      */
478     public function sync(progress_trace $trace, $courseid = null) {
479         global $DB;
481         if (!enrol_is_enabled('self')) {
482             $trace->finished();
483             return 2;
484         }
486         // Unfortunately this may take a long time, execution can be interrupted safely here.
487         core_php_time_limit::raise();
488         raise_memory_limit(MEMORY_HUGE);
490         $trace->output('Verifying self-enrolments...');
492         $params = array('now'=>time(), 'useractive'=>ENROL_USER_ACTIVE, 'courselevel'=>CONTEXT_COURSE);
493         $coursesql = "";
494         if ($courseid) {
495             $coursesql = "AND e.courseid = :courseid";
496             $params['courseid'] = $courseid;
497         }
499         // Note: the logic of self enrolment guarantees that user logged in at least once (=== u.lastaccess set)
500         //       and that user accessed course at least once too (=== user_lastaccess record exists).
502         // First deal with users that did not log in for a really long time - they do not have user_lastaccess records.
503         $sql = "SELECT e.*, ue.userid
504                   FROM {user_enrolments} ue
505                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
506                   JOIN {user} u ON u.id = ue.userid
507                  WHERE :now - u.lastaccess > e.customint2
508                        $coursesql";
509         $rs = $DB->get_recordset_sql($sql, $params);
510         foreach ($rs as $instance) {
511             $userid = $instance->userid;
512             unset($instance->userid);
513             $this->unenrol_user($instance, $userid);
514             $days = $instance->customint2 / 60*60*24;
515             $trace->output("unenrolling user $userid from course $instance->courseid as they have did not log in for at least $days days", 1);
516         }
517         $rs->close();
519         // Now unenrol from course user did not visit for a long time.
520         $sql = "SELECT e.*, ue.userid
521                   FROM {user_enrolments} ue
522                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
523                   JOIN {user_lastaccess} ul ON (ul.userid = ue.userid AND ul.courseid = e.courseid)
524                  WHERE :now - ul.timeaccess > e.customint2
525                        $coursesql";
526         $rs = $DB->get_recordset_sql($sql, $params);
527         foreach ($rs as $instance) {
528             $userid = $instance->userid;
529             unset($instance->userid);
530             $this->unenrol_user($instance, $userid);
531                 $days = $instance->customint2 / 60*60*24;
532             $trace->output("unenrolling user $userid from course $instance->courseid as they have did not access course for at least $days days", 1);
533         }
534         $rs->close();
536         $trace->output('...user self-enrolment updates finished.');
537         $trace->finished();
539         $this->process_expirations($trace, $courseid);
541         return 0;
542     }
544     /**
545      * Returns the user who is responsible for self enrolments in given instance.
546      *
547      * Usually it is the first editing teacher - the person with "highest authority"
548      * as defined by sort_by_roleassignment_authority() having 'enrol/self:manage'
549      * capability.
550      *
551      * @param int $instanceid enrolment instance id
552      * @return stdClass user record
553      */
554     protected function get_enroller($instanceid) {
555         global $DB;
557         if ($this->lasternollerinstanceid == $instanceid and $this->lasternoller) {
558             return $this->lasternoller;
559         }
561         $instance = $DB->get_record('enrol', array('id'=>$instanceid, 'enrol'=>$this->get_name()), '*', MUST_EXIST);
562         $context = context_course::instance($instance->courseid);
564         if ($users = get_enrolled_users($context, 'enrol/self:manage')) {
565             $users = sort_by_roleassignment_authority($users, $context);
566             $this->lasternoller = reset($users);
567             unset($users);
568         } else {
569             $this->lasternoller = parent::get_enroller($instanceid);
570         }
572         $this->lasternollerinstanceid = $instanceid;
574         return $this->lasternoller;
575     }
577     /**
578      * Gets an array of the user enrolment actions.
579      *
580      * @param course_enrolment_manager $manager
581      * @param stdClass $ue A user enrolment object
582      * @return array An array of user_enrolment_actions
583      */
584     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
585         $actions = array();
586         $context = $manager->get_context();
587         $instance = $ue->enrolmentinstance;
588         $params = $manager->get_moodlepage()->url->params();
589         $params['ue'] = $ue->id;
590         if ($this->allow_unenrol($instance) && has_capability("enrol/self:unenrol", $context)) {
591             $url = new moodle_url('/enrol/unenroluser.php', $params);
592             $actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
593         }
594         if ($this->allow_manage($instance) && has_capability("enrol/self:manage", $context)) {
595             $url = new moodle_url('/enrol/editenrolment.php', $params);
596             $actions[] = new user_enrolment_action(new pix_icon('t/edit', ''), get_string('edit'), $url, array('class'=>'editenrollink', 'rel'=>$ue->id));
597         }
598         return $actions;
599     }
601     /**
602      * Restore instance and map settings.
603      *
604      * @param restore_enrolments_structure_step $step
605      * @param stdClass $data
606      * @param stdClass $course
607      * @param int $oldid
608      */
609     public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
610         global $DB;
611         if ($step->get_task()->get_target() == backup::TARGET_NEW_COURSE) {
612             $merge = false;
613         } else {
614             $merge = array(
615                 'courseid'   => $data->courseid,
616                 'enrol'      => $this->get_name(),
617                 'roleid'     => $data->roleid,
618             );
619         }
620         if ($merge and $instances = $DB->get_records('enrol', $merge, 'id')) {
621             $instance = reset($instances);
622             $instanceid = $instance->id;
623         } else {
624             if (!empty($data->customint5)) {
625                 if ($step->get_task()->is_samesite()) {
626                     // Keep cohort restriction unchanged - we are on the same site.
627                 } else {
628                     // Use some id that can not exist in order to prevent self enrolment,
629                     // because we do not know what cohort it is in this site.
630                     $data->customint5 = -1;
631                 }
632             }
633             $instanceid = $this->add_instance($course, (array)$data);
634         }
635         $step->set_mapping('enrol', $oldid, $instanceid);
636     }
638     /**
639      * Restore user enrolment.
640      *
641      * @param restore_enrolments_structure_step $step
642      * @param stdClass $data
643      * @param stdClass $instance
644      * @param int $oldinstancestatus
645      * @param int $userid
646      */
647     public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
648         $this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
649     }
651     /**
652      * Restore role assignment.
653      *
654      * @param stdClass $instance
655      * @param int $roleid
656      * @param int $userid
657      * @param int $contextid
658      */
659     public function restore_role_assignment($instance, $roleid, $userid, $contextid) {
660         // This is necessary only because we may migrate other types to this instance,
661         // we do not use component in manual or self enrol.
662         role_assign($roleid, $userid, $contextid, '', 0);
663     }
665     /**
666      * Is it possible to delete enrol instance via standard UI?
667      *
668      * @param stdClass $instance
669      * @return bool
670      */
671     public function can_delete_instance($instance) {
672         $context = context_course::instance($instance->courseid);
673         return has_capability('enrol/self:config', $context);
674     }
676     /**
677      * Is it possible to hide/show enrol instance via standard UI?
678      *
679      * @param stdClass $instance
680      * @return bool
681      */
682     public function can_hide_show_instance($instance) {
683         $context = context_course::instance($instance->courseid);
684         return has_capability('enrol/self:config', $context);
685     }