Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/webservice/ -> lib.php (source)
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]
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 /** 19 * Web services utility functions and classes 20 * 21 * @package core_webservice 22 * @copyright 2009 Jerome Mouneyrac <jerome@moodle.com> 23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 */ 25 26 use core_external\external_api; 27 use core_external\external_multiple_structure; 28 use core_external\external_settings; 29 use core_external\external_single_structure; 30 use core_external\external_value; 31 32 /** 33 * WEBSERVICE_AUTHMETHOD_USERNAME - username/password authentication (also called simple authentication) 34 */ 35 define('WEBSERVICE_AUTHMETHOD_USERNAME', 0); 36 37 /** 38 * WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN - most common token authentication (external app, mobile app...) 39 */ 40 define('WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN', 1); 41 42 /** 43 * WEBSERVICE_AUTHMETHOD_SESSION_TOKEN - token for embedded application (requires Moodle session) 44 */ 45 define('WEBSERVICE_AUTHMETHOD_SESSION_TOKEN', 2); 46 47 /** 48 * General web service library 49 * 50 * @package core_webservice 51 * @copyright 2010 Jerome Mouneyrac <jerome@moodle.com> 52 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 53 */ 54 class webservice { 55 /** 56 * Only update token last access once per this many seconds. (This constant controls update of 57 * the external tokens last access field. There is a similar define LASTACCESS_UPDATE_SECS 58 * which controls update of the web site last access fields.) 59 * 60 * @var int 61 */ 62 const TOKEN_LASTACCESS_UPDATE_SECS = 60; 63 64 /** 65 * Authenticate user (used by download/upload file scripts) 66 * 67 * @param string $token 68 * @return array - contains the authenticated user, token and service objects 69 */ 70 public function authenticate_user($token) { 71 global $DB, $CFG; 72 73 // web service must be enabled to use this script 74 if (!$CFG->enablewebservices) { 75 throw new webservice_access_exception('Web services are not enabled in Advanced features.'); 76 } 77 78 // Obtain token record 79 if (!$token = $DB->get_record('external_tokens', array('token' => $token))) { 80 //client may want to display login form => moodle_exception 81 throw new moodle_exception('invalidtoken', 'webservice'); 82 } 83 84 $loginfaileddefaultparams = array( 85 'other' => array( 86 'method' => WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN, 87 'reason' => null, 88 'tokenid' => $token->id 89 ) 90 ); 91 92 // Validate token date 93 if ($token->validuntil and $token->validuntil < time()) { 94 $params = $loginfaileddefaultparams; 95 $params['other']['reason'] = 'token_expired'; 96 $event = \core\event\webservice_login_failed::create($params); 97 $event->add_record_snapshot('external_tokens', $token); 98 $event->trigger(); 99 $DB->delete_records('external_tokens', array('token' => $token->token)); 100 throw new webservice_access_exception('Invalid token - token expired - check validuntil time for the token'); 101 } 102 103 // Check ip 104 if ($token->iprestriction and !address_in_subnet(getremoteaddr(), $token->iprestriction)) { 105 $params = $loginfaileddefaultparams; 106 $params['other']['reason'] = 'ip_restricted'; 107 $event = \core\event\webservice_login_failed::create($params); 108 $event->add_record_snapshot('external_tokens', $token); 109 $event->trigger(); 110 throw new webservice_access_exception('Invalid token - IP:' . getremoteaddr() 111 . ' is not supported'); 112 } 113 114 //retrieve user link to the token 115 $user = $DB->get_record('user', array('id' => $token->userid, 'deleted' => 0), '*', MUST_EXIST); 116 117 // let enrol plugins deal with new enrolments if necessary 118 enrol_check_plugins($user, false); 119 120 // setup user session to check capability 121 \core\session\manager::set_user($user); 122 set_login_session_preferences(); 123 124 //assumes that if sid is set then there must be a valid associated session no matter the token type 125 if ($token->sid) { 126 if (!\core\session\manager::session_exists($token->sid)) { 127 $DB->delete_records('external_tokens', array('sid' => $token->sid)); 128 throw new webservice_access_exception('Invalid session based token - session not found or expired'); 129 } 130 } 131 132 // Cannot authenticate unless maintenance access is granted. 133 $hasmaintenanceaccess = has_capability('moodle/site:maintenanceaccess', context_system::instance(), $user); 134 if (!empty($CFG->maintenance_enabled) and !$hasmaintenanceaccess) { 135 //this is usually temporary, client want to implement code logic => moodle_exception 136 throw new moodle_exception('sitemaintenance', 'admin'); 137 } 138 139 //retrieve web service record 140 $service = $DB->get_record('external_services', array('id' => $token->externalserviceid, 'enabled' => 1)); 141 if (empty($service)) { 142 // will throw exception if no token found 143 throw new webservice_access_exception('Web service is not available (it doesn\'t exist or might be disabled)'); 144 } 145 146 //check if there is any required system capability 147 if ($service->requiredcapability and !has_capability($service->requiredcapability, context_system::instance(), $user)) { 148 throw new webservice_access_exception('The capability ' . $service->requiredcapability . ' is required.'); 149 } 150 151 //specific checks related to user restricted service 152 if ($service->restrictedusers) { 153 $authoriseduser = $DB->get_record('external_services_users', array('externalserviceid' => $service->id, 'userid' => $user->id)); 154 155 if (empty($authoriseduser)) { 156 throw new webservice_access_exception( 157 'The user is not allowed for this service. First you need to allow this user on the ' 158 . $service->name . '\'s allowed users administration page.'); 159 } 160 161 if (!empty($authoriseduser->validuntil) and $authoriseduser->validuntil < time()) { 162 throw new webservice_access_exception('Invalid service - service expired - check validuntil time for this allowed user'); 163 } 164 165 if (!empty($authoriseduser->iprestriction) and !address_in_subnet(getremoteaddr(), $authoriseduser->iprestriction)) { 166 throw new webservice_access_exception('Invalid service - IP:' . getremoteaddr() 167 . ' is not supported - check this allowed user'); 168 } 169 } 170 171 //only confirmed user should be able to call web service 172 if (empty($user->confirmed)) { 173 $params = $loginfaileddefaultparams; 174 $params['other']['reason'] = 'user_unconfirmed'; 175 $event = \core\event\webservice_login_failed::create($params); 176 $event->add_record_snapshot('external_tokens', $token); 177 $event->trigger(); 178 throw new moodle_exception('usernotconfirmed', 'moodle', '', $user->username); 179 } 180 181 //check the user is suspended 182 if (!empty($user->suspended)) { 183 $params = $loginfaileddefaultparams; 184 $params['other']['reason'] = 'user_suspended'; 185 $event = \core\event\webservice_login_failed::create($params); 186 $event->add_record_snapshot('external_tokens', $token); 187 $event->trigger(); 188 throw new moodle_exception('wsaccessusersuspended', 'moodle', '', $user->username); 189 } 190 191 //check if the auth method is nologin (in this case refuse connection) 192 if ($user->auth == 'nologin') { 193 $params = $loginfaileddefaultparams; 194 $params['other']['reason'] = 'nologin'; 195 $event = \core\event\webservice_login_failed::create($params); 196 $event->add_record_snapshot('external_tokens', $token); 197 $event->trigger(); 198 throw new moodle_exception('wsaccessusernologin', 'moodle', '', $user->username); 199 } 200 201 //Check if the user password is expired 202 $auth = get_auth_plugin($user->auth); 203 if (!empty($auth->config->expiration) and $auth->config->expiration == 1) { 204 $days2expire = $auth->password_expire($user->username); 205 if (intval($days2expire) < 0) { 206 $params = $loginfaileddefaultparams; 207 $params['other']['reason'] = 'password_expired'; 208 $event = \core\event\webservice_login_failed::create($params); 209 $event->add_record_snapshot('external_tokens', $token); 210 $event->trigger(); 211 throw new moodle_exception('passwordisexpired', 'webservice'); 212 } 213 } 214 215 // log token access 216 self::update_token_lastaccess($token); 217 218 return array('user' => $user, 'token' => $token, 'service' => $service); 219 } 220 221 /** 222 * Updates the last access time for a token. 223 * 224 * @param \stdClass $token Token object (must include id, lastaccess fields) 225 * @param int $time Time of access (0 = use current time) 226 * @throws dml_exception If database error 227 */ 228 public static function update_token_lastaccess($token, int $time = 0) { 229 global $DB; 230 231 if (!$time) { 232 $time = time(); 233 } 234 235 // Only update the field if it is a different time from previous request, 236 // so as not to waste database effort. 237 if ($time >= $token->lastaccess + self::TOKEN_LASTACCESS_UPDATE_SECS) { 238 $DB->set_field('external_tokens', 'lastaccess', $time, array('id' => $token->id)); 239 } 240 } 241 242 /** 243 * Allow user to call a service 244 * 245 * @param stdClass $user a user 246 */ 247 public function add_ws_authorised_user($user) { 248 global $DB; 249 $user->timecreated = time(); 250 $DB->insert_record('external_services_users', $user); 251 } 252 253 /** 254 * Disallow a user to call a service 255 * 256 * @param stdClass $user a user 257 * @param int $serviceid 258 */ 259 public function remove_ws_authorised_user($user, $serviceid) { 260 global $DB; 261 $DB->delete_records('external_services_users', 262 array('externalserviceid' => $serviceid, 'userid' => $user->id)); 263 } 264 265 /** 266 * Update allowed user settings (ip restriction, valid until...) 267 * 268 * @param stdClass $user 269 */ 270 public function update_ws_authorised_user($user) { 271 global $DB; 272 $DB->update_record('external_services_users', $user); 273 } 274 275 /** 276 * Return list of allowed users with their options (ip/timecreated / validuntil...) 277 * for a given service 278 * 279 * @param int $serviceid the service id to search against 280 * @return array $users 281 */ 282 public function get_ws_authorised_users($serviceid) { 283 global $DB, $CFG; 284 285 $params = array($CFG->siteguest, $serviceid); 286 287 $userfields = \core_user\fields::for_identity(context_system::instance())->with_name()->excluding('id'); 288 $fieldsql = $userfields->get_sql('u'); 289 290 $sql = " SELECT u.id as id, esu.id as serviceuserid {$fieldsql->selects}, 291 esu.iprestriction as iprestriction, esu.validuntil as validuntil, 292 esu.timecreated as timecreated 293 FROM {user} u 294 JOIN {external_services_users} esu ON esu.userid = u.id 295 {$fieldsql->joins} 296 WHERE u.id <> ? AND u.deleted = 0 AND u.confirmed = 1 297 AND esu.externalserviceid = ?"; 298 299 $users = $DB->get_records_sql($sql, array_merge($fieldsql->params, $params)); 300 301 return $users; 302 } 303 304 /** 305 * Return an authorised user with their options (ip/timecreated / validuntil...) 306 * 307 * @param int $serviceid the service id to search against 308 * @param int $userid the user to search against 309 * @return stdClass 310 */ 311 public function get_ws_authorised_user($serviceid, $userid) { 312 global $DB, $CFG; 313 $params = array($CFG->siteguest, $serviceid, $userid); 314 $sql = " SELECT u.id as id, esu.id as serviceuserid, u.email as email, u.firstname as firstname, 315 u.lastname as lastname, 316 esu.iprestriction as iprestriction, esu.validuntil as validuntil, 317 esu.timecreated as timecreated 318 FROM {user} u, {external_services_users} esu 319 WHERE u.id <> ? AND u.deleted = 0 AND u.confirmed = 1 320 AND esu.userid = u.id 321 AND esu.externalserviceid = ? 322 AND u.id = ?"; 323 $user = $DB->get_record_sql($sql, $params); 324 return $user; 325 } 326 327 /** 328 * Generate all tokens of a specific user 329 * 330 * @param int $userid user id 331 */ 332 public function generate_user_ws_tokens($userid) { 333 global $CFG, $DB; 334 335 // generate a token for non admin if web service are enable and the user has the capability to create a token 336 if (!is_siteadmin() && has_capability('moodle/webservice:createtoken', context_system::instance(), $userid) && !empty($CFG->enablewebservices)) { 337 // for every service than the user is authorised on, create a token (if it doesn't already exist) 338 339 // get all services which are set to all user (no restricted to specific users) 340 $norestrictedservices = $DB->get_records('external_services', array('restrictedusers' => 0)); 341 $serviceidlist = array(); 342 foreach ($norestrictedservices as $service) { 343 $serviceidlist[] = $service->id; 344 } 345 346 // get all services which are set to the current user (the current user is specified in the restricted user list) 347 $servicesusers = $DB->get_records('external_services_users', array('userid' => $userid)); 348 foreach ($servicesusers as $serviceuser) { 349 if (!in_array($serviceuser->externalserviceid,$serviceidlist)) { 350 $serviceidlist[] = $serviceuser->externalserviceid; 351 } 352 } 353 354 // get all services which already have a token set for the current user 355 $usertokens = $DB->get_records('external_tokens', array('userid' => $userid, 'tokentype' => EXTERNAL_TOKEN_PERMANENT)); 356 $tokenizedservice = array(); 357 foreach ($usertokens as $token) { 358 $tokenizedservice[] = $token->externalserviceid; 359 } 360 361 // create a token for the service which have no token already 362 foreach ($serviceidlist as $serviceid) { 363 if (!in_array($serviceid, $tokenizedservice)) { 364 // create the token for this service 365 $newtoken = new stdClass(); 366 $newtoken->token = md5(uniqid(rand(),1)); 367 // check that the user has capability on this service 368 $newtoken->tokentype = EXTERNAL_TOKEN_PERMANENT; 369 $newtoken->userid = $userid; 370 $newtoken->externalserviceid = $serviceid; 371 // TODO MDL-31190 find a way to get the context - UPDATE FOLLOWING LINE 372 $newtoken->contextid = context_system::instance()->id; 373 $newtoken->creatorid = $userid; 374 $newtoken->timecreated = time(); 375 $newtoken->name = \core_external\util::generate_token_name(); 376 // Generate the private token, it must be transmitted only via https. 377 $newtoken->privatetoken = random_string(64); 378 379 $DB->insert_record('external_tokens', $newtoken); 380 } 381 } 382 383 384 } 385 } 386 387 /** 388 * Return all tokens of a specific user 389 * + the service state (enabled/disabled) 390 * + the authorised user mode (restricted/not restricted) 391 * 392 * @param int $userid user id 393 * @return array 394 */ 395 public function get_user_ws_tokens($userid) { 396 global $DB; 397 //here retrieve token list (including linked users firstname/lastname and linked services name) 398 $sql = "SELECT 399 t.id, t.creatorid, t.name as tokenname, u.firstname, u.lastname, 400 s.id as wsid, s.name as servicename, s.enabled, s.restrictedusers, t.validuntil, t.lastaccess 401 FROM 402 {external_tokens} t, {user} u, {external_services} s 403 WHERE 404 t.userid=? AND t.tokentype = ".EXTERNAL_TOKEN_PERMANENT." AND s.id = t.externalserviceid AND t.userid = u.id"; 405 $tokens = $DB->get_records_sql($sql, array( $userid)); 406 return $tokens; 407 } 408 409 /** 410 * Return a token that has been created by the user (i.e. to created by an admin) 411 * If no tokens exist an exception is thrown 412 * 413 * The returned value is a stdClass: 414 * ->id token id 415 * ->token 416 * ->tokenname 417 * ->firstname user firstname 418 * ->lastname 419 * ->externalserviceid 420 * ->name service name 421 * 422 * @param int $userid user id 423 * @param int $tokenid token id 424 * @return stdClass 425 */ 426 public function get_created_by_user_ws_token($userid, $tokenid) { 427 global $DB; 428 $sql = "SELECT 429 t.id, t.token, t.name AS tokenname, u.firstname, u.lastname, t.externalserviceid, s.name 430 FROM 431 {external_tokens} t, {user} u, {external_services} s 432 WHERE 433 t.creatorid=? AND t.id=? AND t.tokentype = " 434 . EXTERNAL_TOKEN_PERMANENT 435 . " AND s.id = t.externalserviceid AND t.userid = u.id"; 436 //must be the token creator 437 $token = $DB->get_record_sql($sql, array($userid, $tokenid), MUST_EXIST); 438 return $token; 439 } 440 441 /** 442 * Return a token of an arbitrary user by tokenid, including details of the associated user and the service name. 443 * If no tokens exist an exception is thrown 444 * 445 * The returned value is a stdClass: 446 * ->id token id 447 * ->token 448 * ->firstname user firstname 449 * ->lastname 450 * ->name service name 451 * 452 * @param int $tokenid token id 453 * @return stdClass 454 */ 455 public function get_token_by_id_with_details($tokenid) { 456 global $DB; 457 $sql = "SELECT t.id, t.token, u.id AS userid, u.firstname, u.lastname, s.name, t.creatorid 458 FROM {external_tokens} t, {user} u, {external_services} s 459 WHERE t.id=? AND t.tokentype = ? AND s.id = t.externalserviceid AND t.userid = u.id"; 460 $token = $DB->get_record_sql($sql, array($tokenid, EXTERNAL_TOKEN_PERMANENT), MUST_EXIST); 461 return $token; 462 } 463 464 /** 465 * Return a database token record for a token id 466 * 467 * @param int $tokenid token id 468 * @return object token 469 */ 470 public function get_token_by_id($tokenid) { 471 global $DB; 472 return $DB->get_record('external_tokens', array('id' => $tokenid)); 473 } 474 475 /** 476 * Delete a token 477 * 478 * @param int $tokenid token id 479 */ 480 public function delete_user_ws_token($tokenid) { 481 global $DB; 482 $DB->delete_records('external_tokens', array('id'=>$tokenid)); 483 } 484 485 /** 486 * Delete all the tokens belonging to a user. 487 * 488 * @param int $userid the user id whose tokens must be deleted 489 */ 490 public static function delete_user_ws_tokens($userid) { 491 global $DB; 492 $DB->delete_records('external_tokens', array('userid' => $userid)); 493 } 494 495 /** 496 * Delete a service 497 * Also delete function references and authorised user references. 498 * 499 * @param int $serviceid service id 500 */ 501 public function delete_service($serviceid) { 502 global $DB; 503 $DB->delete_records('external_services_users', array('externalserviceid' => $serviceid)); 504 $DB->delete_records('external_services_functions', array('externalserviceid' => $serviceid)); 505 $DB->delete_records('external_tokens', array('externalserviceid' => $serviceid)); 506 $DB->delete_records('external_services', array('id' => $serviceid)); 507 } 508 509 /** 510 * Get a full database token record for a given token value 511 * 512 * @param string $token 513 * @throws moodle_exception if there is multiple result 514 */ 515 public function get_user_ws_token($token) { 516 global $DB; 517 return $DB->get_record('external_tokens', array('token'=>$token), '*', MUST_EXIST); 518 } 519 520 /** 521 * Get the functions list of a service list (by id) 522 * 523 * @param array $serviceids service ids 524 * @return array of functions 525 */ 526 public function get_external_functions($serviceids) { 527 global $DB; 528 if (!empty($serviceids)) { 529 list($serviceids, $params) = $DB->get_in_or_equal($serviceids); 530 $sql = "SELECT f.* 531 FROM {external_functions} f 532 WHERE f.name IN (SELECT sf.functionname 533 FROM {external_services_functions} sf 534 WHERE sf.externalserviceid $serviceids) 535 ORDER BY f.name ASC"; 536 $functions = $DB->get_records_sql($sql, $params); 537 } else { 538 $functions = array(); 539 } 540 return $functions; 541 } 542 543 /** 544 * Get the functions of a service list (by shortname). It can return only enabled functions if required. 545 * 546 * @param array $serviceshortnames service shortnames 547 * @param bool $enabledonly if true then only return functions for services that have been enabled 548 * @return array functions 549 */ 550 public function get_external_functions_by_enabled_services($serviceshortnames, $enabledonly = true) { 551 global $DB; 552 if (!empty($serviceshortnames)) { 553 $enabledonlysql = $enabledonly?' AND s.enabled = 1 ':''; 554 list($serviceshortnames, $params) = $DB->get_in_or_equal($serviceshortnames); 555 $sql = "SELECT f.* 556 FROM {external_functions} f 557 WHERE f.name IN (SELECT sf.functionname 558 FROM {external_services_functions} sf, {external_services} s 559 WHERE s.shortname $serviceshortnames 560 AND sf.externalserviceid = s.id 561 " . $enabledonlysql . ")"; 562 $functions = $DB->get_records_sql($sql, $params); 563 } else { 564 $functions = array(); 565 } 566 return $functions; 567 } 568 569 /** 570 * Get functions not included in a service 571 * 572 * @param int $serviceid service id 573 * @return array functions 574 */ 575 public function get_not_associated_external_functions($serviceid) { 576 global $DB; 577 $select = "name NOT IN (SELECT s.functionname 578 FROM {external_services_functions} s 579 WHERE s.externalserviceid = :sid 580 )"; 581 582 $functions = $DB->get_records_select('external_functions', 583 $select, array('sid' => $serviceid), 'name'); 584 585 return $functions; 586 } 587 588 /** 589 * Get list of required capabilities of a service, sorted by functions 590 * Example of returned value: 591 * Array 592 * ( 593 * [core_group_create_groups] => Array 594 * ( 595 * [0] => moodle/course:managegroups 596 * ) 597 * 598 * [core_enrol_get_enrolled_users] => Array 599 * ( 600 * [0] => moodle/user:viewdetails 601 * [1] => moodle/user:viewhiddendetails 602 * [2] => moodle/course:useremail 603 * [3] => moodle/user:update 604 * [4] => moodle/site:accessallgroups 605 * ) 606 * ) 607 * @param int $serviceid service id 608 * @return array 609 */ 610 public function get_service_required_capabilities($serviceid) { 611 $functions = $this->get_external_functions(array($serviceid)); 612 $requiredusercaps = array(); 613 foreach ($functions as $function) { 614 $functioncaps = explode(',', $function->capabilities); 615 if (!empty($functioncaps) and !empty($functioncaps[0])) { 616 foreach ($functioncaps as $functioncap) { 617 $requiredusercaps[$function->name][] = trim($functioncap); 618 } 619 } 620 } 621 return $requiredusercaps; 622 } 623 624 /** 625 * Get user capabilities (with context) 626 * Only useful for documentation purpose 627 * WARNING: do not use this "broken" function. It was created in the goal to display some capabilities 628 * required by users. In theory we should not need to display this kind of information 629 * as the front end does not display it itself. In pratice, 630 * admins would like the info, for more info you can follow: MDL-29962 631 * 632 * @deprecated since Moodle 3.11 in MDL-67748 without a replacement. 633 * @todo MDL-70187 Please delete this method completely in Moodle 4.3, thank you. 634 * @param int $userid user id 635 * @return array 636 */ 637 public function get_user_capabilities($userid) { 638 global $DB; 639 640 debugging('webservice::get_user_capabilities() has been deprecated.', DEBUG_DEVELOPER); 641 642 //retrieve the user capabilities 643 $sql = "SELECT DISTINCT rc.id, rc.capability FROM {role_capabilities} rc, {role_assignments} ra 644 WHERE rc.roleid=ra.roleid AND ra.userid= ? AND rc.permission = ?"; 645 $dbusercaps = $DB->get_records_sql($sql, array($userid, CAP_ALLOW)); 646 $usercaps = array(); 647 foreach ($dbusercaps as $usercap) { 648 $usercaps[$usercap->capability] = true; 649 } 650 return $usercaps; 651 } 652 653 /** 654 * Get missing user capabilities for the given service's functions. 655 * 656 * Every external function can declare some required capabilities to allow for easier setup of the web services. 657 * However, that is supposed to be used for informational admin report only. There is no automatic evaluation of 658 * the declared capabilities and the context of the capability evaluation is ignored. Also, actual capability 659 * evaluation is much more complex as it allows for overrides etc. 660 * 661 * Returned are capabilities that the given users do not seem to have assigned anywhere at the site and that should 662 * be checked by the admin. 663 * 664 * Do not use this method for anything else, particularly not for any security related checks. See MDL-29962 for the 665 * background of why we have this - there are arguments for dropping this feature completely. 666 * 667 * @param array $users List of users to check, consisting of objects, arrays or integer ids. 668 * @param int $serviceid The id of the external service to check. 669 * @return array List of missing capabilities: (int)userid => array of (string)capabilitynames 670 */ 671 public function get_missing_capabilities_by_users(array $users, int $serviceid): array { 672 global $DB; 673 674 // The following are default capabilities for all authenticated users and we will assume them granted. 675 $commoncaps = get_default_capabilities('user'); 676 677 // Get the list of additional capabilities required by the service. 678 $servicecaps = []; 679 foreach ($this->get_service_required_capabilities($serviceid) as $service => $caps) { 680 foreach ($caps as $cap) { 681 if (empty($commoncaps[$cap])) { 682 $servicecaps[$cap] = true; 683 } 684 } 685 } 686 687 // Bail out early if there's nothing to process. 688 if (empty($users) || empty($servicecaps)) { 689 return []; 690 } 691 692 // Prepare a list of user ids we want to check. 693 $userids = []; 694 foreach ($users as $user) { 695 if (is_object($user) && isset($user->id)) { 696 $userids[$user->id] = true; 697 } else if (is_array($user) && isset($user['id'])) { 698 $userids[$user['id']] = true; 699 } else { 700 throw new coding_exception('Unexpected format of users list in webservice::get_missing_capabilities_by_users().'); 701 } 702 } 703 704 // Prepare a matrix of missing capabilities x users - consider them all missing by default. 705 foreach (array_keys($userids) as $userid) { 706 foreach (array_keys($servicecaps) as $capname) { 707 $matrix[$userid][$capname] = true; 708 } 709 } 710 711 list($capsql, $capparams) = $DB->get_in_or_equal(array_keys($servicecaps), SQL_PARAMS_NAMED, 'paramcap'); 712 list($usersql, $userparams) = $DB->get_in_or_equal(array_keys($userids), SQL_PARAMS_NAMED, 'paramuser'); 713 714 $sql = "SELECT c.name AS capability, u.id AS userid 715 FROM {capabilities} c 716 JOIN {role_capabilities} rc ON c.name = rc.capability 717 JOIN {role_assignments} ra ON ra.roleid = rc.roleid 718 JOIN {user} u ON ra.userid = u.id 719 WHERE rc.permission = :capallow 720 AND c.name {$capsql} 721 AND u.id {$usersql}"; 722 723 $params = $capparams + $userparams + [ 724 'capallow' => CAP_ALLOW, 725 ]; 726 727 $rs = $DB->get_recordset_sql($sql, $params); 728 729 foreach ($rs as $record) { 730 // If there was a potential role assignment found that might grant the user the given capability, 731 // remove it from the matrix. Again, we ignore all the contexts, prohibits, prevents and other details 732 // of the permissions evaluations. See the function docblock for details. 733 unset($matrix[$record->userid][$record->capability]); 734 } 735 736 $rs->close(); 737 738 foreach ($matrix as $userid => $caps) { 739 $matrix[$userid] = array_keys($caps); 740 if (empty($matrix[$userid])) { 741 unset($matrix[$userid]); 742 } 743 } 744 745 return $matrix; 746 } 747 748 /** 749 * Get an external service for a given service id 750 * 751 * @param int $serviceid service id 752 * @param int $strictness IGNORE_MISSING, MUST_EXIST... 753 * @return stdClass external service 754 */ 755 public function get_external_service_by_id($serviceid, $strictness=IGNORE_MISSING) { 756 global $DB; 757 $service = $DB->get_record('external_services', 758 array('id' => $serviceid), '*', $strictness); 759 return $service; 760 } 761 762 /** 763 * Get an external service for a given shortname 764 * 765 * @param string $shortname service shortname 766 * @param int $strictness IGNORE_MISSING, MUST_EXIST... 767 * @return stdClass external service 768 */ 769 public function get_external_service_by_shortname($shortname, $strictness=IGNORE_MISSING) { 770 global $DB; 771 $service = $DB->get_record('external_services', 772 array('shortname' => $shortname), '*', $strictness); 773 return $service; 774 } 775 776 /** 777 * Get an external function for a given function id 778 * 779 * @param int $functionid function id 780 * @param int $strictness IGNORE_MISSING, MUST_EXIST... 781 * @return stdClass external function 782 */ 783 public function get_external_function_by_id($functionid, $strictness=IGNORE_MISSING) { 784 global $DB; 785 $function = $DB->get_record('external_functions', 786 array('id' => $functionid), '*', $strictness); 787 return $function; 788 } 789 790 /** 791 * Add a function to a service 792 * 793 * @param string $functionname function name 794 * @param int $serviceid service id 795 */ 796 public function add_external_function_to_service($functionname, $serviceid) { 797 global $DB; 798 $addedfunction = new stdClass(); 799 $addedfunction->externalserviceid = $serviceid; 800 $addedfunction->functionname = $functionname; 801 $DB->insert_record('external_services_functions', $addedfunction); 802 } 803 804 /** 805 * Add a service 806 * It generates the timecreated field automatically. 807 * 808 * @param stdClass $service 809 * @return serviceid integer 810 */ 811 public function add_external_service($service) { 812 global $DB; 813 $service->timecreated = time(); 814 $serviceid = $DB->insert_record('external_services', $service); 815 return $serviceid; 816 } 817 818 /** 819 * Update a service 820 * It modifies the timemodified automatically. 821 * 822 * @param stdClass $service 823 */ 824 public function update_external_service($service) { 825 global $DB; 826 $service->timemodified = time(); 827 $DB->update_record('external_services', $service); 828 } 829 830 /** 831 * Test whether an external function is already linked to a service 832 * 833 * @param string $functionname function name 834 * @param int $serviceid service id 835 * @return bool true if a matching function exists for the service, else false. 836 * @throws dml_exception if error 837 */ 838 public function service_function_exists($functionname, $serviceid) { 839 global $DB; 840 return $DB->record_exists('external_services_functions', 841 array('externalserviceid' => $serviceid, 842 'functionname' => $functionname)); 843 } 844 845 /** 846 * Remove a function from a service 847 * 848 * @param string $functionname function name 849 * @param int $serviceid service id 850 */ 851 public function remove_external_function_from_service($functionname, $serviceid) { 852 global $DB; 853 $DB->delete_records('external_services_functions', 854 array('externalserviceid' => $serviceid, 'functionname' => $functionname)); 855 856 } 857 858 /** 859 * Return a list with all the valid user tokens for the given user, it only excludes expired tokens. 860 * 861 * @param string $userid user id to retrieve tokens from 862 * @return array array of token entries 863 * @since Moodle 3.2 864 */ 865 public static function get_active_tokens($userid) { 866 global $DB; 867 868 $sql = 'SELECT t.id, t.creatorid, t.externalserviceid, t.name AS tokenname, t.validuntil, s.name AS servicename 869 FROM {external_tokens} t 870 JOIN {external_services} s ON t.externalserviceid = s.id 871 WHERE t.userid = :userid AND (COALESCE(t.validuntil, 0) = 0 OR t.validuntil > :now)'; 872 $params = array('userid' => $userid, 'now' => time()); 873 return $DB->get_records_sql($sql, $params); 874 } 875 } 876 877 /** 878 * Exception indicating access control problem in web service call 879 * This exception should return general errors about web service setup. 880 * Errors related to the user like wrong username/password should not use it, 881 * you should not use this exception if you want to let the client implement 882 * some code logic against an access error. 883 * 884 * @package core_webservice 885 * @copyright 2009 Petr Skodak 886 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 887 */ 888 class webservice_access_exception extends moodle_exception { 889 890 /** 891 * Constructor 892 * 893 * @param string $debuginfo the debug info 894 */ 895 function __construct($debuginfo) { 896 parent::__construct('accessexception', 'webservice', '', null, $debuginfo); 897 } 898 } 899 900 /** 901 * Check if a protocol is enabled 902 * 903 * @param string $protocol name of WS protocol ('rest', 'soap', ...) 904 * @return bool true if the protocol is enabled 905 */ 906 function webservice_protocol_is_enabled($protocol) { 907 global $CFG; 908 909 if (empty($CFG->enablewebservices) || empty($CFG->webserviceprotocols)) { 910 return false; 911 } 912 913 $active = explode(',', $CFG->webserviceprotocols); 914 915 return(in_array($protocol, $active)); 916 } 917 918 /** 919 * Mandatory interface for all test client classes. 920 * 921 * @package core_webservice 922 * @copyright 2009 Petr Skodak 923 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 924 */ 925 interface webservice_test_client_interface { 926 927 /** 928 * Execute test client WS request 929 * 930 * @param string $serverurl server url (including the token param) 931 * @param string $function web service function name 932 * @param array $params parameters of the web service function 933 * @return mixed 934 */ 935 public function simpletest($serverurl, $function, $params); 936 } 937 938 /** 939 * Mandatory interface for all web service protocol classes 940 * 941 * @package core_webservice 942 * @copyright 2009 Petr Skodak 943 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 944 */ 945 interface webservice_server_interface { 946 947 /** 948 * Process request from client. 949 */ 950 public function run(); 951 } 952 953 /** 954 * Abstract web service base class. 955 * 956 * @package core_webservice 957 * @copyright 2009 Petr Skodak 958 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 959 */ 960 abstract class webservice_server implements webservice_server_interface { 961 962 /** @var string Name of the web server plugin */ 963 protected $wsname = null; 964 965 /** @var string Name of local user */ 966 protected $username = null; 967 968 /** @var string Password of the local user */ 969 protected $password = null; 970 971 /** @var int The local user */ 972 protected $userid = null; 973 974 /** @var integer Authentication method one of WEBSERVICE_AUTHMETHOD_* */ 975 protected $authmethod; 976 977 /** @var string Authentication token*/ 978 protected $token = null; 979 980 /** @var stdClass Restricted context */ 981 protected $restricted_context; 982 983 /** @var int Restrict call to one service id*/ 984 protected $restricted_serviceid = null; 985 986 /** 987 * Constructor 988 * 989 * @param integer $authmethod authentication method one of WEBSERVICE_AUTHMETHOD_* 990 */ 991 public function __construct($authmethod) { 992 $this->authmethod = $authmethod; 993 } 994 995 996 /** 997 * Authenticate user using username+password or token. 998 * This function sets up $USER global. 999 * It is safe to use has_capability() after this. 1000 * This method also verifies user is allowed to use this 1001 * server. 1002 */ 1003 protected function authenticate_user() { 1004 global $CFG, $DB; 1005 1006 if (!NO_MOODLE_COOKIES) { 1007 throw new coding_exception('Cookies must be disabled in WS servers!'); 1008 } 1009 1010 $loginfaileddefaultparams = array( 1011 'other' => array( 1012 'method' => $this->authmethod, 1013 'reason' => null 1014 ) 1015 ); 1016 1017 if ($this->authmethod == WEBSERVICE_AUTHMETHOD_USERNAME) { 1018 1019 //we check that authentication plugin is enabled 1020 //it is only required by simple authentication 1021 if (!is_enabled_auth('webservice')) { 1022 throw new webservice_access_exception('The web service authentication plugin is disabled.'); 1023 } 1024 1025 if (!$auth = get_auth_plugin('webservice')) { 1026 throw new webservice_access_exception('The web service authentication plugin is missing.'); 1027 } 1028 1029 $this->restricted_context = context_system::instance(); 1030 1031 if (!$this->username) { 1032 throw new moodle_exception('missingusername', 'webservice'); 1033 } 1034 1035 if (!$this->password) { 1036 throw new moodle_exception('missingpassword', 'webservice'); 1037 } 1038 1039 if (!$auth->user_login_webservice($this->username, $this->password)) { 1040 1041 // Log failed login attempts. 1042 $params = $loginfaileddefaultparams; 1043 $params['other']['reason'] = 'password'; 1044 $params['other']['username'] = $this->username; 1045 $event = \core\event\webservice_login_failed::create($params); 1046 $event->trigger(); 1047 1048 throw new moodle_exception('wrongusernamepassword', 'webservice'); 1049 } 1050 1051 $user = $DB->get_record('user', array('username'=>$this->username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST); 1052 1053 } else if ($this->authmethod == WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN){ 1054 $user = $this->authenticate_by_token(EXTERNAL_TOKEN_PERMANENT); 1055 } else { 1056 $user = $this->authenticate_by_token(EXTERNAL_TOKEN_EMBEDDED); 1057 } 1058 1059 // Cannot authenticate unless maintenance access is granted. 1060 $hasmaintenanceaccess = has_capability('moodle/site:maintenanceaccess', context_system::instance(), $user); 1061 if (!empty($CFG->maintenance_enabled) and !$hasmaintenanceaccess) { 1062 throw new moodle_exception('sitemaintenance', 'admin'); 1063 } 1064 1065 //only confirmed user should be able to call web service 1066 if (!empty($user->deleted)) { 1067 $params = $loginfaileddefaultparams; 1068 $params['other']['reason'] = 'user_deleted'; 1069 $params['other']['username'] = $user->username; 1070 $event = \core\event\webservice_login_failed::create($params); 1071 $event->trigger(); 1072 throw new moodle_exception('wsaccessuserdeleted', 'webservice', '', $user->username); 1073 } 1074 1075 //only confirmed user should be able to call web service 1076 if (empty($user->confirmed)) { 1077 $params = $loginfaileddefaultparams; 1078 $params['other']['reason'] = 'user_unconfirmed'; 1079 $params['other']['username'] = $user->username; 1080 $event = \core\event\webservice_login_failed::create($params); 1081 $event->trigger(); 1082 throw new moodle_exception('wsaccessuserunconfirmed', 'webservice', '', $user->username); 1083 } 1084 1085 //check the user is suspended 1086 if (!empty($user->suspended)) { 1087 $params = $loginfaileddefaultparams; 1088 $params['other']['reason'] = 'user_unconfirmed'; 1089 $params['other']['username'] = $user->username; 1090 $event = \core\event\webservice_login_failed::create($params); 1091 $event->trigger(); 1092 throw new moodle_exception('wsaccessusersuspended', 'webservice', '', $user->username); 1093 } 1094 1095 //retrieve the authentication plugin if no previously done 1096 if (empty($auth)) { 1097 $auth = get_auth_plugin($user->auth); 1098 } 1099 1100 // check if credentials have expired 1101 if (!empty($auth->config->expiration) and $auth->config->expiration == 1) { 1102 $days2expire = $auth->password_expire($user->username); 1103 if (intval($days2expire) < 0 ) { 1104 $params = $loginfaileddefaultparams; 1105 $params['other']['reason'] = 'password_expired'; 1106 $params['other']['username'] = $user->username; 1107 $event = \core\event\webservice_login_failed::create($params); 1108 $event->trigger(); 1109 throw new moodle_exception('wsaccessuserexpired', 'webservice', '', $user->username); 1110 } 1111 } 1112 1113 //check if the auth method is nologin (in this case refuse connection) 1114 if ($user->auth=='nologin') { 1115 $params = $loginfaileddefaultparams; 1116 $params['other']['reason'] = 'login'; 1117 $params['other']['username'] = $user->username; 1118 $event = \core\event\webservice_login_failed::create($params); 1119 $event->trigger(); 1120 throw new moodle_exception('wsaccessusernologin', 'webservice', '', $user->username); 1121 } 1122 1123 // now fake user login, the session is completely empty too 1124 enrol_check_plugins($user, false); 1125 \core\session\manager::set_user($user); 1126 set_login_session_preferences(); 1127 $this->userid = $user->id; 1128 1129 if ($this->authmethod != WEBSERVICE_AUTHMETHOD_SESSION_TOKEN && !has_capability("webservice/$this->wsname:use", $this->restricted_context)) { 1130 throw new webservice_access_exception("You are not allowed to use the {$this->wsname} protocol " . 1131 "(missing capability: webservice/{$this->wsname}:use)"); 1132 } 1133 1134 external_api::set_context_restriction($this->restricted_context); 1135 } 1136 1137 /** 1138 * User authentication by token 1139 * 1140 * @param string $tokentype token type (EXTERNAL_TOKEN_EMBEDDED or EXTERNAL_TOKEN_PERMANENT) 1141 * @return stdClass the authenticated user 1142 * @throws webservice_access_exception 1143 */ 1144 protected function authenticate_by_token($tokentype){ 1145 global $DB; 1146 1147 $loginfaileddefaultparams = array( 1148 'other' => array( 1149 'method' => $this->authmethod, 1150 'reason' => null 1151 ) 1152 ); 1153 1154 if (!$token = $DB->get_record('external_tokens', array('token'=>$this->token, 'tokentype'=>$tokentype))) { 1155 // Log failed login attempts. 1156 $params = $loginfaileddefaultparams; 1157 $params['other']['reason'] = 'invalid_token'; 1158 $event = \core\event\webservice_login_failed::create($params); 1159 $event->trigger(); 1160 throw new moodle_exception('invalidtoken', 'webservice'); 1161 } 1162 1163 if ($token->validuntil and $token->validuntil < time()) { 1164 $DB->delete_records('external_tokens', array('token'=>$this->token, 'tokentype'=>$tokentype)); 1165 throw new webservice_access_exception('Invalid token - token expired - check validuntil time for the token'); 1166 } 1167 1168 if ($token->sid){//assumes that if sid is set then there must be a valid associated session no matter the token type 1169 if (!\core\session\manager::session_exists($token->sid)){ 1170 $DB->delete_records('external_tokens', array('sid'=>$token->sid)); 1171 throw new webservice_access_exception('Invalid session based token - session not found or expired'); 1172 } 1173 } 1174 1175 if ($token->iprestriction and !address_in_subnet(getremoteaddr(), $token->iprestriction)) { 1176 $params = $loginfaileddefaultparams; 1177 $params['other']['reason'] = 'ip_restricted'; 1178 $params['other']['tokenid'] = $token->id; 1179 $event = \core\event\webservice_login_failed::create($params); 1180 $event->add_record_snapshot('external_tokens', $token); 1181 $event->trigger(); 1182 throw new webservice_access_exception('Invalid service - IP:' . getremoteaddr() 1183 . ' is not supported - check this allowed user'); 1184 } 1185 1186 $this->restricted_context = context::instance_by_id($token->contextid); 1187 $this->restricted_serviceid = $token->externalserviceid; 1188 1189 $user = $DB->get_record('user', array('id'=>$token->userid), '*', MUST_EXIST); 1190 1191 // log token access 1192 webservice::update_token_lastaccess($token); 1193 1194 return $user; 1195 1196 } 1197 1198 /** 1199 * Intercept some moodlewssettingXXX $_GET and $_POST parameter 1200 * that are related to the web service call and are not the function parameters 1201 */ 1202 protected function set_web_service_call_settings() { 1203 global $CFG; 1204 1205 // Default web service settings. 1206 // Must be the same XXX key name as the external_settings::set_XXX function. 1207 // Must be the same XXX ws parameter name as 'moodlewssettingXXX'. 1208 $externalsettings = array( 1209 'raw' => array('default' => false, 'type' => PARAM_BOOL), 1210 'fileurl' => array('default' => true, 'type' => PARAM_BOOL), 1211 'filter' => array('default' => false, 'type' => PARAM_BOOL), 1212 'lang' => array('default' => '', 'type' => PARAM_LANG), 1213 'timezone' => array('default' => '', 'type' => PARAM_TIMEZONE), 1214 ); 1215 1216 // Load the external settings with the web service settings. 1217 $settings = external_settings::get_instance(); 1218 foreach ($externalsettings as $name => $settingdata) { 1219 1220 $wsparamname = 'moodlewssetting' . $name; 1221 1222 // Retrieve and remove the setting parameter from the request. 1223 $value = optional_param($wsparamname, $settingdata['default'], $settingdata['type']); 1224 unset($_GET[$wsparamname]); 1225 unset($_POST[$wsparamname]); 1226 1227 $functioname = 'set_' . $name; 1228 $settings->$functioname($value); 1229 } 1230 1231 } 1232 } 1233 1234 /** 1235 * Web Service server base class. 1236 * 1237 * This class handles both simple and token authentication. 1238 * 1239 * @package core_webservice 1240 * @copyright 2009 Petr Skodak 1241 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 1242 */ 1243 abstract class webservice_base_server extends webservice_server { 1244 1245 /** @var array The function parameters - the real values submitted in the request */ 1246 protected $parameters = null; 1247 1248 /** @var string The name of the function that is executed */ 1249 protected $functionname = null; 1250 1251 /** @var stdClass Full function description */ 1252 protected $function = null; 1253 1254 /** @var mixed Function return value */ 1255 protected $returns = null; 1256 1257 /** @var array List of methods and their information provided by the web service. */ 1258 protected $servicemethods; 1259 1260 /** @var array List of struct classes generated for the web service methods. */ 1261 protected $servicestructs; 1262 1263 /** @var string service class name. */ 1264 protected $serviceclass; 1265 1266 /** 1267 * This method parses the request input, it needs to get: 1268 * 1/ user authentication - username+password or token 1269 * 2/ function name 1270 * 3/ function parameters 1271 */ 1272 abstract protected function parse_request(); 1273 1274 /** 1275 * Send the result of function call to the WS client. 1276 */ 1277 abstract protected function send_response(); 1278 1279 /** 1280 * Send the error information to the WS client. 1281 * 1282 * @param exception $ex 1283 */ 1284 abstract protected function send_error($ex=null); 1285 1286 /** 1287 * Process request from client. 1288 * 1289 * @uses die 1290 */ 1291 public function run() { 1292 global $CFG, $USER, $SESSION; 1293 1294 // we will probably need a lot of memory in some functions 1295 raise_memory_limit(MEMORY_EXTRA); 1296 1297 // set some longer timeout, this script is not sending any output, 1298 // this means we need to manually extend the timeout operations 1299 // that need longer time to finish 1300 external_api::set_timeout(); 1301 1302 // set up exception handler first, we want to sent them back in correct format that 1303 // the other system understands 1304 // we do not need to call the original default handler because this ws handler does everything 1305 set_exception_handler(array($this, 'exception_handler')); 1306 1307 // init all properties from the request data 1308 $this->parse_request(); 1309 1310 // authenticate user, this has to be done after the request parsing 1311 // this also sets up $USER and $SESSION 1312 $this->authenticate_user(); 1313 1314 // find all needed function info and make sure user may actually execute the function 1315 $this->load_function_info(); 1316 1317 // Log the web service request. 1318 $params = array( 1319 'other' => array( 1320 'function' => $this->functionname 1321 ) 1322 ); 1323 $event = \core\event\webservice_function_called::create($params); 1324 $event->trigger(); 1325 1326 // Do additional setup stuff. 1327 $settings = external_settings::get_instance(); 1328 $sessionlang = $settings->get_lang(); 1329 if (!empty($sessionlang)) { 1330 $SESSION->lang = $sessionlang; 1331 } 1332 1333 setup_lang_from_browser(); 1334 1335 if (empty($CFG->lang)) { 1336 if (empty($SESSION->lang)) { 1337 $CFG->lang = 'en'; 1338 } else { 1339 $CFG->lang = $SESSION->lang; 1340 } 1341 } 1342 1343 // Change timezone only in sites where it isn't forced. 1344 $newtimezone = $settings->get_timezone(); 1345 if (!empty($newtimezone) && (!isset($CFG->forcetimezone) || $CFG->forcetimezone == 99)) { 1346 $USER->timezone = $newtimezone; 1347 } 1348 1349 // finally, execute the function - any errors are catched by the default exception handler 1350 $this->execute(); 1351 1352 // send the results back in correct format 1353 $this->send_response(); 1354 1355 // session cleanup 1356 $this->session_cleanup(); 1357 1358 die; 1359 } 1360 1361 /** 1362 * Specialised exception handler, we can not use the standard one because 1363 * it can not just print html to output. 1364 * 1365 * @param exception $ex 1366 * $uses exit 1367 */ 1368 public function exception_handler($ex) { 1369 // detect active db transactions, rollback and log as error 1370 abort_all_db_transactions(); 1371 1372 // some hacks might need a cleanup hook 1373 $this->session_cleanup($ex); 1374 1375 // now let the plugin send the exception to client 1376 $this->send_error($ex); 1377 1378 // not much else we can do now, add some logging later 1379 exit(1); 1380 } 1381 1382 /** 1383 * Future hook needed for emulated sessions. 1384 * 1385 * @param exception $exception null means normal termination, $exception received when WS call failed 1386 */ 1387 protected function session_cleanup($exception=null) { 1388 if ($this->authmethod == WEBSERVICE_AUTHMETHOD_USERNAME) { 1389 // nothing needs to be done, there is no persistent session 1390 } else { 1391 // close emulated session if used 1392 } 1393 } 1394 1395 /** 1396 * Fetches the function description from database, 1397 * verifies user is allowed to use this function and 1398 * loads all paremeters and return descriptions. 1399 */ 1400 protected function load_function_info() { 1401 global $DB, $USER, $CFG; 1402 1403 if (empty($this->functionname)) { 1404 throw new invalid_parameter_exception('Missing function name'); 1405 } 1406 1407 // function must exist 1408 $function = external_api::external_function_info($this->functionname); 1409 1410 if ($this->restricted_serviceid) { 1411 $params = array('sid1'=>$this->restricted_serviceid, 'sid2'=>$this->restricted_serviceid); 1412 $wscond1 = 'AND s.id = :sid1'; 1413 $wscond2 = 'AND s.id = :sid2'; 1414 } else { 1415 $params = array(); 1416 $wscond1 = ''; 1417 $wscond2 = ''; 1418 } 1419 1420 // now let's verify access control 1421 1422 // now make sure the function is listed in at least one service user is allowed to use 1423 // allow access only if: 1424 // 1/ entry in the external_services_users table if required 1425 // 2/ validuntil not reached 1426 // 3/ has capability if specified in service desc 1427 // 4/ iprestriction 1428 1429 $sql = "SELECT s.*, NULL AS iprestriction 1430 FROM {external_services} s 1431 JOIN {external_services_functions} sf ON (sf.externalserviceid = s.id AND s.restrictedusers = 0 AND sf.functionname = :name1) 1432 WHERE s.enabled = 1 $wscond1 1433 1434 UNION 1435 1436 SELECT s.*, su.iprestriction 1437 FROM {external_services} s 1438 JOIN {external_services_functions} sf ON (sf.externalserviceid = s.id AND s.restrictedusers = 1 AND sf.functionname = :name2) 1439 JOIN {external_services_users} su ON (su.externalserviceid = s.id AND su.userid = :userid) 1440 WHERE s.enabled = 1 AND (su.validuntil IS NULL OR su.validuntil < :now) $wscond2"; 1441 $params = array_merge($params, array('userid'=>$USER->id, 'name1'=>$function->name, 'name2'=>$function->name, 'now'=>time())); 1442 1443 $rs = $DB->get_recordset_sql($sql, $params); 1444 // now make sure user may access at least one service 1445 $remoteaddr = getremoteaddr(); 1446 $allowed = false; 1447 foreach ($rs as $service) { 1448 if ($service->requiredcapability and !has_capability($service->requiredcapability, $this->restricted_context)) { 1449 continue; // cap required, sorry 1450 } 1451 if ($service->iprestriction and !address_in_subnet($remoteaddr, $service->iprestriction)) { 1452 continue; // wrong request source ip, sorry 1453 } 1454 $allowed = true; 1455 break; // one service is enough, no need to continue 1456 } 1457 $rs->close(); 1458 if (!$allowed) { 1459 throw new webservice_access_exception( 1460 'Access to the function '.$this->functionname.'() is not allowed. 1461 There could be multiple reasons for this: 1462 1. The service linked to the user token does not contain the function. 1463 2. The service is user-restricted and the user is not listed. 1464 3. The service is IP-restricted and the user IP is not listed. 1465 4. The service is time-restricted and the time has expired. 1466 5. The token is time-restricted and the time has expired. 1467 6. The service requires a specific capability which the user does not have. 1468 7. The function is called with username/password (no user token is sent) 1469 and none of the services has the function to allow the user. 1470 These settings can be found in Administration > Site administration 1471 > Server > Web services > External services and Manage tokens.'); 1472 } 1473 1474 // we have all we need now 1475 $this->function = $function; 1476 } 1477 1478 /** 1479 * Execute previously loaded function using parameters parsed from the request data. 1480 */ 1481 protected function execute() { 1482 // validate params, this also sorts the params properly, we need the correct order in the next part 1483 $params = call_user_func(array($this->function->classname, 'validate_parameters'), $this->function->parameters_desc, $this->parameters); 1484 $params = array_values($params); 1485 1486 // Allow any Moodle plugin a chance to override this call. This is a convenient spot to 1487 // make arbitrary behaviour customisations, for example to affect the mobile app behaviour. 1488 // The overriding plugin could call the 'real' function first and then modify the results, 1489 // or it could do a completely separate thing. 1490 $callbacks = get_plugins_with_function('override_webservice_execution'); 1491 foreach ($callbacks as $plugintype => $plugins) { 1492 foreach ($plugins as $plugin => $callback) { 1493 $result = $callback($this->function, $params); 1494 if ($result !== false) { 1495 // If the callback returns anything other than false, we assume it replaces the 1496 // real function. 1497 $this->returns = $result; 1498 return; 1499 } 1500 } 1501 } 1502 1503 // execute - yay! 1504 $this->returns = call_user_func_array(array($this->function->classname, $this->function->methodname), $params); 1505 } 1506 1507 /** 1508 * Load the virtual class needed for the web service. 1509 * 1510 * Initialises the virtual class that contains the web service functions that the user is allowed to use. 1511 * The web service function will be available if the user: 1512 * - is validly registered in the external_services_users table. 1513 * - has the required capability. 1514 * - meets the IP restriction requirement. 1515 * This virtual class can be used by web service protocols such as SOAP, especially when generating WSDL. 1516 */ 1517 protected function init_service_class() { 1518 global $USER, $DB; 1519 1520 // Initialise service methods and struct classes. 1521 $this->servicemethods = array(); 1522 $this->servicestructs = array(); 1523 1524 $params = array(); 1525 $wscond1 = ''; 1526 $wscond2 = ''; 1527 if ($this->restricted_serviceid) { 1528 $params = array('sid1' => $this->restricted_serviceid, 'sid2' => $this->restricted_serviceid); 1529 $wscond1 = 'AND s.id = :sid1'; 1530 $wscond2 = 'AND s.id = :sid2'; 1531 } 1532 1533 $sql = "SELECT s.*, NULL AS iprestriction 1534 FROM {external_services} s 1535 JOIN {external_services_functions} sf ON (sf.externalserviceid = s.id AND s.restrictedusers = 0) 1536 WHERE s.enabled = 1 $wscond1 1537 1538 UNION 1539 1540 SELECT s.*, su.iprestriction 1541 FROM {external_services} s 1542 JOIN {external_services_functions} sf ON (sf.externalserviceid = s.id AND s.restrictedusers = 1) 1543 JOIN {external_services_users} su ON (su.externalserviceid = s.id AND su.userid = :userid) 1544 WHERE s.enabled = 1 AND (su.validuntil IS NULL OR su.validuntil < :now) $wscond2"; 1545 $params = array_merge($params, array('userid' => $USER->id, 'now' => time())); 1546 1547 $serviceids = array(); 1548 $remoteaddr = getremoteaddr(); 1549 1550 // Query list of external services for the user. 1551 $rs = $DB->get_recordset_sql($sql, $params); 1552 1553 // Check which service ID to include. 1554 foreach ($rs as $service) { 1555 if (isset($serviceids[$service->id])) { 1556 continue; // Service already added. 1557 } 1558 if ($service->requiredcapability and !has_capability($service->requiredcapability, $this->restricted_context)) { 1559 continue; // Cap required, sorry. 1560 } 1561 if ($service->iprestriction and !address_in_subnet($remoteaddr, $service->iprestriction)) { 1562 continue; // Wrong request source ip, sorry. 1563 } 1564 $serviceids[$service->id] = $service->id; 1565 } 1566 $rs->close(); 1567 1568 // Generate the virtual class name. 1569 $classname = 'webservices_virtual_class_000000'; 1570 while (class_exists($classname)) { 1571 $classname++; 1572 } 1573 $this->serviceclass = $classname; 1574 1575 // Get the list of all available external functions. 1576 $wsmanager = new webservice(); 1577 $functions = $wsmanager->get_external_functions($serviceids); 1578 1579 // Generate code for the virtual methods for this web service. 1580 $methods = ''; 1581 foreach ($functions as $function) { 1582 $methods .= $this->get_virtual_method_code($function); 1583 } 1584 1585 $code = <<<EOD 1586 /** 1587 * Virtual class web services for user id $USER->id in context {$this->restricted_context->id}. 1588 */ 1589 class $classname { 1590 $methods 1591 } 1592 EOD; 1593 // Load the virtual class definition into memory. 1594 eval($code); 1595 } 1596 1597 /** 1598 * Generates a struct class. 1599 * 1600 * @param external_single_structure $structdesc The basis of the struct class to be generated. 1601 * @return string The class name of the generated struct class. 1602 */ 1603 protected function generate_simple_struct_class(external_single_structure $structdesc) { 1604 global $USER; 1605 1606 $propeties = array(); 1607 $fields = array(); 1608 foreach ($structdesc->keys as $name => $fieldsdesc) { 1609 $type = $this->get_phpdoc_type($fieldsdesc); 1610 $propertytype = array('type' => $type); 1611 if (empty($fieldsdesc->allownull) || $fieldsdesc->allownull == NULL_ALLOWED) { 1612 $propertytype['nillable'] = true; 1613 } 1614 $propeties[$name] = $propertytype; 1615 $fields[] = ' /** @var ' . $type . ' $' . $name . '*/'; 1616 $fields[] = ' public $' . $name .';'; 1617 } 1618 $fieldsstr = implode("\n", $fields); 1619 1620 // We do this after the call to get_phpdoc_type() to avoid duplicate class creation. 1621 $classname = 'webservices_struct_class_000000'; 1622 while (class_exists($classname)) { 1623 $classname++; 1624 } 1625 $code = <<<EOD 1626 /** 1627 * Virtual struct class for web services for user id $USER->id in context {$this->restricted_context->id}. 1628 */ 1629 class $classname { 1630 $fieldsstr 1631 } 1632 EOD; 1633 // Load into memory. 1634 eval($code); 1635 1636 // Prepare struct info. 1637 $structinfo = new stdClass(); 1638 $structinfo->classname = $classname; 1639 $structinfo->properties = $propeties; 1640 // Add the struct info the the list of service struct classes. 1641 $this->servicestructs[] = $structinfo; 1642 1643 return $classname; 1644 } 1645 1646 /** 1647 * Returns a virtual method code for a web service function. 1648 * 1649 * @param stdClass $function a record from external_function 1650 * @return string The PHP code of the virtual method. 1651 * @throws coding_exception 1652 * @throws moodle_exception 1653 */ 1654 protected function get_virtual_method_code($function) { 1655 $function = external_api::external_function_info($function); 1656 1657 // Parameters and their defaults for the method signature. 1658 $paramanddefaults = array(); 1659 // Parameters for external lib call. 1660 $params = array(); 1661 $paramdesc = array(); 1662 // The method's input parameters and their respective types. 1663 $inputparams = array(); 1664 // The method's output parameters and their respective types. 1665 $outputparams = array(); 1666 1667 foreach ($function->parameters_desc->keys as $name => $keydesc) { 1668 $param = '$' . $name; 1669 $paramanddefault = $param; 1670 if ($keydesc->required == VALUE_OPTIONAL) { 1671 // It does not make sense to declare a parameter VALUE_OPTIONAL. VALUE_OPTIONAL is used only for array/object key. 1672 throw new moodle_exception('erroroptionalparamarray', 'webservice', '', $name); 1673 } else if ($keydesc->required == VALUE_DEFAULT) { 1674 // Need to generate the default, if there is any. 1675 if ($keydesc instanceof external_value) { 1676 if ($keydesc->default === null) { 1677 $paramanddefault .= ' = null'; 1678 } else { 1679 switch ($keydesc->type) { 1680 case PARAM_BOOL: 1681 $default = (int)$keydesc->default; 1682 break; 1683 case PARAM_INT: 1684 $default = $keydesc->default; 1685 break; 1686 case PARAM_FLOAT; 1687 $default = $keydesc->default; 1688 break; 1689 default: 1690 $default = "'$keydesc->default'"; 1691 } 1692 $paramanddefault .= " = $default"; 1693 } 1694 } else { 1695 // Accept empty array as default. 1696 if (isset($keydesc->default) && is_array($keydesc->default) && empty($keydesc->default)) { 1697 $paramanddefault .= ' = array()'; 1698 } else { 1699 // For the moment we do not support default for other structure types. 1700 throw new moodle_exception('errornotemptydefaultparamarray', 'webservice', '', $name); 1701 } 1702 } 1703 } 1704 1705 $params[] = $param; 1706 $paramanddefaults[] = $paramanddefault; 1707 $type = $this->get_phpdoc_type($keydesc); 1708 $inputparams[$name]['type'] = $type; 1709 1710 $paramdesc[] = '* @param ' . $type . ' $' . $name . ' ' . $keydesc->desc; 1711 } 1712 $paramanddefaults = implode(', ', $paramanddefaults); 1713 $paramdescstr = implode("\n ", $paramdesc); 1714 1715 $serviceclassmethodbody = $this->service_class_method_body($function, $params); 1716 1717 if (empty($function->returns_desc)) { 1718 $return = '* @return void'; 1719 } else { 1720 $type = $this->get_phpdoc_type($function->returns_desc); 1721 $outputparams['return']['type'] = $type; 1722 $return = '* @return ' . $type . ' ' . $function->returns_desc->desc; 1723 } 1724 1725 // Now create the virtual method that calls the ext implementation. 1726 $code = <<<EOD 1727 /** 1728 * $function->description. 1729 * 1730 $paramdescstr 1731 $return 1732 */ 1733 public function $function->name($paramanddefaults) { 1734 $serviceclassmethodbody 1735 } 1736 EOD; 1737 1738 // Prepare the method information. 1739 $methodinfo = new stdClass(); 1740 $methodinfo->name = $function->name; 1741 $methodinfo->inputparams = $inputparams; 1742 $methodinfo->outputparams = $outputparams; 1743 $methodinfo->description = $function->description; 1744 // Add the method information into the list of service methods. 1745 $this->servicemethods[] = $methodinfo; 1746 1747 return $code; 1748 } 1749 1750 /** 1751 * Get the phpdoc type for an external_description object. 1752 * external_value => int, double or string 1753 * external_single_structure => object|struct, on-fly generated stdClass name. 1754 * external_multiple_structure => array 1755 * 1756 * @param mixed $keydesc The type description. 1757 * @return string The PHP doc type of the external_description object. 1758 */ 1759 protected function get_phpdoc_type($keydesc) { 1760 $type = null; 1761 if ($keydesc instanceof external_value) { 1762 switch ($keydesc->type) { 1763 case PARAM_BOOL: // 0 or 1 only for now. 1764 case PARAM_INT: 1765 $type = 'int'; 1766 break; 1767 case PARAM_FLOAT; 1768 $type = 'double'; 1769 break; 1770 default: 1771 $type = 'string'; 1772 } 1773 } else if ($keydesc instanceof external_single_structure) { 1774 $type = $this->generate_simple_struct_class($keydesc); 1775 } else if ($keydesc instanceof external_multiple_structure) { 1776 $type = 'array'; 1777 } 1778 1779 return $type; 1780 } 1781 1782 /** 1783 * Generates the method body of the virtual external function. 1784 * 1785 * @param stdClass $function a record from external_function. 1786 * @param array $params web service function parameters. 1787 * @return string body of the method for $function ie. everything within the {} of the method declaration. 1788 */ 1789 protected function service_class_method_body($function, $params) { 1790 // Cast the param from object to array (validate_parameters except array only). 1791 $castingcode = ''; 1792 $paramsstr = ''; 1793 if (!empty($params)) { 1794 foreach ($params as $paramtocast) { 1795 // Clean the parameter from any white space. 1796 $paramtocast = trim($paramtocast); 1797 $castingcode .= " $paramtocast = json_decode(json_encode($paramtocast), true);\n"; 1798 } 1799 $paramsstr = implode(', ', $params); 1800 } 1801 1802 $descriptionmethod = $function->methodname . '_returns()'; 1803 $callforreturnvaluedesc = $function->classname . '::' . $descriptionmethod; 1804 1805 $methodbody = <<<EOD 1806 $castingcode 1807 if ($callforreturnvaluedesc == null) { 1808 $function->classname::$function->methodname($paramsstr); 1809 return null; 1810 } 1811 return \\core_external\\external_api::clean_returnvalue($callforreturnvaluedesc, $function->classname::$function->methodname($paramsstr)); 1812 EOD; 1813 return $methodbody; 1814 } 1815 } 1816 1817 /** 1818 * Early WS exception handler. 1819 * It handles exceptions during setup and returns the Exception text in the WS format. 1820 * If a raise function is found nothing is returned. Throws Exception otherwise. 1821 * 1822 * @param Exception $ex Raised exception. 1823 * @throws Exception 1824 */ 1825 function early_ws_exception_handler(Exception $ex): void { 1826 if (function_exists('raise_early_ws_exception')) { 1827 raise_early_ws_exception($ex); 1828 die; 1829 } 1830 1831 throw $ex; 1832 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
