Merge branch 'w41_MDL-42047_m26_cohortdel' of https://github.com/skodak/moodle
[moodle.git] / enrol / cohort / 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  * Cohort enrolment plugin.
19  *
20  * @package    enrol_cohort
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 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Cohort enrolment plugin implementation.
29  * @author Petr Skoda
30  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31  */
32 class enrol_cohort_plugin extends enrol_plugin {
33     /**
34      * Returns localised name of enrol instance.
35      *
36      * @param stdClass $instance (null is accepted too)
37      * @return string
38      */
39     public function get_instance_name($instance) {
40         global $DB;
42         if (empty($instance)) {
43             $enrol = $this->get_name();
44             return get_string('pluginname', 'enrol_'.$enrol);
46         } else if (empty($instance->name)) {
47             $enrol = $this->get_name();
48             $cohort = $DB->get_record('cohort', array('id'=>$instance->customint1));
49             if (!$cohort) {
50                 return get_string('pluginname', 'enrol_'.$enrol);
51             }
52             $cohortname = format_string($cohort->name, true, array('context'=>context::instance_by_id($cohort->contextid)));
53             if ($role = $DB->get_record('role', array('id'=>$instance->roleid))) {
54                 $role = role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING));
55                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . $cohortname . ' - ' . $role .')';
56             } else {
57                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . $cohortname . ')';
58             }
60         } else {
61             return format_string($instance->name, true, array('context'=>context_course::instance($instance->courseid)));
62         }
63     }
65     /**
66      * Returns link to page which may be used to add new instance of enrolment plugin in course.
67      * @param int $courseid
68      * @return moodle_url page url
69      */
70     public function get_newinstance_link($courseid) {
71         if (!$this->can_add_new_instances($courseid)) {
72             return NULL;
73         }
74         // Multiple instances supported - multiple parent courses linked.
75         return new moodle_url('/enrol/cohort/edit.php', array('courseid'=>$courseid));
76     }
78     /**
79      * Given a courseid this function returns true if the user is able to enrol or configure cohorts.
80      * AND there are cohorts that the user can view.
81      *
82      * @param int $courseid
83      * @return bool
84      */
85     protected function can_add_new_instances($courseid) {
86         global $DB;
88         $coursecontext = context_course::instance($courseid);
89         if (!has_capability('moodle/course:enrolconfig', $coursecontext) or !has_capability('enrol/cohort:config', $coursecontext)) {
90             return false;
91         }
92         list($sqlparents, $params) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids());
93         $sql = "SELECT id, contextid
94                   FROM {cohort}
95                  WHERE contextid $sqlparents
96               ORDER BY name ASC";
97         $cohorts = $DB->get_records_sql($sql, $params);
98         foreach ($cohorts as $c) {
99             $context = context::instance_by_id($c->contextid);
100             if (has_capability('moodle/cohort:view', $context)) {
101                 return true;
102             }
103         }
104         return false;
105     }
107     /**
108      * Returns edit icons for the page with list of instances.
109      * @param stdClass $instance
110      * @return array
111      */
112     public function get_action_icons(stdClass $instance) {
113         global $OUTPUT;
115         if ($instance->enrol !== 'cohort') {
116             throw new coding_exception('invalid enrol instance!');
117         }
118         $context = context_course::instance($instance->courseid);
120         $icons = array();
122         if (has_capability('enrol/cohort:config', $context)) {
123             $editlink = new moodle_url("/enrol/cohort/edit.php", array('courseid'=>$instance->courseid, 'id'=>$instance->id));
124             $icons[] = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', get_string('edit'), 'core',
125                     array('class' => 'iconsmall')));
126         }
128         return $icons;
129     }
131     /**
132      * Called for all enabled enrol plugins that returned true from is_cron_required().
133      * @return void
134      */
135     public function cron() {
136         global $CFG;
138         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
139         $trace = new null_progress_trace();
140         enrol_cohort_sync($trace);
141         $trace->finished();
142     }
144     /**
145      * Called after updating/inserting course.
146      *
147      * @param bool $inserted true if course just inserted
148      * @param stdClass $course
149      * @param stdClass $data form data
150      * @return void
151      */
152     public function course_updated($inserted, $course, $data) {
153         // It turns out there is no need for cohorts to deal with this hook, see MDL-34870.
154     }
156     /**
157      * Update instance status
158      *
159      * @param stdClass $instance
160      * @param int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
161      * @return void
162      */
163     public function update_status($instance, $newstatus) {
164         global $CFG;
166         parent::update_status($instance, $newstatus);
168         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
169         $trace = new null_progress_trace();
170         enrol_cohort_sync($trace, $instance->courseid);
171         $trace->finished();
172     }
174     /**
175      * Does this plugin allow manual unenrolment of a specific user?
176      * Yes, but only if user suspended...
177      *
178      * @param stdClass $instance course enrol instance
179      * @param stdClass $ue record from user_enrolments table
180      *
181      * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
182      */
183     public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
184         if ($ue->status == ENROL_USER_SUSPENDED) {
185             return true;
186         }
188         return false;
189     }
191     /**
192      * Gets an array of the user enrolment actions.
193      *
194      * @param course_enrolment_manager $manager
195      * @param stdClass $ue A user enrolment object
196      * @return array An array of user_enrolment_actions
197      */
198     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
199         $actions = array();
200         $context = $manager->get_context();
201         $instance = $ue->enrolmentinstance;
202         $params = $manager->get_moodlepage()->url->params();
203         $params['ue'] = $ue->id;
204         if ($this->allow_unenrol_user($instance, $ue) && has_capability('enrol/cohort:unenrol', $context)) {
205             $url = new moodle_url('/enrol/unenroluser.php', $params);
206             $actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
207         }
208         return $actions;
209     }
211     /**
212      * Returns a button to enrol a cohort or its users through the manual enrolment plugin.
213      *
214      * This function also adds a quickenrolment JS ui to the page so that users can be enrolled
215      * via AJAX.
216      *
217      * @param course_enrolment_manager $manager
218      * @return enrol_user_button
219      */
220     public function get_manual_enrol_button(course_enrolment_manager $manager) {
221         $course = $manager->get_course();
222         if (!$this->can_add_new_instances($course->id)) {
223             return false;
224         }
226         $cohorturl = new moodle_url('/enrol/cohort/edit.php', array('courseid' => $course->id));
227         $button = new enrol_user_button($cohorturl, get_string('enrolcohort', 'enrol'), 'get');
228         $button->class .= ' enrol_cohort_plugin';
230         $button->strings_for_js(array(
231             'enrol',
232             'synced',
233             'enrolcohort',
234             'enrolcohortusers',
235             ), 'enrol');
236         $button->strings_for_js(array(
237             'ajaxmore',
238             'cohortsearch',
239             ), 'enrol_cohort');
240         $button->strings_for_js('assignroles', 'role');
241         $button->strings_for_js('cohort', 'cohort');
242         $button->strings_for_js('users', 'moodle');
244         // No point showing this at all if the user cant manually enrol users.
245         $hasmanualinstance = has_capability('enrol/manual:enrol', $manager->get_context()) && $manager->has_instance('manual');
247         $modules = array('moodle-enrol_cohort-quickenrolment', 'moodle-enrol_cohort-quickenrolment-skin');
248         $function = 'M.enrol_cohort.quickenrolment.init';
249         $arguments = array(
250             'courseid'        => $course->id,
251             'ajaxurl'         => '/enrol/cohort/ajax.php',
252             'url'             => $manager->get_moodlepage()->url->out(false),
253             'manualEnrolment' => $hasmanualinstance);
254         $button->require_yui_module($modules, $function, array($arguments));
256         return $button;
257     }
259     /**
260      * Restore instance and map settings.
261      *
262      * @param restore_enrolments_structure_step $step
263      * @param stdClass $data
264      * @param stdClass $course
265      * @param int $oldid
266      */
267     public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
268         global $DB, $CFG;
270         if (!$step->get_task()->is_samesite()) {
271             // No cohort restore from other sites.
272             $step->set_mapping('enrol', $oldid, 0);
273             return;
274         }
276         if (!empty($data->customint2)) {
277             $data->customint2 = $step->get_mappingid('group', $data->customint2);
278         }
280         if ($data->roleid and $DB->record_exists('cohort', array('id'=>$data->customint1))) {
281             $instance = $DB->get_record('enrol', array('roleid'=>$data->roleid, 'customint1'=>$data->customint1, 'courseid'=>$course->id, 'enrol'=>$this->get_name()));
282             if ($instance) {
283                 $instanceid = $instance->id;
284             } else {
285                 $instanceid = $this->add_instance($course, (array)$data);
286             }
287             $step->set_mapping('enrol', $oldid, $instanceid);
289             require_once("$CFG->dirroot/enrol/cohort/locallib.php");
290             $trace = new null_progress_trace();
291             enrol_cohort_sync($trace, $course->id);
292             $trace->finished();
294         } else if ($this->get_config('unenrolaction') == ENROL_EXT_REMOVED_SUSPENDNOROLES) {
295             $data->customint1 = 0;
296             $instance = $DB->get_record('enrol', array('roleid'=>$data->roleid, 'customint1'=>$data->customint1, 'courseid'=>$course->id, 'enrol'=>$this->get_name()));
298             if ($instance) {
299                 $instanceid = $instance->id;
300             } else {
301                 $data->status = ENROL_INSTANCE_DISABLED;
302                 $instanceid = $this->add_instance($course, (array)$data);
303             }
304             $step->set_mapping('enrol', $oldid, $instanceid);
306             require_once("$CFG->dirroot/enrol/cohort/locallib.php");
307             $trace = new null_progress_trace();
308             enrol_cohort_sync($trace, $course->id);
309             $trace->finished();
311         } else {
312             $step->set_mapping('enrol', $oldid, 0);
313         }
314     }
316     /**
317      * Restore user enrolment.
318      *
319      * @param restore_enrolments_structure_step $step
320      * @param stdClass $data
321      * @param stdClass $instance
322      * @param int $oldinstancestatus
323      * @param int $userid
324      */
325     public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
326         global $DB;
328         if ($this->get_config('unenrolaction') != ENROL_EXT_REMOVED_SUSPENDNOROLES) {
329             // Enrolments were already synchronised in restore_instance(), we do not want any suspended leftovers.
330             return;
331         }
333         // ENROL_EXT_REMOVED_SUSPENDNOROLES means all previous enrolments are restored
334         // but without roles and suspended.
336         if (!$DB->record_exists('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
337             $this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, ENROL_USER_SUSPENDED);
338         }
339     }
341     /**
342      * Restore user group membership.
343      * @param stdClass $instance
344      * @param int $groupid
345      * @param int $userid
346      */
347     public function restore_group_member($instance, $groupid, $userid) {
348         // Nothing to do here, the group members are added in $this->restore_group_restored()
349         return;
350     }
353 /**
354  * Prevent removal of enrol roles.
355  * @param int $itemid
356  * @param int $groupid
357  * @param int $userid
358  * @return bool
359  */
360 function enrol_cohort_allow_group_member_remove($itemid, $groupid, $userid) {
361     return false;