LDAPMemberExtension::sync() - Code Metrics - Inspection of "Expose more SAML configuration options to SS confi..." - silverstripe/silverstripe-activedirectory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#117)

by Mateusz

created 2017-08-18 01:12 UTC

LDAPMemberExtension::sync() A

↳ Parent: LDAPMemberExtension

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	2
nop	0

<?php
/**
 * Class LDAPMemberExtension.
 *
 * Adds mappings from AD attributes to SilverStripe {@link Member} fields.
 */
class LDAPMemberExtension extends DataExtension
namespace YourVendor;

class YourClass { }
{
    /**
     * @var array
     */
    private static $db = [

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

    /**
     * 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, and synchronise
     * membership to groups mapped to LDAP.
     *
     * Keep in mind this will currently NOT trigger if there are no
     * field changes due to onAfterWrite in framework not being called
     * when there are no changes.
     *
     * 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[] = new ReadonlyField('GUID'));
        $fields->replaceField('IsExpired', $ldapMetadata[] = new ReadonlyField(
            'IsExpired',
            _t('LDAPMemberExtension.ISEXPIRED', 'Has user\'s LDAP/AD login expired?'))
        );
        $fields->replaceField('LastSynced', $ldapMetadata[] = new ReadonlyField(
            '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',
                new LiteralField(
                    'Info',
                    sprintf('<p class="message warning">%s</p>', $message)
                ),
                'FirstName'
            );
        }
    }

    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->error(
                '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()

    {
        if ($this->owner->LDAPMemberExtension_NoSync) {
            return;
        }

        $service = Injector::inst()->get('LDAPService');
        if (
            !$service->enabled() ||
            !$this->owner->config()->create_users_in_ldap ||
            !$this->owner->Username ||
            $this->owner->GUID
        ) {
            return;
        }

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

    public function onAfterWrite()
    {
        if ($this->owner->LDAPMemberExtension_NoSync) {
            return;
        }

        if (!$this->owner->config()->update_ldap_from_local) {
            return;
        }
        $this->sync();
    }

    public function onAfterDelete() {

        if ($this->owner->LDAPMemberExtension_NoSync) {
            return;
        }

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

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

    /**
     * Write DataObject without triggering this extension's hooks.
     *
     * @throws Exception
     */
    public function writeWithoutSync() {
        $this->owner->LDAPMemberExtension_NoSync = true;
        try {
            $this->owner->write();
        } catch (Exception $e) {
            $this->owner->LDAPMemberExtension_NoSync = false;
            throw $e;
        }
        $this->owner->LDAPMemberExtension_NoSync = false;
    }

    /**
     * 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 sync() {
        $service = Injector::inst()->get('LDAPService');
        if (
            !$service->enabled() ||
            !$this->owner->GUID
        ) {
            return;
        }
        $service->updateLDAPFromMember($this->owner);
        $service->updateLDAPGroupsForMember($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('LDAPService')->updateMemberFromLDAP($this->owner);
        }
    }
}


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

silverstripe / silverstripe-activedirectory

Pull Request — master (#117)

LDAPMemberExtension::sync() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like