Plugin: Azure: Refactor conditions to register/update user - refs BT#21930

plugin/azure_active_directory/src/AzureActiveDirectory.php

@@ -227,7 +227,10 @@ class AzureActiveDirectory extends Plugin
 
         if (empty($userId)) {
             // If we didn't find the user
-            if ($this->get(self::SETTING_PROVISION_USERS) === 'true') {
+            if ($this->get(self::SETTING_PROVISION_USERS) !== 'true') {
+                throw new Exception('User not found when checking the extra fields from ' . $azureUserInfo['mail'] . ' or ' . $azureUserInfo['mailNickname'] . ' or ' . $azureUserInfo[$azureUidKey] . '.');
+            }
+
             [
                 $firstNme,
                 $lastName,
@@ -262,13 +265,14 @@ class AzureActiveDirectory extends Plugin
                 null,
                 $isAdmin
             );
+
             if (!$userId) {
-                    throw new Exception(get_lang('UserNotAdded').' '.$azureUserInfo['userPrincipalName']);
+                throw new Exception(get_lang('UserNotAdded') . ' ' . $azureUserInfo['userPrincipalName']);
             }
-            } else {
-                throw new Exception('User not found when checking the extra fields from '.$azureUserInfo['mail'].' or '.$azureUserInfo['mailNickname'].' or '.$azureUserInfo[$azureUidKey].'.');
+
+            return $userId;
         }
-        } else {
+
         if ($this->get(self::SETTING_UPDATE_USERS) === 'true') {
             [
                 $firstNme,
@@ -306,25 +310,33 @@ class AzureActiveDirectory extends Plugin
                 throw new Exception(get_lang('CouldNotUpdateUser').' '.$azureUserInfo['userPrincipalName']);
             }
         }
-        }
 
         return $userId;
     }
 
+    /**
+     * @throws Exception
+     */
     private function formatUserData(
         AccessTokenInterface $token,
         Azure $provider,
         array $azureUserInfo,
         string $apiGroupsRef,
-        string $objectIdKey,
+        string $groupObjectIdKey,
         string $azureUidKey
     ): array {
+        try {
             [$userRole, $isAdmin] = $this->getUserRoleAndCheckIsAdmin(
                 $token,
                 $provider,
                 $apiGroupsRef,
-            $objectIdKey
+                $groupObjectIdKey
+            );
+        } catch (Exception $e) {
+            throw new Exception(
+                'Exception when formatting user '.$azureUserInfo[$azureUidKey].' data: '.$e->getMessage()
             );
+        }
 
         $phone = null;
 
@@ -363,15 +375,20 @@ class AzureActiveDirectory extends Plugin
         ];
     }
 
+    /**
+     * @throws Exception
+     */
     private function getUserRoleAndCheckIsAdmin(
         AccessTokenInterface $token,
-        Azure $provider = null,
+        Azure $provider,
         string $apiRef = 'me/memberOf',
-        string $objectIdKey = 'objectId'
+        string $groupObjectIdKey = 'objectId'
     ): array {
-        $provider = $provider ?: $this->getProvider();
-
+        try {
             $groups = $provider->get($apiRef, $token);
+        } catch (Exception $e) {
+            throw new Exception('Exception when requesting user groups from Azure: '.$e->getMessage());
+        }
 
         // If any specific group ID has been defined for a specific role, use that
         // ID to give the user the right role
@@ -381,12 +398,12 @@ class AzureActiveDirectory extends Plugin
         $userRole = STUDENT;
         $isAdmin = false;
         foreach ($groups as $group) {
-            if ($givenAdminGroup == $group[$objectIdKey]) {
+            if ($givenAdminGroup == $group[$groupObjectIdKey]) {
                 $userRole = COURSEMANAGER;
                 $isAdmin = true;
-            } elseif ($givenSessionAdminGroup == $group[$objectIdKey]) {
+            } elseif ($givenSessionAdminGroup == $group[$groupObjectIdKey]) {
                 $userRole = SESSIONADMIN;
-            } elseif ($userRole != SESSIONADMIN && $givenTeacherGroup == $group[$objectIdKey]) {
+            } elseif ($userRole != SESSIONADMIN && $givenTeacherGroup == $group[$groupObjectIdKey]) {
                 $userRole = COURSEMANAGER;
             }
         }