lib/ajax/service.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 is used to call any registered externallib function in Moodle.
  19  *
  20  * It will process more than one request and return more than one response if required.
  21  * It is recommended to add webservice functions and re-use this script instead of
  22  * writing any new custom ajax scripts.
  23  *
  24  * @since Moodle 2.9
  25  * @package core
  26  * @copyright 2015 Damyon Wiese
  27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29
  30 define('AJAX_SCRIPT', true);
  31
  32 require_once(dirname(__FILE__) . '/../../config.php');
  33 require_once($CFG->libdir . '/externallib.php');
  34
  35 require_login(null, true, null, true, true);
  36 require_sesskey();
  37
  38 $rawjson = file_get_contents('php://input');
  39
  40 $requests = json_decode($rawjson, true);
  41 if ($requests === null) {
  42     $lasterror = json_last_error_msg();
  43     throw new coding_exception('Invalid json in request: ' . $lasterror);
  44 }
  45 $responses = array();
  46
  47
  48 foreach ($requests as $request) {
  49     $response = array();
  50     $methodname = clean_param($request['methodname'], PARAM_ALPHANUMEXT);
  51     $index = clean_param($request['index'], PARAM_INT);
  52     $args = $request['args'];
  53
  54     try {
  55         $externalfunctioninfo = external_function_info($methodname);
  56
  57         if (!$externalfunctioninfo->allowed_from_ajax) {
  58             throw new moodle_exception('servicenotavailable', 'webservice');
  59         }
  60
  61         // Validate params, this also sorts the params properly, we need the correct order in the next part.
  62         $callable = array($externalfunctioninfo->classname, 'validate_parameters');
  63         $params = call_user_func($callable,
  64                                  $externalfunctioninfo->parameters_desc,
  65                                  $args);
  66
  67         // Execute - gulp!
  68         $callable = array($externalfunctioninfo->classname, $externalfunctioninfo->methodname);
  69         $result = call_user_func_array($callable,
  70                                        array_values($params));
  71
  72         $response['error'] = false;
  73         $response['data'] = $result;
  74         $responses[$index] = $response;
  75     } catch (Exception $e) {
  76         $jsonexception = get_exception_info($e);
  77         unset($jsonexception->a);
  78         if (!debugging('', DEBUG_DEVELOPER)) {
  79             unset($jsonexception->debuginfo);
  80             unset($jsonexception->backtrace);
  81         }
  82         $response['error'] = true;
  83         $response['exception'] = $jsonexception;
  84         $responses[$index] = $response;
  85         // Do not process the remaining requests.
  86         break;
  87     }
  88 }
  89
  90 echo json_encode($responses);