MDL-49380 enrol_cohort: Update to code and introduction of a constant.
[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_CREATEGROUP constant for automatically creating a group for a cohort.
29  */
30 define('COHORT_CREATE_GROUP', -1);
32 /**
33  * Cohort enrolment plugin implementation.
34  * @author Petr Skoda
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class enrol_cohort_plugin extends enrol_plugin {
39     /**
40      * Is it possible to delete enrol instance via standard UI?
41      *
42      * @param stdClass $instance
43      * @return bool
44      */
45     public function can_delete_instance($instance) {
46         $context = context_course::instance($instance->courseid);
47         return has_capability('enrol/cohort:config', $context);
48     }
50     /**
51      * Returns localised name of enrol instance.
52      *
53      * @param stdClass $instance (null is accepted too)
54      * @return string
55      */
56     public function get_instance_name($instance) {
57         global $DB;
59         if (empty($instance)) {
60             $enrol = $this->get_name();
61             return get_string('pluginname', 'enrol_'.$enrol);
63         } else if (empty($instance->name)) {
64             $enrol = $this->get_name();
65             $cohort = $DB->get_record('cohort', array('id'=>$instance->customint1));
66             if (!$cohort) {
67                 return get_string('pluginname', 'enrol_'.$enrol);
68             }
69             $cohortname = format_string($cohort->name, true, array('context'=>context::instance_by_id($cohort->contextid)));
70             if ($role = $DB->get_record('role', array('id'=>$instance->roleid))) {
71                 $role = role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING));
72                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . $cohortname . ' - ' . $role .')';
73             } else {
74                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . $cohortname . ')';
75             }
77         } else {
78             return format_string($instance->name, true, array('context'=>context_course::instance($instance->courseid)));
79         }
80     }
82     /**
83      * Returns link to page which may be used to add new instance of enrolment plugin in course.
84      * @param int $courseid
85      * @return moodle_url page url
86      */
87     public function get_newinstance_link($courseid) {
88         if (!$this->can_add_new_instances($courseid)) {
89             return NULL;
90         }
91         // Multiple instances supported - multiple parent courses linked.
92         return new moodle_url('/enrol/cohort/edit.php', array('courseid'=>$courseid));
93     }
95     /**
96      * Given a courseid this function returns true if the user is able to enrol or configure cohorts.
97      * AND there are cohorts that the user can view.
98      *
99      * @param int $courseid
100      * @return bool
101      */
102     protected function can_add_new_instances($courseid) {
103         global $CFG;
104         require_once($CFG->dirroot . '/cohort/lib.php');
105         $coursecontext = context_course::instance($courseid);
106         if (!has_capability('moodle/course:enrolconfig', $coursecontext) or !has_capability('enrol/cohort:config', $coursecontext)) {
107             return false;
108         }
109         return cohort_get_available_cohorts($coursecontext, 0, 0, 1) ? true : false;
110     }
112     /**
113      * Returns edit icons for the page with list of instances.
114      * @param stdClass $instance
115      * @return array
116      */
117     public function get_action_icons(stdClass $instance) {
118         global $OUTPUT;
120         if ($instance->enrol !== 'cohort') {
121             throw new coding_exception('invalid enrol instance!');
122         }
123         $context = context_course::instance($instance->courseid);
125         $icons = array();
127         if (has_capability('enrol/cohort:config', $context)) {
128             $editlink = new moodle_url("/enrol/cohort/edit.php", array('courseid'=>$instance->courseid, 'id'=>$instance->id));
129             $icons[] = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', get_string('edit'), 'core',
130                     array('class' => 'iconsmall')));
131         }
133         return $icons;
134     }
136     /**
137      * Called for all enabled enrol plugins that returned true from is_cron_required().
138      * @return void
139      */
140     public function cron() {
141         global $CFG;
143         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
144         $trace = new null_progress_trace();
145         enrol_cohort_sync($trace);
146         $trace->finished();
147     }
149     /**
150      * Called after updating/inserting course.
151      *
152      * @param bool $inserted true if course just inserted
153      * @param stdClass $course
154      * @param stdClass $data form data
155      * @return void
156      */
157     public function course_updated($inserted, $course, $data) {
158         // It turns out there is no need for cohorts to deal with this hook, see MDL-34870.
159     }
161     /**
162      * Update instance status
163      *
164      * @param stdClass $instance
165      * @param int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
166      * @return void
167      */
168     public function update_status($instance, $newstatus) {
169         global $CFG;
171         parent::update_status($instance, $newstatus);
173         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
174         $trace = new null_progress_trace();
175         enrol_cohort_sync($trace, $instance->courseid);
176         $trace->finished();
177     }
179     /**
180      * Does this plugin allow manual unenrolment of a specific user?
181      * Yes, but only if user suspended...
182      *
183      * @param stdClass $instance course enrol instance
184      * @param stdClass $ue record from user_enrolments table
185      *
186      * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
187      */
188     public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
189         if ($ue->status == ENROL_USER_SUSPENDED) {
190             return true;
191         }
193         return false;
194     }
196     /**
197      * Gets an array of the user enrolment actions.
198      *
199      * @param course_enrolment_manager $manager
200      * @param stdClass $ue A user enrolment object
201      * @return array An array of user_enrolment_actions
202      */
203     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
204         $actions = array();
205         $context = $manager->get_context();
206         $instance = $ue->enrolmentinstance;
207         $params = $manager->get_moodlepage()->url->params();
208         $params['ue'] = $ue->id;
209         if ($this->allow_unenrol_user($instance, $ue) && has_capability('enrol/cohort:unenrol', $context)) {
210             $url = new moodle_url('/enrol/unenroluser.php', $params);
211             $actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
212         }
213         return $actions;
214     }
216     /**
217      * Restore instance and map settings.
218      *
219      * @param restore_enrolments_structure_step $step
220      * @param stdClass $data
221      * @param stdClass $course
222      * @param int $oldid
223      */
224     public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
225         global $DB, $CFG;
227         if (!$step->get_task()->is_samesite()) {
228             // No cohort restore from other sites.
229             $step->set_mapping('enrol', $oldid, 0);
230             return;
231         }
233         if (!empty($data->customint2)) {
234             $data->customint2 = $step->get_mappingid('group', $data->customint2);
235         }
237         if ($data->roleid and $DB->record_exists('cohort', array('id'=>$data->customint1))) {
238             $instance = $DB->get_record('enrol', array('roleid'=>$data->roleid, 'customint1'=>$data->customint1, 'courseid'=>$course->id, 'enrol'=>$this->get_name()));
239             if ($instance) {
240                 $instanceid = $instance->id;
241             } else {
242                 $instanceid = $this->add_instance($course, (array)$data);
243             }
244             $step->set_mapping('enrol', $oldid, $instanceid);
246             require_once("$CFG->dirroot/enrol/cohort/locallib.php");
247             $trace = new null_progress_trace();
248             enrol_cohort_sync($trace, $course->id);
249             $trace->finished();
251         } else if ($this->get_config('unenrolaction') == ENROL_EXT_REMOVED_SUSPENDNOROLES) {
252             $data->customint1 = 0;
253             $instance = $DB->get_record('enrol', array('roleid'=>$data->roleid, 'customint1'=>$data->customint1, 'courseid'=>$course->id, 'enrol'=>$this->get_name()));
255             if ($instance) {
256                 $instanceid = $instance->id;
257             } else {
258                 $data->status = ENROL_INSTANCE_DISABLED;
259                 $instanceid = $this->add_instance($course, (array)$data);
260             }
261             $step->set_mapping('enrol', $oldid, $instanceid);
263             require_once("$CFG->dirroot/enrol/cohort/locallib.php");
264             $trace = new null_progress_trace();
265             enrol_cohort_sync($trace, $course->id);
266             $trace->finished();
268         } else {
269             $step->set_mapping('enrol', $oldid, 0);
270         }
271     }
273     /**
274      * Restore user enrolment.
275      *
276      * @param restore_enrolments_structure_step $step
277      * @param stdClass $data
278      * @param stdClass $instance
279      * @param int $oldinstancestatus
280      * @param int $userid
281      */
282     public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
283         global $DB;
285         if ($this->get_config('unenrolaction') != ENROL_EXT_REMOVED_SUSPENDNOROLES) {
286             // Enrolments were already synchronised in restore_instance(), we do not want any suspended leftovers.
287             return;
288         }
290         // ENROL_EXT_REMOVED_SUSPENDNOROLES means all previous enrolments are restored
291         // but without roles and suspended.
293         if (!$DB->record_exists('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$userid))) {
294             $this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, ENROL_USER_SUSPENDED);
295         }
296     }
298     /**
299      * Restore user group membership.
300      * @param stdClass $instance
301      * @param int $groupid
302      * @param int $userid
303      */
304     public function restore_group_member($instance, $groupid, $userid) {
305         // Nothing to do here, the group members are added in $this->restore_group_restored()
306         return;
307     }
309     /**
310      * Is it possible to hide/show enrol instance via standard UI?
311      *
312      * @param stdClass $instance
313      * @return bool
314      */
315     public function can_hide_show_instance($instance) {
316         $context = context_course::instance($instance->courseid);
317         return has_capability('enrol/cohort:config', $context);
318     }
321 /**
322  * Prevent removal of enrol roles.
323  * @param int $itemid
324  * @param int $groupid
325  * @param int $userid
326  * @return bool
327  */
328 function enrol_cohort_allow_group_member_remove($itemid, $groupid, $userid) {
329     return false;
332 /**
333  * Create a new group with the cohorts name.
334  *
335  * @param int $courseid
336  * @param int $cohortid
337  * @return int $groupid Group ID for this cohort.
338  */
339 function enrol_cohort_create_new_group($courseid, $cohortid) {
340     global $DB;
342     $groupname = $DB->get_field('cohort', 'name', array('id' => $cohortid), MUST_EXIST);
343     $a = new stdClass();
344     $a->name = $groupname;
345     $a->increment = '';
346     $groupname = get_string('defaultgroupnametext', 'enrol_cohort', $a);
347     // Check to see if the cohort group name already exists. Add an incremented number if it does.
348     while ($DB->record_exists('groups', array('name' => $groupname))) {
349         $matches = array();
350         if (!preg_match('/(.*?)\(([0-9]+)\)$/', $groupname, $matches)) {
351             $a->increment = '(2)';
352         } else {
353             $a->increment = '(' . $matches[2]+1 . ')';
354         }
355         $newshortname = get_string('defaultgroupnametext', 'enrol_cohort', $a);
356         $groupname = $newshortname;
357     }
358     // Create a new group for the cohort.
359     $groupdata = new stdClass();
360     $groupdata->courseid = $courseid;
361     $groupdata->name = $groupname;
362     $groupid = groups_create_group($groupdata);
364     return $groupid;