nextcloud / server

apps/user_ldap/lib/User_LDAP.php

Indentation +568 added lines, -568 removed lines

@@ -51,576 +51,576 @@
 use OCP\Util;
 
 class User_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP {
-	/** @var \OCP\IConfig */
-	protected $ocConfig;
-
-	/** @var INotificationManager */
-	protected $notificationManager;
-
-	/** @var string */
-	protected $currentUserInDeletionProcess;
-
-	/** @var UserPluginManager */
-	protected $userPluginManager;
-
-	/**
-	 * @param Access $access
-	 * @param \OCP\IConfig $ocConfig
-	 * @param \OCP\Notification\IManager $notificationManager
-	 * @param IUserSession $userSession
-	 */
-	public function __construct(Access $access, IConfig $ocConfig, INotificationManager $notificationManager, IUserSession $userSession, UserPluginManager $userPluginManager) {
-		parent::__construct($access);
-		$this->ocConfig = $ocConfig;
-		$this->notificationManager = $notificationManager;
-		$this->userPluginManager = $userPluginManager;
-		$this->registerHooks($userSession);
-	}
-
-	protected function registerHooks(IUserSession $userSession) {
-		$userSession->listen('\OC\User', 'preDelete', [$this, 'preDeleteUser']);
-		$userSession->listen('\OC\User', 'postDelete', [$this, 'postDeleteUser']);
-	}
-
-	public function preDeleteUser(IUser $user) {
-		$this->currentUserInDeletionProcess = $user->getUID();
-	}
-
-	public function postDeleteUser() {
-		$this->currentUserInDeletionProcess = null;
-	}
-
-	/**
-	 * 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) {
-		if ($this->userPluginManager->implementsActions(Backend::PROVIDE_AVATAR)) {
-			return $this->userPluginManager->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 \OCP\IConfig */
+    protected $ocConfig;
+
+    /** @var INotificationManager */
+    protected $notificationManager;
+
+    /** @var string */
+    protected $currentUserInDeletionProcess;
+
+    /** @var UserPluginManager */
+    protected $userPluginManager;
+
+    /**
+     * @param Access $access
+     * @param \OCP\IConfig $ocConfig
+     * @param \OCP\Notification\IManager $notificationManager
+     * @param IUserSession $userSession
+     */
+    public function __construct(Access $access, IConfig $ocConfig, INotificationManager $notificationManager, IUserSession $userSession, UserPluginManager $userPluginManager) {
+        parent::__construct($access);
+        $this->ocConfig = $ocConfig;
+        $this->notificationManager = $notificationManager;
+        $this->userPluginManager = $userPluginManager;
+        $this->registerHooks($userSession);
+    }
+
+    protected function registerHooks(IUserSession $userSession) {
+        $userSession->listen('\OC\User', 'preDelete', [$this, 'preDeleteUser']);
+        $userSession->listen('\OC\User', 'postDelete', [$this, 'postDeleteUser']);
+    }
+
+    public function preDeleteUser(IUser $user) {
+        $this->currentUserInDeletionProcess = $user->getUID();
+    }
+
+    public function postDeleteUser() {
+        $this->currentUserInDeletionProcess = null;
+    }
+
+    /**
+     * 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) {
+        if ($this->userPluginManager->implementsActions(Backend::PROVIDE_AVATAR)) {
+            return $this->userPluginManager->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) {
-		if ($this->userPluginManager->implementsActions(Backend::SET_PASSWORD)) {
-			return $this->userPluginManager->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 && $this->access->setPassword($user->getDN(), $password)) {
-			$ldapDefaultPPolicyDN = $this->access->connection->ldapDefaultPPolicyDN;
-			$turnOnPasswordChange = $this->access->connection->turnOnPasswordChange;
-			if (!empty($ldapDefaultPPolicyDN) && ((int)$turnOnPasswordChange === 1)) {
-				//remove last password expiry warning if any
-				$notification = $this->notificationManager->createNotification();
-				$notification->setApp('user_ldap')
-					->setUser($uid)
-					->setObject('pwd_exp_warn', $uid)
-				;
-				$this->notificationManager->markProcessed($notification);
-			}
-			return true;
-		}
-
-		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 Nextcloud names
-		$ldap_users = $this->access->fetchListOfUsers(
-			$filter,
-			$this->access->userManager->getAttributes(true),
-			$limit, $offset);
-		$ldap_users = $this->access->nextcloudUserNames($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 Nextcloud 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 (ServerNotAvailableException $e) {
-				throw $e;
-			} 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) {
-		if ($this->userPluginManager->canDeleteUser()) {
-			return $this->userPluginManager->deleteUser($uid);
-		}
-
-		$marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
-		if((int)$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'));
-
-		$this->access->getUserMapper()->unmap($uid); // we don't emit revoke signals here, since it is implicit to delete signals fired from core
-		$this->access->userManager->invalidate($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) {
-		// user Exists check required as it is not done in user proxy!
-		if(!$this->userExists($uid)) {
-			return false;
-		}
-
-		if ($this->userPluginManager->implementsActions(Backend::GET_HOME)) {
-			return $this->userPluginManager->getHome($uid);
-		}
-
-		$cacheKey = 'getHome'.$uid;
-		$path = $this->access->connection->getFromCache($cacheKey);
-		if(!is_null($path)) {
-			return $path;
-		}
-
-		// early return path if it is a deleted user
-		$user = $this->access->userManager->get($uid);
-		if($user instanceof OfflineUser) {
-			if($this->currentUserInDeletionProcess !== null
-				&& $this->currentUserInDeletionProcess === $user->getOCName()
-			) {
-				return $user->getHomePath();
-			} else {
-				throw new NoUserException($uid . ' is not a valid user anymore');
-			}
-		} else if ($user === null) {
-			throw new NoUserException($uid . ' is not a valid user anymore');
-		}
-
-		$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->userPluginManager->implementsActions(Backend::GET_DISPLAYNAME)) {
-			return $this->userPluginManager->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;
-	}
-
-	/**
-	 * set display name of the user
-	 * @param string $uid user ID of the user
-	 * @param string $displayName new display name of the user
-	 * @return string|false display name
-	 */
-	public function setDisplayName($uid, $displayName) {
-		if ($this->userPluginManager->implementsActions(Backend::SET_DISPLAYNAME)) {
-			return $this->userPluginManager->setDisplayName($uid, $displayName);
-		}
-		return false;
-	}
-
-	/**
-	 * 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
-			| (((int)$this->access->connection->turnOnPasswordChange === 1)? Backend::SET_PASSWORD :0)
-			| $this->userPluginManager->getImplementedActions())
-			& $actions);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasUserListings() {
-		return true;
-	}
-
-	/**
-	 * counts the users in LDAP
-	 *
-	 * @return int|bool
-	 */
-	public function countUsers() {
-		if ($this->userPluginManager->implementsActions(Backend::COUNT_USERS)) {
-			return $this->userPluginManager->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) {
+        if ($this->userPluginManager->implementsActions(Backend::SET_PASSWORD)) {
+            return $this->userPluginManager->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 && $this->access->setPassword($user->getDN(), $password)) {
+            $ldapDefaultPPolicyDN = $this->access->connection->ldapDefaultPPolicyDN;
+            $turnOnPasswordChange = $this->access->connection->turnOnPasswordChange;
+            if (!empty($ldapDefaultPPolicyDN) && ((int)$turnOnPasswordChange === 1)) {
+                //remove last password expiry warning if any
+                $notification = $this->notificationManager->createNotification();
+                $notification->setApp('user_ldap')
+                    ->setUser($uid)
+                    ->setObject('pwd_exp_warn', $uid)
+                ;
+                $this->notificationManager->markProcessed($notification);
+            }
+            return true;
+        }
+
+        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 Nextcloud names
+        $ldap_users = $this->access->fetchListOfUsers(
+            $filter,
+            $this->access->userManager->getAttributes(true),
+            $limit, $offset);
+        $ldap_users = $this->access->nextcloudUserNames($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 Nextcloud 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 (ServerNotAvailableException $e) {
+                throw $e;
+            } 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) {
+        if ($this->userPluginManager->canDeleteUser()) {
+            return $this->userPluginManager->deleteUser($uid);
+        }
+
+        $marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
+        if((int)$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'));
+
+        $this->access->getUserMapper()->unmap($uid); // we don't emit revoke signals here, since it is implicit to delete signals fired from core
+        $this->access->userManager->invalidate($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) {
+        // user Exists check required as it is not done in user proxy!
+        if(!$this->userExists($uid)) {
+            return false;
+        }
+
+        if ($this->userPluginManager->implementsActions(Backend::GET_HOME)) {
+            return $this->userPluginManager->getHome($uid);
+        }
+
+        $cacheKey = 'getHome'.$uid;
+        $path = $this->access->connection->getFromCache($cacheKey);
+        if(!is_null($path)) {
+            return $path;
+        }
+
+        // early return path if it is a deleted user
+        $user = $this->access->userManager->get($uid);
+        if($user instanceof OfflineUser) {
+            if($this->currentUserInDeletionProcess !== null
+                && $this->currentUserInDeletionProcess === $user->getOCName()
+            ) {
+                return $user->getHomePath();
+            } else {
+                throw new NoUserException($uid . ' is not a valid user anymore');
+            }
+        } else if ($user === null) {
+            throw new NoUserException($uid . ' is not a valid user anymore');
+        }
+
+        $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->userPluginManager->implementsActions(Backend::GET_DISPLAYNAME)) {
+            return $this->userPluginManager->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;
+    }
+
+    /**
+     * set display name of the user
+     * @param string $uid user ID of the user
+     * @param string $displayName new display name of the user
+     * @return string|false display name
+     */
+    public function setDisplayName($uid, $displayName) {
+        if ($this->userPluginManager->implementsActions(Backend::SET_DISPLAYNAME)) {
+            return $this->userPluginManager->setDisplayName($uid, $displayName);
+        }
+        return false;
+    }
+
+    /**
+     * 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
+            | (((int)$this->access->connection->turnOnPasswordChange === 1)? Backend::SET_PASSWORD :0)
+            | $this->userPluginManager->getImplementedActions())
+            & $actions);
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasUserListings() {
+        return true;
+    }
+
+    /**
+     * counts the users in LDAP
+     *
+     * @return int|bool
+     */
+    public function countUsers() {
+        if ($this->userPluginManager->implementsActions(Backend::COUNT_USERS)) {
+            return $this->userPluginManager->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();
-	}
-
-	/**
-	 * create new user
-	 * @param string $username username of the new user
-	 * @param string $password password of the new user
-	 * @return bool was the user created?
-	 */
-	public function createUser($username, $password) {
-		if ($this->userPluginManager->implementsActions(Backend::CREATE_USER)) {
-			return $this->userPluginManager->createUser($username, $password);
-		}
-		return false;
-	}
+    /**
+     * 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();
+    }
+
+    /**
+     * create new user
+     * @param string $username username of the new user
+     * @param string $password password of the new user
+     * @return bool was the user created?
+     */
+    public function createUser($username, $password) {
+        if ($this->userPluginManager->implementsActions(Backend::CREATE_USER)) {
+            return $this->userPluginManager->createUser($username, $password);
+        }
+        return false;
+    }
 
 }

apps/user_ldap/lib/Mapping/AbstractMapping.php

Indentation +239 added lines, -239 removed lines

@@ -29,293 +29,293 @@
 * @package OCA\User_LDAP\Mapping
 */
 abstract class AbstractMapping {
-	/**
-	 * @var \OCP\IDBConnection $dbc
-	 */
-	protected $dbc;
+    /**
+     * @var \OCP\IDBConnection $dbc
+     */
+    protected $dbc;
 
-	/**
-	 * returns the DB table name which holds the mappings
-	 * @return string
-	 */
-	abstract protected function getTableName();
+    /**
+     * returns the DB table name which holds the mappings
+     * @return string
+     */
+    abstract protected function getTableName();
 
-	/**
-	 * @param \OCP\IDBConnection $dbc
-	 */
-	public function __construct(\OCP\IDBConnection $dbc) {
-		$this->dbc = $dbc;
-	}
+    /**
+     * @param \OCP\IDBConnection $dbc
+     */
+    public function __construct(\OCP\IDBConnection $dbc) {
+        $this->dbc = $dbc;
+    }
 
-	/**
-	 * checks whether a provided string represents an existing table col
-	 * @param string $col
-	 * @return bool
-	 */
-	public function isColNameValid($col) {
-		switch($col) {
-			case 'ldap_dn':
-			case 'owncloud_name':
-			case 'directory_uuid':
-				return true;
-			default:
-				return false;
-		}
-	}
+    /**
+     * checks whether a provided string represents an existing table col
+     * @param string $col
+     * @return bool
+     */
+    public function isColNameValid($col) {
+        switch($col) {
+            case 'ldap_dn':
+            case 'owncloud_name':
+            case 'directory_uuid':
+                return true;
+            default:
+                return false;
+        }
+    }
 
-	/**
-	 * Gets the value of one column based on a provided value of another column
-	 * @param string $fetchCol
-	 * @param string $compareCol
-	 * @param string $search
-	 * @throws \Exception
-	 * @return string|false
-	 */
-	protected function getXbyY($fetchCol, $compareCol, $search) {
-		if(!$this->isColNameValid($fetchCol)) {
-			//this is used internally only, but we don't want to risk
-			//having SQL injection at all.
-			throw new \Exception('Invalid Column Name');
-		}
-		$query = $this->dbc->prepare('
+    /**
+     * Gets the value of one column based on a provided value of another column
+     * @param string $fetchCol
+     * @param string $compareCol
+     * @param string $search
+     * @throws \Exception
+     * @return string|false
+     */
+    protected function getXbyY($fetchCol, $compareCol, $search) {
+        if(!$this->isColNameValid($fetchCol)) {
+            //this is used internally only, but we don't want to risk
+            //having SQL injection at all.
+            throw new \Exception('Invalid Column Name');
+        }
+        $query = $this->dbc->prepare('
 			SELECT `' . $fetchCol . '`
 			FROM `'. $this->getTableName() .'`
 			WHERE `' . $compareCol . '` = ?
 		');
 
-		$res = $query->execute(array($search));
-		if($res !== false) {
-			return $query->fetchColumn();
-		}
+        $res = $query->execute(array($search));
+        if($res !== false) {
+            return $query->fetchColumn();
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Performs a DELETE or UPDATE query to the database.
-	 * @param \Doctrine\DBAL\Driver\Statement $query
-	 * @param array $parameters
-	 * @return bool true if at least one row was modified, false otherwise
-	 */
-	protected function modify($query, $parameters) {
-		$result = $query->execute($parameters);
-		return ($result === true && $query->rowCount() > 0);
-	}
+    /**
+     * Performs a DELETE or UPDATE query to the database.
+     * @param \Doctrine\DBAL\Driver\Statement $query
+     * @param array $parameters
+     * @return bool true if at least one row was modified, false otherwise
+     */
+    protected function modify($query, $parameters) {
+        $result = $query->execute($parameters);
+        return ($result === true && $query->rowCount() > 0);
+    }
 
-	/**
-	 * Gets the LDAP DN based on the provided name.
-	 * Replaces Access::ocname2dn
-	 * @param string $name
-	 * @return string|false
-	 */
-	public function getDNByName($name) {
-		return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
-	}
+    /**
+     * Gets the LDAP DN based on the provided name.
+     * Replaces Access::ocname2dn
+     * @param string $name
+     * @return string|false
+     */
+    public function getDNByName($name) {
+        return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
+    }
 
-	/**
-	 * Updates the DN based on the given UUID
-	 * @param string $fdn
-	 * @param string $uuid
-	 * @return bool
-	 */
-	public function setDNbyUUID($fdn, $uuid) {
-		$query = $this->dbc->prepare('
+    /**
+     * Updates the DN based on the given UUID
+     * @param string $fdn
+     * @param string $uuid
+     * @return bool
+     */
+    public function setDNbyUUID($fdn, $uuid) {
+        $query = $this->dbc->prepare('
 			UPDATE `' . $this->getTableName() . '`
 			SET `ldap_dn` = ?
 			WHERE `directory_uuid` = ?
 		');
 
-		return $this->modify($query, array($fdn, $uuid));
-	}
+        return $this->modify($query, array($fdn, $uuid));
+    }
 
-	/**
-	 * Updates the UUID based on the given DN
-	 *
-	 * required by Migration/UUIDFix
-	 *
-	 * @param $uuid
-	 * @param $fdn
-	 * @return bool
-	 */
-	public function setUUIDbyDN($uuid, $fdn) {
-		$query = $this->dbc->prepare('
+    /**
+     * Updates the UUID based on the given DN
+     *
+     * required by Migration/UUIDFix
+     *
+     * @param $uuid
+     * @param $fdn
+     * @return bool
+     */
+    public function setUUIDbyDN($uuid, $fdn) {
+        $query = $this->dbc->prepare('
 			UPDATE `' . $this->getTableName() . '`
 			SET `directory_uuid` = ?
 			WHERE `ldap_dn` = ?
 		');
 
-		return $this->modify($query, [$uuid, $fdn]);
-	}
+        return $this->modify($query, [$uuid, $fdn]);
+    }
 
-	/**
-	 * Gets the name based on the provided LDAP DN.
-	 * @param string $fdn
-	 * @return string|false
-	 */
-	public function getNameByDN($fdn) {
-		return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
-	}
+    /**
+     * Gets the name based on the provided LDAP DN.
+     * @param string $fdn
+     * @return string|false
+     */
+    public function getNameByDN($fdn) {
+        return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
+    }
 
-	/**
-	 * Searches mapped names by the giving string in the name column
-	 * @param string $search
-	 * @param string $prefixMatch
-	 * @param string $postfixMatch
-	 * @return string[]
-	 */
-	public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
-		$query = $this->dbc->prepare('
+    /**
+     * Searches mapped names by the giving string in the name column
+     * @param string $search
+     * @param string $prefixMatch
+     * @param string $postfixMatch
+     * @return string[]
+     */
+    public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
+        $query = $this->dbc->prepare('
 			SELECT `owncloud_name`
 			FROM `'. $this->getTableName() .'`
 			WHERE `owncloud_name` LIKE ?
 		');
 
-		$res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch));
-		$names = array();
-		if($res !== false) {
-			while($row = $query->fetch()) {
-				$names[] = $row['owncloud_name'];
-			}
-		}
-		return $names;
-	}
+        $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch));
+        $names = array();
+        if($res !== false) {
+            while($row = $query->fetch()) {
+                $names[] = $row['owncloud_name'];
+            }
+        }
+        return $names;
+    }
 
-	/**
-	 * Gets the name based on the provided LDAP UUID.
-	 * @param string $uuid
-	 * @return string|false
-	 */
-	public function getNameByUUID($uuid) {
-		return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
-	}
+    /**
+     * Gets the name based on the provided LDAP UUID.
+     * @param string $uuid
+     * @return string|false
+     */
+    public function getNameByUUID($uuid) {
+        return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
+    }
 
-	/**
-	 * Gets the UUID based on the provided LDAP DN
-	 * @param string $dn
-	 * @return false|string
-	 * @throws \Exception
-	 */
-	public function getUUIDByDN($dn) {
-		return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
-	}
+    /**
+     * Gets the UUID based on the provided LDAP DN
+     * @param string $dn
+     * @return false|string
+     * @throws \Exception
+     */
+    public function getUUIDByDN($dn) {
+        return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
+    }
 
-	/**
-	 * gets a piece of the mapping list
-	 * @param int $offset
-	 * @param int $limit
-	 * @return array
-	 */
-	public function getList($offset = null, $limit = null) {
-		$query = $this->dbc->prepare('
+    /**
+     * gets a piece of the mapping list
+     * @param int $offset
+     * @param int $limit
+     * @return array
+     */
+    public function getList($offset = null, $limit = null) {
+        $query = $this->dbc->prepare('
 			SELECT
 				`ldap_dn` AS `dn`,
 				`owncloud_name` AS `name`,
 				`directory_uuid` AS `uuid`
 			FROM `' . $this->getTableName() . '`',
-			$limit,
-			$offset
-		);
+            $limit,
+            $offset
+        );
 
-		$query->execute();
-		return $query->fetchAll();
-	}
+        $query->execute();
+        return $query->fetchAll();
+    }
 
-	/**
-	 * attempts to map the given entry
-	 * @param string $fdn fully distinguished name (from LDAP)
-	 * @param string $name
-	 * @param string $uuid a unique identifier as used in LDAP
-	 * @return bool
-	 */
-	public function map($fdn, $name, $uuid) {
-		if(mb_strlen($fdn) > 255) {
-			\OC::$server->getLogger()->error(
-				'Cannot map, because the DN exceeds 255 characters: {dn}',
-				[
-					'app' => 'user_ldap',
-					'dn' => $fdn,
-				]
-			);
-			return false;
-		}
+    /**
+     * attempts to map the given entry
+     * @param string $fdn fully distinguished name (from LDAP)
+     * @param string $name
+     * @param string $uuid a unique identifier as used in LDAP
+     * @return bool
+     */
+    public function map($fdn, $name, $uuid) {
+        if(mb_strlen($fdn) > 255) {
+            \OC::$server->getLogger()->error(
+                'Cannot map, because the DN exceeds 255 characters: {dn}',
+                [
+                    'app' => 'user_ldap',
+                    'dn' => $fdn,
+                ]
+            );
+            return false;
+        }
 
-		$row = array(
-			'ldap_dn'        => $fdn,
-			'owncloud_name'  => $name,
-			'directory_uuid' => $uuid
-		);
+        $row = array(
+            'ldap_dn'        => $fdn,
+            'owncloud_name'  => $name,
+            'directory_uuid' => $uuid
+        );
 
-		try {
-			$result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
-			// insertIfNotExist returns values as int
-			return (bool)$result;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
+        try {
+            $result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
+            // insertIfNotExist returns values as int
+            return (bool)$result;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * removes a mapping based on the owncloud_name of the entry
-	 * @param string $name
-	 * @return bool
-	 */
-	public function unmap($name) {
-		$query = $this->dbc->prepare('
+    /**
+     * removes a mapping based on the owncloud_name of the entry
+     * @param string $name
+     * @return bool
+     */
+    public function unmap($name) {
+        $query = $this->dbc->prepare('
 			DELETE FROM `'. $this->getTableName() .'`
 			WHERE `owncloud_name` = ?');
 
-		return $this->modify($query, array($name));
-	}
+        return $this->modify($query, array($name));
+    }
 
-	/**
-	 * Truncate's the mapping table
-	 * @return bool
-	 */
-	public function clear() {
-		$sql = $this->dbc
-			->getDatabasePlatform()
-			->getTruncateTableSQL('`' . $this->getTableName() . '`');
-		return $this->dbc->prepare($sql)->execute();
-	}
+    /**
+     * Truncate's the mapping table
+     * @return bool
+     */
+    public function clear() {
+        $sql = $this->dbc
+            ->getDatabasePlatform()
+            ->getTruncateTableSQL('`' . $this->getTableName() . '`');
+        return $this->dbc->prepare($sql)->execute();
+    }
 
-	/**
-	 * clears the mapping table one by one and executing a callback with
-	 * each row's id (=owncloud_name col)
-	 *
-	 * @param callable $preCallback
-	 * @param callable $postCallback
-	 * @return bool true on success, false when at least one row was not
-	 * deleted
-	 */
-	public function clearCb(Callable $preCallback, Callable $postCallback): bool {
-		$picker = $this->dbc->getQueryBuilder();
-		$picker->select('owncloud_name')
-			->from($this->getTableName());
-		$cursor = $picker->execute();
-		$result = true;
-		while($id = $cursor->fetchColumn(0)) {
-			$preCallback($id);
-			if($isUnmapped = $this->unmap($id)) {
-				$postCallback($id);
-			}
-			$result &= $isUnmapped;
-		}
-		$cursor->closeCursor();
-		return $result;
-	}
+    /**
+     * clears the mapping table one by one and executing a callback with
+     * each row's id (=owncloud_name col)
+     *
+     * @param callable $preCallback
+     * @param callable $postCallback
+     * @return bool true on success, false when at least one row was not
+     * deleted
+     */
+    public function clearCb(Callable $preCallback, Callable $postCallback): bool {
+        $picker = $this->dbc->getQueryBuilder();
+        $picker->select('owncloud_name')
+            ->from($this->getTableName());
+        $cursor = $picker->execute();
+        $result = true;
+        while($id = $cursor->fetchColumn(0)) {
+            $preCallback($id);
+            if($isUnmapped = $this->unmap($id)) {
+                $postCallback($id);
+            }
+            $result &= $isUnmapped;
+        }
+        $cursor->closeCursor();
+        return $result;
+    }
 
-	/**
-	 * returns the number of entries in the mappings table
-	 *
-	 * @return int
-	 */
-	public function count() {
-		$qb = $this->dbc->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`ldap_dn`)'))
-			->from($this->getTableName());
-		$res = $query->execute();
-		$count = $res->fetchColumn();
-		$res->closeCursor();
-		return (int)$count;
-	}
+    /**
+     * returns the number of entries in the mappings table
+     *
+     * @return int
+     */
+    public function count() {
+        $qb = $this->dbc->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`ldap_dn`)'))
+            ->from($this->getTableName());
+        $res = $query->execute();
+        $count = $res->fetchColumn();
+        $res->closeCursor();
+        return (int)$count;
+    }
 }

apps/admin_audit/lib/Actions/UserManagement.php

Indentation +86 added lines, -86 removed lines

@@ -35,95 +35,95 @@
  * @package OCA\AdminAudit\Actions
  */
 class UserManagement extends Action {
-	/**
-	 * Log creation of users
-	 *
-	 * @param array $params
-	 */
-	public function create(array $params) {
-		$this->log(
-			'User created: "%s"',
-			$params,
-			[
-				'uid',
-			]
-		);
-	}
+    /**
+     * Log creation of users
+     *
+     * @param array $params
+     */
+    public function create(array $params) {
+        $this->log(
+            'User created: "%s"',
+            $params,
+            [
+                'uid',
+            ]
+        );
+    }
 
-	/**
-	 * Log assignments of users (typically user backends)
-	 *
-	 * @param string $uid
-	 */
-	public function announce(string $uid) {
-		$this->log(
-		'UserID assgined: "%s"',
-			[ 'uid' => $uid ],
-			[ 'uid' ]
-		);
-	}
+    /**
+     * Log assignments of users (typically user backends)
+     *
+     * @param string $uid
+     */
+    public function announce(string $uid) {
+        $this->log(
+        'UserID assgined: "%s"',
+            [ 'uid' => $uid ],
+            [ 'uid' ]
+        );
+    }
 
-	/**
-	 * Log deletion of users
-	 *
-	 * @param array $params
-	 */
-	public function delete(array $params) {
-		$this->log(
-			'User deleted: "%s"',
-			$params,
-			[
-				'uid',
-			]
-		);
-	}
+    /**
+     * Log deletion of users
+     *
+     * @param array $params
+     */
+    public function delete(array $params) {
+        $this->log(
+            'User deleted: "%s"',
+            $params,
+            [
+                'uid',
+            ]
+        );
+    }
 
-	/**
-	 * Log unassignments of users (typically user backends, no data removed)
-	 *
-	 * @param string $uid
-	 */
-	public function revoke(string $uid) {
-		$this->log(
-			'UserID unassigned: "%s"',
-			[ 'uid' => $uid ],
-			[ 'uid' ]
-		);
-	}
+    /**
+     * Log unassignments of users (typically user backends, no data removed)
+     *
+     * @param string $uid
+     */
+    public function revoke(string $uid) {
+        $this->log(
+            'UserID unassigned: "%s"',
+            [ 'uid' => $uid ],
+            [ 'uid' ]
+        );
+    }
 
-	/**
-	 * Log enabling of users
-	 *
-	 * @param array $params
-	 */
-	public function change(array $params) {
-		if ($params['feature'] === 'enabled') {
-			$this->log(
-				$params['value'] === 'true' ? 'User enabled: "%s"' : 'User disabled: "%s"',
-				['user' => $params['user']->getUID()],
-				[
-					'user',
-				]
-			);
-		}
-	}
+    /**
+     * Log enabling of users
+     *
+     * @param array $params
+     */
+    public function change(array $params) {
+        if ($params['feature'] === 'enabled') {
+            $this->log(
+                $params['value'] === 'true' ? 'User enabled: "%s"' : 'User disabled: "%s"',
+                ['user' => $params['user']->getUID()],
+                [
+                    'user',
+                ]
+            );
+        }
+    }
 
-	/**
-	 * Logs changing of the user scope
-	 *
-	 * @param IUser $user
-	 */
-	public function setPassword(IUser $user) {
-		if($user->getBackendClassName() === 'Database') {
-			$this->log(
-				'Password of user "%s" has been changed',
-				[
-					'user' => $user->getUID(),
-				],
-				[
-					'user',
-				]
-			);
-		}
-	}
+    /**
+     * Logs changing of the user scope
+     *
+     * @param IUser $user
+     */
+    public function setPassword(IUser $user) {
+        if($user->getBackendClassName() === 'Database') {
+            $this->log(
+                'Password of user "%s" has been changed',
+                [
+                    'user' => $user->getUID(),
+                ],
+                [
+                    'user',
+                ]
+            );
+        }
+    }
 }

apps/admin_audit/lib/AppInfo/Application.php

Indentation +185 added lines, -185 removed lines

@@ -53,189 +53,189 @@
 
 class Application extends App {
 
-	public function __construct() {
-		parent::__construct('admin_audit');
-	}
-
-	public function register() {
-		$this->registerHooks();
-	}
-
-	/**
-	 * Register hooks in order to log them
-	 */
-	protected function registerHooks() {
-		$logger = $this->getContainer()->getServer()->getLogger();
-
-		$this->userManagementHooks($logger);
-		$this->groupHooks($logger);
-		$this->authHooks($logger);
-
-		$this->consoleHooks($logger);
-		$this->appHooks($logger);
-
-		$this->sharingHooks($logger);
-
-		$this->fileHooks($logger);
-		$this->trashbinHooks($logger);
-		$this->versionsHooks($logger);
-
-		$this->securityHooks($logger);
-	}
-
-	protected function userManagementHooks(ILogger $logger) {
-		$userActions = new UserManagement($logger);
-
-		Util::connectHook('OC_User', 'post_createUser',	$userActions, 'create');
-		Util::connectHook('OC_User', 'post_deleteUser',	$userActions, 'delete');
-		Util::connectHook('OC_User', 'changeUser',	$userActions, 'change');
-
-		/** @var IUserSession|Session $userSession */
-		$userSession = $this->getContainer()->getServer()->getUserSession();
-		$userSession->listen('\OC\User', 'postSetPassword', [$userActions, 'setPassword']);
-		$userSession->listen('\OC\User', 'assignedUserId', [$userActions, 'announce']);
-		$userSession->listen('\OC\User', 'postUnassignedUserId', [$userActions, 'revoke']);
-	}
-
-	protected function groupHooks(ILogger $logger)  {
-		$groupActions = new GroupManagement($logger);
-
-		/** @var IGroupManager|Manager $groupManager */
-		$groupManager = $this->getContainer()->getServer()->getGroupManager();
-		$groupManager->listen('\OC\Group', 'postRemoveUser',  [$groupActions, 'removeUser']);
-		$groupManager->listen('\OC\Group', 'postAddUser',  [$groupActions, 'addUser']);
-		$groupManager->listen('\OC\Group', 'postDelete',  [$groupActions, 'deleteGroup']);
-		$groupManager->listen('\OC\Group', 'postCreate',  [$groupActions, 'createGroup']);
-	}
-
-	protected function sharingHooks(ILogger $logger) {
-		$shareActions = new Sharing($logger);
-
-		Util::connectHook(Share::class, 'post_shared', $shareActions, 'shared');
-		Util::connectHook(Share::class, 'post_unshare', $shareActions, 'unshare');
-		Util::connectHook(Share::class, 'post_update_permissions', $shareActions, 'updatePermissions');
-		Util::connectHook(Share::class, 'post_update_password', $shareActions, 'updatePassword');
-		Util::connectHook(Share::class, 'post_set_expiration_date', $shareActions, 'updateExpirationDate');
-		Util::connectHook(Share::class, 'share_link_access', $shareActions, 'shareAccessed');
-	}
-
-	protected function authHooks(ILogger $logger) {
-		$authActions = new Auth($logger);
-
-		Util::connectHook('OC_User', 'pre_login', $authActions, 'loginAttempt');
-		Util::connectHook('OC_User', 'post_login', $authActions, 'loginSuccessful');
-		Util::connectHook('OC_User', 'logout', $authActions, 'logout');
-	}
-
-	protected function appHooks(ILogger $logger) {
-
-		$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
-		$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE, function(ManagerEvent $event) use ($logger) {
-			$appActions = new AppManagement($logger);
-			$appActions->enableApp($event->getAppID());
-		});
-		$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, function(ManagerEvent $event) use ($logger) {
-			$appActions = new AppManagement($logger);
-			$appActions->enableAppForGroups($event->getAppID(), $event->getGroups());
-		});
-		$eventDispatcher->addListener(ManagerEvent::EVENT_APP_DISABLE, function(ManagerEvent $event) use ($logger) {
-			$appActions = new AppManagement($logger);
-			$appActions->disableApp($event->getAppID());
-		});
-
-	}
-
-	protected function consoleHooks(ILogger $logger) {
-		$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
-		$eventDispatcher->addListener(ConsoleEvent::EVENT_RUN, function(ConsoleEvent $event) use ($logger) {
-			$appActions = new Console($logger);
-			$appActions->runCommand($event->getArguments());
-		});
-	}
-
-	protected function fileHooks(ILogger $logger) {
-		$fileActions = new Files($logger);
-		$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
-		$eventDispatcher->addListener(
-			IPreview::EVENT,
-			function(GenericEvent $event) use ($fileActions) {
-				/** @var File $file */
-				$file = $event->getSubject();
-				$fileActions->preview([
-					'path' => substr($file->getInternalPath(), 5),
-					'width' => $event->getArguments()['width'],
-					'height' => $event->getArguments()['height'],
-					'crop' => $event->getArguments()['crop'],
-					'mode'  => $event->getArguments()['mode']
-				]);
-			}
-		);
-
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_post_rename,
-			$fileActions,
-			'rename'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_post_create,
-			$fileActions,
-			'create'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_post_copy,
-			$fileActions,
-			'copy'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_post_write,
-			$fileActions,
-			'write'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_post_update,
-			$fileActions,
-			'update'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_read,
-			$fileActions,
-			'read'
-		);
-		Util::connectHook(
-			Filesystem::CLASSNAME,
-			Filesystem::signal_delete,
-			$fileActions,
-			'delete'
-		);
-	}
-
-	protected function versionsHooks(ILogger $logger) {
-		$versionsActions = new Versions($logger);
-		Util::connectHook('\OCP\Versions', 'rollback', $versionsActions, 'rollback');
-		Util::connectHook('\OCP\Versions', 'delete',$versionsActions, 'delete');
-	}
-
-	protected function trashbinHooks(ILogger $logger) {
-		$trashActions = new Trashbin($logger);
-		Util::connectHook('\OCP\Trashbin', 'preDelete', $trashActions, 'delete');
-		Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', $trashActions, 'restore');
-	}
-
-	protected function securityHooks(ILogger $logger) {
-		$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
-		$eventDispatcher->addListener(IProvider::EVENT_SUCCESS, function(GenericEvent $event) use ($logger) {
-			$security = new Security($logger);
-			$security->twofactorSuccess($event->getSubject(), $event->getArguments());
-		});
-		$eventDispatcher->addListener(IProvider::EVENT_FAILED, function(GenericEvent $event) use ($logger) {
-			$security = new Security($logger);
-			$security->twofactorFailed($event->getSubject(), $event->getArguments());
-		});
-	}
+    public function __construct() {
+        parent::__construct('admin_audit');
+    }
+
+    public function register() {
+        $this->registerHooks();
+    }
+
+    /**
+     * Register hooks in order to log them
+     */
+    protected function registerHooks() {
+        $logger = $this->getContainer()->getServer()->getLogger();
+
+        $this->userManagementHooks($logger);
+        $this->groupHooks($logger);
+        $this->authHooks($logger);
+
+        $this->consoleHooks($logger);
+        $this->appHooks($logger);
+
+        $this->sharingHooks($logger);
+
+        $this->fileHooks($logger);
+        $this->trashbinHooks($logger);
+        $this->versionsHooks($logger);
+
+        $this->securityHooks($logger);
+    }
+
+    protected function userManagementHooks(ILogger $logger) {
+        $userActions = new UserManagement($logger);
+
+        Util::connectHook('OC_User', 'post_createUser',	$userActions, 'create');
+        Util::connectHook('OC_User', 'post_deleteUser',	$userActions, 'delete');
+        Util::connectHook('OC_User', 'changeUser',	$userActions, 'change');
+
+        /** @var IUserSession|Session $userSession */
+        $userSession = $this->getContainer()->getServer()->getUserSession();
+        $userSession->listen('\OC\User', 'postSetPassword', [$userActions, 'setPassword']);
+        $userSession->listen('\OC\User', 'assignedUserId', [$userActions, 'announce']);
+        $userSession->listen('\OC\User', 'postUnassignedUserId', [$userActions, 'revoke']);
+    }
+
+    protected function groupHooks(ILogger $logger)  {
+        $groupActions = new GroupManagement($logger);
+
+        /** @var IGroupManager|Manager $groupManager */
+        $groupManager = $this->getContainer()->getServer()->getGroupManager();
+        $groupManager->listen('\OC\Group', 'postRemoveUser',  [$groupActions, 'removeUser']);
+        $groupManager->listen('\OC\Group', 'postAddUser',  [$groupActions, 'addUser']);
+        $groupManager->listen('\OC\Group', 'postDelete',  [$groupActions, 'deleteGroup']);
+        $groupManager->listen('\OC\Group', 'postCreate',  [$groupActions, 'createGroup']);
+    }
+
+    protected function sharingHooks(ILogger $logger) {
+        $shareActions = new Sharing($logger);
+
+        Util::connectHook(Share::class, 'post_shared', $shareActions, 'shared');
+        Util::connectHook(Share::class, 'post_unshare', $shareActions, 'unshare');
+        Util::connectHook(Share::class, 'post_update_permissions', $shareActions, 'updatePermissions');
+        Util::connectHook(Share::class, 'post_update_password', $shareActions, 'updatePassword');
+        Util::connectHook(Share::class, 'post_set_expiration_date', $shareActions, 'updateExpirationDate');
+        Util::connectHook(Share::class, 'share_link_access', $shareActions, 'shareAccessed');
+    }
+
+    protected function authHooks(ILogger $logger) {
+        $authActions = new Auth($logger);
+
+        Util::connectHook('OC_User', 'pre_login', $authActions, 'loginAttempt');
+        Util::connectHook('OC_User', 'post_login', $authActions, 'loginSuccessful');
+        Util::connectHook('OC_User', 'logout', $authActions, 'logout');
+    }
+
+    protected function appHooks(ILogger $logger) {
+
+        $eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+        $eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE, function(ManagerEvent $event) use ($logger) {
+            $appActions = new AppManagement($logger);
+            $appActions->enableApp($event->getAppID());
+        });
+        $eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, function(ManagerEvent $event) use ($logger) {
+            $appActions = new AppManagement($logger);
+            $appActions->enableAppForGroups($event->getAppID(), $event->getGroups());
+        });
+        $eventDispatcher->addListener(ManagerEvent::EVENT_APP_DISABLE, function(ManagerEvent $event) use ($logger) {
+            $appActions = new AppManagement($logger);
+            $appActions->disableApp($event->getAppID());
+        });
+
+    }
+
+    protected function consoleHooks(ILogger $logger) {
+        $eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+        $eventDispatcher->addListener(ConsoleEvent::EVENT_RUN, function(ConsoleEvent $event) use ($logger) {
+            $appActions = new Console($logger);
+            $appActions->runCommand($event->getArguments());
+        });
+    }
+
+    protected function fileHooks(ILogger $logger) {
+        $fileActions = new Files($logger);
+        $eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+        $eventDispatcher->addListener(
+            IPreview::EVENT,
+            function(GenericEvent $event) use ($fileActions) {
+                /** @var File $file */
+                $file = $event->getSubject();
+                $fileActions->preview([
+                    'path' => substr($file->getInternalPath(), 5),
+                    'width' => $event->getArguments()['width'],
+                    'height' => $event->getArguments()['height'],
+                    'crop' => $event->getArguments()['crop'],
+                    'mode'  => $event->getArguments()['mode']
+                ]);
+            }
+        );
+
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_post_rename,
+            $fileActions,
+            'rename'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_post_create,
+            $fileActions,
+            'create'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_post_copy,
+            $fileActions,
+            'copy'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_post_write,
+            $fileActions,
+            'write'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_post_update,
+            $fileActions,
+            'update'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_read,
+            $fileActions,
+            'read'
+        );
+        Util::connectHook(
+            Filesystem::CLASSNAME,
+            Filesystem::signal_delete,
+            $fileActions,
+            'delete'
+        );
+    }
+
+    protected function versionsHooks(ILogger $logger) {
+        $versionsActions = new Versions($logger);
+        Util::connectHook('\OCP\Versions', 'rollback', $versionsActions, 'rollback');
+        Util::connectHook('\OCP\Versions', 'delete',$versionsActions, 'delete');
+    }
+
+    protected function trashbinHooks(ILogger $logger) {
+        $trashActions = new Trashbin($logger);
+        Util::connectHook('\OCP\Trashbin', 'preDelete', $trashActions, 'delete');
+        Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', $trashActions, 'restore');
+    }
+
+    protected function securityHooks(ILogger $logger) {
+        $eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+        $eventDispatcher->addListener(IProvider::EVENT_SUCCESS, function(GenericEvent $event) use ($logger) {
+            $security = new Security($logger);
+            $security->twofactorSuccess($event->getSubject(), $event->getArguments());
+        });
+        $eventDispatcher->addListener(IProvider::EVENT_FAILED, function(GenericEvent $event) use ($logger) {
+            $security = new Security($logger);
+            $security->twofactorFailed($event->getSubject(), $event->getArguments());
+        });
+    }
 }

apps/user_ldap/ajax/clearMappings.php

Indentation +20 added lines, -20 removed lines

@@ -34,26 +34,26 @@
 $subject = (string)$_POST['ldap_clear_mapping'];
 $mapping = null;
 try {
-	if($subject === 'user') {
-		$mapping = new UserMapping(\OC::$server->getDatabaseConnection());
-		$result = $mapping->clearCb(
-			function ($uid) {
-				\OC::$server->getUserManager()->emit('\OC\User', 'preUnassignedUserId', [$uid]);
-			},
-			function ($uid) {
-				\OC::$server->getUserManager()->emit('\OC\User', 'postUnassignedUserId', [$uid]);
-			}
-		);
-	} else if($subject === 'group') {
-		$mapping = new GroupMapping(\OC::$server->getDatabaseConnection());
-		$result = $mapping->clear();
-	}
+    if($subject === 'user') {
+        $mapping = new UserMapping(\OC::$server->getDatabaseConnection());
+        $result = $mapping->clearCb(
+            function ($uid) {
+                \OC::$server->getUserManager()->emit('\OC\User', 'preUnassignedUserId', [$uid]);
+            },
+            function ($uid) {
+                \OC::$server->getUserManager()->emit('\OC\User', 'postUnassignedUserId', [$uid]);
+            }
+        );
+    } else if($subject === 'group') {
+        $mapping = new GroupMapping(\OC::$server->getDatabaseConnection());
+        $result = $mapping->clear();
+    }
 
-	if($mapping === null || !$result) {
-		$l = \OC::$server->getL10N('user_ldap');
-		throw new \Exception($l->t('Failed to clear the mappings.'));
-	}
-	OCP\JSON::success();
+    if($mapping === null || !$result) {
+        $l = \OC::$server->getL10N('user_ldap');
+        throw new \Exception($l->t('Failed to clear the mappings.'));
+    }
+    OCP\JSON::success();
 } catch (\Exception $e) {
-	OCP\JSON::error(array('message' => $e->getMessage()));
+    OCP\JSON::error(array('message' => $e->getMessage()));
 }

apps/user_ldap/lib/AccessFactory.php

Indentation +33 added lines, -33 removed lines

@@ -29,39 +29,39 @@
 use OCP\IUserManager;
 
 class AccessFactory {
-	/** @var ILDAPWrapper */
-	protected $ldap;
-	/** @var Manager */
-	protected $userManager;
-	/** @var Helper */
-	protected $helper;
-	/** @var IConfig */
-	protected $config;
-	/** @var IUserManager */
-	private $ncUserManager;
+    /** @var ILDAPWrapper */
+    protected $ldap;
+    /** @var Manager */
+    protected $userManager;
+    /** @var Helper */
+    protected $helper;
+    /** @var IConfig */
+    protected $config;
+    /** @var IUserManager */
+    private $ncUserManager;
 
-	public function __construct(
-		ILDAPWrapper $ldap,
-		Manager $userManager,
-		Helper $helper,
-		IConfig $config,
-		IUserManager $ncUserManager)
-	{
-		$this->ldap = $ldap;
-		$this->userManager = $userManager;
-		$this->helper = $helper;
-		$this->config = $config;
-		$this->ncUserManager = $ncUserManager;
-	}
+    public function __construct(
+        ILDAPWrapper $ldap,
+        Manager $userManager,
+        Helper $helper,
+        IConfig $config,
+        IUserManager $ncUserManager)
+    {
+        $this->ldap = $ldap;
+        $this->userManager = $userManager;
+        $this->helper = $helper;
+        $this->config = $config;
+        $this->ncUserManager = $ncUserManager;
+    }
 
-	public function get(Connection $connection) {
-		return new Access(
-			$connection,
-			$this->ldap,
-			$this->userManager,
-			$this->helper,
-			$this->config,
-			$this->ncUserManager
-		);
-	}
+    public function get(Connection $connection) {
+        return new Access(
+            $connection,
+            $this->ldap,
+            $this->userManager,
+            $this->helper,
+            $this->config,
+            $this->ncUserManager
+        );
+    }
 }

apps/user_ldap/lib/Proxy.php

Indentation +166 added lines, -166 removed lines

@@ -37,170 +37,170 @@
 use OCA\User_LDAP\User\Manager;
 
 abstract class Proxy {
-	static private $accesses = array();
-	private $ldap = null;
-
-	/** @var \OCP\ICache|null */
-	private $cache;
-
-	/**
-	 * @param ILDAPWrapper $ldap
-	 */
-	public function __construct(ILDAPWrapper $ldap) {
-		$this->ldap = $ldap;
-		$memcache = \OC::$server->getMemCacheFactory();
-		if($memcache->isAvailable()) {
-			$this->cache = $memcache->createDistributed();
-		}
-	}
-
-	/**
-	 * @param string $configPrefix
-	 */
-	private function addAccess($configPrefix) {
-		static $ocConfig;
-		static $fs;
-		static $log;
-		static $avatarM;
-		static $userMap;
-		static $groupMap;
-		static $db;
-		static $coreUserManager;
-		static $coreNotificationManager;
-		if($fs === null) {
-			$ocConfig = \OC::$server->getConfig();
-			$fs       = new FilesystemHelper();
-			$log      = new LogWrapper();
-			$avatarM  = \OC::$server->getAvatarManager();
-			$db       = \OC::$server->getDatabaseConnection();
-			$userMap  = new UserMapping($db);
-			$groupMap = new GroupMapping($db);
-			$coreUserManager = \OC::$server->getUserManager();
-			$coreNotificationManager = \OC::$server->getNotificationManager();
-		}
-		$userManager =
-			new Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db,
-				$coreUserManager, $coreNotificationManager);
-		$connector = new Connection($this->ldap, $configPrefix);
-		$access = new Access($connector, $this->ldap, $userManager, new Helper($ocConfig), $ocConfig, $coreUserManager);
-		$access->setUserMapper($userMap);
-		$access->setGroupMapper($groupMap);
-		self::$accesses[$configPrefix] = $access;
-	}
-
-	/**
-	 * @param string $configPrefix
-	 * @return mixed
-	 */
-	protected function getAccess($configPrefix) {
-		if(!isset(self::$accesses[$configPrefix])) {
-			$this->addAccess($configPrefix);
-		}
-		return self::$accesses[$configPrefix];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function getUserCacheKey($uid) {
-		return 'user-'.$uid.'-lastSeenOn';
-	}
-
-	/**
-	 * @param string $gid
-	 * @return string
-	 */
-	protected function getGroupCacheKey($gid) {
-		return 'group-'.$gid.'-lastSeenOn';
-	}
-
-	/**
-	 * @param string $id
-	 * @param string $method
-	 * @param array $parameters
-	 * @param bool $passOnWhen
-	 * @return mixed
-	 */
-	abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
-
-	/**
-	 * @param string $id
-	 * @param string $method
-	 * @param array $parameters
-	 * @return mixed
-	 */
-	abstract protected function walkBackends($id, $method, $parameters);
-
-	/**
-	 * @param string $id
-	 * @return Access
-	 */
-	abstract public function getLDAPAccess($id);
-
-	/**
-	 * Takes care of the request to the User backend
-	 * @param string $id
-	 * @param string $method string, the method of the user backend that shall be called
-	 * @param array $parameters an array of parameters to be passed
-	 * @param bool $passOnWhen
-	 * @return mixed, the result of the specified method
-	 */
-	protected function handleRequest($id, $method, $parameters, $passOnWhen = false) {
-		$result = $this->callOnLastSeenOn($id,  $method, $parameters, $passOnWhen);
-		if($result === $passOnWhen) {
-			$result = $this->walkBackends($id, $method, $parameters);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string|null $key
-	 * @return string
-	 */
-	private function getCacheKey($key) {
-		$prefix = 'LDAP-Proxy-';
-		if($key === null) {
-			return $prefix;
-		}
-		return $prefix.hash('sha256', $key);
-	}
-
-	/**
-	 * @param string $key
-	 * @return mixed|null
-	 */
-	public function getFromCache($key) {
-		if($this->cache === null) {
-			return null;
-		}
-
-		$key = $this->getCacheKey($key);
-		$value = $this->cache->get($key);
-		if ($value === null) {
-			return null;
-		}
-
-		return json_decode(base64_decode($value));
-	}
-
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function writeToCache($key, $value) {
-		if($this->cache === null) {
-			return;
-		}
-		$key   = $this->getCacheKey($key);
-		$value = base64_encode(json_encode($value));
-		$this->cache->set($key, $value, 2592000);
-	}
-
-	public function clearCache() {
-		if($this->cache === null) {
-			return;
-		}
-		$this->cache->clear($this->getCacheKey(null));
-	}
+    static private $accesses = array();
+    private $ldap = null;
+
+    /** @var \OCP\ICache|null */
+    private $cache;
+
+    /**
+     * @param ILDAPWrapper $ldap
+     */
+    public function __construct(ILDAPWrapper $ldap) {
+        $this->ldap = $ldap;
+        $memcache = \OC::$server->getMemCacheFactory();
+        if($memcache->isAvailable()) {
+            $this->cache = $memcache->createDistributed();
+        }
+    }
+
+    /**
+     * @param string $configPrefix
+     */
+    private function addAccess($configPrefix) {
+        static $ocConfig;
+        static $fs;
+        static $log;
+        static $avatarM;
+        static $userMap;
+        static $groupMap;
+        static $db;
+        static $coreUserManager;
+        static $coreNotificationManager;
+        if($fs === null) {
+            $ocConfig = \OC::$server->getConfig();
+            $fs       = new FilesystemHelper();
+            $log      = new LogWrapper();
+            $avatarM  = \OC::$server->getAvatarManager();
+            $db       = \OC::$server->getDatabaseConnection();
+            $userMap  = new UserMapping($db);
+            $groupMap = new GroupMapping($db);
+            $coreUserManager = \OC::$server->getUserManager();
+            $coreNotificationManager = \OC::$server->getNotificationManager();
+        }
+        $userManager =
+            new Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db,
+                $coreUserManager, $coreNotificationManager);
+        $connector = new Connection($this->ldap, $configPrefix);
+        $access = new Access($connector, $this->ldap, $userManager, new Helper($ocConfig), $ocConfig, $coreUserManager);
+        $access->setUserMapper($userMap);
+        $access->setGroupMapper($groupMap);
+        self::$accesses[$configPrefix] = $access;
+    }
+
+    /**
+     * @param string $configPrefix
+     * @return mixed
+     */
+    protected function getAccess($configPrefix) {
+        if(!isset(self::$accesses[$configPrefix])) {
+            $this->addAccess($configPrefix);
+        }
+        return self::$accesses[$configPrefix];
+    }
+
+    /**
+     * @param string $uid
+     * @return string
+     */
+    protected function getUserCacheKey($uid) {
+        return 'user-'.$uid.'-lastSeenOn';
+    }
+
+    /**
+     * @param string $gid
+     * @return string
+     */
+    protected function getGroupCacheKey($gid) {
+        return 'group-'.$gid.'-lastSeenOn';
+    }
+
+    /**
+     * @param string $id
+     * @param string $method
+     * @param array $parameters
+     * @param bool $passOnWhen
+     * @return mixed
+     */
+    abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
+
+    /**
+     * @param string $id
+     * @param string $method
+     * @param array $parameters
+     * @return mixed
+     */
+    abstract protected function walkBackends($id, $method, $parameters);
+
+    /**
+     * @param string $id
+     * @return Access
+     */
+    abstract public function getLDAPAccess($id);
+
+    /**
+     * Takes care of the request to the User backend
+     * @param string $id
+     * @param string $method string, the method of the user backend that shall be called
+     * @param array $parameters an array of parameters to be passed
+     * @param bool $passOnWhen
+     * @return mixed, the result of the specified method
+     */
+    protected function handleRequest($id, $method, $parameters, $passOnWhen = false) {
+        $result = $this->callOnLastSeenOn($id,  $method, $parameters, $passOnWhen);
+        if($result === $passOnWhen) {
+            $result = $this->walkBackends($id, $method, $parameters);
+        }
+        return $result;
+    }
+
+    /**
+     * @param string|null $key
+     * @return string
+     */
+    private function getCacheKey($key) {
+        $prefix = 'LDAP-Proxy-';
+        if($key === null) {
+            return $prefix;
+        }
+        return $prefix.hash('sha256', $key);
+    }
+
+    /**
+     * @param string $key
+     * @return mixed|null
+     */
+    public function getFromCache($key) {
+        if($this->cache === null) {
+            return null;
+        }
+
+        $key = $this->getCacheKey($key);
+        $value = $this->cache->get($key);
+        if ($value === null) {
+            return null;
+        }
+
+        return json_decode(base64_decode($value));
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $value
+     */
+    public function writeToCache($key, $value) {
+        if($this->cache === null) {
+            return;
+        }
+        $key   = $this->getCacheKey($key);
+        $value = base64_encode(json_encode($value));
+        $this->cache->set($key, $value, 2592000);
+    }
+
+    public function clearCache() {
+        if($this->cache === null) {
+            return;
+        }
+        $this->cache->clear($this->getCacheKey(null));
+    }
 }

apps/user_ldap/lib/Jobs/UpdateGroups.php

Indentation +164 added lines, -164 removed lines

@@ -45,183 +45,183 @@
 use OCA\User_LDAP\User\Manager;
 
 class UpdateGroups extends \OC\BackgroundJob\TimedJob {
-	static private $groupsFromDB;
-
-	static private $groupBE;
-
-	public function __construct(){
-		$this->interval = self::getRefreshInterval();
-	}
-
-	/**
-	 * @param mixed $argument
-	 */
-	public function run($argument){
-		self::updateGroups();
-	}
-
-	static public function updateGroups() {
-		\OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
-
-		$knownGroups = array_keys(self::getKnownGroups());
-		$actualGroups = self::getGroupBE()->getGroups();
-
-		if(empty($actualGroups) && empty($knownGroups)) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
-				\OCP\Util::INFO);
-			return;
-		}
-
-		self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
-		self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
-		self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
-
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return int
-	 */
-	static private function getRefreshInterval() {
-		//defaults to every hour
-		return \OC::$server->getConfig()->getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
-	}
-
-	/**
-	 * @param string[] $groups
-	 */
-	static private function handleKnownGroups($groups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+    static private $groupsFromDB;
+
+    static private $groupBE;
+
+    public function __construct(){
+        $this->interval = self::getRefreshInterval();
+    }
+
+    /**
+     * @param mixed $argument
+     */
+    public function run($argument){
+        self::updateGroups();
+    }
+
+    static public function updateGroups() {
+        \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
+
+        $knownGroups = array_keys(self::getKnownGroups());
+        $actualGroups = self::getGroupBE()->getGroups();
+
+        if(empty($actualGroups) && empty($knownGroups)) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
+                \OCP\Util::INFO);
+            return;
+        }
+
+        self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
+        self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
+        self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
+
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return int
+     */
+    static private function getRefreshInterval() {
+        //defaults to every hour
+        return \OC::$server->getConfig()->getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
+    }
+
+    /**
+     * @param string[] $groups
+     */
+    static private function handleKnownGroups($groups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			UPDATE `*PREFIX*ldap_group_members`
 			SET `owncloudusers` = ?
 			WHERE `owncloudname` = ?
 		');
-		foreach($groups as $group) {
-			//we assume, that self::$groupsFromDB has been retrieved already
-			$knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
-			$actualUsers = self::getGroupBE()->usersInGroup($group);
-			$hasChanged = false;
-			foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			if($hasChanged) {
-				$query->execute(array(serialize($actualUsers), $group));
-			}
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with known Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $createdGroups
-	 */
-	static private function handleCreatedGroups($createdGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($groups as $group) {
+            //we assume, that self::$groupsFromDB has been retrieved already
+            $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
+            $actualUsers = self::getGroupBE()->usersInGroup($group);
+            $hasChanged = false;
+            foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            if($hasChanged) {
+                $query->execute(array(serialize($actualUsers), $group));
+            }
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with known Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $createdGroups
+     */
+    static private function handleCreatedGroups($createdGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			INSERT
 			INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`)
 			VALUES (?, ?)
 		');
-		foreach($createdGroups as $createdGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
-				\OCP\Util::INFO);
-			$users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
-			$query->execute(array($createdGroup, $users));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with created Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $removedGroups
-	 */
-	static private function handleRemovedGroups($removedGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($createdGroups as $createdGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
+                \OCP\Util::INFO);
+            $users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
+            $query->execute(array($createdGroup, $users));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with created Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $removedGroups
+     */
+    static private function handleRemovedGroups($removedGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			DELETE
 			FROM `*PREFIX*ldap_group_members`
 			WHERE `owncloudname` = ?
 		');
-		foreach($removedGroups as $removedGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
-				\OCP\Util::INFO);
-			$query->execute(array($removedGroup));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with removed groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
-	 */
-	static private function getGroupBE() {
-		if(!is_null(self::$groupBE)) {
-			return self::$groupBE;
-		}
-		$helper = new Helper(\OC::$server->getConfig());
-		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
-		$ldapWrapper = new LDAP();
-		if(count($configPrefixes) === 1) {
-			//avoid the proxy when there is only one LDAP server configured
-			$dbc = \OC::$server->getDatabaseConnection();
-			$userManager = new Manager(
-				\OC::$server->getConfig(),
-				new FilesystemHelper(),
-				new LogWrapper(),
-				\OC::$server->getAvatarManager(),
-				new \OCP\Image(),
-				$dbc,
-				\OC::$server->getUserManager(),
-				\OC::$server->getNotificationManager());
-			$connector = new Connection($ldapWrapper, $configPrefixes[0]);
-			$ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper, \OC::$server->getConfig(), \OC::$server->getUserManager());
-			$groupMapper = new GroupMapping($dbc);
-			$userMapper  = new UserMapping($dbc);
-			$ldapAccess->setGroupMapper($groupMapper);
-			$ldapAccess->setUserMapper($userMapper);
-			self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess, \OC::$server->query('LDAPGroupPluginManager'));
-		} else {
-			self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, \OC::$server->query('LDAPGroupPluginManager'));
-		}
-
-		return self::$groupBE;
-	}
-
-	/**
-	 * @return array
-	 */
-	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
-			return self::$groupsFromDB;
-		}
-		$query = \OCP\DB::prepare('
+        foreach($removedGroups as $removedGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
+                \OCP\Util::INFO);
+            $query->execute(array($removedGroup));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with removed groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
+     */
+    static private function getGroupBE() {
+        if(!is_null(self::$groupBE)) {
+            return self::$groupBE;
+        }
+        $helper = new Helper(\OC::$server->getConfig());
+        $configPrefixes = $helper->getServerConfigurationPrefixes(true);
+        $ldapWrapper = new LDAP();
+        if(count($configPrefixes) === 1) {
+            //avoid the proxy when there is only one LDAP server configured
+            $dbc = \OC::$server->getDatabaseConnection();
+            $userManager = new Manager(
+                \OC::$server->getConfig(),
+                new FilesystemHelper(),
+                new LogWrapper(),
+                \OC::$server->getAvatarManager(),
+                new \OCP\Image(),
+                $dbc,
+                \OC::$server->getUserManager(),
+                \OC::$server->getNotificationManager());
+            $connector = new Connection($ldapWrapper, $configPrefixes[0]);
+            $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper, \OC::$server->getConfig(), \OC::$server->getUserManager());
+            $groupMapper = new GroupMapping($dbc);
+            $userMapper  = new UserMapping($dbc);
+            $ldapAccess->setGroupMapper($groupMapper);
+            $ldapAccess->setUserMapper($userMapper);
+            self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess, \OC::$server->query('LDAPGroupPluginManager'));
+        } else {
+            self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, \OC::$server->query('LDAPGroupPluginManager'));
+        }
+
+        return self::$groupBE;
+    }
+
+    /**
+     * @return array
+     */
+    static private function getKnownGroups() {
+        if(is_array(self::$groupsFromDB)) {
+            return self::$groupsFromDB;
+        }
+        $query = \OCP\DB::prepare('
 			SELECT `owncloudname`, `owncloudusers`
 			FROM `*PREFIX*ldap_group_members`
 		');
-		$result = $query->execute()->fetchAll();
-		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
-			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
-		}
-
-		return self::$groupsFromDB;
-	}
+        $result = $query->execute()->fetchAll();
+        self::$groupsFromDB = array();
+        foreach($result as $dataset) {
+            self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
+        }
+
+        return self::$groupsFromDB;
+    }
 }

apps/user_ldap/lib/Jobs/Sync.php

Indentation +338 added lines, -338 removed lines

@@ -42,343 +42,343 @@
 use OCP\Notification\IManager;
 
 class Sync extends TimedJob {
-	const MAX_INTERVAL = 12 * 60 * 60; // 12h
-	const MIN_INTERVAL = 30 * 60; // 30min
-	/** @var  Helper */
-	protected $ldapHelper;
-	/** @var  LDAP */
-	protected $ldap;
-	/** @var  Manager */
-	protected $userManager;
-	/** @var UserMapping */
-	protected $mapper;
-	/** @var  IConfig */
-	protected $config;
-	/** @var  IAvatarManager */
-	protected $avatarManager;
-	/** @var  IDBConnection */
-	protected $dbc;
-	/** @var  IUserManager */
-	protected $ncUserManager;
-	/** @var  IManager */
-	protected $notificationManager;
-	/** @var ConnectionFactory */
-	protected $connectionFactory;
-	/** @var AccessFactory */
-	protected $accessFactory;
-
-	public function __construct() {
-		$this->setInterval(
-			\OC::$server->getConfig()->getAppValue(
-				'user_ldap',
-				'background_sync_interval',
-				self::MIN_INTERVAL
-			)
-		);
-	}
-
-	/**
-	 * updates the interval
-	 *
-	 * the idea is to adjust the interval depending on the amount of known users
-	 * and the attempt to update each user one day. At most it would run every
-	 * 30 minutes, and at least every 12 hours.
-	 */
-	public function updateInterval() {
-		$minPagingSize = $this->getMinPagingSize();
-		$mappedUsers = $this->mapper->count();
-
-		$runsPerDay = ($minPagingSize === 0 || $mappedUsers === 0) ? self::MAX_INTERVAL
-			: $mappedUsers / $minPagingSize;
-		$interval = floor(24 * 60 * 60 / $runsPerDay);
-		$interval = min(max($interval, self::MIN_INTERVAL), self::MAX_INTERVAL);
-
-		$this->config->setAppValue('user_ldap', 'background_sync_interval', $interval);
-	}
-
-	/**
-	 * returns the smallest configured paging size
-	 * @return int
-	 */
-	protected function getMinPagingSize() {
-		$configKeys = $this->config->getAppKeys('user_ldap');
-		$configKeys = array_filter($configKeys, function($key) {
-			return strpos($key, 'ldap_paging_size') !== false;
-		});
-		$minPagingSize = null;
-		foreach ($configKeys as $configKey) {
-			$pagingSize = $this->config->getAppValue('user_ldap', $configKey, $minPagingSize);
-			$minPagingSize = $minPagingSize === null ? $pagingSize : min($minPagingSize, $pagingSize);
-		}
-		return (int)$minPagingSize;
-	}
-
-	/**
-	 * @param array $argument
-	 */
-	public function run($argument) {
-		$this->setArgument($argument);
-
-		$isBackgroundJobModeAjax = $this->config
-				->getAppValue('core', 'backgroundjobs_mode', 'ajax') === 'ajax';
-		if($isBackgroundJobModeAjax) {
-			return;
-		}
-
-		$cycleData = $this->getCycle();
-		if($cycleData === null) {
-			$cycleData = $this->determineNextCycle();
-			if($cycleData === null) {
-				$this->updateInterval();
-				return;
-			}
-		}
-
-		if(!$this->qualifiesToRun($cycleData)) {
-			$this->updateInterval();
-			return;
-		}
-
-		try {
-			$expectMoreResults = $this->runCycle($cycleData);
-			if ($expectMoreResults) {
-				$this->increaseOffset($cycleData);
-			} else {
-				$this->determineNextCycle($cycleData);
-			}
-			$this->updateInterval();
-		} catch (ServerNotAvailableException $e) {
-			$this->determineNextCycle($cycleData);
-		}
-	}
-
-	/**
-	 * @param array $cycleData
-	 * @return bool whether more results are expected from the same configuration
-	 */
-	public function runCycle($cycleData) {
-		$connection = $this->connectionFactory->get($cycleData['prefix']);
-		$access = $this->accessFactory->get($connection);
-		$access->setUserMapper($this->mapper);
-
-		$filter = $access->combineFilterWithAnd(array(
-			$access->connection->ldapUserFilter,
-			$access->connection->ldapUserDisplayName . '=*',
-			$access->getFilterPartForUserSearch('')
-		));
-		$results = $access->fetchListOfUsers(
-			$filter,
-			$access->userManager->getAttributes(),
-			$connection->ldapPagingSize,
-			$cycleData['offset'],
-			true
-		);
-
-		if((int)$connection->ldapPagingSize === 0) {
-			return false;
-		}
-		return count($results) >= (int)$connection->ldapPagingSize;
-	}
-
-	/**
-	 * returns the info about the current cycle that should be run, if any,
-	 * otherwise null
-	 *
-	 * @return array|null
-	 */
-	public function getCycle() {
-		$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
-		if(count($prefixes) === 0) {
-			return null;
-		}
-
-		$cycleData = [
-			'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', null),
-			'offset' => (int)$this->config->getAppValue('user_ldap', 'background_sync_offset', 0),
-		];
-
-		if(
-			$cycleData['prefix'] !== null
-			&& in_array($cycleData['prefix'], $prefixes)
-		) {
-			return $cycleData;
-		}
-
-		return null;
-	}
-
-	/**
-	 * Save the provided cycle information in the DB
-	 *
-	 * @param array $cycleData
-	 */
-	public function setCycle(array $cycleData) {
-		$this->config->setAppValue('user_ldap', 'background_sync_prefix', $cycleData['prefix']);
-		$this->config->setAppValue('user_ldap', 'background_sync_offset', $cycleData['offset']);
-	}
-
-	/**
-	 * returns data about the next cycle that should run, if any, otherwise
-	 * null. It also always goes for the next LDAP configuration!
-	 *
-	 * @param array|null $cycleData the old cycle
-	 * @return array|null
-	 */
-	public function determineNextCycle(array $cycleData = null) {
-		$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
-		if(count($prefixes) === 0) {
-			return null;
-		}
-
-		// get the next prefix in line and remember it
-		$oldPrefix = $cycleData === null ? null : $cycleData['prefix'];
-		$prefix = $this->getNextPrefix($oldPrefix);
-		if($prefix === null) {
-			return null;
-		}
-		$cycleData['prefix'] = $prefix;
-		$cycleData['offset'] = 0;
-		$this->setCycle(['prefix' => $prefix, 'offset' => 0]);
-
-		return $cycleData;
-	}
-
-	/**
-	 * Checks whether the provided cycle should be run. Currently only the
-	 * last configuration change goes into account (at least one hour).
-	 *
-	 * @param $cycleData
-	 * @return bool
-	 */
-	public function qualifiesToRun($cycleData) {
-		$lastChange = $this->config->getAppValue('user_ldap', $cycleData['prefix'] . '_lastChange', 0);
-		if((time() - $lastChange) > 60 * 30) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * increases the offset of the current cycle for the next run
-	 *
-	 * @param $cycleData
-	 */
-	protected function increaseOffset($cycleData) {
-		$ldapConfig = new Configuration($cycleData['prefix']);
-		$cycleData['offset'] += (int)$ldapConfig->ldapPagingSize;
-		$this->setCycle($cycleData);
-	}
-
-	/**
-	 * determines the next configuration prefix based on the last one (if any)
-	 *
-	 * @param string|null $lastPrefix
-	 * @return string|null
-	 */
-	protected function getNextPrefix($lastPrefix) {
-		$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
-		$noOfPrefixes = count($prefixes);
-		if($noOfPrefixes === 0) {
-			return null;
-		}
-		$i = $lastPrefix === null ? false : array_search($lastPrefix, $prefixes, true);
-		if($i === false) {
-			$i = -1;
-		} else {
-			$i++;
-		}
-
-		if(!isset($prefixes[$i])) {
-			$i = 0;
-		}
-		return $prefixes[$i];
-	}
-
-	/**
-	 * "fixes" DI
-	 *
-	 * @param array $argument
-	 */
-	public function setArgument($argument) {
-		if(isset($argument['config'])) {
-			$this->config = $argument['config'];
-		} else {
-			$this->config = \OC::$server->getConfig();
-		}
-
-		if(isset($argument['helper'])) {
-			$this->ldapHelper = $argument['helper'];
-		} else {
-			$this->ldapHelper = new Helper($this->config);
-		}
-
-		if(isset($argument['ldapWrapper'])) {
-			$this->ldap = $argument['ldapWrapper'];
-		} else {
-			$this->ldap = new LDAP();
-		}
-
-		if(isset($argument['avatarManager'])) {
-			$this->avatarManager = $argument['avatarManager'];
-		} else {
-			$this->avatarManager = \OC::$server->getAvatarManager();
-		}
-
-		if(isset($argument['dbc'])) {
-			$this->dbc = $argument['dbc'];
-		} else {
-			$this->dbc = \OC::$server->getDatabaseConnection();
-		}
-
-		if(isset($argument['ncUserManager'])) {
-			$this->ncUserManager = $argument['ncUserManager'];
-		} else {
-			$this->ncUserManager = \OC::$server->getUserManager();
-		}
-
-		if(isset($argument['notificationManager'])) {
-			$this->notificationManager = $argument['notificationManager'];
-		} else {
-			$this->notificationManager = \OC::$server->getNotificationManager();
-		}
-
-		if(isset($argument['userManager'])) {
-			$this->userManager = $argument['userManager'];
-		} else {
-			$this->userManager = new Manager(
-				$this->config,
-				new FilesystemHelper(),
-				new LogWrapper(),
-				$this->avatarManager,
-				new Image(),
-				$this->dbc,
-				$this->ncUserManager,
-				$this->notificationManager
-			);
-		}
-
-		if(isset($argument['mapper'])) {
-			$this->mapper = $argument['mapper'];
-		} else {
-			$this->mapper = new UserMapping($this->dbc);
-		}
+    const MAX_INTERVAL = 12 * 60 * 60; // 12h
+    const MIN_INTERVAL = 30 * 60; // 30min
+    /** @var  Helper */
+    protected $ldapHelper;
+    /** @var  LDAP */
+    protected $ldap;
+    /** @var  Manager */
+    protected $userManager;
+    /** @var UserMapping */
+    protected $mapper;
+    /** @var  IConfig */
+    protected $config;
+    /** @var  IAvatarManager */
+    protected $avatarManager;
+    /** @var  IDBConnection */
+    protected $dbc;
+    /** @var  IUserManager */
+    protected $ncUserManager;
+    /** @var  IManager */
+    protected $notificationManager;
+    /** @var ConnectionFactory */
+    protected $connectionFactory;
+    /** @var AccessFactory */
+    protected $accessFactory;
+
+    public function __construct() {
+        $this->setInterval(
+            \OC::$server->getConfig()->getAppValue(
+                'user_ldap',
+                'background_sync_interval',
+                self::MIN_INTERVAL
+            )
+        );
+    }
+
+    /**
+     * updates the interval
+     *
+     * the idea is to adjust the interval depending on the amount of known users
+     * and the attempt to update each user one day. At most it would run every
+     * 30 minutes, and at least every 12 hours.
+     */
+    public function updateInterval() {
+        $minPagingSize = $this->getMinPagingSize();
+        $mappedUsers = $this->mapper->count();
+
+        $runsPerDay = ($minPagingSize === 0 || $mappedUsers === 0) ? self::MAX_INTERVAL
+            : $mappedUsers / $minPagingSize;
+        $interval = floor(24 * 60 * 60 / $runsPerDay);
+        $interval = min(max($interval, self::MIN_INTERVAL), self::MAX_INTERVAL);
+
+        $this->config->setAppValue('user_ldap', 'background_sync_interval', $interval);
+    }
+
+    /**
+     * returns the smallest configured paging size
+     * @return int
+     */
+    protected function getMinPagingSize() {
+        $configKeys = $this->config->getAppKeys('user_ldap');
+        $configKeys = array_filter($configKeys, function($key) {
+            return strpos($key, 'ldap_paging_size') !== false;
+        });
+        $minPagingSize = null;
+        foreach ($configKeys as $configKey) {
+            $pagingSize = $this->config->getAppValue('user_ldap', $configKey, $minPagingSize);
+            $minPagingSize = $minPagingSize === null ? $pagingSize : min($minPagingSize, $pagingSize);
+        }
+        return (int)$minPagingSize;
+    }
+
+    /**
+     * @param array $argument
+     */
+    public function run($argument) {
+        $this->setArgument($argument);
+
+        $isBackgroundJobModeAjax = $this->config
+                ->getAppValue('core', 'backgroundjobs_mode', 'ajax') === 'ajax';
+        if($isBackgroundJobModeAjax) {
+            return;
+        }
+
+        $cycleData = $this->getCycle();
+        if($cycleData === null) {
+            $cycleData = $this->determineNextCycle();
+            if($cycleData === null) {
+                $this->updateInterval();
+                return;
+            }
+        }
+
+        if(!$this->qualifiesToRun($cycleData)) {
+            $this->updateInterval();
+            return;
+        }
+
+        try {
+            $expectMoreResults = $this->runCycle($cycleData);
+            if ($expectMoreResults) {
+                $this->increaseOffset($cycleData);
+            } else {
+                $this->determineNextCycle($cycleData);
+            }
+            $this->updateInterval();
+        } catch (ServerNotAvailableException $e) {
+            $this->determineNextCycle($cycleData);
+        }
+    }
+
+    /**
+     * @param array $cycleData
+     * @return bool whether more results are expected from the same configuration
+     */
+    public function runCycle($cycleData) {
+        $connection = $this->connectionFactory->get($cycleData['prefix']);
+        $access = $this->accessFactory->get($connection);
+        $access->setUserMapper($this->mapper);
+
+        $filter = $access->combineFilterWithAnd(array(
+            $access->connection->ldapUserFilter,
+            $access->connection->ldapUserDisplayName . '=*',
+            $access->getFilterPartForUserSearch('')
+        ));
+        $results = $access->fetchListOfUsers(
+            $filter,
+            $access->userManager->getAttributes(),
+            $connection->ldapPagingSize,
+            $cycleData['offset'],
+            true
+        );
+
+        if((int)$connection->ldapPagingSize === 0) {
+            return false;
+        }
+        return count($results) >= (int)$connection->ldapPagingSize;
+    }
+
+    /**
+     * returns the info about the current cycle that should be run, if any,
+     * otherwise null
+     *
+     * @return array|null
+     */
+    public function getCycle() {
+        $prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
+        if(count($prefixes) === 0) {
+            return null;
+        }
+
+        $cycleData = [
+            'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', null),
+            'offset' => (int)$this->config->getAppValue('user_ldap', 'background_sync_offset', 0),
+        ];
+
+        if(
+            $cycleData['prefix'] !== null
+            && in_array($cycleData['prefix'], $prefixes)
+        ) {
+            return $cycleData;
+        }
+
+        return null;
+    }
+
+    /**
+     * Save the provided cycle information in the DB
+     *
+     * @param array $cycleData
+     */
+    public function setCycle(array $cycleData) {
+        $this->config->setAppValue('user_ldap', 'background_sync_prefix', $cycleData['prefix']);
+        $this->config->setAppValue('user_ldap', 'background_sync_offset', $cycleData['offset']);
+    }
+
+    /**
+     * returns data about the next cycle that should run, if any, otherwise
+     * null. It also always goes for the next LDAP configuration!
+     *
+     * @param array|null $cycleData the old cycle
+     * @return array|null
+     */
+    public function determineNextCycle(array $cycleData = null) {
+        $prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
+        if(count($prefixes) === 0) {
+            return null;
+        }
+
+        // get the next prefix in line and remember it
+        $oldPrefix = $cycleData === null ? null : $cycleData['prefix'];
+        $prefix = $this->getNextPrefix($oldPrefix);
+        if($prefix === null) {
+            return null;
+        }
+        $cycleData['prefix'] = $prefix;
+        $cycleData['offset'] = 0;
+        $this->setCycle(['prefix' => $prefix, 'offset' => 0]);
+
+        return $cycleData;
+    }
+
+    /**
+     * Checks whether the provided cycle should be run. Currently only the
+     * last configuration change goes into account (at least one hour).
+     *
+     * @param $cycleData
+     * @return bool
+     */
+    public function qualifiesToRun($cycleData) {
+        $lastChange = $this->config->getAppValue('user_ldap', $cycleData['prefix'] . '_lastChange', 0);
+        if((time() - $lastChange) > 60 * 30) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * increases the offset of the current cycle for the next run
+     *
+     * @param $cycleData
+     */
+    protected function increaseOffset($cycleData) {
+        $ldapConfig = new Configuration($cycleData['prefix']);
+        $cycleData['offset'] += (int)$ldapConfig->ldapPagingSize;
+        $this->setCycle($cycleData);
+    }
+
+    /**
+     * determines the next configuration prefix based on the last one (if any)
+     *
+     * @param string|null $lastPrefix
+     * @return string|null
+     */
+    protected function getNextPrefix($lastPrefix) {
+        $prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
+        $noOfPrefixes = count($prefixes);
+        if($noOfPrefixes === 0) {
+            return null;
+        }
+        $i = $lastPrefix === null ? false : array_search($lastPrefix, $prefixes, true);
+        if($i === false) {
+            $i = -1;
+        } else {
+            $i++;
+        }
+
+        if(!isset($prefixes[$i])) {
+            $i = 0;
+        }
+        return $prefixes[$i];
+    }
+
+    /**
+     * "fixes" DI
+     *
+     * @param array $argument
+     */
+    public function setArgument($argument) {
+        if(isset($argument['config'])) {
+            $this->config = $argument['config'];
+        } else {
+            $this->config = \OC::$server->getConfig();
+        }
+
+        if(isset($argument['helper'])) {
+            $this->ldapHelper = $argument['helper'];
+        } else {
+            $this->ldapHelper = new Helper($this->config);
+        }
+
+        if(isset($argument['ldapWrapper'])) {
+            $this->ldap = $argument['ldapWrapper'];
+        } else {
+            $this->ldap = new LDAP();
+        }
+
+        if(isset($argument['avatarManager'])) {
+            $this->avatarManager = $argument['avatarManager'];
+        } else {
+            $this->avatarManager = \OC::$server->getAvatarManager();
+        }
+
+        if(isset($argument['dbc'])) {
+            $this->dbc = $argument['dbc'];
+        } else {
+            $this->dbc = \OC::$server->getDatabaseConnection();
+        }
+
+        if(isset($argument['ncUserManager'])) {
+            $this->ncUserManager = $argument['ncUserManager'];
+        } else {
+            $this->ncUserManager = \OC::$server->getUserManager();
+        }
+
+        if(isset($argument['notificationManager'])) {
+            $this->notificationManager = $argument['notificationManager'];
+        } else {
+            $this->notificationManager = \OC::$server->getNotificationManager();
+        }
+
+        if(isset($argument['userManager'])) {
+            $this->userManager = $argument['userManager'];
+        } else {
+            $this->userManager = new Manager(
+                $this->config,
+                new FilesystemHelper(),
+                new LogWrapper(),
+                $this->avatarManager,
+                new Image(),
+                $this->dbc,
+                $this->ncUserManager,
+                $this->notificationManager
+            );
+        }
+
+        if(isset($argument['mapper'])) {
+            $this->mapper = $argument['mapper'];
+        } else {
+            $this->mapper = new UserMapping($this->dbc);
+        }
 		
-		if(isset($argument['connectionFactory'])) {
-			$this->connectionFactory = $argument['connectionFactory'];
-		} else {
-			$this->connectionFactory = new ConnectionFactory($this->ldap);
-		}
-
-		if(isset($argument['accessFactory'])) {
-			$this->accessFactory = $argument['accessFactory'];
-		} else {
-			$this->accessFactory = new AccessFactory(
-				$this->ldap,
-				$this->userManager,
-				$this->ldapHelper,
-				$this->config,
-				$this->ncUserManager
-			);
-		}
-	}
+        if(isset($argument['connectionFactory'])) {
+            $this->connectionFactory = $argument['connectionFactory'];
+        } else {
+            $this->connectionFactory = new ConnectionFactory($this->ldap);
+        }
+
+        if(isset($argument['accessFactory'])) {
+            $this->accessFactory = $argument['accessFactory'];
+        } else {
+            $this->accessFactory = new AccessFactory(
+                $this->ldap,
+                $this->userManager,
+                $this->ldapHelper,
+                $this->config,
+                $this->ncUserManager
+            );
+        }
+    }
 }