LDAPCachableObject::getField() - Code Metrics - Inspection of "Merge pull request #122 from BurningFlipside/devel..." - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f22a46...046041 )

by Patrick

created 2020-06-15 02:42 UTC

LDAPCachableObject::getField() A

↳ Parent: LDAPCachableObject

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php
namespace Flipside\Auth;

trait LDAPCachableObject
{
    protected function initialize($data)
    {
        if($data === false)
        {
            return;
        }
        if(is_string($data))
        {
            $this->ldapObj = $this->initializeFromDN($data);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return;
        }
        if($data instanceof \Flipside\LDAP\LDAPObject)
        {
            $this->ldapObj = $data;
            return;
        }
        $this->ldapObj = $this->initializeFromArray($data);
    }

    /**
     * Get the data from the server based on the DN
     *
     * @param string $dn The DN of the LDAP object
     *
     * @return array The raw LDAP data
     */
    private function initializeFromDN($dn)
    {
        $data = $this->server->read($dn, false, true);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        if($data === false || !isset($data[0]))
        {
            return false;
        }
        return $data[0];
    }

    private function initializeFromArray($array)
    {
        if(isset($array['extended']))
        {
            return $array['extended'];
        }
        //Generic user object
        if(isset($array['mail']))
        {
            $filter = new \Flipside\Data\Filter('mail eq '.$array['mail']);
            $users = $this->server->read($this->server->user_base, $filter);
            if($users === false || !isset($users[0]))
            {
                return false;
            }
            return $users[0];
        }
        var_dump($array);

        die();
    }

    protected function update($obj)
    {
        try
        {
            return $this->server->update($obj);
        }
        catch(\Exception $ex)
        {
            $auth = \Flipside\AuthProvider::getInstance();
            $ldap = $auth->getMethodByName('Auth\LDAPAuthenticator');
            if($ldap === false)
            {
                return false;
            }
            $this->server = $ldap->getAndBindServer(true);
            return $this->server->update($obj);
        }
    }

    /**
     * Get the specified field from the cached object or LDAPObject
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return mixed string|array the value of the field
     */
    protected function getField($fieldName)
    {
        if(!is_object($this->ldapObj))
        {
            return $this->getFieldLocal($fieldName);
        }
        return $this->getFieldServer($fieldName);
    }

    /**
     * Get the value of the specified field from the cached object or LDAPObject
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return mixed string the value of the field
     */
    protected function getFieldSingleValue($fieldName)
    {
        if(!is_object($this->ldapObj))
        {
            return $this->getFieldLocalSingleValue($fieldName);
        }
        return $this->getFieldServerSingleValue($fieldName);
    }

    /**
     * Set the value of the specified field in the cached object or LDAPObject
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to set in the field
     *
     * @return boolean true if the field is set and false otherwise
     */
    protected function setField($fieldName, $fieldValue)
    {
        if(!is_object($this->ldapObj))
        {
            return $this->setFieldLocal($fieldName, $fieldValue);
        }
        return $this->setFieldServer($fieldName, $fieldValue);
    }

    /**
     * Append a value of the specified field in the cached object or LDAPObject
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to append to the field
     *
     * @return  boolean true if the field is set and false otherwise
     */
    protected function appendField($fieldName, $fieldValue)
    {
        if(!is_object($this->ldapObj))
        {
            return $this->appendFieldLocal($fieldName, $fieldValue);
        }
        return $this->appendFieldServer($fieldName, $fieldValue);
    }

    /**
     * Get the value of the field in the local cache
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return mixed the value of the field
     */
    private function getFieldLocal($fieldName)
    {
        if($this->ldapObj === false)
        {
            return false;
        }
        if(!isset($this->ldapObj[$fieldName]))
        {
            return false;
        }
        return $this->ldapObj[$fieldName];
    }

    /**
     * Get the value of the field in the server object
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return mixed the value of the field
     */
    private function getFieldServer($fieldName)
    {
        $lowerName = strtolower($fieldName);
        if(!isset($this->ldapObj->{$lowerName}))
        {
            return false;
        }
        return $this->ldapObj->{$lowerName};
    }

    /**
     * Get the value of the specified field from the local cache
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return string the value of the field
     */
    private function getFieldLocalSingleValue($fieldName)
    {
        if($this->ldapObj === false)
        {
            return false;
        }
        if(!isset($this->ldapObj[$fieldName]))
        {
            return false;
        }
        if(is_array($this->ldapObj[$fieldName]))
        {
            return $this->ldapObj[$fieldName][0];
        }
        return $this->ldapObj[$fieldName];
    }

    /**
     * Get the value of the specified field from the server
     *
     * @param string $fieldName The name of the field to retrieve
     *
     * @return string the value of the field
     */
    private function getFieldServerSingleValue($fieldName)
    {
        $lowerName = strtolower($fieldName);
        if(!isset($this->ldapObj->{$lowerName}))
        {
            return false;
        }
        $field = $this->ldapObj->{$lowerName};
        if(!isset($field[0]))
        {
            return false;
        }
        return $field[0];
    }

    /**
     * Set the specified field in the server
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to write to the field
     *
     * @return boolean true if the field is set and false otherwise
     */
    private function setFieldServer($fieldName, $fieldValue)
    {
        $obj = array('dn'=>$this->ldapObj->dn);
        if($fieldValue !== null && is_array($fieldValue))
        {
            $found = false;
            foreach($fieldValue as $value)
            {
                if($value !== null && strlen($value) > 0)
                {
                    $found = true;
                    break;
                }
            }
            if($found)
            {
                $obj[$fieldName] = $fieldValue;
            }
        }
        else if($fieldValue !== null && strlen($fieldValue) > 0)
        {
            $obj[$fieldName] = $fieldValue;
        }
        else
        {
            $obj[$fieldName] = null;
        }
        $lowerName = strtolower($fieldName);
        if(!is_array($fieldValue))
        {
            $this->ldapObj->{$lowerName} = array($fieldValue);
        }
        else
        {
            $this->ldapObj->{$lowerName} = $fieldValue;
        }
        return $this->update($obj);
    }

    /**
     * Append a value of the specified field in the server
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to append to the field
     *
     * @return  boolean true if the field is set and false otherwise
     */
    private function appendFieldServer($fieldName, $fieldValue)
    {
        $obj = array('dn'=>$this->ldapObj->dn);
        if(isset($this->ldapObj->{$fieldName}))
        {
            $obj[$fieldName] = $this->ldapObj->{$fieldName};
            $obj[$fieldName][$obj[$fieldName]['count']] = $fieldValue;
            $obj[$fieldName]['count']++;
        }
        else
        {
            $obj[$fieldName] = $fieldValue;
        }
        return $this->update($obj);
    }

    /**
     * Set the specified field in the local cache
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to write to the field
     *
     * @return boolean true if the field is set and false otherwise
     */
    private function setFieldLocal($fieldName, $fieldValue)
    {
        if($this->ldapObj === false)
        {
            $this->ldapObj = array();
        }
        if($fieldValue === null || (is_string($fieldValue) && strlen($fieldValue) === 0))
        {
            if(isset($this->ldapObj[$fieldName]))
            {
                unset($this->ldapObj[$fieldName]);
            }
            return true;
        }
        $this->ldapObj[$fieldName] = $fieldValue;
        return true;
    }

    /**
     * Append a value of the specified field in the local cache
     *
     * @param string $fieldName The name of the field to set
     * @param mixed $fieldValue The value to append to the field
     *
     * @return  boolean true if the field is set and false otherwise
     */
    private function appendFieldLocal($fieldName, $fieldValue)
    {
        if($this->ldapObj === false)
        {
            $this->ldapObj = array();
        }
        if(!isset($this->ldapObj[$fieldName]))
        {
            $this->ldapObj[$fieldName] = array();
        }
        $this->ldapObj[$fieldName][] = $fieldValue;
        return true;
    }
}

/* vim: set tabstop=4 shiftwidth=4 expandtab: */


1			<?php
2			namespace Flipside\Auth;
3
4			trait LDAPCachableObject
5			{
6			protected function initialize($data)
7			{
8			if($data === false)
9			{
10			return;
11			}
12			if(is_string($data))
13			{
14			$this->ldapObj = $this->initializeFromDN($data);
			0 ignored issues – show Bug introduced 2016-06-10 16:57 UTC by Report Bug Copy Issue Report The property `ldapObj` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
15			return;
16			}
17			if($data instanceof \Flipside\LDAP\LDAPObject)
18			{
19			$this->ldapObj = $data;
20			return;
21			}
22			$this->ldapObj = $this->initializeFromArray($data);
23			}
24
25			/**
26			* Get the data from the server based on the DN
27			*
28			* @param string $dn The DN of the LDAP object
29			*
30			* @return array The raw LDAP data
31			*/
32			private function initializeFromDN($dn)
33			{
34			$data = $this->server->read($dn, false, true);
			0 ignored issues – show Bug introduced 2017-02-09 19:08 UTC by Report Bug Copy Issue Report The property `server` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
35			if($data === false \|\| !isset($data[0]))
36			{
37			return false;
38			}
39			return $data[0];
40			}
41
42			private function initializeFromArray($array)
43			{
44			if(isset($array['extended']))
45			{
46			return $array['extended'];
47			}
48			//Generic user object
49			if(isset($array['mail']))
50			{
51			$filter = new \Flipside\Data\Filter('mail eq '.$array['mail']);
52			$users = $this->server->read($this->server->user_base, $filter);
53			if($users === false \|\| !isset($users[0]))
54			{
55			return false;
56			}
57			return $users[0];
58			}
59			var_dump($array);
			0 ignored issues – show Security Debugging Code introduced 2020-06-15 01:15 UTC by Report Bug Copy Issue Report `var_dump($array);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
60			die();
61			}
62
63			protected function update($obj)
64			{
65			try
66			{
67			return $this->server->update($obj);
68			}
69			catch(\Exception $ex)
70			{
71			$auth = \Flipside\AuthProvider::getInstance();
72			$ldap = $auth->getMethodByName('Auth\LDAPAuthenticator');
73			if($ldap === false)
74			{
75			return false;
76			}
77			$this->server = $ldap->getAndBindServer(true);
78			return $this->server->update($obj);
79			}
80			}
81
82			/**
83			* Get the specified field from the cached object or LDAPObject
84			*
85			* @param string $fieldName The name of the field to retrieve
86			*
87			* @return mixed string\|array the value of the field
88			*/
89			protected function getField($fieldName)
90			{
91			if(!is_object($this->ldapObj))
92			{
93			return $this->getFieldLocal($fieldName);
94			}
95			return $this->getFieldServer($fieldName);
96			}
97
98			/**
99			* Get the value of the specified field from the cached object or LDAPObject
100			*
101			* @param string $fieldName The name of the field to retrieve
102			*
103			* @return mixed string the value of the field
104			*/
105			protected function getFieldSingleValue($fieldName)
106			{
107			if(!is_object($this->ldapObj))
108			{
109			return $this->getFieldLocalSingleValue($fieldName);
110			}
111			return $this->getFieldServerSingleValue($fieldName);
112			}
113
114			/**
115			* Set the value of the specified field in the cached object or LDAPObject
116			*
117			* @param string $fieldName The name of the field to set
118			* @param mixed $fieldValue The value to set in the field
119			*
120			* @return boolean true if the field is set and false otherwise
121			*/
122			protected function setField($fieldName, $fieldValue)
123			{
124			if(!is_object($this->ldapObj))
125			{
126			return $this->setFieldLocal($fieldName, $fieldValue);
127			}
128			return $this->setFieldServer($fieldName, $fieldValue);
129			}
130
131			/**
132			* Append a value of the specified field in the cached object or LDAPObject
133			*
134			* @param string $fieldName The name of the field to set
135			* @param mixed $fieldValue The value to append to the field
136			*
137			* @return boolean true if the field is set and false otherwise
138			*/
139			protected function appendField($fieldName, $fieldValue)
140			{
141			if(!is_object($this->ldapObj))
142			{
143			return $this->appendFieldLocal($fieldName, $fieldValue);
144			}
145			return $this->appendFieldServer($fieldName, $fieldValue);
146			}
147
148			/**
149			* Get the value of the field in the local cache
150			*
151			* @param string $fieldName The name of the field to retrieve
152			*
153			* @return mixed the value of the field
154			*/
155			private function getFieldLocal($fieldName)
156			{
157			if($this->ldapObj === false)
158			{
159			return false;
160			}
161			if(!isset($this->ldapObj[$fieldName]))
162			{
163			return false;
164			}
165			return $this->ldapObj[$fieldName];
166			}
167
168			/**
169			* Get the value of the field in the server object
170			*
171			* @param string $fieldName The name of the field to retrieve
172			*
173			* @return mixed the value of the field
174			*/
175			private function getFieldServer($fieldName)
176			{
177			$lowerName = strtolower($fieldName);
178			if(!isset($this->ldapObj->{$lowerName}))
179			{
180			return false;
181			}
182			return $this->ldapObj->{$lowerName};
183			}
184
185			/**
186			* Get the value of the specified field from the local cache
187			*
188			* @param string $fieldName The name of the field to retrieve
189			*
190			* @return string the value of the field
191			*/
192			private function getFieldLocalSingleValue($fieldName)
193			{
194			if($this->ldapObj === false)
195			{
196			return false;
197			}
198			if(!isset($this->ldapObj[$fieldName]))
199			{
200			return false;
201			}
202			if(is_array($this->ldapObj[$fieldName]))
203			{
204			return $this->ldapObj[$fieldName][0];
205			}
206			return $this->ldapObj[$fieldName];
207			}
208
209			/**
210			* Get the value of the specified field from the server
211			*
212			* @param string $fieldName The name of the field to retrieve
213			*
214			* @return string the value of the field
215			*/
216			private function getFieldServerSingleValue($fieldName)
217			{
218			$lowerName = strtolower($fieldName);
219			if(!isset($this->ldapObj->{$lowerName}))
220			{
221			return false;
222			}
223			$field = $this->ldapObj->{$lowerName};
224			if(!isset($field[0]))
225			{
226			return false;
227			}
228			return $field[0];
229			}
230
231			/**
232			* Set the specified field in the server
233			*
234			* @param string $fieldName The name of the field to set
235			* @param mixed $fieldValue The value to write to the field
236			*
237			* @return boolean true if the field is set and false otherwise
238			*/
239			private function setFieldServer($fieldName, $fieldValue)
240			{
241			$obj = array('dn'=>$this->ldapObj->dn);
242			if($fieldValue !== null && is_array($fieldValue))
243			{
244			$found = false;
245			foreach($fieldValue as $value)
246			{
247			if($value !== null && strlen($value) > 0)
248			{
249			$found = true;
250			break;
251			}
252			}
253			if($found)
254			{
255			$obj[$fieldName] = $fieldValue;
256			}
257			}
258			else if($fieldValue !== null && strlen($fieldValue) > 0)
259			{
260			$obj[$fieldName] = $fieldValue;
261			}
262			else
263			{
264			$obj[$fieldName] = null;
265			}
266			$lowerName = strtolower($fieldName);
267			if(!is_array($fieldValue))
268			{
269			$this->ldapObj->{$lowerName} = array($fieldValue);
270			}
271			else
272			{
273			$this->ldapObj->{$lowerName} = $fieldValue;
274			}
275			return $this->update($obj);
276			}
277
278			/**
279			* Append a value of the specified field in the server
280			*
281			* @param string $fieldName The name of the field to set
282			* @param mixed $fieldValue The value to append to the field
283			*
284			* @return boolean true if the field is set and false otherwise
285			*/
286			private function appendFieldServer($fieldName, $fieldValue)
287			{
288			$obj = array('dn'=>$this->ldapObj->dn);
289			if(isset($this->ldapObj->{$fieldName}))
290			{
291			$obj[$fieldName] = $this->ldapObj->{$fieldName};
292			$obj[$fieldName][$obj[$fieldName]['count']] = $fieldValue;
293			$obj[$fieldName]['count']++;
294			}
295			else
296			{
297			$obj[$fieldName] = $fieldValue;
298			}
299			return $this->update($obj);
300			}
301
302			/**
303			* Set the specified field in the local cache
304			*
305			* @param string $fieldName The name of the field to set
306			* @param mixed $fieldValue The value to write to the field
307			*
308			* @return boolean true if the field is set and false otherwise
309			*/
310			private function setFieldLocal($fieldName, $fieldValue)
311			{
312			if($this->ldapObj === false)
313			{
314			$this->ldapObj = array();
315			}
316			if($fieldValue === null \|\| (is_string($fieldValue) && strlen($fieldValue) === 0))
317			{
318			if(isset($this->ldapObj[$fieldName]))
319			{
320			unset($this->ldapObj[$fieldName]);
321			}
322			return true;
323			}
324			$this->ldapObj[$fieldName] = $fieldValue;
325			return true;
326			}
327
328			/**
329			* Append a value of the specified field in the local cache
330			*
331			* @param string $fieldName The name of the field to set
332			* @param mixed $fieldValue The value to append to the field
333			*
334			* @return boolean true if the field is set and false otherwise
335			*/
336			private function appendFieldLocal($fieldName, $fieldValue)
337			{
338			if($this->ldapObj === false)
339			{
340			$this->ldapObj = array();
341			}
342			if(!isset($this->ldapObj[$fieldName]))
343			{
344			$this->ldapObj[$fieldName] = array();
345			}
346			$this->ldapObj[$fieldName][] = $fieldValue;
347			return true;
348			}
349			}
350
351			/* vim: set tabstop=4 shiftwidth=4 expandtab: */
352

BurningFlipside / CommonCode

Push — master ( f22a46...046041 )

LDAPCachableObject::getField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like