lib.php 18 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?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.
 *
20
 * @package    enrol_self
Petr Skoda's avatar
Petr Skoda committed
21
22
 * @copyright  2010 Petr Skoda  {@link http://skodak.org}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
24
25
26
27
28
29
30
31
 */

/**
 * 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 {

32
33
34
35
36
37
38
39
40
41
42
43
    /**
     * 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
     */
44
    public function get_info_icons(array $instances) {
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
        $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;
62
63
    }

64
65
66
    /**
     * Returns localised name of enrol instance
     *
67
     * @param stdClass $instance (null is accepted too)
68
69
70
71
72
73
74
     * @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))) {
75
                $role = ' (' . role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING)) . ')';
76
77
78
79
80
81
82
83
84
85
86
            } else {
                $role = '';
            }
            $enrol = $this->get_name();
            return get_string('pluginname', 'enrol_'.$enrol) . $role;
        } else {
            return format_string($instance->name);
        }
    }

    public function roles_protected() {
87
        // Users may tweak the roles later.
88
89
90
91
        return false;
    }

    public function allow_unenrol(stdClass $instance) {
92
        // Users with unenrol cap may unenrol other users manually manually.
93
94
95
96
        return true;
    }

    public function allow_manage(stdClass $instance) {
97
        // Users with manage cap may tweak period and status.
98
99
100
        return true;
    }

101
    public function show_enrolme_link(stdClass $instance) {
102
103
104
105
106
107
108
109
110
111
        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;
112
113
    }

114
    /**
Petr Skoda's avatar
Petr Skoda committed
115
     * Sets up navigation entries.
116
     *
117
118
     * @param stdClass $instancesnode
     * @param stdClass $instance
Petr Skoda's avatar
Petr Skoda committed
119
     * @return void
120
121
122
123
124
125
     */
    public function add_course_navigation($instancesnode, stdClass $instance) {
        if ($instance->enrol !== 'self') {
             throw new coding_exception('Invalid enrol instance type!');
        }

126
        $context = context_course::instance($instance->courseid);
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
        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!');
        }
144
        $context = context_course::instance($instance->courseid);
145
146
147
148
149
150
151
152
153
154
155

        $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;
    }

156
157
158
159
160
    /**
     * 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
     */
161
    public function get_newinstance_link($courseid) {
162
        $context = context_course::instance($courseid, MUST_EXIST);
163

Sun Zhigang's avatar
Sun Zhigang committed
164
        if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/self:config', $context)) {
165
166
            return NULL;
        }
167
        // Multiple instances supported - different roles with different password.
168
        return new moodle_url('/enrol/self/edit.php', array('courseid'=>$courseid));
169
170
171
172
173
174
175
176
177
178
179
180
181
    }

    /**
     * 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()) {
182
            // Can not enrol guest!!
183
184
185
186
187
188
189
            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;
        }

190
        if ($instance->enrolstartdate != 0 and $instance->enrolstartdate > time()) {
191
192
193
194
            //TODO: inform that we can not enrol yet
            return null;
        }

195
        if ($instance->enrolenddate != 0 and $instance->enrolenddate < time()) {
196
197
198
199
            //TODO: inform that enrolment is not possible any more
            return null;
        }

200
201
202
203
204
205
206
207
208
209
210
211
        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)));
            }
        }

212
        require_once("$CFG->dirroot/enrol/self/locallib.php");
213
214
        require_once("$CFG->dirroot/group/lib.php");

215
216
217
218
219
220
        $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');
221
                $timestart = time();
222
                if ($instance->enrolperiod) {
223
                    $timeend = $timestart + $instance->enrolperiod;
224
                } else {
225
                    $timeend = 0;
226
227
                }

228
                $this->enrol_user($instance, $USER->id, $instance->roleid, $timestart, $timeend);
229
                add_to_log($instance->courseid, 'course', 'enrol', '../enrol/users.php?id='.$instance->courseid, $instance->courseid); //TODO: There should be userid somewhere!
230
231
232
233
234
235
236
237
238
239
240
241
242
243

                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;
                        }
                    }
                }
244
                // Send welcome message.
245
                if ($instance->customint4) {
246
247
248
249
250
251
252
253
254
255
256
257
258
259
                    $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.
260
     * @param stdClass $course
261
262
263
     * @return int id of new instance
     */
    public function add_default_instance($course) {
Petr Skoda's avatar
Petr Skoda committed
264
        $fields = array('customint1'  => $this->get_config('groupkey'),
265
                        'customint2'  => $this->get_config('longtimenosee'),
266
                        'customint3'  => $this->get_config('maxenrolled'),
267
                        'customint4'  => $this->get_config('sendcoursewelcomemessage'),
268
                        'customint5'  => 0,
Petr Skoda's avatar
Petr Skoda committed
269
270
271
                        'enrolperiod' => $this->get_config('enrolperiod', 0),
                        'status'      => $this->get_config('status'),
                        'roleid'      => $this->get_config('roleid', 0));
272
273
274
275
276
277
278
279
280

        if ($this->get_config('requirepassword')) {
            $fields['password'] = generate_password(20);
        }

        return $this->add_instance($course, $fields);
    }

    /**
281
     * Send welcome email to specified user.
282
     *
283
284
     * @param stdClass $instance
     * @param stdClass $user user record
285
286
287
288
289
290
     * @return void
     */
    protected function email_welcome_message($instance, $user) {
        global $CFG, $DB;

        $course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
291
        $context = context_course::instance($course->id);
292

293
        $a = new stdClass();
294
        $a->coursename = format_string($course->fullname, true, array('context'=>$context));
295
296
297
298
299
300
        $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);
301
302
303
304
305
306
307
308
309
            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);
            }
310
        } else {
311
312
            $messagetext = get_string('welcometocoursetext', 'enrol_self', $a);
            $messagehtml = text_to_html($messagetext, null, false, true);
313
314
        }

315
        $subject = get_string('welcometocourse', 'enrol_self', format_string($course->fullname, true, array('context'=>$context)));
316

317
        $rusers = array();
318
319
320
321
322
323
324
        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 {
325
            $contact = generate_email_supportuser();
326
327
        }

328
        // Directly emailing welcome message rather than using messaging.
329
        email_to_user($user, $contact, $subject, $messagetext, $messagehtml);
330
    }
331
332

    /**
333
     * Enrol self cron support.
334
335
336
337
338
339
340
341
342
343
344
345
346
     * @return void
     */
    public function cron() {
        global $DB;

        if (!enrol_is_enabled('self')) {
            return;
        }

        $plugin = enrol_get_plugin('self');

        $now = time();

347
348
        // 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).
349

350
        // First deal with users that did not log in for a really long time.
351
352
353
354
355
356
357
358
359
360
361
362
363
364
        $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();

365
        // Now unenrol from course user did not visit for a long time.
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
        $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();
    }
382
383

     /**
384
     * Gets an array of the user enrolment actions.
385
386
387
388
389
390
391
392
393
394
395
396
     *
     * @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)) {
397
            $url = new moodle_url('/enrol/unenroluser.php', $params);
398
399
400
401
402
403
404
405
            $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;
    }
406

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
    /**
     * 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);
    }
443

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
    /**
     * 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);
469
470
    }
}