AbstractMapping::getTableName()

Completed

Push — master ( c20409...a4266f )

by Lukas

created 2017-02-20 20:35 UTC

↳ Parent: AbstractMapping

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Aaron Wood <[email protected]>
 * @author Arthur Schiwon <[email protected]>
 * @author Morris Jobke <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\User_LDAP\Mapping;

/**
* Class AbstractMapping
* @package OCA\User_LDAP\Mapping
*/
abstract class AbstractMapping {
	/**
	 * @var \OCP\IDBConnection $dbc
	 */
	protected $dbc;

	/**
	 * returns the DB table name which holds the mappings
	 * @return string
	 */
	abstract protected function getTableName();

	/**
	 * @param \OCP\IDBConnection $dbc
	 */
	public function __construct(\OCP\IDBConnection $dbc) {
		$this->dbc = $dbc;
	}

	/**
	 * checks whether a provided string represents an existing table col
	 * @param string $col
	 * @return bool
	 */
	public function isColNameValid($col) {
		switch($col) {
			case 'ldap_dn':
			case 'owncloud_name':
			case 'directory_uuid':
				return true;
			default:
				return false;
		}
	}

	/**
	 * Gets the value of one column based on a provided value of another column
	 * @param string $fetchCol
	 * @param string $compareCol
	 * @param string $search
	 * @throws \Exception
	 * @return string|false
	 */
	protected function getXbyY($fetchCol, $compareCol, $search) {
		if(!$this->isColNameValid($fetchCol)) {
			//this is used internally only, but we don't want to risk
			//having SQL injection at all.
			throw new \Exception('Invalid Column Name');
		}
		$query = $this->dbc->prepare('
			SELECT `' . $fetchCol . '`
			FROM `'. $this->getTableName() .'`
			WHERE `' . $compareCol . '` = ?
		');

		$res = $query->execute(array($search));
		if($res !== false) {
			return $query->fetchColumn();
		}

		return false;
	}

	/**
	 * Performs a DELETE or UPDATE query to the database.
	 * @param \Doctrine\DBAL\Driver\Statement $query
	 * @param array $parameters
	 * @return bool true if at least one row was modified, false otherwise
	 */
	protected function modify($query, $parameters) {
		$result = $query->execute($parameters);
		return ($result === true && $query->rowCount() > 0);
	}

	/**
	 * Gets the LDAP DN based on the provided name.
	 * Replaces Access::ocname2dn
	 * @param string $name
	 * @return string|false
	 */
	public function getDNByName($name) {
		return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
	}

	/**
	 * Updates the DN based on the given UUID
	 * @param string $fdn
	 * @param string $uuid
	 * @return bool
	 */
	public function setDNbyUUID($fdn, $uuid) {

		$query = $this->dbc->prepare('
			UPDATE `' . $this->getTableName() . '`
			SET `ldap_dn` = ?
			WHERE `directory_uuid` = ?
		');

		return $this->modify($query, array($fdn, $uuid));
	}

	/**
	 * Updates the UUID based on the given DN
	 *
	 * required by Migration/UUIDFix
	 *
	 * @param $uuid
	 * @param $fdn
	 * @return bool
	 */
	public function setUUIDbyDN($uuid, $fdn) {

		$query = $this->dbc->prepare('
			UPDATE `' . $this->getTableName() . '`
			SET `directory_uuid` = ?
			WHERE `ldap_dn` = ?
		');

		return $this->modify($query, [$uuid, $fdn]);
	}

	/**
	 * Gets the name based on the provided LDAP DN.
	 * @param string $fdn
	 * @return string|false
	 */
	public function getNameByDN($fdn) {
		return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
	}

	/**
	 * Searches mapped names by the giving string in the name column
	 * @param string $search
	 * @param string $prefixMatch
	 * @param string $postfixMatch
	 * @return string[]
	 */
	public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
		$query = $this->dbc->prepare('
			SELECT `owncloud_name`
			FROM `'. $this->getTableName() .'`
			WHERE `owncloud_name` LIKE ?
		');

		$res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch));
		$names = array();
		if($res !== false) {
			while($row = $query->fetch()) {
				$names[] = $row['owncloud_name'];
			}
		}
		return $names;
	}

	/**
	 * Gets the name based on the provided LDAP UUID.
	 * @param string $uuid
	 * @return string|false
	 */
	public function getNameByUUID($uuid) {
		return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
	}

	/**
	 * Gets the UUID based on the provided LDAP DN
	 * @param string $dn
	 * @return false|string
	 * @throws \Exception
	 */
	public function getUUIDByDN($dn) {
		return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
	}

	/**
	 * gets a piece of the mapping list
	 * @param int $offset
	 * @param int $limit
	 * @return array
	 */
	public function getList($offset = null, $limit = null) {
		$query = $this->dbc->prepare('
			SELECT
				`ldap_dn` AS `dn`,
				`owncloud_name` AS `name`,
				`directory_uuid` AS `uuid`
			FROM `' . $this->getTableName() . '`',
			$limit,
			$offset
		);

		$query->execute();
		return $query->fetchAll();
	}

	/**
	 * attempts to map the given entry
	 * @param string $fdn fully distinguished name (from LDAP)
	 * @param string $name
	 * @param string $uuid a unique identifier as used in LDAP
	 * @return bool
	 */
	public function map($fdn, $name, $uuid) {
		if(mb_strlen($fdn) > 255) {

			\OC::$server->getLogger()->error(
				'Cannot map, because the DN exceeds 255 characters: {dn}',
				[
					'app' => 'user_ldap',
					'dn' => $fdn,
				]
			);
			return false;
		}

		$row = array(
			'ldap_dn'        => $fdn,
			'owncloud_name'  => $name,
			'directory_uuid' => $uuid
		);

		try {
			$result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
			// insertIfNotExist returns values as int
			return (bool)$result;
		} catch (\Exception $e) {
			return false;
		}
	}

	/**
	 * removes a mapping based on the owncloud_name of the entry
	 * @param string $name
	 * @return bool
	 */
	public function unmap($name) {

		$query = $this->dbc->prepare('
			DELETE FROM `'. $this->getTableName() .'`
			WHERE `owncloud_name` = ?');

		return $this->modify($query, array($name));
	}

	/**
	 * Truncate's the mapping table
	 * @return bool
	 */
	public function clear() {
		$sql = $this->dbc
			->getDatabasePlatform()
			->getTruncateTableSQL('`' . $this->getTableName() . '`');
		return $this->dbc->prepare($sql)->execute();
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Aaron Wood <[email protected]>
6		* @author Arthur Schiwon <[email protected]>
7		* @author Morris Jobke <[email protected]>
8		*
9		* @license AGPL-3.0
10		*
11		* This code is free software: you can redistribute it and/or modify
12		* it under the terms of the GNU Affero General Public License, version 3,
13		* as published by the Free Software Foundation.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU Affero General Public License for more details.
19		*
20		* You should have received a copy of the GNU Affero General Public License, version 3,
21		* along with this program. If not, see <http://www.gnu.org/licenses/>
22		*
23		*/
24
25		namespace OCA\User_LDAP\Mapping;
26
27		/**
28		* Class AbstractMapping
29		* @package OCA\User_LDAP\Mapping
30		*/
31		abstract class AbstractMapping {
32		/**
33		* @var \OCP\IDBConnection $dbc
34		*/
35		protected $dbc;
36
37		/**
38		* returns the DB table name which holds the mappings
39		* @return string
40		*/
41		abstract protected function getTableName();
42
43		/**
44		* @param \OCP\IDBConnection $dbc
45		*/
46		public function __construct(\OCP\IDBConnection $dbc) {
47		$this->dbc = $dbc;
48		}
49
50		/**
51		* checks whether a provided string represents an existing table col
52		* @param string $col
53		* @return bool
54		*/
55		public function isColNameValid($col) {
56		switch($col) {
57		case 'ldap_dn':
58		case 'owncloud_name':
59		case 'directory_uuid':
60		return true;
61		default:
62		return false;
63		}
64		}
65
66		/**
67		* Gets the value of one column based on a provided value of another column
68		* @param string $fetchCol
69		* @param string $compareCol
70		* @param string $search
71		* @throws \Exception
72		* @return string\|false
73		*/
74		protected function getXbyY($fetchCol, $compareCol, $search) {
75		if(!$this->isColNameValid($fetchCol)) {
76		//this is used internally only, but we don't want to risk
77		//having SQL injection at all.
78		throw new \Exception('Invalid Column Name');
79		}
80		$query = $this->dbc->prepare('
81		SELECT `' . $fetchCol . '`
82		FROM `'. $this->getTableName() .'`
83		WHERE `' . $compareCol . '` = ?
84		');
85
86		$res = $query->execute(array($search));
87		if($res !== false) {
88		return $query->fetchColumn();
89		}
90
91		return false;
92		}
93
94		/**
95		* Performs a DELETE or UPDATE query to the database.
96		* @param \Doctrine\DBAL\Driver\Statement $query
97		* @param array $parameters
98		* @return bool true if at least one row was modified, false otherwise
99		*/
100		protected function modify($query, $parameters) {
101		$result = $query->execute($parameters);
102		return ($result === true && $query->rowCount() > 0);
103		}
104
105		/**
106		* Gets the LDAP DN based on the provided name.
107		* Replaces Access::ocname2dn
108		* @param string $name
109		* @return string\|false
110		*/
111		public function getDNByName($name) {
112		return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
113		}
114
115		/**
116		* Updates the DN based on the given UUID
117		* @param string $fdn
118		* @param string $uuid
119		* @return bool
120		*/
121	View Code Duplication	public function setDNbyUUID($fdn, $uuid) {
		0 ignored issues – show Duplication introduced 2016-06-09 12:21 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...
122		$query = $this->dbc->prepare('
123		UPDATE `' . $this->getTableName() . '`
124		SET `ldap_dn` = ?
125		WHERE `directory_uuid` = ?
126		');
127
128		return $this->modify($query, array($fdn, $uuid));
129		}
130
131		/**
132		* Updates the UUID based on the given DN
133		*
134		* required by Migration/UUIDFix
135		*
136		* @param $uuid
137		* @param $fdn
138		* @return bool
139		*/
140	View Code Duplication	public function setUUIDbyDN($uuid, $fdn) {
		0 ignored issues – show Duplication introduced 2017-02-17 19:15 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...
141		$query = $this->dbc->prepare('
142		UPDATE `' . $this->getTableName() . '`
143		SET `directory_uuid` = ?
144		WHERE `ldap_dn` = ?
145		');
146
147		return $this->modify($query, [$uuid, $fdn]);
148		}
149
150		/**
151		* Gets the name based on the provided LDAP DN.
152		* @param string $fdn
153		* @return string\|false
154		*/
155		public function getNameByDN($fdn) {
156		return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
157		}
158
159		/**
160		* Searches mapped names by the giving string in the name column
161		* @param string $search
162		* @param string $prefixMatch
163		* @param string $postfixMatch
164		* @return string[]
165		*/
166		public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
167		$query = $this->dbc->prepare('
168		SELECT `owncloud_name`
169		FROM `'. $this->getTableName() .'`
170		WHERE `owncloud_name` LIKE ?
171		');
172
173		$res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch));
174		$names = array();
175		if($res !== false) {
176		while($row = $query->fetch()) {
177		$names[] = $row['owncloud_name'];
178		}
179		}
180		return $names;
181		}
182
183		/**
184		* Gets the name based on the provided LDAP UUID.
185		* @param string $uuid
186		* @return string\|false
187		*/
188		public function getNameByUUID($uuid) {
189		return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
190		}
191
192		/**
193		* Gets the UUID based on the provided LDAP DN
194		* @param string $dn
195		* @return false\|string
196		* @throws \Exception
197		*/
198		public function getUUIDByDN($dn) {
199		return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
200		}
201
202		/**
203		* gets a piece of the mapping list
204		* @param int $offset
205		* @param int $limit
206		* @return array
207		*/
208		public function getList($offset = null, $limit = null) {
209		$query = $this->dbc->prepare('
210		SELECT
211		`ldap_dn` AS `dn`,
212		`owncloud_name` AS `name`,
213		`directory_uuid` AS `uuid`
214		FROM `' . $this->getTableName() . '`',
215		$limit,
216		$offset
217		);
218
219		$query->execute();
220		return $query->fetchAll();
221		}
222
223		/**
224		* attempts to map the given entry
225		* @param string $fdn fully distinguished name (from LDAP)
226		* @param string $name
227		* @param string $uuid a unique identifier as used in LDAP
228		* @return bool
229		*/
230		public function map($fdn, $name, $uuid) {
231	View Code Duplication	if(mb_strlen($fdn) > 255) {
		0 ignored issues – show Duplication introduced 2017-01-25 16:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
232		\OC::$server->getLogger()->error(
233		'Cannot map, because the DN exceeds 255 characters: {dn}',
234		[
235		'app' => 'user_ldap',
236		'dn' => $fdn,
237		]
238		);
239		return false;
240		}
241
242		$row = array(
243		'ldap_dn' => $fdn,
244		'owncloud_name' => $name,
245		'directory_uuid' => $uuid
246		);
247
248		try {
249		$result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
250		// insertIfNotExist returns values as int
251		return (bool)$result;
252		} catch (\Exception $e) {
253		return false;
254		}
255		}
256
257		/**
258		* removes a mapping based on the owncloud_name of the entry
259		* @param string $name
260		* @return bool
261		*/
262	View Code Duplication	public function unmap($name) {
		0 ignored issues – show Duplication introduced 2016-06-09 12:21 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...
263		$query = $this->dbc->prepare('
264		DELETE FROM `'. $this->getTableName() .'`
265		WHERE `owncloud_name` = ?');
266
267		return $this->modify($query, array($name));
268		}
269
270		/**
271		* Truncate's the mapping table
272		* @return bool
273		*/
274		public function clear() {
275		$sql = $this->dbc
276		->getDatabasePlatform()
277		->getTruncateTableSQL('`' . $this->getTableName() . '`');
278		return $this->dbc->prepare($sql)->execute();
279		}
280		}
281

nextcloud / server

Push — master ( c20409...a4266f )

AbstractMapping::getTableName()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like