mirror of
https://github.com/moodle/moodle.git
synced 2025-04-21 16:32:18 +02:00
29a541724f
This has been generated running the following Sniff, part of the Moodle's CodeSniffer standard: - PSR2.Methods.MethodDeclaration It just ensures all the function declarations have the correct order for: - abstract and final. - visibility (public, protected, private). - static. So, all the lines modified by this commit are function declarations and the only changes are in the positions of those keywords.
135 lines
4.5 KiB
PHP
135 lines
4.5 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/>.
|
|
|
|
/**
|
|
* Rest API base class mapping rest api methods to endpoints with http methods, args and post body.
|
|
*
|
|
* @package core
|
|
* @copyright 2017 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
namespace core\oauth2;
|
|
|
|
use curl;
|
|
use coding_exception;
|
|
use stdClass;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once($CFG->libdir . '/filelib.php');
|
|
|
|
/**
|
|
* Rest API base class mapping rest api methods to endpoints with http methods, args and post body.
|
|
*
|
|
* @copyright 2017 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class rest {
|
|
|
|
/** @var curl $curl */
|
|
protected $curl;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param curl $curl
|
|
*/
|
|
public function __construct(curl $curl) {
|
|
$this->curl = $curl;
|
|
}
|
|
|
|
/**
|
|
* Abstract function to define the functions of the rest API.
|
|
*
|
|
* @return array Example:
|
|
* [ 'listFiles' => [ 'method' => 'get', 'args' => [ 'folder' => PARAM_STRING ], 'response' => 'json' ] ]
|
|
*/
|
|
abstract public function get_api_functions();
|
|
|
|
/**
|
|
* Call a function from the Api with a set of arguments and optional data.
|
|
*
|
|
* @param string $functionname
|
|
* @param array $functionargs
|
|
* @param string $rawpost Optional param to include in the body of a post.
|
|
* @param string $contenttype The MIME type for the request's Content-Type header.
|
|
* @return string|stdClass
|
|
*/
|
|
public function call($functionname, $functionargs, $rawpost = false, $contenttype = false) {
|
|
$functions = $this->get_api_functions();
|
|
$supportedmethods = [ 'get', 'put', 'post', 'patch', 'head', 'delete' ];
|
|
if (empty($functions[$functionname])) {
|
|
throw new coding_exception('unsupported api functionname: ' . $functionname);
|
|
}
|
|
|
|
$method = $functions[$functionname]['method'];
|
|
$endpoint = $functions[$functionname]['endpoint'];
|
|
|
|
$responsetype = $functions[$functionname]['response'];
|
|
if (!in_array($method, $supportedmethods)) {
|
|
throw new coding_exception('unsupported api method: ' . $method);
|
|
}
|
|
|
|
$args = $functions[$functionname]['args'];
|
|
$callargs = [];
|
|
foreach ($args as $argname => $argtype) {
|
|
if (isset($functionargs[$argname])) {
|
|
$callargs[$argname] = clean_param($functionargs[$argname], $argtype);
|
|
}
|
|
}
|
|
|
|
// Allow params in the URL path like /me/{parent}/children.
|
|
foreach ($callargs as $argname => $value) {
|
|
$newendpoint = str_replace('{' . $argname . '}', $value, $endpoint);
|
|
if ($newendpoint != $endpoint) {
|
|
$endpoint = $newendpoint;
|
|
unset($callargs[$argname]);
|
|
}
|
|
}
|
|
|
|
if ($rawpost !== false) {
|
|
$queryparams = $this->curl->build_post_data($callargs);
|
|
if (!empty($queryparams)) {
|
|
$endpoint .= '?' . $queryparams;
|
|
}
|
|
$callargs = $rawpost;
|
|
}
|
|
|
|
if (empty($contenttype)) {
|
|
$this->curl->setHeader('Content-type: application/json');
|
|
} else {
|
|
$this->curl->setHeader('Content-type: ' . $contenttype);
|
|
}
|
|
$response = $this->curl->$method($endpoint, $callargs);
|
|
|
|
if ($this->curl->errno == 0) {
|
|
if ($responsetype == 'json') {
|
|
$json = json_decode($response);
|
|
|
|
if (!empty($json->error)) {
|
|
throw new rest_exception($json->error->code . ': ' . $json->error->message);
|
|
}
|
|
return $json;
|
|
} else if ($responsetype == 'headers') {
|
|
$response = $this->curl->get_raw_response();
|
|
}
|
|
return $response;
|
|
} else {
|
|
throw new rest_exception($this->curl->error, $this->curl->errno);
|
|
}
|
|
}
|
|
}
|