nextcloud / server

apps/user_ldap/lib/LDAPProvider.php

Indentation +138 added lines, -138 removed lines

@@ -33,155 +33,155 @@
  */
 class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
 
-	private $backend;
-	private $logger;
-	private $helper;
-	private $deletedUsersIndex;
+    private $backend;
+    private $logger;
+    private $helper;
+    private $deletedUsersIndex;
 	
-	/**
-	 * Create new LDAPProvider
-	 * @param \OCP\IServerContainer $serverContainer
-	 * @throws \Exception if user_ldap app was not enabled
-	 */
-	public function __construct(IServerContainer $serverContainer, Helper $helper, DeletedUsersIndex $deletedUsersIndex) {
-		$this->logger = $serverContainer->getLogger();
-		$this->helper = $helper;
-		$this->deletedUsersIndex = $deletedUsersIndex;
-		foreach ($serverContainer->getUserManager()->getBackends() as $backend){
-			$this->logger->debug('instance '.get_class($backend).' backend.', ['app' => 'user_ldap']);
-			if ($backend instanceof IUserLDAP) {
-				$this->backend = $backend;
-				return;
-			}
+    /**
+     * Create new LDAPProvider
+     * @param \OCP\IServerContainer $serverContainer
+     * @throws \Exception if user_ldap app was not enabled
+     */
+    public function __construct(IServerContainer $serverContainer, Helper $helper, DeletedUsersIndex $deletedUsersIndex) {
+        $this->logger = $serverContainer->getLogger();
+        $this->helper = $helper;
+        $this->deletedUsersIndex = $deletedUsersIndex;
+        foreach ($serverContainer->getUserManager()->getBackends() as $backend){
+            $this->logger->debug('instance '.get_class($backend).' backend.', ['app' => 'user_ldap']);
+            if ($backend instanceof IUserLDAP) {
+                $this->backend = $backend;
+                return;
+            }
         }
-		throw new \Exception('To use the LDAPProvider, user_ldap app must be enabled');
-	}
+        throw new \Exception('To use the LDAPProvider, user_ldap app must be enabled');
+    }
 	
-	/**
-	 * Translate an user id to LDAP DN
-	 * @param string $uid user id
-	 * @return string with the LDAP DN
-	 * @throws \Exception if translation was unsuccessful
-	 */
-	public function getUserDN($uid) {
-		if(!$this->backend->userExists($uid)){
-			throw new \Exception('User id not found in LDAP');
-		}
-		$result = $this->backend->getLDAPAccess($uid)->username2dn($uid);
-		if(!$result){
-			throw new \Exception('Translation to LDAP DN unsuccessful');
-		}
-		return $result;
-	}
+    /**
+     * Translate an user id to LDAP DN
+     * @param string $uid user id
+     * @return string with the LDAP DN
+     * @throws \Exception if translation was unsuccessful
+     */
+    public function getUserDN($uid) {
+        if(!$this->backend->userExists($uid)){
+            throw new \Exception('User id not found in LDAP');
+        }
+        $result = $this->backend->getLDAPAccess($uid)->username2dn($uid);
+        if(!$result){
+            throw new \Exception('Translation to LDAP DN unsuccessful');
+        }
+        return $result;
+    }
 	
-	/**
-	 * Translate a LDAP DN to an internal user name. If there is no mapping between 
-	 * the DN and the user name, a new one will be created.
-	 * @param string $dn LDAP DN
-	 * @return string with the internal user name
-	 * @throws \Exception if translation was unsuccessful
-	 */
-	public function getUserName($dn) {
-		$result = $this->backend->dn2UserName($dn);
-		if(!$result){
-			throw new \Exception('Translation to internal user name unsuccessful');
-		}
-		return $result;
-	}
+    /**
+     * Translate a LDAP DN to an internal user name. If there is no mapping between 
+     * the DN and the user name, a new one will be created.
+     * @param string $dn LDAP DN
+     * @return string with the internal user name
+     * @throws \Exception if translation was unsuccessful
+     */
+    public function getUserName($dn) {
+        $result = $this->backend->dn2UserName($dn);
+        if(!$result){
+            throw new \Exception('Translation to internal user name unsuccessful');
+        }
+        return $result;
+    }
 	
-	/**
-	 * Convert a stored DN so it can be used as base parameter for LDAP queries.
-	 * @param string $dn the DN in question
-	 * @return string
-	 */
-	public function DNasBaseParameter($dn) {
-		return $this->helper->DNasBaseParameter($dn);
-	}
+    /**
+     * Convert a stored DN so it can be used as base parameter for LDAP queries.
+     * @param string $dn the DN in question
+     * @return string
+     */
+    public function DNasBaseParameter($dn) {
+        return $this->helper->DNasBaseParameter($dn);
+    }
 	
-	/**
-	 * Sanitize a DN received from the LDAP server.
-	 * @param array $dn the DN in question
-	 * @return array the sanitized DN
-	 */
-	public function sanitizeDN($dn) {
-		return $this->helper->sanitizeDN($dn);
-	}
+    /**
+     * Sanitize a DN received from the LDAP server.
+     * @param array $dn the DN in question
+     * @return array the sanitized DN
+     */
+    public function sanitizeDN($dn) {
+        return $this->helper->sanitizeDN($dn);
+    }
 	
-	/**
-	 * Return a new LDAP connection resource for the specified user. 
-	 * The connection must be closed manually.
-	 * @param string $uid user id
-	 * @return resource of the LDAP connection
-	 * @throws \Exception if user id was not found in LDAP
-	 */
-	public function getLDAPConnection($uid) {
-		if(!$this->backend->userExists($uid)){
-			throw new \Exception('User id not found in LDAP');
-		}
-		return $this->backend->getNewLDAPConnection($uid);
-	}
+    /**
+     * Return a new LDAP connection resource for the specified user. 
+     * The connection must be closed manually.
+     * @param string $uid user id
+     * @return resource of the LDAP connection
+     * @throws \Exception if user id was not found in LDAP
+     */
+    public function getLDAPConnection($uid) {
+        if(!$this->backend->userExists($uid)){
+            throw new \Exception('User id not found in LDAP');
+        }
+        return $this->backend->getNewLDAPConnection($uid);
+    }
 	
-	/**
-	 * Get the LDAP base for users.
-	 * @param string $uid user id
-	 * @return string the base for users
-	 * @throws \Exception if user id was not found in LDAP
-	 */
-	public function getLDAPBaseUsers($uid) {
-		if(!$this->backend->userExists($uid)){
-			throw new \Exception('User id not found in LDAP');
-		}	
-		return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_users'];
-	}
+    /**
+     * Get the LDAP base for users.
+     * @param string $uid user id
+     * @return string the base for users
+     * @throws \Exception if user id was not found in LDAP
+     */
+    public function getLDAPBaseUsers($uid) {
+        if(!$this->backend->userExists($uid)){
+            throw new \Exception('User id not found in LDAP');
+        }	
+        return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_users'];
+    }
 	
-	/**
-	 * Get the LDAP base for groups.
-	 * @param string $uid user id
-	 * @return string the base for groups
-	 * @throws \Exception if user id was not found in LDAP
-	 */
-	public function getLDAPBaseGroups($uid) {
-		if(!$this->backend->userExists($uid)){
-			throw new \Exception('User id not found in LDAP');
-		}
-		return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_groups'];
-	}
+    /**
+     * Get the LDAP base for groups.
+     * @param string $uid user id
+     * @return string the base for groups
+     * @throws \Exception if user id was not found in LDAP
+     */
+    public function getLDAPBaseGroups($uid) {
+        if(!$this->backend->userExists($uid)){
+            throw new \Exception('User id not found in LDAP');
+        }
+        return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_groups'];
+    }
 	
-	/**
-	 * Clear the cache if a cache is used, otherwise do nothing.
-	 * @param string $uid user id
-	 * @throws \Exception if user id was not found in LDAP
-	 */
-	public function clearCache($uid) {
-		if(!$this->backend->userExists($uid)){
-			throw new \Exception('User id not found in LDAP');
-		}
-		$this->backend->getLDAPAccess($uid)->getConnection()->clearCache();
-	}
+    /**
+     * Clear the cache if a cache is used, otherwise do nothing.
+     * @param string $uid user id
+     * @throws \Exception if user id was not found in LDAP
+     */
+    public function clearCache($uid) {
+        if(!$this->backend->userExists($uid)){
+            throw new \Exception('User id not found in LDAP');
+        }
+        $this->backend->getLDAPAccess($uid)->getConnection()->clearCache();
+    }
 	
-	/**
-	 * Check whether a LDAP DN exists
-	 * @param string $dn LDAP DN
-	 * @return bool whether the DN exists
-	 */
-	public function dnExists($dn) {
-		$result = $this->backend->dn2UserName($dn);
-		return !$result ? false : true;
-	}
+    /**
+     * Check whether a LDAP DN exists
+     * @param string $dn LDAP DN
+     * @return bool whether the DN exists
+     */
+    public function dnExists($dn) {
+        $result = $this->backend->dn2UserName($dn);
+        return !$result ? false : true;
+    }
 	
-	/**
-	 * Flag record for deletion.
-	 * @param string $uid user id
-	 */
-	public function flagRecord($uid) {
-		$this->deletedUsersIndex->markUser($uid);
-	}
+    /**
+     * Flag record for deletion.
+     * @param string $uid user id
+     */
+    public function flagRecord($uid) {
+        $this->deletedUsersIndex->markUser($uid);
+    }
 	
-	/**
-	 * Unflag record for deletion.
-	 * @param string $uid user id
-	 */
-	public function unflagRecord($uid) {
-		//do nothing
-	}
+    /**
+     * Unflag record for deletion.
+     * @param string $uid user id
+     */
+    public function unflagRecord($uid) {
+        //do nothing
+    }
 }

apps/user_ldap/lib/User_LDAP.php

Indentation +485 added lines, -485 removed lines

@@ -44,492 +44,492 @@
 use OCP\Util;
 
 class User_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP {
-	/** @var string[] $homesToKill */
-	protected $homesToKill = array();
-
-	/** @var \OCP\IConfig */
-	protected $ocConfig;
-
-	/**
-	 * @param Access $access
-	 * @param \OCP\IConfig $ocConfig
-	 */
-	public function __construct(Access $access, IConfig $ocConfig) {
-		parent::__construct($access);
-		$this->ocConfig = $ocConfig;
-	}
-
-	/**
-	 * checks whether the user is allowed to change his avatar in ownCloud
-	 * @param string $uid the ownCloud user name
-	 * @return boolean either the user can or cannot
-	 */
-	public function canChangeAvatar($uid) {
-		$user = $this->access->userManager->get($uid);
-		if(!$user instanceof User) {
-			return false;
-		}
-		if($user->getAvatarImage() === false) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * returns the username for the given login name, if available
-	 *
-	 * @param string $loginName
-	 * @return string|false
-	 */
-	public function loginName2UserName($loginName) {
-		$cacheKey = 'loginName2UserName-'.$loginName;
-		$username = $this->access->connection->getFromCache($cacheKey);
-		if(!is_null($username)) {
-			return $username;
-		}
-
-		try {
-			$ldapRecord = $this->getLDAPUserByLoginName($loginName);
-			$user = $this->access->userManager->get($ldapRecord['dn'][0]);
-			if($user instanceof OfflineUser) {
-				// this path is not really possible, however get() is documented
-				// to return User or OfflineUser so we are very defensive here.
-				$this->access->connection->writeToCache($cacheKey, false);
-				return false;
-			}
-			$username = $user->getUsername();
-			$this->access->connection->writeToCache($cacheKey, $username);
-			return $username;
-		} catch (NotOnLDAP $e) {
-			$this->access->connection->writeToCache($cacheKey, false);
-			return false;
-		}
-	}
+    /** @var string[] $homesToKill */
+    protected $homesToKill = array();
+
+    /** @var \OCP\IConfig */
+    protected $ocConfig;
+
+    /**
+     * @param Access $access
+     * @param \OCP\IConfig $ocConfig
+     */
+    public function __construct(Access $access, IConfig $ocConfig) {
+        parent::__construct($access);
+        $this->ocConfig = $ocConfig;
+    }
+
+    /**
+     * checks whether the user is allowed to change his avatar in ownCloud
+     * @param string $uid the ownCloud user name
+     * @return boolean either the user can or cannot
+     */
+    public function canChangeAvatar($uid) {
+        $user = $this->access->userManager->get($uid);
+        if(!$user instanceof User) {
+            return false;
+        }
+        if($user->getAvatarImage() === false) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * returns the username for the given login name, if available
+     *
+     * @param string $loginName
+     * @return string|false
+     */
+    public function loginName2UserName($loginName) {
+        $cacheKey = 'loginName2UserName-'.$loginName;
+        $username = $this->access->connection->getFromCache($cacheKey);
+        if(!is_null($username)) {
+            return $username;
+        }
+
+        try {
+            $ldapRecord = $this->getLDAPUserByLoginName($loginName);
+            $user = $this->access->userManager->get($ldapRecord['dn'][0]);
+            if($user instanceof OfflineUser) {
+                // this path is not really possible, however get() is documented
+                // to return User or OfflineUser so we are very defensive here.
+                $this->access->connection->writeToCache($cacheKey, false);
+                return false;
+            }
+            $username = $user->getUsername();
+            $this->access->connection->writeToCache($cacheKey, $username);
+            return $username;
+        } catch (NotOnLDAP $e) {
+            $this->access->connection->writeToCache($cacheKey, false);
+            return false;
+        }
+    }
 	
-	/**
-	 * returns the username for the given LDAP DN, if available
-	 *
-	 * @param string $dn
-	 * @return string|false with the username
-	 */
-	public function dn2UserName($dn) {
-		return $this->access->dn2username($dn);
-	}
-
-	/**
-	 * returns an LDAP record based on a given login name
-	 *
-	 * @param string $loginName
-	 * @return array
-	 * @throws NotOnLDAP
-	 */
-	public function getLDAPUserByLoginName($loginName) {
-		//find out dn of the user name
-		$attrs = $this->access->userManager->getAttributes();
-		$users = $this->access->fetchUsersByLoginName($loginName, $attrs);
-		if(count($users) < 1) {
-			throw new NotOnLDAP('No user available for the given login name on ' .
-				$this->access->connection->ldapHost . ':' . $this->access->connection->ldapPort);
-		}
-		return $users[0];
-	}
-
-	/**
-	 * Check if the password is correct without logging in the user
-	 *
-	 * @param string $uid The username
-	 * @param string $password The password
-	 * @return false|string
-	 */
-	public function checkPassword($uid, $password) {
-		try {
-			$ldapRecord = $this->getLDAPUserByLoginName($uid);
-		} catch(NotOnLDAP $e) {
-			if($this->ocConfig->getSystemValue('loglevel', Util::WARN) === Util::DEBUG) {
-				\OC::$server->getLogger()->logException($e, ['app' => 'user_ldap']);
-			}
-			return false;
-		}
-		$dn = $ldapRecord['dn'][0];
-		$user = $this->access->userManager->get($dn);
-
-		if(!$user instanceof User) {
-			Util::writeLog('user_ldap',
-				'LDAP Login: Could not get user object for DN ' . $dn .
-				'. Maybe the LDAP entry has no set display name attribute?',
-				Util::WARN);
-			return false;
-		}
-		if($user->getUsername() !== false) {
-			//are the credentials OK?
-			if(!$this->access->areCredentialsValid($dn, $password)) {
-				return false;
-			}
-
-			$this->access->cacheUserExists($user->getUsername());
-			$user->processAttributes($ldapRecord);
-			$user->markLogin();
-
-			return $user->getUsername();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Set password
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @return bool
-	 */
-	public function setPassword($uid, $password) {
-		$user = $this->access->userManager->get($uid);
-
-		if(!$user instanceof User) {
-			throw new \Exception('LDAP setPassword: Could not get user object for uid ' . $uid .
-				'. Maybe the LDAP entry has no set display name attribute?');
-		}
-		if($user->getUsername() !== false) {
-			return $this->access->setPassword($user->getDN(), $password);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param integer $limit
-	 * @param integer $offset
-	 * @return string[] an array of all uids
-	 */
-	public function getUsers($search = '', $limit = 10, $offset = 0) {
-		$search = $this->access->escapeFilterPart($search, true);
-		$cachekey = 'getUsers-'.$search.'-'.$limit.'-'.$offset;
-
-		//check if users are cached, if so return
-		$ldap_users = $this->access->connection->getFromCache($cachekey);
-		if(!is_null($ldap_users)) {
-			return $ldap_users;
-		}
-
-		// if we'd pass -1 to LDAP search, we'd end up in a Protocol
-		// error. With a limit of 0, we get 0 results. So we pass null.
-		if($limit <= 0) {
-			$limit = null;
-		}
-		$filter = $this->access->combineFilterWithAnd(array(
-			$this->access->connection->ldapUserFilter,
-			$this->access->connection->ldapUserDisplayName . '=*',
-			$this->access->getFilterPartForUserSearch($search)
-		));
-
-		Util::writeLog('user_ldap',
-			'getUsers: Options: search '.$search.' limit '.$limit.' offset '.$offset.' Filter: '.$filter,
-			Util::DEBUG);
-		//do the search and translate results to owncloud names
-		$ldap_users = $this->access->fetchListOfUsers(
-			$filter,
-			$this->access->userManager->getAttributes(true),
-			$limit, $offset);
-		$ldap_users = $this->access->ownCloudUserNames($ldap_users);
-		Util::writeLog('user_ldap', 'getUsers: '.count($ldap_users). ' Users found', Util::DEBUG);
-
-		$this->access->connection->writeToCache($cachekey, $ldap_users);
-		return $ldap_users;
-	}
-
-	/**
-	 * checks whether a user is still available on LDAP
-	 *
-	 * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
-	 * name or an instance of that user
-	 * @return bool
-	 * @throws \Exception
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	public function userExistsOnLDAP($user) {
-		if(is_string($user)) {
-			$user = $this->access->userManager->get($user);
-		}
-		if(is_null($user)) {
-			return false;
-		}
-
-		$dn = $user->getDN();
-		//check if user really still exists by reading its entry
-		if(!is_array($this->access->readAttribute($dn, '', $this->access->connection->ldapUserFilter))) {
-			$lcr = $this->access->connection->getConnectionResource();
-			if(is_null($lcr)) {
-				throw new \Exception('No LDAP Connection to server ' . $this->access->connection->ldapHost);
-			}
-
-			try {
-				$uuid = $this->access->getUserMapper()->getUUIDByDN($dn);
-				if(!$uuid) {
-					return false;
-				}
-				$newDn = $this->access->getUserDnByUuid($uuid);
-				//check if renamed user is still valid by reapplying the ldap filter
-				if(!is_array($this->access->readAttribute($newDn, '', $this->access->connection->ldapUserFilter))) {
-					return false;
-				}
-				$this->access->getUserMapper()->setDNbyUUID($newDn, $uuid);
-				return true;
-			} catch (\Exception $e) {
-				return false;
-			}
-		}
-
-		if($user instanceof OfflineUser) {
-			$user->unmark();
-		}
-
-		return true;
-	}
-
-	/**
-	 * check if a user exists
-	 * @param string $uid the username
-	 * @return boolean
-	 * @throws \Exception when connection could not be established
-	 */
-	public function userExists($uid) {
-		$userExists = $this->access->connection->getFromCache('userExists'.$uid);
-		if(!is_null($userExists)) {
-			return (bool)$userExists;
-		}
-		//getting dn, if false the user does not exist. If dn, he may be mapped only, requires more checking.
-		$user = $this->access->userManager->get($uid);
-
-		if(is_null($user)) {
-			Util::writeLog('user_ldap', 'No DN found for '.$uid.' on '.
-				$this->access->connection->ldapHost, Util::DEBUG);
-			$this->access->connection->writeToCache('userExists'.$uid, false);
-			return false;
-		} else if($user instanceof OfflineUser) {
-			//express check for users marked as deleted. Returning true is
-			//necessary for cleanup
-			return true;
-		}
-
-		$result = $this->userExistsOnLDAP($user);
-		$this->access->connection->writeToCache('userExists'.$uid, $result);
-		if($result === true) {
-			$user->update();
-		}
-		return $result;
-	}
-
-	/**
-	* returns whether a user was deleted in LDAP
-	*
-	* @param string $uid The username of the user to delete
-	* @return bool
-	*/
-	public function deleteUser($uid) {
-		$marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
-		if(intval($marked) === 0) {
-			\OC::$server->getLogger()->notice(
-				'User '.$uid . ' is not marked as deleted, not cleaning up.',
-				array('app' => 'user_ldap'));
-			return false;
-		}
-		\OC::$server->getLogger()->info('Cleaning up after user ' . $uid,
-			array('app' => 'user_ldap'));
-
-		//Get Home Directory out of user preferences so we can return it later,
-		//necessary for removing directories as done by OC_User.
-		$home = $this->ocConfig->getUserValue($uid, 'user_ldap', 'homePath', '');
-		$this->homesToKill[$uid] = $home;
-		$this->access->getUserMapper()->unmap($uid);
-
-		return true;
-	}
-
-	/**
-	 * get the user's home directory
-	 *
-	 * @param string $uid the username
-	 * @return bool|string
-	 * @throws NoUserException
-	 * @throws \Exception
-	 */
-	public function getHome($uid) {
-		if(isset($this->homesToKill[$uid]) && !empty($this->homesToKill[$uid])) {
-			//a deleted user who needs some clean up
-			return $this->homesToKill[$uid];
-		}
-
-		// user Exists check required as it is not done in user proxy!
-		if(!$this->userExists($uid)) {
-			return false;
-		}
-
-		$cacheKey = 'getHome'.$uid;
-		$path = $this->access->connection->getFromCache($cacheKey);
-		if(!is_null($path)) {
-			return $path;
-		}
-
-		$user = $this->access->userManager->get($uid);
-		if(is_null($user) || ($user instanceof OfflineUser && !$this->userExistsOnLDAP($user->getOCName()))) {
-			throw new NoUserException($uid . ' is not a valid user anymore');
-		}
-		if($user instanceof OfflineUser) {
-			// apparently this user survived the userExistsOnLDAP check,
-			// we request the user instance again in order to retrieve a User
-			// instance instead
-			$user = $this->access->userManager->get($uid);
-		}
-		$path = $user->getHomePath();
-		$this->access->cacheUserHome($uid, $path);
-
-		return $path;
-	}
-
-	/**
-	 * get display name of the user
-	 * @param string $uid user ID of the user
-	 * @return string|false display name
-	 */
-	public function getDisplayName($uid) {
-		if(!$this->userExists($uid)) {
-			return false;
-		}
-
-		$cacheKey = 'getDisplayName'.$uid;
-		if(!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
-			return $displayName;
-		}
-
-		//Check whether the display name is configured to have a 2nd feature
-		$additionalAttribute = $this->access->connection->ldapUserDisplayName2;
-		$displayName2 = '';
-		if ($additionalAttribute !== '') {
-			$displayName2 = $this->access->readAttribute(
-				$this->access->username2dn($uid),
-				$additionalAttribute);
-		}
-
-		$displayName = $this->access->readAttribute(
-			$this->access->username2dn($uid),
-			$this->access->connection->ldapUserDisplayName);
-
-		if($displayName && (count($displayName) > 0)) {
-			$displayName = $displayName[0];
-
-			if (is_array($displayName2)){
-				$displayName2 = count($displayName2) > 0 ? $displayName2[0] : '';
-			}
-
-			$user = $this->access->userManager->get($uid);
-			if ($user instanceof User) {
-				$displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
-				$this->access->connection->writeToCache($cacheKey, $displayName);
-			}
-			if ($user instanceof OfflineUser) {
-				/** @var OfflineUser $user*/
-				$displayName = $user->getDisplayName();
-			}
-			return $displayName;
-		}
-
-		return null;
-	}
-
-	/**
-	 * Get a list of all display names
-	 *
-	 * @param string $search
-	 * @param string|null $limit
-	 * @param string|null $offset
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
-	 */
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;
-		if(!is_null($displayNames = $this->access->connection->getFromCache($cacheKey))) {
-			return $displayNames;
-		}
-
-		$displayNames = array();
-		$users = $this->getUsers($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user] = $this->getDisplayName($user);
-		}
-		$this->access->connection->writeToCache($cacheKey, $displayNames);
-		return $displayNames;
-	}
-
-	/**
-	* Check if backend implements actions
-	* @param int $actions bitwise-or'ed actions
-	* @return boolean
-	*
-	* Returns the supported actions as int to be
-	* compared with OC_USER_BACKEND_CREATE_USER etc.
-	*/
-	public function implementsActions($actions) {
-		return (bool)((Backend::CHECK_PASSWORD
-			| Backend::GET_HOME
-			| Backend::GET_DISPLAYNAME
-			| Backend::PROVIDE_AVATAR
-			| Backend::COUNT_USERS
-			| ((intval($this->access->connection->turnOnPasswordChange) === 1)?(Backend::SET_PASSWORD):0))
-			& $actions);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasUserListings() {
-		return true;
-	}
-
-	/**
-	 * counts the users in LDAP
-	 *
-	 * @return int|bool
-	 */
-	public function countUsers() {
-		$filter = $this->access->getFilterForUserCount();
-		$cacheKey = 'countUsers-'.$filter;
-		if(!is_null($entries = $this->access->connection->getFromCache($cacheKey))) {
-			return $entries;
-		}
-		$entries = $this->access->countUsers($filter);
-		$this->access->connection->writeToCache($cacheKey, $entries);
-		return $entries;
-	}
-
-	/**
-	 * Backend name to be shown in user management
-	 * @return string the name of the backend to be shown
-	 */
-	public function getBackendName(){
-		return 'LDAP';
-	}
+    /**
+     * returns the username for the given LDAP DN, if available
+     *
+     * @param string $dn
+     * @return string|false with the username
+     */
+    public function dn2UserName($dn) {
+        return $this->access->dn2username($dn);
+    }
+
+    /**
+     * returns an LDAP record based on a given login name
+     *
+     * @param string $loginName
+     * @return array
+     * @throws NotOnLDAP
+     */
+    public function getLDAPUserByLoginName($loginName) {
+        //find out dn of the user name
+        $attrs = $this->access->userManager->getAttributes();
+        $users = $this->access->fetchUsersByLoginName($loginName, $attrs);
+        if(count($users) < 1) {
+            throw new NotOnLDAP('No user available for the given login name on ' .
+                $this->access->connection->ldapHost . ':' . $this->access->connection->ldapPort);
+        }
+        return $users[0];
+    }
+
+    /**
+     * Check if the password is correct without logging in the user
+     *
+     * @param string $uid The username
+     * @param string $password The password
+     * @return false|string
+     */
+    public function checkPassword($uid, $password) {
+        try {
+            $ldapRecord = $this->getLDAPUserByLoginName($uid);
+        } catch(NotOnLDAP $e) {
+            if($this->ocConfig->getSystemValue('loglevel', Util::WARN) === Util::DEBUG) {
+                \OC::$server->getLogger()->logException($e, ['app' => 'user_ldap']);
+            }
+            return false;
+        }
+        $dn = $ldapRecord['dn'][0];
+        $user = $this->access->userManager->get($dn);
+
+        if(!$user instanceof User) {
+            Util::writeLog('user_ldap',
+                'LDAP Login: Could not get user object for DN ' . $dn .
+                '. Maybe the LDAP entry has no set display name attribute?',
+                Util::WARN);
+            return false;
+        }
+        if($user->getUsername() !== false) {
+            //are the credentials OK?
+            if(!$this->access->areCredentialsValid($dn, $password)) {
+                return false;
+            }
+
+            $this->access->cacheUserExists($user->getUsername());
+            $user->processAttributes($ldapRecord);
+            $user->markLogin();
+
+            return $user->getUsername();
+        }
+
+        return false;
+    }
+
+    /**
+     * Set password
+     * @param string $uid The username
+     * @param string $password The new password
+     * @return bool
+     */
+    public function setPassword($uid, $password) {
+        $user = $this->access->userManager->get($uid);
+
+        if(!$user instanceof User) {
+            throw new \Exception('LDAP setPassword: Could not get user object for uid ' . $uid .
+                '. Maybe the LDAP entry has no set display name attribute?');
+        }
+        if($user->getUsername() !== false) {
+            return $this->access->setPassword($user->getDN(), $password);
+        }
+
+        return false;
+    }
+
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param integer $limit
+     * @param integer $offset
+     * @return string[] an array of all uids
+     */
+    public function getUsers($search = '', $limit = 10, $offset = 0) {
+        $search = $this->access->escapeFilterPart($search, true);
+        $cachekey = 'getUsers-'.$search.'-'.$limit.'-'.$offset;
+
+        //check if users are cached, if so return
+        $ldap_users = $this->access->connection->getFromCache($cachekey);
+        if(!is_null($ldap_users)) {
+            return $ldap_users;
+        }
+
+        // if we'd pass -1 to LDAP search, we'd end up in a Protocol
+        // error. With a limit of 0, we get 0 results. So we pass null.
+        if($limit <= 0) {
+            $limit = null;
+        }
+        $filter = $this->access->combineFilterWithAnd(array(
+            $this->access->connection->ldapUserFilter,
+            $this->access->connection->ldapUserDisplayName . '=*',
+            $this->access->getFilterPartForUserSearch($search)
+        ));
+
+        Util::writeLog('user_ldap',
+            'getUsers: Options: search '.$search.' limit '.$limit.' offset '.$offset.' Filter: '.$filter,
+            Util::DEBUG);
+        //do the search and translate results to owncloud names
+        $ldap_users = $this->access->fetchListOfUsers(
+            $filter,
+            $this->access->userManager->getAttributes(true),
+            $limit, $offset);
+        $ldap_users = $this->access->ownCloudUserNames($ldap_users);
+        Util::writeLog('user_ldap', 'getUsers: '.count($ldap_users). ' Users found', Util::DEBUG);
+
+        $this->access->connection->writeToCache($cachekey, $ldap_users);
+        return $ldap_users;
+    }
+
+    /**
+     * checks whether a user is still available on LDAP
+     *
+     * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
+     * name or an instance of that user
+     * @return bool
+     * @throws \Exception
+     * @throws \OC\ServerNotAvailableException
+     */
+    public function userExistsOnLDAP($user) {
+        if(is_string($user)) {
+            $user = $this->access->userManager->get($user);
+        }
+        if(is_null($user)) {
+            return false;
+        }
+
+        $dn = $user->getDN();
+        //check if user really still exists by reading its entry
+        if(!is_array($this->access->readAttribute($dn, '', $this->access->connection->ldapUserFilter))) {
+            $lcr = $this->access->connection->getConnectionResource();
+            if(is_null($lcr)) {
+                throw new \Exception('No LDAP Connection to server ' . $this->access->connection->ldapHost);
+            }
+
+            try {
+                $uuid = $this->access->getUserMapper()->getUUIDByDN($dn);
+                if(!$uuid) {
+                    return false;
+                }
+                $newDn = $this->access->getUserDnByUuid($uuid);
+                //check if renamed user is still valid by reapplying the ldap filter
+                if(!is_array($this->access->readAttribute($newDn, '', $this->access->connection->ldapUserFilter))) {
+                    return false;
+                }
+                $this->access->getUserMapper()->setDNbyUUID($newDn, $uuid);
+                return true;
+            } catch (\Exception $e) {
+                return false;
+            }
+        }
+
+        if($user instanceof OfflineUser) {
+            $user->unmark();
+        }
+
+        return true;
+    }
+
+    /**
+     * check if a user exists
+     * @param string $uid the username
+     * @return boolean
+     * @throws \Exception when connection could not be established
+     */
+    public function userExists($uid) {
+        $userExists = $this->access->connection->getFromCache('userExists'.$uid);
+        if(!is_null($userExists)) {
+            return (bool)$userExists;
+        }
+        //getting dn, if false the user does not exist. If dn, he may be mapped only, requires more checking.
+        $user = $this->access->userManager->get($uid);
+
+        if(is_null($user)) {
+            Util::writeLog('user_ldap', 'No DN found for '.$uid.' on '.
+                $this->access->connection->ldapHost, Util::DEBUG);
+            $this->access->connection->writeToCache('userExists'.$uid, false);
+            return false;
+        } else if($user instanceof OfflineUser) {
+            //express check for users marked as deleted. Returning true is
+            //necessary for cleanup
+            return true;
+        }
+
+        $result = $this->userExistsOnLDAP($user);
+        $this->access->connection->writeToCache('userExists'.$uid, $result);
+        if($result === true) {
+            $user->update();
+        }
+        return $result;
+    }
+
+    /**
+     * returns whether a user was deleted in LDAP
+     *
+     * @param string $uid The username of the user to delete
+     * @return bool
+     */
+    public function deleteUser($uid) {
+        $marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
+        if(intval($marked) === 0) {
+            \OC::$server->getLogger()->notice(
+                'User '.$uid . ' is not marked as deleted, not cleaning up.',
+                array('app' => 'user_ldap'));
+            return false;
+        }
+        \OC::$server->getLogger()->info('Cleaning up after user ' . $uid,
+            array('app' => 'user_ldap'));
+
+        //Get Home Directory out of user preferences so we can return it later,
+        //necessary for removing directories as done by OC_User.
+        $home = $this->ocConfig->getUserValue($uid, 'user_ldap', 'homePath', '');
+        $this->homesToKill[$uid] = $home;
+        $this->access->getUserMapper()->unmap($uid);
+
+        return true;
+    }
+
+    /**
+     * get the user's home directory
+     *
+     * @param string $uid the username
+     * @return bool|string
+     * @throws NoUserException
+     * @throws \Exception
+     */
+    public function getHome($uid) {
+        if(isset($this->homesToKill[$uid]) && !empty($this->homesToKill[$uid])) {
+            //a deleted user who needs some clean up
+            return $this->homesToKill[$uid];
+        }
+
+        // user Exists check required as it is not done in user proxy!
+        if(!$this->userExists($uid)) {
+            return false;
+        }
+
+        $cacheKey = 'getHome'.$uid;
+        $path = $this->access->connection->getFromCache($cacheKey);
+        if(!is_null($path)) {
+            return $path;
+        }
+
+        $user = $this->access->userManager->get($uid);
+        if(is_null($user) || ($user instanceof OfflineUser && !$this->userExistsOnLDAP($user->getOCName()))) {
+            throw new NoUserException($uid . ' is not a valid user anymore');
+        }
+        if($user instanceof OfflineUser) {
+            // apparently this user survived the userExistsOnLDAP check,
+            // we request the user instance again in order to retrieve a User
+            // instance instead
+            $user = $this->access->userManager->get($uid);
+        }
+        $path = $user->getHomePath();
+        $this->access->cacheUserHome($uid, $path);
+
+        return $path;
+    }
+
+    /**
+     * get display name of the user
+     * @param string $uid user ID of the user
+     * @return string|false display name
+     */
+    public function getDisplayName($uid) {
+        if(!$this->userExists($uid)) {
+            return false;
+        }
+
+        $cacheKey = 'getDisplayName'.$uid;
+        if(!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
+            return $displayName;
+        }
+
+        //Check whether the display name is configured to have a 2nd feature
+        $additionalAttribute = $this->access->connection->ldapUserDisplayName2;
+        $displayName2 = '';
+        if ($additionalAttribute !== '') {
+            $displayName2 = $this->access->readAttribute(
+                $this->access->username2dn($uid),
+                $additionalAttribute);
+        }
+
+        $displayName = $this->access->readAttribute(
+            $this->access->username2dn($uid),
+            $this->access->connection->ldapUserDisplayName);
+
+        if($displayName && (count($displayName) > 0)) {
+            $displayName = $displayName[0];
+
+            if (is_array($displayName2)){
+                $displayName2 = count($displayName2) > 0 ? $displayName2[0] : '';
+            }
+
+            $user = $this->access->userManager->get($uid);
+            if ($user instanceof User) {
+                $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
+                $this->access->connection->writeToCache($cacheKey, $displayName);
+            }
+            if ($user instanceof OfflineUser) {
+                /** @var OfflineUser $user*/
+                $displayName = $user->getDisplayName();
+            }
+            return $displayName;
+        }
+
+        return null;
+    }
+
+    /**
+     * Get a list of all display names
+     *
+     * @param string $search
+     * @param string|null $limit
+     * @param string|null $offset
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
+     */
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;
+        if(!is_null($displayNames = $this->access->connection->getFromCache($cacheKey))) {
+            return $displayNames;
+        }
+
+        $displayNames = array();
+        $users = $this->getUsers($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user] = $this->getDisplayName($user);
+        }
+        $this->access->connection->writeToCache($cacheKey, $displayNames);
+        return $displayNames;
+    }
+
+    /**
+     * Check if backend implements actions
+     * @param int $actions bitwise-or'ed actions
+     * @return boolean
+     *
+     * Returns the supported actions as int to be
+     * compared with OC_USER_BACKEND_CREATE_USER etc.
+     */
+    public function implementsActions($actions) {
+        return (bool)((Backend::CHECK_PASSWORD
+            | Backend::GET_HOME
+            | Backend::GET_DISPLAYNAME
+            | Backend::PROVIDE_AVATAR
+            | Backend::COUNT_USERS
+            | ((intval($this->access->connection->turnOnPasswordChange) === 1)?(Backend::SET_PASSWORD):0))
+            & $actions);
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasUserListings() {
+        return true;
+    }
+
+    /**
+     * counts the users in LDAP
+     *
+     * @return int|bool
+     */
+    public function countUsers() {
+        $filter = $this->access->getFilterForUserCount();
+        $cacheKey = 'countUsers-'.$filter;
+        if(!is_null($entries = $this->access->connection->getFromCache($cacheKey))) {
+            return $entries;
+        }
+        $entries = $this->access->countUsers($filter);
+        $this->access->connection->writeToCache($cacheKey, $entries);
+        return $entries;
+    }
+
+    /**
+     * Backend name to be shown in user management
+     * @return string the name of the backend to be shown
+     */
+    public function getBackendName(){
+        return 'LDAP';
+    }
 	
-	/**
-	 * Return access for LDAP interaction.
-	 * @param string $uid
-	 * @return Access instance of Access for LDAP interaction
-	 */
-	public function getLDAPAccess($uid) {
-		return $this->access;
-	}
+    /**
+     * Return access for LDAP interaction.
+     * @param string $uid
+     * @return Access instance of Access for LDAP interaction
+     */
+    public function getLDAPAccess($uid) {
+        return $this->access;
+    }
 	
-	/**
-	 * Return LDAP connection resource from a cloned connection.
-	 * The cloned connection needs to be closed manually.
-	 * of the current access.
-	 * @param string $uid
-	 * @return resource of the LDAP connection
-	 */
-	public function getNewLDAPConnection($uid) {
-		$connection = clone $this->access->getConnection();
-		return $connection->getConnectionResource();
-	}
+    /**
+     * Return LDAP connection resource from a cloned connection.
+     * The cloned connection needs to be closed manually.
+     * of the current access.
+     * @param string $uid
+     * @return resource of the LDAP connection
+     */
+    public function getNewLDAPConnection($uid) {
+        $connection = clone $this->access->getConnection();
+        return $connection->getConnectionResource();
+    }
 }

apps/user_ldap/lib/LogWrapper.php

Indentation +8 added lines, -8 removed lines

@@ -28,13 +28,13 @@
  * @brief wraps around static ownCloud core methods
  */
 class LogWrapper {
-	protected $app = 'user_ldap';
+    protected $app = 'user_ldap';
 
-	/**
-	 * @brief states whether the filesystem was loaded
-	 * @return bool
-	 */
-	public function log($msg, $level) {
-		\OCP\Util::writeLog($this->app, $msg, $level);
-	}
+    /**
+     * @brief states whether the filesystem was loaded
+     * @return bool
+     */
+    public function log($msg, $level) {
+        \OCP\Util::writeLog($this->app, $msg, $level);
+    }
 }

apps/user_ldap/lib/LDAPProviderFactory.php

Indentation +26 added lines, -26 removed lines

@@ -28,32 +28,32 @@
 use OCA\User_LDAP\Mapping\UserMapping;
 
 class LDAPProviderFactory implements ILDAPProviderFactory {
-	/**
-	 * Server container
-	 *
-	 * @var IServerContainer
-	 */
-	private $serverContainer;
+    /**
+     * Server container
+     *
+     * @var IServerContainer
+     */
+    private $serverContainer;
 	
-	/**
-	 * Constructor for the LDAP provider factory
-	 *
-	 * @param IServerContainer $serverContainer server container
-	 */
-	public function __construct(IServerContainer $serverContainer) {
-		$this->serverContainer = $serverContainer;
-	}
+    /**
+     * Constructor for the LDAP provider factory
+     *
+     * @param IServerContainer $serverContainer server container
+     */
+    public function __construct(IServerContainer $serverContainer) {
+        $this->serverContainer = $serverContainer;
+    }
 	
-	/**
-	 * creates and returns an instance of the ILDAPProvider
-	 *
-	 * @return OCP\LDAP\ILDAPProvider
-	 */
-	public function getLDAPProvider() {
-		$dbConnection = $this->serverContainer->getDatabaseConnection();
-		$userMapping = new UserMapping($dbConnection);
-		return new LDAPProvider($this->serverContainer, new Helper($this->serverContainer->getConfig()),
-					new DeletedUsersIndex($this->serverContainer->getConfig(), 
-					$dbConnection, $userMapping));
-	}
+    /**
+     * creates and returns an instance of the ILDAPProvider
+     *
+     * @return OCP\LDAP\ILDAPProvider
+     */
+    public function getLDAPProvider() {
+        $dbConnection = $this->serverContainer->getDatabaseConnection();
+        $userMapping = new UserMapping($dbConnection);
+        return new LDAPProvider($this->serverContainer, new Helper($this->serverContainer->getConfig()),
+                    new DeletedUsersIndex($this->serverContainer->getConfig(), 
+                    $dbConnection, $userMapping));
+    }
 }

apps/user_ldap/lib/ILDAPWrapper.php

Indentation +186 added lines, -186 removed lines

@@ -29,192 +29,192 @@
 
 interface ILDAPWrapper {
 
-	//LDAP functions in use
-
-	/**
-	 * Bind to LDAP directory
-	 * @param resource $link LDAP link resource
-	 * @param string $dn an RDN to log in with
-	 * @param string $password the password
-	 * @return bool true on success, false otherwise
-	 *
-	 * with $dn and $password as null a anonymous bind is attempted.
-	 */
-	public function bind($link, $dn, $password);
-
-	/**
-	 * connect to an LDAP server
-	 * @param string $host The host to connect to
-	 * @param string $port The port to connect to
-	 * @return mixed a link resource on success, otherwise false
-	 */
-	public function connect($host, $port);
-
-	/**
-	 * Send LDAP pagination control
-	 * @param resource $link LDAP link resource
-	 * @param int $pageSize number of results per page
-	 * @param bool $isCritical Indicates whether the pagination is critical of not.
-	 * @param string $cookie structure sent by LDAP server
-	 * @return bool true on success, false otherwise
-	 */
-	public function controlPagedResult($link, $pageSize, $isCritical, $cookie);
-
-	/**
-	 * Retrieve the LDAP pagination cookie
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @param string $cookie structure sent by LDAP server
-	 * @return bool true on success, false otherwise
-	 *
-	 * Corresponds to ldap_control_paged_result_response
-	 */
-	public function controlPagedResultResponse($link, $result, &$cookie);
-
-	/**
-	 * Count the number of entries in a search
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @return int|false number of results on success, false otherwise
-	 */
-	public function countEntries($link, $result);
-
-	/**
-	 * Return the LDAP error number of the last LDAP command
-	 * @param resource $link LDAP link resource
-	 * @return string error message as string
-	 */
-	public function errno($link);
-
-	/**
-	 * Return the LDAP error message of the last LDAP command
-	 * @param resource $link LDAP link resource
-	 * @return int error code as integer
-	 */
-	public function error($link);
-
-	/**
-	 * Splits DN into its component parts
-	 * @param string $dn
-	 * @param int @withAttrib
-	 * @return array|false
-	 * @link http://www.php.net/manual/en/function.ldap-explode-dn.php
-	 */
-	public function explodeDN($dn, $withAttrib);
-
-	/**
-	 * Return first result id
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @return Resource an LDAP search result resource
-	 * */
-	public function firstEntry($link, $result);
-
-	/**
-	 * Get attributes from a search result entry
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @return array containing the results, false on error
-	 * */
-	public function getAttributes($link, $result);
-
-	/**
-	 * Get the DN of a result entry
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @return string containing the DN, false on error
-	 */
-	public function getDN($link, $result);
-
-	/**
-	 * Get all result entries
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP result resource
-	 * @return array containing the results, false on error
-	 */
-	public function getEntries($link, $result);
-
-	/**
-	 * Return next result id
-	 * @param resource $link LDAP link resource
-	 * @param resource $result LDAP entry result resource
-	 * @return resource an LDAP search result resource
-	 * */
-	public function nextEntry($link, $result);
-
-	/**
-	 * Read an entry
-	 * @param resource $link LDAP link resource
-	 * @param array $baseDN The DN of the entry to read from
-	 * @param string $filter An LDAP filter
-	 * @param array $attr array of the attributes to read
-	 * @return resource an LDAP search result resource
-	 */
-	public function read($link, $baseDN, $filter, $attr);
-
-	/**
-	 * Search LDAP tree
-	 * @param resource $link LDAP link resource
-	 * @param string $baseDN The DN of the entry to read from
-	 * @param string $filter An LDAP filter
-	 * @param array $attr array of the attributes to read
-	 * @param int $attrsOnly optional, 1 if only attribute types shall be returned
-	 * @param int $limit optional, limits the result entries
-	 * @return resource|false an LDAP search result resource, false on error
-	 */
-	public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0);
+    //LDAP functions in use
+
+    /**
+     * Bind to LDAP directory
+     * @param resource $link LDAP link resource
+     * @param string $dn an RDN to log in with
+     * @param string $password the password
+     * @return bool true on success, false otherwise
+     *
+     * with $dn and $password as null a anonymous bind is attempted.
+     */
+    public function bind($link, $dn, $password);
+
+    /**
+     * connect to an LDAP server
+     * @param string $host The host to connect to
+     * @param string $port The port to connect to
+     * @return mixed a link resource on success, otherwise false
+     */
+    public function connect($host, $port);
+
+    /**
+     * Send LDAP pagination control
+     * @param resource $link LDAP link resource
+     * @param int $pageSize number of results per page
+     * @param bool $isCritical Indicates whether the pagination is critical of not.
+     * @param string $cookie structure sent by LDAP server
+     * @return bool true on success, false otherwise
+     */
+    public function controlPagedResult($link, $pageSize, $isCritical, $cookie);
+
+    /**
+     * Retrieve the LDAP pagination cookie
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @param string $cookie structure sent by LDAP server
+     * @return bool true on success, false otherwise
+     *
+     * Corresponds to ldap_control_paged_result_response
+     */
+    public function controlPagedResultResponse($link, $result, &$cookie);
+
+    /**
+     * Count the number of entries in a search
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @return int|false number of results on success, false otherwise
+     */
+    public function countEntries($link, $result);
+
+    /**
+     * Return the LDAP error number of the last LDAP command
+     * @param resource $link LDAP link resource
+     * @return string error message as string
+     */
+    public function errno($link);
+
+    /**
+     * Return the LDAP error message of the last LDAP command
+     * @param resource $link LDAP link resource
+     * @return int error code as integer
+     */
+    public function error($link);
+
+    /**
+     * Splits DN into its component parts
+     * @param string $dn
+     * @param int @withAttrib
+     * @return array|false
+     * @link http://www.php.net/manual/en/function.ldap-explode-dn.php
+     */
+    public function explodeDN($dn, $withAttrib);
+
+    /**
+     * Return first result id
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @return Resource an LDAP search result resource
+     * */
+    public function firstEntry($link, $result);
+
+    /**
+     * Get attributes from a search result entry
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @return array containing the results, false on error
+     * */
+    public function getAttributes($link, $result);
+
+    /**
+     * Get the DN of a result entry
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @return string containing the DN, false on error
+     */
+    public function getDN($link, $result);
+
+    /**
+     * Get all result entries
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP result resource
+     * @return array containing the results, false on error
+     */
+    public function getEntries($link, $result);
+
+    /**
+     * Return next result id
+     * @param resource $link LDAP link resource
+     * @param resource $result LDAP entry result resource
+     * @return resource an LDAP search result resource
+     * */
+    public function nextEntry($link, $result);
+
+    /**
+     * Read an entry
+     * @param resource $link LDAP link resource
+     * @param array $baseDN The DN of the entry to read from
+     * @param string $filter An LDAP filter
+     * @param array $attr array of the attributes to read
+     * @return resource an LDAP search result resource
+     */
+    public function read($link, $baseDN, $filter, $attr);
+
+    /**
+     * Search LDAP tree
+     * @param resource $link LDAP link resource
+     * @param string $baseDN The DN of the entry to read from
+     * @param string $filter An LDAP filter
+     * @param array $attr array of the attributes to read
+     * @param int $attrsOnly optional, 1 if only attribute types shall be returned
+     * @param int $limit optional, limits the result entries
+     * @return resource|false an LDAP search result resource, false on error
+     */
+    public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0);
 	
-	/**
-	 * Replace the value of a userPassword by $password
-	 * @param resource $link LDAP link resource
-	 * @param string $userDN the DN of the user whose password is to be replaced
-	 * @param string $password the new value for the userPassword
-	 * @return bool true on success, false otherwise
-	 */
-	public function modReplace($link, $userDN, $password);
-
-	/**
-	 * Sets the value of the specified option to be $value
-	 * @param resource $link LDAP link resource
-	 * @param string $option a defined LDAP Server option
-	 * @param int $value the new value for the option
-	 * @return bool true on success, false otherwise
-	 */
-	public function setOption($link, $option, $value);
-
-	/**
-	 * establish Start TLS
-	 * @param resource $link LDAP link resource
-	 * @return bool true on success, false otherwise
-	 */
-	public function startTls($link);
-
-	/**
-	 * Unbind from LDAP directory
-	 * @param resource $link LDAP link resource
-	 * @return bool true on success, false otherwise
-	 */
-	public function unbind($link);
-
-	//additional required methods in ownCloud
-
-	/**
-	 * Checks whether the server supports LDAP
-	 * @return bool true if it the case, false otherwise
-	 * */
-	public function areLDAPFunctionsAvailable();
-
-	/**
-	 * Checks whether PHP supports LDAP Paged Results
-	 * @return bool true if it the case, false otherwise
-	 * */
-	public function hasPagedResultSupport();
-
-	/**
-	 * Checks whether the submitted parameter is a resource
-	 * @param resource $resource the resource variable to check
-	 * @return bool true if it is a resource, false otherwise
-	 */
-	public function isResource($resource);
+    /**
+     * Replace the value of a userPassword by $password
+     * @param resource $link LDAP link resource
+     * @param string $userDN the DN of the user whose password is to be replaced
+     * @param string $password the new value for the userPassword
+     * @return bool true on success, false otherwise
+     */
+    public function modReplace($link, $userDN, $password);
+
+    /**
+     * Sets the value of the specified option to be $value
+     * @param resource $link LDAP link resource
+     * @param string $option a defined LDAP Server option
+     * @param int $value the new value for the option
+     * @return bool true on success, false otherwise
+     */
+    public function setOption($link, $option, $value);
+
+    /**
+     * establish Start TLS
+     * @param resource $link LDAP link resource
+     * @return bool true on success, false otherwise
+     */
+    public function startTls($link);
+
+    /**
+     * Unbind from LDAP directory
+     * @param resource $link LDAP link resource
+     * @return bool true on success, false otherwise
+     */
+    public function unbind($link);
+
+    //additional required methods in ownCloud
+
+    /**
+     * Checks whether the server supports LDAP
+     * @return bool true if it the case, false otherwise
+     * */
+    public function areLDAPFunctionsAvailable();
+
+    /**
+     * Checks whether PHP supports LDAP Paged Results
+     * @return bool true if it the case, false otherwise
+     * */
+    public function hasPagedResultSupport();
+
+    /**
+     * Checks whether the submitted parameter is a resource
+     * @param resource $resource the resource variable to check
+     * @return bool true if it is a resource, false otherwise
+     */
+    public function isResource($resource);
 
 }

apps/user_ldap/appinfo/routes.php

Indentation +13 added lines, -13 removed lines

@@ -23,26 +23,26 @@
 
 /** @var $this \OCP\Route\IRouter */
 $this->create('user_ldap_ajax_clearMappings', 'ajax/clearMappings.php')
-	->actionInclude('user_ldap/ajax/clearMappings.php');
+    ->actionInclude('user_ldap/ajax/clearMappings.php');
 $this->create('user_ldap_ajax_deleteConfiguration', 'ajax/deleteConfiguration.php')
-	->actionInclude('user_ldap/ajax/deleteConfiguration.php');
+    ->actionInclude('user_ldap/ajax/deleteConfiguration.php');
 $this->create('user_ldap_ajax_getConfiguration', 'ajax/getConfiguration.php')
-	->actionInclude('user_ldap/ajax/getConfiguration.php');
+    ->actionInclude('user_ldap/ajax/getConfiguration.php');
 $this->create('user_ldap_ajax_getNewServerConfigPrefix', 'ajax/getNewServerConfigPrefix.php')
-	->actionInclude('user_ldap/ajax/getNewServerConfigPrefix.php');
+    ->actionInclude('user_ldap/ajax/getNewServerConfigPrefix.php');
 $this->create('user_ldap_ajax_setConfiguration', 'ajax/setConfiguration.php')
-	->actionInclude('user_ldap/ajax/setConfiguration.php');
+    ->actionInclude('user_ldap/ajax/setConfiguration.php');
 $this->create('user_ldap_ajax_testConfiguration', 'ajax/testConfiguration.php')
-	->actionInclude('user_ldap/ajax/testConfiguration.php');
+    ->actionInclude('user_ldap/ajax/testConfiguration.php');
 $this->create('user_ldap_ajax_wizard', 'ajax/wizard.php')
-	->actionInclude('user_ldap/ajax/wizard.php');
+    ->actionInclude('user_ldap/ajax/wizard.php');
 
 $application = new \OCP\AppFramework\App('user_ldap');
 $application->registerRoutes($this, [
-	'ocs' => [
-		['name' => 'ConfigAPI#create', 'url' => '/api/v1/config', 'verb' => 'POST'],
-		['name' => 'ConfigAPI#show',   'url' => '/api/v1/config/{configID}', 'verb' => 'GET'],
-		['name' => 'ConfigAPI#modify', 'url' => '/api/v1/config/{configID}', 'verb' => 'PUT'],
-		['name' => 'ConfigAPI#delete', 'url' => '/api/v1/config/{configID}', 'verb' => 'DELETE'],
-	]
+    'ocs' => [
+        ['name' => 'ConfigAPI#create', 'url' => '/api/v1/config', 'verb' => 'POST'],
+        ['name' => 'ConfigAPI#show',   'url' => '/api/v1/config/{configID}', 'verb' => 'GET'],
+        ['name' => 'ConfigAPI#modify', 'url' => '/api/v1/config/{configID}', 'verb' => 'PUT'],
+        ['name' => 'ConfigAPI#delete', 'url' => '/api/v1/config/{configID}', 'verb' => 'DELETE'],
+    ]
 ]);

apps/user_ldap/appinfo/register_command.php

Indentation +6 added lines, -6 removed lines

@@ -33,12 +33,12 @@ 
 $helper = new Helper(\OC::$server->getConfig());
 $ocConfig = \OC::$server->getConfig();
 $uBackend = new User_Proxy(
-	$helper->getServerConfigurationPrefixes(true),
-	new LDAP(),
-	$ocConfig
+    $helper->getServerConfigurationPrefixes(true),
+    new LDAP(),
+    $ocConfig
 );
 $deletedUsersIndex = new DeletedUsersIndex(
-	$ocConfig, $dbConnection, $userMapping
+    $ocConfig, $dbConnection, $userMapping
 );
 
 $application->add(new OCA\User_LDAP\Command\ShowConfig($helper));
@@ -48,8 +48,8 @@ 
 $application->add(new OCA\User_LDAP\Command\DeleteConfig($helper));
 $application->add(new OCA\User_LDAP\Command\Search($ocConfig));
 $application->add(new OCA\User_LDAP\Command\ShowRemnants(
-	$deletedUsersIndex, \OC::$server->getDateTimeFormatter())
+    $deletedUsersIndex, \OC::$server->getDateTimeFormatter())
 );
 $application->add(new OCA\User_LDAP\Command\CheckUser(
-	$uBackend, $helper, $deletedUsersIndex, $userMapping)
+    $uBackend, $helper, $deletedUsersIndex, $userMapping)
 );

apps/user_ldap/appinfo/install.php

Indentation +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
  */
 $state = OCP\Config::getSystemValue('ldapIgnoreNamingRules', 'doSet');
 if($state === 'doSet') {
-	OCP\Config::setSystemValue('ldapIgnoreNamingRules', false);
+    OCP\Config::setSystemValue('ldapIgnoreNamingRules', false);
 }
 
 $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());

apps/files_external/templates/settings.php

Indentation +56 added lines, -56 removed lines

@@ -1,47 +1,47 @@ 
 <?php
-	use \OCA\Files_External\Lib\Backend\Backend;
-	use \OCA\Files_External\Lib\Auth\AuthMechanism;
-	use \OCA\Files_External\Lib\DefinitionParameter;
-	use \OCA\Files_External\Service\BackendService;
+    use \OCA\Files_External\Lib\Backend\Backend;
+    use \OCA\Files_External\Lib\Auth\AuthMechanism;
+    use \OCA\Files_External\Lib\DefinitionParameter;
+    use \OCA\Files_External\Service\BackendService;
 
-	$canCreateMounts = $_['visibilityType'] === BackendService::VISIBILITY_ADMIN || $_['allowUserMounting'];
+    $canCreateMounts = $_['visibilityType'] === BackendService::VISIBILITY_ADMIN || $_['allowUserMounting'];
 
-	$l->t("Enable encryption");
-	$l->t("Enable previews");
-	$l->t("Enable sharing");
-	$l->t("Check for changes");
-	$l->t("Never");
-	$l->t("Once every direct access");
+    $l->t("Enable encryption");
+    $l->t("Enable previews");
+    $l->t("Enable sharing");
+    $l->t("Check for changes");
+    $l->t("Never");
+    $l->t("Once every direct access");
 
-	script('files_external', 'settings');
-	style('files_external', 'settings');
+    script('files_external', 'settings');
+    style('files_external', 'settings');
 
-	// load custom JS
-	foreach ($_['backends'] as $backend) {
-		/** @var Backend $backend */
-		$scripts = $backend->getCustomJs();
-		foreach ($scripts as $script) {
-			script('files_external', $script);
-		}
-	}
-	foreach ($_['authMechanisms'] as $authMechanism) {
-		/** @var AuthMechanism $authMechanism */
-		$scripts = $authMechanism->getCustomJs();
-		foreach ($scripts as $script) {
-			script('files_external', $script);
-		}
-	}
+    // load custom JS
+    foreach ($_['backends'] as $backend) {
+        /** @var Backend $backend */
+        $scripts = $backend->getCustomJs();
+        foreach ($scripts as $script) {
+            script('files_external', $script);
+        }
+    }
+    foreach ($_['authMechanisms'] as $authMechanism) {
+        /** @var AuthMechanism $authMechanism */
+        $scripts = $authMechanism->getCustomJs();
+        foreach ($scripts as $script) {
+            script('files_external', $script);
+        }
+    }
 
-	function writeParameterInput($parameter, $options, $classes = []) {
-		$value = '';
-		if (isset($options[$parameter->getName()])) {
-			$value = $options[$parameter->getName()];
-		}
-		$placeholder = $parameter->getText();
-		$is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL);
+    function writeParameterInput($parameter, $options, $classes = []) {
+        $value = '';
+        if (isset($options[$parameter->getName()])) {
+            $value = $options[$parameter->getName()];
+        }
+        $placeholder = $parameter->getText();
+        $is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL);
 
-		switch ($parameter->getType()) {
-		case DefinitionParameter::VALUE_PASSWORD: ?>
+        switch ($parameter->getType()) {
+        case DefinitionParameter::VALUE_PASSWORD: ?>
 			<?php if ($is_optional) { $classes[] = 'optional'; } ?>
 			<input type="password"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
@@ -50,8 +50,8 @@ 
 				placeholder="<?php p($placeholder); ?>"
 			/>
 			<?php
-			break;
-		case DefinitionParameter::VALUE_BOOLEAN: ?>
+            break;
+        case DefinitionParameter::VALUE_BOOLEAN: ?>
 			<?php $checkboxId = uniqid("checkbox_"); ?>
 			<div>
 			<label>
@@ -65,16 +65,16 @@ 
 			</label>
 			</div>
 			<?php
-			break;
-		case DefinitionParameter::VALUE_HIDDEN: ?>
+            break;
+        case DefinitionParameter::VALUE_HIDDEN: ?>
 			<input type="hidden"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
 				data-parameter="<?php p($parameter->getName()); ?>"
 				value="<?php p($value); ?>"
 			/>
 			<?php
-			break;
-		default: ?>
+            break;
+        default: ?>
 			<?php if ($is_optional) { $classes[] = 'optional'; } ?>
 			<input type="text"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
@@ -83,8 +83,8 @@ 
 				placeholder="<?php p($placeholder); ?>"
 			/>
 			<?php
-		}
-	}
+        }
+    }
 ?>
 
 <form data-can-create="<?php echo $canCreateMounts?'true':'false' ?>" id="files_external" class="section" data-encryption-enabled="<?php echo $_['encryptionEnabled']?'true': 'false'; ?>">
@@ -122,13 +122,13 @@ 
 							<?php p($l->t('Add storage')); ?>
 						</option>
 						<?php
-							$sortedBackends = array_filter($_['backends'], function($backend) use ($_) {
-								return $backend->isVisibleFor($_['visibilityType']);
-							});
-							uasort($sortedBackends, function($a, $b) {
-								return strcasecmp($a->getText(), $b->getText());
-							});
-						?>
+                            $sortedBackends = array_filter($_['backends'], function($backend) use ($_) {
+                                return $backend->isVisibleFor($_['visibilityType']);
+                            });
+                            uasort($sortedBackends, function($a, $b) {
+                                return strcasecmp($a->getText(), $b->getText());
+                            });
+                        ?>
 						<?php foreach ($sortedBackends as $backend): ?>
 							<?php if ($backend->getDeprecateTo()) continue; // ignore deprecated backends ?>
 							<option value="<?php p($backend->getIdentifier()); ?>"><?php p($backend->getText()); ?></option>
@@ -169,10 +169,10 @@ 
 		<p id="userMountingBackends"<?php if ($_['allowUserMounting'] != 'yes'): ?> class="hidden"<?php endif; ?>>
 			<?php p($l->t('Allow users to mount the following external storage')); ?><br />
 			<?php
-				$userBackends = array_filter($_['backends'], function($backend) {
-					return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL);
-				});
-			?>
+                $userBackends = array_filter($_['backends'], function($backend) {
+                    return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL);
+                });
+            ?>
 			<?php $i = 0; foreach ($userBackends as $backend): ?>
 				<?php if ($deprecateTo = $backend->getDeprecateTo()): ?>
 					<input type="hidden" id="allowUserMountingBackends<?php p($i); ?>" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" data-deprecate-to="<?php p($deprecateTo->getIdentifier()); ?>" />