nextcloud / server

lib/private/Authentication/TwoFactorAuth/Manager.php

Spacing +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 			}
 		}
 
-		return array_filter($providers, function ($provider) use ($user) {
+		return array_filter($providers, function($provider) use ($user) {
 			/* @var $provider IProvider */
 			return $provider->isTwoFactorAuthEnabledForUser($user);
 		});

Indentation +288 added lines, -288 removed lines

@@ -41,296 +41,296 @@
 
 class Manager {
 
-	const SESSION_UID_KEY = 'two_factor_auth_uid';
-	const SESSION_UID_DONE = 'two_factor_auth_passed';
-	const BACKUP_CODES_APP_ID = 'twofactor_backupcodes';
-	const BACKUP_CODES_PROVIDER_ID = 'backup_codes';
-	const REMEMBER_LOGIN = 'two_factor_remember_login';
-
-	/** @var AppManager */
-	private $appManager;
-
-	/** @var ISession */
-	private $session;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IManager */
-	private $activityManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var TokenProvider */
-	private $tokenProvider;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/**
-	 * @param AppManager $appManager
-	 * @param ISession $session
-	 * @param IConfig $config
-	 * @param IManager $activityManager
-	 * @param ILogger $logger
-	 * @param TokenProvider $tokenProvider
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(AppManager $appManager,
-								ISession $session,
-								IConfig $config,
-								IManager $activityManager,
-								ILogger $logger,
-								TokenProvider $tokenProvider,
-								ITimeFactory $timeFactory) {
-		$this->appManager = $appManager;
-		$this->session = $session;
-		$this->config = $config;
-		$this->activityManager = $activityManager;
-		$this->logger = $logger;
-		$this->tokenProvider = $tokenProvider;
-		$this->timeFactory = $timeFactory;
-	}
-
-	/**
-	 * Determine whether the user must provide a second factor challenge
-	 *
-	 * @param IUser $user
-	 * @return boolean
-	 */
-	public function isTwoFactorAuthenticated(IUser $user) {
-		$twoFactorEnabled = ((int) $this->config->getUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 0)) === 0;
-		return $twoFactorEnabled && count($this->getProviders($user)) > 0;
-	}
-
-	/**
-	 * Disable 2FA checks for the given user
-	 *
-	 * @param IUser $user
-	 */
-	public function disableTwoFactorAuthentication(IUser $user) {
-		$this->config->setUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 1);
-	}
-
-	/**
-	 * Enable all 2FA checks for the given user
-	 *
-	 * @param IUser $user
-	 */
-	public function enableTwoFactorAuthentication(IUser $user) {
-		$this->config->deleteUserValue($user->getUID(), 'core', 'two_factor_auth_disabled');
-	}
-
-	/**
-	 * Get a 2FA provider by its ID
-	 *
-	 * @param IUser $user
-	 * @param string $challengeProviderId
-	 * @return IProvider|null
-	 */
-	public function getProvider(IUser $user, $challengeProviderId) {
-		$providers = $this->getProviders($user, true);
-		return isset($providers[$challengeProviderId]) ? $providers[$challengeProviderId] : null;
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return IProvider|null the backup provider, if enabled for the given user
-	 */
-	public function getBackupProvider(IUser $user) {
-		$providers = $this->getProviders($user, true);
-		if (!isset($providers[self::BACKUP_CODES_PROVIDER_ID])) {
-			return null;
-		}
-		return $providers[self::BACKUP_CODES_PROVIDER_ID];
-	}
-
-	/**
-	 * Get the list of 2FA providers for the given user
-	 *
-	 * @param IUser $user
-	 * @param bool $includeBackupApp
-	 * @return IProvider[]
-	 * @throws Exception
-	 */
-	public function getProviders(IUser $user, $includeBackupApp = false) {
-		$allApps = $this->appManager->getEnabledAppsForUser($user);
-		$providers = [];
-
-		foreach ($allApps as $appId) {
-			if (!$includeBackupApp && $appId === self::BACKUP_CODES_APP_ID) {
-				continue;
-			}
-
-			$info = $this->appManager->getAppInfo($appId);
-			if (isset($info['two-factor-providers'])) {
-				$providerClasses = $info['two-factor-providers'];
-				foreach ($providerClasses as $class) {
-					try {
-						$this->loadTwoFactorApp($appId);
-						$provider = OC::$server->query($class);
-						$providers[$provider->getId()] = $provider;
-					} catch (QueryException $exc) {
-						// Provider class can not be resolved
-						throw new Exception("Could not load two-factor auth provider $class");
-					}
-				}
-			}
-		}
-
-		return array_filter($providers, function ($provider) use ($user) {
-			/* @var $provider IProvider */
-			return $provider->isTwoFactorAuthEnabledForUser($user);
-		});
-	}
-
-	/**
-	 * Load an app by ID if it has not been loaded yet
-	 *
-	 * @param string $appId
-	 */
-	protected function loadTwoFactorApp($appId) {
-		if (!OC_App::isAppLoaded($appId)) {
-			OC_App::loadApp($appId);
-		}
-	}
-
-	/**
-	 * Verify the given challenge
-	 *
-	 * @param string $providerId
-	 * @param IUser $user
-	 * @param string $challenge
-	 * @return boolean
-	 */
-	public function verifyChallenge($providerId, IUser $user, $challenge) {
-		$provider = $this->getProvider($user, $providerId);
-		if (is_null($provider)) {
-			return false;
-		}
-
-		$passed = $provider->verifyChallenge($user, $challenge);
-		if ($passed) {
-			if ($this->session->get(self::REMEMBER_LOGIN) === true) {
-				// TODO: resolve cyclic dependency and use DI
-				\OC::$server->getUserSession()->createRememberMeToken($user);
-			}
-			$this->session->remove(self::SESSION_UID_KEY);
-			$this->session->remove(self::REMEMBER_LOGIN);
-			$this->session->set(self::SESSION_UID_DONE, $user->getUID());
-
-			// Clear token from db
-			$sessionId = $this->session->getId();
-			$token = $this->tokenProvider->getToken($sessionId);
-			$tokenId = $token->getId();
-			$this->config->deleteUserValue($user->getUID(), 'login_token_2fa', $tokenId);
-
-			$this->publishEvent($user, 'twofactor_success', [
-				'provider' => $provider->getDisplayName(),
-			]);
-		} else {
-			$this->publishEvent($user, 'twofactor_failed', [
-				'provider' => $provider->getDisplayName(),
-			]);
-		}
-		return $passed;
-	}
-
-	/**
-	 * Push a 2fa event the user's activity stream
-	 *
-	 * @param IUser $user
-	 * @param string $event
-	 */
-	private function publishEvent(IUser $user, $event, array $params) {
-		$activity = $this->activityManager->generateEvent();
-		$activity->setApp('core')
-			->setType('security')
-			->setAuthor($user->getUID())
-			->setAffectedUser($user->getUID())
-			->setSubject($event, $params);
-		try {
-			$this->activityManager->publish($activity);
-		} catch (BadMethodCallException $e) {
-			$this->logger->warning('could not publish backup code creation activity', ['app' => 'core']);
-			$this->logger->logException($e, ['app' => 'core']);
-		}
-	}
-
-	/**
-	 * Check if the currently logged in user needs to pass 2FA
-	 *
-	 * @param IUser $user the currently logged in user
-	 * @return boolean
-	 */
-	public function needsSecondFactor(IUser $user = null) {
-		if ($user === null) {
-			return false;
-		}
-
-		// If we are authenticated using an app password skip all this
-		if ($this->session->exists('app_password')) {
-			return false;
-		}
-
-		// First check if the session tells us we should do 2FA (99% case)
-		if (!$this->session->exists(self::SESSION_UID_KEY)) {
-
-			// Check if the session tells us it is 2FA authenticated already
-			if ($this->session->exists(self::SESSION_UID_DONE) &&
-				$this->session->get(self::SESSION_UID_DONE) === $user->getUID()) {
-				return false;
-			}
-
-			/*
+    const SESSION_UID_KEY = 'two_factor_auth_uid';
+    const SESSION_UID_DONE = 'two_factor_auth_passed';
+    const BACKUP_CODES_APP_ID = 'twofactor_backupcodes';
+    const BACKUP_CODES_PROVIDER_ID = 'backup_codes';
+    const REMEMBER_LOGIN = 'two_factor_remember_login';
+
+    /** @var AppManager */
+    private $appManager;
+
+    /** @var ISession */
+    private $session;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IManager */
+    private $activityManager;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var TokenProvider */
+    private $tokenProvider;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /**
+     * @param AppManager $appManager
+     * @param ISession $session
+     * @param IConfig $config
+     * @param IManager $activityManager
+     * @param ILogger $logger
+     * @param TokenProvider $tokenProvider
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(AppManager $appManager,
+                                ISession $session,
+                                IConfig $config,
+                                IManager $activityManager,
+                                ILogger $logger,
+                                TokenProvider $tokenProvider,
+                                ITimeFactory $timeFactory) {
+        $this->appManager = $appManager;
+        $this->session = $session;
+        $this->config = $config;
+        $this->activityManager = $activityManager;
+        $this->logger = $logger;
+        $this->tokenProvider = $tokenProvider;
+        $this->timeFactory = $timeFactory;
+    }
+
+    /**
+     * Determine whether the user must provide a second factor challenge
+     *
+     * @param IUser $user
+     * @return boolean
+     */
+    public function isTwoFactorAuthenticated(IUser $user) {
+        $twoFactorEnabled = ((int) $this->config->getUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 0)) === 0;
+        return $twoFactorEnabled && count($this->getProviders($user)) > 0;
+    }
+
+    /**
+     * Disable 2FA checks for the given user
+     *
+     * @param IUser $user
+     */
+    public function disableTwoFactorAuthentication(IUser $user) {
+        $this->config->setUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 1);
+    }
+
+    /**
+     * Enable all 2FA checks for the given user
+     *
+     * @param IUser $user
+     */
+    public function enableTwoFactorAuthentication(IUser $user) {
+        $this->config->deleteUserValue($user->getUID(), 'core', 'two_factor_auth_disabled');
+    }
+
+    /**
+     * Get a 2FA provider by its ID
+     *
+     * @param IUser $user
+     * @param string $challengeProviderId
+     * @return IProvider|null
+     */
+    public function getProvider(IUser $user, $challengeProviderId) {
+        $providers = $this->getProviders($user, true);
+        return isset($providers[$challengeProviderId]) ? $providers[$challengeProviderId] : null;
+    }
+
+    /**
+     * @param IUser $user
+     * @return IProvider|null the backup provider, if enabled for the given user
+     */
+    public function getBackupProvider(IUser $user) {
+        $providers = $this->getProviders($user, true);
+        if (!isset($providers[self::BACKUP_CODES_PROVIDER_ID])) {
+            return null;
+        }
+        return $providers[self::BACKUP_CODES_PROVIDER_ID];
+    }
+
+    /**
+     * Get the list of 2FA providers for the given user
+     *
+     * @param IUser $user
+     * @param bool $includeBackupApp
+     * @return IProvider[]
+     * @throws Exception
+     */
+    public function getProviders(IUser $user, $includeBackupApp = false) {
+        $allApps = $this->appManager->getEnabledAppsForUser($user);
+        $providers = [];
+
+        foreach ($allApps as $appId) {
+            if (!$includeBackupApp && $appId === self::BACKUP_CODES_APP_ID) {
+                continue;
+            }
+
+            $info = $this->appManager->getAppInfo($appId);
+            if (isset($info['two-factor-providers'])) {
+                $providerClasses = $info['two-factor-providers'];
+                foreach ($providerClasses as $class) {
+                    try {
+                        $this->loadTwoFactorApp($appId);
+                        $provider = OC::$server->query($class);
+                        $providers[$provider->getId()] = $provider;
+                    } catch (QueryException $exc) {
+                        // Provider class can not be resolved
+                        throw new Exception("Could not load two-factor auth provider $class");
+                    }
+                }
+            }
+        }
+
+        return array_filter($providers, function ($provider) use ($user) {
+            /* @var $provider IProvider */
+            return $provider->isTwoFactorAuthEnabledForUser($user);
+        });
+    }
+
+    /**
+     * Load an app by ID if it has not been loaded yet
+     *
+     * @param string $appId
+     */
+    protected function loadTwoFactorApp($appId) {
+        if (!OC_App::isAppLoaded($appId)) {
+            OC_App::loadApp($appId);
+        }
+    }
+
+    /**
+     * Verify the given challenge
+     *
+     * @param string $providerId
+     * @param IUser $user
+     * @param string $challenge
+     * @return boolean
+     */
+    public function verifyChallenge($providerId, IUser $user, $challenge) {
+        $provider = $this->getProvider($user, $providerId);
+        if (is_null($provider)) {
+            return false;
+        }
+
+        $passed = $provider->verifyChallenge($user, $challenge);
+        if ($passed) {
+            if ($this->session->get(self::REMEMBER_LOGIN) === true) {
+                // TODO: resolve cyclic dependency and use DI
+                \OC::$server->getUserSession()->createRememberMeToken($user);
+            }
+            $this->session->remove(self::SESSION_UID_KEY);
+            $this->session->remove(self::REMEMBER_LOGIN);
+            $this->session->set(self::SESSION_UID_DONE, $user->getUID());
+
+            // Clear token from db
+            $sessionId = $this->session->getId();
+            $token = $this->tokenProvider->getToken($sessionId);
+            $tokenId = $token->getId();
+            $this->config->deleteUserValue($user->getUID(), 'login_token_2fa', $tokenId);
+
+            $this->publishEvent($user, 'twofactor_success', [
+                'provider' => $provider->getDisplayName(),
+            ]);
+        } else {
+            $this->publishEvent($user, 'twofactor_failed', [
+                'provider' => $provider->getDisplayName(),
+            ]);
+        }
+        return $passed;
+    }
+
+    /**
+     * Push a 2fa event the user's activity stream
+     *
+     * @param IUser $user
+     * @param string $event
+     */
+    private function publishEvent(IUser $user, $event, array $params) {
+        $activity = $this->activityManager->generateEvent();
+        $activity->setApp('core')
+            ->setType('security')
+            ->setAuthor($user->getUID())
+            ->setAffectedUser($user->getUID())
+            ->setSubject($event, $params);
+        try {
+            $this->activityManager->publish($activity);
+        } catch (BadMethodCallException $e) {
+            $this->logger->warning('could not publish backup code creation activity', ['app' => 'core']);
+            $this->logger->logException($e, ['app' => 'core']);
+        }
+    }
+
+    /**
+     * Check if the currently logged in user needs to pass 2FA
+     *
+     * @param IUser $user the currently logged in user
+     * @return boolean
+     */
+    public function needsSecondFactor(IUser $user = null) {
+        if ($user === null) {
+            return false;
+        }
+
+        // If we are authenticated using an app password skip all this
+        if ($this->session->exists('app_password')) {
+            return false;
+        }
+
+        // First check if the session tells us we should do 2FA (99% case)
+        if (!$this->session->exists(self::SESSION_UID_KEY)) {
+
+            // Check if the session tells us it is 2FA authenticated already
+            if ($this->session->exists(self::SESSION_UID_DONE) &&
+                $this->session->get(self::SESSION_UID_DONE) === $user->getUID()) {
+                return false;
+            }
+
+            /*
 			 * If the session is expired check if we are not logged in by a token
 			 * that still needs 2FA auth
 			 */
-			try {
-				$sessionId = $this->session->getId();
-				$token = $this->tokenProvider->getToken($sessionId);
-				$tokenId = $token->getId();
-				$tokensNeeding2FA = $this->config->getUserKeys($user->getUID(), 'login_token_2fa');
-
-				if (!in_array($tokenId, $tokensNeeding2FA, true)) {
-					$this->session->set(self::SESSION_UID_DONE, $user->getUID());
-					return false;
-				}
-			} catch (InvalidTokenException $e) {
-			}
-		}
-
-		if (!$this->isTwoFactorAuthenticated($user)) {
-			// There is no second factor any more -> let the user pass
-			//   This prevents infinite redirect loops when a user is about
-			//   to solve the 2FA challenge, and the provider app is
-			//   disabled the same time
-			$this->session->remove(self::SESSION_UID_KEY);
-
-			$keys = $this->config->getUserKeys($user->getUID(), 'login_token_2fa');
-			foreach ($keys as $key) {
-				$this->config->deleteUserValue($user->getUID(), 'login_token_2fa', $key);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Prepare the 2FA login
-	 *
-	 * @param IUser $user
-	 * @param boolean $rememberMe
-	 */
-	public function prepareTwoFactorLogin(IUser $user, $rememberMe) {
-		$this->session->set(self::SESSION_UID_KEY, $user->getUID());
-		$this->session->set(self::REMEMBER_LOGIN, $rememberMe);
-
-		$id = $this->session->getId();
-		$token = $this->tokenProvider->getToken($id);
-		$this->config->setUserValue($user->getUID(), 'login_token_2fa', $token->getId(), $this->timeFactory->getTime());
-	}
+            try {
+                $sessionId = $this->session->getId();
+                $token = $this->tokenProvider->getToken($sessionId);
+                $tokenId = $token->getId();
+                $tokensNeeding2FA = $this->config->getUserKeys($user->getUID(), 'login_token_2fa');
+
+                if (!in_array($tokenId, $tokensNeeding2FA, true)) {
+                    $this->session->set(self::SESSION_UID_DONE, $user->getUID());
+                    return false;
+                }
+            } catch (InvalidTokenException $e) {
+            }
+        }
+
+        if (!$this->isTwoFactorAuthenticated($user)) {
+            // There is no second factor any more -> let the user pass
+            //   This prevents infinite redirect loops when a user is about
+            //   to solve the 2FA challenge, and the provider app is
+            //   disabled the same time
+            $this->session->remove(self::SESSION_UID_KEY);
+
+            $keys = $this->config->getUserKeys($user->getUID(), 'login_token_2fa');
+            foreach ($keys as $key) {
+                $this->config->deleteUserValue($user->getUID(), 'login_token_2fa', $key);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Prepare the 2FA login
+     *
+     * @param IUser $user
+     * @param boolean $rememberMe
+     */
+    public function prepareTwoFactorLogin(IUser $user, $rememberMe) {
+        $this->session->set(self::SESSION_UID_KEY, $user->getUID());
+        $this->session->set(self::REMEMBER_LOGIN, $rememberMe);
+
+        $id = $this->session->getId();
+        $token = $this->tokenProvider->getToken($id);
+        $this->config->setUserValue($user->getUID(), 'login_token_2fa', $token->getId(), $this->timeFactory->getTime());
+    }
 
 }

lib/private/Authentication/Token/DefaultTokenMapper.php

Spacing +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 		$data = $result->fetchAll();
 		$result->closeCursor();
 
-		$entities = array_map(function ($row) {
+		$entities = array_map(function($row) {
 			return DefaultToken::fromRow($row);
 		}, $data);
 

Indentation +129 added lines, -129 removed lines

@@ -36,134 +36,134 @@
 
 class DefaultTokenMapper extends Mapper {
 
-	public function __construct(IDBConnection $db) {
-		parent::__construct($db, 'authtoken');
-	}
-
-	/**
-	 * Invalidate (delete) a given token
-	 *
-	 * @param string $token
-	 */
-	public function invalidate($token) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('authtoken')
-			->where($qb->expr()->eq('token', $qb->createParameter('token')))
-			->setParameter('token', $token)
-			->execute();
-	}
-
-	/**
-	 * @param int $olderThan
-	 * @param int $remember
-	 */
-	public function invalidateOld($olderThan, $remember = IToken::DO_NOT_REMEMBER) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('authtoken')
-			->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT)))
-			->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT)))
-			->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT)))
-			->execute();
-	}
-
-	/**
-	 * Get the user UID for the given token
-	 *
-	 * @param string $token
-	 * @throws DoesNotExistException
-	 * @return DefaultToken
-	 */
-	public function getToken($token) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$result = $qb->select('*')
-			->from('authtoken')
-			->where($qb->expr()->eq('token', $qb->createNamedParameter($token)))
-			->execute();
-
-		$data = $result->fetch();
-		$result->closeCursor();
-		if ($data === false) {
-			throw new DoesNotExistException('token does not exist');
-		}
-		return DefaultToken::fromRow($data);
-	}
-
-	/**
-	 * Get the token for $id
-	 *
-	 * @param string $id
-	 * @throws DoesNotExistException
-	 * @return DefaultToken
-	 */
-	public function getTokenById($id) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$result = $qb->select('*')
-			->from('authtoken')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
-			->execute();
-
-		$data = $result->fetch();
-		$result->closeCursor();
-		if ($data === false) {
-			throw new DoesNotExistException('token does not exist');
-		}
-		return DefaultToken::fromRow($data);
-	}
-
-	/**
-	 * Get all tokens of a user
-	 *
-	 * The provider may limit the number of result rows in case of an abuse
-	 * where a high number of (session) tokens is generated
-	 *
-	 * @param IUser $user
-	 * @return DefaultToken[]
-	 */
-	public function getTokenByUser(IUser $user) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$qb->select('*')
-			->from('authtoken')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->setMaxResults(1000);
-		$result = $qb->execute();
-		$data = $result->fetchAll();
-		$result->closeCursor();
-
-		$entities = array_map(function ($row) {
-			return DefaultToken::fromRow($row);
-		}, $data);
-
-		return $entities;
-	}
-
-	/**
-	 * @param IUser $user
-	 * @param int $id
-	 */
-	public function deleteById(IUser $user, $id) {
-		/* @var $qb IQueryBuilder */
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('authtoken')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())));
-		$qb->execute();
-	}
-
-	/**
-	 * delete all auth token which belong to a specific client if the client was deleted
-	 *
-	 * @param string $name
-	 */
-	public function deleteByName($name) {
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete('authtoken')
-			->where($qb->expr()->eq('name', $qb->createNamedParameter($name), IQueryBuilder::PARAM_STR));
-		$qb->execute();
-	}
+    public function __construct(IDBConnection $db) {
+        parent::__construct($db, 'authtoken');
+    }
+
+    /**
+     * Invalidate (delete) a given token
+     *
+     * @param string $token
+     */
+    public function invalidate($token) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('authtoken')
+            ->where($qb->expr()->eq('token', $qb->createParameter('token')))
+            ->setParameter('token', $token)
+            ->execute();
+    }
+
+    /**
+     * @param int $olderThan
+     * @param int $remember
+     */
+    public function invalidateOld($olderThan, $remember = IToken::DO_NOT_REMEMBER) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('authtoken')
+            ->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT)))
+            ->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT)))
+            ->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT)))
+            ->execute();
+    }
+
+    /**
+     * Get the user UID for the given token
+     *
+     * @param string $token
+     * @throws DoesNotExistException
+     * @return DefaultToken
+     */
+    public function getToken($token) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $result = $qb->select('*')
+            ->from('authtoken')
+            ->where($qb->expr()->eq('token', $qb->createNamedParameter($token)))
+            ->execute();
+
+        $data = $result->fetch();
+        $result->closeCursor();
+        if ($data === false) {
+            throw new DoesNotExistException('token does not exist');
+        }
+        return DefaultToken::fromRow($data);
+    }
+
+    /**
+     * Get the token for $id
+     *
+     * @param string $id
+     * @throws DoesNotExistException
+     * @return DefaultToken
+     */
+    public function getTokenById($id) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $result = $qb->select('*')
+            ->from('authtoken')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+            ->execute();
+
+        $data = $result->fetch();
+        $result->closeCursor();
+        if ($data === false) {
+            throw new DoesNotExistException('token does not exist');
+        }
+        return DefaultToken::fromRow($data);
+    }
+
+    /**
+     * Get all tokens of a user
+     *
+     * The provider may limit the number of result rows in case of an abuse
+     * where a high number of (session) tokens is generated
+     *
+     * @param IUser $user
+     * @return DefaultToken[]
+     */
+    public function getTokenByUser(IUser $user) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $qb->select('*')
+            ->from('authtoken')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->setMaxResults(1000);
+        $result = $qb->execute();
+        $data = $result->fetchAll();
+        $result->closeCursor();
+
+        $entities = array_map(function ($row) {
+            return DefaultToken::fromRow($row);
+        }, $data);
+
+        return $entities;
+    }
+
+    /**
+     * @param IUser $user
+     * @param int $id
+     */
+    public function deleteById(IUser $user, $id) {
+        /* @var $qb IQueryBuilder */
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('authtoken')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())));
+        $qb->execute();
+    }
+
+    /**
+     * delete all auth token which belong to a specific client if the client was deleted
+     *
+     * @param string $name
+     */
+    public function deleteByName($name) {
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete('authtoken')
+            ->where($qb->expr()->eq('name', $qb->createNamedParameter($name), IQueryBuilder::PARAM_STR));
+        $qb->execute();
+    }
 
 }

lib/private/Authentication/Token/DefaultTokenCleanupJob.php

Indentation +5 added lines, -5 removed lines

@@ -27,10 +27,10 @@
 
 class DefaultTokenCleanupJob extends Job {
 
-	protected function run($argument) {
-		/* @var $provider IProvider */
-		$provider = OC::$server->query('OC\Authentication\Token\IProvider');
-		$provider->invalidateOldTokens();
-	}
+    protected function run($argument) {
+        /* @var $provider IProvider */
+        $provider = OC::$server->query('OC\Authentication\Token\IProvider');
+        $provider->invalidateOldTokens();
+    }
 
 }

lib/private/Console/TimestampFormatter.php

Spacing +1 added lines, -1 removed lines

@@ -103,6 +103,6 @@
 		$time = new \DateTime('now', $timeZone);
 		$timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM));
 
-		return $timestampInfo . ' ' . $this->formatter->format($message);
+		return $timestampInfo.' '.$this->formatter->format($message);
 	}
 }

Indentation +70 added lines, -70 removed lines

@@ -28,85 +28,85 @@
 use Symfony\Component\Console\Formatter\OutputFormatterStyleInterface;
 
 class TimestampFormatter implements OutputFormatterInterface {
-	/** @var IConfig */
-	protected $config;
+    /** @var IConfig */
+    protected $config;
 
-	/** @var OutputFormatterInterface */
-	protected $formatter;
+    /** @var OutputFormatterInterface */
+    protected $formatter;
 
-	/**
-	 * @param IConfig $config
-	 * @param OutputFormatterInterface $formatter
-	 */
-	public function __construct(IConfig $config, OutputFormatterInterface $formatter) {
-		$this->config = $config;
-		$this->formatter = $formatter;
-	}
+    /**
+     * @param IConfig $config
+     * @param OutputFormatterInterface $formatter
+     */
+    public function __construct(IConfig $config, OutputFormatterInterface $formatter) {
+        $this->config = $config;
+        $this->formatter = $formatter;
+    }
 
-	/**
-	 * Sets the decorated flag.
-	 *
-	 * @param bool $decorated Whether to decorate the messages or not
-	 */
-	public function setDecorated($decorated) {
-		$this->formatter->setDecorated($decorated);
-	}
+    /**
+     * Sets the decorated flag.
+     *
+     * @param bool $decorated Whether to decorate the messages or not
+     */
+    public function setDecorated($decorated) {
+        $this->formatter->setDecorated($decorated);
+    }
 
-	/**
-	 * Gets the decorated flag.
-	 *
-	 * @return bool true if the output will decorate messages, false otherwise
-	 */
-	public function isDecorated() {
-		return $this->formatter->isDecorated();
-	}
+    /**
+     * Gets the decorated flag.
+     *
+     * @return bool true if the output will decorate messages, false otherwise
+     */
+    public function isDecorated() {
+        return $this->formatter->isDecorated();
+    }
 
-	/**
-	 * Sets a new style.
-	 *
-	 * @param string $name The style name
-	 * @param OutputFormatterStyleInterface $style The style instance
-	 */
-	public function setStyle($name, OutputFormatterStyleInterface $style) {
-		$this->formatter->setStyle($name, $style);
-	}
+    /**
+     * Sets a new style.
+     *
+     * @param string $name The style name
+     * @param OutputFormatterStyleInterface $style The style instance
+     */
+    public function setStyle($name, OutputFormatterStyleInterface $style) {
+        $this->formatter->setStyle($name, $style);
+    }
 
-	/**
-	 * Checks if output formatter has style with specified name.
-	 *
-	 * @param string $name
-	 * @return bool
-	 */
-	public function hasStyle($name) {
-		return $this->formatter->hasStyle($name);
-	}
+    /**
+     * Checks if output formatter has style with specified name.
+     *
+     * @param string $name
+     * @return bool
+     */
+    public function hasStyle($name) {
+        return $this->formatter->hasStyle($name);
+    }
 
-	/**
-	 * Gets style options from style with specified name.
-	 *
-	 * @param string $name
-	 * @return OutputFormatterStyleInterface
-	 * @throws \InvalidArgumentException When style isn't defined
-	 */
-	public function getStyle($name) {
-		return $this->formatter->getStyle($name);
-	}
+    /**
+     * Gets style options from style with specified name.
+     *
+     * @param string $name
+     * @return OutputFormatterStyleInterface
+     * @throws \InvalidArgumentException When style isn't defined
+     */
+    public function getStyle($name) {
+        return $this->formatter->getStyle($name);
+    }
 
-	/**
-	 * Formats a message according to the given styles.
-	 *
-	 * @param string $message The message to style
-	 * @return string The styled message, prepended with a timestamp using the
-	 * log timezone and dateformat, e.g. "2015-06-23T17:24:37+02:00"
-	 */
-	public function format($message) {
+    /**
+     * Formats a message according to the given styles.
+     *
+     * @param string $message The message to style
+     * @return string The styled message, prepended with a timestamp using the
+     * log timezone and dateformat, e.g. "2015-06-23T17:24:37+02:00"
+     */
+    public function format($message) {
 
-		$timeZone = $this->config->getSystemValue('logtimezone', 'UTC');
-		$timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null;
+        $timeZone = $this->config->getSystemValue('logtimezone', 'UTC');
+        $timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null;
 
-		$time = new \DateTime('now', $timeZone);
-		$timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM));
+        $time = new \DateTime('now', $timeZone);
+        $timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTime::ATOM));
 
-		return $timestampInfo . ' ' . $this->formatter->format($message);
-	}
+        return $timestampInfo . ' ' . $this->formatter->format($message);
+    }
 }

lib/private/SubAdmin.php

Indentation +247 added lines, -247 removed lines

@@ -36,253 +36,253 @@
 
 class SubAdmin extends PublicEmitter {
 
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param IDBConnection $dbConn
-	 */
-	public function __construct(IUserManager $userManager,
-	                            IGroupManager $groupManager,
-								IDBConnection $dbConn) {
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->dbConn = $dbConn;
-
-		$this->userManager->listen('\OC\User', 'postDelete', function($user) {
-			$this->post_deleteUser($user);
-		});
-		$this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
-			$this->post_deleteGroup($group);	
-		});
-	}
-
-	/**
-	 * add a SubAdmin
-	 * @param IUser $user user to be SubAdmin
-	 * @param IGroup $group group $user becomes subadmin of
-	 * @return bool
-	 */
-	public function createSubAdmin(IUser $user, IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->insert('group_admin')
-			->values([
-				'gid' => $qb->createNamedParameter($group->getGID()),
-				'uid' => $qb->createNamedParameter($user->getUID())
-			])
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
-		return true;
-	}
-
-	/**
-	 * delete a SubAdmin
-	 * @param IUser $user the user that is the SubAdmin
-	 * @param IGroup $group the group
-	 * @return bool
-	 */
-	public function deleteSubAdmin(IUser $user, IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
-		return true;
-	}
-
-	/**
-	 * get groups of a SubAdmin
-	 * @param IUser $user the SubAdmin
-	 * @return IGroup[]
-	 */
-	public function getSubAdminsGroups(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$groups = [];
-		while($row = $result->fetch()) {
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($group)) {
-				$groups[] = $group;
-			}
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get SubAdmins of a group
-	 * @param IGroup $group the group
-	 * @return IUser[]
-	 */
-	public function getGroupsSubAdmins(IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('uid')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-
-		$users = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			if(!is_null($user)) {
-				$users[] = $user;
-			}
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get all SubAdmins
-	 * @return array
-	 */
-	public function getAllSubAdmins() {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('*')
-			->from('group_admin')
-			->execute();
-
-		$subadmins = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($user) && !is_null($group)) {
-				$subadmins[] = [
-					'user'  => $user,
-					'group' => $group
-				];
-			}
-		}
-		$result->closeCursor();
-
-		return $subadmins;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin of a group
-	 * @param IUser $user 
-	 * @param IGroup $group
-	 * @return bool
-	 */
-	public function isSubAdminOfGroup(IUser $user, IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		/*
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param IDBConnection $dbConn
+     */
+    public function __construct(IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IDBConnection $dbConn) {
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->dbConn = $dbConn;
+
+        $this->userManager->listen('\OC\User', 'postDelete', function($user) {
+            $this->post_deleteUser($user);
+        });
+        $this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
+            $this->post_deleteGroup($group);	
+        });
+    }
+
+    /**
+     * add a SubAdmin
+     * @param IUser $user user to be SubAdmin
+     * @param IGroup $group group $user becomes subadmin of
+     * @return bool
+     */
+    public function createSubAdmin(IUser $user, IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->insert('group_admin')
+            ->values([
+                'gid' => $qb->createNamedParameter($group->getGID()),
+                'uid' => $qb->createNamedParameter($user->getUID())
+            ])
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
+        return true;
+    }
+
+    /**
+     * delete a SubAdmin
+     * @param IUser $user the user that is the SubAdmin
+     * @param IGroup $group the group
+     * @return bool
+     */
+    public function deleteSubAdmin(IUser $user, IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
+        return true;
+    }
+
+    /**
+     * get groups of a SubAdmin
+     * @param IUser $user the SubAdmin
+     * @return IGroup[]
+     */
+    public function getSubAdminsGroups(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $groups = [];
+        while($row = $result->fetch()) {
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($group)) {
+                $groups[] = $group;
+            }
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get SubAdmins of a group
+     * @param IGroup $group the group
+     * @return IUser[]
+     */
+    public function getGroupsSubAdmins(IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('uid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+
+        $users = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            if(!is_null($user)) {
+                $users[] = $user;
+            }
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get all SubAdmins
+     * @return array
+     */
+    public function getAllSubAdmins() {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->execute();
+
+        $subadmins = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($user) && !is_null($group)) {
+                $subadmins[] = [
+                    'user'  => $user,
+                    'group' => $group
+                ];
+            }
+        }
+        $result->closeCursor();
+
+        return $subadmins;
+    }
+
+    /**
+     * checks if a user is a SubAdmin of a group
+     * @param IUser $user 
+     * @param IGroup $group
+     * @return bool
+     */
+    public function isSubAdminOfGroup(IUser $user, IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        /*
 		 * Primary key is ('gid', 'uid') so max 1 result possible here
 		 */
-		$result = $qb->select('*')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$fetch =  $result->fetch();
-		$result->closeCursor();
-		$result = !empty($fetch) ? true : false;
-
-		return $result;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin
-	 * @param IUser $user 
-	 * @return bool
-	 */
-	public function isSubAdmin(IUser $user) {
-		// Check if the user is already an admin
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->setMaxResults(1)
-			->execute();
-
-		$isSubAdmin = $result->fetch();
-		$result->closeCursor();
-
-		$result = $isSubAdmin === false ? false : true;
-
-		return $result;
-	}
-
-	/**
-	 * checks if a user is a accessible by a subadmin
-	 * @param IUser $subadmin
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function isUserAccessible($subadmin, $user) {
-		if(!$this->isSubAdmin($subadmin)) {
-			return false;
-		}
-		if($this->groupManager->isAdmin($user->getUID())) {
-			return false;
-		}
-		$accessibleGroups = $this->getSubAdminsGroups($subadmin);
-		foreach($accessibleGroups as $accessibleGroup) {
-			if($accessibleGroup->inGroup($user)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * delete all SubAdmins by $user
-	 * @param IUser $user
-	 * @return boolean
-	 */
-	private function post_deleteUser($user) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		return true;
-	}
-
-	/**
-	 * delete all SubAdmins by $group
-	 * @param IGroup $group
-	 * @return boolean
-	 */
-	private function post_deleteGroup($group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-
-		return true;
-	}
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $fetch =  $result->fetch();
+        $result->closeCursor();
+        $result = !empty($fetch) ? true : false;
+
+        return $result;
+    }
+
+    /**
+     * checks if a user is a SubAdmin
+     * @param IUser $user 
+     * @return bool
+     */
+    public function isSubAdmin(IUser $user) {
+        // Check if the user is already an admin
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->setMaxResults(1)
+            ->execute();
+
+        $isSubAdmin = $result->fetch();
+        $result->closeCursor();
+
+        $result = $isSubAdmin === false ? false : true;
+
+        return $result;
+    }
+
+    /**
+     * checks if a user is a accessible by a subadmin
+     * @param IUser $subadmin
+     * @param IUser $user
+     * @return bool
+     */
+    public function isUserAccessible($subadmin, $user) {
+        if(!$this->isSubAdmin($subadmin)) {
+            return false;
+        }
+        if($this->groupManager->isAdmin($user->getUID())) {
+            return false;
+        }
+        $accessibleGroups = $this->getSubAdminsGroups($subadmin);
+        foreach($accessibleGroups as $accessibleGroup) {
+            if($accessibleGroup->inGroup($user)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * delete all SubAdmins by $user
+     * @param IUser $user
+     * @return boolean
+     */
+    private function post_deleteUser($user) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        return true;
+    }
+
+    /**
+     * delete all SubAdmins by $group
+     * @param IGroup $group
+     * @return boolean
+     */
+    private function post_deleteGroup($group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+
+        return true;
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -119,9 +119,9 @@ 
 			->execute();
 
 		$groups = [];
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($group)) {
+			if (!is_null($group)) {
 				$groups[] = $group;
 			}
 		}
@@ -144,9 +144,9 @@ 
 			->execute();
 
 		$users = [];
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$user = $this->userManager->get($row['uid']);
-			if(!is_null($user)) {
+			if (!is_null($user)) {
 				$users[] = $user;
 			}
 		}
@@ -167,10 +167,10 @@ 
 			->execute();
 
 		$subadmins = [];
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$user = $this->userManager->get($row['uid']);
 			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($user) && !is_null($group)) {
+			if (!is_null($user) && !is_null($group)) {
 				$subadmins[] = [
 					'user'  => $user,
 					'group' => $group
@@ -200,7 +200,7 @@ 
 			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
 			->execute();
 
-		$fetch =  $result->fetch();
+		$fetch = $result->fetch();
 		$result->closeCursor();
 		$result = !empty($fetch) ? true : false;
 
@@ -241,15 +241,15 @@ 
 	 * @return bool
 	 */
 	public function isUserAccessible($subadmin, $user) {
-		if(!$this->isSubAdmin($subadmin)) {
+		if (!$this->isSubAdmin($subadmin)) {
 			return false;
 		}
-		if($this->groupManager->isAdmin($user->getUID())) {
+		if ($this->groupManager->isAdmin($user->getUID())) {
 			return false;
 		}
 		$accessibleGroups = $this->getSubAdminsGroups($subadmin);
-		foreach($accessibleGroups as $accessibleGroup) {
-			if($accessibleGroup->inGroup($user)) {
+		foreach ($accessibleGroups as $accessibleGroup) {
+			if ($accessibleGroup->inGroup($user)) {
 				return true;
 			}
 		}

lib/private/Activity/Event.php

Indentation +515 added lines, -515 removed lines

@@ -30,523 +30,523 @@
 
 class Event implements IEvent {
 
-	/** @var string */
-	protected $app = '';
-	/** @var string */
-	protected $type = '';
-	/** @var string */
-	protected $affectedUser = '';
-	/** @var string */
-	protected $author = '';
-	/** @var int */
-	protected $timestamp = 0;
-	/** @var string */
-	protected $subject = '';
-	/** @var array */
-	protected $subjectParameters = [];
-	/** @var string */
-	protected $subjectParsed;
-	/** @var string */
-	protected $subjectRich;
-	/** @var array */
-	protected $subjectRichParameters;
-	/** @var string */
-	protected $message = '';
-	/** @var array */
-	protected $messageParameters = [];
-	/** @var string */
-	protected $messageParsed;
-	/** @var string */
-	protected $messageRich;
-	/** @var array */
-	protected $messageRichParameters;
-	/** @var string */
-	protected $objectType = '';
-	/** @var int */
-	protected $objectId = 0;
-	/** @var string */
-	protected $objectName = '';
-	/** @var string */
-	protected $link = '';
-	/** @var string */
-	protected $icon = '';
-
-	/** @var IEvent */
-	protected $child = null;
-	/** @var IValidator */
-	protected $richValidator;
-
-	/**
-	 * @param IValidator $richValidator
-	 */
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
-	}
-
-	/**
-	 * Set the app of the activity
-	 *
-	 * @param string $app
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp($app) {
-		if (!is_string($app) || $app === '' || isset($app[32])) {
-			throw new \InvalidArgumentException('The given app is invalid');
-		}
-		$this->app = (string) $app;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getApp() {
-		return $this->app;
-	}
-
-	/**
-	 * Set the type of the activity
-	 *
-	 * @param string $type
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the type is invalid
-	 * @since 8.2.0
-	 */
-	public function setType($type) {
-		if (!is_string($type) || $type === '' || isset($type[255])) {
-			throw new \InvalidArgumentException('The given type is invalid');
-		}
-		$this->type = (string) $type;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getType() {
-		return $this->type;
-	}
-
-	/**
-	 * Set the affected user of the activity
-	 *
-	 * @param string $affectedUser
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the affected user is invalid
-	 * @since 8.2.0
-	 */
-	public function setAffectedUser($affectedUser) {
-		if (!is_string($affectedUser) || $affectedUser === '' || isset($affectedUser[64])) {
-			throw new \InvalidArgumentException('The given affected user is invalid');
-		}
-		$this->affectedUser = (string) $affectedUser;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAffectedUser() {
-		return $this->affectedUser;
-	}
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param string $author
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the author is invalid
-	 * @since 8.2.0
-	 */
-	public function setAuthor($author) {
-		if (!is_string($author) || isset($author[64])) {
-			throw new \InvalidArgumentException('The given author user is invalid'. serialize($author));
-		}
-		$this->author = (string) $author;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAuthor() {
-		return $this->author;
-	}
-
-	/**
-	 * Set the timestamp of the activity
-	 *
-	 * @param int $timestamp
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the timestamp is invalid
-	 * @since 8.2.0
-	 */
-	public function setTimestamp($timestamp) {
-		if (!is_int($timestamp)) {
-			throw new \InvalidArgumentException('The given timestamp is invalid');
-		}
-		$this->timestamp = (int) $timestamp;
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getTimestamp() {
-		return $this->timestamp;
-	}
-
-	/**
-	 * Set the subject of the activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject($subject, array $parameters = []) {
-		if (!is_string($subject) || isset($subject[255])) {
-			throw new \InvalidArgumentException('The given subject is invalid');
-		}
-		$this->subject = (string) $subject;
-		$this->subjectParameters = $parameters;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getSubject() {
-		return $this->subject;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getSubjectParameters() {
-		return $this->subjectParameters;
-	}
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedSubject($subject) {
-		if (!is_string($subject) || $subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectParsed = $subject;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedSubject() {
-		return $this->subjectParsed;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject($subject, array $parameters = []) {
-		if (!is_string($subject) || $subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectRich = $subject;
-
-		if (!is_array($parameters)) {
-			throw new \InvalidArgumentException('The given subject parameters are invalid');
-		}
-		$this->subjectRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject() {
-		return $this->subjectRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters() {
-		return $this->subjectRichParameters;
-	}
-
-	/**
-	 * Set the message of the activity
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage($message, array $parameters = []) {
-		if (!is_string($message) || isset($message[255])) {
-			throw new \InvalidArgumentException('The given message is invalid');
-		}
-		$this->message = (string) $message;
-		$this->messageParameters = $parameters;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMessage() {
-		return $this->message;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getMessageParameters() {
-		return $this->messageParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedMessage($message) {
-		if (!is_string($message)) {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-		$this->messageParsed = $message;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedMessage() {
-		return $this->messageParsed;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage($message, array $parameters = []) {
-		if (!is_string($message)) {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-		$this->messageRich = $message;
-
-		if (!is_array($parameters)) {
-			throw new \InvalidArgumentException('The given message parameters are invalid');
-		}
-		$this->messageRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage() {
-		return $this->messageRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters() {
-		return $this->messageRichParameters;
-	}
-
-	/**
-	 * Set the object of the activity
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @param string $objectName
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the object is invalid
-	 * @since 8.2.0
-	 */
-	public function setObject($objectType, $objectId, $objectName = '') {
-		if (!is_string($objectType) || isset($objectType[255])) {
-			throw new \InvalidArgumentException('The given object type is invalid');
-		}
-		if (!is_int($objectId)) {
-			throw new \InvalidArgumentException('The given object id is invalid');
-		}
-		if (!is_string($objectName) || isset($objectName[4000])) {
-			throw new \InvalidArgumentException('The given object name is invalid');
-		}
-		$this->objectType = (string) $objectType;
-		$this->objectId = (int) $objectId;
-		$this->objectName = (string) $objectName;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getObjectType() {
-		return $this->objectType;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getObjectId() {
-		return $this->objectId;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getObjectName() {
-		return $this->objectName;
-	}
-
-	/**
-	 * Set the link of the activity
-	 *
-	 * @param string $link
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink($link) {
-		if (!is_string($link) || isset($link[4000])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		$this->link = (string) $link;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getLink() {
-		return $this->link;
-	}
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon($icon) {
-		if (!is_string($icon) || isset($icon[4000])) {
-			throw new \InvalidArgumentException('The given icon is invalid');
-		}
-		$this->icon = $icon;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon() {
-		return $this->icon;
-	}
-
-	/**
-	 * @param IEvent $child
-	 * @since 11.0.0
-	 */
-	public function setChildEvent(IEvent $child) {
-		$this->child = $child;
-	}
-
-	/**
-	 * @return IEvent|null
-	 * @since 11.0.0
-	 */
-	public function getChildEvent() {
-		return $this->child;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValid() {
-		return
-			$this->isValidCommon()
-			&&
-			$this->getSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValidParsed() {
-		if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		return
-			$this->isValidCommon()
-			&&
-			$this->getParsedSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function isValidCommon() {
-		return
-			$this->getApp() !== ''
-			&&
-			$this->getType() !== ''
-			&&
-			$this->getAffectedUser() !== ''
-			&&
-			$this->getTimestamp() !== 0
-			/**
-			 * Disabled for BC with old activities
+    /** @var string */
+    protected $app = '';
+    /** @var string */
+    protected $type = '';
+    /** @var string */
+    protected $affectedUser = '';
+    /** @var string */
+    protected $author = '';
+    /** @var int */
+    protected $timestamp = 0;
+    /** @var string */
+    protected $subject = '';
+    /** @var array */
+    protected $subjectParameters = [];
+    /** @var string */
+    protected $subjectParsed;
+    /** @var string */
+    protected $subjectRich;
+    /** @var array */
+    protected $subjectRichParameters;
+    /** @var string */
+    protected $message = '';
+    /** @var array */
+    protected $messageParameters = [];
+    /** @var string */
+    protected $messageParsed;
+    /** @var string */
+    protected $messageRich;
+    /** @var array */
+    protected $messageRichParameters;
+    /** @var string */
+    protected $objectType = '';
+    /** @var int */
+    protected $objectId = 0;
+    /** @var string */
+    protected $objectName = '';
+    /** @var string */
+    protected $link = '';
+    /** @var string */
+    protected $icon = '';
+
+    /** @var IEvent */
+    protected $child = null;
+    /** @var IValidator */
+    protected $richValidator;
+
+    /**
+     * @param IValidator $richValidator
+     */
+    public function __construct(IValidator $richValidator) {
+        $this->richValidator = $richValidator;
+    }
+
+    /**
+     * Set the app of the activity
+     *
+     * @param string $app
+     * @return IEvent
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp($app) {
+        if (!is_string($app) || $app === '' || isset($app[32])) {
+            throw new \InvalidArgumentException('The given app is invalid');
+        }
+        $this->app = (string) $app;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getApp() {
+        return $this->app;
+    }
+
+    /**
+     * Set the type of the activity
+     *
+     * @param string $type
+     * @return IEvent
+     * @throws \InvalidArgumentException if the type is invalid
+     * @since 8.2.0
+     */
+    public function setType($type) {
+        if (!is_string($type) || $type === '' || isset($type[255])) {
+            throw new \InvalidArgumentException('The given type is invalid');
+        }
+        $this->type = (string) $type;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType() {
+        return $this->type;
+    }
+
+    /**
+     * Set the affected user of the activity
+     *
+     * @param string $affectedUser
+     * @return IEvent
+     * @throws \InvalidArgumentException if the affected user is invalid
+     * @since 8.2.0
+     */
+    public function setAffectedUser($affectedUser) {
+        if (!is_string($affectedUser) || $affectedUser === '' || isset($affectedUser[64])) {
+            throw new \InvalidArgumentException('The given affected user is invalid');
+        }
+        $this->affectedUser = (string) $affectedUser;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAffectedUser() {
+        return $this->affectedUser;
+    }
+
+    /**
+     * Set the author of the activity
+     *
+     * @param string $author
+     * @return IEvent
+     * @throws \InvalidArgumentException if the author is invalid
+     * @since 8.2.0
+     */
+    public function setAuthor($author) {
+        if (!is_string($author) || isset($author[64])) {
+            throw new \InvalidArgumentException('The given author user is invalid'. serialize($author));
+        }
+        $this->author = (string) $author;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthor() {
+        return $this->author;
+    }
+
+    /**
+     * Set the timestamp of the activity
+     *
+     * @param int $timestamp
+     * @return IEvent
+     * @throws \InvalidArgumentException if the timestamp is invalid
+     * @since 8.2.0
+     */
+    public function setTimestamp($timestamp) {
+        if (!is_int($timestamp)) {
+            throw new \InvalidArgumentException('The given timestamp is invalid');
+        }
+        $this->timestamp = (int) $timestamp;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getTimestamp() {
+        return $this->timestamp;
+    }
+
+    /**
+     * Set the subject of the activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject($subject, array $parameters = []) {
+        if (!is_string($subject) || isset($subject[255])) {
+            throw new \InvalidArgumentException('The given subject is invalid');
+        }
+        $this->subject = (string) $subject;
+        $this->subjectParameters = $parameters;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSubject() {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     */
+    public function getSubjectParameters() {
+        return $this->subjectParameters;
+    }
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 11.0.0
+     */
+    public function setParsedSubject($subject) {
+        if (!is_string($subject) || $subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectParsed = $subject;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedSubject() {
+        return $this->subjectParsed;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject($subject, array $parameters = []) {
+        if (!is_string($subject) || $subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectRich = $subject;
+
+        if (!is_array($parameters)) {
+            throw new \InvalidArgumentException('The given subject parameters are invalid');
+        }
+        $this->subjectRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject() {
+        return $this->subjectRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters() {
+        return $this->subjectRichParameters;
+    }
+
+    /**
+     * Set the message of the activity
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage($message, array $parameters = []) {
+        if (!is_string($message) || isset($message[255])) {
+            throw new \InvalidArgumentException('The given message is invalid');
+        }
+        $this->message = (string) $message;
+        $this->messageParameters = $parameters;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage() {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getMessageParameters() {
+        return $this->messageParameters;
+    }
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 11.0.0
+     */
+    public function setParsedMessage($message) {
+        if (!is_string($message)) {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+        $this->messageParsed = $message;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedMessage() {
+        return $this->messageParsed;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage($message, array $parameters = []) {
+        if (!is_string($message)) {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+        $this->messageRich = $message;
+
+        if (!is_array($parameters)) {
+            throw new \InvalidArgumentException('The given message parameters are invalid');
+        }
+        $this->messageRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage() {
+        return $this->messageRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters() {
+        return $this->messageRichParameters;
+    }
+
+    /**
+     * Set the object of the activity
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @param string $objectName
+     * @return IEvent
+     * @throws \InvalidArgumentException if the object is invalid
+     * @since 8.2.0
+     */
+    public function setObject($objectType, $objectId, $objectName = '') {
+        if (!is_string($objectType) || isset($objectType[255])) {
+            throw new \InvalidArgumentException('The given object type is invalid');
+        }
+        if (!is_int($objectId)) {
+            throw new \InvalidArgumentException('The given object id is invalid');
+        }
+        if (!is_string($objectName) || isset($objectName[4000])) {
+            throw new \InvalidArgumentException('The given object name is invalid');
+        }
+        $this->objectType = (string) $objectType;
+        $this->objectId = (int) $objectId;
+        $this->objectName = (string) $objectName;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectType() {
+        return $this->objectType;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectId() {
+        return $this->objectId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectName() {
+        return $this->objectName;
+    }
+
+    /**
+     * Set the link of the activity
+     *
+     * @param string $link
+     * @return IEvent
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink($link) {
+        if (!is_string($link) || isset($link[4000])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        $this->link = (string) $link;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLink() {
+        return $this->link;
+    }
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon($icon) {
+        if (!is_string($icon) || isset($icon[4000])) {
+            throw new \InvalidArgumentException('The given icon is invalid');
+        }
+        $this->icon = $icon;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon() {
+        return $this->icon;
+    }
+
+    /**
+     * @param IEvent $child
+     * @since 11.0.0
+     */
+    public function setChildEvent(IEvent $child) {
+        $this->child = $child;
+    }
+
+    /**
+     * @return IEvent|null
+     * @since 11.0.0
+     */
+    public function getChildEvent() {
+        return $this->child;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValid() {
+        return
+            $this->isValidCommon()
+            &&
+            $this->getSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValidParsed() {
+        if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        return
+            $this->isValidCommon()
+            &&
+            $this->getParsedSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isValidCommon() {
+        return
+            $this->getApp() !== ''
+            &&
+            $this->getType() !== ''
+            &&
+            $this->getAffectedUser() !== ''
+            &&
+            $this->getTimestamp() !== 0
+            /**
+             * Disabled for BC with old activities
 			&&
 			$this->getObjectType() !== ''
 			&&
 			$this->getObjectId() !== 0
-			 */
-		;
-	}
+             */
+        ;
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -162,7 +162,7 @@
 	 */
 	public function setAuthor($author) {
 		if (!is_string($author) || isset($author[64])) {
-			throw new \InvalidArgumentException('The given author user is invalid'. serialize($author));
+			throw new \InvalidArgumentException('The given author user is invalid'.serialize($author));
 		}
 		$this->author = (string) $author;
 		return $this;

lib/private/Activity/LegacyFilter.php

Indentation +71 added lines, -71 removed lines

@@ -26,83 +26,83 @@
 
 class LegacyFilter implements IFilter {
 
-	/** @var IManager */
-	protected $manager;
-	/** @var string */
-	protected $identifier;
-	/** @var string */
-	protected $name;
-	/** @var bool */
-	protected $isTopFilter;
+    /** @var IManager */
+    protected $manager;
+    /** @var string */
+    protected $identifier;
+    /** @var string */
+    protected $name;
+    /** @var bool */
+    protected $isTopFilter;
 
-	/**
-	 * LegacySetting constructor.
-	 *
-	 * @param IManager $manager
-	 * @param string $identifier
-	 * @param string $name
-	 * @param bool $isTopFilter
-	 */
-	public function __construct(IManager $manager,
-								$identifier,
-								$name,
-								$isTopFilter) {
-		$this->manager = $manager;
-		$this->identifier = $identifier;
-		$this->name = $name;
-		$this->isTopFilter = $isTopFilter;
-	}
+    /**
+     * LegacySetting constructor.
+     *
+     * @param IManager $manager
+     * @param string $identifier
+     * @param string $name
+     * @param bool $isTopFilter
+     */
+    public function __construct(IManager $manager,
+                                $identifier,
+                                $name,
+                                $isTopFilter) {
+        $this->manager = $manager;
+        $this->identifier = $identifier;
+        $this->name = $name;
+        $this->isTopFilter = $isTopFilter;
+    }
 
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier() {
-		return $this->identifier;
-	}
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier() {
+        return $this->identifier;
+    }
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName() {
-		return $this->name;
-	}
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName() {
+        return $this->name;
+    }
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority() {
-		return $this->isTopFilter ? 40 : 50;
-	}
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority() {
+        return $this->isTopFilter ? 40 : 50;
+    }
 
-	/**
-	 * @return string Full URL to an icon, empty string when none is given
-	 * @since 11.0.0
-	 */
-	public function getIcon() {
-		// Old API was CSS class, so we can not use this...
-		return '';
-	}
+    /**
+     * @return string Full URL to an icon, empty string when none is given
+     * @since 11.0.0
+     */
+    public function getIcon() {
+        // Old API was CSS class, so we can not use this...
+        return '';
+    }
 
-	/**
-	 * @param string[] $types
-	 * @return string[] An array of allowed apps from which activities should be displayed
-	 * @since 11.0.0
-	 */
-	public function filterTypes(array $types) {
-		return $this->manager->filterNotificationTypes($types, $this->getIdentifier());
-	}
+    /**
+     * @param string[] $types
+     * @return string[] An array of allowed apps from which activities should be displayed
+     * @since 11.0.0
+     */
+    public function filterTypes(array $types) {
+        return $this->manager->filterNotificationTypes($types, $this->getIdentifier());
+    }
 
-	/**
-	 * @return string[] An array of allowed apps from which activities should be displayed
-	 * @since 11.0.0
-	 */
-	public function allowedApps() {
-		return [];
-	}
+    /**
+     * @return string[] An array of allowed apps from which activities should be displayed
+     * @since 11.0.0
+     */
+    public function allowedApps() {
+        return [];
+    }
 }
 

lib/private/Activity/Manager.php

Spacing +3 added lines, -3 removed lines

@@ -112,7 +112,7 @@ 
 		}
 
 		$this->consumers = [];
-		foreach($this->consumersClosures as $consumer) {
+		foreach ($this->consumersClosures as $consumer) {
 			$c = $consumer();
 			if ($c instanceof IConsumer) {
 				$this->consumers[] = $c;
@@ -133,7 +133,7 @@ 
 		}
 
 		$this->extensions = [];
-		foreach($this->extensionsClosures as $extension) {
+		foreach ($this->extensionsClosures as $extension) {
 			$e = $extension();
 			if ($e instanceof IExtension) {
 				$this->extensions[] = $e;
@@ -669,7 +669,7 @@ 
 			return array(null, null);
 		}
 
-		return array(' and ((' . implode(') or (', $conditions) . '))', $parameters);
+		return array(' and (('.implode(') or (', $conditions).'))', $parameters);
 	}
 
 	/**

Indentation +684 added lines, -684 removed lines

@@ -39,688 +39,688 @@
 use OCP\RichObjectStrings\IValidator;
 
 class Manager implements IManager {
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected $session;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IValidator */
-	protected $validator;
-
-	/** @var string */
-	protected $formattingObjectType;
-
-	/** @var int */
-	protected $formattingObjectId;
-
-	/** @var bool */
-	protected $requirePNG;
-
-	/** @var string */
-	protected $currentUserId;
-
-	/**
-	 * constructor of the controller
-	 *
-	 * @param IRequest $request
-	 * @param IUserSession $session
-	 * @param IConfig $config
-	 * @param IValidator $validator
-	 */
-	public function __construct(IRequest $request,
-								IUserSession $session,
-								IConfig $config,
-								IValidator $validator) {
-		$this->request = $request;
-		$this->session = $session;
-		$this->config = $config;
-		$this->validator = $validator;
-	}
-
-	/** @var \Closure[] */
-	private $consumersClosures = array();
-
-	/** @var IConsumer[] */
-	private $consumers = array();
-
-	/** @var \Closure[] */
-	private $extensionsClosures = array();
-
-	/** @var IExtension[] */
-	private $extensions = array();
-
-	/** @var array list of filters "name" => "is valid" */
-	protected $validFilters = array(
-		'all'	=> true,
-		'by'	=> true,
-		'self'	=> true,
-	);
-
-	/** @var array list of type icons "type" => "css class" */
-	protected $typeIcons = array();
-
-	/** @var array list of special parameters "app" => ["text" => ["parameter" => "type"]] */
-	protected $specialParameters = array();
-
-	/**
-	 * @return \OCP\Activity\IConsumer[]
-	 */
-	protected function getConsumers() {
-		if (!empty($this->consumers)) {
-			return $this->consumers;
-		}
-
-		$this->consumers = [];
-		foreach($this->consumersClosures as $consumer) {
-			$c = $consumer();
-			if ($c instanceof IConsumer) {
-				$this->consumers[] = $c;
-			} else {
-				throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface');
-			}
-		}
-
-		return $this->consumers;
-	}
-
-	/**
-	 * @return \OCP\Activity\IExtension[]
-	 */
-	protected function getExtensions() {
-		if (!empty($this->extensions)) {
-			return $this->extensions;
-		}
-
-		$this->extensions = [];
-		foreach($this->extensionsClosures as $extension) {
-			$e = $extension();
-			if ($e instanceof IExtension) {
-				$this->extensions[] = $e;
-			} else {
-				throw new \InvalidArgumentException('The given extension does not implement the \OCP\Activity\IExtension interface');
-			}
-		}
-
-		return $this->extensions;
-	}
-
-	/**
-	 * Generates a new IEvent object
-	 *
-	 * Make sure to call at least the following methods before sending it to the
-	 * app with via the publish() method:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @return IEvent
-	 */
-	public function generateEvent() {
-		return new Event($this->validator);
-	}
-
-	/**
-	 * Publish an event to the activity consumers
-	 *
-	 * Make sure to call at least the following methods before sending an Event:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @param IEvent $event
-	 * @throws \BadMethodCallException if required values have not been set
-	 */
-	public function publish(IEvent $event) {
-		if ($event->getAuthor() === '') {
-			if ($this->session->getUser() instanceof IUser) {
-				$event->setAuthor($this->session->getUser()->getUID());
-			}
-		}
-
-		if (!$event->getTimestamp()) {
-			$event->setTimestamp(time());
-		}
-
-		if (!$event->isValid()) {
-			throw new \BadMethodCallException('The given event is invalid');
-		}
-
-		foreach ($this->getConsumers() as $c) {
-			$c->receive($event);
-		}
-	}
-
-	/**
-	 * @param string $app           The app where this event is associated with
-	 * @param string $subject       A short description of the event
-	 * @param array  $subjectParams Array with parameters that are filled in the subject
-	 * @param string $message       A longer description of the event
-	 * @param array  $messageParams Array with parameters that are filled in the message
-	 * @param string $file          The file including path where this event is associated with
-	 * @param string $link          A link where this event is associated with
-	 * @param string $affectedUser  Recipient of the activity
-	 * @param string $type          Type of the notification
-	 * @param int    $priority      Priority of the notification
-	 */
-	public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
-		$event = $this->generateEvent();
-		$event->setApp($app)
-			->setType($type)
-			->setAffectedUser($affectedUser)
-			->setSubject($subject, $subjectParams)
-			->setMessage($message, $messageParams)
-			->setObject('', 0, $file)
-			->setLink($link);
-
-		$this->publish($event);
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * activity consumers are actually requested
-	 *
-	 * $callable has to return an instance of OCA\Activity\IConsumer
-	 *
-	 * @param \Closure $callable
-	 */
-	public function registerConsumer(\Closure $callable) {
-		array_push($this->consumersClosures, $callable);
-		$this->consumers = [];
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * activity consumers are actually requested
-	 *
-	 * $callable has to return an instance of OCA\Activity\IExtension
-	 *
-	 * @param \Closure $callable
-	 */
-	public function registerExtension(\Closure $callable) {
-		array_push($this->extensionsClosures, $callable);
-		$this->extensions = [];
-	}
-
-	/** @var string[] */
-	protected $filterClasses = [];
-
-	/** @var IFilter[] */
-	protected $filters = [];
-
-	/** @var bool */
-	protected $loadedLegacyFilters = false;
-
-	/**
-	 * @param string $filter Class must implement OCA\Activity\IFilter
-	 * @return void
-	 */
-	public function registerFilter($filter) {
-		$this->filterClasses[$filter] = false;
-	}
-
-	/**
-	 * @return IFilter[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getFilters() {
-		if (!$this->loadedLegacyFilters) {
-			$legacyFilters = $this->getNavigation();
-
-			foreach ($legacyFilters['top'] as $filter => $data) {
-				$this->filters[$filter] = new LegacyFilter(
-					$this, $filter, $data['name'], true
-				);
-			}
-
-			foreach ($legacyFilters['apps'] as $filter => $data) {
-				$this->filters[$filter] = new LegacyFilter(
-					$this, $filter, $data['name'], false
-				);
-			}
-			$this->loadedLegacyFilters = true;
-		}
-
-		foreach ($this->filterClasses as $class => $false) {
-			/** @var IFilter $filter */
-			$filter = \OC::$server->query($class);
-
-			if (!$filter instanceof IFilter) {
-				throw new \InvalidArgumentException('Invalid activity filter registered');
-			}
-
-			$this->filters[$filter->getIdentifier()] = $filter;
-
-			unset($this->filterClasses[$class]);
-		}
-		return $this->filters;
-	}
-
-	/**
-	 * @param string $id
-	 * @return IFilter
-	 * @throws \InvalidArgumentException when the filter was not found
-	 * @since 11.0.0
-	 */
-	public function getFilterById($id) {
-		$filters = $this->getFilters();
-
-		if (isset($filters[$id])) {
-			return $filters[$id];
-		}
-
-		throw new \InvalidArgumentException('Requested filter does not exist');
-	}
-
-	/** @var string[] */
-	protected $providerClasses = [];
-
-	/** @var IProvider[] */
-	protected $providers = [];
-
-	/**
-	 * @param string $provider Class must implement OCA\Activity\IProvider
-	 * @return void
-	 */
-	public function registerProvider($provider) {
-		$this->providerClasses[$provider] = false;
-	}
-
-	/**
-	 * @return IProvider[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getProviders() {
-		foreach ($this->providerClasses as $class => $false) {
-			/** @var IProvider $provider */
-			$provider = \OC::$server->query($class);
-
-			if (!$provider instanceof IProvider) {
-				throw new \InvalidArgumentException('Invalid activity provider registered');
-			}
-
-			$this->providers[] = $provider;
-
-			unset($this->providerClasses[$class]);
-		}
-		return $this->providers;
-	}
-
-	/** @var string[] */
-	protected $settingsClasses = [];
-
-	/** @var ISetting[] */
-	protected $settings = [];
-
-	/** @var bool */
-	protected $loadedLegacyTypes = false;
-
-	/**
-	 * @param string $setting Class must implement OCA\Activity\ISetting
-	 * @return void
-	 */
-	public function registerSetting($setting) {
-		$this->settingsClasses[$setting] = false;
-	}
-
-	/**
-	 * @return ISetting[]
-	 * @throws \InvalidArgumentException
-	 */
-	public function getSettings() {
-		if (!$this->loadedLegacyTypes) {
-			$l = \OC::$server->getL10N('core');
-			$legacyTypes = $this->getNotificationTypes($l->getLanguageCode());
-			$streamTypes = $this->getDefaultTypes(IExtension::METHOD_STREAM);
-			$mailTypes = $this->getDefaultTypes(IExtension::METHOD_MAIL);
-			foreach ($legacyTypes as $type => $data) {
-				if (is_string($data)) {
-					$desc = $data;
-					$canChangeStream = true;
-					$canChangeMail = true;
-				} else {
-					$desc = $data['desc'];
-					$canChangeStream = in_array(IExtension::METHOD_STREAM, $data['methods']);
-					$canChangeMail = in_array(IExtension::METHOD_MAIL, $data['methods']);
-				}
-
-				$this->settings[$type] = new LegacySetting(
-					$type, $desc,
-					$canChangeStream, in_array($type, $streamTypes),
-					$canChangeMail, in_array($type, $mailTypes)
-				);
-			}
-			$this->loadedLegacyTypes = true;
-		}
-
-		foreach ($this->settingsClasses as $class => $false) {
-			/** @var ISetting $setting */
-			$setting = \OC::$server->query($class);
-
-			if (!$setting instanceof ISetting) {
-				throw new \InvalidArgumentException('Invalid activity filter registered');
-			}
-
-			$this->settings[$setting->getIdentifier()] = $setting;
-
-			unset($this->settingsClasses[$class]);
-		}
-		return $this->settings;
-	}
-
-	/**
-	 * @param string $id
-	 * @return ISetting
-	 * @throws \InvalidArgumentException when the setting was not found
-	 * @since 11.0.0
-	 */
-	public function getSettingById($id) {
-		$settings = $this->getSettings();
-
-		if (isset($settings[$id])) {
-			return $settings[$id];
-		}
-
-		throw new \InvalidArgumentException('Requested setting does not exist');
-	}
-
-	/**
-	 * @param string $type
-	 * @return string
-	 */
-	public function getTypeIcon($type) {
-		if (isset($this->typeIcons[$type])) {
-			return $this->typeIcons[$type];
-		}
-
-		foreach ($this->getExtensions() as $c) {
-			$icon = $c->getTypeIcon($type);
-			if (is_string($icon)) {
-				$this->typeIcons[$type] = $icon;
-				return $icon;
-			}
-		}
-
-		$this->typeIcons[$type] = '';
-		return '';
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 */
-	public function setFormattingObject($type, $id) {
-		$this->formattingObjectType = $type;
-		$this->formattingObjectId = (string) $id;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isFormattingFilteredObject() {
-		return $this->formattingObjectType !== null && $this->formattingObjectId !== null
-			&& $this->formattingObjectType === $this->request->getParam('object_type')
-			&& $this->formattingObjectId === $this->request->getParam('object_id');
-	}
-
-	/**
-	 * @param bool $status Set to true, when parsing events should not use SVG icons
-	 */
-	public function setRequirePNG($status) {
-		$this->requirePNG = $status;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function getRequirePNG() {
-		return $this->requirePNG;
-	}
-
-	/**
-	 * @param string $app
-	 * @param string $text
-	 * @param array $params
-	 * @param boolean $stripPath
-	 * @param boolean $highlightParams
-	 * @param string $languageCode
-	 * @return string|false
-	 */
-	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
-		foreach ($this->getExtensions() as $c) {
-			$translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
-			if (is_string($translation)) {
-				return $translation;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $app
-	 * @param string $text
-	 * @return array|false
-	 */
-	public function getSpecialParameterList($app, $text) {
-		if (isset($this->specialParameters[$app][$text])) {
-			return $this->specialParameters[$app][$text];
-		}
-
-		if (!isset($this->specialParameters[$app])) {
-			$this->specialParameters[$app] = array();
-		}
-
-		foreach ($this->getExtensions() as $c) {
-			$specialParameter = $c->getSpecialParameterList($app, $text);
-			if (is_array($specialParameter)) {
-				$this->specialParameters[$app][$text] = $specialParameter;
-				return $specialParameter;
-			}
-		}
-
-		$this->specialParameters[$app][$text] = false;
-		return false;
-	}
-
-	/**
-	 * @param array $activity
-	 * @return integer|false
-	 */
-	public function getGroupParameter($activity) {
-		foreach ($this->getExtensions() as $c) {
-			$parameter = $c->getGroupParameter($activity);
-			if ($parameter !== false) {
-				return $parameter;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Set the user we need to use
-	 *
-	 * @param string|null $currentUserId
-	 * @throws \UnexpectedValueException If the user is invalid
-	 */
-	public function setCurrentUserId($currentUserId) {
-		if (!is_string($currentUserId) && $currentUserId !== null) {
-			throw new \UnexpectedValueException('The given current user is invalid');
-		}
-		$this->currentUserId = $currentUserId;
-	}
-
-	/**
-	 * Get the user we need to use
-	 *
-	 * Either the user is logged in, or we try to get it from the token
-	 *
-	 * @return string
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
-	 */
-	public function getCurrentUserId() {
-		if ($this->currentUserId !== null) {
-			return $this->currentUserId;
-		} else if (!$this->session->isLoggedIn()) {
-			return $this->getUserFromToken();
-		} else {
-			return $this->session->getUser()->getUID();
-		}
-	}
-
-	/**
-	 * Get the user for the token
-	 *
-	 * @return string
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
-	 */
-	protected function getUserFromToken() {
-		$token = (string) $this->request->getParam('token', '');
-		if (strlen($token) !== 30) {
-			throw new \UnexpectedValueException('The token is invalid');
-		}
-
-		$users = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
-
-		if (count($users) !== 1) {
-			// No unique user found
-			throw new \UnexpectedValueException('The token is invalid');
-		}
-
-		// Token found login as that user
-		return array_shift($users);
-	}
-
-	/**
-	 * @return array
-	 * @deprecated 11.0.0 - Use getFilters() instead
-	 */
-	public function getNavigation() {
-		$entries = array(
-			'apps' => array(),
-			'top' => array(),
-		);
-		foreach ($this->getExtensions() as $c) {
-			$additionalEntries = $c->getNavigation();
-			if (is_array($additionalEntries)) {
-				$entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']);
-				$entries['top'] = array_merge($entries['top'], $additionalEntries['top']);
-			}
-		}
-
-		return $entries;
-	}
-
-	/**
-	 * @param string $filterValue
-	 * @return boolean
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function isFilterValid($filterValue) {
-		if (isset($this->validFilters[$filterValue])) {
-			return $this->validFilters[$filterValue];
-		}
-
-		foreach ($this->getExtensions() as $c) {
-			if ($c->isFilterValid($filterValue) === true) {
-				$this->validFilters[$filterValue] = true;
-				return true;
-			}
-		}
-
-		$this->validFilters[$filterValue] = false;
-		return false;
-	}
-
-	/**
-	 * @param array $types
-	 * @param string $filter
-	 * @return array
-	 * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
-	 */
-	public function filterNotificationTypes($types, $filter) {
-		if (!$this->isFilterValid($filter)) {
-			return $types;
-		}
-
-		foreach ($this->getExtensions() as $c) {
-			$result = $c->filterNotificationTypes($types, $filter);
-			if (is_array($result)) {
-				$types = $result;
-			}
-		}
-		return $types;
-	}
-
-	/**
-	 * @param string $filter
-	 * @return array
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function getQueryForFilter($filter) {
-		if (!$this->isFilterValid($filter)) {
-			return [null, null];
-		}
-
-		$conditions = array();
-		$parameters = array();
-
-		foreach ($this->getExtensions() as $c) {
-			$result = $c->getQueryForFilter($filter);
-			if (is_array($result)) {
-				list($condition, $parameter) = $result;
-				if ($condition && is_array($parameter)) {
-					$conditions[] = $condition;
-					$parameters = array_merge($parameters, $parameter);
-				}
-			}
-		}
-
-		if (empty($conditions)) {
-			return array(null, null);
-		}
-
-		return array(' and ((' . implode(') or (', $conditions) . '))', $parameters);
-	}
-
-	/**
-	 * Will return additional notification types as specified by other apps
-	 *
-	 * @param string $languageCode
-	 * @return array
-	 * @deprecated 11.0.0 - Use getSettings() instead
-	 */
-	public function getNotificationTypes($languageCode) {
-		$notificationTypes = $sharingNotificationTypes = [];
-		foreach ($this->getExtensions() as $c) {
-			$result = $c->getNotificationTypes($languageCode);
-			if (is_array($result)) {
-				$notificationTypes = array_merge($notificationTypes, $result);
-			}
-		}
-
-		return array_merge($sharingNotificationTypes, $notificationTypes);
-	}
-
-	/**
-	 * @param string $method
-	 * @return array
-	 * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
-	 */
-	public function getDefaultTypes($method) {
-		$defaultTypes = array();
-		foreach ($this->getExtensions() as $c) {
-			$types = $c->getDefaultTypes($method);
-			if (is_array($types)) {
-				$defaultTypes = array_merge($types, $defaultTypes);
-			}
-		}
-		return $defaultTypes;
-	}
+    /** @var IRequest */
+    protected $request;
+
+    /** @var IUserSession */
+    protected $session;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IValidator */
+    protected $validator;
+
+    /** @var string */
+    protected $formattingObjectType;
+
+    /** @var int */
+    protected $formattingObjectId;
+
+    /** @var bool */
+    protected $requirePNG;
+
+    /** @var string */
+    protected $currentUserId;
+
+    /**
+     * constructor of the controller
+     *
+     * @param IRequest $request
+     * @param IUserSession $session
+     * @param IConfig $config
+     * @param IValidator $validator
+     */
+    public function __construct(IRequest $request,
+                                IUserSession $session,
+                                IConfig $config,
+                                IValidator $validator) {
+        $this->request = $request;
+        $this->session = $session;
+        $this->config = $config;
+        $this->validator = $validator;
+    }
+
+    /** @var \Closure[] */
+    private $consumersClosures = array();
+
+    /** @var IConsumer[] */
+    private $consumers = array();
+
+    /** @var \Closure[] */
+    private $extensionsClosures = array();
+
+    /** @var IExtension[] */
+    private $extensions = array();
+
+    /** @var array list of filters "name" => "is valid" */
+    protected $validFilters = array(
+        'all'	=> true,
+        'by'	=> true,
+        'self'	=> true,
+    );
+
+    /** @var array list of type icons "type" => "css class" */
+    protected $typeIcons = array();
+
+    /** @var array list of special parameters "app" => ["text" => ["parameter" => "type"]] */
+    protected $specialParameters = array();
+
+    /**
+     * @return \OCP\Activity\IConsumer[]
+     */
+    protected function getConsumers() {
+        if (!empty($this->consumers)) {
+            return $this->consumers;
+        }
+
+        $this->consumers = [];
+        foreach($this->consumersClosures as $consumer) {
+            $c = $consumer();
+            if ($c instanceof IConsumer) {
+                $this->consumers[] = $c;
+            } else {
+                throw new \InvalidArgumentException('The given consumer does not implement the \OCP\Activity\IConsumer interface');
+            }
+        }
+
+        return $this->consumers;
+    }
+
+    /**
+     * @return \OCP\Activity\IExtension[]
+     */
+    protected function getExtensions() {
+        if (!empty($this->extensions)) {
+            return $this->extensions;
+        }
+
+        $this->extensions = [];
+        foreach($this->extensionsClosures as $extension) {
+            $e = $extension();
+            if ($e instanceof IExtension) {
+                $this->extensions[] = $e;
+            } else {
+                throw new \InvalidArgumentException('The given extension does not implement the \OCP\Activity\IExtension interface');
+            }
+        }
+
+        return $this->extensions;
+    }
+
+    /**
+     * Generates a new IEvent object
+     *
+     * Make sure to call at least the following methods before sending it to the
+     * app with via the publish() method:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @return IEvent
+     */
+    public function generateEvent() {
+        return new Event($this->validator);
+    }
+
+    /**
+     * Publish an event to the activity consumers
+     *
+     * Make sure to call at least the following methods before sending an Event:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @param IEvent $event
+     * @throws \BadMethodCallException if required values have not been set
+     */
+    public function publish(IEvent $event) {
+        if ($event->getAuthor() === '') {
+            if ($this->session->getUser() instanceof IUser) {
+                $event->setAuthor($this->session->getUser()->getUID());
+            }
+        }
+
+        if (!$event->getTimestamp()) {
+            $event->setTimestamp(time());
+        }
+
+        if (!$event->isValid()) {
+            throw new \BadMethodCallException('The given event is invalid');
+        }
+
+        foreach ($this->getConsumers() as $c) {
+            $c->receive($event);
+        }
+    }
+
+    /**
+     * @param string $app           The app where this event is associated with
+     * @param string $subject       A short description of the event
+     * @param array  $subjectParams Array with parameters that are filled in the subject
+     * @param string $message       A longer description of the event
+     * @param array  $messageParams Array with parameters that are filled in the message
+     * @param string $file          The file including path where this event is associated with
+     * @param string $link          A link where this event is associated with
+     * @param string $affectedUser  Recipient of the activity
+     * @param string $type          Type of the notification
+     * @param int    $priority      Priority of the notification
+     */
+    public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
+        $event = $this->generateEvent();
+        $event->setApp($app)
+            ->setType($type)
+            ->setAffectedUser($affectedUser)
+            ->setSubject($subject, $subjectParams)
+            ->setMessage($message, $messageParams)
+            ->setObject('', 0, $file)
+            ->setLink($link);
+
+        $this->publish($event);
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * activity consumers are actually requested
+     *
+     * $callable has to return an instance of OCA\Activity\IConsumer
+     *
+     * @param \Closure $callable
+     */
+    public function registerConsumer(\Closure $callable) {
+        array_push($this->consumersClosures, $callable);
+        $this->consumers = [];
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * activity consumers are actually requested
+     *
+     * $callable has to return an instance of OCA\Activity\IExtension
+     *
+     * @param \Closure $callable
+     */
+    public function registerExtension(\Closure $callable) {
+        array_push($this->extensionsClosures, $callable);
+        $this->extensions = [];
+    }
+
+    /** @var string[] */
+    protected $filterClasses = [];
+
+    /** @var IFilter[] */
+    protected $filters = [];
+
+    /** @var bool */
+    protected $loadedLegacyFilters = false;
+
+    /**
+     * @param string $filter Class must implement OCA\Activity\IFilter
+     * @return void
+     */
+    public function registerFilter($filter) {
+        $this->filterClasses[$filter] = false;
+    }
+
+    /**
+     * @return IFilter[]
+     * @throws \InvalidArgumentException
+     */
+    public function getFilters() {
+        if (!$this->loadedLegacyFilters) {
+            $legacyFilters = $this->getNavigation();
+
+            foreach ($legacyFilters['top'] as $filter => $data) {
+                $this->filters[$filter] = new LegacyFilter(
+                    $this, $filter, $data['name'], true
+                );
+            }
+
+            foreach ($legacyFilters['apps'] as $filter => $data) {
+                $this->filters[$filter] = new LegacyFilter(
+                    $this, $filter, $data['name'], false
+                );
+            }
+            $this->loadedLegacyFilters = true;
+        }
+
+        foreach ($this->filterClasses as $class => $false) {
+            /** @var IFilter $filter */
+            $filter = \OC::$server->query($class);
+
+            if (!$filter instanceof IFilter) {
+                throw new \InvalidArgumentException('Invalid activity filter registered');
+            }
+
+            $this->filters[$filter->getIdentifier()] = $filter;
+
+            unset($this->filterClasses[$class]);
+        }
+        return $this->filters;
+    }
+
+    /**
+     * @param string $id
+     * @return IFilter
+     * @throws \InvalidArgumentException when the filter was not found
+     * @since 11.0.0
+     */
+    public function getFilterById($id) {
+        $filters = $this->getFilters();
+
+        if (isset($filters[$id])) {
+            return $filters[$id];
+        }
+
+        throw new \InvalidArgumentException('Requested filter does not exist');
+    }
+
+    /** @var string[] */
+    protected $providerClasses = [];
+
+    /** @var IProvider[] */
+    protected $providers = [];
+
+    /**
+     * @param string $provider Class must implement OCA\Activity\IProvider
+     * @return void
+     */
+    public function registerProvider($provider) {
+        $this->providerClasses[$provider] = false;
+    }
+
+    /**
+     * @return IProvider[]
+     * @throws \InvalidArgumentException
+     */
+    public function getProviders() {
+        foreach ($this->providerClasses as $class => $false) {
+            /** @var IProvider $provider */
+            $provider = \OC::$server->query($class);
+
+            if (!$provider instanceof IProvider) {
+                throw new \InvalidArgumentException('Invalid activity provider registered');
+            }
+
+            $this->providers[] = $provider;
+
+            unset($this->providerClasses[$class]);
+        }
+        return $this->providers;
+    }
+
+    /** @var string[] */
+    protected $settingsClasses = [];
+
+    /** @var ISetting[] */
+    protected $settings = [];
+
+    /** @var bool */
+    protected $loadedLegacyTypes = false;
+
+    /**
+     * @param string $setting Class must implement OCA\Activity\ISetting
+     * @return void
+     */
+    public function registerSetting($setting) {
+        $this->settingsClasses[$setting] = false;
+    }
+
+    /**
+     * @return ISetting[]
+     * @throws \InvalidArgumentException
+     */
+    public function getSettings() {
+        if (!$this->loadedLegacyTypes) {
+            $l = \OC::$server->getL10N('core');
+            $legacyTypes = $this->getNotificationTypes($l->getLanguageCode());
+            $streamTypes = $this->getDefaultTypes(IExtension::METHOD_STREAM);
+            $mailTypes = $this->getDefaultTypes(IExtension::METHOD_MAIL);
+            foreach ($legacyTypes as $type => $data) {
+                if (is_string($data)) {
+                    $desc = $data;
+                    $canChangeStream = true;
+                    $canChangeMail = true;
+                } else {
+                    $desc = $data['desc'];
+                    $canChangeStream = in_array(IExtension::METHOD_STREAM, $data['methods']);
+                    $canChangeMail = in_array(IExtension::METHOD_MAIL, $data['methods']);
+                }
+
+                $this->settings[$type] = new LegacySetting(
+                    $type, $desc,
+                    $canChangeStream, in_array($type, $streamTypes),
+                    $canChangeMail, in_array($type, $mailTypes)
+                );
+            }
+            $this->loadedLegacyTypes = true;
+        }
+
+        foreach ($this->settingsClasses as $class => $false) {
+            /** @var ISetting $setting */
+            $setting = \OC::$server->query($class);
+
+            if (!$setting instanceof ISetting) {
+                throw new \InvalidArgumentException('Invalid activity filter registered');
+            }
+
+            $this->settings[$setting->getIdentifier()] = $setting;
+
+            unset($this->settingsClasses[$class]);
+        }
+        return $this->settings;
+    }
+
+    /**
+     * @param string $id
+     * @return ISetting
+     * @throws \InvalidArgumentException when the setting was not found
+     * @since 11.0.0
+     */
+    public function getSettingById($id) {
+        $settings = $this->getSettings();
+
+        if (isset($settings[$id])) {
+            return $settings[$id];
+        }
+
+        throw new \InvalidArgumentException('Requested setting does not exist');
+    }
+
+    /**
+     * @param string $type
+     * @return string
+     */
+    public function getTypeIcon($type) {
+        if (isset($this->typeIcons[$type])) {
+            return $this->typeIcons[$type];
+        }
+
+        foreach ($this->getExtensions() as $c) {
+            $icon = $c->getTypeIcon($type);
+            if (is_string($icon)) {
+                $this->typeIcons[$type] = $icon;
+                return $icon;
+            }
+        }
+
+        $this->typeIcons[$type] = '';
+        return '';
+    }
+
+    /**
+     * @param string $type
+     * @param string $id
+     */
+    public function setFormattingObject($type, $id) {
+        $this->formattingObjectType = $type;
+        $this->formattingObjectId = (string) $id;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isFormattingFilteredObject() {
+        return $this->formattingObjectType !== null && $this->formattingObjectId !== null
+            && $this->formattingObjectType === $this->request->getParam('object_type')
+            && $this->formattingObjectId === $this->request->getParam('object_id');
+    }
+
+    /**
+     * @param bool $status Set to true, when parsing events should not use SVG icons
+     */
+    public function setRequirePNG($status) {
+        $this->requirePNG = $status;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getRequirePNG() {
+        return $this->requirePNG;
+    }
+
+    /**
+     * @param string $app
+     * @param string $text
+     * @param array $params
+     * @param boolean $stripPath
+     * @param boolean $highlightParams
+     * @param string $languageCode
+     * @return string|false
+     */
+    public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
+        foreach ($this->getExtensions() as $c) {
+            $translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
+            if (is_string($translation)) {
+                return $translation;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $app
+     * @param string $text
+     * @return array|false
+     */
+    public function getSpecialParameterList($app, $text) {
+        if (isset($this->specialParameters[$app][$text])) {
+            return $this->specialParameters[$app][$text];
+        }
+
+        if (!isset($this->specialParameters[$app])) {
+            $this->specialParameters[$app] = array();
+        }
+
+        foreach ($this->getExtensions() as $c) {
+            $specialParameter = $c->getSpecialParameterList($app, $text);
+            if (is_array($specialParameter)) {
+                $this->specialParameters[$app][$text] = $specialParameter;
+                return $specialParameter;
+            }
+        }
+
+        $this->specialParameters[$app][$text] = false;
+        return false;
+    }
+
+    /**
+     * @param array $activity
+     * @return integer|false
+     */
+    public function getGroupParameter($activity) {
+        foreach ($this->getExtensions() as $c) {
+            $parameter = $c->getGroupParameter($activity);
+            if ($parameter !== false) {
+                return $parameter;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Set the user we need to use
+     *
+     * @param string|null $currentUserId
+     * @throws \UnexpectedValueException If the user is invalid
+     */
+    public function setCurrentUserId($currentUserId) {
+        if (!is_string($currentUserId) && $currentUserId !== null) {
+            throw new \UnexpectedValueException('The given current user is invalid');
+        }
+        $this->currentUserId = $currentUserId;
+    }
+
+    /**
+     * Get the user we need to use
+     *
+     * Either the user is logged in, or we try to get it from the token
+     *
+     * @return string
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
+     */
+    public function getCurrentUserId() {
+        if ($this->currentUserId !== null) {
+            return $this->currentUserId;
+        } else if (!$this->session->isLoggedIn()) {
+            return $this->getUserFromToken();
+        } else {
+            return $this->session->getUser()->getUID();
+        }
+    }
+
+    /**
+     * Get the user for the token
+     *
+     * @return string
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
+     */
+    protected function getUserFromToken() {
+        $token = (string) $this->request->getParam('token', '');
+        if (strlen($token) !== 30) {
+            throw new \UnexpectedValueException('The token is invalid');
+        }
+
+        $users = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
+
+        if (count($users) !== 1) {
+            // No unique user found
+            throw new \UnexpectedValueException('The token is invalid');
+        }
+
+        // Token found login as that user
+        return array_shift($users);
+    }
+
+    /**
+     * @return array
+     * @deprecated 11.0.0 - Use getFilters() instead
+     */
+    public function getNavigation() {
+        $entries = array(
+            'apps' => array(),
+            'top' => array(),
+        );
+        foreach ($this->getExtensions() as $c) {
+            $additionalEntries = $c->getNavigation();
+            if (is_array($additionalEntries)) {
+                $entries['apps'] = array_merge($entries['apps'], $additionalEntries['apps']);
+                $entries['top'] = array_merge($entries['top'], $additionalEntries['top']);
+            }
+        }
+
+        return $entries;
+    }
+
+    /**
+     * @param string $filterValue
+     * @return boolean
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function isFilterValid($filterValue) {
+        if (isset($this->validFilters[$filterValue])) {
+            return $this->validFilters[$filterValue];
+        }
+
+        foreach ($this->getExtensions() as $c) {
+            if ($c->isFilterValid($filterValue) === true) {
+                $this->validFilters[$filterValue] = true;
+                return true;
+            }
+        }
+
+        $this->validFilters[$filterValue] = false;
+        return false;
+    }
+
+    /**
+     * @param array $types
+     * @param string $filter
+     * @return array
+     * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
+     */
+    public function filterNotificationTypes($types, $filter) {
+        if (!$this->isFilterValid($filter)) {
+            return $types;
+        }
+
+        foreach ($this->getExtensions() as $c) {
+            $result = $c->filterNotificationTypes($types, $filter);
+            if (is_array($result)) {
+                $types = $result;
+            }
+        }
+        return $types;
+    }
+
+    /**
+     * @param string $filter
+     * @return array
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function getQueryForFilter($filter) {
+        if (!$this->isFilterValid($filter)) {
+            return [null, null];
+        }
+
+        $conditions = array();
+        $parameters = array();
+
+        foreach ($this->getExtensions() as $c) {
+            $result = $c->getQueryForFilter($filter);
+            if (is_array($result)) {
+                list($condition, $parameter) = $result;
+                if ($condition && is_array($parameter)) {
+                    $conditions[] = $condition;
+                    $parameters = array_merge($parameters, $parameter);
+                }
+            }
+        }
+
+        if (empty($conditions)) {
+            return array(null, null);
+        }
+
+        return array(' and ((' . implode(') or (', $conditions) . '))', $parameters);
+    }
+
+    /**
+     * Will return additional notification types as specified by other apps
+     *
+     * @param string $languageCode
+     * @return array
+     * @deprecated 11.0.0 - Use getSettings() instead
+     */
+    public function getNotificationTypes($languageCode) {
+        $notificationTypes = $sharingNotificationTypes = [];
+        foreach ($this->getExtensions() as $c) {
+            $result = $c->getNotificationTypes($languageCode);
+            if (is_array($result)) {
+                $notificationTypes = array_merge($notificationTypes, $result);
+            }
+        }
+
+        return array_merge($sharingNotificationTypes, $notificationTypes);
+    }
+
+    /**
+     * @param string $method
+     * @return array
+     * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
+     */
+    public function getDefaultTypes($method) {
+        $defaultTypes = array();
+        foreach ($this->getExtensions() as $c) {
+            $types = $c->getDefaultTypes($method);
+            if (is_array($types)) {
+                $defaultTypes = array_merge($types, $defaultTypes);
+            }
+        }
+        return $defaultTypes;
+    }
 }

lib/private/Activity/LegacySetting.php

Indentation +86 added lines, -86 removed lines

@@ -25,99 +25,99 @@
 
 class LegacySetting implements ISetting {
 
-	/** @var string */
-	protected $identifier;
-	/** @var string */
-	protected $name;
-	/** @var bool */
-	protected $canChangeStream;
-	/** @var bool */
-	protected $isDefaultEnabledStream;
-	/** @var bool */
-	protected $canChangeMail;
-	/** @var bool */
-	protected $isDefaultEnabledMail;
+    /** @var string */
+    protected $identifier;
+    /** @var string */
+    protected $name;
+    /** @var bool */
+    protected $canChangeStream;
+    /** @var bool */
+    protected $isDefaultEnabledStream;
+    /** @var bool */
+    protected $canChangeMail;
+    /** @var bool */
+    protected $isDefaultEnabledMail;
 
-	/**
-	 * LegacySetting constructor.
-	 *
-	 * @param string $identifier
-	 * @param string $name
-	 * @param bool $canChangeStream
-	 * @param bool $isDefaultEnabledStream
-	 * @param bool $canChangeMail
-	 * @param bool $isDefaultEnabledMail
-	 */
-	public function __construct($identifier,
-								$name,
-								$canChangeStream,
-								$isDefaultEnabledStream,
-								$canChangeMail,
-								$isDefaultEnabledMail) {
-		$this->identifier = $identifier;
-		$this->name = $name;
-		$this->canChangeStream = $canChangeStream;
-		$this->isDefaultEnabledStream = $isDefaultEnabledStream;
-		$this->canChangeMail = $canChangeMail;
-		$this->isDefaultEnabledMail = $isDefaultEnabledMail;
-	}
+    /**
+     * LegacySetting constructor.
+     *
+     * @param string $identifier
+     * @param string $name
+     * @param bool $canChangeStream
+     * @param bool $isDefaultEnabledStream
+     * @param bool $canChangeMail
+     * @param bool $isDefaultEnabledMail
+     */
+    public function __construct($identifier,
+                                $name,
+                                $canChangeStream,
+                                $isDefaultEnabledStream,
+                                $canChangeMail,
+                                $isDefaultEnabledMail) {
+        $this->identifier = $identifier;
+        $this->name = $name;
+        $this->canChangeStream = $canChangeStream;
+        $this->isDefaultEnabledStream = $isDefaultEnabledStream;
+        $this->canChangeMail = $canChangeMail;
+        $this->isDefaultEnabledMail = $isDefaultEnabledMail;
+    }
 
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier() {
-		return $this->identifier;
-	}
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier() {
+        return $this->identifier;
+    }
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName() {
-		return $this->name;
-	}
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName() {
+        return $this->name;
+    }
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority() {
-		return 70;
-	}
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority() {
+        return 70;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function canChangeStream() {
-		return $this->canChangeStream;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function canChangeStream() {
+        return $this->canChangeStream;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledStream() {
-		return $this->isDefaultEnabledStream;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledStream() {
+        return $this->isDefaultEnabledStream;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the mail
-	 * @since 11.0.0
-	 */
-	public function canChangeMail() {
-		return $this->canChangeMail;
-	}
+    /**
+     * @return bool True when the option can be changed for the mail
+     * @since 11.0.0
+     */
+    public function canChangeMail() {
+        return $this->canChangeMail;
+    }
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledMail() {
-		return $this->isDefaultEnabledMail;
-	}
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledMail() {
+        return $this->isDefaultEnabledMail;
+    }
 }