LDAPMemberExtension::updateCMSFields() - Code Metrics - Inspection of "Merge pull request #84 from robbieaverill/master" - silverstripe/silverstripe-activedirectory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 197387...875417 )

by Damian

created 2017-01-26 21:27 UTC

LDAPMemberExtension::updateCMSFields() B

↳ Parent: LDAPMemberExtension

Complexity

Conditions	8
Paths	6

Size

Total Lines	56
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	7.3333
c	0
b	0
f	0
cc	8
eloc	36
nc	6
nop	1

How to fix Long Method

<?php

namespace SilverStripe\ActiveDirectory\Extensions;

use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\ORM\ValidationException;

/**
 * Class LDAPMemberExtension.
 *
 * Adds mappings from AD attributes to SilverStripe {@link Member} fields.
 *
 * @package activedirectory
 */
class LDAPMemberExtension extends DataExtension
{
    /**
     * @var array
     */
    private static $db = [

        // Unique user identifier, same field is used by SAMLMemberExtension
        'GUID' => 'Varchar(50)',
        'Username' => 'Varchar(64)',
        'IsExpired' => 'Boolean',
        'LastSynced' => 'DBDatetime',
    ];

    /**
     * These fields are used by {@link LDAPMemberSync} to map specific AD attributes
     * to {@link Member} fields.
     *
     * @var array
     * @config
     */
    private static $ldap_field_mappings = [

        'givenname' => 'FirstName',
        'samaccountname' => 'Username',
        'sn' => 'Surname',
        'mail' => 'Email',
    ];

    /**
     * The location (relative to /assets) where to save thumbnailphoto data.
     *
     * @var string
     * @config
     */
    private static $ldap_thumbnail_path = 'Uploads';


    /**
     * When enabled, LDAP managed Member records (GUID flag)
     * have their data written back to LDAP on write.
     *
     * This requires setting write permissions on the user configured in the LDAP
     * credentials, which is why this is disabled by default.
     *
     * @var bool
     * @config
     */
    private static $update_ldap_from_local = false;


    /**
     * If enabled, Member records with a Username field have the user created in LDAP
     * on write.
     *
     * This requires setting write permissions on the user configured in the LDAP
     * credentials, which is why this is disabled by default.
     *
     * @var bool
     * @config
     */
    private static $create_users_in_ldap = false;


    /**
     * If enabled, deleting Member records mapped to LDAP deletes the LDAP user.
     *
     * This requires setting write permissions on the user configured in the LDAP
     * credentials, which is why this is disabled by default.
     *
     * @var bool
     * @config
     */
    private static $delete_users_in_ldap = false;


    /**
     * @param FieldList $fields
     */
    public function updateCMSFields(FieldList $fields)
    {
        // Redo LDAP metadata fields as read-only and move to LDAP tab.
        $ldapMetadata = [];
        $fields->replaceField('GUID', $ldapMetadata[] = ReadonlyField::create('GUID'));
        $fields->replaceField(
            'IsExpired',
            $ldapMetadata[] = ReadonlyField::create(
                'IsExpired',
                _t('LDAPMemberExtension.ISEXPIRED', 'Has user\'s LDAP/AD login expired?')
            )
        );
        $fields->replaceField(
            'LastSynced',
            $ldapMetadata[] = ReadonlyField::create(
                'LastSynced',
                _t('LDAPMemberExtension.LASTSYNCED', 'Last synced')
            )
        );
        $fields->addFieldsToTab('Root.LDAP', $ldapMetadata);

        $message = '';
        if ($this->owner->GUID && $this->owner->config()->update_ldap_from_local) {
            $message = _t(
                'LDAPMemberExtension.CHANGEFIELDSUPDATELDAP',
                'Changing fields here will update them in LDAP.'
            );
        } elseif ($this->owner->GUID && !$this->owner->config()->update_ldap_from_local) {
            // Transform the automatically mapped fields into read-only. This doesn't
            // apply if updating LDAP from local is enabled, as changing data locally can be written back.
            foreach ($this->owner->config()->ldap_field_mappings as $name) {
                $field = $fields->dataFieldByName($name);
                if (!empty($field)) {
                    // Set to readonly, but not disabled so that the data is still sent to the
                    // server and doesn't break Member_Validator
                    $field->setReadonly(true);
                    $field->setTitle($field->Title()._t('LDAPMemberExtension.IMPORTEDFIELD', ' (imported)'));
                }
            }
            $message = _t(
                'LDAPMemberExtension.INFOIMPORTED',
                'This user is automatically imported from LDAP. '.
                    'Manual changes to imported fields will be removed upon sync.'
            );
        }
        if ($message) {
            $fields->addFieldToTab(
                'Root.Main',
                LiteralField::create(
                    'Info',
                    sprintf('<p class="message warning">%s</p>', $message)
                ),
                'FirstName'
            );
        }
    }

    /**
     * @param  ValidationResult
     * @throws ValidationException
     */
    public function validate(ValidationResult $validationResult)
    {
        // We allow empty Username for registration purposes, as we need to
        // create Member records with empty Username temporarily. Forms should explicitly
        // check for Username not being empty if they require it not to be.
        if (empty($this->owner->Username) || !$this->owner->config()->create_users_in_ldap) {
            return;
        }

        if (!preg_match('/^[a-z0-9\.]+$/', $this->owner->Username)) {
            $validationResult->addError(
                'Username must only contain lowercase alphanumeric characters and dots.',
                'bad'
            );
            throw new ValidationException($validationResult);
        }
    }

    /**
     * Create the user in LDAP, provided this configuration is enabled
     * and a username was passed to a new Member record.
     */
    public function onBeforeWrite()
    {
        $service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
        if (!$service->enabled()
            || !$this->owner->config()->create_users_in_ldap
            || !$this->owner->Username
            || $this->owner->GUID
        ) {
            return;
        }

        $service->createLDAPUser($this->owner);
    }

    /**
     * Update the local data with LDAP, and ensure local membership is also set in
     * LDAP too. This writes into LDAP, provided that feature is enabled.
     */
    public function onAfterWrite()

    {
        $service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
        if (!$service->enabled()
            || !$this->owner->config()->update_ldap_from_local
            || !$this->owner->GUID
        ) {
            return;
        }

        $service->updateLDAPFromMember($this->owner);
        $service->updateLDAPGroupsForMember($this->owner);
    }

    public function onAfterDelete()

    {
        $service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
        if (!$service->enabled()
            || !$this->owner->config()->delete_users_in_ldap
            || !$this->owner->GUID
        ) {
            return;
        }

        $service->deleteLDAPMember($this->owner);
    }

    /**
     * Triggered by {@link Member::logIn()} when successfully logged in,
     * this will update the Member record from AD data.
     */
    public function memberLoggedIn()
    {
        if ($this->owner->GUID) {
            Injector::inst()
                ->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService')
                ->updateMemberFromLDAP($this->owner);
        }
    }
}


1		<?php
2
3		namespace SilverStripe\ActiveDirectory\Extensions;
4
5		use SilverStripe\Core\Injector\Injector;
6		use SilverStripe\Forms\FieldList;
7		use SilverStripe\Forms\LiteralField;
8		use SilverStripe\Forms\ReadonlyField;
9		use SilverStripe\ORM\DataExtension;
10		use SilverStripe\ORM\ValidationResult;
11		use SilverStripe\ORM\ValidationException;
12
13		/**
14		* Class LDAPMemberExtension.
15		*
16		* Adds mappings from AD attributes to SilverStripe {@link Member} fields.
17		*
18		* @package activedirectory
19		*/
20		class LDAPMemberExtension extends DataExtension
21		{
22		/**
23		* @var array
24		*/
25		private static $db = [
		0 ignored issues – show Unused Code introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
26		// Unique user identifier, same field is used by SAMLMemberExtension
27		'GUID' => 'Varchar(50)',
28		'Username' => 'Varchar(64)',
29		'IsExpired' => 'Boolean',
30		'LastSynced' => 'DBDatetime',
31		];
32
33		/**
34		* These fields are used by {@link LDAPMemberSync} to map specific AD attributes
35		* to {@link Member} fields.
36		*
37		* @var array
38		* @config
39		*/
40		private static $ldap_field_mappings = [
		0 ignored issues – show Unused Code introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report The property `$ldap_field_mappings` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
41		'givenname' => 'FirstName',
42		'samaccountname' => 'Username',
43		'sn' => 'Surname',
44		'mail' => 'Email',
45		];
46
47		/**
48		* The location (relative to /assets) where to save thumbnailphoto data.
49		*
50		* @var string
51		* @config
52		*/
53		private static $ldap_thumbnail_path = 'Uploads';
		0 ignored issues – show Unused Code introduced 2016-03-22 20:04 UTC by Report Bug Copy Issue Report The property `$ldap_thumbnail_path` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
54
55		/**
56		* When enabled, LDAP managed Member records (GUID flag)
57		* have their data written back to LDAP on write.
58		*
59		* This requires setting write permissions on the user configured in the LDAP
60		* credentials, which is why this is disabled by default.
61		*
62		* @var bool
63		* @config
64		*/
65		private static $update_ldap_from_local = false;
		0 ignored issues – show Unused Code introduced 2017-01-16 21:03 UTC by Report Bug Copy Issue Report The property `$update_ldap_from_local` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
66
67		/**
68		* If enabled, Member records with a Username field have the user created in LDAP
69		* on write.
70		*
71		* This requires setting write permissions on the user configured in the LDAP
72		* credentials, which is why this is disabled by default.
73		*
74		* @var bool
75		* @config
76		*/
77		private static $create_users_in_ldap = false;
		0 ignored issues – show Unused Code introduced 2016-06-21 23:46 UTC by Report Bug Copy Issue Report The property `$create_users_in_ldap` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
78
79		/**
80		* If enabled, deleting Member records mapped to LDAP deletes the LDAP user.
81		*
82		* This requires setting write permissions on the user configured in the LDAP
83		* credentials, which is why this is disabled by default.
84		*
85		* @var bool
86		* @config
87		*/
88		private static $delete_users_in_ldap = false;
		0 ignored issues – show Unused Code introduced 2016-06-21 23:46 UTC by Report Bug Copy Issue Report The property `$delete_users_in_ldap` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
89
90		/**
91		* @param FieldList $fields
92		*/
93		public function updateCMSFields(FieldList $fields)
94		{
95		// Redo LDAP metadata fields as read-only and move to LDAP tab.
96		$ldapMetadata = [];
97		$fields->replaceField('GUID', $ldapMetadata[] = ReadonlyField::create('GUID'));
98		$fields->replaceField(
99		'IsExpired',
100		$ldapMetadata[] = ReadonlyField::create(
101		'IsExpired',
102		_t('LDAPMemberExtension.ISEXPIRED', 'Has user\'s LDAP/AD login expired?')
103		)
104		);
105		$fields->replaceField(
106		'LastSynced',
107		$ldapMetadata[] = ReadonlyField::create(
108		'LastSynced',
109		_t('LDAPMemberExtension.LASTSYNCED', 'Last synced')
110		)
111		);
112		$fields->addFieldsToTab('Root.LDAP', $ldapMetadata);
113
114		$message = '';
115		if ($this->owner->GUID && $this->owner->config()->update_ldap_from_local) {
116		$message = _t(
117		'LDAPMemberExtension.CHANGEFIELDSUPDATELDAP',
118		'Changing fields here will update them in LDAP.'
119		);
120		} elseif ($this->owner->GUID && !$this->owner->config()->update_ldap_from_local) {
121		// Transform the automatically mapped fields into read-only. This doesn't
122		// apply if updating LDAP from local is enabled, as changing data locally can be written back.
123		foreach ($this->owner->config()->ldap_field_mappings as $name) {
124		$field = $fields->dataFieldByName($name);
125		if (!empty($field)) {
126		// Set to readonly, but not disabled so that the data is still sent to the
127		// server and doesn't break Member_Validator
128		$field->setReadonly(true);
129		$field->setTitle($field->Title()._t('LDAPMemberExtension.IMPORTEDFIELD', ' (imported)'));
130		}
131		}
132		$message = _t(
133		'LDAPMemberExtension.INFOIMPORTED',
134		'This user is automatically imported from LDAP. '.
135		'Manual changes to imported fields will be removed upon sync.'
136		);
137		}
138		if ($message) {
139		$fields->addFieldToTab(
140		'Root.Main',
141		LiteralField::create(
142		'Info',
143		sprintf('<p class="message warning">%s</p>', $message)
144		),
145		'FirstName'
146		);
147		}
148		}
149
150		/**
151		* @param ValidationResult
152		* @throws ValidationException
153		*/
154		public function validate(ValidationResult $validationResult)
155		{
156		// We allow empty Username for registration purposes, as we need to
157		// create Member records with empty Username temporarily. Forms should explicitly
158		// check for Username not being empty if they require it not to be.
159		if (empty($this->owner->Username) \|\| !$this->owner->config()->create_users_in_ldap) {
160		return;
161		}
162
163		if (!preg_match('/^[a-z0-9\.]+$/', $this->owner->Username)) {
164		$validationResult->addError(
165		'Username must only contain lowercase alphanumeric characters and dots.',
166		'bad'
167		);
168		throw new ValidationException($validationResult);
169		}
170		}
171
172		/**
173		* Create the user in LDAP, provided this configuration is enabled
174		* and a username was passed to a new Member record.
175		*/
176		public function onBeforeWrite()
177		{
178		$service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
179		if (!$service->enabled()
180		\|\| !$this->owner->config()->create_users_in_ldap
181		\|\| !$this->owner->Username
182		\|\| $this->owner->GUID
183		) {
184		return;
185		}
186
187		$service->createLDAPUser($this->owner);
188		}
189
190		/**
191		* Update the local data with LDAP, and ensure local membership is also set in
192		* LDAP too. This writes into LDAP, provided that feature is enabled.
193		*/
194	View Code Duplication	public function onAfterWrite()
		0 ignored issues – show Duplication introduced 2016-06-21 23:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195		{
196		$service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
197		if (!$service->enabled()
198		\|\| !$this->owner->config()->update_ldap_from_local
199		\|\| !$this->owner->GUID
200		) {
201		return;
202		}
203
204		$service->updateLDAPFromMember($this->owner);
205		$service->updateLDAPGroupsForMember($this->owner);
206		}
207
208	View Code Duplication	public function onAfterDelete()
		0 ignored issues – show Duplication introduced 2016-06-21 23:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
209		{
210		$service = Injector::inst()->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService');
211		if (!$service->enabled()
212		\|\| !$this->owner->config()->delete_users_in_ldap
213		\|\| !$this->owner->GUID
214		) {
215		return;
216		}
217
218		$service->deleteLDAPMember($this->owner);
219		}
220
221		/**
222		* Triggered by {@link Member::logIn()} when successfully logged in,
223		* this will update the Member record from AD data.
224		*/
225		public function memberLoggedIn()
226		{
227		if ($this->owner->GUID) {
228		Injector::inst()
229		->get('SilverStripe\\ActiveDirectory\\Services\\LDAPService')
230		->updateMemberFromLDAP($this->owner);
231		}
232		}
233		}
234

silverstripe / silverstripe-activedirectory

Push — master ( 197387...875417 )

LDAPMemberExtension::updateCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like