MDL-59756 enrol: Swap positions of edit and unenrol actions
[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      * Return true if we can add a new instance to this course.
122      *
123      * @param int $courseid
124      * @return boolean
125      */
126     public function can_add_instance($courseid) {
127         $context = context_course::instance($courseid, MUST_EXIST);
129         if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/self:config', $context)) {
130             return false;
131         }
133         return true;
134     }
136     /**
137      * Self enrol user to course
138      *
139      * @param stdClass $instance enrolment instance
140      * @param stdClass $data data needed for enrolment.
141      * @return bool|array true if enroled else eddor code and messege
142      */
143     public function enrol_self(stdClass $instance, $data = null) {
144         global $DB, $USER, $CFG;
146         // Don't enrol user if password is not passed when required.
147         if ($instance->password && !isset($data->enrolpassword)) {
148             return;
149         }
151         $timestart = time();
152         if ($instance->enrolperiod) {
153             $timeend = $timestart + $instance->enrolperiod;
154         } else {
155             $timeend = 0;
156         }
158         $this->enrol_user($instance, $USER->id, $instance->roleid, $timestart, $timeend);
160         if ($instance->password and $instance->customint1 and $data->enrolpassword !== $instance->password) {
161             // It must be a group enrolment, let's assign group too.
162             $groups = $DB->get_records('groups', array('courseid'=>$instance->courseid), 'id', 'id, enrolmentkey');
163             foreach ($groups as $group) {
164                 if (empty($group->enrolmentkey)) {
165                     continue;
166                 }
167                 if ($group->enrolmentkey === $data->enrolpassword) {
168                     // Add user to group.
169                     require_once($CFG->dirroot.'/group/lib.php');
170                     groups_add_member($group->id, $USER->id);
171                     break;
172                 }
173             }
174         }
175         // Send welcome message.
176         if ($instance->customint4 != ENROL_DO_NOT_SEND_EMAIL) {
177             $this->email_welcome_message($instance, $USER);
178         }
179     }
181     /**
182      * Creates course enrol form, checks if form submitted
183      * and enrols user if necessary. It can also redirect.
184      *
185      * @param stdClass $instance
186      * @return string html text, usually a form in a text box
187      */
188     public function enrol_page_hook(stdClass $instance) {
189         global $CFG, $OUTPUT, $USER;
191         require_once("$CFG->dirroot/enrol/self/locallib.php");
193         $enrolstatus = $this->can_self_enrol($instance);
195         if (true === $enrolstatus) {
196             // This user can self enrol using this instance.
197             $form = new enrol_self_enrol_form(null, $instance);
198             $instanceid = optional_param('instance', 0, PARAM_INT);
199             if ($instance->id == $instanceid) {
200                 if ($data = $form->get_data()) {
201                     $this->enrol_self($instance, $data);
202                 }
203             }
204         } else {
205             // This user can not self enrol using this instance. Using an empty form to keep
206             // the UI consistent with other enrolment plugins that returns a form.
207             $data = new stdClass();
208             $data->header = $this->get_instance_name($instance);
209             $data->info = $enrolstatus;
211             // The can_self_enrol call returns a button to the login page if the user is a
212             // guest, setting the login url to the form if that is the case.
213             $url = isguestuser() ? get_login_url() : null;
214             $form = new enrol_self_empty_form($url, $data);
215         }
217         ob_start();
218         $form->display();
219         $output = ob_get_clean();
220         return $OUTPUT->box($output);
221     }
223     /**
224      * Checks if user can self enrol.
225      *
226      * @param stdClass $instance enrolment instance
227      * @param bool $checkuserenrolment if true will check if user enrolment is inactive.
228      *             used by navigation to improve performance.
229      * @return bool|string true if successful, else error message or false.
230      */
231     public function can_self_enrol(stdClass $instance, $checkuserenrolment = true) {
232         global $CFG, $DB, $OUTPUT, $USER;
234         if ($checkuserenrolment) {
235             if (isguestuser()) {
236                 // Can not enrol guest.
237                 return get_string('noguestaccess', 'enrol') . $OUTPUT->continue_button(get_login_url());
238             }
239             // Check if user is already enroled.
240             if ($DB->get_record('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
241                 return get_string('canntenrol', 'enrol_self');
242             }
243         }
245         if ($instance->status != ENROL_INSTANCE_ENABLED) {
246             return get_string('canntenrol', 'enrol_self');
247         }
249         if ($instance->enrolstartdate != 0 and $instance->enrolstartdate > time()) {
250             return get_string('canntenrolearly', 'enrol_self', userdate($instance->enrolstartdate));
251         }
253         if ($instance->enrolenddate != 0 and $instance->enrolenddate < time()) {
254             return get_string('canntenrollate', 'enrol_self', userdate($instance->enrolenddate));
255         }
257         if (!$instance->customint6) {
258             // New enrols not allowed.
259             return get_string('canntenrol', 'enrol_self');
260         }
262         if ($DB->record_exists('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
263             return get_string('canntenrol', 'enrol_self');
264         }
266         if ($instance->customint3 > 0) {
267             // Max enrol limit specified.
268             $count = $DB->count_records('user_enrolments', array('enrolid' => $instance->id));
269             if ($count >= $instance->customint3) {
270                 // Bad luck, no more self enrolments here.
271                 return get_string('maxenrolledreached', 'enrol_self');
272             }
273         }
275         if ($instance->customint5) {
276             require_once("$CFG->dirroot/cohort/lib.php");
277             if (!cohort_is_member($instance->customint5, $USER->id)) {
278                 $cohort = $DB->get_record('cohort', array('id' => $instance->customint5));
279                 if (!$cohort) {
280                     return null;
281                 }
282                 $a = format_string($cohort->name, true, array('context' => context::instance_by_id($cohort->contextid)));
283                 return markdown_to_html(get_string('cohortnonmemberinfo', 'enrol_self', $a));
284             }
285         }
287         return true;
288     }
290     /**
291      * Return information for enrolment instance containing list of parameters required
292      * for enrolment, name of enrolment plugin etc.
293      *
294      * @param stdClass $instance enrolment instance
295      * @return stdClass instance info.
296      */
297     public function get_enrol_info(stdClass $instance) {
299         $instanceinfo = new stdClass();
300         $instanceinfo->id = $instance->id;
301         $instanceinfo->courseid = $instance->courseid;
302         $instanceinfo->type = $this->get_name();
303         $instanceinfo->name = $this->get_instance_name($instance);
304         $instanceinfo->status = $this->can_self_enrol($instance);
306         if ($instance->password) {
307             $instanceinfo->requiredparam = new stdClass();
308             $instanceinfo->requiredparam->enrolpassword = get_string('password', 'enrol_self');
309         }
311         // If enrolment is possible and password is required then return ws function name to get more information.
312         if ((true === $instanceinfo->status) && $instance->password) {
313             $instanceinfo->wsfunction = 'enrol_self_get_instance_info';
314         }
315         return $instanceinfo;
316     }
318     /**
319      * Add new instance of enrol plugin with default settings.
320      * @param stdClass $course
321      * @return int id of new instance
322      */
323     public function add_default_instance($course) {
324         $fields = $this->get_instance_defaults();
326         if ($this->get_config('requirepassword')) {
327             $fields['password'] = generate_password(20);
328         }
330         return $this->add_instance($course, $fields);
331     }
333     /**
334      * Returns defaults for new instances.
335      * @return array
336      */
337     public function get_instance_defaults() {
338         $expirynotify = $this->get_config('expirynotify');
339         if ($expirynotify == 2) {
340             $expirynotify = 1;
341             $notifyall = 1;
342         } else {
343             $notifyall = 0;
344         }
346         $fields = array();
347         $fields['status']          = $this->get_config('status');
348         $fields['roleid']          = $this->get_config('roleid');
349         $fields['enrolperiod']     = $this->get_config('enrolperiod');
350         $fields['expirynotify']    = $expirynotify;
351         $fields['notifyall']       = $notifyall;
352         $fields['expirythreshold'] = $this->get_config('expirythreshold');
353         $fields['customint1']      = $this->get_config('groupkey');
354         $fields['customint2']      = $this->get_config('longtimenosee');
355         $fields['customint3']      = $this->get_config('maxenrolled');
356         $fields['customint4']      = $this->get_config('sendcoursewelcomemessage');
357         $fields['customint5']      = 0;
358         $fields['customint6']      = $this->get_config('newenrols');
360         return $fields;
361     }
363     /**
364      * Send welcome email to specified user.
365      *
366      * @param stdClass $instance
367      * @param stdClass $user user record
368      * @return void
369      */
370     protected function email_welcome_message($instance, $user) {
371         global $CFG, $DB;
373         $course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
374         $context = context_course::instance($course->id);
376         $a = new stdClass();
377         $a->coursename = format_string($course->fullname, true, array('context'=>$context));
378         $a->profileurl = "$CFG->wwwroot/user/view.php?id=$user->id&course=$course->id";
380         if (trim($instance->customtext1) !== '') {
381             $message = $instance->customtext1;
382             $key = array('{$a->coursename}', '{$a->profileurl}', '{$a->fullname}', '{$a->email}');
383             $value = array($a->coursename, $a->profileurl, fullname($user), $user->email);
384             $message = str_replace($key, $value, $message);
385             if (strpos($message, '<') === false) {
386                 // Plain text only.
387                 $messagetext = $message;
388                 $messagehtml = text_to_html($messagetext, null, false, true);
389             } else {
390                 // This is most probably the tag/newline soup known as FORMAT_MOODLE.
391                 $messagehtml = format_text($message, FORMAT_MOODLE, array('context'=>$context, 'para'=>false, 'newlines'=>true, 'filter'=>true));
392                 $messagetext = html_to_text($messagehtml);
393             }
394         } else {
395             $messagetext = get_string('welcometocoursetext', 'enrol_self', $a);
396             $messagehtml = text_to_html($messagetext, null, false, true);
397         }
399         $subject = get_string('welcometocourse', 'enrol_self', format_string($course->fullname, true, array('context'=>$context)));
401         $sendoption = $instance->customint4;
402         $contact = $this->get_welcome_email_contact($sendoption, $context);
404         // Directly emailing welcome message rather than using messaging.
405         email_to_user($user, $contact, $subject, $messagetext, $messagehtml);
406     }
408     /**
409      * Enrol self cron support.
410      * @return void
411      */
412     public function cron() {
413         $trace = new text_progress_trace();
414         $this->sync($trace, null);
415         $this->send_expiry_notifications($trace);
416     }
418     /**
419      * Sync all meta course links.
420      *
421      * @param progress_trace $trace
422      * @param int $courseid one course, empty mean all
423      * @return int 0 means ok, 1 means error, 2 means plugin disabled
424      */
425     public function sync(progress_trace $trace, $courseid = null) {
426         global $DB;
428         if (!enrol_is_enabled('self')) {
429             $trace->finished();
430             return 2;
431         }
433         // Unfortunately this may take a long time, execution can be interrupted safely here.
434         core_php_time_limit::raise();
435         raise_memory_limit(MEMORY_HUGE);
437         $trace->output('Verifying self-enrolments...');
439         $params = array('now'=>time(), 'useractive'=>ENROL_USER_ACTIVE, 'courselevel'=>CONTEXT_COURSE);
440         $coursesql = "";
441         if ($courseid) {
442             $coursesql = "AND e.courseid = :courseid";
443             $params['courseid'] = $courseid;
444         }
446         // Note: the logic of self enrolment guarantees that user logged in at least once (=== u.lastaccess set)
447         //       and that user accessed course at least once too (=== user_lastaccess record exists).
449         // First deal with users that did not log in for a really long time - they do not have user_lastaccess records.
450         $sql = "SELECT e.*, ue.userid
451                   FROM {user_enrolments} ue
452                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
453                   JOIN {user} u ON u.id = ue.userid
454                  WHERE :now - u.lastaccess > e.customint2
455                        $coursesql";
456         $rs = $DB->get_recordset_sql($sql, $params);
457         foreach ($rs as $instance) {
458             $userid = $instance->userid;
459             unset($instance->userid);
460             $this->unenrol_user($instance, $userid);
461             $days = $instance->customint2 / 60*60*24;
462             $trace->output("unenrolling user $userid from course $instance->courseid as they have did not log in for at least $days days", 1);
463         }
464         $rs->close();
466         // Now unenrol from course user did not visit for a long time.
467         $sql = "SELECT e.*, ue.userid
468                   FROM {user_enrolments} ue
469                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.enrol = 'self' AND e.customint2 > 0)
470                   JOIN {user_lastaccess} ul ON (ul.userid = ue.userid AND ul.courseid = e.courseid)
471                  WHERE :now - ul.timeaccess > e.customint2
472                        $coursesql";
473         $rs = $DB->get_recordset_sql($sql, $params);
474         foreach ($rs as $instance) {
475             $userid = $instance->userid;
476             unset($instance->userid);
477             $this->unenrol_user($instance, $userid);
478                 $days = $instance->customint2 / 60*60*24;
479             $trace->output("unenrolling user $userid from course $instance->courseid as they have did not access course for at least $days days", 1);
480         }
481         $rs->close();
483         $trace->output('...user self-enrolment updates finished.');
484         $trace->finished();
486         $this->process_expirations($trace, $courseid);
488         return 0;
489     }
491     /**
492      * Returns the user who is responsible for self enrolments in given instance.
493      *
494      * Usually it is the first editing teacher - the person with "highest authority"
495      * as defined by sort_by_roleassignment_authority() having 'enrol/self:manage'
496      * capability.
497      *
498      * @param int $instanceid enrolment instance id
499      * @return stdClass user record
500      */
501     protected function get_enroller($instanceid) {
502         global $DB;
504         if ($this->lasternollerinstanceid == $instanceid and $this->lasternoller) {
505             return $this->lasternoller;
506         }
508         $instance = $DB->get_record('enrol', array('id'=>$instanceid, 'enrol'=>$this->get_name()), '*', MUST_EXIST);
509         $context = context_course::instance($instance->courseid);
511         if ($users = get_enrolled_users($context, 'enrol/self:manage')) {
512             $users = sort_by_roleassignment_authority($users, $context);
513             $this->lasternoller = reset($users);
514             unset($users);
515         } else {
516             $this->lasternoller = parent::get_enroller($instanceid);
517         }
519         $this->lasternollerinstanceid = $instanceid;
521         return $this->lasternoller;
522     }
524     /**
525      * Gets an array of the user enrolment actions.
526      *
527      * @param course_enrolment_manager $manager
528      * @param stdClass $ue A user enrolment object
529      * @return array An array of user_enrolment_actions
530      */
531     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
532         $actions = array();
533         $context = $manager->get_context();
534         $instance = $ue->enrolmentinstance;
535         $params = $manager->get_moodlepage()->url->params();
536         $params['ue'] = $ue->id;
537         if ($this->allow_manage($instance) && has_capability("enrol/self:manage", $context)) {
538             $url = new moodle_url('/enrol/editenrolment.php', $params);
539             $actionparams = array('class' => 'editenrollink', 'rel' => $ue->id, 'data-action' => ENROL_ACTION_EDIT);
540             $actions[] = new user_enrolment_action(new pix_icon('t/edit', get_string('editenrolment', 'enrol')),
541                 get_string('editenrolment', 'enrol'), $url, $actionparams);
542         }
543         if ($this->allow_unenrol($instance) && has_capability("enrol/self:unenrol", $context)) {
544             $url = new moodle_url('/enrol/unenroluser.php', $params);
545             $actionparams = array('class' => 'unenrollink', 'rel' => $ue->id, 'data-action' => ENROL_ACTION_UNENROL);
546             $actions[] = new user_enrolment_action(new pix_icon('t/delete', get_string('unenrol', 'enrol')),
547                 get_string('unenrol', 'enrol'), $url, $actionparams);
548         }
549         return $actions;
550     }
552     /**
553      * Restore instance and map settings.
554      *
555      * @param restore_enrolments_structure_step $step
556      * @param stdClass $data
557      * @param stdClass $course
558      * @param int $oldid
559      */
560     public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
561         global $DB;
562         if ($step->get_task()->get_target() == backup::TARGET_NEW_COURSE) {
563             $merge = false;
564         } else {
565             $merge = array(
566                 'courseid'   => $data->courseid,
567                 'enrol'      => $this->get_name(),
568                 'status'     => $data->status,
569                 'roleid'     => $data->roleid,
570             );
571         }
572         if ($merge and $instances = $DB->get_records('enrol', $merge, 'id')) {
573             $instance = reset($instances);
574             $instanceid = $instance->id;
575         } else {
576             if (!empty($data->customint5)) {
577                 if ($step->get_task()->is_samesite()) {
578                     // Keep cohort restriction unchanged - we are on the same site.
579                 } else {
580                     // Use some id that can not exist in order to prevent self enrolment,
581                     // because we do not know what cohort it is in this site.
582                     $data->customint5 = -1;
583                 }
584             }
585             $instanceid = $this->add_instance($course, (array)$data);
586         }
587         $step->set_mapping('enrol', $oldid, $instanceid);
588     }
590     /**
591      * Restore user enrolment.
592      *
593      * @param restore_enrolments_structure_step $step
594      * @param stdClass $data
595      * @param stdClass $instance
596      * @param int $oldinstancestatus
597      * @param int $userid
598      */
599     public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
600         $this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
601     }
603     /**
604      * Restore role assignment.
605      *
606      * @param stdClass $instance
607      * @param int $roleid
608      * @param int $userid
609      * @param int $contextid
610      */
611     public function restore_role_assignment($instance, $roleid, $userid, $contextid) {
612         // This is necessary only because we may migrate other types to this instance,
613         // we do not use component in manual or self enrol.
614         role_assign($roleid, $userid, $contextid, '', 0);
615     }
617     /**
618      * Is it possible to delete enrol instance via standard UI?
619      *
620      * @param stdClass $instance
621      * @return bool
622      */
623     public function can_delete_instance($instance) {
624         $context = context_course::instance($instance->courseid);
625         return has_capability('enrol/self:config', $context);
626     }
628     /**
629      * Is it possible to hide/show enrol instance via standard UI?
630      *
631      * @param stdClass $instance
632      * @return bool
633      */
634     public function can_hide_show_instance($instance) {
635         $context = context_course::instance($instance->courseid);
637         if (!has_capability('enrol/self:config', $context)) {
638             return false;
639         }
641         // If the instance is currently disabled, before it can be enabled,
642         // we must check whether the password meets the password policies.
643         if ($instance->status == ENROL_INSTANCE_DISABLED) {
644             if ($this->get_config('requirepassword')) {
645                 if (empty($instance->password)) {
646                     return false;
647                 }
648             }
649             // Only check the password if it is set.
650             if (!empty($instance->password) && $this->get_config('usepasswordpolicy')) {
651                 if (!check_password_policy($instance->password, $errmsg)) {
652                     return false;
653                 }
654             }
655         }
657         return true;
658     }
660     /**
661      * Return an array of valid options for the status.
662      *
663      * @return array
664      */
665     protected function get_status_options() {
666         $options = array(ENROL_INSTANCE_ENABLED  => get_string('yes'),
667                          ENROL_INSTANCE_DISABLED => get_string('no'));
668         return $options;
669     }
671     /**
672      * Return an array of valid options for the newenrols property.
673      *
674      * @return array
675      */
676     protected function get_newenrols_options() {
677         $options = array(1 => get_string('yes'), 0 => get_string('no'));
678         return $options;
679     }
681     /**
682      * Return an array of valid options for the groupkey property.
683      *
684      * @return array
685      */
686     protected function get_groupkey_options() {
687         $options = array(1 => get_string('yes'), 0 => get_string('no'));
688         return $options;
689     }
691     /**
692      * Return an array of valid options for the expirynotify property.
693      *
694      * @return array
695      */
696     protected function get_expirynotify_options() {
697         $options = array(0 => get_string('no'),
698                          1 => get_string('expirynotifyenroller', 'core_enrol'),
699                          2 => get_string('expirynotifyall', 'core_enrol'));
700         return $options;
701     }
703     /**
704      * Return an array of valid options for the longtimenosee property.
705      *
706      * @return array
707      */
708     protected function get_longtimenosee_options() {
709         $options = array(0 => get_string('never'),
710                          1800 * 3600 * 24 => get_string('numdays', '', 1800),
711                          1000 * 3600 * 24 => get_string('numdays', '', 1000),
712                          365 * 3600 * 24 => get_string('numdays', '', 365),
713                          180 * 3600 * 24 => get_string('numdays', '', 180),
714                          150 * 3600 * 24 => get_string('numdays', '', 150),
715                          120 * 3600 * 24 => get_string('numdays', '', 120),
716                          90 * 3600 * 24 => get_string('numdays', '', 90),
717                          60 * 3600 * 24 => get_string('numdays', '', 60),
718                          30 * 3600 * 24 => get_string('numdays', '', 30),
719                          21 * 3600 * 24 => get_string('numdays', '', 21),
720                          14 * 3600 * 24 => get_string('numdays', '', 14),
721                          7 * 3600 * 24 => get_string('numdays', '', 7));
722         return $options;
723     }
725     /**
726      * Add elements to the edit instance form.
727      *
728      * @param stdClass $instance
729      * @param MoodleQuickForm $mform
730      * @param context $context
731      * @return bool
732      */
733     public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
734         global $CFG;
736         // Merge these two settings to one value for the single selection element.
737         if ($instance->notifyall and $instance->expirynotify) {
738             $instance->expirynotify = 2;
739         }
740         unset($instance->notifyall);
742         $nameattribs = array('size' => '20', 'maxlength' => '255');
743         $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs);
744         $mform->setType('name', PARAM_TEXT);
745         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server');
747         $options = $this->get_status_options();
748         $mform->addElement('select', 'status', get_string('status', 'enrol_self'), $options);
749         $mform->addHelpButton('status', 'status', 'enrol_self');
751         $options = $this->get_newenrols_options();
752         $mform->addElement('select', 'customint6', get_string('newenrols', 'enrol_self'), $options);
753         $mform->addHelpButton('customint6', 'newenrols', 'enrol_self');
754         $mform->disabledIf('customint6', 'status', 'eq', ENROL_INSTANCE_DISABLED);
756         $passattribs = array('size' => '20', 'maxlength' => '50');
757         $mform->addElement('passwordunmask', 'password', get_string('password', 'enrol_self'), $passattribs);
758         $mform->addHelpButton('password', 'password', 'enrol_self');
759         if (empty($instance->id) and $this->get_config('requirepassword')) {
760             $mform->addRule('password', get_string('required'), 'required', null, 'client');
761         }
762         $mform->addRule('password', get_string('maximumchars', '', 50), 'maxlength', 50, 'server');
764         $options = $this->get_groupkey_options();
765         $mform->addElement('select', 'customint1', get_string('groupkey', 'enrol_self'), $options);
766         $mform->addHelpButton('customint1', 'groupkey', 'enrol_self');
768         $roles = $this->extend_assignable_roles($context, $instance->roleid);
769         $mform->addElement('select', 'roleid', get_string('role', 'enrol_self'), $roles);
771         $options = array('optional' => true, 'defaultunit' => 86400);
772         $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_self'), $options);
773         $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_self');
775         $options = $this->get_expirynotify_options();
776         $mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
777         $mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
779         $options = array('optional' => false, 'defaultunit' => 86400);
780         $mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
781         $mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
782         $mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
784         $options = array('optional' => true);
785         $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_self'), $options);
786         $mform->setDefault('enrolstartdate', 0);
787         $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_self');
789         $options = array('optional' => true);
790         $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_self'), $options);
791         $mform->setDefault('enrolenddate', 0);
792         $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_self');
794         $options = $this->get_longtimenosee_options();
795         $mform->addElement('select', 'customint2', get_string('longtimenosee', 'enrol_self'), $options);
796         $mform->addHelpButton('customint2', 'longtimenosee', 'enrol_self');
798         $mform->addElement('text', 'customint3', get_string('maxenrolled', 'enrol_self'));
799         $mform->addHelpButton('customint3', 'maxenrolled', 'enrol_self');
800         $mform->setType('customint3', PARAM_INT);
802         require_once($CFG->dirroot.'/cohort/lib.php');
804         $cohorts = array(0 => get_string('no'));
805         $allcohorts = cohort_get_available_cohorts($context, 0, 0, 0);
806         if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
807             $c = $DB->get_record('cohort',
808                                  array('id' => $instance->customint5),
809                                  'id, name, idnumber, contextid, visible',
810                                  IGNORE_MISSING);
811             if ($c) {
812                 // Current cohort was not found because current user can not see it. Still keep it.
813                 $allcohorts[$instance->customint5] = $c;
814             }
815         }
816         foreach ($allcohorts as $c) {
817             $cohorts[$c->id] = format_string($c->name, true, array('context' => context::instance_by_id($c->contextid)));
818             if ($c->idnumber) {
819                 $cohorts[$c->id] .= ' ['.s($c->idnumber).']';
820             }
821         }
822         if ($instance->customint5 && !isset($allcohorts[$instance->customint5])) {
823             // Somebody deleted a cohort, better keep the wrong value so that random ppl can not enrol.
824             $cohorts[$instance->customint5] = get_string('unknowncohort', 'cohort', $instance->customint5);
825         }
826         if (count($cohorts) > 1) {
827             $mform->addElement('select', 'customint5', get_string('cohortonly', 'enrol_self'), $cohorts);
828             $mform->addHelpButton('customint5', 'cohortonly', 'enrol_self');
829         } else {
830             $mform->addElement('hidden', 'customint5');
831             $mform->setType('customint5', PARAM_INT);
832             $mform->setConstant('customint5', 0);
833         }
835         $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
836                 enrol_send_welcome_email_options());
837         $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
839         $options = array('cols' => '60', 'rows' => '8');
840         $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'enrol_self'), $options);
841         $mform->addHelpButton('customtext1', 'customwelcomemessage', 'enrol_self');
843         if (enrol_accessing_via_instance($instance)) {
844             $warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
845             $mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
846         }
847     }
849     /**
850      * We are a good plugin and don't invent our own UI/validation code path.
851      *
852      * @return boolean
853      */
854     public function use_standard_editing_ui() {
855         return true;
856     }
858     /**
859      * Perform custom validation of the data used to edit the instance.
860      *
861      * @param array $data array of ("fieldname"=>value) of submitted data
862      * @param array $files array of uploaded files "element_name"=>tmp_file_path
863      * @param object $instance The instance loaded from the DB
864      * @param context $context The context of the instance we are editing
865      * @return array of "element_name"=>"error_description" if there are errors,
866      *         or an empty array if everything is OK.
867      * @return void
868      */
869     public function edit_instance_validation($data, $files, $instance, $context) {
870         $errors = array();
872         $checkpassword = false;
874         if ($instance->id) {
875             // Check the password if we are enabling the plugin again.
876             if (($instance->status == ENROL_INSTANCE_DISABLED) && ($data['status'] == ENROL_INSTANCE_ENABLED)) {
877                 $checkpassword = true;
878             }
880             // Check the password if the instance is enabled and the password has changed.
881             if (($data['status'] == ENROL_INSTANCE_ENABLED) && ($instance->password !== $data['password'])) {
882                 $checkpassword = true;
883             }
884         } else {
885             $checkpassword = true;
886         }
888         if ($checkpassword) {
889             $require = $this->get_config('requirepassword');
890             $policy  = $this->get_config('usepasswordpolicy');
891             if ($require and trim($data['password']) === '') {
892                 $errors['password'] = get_string('required');
893             } else if (!empty($data['password']) && $policy) {
894                 $errmsg = '';
895                 if (!check_password_policy($data['password'], $errmsg)) {
896                     $errors['password'] = $errmsg;
897                 }
898             }
899         }
901         if ($data['status'] == ENROL_INSTANCE_ENABLED) {
902             if (!empty($data['enrolenddate']) and $data['enrolenddate'] < $data['enrolstartdate']) {
903                 $errors['enrolenddate'] = get_string('enrolenddaterror', 'enrol_self');
904             }
905         }
907         if ($data['expirynotify'] > 0 and $data['expirythreshold'] < 86400) {
908             $errors['expirythreshold'] = get_string('errorthresholdlow', 'core_enrol');
909         }
911         // Now these ones are checked by quickforms, but we may be called by the upload enrolments tool, or a webservive.
912         if (core_text::strlen($data['name']) > 255) {
913             $errors['name'] = get_string('err_maxlength', 'form', 255);
914         }
915         $validstatus = array_keys($this->get_status_options());
916         $validnewenrols = array_keys($this->get_newenrols_options());
917         if (core_text::strlen($data['password']) > 50) {
918             $errors['name'] = get_string('err_maxlength', 'form', 50);
919         }
920         $validgroupkey = array_keys($this->get_groupkey_options());
921         $context = context_course::instance($instance->courseid);
922         $validroles = array_keys($this->extend_assignable_roles($context, $instance->roleid));
923         $validexpirynotify = array_keys($this->get_expirynotify_options());
924         $validlongtimenosee = array_keys($this->get_longtimenosee_options());
925         $tovalidate = array(
926             'enrolstartdate' => PARAM_INT,
927             'enrolenddate' => PARAM_INT,
928             'name' => PARAM_TEXT,
929             'customint1' => $validgroupkey,
930             'customint2' => $validlongtimenosee,
931             'customint3' => PARAM_INT,
932             'customint4' => PARAM_INT,
933             'customint5' => PARAM_INT,
934             'customint6' => $validnewenrols,
935             'status' => $validstatus,
936             'enrolperiod' => PARAM_INT,
937             'expirynotify' => $validexpirynotify,
938             'roleid' => $validroles
939         );
940         if ($data['expirynotify'] != 0) {
941             $tovalidate['expirythreshold'] = PARAM_INT;
942         }
943         $typeerrors = $this->validate_param_types($data, $tovalidate);
944         $errors = array_merge($errors, $typeerrors);
946         return $errors;
947     }
949     /**
950      * Add new instance of enrol plugin.
951      * @param object $course
952      * @param array $fields instance fields
953      * @return int id of new instance, null if can not be created
954      */
955     public function add_instance($course, array $fields = null) {
956         // In the form we are representing 2 db columns with one field.
957         if (!empty($fields) && !empty($fields['expirynotify'])) {
958             if ($fields['expirynotify'] == 2) {
959                 $fields['expirynotify'] = 1;
960                 $fields['notifyall'] = 1;
961             } else {
962                 $fields['notifyall'] = 0;
963             }
964         }
966         return parent::add_instance($course, $fields);
967     }
969     /**
970      * Update instance of enrol plugin.
971      * @param stdClass $instance
972      * @param stdClass $data modified instance fields
973      * @return boolean
974      */
975     public function update_instance($instance, $data) {
976         // In the form we are representing 2 db columns with one field.
977         if ($data->expirynotify == 2) {
978             $data->expirynotify = 1;
979             $data->notifyall = 1;
980         } else {
981             $data->notifyall = 0;
982         }
983         // Keep previous/default value of disabled expirythreshold option.
984         if (!$data->expirynotify) {
985             $data->expirythreshold = $instance->expirythreshold;
986         }
987         // Add previous value of newenrols if disabled.
988         if (!isset($data->customint6)) {
989             $data->customint6 = $instance->customint6;
990         }
992         return parent::update_instance($instance, $data);
993     }
995     /**
996      * Gets a list of roles that this user can assign for the course as the default for self-enrolment.
997      *
998      * @param context $context the context.
999      * @param integer $defaultrole the id of the role that is set as the default for self-enrolment
1000      * @return array index is the role id, value is the role name
1001      */
1002     public function extend_assignable_roles($context, $defaultrole) {
1003         global $DB;
1005         $roles = get_assignable_roles($context, ROLENAME_BOTH);
1006         if (!isset($roles[$defaultrole])) {
1007             if ($role = $DB->get_record('role', array('id' => $defaultrole))) {
1008                 $roles[$defaultrole] = role_get_name($role, $context, ROLENAME_BOTH);
1009             }
1010         }
1011         return $roles;
1012     }
1014     /**
1015      * Get the "from" contact which the email will be sent from.
1016      *
1017      * @param int $sendoption send email from constant ENROL_SEND_EMAIL_FROM_*
1018      * @param $context context where the user will be fetched
1019      * @return mixed|stdClass the contact user object.
1020      */
1021     public function get_welcome_email_contact($sendoption, $context) {
1022         global $CFG;
1024         $contact = null;
1025         // Send as the first user assigned as the course contact.
1026         if ($sendoption == ENROL_SEND_EMAIL_FROM_COURSE_CONTACT) {
1027             $rusers = array();
1028             if (!empty($CFG->coursecontact)) {
1029                 $croles = explode(',', $CFG->coursecontact);
1030                 list($sort, $sortparams) = users_order_by_sql('u');
1031                 // We only use the first user.
1032                 $i = 0;
1033                 do {
1034                     $rusers = get_role_users($croles[$i], $context, true, '',
1035                         'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
1036                     $i++;
1037                 } while (empty($rusers) && !empty($croles[$i]));
1038             }
1039             if ($rusers) {
1040                 $contact = array_values($rusers)[0];
1041             }
1042         } else if ($sendoption == ENROL_SEND_EMAIL_FROM_KEY_HOLDER) {
1043             // Send as the first user with enrol/self:holdkey capability assigned in the course.
1044             list($sort) = users_order_by_sql('u');
1045             $keyholders = get_users_by_capability($context, 'enrol/self:holdkey', 'u.*', $sort);
1046             if (!empty($keyholders)) {
1047                 $contact = array_values($keyholders)[0];
1048             }
1049         }
1051         // If send welcome email option is set to no reply or if none of the previous options have
1052         // returned a contact send welcome message as noreplyuser.
1053         if ($sendoption == ENROL_SEND_EMAIL_FROM_NOREPLY || empty($contact)) {
1054             $contact = core_user::get_noreply_user();
1055         }
1057         return $contact;
1058     }
1061 /**
1062  * Get icon mapping for font-awesome.
1063  */
1064 function enrol_self_get_fontawesome_icon_map() {
1065     return [
1066         'enrol_self:withkey' => 'fa-key',
1067         'enrol_self:withoutkey' => 'fa-sign-in',
1068     ];