AzureCommand::getAzureGroups() - Code Metrics - Inspection of "Plugin: Azure: Add option to filter groups by disp..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.11.x (#6003)

by Angel Fernando Quiroz

created 2024-12-28 18:55 UTC

AzureCommand::getAzureGroups() C

↳ Parent: AzureCommand

Complexity

Conditions	12
Paths	39

Size

Total Lines	67
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	41
c	1
b	0
f	0
dl	0
loc	67
rs	6.9666
cc	12
nc	39
nop	0

How to fix Long Method Complexity

<?php

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

use Chamilo\PluginBundle\Entity\AzureActiveDirectory\AzureSyncState;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessTokenInterface;
use TheNetworg\OAuth2\Client\Provider\Azure;

abstract class AzureCommand
{
    /**
     * @var AzureActiveDirectory
     */
    protected $plugin;
    /**
     * @var Azure
     */
    protected $provider;

    public function __construct()
    {
        $this->plugin = AzureActiveDirectory::create();
        $this->plugin->get_settings(true);
        $this->provider = $this->plugin->getProviderForApiGraph();
    }

    /**
     * @throws IdentityProviderException
     */
    protected function generateOrRefreshToken(?AccessTokenInterface &$token)
    {
        if (!$token || ($token->getExpires() && !$token->getRefreshToken())) {
            $token = $this->provider->getAccessToken(
                'client_credentials',
                ['resource' => $this->provider->resource]
            );
        }
    }

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

        $getUsersDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERS_DELTA);

        if ($getUsersDelta) {
            $usersDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERS_DATALINK);

            $query = $usersDeltaLink
                ? $usersDeltaLink->getValue()
                : sprintf('$select=%s', implode(',', $userFields));
        } else {
            $query = sprintf(
                '$top=%d&$select=%s',
                AzureActiveDirectory::API_PAGE_SIZE,
                implode(',', $userFields)
            );
        }

        $token = null;

        do {
            $this->generateOrRefreshToken($token);

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

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

            foreach ($azureUsersInfo as $azureUserInfo) {
                $azureUserInfo['mail'] = $azureUserInfo['mail'] ?? null;
                $azureUserInfo['surname'] = $azureUserInfo['surname'] ?? null;
                $azureUserInfo['givenName'] = $azureUserInfo['givenName'] ?? null;

                yield $azureUserInfo;
            }

            $hasNextLink = false;

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

            if ($getUsersDelta && !empty($azureUsersRequest['@odata.deltaLink'])) {
                $this->plugin->saveSyncState(
                    AzureSyncState::USERS_DATALINK,
                    parse_url($azureUsersRequest['@odata.deltaLink'], PHP_URL_QUERY),
                );
            }
        } while ($hasNextLink);
    }

    /**
     * @throws Exception
     *
     * @return Generator<int, array<string, string>>
     */
    protected function getAzureGroups(): Generator
    {
        $groupFilter = $this->plugin->get(AzureActiveDirectory::SETTING_GROUP_FILTER);

        $groupFields = [
            'id',
            'displayName',
            'description',
        ];

        $getUsergroupsDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERGROUPS_DELTA);

        if ($getUsergroupsDelta) {
            $usergroupsDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERGROUPS_DATALINK);

            $query = $usergroupsDeltaLink
                ? $usergroupsDeltaLink->getValue()
                : sprintf('$select=%s', implode(',', $groupFields));
        } else {
            $query = sprintf(
                '$top=%d&$select=%s',
                AzureActiveDirectory::API_PAGE_SIZE,
                implode(',', $groupFields)
            );
        }

        $token = null;

        do {
            $this->generateOrRefreshToken($token);

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

            $azureGroupsInfo = $azureGroupsRequest['value'] ?? [];

            foreach ($azureGroupsInfo as $azureGroupInfo) {
                if (!empty($groupFilter) &&
                    !preg_match("/$groupFilter/", $azureGroupInfo['displayName'])
                ) {
                    continue;
                }

                yield $azureGroupInfo;
            }

            $hasNextLink = false;

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

            if ($getUsergroupsDelta && !empty($azureGroupsRequest['@odata.deltaLink'])) {
                $this->plugin->saveSyncState(
                    AzureSyncState::USERGROUPS_DATALINK,
                    parse_url($azureGroupsRequest['@odata.deltaLink'], PHP_URL_QUERY),
                );
            }
        } while ($hasNextLink);
    }

    /**
     * @throws Exception
     *
     * @return Generator<int, array<string, string>>
     */
    protected function getAzureGroupMembers(string $groupUid): Generator
    {
        $userFields = [
            'mail',
            'mailNickname',
            'id',
        ];

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

        $token = null;

        do {
            $this->generateOrRefreshToken($token);

            try {
                $azureGroupMembersRequest = $this->provider->request(
                    'get',
                    "groups/$groupUid/members?$query",
                    $token
                );
            } catch (Exception $e) {
                throw new Exception('Exception when requesting group members from Azure: '.$e->getMessage());
            }

            $azureGroupMembers = $azureGroupMembersRequest['value'] ?? [];

            foreach ($azureGroupMembers as $azureGroupMember) {
                yield $azureGroupMember;
            }

            $hasNextLink = false;

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


1			<?php
2
3			/* For license terms, see /license.txt */
4
5			use Chamilo\PluginBundle\Entity\AzureActiveDirectory\AzureSyncState;
6			use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
7			use League\OAuth2\Client\Token\AccessTokenInterface;
8			use TheNetworg\OAuth2\Client\Provider\Azure;
9
10			abstract class AzureCommand
11			{
12			/**
13			* @var AzureActiveDirectory
14			*/
15			protected $plugin;
16			/**
17			* @var Azure
18			*/
19			protected $provider;
20
21			public function __construct()
22			{
23			$this->plugin = AzureActiveDirectory::create();
24			$this->plugin->get_settings(true);
25			$this->provider = $this->plugin->getProviderForApiGraph();
26			}
27
28			/**
29			* @throws IdentityProviderException
30			*/
31			protected function generateOrRefreshToken(?AccessTokenInterface &$token)
32			{
33			if (!$token \|\| ($token->getExpires() && !$token->getRefreshToken())) {
34			$token = $this->provider->getAccessToken(
35			'client_credentials',
36			['resource' => $this->provider->resource]
37			);
38			}
39			}
40
41			/**
42			* @throws Exception
43			*
44			* @return Generator<int, array<string, string>>
45			*/
46			protected function getAzureUsers(): Generator
47			{
48			$userFields = [
49			'givenName',
50			'surname',
51			'mail',
52			'userPrincipalName',
53			'businessPhones',
54			'mobilePhone',
55			'accountEnabled',
56			'mailNickname',
57			'id',
58			];
59
60			$getUsersDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERS_DELTA);
61
62			if ($getUsersDelta) {
63			$usersDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERS_DATALINK);
64
65			$query = $usersDeltaLink
66			? $usersDeltaLink->getValue()
67			: sprintf('$select=%s', implode(',', $userFields));
68			} else {
69			$query = sprintf(
70			'$top=%d&$select=%s',
71			AzureActiveDirectory::API_PAGE_SIZE,
72			implode(',', $userFields)
73			);
74			}
75
76			$token = null;
77
78			do {
79			$this->generateOrRefreshToken($token);
80
81			try {
82			$azureUsersRequest = $this->provider->request(
83			'get',
84			$getUsersDelta ? "users/delta?$query" : "users?$query",
85			$token
86			);
87			} catch (Exception $e) {
88			throw new Exception('Exception when requesting users from Azure: '.$e->getMessage());
89			}
90
91			$azureUsersInfo = $azureUsersRequest['value'] ?? [];
92
93			foreach ($azureUsersInfo as $azureUserInfo) {
94			$azureUserInfo['mail'] = $azureUserInfo['mail'] ?? null;
95			$azureUserInfo['surname'] = $azureUserInfo['surname'] ?? null;
96			$azureUserInfo['givenName'] = $azureUserInfo['givenName'] ?? null;
97
98			yield $azureUserInfo;
99			}
100
101			$hasNextLink = false;
102
103			if (!empty($azureUsersRequest['@odata.nextLink'])) {
104			$hasNextLink = true;
105			$query = parse_url($azureUsersRequest['@odata.nextLink'], PHP_URL_QUERY);
106			}
107
108			if ($getUsersDelta && !empty($azureUsersRequest['@odata.deltaLink'])) {
109			$this->plugin->saveSyncState(
110			AzureSyncState::USERS_DATALINK,
111			parse_url($azureUsersRequest['@odata.deltaLink'], PHP_URL_QUERY),
112			);
113			}
114			} while ($hasNextLink);
115			}
116
117			/**
118			* @throws Exception
119			*
120			* @return Generator<int, array<string, string>>
121			*/
122			protected function getAzureGroups(): Generator
123			{
124			$groupFilter = $this->plugin->get(AzureActiveDirectory::SETTING_GROUP_FILTER);
125
126			$groupFields = [
127			'id',
128			'displayName',
129			'description',
130			];
131
132			$getUsergroupsDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERGROUPS_DELTA);
133
134			if ($getUsergroupsDelta) {
135			$usergroupsDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERGROUPS_DATALINK);
136
137			$query = $usergroupsDeltaLink
138			? $usergroupsDeltaLink->getValue()
139			: sprintf('$select=%s', implode(',', $groupFields));
140			} else {
141			$query = sprintf(
142			'$top=%d&$select=%s',
143			AzureActiveDirectory::API_PAGE_SIZE,
144			implode(',', $groupFields)
145			);
146			}
147
148			$token = null;
149
150			do {
151			$this->generateOrRefreshToken($token);
152
153			try {
154			$azureGroupsRequest = $this->provider->request(
155			'get',
156			$getUsergroupsDelta ? "groups/delta?$query" : "groups?$query",
157			$token
158			);
159			} catch (Exception $e) {
160			throw new Exception('Exception when requesting groups from Azure: '.$e->getMessage());
161			}
162
163			$azureGroupsInfo = $azureGroupsRequest['value'] ?? [];
164
165			foreach ($azureGroupsInfo as $azureGroupInfo) {
166			if (!empty($groupFilter) &&
167			!preg_match("/$groupFilter/", $azureGroupInfo['displayName'])
168			) {
169			continue;
170			}
171
172			yield $azureGroupInfo;
173			}
174
175			$hasNextLink = false;
176
177			if (!empty($azureGroupsRequest['@odata.nextLink'])) {
178			$hasNextLink = true;
179			$query = parse_url($azureGroupsRequest['@odata.nextLink'], PHP_URL_QUERY);
180			}
181
182			if ($getUsergroupsDelta && !empty($azureGroupsRequest['@odata.deltaLink'])) {
183			$this->plugin->saveSyncState(
184			AzureSyncState::USERGROUPS_DATALINK,
185			parse_url($azureGroupsRequest['@odata.deltaLink'], PHP_URL_QUERY),
186			);
187			}
188			} while ($hasNextLink);
189			}
190
191			/**
192			* @throws Exception
193			*
194			* @return Generator<int, array<string, string>>
195			*/
196			protected function getAzureGroupMembers(string $groupUid): Generator
197			{
198			$userFields = [
199			'mail',
200			'mailNickname',
201			'id',
202			];
203
204			$query = sprintf(
205			'$top=%d&$select=%s',
206			AzureActiveDirectory::API_PAGE_SIZE,
207			implode(',', $userFields)
208			);
209
210			$token = null;
211
212			do {
213			$this->generateOrRefreshToken($token);
214
215			try {
216			$azureGroupMembersRequest = $this->provider->request(
217			'get',
218			"groups/$groupUid/members?$query",
219			$token
220			);
221			} catch (Exception $e) {
222			throw new Exception('Exception when requesting group members from Azure: '.$e->getMessage());
223			}
224
225			$azureGroupMembers = $azureGroupMembersRequest['value'] ?? [];
226
227			foreach ($azureGroupMembers as $azureGroupMember) {
228			yield $azureGroupMember;
229			}
230
231			$hasNextLink = false;
232
233			if (!empty($azureGroupMembersRequest['@odata.nextLink'])) {
234			$hasNextLink = true;
235			$query = parse_url($azureGroupMembersRequest['@odata.nextLink'], PHP_URL_QUERY);
236			}
237			} while ($hasNextLink);
238			}
239			}
240

chamilo / chamilo-lms

Pull Request — 1.11.x (#6003)

AzureCommand::getAzureGroups() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like