LDAPServer::read() - Code Metrics - Inspection of "Fix some issues in classes rated C by CodeClimate" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b25e7b...4d2b11 )

by Patrick

created 2016-06-14 19:14 UTC

LDAPServer::read() B

↳ Parent: LDAPServer

Complexity

Conditions	5
Paths	10

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	2	Features	0

Metric	Value
cc	5
eloc	15
c	2
b	2
f	0
nc	10
nop	4
dl	0
loc	27
rs	8.439

<?php
namespace LDAP;

/**
 * function ldap_escape
 * @author Chris Wright
 * @version 2.0
 * @param string $subject The subject string
 * @param bool $dn Treat subject as a DN if TRUE
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 * @param string|array $ignore Set of characters to leave untouched
 * @return string The escaped string
 */
function ldap_escape($subject, $distinguishedName = false, $ignore = NULL)
{
    // The base array of characters to escape
    // Flip to keys for easy use of unset()
    $search = array_flip($distinguishedName ? array('\\', '+', '<', '>', ';', '"', '#') : array('\\', '*', '(', ')', "\x00"));

    // Process characters to ignore
    if(is_array($ignore))
    {
        $ignore = array_values($ignore);
    }
    for($char = 0; isset($ignore[$char]); $char++)
    {
        unset($search[$ignore[$char]]);
    }

    // Flip $search back to values and build $replace array
    $search = array_keys($search); 
    $replace = array();
    foreach($search as $char)
    {
        $replace[] = sprintf('\\%02x', ord($char));
    }

    // Do the main replacement
    $result = str_replace($search, $replace, $subject);

    // Encode leading/trailing spaces in DN values
    if($distinguishedName)
    {
        $result = cleanupDN($result);
    }

    return $result;
}

function cleanupDN($distinguishedName)
{
    if($distinguishedName[0] == ' ')
    {
        $distinguishedName = '\\20'.substr($distinguishedName, 1);
    }
    if($distinguishedName[strlen($distinguishedName) - 1] == ' ')
    {
        $distinguishedName = substr($distinguishedName, 0, -1).'\\20';
    }
    return $distinguishedName;
}

class LDAPServer extends \Singleton
{
    protected $ds;
    protected $connect;
    protected $binder;
    public $user_base;
    public $group_base;

    protected function __construct()
    {
        $this->ds = null;
        $this->binder = null;
    }

    public function __destruct()
    {
    }

    public function __wakeup()
    {
        $this->ds = ldap_connect($this->connect);
    }

    private function getConnectString($name, $proto = false)
    {
        if(strstr($name, ':') !== false)
        {
            return $name;
        }
        if($proto !== 'ldap')
        {
            return $proto.'://'.$name;
        }
        return $name;
    }

    public function connect($name, $proto = false)
    {
        $connectStr = $this->getConnectString($name, $proto);
        if($this->ds !== null)
        {
            ldap_close($this->ds);
        }
        $this->connect = $connectStr;
        $this->ds      = ldap_connect($this->connect);
        if($this->ds === false)
        {
            $this->ds = null;
            return false;
        }
        ldap_set_option($this->ds, LDAP_OPT_PROTOCOL_VERSION, 3);
        return true;
    }

    public function disconnect()
    {
        if($this->ds !== null)
        {
            ldap_close($this->ds);
            $this->ds = null;
        }
        $this->connect = false;
    }

    /**
     * Bind (login0 to the LDAP Server
     *
     * @param string $cn The common name to bind with, null to bind anonymously
     * @param string $password The password to bind with, null to bind anonymously
     */
    public function bind($cn = null, $password = null)
    {
        $res = false;
        if($this->ds === null)
        {
            throw new \Exception('Not connected');
        }
        $this->binder = $cn;
        if($cn === null || $password === null)
        {
            return @ldap_bind($this->ds);
        }
        try
        {
            $res = ldap_bind($this->ds, $cn, $password);
        }
        catch(\Exception $ex)
        {
            $this->ds = ldap_connect($this->connect);
            $res = @ldap_bind($this->ds, $cn, $password);
        }
        return $res;
    }

    public function unbind()
    {
        if($this->ds === null)
        {
            return true;
        }
        return @ldap_unbind($this->ds);
    }

    public function getError()
    {
        return ldap_error($this->ds);
    }

    private function fixObject($object, &$delete = false)
    {
        $entity = $object;
        if(!is_array($object))
        {
            $entity = $object->to_array();
        }
        unset($entity['dn']);
        $keys = array_keys($entity);
        $count = count($keys);
        for($i = 0; $i < $count; $i++)
        {
            if(is_array($entity[$keys[$i]]))
            {
                $array = $entity[$keys[$i]];
                unset($entity[$keys[$i]]);
                $count1 = count($array);
                for($j = 0; $j < $count1; $j++)
                {
                    if(isset($array[$j]))
                    {
                        $entity[$keys[$i]][$j] = $array[$j];
                    }
                }
            }
            else if($delete !== false && $entity[$keys[$i]] === null)
            {
                $delete[$keys[$i]] = array();
                unset($entity[$keys[$i]]);
            }
        }
        return $entity;
    }

    public function create($object)
    {
        $dn = ldap_escape($object['dn'], true);
        $entity = $this->fixObject($object);
        $ret = ldap_add($this->ds, $dn, $entity);
        if($ret === false)
        {
            throw new \Exception('Failed to create object with dn='.$dn);
        }
        return $ret;
    }

    /**
     * Get the LDAP filter represented by the passed object
     *
     * @param boolean|string|\Data\Filter $filter The fiter to use
     *
     * @return string The filter in LDAP format
     */
    private function filterToString($filter)
    {
        if($filter === false)
        {
            return '(objectclass=*)';
        }
        if(is_string($filter))
        {
            return $filter;
        }
        return $filter->to_ldap_string();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
    }

    private function searchResultToArray($searchResult)
    {
        if($searchResult === false)
        {
            return false;
        }
        $res = ldap_get_entries($this->ds, $searchResult);
        if(is_array($res))
        {
            $ldap = $res;
            $res = array();
            for($i = 0; $i < $ldap['count']; $i++)
            {
                array_push($res, new LDAPObject($ldap[$i], $this));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }
        return $res;
    }

    public function read($baseDN, $filter = false, $single = false, $attributes = false)
    {
        $filterStr = $this->filterToString($filter);
        if($this->ds === null)
        {
            throw new \Exception('Not connected');
        }
        try
        {
            if($single === true)
            {
                $searchResult = @ldap_read($this->ds, $baseDN, $filterStr);
                return $this->searchResultToArray($searchResult);
            }
            if($attributes !== false)
            {
                $searchResult = @ldap_list($this->ds, $baseDN, $filterStr, $attributes);
                return $this->searchResultToArray($searchResult);
            }
            $searchResult = @ldap_list($this->ds, $baseDN, $filterStr);
            return $this->searchResultToArray($searchResult);
        }
        catch(\Exception $e)
        {
            throw new \Exception($e->getMessage().' '.$filterStr, $e->getCode(), $e);
        }
    }

    public function count($baseDN, $filter = false)
    {
        $filterStr = $this->filterToString($filter);
        if($this->ds === null)
        {
            throw new \Exception('Not connected');
        }
        try
        {
            $sr = ldap_list($this->ds, $baseDN, $filterStr, array('dn'));
        }
        catch(\Exception $e)
        {
            throw new \Exception($e->getMessage().' '.$filterStr, $e->getCode(), $e);
        }
        if($sr === false)
        {
            return false;
        }
        return ldap_count_entries($this->ds, $sr);
    }

    public function update($object)
    {
        $dn = ldap_escape($object['dn'], true);
        $delete = array();
        $entity = $this->fixObject($object, $delete);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $ret = false;
        if(!empty($entity))
        {
            $ret = @ldap_mod_replace($this->ds, $dn, $entity);
            if($ret === false)
            {
                throw new \Exception('Failed to update object with dn='.$dn.'('.ldap_errno($this->ds).':'.ldap_error($this->ds).') '.print_r($entity, true));
            }
        }
        if(!empty($delete))
        {
            $ret = @ldap_mod_del($this->ds, $dn, $delete);
        }
        return $ret;
    }

    public function delete($distinguishedName)
    {
        return ldap_delete($this->ds, $distinguishedName);
    }
}



1			<?php
2			namespace LDAP;
3
4			/**
5			* function ldap_escape
6			* @author Chris Wright
7			* @version 2.0
8			* @param string $subject The subject string
9			* @param bool $dn Treat subject as a DN if TRUE
			0 ignored issues – show Bug introduced 2016-06-14 19:18 UTC by Report Bug Copy Issue Report There is no parameter named `$dn`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
10			* @param string\|array $ignore Set of characters to leave untouched
11			* @return string The escaped string
12			*/
13			function ldap_escape($subject, $distinguishedName = false, $ignore = NULL)
14			{
15			// The base array of characters to escape
16			// Flip to keys for easy use of unset()
17			$search = array_flip($distinguishedName ? array('\\', '+', '<', '>', ';', '"', '#') : array('\\', '*', '(', ')', "\x00"));
18
19			// Process characters to ignore
20			if(is_array($ignore))
21			{
22			$ignore = array_values($ignore);
23			}
24			for($char = 0; isset($ignore[$char]); $char++)
25			{
26			unset($search[$ignore[$char]]);
27			}
28
29			// Flip $search back to values and build $replace array
30			$search = array_keys($search);
31			$replace = array();
32			foreach($search as $char)
33			{
34			$replace[] = sprintf('\\%02x', ord($char));
35			}
36
37			// Do the main replacement
38			$result = str_replace($search, $replace, $subject);
39
40			// Encode leading/trailing spaces in DN values
41			if($distinguishedName)
42			{
43			$result = cleanupDN($result);
44			}
45
46			return $result;
47			}
48
49			function cleanupDN($distinguishedName)
50			{
51			if($distinguishedName[0] == ' ')
52			{
53			$distinguishedName = '\\20'.substr($distinguishedName, 1);
54			}
55			if($distinguishedName[strlen($distinguishedName) - 1] == ' ')
56			{
57			$distinguishedName = substr($distinguishedName, 0, -1).'\\20';
58			}
59			return $distinguishedName;
60			}
61
62			class LDAPServer extends \Singleton
63			{
64			protected $ds;
65			protected $connect;
66			protected $binder;
67			public $user_base;
68			public $group_base;
69
70			protected function __construct()
71			{
72			$this->ds = null;
73			$this->binder = null;
74			}
75
76			public function __destruct()
77			{
78			}
79
80			public function __wakeup()
81			{
82			$this->ds = ldap_connect($this->connect);
83			}
84
85			private function getConnectString($name, $proto = false)
86			{
87			if(strstr($name, ':') !== false)
88			{
89			return $name;
90			}
91			if($proto !== 'ldap')
92			{
93			return $proto.'://'.$name;
94			}
95			return $name;
96			}
97
98			public function connect($name, $proto = false)
99			{
100			$connectStr = $this->getConnectString($name, $proto);
101			if($this->ds !== null)
102			{
103			ldap_close($this->ds);
104			}
105			$this->connect = $connectStr;
106			$this->ds = ldap_connect($this->connect);
107			if($this->ds === false)
108			{
109			$this->ds = null;
110			return false;
111			}
112			ldap_set_option($this->ds, LDAP_OPT_PROTOCOL_VERSION, 3);
113			return true;
114			}
115
116			public function disconnect()
117			{
118			if($this->ds !== null)
119			{
120			ldap_close($this->ds);
121			$this->ds = null;
122			}
123			$this->connect = false;
124			}
125
126			/**
127			* Bind (login0 to the LDAP Server
128			*
129			* @param string $cn The common name to bind with, null to bind anonymously
130			* @param string $password The password to bind with, null to bind anonymously
131			*/
132			public function bind($cn = null, $password = null)
133			{
134			$res = false;
135			if($this->ds === null)
136			{
137			throw new \Exception('Not connected');
138			}
139			$this->binder = $cn;
140			if($cn === null \|\| $password === null)
141			{
142			return @ldap_bind($this->ds);
143			}
144			try
145			{
146			$res = ldap_bind($this->ds, $cn, $password);
147			}
148			catch(\Exception $ex)
149			{
150			$this->ds = ldap_connect($this->connect);
151			$res = @ldap_bind($this->ds, $cn, $password);
152			}
153			return $res;
154			}
155
156			public function unbind()
157			{
158			if($this->ds === null)
159			{
160			return true;
161			}
162			return @ldap_unbind($this->ds);
163			}
164
165			public function getError()
166			{
167			return ldap_error($this->ds);
168			}
169
170			private function fixObject($object, &$delete = false)
171			{
172			$entity = $object;
173			if(!is_array($object))
174			{
175			$entity = $object->to_array();
176			}
177			unset($entity['dn']);
178			$keys = array_keys($entity);
179			$count = count($keys);
180			for($i = 0; $i < $count; $i++)
181			{
182			if(is_array($entity[$keys[$i]]))
183			{
184			$array = $entity[$keys[$i]];
185			unset($entity[$keys[$i]]);
186			$count1 = count($array);
187			for($j = 0; $j < $count1; $j++)
188			{
189			if(isset($array[$j]))
190			{
191			$entity[$keys[$i]][$j] = $array[$j];
192			}
193			}
194			}
195			else if($delete !== false && $entity[$keys[$i]] === null)
196			{
197			$delete[$keys[$i]] = array();
198			unset($entity[$keys[$i]]);
199			}
200			}
201			return $entity;
202			}
203
204			public function create($object)
205			{
206			$dn = ldap_escape($object['dn'], true);
207			$entity = $this->fixObject($object);
208			$ret = ldap_add($this->ds, $dn, $entity);
209			if($ret === false)
210			{
211			throw new \Exception('Failed to create object with dn='.$dn);
212			}
213			return $ret;
214			}
215
216			/**
217			* Get the LDAP filter represented by the passed object
218			*
219			* @param boolean\|string\|\Data\Filter $filter The fiter to use
220			*
221			* @return string The filter in LDAP format
222			*/
223			private function filterToString($filter)
224			{
225			if($filter === false)
226			{
227			return '(objectclass=*)';
228			}
229			if(is_string($filter))
230			{
231			return $filter;
232			}
233			return $filter->to_ldap_string();
			0 ignored issues – show Bug introduced 2016-06-07 04:07 UTC by Report Bug Copy Issue Report It seems like `$filter` is not always an object, but can also be of type `boolean`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
234			}
235
236			private function searchResultToArray($searchResult)
237			{
238			if($searchResult === false)
239			{
240			return false;
241			}
242			$res = ldap_get_entries($this->ds, $searchResult);
243			if(is_array($res))
244			{
245			$ldap = $res;
246			$res = array();
247			for($i = 0; $i < $ldap['count']; $i++)
248			{
249			array_push($res, new LDAPObject($ldap[$i], $this));
			0 ignored issues – show Documentation introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report `$this` is of type `this<LDAP\LDAPServer>`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
250			}
251			}
252			return $res;
253			}
254
255			public function read($baseDN, $filter = false, $single = false, $attributes = false)
256			{
257			$filterStr = $this->filterToString($filter);
258			if($this->ds === null)
259			{
260			throw new \Exception('Not connected');
261			}
262			try
263			{
264			if($single === true)
265			{
266			$searchResult = @ldap_read($this->ds, $baseDN, $filterStr);
267			return $this->searchResultToArray($searchResult);
268			}
269			if($attributes !== false)
270			{
271			$searchResult = @ldap_list($this->ds, $baseDN, $filterStr, $attributes);
272			return $this->searchResultToArray($searchResult);
273			}
274			$searchResult = @ldap_list($this->ds, $baseDN, $filterStr);
275			return $this->searchResultToArray($searchResult);
276			}
277			catch(\Exception $e)
278			{
279			throw new \Exception($e->getMessage().' '.$filterStr, $e->getCode(), $e);
280			}
281			}
282
283			public function count($baseDN, $filter = false)
284			{
285			$filterStr = $this->filterToString($filter);
286			if($this->ds === null)
287			{
288			throw new \Exception('Not connected');
289			}
290			try
291			{
292			$sr = ldap_list($this->ds, $baseDN, $filterStr, array('dn'));
293			}
294			catch(\Exception $e)
295			{
296			throw new \Exception($e->getMessage().' '.$filterStr, $e->getCode(), $e);
297			}
298			if($sr === false)
299			{
300			return false;
301			}
302			return ldap_count_entries($this->ds, $sr);
303			}
304
305			public function update($object)
306			{
307			$dn = ldap_escape($object['dn'], true);
308			$delete = array();
309			$entity = $this->fixObject($object, $delete);
			0 ignored issues – show Documentation introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report `$delete` is of type `array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
310			$ret = false;
311			if(!empty($entity))
312			{
313			$ret = @ldap_mod_replace($this->ds, $dn, $entity);
314			if($ret === false)
315			{
316			throw new \Exception('Failed to update object with dn='.$dn.'('.ldap_errno($this->ds).':'.ldap_error($this->ds).') '.print_r($entity, true));
317			}
318			}
319			if(!empty($delete))
320			{
321			$ret = @ldap_mod_del($this->ds, $dn, $delete);
322			}
323			return $ret;
324			}
325
326			public function delete($distinguishedName)
327			{
328			return ldap_delete($this->ds, $distinguishedName);
329			}
330			}
331
332

BurningFlipside / CommonCode

Push — master ( b25e7b...4d2b11 )

LDAPServer::read() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like