Merge branch 'MDL-38474-master' of git://github.com/FMCorz/moodle
[moodle.git] / enrol / manual / ajax.php
CommitLineData
cf855c0b
SH
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/>.
16
17/**
18 * This file processes AJAX enrolment actions and returns JSON for the manual enrolments plugin
19 *
20 * The general idea behind this file is that any errors should throw exceptions
21 * which will be returned and acted upon by the calling AJAX script.
22 *
6f6c9e5c 23 * @package enrol_manual
cf855c0b
SH
24 * @copyright 2010 Sam Hemelryk
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
28define('AJAX_SCRIPT', true);
29
30require('../../config.php');
31require_once($CFG->dirroot.'/enrol/locallib.php');
32require_once($CFG->dirroot.'/group/lib.php');
33
6f6c9e5c 34$id = required_param('id', PARAM_INT); // Course id.
405aca35 35$action = required_param('action', PARAM_ALPHANUMEXT);
cf855c0b
SH
36
37$PAGE->set_url(new moodle_url('/enrol/ajax.php', array('id'=>$id, 'action'=>$action)));
38
39$course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
55bcef29 40$context = context_course::instance($course->id, MUST_EXIST);
cf855c0b
SH
41
42if ($course->id == SITEID) {
43 throw new moodle_exception('invalidcourse');
44}
45
46require_login($course);
47require_capability('moodle/course:enrolreview', $context);
48require_sesskey();
49
6f6c9e5c 50echo $OUTPUT->header(); // Send headers.
cf855c0b 51
076995bf 52$manager = new course_enrolment_manager($PAGE, $course);
cf855c0b 53
13bd955e 54$outcome = new stdClass();
cf855c0b 55$outcome->success = true;
13bd955e 56$outcome->response = new stdClass();
cf855c0b
SH
57$outcome->error = '';
58
e059c033
TH
59$searchanywhere = get_user_preferences('userselector_searchanywhere', false);
60
cf855c0b
SH
61switch ($action) {
62 case 'getassignable':
63 $otheruserroles = optional_param('otherusers', false, PARAM_BOOL);
64 $outcome->response = array_reverse($manager->get_assignable_roles($otheruserroles), true);
65 break;
66 case 'searchusers':
67 $enrolid = required_param('enrolid', PARAM_INT);
e059c033 68 $search = optional_param('search', '', PARAM_RAW);
cf855c0b 69 $page = optional_param('page', 0, PARAM_INT);
4be3ed4b 70 $addedenrollment = optional_param('enrolcount', 0, PARAM_INT);
62a973ce 71 $perpage = optional_param('perpage', 25, PARAM_INT); // This value is hard-coded to 25 in quickenrolment.js
4be3ed4b 72 $outcome->response = $manager->get_potential_users($enrolid, $search, $searchanywhere, $page, $perpage, $addedenrollment);
b849c212 73 $extrafields = get_extra_user_fields($context);
cf855c0b
SH
74 foreach ($outcome->response['users'] as &$user) {
75 $user->picture = $OUTPUT->user_picture($user);
76 $user->fullname = fullname($user);
b849c212 77 $fieldvalues = array();
78 foreach ($extrafields as $field) {
79 $fieldvalues[] = s($user->{$field});
80 unset($user->{$field});
81 }
82 $user->extrafields = implode(', ', $fieldvalues);
cf855c0b 83 }
13bd955e
TH
84 // Chrome will display users in the order of the array keys, so we need
85 // to ensure that the results ordered array keys. Fortunately, the JavaScript
86 // does not care what the array keys are. It uses user.id where necessary.
87 $outcome->response['users'] = array_values($outcome->response['users']);
cf855c0b
SH
88 $outcome->success = true;
89 break;
90 case 'enrol':
91 $enrolid = required_param('enrolid', PARAM_INT);
92 $userid = required_param('userid', PARAM_INT);
93
94 $roleid = optional_param('role', null, PARAM_INT);
95 $duration = optional_param('duration', 0, PARAM_INT);
96 $startdate = optional_param('startdate', 0, PARAM_INT);
d4c98cff
SH
97 $recovergrades = optional_param('recovergrades', 0, PARAM_INT);
98
cf855c0b
SH
99 if (empty($roleid)) {
100 $roleid = null;
101 }
102
103 switch($startdate) {
104 case 2:
105 $timestart = $course->startdate;
106 break;
107 case 3:
108 default:
109 $today = time();
110 $today = make_timestamp(date('Y', $today), date('m', $today), date('d', $today), 0, 0, 0);
111 $timestart = $today;
112 break;
113 }
114 if ($duration <= 0) {
115 $timeend = 0;
116 } else {
117 $timeend = $timestart + ($duration*24*60*60);
118 }
119
120 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
121 $instances = $manager->get_enrolment_instances();
005e57a2 122 $plugins = $manager->get_enrolment_plugins(true); // Do not allow actions on disabled plugins.
cf855c0b
SH
123 if (!array_key_exists($enrolid, $instances)) {
124 throw new enrol_ajax_exception('invalidenrolinstance');
125 }
126 $instance = $instances[$enrolid];
005e57a2
PS
127 if (!isset($plugins[$instance->enrol])) {
128 throw new enrol_ajax_exception('enrolnotpermitted');
129 }
cf855c0b
SH
130 $plugin = $plugins[$instance->enrol];
131 if ($plugin->allow_enrol($instance) && has_capability('enrol/'.$plugin->get_name().':enrol', $context)) {
132 $plugin->enrol_user($instance, $user->id, $roleid, $timestart, $timeend);
d4c98cff
SH
133 if ($recovergrades) {
134 require_once($CFG->libdir.'/gradelib.php');
135 grade_recover_history_grades($user->id, $instance->courseid);
136 }
cf855c0b
SH
137 } else {
138 throw new enrol_ajax_exception('enrolnotpermitted');
139 }
140 $outcome->success = true;
141 break;
142
143 default:
144 throw new enrol_ajax_exception('unknowajaxaction');
145}
146
6f6c9e5c 147echo json_encode($outcome);