nextcloud / server

apps/user_ldap/lib/User/Manager.php

Indentation +199 added lines, -199 removed lines

@@ -45,231 +45,231 @@
  * cache
  */
 class Manager {
-	/** @var Access */
-	protected $access;
+    /** @var Access */
+    protected $access;
 
-	/** @var IConfig */
-	protected $ocConfig;
+    /** @var IConfig */
+    protected $ocConfig;
 
-	/** @var IDBConnection */
-	protected $db;
+    /** @var IDBConnection */
+    protected $db;
 
-	/** @var IUserManager */
-	protected $userManager;
+    /** @var IUserManager */
+    protected $userManager;
 
-	/** @var INotificationManager */
-	protected $notificationManager;
+    /** @var INotificationManager */
+    protected $notificationManager;
 
-	/** @var FilesystemHelper */
-	protected $ocFilesystem;
+    /** @var FilesystemHelper */
+    protected $ocFilesystem;
 
-	/** @var LogWrapper */
-	protected $ocLog;
+    /** @var LogWrapper */
+    protected $ocLog;
 
-	/** @var Image */
-	protected $image;
+    /** @var Image */
+    protected $image;
 
-	/** @param \OCP\IAvatarManager */
-	protected $avatarManager;
+    /** @param \OCP\IAvatarManager */
+    protected $avatarManager;
 
-	/**
-	 * @var CappedMemoryCache $usersByDN
-	 */
-	protected $usersByDN;
-	/**
-	 * @var CappedMemoryCache $usersByUid
-	 */
-	protected $usersByUid;
+    /**
+     * @var CappedMemoryCache $usersByDN
+     */
+    protected $usersByDN;
+    /**
+     * @var CappedMemoryCache $usersByUid
+     */
+    protected $usersByUid;
 
-	/**
-	 * @param IConfig $ocConfig
-	 * @param \OCA\User_LDAP\FilesystemHelper $ocFilesystem object that
-	 * gives access to necessary functions from the OC filesystem
-	 * @param  \OCA\User_LDAP\LogWrapper $ocLog
-	 * @param IAvatarManager $avatarManager
-	 * @param Image $image an empty image instance
-	 * @param IDBConnection $db
-	 * @throws \Exception when the methods mentioned above do not exist
-	 */
-	public function __construct(IConfig $ocConfig,
-								FilesystemHelper $ocFilesystem, LogWrapper $ocLog,
-								IAvatarManager $avatarManager, Image $image,
-								IDBConnection $db, IUserManager $userManager,
-								INotificationManager $notificationManager) {
+    /**
+     * @param IConfig $ocConfig
+     * @param \OCA\User_LDAP\FilesystemHelper $ocFilesystem object that
+     * gives access to necessary functions from the OC filesystem
+     * @param  \OCA\User_LDAP\LogWrapper $ocLog
+     * @param IAvatarManager $avatarManager
+     * @param Image $image an empty image instance
+     * @param IDBConnection $db
+     * @throws \Exception when the methods mentioned above do not exist
+     */
+    public function __construct(IConfig $ocConfig,
+                                FilesystemHelper $ocFilesystem, LogWrapper $ocLog,
+                                IAvatarManager $avatarManager, Image $image,
+                                IDBConnection $db, IUserManager $userManager,
+                                INotificationManager $notificationManager) {
 
-		$this->ocConfig            = $ocConfig;
-		$this->ocFilesystem        = $ocFilesystem;
-		$this->ocLog               = $ocLog;
-		$this->avatarManager       = $avatarManager;
-		$this->image               = $image;
-		$this->db                  = $db;
-		$this->userManager         = $userManager;
-		$this->notificationManager = $notificationManager;
-		$this->usersByDN           = new CappedMemoryCache();
-		$this->usersByUid          = new CappedMemoryCache();
-	}
+        $this->ocConfig            = $ocConfig;
+        $this->ocFilesystem        = $ocFilesystem;
+        $this->ocLog               = $ocLog;
+        $this->avatarManager       = $avatarManager;
+        $this->image               = $image;
+        $this->db                  = $db;
+        $this->userManager         = $userManager;
+        $this->notificationManager = $notificationManager;
+        $this->usersByDN           = new CappedMemoryCache();
+        $this->usersByUid          = new CappedMemoryCache();
+    }
 
-	/**
-	 * Binds manager to an instance of Access.
-	 * It needs to be assigned first before the manager can be used.
-	 * @param Access
-	 */
-	public function setLdapAccess(Access $access) {
-		$this->access = $access;
-	}
+    /**
+     * Binds manager to an instance of Access.
+     * It needs to be assigned first before the manager can be used.
+     * @param Access
+     */
+    public function setLdapAccess(Access $access) {
+        $this->access = $access;
+    }
 
-	/**
-	 * @brief creates an instance of User and caches (just runtime) it in the
-	 * property array
-	 * @param string $dn the DN of the user
-	 * @param string $uid the internal (owncloud) username
-	 * @return \OCA\User_LDAP\User\User
-	 */
-	private function createAndCache($dn, $uid) {
-		$this->checkAccess();
-		$user = new User($uid, $dn, $this->access, $this->ocConfig,
-			$this->ocFilesystem, clone $this->image, $this->ocLog,
-			$this->avatarManager, $this->userManager, 
-			$this->notificationManager);
-		$this->usersByDN[$dn]   = $user;
-		$this->usersByUid[$uid] = $user;
-		return $user;
-	}
+    /**
+     * @brief creates an instance of User and caches (just runtime) it in the
+     * property array
+     * @param string $dn the DN of the user
+     * @param string $uid the internal (owncloud) username
+     * @return \OCA\User_LDAP\User\User
+     */
+    private function createAndCache($dn, $uid) {
+        $this->checkAccess();
+        $user = new User($uid, $dn, $this->access, $this->ocConfig,
+            $this->ocFilesystem, clone $this->image, $this->ocLog,
+            $this->avatarManager, $this->userManager, 
+            $this->notificationManager);
+        $this->usersByDN[$dn]   = $user;
+        $this->usersByUid[$uid] = $user;
+        return $user;
+    }
 
-	/**
-	 * removes a user entry from the cache
-	 * @param $uid
-	 */
-	public function invalidate($uid) {
-		if(!isset($this->usersByUid[$uid])) {
-			return;
-		}
-		$dn = $this->usersByUid[$uid]->getDN();
-		unset($this->usersByUid[$uid]);
-		unset($this->usersByDN[$dn]);
-	}
+    /**
+     * removes a user entry from the cache
+     * @param $uid
+     */
+    public function invalidate($uid) {
+        if(!isset($this->usersByUid[$uid])) {
+            return;
+        }
+        $dn = $this->usersByUid[$uid]->getDN();
+        unset($this->usersByUid[$uid]);
+        unset($this->usersByDN[$dn]);
+    }
 
-	/**
-	 * @brief checks whether the Access instance has been set
-	 * @throws \Exception if Access has not been set
-	 * @return null
-	 */
-	private function checkAccess() {
-		if(is_null($this->access)) {
-			throw new \Exception('LDAP Access instance must be set first');
-		}
-	}
+    /**
+     * @brief checks whether the Access instance has been set
+     * @throws \Exception if Access has not been set
+     * @return null
+     */
+    private function checkAccess() {
+        if(is_null($this->access)) {
+            throw new \Exception('LDAP Access instance must be set first');
+        }
+    }
 
-	/**
-	 * returns a list of attributes that will be processed further, e.g. quota,
-	 * email, displayname, or others.
-	 *
-	 * @param bool $minimal - optional, set to true to skip attributes with big
-	 * payload
-	 * @return string[]
-	 */
-	public function getAttributes($minimal = false) {
-		$baseAttributes = array_merge(Access::UUID_ATTRIBUTES, ['dn', 'uid', 'samaccountname', 'memberof']);
-		$attributes = [
-			$this->access->getConnection()->ldapExpertUUIDUserAttr,
-			$this->access->getConnection()->ldapQuotaAttribute,
-			$this->access->getConnection()->ldapEmailAttribute,
-			$this->access->getConnection()->ldapUserDisplayName,
-			$this->access->getConnection()->ldapUserDisplayName2,
-		];
+    /**
+     * returns a list of attributes that will be processed further, e.g. quota,
+     * email, displayname, or others.
+     *
+     * @param bool $minimal - optional, set to true to skip attributes with big
+     * payload
+     * @return string[]
+     */
+    public function getAttributes($minimal = false) {
+        $baseAttributes = array_merge(Access::UUID_ATTRIBUTES, ['dn', 'uid', 'samaccountname', 'memberof']);
+        $attributes = [
+            $this->access->getConnection()->ldapExpertUUIDUserAttr,
+            $this->access->getConnection()->ldapQuotaAttribute,
+            $this->access->getConnection()->ldapEmailAttribute,
+            $this->access->getConnection()->ldapUserDisplayName,
+            $this->access->getConnection()->ldapUserDisplayName2,
+        ];
 
-		$homeRule = $this->access->getConnection()->homeFolderNamingRule;
-		if(strpos($homeRule, 'attr:') === 0) {
-			$attributes[] = substr($homeRule, strlen('attr:'));
-		}
+        $homeRule = $this->access->getConnection()->homeFolderNamingRule;
+        if(strpos($homeRule, 'attr:') === 0) {
+            $attributes[] = substr($homeRule, strlen('attr:'));
+        }
 
-		if(!$minimal) {
-			// attributes that are not really important but may come with big
-			// payload.
-			$attributes = array_merge(
-				$attributes,
-				$this->access->getConnection()->resolveRule('avatar')
-			);
-		}
+        if(!$minimal) {
+            // attributes that are not really important but may come with big
+            // payload.
+            $attributes = array_merge(
+                $attributes,
+                $this->access->getConnection()->resolveRule('avatar')
+            );
+        }
 
-		$attributes = array_reduce($attributes,
-			function($list, $attribute) {
-				$attribute = strtolower(trim((string)$attribute));
-				if(!empty($attribute) && !in_array($attribute, $list)) {
-					$list[] = $attribute;
-				}
+        $attributes = array_reduce($attributes,
+            function($list, $attribute) {
+                $attribute = strtolower(trim((string)$attribute));
+                if(!empty($attribute) && !in_array($attribute, $list)) {
+                    $list[] = $attribute;
+                }
 
-				return $list;
-			},
-			$baseAttributes // hard-coded, lower-case, non-empty attributes
-		);
+                return $list;
+            },
+            $baseAttributes // hard-coded, lower-case, non-empty attributes
+        );
 
-		return $attributes;
-	}
+        return $attributes;
+    }
 
-	/**
-	 * Checks whether the specified user is marked as deleted
-	 * @param string $id the Nextcloud user name
-	 * @return bool
-	 */
-	public function isDeletedUser($id) {
-		$isDeleted = $this->ocConfig->getUserValue(
-			$id, 'user_ldap', 'isDeleted', 0);
-		return (int)$isDeleted === 1;
-	}
+    /**
+     * Checks whether the specified user is marked as deleted
+     * @param string $id the Nextcloud user name
+     * @return bool
+     */
+    public function isDeletedUser($id) {
+        $isDeleted = $this->ocConfig->getUserValue(
+            $id, 'user_ldap', 'isDeleted', 0);
+        return (int)$isDeleted === 1;
+    }
 
-	/**
-	 * creates and returns an instance of OfflineUser for the specified user
-	 * @param string $id
-	 * @return \OCA\User_LDAP\User\OfflineUser
-	 */
-	public function getDeletedUser($id) {
-		return new OfflineUser(
-			$id,
-			$this->ocConfig,
-			$this->db,
-			$this->access->getUserMapper());
-	}
+    /**
+     * creates and returns an instance of OfflineUser for the specified user
+     * @param string $id
+     * @return \OCA\User_LDAP\User\OfflineUser
+     */
+    public function getDeletedUser($id) {
+        return new OfflineUser(
+            $id,
+            $this->ocConfig,
+            $this->db,
+            $this->access->getUserMapper());
+    }
 
-	/**
-	 * @brief returns a User object by it's Nextcloud username
-	 * @param string $id the DN or username of the user
-	 * @return \OCA\User_LDAP\User\User|\OCA\User_LDAP\User\OfflineUser|null
-	 */
-	protected function createInstancyByUserName($id) {
-		//most likely a uid. Check whether it is a deleted user
-		if($this->isDeletedUser($id)) {
-			return $this->getDeletedUser($id);
-		}
-		$dn = $this->access->username2dn($id);
-		if($dn !== false) {
-			return $this->createAndCache($dn, $id);
-		}
-		return null;
-	}
+    /**
+     * @brief returns a User object by it's Nextcloud username
+     * @param string $id the DN or username of the user
+     * @return \OCA\User_LDAP\User\User|\OCA\User_LDAP\User\OfflineUser|null
+     */
+    protected function createInstancyByUserName($id) {
+        //most likely a uid. Check whether it is a deleted user
+        if($this->isDeletedUser($id)) {
+            return $this->getDeletedUser($id);
+        }
+        $dn = $this->access->username2dn($id);
+        if($dn !== false) {
+            return $this->createAndCache($dn, $id);
+        }
+        return null;
+    }
 
-	/**
-	 * @brief returns a User object by it's DN or Nextcloud username
-	 * @param string $id the DN or username of the user
-	 * @return \OCA\User_LDAP\User\User|\OCA\User_LDAP\User\OfflineUser|null
-	 * @throws \Exception when connection could not be established
-	 */
-	public function get($id) {
-		$this->checkAccess();
-		if(isset($this->usersByDN[$id])) {
-			return $this->usersByDN[$id];
-		} else if(isset($this->usersByUid[$id])) {
-			return $this->usersByUid[$id];
-		}
+    /**
+     * @brief returns a User object by it's DN or Nextcloud username
+     * @param string $id the DN or username of the user
+     * @return \OCA\User_LDAP\User\User|\OCA\User_LDAP\User\OfflineUser|null
+     * @throws \Exception when connection could not be established
+     */
+    public function get($id) {
+        $this->checkAccess();
+        if(isset($this->usersByDN[$id])) {
+            return $this->usersByDN[$id];
+        } else if(isset($this->usersByUid[$id])) {
+            return $this->usersByUid[$id];
+        }
 
-		if($this->access->stringResemblesDN($id) ) {
-			$uid = $this->access->dn2username($id);
-			if($uid !== false) {
-				return $this->createAndCache($id, $uid);
-			}
-		}
+        if($this->access->stringResemblesDN($id) ) {
+            $uid = $this->access->dn2username($id);
+            if($uid !== false) {
+                return $this->createAndCache($id, $uid);
+            }
+        }
 
-		return $this->createInstancyByUserName($id);
-	}
+        return $this->createInstancyByUserName($id);
+    }
 
 }

Spacing +13 added lines, -13 removed lines

@@ -141,7 +141,7 @@ 
 	 * @param $uid
 	 */
 	public function invalidate($uid) {
-		if(!isset($this->usersByUid[$uid])) {
+		if (!isset($this->usersByUid[$uid])) {
 			return;
 		}
 		$dn = $this->usersByUid[$uid]->getDN();
@@ -155,7 +155,7 @@ 
 	 * @return null
 	 */
 	private function checkAccess() {
-		if(is_null($this->access)) {
+		if (is_null($this->access)) {
 			throw new \Exception('LDAP Access instance must be set first');
 		}
 	}
@@ -179,11 +179,11 @@ 
 		];
 
 		$homeRule = $this->access->getConnection()->homeFolderNamingRule;
-		if(strpos($homeRule, 'attr:') === 0) {
+		if (strpos($homeRule, 'attr:') === 0) {
 			$attributes[] = substr($homeRule, strlen('attr:'));
 		}
 
-		if(!$minimal) {
+		if (!$minimal) {
 			// attributes that are not really important but may come with big
 			// payload.
 			$attributes = array_merge(
@@ -194,8 +194,8 @@ 
 
 		$attributes = array_reduce($attributes,
 			function($list, $attribute) {
-				$attribute = strtolower(trim((string)$attribute));
-				if(!empty($attribute) && !in_array($attribute, $list)) {
+				$attribute = strtolower(trim((string) $attribute));
+				if (!empty($attribute) && !in_array($attribute, $list)) {
 					$list[] = $attribute;
 				}
 
@@ -215,7 +215,7 @@ 
 	public function isDeletedUser($id) {
 		$isDeleted = $this->ocConfig->getUserValue(
 			$id, 'user_ldap', 'isDeleted', 0);
-		return (int)$isDeleted === 1;
+		return (int) $isDeleted === 1;
 	}
 
 	/**
@@ -238,11 +238,11 @@ 
 	 */
 	protected function createInstancyByUserName($id) {
 		//most likely a uid. Check whether it is a deleted user
-		if($this->isDeletedUser($id)) {
+		if ($this->isDeletedUser($id)) {
 			return $this->getDeletedUser($id);
 		}
 		$dn = $this->access->username2dn($id);
-		if($dn !== false) {
+		if ($dn !== false) {
 			return $this->createAndCache($dn, $id);
 		}
 		return null;
@@ -256,15 +256,15 @@ 
 	 */
 	public function get($id) {
 		$this->checkAccess();
-		if(isset($this->usersByDN[$id])) {
+		if (isset($this->usersByDN[$id])) {
 			return $this->usersByDN[$id];
-		} else if(isset($this->usersByUid[$id])) {
+		} else if (isset($this->usersByUid[$id])) {
 			return $this->usersByUid[$id];
 		}
 
-		if($this->access->stringResemblesDN($id) ) {
+		if ($this->access->stringResemblesDN($id)) {
 			$uid = $this->access->dn2username($id);
-			if($uid !== false) {
+			if ($uid !== false) {
 				return $this->createAndCache($id, $uid);
 			}
 		}