lib/externallib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Support for external API
  20  *
  21  * @package    core
  22  * @subpackage webservice
  23  * @copyright  2009 Moodle Pty Ltd (http://moodle.com)
  24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 /**
  30  * Returns detailed function information
  31  * @param string|object $function name of external function or record from external_function
  32  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
  33  *                        MUST_EXIST means throw exception if no record or multiple records found
  34  * @return object description or false if not found or exception thrown
  35  */
  36 function external_function_info($function, $strictness=MUST_EXIST) {
  37     global $DB, $CFG;
  38
  39     if (!is_object($function)) {
  40         if (!$function = $DB->get_record('external_functions', array('name'=>$function), '*', $strictness)) {
  41             return false;
  42         }
  43     }
  44
  45     //first find and include the ext implementation class
  46     $function->classpath = empty($function->classpath) ? get_component_directory($function->component).'/externallib.php' : $CFG->dirroot.'/'.$function->classpath;
  47     if (!file_exists($function->classpath)) {
  48         throw new coding_exception('Can not find file with external function implementation');
  49     }
  50     require_once($function->classpath);
  51
  52     $function->parameters_method = $function->methodname.'_parameters';
  53     $function->returns_method    = $function->methodname.'_returns';
  54
  55     // make sure the implementaion class is ok
  56     if (!method_exists($function->classname, $function->methodname)) {
  57         throw new coding_exception('Missing implementation method of '.$function->classname.'::'.$function->methodname);
  58     }
  59     if (!method_exists($function->classname, $function->parameters_method)) {
  60         throw new coding_exception('Missing parameters description');
  61     }
  62     if (!method_exists($function->classname, $function->returns_method)) {
  63         throw new coding_exception('Missing returned values description');
  64     }
  65
  66     // fetch the parameters description
  67     $function->parameters_desc = call_user_func(array($function->classname, $function->parameters_method));
  68     if (!($function->parameters_desc instanceof external_function_parameters)) {
  69         throw new coding_exception('Invalid parameters description');
  70     }
  71
  72     // fetch the return values description
  73     $function->returns_desc = call_user_func(array($function->classname, $function->returns_method));
  74     // null means void result or result is ignored
  75     if (!is_null($function->returns_desc) and !($function->returns_desc instanceof external_description)) {
  76         throw new coding_exception('Invalid return description');
  77     }
  78
  79     //now get the function description
  80     //TODO: use localised lang pack descriptions, it would be nice to have
  81     //      easy to understand descriptions in admin UI,
  82     //      on the other hand this is still a bit in a flux and we need to find some new naming
  83     //      conventions for these descriptions in lang packs
  84     $function->description = null;
  85     $servicesfile = get_component_directory($function->component).'/db/services.php';
  86     if (file_exists($servicesfile)) {
  87         $functions = null;
  88         include($servicesfile);
  89         if (isset($functions[$function->name]['description'])) {
  90             $function->description = $functions[$function->name]['description'];
  91         }
  92         if (isset($functions[$function->name]['testclientpath'])) {
  93             $function->testclientpath = $functions[$function->name]['testclientpath'];
  94         }
  95     }
  96
  97     return $function;
  98 }
  99
 100 /**
 101  * Exception indicating user is not allowed to use external function in
 102  * the current context.
 103  */
 104 class restricted_context_exception extends moodle_exception {
 105     /**
 106      * Constructor
 107      */
 108     function __construct() {
 109         parent::__construct('restrictedcontextexception', 'error');
 110     }
 111 }
 112
 113 /**
 114  * Base class for external api methods.
 115  */
 116 class external_api {
 117     private static $contextrestriction;
 118
 119     /**
 120      * Set context restriction for all following subsequent function calls.
 121      * @param stdClass $contex
 122      * @return void
 123      */
 124     public static function set_context_restriction($context) {
 125         self::$contextrestriction = $context;
 126     }
 127
 128     /**
 129      * This method has to be called before every operation
 130      * that takes a longer time to finish!
 131      *
 132      * @param int $seconds max expected time the next operation needs
 133      * @return void
 134      */
 135     public static function set_timeout($seconds=360) {
 136         $seconds = ($seconds < 300) ? 300 : $seconds;
 137         set_time_limit($seconds);
 138     }
 139
 140     /**
 141      * Validates submitted function parameters, if anything is incorrect
 142      * invalid_parameter_exception is thrown.
 143      * This is a simple recursive method which is intended to be called from
 144      * each implementation method of external API.
 145      * @param external_description $description description of parameters
 146      * @param mixed $params the actual parameters
 147      * @return mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found
 148      */
 149     public static function validate_parameters(external_description $description, $params) {
 150         if ($description instanceof external_value) {
 151             if (is_array($params) or is_object($params)) {
 152                 throw new invalid_parameter_exception('Scalar type expected, array or object received.');
 153             }
 154
 155             if ($description->type == PARAM_BOOL) {
 156                 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
 157                 if (is_bool($params) or $params === 0 or $params === 1 or $params === '0' or $params === '1') {
 158                     return (bool)$params;
 159                 }
 160             }
 161             $debuginfo = 'Invalid external api parameter: the value is "' . $params .
 162                     '", the server was expecting "' . $description->type . '" type';
 163             return validate_param($params, $description->type, $description->allownull, $debuginfo);
 164
 165         } else if ($description instanceof external_single_structure) {
 166             if (!is_array($params)) {
 167                 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
 168                         . print_r($params, true) . '\'');
 169             }
 170             $result = array();
 171             foreach ($description->keys as $key=>$subdesc) {
 172                 if (!array_key_exists($key, $params)) {
 173                     if ($subdesc->required == VALUE_REQUIRED) {
 174                         throw new invalid_parameter_exception('Missing required key in single structure: '. $key);
 175                     }
 176                     if ($subdesc->required == VALUE_DEFAULT) {
 177                         try {
 178                             $result[$key] = self::validate_parameters($subdesc, $subdesc->default);
 179                         } catch (invalid_parameter_exception $e) {
 180                             //we are only interested by exceptions returned by validate_param() and validate_parameters()
 181                             //(in order to build the path to the faulty attribut)
 182                             throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo);
 183                         }
 184                     }
 185                 } else {
 186                     try {
 187                         $result[$key] = self::validate_parameters($subdesc, $params[$key]);
 188                     } catch (invalid_parameter_exception $e) {
 189                         //we are only interested by exceptions returned by validate_param() and validate_parameters()
 190                         //(in order to build the path to the faulty attribut)
 191                         throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo);
 192                     }
 193                 }
 194                 unset($params[$key]);
 195             }
 196             if (!empty($params)) {
 197                 //list all unexpected keys
 198                 $keys = '';
 199                 foreach($params as $key => $value) {
 200                     $keys .= $key . ',';
 201                 }
 202                 throw new invalid_parameter_exception('Unexpected keys (' . $keys . ') detected in parameter array.');
 203             }
 204             return $result;
 205
 206         } else if ($description instanceof external_multiple_structure) {
 207             if (!is_array($params)) {
 208                 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
 209                         . print_r($params, true) . '\'');
 210             }
 211             $result = array();
 212             foreach ($params as $param) {
 213                 $result[] = self::validate_parameters($description->content, $param);
 214             }
 215             return $result;
 216
 217         } else {
 218             throw new invalid_parameter_exception('Invalid external api description');
 219         }
 220     }
 221
 222     /**
 223      * Clean response
 224      * If a response attribute is unknown from the description, we just ignore the attribute.
 225      * If a response attribute is incorrect, invalid_response_exception is thrown.
 226      * Note: this function is similar to validate parameters, however it is distinct because
 227      * parameters validation must be distinct from cleaning return values.
 228      * @param external_description $description description of the return values
 229      * @param mixed $response the actual response
 230      * @return mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found
 231      */
 232     public static function clean_returnvalue(external_description $description, $response) {
 233         if ($description instanceof external_value) {
 234             if (is_array($response) or is_object($response)) {
 235                 throw new invalid_response_exception('Scalar type expected, array or object received.');
 236             }
 237
 238             if ($description->type == PARAM_BOOL) {
 239                 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
 240                 if (is_bool($response) or $response === 0 or $response === 1 or $response === '0' or $response === '1') {
 241                     return (bool)$response;
 242                 }
 243             }
 244             $debuginfo = 'Invalid external api response: the value is "' . $response .
 245                     '", the server was expecting "' . $description->type . '" type';
 246             try {
 247                 return validate_param($response, $description->type, $description->allownull, $debuginfo);
 248             } catch (invalid_parameter_exception $e) {
 249                 //proper exception name, to be recursively catched to build the path to the faulty attribut
 250                 throw new invalid_response_exception($e->debuginfo);
 251             }
 252
 253         } else if ($description instanceof external_single_structure) {
 254             if (!is_array($response)) {
 255                 throw new invalid_response_exception('Only arrays accepted. The bad value is: \'' .
 256                         print_r($response, true) . '\'');
 257             }
 258             $result = array();
 259             foreach ($description->keys as $key=>$subdesc) {
 260                 if (!array_key_exists($key, $response)) {
 261                     if ($subdesc->required == VALUE_REQUIRED) {
 262                         throw new invalid_response_exception('Error in response - Missing following required key in a single structure: ' . $key);
 263                     }
 264                     if ($subdesc instanceof external_value) {
 265                         if ($subdesc->required == VALUE_DEFAULT) {
 266                             try {
 267                                     $result[$key] = self::clean_returnvalue($subdesc, $subdesc->default);
 268                             } catch (invalid_response_exception $e) {
 269                                 //build the path to the faulty attribut
 270                                 throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo);
 271                             }
 272                         }
 273                     }
 274                 } else {
 275                     try {
 276                         $result[$key] = self::clean_returnvalue($subdesc, $response[$key]);
 277                     } catch (invalid_response_exception $e) {
 278                         //build the path to the faulty attribut
 279                         throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo);
 280                     }
 281                 }
 282                 unset($response[$key]);
 283             }
 284
 285             return $result;
 286
 287         } else if ($description instanceof external_multiple_structure) {
 288             if (!is_array($response)) {
 289                 throw new invalid_response_exception('Only arrays accepted. The bad value is: \'' .
 290                         print_r($response, true) . '\'');
 291             }
 292             $result = array();
 293             foreach ($response as $param) {
 294                 $result[] = self::clean_returnvalue($description->content, $param);
 295             }
 296             return $result;
 297
 298         } else {
 299             throw new invalid_response_exception('Invalid external api response description');
 300         }
 301     }
 302
 303     /**
 304      * Makes sure user may execute functions in this context.
 305      * @param object $context
 306      * @return void
 307      */
 308     protected static function validate_context($context) {
 309         global $CFG;
 310
 311         if (empty($context)) {
 312             throw new invalid_parameter_exception('Context does not exist');
 313         }
 314         if (empty(self::$contextrestriction)) {
 315             self::$contextrestriction = get_context_instance(CONTEXT_SYSTEM);
 316         }
 317         $rcontext = self::$contextrestriction;
 318
 319         if ($rcontext->contextlevel == $context->contextlevel) {
 320             if ($rcontext->id != $context->id) {
 321                 throw new restricted_context_exception();
 322             }
 323         } else if ($rcontext->contextlevel > $context->contextlevel) {
 324             throw new restricted_context_exception();
 325         } else {
 326             $parents = get_parent_contexts($context);
 327             if (!in_array($rcontext->id, $parents)) {
 328                 throw new restricted_context_exception();
 329             }
 330         }
 331
 332         if ($context->contextlevel >= CONTEXT_COURSE) {
 333             list($context, $course, $cm) = get_context_info_array($context->id);
 334             require_login($course, false, $cm, false, true);
 335         }
 336     }
 337 }
 338
 339 /**
 340  * Common ancestor of all parameter description classes
 341  */
 342 abstract class external_description {
 343     /** @property string $description description of element */
 344     public $desc;
 345     /** @property bool $required element value required, null not allowed */
 346     public $required;
 347     /** @property mixed $default default value */
 348     public $default;
 349
 350     /**
 351      * Contructor
 352      * @param string $desc
 353      * @param bool $required
 354      * @param mixed $default
 355      */
 356     public function __construct($desc, $required, $default) {
 357         $this->desc = $desc;
 358         $this->required = $required;
 359         $this->default = $default;
 360     }
 361 }
 362
 363 /**
 364  * Scalar alue description class
 365  */
 366 class external_value extends external_description {
 367     /** @property mixed $type value type PARAM_XX */
 368     public $type;
 369     /** @property bool $allownull allow null values */
 370     public $allownull;
 371
 372     /**
 373      * Constructor
 374      * @param mixed $type
 375      * @param string $desc
 376      * @param bool $required
 377      * @param mixed $default
 378      * @param bool $allownull
 379      */
 380     public function __construct($type, $desc='', $required=VALUE_REQUIRED,
 381             $default=null, $allownull=NULL_ALLOWED) {
 382         parent::__construct($desc, $required, $default);
 383         $this->type      = $type;
 384         $this->allownull = $allownull;
 385     }
 386 }
 387
 388 /**
 389  * Associative array description class
 390  */
 391 class external_single_structure extends external_description {
 392      /** @property array $keys description of array keys key=>external_description */
 393     public $keys;
 394
 395     /**
 396      * Constructor
 397      * @param array $keys
 398      * @param string $desc
 399      * @param bool $required
 400      * @param array $default
 401      */
 402     public function __construct(array $keys, $desc='',
 403             $required=VALUE_REQUIRED, $default=null) {
 404         parent::__construct($desc, $required, $default);
 405         $this->keys = $keys;
 406     }
 407 }
 408
 409 /**
 410  * Bulk array description class.
 411  */
 412 class external_multiple_structure extends external_description {
 413      /** @property external_description $content */
 414     public $content;
 415
 416     /**
 417      * Constructor
 418      * @param external_description $content
 419      * @param string $desc
 420      * @param bool $required
 421      * @param array $default
 422      */
 423     public function __construct(external_description $content, $desc='',
 424             $required=VALUE_REQUIRED, $default=null) {
 425         parent::__construct($desc, $required, $default);
 426         $this->content = $content;
 427     }
 428 }
 429
 430 /**
 431  * Description of top level - PHP function parameters.
 432  * @author skodak
 433  *
 434  */
 435 class external_function_parameters extends external_single_structure {
 436 }
 437
 438 function external_generate_token($tokentype, $serviceorid, $userid, $contextorid, $validuntil=0, $iprestriction=''){
 439     global $DB, $USER;
 440     // make sure the token doesn't exist (even if it should be almost impossible with the random generation)
 441     $numtries = 0;
 442     do {
 443         $numtries ++;
 444         $generatedtoken = md5(uniqid(rand(),1));
 445         if ($numtries > 5){
 446             throw new moodle_exception('tokengenerationfailed');
 447         }
 448     } while ($DB->record_exists('external_tokens', array('token'=>$generatedtoken)));
 449     $newtoken = new stdClass();
 450     $newtoken->token = $generatedtoken;
 451     if (!is_object($serviceorid)){
 452         $service = $DB->get_record('external_services', array('id' => $serviceorid));
 453     } else {
 454         $service = $serviceorid;
 455     }
 456     if (!is_object($contextorid)){
 457         $context = get_context_instance_by_id($contextorid, MUST_EXIST);
 458     } else {
 459         $context = $contextorid;
 460     }
 461     if (empty($service->requiredcapability) || has_capability($service->requiredcapability, $context, $userid)) {
 462         $newtoken->externalserviceid = $service->id;
 463     } else {
 464         throw new moodle_exception('nocapabilitytousethisservice');
 465     }
 466     $newtoken->tokentype = $tokentype;
 467     $newtoken->userid = $userid;
 468     if ($tokentype == EXTERNAL_TOKEN_EMBEDDED){
 469         $newtoken->sid = session_id();
 470     }
 471
 472     $newtoken->contextid = $context->id;
 473     $newtoken->creatorid = $USER->id;
 474     $newtoken->timecreated = time();
 475     $newtoken->validuntil = $validuntil;
 476     if (!empty($iprestriction)) {
 477         $newtoken->iprestriction = $iprestriction;
 478     }
 479     $DB->insert_record('external_tokens', $newtoken);
 480     return $newtoken->token;
 481 }
 482 /**
 483  * Create and return a session linked token. Token to be used for html embedded client apps that want to communicate
 484  * with the Moodle server through web services. The token is linked to the current session for the current page request.
 485  * It is expected this will be called in the script generating the html page that is embedding the client app and that the
 486  * returned token will be somehow passed into the client app being embedded in the page.
 487  * @param string $servicename name of the web service. Service name as defined in db/services.php
 488  * @param int $context context within which the web service can operate.
 489  * @return int returns token id.
 490  */
 491 function external_create_service_token($servicename, $context){
 492     global $USER, $DB;
 493     $service = $DB->get_record('external_services', array('name'=>$servicename), '*', MUST_EXIST);
 494     return external_generate_token(EXTERNAL_TOKEN_EMBEDDED, $service, $USER->id, $context, 0);
 495 }