AzureSyncUsersCommand::__invoke() - Code Metrics - Inspection of "Plugin: Azure: Improvements for existing user veri..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.11.x (#5763)

by Angel Fernando Quiroz

created 2024-09-04 23:32 UTC

AzureSyncUsersCommand::__invoke() A

↳ Parent: AzureSyncUsersCommand

Complexity

Conditions	4
Paths	6

Size

Total Lines	54
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	33
c	1
b	0
f	0
dl	0
loc	54
rs	9.392
cc	4
nc	6
nop	0

How to fix Long Method

<?php

/* For license terms, see /license.txt */

use League\OAuth2\Client\Token\AccessTokenInterface;

class AzureSyncUsersCommand extends AzureCommand
{
    /**
     * @return Generator<int, string>
     * @throws Exception
     */
    public function __invoke(): Generator
    {
        yield 'Synchronizing users from Azure.';

        $token = $this->provider->getAccessToken(
            'client_credentials',
            ['resource' => $this->provider->resource]
        );

        $existingUsers = [];

        foreach ($this->getAzureUsers($token) as $azureUserInfo) {
            try {
                $userId = $this->plugin->registerUser(
                    $token,
                    $this->provider,
                    $azureUserInfo,
                    'users/' . $azureUserInfo['id'] . '/memberOf',
                    'id',
                    'id'
                );
            } catch (Exception $e) {
                yield $e->getMessage();

                continue;
            }

            $existingUsers[] = $userId;

            $userInfo = api_get_user_info($userId);

            yield sprintf('User info: %s', serialize($userInfo));
        }

        if ('true' === $this->plugin->get(AzureActiveDirectory::SETTING_DEACTIVATE_NONEXISTING_USERS)) {
            yield '----------------';

            yield 'Trying deactivate non-existing users in Azure';

            $users = UserManager::getRepository()->findByAuthSource('azure');
            $userIdList = array_map(
                function ($user) {
                    return $user->getId();
                },
                $users
            );

            $nonExistingUsers = array_diff($userIdList, $existingUsers);

            UserManager::deactivate_users($nonExistingUsers);

            yield sprintf(
                'Deactivated users IDs: %s',
                implode(', ', $nonExistingUsers)
            );
        }
    }

    /**
     * @return Generator<int, array<string, string>>
     * @throws Exception
     */
    private function getAzureUsers(AccessTokenInterface $token): Generator
    {
        $userFields = [
            'givenName',
            'surname',
            'mail',
            'userPrincipalName',
            'businessPhones',
            'mobilePhone',
            'accountEnabled',
            'mailNickname',
            'id'
        ];

        $query = sprintf(
            '$top=%d&$select=%s',
            AzureActiveDirectory::API_PAGE_SIZE,
            implode(',', $userFields)
        );

        do {
            try {
                $azureUsersRequest = $this->provider->request('get', "users?$query", $token);
            } catch (Exception $e) {
                throw new Exception('Exception when requesting users from Azure: '.$e->getMessage());
            }

            $azureUsersInfo = $azureUsersRequest['value'] ?? [];

            foreach ($azureUsersInfo as $azureUserInfo) {
                yield $azureUserInfo;
            }

            $hasNextLink = false;

            if (!empty($azureUsersRequest['@odata.nextLink'])) {
                $hasNextLink = true;
                $query = parse_url($azureUsersRequest['@odata.nextLink'], PHP_URL_QUERY);
            }
        } while ($hasNextLink);
    }
}


1			<?php
2
3			/* For license terms, see /license.txt */
4
5			use League\OAuth2\Client\Token\AccessTokenInterface;
6
7			class AzureSyncUsersCommand extends AzureCommand
8			{
9			/**
10			* @return Generator<int, string>
11			* @throws Exception
12			*/
13			public function __invoke(): Generator
14			{
15			yield 'Synchronizing users from Azure.';
16
17			$token = $this->provider->getAccessToken(
18			'client_credentials',
19			['resource' => $this->provider->resource]
20			);
21
22			$existingUsers = [];
23
24			foreach ($this->getAzureUsers($token) as $azureUserInfo) {
25			try {
26			$userId = $this->plugin->registerUser(
27			$token,
28			$this->provider,
29			$azureUserInfo,
30			'users/' . $azureUserInfo['id'] . '/memberOf',
31			'id',
32			'id'
33			);
34			} catch (Exception $e) {
35			yield $e->getMessage();
36
37			continue;
38			}
39
40			$existingUsers[] = $userId;
41
42			$userInfo = api_get_user_info($userId);
43
44			yield sprintf('User info: %s', serialize($userInfo));
45			}
46
47			if ('true' === $this->plugin->get(AzureActiveDirectory::SETTING_DEACTIVATE_NONEXISTING_USERS)) {
48			yield '----------------';
49
50			yield 'Trying deactivate non-existing users in Azure';
51
52			$users = UserManager::getRepository()->findByAuthSource('azure');
53			$userIdList = array_map(
54			function ($user) {
55			return $user->getId();
56			},
57			$users
58			);
59
60			$nonExistingUsers = array_diff($userIdList, $existingUsers);
61
62			UserManager::deactivate_users($nonExistingUsers);
63
64			yield sprintf(
65			'Deactivated users IDs: %s',
66			implode(', ', $nonExistingUsers)
67			);
68			}
69			}
70
71			/**
72			* @return Generator<int, array<string, string>>
73			* @throws Exception
74			*/
75			private function getAzureUsers(AccessTokenInterface $token): Generator
76			{
77			$userFields = [
78			'givenName',
79			'surname',
80			'mail',
81			'userPrincipalName',
82			'businessPhones',
83			'mobilePhone',
84			'accountEnabled',
85			'mailNickname',
86			'id'
87			];
88
89			$query = sprintf(
90			'$top=%d&$select=%s',
91			AzureActiveDirectory::API_PAGE_SIZE,
92			implode(',', $userFields)
93			);
94
95			do {
96			try {
97			$azureUsersRequest = $this->provider->request('get', "users?$query", $token);
98			} catch (Exception $e) {
99			throw new Exception('Exception when requesting users from Azure: '.$e->getMessage());
100			}
101
102			$azureUsersInfo = $azureUsersRequest['value'] ?? [];
103
104			foreach ($azureUsersInfo as $azureUserInfo) {
105			yield $azureUserInfo;
106			}
107
108			$hasNextLink = false;
109
110			if (!empty($azureUsersRequest['@odata.nextLink'])) {
111			$hasNextLink = true;
112			$query = parse_url($azureUsersRequest['@odata.nextLink'], PHP_URL_QUERY);
113			}
114			} while ($hasNextLink);
115			}
116			}
117

chamilo / chamilo-lms

Pull Request — 1.11.x (#5763)

AzureSyncUsersCommand::__invoke() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like