enrol/manual/ajax.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/>.
  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  *
  23  * @package    enrol_manual
  24  * @copyright  2010 Sam Hemelryk
  25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 define('AJAX_SCRIPT', true);
  29
  30 require('../../config.php');
  31 require_once($CFG->dirroot.'/enrol/locallib.php');
  32 require_once($CFG->dirroot.'/group/lib.php');
  33 require_once($CFG->dirroot.'/enrol/manual/locallib.php');
  34 require_once($CFG->dirroot.'/cohort/lib.php');
  35
  36 $id      = required_param('id', PARAM_INT); // Course id.
  37 $action  = required_param('action', PARAM_ALPHANUMEXT);
  38
  39 $PAGE->set_url(new moodle_url('/enrol/ajax.php', array('id'=>$id, 'action'=>$action)));
  40
  41 $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
  42 $context = context_course::instance($course->id, MUST_EXIST);
  43
  44 if ($course->id == SITEID) {
  45     throw new moodle_exception('invalidcourse');
  46 }
  47
  48 require_login($course);
  49 require_capability('moodle/course:enrolreview', $context);
  50 require_sesskey();
  51
  52 echo $OUTPUT->header(); // Send headers.
  53
  54 $manager = new course_enrolment_manager($PAGE, $course);
  55
  56 $outcome = new stdClass();
  57 $outcome->success = true;
  58 $outcome->response = new stdClass();
  59 $outcome->error = '';
  60
  61 $searchanywhere = get_user_preferences('userselector_searchanywhere', false);
  62
  63 switch ($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);
  70         $search = optional_param('search', '', PARAM_RAW);
  71         $page = optional_param('page', 0, PARAM_INT);
  72         $addedenrollment = optional_param('enrolcount', 0, PARAM_INT);
  73         $perpage = optional_param('perpage', 25, PARAM_INT);  //  This value is hard-coded to 25 in quickenrolment.js
  74         $outcome->response = $manager->get_potential_users($enrolid, $search, $searchanywhere, $page, $perpage, $addedenrollment);
  75         $extrafields = get_extra_user_fields($context);
  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         }
  83         foreach ($outcome->response['users'] as &$user) {
  84             $user->picture = $OUTPUT->user_picture($user, $useroptions);
  85             $user->fullname = fullname($user);
  86             $fieldvalues = array();
  87             foreach ($extrafields as $field) {
  88                 $fieldvalues[] = s($user->{$field});
  89                 unset($user->{$field});
  90             }
  91             $user->extrafields = implode(', ', $fieldvalues);
  92         }
  93         // Chrome will display users in the order of the array keys, so we need
  94         // to ensure that the results ordered array keys. Fortunately, the JavaScript
  95         // does not care what the array keys are. It uses user.id where necessary.
  96         $outcome->response['users'] = array_values($outcome->response['users']);
  97         $outcome->success = true;
  98         break;
  99     case 'searchcohorts':
 100         $enrolid = required_param('enrolid', PARAM_INT);
 101         $search = optional_param('search', '', PARAM_RAW);
 102         $page = optional_param('page', 0, PARAM_INT);
 103         $addedenrollment = optional_param('enrolcount', 0, PARAM_INT);
 104         $perpage = optional_param('perpage', 25, PARAM_INT);  //  This value is hard-coded to 25 in quickenrolment.js
 105         $outcome->response = enrol_manual_get_potential_cohorts($context, $enrolid, $search, $page, $perpage, $addedenrollment);
 106         $outcome->success = true;
 107         break;
 108     case 'enrol':
 109         $enrolid = required_param('enrolid', PARAM_INT);
 110         $cohort = $user = null;
 111         $cohortid = optional_param('cohortid', 0, PARAM_INT);
 112         if (!$cohortid) {
 113             $userid = required_param('userid', PARAM_INT);
 114             $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
 115         } else {
 116             $cohort = $DB->get_record('cohort', array('id' => $cohortid), '*', MUST_EXIST);
 117             if (!cohort_can_view_cohort($cohort, $context)) {
 118                 throw new enrol_ajax_exception('invalidenrolinstance'); // TODO error text!
 119             }
 120         }
 121
 122         $roleid = optional_param('role', null, PARAM_INT);
 123         $duration = optional_param('duration', 0, PARAM_INT);
 124         $startdate = optional_param('startdate', 0, PARAM_INT);
 125         $recovergrades = optional_param('recovergrades', 0, PARAM_INT);
 126
 127         if (empty($roleid)) {
 128             $roleid = null;
 129         }
 130
 131         if (empty($startdate)) {
 132             if (!$startdate = get_config('enrol_manual', 'enrolstart')) {
 133                 // Default to now if there is no system setting.
 134                 $startdate = 4;
 135             }
 136         }
 137
 138         switch($startdate) {
 139             case 2:
 140                 $timestart = $course->startdate;
 141                 break;
 142             case 4:
 143                 $timestart = time();
 144                 break;
 145             case 3:
 146             default:
 147                 $today = time();
 148                 $today = make_timestamp(date('Y', $today), date('m', $today), date('d', $today), 0, 0, 0);
 149                 $timestart = $today;
 150                 break;
 151         }
 152         if ($duration <= 0) {
 153             $timeend = 0;
 154         } else {
 155             $timeend = $timestart + ($duration*24*60*60);
 156         }
 157
 158         $instances = $manager->get_enrolment_instances();
 159         $plugins = $manager->get_enrolment_plugins(true); // Do not allow actions on disabled plugins.
 160         if (!array_key_exists($enrolid, $instances)) {
 161             throw new enrol_ajax_exception('invalidenrolinstance');
 162         }
 163         $instance = $instances[$enrolid];
 164         if (!isset($plugins[$instance->enrol])) {
 165             throw new enrol_ajax_exception('enrolnotpermitted');
 166         }
 167         $plugin = $plugins[$instance->enrol];
 168         if ($plugin->allow_enrol($instance) && has_capability('enrol/'.$plugin->get_name().':enrol', $context)) {
 169             if ($user) {
 170                 $plugin->enrol_user($instance, $user->id, $roleid, $timestart, $timeend, null, $recovergrades);
 171             } else {
 172                 $plugin->enrol_cohort($instance, $cohort->id, $roleid, $timestart, $timeend, null, $recovergrades);
 173             }
 174         } else {
 175             throw new enrol_ajax_exception('enrolnotpermitted');
 176         }
 177         $outcome->success = true;
 178         break;
 179
 180     default:
 181         throw new enrol_ajax_exception('unknowajaxaction');
 182 }
 183
 184 echo json_encode($outcome);