MDL-56629 dataformat_html: Adding UTF-8 charset
[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');
b6548192
MG
33require_once($CFG->dirroot.'/enrol/manual/locallib.php');
34require_once($CFG->dirroot.'/cohort/lib.php');
cf855c0b 35
6f6c9e5c 36$id = required_param('id', PARAM_INT); // Course id.
405aca35 37$action = required_param('action', PARAM_ALPHANUMEXT);
cf855c0b
SH
38
39$PAGE->set_url(new moodle_url('/enrol/ajax.php', array('id'=>$id, 'action'=>$action)));
40
74df2951 41$course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
55bcef29 42$context = context_course::instance($course->id, MUST_EXIST);
cf855c0b
SH
43
44if ($course->id == SITEID) {
45 throw new moodle_exception('invalidcourse');
46}
47
48require_login($course);
49require_capability('moodle/course:enrolreview', $context);
50require_sesskey();
51
6f6c9e5c 52echo $OUTPUT->header(); // Send headers.
cf855c0b 53
076995bf 54$manager = new course_enrolment_manager($PAGE, $course);
cf855c0b 55
13bd955e 56$outcome = new stdClass();
cf855c0b 57$outcome->success = true;
13bd955e 58$outcome->response = new stdClass();
cf855c0b
SH
59$outcome->error = '';
60
e059c033
TH
61$searchanywhere = get_user_preferences('userselector_searchanywhere', false);
62
cf855c0b
SH
63switch ($action) {
64 case 'getassignable':
65 $otheruserroles = optional_param('otherusers', false, PARAM_BOOL);
66 $outcome->response = array_reverse($manager->get_assignable_roles($otheruserroles), true);
67 break;
68 case 'searchusers':
69 $enrolid = required_param('enrolid', PARAM_INT);
e059c033 70 $search = optional_param('search', '', PARAM_RAW);
cf855c0b 71 $page = optional_param('page', 0, PARAM_INT);
4be3ed4b 72 $addedenrollment = optional_param('enrolcount', 0, PARAM_INT);
62a973ce 73 $perpage = optional_param('perpage', 25, PARAM_INT); // This value is hard-coded to 25 in quickenrolment.js
4be3ed4b 74 $outcome->response = $manager->get_potential_users($enrolid, $search, $searchanywhere, $page, $perpage, $addedenrollment);
b849c212 75 $extrafields = get_extra_user_fields($context);
d2f3c5c5
PS
76 $useroptions = array();
77 // User is not enrolled yet, either link to site profile or do not link at all.
78 if (has_capability('moodle/user:viewdetails', context_system::instance())) {
79 $useroptions['courseid'] = SITEID;
80 } else {
81 $useroptions['link'] = false;
82 }
d636015c 83 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
cf855c0b 84 foreach ($outcome->response['users'] as &$user) {
d2f3c5c5 85 $user->picture = $OUTPUT->user_picture($user, $useroptions);
d636015c 86 $user->fullname = fullname($user, $viewfullnames);
b849c212 87 $fieldvalues = array();
88 foreach ($extrafields as $field) {
89 $fieldvalues[] = s($user->{$field});
90 unset($user->{$field});
91 }
92 $user->extrafields = implode(', ', $fieldvalues);
cf855c0b 93 }
13bd955e
TH
94 // Chrome will display users in the order of the array keys, so we need
95 // to ensure that the results ordered array keys. Fortunately, the JavaScript
96 // does not care what the array keys are. It uses user.id where necessary.
97 $outcome->response['users'] = array_values($outcome->response['users']);
cf855c0b
SH
98 $outcome->success = true;
99 break;
b6548192
MG
100 case 'searchcohorts':
101 $enrolid = required_param('enrolid', PARAM_INT);
102 $search = optional_param('search', '', PARAM_RAW);
103 $page = optional_param('page', 0, PARAM_INT);
104 $addedenrollment = optional_param('enrolcount', 0, PARAM_INT);
105 $perpage = optional_param('perpage', 25, PARAM_INT); // This value is hard-coded to 25 in quickenrolment.js
106 $outcome->response = enrol_manual_get_potential_cohorts($context, $enrolid, $search, $page, $perpage, $addedenrollment);
107 $outcome->success = true;
108 break;
cf855c0b
SH
109 case 'enrol':
110 $enrolid = required_param('enrolid', PARAM_INT);
b6548192
MG
111 $cohort = $user = null;
112 $cohortid = optional_param('cohortid', 0, PARAM_INT);
113 if (!$cohortid) {
114 $userid = required_param('userid', PARAM_INT);
115 $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
116 } else {
117 $cohort = $DB->get_record('cohort', array('id' => $cohortid), '*', MUST_EXIST);
118 if (!cohort_can_view_cohort($cohort, $context)) {
119 throw new enrol_ajax_exception('invalidenrolinstance'); // TODO error text!
120 }
121 }
cf855c0b
SH
122
123 $roleid = optional_param('role', null, PARAM_INT);
a5ea5149 124 $duration = optional_param('duration', 0, PARAM_FLOAT);
cf855c0b 125 $startdate = optional_param('startdate', 0, PARAM_INT);
d4c98cff
SH
126 $recovergrades = optional_param('recovergrades', 0, PARAM_INT);
127
cf855c0b
SH
128 if (empty($roleid)) {
129 $roleid = null;
130 }
131
d005d718
DM
132 if (empty($startdate)) {
133 if (!$startdate = get_config('enrol_manual', 'enrolstart')) {
134 // Default to now if there is no system setting.
135 $startdate = 4;
136 }
137 }
138
cf855c0b
SH
139 switch($startdate) {
140 case 2:
141 $timestart = $course->startdate;
142 break;
d005d718 143 case 4:
ba523bf5
DM
144 // We mimic get_enrolled_sql round(time(), -2) but always floor as we want users to always access their
145 // courses once they are enrolled.
146 $timestart = intval(substr(time(), 0, 8) . '00') - 1;
d005d718 147 break;
cf855c0b
SH
148 case 3:
149 default:
150 $today = time();
151 $today = make_timestamp(date('Y', $today), date('m', $today), date('d', $today), 0, 0, 0);
152 $timestart = $today;
153 break;
154 }
155 if ($duration <= 0) {
156 $timeend = 0;
157 } else {
a5ea5149 158 $timeend = $timestart + intval($duration*24*60*60);
cf855c0b
SH
159 }
160
cf855c0b 161 $instances = $manager->get_enrolment_instances();
005e57a2 162 $plugins = $manager->get_enrolment_plugins(true); // Do not allow actions on disabled plugins.
cf855c0b
SH
163 if (!array_key_exists($enrolid, $instances)) {
164 throw new enrol_ajax_exception('invalidenrolinstance');
165 }
166 $instance = $instances[$enrolid];
005e57a2
PS
167 if (!isset($plugins[$instance->enrol])) {
168 throw new enrol_ajax_exception('enrolnotpermitted');
169 }
cf855c0b
SH
170 $plugin = $plugins[$instance->enrol];
171 if ($plugin->allow_enrol($instance) && has_capability('enrol/'.$plugin->get_name().':enrol', $context)) {
b6548192
MG
172 if ($user) {
173 $plugin->enrol_user($instance, $user->id, $roleid, $timestart, $timeend, null, $recovergrades);
174 } else {
175 $plugin->enrol_cohort($instance, $cohort->id, $roleid, $timestart, $timeend, null, $recovergrades);
176 }
cf855c0b
SH
177 } else {
178 throw new enrol_ajax_exception('enrolnotpermitted');
179 }
180 $outcome->success = true;
181 break;
182
183 default:
184 throw new enrol_ajax_exception('unknowajaxaction');
185}
186
6f6c9e5c 187echo json_encode($outcome);