c4a222ebb607debb06da300a18feeba2b548ae4e
[moodle.git] / enrol / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains the course_enrolment_manager class which is used to interface
20  * with the functions that exist in enrollib.php in relation to a single course.
21  *
22  * @package    core
23  * @subpackage enrol
24  * @copyright  2010 Sam Hemelryk
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * This class provides a targeted tied together means of interfacing the enrolment
32  * tasks together with a course.
33  *
34  * It is provided as a convenience more than anything else.
35  *
36  * @copyright 2010 Sam Hemelryk
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class course_enrolment_manager {
41     /**
42      * The course context
43      * @var stdClass
44      */
45     protected $context;
46     /**
47      * The course we are managing enrolments for
48      * @var stdClass
49      */
50     protected $course = null;
51     /**
52      * Limits the focus of the manager to one enrolment plugin instance
53      * @var string
54      */
55     protected $instancefilter = null;
57     /**
58      * The total number of users enrolled in the course
59      * Populated by course_enrolment_manager::get_total_users
60      * @var int
61      */
62     protected $totalusers = null;
63     /**
64      * An array of users currently enrolled in the course
65      * Populated by course_enrolment_manager::get_users
66      * @var array
67      */
68     protected $users = array();
70     /**
71      * An array of users who have roles within this course but who have not
72      * been enrolled in the course
73      * @var array
74      */
75     protected $otherusers = array();
77     /**
78      * The total number of users who hold a role within the course but who
79      * arn't enrolled.
80      * @var int
81      */
82     protected $totalotherusers = null;
84     /**
85      * The current moodle_page object
86      * @var moodle_page
87      */
88     protected $moodlepage = null;
90     /**#@+
91      * These variables are used to cache the information this class uses
92      * please never use these directly instead use their get_ counterparts.
93      * @access private
94      * @var array
95      */
96     private $_instancessql = null;
97     private $_instances = null;
98     private $_inames = null;
99     private $_plugins = null;
100     private $_allplugins = null;
101     private $_roles = null;
102     private $_assignableroles = null;
103     private $_assignablerolesothers = null;
104     private $_groups = null;
105     /**#@-*/
107     /**
108      * Constructs the course enrolment manager
109      *
110      * @param moodle_page $moodlepage
111      * @param stdClass $course
112      * @param string $instancefilter
113      */
114     public function __construct(moodle_page $moodlepage, $course, $instancefilter = null) {
115         $this->moodlepage = $moodlepage;
116         $this->context = context_course::instance($course->id);
117         $this->course = $course;
118         $this->instancefilter = $instancefilter;
119     }
121     /**
122      * Returns the current moodle page
123      * @return moodle_page
124      */
125     public function get_moodlepage() {
126         return $this->moodlepage;
127     }
129     /**
130      * Returns the total number of enrolled users in the course.
131      *
132      * If a filter was specificed this will be the total number of users enrolled
133      * in this course by means of that instance.
134      *
135      * @global moodle_database $DB
136      * @return int
137      */
138     public function get_total_users() {
139         global $DB;
140         if ($this->totalusers === null) {
141             list($instancessql, $params, $filter) = $this->get_instance_sql();
142             $sqltotal = "SELECT COUNT(DISTINCT u.id)
143                            FROM {user} u
144                            JOIN {user_enrolments} ue ON (ue.userid = u.id  AND ue.enrolid $instancessql)
145                            JOIN {enrol} e ON (e.id = ue.enrolid)";
146             $this->totalusers = (int)$DB->count_records_sql($sqltotal, $params);
147         }
148         return $this->totalusers;
149     }
151     /**
152      * Returns the total number of enrolled users in the course.
153      *
154      * If a filter was specificed this will be the total number of users enrolled
155      * in this course by means of that instance.
156      *
157      * @global moodle_database $DB
158      * @return int
159      */
160     public function get_total_other_users() {
161         global $DB;
162         if ($this->totalotherusers === null) {
163             list($ctxcondition, $params) = $DB->get_in_or_equal(get_parent_contexts($this->context, true), SQL_PARAMS_NAMED, 'ctx');
164             $params['courseid'] = $this->course->id;
165             $sql = "SELECT COUNT(DISTINCT u.id)
166                       FROM {role_assignments} ra
167                       JOIN {user} u ON u.id = ra.userid
168                       JOIN {context} ctx ON ra.contextid = ctx.id
169                  LEFT JOIN (
170                            SELECT ue.id, ue.userid
171                              FROM {user_enrolments} ue
172                         LEFT JOIN {enrol} e ON e.id=ue.enrolid
173                             WHERE e.courseid = :courseid
174                          ) ue ON ue.userid=u.id
175                      WHERE ctx.id $ctxcondition AND
176                            ue.id IS NULL";
177             $this->totalotherusers = (int)$DB->count_records_sql($sql, $params);
178         }
179         return $this->totalotherusers;
180     }
182     /**
183      * Gets all of the users enrolled in this course.
184      *
185      * If a filter was specified this will be the users who were enrolled
186      * in this course by means of that instance.
187      *
188      * @global moodle_database $DB
189      * @param string $sort
190      * @param string $direction ASC or DESC
191      * @param int $page First page should be 0
192      * @param int $perpage Defaults to 25
193      * @return array
194      */
195     public function get_users($sort, $direction='ASC', $page=0, $perpage=25) {
196         global $DB;
197         if ($direction !== 'ASC') {
198             $direction = 'DESC';
199         }
200         $key = md5("$sort-$direction-$page-$perpage");
201         if (!array_key_exists($key, $this->users)) {
202             list($instancessql, $params, $filter) = $this->get_instance_sql();
203             $extrafields = get_extra_user_fields($this->get_context());
204             $extrafields[] = 'lastaccess';
205             $ufields = user_picture::fields('u', $extrafields);
206             $sql = "SELECT DISTINCT $ufields, ul.timeaccess AS lastseen
207                       FROM {user} u
208                       JOIN {user_enrolments} ue ON (ue.userid = u.id  AND ue.enrolid $instancessql)
209                       JOIN {enrol} e ON (e.id = ue.enrolid)
210                  LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = u.id)";
211             if ($sort === 'firstname') {
212                 $sql .= " ORDER BY u.firstname $direction, u.lastname $direction";
213             } else if ($sort === 'lastname') {
214                 $sql .= " ORDER BY u.lastname $direction, u.firstname $direction";
215             } else if ($sort === 'email') {
216                 $sql .= " ORDER BY u.email $direction, u.lastname $direction, u.firstname $direction";
217             } else if ($sort === 'lastseen') {
218                 $sql .= " ORDER BY ul.timeaccess $direction, u.lastname $direction, u.firstname $direction";
219             }
220             $this->users[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
221         }
222         return $this->users[$key];
223     }
225     /**
226      * Gets and array of other users.
227      *
228      * Other users are users who have been assigned roles or inherited roles
229      * within this course but who have not been enrolled in the course
230      *
231      * @global moodle_database $DB
232      * @param string $sort
233      * @param string $direction
234      * @param int $page
235      * @param int $perpage
236      * @return array
237      */
238     public function get_other_users($sort, $direction='ASC', $page=0, $perpage=25) {
239         global $DB;
240         if ($direction !== 'ASC') {
241             $direction = 'DESC';
242         }
243         $key = md5("$sort-$direction-$page-$perpage");
244         if (!array_key_exists($key, $this->otherusers)) {
245             list($ctxcondition, $params) = $DB->get_in_or_equal(get_parent_contexts($this->context, true), SQL_PARAMS_NAMED, 'ctx');
246             $params['courseid'] = $this->course->id;
247             $params['cid'] = $this->course->id;
248             $sql = "SELECT ra.id as raid, ra.contextid, ra.component, ctx.contextlevel, ra.roleid, u.*, ue.lastseen
249                     FROM {role_assignments} ra
250                     JOIN {user} u ON u.id = ra.userid
251                     JOIN {context} ctx ON ra.contextid = ctx.id
252                LEFT JOIN (
253                        SELECT ue.id, ue.userid, ul.timeaccess AS lastseen
254                          FROM {user_enrolments} ue
255                     LEFT JOIN {enrol} e ON e.id=ue.enrolid
256                     LEFT JOIN {user_lastaccess} ul ON (ul.courseid = e.courseid AND ul.userid = ue.userid)
257                         WHERE e.courseid = :courseid
258                        ) ue ON ue.userid=u.id
259                    WHERE ctx.id $ctxcondition AND
260                          ue.id IS NULL
261                 ORDER BY u.$sort $direction, ctx.depth DESC";
262             $this->otherusers[$key] = $DB->get_records_sql($sql, $params, $page*$perpage, $perpage);
263         }
264         return $this->otherusers[$key];
265     }
267     /**
268      * Helper method used by {@link get_potential_users()} and {@link search_other_users()}.
269      *
270      * @param string $search the search term, if any.
271      * @param bool $searchanywhere Can the search term be anywhere, or must it be at the start.
272      * @return array with three elements:
273      *     string list of fields to SELECT,
274      *     string contents of SQL WHERE clause,
275      *     array query params. Note that the SQL snippets use named parameters.
276      */
277     protected function get_basic_search_conditions($search, $searchanywhere) {
278         global $DB, $CFG;
280         // Add some additional sensible conditions
281         $tests = array("u.id <> :guestid", 'u.deleted = 0', 'u.confirmed = 1');
282         $params = array('guestid' => $CFG->siteguest);
283         if (!empty($search)) {
284             $conditions = get_extra_user_fields($this->get_context());
285             $conditions[] = 'u.firstname';
286             $conditions[] = 'u.lastname';
287             $conditions[] = $DB->sql_fullname('u.firstname', 'u.lastname');
288             if ($searchanywhere) {
289                 $searchparam = '%' . $search . '%';
290             } else {
291                 $searchparam = $search . '%';
292             }
293             $i = 0;
294             foreach ($conditions as $key => $condition) {
295                 $conditions[$key] = $DB->sql_like($condition, ":con{$i}00", false);
296                 $params["con{$i}00"] = $searchparam;
297                 $i++;
298             }
299             $tests[] = '(' . implode(' OR ', $conditions) . ')';
300         }
301         $wherecondition = implode(' AND ', $tests);
303         $extrafields = get_extra_user_fields($this->get_context(), array('username', 'lastaccess'));
304         $extrafields[] = 'username';
305         $extrafields[] = 'lastaccess';
306         $ufields = user_picture::fields('u', $extrafields);
308         return array($ufields, $params, $wherecondition);
309     }
311     /**
312      * Helper method used by {@link get_potential_users()} and {@link search_other_users()}.
313      *
314      * @param string $search the search string, if any.
315      * @param string $fields the first bit of the SQL when returning some users.
316      * @param string $countfields fhe first bit of the SQL when counting the users.
317      * @param string $sql the bulk of the SQL statement.
318      * @param array $params query parameters.
319      * @param int $page which page number of the results to show.
320      * @param int $perpage number of users per page.
321      * @return array with two elememts:
322      *      int total number of users matching the search.
323      *      array of user objects returned by the query.
324      */
325     protected function execute_search_queries($search, $fields, $countfields, $sql, array $params, $page, $perpage) {
326         global $DB, $CFG;
328         list($sort, $sortparams) = users_order_by_sql('u', $search, $this->get_context());
329         $order = ' ORDER BY ' . $sort;
331         $totalusers = $DB->count_records_sql($countfields . $sql, $params);
332         $availableusers = $DB->get_records_sql($fields . $sql . $order,
333                 array_merge($params, $sortparams), $page*$perpage, $perpage);
335         return array('totalusers' => $totalusers, 'users' => $availableusers);
336     }
338     /**
339      * Gets an array of the users that can be enrolled in this course.
340      *
341      * @global moodle_database $DB
342      * @param int $enrolid
343      * @param string $search
344      * @param bool $searchanywhere
345      * @param int $page Defaults to 0
346      * @param int $perpage Defaults to 25
347      * @return array Array(totalusers => int, users => array)
348      */
349     public function get_potential_users($enrolid, $search='', $searchanywhere=false, $page=0, $perpage=25) {
350         global $DB;
352         list($ufields, $params, $wherecondition) = $this->get_basic_search_conditions($search, $searchanywhere);
354         $fields      = 'SELECT '.$ufields;
355         $countfields = 'SELECT COUNT(1)';
356         $sql = " FROM {user} u
357             LEFT JOIN {user_enrolments} ue ON (ue.userid = u.id AND ue.enrolid = :enrolid)
358                 WHERE $wherecondition
359                       AND ue.id IS NULL";
360         $params['enrolid'] = $enrolid;
362         return $this->execute_search_queries($search, $fields, $countfields, $sql, $params, $page, $perpage);
363     }
365     /**
366      * Searches other users and returns paginated results
367      *
368      * @global moodle_database $DB
369      * @param string $search
370      * @param bool $searchanywhere
371      * @param int $page Starting at 0
372      * @param int $perpage
373      * @return array
374      */
375     public function search_other_users($search='', $searchanywhere=false, $page=0, $perpage=25) {
376         global $DB, $CFG;
378         list($ufields, $params, $wherecondition) = $this->get_basic_search_conditions($search, $searchanywhere);
380         $fields      = 'SELECT ' . $ufields;
381         $countfields = 'SELECT COUNT(u.id)';
382         $sql   = " FROM {user} u
383               LEFT JOIN {role_assignments} ra ON (ra.userid = u.id AND ra.contextid = :contextid)
384                   WHERE $wherecondition
385                     AND ra.id IS NULL";
386         $params['contextid'] = $this->context->id;
388         return $this->execute_search_queries($search, $fields, $countfields, $sql, $params, $page, $perpage);
389     }
391     /**
392      * Gets an array containing some SQL to user for when selecting, params for
393      * that SQL, and the filter that was used in constructing the sql.
394      *
395      * @global moodle_database $DB
396      * @return string
397      */
398     protected function get_instance_sql() {
399         global $DB;
400         if ($this->_instancessql === null) {
401             $instances = $this->get_enrolment_instances();
402             $filter = $this->get_enrolment_filter();
403             if ($filter && array_key_exists($filter, $instances)) {
404                 $sql = " = :ifilter";
405                 $params = array('ifilter'=>$filter);
406             } else {
407                 $filter = 0;
408                 if ($instances) {
409                     list($sql, $params) = $DB->get_in_or_equal(array_keys($this->get_enrolment_instances()), SQL_PARAMS_NAMED);
410                 } else {
411                     // no enabled instances, oops, we should probably say something
412                     $sql = "= :never";
413                     $params = array('never'=>-1);
414                 }
415             }
416             $this->instancefilter = $filter;
417             $this->_instancessql = array($sql, $params, $filter);
418         }
419         return $this->_instancessql;
420     }
422     /**
423      * Returns all of the enrolment instances for this course.
424      *
425      * NOTE: since 2.4 it includes instances of disabled plugins too.
426      *
427      * @return array
428      */
429     public function get_enrolment_instances() {
430         if ($this->_instances === null) {
431             $this->_instances = enrol_get_instances($this->course->id, false);
432         }
433         return $this->_instances;
434     }
436     /**
437      * Returns the names for all of the enrolment instances for this course.
438      *
439      * NOTE: since 2.4 it includes instances of disabled plugins too.
440      *
441      * @return array
442      */
443     public function get_enrolment_instance_names() {
444         if ($this->_inames === null) {
445             $instances = $this->get_enrolment_instances();
446             $plugins = $this->get_enrolment_plugins(false);
447             foreach ($instances as $key=>$instance) {
448                 if (!isset($plugins[$instance->enrol])) {
449                     // weird, some broken stuff in plugin
450                     unset($instances[$key]);
451                     continue;
452                 }
453                 $this->_inames[$key] = $plugins[$instance->enrol]->get_instance_name($instance);
454             }
455         }
456         return $this->_inames;
457     }
459     /**
460      * Gets all of the enrolment plugins that are active for this course.
461      *
462      * @param bool $onlyenabled return only enabled enrol plugins
463      * @return array
464      */
465     public function get_enrolment_plugins($onlyenabled = true) {
466         if ($this->_plugins === null) {
467             $this->_plugins = enrol_get_plugins(true);
468         }
470         if ($onlyenabled) {
471             return $this->_plugins;
472         }
474         if ($this->_allplugins === null) {
475             // Make sure we have the same objects in _allplugins and _plugins.
476             $this->_allplugins = $this->_plugins;
477             foreach (enrol_get_plugins(false) as $name=>$plugin) {
478                 if (!isset($this->_allplugins[$name])) {
479                     $this->_allplugins[$name] = $plugin;
480                 }
481             }
482         }
484         return $this->_allplugins;
485     }
487     /**
488      * Gets all of the roles this course can contain.
489      *
490      * @return array
491      */
492     public function get_all_roles() {
493         if ($this->_roles === null) {
494             $this->_roles = role_fix_names(get_all_roles($this->context), $this->context);
495         }
496         return $this->_roles;
497     }
499     /**
500      * Gets all of the assignable roles for this course.
501      *
502      * @return array
503      */
504     public function get_assignable_roles($otherusers = false) {
505         if ($this->_assignableroles === null) {
506             $this->_assignableroles = get_assignable_roles($this->context, ROLENAME_ALIAS, false); // verifies unassign access control too
507         }
509         if ($otherusers) {
510             if (!is_array($this->_assignablerolesothers)) {
511                 $this->_assignablerolesothers = array();
512                 list($courseviewroles, $ignored) = get_roles_with_cap_in_context($this->context, 'moodle/course:view');
513                 foreach ($this->_assignableroles as $roleid=>$role) {
514                     if (isset($courseviewroles[$roleid])) {
515                         $this->_assignablerolesothers[$roleid] = $role;
516                     }
517                 }
518             }
519             return $this->_assignablerolesothers;
520         } else {
521             return $this->_assignableroles;
522         }
523     }
525     /**
526      * Gets all of the groups for this course.
527      *
528      * @return array
529      */
530     public function get_all_groups() {
531         if ($this->_groups === null) {
532             $this->_groups = groups_get_all_groups($this->course->id);
533             foreach ($this->_groups as $gid=>$group) {
534                 $this->_groups[$gid]->name = format_string($group->name);
535             }
536         }
537         return $this->_groups;
538     }
540     /**
541      * Unenrols a user from the course given the users ue entry
542      *
543      * @global moodle_database $DB
544      * @param stdClass $ue
545      * @return bool
546      */
547     public function unenrol_user($ue) {
548         global $DB;
549         list ($instance, $plugin) = $this->get_user_enrolment_components($ue);
550         if ($instance && $plugin && $plugin->allow_unenrol_user($instance, $ue) && has_capability("enrol/$instance->enrol:unenrol", $this->context)) {
551             $plugin->unenrol_user($instance, $ue->userid);
552             return true;
553         }
554         return false;
555     }
557     /**
558      * Given a user enrolment record this method returns the plugin and enrolment
559      * instance that relate to it.
560      *
561      * @param stdClass|int $userenrolment
562      * @return array array($instance, $plugin)
563      */
564     public function get_user_enrolment_components($userenrolment) {
565         global $DB;
566         if (is_numeric($userenrolment)) {
567             $userenrolment = $DB->get_record('user_enrolments', array('id'=>(int)$userenrolment));
568         }
569         $instances = $this->get_enrolment_instances();
570         $plugins = $this->get_enrolment_plugins(false);
571         if (!$userenrolment || !isset($instances[$userenrolment->enrolid])) {
572             return array(false, false);
573         }
574         $instance = $instances[$userenrolment->enrolid];
575         $plugin = $plugins[$instance->enrol];
576         return array($instance, $plugin);
577     }
579     /**
580      * Removes an assigned role from a user.
581      *
582      * @global moodle_database $DB
583      * @param int $userid
584      * @param int $roleid
585      * @return bool
586      */
587     public function unassign_role_from_user($userid, $roleid) {
588         global $DB;
589         // Admins may unassign any role, others only those they could assign.
590         if (!is_siteadmin() and !array_key_exists($roleid, $this->get_assignable_roles())) {
591             if (defined('AJAX_SCRIPT')) {
592                 throw new moodle_exception('invalidrole');
593             }
594             return false;
595         }
596         $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
597         $ras = $DB->get_records('role_assignments', array('contextid'=>$this->context->id, 'userid'=>$user->id, 'roleid'=>$roleid));
598         foreach ($ras as $ra) {
599             if ($ra->component) {
600                 if (strpos($ra->component, 'enrol_') !== 0) {
601                     continue;
602                 }
603                 if (!$plugin = enrol_get_plugin(substr($ra->component, 6))) {
604                     continue;
605                 }
606                 if ($plugin->roles_protected()) {
607                     continue;
608                 }
609             }
610             role_unassign($ra->roleid, $ra->userid, $ra->contextid, $ra->component, $ra->itemid);
611         }
612         return true;
613     }
615     /**
616      * Assigns a role to a user.
617      *
618      * @param int $roleid
619      * @param int $userid
620      * @return int|false
621      */
622     public function assign_role_to_user($roleid, $userid) {
623         require_capability('moodle/role:assign', $this->context);
624         if (!array_key_exists($roleid, $this->get_assignable_roles())) {
625             if (defined('AJAX_SCRIPT')) {
626                 throw new moodle_exception('invalidrole');
627             }
628             return false;
629         }
630         return role_assign($roleid, $userid, $this->context->id, '', NULL);
631     }
633     /**
634      * Adds a user to a group
635      *
636      * @param stdClass $user
637      * @param int $groupid
638      * @return bool
639      */
640     public function add_user_to_group($user, $groupid) {
641         require_capability('moodle/course:managegroups', $this->context);
642         $group = $this->get_group($groupid);
643         if (!$group) {
644             return false;
645         }
646         return groups_add_member($group->id, $user->id);
647     }
649     /**
650      * Removes a user from a group
651      *
652      * @global moodle_database $DB
653      * @param StdClass $user
654      * @param int $groupid
655      * @return bool
656      */
657     public function remove_user_from_group($user, $groupid) {
658         global $DB;
659         require_capability('moodle/course:managegroups', $this->context);
660         $group = $this->get_group($groupid);
661         if (!groups_remove_member_allowed($group, $user)) {
662             return false;
663         }
664         if (!$group) {
665             return false;
666         }
667         return groups_remove_member($group, $user);
668     }
670     /**
671      * Gets the requested group
672      *
673      * @param int $groupid
674      * @return stdClass|int
675      */
676     public function get_group($groupid) {
677         $groups = $this->get_all_groups();
678         if (!array_key_exists($groupid, $groups)) {
679             return false;
680         }
681         return $groups[$groupid];
682     }
684     /**
685      * Edits an enrolment
686      *
687      * @param stdClass $userenrolment
688      * @param stdClass $data
689      * @return bool
690      */
691     public function edit_enrolment($userenrolment, $data) {
692         //Only allow editing if the user has the appropriate capability
693         //Already checked in /enrol/users.php but checking again in case this function is called from elsewhere
694         list($instance, $plugin) = $this->get_user_enrolment_components($userenrolment);
695         if ($instance && $plugin && $plugin->allow_manage($instance) && has_capability("enrol/$instance->enrol:manage", $this->context)) {
696             if (!isset($data->status)) {
697                 $data->status = $userenrolment->status;
698             }
699             $plugin->update_user_enrol($instance, $userenrolment->userid, $data->status, $data->timestart, $data->timeend);
700             return true;
701         }
702         return false;
703     }
705     /**
706      * Returns the current enrolment filter that is being applied by this class
707      * @return string
708      */
709     public function get_enrolment_filter() {
710         return $this->instancefilter;
711     }
713     /**
714      * Gets the roles assigned to this user that are applicable for this course.
715      *
716      * @param int $userid
717      * @return array
718      */
719     public function get_user_roles($userid) {
720         $roles = array();
721         $ras = get_user_roles($this->context, $userid, true, 'c.contextlevel DESC, r.sortorder ASC');
722         $plugins = $this->get_enrolment_plugins(false);
723         foreach ($ras as $ra) {
724             if ($ra->contextid != $this->context->id) {
725                 if (!array_key_exists($ra->roleid, $roles)) {
726                     $roles[$ra->roleid] = null;
727                 }
728                 // higher ras, course always takes precedence
729                 continue;
730             }
731             if (array_key_exists($ra->roleid, $roles) && $roles[$ra->roleid] === false) {
732                 continue;
733             }
734             $changeable = true;
735             if ($ra->component) {
736                 $changeable = false;
737                 if (strpos($ra->component, 'enrol_') === 0) {
738                     $plugin = substr($ra->component, 6);
739                     if (isset($plugins[$plugin])) {
740                         $changeable = !$plugins[$plugin]->roles_protected();
741                     }
742                 }
743             }
745             $roles[$ra->roleid] = $changeable;
746         }
747         return $roles;
748     }
750     /**
751      * Gets the enrolments this user has in the course - including all suspended plugins and instances.
752      *
753      * @global moodle_database $DB
754      * @param int $userid
755      * @return array
756      */
757     public function get_user_enrolments($userid) {
758         global $DB;
759         list($instancessql, $params, $filter) = $this->get_instance_sql();
760         $params['userid'] = $userid;
761         $userenrolments = $DB->get_records_select('user_enrolments', "enrolid $instancessql AND userid = :userid", $params);
762         $instances = $this->get_enrolment_instances();
763         $plugins = $this->get_enrolment_plugins(false);
764         $inames = $this->get_enrolment_instance_names();
765         foreach ($userenrolments as &$ue) {
766             $ue->enrolmentinstance     = $instances[$ue->enrolid];
767             $ue->enrolmentplugin       = $plugins[$ue->enrolmentinstance->enrol];
768             $ue->enrolmentinstancename = $inames[$ue->enrolmentinstance->id];
769         }
770         return $userenrolments;
771     }
773     /**
774      * Gets the groups this user belongs to
775      *
776      * @param int $userid
777      * @return array
778      */
779     public function get_user_groups($userid) {
780         return groups_get_all_groups($this->course->id, $userid, 0, 'g.id');
781     }
783     /**
784      * Retursn an array of params that would go into the URL to return to this
785      * exact page.
786      *
787      * @return array
788      */
789     public function get_url_params() {
790         $args = array(
791             'id' => $this->course->id
792         );
793         if (!empty($this->instancefilter)) {
794             $args['ifilter'] = $this->instancefilter;
795         }
796         return $args;
797     }
799     /**
800      * Returns the course this object is managing enrolments for
801      *
802      * @return stdClass
803      */
804     public function get_course() {
805         return $this->course;
806     }
808     /**
809      * Returns the course context
810      *
811      * @return stdClass
812      */
813     public function get_context() {
814         return $this->context;
815     }
817     /**
818      * Gets an array of other users in this course ready for display.
819      *
820      * Other users are users who have been assigned or inherited roles within this
821      * course but have not been enrolled.
822      *
823      * @param core_enrol_renderer $renderer
824      * @param moodle_url $pageurl
825      * @param string $sort
826      * @param string $direction ASC | DESC
827      * @param int $page Starting from 0
828      * @param int $perpage
829      * @return array
830      */
831     public function get_other_users_for_display(core_enrol_renderer $renderer, moodle_url $pageurl, $sort, $direction, $page, $perpage) {
833         $userroles = $this->get_other_users($sort, $direction, $page, $perpage);
834         $roles = $this->get_all_roles();
835         $plugins = $this->get_enrolment_plugins(false);
837         $context    = $this->get_context();
838         $now = time();
839         $extrafields = get_extra_user_fields($context);
841         $users = array();
842         foreach ($userroles as $userrole) {
843             $contextid = $userrole->contextid;
844             unset($userrole->contextid); // This would collide with user avatar.
845             if (!array_key_exists($userrole->id, $users)) {
846                 $users[$userrole->id] = $this->prepare_user_for_display($userrole, $extrafields, $now);
847             }
848             $a = new stdClass;
849             $a->role = $roles[$userrole->roleid]->localname;
850             if ($contextid == $this->context->id) {
851                 $changeable = true;
852                 if ($userrole->component) {
853                     $changeable = false;
854                     if (strpos($userrole->component, 'enrol_') === 0) {
855                         $plugin = substr($userrole->component, 6);
856                         if (isset($plugins[$plugin])) {
857                             $changeable = !$plugin[$plugin]->roles_protected();
858                         }
859                     }
860                 }
861                 $roletext = get_string('rolefromthiscourse', 'enrol', $a);
862             } else {
863                 $changeable = false;
864                 switch ($userrole->contextlevel) {
865                     case CONTEXT_COURSE :
866                         // Meta course
867                         $roletext = get_string('rolefrommetacourse', 'enrol', $a);
868                         break;
869                     case CONTEXT_COURSECAT :
870                         $roletext = get_string('rolefromcategory', 'enrol', $a);
871                         break;
872                     case CONTEXT_SYSTEM:
873                     default:
874                         $roletext = get_string('rolefromsystem', 'enrol', $a);
875                         break;
876                 }
877             }
878             $users[$userrole->id]['roles'] = array();
879             $users[$userrole->id]['roles'][$userrole->roleid] = array(
880                 'text' => $roletext,
881                 'unchangeable' => !$changeable
882             );
883         }
884         return $users;
885     }
887     /**
888      * Gets an array of users for display, this includes minimal user information
889      * as well as minimal information on the users roles, groups, and enrolments.
890      *
891      * @param core_enrol_renderer $renderer
892      * @param moodle_url $pageurl
893      * @param int $sort
894      * @param string $direction ASC or DESC
895      * @param int $page
896      * @param int $perpage
897      * @return array
898      */
899     public function get_users_for_display(course_enrolment_manager $manager, $sort, $direction, $page, $perpage) {
900         $pageurl = $manager->get_moodlepage()->url;
901         $users = $this->get_users($sort, $direction, $page, $perpage);
903         $now = time();
904         $straddgroup = get_string('addgroup', 'group');
905         $strunenrol = get_string('unenrol', 'enrol');
906         $stredit = get_string('edit');
908         $allroles   = $this->get_all_roles();
909         $assignable = $this->get_assignable_roles();
910         $allgroups  = $this->get_all_groups();
911         $context    = $this->get_context();
912         $canmanagegroups = has_capability('moodle/course:managegroups', $context);
914         $url = new moodle_url($pageurl, $this->get_url_params());
915         $extrafields = get_extra_user_fields($context);
917         $enabledplugins = $this->get_enrolment_plugins(true);
919         $userdetails = array();
920         foreach ($users as $user) {
921             $details = $this->prepare_user_for_display($user, $extrafields, $now);
923             // Roles
924             $details['roles'] = array();
925             foreach ($this->get_user_roles($user->id) as $rid=>$rassignable) {
926                 $unchangeable = !$rassignable;
927                 if (!is_siteadmin() and !isset($assignable[$rid])) {
928                     $unchangeable = true;
929                 }
930                 $details['roles'][$rid] = array('text'=>$allroles[$rid]->localname, 'unchangeable'=>$unchangeable);
931             }
933             // Users
934             $usergroups = $this->get_user_groups($user->id);
935             $details['groups'] = array();
936             foreach($usergroups as $gid=>$unused) {
937                 $details['groups'][$gid] = $allgroups[$gid]->name;
938             }
940             // Enrolments
941             $details['enrolments'] = array();
942             foreach ($this->get_user_enrolments($user->id) as $ue) {
943                 if (!isset($enabledplugins[$ue->enrolmentinstance->enrol])) {
944                     $details['enrolments'][$ue->id] = array(
945                         'text' => $ue->enrolmentinstancename,
946                         'period' => null,
947                         'dimmed' =>  true,
948                         'actions' => array()
949                     );
950                     continue;
951                 } else if ($ue->timestart and $ue->timeend) {
952                     $period = get_string('periodstartend', 'enrol', array('start'=>userdate($ue->timestart), 'end'=>userdate($ue->timeend)));
953                     $periodoutside = ($ue->timestart && $ue->timeend && $now < $ue->timestart && $now > $ue->timeend);
954                 } else if ($ue->timestart) {
955                     $period = get_string('periodstart', 'enrol', userdate($ue->timestart));
956                     $periodoutside = ($ue->timestart && $now < $ue->timestart);
957                 } else if ($ue->timeend) {
958                     $period = get_string('periodend', 'enrol', userdate($ue->timeend));
959                     $periodoutside = ($ue->timeend && $now > $ue->timeend);
960                 } else {
961                     // If there is no start or end show when user was enrolled.
962                     $period = get_string('periodnone', 'enrol', userdate($ue->timecreated));
963                     $periodoutside = false;
964                 }
965                 $details['enrolments'][$ue->id] = array(
966                     'text' => $ue->enrolmentinstancename,
967                     'period' => $period,
968                     'dimmed' =>  ($periodoutside or $ue->status != ENROL_USER_ACTIVE or $ue->enrolmentinstance->status != ENROL_INSTANCE_ENABLED),
969                     'actions' => $ue->enrolmentplugin->get_user_enrolment_actions($manager, $ue)
970                 );
971             }
972             $userdetails[$user->id] = $details;
973         }
974         return $userdetails;
975     }
977     /**
978      * Prepare a user record for display
979      *
980      * This function is called by both {@link get_users_for_display} and {@link get_other_users_for_display} to correctly
981      * prepare user fields for display
982      *
983      * Please note that this function does not check capability for moodle/coures:viewhiddenuserfields
984      *
985      * @param object $user The user record
986      * @param array $extrafields The list of fields as returned from get_extra_user_fields used to determine which
987      * additional fields may be displayed
988      * @param int $now The time used for lastaccess calculation
989      * @return array The fields to be displayed including userid, courseid, picture, firstname, lastseen and any
990      * additional fields from $extrafields
991      */
992     private function prepare_user_for_display($user, $extrafields, $now) {
993         $details = array(
994             'userid'    => $user->id,
995             'courseid'  => $this->get_course()->id,
996             'picture'   => new user_picture($user),
997             'firstname' => fullname($user, has_capability('moodle/site:viewfullnames', $this->get_context())),
998             'lastseen'  => get_string('never'),
999         );
1000         foreach ($extrafields as $field) {
1001             $details[$field] = $user->{$field};
1002         }
1004         if ($user->lastaccess) {
1005             $details['lastseen'] = format_time($now - $user->lastaccess);
1006         }
1007         return $details;
1008     }
1010     public function get_manual_enrol_buttons() {
1011         $plugins = $this->get_enrolment_plugins(true); // Skip disabled plugins.
1012         $buttons = array();
1013         foreach ($plugins as $plugin) {
1014             $newbutton = $plugin->get_manual_enrol_button($this);
1015             if (is_array($newbutton)) {
1016                 $buttons += $newbutton;
1017             } else if ($newbutton instanceof enrol_user_button) {
1018                 $buttons[] = $newbutton;
1019             }
1020         }
1021         return $buttons;
1022     }
1024     public function has_instance($enrolpluginname) {
1025         // Make sure manual enrolments instance exists
1026         foreach ($this->get_enrolment_instances() as $instance) {
1027             if ($instance->enrol == $enrolpluginname) {
1028                 return true;
1029             }
1030         }
1031         return false;
1032     }
1034     /**
1035      * Returns the enrolment plugin that the course manager was being filtered to.
1036      *
1037      * If no filter was being applied then this function returns false.
1038      *
1039      * @return enrol_plugin
1040      */
1041     public function get_filtered_enrolment_plugin() {
1042         $instances = $this->get_enrolment_instances();
1043         $plugins = $this->get_enrolment_plugins(false);
1045         if (empty($this->instancefilter) || !array_key_exists($this->instancefilter, $instances)) {
1046             return false;
1047         }
1049         $instance = $instances[$this->instancefilter];
1050         return $plugins[$instance->enrol];
1051     }
1053     /**
1054      * Returns and array of users + enrolment details.
1055      *
1056      * Given an array of user id's this function returns and array of user enrolments for those users
1057      * as well as enough user information to display the users name and picture for each enrolment.
1058      *
1059      * @global moodle_database $DB
1060      * @param array $userids
1061      * @return array
1062      */
1063     public function get_users_enrolments(array $userids) {
1064         global $DB;
1066         $instances = $this->get_enrolment_instances();
1067         $plugins = $this->get_enrolment_plugins(false);
1069         if  (!empty($this->instancefilter)) {
1070             $instancesql = ' = :instanceid';
1071             $instanceparams = array('instanceid' => $this->instancefilter);
1072         } else {
1073             list($instancesql, $instanceparams) = $DB->get_in_or_equal(array_keys($instances), SQL_PARAMS_NAMED, 'instanceid0000');
1074         }
1076         $userfields = user_picture::fields('u');
1077         list($idsql, $idparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED, 'userid0000');
1079         list($sort, $sortparams) = users_order_by_sql('u');
1081         $sql = "SELECT ue.id AS ueid, ue.status, ue.enrolid, ue.userid, ue.timestart, ue.timeend, ue.modifierid, ue.timecreated, ue.timemodified, $userfields
1082                   FROM {user_enrolments} ue
1083              LEFT JOIN {user} u ON u.id = ue.userid
1084                  WHERE ue.enrolid $instancesql AND
1085                        u.id $idsql
1086               ORDER BY $sort";
1088         $rs = $DB->get_recordset_sql($sql, $idparams + $instanceparams + $sortparams);
1089         $users = array();
1090         foreach ($rs as $ue) {
1091             $user = user_picture::unalias($ue);
1092             $ue->id = $ue->ueid;
1093             unset($ue->ueid);
1094             if (!array_key_exists($user->id, $users)) {
1095                 $user->enrolments = array();
1096                 $users[$user->id] = $user;
1097             }
1098             $ue->enrolmentinstance = $instances[$ue->enrolid];
1099             $ue->enrolmentplugin = $plugins[$ue->enrolmentinstance->enrol];
1100             $users[$user->id]->enrolments[$ue->id] = $ue;
1101         }
1102         $rs->close();
1103         return $users;
1104     }
1107 /**
1108  * A button that is used to enrol users in a course
1109  *
1110  * @copyright 2010 Sam Hemelryk
1111  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1112  */
1113 class enrol_user_button extends single_button {
1115     /**
1116      * An array containing JS YUI modules required by this button
1117      * @var array
1118      */
1119     protected $jsyuimodules = array();
1121     /**
1122      * An array containing JS initialisation calls required by this button
1123      * @var array
1124      */
1125     protected $jsinitcalls = array();
1127     /**
1128      * An array strings required by JS for this button
1129      * @var array
1130      */
1131     protected $jsstrings = array();
1133     /**
1134      * Initialises the new enrol_user_button
1135      *
1136      * @staticvar int $count The number of enrol user buttons already created
1137      * @param moodle_url $url
1138      * @param string $label The text to display in the button
1139      * @param string $method Either post or get
1140      */
1141     public function __construct(moodle_url $url, $label, $method = 'post') {
1142         static $count = 0;
1143         $count ++;
1144         parent::__construct($url, $label, $method);
1145         $this->class = 'singlebutton enrolusersbutton';
1146         $this->formid = 'enrolusersbutton-'.$count;
1147     }
1149     /**
1150      * Adds a YUI module call that will be added to the page when the button is used.
1151      *
1152      * @param string|array $modules One or more modules to require
1153      * @param string $function The JS function to call
1154      * @param array $arguments An array of arguments to pass to the function
1155      * @param string $galleryversion The YUI gallery version of any modules required
1156      * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1157      */
1158     public function require_yui_module($modules, $function, array $arguments = null, $galleryversion = '2010.04.08-12-35', $ondomready = false) {
1159         $js = new stdClass;
1160         $js->modules = (array)$modules;
1161         $js->function = $function;
1162         $js->arguments = $arguments;
1163         $js->galleryversion = $galleryversion;
1164         $js->ondomready = $ondomready;
1165         $this->jsyuimodules[] = $js;
1166     }
1168     /**
1169      * Adds a JS initialisation call to the page when the button is used.
1170      *
1171      * @param string $function The function to call
1172      * @param array $extraarguments An array of arguments to pass to the function
1173      * @param bool $ondomready If true the call is postponed until the DOM is finished loading
1174      * @param array $module A module definition
1175      */
1176     public function require_js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
1177         $js = new stdClass;
1178         $js->function = $function;
1179         $js->extraarguments = $extraarguments;
1180         $js->ondomready = $ondomready;
1181         $js->module = $module;
1182         $this->jsinitcalls[] = $js;
1183     }
1185     /**
1186      * Requires strings for JS that will be loaded when the button is used.
1187      *
1188      * @param type $identifiers
1189      * @param string $component
1190      * @param mixed $a
1191      */
1192     public function strings_for_js($identifiers, $component = 'moodle', $a = null) {
1193         $string = new stdClass;
1194         $string->identifiers = (array)$identifiers;
1195         $string->component = $component;
1196         $string->a = $a;
1197         $this->jsstrings[] = $string;
1198     }
1200     /**
1201      * Initialises the JS that is required by this button
1202      *
1203      * @param moodle_page $page
1204      */
1205     public function initialise_js(moodle_page $page) {
1206         foreach ($this->jsyuimodules as $js) {
1207             $page->requires->yui_module($js->modules, $js->function, $js->arguments, $js->galleryversion, $js->ondomready);
1208         }
1209         foreach ($this->jsinitcalls as $js) {
1210             $page->requires->js_init_call($js->function, $js->extraarguments, $js->ondomready, $js->module);
1211         }
1212         foreach ($this->jsstrings as $string) {
1213             $page->requires->strings_for_js($string->identifiers, $string->component, $string->a);
1214         }
1215     }
1218 /**
1219  * User enrolment action
1220  *
1221  * This class is used to manage a renderable ue action such as editing an user enrolment or deleting
1222  * a user enrolment.
1223  *
1224  * @copyright  2011 Sam Hemelryk
1225  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1226  */
1227 class user_enrolment_action implements renderable {
1229     /**
1230      * The icon to display for the action
1231      * @var pix_icon
1232      */
1233     protected $icon;
1235     /**
1236      * The title for the action
1237      * @var string
1238      */
1239     protected $title;
1241     /**
1242      * The URL to the action
1243      * @var moodle_url
1244      */
1245     protected $url;
1247     /**
1248      * An array of HTML attributes
1249      * @var array
1250      */
1251     protected $attributes = array();
1253     /**
1254      * Constructor
1255      * @param pix_icon $icon
1256      * @param string $title
1257      * @param moodle_url $url
1258      * @param array $attributes
1259      */
1260     public function __construct(pix_icon $icon, $title, $url, array $attributes = null) {
1261         $this->icon = $icon;
1262         $this->title = $title;
1263         $this->url = new moodle_url($url);
1264         if (!empty($attributes)) {
1265             $this->attributes = $attributes;
1266         }
1267         $this->attributes['title'] = $title;
1268     }
1270     /**
1271      * Returns the icon for this action
1272      * @return pix_icon
1273      */
1274     public function get_icon() {
1275         return $this->icon;
1276     }
1278     /**
1279      * Returns the title for this action
1280      * @return string
1281      */
1282     public function get_title() {
1283         return $this->title;
1284     }
1286     /**
1287      * Returns the URL for this action
1288      * @return moodle_url
1289      */
1290     public function get_url() {
1291         return $this->url;
1292     }
1294     /**
1295      * Returns the attributes to use for this action
1296      * @return array
1297      */
1298     public function get_attributes() {
1299         return $this->attributes;
1300     }
1303 class enrol_ajax_exception extends moodle_exception {
1304     /**
1305      * Constructor
1306      * @param string $errorcode The name of the string from error.php to print
1307      * @param string $module name of module
1308      * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
1309      * @param object $a Extra words and phrases that might be required in the error string
1310      * @param string $debuginfo optional debugging information
1311      */
1312     public function __construct($errorcode, $link = '', $a = NULL, $debuginfo = null) {
1313         parent::__construct($errorcode, 'enrol', $link, $a, $debuginfo);
1314     }
1317 /**
1318  * This class is used to manage a bulk operations for enrolment plugins.
1319  *
1320  * @copyright 2011 Sam Hemelryk
1321  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1322  */
1323 abstract class enrol_bulk_enrolment_operation {
1325     /**
1326      * The course enrolment manager
1327      * @var course_enrolment_manager
1328      */
1329     protected $manager;
1331     /**
1332      * The enrolment plugin to which this operation belongs
1333      * @var enrol_plugin
1334      */
1335     protected $plugin;
1337     /**
1338      * Contructor
1339      * @param course_enrolment_manager $manager
1340      * @param stdClass $plugin
1341      */
1342     public function __construct(course_enrolment_manager $manager, enrol_plugin $plugin = null) {
1343         $this->manager = $manager;
1344         $this->plugin = $plugin;
1345     }
1347     /**
1348      * Returns a moodleform used for this operation, or false if no form is required and the action
1349      * should be immediatly processed.
1350      *
1351      * @param moodle_url|string $defaultaction
1352      * @param mixed $defaultcustomdata
1353      * @return enrol_bulk_enrolment_change_form|moodleform|false
1354      */
1355     public function get_form($defaultaction = null, $defaultcustomdata = null) {
1356         return false;
1357     }
1359     /**
1360      * Returns the title to use for this bulk operation
1361      *
1362      * @return string
1363      */
1364     abstract public function get_title();
1366     /**
1367      * Returns the identifier for this bulk operation.
1368      * This should be the same identifier used by the plugins function when returning
1369      * all of its bulk operations.
1370      *
1371      * @return string
1372      */
1373     abstract public function get_identifier();
1375     /**
1376      * Processes the bulk operation on the given users
1377      *
1378      * @param course_enrolment_manager $manager
1379      * @param array $users
1380      * @param stdClass $properties
1381      */
1382     abstract public function process(course_enrolment_manager $manager, array $users, stdClass $properties);