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:33 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
{
    /**
     * @throws Exception
     *
     * @return Generator<int, string>
     */
    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)
            );
        }
    }

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

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