nextcloud / server

apps/user_ldap/lib/Group_Proxy.php

Spacing +12 added lines, -12 removed lines

@@ -36,10 +36,10 @@ 
 	 */
 	public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap, GroupPluginManager $groupPluginManager) {
 		parent::__construct($ldap);
-		foreach($serverConfigPrefixes as $configPrefix) {
+		foreach ($serverConfigPrefixes as $configPrefix) {
 			$this->backends[$configPrefix] =
 				new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix), $groupPluginManager);
-			if(is_null($this->refBackend)) {
+			if (is_null($this->refBackend)) {
 				$this->refBackend = &$this->backends[$configPrefix];
 			}
 		}
@@ -54,8 +54,8 @@ 
 	 */
 	protected function walkBackends($gid, $method, $parameters) {
 		$cacheKey = $this->getGroupCacheKey($gid);
-		foreach($this->backends as $configPrefix => $backend) {
-			if($result = call_user_func_array(array($backend, $method), $parameters)) {
+		foreach ($this->backends as $configPrefix => $backend) {
+			if ($result = call_user_func_array(array($backend, $method), $parameters)) {
 				$this->writeToCache($cacheKey, $configPrefix);
 				return $result;
 			}
@@ -72,20 +72,20 @@ 
 	 * @return mixed, the result of the method or false
 	 */
 	protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) {
-		$cacheKey = $this->getGroupCacheKey($gid);;
+		$cacheKey = $this->getGroupCacheKey($gid); ;
 		$prefix = $this->getFromCache($cacheKey);
 		//in case the uid has been found in the past, try this stored connection first
-		if(!is_null($prefix)) {
-			if(isset($this->backends[$prefix])) {
+		if (!is_null($prefix)) {
+			if (isset($this->backends[$prefix])) {
 				$result = call_user_func_array(array($this->backends[$prefix], $method), $parameters);
-				if($result === $passOnWhen) {
+				if ($result === $passOnWhen) {
 					//not found here, reset cache to null if group vanished
 					//because sometimes methods return false with a reason
 					$groupExists = call_user_func_array(
 						array($this->backends[$prefix], 'groupExists'),
 						array($gid)
 					);
-					if(!$groupExists) {
+					if (!$groupExists) {
 						$this->writeToCache($cacheKey, null);
 					}
 				}
@@ -118,7 +118,7 @@ 
 	public function getUserGroups($uid) {
 		$groups = array();
 
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendGroups = $backend->getUserGroups($uid);
 			if (is_array($backendGroups)) {
 				$groups = array_merge($groups, $backendGroups);
@@ -135,7 +135,7 @@ 
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		$users = array();
 
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset);
 			if (is_array($backendUsers)) {
 				$users = array_merge($users, $backendUsers);
@@ -220,7 +220,7 @@ 
 	public function getGroups($search = '', $limit = -1, $offset = 0) {
 		$groups = array();
 
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendGroups = $backend->getGroups($search, $limit, $offset);
 			if (is_array($backendGroups)) {
 				$groups = array_merge($groups, $backendGroups);

Indentation +220 added lines, -220 removed lines

@@ -27,248 +27,248 @@
 namespace OCA\User_LDAP;
 
 class Group_Proxy extends Proxy implements \OCP\GroupInterface, IGroupLDAP {
-	private $backends = array();
-	private $refBackend = null;
+    private $backends = array();
+    private $refBackend = null;
 
-	/**
-	 * Constructor
-	 * @param string[] $serverConfigPrefixes array containing the config Prefixes
-	 */
-	public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap, GroupPluginManager $groupPluginManager) {
-		parent::__construct($ldap);
-		foreach($serverConfigPrefixes as $configPrefix) {
-			$this->backends[$configPrefix] =
-				new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix), $groupPluginManager);
-			if(is_null($this->refBackend)) {
-				$this->refBackend = &$this->backends[$configPrefix];
-			}
-		}
-	}
+    /**
+     * Constructor
+     * @param string[] $serverConfigPrefixes array containing the config Prefixes
+     */
+    public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap, GroupPluginManager $groupPluginManager) {
+        parent::__construct($ldap);
+        foreach($serverConfigPrefixes as $configPrefix) {
+            $this->backends[$configPrefix] =
+                new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix), $groupPluginManager);
+            if(is_null($this->refBackend)) {
+                $this->refBackend = &$this->backends[$configPrefix];
+            }
+        }
+    }
 
-	/**
-	 * Tries the backends one after the other until a positive result is returned from the specified method
-	 * @param string $gid the gid connected to the request
-	 * @param string $method the method of the group backend that shall be called
-	 * @param array $parameters an array of parameters to be passed
-	 * @return mixed, the result of the method or false
-	 */
-	protected function walkBackends($gid, $method, $parameters) {
-		$cacheKey = $this->getGroupCacheKey($gid);
-		foreach($this->backends as $configPrefix => $backend) {
-			if($result = call_user_func_array(array($backend, $method), $parameters)) {
-				$this->writeToCache($cacheKey, $configPrefix);
-				return $result;
-			}
-		}
-		return false;
-	}
+    /**
+     * Tries the backends one after the other until a positive result is returned from the specified method
+     * @param string $gid the gid connected to the request
+     * @param string $method the method of the group backend that shall be called
+     * @param array $parameters an array of parameters to be passed
+     * @return mixed, the result of the method or false
+     */
+    protected function walkBackends($gid, $method, $parameters) {
+        $cacheKey = $this->getGroupCacheKey($gid);
+        foreach($this->backends as $configPrefix => $backend) {
+            if($result = call_user_func_array(array($backend, $method), $parameters)) {
+                $this->writeToCache($cacheKey, $configPrefix);
+                return $result;
+            }
+        }
+        return false;
+    }
 
-	/**
-	 * Asks the backend connected to the server that supposely takes care of the gid from the request.
-	 * @param string $gid the gid connected to the request
-	 * @param string $method the method of the group backend that shall be called
-	 * @param array $parameters an array of parameters to be passed
-	 * @param mixed $passOnWhen the result matches this variable
-	 * @return mixed, the result of the method or false
-	 */
-	protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) {
-		$cacheKey = $this->getGroupCacheKey($gid);;
-		$prefix = $this->getFromCache($cacheKey);
-		//in case the uid has been found in the past, try this stored connection first
-		if(!is_null($prefix)) {
-			if(isset($this->backends[$prefix])) {
-				$result = call_user_func_array(array($this->backends[$prefix], $method), $parameters);
-				if($result === $passOnWhen) {
-					//not found here, reset cache to null if group vanished
-					//because sometimes methods return false with a reason
-					$groupExists = call_user_func_array(
-						array($this->backends[$prefix], 'groupExists'),
-						array($gid)
-					);
-					if(!$groupExists) {
-						$this->writeToCache($cacheKey, null);
-					}
-				}
-				return $result;
-			}
-		}
-		return false;
-	}
+    /**
+     * Asks the backend connected to the server that supposely takes care of the gid from the request.
+     * @param string $gid the gid connected to the request
+     * @param string $method the method of the group backend that shall be called
+     * @param array $parameters an array of parameters to be passed
+     * @param mixed $passOnWhen the result matches this variable
+     * @return mixed, the result of the method or false
+     */
+    protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) {
+        $cacheKey = $this->getGroupCacheKey($gid);;
+        $prefix = $this->getFromCache($cacheKey);
+        //in case the uid has been found in the past, try this stored connection first
+        if(!is_null($prefix)) {
+            if(isset($this->backends[$prefix])) {
+                $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters);
+                if($result === $passOnWhen) {
+                    //not found here, reset cache to null if group vanished
+                    //because sometimes methods return false with a reason
+                    $groupExists = call_user_func_array(
+                        array($this->backends[$prefix], 'groupExists'),
+                        array($gid)
+                    );
+                    if(!$groupExists) {
+                        $this->writeToCache($cacheKey, null);
+                    }
+                }
+                return $result;
+            }
+        }
+        return false;
+    }
 
-	/**
-	 * is user in group?
-	 * @param string $uid uid of the user
-	 * @param string $gid gid of the group
-	 * @return bool
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public function inGroup($uid, $gid) {
-		return $this->handleRequest($gid, 'inGroup', array($uid, $gid));
-	}
+    /**
+     * is user in group?
+     * @param string $uid uid of the user
+     * @param string $gid gid of the group
+     * @return bool
+     *
+     * Checks whether the user is member of a group or not.
+     */
+    public function inGroup($uid, $gid) {
+        return $this->handleRequest($gid, 'inGroup', array($uid, $gid));
+    }
 
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return string[] with group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public function getUserGroups($uid) {
-		$groups = array();
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return string[] with group names
+     *
+     * This function fetches all groups a user belongs to. It does not check
+     * if the user exists at all.
+     */
+    public function getUserGroups($uid) {
+        $groups = array();
 
-		foreach($this->backends as $backend) {
-			$backendGroups = $backend->getUserGroups($uid);
-			if (is_array($backendGroups)) {
-				$groups = array_merge($groups, $backendGroups);
-			}
-		}
+        foreach($this->backends as $backend) {
+            $backendGroups = $backend->getUserGroups($uid);
+            if (is_array($backendGroups)) {
+                $groups = array_merge($groups, $backendGroups);
+            }
+        }
 
-		return $groups;
-	}
+        return $groups;
+    }
 
-	/**
-	 * get a list of all users in a group
-	 * @return string[] with user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$users = array();
+    /**
+     * get a list of all users in a group
+     * @return string[] with user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $users = array();
 
-		foreach($this->backends as $backend) {
-			$backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset);
-			if (is_array($backendUsers)) {
-				$users = array_merge($users, $backendUsers);
-			}
-		}
+        foreach($this->backends as $backend) {
+            $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset);
+            if (is_array($backendUsers)) {
+                $users = array_merge($users, $backendUsers);
+            }
+        }
 
-		return $users;
-	}
+        return $users;
+    }
 
-	/**
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function createGroup($gid) {
-		return $this->handleRequest(
-			$gid, 'createGroup', array($gid));
-	}
+    /**
+     * @param string $gid
+     * @return bool
+     */
+    public function createGroup($gid) {
+        return $this->handleRequest(
+            $gid, 'createGroup', array($gid));
+    }
 
-	/**
-	 * delete a group
-	 * @param string $gid gid of the group to delete
-	 * @return bool
-	 */
-	public function deleteGroup($gid) {
-		return $this->handleRequest(
-			$gid, 'deleteGroup', array($gid));
-	}
+    /**
+     * delete a group
+     * @param string $gid gid of the group to delete
+     * @return bool
+     */
+    public function deleteGroup($gid) {
+        return $this->handleRequest(
+            $gid, 'deleteGroup', array($gid));
+    }
 
-	/**
-	 * Add a user to a group
-	 * @param string $uid Name of the user to add to group
-	 * @param string $gid Name of the group in which add the user
-	 * @return bool
-	 *
-	 * Adds a user to a group.
-	 */
-	public function addToGroup($uid, $gid) {
-		return $this->handleRequest(
-			$gid, 'addToGroup', array($uid, $gid));
-	}
+    /**
+     * Add a user to a group
+     * @param string $uid Name of the user to add to group
+     * @param string $gid Name of the group in which add the user
+     * @return bool
+     *
+     * Adds a user to a group.
+     */
+    public function addToGroup($uid, $gid) {
+        return $this->handleRequest(
+            $gid, 'addToGroup', array($uid, $gid));
+    }
 
-	/**
-	 * Removes a user from a group
-	 * @param string $uid Name of the user to remove from group
-	 * @param string $gid Name of the group from which remove the user
-	 * @return bool
-	 *
-	 * removes the user from a group.
-	 */
-	public function removeFromGroup($uid, $gid) {
-		return $this->handleRequest(
-			$gid, 'removeFromGroup', array($uid, $gid));
-	}
+    /**
+     * Removes a user from a group
+     * @param string $uid Name of the user to remove from group
+     * @param string $gid Name of the group from which remove the user
+     * @return bool
+     *
+     * removes the user from a group.
+     */
+    public function removeFromGroup($uid, $gid) {
+        return $this->handleRequest(
+            $gid, 'removeFromGroup', array($uid, $gid));
+    }
 
-	/**
-	 * returns the number of users in a group, who match the search term
-	 * @param string $gid the internal group name
-	 * @param string $search optional, a search string
-	 * @return int|bool
-	 */
-	public function countUsersInGroup($gid, $search = '') {
-		return $this->handleRequest(
-			$gid, 'countUsersInGroup', array($gid, $search));
-	}
+    /**
+     * returns the number of users in a group, who match the search term
+     * @param string $gid the internal group name
+     * @param string $search optional, a search string
+     * @return int|bool
+     */
+    public function countUsersInGroup($gid, $search = '') {
+        return $this->handleRequest(
+            $gid, 'countUsersInGroup', array($gid, $search));
+    }
 
-	/**
-	 * get an array with group details
-	 * @param string $gid
-	 * @return array|false
-	 */
-	public function getGroupDetails($gid) {
-		return $this->handleRequest(
-			$gid, 'getGroupDetails', array($gid));
-	}
+    /**
+     * get an array with group details
+     * @param string $gid
+     * @return array|false
+     */
+    public function getGroupDetails($gid) {
+        return $this->handleRequest(
+            $gid, 'getGroupDetails', array($gid));
+    }
 
-	/**
-	 * get a list of all groups
-	 * @return string[] with group names
-	 *
-	 * Returns a list with all groups
-	 */
-	public function getGroups($search = '', $limit = -1, $offset = 0) {
-		$groups = array();
+    /**
+     * get a list of all groups
+     * @return string[] with group names
+     *
+     * Returns a list with all groups
+     */
+    public function getGroups($search = '', $limit = -1, $offset = 0) {
+        $groups = array();
 
-		foreach($this->backends as $backend) {
-			$backendGroups = $backend->getGroups($search, $limit, $offset);
-			if (is_array($backendGroups)) {
-				$groups = array_merge($groups, $backendGroups);
-			}
-		}
+        foreach($this->backends as $backend) {
+            $backendGroups = $backend->getGroups($search, $limit, $offset);
+            if (is_array($backendGroups)) {
+                $groups = array_merge($groups, $backendGroups);
+            }
+        }
 
-		return $groups;
-	}
+        return $groups;
+    }
 
-	/**
-	 * check if a group exists
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return $this->handleRequest($gid, 'groupExists', array($gid));
-	}
+    /**
+     * check if a group exists
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return $this->handleRequest($gid, 'groupExists', array($gid));
+    }
 
-	/**
-	 * Check if backend implements actions
-	 * @param int $actions bitwise-or'ed actions
-	 * @return boolean
-	 *
-	 * Returns the supported actions as int to be
-	 * compared with \OCP\GroupInterface::CREATE_GROUP etc.
-	 */
-	public function implementsActions($actions) {
-		//it's the same across all our user backends obviously
-		return $this->refBackend->implementsActions($actions);
-	}
+    /**
+     * Check if backend implements actions
+     * @param int $actions bitwise-or'ed actions
+     * @return boolean
+     *
+     * Returns the supported actions as int to be
+     * compared with \OCP\GroupInterface::CREATE_GROUP etc.
+     */
+    public function implementsActions($actions) {
+        //it's the same across all our user backends obviously
+        return $this->refBackend->implementsActions($actions);
+    }
 
-	/**
-	 * Return access for LDAP interaction.
-	 * @param string $gid
-	 * @return Access instance of Access for LDAP interaction
-	 */
-	public function getLDAPAccess($gid) {
-		return $this->handleRequest($gid, 'getLDAPAccess', [$gid]);
-	}
+    /**
+     * Return access for LDAP interaction.
+     * @param string $gid
+     * @return Access instance of Access for LDAP interaction
+     */
+    public function getLDAPAccess($gid) {
+        return $this->handleRequest($gid, 'getLDAPAccess', [$gid]);
+    }
 
-	/**
-	 * Return a new LDAP connection for the specified group.
-	 * The connection needs to be closed manually.
-	 * @param string $gid
-	 * @return resource of the LDAP connection
-	 */
-	public function getNewLDAPConnection($gid) {
-		return $this->handleRequest($gid, 'getNewLDAPConnection', array($gid));
-	}
+    /**
+     * Return a new LDAP connection for the specified group.
+     * The connection needs to be closed manually.
+     * @param string $gid
+     * @return resource of the LDAP connection
+     */
+    public function getNewLDAPConnection($gid) {
+        return $this->handleRequest($gid, 'getNewLDAPConnection', array($gid));
+    }
 
 }

lib/public/IGroupManager.php

Indentation +87 added lines, -87 removed lines

@@ -45,103 +45,103 @@
  * @since 8.0.0
  */
 interface IGroupManager {
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isBackendUsed($backendClass);
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isBackendUsed($backendClass);
 
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 * @since 8.0.0
-	 */
-	public function addBackend($backend);
+    /**
+     * @param \OCP\GroupInterface $backend
+     * @since 8.0.0
+     */
+    public function addBackend($backend);
 
-	/**
-	 * @since 8.0.0
-	 */
-	public function clearBackends();
+    /**
+     * @since 8.0.0
+     */
+    public function clearBackends();
 
-	/**
-	 * Get the active backends
-	 * @return \OCP\GroupInterface[]
-	 * @since 13.0.0
-	 */
-	public function getBackends();
+    /**
+     * Get the active backends
+     * @return \OCP\GroupInterface[]
+     * @since 13.0.0
+     */
+    public function getBackends();
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function get($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function get($gid);
 
-	/**
-	 * @param string $gid
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function groupExists($gid);
+    /**
+     * @param string $gid
+     * @return bool
+     * @since 8.0.0
+     */
+    public function groupExists($gid);
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function createGroup($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function createGroup($gid);
 
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function search($search, $limit = null, $offset = null);
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function search($search, $limit = null, $offset = null);
 
-	/**
-	 * @param \OCP\IUser|null $user
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function getUserGroups(IUser $user = null);
+    /**
+     * @param \OCP\IUser|null $user
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function getUserGroups(IUser $user = null);
 
-	/**
-	 * @param \OCP\IUser $user
-	 * @return array with group names
-	 * @since 8.0.0
-	 */
-	public function getUserGroupIds(IUser $user);
+    /**
+     * @param \OCP\IUser $user
+     * @return array with group names
+     * @since 8.0.0
+     */
+    public function getUserGroupIds(IUser $user);
 
-	/**
-	 * get a list of all display names in a group
-	 *
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 * @since 8.0.0
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
+    /**
+     * get a list of all display names in a group
+     *
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     * @since 8.0.0
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
 
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 * @since 8.0.0
-	 */
-	public function isAdmin($userId);
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     * @since 8.0.0
+     */
+    public function isAdmin($userId);
 
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 * @since 8.0.0
-	 */
-	public function isInGroup($userId, $group);
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     * @since 8.0.0
+     */
+    public function isInGroup($userId, $group);
 }

apps/user_ldap/lib/Migration/UUIDFixUser.php

Indentation +5 added lines, -5 removed lines

@@ -30,9 +30,9 @@
 use OCP\IConfig;
 
 class UUIDFixUser extends UUIDFix {
-	public function __construct(UserMapping $mapper, LDAP $ldap, IConfig $config, Helper $helper) {
-		$this->mapper = $mapper;
-		$groupPluginManager = \OC::$server->query('LDAPGroupPluginManager');
-		$this->proxy = new Group_Proxy($helper->getServerConfigurationPrefixes(true), $ldap, $groupPluginManager);
-	}
+    public function __construct(UserMapping $mapper, LDAP $ldap, IConfig $config, Helper $helper) {
+        $this->mapper = $mapper;
+        $groupPluginManager = \OC::$server->query('LDAPGroupPluginManager');
+        $this->proxy = new Group_Proxy($helper->getServerConfigurationPrefixes(true), $ldap, $groupPluginManager);
+    }
 }

apps/user_ldap/lib/ILDAPWrapper.php

Indentation +187 added lines, -187 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 int error code
-	 */
-	public function errno($link);
-
-	/**
-	 * Return the LDAP error message of the last LDAP command
-	 * @param resource $link LDAP link resource
-	 * @return string error message
-	 */
-	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 Nextcloud
-
-	/**
-	 * 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);
+    //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 int error code
+     */
+    public function errno($link);
+
+    /**
+     * Return the LDAP error message of the last LDAP command
+     * @param resource $link LDAP link resource
+     * @return string error message
+     */
+    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 Nextcloud
+
+    /**
+     * 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/lib/IGroupLDAP.php

Indentation +13 added lines, -13 removed lines

@@ -26,20 +26,20 @@
 
 interface IGroupLDAP {
 
-	//Used by LDAPProvider
+    //Used by LDAPProvider
 
-	/**
-	 * Return access for LDAP interaction.
-	 * @param string $gid
-	 * @return Access instance of Access for LDAP interaction
-	 */
-	public function getLDAPAccess($gid);
+    /**
+     * Return access for LDAP interaction.
+     * @param string $gid
+     * @return Access instance of Access for LDAP interaction
+     */
+    public function getLDAPAccess($gid);
 
-	/**
-	 * Return a new LDAP connection for the specified group.
-	 * @param string $gid
-	 * @return resource of the LDAP connection
-	 */
-	public function getNewLDAPConnection($gid);
+    /**
+     * Return a new LDAP connection for the specified group.
+     * @param string $gid
+     * @return resource of the LDAP connection
+     */
+    public function getNewLDAPConnection($gid);
 
 }

apps/user_ldap/appinfo/register_command.php

Indentation +9 added lines, -9 removed lines

@@ -34,15 +34,15 @@ 
 $helper = new Helper(\OC::$server->getConfig());
 $ocConfig = \OC::$server->getConfig();
 $uBackend = new User_Proxy(
-	$helper->getServerConfigurationPrefixes(true),
-	new LDAP(),
-	$ocConfig,
-	\OC::$server->getNotificationManager(),
-	\OC::$server->getUserSession(),
-	\OC::$server->query('LDAPUserPluginManager')
+    $helper->getServerConfigurationPrefixes(true),
+    new LDAP(),
+    $ocConfig,
+    \OC::$server->getNotificationManager(),
+    \OC::$server->getUserSession(),
+    \OC::$server->query('LDAPUserPluginManager')
 );
 $deletedUsersIndex = new DeletedUsersIndex(
-	$ocConfig, $dbConnection, $userMapping
+    $ocConfig, $dbConnection, $userMapping
 );
 
 $application->add(new OCA\User_LDAP\Command\ShowConfig($helper));
@@ -52,8 +52,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/app.php

Indentation +32 added lines, -32 removed lines

@@ -30,50 +30,50 @@
  */
 
 \OC::$server->registerService('LDAPUserPluginManager', function() {
-	return new OCA\User_LDAP\UserPluginManager();
+    return new OCA\User_LDAP\UserPluginManager();
 });
 \OC::$server->registerService('LDAPGroupPluginManager', function() {
-	return new OCA\User_LDAP\GroupPluginManager();
+    return new OCA\User_LDAP\GroupPluginManager();
 });
 
 $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
 $configPrefixes = $helper->getServerConfigurationPrefixes(true);
 if(count($configPrefixes) > 0) {
-	$ldapWrapper = new OCA\User_LDAP\LDAP();
-	$ocConfig = \OC::$server->getConfig();
-	$notificationManager = \OC::$server->getNotificationManager();
-	$notificationManager->registerNotifier(function() {
-		return new \OCA\User_LDAP\Notification\Notifier(
-			\OC::$server->getL10NFactory()
-		);
-	}, function() {
-		$l = \OC::$server->getL10N('user_ldap');
-		return [
-			'id' => 'user_ldap',
-			'name' => $l->t('LDAP user and group backend'),
-		];
-	});
-	$userSession = \OC::$server->getUserSession();
+    $ldapWrapper = new OCA\User_LDAP\LDAP();
+    $ocConfig = \OC::$server->getConfig();
+    $notificationManager = \OC::$server->getNotificationManager();
+    $notificationManager->registerNotifier(function() {
+        return new \OCA\User_LDAP\Notification\Notifier(
+            \OC::$server->getL10NFactory()
+        );
+    }, function() {
+        $l = \OC::$server->getL10N('user_ldap');
+        return [
+            'id' => 'user_ldap',
+            'name' => $l->t('LDAP user and group backend'),
+        ];
+    });
+    $userSession = \OC::$server->getUserSession();
 
-	$userPluginManager = \OC::$server->query('LDAPUserPluginManager');
-	$groupPluginManager = \OC::$server->query('LDAPGroupPluginManager');
+    $userPluginManager = \OC::$server->query('LDAPUserPluginManager');
+    $groupPluginManager = \OC::$server->query('LDAPGroupPluginManager');
 
-	$userBackend  = new OCA\User_LDAP\User_Proxy(
-		$configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession, $userPluginManager
-	);
-	$groupBackend  = new OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, $groupPluginManager);
-	// register user backend
-	OC_User::useBackend($userBackend);
+    $userBackend  = new OCA\User_LDAP\User_Proxy(
+        $configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession, $userPluginManager
+    );
+    $groupBackend  = new OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, $groupPluginManager);
+    // register user backend
+    OC_User::useBackend($userBackend);
 
-	// Hook to allow plugins to work on registered backends
-	OC::$server->getEventDispatcher()->dispatch('OCA\\User_LDAP\\User\\User::postLDAPBackendAdded');
+    // Hook to allow plugins to work on registered backends
+    OC::$server->getEventDispatcher()->dispatch('OCA\\User_LDAP\\User\\User::postLDAPBackendAdded');
 
-	\OC::$server->getGroupManager()->addBackend($groupBackend);
+    \OC::$server->getGroupManager()->addBackend($groupBackend);
 }
 
 \OCP\Util::connectHook(
-	'\OCA\Files_Sharing\API\Server2Server',
-	'preLoginNameUsedAsUserName',
-	'\OCA\User_LDAP\Helper',
-	'loginName2UserName'
+    '\OCA\Files_Sharing\API\Server2Server',
+    'preLoginNameUsedAsUserName',
+    '\OCA\User_LDAP\Helper',
+    'loginName2UserName'
 );

Spacing +3 added lines, -3 removed lines

@@ -38,7 +38,7 @@ 
 
 $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
 $configPrefixes = $helper->getServerConfigurationPrefixes(true);
-if(count($configPrefixes) > 0) {
+if (count($configPrefixes) > 0) {
 	$ldapWrapper = new OCA\User_LDAP\LDAP();
 	$ocConfig = \OC::$server->getConfig();
 	$notificationManager = \OC::$server->getNotificationManager();
@@ -58,10 +58,10 @@ 
 	$userPluginManager = \OC::$server->query('LDAPUserPluginManager');
 	$groupPluginManager = \OC::$server->query('LDAPGroupPluginManager');
 
-	$userBackend  = new OCA\User_LDAP\User_Proxy(
+	$userBackend = new OCA\User_LDAP\User_Proxy(
 		$configPrefixes, $ldapWrapper, $ocConfig, $notificationManager, $userSession, $userPluginManager
 	);
-	$groupBackend  = new OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, $groupPluginManager);
+	$groupBackend = new OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, $groupPluginManager);
 	// register user backend
 	OC_User::useBackend($userBackend);
 

apps/user_ldap/lib/User_Proxy.php

Indentation +286 added lines, -286 removed lines

@@ -37,314 +37,314 @@
 use OCP\Notification\IManager as INotificationManager;
 
 class User_Proxy extends Proxy implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP {
-	private $backends = array();
-	private $refBackend = null;
+    private $backends = array();
+    private $refBackend = null;
 
-	/**
-	 * Constructor
-	 *
-	 * @param array $serverConfigPrefixes array containing the config Prefixes
-	 * @param ILDAPWrapper $ldap
-	 * @param IConfig $ocConfig
-	 * @param INotificationManager $notificationManager
-	 * @param IUserSession $userSession
-	 */
-	public function __construct(array $serverConfigPrefixes, ILDAPWrapper $ldap, IConfig $ocConfig,
-		INotificationManager $notificationManager, IUserSession $userSession,
-								UserPluginManager $userPluginManager) {
-		parent::__construct($ldap);
-		foreach($serverConfigPrefixes as $configPrefix) {
-			$this->backends[$configPrefix] =
-				new User_LDAP($this->getAccess($configPrefix), $ocConfig, $notificationManager, $userSession, $userPluginManager);
+    /**
+     * Constructor
+     *
+     * @param array $serverConfigPrefixes array containing the config Prefixes
+     * @param ILDAPWrapper $ldap
+     * @param IConfig $ocConfig
+     * @param INotificationManager $notificationManager
+     * @param IUserSession $userSession
+     */
+    public function __construct(array $serverConfigPrefixes, ILDAPWrapper $ldap, IConfig $ocConfig,
+        INotificationManager $notificationManager, IUserSession $userSession,
+                                UserPluginManager $userPluginManager) {
+        parent::__construct($ldap);
+        foreach($serverConfigPrefixes as $configPrefix) {
+            $this->backends[$configPrefix] =
+                new User_LDAP($this->getAccess($configPrefix), $ocConfig, $notificationManager, $userSession, $userPluginManager);
 
-			if(is_null($this->refBackend)) {
-				$this->refBackend = &$this->backends[$configPrefix];
-			}
-		}
-	}
+            if(is_null($this->refBackend)) {
+                $this->refBackend = &$this->backends[$configPrefix];
+            }
+        }
+    }
 
-	/**
-	 * Tries the backends one after the other until a positive result is returned from the specified method
-	 * @param string $uid the uid connected to the request
-	 * @param string $method the method of the user backend that shall be called
-	 * @param array $parameters an array of parameters to be passed
-	 * @return mixed the result of the method or false
-	 */
-	protected function walkBackends($uid, $method, $parameters) {
-		$cacheKey = $this->getUserCacheKey($uid);
-		foreach($this->backends as $configPrefix => $backend) {
-			$instance = $backend;
-			if(!method_exists($instance, $method)
-				&& method_exists($this->getAccess($configPrefix), $method)) {
-				$instance = $this->getAccess($configPrefix);
-			}
-			if($result = call_user_func_array(array($instance, $method), $parameters)) {
-				$this->writeToCache($cacheKey, $configPrefix);
-				return $result;
-			}
-		}
-		return false;
-	}
+    /**
+     * Tries the backends one after the other until a positive result is returned from the specified method
+     * @param string $uid the uid connected to the request
+     * @param string $method the method of the user backend that shall be called
+     * @param array $parameters an array of parameters to be passed
+     * @return mixed the result of the method or false
+     */
+    protected function walkBackends($uid, $method, $parameters) {
+        $cacheKey = $this->getUserCacheKey($uid);
+        foreach($this->backends as $configPrefix => $backend) {
+            $instance = $backend;
+            if(!method_exists($instance, $method)
+                && method_exists($this->getAccess($configPrefix), $method)) {
+                $instance = $this->getAccess($configPrefix);
+            }
+            if($result = call_user_func_array(array($instance, $method), $parameters)) {
+                $this->writeToCache($cacheKey, $configPrefix);
+                return $result;
+            }
+        }
+        return false;
+    }
 
-	/**
-	 * Asks the backend connected to the server that supposely takes care of the uid from the request.
-	 * @param string $uid the uid connected to the request
-	 * @param string $method the method of the user backend that shall be called
-	 * @param array $parameters an array of parameters to be passed
-	 * @param mixed $passOnWhen the result matches this variable
-	 * @return mixed the result of the method or false
-	 */
-	protected function callOnLastSeenOn($uid, $method, $parameters, $passOnWhen) {
-		$cacheKey = $this->getUserCacheKey($uid);
-		$prefix = $this->getFromCache($cacheKey);
-		//in case the uid has been found in the past, try this stored connection first
-		if(!is_null($prefix)) {
-			if(isset($this->backends[$prefix])) {
-				$instance = $this->backends[$prefix];
-				if(!method_exists($instance, $method)
-					&& method_exists($this->getAccess($prefix), $method)) {
-					$instance = $this->getAccess($prefix);
-				}
-				$result = call_user_func_array(array($instance, $method), $parameters);
-				if($result === $passOnWhen) {
-					//not found here, reset cache to null if user vanished
-					//because sometimes methods return false with a reason
-					$userExists = call_user_func_array(
-						array($this->backends[$prefix], 'userExists'),
-						array($uid)
-					);
-					if(!$userExists) {
-						$this->writeToCache($cacheKey, null);
-					}
-				}
-				return $result;
-			}
-		}
-		return false;
-	}
+    /**
+     * Asks the backend connected to the server that supposely takes care of the uid from the request.
+     * @param string $uid the uid connected to the request
+     * @param string $method the method of the user backend that shall be called
+     * @param array $parameters an array of parameters to be passed
+     * @param mixed $passOnWhen the result matches this variable
+     * @return mixed the result of the method or false
+     */
+    protected function callOnLastSeenOn($uid, $method, $parameters, $passOnWhen) {
+        $cacheKey = $this->getUserCacheKey($uid);
+        $prefix = $this->getFromCache($cacheKey);
+        //in case the uid has been found in the past, try this stored connection first
+        if(!is_null($prefix)) {
+            if(isset($this->backends[$prefix])) {
+                $instance = $this->backends[$prefix];
+                if(!method_exists($instance, $method)
+                    && method_exists($this->getAccess($prefix), $method)) {
+                    $instance = $this->getAccess($prefix);
+                }
+                $result = call_user_func_array(array($instance, $method), $parameters);
+                if($result === $passOnWhen) {
+                    //not found here, reset cache to null if user vanished
+                    //because sometimes methods return false with a reason
+                    $userExists = call_user_func_array(
+                        array($this->backends[$prefix], 'userExists'),
+                        array($uid)
+                    );
+                    if(!$userExists) {
+                        $this->writeToCache($cacheKey, null);
+                    }
+                }
+                return $result;
+            }
+        }
+        return false;
+    }
 
-	/**
-	 * 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) {
-		//it's the same across all our user backends obviously
-		return $this->refBackend->implementsActions($actions);
-	}
+    /**
+     * 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) {
+        //it's the same across all our user backends obviously
+        return $this->refBackend->implementsActions($actions);
+    }
 
-	/**
-	 * Backend name to be shown in user management
-	 * @return string the name of the backend to be shown
-	 */
-	public function getBackendName() {
-		return $this->refBackend->getBackendName();
-	}
+    /**
+     * Backend name to be shown in user management
+     * @return string the name of the backend to be shown
+     */
+    public function getBackendName() {
+        return $this->refBackend->getBackendName();
+    }
 
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param null|int $limit
-	 * @param null|int $offset
-	 * @return string[] an array of all uids
-	 */
-	public function getUsers($search = '', $limit = 10, $offset = 0) {
-		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
-		$users = array();
-		foreach($this->backends as $backend) {
-			$backendUsers = $backend->getUsers($search, $limit, $offset);
-			if (is_array($backendUsers)) {
-				$users = array_merge($users, $backendUsers);
-			}
-		}
-		return $users;
-	}
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param null|int $limit
+     * @param null|int $offset
+     * @return string[] an array of all uids
+     */
+    public function getUsers($search = '', $limit = 10, $offset = 0) {
+        //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
+        $users = array();
+        foreach($this->backends as $backend) {
+            $backendUsers = $backend->getUsers($search, $limit, $offset);
+            if (is_array($backendUsers)) {
+                $users = array_merge($users, $backendUsers);
+            }
+        }
+        return $users;
+    }
 
-	/**
-	 * check if a user exists
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function userExists($uid) {
-		return $this->handleRequest($uid, 'userExists', array($uid));
-	}
+    /**
+     * check if a user exists
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function userExists($uid) {
+        return $this->handleRequest($uid, 'userExists', array($uid));
+    }
 
-	/**
-	 * check if a user exists on LDAP
-	 * @param string|\OCA\User_LDAP\User\User $user either the Nextcloud user
-	 * name or an instance of that user
-	 * @return boolean
-	 */
-	public function userExistsOnLDAP($user) {
-		$id = ($user instanceof User) ? $user->getUsername() : $user;
-		return $this->handleRequest($id, 'userExistsOnLDAP', array($user));
-	}
+    /**
+     * check if a user exists on LDAP
+     * @param string|\OCA\User_LDAP\User\User $user either the Nextcloud user
+     * name or an instance of that user
+     * @return boolean
+     */
+    public function userExistsOnLDAP($user) {
+        $id = ($user instanceof User) ? $user->getUsername() : $user;
+        return $this->handleRequest($id, 'userExistsOnLDAP', array($user));
+    }
 
-	/**
-	 * Check if the password is correct
-	 * @param string $uid The username
-	 * @param string $password The password
-	 * @return bool
-	 *
-	 * Check if the password is correct without logging in the user
-	 */
-	public function checkPassword($uid, $password) {
-		return $this->handleRequest($uid, 'checkPassword', array($uid, $password));
-	}
+    /**
+     * Check if the password is correct
+     * @param string $uid The username
+     * @param string $password The password
+     * @return bool
+     *
+     * Check if the password is correct without logging in the user
+     */
+    public function checkPassword($uid, $password) {
+        return $this->handleRequest($uid, 'checkPassword', array($uid, $password));
+    }
 
-	/**
-	 * returns the username for the given login name, if available
-	 *
-	 * @param string $loginName
-	 * @return string|false
-	 */
-	public function loginName2UserName($loginName) {
-		$id = 'LOGINNAME,' . $loginName;
-		return $this->handleRequest($id, 'loginName2UserName', array($loginName));
-	}
+    /**
+     * returns the username for the given login name, if available
+     *
+     * @param string $loginName
+     * @return string|false
+     */
+    public function loginName2UserName($loginName) {
+        $id = 'LOGINNAME,' . $loginName;
+        return $this->handleRequest($id, 'loginName2UserName', array($loginName));
+    }
 	
-	/**
-	 * returns the username for the given LDAP DN, if available
-	 *
-	 * @param string $dn
-	 * @return string|false with the username
-	 */
-	public function dn2UserName($dn) {
-		$id = 'DN,' . $dn;
-		return $this->handleRequest($id, 'dn2UserName', array($dn));
-	}
+    /**
+     * returns the username for the given LDAP DN, if available
+     *
+     * @param string $dn
+     * @return string|false with the username
+     */
+    public function dn2UserName($dn) {
+        $id = 'DN,' . $dn;
+        return $this->handleRequest($id, 'dn2UserName', array($dn));
+    }
 
-	/**
-	 * get the user's home directory
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function getHome($uid) {
-		return $this->handleRequest($uid, 'getHome', array($uid));
-	}
+    /**
+     * get the user's home directory
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function getHome($uid) {
+        return $this->handleRequest($uid, 'getHome', array($uid));
+    }
 
-	/**
-	 * get display name of the user
-	 * @param string $uid user ID of the user
-	 * @return string display name
-	 */
-	public function getDisplayName($uid) {
-		return $this->handleRequest($uid, 'getDisplayName', array($uid));
-	}
+    /**
+     * get display name of the user
+     * @param string $uid user ID of the user
+     * @return string display name
+     */
+    public function getDisplayName($uid) {
+        return $this->handleRequest($uid, 'getDisplayName', array($uid));
+    }
 
-	/**
-	 * set display name of the user
-	 *
-	 * @param string $uid user ID of the user
-	 * @param string $displayName new display name
-	 * @return string display name
-	 */
-	public function setDisplayName($uid, $displayName) {
-		return $this->handleRequest($uid, 'setDisplayName', array($uid, $displayName));
-	}
+    /**
+     * set display name of the user
+     *
+     * @param string $uid user ID of the user
+     * @param string $displayName new display name
+     * @return string display name
+     */
+    public function setDisplayName($uid, $displayName) {
+        return $this->handleRequest($uid, 'setDisplayName', array($uid, $displayName));
+    }
 
-	/**
-	 * checks whether the user is allowed to change his avatar in Nextcloud
-	 * @param string $uid the Nextcloud user name
-	 * @return boolean either the user can or cannot
-	 */
-	public function canChangeAvatar($uid) {
-		return $this->handleRequest($uid, 'canChangeAvatar', array($uid));
-	}
+    /**
+     * checks whether the user is allowed to change his avatar in Nextcloud
+     * @param string $uid the Nextcloud user name
+     * @return boolean either the user can or cannot
+     */
+    public function canChangeAvatar($uid) {
+        return $this->handleRequest($uid, 'canChangeAvatar', array($uid));
+    }
 
-	/**
-	 * Get a list of all display names and user ids.
-	 * @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) {
-		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
-		$users = array();
-		foreach($this->backends as $backend) {
-			$backendUsers = $backend->getDisplayNames($search, $limit, $offset);
-			if (is_array($backendUsers)) {
-				$users = $users + $backendUsers;
-			}
-		}
-		return $users;
-	}
+    /**
+     * Get a list of all display names and user ids.
+     * @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) {
+        //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
+        $users = array();
+        foreach($this->backends as $backend) {
+            $backendUsers = $backend->getDisplayNames($search, $limit, $offset);
+            if (is_array($backendUsers)) {
+                $users = $users + $backendUsers;
+            }
+        }
+        return $users;
+    }
 
-	/**
-	 * delete a user
-	 * @param string $uid The username of the user to delete
-	 * @return bool
-	 *
-	 * Deletes a user
-	 */
-	public function deleteUser($uid) {
-		return $this->handleRequest($uid, 'deleteUser', array($uid));
-	}
+    /**
+     * delete a user
+     * @param string $uid The username of the user to delete
+     * @return bool
+     *
+     * Deletes a user
+     */
+    public function deleteUser($uid) {
+        return $this->handleRequest($uid, 'deleteUser', array($uid));
+    }
 	
-	/**
-	 * Set password
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @return bool
-	 *
-	 */
-	public function setPassword($uid, $password) {
-		return $this->handleRequest($uid, 'setPassword', array($uid, $password));
-	}
+    /**
+     * Set password
+     * @param string $uid The username
+     * @param string $password The new password
+     * @return bool
+     *
+     */
+    public function setPassword($uid, $password) {
+        return $this->handleRequest($uid, 'setPassword', array($uid, $password));
+    }
 
-	/**
-	 * @return bool
-	 */
-	public function hasUserListings() {
-		return $this->refBackend->hasUserListings();
-	}
+    /**
+     * @return bool
+     */
+    public function hasUserListings() {
+        return $this->refBackend->hasUserListings();
+    }
 
-	/**
-	 * Count the number of users
-	 * @return int|bool
-	 */
-	public function countUsers() {
-		$users = false;
-		foreach($this->backends as $backend) {
-			$backendUsers = $backend->countUsers();
-			if ($backendUsers !== false) {
-				$users += $backendUsers;
-			}
-		}
-		return $users;
-	}
+    /**
+     * Count the number of users
+     * @return int|bool
+     */
+    public function countUsers() {
+        $users = false;
+        foreach($this->backends as $backend) {
+            $backendUsers = $backend->countUsers();
+            if ($backendUsers !== false) {
+                $users += $backendUsers;
+            }
+        }
+        return $users;
+    }
 
-	/**
-	 * Return access for LDAP interaction.
-	 * @param string $uid
-	 * @return Access instance of Access for LDAP interaction
-	 */
-	public function getLDAPAccess($uid) {
-		return $this->handleRequest($uid, 'getLDAPAccess', array($uid));
-	}
+    /**
+     * Return access for LDAP interaction.
+     * @param string $uid
+     * @return Access instance of Access for LDAP interaction
+     */
+    public function getLDAPAccess($uid) {
+        return $this->handleRequest($uid, 'getLDAPAccess', array($uid));
+    }
 	
-	/**
-	 * Return a new LDAP connection for the specified user.
-	 * The connection needs to be closed manually.
-	 * @param string $uid
-	 * @return resource of the LDAP connection
-	 */
-	public function getNewLDAPConnection($uid) {
-		return $this->handleRequest($uid, 'getNewLDAPConnection', array($uid));
-	}
+    /**
+     * Return a new LDAP connection for the specified user.
+     * The connection needs to be closed manually.
+     * @param string $uid
+     * @return resource of the LDAP connection
+     */
+    public function getNewLDAPConnection($uid) {
+        return $this->handleRequest($uid, 'getNewLDAPConnection', array($uid));
+    }
 
-	/**
-	 * Creates a new user in LDAP
-	 * @param $username
-	 * @param $password
-	 * @return bool
-	 */
-	public function createUser($username, $password) {
-		return $this->handleRequest($username, 'createUser', array($username,$password));
-	}
+    /**
+     * Creates a new user in LDAP
+     * @param $username
+     * @param $password
+     * @return bool
+     */
+    public function createUser($username, $password) {
+        return $this->handleRequest($username, 'createUser', array($username,$password));
+    }
 }

Spacing +16 added lines, -16 removed lines

@@ -53,11 +53,11 @@ 
 		INotificationManager $notificationManager, IUserSession $userSession,
 								UserPluginManager $userPluginManager) {
 		parent::__construct($ldap);
-		foreach($serverConfigPrefixes as $configPrefix) {
+		foreach ($serverConfigPrefixes as $configPrefix) {
 			$this->backends[$configPrefix] =
 				new User_LDAP($this->getAccess($configPrefix), $ocConfig, $notificationManager, $userSession, $userPluginManager);
 
-			if(is_null($this->refBackend)) {
+			if (is_null($this->refBackend)) {
 				$this->refBackend = &$this->backends[$configPrefix];
 			}
 		}
@@ -72,13 +72,13 @@ 
 	 */
 	protected function walkBackends($uid, $method, $parameters) {
 		$cacheKey = $this->getUserCacheKey($uid);
-		foreach($this->backends as $configPrefix => $backend) {
+		foreach ($this->backends as $configPrefix => $backend) {
 			$instance = $backend;
-			if(!method_exists($instance, $method)
+			if (!method_exists($instance, $method)
 				&& method_exists($this->getAccess($configPrefix), $method)) {
 				$instance = $this->getAccess($configPrefix);
 			}
-			if($result = call_user_func_array(array($instance, $method), $parameters)) {
+			if ($result = call_user_func_array(array($instance, $method), $parameters)) {
 				$this->writeToCache($cacheKey, $configPrefix);
 				return $result;
 			}
@@ -98,22 +98,22 @@ 
 		$cacheKey = $this->getUserCacheKey($uid);
 		$prefix = $this->getFromCache($cacheKey);
 		//in case the uid has been found in the past, try this stored connection first
-		if(!is_null($prefix)) {
-			if(isset($this->backends[$prefix])) {
+		if (!is_null($prefix)) {
+			if (isset($this->backends[$prefix])) {
 				$instance = $this->backends[$prefix];
-				if(!method_exists($instance, $method)
+				if (!method_exists($instance, $method)
 					&& method_exists($this->getAccess($prefix), $method)) {
 					$instance = $this->getAccess($prefix);
 				}
 				$result = call_user_func_array(array($instance, $method), $parameters);
-				if($result === $passOnWhen) {
+				if ($result === $passOnWhen) {
 					//not found here, reset cache to null if user vanished
 					//because sometimes methods return false with a reason
 					$userExists = call_user_func_array(
 						array($this->backends[$prefix], 'userExists'),
 						array($uid)
 					);
-					if(!$userExists) {
+					if (!$userExists) {
 						$this->writeToCache($cacheKey, null);
 					}
 				}
@@ -155,7 +155,7 @@ 
 	public function getUsers($search = '', $limit = 10, $offset = 0) {
 		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
 		$users = array();
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendUsers = $backend->getUsers($search, $limit, $offset);
 			if (is_array($backendUsers)) {
 				$users = array_merge($users, $backendUsers);
@@ -203,7 +203,7 @@ 
 	 * @return string|false
 	 */
 	public function loginName2UserName($loginName) {
-		$id = 'LOGINNAME,' . $loginName;
+		$id = 'LOGINNAME,'.$loginName;
 		return $this->handleRequest($id, 'loginName2UserName', array($loginName));
 	}
 	
@@ -214,7 +214,7 @@ 
 	 * @return string|false with the username
 	 */
 	public function dn2UserName($dn) {
-		$id = 'DN,' . $dn;
+		$id = 'DN,'.$dn;
 		return $this->handleRequest($id, 'dn2UserName', array($dn));
 	}
 
@@ -266,7 +266,7 @@ 
 	public function getDisplayNames($search = '', $limit = null, $offset = null) {
 		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
 		$users = array();
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendUsers = $backend->getDisplayNames($search, $limit, $offset);
 			if (is_array($backendUsers)) {
 				$users = $users + $backendUsers;
@@ -310,7 +310,7 @@ 
 	 */
 	public function countUsers() {
 		$users = false;
-		foreach($this->backends as $backend) {
+		foreach ($this->backends as $backend) {
 			$backendUsers = $backend->countUsers();
 			if ($backendUsers !== false) {
 				$users += $backendUsers;
@@ -345,6 +345,6 @@ 
 	 * @return bool
 	 */
 	public function createUser($username, $password) {
-		return $this->handleRequest($username, 'createUser', array($username,$password));
+		return $this->handleRequest($username, 'createUser', array($username, $password));
 	}
 }

apps/user_ldap/lib/Jobs/CleanUp.php

Indentation +192 added lines, -192 removed lines

@@ -40,197 +40,197 @@
  * @package OCA\User_LDAP\Jobs;
  */
 class CleanUp extends TimedJob {
-	/** @var int $limit amount of users that should be checked per run */
-	protected $limit = 50;
-
-	/** @var int $defaultIntervalMin default interval in minutes */
-	protected $defaultIntervalMin = 51;
-
-	/** @var User_LDAP|User_Proxy $userBackend */
-	protected $userBackend;
-
-	/** @var \OCP\IConfig $ocConfig */
-	protected $ocConfig;
-
-	/** @var \OCP\IDBConnection $db */
-	protected $db;
-
-	/** @var Helper $ldapHelper */
-	protected $ldapHelper;
-
-	/** @var \OCA\User_LDAP\Mapping\UserMapping */
-	protected $mapping;
-
-	/** @var \OCA\User_LDAP\User\DeletedUsersIndex */
-	protected $dui;
-
-	public function __construct() {
-		$minutes = \OC::$server->getConfig()->getSystemValue(
-			'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
-		$this->setInterval(intval($minutes) * 60);
-	}
-
-	/**
-	 * assigns the instances passed to run() to the class properties
-	 * @param array $arguments
-	 */
-	public function setArguments($arguments) {
-		//Dependency Injection is not possible, because the constructor will
-		//only get values that are serialized to JSON. I.e. whatever we would
-		//pass in app.php we do add here, except something else is passed e.g.
-		//in tests.
-
-		if(isset($arguments['helper'])) {
-			$this->ldapHelper = $arguments['helper'];
-		} else {
-			$this->ldapHelper = new Helper(\OC::$server->getConfig());
-		}
-
-		if(isset($arguments['ocConfig'])) {
-			$this->ocConfig = $arguments['ocConfig'];
-		} else {
-			$this->ocConfig = \OC::$server->getConfig();
-		}
-
-		if(isset($arguments['userBackend'])) {
-			$this->userBackend = $arguments['userBackend'];
-		} else {
-			$this->userBackend =  new User_Proxy(
-				$this->ldapHelper->getServerConfigurationPrefixes(true),
-				new LDAP(),
-				$this->ocConfig,
-				\OC::$server->getNotificationManager(),
-				\OC::$server->getUserSession(),
-				\OC::$server->query('LDAPUserPluginManager')
-			);
-		}
-
-		if(isset($arguments['db'])) {
-			$this->db = $arguments['db'];
-		} else {
-			$this->db = \OC::$server->getDatabaseConnection();
-		}
-
-		if(isset($arguments['mapping'])) {
-			$this->mapping = $arguments['mapping'];
-		} else {
-			$this->mapping = new UserMapping($this->db);
-		}
-
-		if(isset($arguments['deletedUsersIndex'])) {
-			$this->dui = $arguments['deletedUsersIndex'];
-		} else {
-			$this->dui = new DeletedUsersIndex(
-				$this->ocConfig, $this->db, $this->mapping);
-		}
-	}
-
-	/**
-	 * makes the background job do its work
-	 * @param array $argument
-	 */
-	public function run($argument) {
-		$this->setArguments($argument);
-
-		if(!$this->isCleanUpAllowed()) {
-			return;
-		}
-		$users = $this->mapping->getList($this->getOffset(), $this->limit);
-		if(!is_array($users)) {
-			//something wrong? Let's start from the beginning next time and
-			//abort
-			$this->setOffset(true);
-			return;
-		}
-		$resetOffset = $this->isOffsetResetNecessary(count($users));
-		$this->checkUsers($users);
-		$this->setOffset($resetOffset);
-	}
-
-	/**
-	 * checks whether next run should start at 0 again
-	 * @param int $resultCount
-	 * @return bool
-	 */
-	public function isOffsetResetNecessary($resultCount) {
-		return ($resultCount < $this->limit) ? true : false;
-	}
-
-	/**
-	 * checks whether cleaning up LDAP users is allowed
-	 * @return bool
-	 */
-	public function isCleanUpAllowed() {
-		try {
-			if($this->ldapHelper->haveDisabledConfigurations()) {
-				return false;
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-
-		$enabled = $this->isCleanUpEnabled();
-
-		return $enabled;
-	}
-
-	/**
-	 * checks whether clean up is enabled by configuration
-	 * @return bool
-	 */
-	private function isCleanUpEnabled() {
-		return (bool)$this->ocConfig->getSystemValue(
-			'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
-	}
-
-	/**
-	 * checks users whether they are still existing
-	 * @param array $users result from getMappedUsers()
-	 */
-	private function checkUsers(array $users) {
-		foreach($users as $user) {
-			$this->checkUser($user);
-		}
-	}
-
-	/**
-	 * checks whether a user is still existing in LDAP
-	 * @param string[] $user
-	 */
-	private function checkUser(array $user) {
-		if($this->userBackend->userExistsOnLDAP($user['name'])) {
-			//still available, all good
-
-			return;
-		}
-
-		$this->dui->markUser($user['name']);
-	}
-
-	/**
-	 * gets the offset to fetch users from the mappings table
-	 * @return int
-	 */
-	private function getOffset() {
-		return intval($this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0));
-	}
-
-	/**
-	 * sets the new offset for the next run
-	 * @param bool $reset whether the offset should be set to 0
-	 */
-	public function setOffset($reset = false) {
-		$newOffset = $reset ? 0 :
-			$this->getOffset() + $this->limit;
-		$this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
-	}
-
-	/**
-	 * returns the chunk size (limit in DB speak)
-	 * @return int
-	 */
-	public function getChunkSize() {
-		return $this->limit;
-	}
+    /** @var int $limit amount of users that should be checked per run */
+    protected $limit = 50;
+
+    /** @var int $defaultIntervalMin default interval in minutes */
+    protected $defaultIntervalMin = 51;
+
+    /** @var User_LDAP|User_Proxy $userBackend */
+    protected $userBackend;
+
+    /** @var \OCP\IConfig $ocConfig */
+    protected $ocConfig;
+
+    /** @var \OCP\IDBConnection $db */
+    protected $db;
+
+    /** @var Helper $ldapHelper */
+    protected $ldapHelper;
+
+    /** @var \OCA\User_LDAP\Mapping\UserMapping */
+    protected $mapping;
+
+    /** @var \OCA\User_LDAP\User\DeletedUsersIndex */
+    protected $dui;
+
+    public function __construct() {
+        $minutes = \OC::$server->getConfig()->getSystemValue(
+            'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
+        $this->setInterval(intval($minutes) * 60);
+    }
+
+    /**
+     * assigns the instances passed to run() to the class properties
+     * @param array $arguments
+     */
+    public function setArguments($arguments) {
+        //Dependency Injection is not possible, because the constructor will
+        //only get values that are serialized to JSON. I.e. whatever we would
+        //pass in app.php we do add here, except something else is passed e.g.
+        //in tests.
+
+        if(isset($arguments['helper'])) {
+            $this->ldapHelper = $arguments['helper'];
+        } else {
+            $this->ldapHelper = new Helper(\OC::$server->getConfig());
+        }
+
+        if(isset($arguments['ocConfig'])) {
+            $this->ocConfig = $arguments['ocConfig'];
+        } else {
+            $this->ocConfig = \OC::$server->getConfig();
+        }
+
+        if(isset($arguments['userBackend'])) {
+            $this->userBackend = $arguments['userBackend'];
+        } else {
+            $this->userBackend =  new User_Proxy(
+                $this->ldapHelper->getServerConfigurationPrefixes(true),
+                new LDAP(),
+                $this->ocConfig,
+                \OC::$server->getNotificationManager(),
+                \OC::$server->getUserSession(),
+                \OC::$server->query('LDAPUserPluginManager')
+            );
+        }
+
+        if(isset($arguments['db'])) {
+            $this->db = $arguments['db'];
+        } else {
+            $this->db = \OC::$server->getDatabaseConnection();
+        }
+
+        if(isset($arguments['mapping'])) {
+            $this->mapping = $arguments['mapping'];
+        } else {
+            $this->mapping = new UserMapping($this->db);
+        }
+
+        if(isset($arguments['deletedUsersIndex'])) {
+            $this->dui = $arguments['deletedUsersIndex'];
+        } else {
+            $this->dui = new DeletedUsersIndex(
+                $this->ocConfig, $this->db, $this->mapping);
+        }
+    }
+
+    /**
+     * makes the background job do its work
+     * @param array $argument
+     */
+    public function run($argument) {
+        $this->setArguments($argument);
+
+        if(!$this->isCleanUpAllowed()) {
+            return;
+        }
+        $users = $this->mapping->getList($this->getOffset(), $this->limit);
+        if(!is_array($users)) {
+            //something wrong? Let's start from the beginning next time and
+            //abort
+            $this->setOffset(true);
+            return;
+        }
+        $resetOffset = $this->isOffsetResetNecessary(count($users));
+        $this->checkUsers($users);
+        $this->setOffset($resetOffset);
+    }
+
+    /**
+     * checks whether next run should start at 0 again
+     * @param int $resultCount
+     * @return bool
+     */
+    public function isOffsetResetNecessary($resultCount) {
+        return ($resultCount < $this->limit) ? true : false;
+    }
+
+    /**
+     * checks whether cleaning up LDAP users is allowed
+     * @return bool
+     */
+    public function isCleanUpAllowed() {
+        try {
+            if($this->ldapHelper->haveDisabledConfigurations()) {
+                return false;
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+
+        $enabled = $this->isCleanUpEnabled();
+
+        return $enabled;
+    }
+
+    /**
+     * checks whether clean up is enabled by configuration
+     * @return bool
+     */
+    private function isCleanUpEnabled() {
+        return (bool)$this->ocConfig->getSystemValue(
+            'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
+    }
+
+    /**
+     * checks users whether they are still existing
+     * @param array $users result from getMappedUsers()
+     */
+    private function checkUsers(array $users) {
+        foreach($users as $user) {
+            $this->checkUser($user);
+        }
+    }
+
+    /**
+     * checks whether a user is still existing in LDAP
+     * @param string[] $user
+     */
+    private function checkUser(array $user) {
+        if($this->userBackend->userExistsOnLDAP($user['name'])) {
+            //still available, all good
+
+            return;
+        }
+
+        $this->dui->markUser($user['name']);
+    }
+
+    /**
+     * gets the offset to fetch users from the mappings table
+     * @return int
+     */
+    private function getOffset() {
+        return intval($this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0));
+    }
+
+    /**
+     * sets the new offset for the next run
+     * @param bool $reset whether the offset should be set to 0
+     */
+    public function setOffset($reset = false) {
+        $newOffset = $reset ? 0 :
+            $this->getOffset() + $this->limit;
+        $this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
+    }
+
+    /**
+     * returns the chunk size (limit in DB speak)
+     * @return int
+     */
+    public function getChunkSize() {
+        return $this->limit;
+    }
 
 }