Manager::getUserObject() - Code Metrics - Inspection of "Merge pull request #1156 from nextcloud/stable9.1-..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — stable10 ( 167cea...deadbf )

by Roeland

created 2016-08-29 18:33 UTC

Manager::getUserObject() B

↳ Parent: Manager

Complexity

Conditions	6
Paths	9

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	6
eloc	13
c	1
b	1
f	0
nc	9
nop	3
dl	0
loc	21
rs	8.7624

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Arthur Schiwon <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Jörn Friedrich Dreyer <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Michael U <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Vincent Chan <[email protected]>
 * @author Volkan Gezer <[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 OC\User;

use OC\Hooks\PublicEmitter;
use OCP\IUser;
use OCP\IUserBackend;
use OCP\IUserManager;
use OCP\IConfig;

/**
 * Class Manager
 *
 * Hooks available in scope \OC\User:
 * - preSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
 * - postSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
 * - preDelete(\OC\User\User $user)
 * - postDelete(\OC\User\User $user)
 * - preCreateUser(string $uid, string $password)
 * - postCreateUser(\OC\User\User $user, string $password)
 * - change(\OC\User\User $user)
 *
 * @package OC\User
 */
class Manager extends PublicEmitter implements IUserManager {
	/**
	 * @var \OCP\UserInterface[] $backends
	 */
	private $backends = array();

	/**
	 * @var \OC\User\User[] $cachedUsers
	 */
	private $cachedUsers = array();

	/**
	 * @var \OCP\IConfig $config
	 */
	private $config;

	/**
	 * @param \OCP\IConfig $config
	 */
	public function __construct(IConfig $config = null) {
		$this->config = $config;
		$cachedUsers = &$this->cachedUsers;
		$this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
			/** @var \OC\User\User $user */
			unset($cachedUsers[$user->getUID()]);
		});
		$this->listen('\OC\User', 'postLogin', function ($user) {
			/** @var \OC\User\User $user */
			$user->updateLastLoginTimestamp();
		});
		$this->listen('\OC\User', 'postRememberedLogin', function ($user) {
			/** @var \OC\User\User $user */
			$user->updateLastLoginTimestamp();
		});
	}

	/**
	 * Get the active backends
	 * @return \OCP\UserInterface[]
	 */
	public function getBackends() {
		return $this->backends;
	}

	/**
	 * register a user backend
	 *
	 * @param \OCP\UserInterface $backend
	 */
	public function registerBackend($backend) {
		$this->backends[] = $backend;
	}

	/**
	 * remove a user backend
	 *
	 * @param \OCP\UserInterface $backend
	 */
	public function removeBackend($backend) {
		$this->cachedUsers = array();
		if (($i = array_search($backend, $this->backends)) !== false) {
			unset($this->backends[$i]);
		}
	}

	/**
	 * remove all user backends
	 */
	public function clearBackends() {
		$this->cachedUsers = array();
		$this->backends = array();
	}

	/**
	 * get a user by user id
	 *
	 * @param string $uid
	 * @return \OC\User\User|null Either the user or null if the specified user does not exist
	 */
	public function get($uid) {
		if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
			return $this->cachedUsers[$uid];
		}
		foreach ($this->backends as $backend) {
			if ($backend->userExists($uid)) {
				return $this->getUserObject($uid, $backend);
			}
		}
		return null;
	}

	/**
	 * get or construct the user object
	 *
	 * @param string $uid
	 * @param \OCP\UserInterface $backend
	 * @param bool $cacheUser If false the newly created user object will not be cached
	 * @return \OC\User\User
	 */
	protected function getUserObject($uid, $backend, $cacheUser = true) {
		if (isset($this->cachedUsers[$uid])) {
			return $this->cachedUsers[$uid];
		}

		if (method_exists($backend, 'loginName2UserName')) {
			$loginName = $backend->loginName2UserName($uid);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
			if ($loginName !== false) {
				$uid = $loginName;
			}
			if (isset($this->cachedUsers[$uid])) {
				return $this->cachedUsers[$uid];
			}
		}

		$user = new User($uid, $backend, $this, $this->config);
		if ($cacheUser) {
			$this->cachedUsers[$uid] = $user;
		}
		return $user;
	}

	/**
	 * check if a user exists
	 *
	 * @param string $uid
	 * @return bool
	 */
	public function userExists($uid) {
		$user = $this->get($uid);
		return ($user !== null);
	}

	/**
	 * Check if the password is valid for the user
	 *
	 * @param string $loginName
	 * @param string $password
	 * @return mixed the User object on success, false otherwise
	 */
	public function checkPassword($loginName, $password) {
		$loginName = str_replace("\0", '', $loginName);
		$password = str_replace("\0", '', $password);
		
		foreach ($this->backends as $backend) {
			if ($backend->implementsActions(\OC\User\Backend::CHECK_PASSWORD)) {
				$uid = $backend->checkPassword($loginName, $password);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				if ($uid !== false) {
					return $this->getUserObject($uid, $backend);
				}
			}
		}

		\OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
		return false;
	}

	/**
	 * search by user id
	 *
	 * @param string $pattern
	 * @param int $limit
	 * @param int $offset
	 * @return \OC\User\User[]
	 */
	public function search($pattern, $limit = null, $offset = null) {

		$users = array();
		foreach ($this->backends as $backend) {
			$backendUsers = $backend->getUsers($pattern, $limit, $offset);
			if (is_array($backendUsers)) {
				foreach ($backendUsers as $uid) {
					$users[$uid] = $this->getUserObject($uid, $backend);
				}
			}
		}

		uasort($users, function ($a, $b) {
			/**
			 * @var \OC\User\User $a
			 * @var \OC\User\User $b
			 */
			return strcmp($a->getUID(), $b->getUID());
		});
		return $users;
	}

	/**
	 * search by displayName
	 *
	 * @param string $pattern
	 * @param int $limit
	 * @param int $offset
	 * @return \OC\User\User[]
	 */
	public function searchDisplayName($pattern, $limit = null, $offset = null) {

		$users = array();
		foreach ($this->backends as $backend) {
			$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
			if (is_array($backendUsers)) {
				foreach ($backendUsers as $uid => $displayName) {
					$users[] = $this->getUserObject($uid, $backend);
				}
			}
		}

		usort($users, function ($a, $b) {
			/**
			 * @var \OC\User\User $a
			 * @var \OC\User\User $b
			 */
			return strcmp($a->getDisplayName(), $b->getDisplayName());
		});
		return $users;
	}

	/**
	 * @param string $uid
	 * @param string $password
	 * @throws \Exception
	 * @return bool|\OC\User\User the created user or false
	 */
	public function createUser($uid, $password) {
		$l = \OC::$server->getL10N('lib');
		// Check the name for bad characters
		// Allowed are: "a-z", "A-Z", "0-9" and "_.@-'"
		if (preg_match('/[^a-zA-Z0-9 _\.@\-\']/', $uid)) {
			throw new \Exception($l->t('Only the following characters are allowed in a username:'
				. ' "a-z", "A-Z", "0-9", and "_.@-\'"'));
		}
		// No empty username
		if (trim($uid) == '') {
			throw new \Exception($l->t('A valid username must be provided'));
		}
		// No whitespace at the beginning or at the end
		if (strlen(trim($uid, "\t\n\r\0\x0B\xe2\x80\x8b")) !== strlen(trim($uid))) {
			throw new \Exception($l->t('Username contains whitespace at the beginning or at the end'));
		}
		// No empty password
		if (trim($password) == '') {
			throw new \Exception($l->t('A valid password must be provided'));
		}

		// Check if user already exists
		if ($this->userExists($uid)) {
			throw new \Exception($l->t('The username is already being used'));
		}

		$this->emit('\OC\User', 'preCreateUser', array($uid, $password));
		foreach ($this->backends as $backend) {
			if ($backend->implementsActions(\OC\User\Backend::CREATE_USER)) {
				$backend->createUser($uid, $password);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				$user = $this->getUserObject($uid, $backend);
				$this->emit('\OC\User', 'postCreateUser', array($user, $password));
				return $user;
			}
		}
		return false;
	}

	/**
	 * returns how many users per backend exist (if supported by backend)
	 *
	 * @return array an array of backend class as key and count number as value
	 */
	public function countUsers() {
		$userCountStatistics = array();
		foreach ($this->backends as $backend) {
			if ($backend->implementsActions(\OC\User\Backend::COUNT_USERS)) {
				$backendUsers = $backend->countUsers();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				if($backendUsers !== false) {
					if($backend instanceof IUserBackend) {
						$name = $backend->getBackendName();
					} else {
						$name = get_class($backend);
					}
					if(isset($userCountStatistics[$name])) {
						$userCountStatistics[$name] += $backendUsers;
					} else {
						$userCountStatistics[$name] = $backendUsers;
					}
				}
			}
		}
		return $userCountStatistics;
	}

	/**
	 * The callback is executed for each user on each backend.
	 * If the callback returns false no further users will be retrieved.
	 *
	 * @param \Closure $callback
	 * @param string $search
	 * @since 9.0.0
	 */
	public function callForAllUsers(\Closure $callback, $search = '') {
		foreach($this->getBackends() as $backend) {
			$limit = 500;
			$offset = 0;
			do {
				$users = $backend->getUsers($search, $limit, $offset);
				foreach ($users as $uid) {
					if (!$backend->userExists($uid)) {
						continue;
					}
					$user = $this->getUserObject($uid, $backend, false);
					$return = $callback($user);
					if ($return === false) {
						break;
					}
				}
				$offset += $limit;
			} while (count($users) >= $limit);
		}
	}

	/**
	 * @param string $email
	 * @return IUser[]
	 * @since 9.1.0
	 */
	public function getByEmail($email) {
		$userIds = $this->config->getUsersForUserValue('settings', 'email', $email);

		return array_map(function($uid) {
			return $this->get($uid);
		}, $userIds);
	}
}


Push — stable10 ( 167cea...deadbf )

Manager::getUserObject() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Arthur Schiwon <[email protected]>
6		* @author Joas Schilling <[email protected]>
7		* @author Jörn Friedrich Dreyer <[email protected]>
8		* @author Lukas Reschke <[email protected]>
9		* @author Michael U <[email protected]>
10		* @author Morris Jobke <[email protected]>
11		* @author Robin Appelman <[email protected]>
12		* @author Robin McCorkell <[email protected]>
13		* @author Roeland Jago Douma <[email protected]>
14		* @author Thomas Müller <[email protected]>
15		* @author Vincent Chan <[email protected]>
16		* @author Volkan Gezer <[email protected]>
17		*
18		* @license AGPL-3.0
19		*
20		* This code is free software: you can redistribute it and/or modify
21		* it under the terms of the GNU Affero General Public License, version 3,
22		* as published by the Free Software Foundation.
23		*
24		* This program is distributed in the hope that it will be useful,
25		* but WITHOUT ANY WARRANTY; without even the implied warranty of
26		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27		* GNU Affero General Public License for more details.
28		*
29		* You should have received a copy of the GNU Affero General Public License, version 3,
30		* along with this program. If not, see <http://www.gnu.org/licenses/>
31		*
32		*/
33
34		namespace OC\User;
35
36		use OC\Hooks\PublicEmitter;
37		use OCP\IUser;
38		use OCP\IUserBackend;
39		use OCP\IUserManager;
40		use OCP\IConfig;
41
42		/**
43		* Class Manager
44		*
45		* Hooks available in scope \OC\User:
46		* - preSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
47		* - postSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
48		* - preDelete(\OC\User\User $user)
49		* - postDelete(\OC\User\User $user)
50		* - preCreateUser(string $uid, string $password)
51		* - postCreateUser(\OC\User\User $user, string $password)
52		* - change(\OC\User\User $user)
53		*
54		* @package OC\User
55		*/
56		class Manager extends PublicEmitter implements IUserManager {
57		/**
58		* @var \OCP\UserInterface[] $backends
59		*/
60		private $backends = array();
61
62		/**
63		* @var \OC\User\User[] $cachedUsers
64		*/
65		private $cachedUsers = array();
66
67		/**
68		* @var \OCP\IConfig $config
69		*/
70		private $config;
71
72		/**
73		* @param \OCP\IConfig $config
74		*/
75		public function __construct(IConfig $config = null) {
76		$this->config = $config;
77		$cachedUsers = &$this->cachedUsers;
78		$this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
79		/** @var \OC\User\User $user */
80		unset($cachedUsers[$user->getUID()]);
81		});
82		$this->listen('\OC\User', 'postLogin', function ($user) {
83		/** @var \OC\User\User $user */
84		$user->updateLastLoginTimestamp();
85		});
86		$this->listen('\OC\User', 'postRememberedLogin', function ($user) {
87		/** @var \OC\User\User $user */
88		$user->updateLastLoginTimestamp();
89		});
90		}
91
92		/**
93		* Get the active backends
94		* @return \OCP\UserInterface[]
95		*/
96		public function getBackends() {
97		return $this->backends;
98		}
99
100		/**
101		* register a user backend
102		*
103		* @param \OCP\UserInterface $backend
104		*/
105		public function registerBackend($backend) {
106		$this->backends[] = $backend;
107		}
108
109		/**
110		* remove a user backend
111		*
112		* @param \OCP\UserInterface $backend
113		*/
114		public function removeBackend($backend) {
115		$this->cachedUsers = array();
116		if (($i = array_search($backend, $this->backends)) !== false) {
117		unset($this->backends[$i]);
118		}
119		}
120
121		/**
122		* remove all user backends
123		*/
124		public function clearBackends() {
125		$this->cachedUsers = array();
126		$this->backends = array();
127		}
128
129		/**
130		* get a user by user id
131		*
132		* @param string $uid
133		* @return \OC\User\User\|null Either the user or null if the specified user does not exist
134		*/
135		public function get($uid) {
136		if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
137		return $this->cachedUsers[$uid];
138		}
139		foreach ($this->backends as $backend) {
140		if ($backend->userExists($uid)) {
141		return $this->getUserObject($uid, $backend);
142		}
143		}
144		return null;
145		}
146
147		/**
148		* get or construct the user object
149		*
150		* @param string $uid
151		* @param \OCP\UserInterface $backend
152		* @param bool $cacheUser If false the newly created user object will not be cached
153		* @return \OC\User\User
154		*/
155		protected function getUserObject($uid, $backend, $cacheUser = true) {
156		if (isset($this->cachedUsers[$uid])) {
157		return $this->cachedUsers[$uid];
158		}
159
160		if (method_exists($backend, 'loginName2UserName')) {
161		$loginName = $backend->loginName2UserName($uid);
		0 ignored issues – show Bug introduced 2016-08-29 15:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OCP\UserInterface` as the method `loginName2UserName()` does only exist in the following implementations of said interface: `OCA\User_LDAP\User_LDAP`, `OCA\User_LDAP\User_Proxy`, `OC\User\Database`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
162		if ($loginName !== false) {
163		$uid = $loginName;
164		}
165		if (isset($this->cachedUsers[$uid])) {
166		return $this->cachedUsers[$uid];
167		}
168		}
169
170		$user = new User($uid, $backend, $this, $this->config);
171		if ($cacheUser) {
172		$this->cachedUsers[$uid] = $user;
173		}
174		return $user;
175		}
176
177		/**
178		* check if a user exists
179		*
180		* @param string $uid
181		* @return bool
182		*/
183		public function userExists($uid) {
184		$user = $this->get($uid);
185		return ($user !== null);
186		}
187
188		/**
189		* Check if the password is valid for the user
190		*
191		* @param string $loginName
192		* @param string $password
193		* @return mixed the User object on success, false otherwise
194		*/
195		public function checkPassword($loginName, $password) {
196		$loginName = str_replace("\0", '', $loginName);
197		$password = str_replace("\0", '', $password);
198
199		foreach ($this->backends as $backend) {
200		if ($backend->implementsActions(\OC\User\Backend::CHECK_PASSWORD)) {
201		$uid = $backend->checkPassword($loginName, $password);
		0 ignored issues – show Bug introduced 2016-06-09 12:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OCP\UserInterface` as the method `checkPassword()` does only exist in the following implementations of said interface: `OCA\User_LDAP\User_LDAP`, `OCA\User_LDAP\User_Proxy`, `OC\User\Database`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
202		if ($uid !== false) {
203		return $this->getUserObject($uid, $backend);
204		}
205		}
206		}
207
208		\OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
209		return false;
210		}
211
212		/**
213		* search by user id
214		*
215		* @param string $pattern
216		* @param int $limit
217		* @param int $offset
218		* @return \OC\User\User[]
219		*/
220	View Code Duplication	public function search($pattern, $limit = null, $offset = null) {
		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...
221		$users = array();
222		foreach ($this->backends as $backend) {
223		$backendUsers = $backend->getUsers($pattern, $limit, $offset);
224		if (is_array($backendUsers)) {
225		foreach ($backendUsers as $uid) {
226		$users[$uid] = $this->getUserObject($uid, $backend);
227		}
228		}
229		}
230
231		uasort($users, function ($a, $b) {
232		/**
233		* @var \OC\User\User $a
234		* @var \OC\User\User $b
235		*/
236		return strcmp($a->getUID(), $b->getUID());
237		});
238		return $users;
239		}
240
241		/**
242		* search by displayName
243		*
244		* @param string $pattern
245		* @param int $limit
246		* @param int $offset
247		* @return \OC\User\User[]
248		*/
249	View Code Duplication	public function searchDisplayName($pattern, $limit = null, $offset = null) {
		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...
250		$users = array();
251		foreach ($this->backends as $backend) {
252		$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
253		if (is_array($backendUsers)) {
254		foreach ($backendUsers as $uid => $displayName) {
255		$users[] = $this->getUserObject($uid, $backend);
256		}
257		}
258		}
259
260		usort($users, function ($a, $b) {
261		/**
262		* @var \OC\User\User $a
263		* @var \OC\User\User $b
264		*/
265		return strcmp($a->getDisplayName(), $b->getDisplayName());
266		});
267		return $users;
268		}
269
270		/**
271		* @param string $uid
272		* @param string $password
273		* @throws \Exception
274		* @return bool\|\OC\User\User the created user or false
275		*/
276		public function createUser($uid, $password) {
277		$l = \OC::$server->getL10N('lib');
278		// Check the name for bad characters
279		// Allowed are: "a-z", "A-Z", "0-9" and "_.@-'"
280		if (preg_match('/[^a-zA-Z0-9 _\.@\-\']/', $uid)) {
281		throw new \Exception($l->t('Only the following characters are allowed in a username:'
282		. ' "a-z", "A-Z", "0-9", and "_.@-\'"'));
283		}
284		// No empty username
285		if (trim($uid) == '') {
286		throw new \Exception($l->t('A valid username must be provided'));
287		}
288		// No whitespace at the beginning or at the end
289		if (strlen(trim($uid, "\t\n\r\0\x0B\xe2\x80\x8b")) !== strlen(trim($uid))) {
290		throw new \Exception($l->t('Username contains whitespace at the beginning or at the end'));
291		}
292		// No empty password
293		if (trim($password) == '') {
294		throw new \Exception($l->t('A valid password must be provided'));
295		}
296
297		// Check if user already exists
298		if ($this->userExists($uid)) {
299		throw new \Exception($l->t('The username is already being used'));
300		}
301
302		$this->emit('\OC\User', 'preCreateUser', array($uid, $password));
303		foreach ($this->backends as $backend) {
304		if ($backend->implementsActions(\OC\User\Backend::CREATE_USER)) {
305		$backend->createUser($uid, $password);
		0 ignored issues – show Bug introduced 2016-06-09 12:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OCP\UserInterface` as the method `createUser()` does only exist in the following implementations of said interface: `OC\User\Database`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
306		$user = $this->getUserObject($uid, $backend);
307		$this->emit('\OC\User', 'postCreateUser', array($user, $password));
308		return $user;
309		}
310		}
311		return false;
312		}
313
314		/**
315		* returns how many users per backend exist (if supported by backend)
316		*
317		* @return array an array of backend class as key and count number as value
318		*/
319		public function countUsers() {
320		$userCountStatistics = array();
321		foreach ($this->backends as $backend) {
322		if ($backend->implementsActions(\OC\User\Backend::COUNT_USERS)) {
323		$backendUsers = $backend->countUsers();
		0 ignored issues – show Bug introduced 2016-06-09 12:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OCP\UserInterface` as the method `countUsers()` does only exist in the following implementations of said interface: `OCA\User_LDAP\User_LDAP`, `OCA\User_LDAP\User_Proxy`, `OC\User\Database`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
324		if($backendUsers !== false) {
325		if($backend instanceof IUserBackend) {
326		$name = $backend->getBackendName();
327		} else {
328		$name = get_class($backend);
329		}
330		if(isset($userCountStatistics[$name])) {
331		$userCountStatistics[$name] += $backendUsers;
332		} else {
333		$userCountStatistics[$name] = $backendUsers;
334		}
335		}
336		}
337		}
338		return $userCountStatistics;
339		}
340
341		/**
342		* The callback is executed for each user on each backend.
343		* If the callback returns false no further users will be retrieved.
344		*
345		* @param \Closure $callback
346		* @param string $search
347		* @since 9.0.0
348		*/
349		public function callForAllUsers(\Closure $callback, $search = '') {
350		foreach($this->getBackends() as $backend) {
351		$limit = 500;
352		$offset = 0;
353		do {
354		$users = $backend->getUsers($search, $limit, $offset);
355		foreach ($users as $uid) {
356		if (!$backend->userExists($uid)) {
357		continue;
358		}
359		$user = $this->getUserObject($uid, $backend, false);
360		$return = $callback($user);
361		if ($return === false) {
362		break;
363		}
364		}
365		$offset += $limit;
366		} while (count($users) >= $limit);
367		}
368		}
369
370		/**
371		* @param string $email
372		* @return IUser[]
373		* @since 9.1.0
374		*/
375		public function getByEmail($email) {
376		$userIds = $this->config->getUsersForUserValue('settings', 'email', $email);
377
378		return array_map(function($uid) {
379		return $this->get($uid);
380		}, $userIds);
381		}
382		}
383

nextcloud / server

Push — stable10 ( 167cea...deadbf )

Manager::getUserObject() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like