mirror of
https://github.com/moodle/moodle.git
synced 2025-03-27 19:12:39 +01:00
6a1ad7c677
This allows for better caching capabilities on servers. If a cache key is passed and the web service call does not require the user to be logged in we will attempt to use GET for the request. This allows for things like proxy caching on URLs. The cache key must be changed if we do not want to retrieve what has been cached and want to perform the request again.
99 lines
3.2 KiB
PHP
99 lines
3.2 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* This file is used to call any registered externallib function in Moodle.
|
|
*
|
|
* It will process more than one request and return more than one response if required.
|
|
* It is recommended to add webservice functions and re-use this script instead of
|
|
* writing any new custom ajax scripts.
|
|
*
|
|
* @since Moodle 2.9
|
|
* @package core
|
|
* @copyright 2015 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
define('AJAX_SCRIPT', true);
|
|
|
|
if (!empty($_GET['nosessionupdate'])) {
|
|
define('NO_SESSION_UPDATE', true);
|
|
}
|
|
|
|
require_once(__DIR__ . '/../../config.php');
|
|
require_once($CFG->libdir . '/externallib.php');
|
|
|
|
define('PREFERRED_RENDERER_TARGET', RENDERER_TARGET_GENERAL);
|
|
|
|
$arguments = '';
|
|
$cacherequest = false;
|
|
if (defined('ALLOW_GET_PARAMETERS')) {
|
|
$arguments = optional_param('args', '', PARAM_RAW);
|
|
$cachekey = optional_param('cachekey', '', PARAM_INT);
|
|
if ($cachekey && $cachekey > 0 && $cachekey <= time()) {
|
|
$cacherequest = true;
|
|
}
|
|
}
|
|
|
|
// Either we are not allowing GET parameters or we didn't use GET because
|
|
// we did not pass a cache key or the URL was too long.
|
|
if (empty($arguments)) {
|
|
$arguments = file_get_contents('php://input');
|
|
}
|
|
|
|
$requests = json_decode($arguments, true);
|
|
|
|
if ($requests === null) {
|
|
$lasterror = json_last_error_msg();
|
|
throw new coding_exception('Invalid json in request: ' . $lasterror);
|
|
}
|
|
$responses = array();
|
|
|
|
// Defines the external settings required for Ajax processing.
|
|
$settings = external_settings::get_instance();
|
|
$settings->set_file('pluginfile.php');
|
|
$settings->set_fileurl(true);
|
|
$settings->set_filter(true);
|
|
$settings->set_raw(false);
|
|
|
|
$haserror = false;
|
|
foreach ($requests as $request) {
|
|
$response = array();
|
|
$methodname = clean_param($request['methodname'], PARAM_ALPHANUMEXT);
|
|
$index = clean_param($request['index'], PARAM_INT);
|
|
$args = $request['args'];
|
|
|
|
$response = external_api::call_external_function($methodname, $args, true);
|
|
$responses[$index] = $response;
|
|
if ($response['error']) {
|
|
// Do not process the remaining requests.
|
|
$haserror = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($cacherequest && !$haserror) {
|
|
// 90 days only - based on Moodle point release cadence being every 3 months.
|
|
$lifetime = 60 * 60 * 24 * 90;
|
|
|
|
header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
|
|
header('Pragma: ');
|
|
header('Cache-Control: public, max-age=' . $lifetime . ', immutable');
|
|
header('Accept-Ranges: none');
|
|
}
|
|
|
|
echo json_encode($responses);
|