LDAPClient::__construct() - Code Metrics - Inspection of "changed class LDAPClient, added method to list gro..." - JuKu/JuKuCMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5b1d5e...6bc2f3 )

by Justin

created 2018-05-12 11:50 UTC

LDAPClient::__construct() C

↳ Parent: LDAPClient

Complexity

Conditions	9
Paths	26

Size

Total Lines	60
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	60
rs	6.8358
cc	9
eloc	29
nc	26
nop	3

How to fix Long Method

<?php

/**
 * Copyright (c) 2018 Justin Kuenzel (jukusoft.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


/**
 * Project: JuKuCMS
 * License: Apache 2.0 license
 * User: Justin
 * Date: 24.04.2018
 * Time: 23:00
 */

class LDAPClient {

	//host and port
	protected $host = "";
	protected $port = 389;

	//flag, if uri is used instead of host
	protected $uri_used = false;
	protected $uri = "";

	protected $conn = null;
	protected $res = null;

	protected $dn = "";

	protected $ldap_config = array();

	//flag, if connection is readonly
	protected $readonly = false;

	public function __construct (string $host = "", int $port = 0, bool $ssl = false) {
		$ldap_config = array(
			'enabled' => true,
			'ssl' => $ssl
		);

		if (empty($host)) {
			//load local config
			if (!file_exists(CONFIG_PATH . "ldap.php")) {
				throw new IllegalStateException("No ldap configuration file config/ldap.php exists!");
			}

			//override $ldap_config
			require(CONFIG_PATH . "ldap.php");

			//check, if ldap is enabled
			if ($ldap_config['enabled'] == false) {

				throw new IllegalStateException("LDAP is disabled.");
			}

			$this->host = $ldap_config['host'];
			$this->port = intval($ldap_config['port']);

			$this->readonly = boolval($ldap_config['readonly']);
		} else {
			$this->host = $host;
			$this->port = $port;
		}

		//check, if SSL is enabled
		if ($ldap_config['ssl'] == true) {

			//use OpenLDAP 2.x.x URI instead of host
			$this->uri = "ldaps://" . $this->host . ":" . $this->port;

			//set flag, that uri is used
			$this->uri_used = true;
		}

		//check, if host / uri is valide (this statement doesnt connect to server!) - see also http://php.net/manual/de/function.ldap-connect.php
		if ($this->uri_used) {
			$this->conn = ldap_connect($this->uri);
		} else {
			$this->conn = ldap_connect($this->host, $this->port);
		}

		if ($this->conn === FALSE) {

			throw new IllegalStateException("LDAP connection parameters (host or port) are invalide.");
		}

		$this->dn = $ldap_config['dn'];

		//set ldap params
		if (isset($ldap_config['params'])) {
			foreach ($ldap_config['params'] as $key=>$value) {

				// configure ldap params
				ldap_set_option($this->conn,$key, $value);
			}
		}

		$this->ldap_config = $ldap_config;
	}

	public function bind (string $username = null, string $password = null) : bool {
		if (is_null($username) && isset($this->ldap_config['user'])) {
			$username = $this->ldap_config['user'];
			$password = $this->ldap_config['password'];
		}

		$ldap_usr_dom = "";

		if (isset($this->ldap_config['ldap_usr_dom'])) {
			$ldap_usr_dom = $this->ldap_config['ldap_usr_dom'];
		}

		if ($this->conn === FALSE) {
			throw new IllegalStateException("ldap connection check failed.");
		}

		//http://www.selfadsi.de/ads-attributes/user-sAMAccountName.htm

		//connect and bind to ldap server
		if (!is_null($username)) {
			//with authentification
			$this->res = @ldap_bind($this->conn, $username . $ldap_usr_dom, $password);
		} else {
			//anonymous binding
			$this->res = @ldap_bind($this->conn);
		}

		return $this->res !== FALSE;
	}

	public function listGroupsOfUser (string $user) : array {
		// check presence in groups
		$filter = "(sAMAccountName=" . $user . ")";
		$attr = array("memberof");

		//https://samjlevy.com/php-ldap-login/

		$result = ldap_search($this->conn, $this->dn, $filter, $attr) or exit("Unable to search LDAP server");


		/*
		 *return_value["count"] = number of entries in the result
		 * return_value[0] : refers to the details of first entry
		 * return_value[i]["dn"] = DN of the ith entry in the result
		 * return_value[i]["count"] = number of attributes in ith entry
		 * return_value[i][j] = NAME of the jth attribute in the ith entry in the result
		 * return_value[i]["attribute"]["count"] = number of values for
		 * attribute in ith entry
		 * return_value[i]["attribute"][j] = jth value of attribute in ith entry
		 */
		$entries = ldap_get_entries($this->conn, $result);

		/*$array = array();

		$count = intval($entries['count']);

		for ($i = 0; $i < $count; $i++) {
			$entry = $entries[$i];

			$array[] = array(
				'dn' => $entry['dn'],
				'count' => $entry['count'],
				'attributes' => $entry,
			);
		}*/

		$groups = array();

		foreach($entries[0]['memberof'] as $grps) {
			$groups[] = $grps;
		}

		return $groups;
	}

	public function unbind () {
		//disconnect from ldap server
		ldap_unbind($this->conn);
	}

	public function getConnection () {
		return $this->conn;
	}

}

?>



1			<?php
2
3			/**
4			* Copyright (c) 2018 Justin Kuenzel (jukusoft.com)
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19
20			/**
21			* Project: JuKuCMS
22			* License: Apache 2.0 license
23			* User: Justin
24			* Date: 24.04.2018
25			* Time: 23:00
26			*/
27
28			class LDAPClient {
29
30			//host and port
31			protected $host = "";
32			protected $port = 389;
33
34			//flag, if uri is used instead of host
35			protected $uri_used = false;
36			protected $uri = "";
37
38			protected $conn = null;
39			protected $res = null;
40
41			protected $dn = "";
42
43			protected $ldap_config = array();
44
45			//flag, if connection is readonly
46			protected $readonly = false;
47
48			public function __construct (string $host = "", int $port = 0, bool $ssl = false) {
49			$ldap_config = array(
50			'enabled' => true,
51			'ssl' => $ssl
52			);
53
54			if (empty($host)) {
55			//load local config
56			if (!file_exists(CONFIG_PATH . "ldap.php")) {
57			throw new IllegalStateException("No ldap configuration file config/ldap.php exists!");
58			}
59
60			//override $ldap_config
61			require(CONFIG_PATH . "ldap.php");
62
63			//check, if ldap is enabled
64			if ($ldap_config['enabled'] == false) {
			0 ignored issues – show Coding Style Best Practice introduced 2018-04-24 21:37 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history... introduced 2018-04-24 21:37 UTC by Report Bug Copy Issue Report The condition `$ldap_config['enabled'] == false` is always `false`. Loading history...
65			throw new IllegalStateException("LDAP is disabled.");
66			}
67
68			$this->host = $ldap_config['host'];
69			$this->port = intval($ldap_config['port']);
70
71			$this->readonly = boolval($ldap_config['readonly']);
72			} else {
73			$this->host = $host;
74			$this->port = $port;
75			}
76
77			//check, if SSL is enabled
78			if ($ldap_config['ssl'] == true) {
			0 ignored issues – show Coding Style Best Practice introduced 2018-04-24 21:37 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
79			//use OpenLDAP 2.x.x URI instead of host
80			$this->uri = "ldaps://" . $this->host . ":" . $this->port;
81
82			//set flag, that uri is used
83			$this->uri_used = true;
84			}
85
86			//check, if host / uri is valide (this statement doesnt connect to server!) - see also http://php.net/manual/de/function.ldap-connect.php
87			if ($this->uri_used) {
88			$this->conn = ldap_connect($this->uri);
89			} else {
90			$this->conn = ldap_connect($this->host, $this->port);
91			}
92
93			if ($this->conn === FALSE) {
			0 ignored issues – show introduced 2018-04-24 21:37 UTC by Report Bug Copy Issue Report The condition `$this->conn === FALSE` is always `false`. Loading history...
94			throw new IllegalStateException("LDAP connection parameters (host or port) are invalide.");
95			}
96
97			$this->dn = $ldap_config['dn'];
98
99			//set ldap params
100			if (isset($ldap_config['params'])) {
101			foreach ($ldap_config['params'] as $key=>$value) {
			0 ignored issues – show Bug introduced 2018-05-12 10:53 UTC by Report Bug Copy Issue Report The expression `$ldap_config['params']` of type `boolean` is not traversable. Loading history...
102			// configure ldap params
103			ldap_set_option($this->conn,$key, $value);
104			}
105			}
106
107			$this->ldap_config = $ldap_config;
108			}
109
110			public function bind (string $username = null, string $password = null) : bool {
111			if (is_null($username) && isset($this->ldap_config['user'])) {
112			$username = $this->ldap_config['user'];
113			$password = $this->ldap_config['password'];
114			}
115
116			$ldap_usr_dom = "";
117
118			if (isset($this->ldap_config['ldap_usr_dom'])) {
119			$ldap_usr_dom = $this->ldap_config['ldap_usr_dom'];
120			}
121
122			if ($this->conn === FALSE) {
123			throw new IllegalStateException("ldap connection check failed.");
124			}
125
126			//http://www.selfadsi.de/ads-attributes/user-sAMAccountName.htm
127
128			//connect and bind to ldap server
129			if (!is_null($username)) {
130			//with authentification
131			$this->res = @ldap_bind($this->conn, $username . $ldap_usr_dom, $password);
132			} else {
133			//anonymous binding
134			$this->res = @ldap_bind($this->conn);
135			}
136
137			return $this->res !== FALSE;
138			}
139
140			public function listGroupsOfUser (string $user) : array {
141			// check presence in groups
142			$filter = "(sAMAccountName=" . $user . ")";
143			$attr = array("memberof");
144
145			//https://samjlevy.com/php-ldap-login/
146
147			$result = ldap_search($this->conn, $this->dn, $filter, $attr) or exit("Unable to search LDAP server");
			0 ignored issues – show Best Practice introduced 2018-05-12 11:38 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
148
149			/*
150			*return_value["count"] = number of entries in the result
151			* return_value[0] : refers to the details of first entry
152			* return_value[i]["dn"] = DN of the ith entry in the result
153			* return_value[i]["count"] = number of attributes in ith entry
154			* return_value[i][j] = NAME of the jth attribute in the ith entry in the result
155			* return_value[i]["attribute"]["count"] = number of values for
156			* attribute in ith entry
157			* return_value[i]["attribute"][j] = jth value of attribute in ith entry
158			*/
159			$entries = ldap_get_entries($this->conn, $result);
160
161			/*$array = array();
162
163			$count = intval($entries['count']);
164
165			for ($i = 0; $i < $count; $i++) {
166			$entry = $entries[$i];
167
168			$array[] = array(
169			'dn' => $entry['dn'],
170			'count' => $entry['count'],
171			'attributes' => $entry,
172			);
173			}*/
174
175			$groups = array();
176
177			foreach($entries[0]['memberof'] as $grps) {
178			$groups[] = $grps;
179			}
180
181			return $groups;
182			}
183
184			public function unbind () {
185			//disconnect from ldap server
186			ldap_unbind($this->conn);
187			}
188
189			public function getConnection () {
190			return $this->conn;
191			}
192
193			}
194
195			?>
			0 ignored issues – show Best Practice introduced 2018-05-12 11:38 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
196

JuKu / JuKuCMS

Push — master ( 5b1d5e...6bc2f3 )

LDAPClient::__construct() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like