New user management classes

1 files changed, 189 insertions, 0 deletions

diff --git a/lib/user/manager.php b/lib/user/manager.php
new file mode 100644
index 00000000000..25e67ca36b5
--- /dev/null
+++ b/lib/user/manager.php
@@ -0,0 +1,189 @@
+<?php
+
+/**
+ * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OC\User;
+
+use OC\Hooks\PublicEmitter;
+
+/**
+ * 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)
+ *
+ * @package OC\User
+ */
+class Manager extends PublicEmitter {
+	/**
+	 * @var \OC_User_Backend[] $backends
+	 */
+	private $backends = array();
+
+	/**
+	 * @param \OC_User_Backend $backend
+	 */
+	public function registerBackend($backend) {
+		$this->backends[] = $backend;
+	}
+
+	/**
+	 * @param \OC_User_Backend $backend
+	 */
+	public function removeBackend($backend) {
+		if (($i = array_search($backend, $this->backends)) !== false) {
+			unset($this->backends[$i]);
+		}
+	}
+
+	public function clearBackends() {
+		$this->backends = array();
+	}
+
+	/**
+	 * @param string $uid
+	 * @return \OC\User\User
+	 */
+	public function get($uid) {
+		foreach ($this->backends as $backend) {
+			if ($backend->userExists($uid)) {
+				return new User($uid, $backend);
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * @param string $uid
+	 * @return bool
+	 */
+	public function userExists($uid) {
+		foreach ($this->backends as $backend) {
+			if ($backend->userExists($uid)) {
+				return true;
+			}
+		}
+		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[] = new User($uid, $backend);
+					if (!is_null($limit)) {
+						$limit--;
+					}
+					if (!is_null($offset) and $offset > 0) {
+						$offset--;
+					}
+
+				}
+			}
+		}
+
+		usort($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[] = new User($uid, $backend);
+					if (!is_null($limit)) {
+						$limit--;
+					}
+					if (!is_null($offset) and $offset > 0) {
+						$offset--;
+					}
+
+				}
+			}
+		}
+
+		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 of false
+	 */
+	public function createUser($uid, $password) {
+		// 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('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('A valid username must be provided');
+		}
+		// No empty password
+		if (trim($password) == '') {
+			throw new \Exception('A valid password must be provided');
+		}
+
+		// Check if user already exists
+		if ($this->userExists($uid)) {
+			throw new \Exception('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 = new User($uid, $backend);
+				$this->emit('\OC\User', 'postCreateUser', array($user));
+				return $user;
+			}
+		}
+		return false;
+	}
+}