Move \OC\User to PSR-4

1 files changed, 371 insertions, 0 deletions

diff --git a/lib/private/User/Manager.php b/lib/private/User/Manager.php
new file mode 100644
index 00000000000..37a3e5ba134
--- /dev/null
+++ b/lib/private/User/Manager.php
@@ -0,0 +1,371 @@
+<?php
+/**
+ * @author Arthur Schiwon <blizzz@owncloud.com>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Michael U <mdusher@users.noreply.github.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author RealRancor <Fisch.666@gmx.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Vincent Chan <plus.vincchan@gmail.com>
+ * @author Volkan Gezer <volkangezer@gmail.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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];
+		}
+
+		$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);
+				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);
+				$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();
+				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);
+	}
+}