Merge branch 'MDL-67804-master' of https://github.com/jleyva/moodle

laurentdavid · Dec 1, 2021 · 7fa38ba · 7fa38ba
2 parents 284c27c + a5c48fe
commit 7fa38ba
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/webservice/lib.php b/webservice/lib.php
@@ -187,7 +187,7 @@ public function authenticate_user($token) {
             $event->add_record_snapshot('external_tokens', $token);
             $event->set_legacy_logdata(array(SITEID, 'webservice', 'user suspended', '', $user->username));
             $event->trigger();
-            throw new webservice_access_exception('Refused web service access for suspended username: ' . $user->username);
+            throw new moodle_exception('wsaccessusersuspended', 'moodle', '', $user->username);
         }
 
         //check if the auth method is nologin (in this case refuse connection)
@@ -198,7 +198,7 @@ public function authenticate_user($token) {
             $event->add_record_snapshot('external_tokens', $token);
             $event->set_legacy_logdata(array(SITEID, 'webservice', 'nologin auth attempt with web service', '', $user->username));
             $event->trigger();
-            throw new webservice_access_exception('Refused web service access for nologin authentication username: ' . $user->username);
+            throw new moodle_exception('wsaccessusernologin', 'moodle', '', $user->username);
         }
 
         //Check if the user password is expired
@@ -1071,7 +1071,7 @@ protected function authenticate_user() {
             $event->set_legacy_logdata(array(SITEID, '', '', '', get_string('wsaccessuserdeleted', 'webservice',
                 $user->username) . " - ".getremoteaddr(), 0, $user->id));
             $event->trigger();
-            throw new webservice_access_exception('Refused web service access for deleted username: ' . $user->username);
+            throw new moodle_exception('wsaccessuserdeleted', 'webservice', '', $user->username);
         }
 
         //only confirmed user should be able to call web service
@@ -1095,7 +1095,7 @@ protected function authenticate_user() {
             $event->set_legacy_logdata(array(SITEID, '', '', '', get_string('wsaccessusersuspended', 'webservice',
                 $user->username) . " - ".getremoteaddr(), 0, $user->id));
             $event->trigger();
-            throw new webservice_access_exception('Refused web service access for suspended username: ' . $user->username);
+            throw new moodle_exception('wsaccessusersuspended', 'webservice', '', $user->username);
         }
 
         //retrieve the authentication plugin if no previously done
@@ -1114,7 +1114,7 @@ protected function authenticate_user() {
                 $event->set_legacy_logdata(array(SITEID, '', '', '', get_string('wsaccessuserexpired', 'webservice',
                     $user->username) . " - ".getremoteaddr(), 0, $user->id));
                 $event->trigger();
-                throw new webservice_access_exception('Refused web service access for password expired username: ' . $user->username);
+                throw new moodle_exception('wsaccessuserexpired', 'webservice', '', $user->username);
             }
         }
 
@@ -1127,7 +1127,7 @@ protected function authenticate_user() {
             $event->set_legacy_logdata(array(SITEID, '', '', '', get_string('wsaccessusernologin', 'webservice',
                 $user->username) . " - ".getremoteaddr(), 0, $user->id));
             $event->trigger();
-            throw new webservice_access_exception('Refused web service access for nologin authentication username: ' . $user->username);
+            throw new moodle_exception('wsaccessusernologin', 'webservice', '', $user->username);
         }
 
         // now fake user login, the session is completely empty too

diff --git a/webservice/upgrade.txt b/webservice/upgrade.txt
@@ -3,6 +3,11 @@ information provided here is intended especially for developers.
 
 This information is intended for authors of webservices, not people writing webservice clients.
 
+=== 4.0 ===
+
+* User access related exceptions have been changed to use the moodle_exception class instead of the generic webservice_access_exception,
+  the main reason for this change is to allow clients to implement some code logic against an access error.
+
 === 3.11 ===
 
 * The method webservice::get_user_capabilities() is deprecated now without a replacement. It has been used