MDL-54799 webservice: Handle exception in WS format ASAP

moodle · Nov 29, 2019 · 4ed6010 · 4ed6010
1 parent 800563e
commit 4ed6010
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 5 deletions.
diff --git a/lib/setup.php b/lib/setup.php
@@ -566,6 +566,11 @@
     set_error_handler('behat_error_handler', E_ALL | E_STRICT);
 }
 
+if (defined('WS_SERVER') && WS_SERVER) {
+    require_once($CFG->dirroot . '/webservice/lib.php');
+    set_exception_handler('early_ws_exception_handler');
+}
+
 // If there are any errors in the standard libraries we want to know!
 error_reporting(E_ALL | E_STRICT);
 

diff --git a/webservice/lib.php b/webservice/lib.php
@@ -1753,3 +1753,20 @@ protected function service_class_method_body($function, $params) {
         return $methodbody;
     }
 }
+
+/**
+ * Early WS exception handler.
+ * It handles exceptions during setup and returns the Exception text in the WS format.
+ * If a raise function is found nothing is returned. Throws Exception otherwise.
+ *
+ * @param  Exception $ex Raised exception.
+ * @throws Exception
+ */
+function early_ws_exception_handler(Exception $ex): void {
+    if (function_exists('raise_early_ws_exception')) {
+        raise_early_ws_exception($ex);
+        die;
+    }
+
+    throw $ex;
+}
diff --git a/webservice/rest/locallib.php b/webservice/rest/locallib.php
@@ -48,6 +48,19 @@ public function __construct($authmethod) {
         $this->wsname = 'rest';
     }
 
+    /**
+     * Set the request format to.
+     */
+    public function set_rest_format(): void {
+        // Get GET and POST parameters.
+        $methodvariables = array_merge($_GET, $_POST);
+
+        // Retrieve REST format parameter - 'xml' (default) or 'json'.
+        $restformatisset = isset($methodvariables['moodlewsrestformat'])
+                && (($methodvariables['moodlewsrestformat'] == 'xml' || $methodvariables['moodlewsrestformat'] == 'json'));
+        $this->restformat = $restformatisset ? $methodvariables['moodlewsrestformat'] : 'xml';
+    }
+
     /**
      * This method parses the $_POST and $_GET superglobals and looks for
      * the following information:
@@ -64,11 +77,7 @@ protected function parse_request() {
 
         // Get GET and POST parameters.
         $methodvariables = array_merge($_GET, $_POST);
-
-        // Retrieve REST format parameter - 'xml' (default) or 'json'.
-        $restformatisset = isset($methodvariables['moodlewsrestformat'])
-                && (($methodvariables['moodlewsrestformat'] == 'xml' || $methodvariables['moodlewsrestformat'] == 'json'));
-        $this->restformat = $restformatisset ? $methodvariables['moodlewsrestformat'] : 'xml';
+        $this->set_rest_format();
         unset($methodvariables['moodlewsrestformat']);
 
         if ($this->authmethod == WEBSERVICE_AUTHMETHOD_USERNAME) {

diff --git a/webservice/rest/server.php b/webservice/rest/server.php
@@ -44,3 +44,15 @@
 $server->run();
 die;
 
+/**
+ * Raises Early WS Exception in REST format.
+ *
+ * @param  Exception $ex Raised exception.
+ */
+function raise_early_ws_exception(Exception $ex): void {
+    global $CFG;
+    require_once("$CFG->dirroot/webservice/rest/locallib.php");
+    $server = new webservice_rest_server(WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN);
+    $server->set_rest_format();
+    $server->exception_handler($ex);
+}
diff --git a/webservice/soap/server.php b/webservice/soap/server.php
@@ -43,3 +43,14 @@
 $server->run();
 die;
 
+/**
+ * Raises Early WS Exception in SOAP format.
+ *
+ * @param  Exception $ex Raised exception.
+ */
+function raise_early_ws_exception(Exception $ex): void {
+    global $CFG;
+    require_once("$CFG->dirroot/webservice/soap/locallib.php");
+    $server = new webservice_soap_server(WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN);
+    $server->exception_handler($ex);
+}
diff --git a/webservice/xmlrpc/server.php b/webservice/xmlrpc/server.php
@@ -43,3 +43,15 @@
 $server->run();
 die;
 
+/**
+ * Raises Early WS Exception in XMLRPC format.
+ *
+ * @param  Exception $ex Raised exception.
+ */
+function raise_early_ws_exception(Exception $ex): void {
+    global $CFG;
+    require_once("$CFG->dirroot/webservice/xmlrpc/locallib.php");
+    $server = new webservice_xmlrpc_server(WEBSERVICE_AUTHMETHOD_PERMANENT_TOKEN);
+    $server->exception_handler($ex);
+}
+