nextcloud / server

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

Indentation +667 added lines, -667 removed lines

@@ -39,671 +39,671 @@
 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 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 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 (sizeof($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 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 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 (sizeof($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;
+    }
 }
 

lib/private/Security/CSP/ContentSecurityPolicyNonceManager.php

Indentation +42 added lines, -42 removed lines

@@ -29,52 +29,52 @@
  * @package OC\Security\CSP
  */
 class ContentSecurityPolicyNonceManager {
-	/** @var CsrfTokenManager */
-	private $csrfTokenManager;
-	/** @var IRequest */
-	private $request;
-	/** @var string */
-	private $nonce = '';
+    /** @var CsrfTokenManager */
+    private $csrfTokenManager;
+    /** @var IRequest */
+    private $request;
+    /** @var string */
+    private $nonce = '';
 
-	/**
-	 * @param CsrfTokenManager $csrfTokenManager
-	 * @param IRequest $request
-	 */
-	public function __construct(CsrfTokenManager $csrfTokenManager,
-								IRequest $request) {
-		$this->csrfTokenManager = $csrfTokenManager;
-		$this->request = $request;
-	}
+    /**
+     * @param CsrfTokenManager $csrfTokenManager
+     * @param IRequest $request
+     */
+    public function __construct(CsrfTokenManager $csrfTokenManager,
+                                IRequest $request) {
+        $this->csrfTokenManager = $csrfTokenManager;
+        $this->request = $request;
+    }
 
-	/**
-	 * Returns the current CSP nounce
-	 *
-	 * @return string
-	 */
-	public function getNonce() {
-		if($this->nonce === '') {
-			$this->nonce = base64_encode($this->csrfTokenManager->getToken()->getEncryptedValue());
-		}
+    /**
+     * Returns the current CSP nounce
+     *
+     * @return string
+     */
+    public function getNonce() {
+        if($this->nonce === '') {
+            $this->nonce = base64_encode($this->csrfTokenManager->getToken()->getEncryptedValue());
+        }
 
-		return $this->nonce;
-	}
+        return $this->nonce;
+    }
 
-	/**
-	 * Check if the browser supports CSP v3
-	 *
-	 * @return bool
-	 */
-	public function browserSupportsCspV3() {
-		$browserWhitelist = [
-			Request::USER_AGENT_CHROME,
-			// Firefox 45+
-			'/^Mozilla\/5\.0 \([^)]+\) Gecko\/[0-9.]+ Firefox\/(4[5-9]|[5-9][0-9])\.[0-9.]+$/',
-		];
+    /**
+     * Check if the browser supports CSP v3
+     *
+     * @return bool
+     */
+    public function browserSupportsCspV3() {
+        $browserWhitelist = [
+            Request::USER_AGENT_CHROME,
+            // Firefox 45+
+            '/^Mozilla\/5\.0 \([^)]+\) Gecko\/[0-9.]+ Firefox\/(4[5-9]|[5-9][0-9])\.[0-9.]+$/',
+        ];
 
-		if($this->request->isUserAgent($browserWhitelist)) {
-			return true;
-		}
+        if($this->request->isUserAgent($browserWhitelist)) {
+            return true;
+        }
 
-		return false;
-	}
+        return false;
+    }
 }

lib/private/Security/CSP/ContentSecurityPolicy.php

Indentation +167 added lines, -167 removed lines

@@ -29,172 +29,172 @@
  * @package OC\Security\CSP
  */
 class ContentSecurityPolicy extends \OCP\AppFramework\Http\ContentSecurityPolicy {
-	/**
-	 * @return boolean
-	 */
-	public function isInlineScriptAllowed() {
-		return $this->inlineScriptAllowed;
-	}
-
-	/**
-	 * @param boolean $inlineScriptAllowed
-	 */
-	public function setInlineScriptAllowed($inlineScriptAllowed) {
-		$this->inlineScriptAllowed = $inlineScriptAllowed;
-	}
-
-	/**
-	 * @return boolean
-	 */
-	public function isEvalScriptAllowed() {
-		return $this->evalScriptAllowed;
-	}
-
-	/**
-	 * @param boolean $evalScriptAllowed
-	 */
-	public function setEvalScriptAllowed($evalScriptAllowed) {
-		$this->evalScriptAllowed = $evalScriptAllowed;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedScriptDomains() {
-		return $this->allowedScriptDomains;
-	}
-
-	/**
-	 * @param array $allowedScriptDomains
-	 */
-	public function setAllowedScriptDomains($allowedScriptDomains) {
-		$this->allowedScriptDomains = $allowedScriptDomains;
-	}
-
-	/**
-	 * @return boolean
-	 */
-	public function isInlineStyleAllowed() {
-		return $this->inlineStyleAllowed;
-	}
-
-	/**
-	 * @param boolean $inlineStyleAllowed
-	 */
-	public function setInlineStyleAllowed($inlineStyleAllowed) {
-		$this->inlineStyleAllowed = $inlineStyleAllowed;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedStyleDomains() {
-		return $this->allowedStyleDomains;
-	}
-
-	/**
-	 * @param array $allowedStyleDomains
-	 */
-	public function setAllowedStyleDomains($allowedStyleDomains) {
-		$this->allowedStyleDomains = $allowedStyleDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedImageDomains() {
-		return $this->allowedImageDomains;
-	}
-
-	/**
-	 * @param array $allowedImageDomains
-	 */
-	public function setAllowedImageDomains($allowedImageDomains) {
-		$this->allowedImageDomains = $allowedImageDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedConnectDomains() {
-		return $this->allowedConnectDomains;
-	}
-
-	/**
-	 * @param array $allowedConnectDomains
-	 */
-	public function setAllowedConnectDomains($allowedConnectDomains) {
-		$this->allowedConnectDomains = $allowedConnectDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedMediaDomains() {
-		return $this->allowedMediaDomains;
-	}
-
-	/**
-	 * @param array $allowedMediaDomains
-	 */
-	public function setAllowedMediaDomains($allowedMediaDomains) {
-		$this->allowedMediaDomains = $allowedMediaDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedObjectDomains() {
-		return $this->allowedObjectDomains;
-	}
-
-	/**
-	 * @param array $allowedObjectDomains
-	 */
-	public function setAllowedObjectDomains($allowedObjectDomains) {
-		$this->allowedObjectDomains = $allowedObjectDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedFrameDomains() {
-		return $this->allowedFrameDomains;
-	}
-
-	/**
-	 * @param array $allowedFrameDomains
-	 */
-	public function setAllowedFrameDomains($allowedFrameDomains) {
-		$this->allowedFrameDomains = $allowedFrameDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedFontDomains() {
-		return $this->allowedFontDomains;
-	}
-
-	/**
-	 * @param array $allowedFontDomains
-	 */
-	public function setAllowedFontDomains($allowedFontDomains) {
-		$this->allowedFontDomains = $allowedFontDomains;
-	}
-
-	/**
-	 * @return array
-	 */
-	public function getAllowedChildSrcDomains() {
-		return $this->allowedChildSrcDomains;
-	}
-
-	/**
-	 * @param array $allowedChildSrcDomains
-	 */
-	public function setAllowedChildSrcDomains($allowedChildSrcDomains) {
-		$this->allowedChildSrcDomains = $allowedChildSrcDomains;
-	}
+    /**
+     * @return boolean
+     */
+    public function isInlineScriptAllowed() {
+        return $this->inlineScriptAllowed;
+    }
+
+    /**
+     * @param boolean $inlineScriptAllowed
+     */
+    public function setInlineScriptAllowed($inlineScriptAllowed) {
+        $this->inlineScriptAllowed = $inlineScriptAllowed;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function isEvalScriptAllowed() {
+        return $this->evalScriptAllowed;
+    }
+
+    /**
+     * @param boolean $evalScriptAllowed
+     */
+    public function setEvalScriptAllowed($evalScriptAllowed) {
+        $this->evalScriptAllowed = $evalScriptAllowed;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedScriptDomains() {
+        return $this->allowedScriptDomains;
+    }
+
+    /**
+     * @param array $allowedScriptDomains
+     */
+    public function setAllowedScriptDomains($allowedScriptDomains) {
+        $this->allowedScriptDomains = $allowedScriptDomains;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function isInlineStyleAllowed() {
+        return $this->inlineStyleAllowed;
+    }
+
+    /**
+     * @param boolean $inlineStyleAllowed
+     */
+    public function setInlineStyleAllowed($inlineStyleAllowed) {
+        $this->inlineStyleAllowed = $inlineStyleAllowed;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedStyleDomains() {
+        return $this->allowedStyleDomains;
+    }
+
+    /**
+     * @param array $allowedStyleDomains
+     */
+    public function setAllowedStyleDomains($allowedStyleDomains) {
+        $this->allowedStyleDomains = $allowedStyleDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedImageDomains() {
+        return $this->allowedImageDomains;
+    }
+
+    /**
+     * @param array $allowedImageDomains
+     */
+    public function setAllowedImageDomains($allowedImageDomains) {
+        $this->allowedImageDomains = $allowedImageDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedConnectDomains() {
+        return $this->allowedConnectDomains;
+    }
+
+    /**
+     * @param array $allowedConnectDomains
+     */
+    public function setAllowedConnectDomains($allowedConnectDomains) {
+        $this->allowedConnectDomains = $allowedConnectDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedMediaDomains() {
+        return $this->allowedMediaDomains;
+    }
+
+    /**
+     * @param array $allowedMediaDomains
+     */
+    public function setAllowedMediaDomains($allowedMediaDomains) {
+        $this->allowedMediaDomains = $allowedMediaDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedObjectDomains() {
+        return $this->allowedObjectDomains;
+    }
+
+    /**
+     * @param array $allowedObjectDomains
+     */
+    public function setAllowedObjectDomains($allowedObjectDomains) {
+        $this->allowedObjectDomains = $allowedObjectDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedFrameDomains() {
+        return $this->allowedFrameDomains;
+    }
+
+    /**
+     * @param array $allowedFrameDomains
+     */
+    public function setAllowedFrameDomains($allowedFrameDomains) {
+        $this->allowedFrameDomains = $allowedFrameDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedFontDomains() {
+        return $this->allowedFontDomains;
+    }
+
+    /**
+     * @param array $allowedFontDomains
+     */
+    public function setAllowedFontDomains($allowedFontDomains) {
+        $this->allowedFontDomains = $allowedFontDomains;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllowedChildSrcDomains() {
+        return $this->allowedChildSrcDomains;
+    }
+
+    /**
+     * @param array $allowedChildSrcDomains
+     */
+    public function setAllowedChildSrcDomains($allowedChildSrcDomains) {
+        $this->allowedChildSrcDomains = $allowedChildSrcDomains;
+    }
 
 }

lib/private/Security/CSP/ContentSecurityPolicyManager.php

Indentation +40 added lines, -40 removed lines

@@ -27,48 +27,48 @@
 use OCP\Security\IContentSecurityPolicyManager;
 
 class ContentSecurityPolicyManager implements IContentSecurityPolicyManager {
-	/** @var ContentSecurityPolicy[] */
-	private $policies = [];
+    /** @var ContentSecurityPolicy[] */
+    private $policies = [];
 
-	/** {@inheritdoc} */
-	public function addDefaultPolicy(EmptyContentSecurityPolicy $policy) {
-		$this->policies[] = $policy;
-	}
+    /** {@inheritdoc} */
+    public function addDefaultPolicy(EmptyContentSecurityPolicy $policy) {
+        $this->policies[] = $policy;
+    }
 
-	/**
-	 * Get the configured default policy. This is not in the public namespace
-	 * as it is only supposed to be used by core itself.
-	 *
-	 * @return ContentSecurityPolicy
-	 */
-	public function getDefaultPolicy() {
-		$defaultPolicy = new \OC\Security\CSP\ContentSecurityPolicy();
-		foreach($this->policies as $policy) {
-			$defaultPolicy = $this->mergePolicies($defaultPolicy, $policy);
-		}
-		return $defaultPolicy;
-	}
+    /**
+     * Get the configured default policy. This is not in the public namespace
+     * as it is only supposed to be used by core itself.
+     *
+     * @return ContentSecurityPolicy
+     */
+    public function getDefaultPolicy() {
+        $defaultPolicy = new \OC\Security\CSP\ContentSecurityPolicy();
+        foreach($this->policies as $policy) {
+            $defaultPolicy = $this->mergePolicies($defaultPolicy, $policy);
+        }
+        return $defaultPolicy;
+    }
 
-	/**
-	 * Merges the first given policy with the second one
-	 *
-	 * @param ContentSecurityPolicy $defaultPolicy
-	 * @param EmptyContentSecurityPolicy $originalPolicy
-	 * @return ContentSecurityPolicy
-	 */
-	public function mergePolicies(ContentSecurityPolicy $defaultPolicy,
-								  EmptyContentSecurityPolicy $originalPolicy) {
-		foreach((object)(array)$originalPolicy as $name => $value) {
-			$setter = 'set'.ucfirst($name);
-			if(is_array($value)) {
-				$getter = 'get'.ucfirst($name);
-				$currentValues = is_array($defaultPolicy->$getter()) ? $defaultPolicy->$getter() : [];
-				$defaultPolicy->$setter(array_values(array_unique(array_merge($currentValues, $value))));
-			} elseif (is_bool($value)) {
-				$defaultPolicy->$setter($value);
-			}
-		}
+    /**
+     * Merges the first given policy with the second one
+     *
+     * @param ContentSecurityPolicy $defaultPolicy
+     * @param EmptyContentSecurityPolicy $originalPolicy
+     * @return ContentSecurityPolicy
+     */
+    public function mergePolicies(ContentSecurityPolicy $defaultPolicy,
+                                    EmptyContentSecurityPolicy $originalPolicy) {
+        foreach((object)(array)$originalPolicy as $name => $value) {
+            $setter = 'set'.ucfirst($name);
+            if(is_array($value)) {
+                $getter = 'get'.ucfirst($name);
+                $currentValues = is_array($defaultPolicy->$getter()) ? $defaultPolicy->$getter() : [];
+                $defaultPolicy->$setter(array_values(array_unique(array_merge($currentValues, $value))));
+            } elseif (is_bool($value)) {
+                $defaultPolicy->$setter($value);
+            }
+        }
 
-		return $defaultPolicy;
-	}
+        return $defaultPolicy;
+    }
 }

lib/private/Security/CredentialsManager.php

Indentation +78 added lines, -78 removed lines

@@ -34,93 +34,93 @@
  */
 class CredentialsManager implements ICredentialsManager {
 
-	const DB_TABLE = 'credentials';
+    const DB_TABLE = 'credentials';
 
-	/** @var ICrypto */
-	protected $crypto;
+    /** @var ICrypto */
+    protected $crypto;
 
-	/** @var IDBConnection */
-	protected $dbConnection;
+    /** @var IDBConnection */
+    protected $dbConnection;
 
-	/**
-	 * @param ICrypto $crypto
-	 * @param IDBConnection $dbConnection
-	 */
-	public function __construct(ICrypto $crypto, IDBConnection $dbConnection) {
-		$this->crypto = $crypto;
-		$this->dbConnection = $dbConnection;
-	}
+    /**
+     * @param ICrypto $crypto
+     * @param IDBConnection $dbConnection
+     */
+    public function __construct(ICrypto $crypto, IDBConnection $dbConnection) {
+        $this->crypto = $crypto;
+        $this->dbConnection = $dbConnection;
+    }
 
-	/**
-	 * Store a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @param mixed $credentials
-	 */
-	public function store($userId, $identifier, $credentials) {
-		$value = $this->crypto->encrypt(json_encode($credentials));
+    /**
+     * Store a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @param mixed $credentials
+     */
+    public function store($userId, $identifier, $credentials) {
+        $value = $this->crypto->encrypt(json_encode($credentials));
 
-		$this->dbConnection->setValues(self::DB_TABLE, [
-			'user' => $userId,
-			'identifier' => $identifier,
-		], [
-			'credentials' => $value,
-		]);
-	}
+        $this->dbConnection->setValues(self::DB_TABLE, [
+            'user' => $userId,
+            'identifier' => $identifier,
+        ], [
+            'credentials' => $value,
+        ]);
+    }
 
-	/**
-	 * Retrieve a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return mixed
-	 */
-	public function retrieve($userId, $identifier) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('credentials')
-			->from(self::DB_TABLE)
-			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
-			->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier)))
-		;
-		$result = $qb->execute()->fetch();
+    /**
+     * Retrieve a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return mixed
+     */
+    public function retrieve($userId, $identifier) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('credentials')
+            ->from(self::DB_TABLE)
+            ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
+            ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier)))
+        ;
+        $result = $qb->execute()->fetch();
 
-		if (!$result) {
-			return null;
-		}
-		$value = $result['credentials'];
+        if (!$result) {
+            return null;
+        }
+        $value = $result['credentials'];
 
-		return json_decode($this->crypto->decrypt($value), true);
-	}
+        return json_decode($this->crypto->decrypt($value), true);
+    }
 
-	/**
-	 * Delete a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return int rows removed
-	 */
-	public function delete($userId, $identifier) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->delete(self::DB_TABLE)
-			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
-			->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier)))
-		;
-		return $qb->execute();
-	}
+    /**
+     * Delete a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return int rows removed
+     */
+    public function delete($userId, $identifier) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->delete(self::DB_TABLE)
+            ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
+            ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier)))
+        ;
+        return $qb->execute();
+    }
 
-	/**
-	 * Erase all credentials stored for a user
-	 *
-	 * @param string $userId
-	 * @return int rows removed
-	 */
-	public function erase($userId) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->delete(self::DB_TABLE)
-			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
-		;
-		return $qb->execute();
-	}
+    /**
+     * Erase all credentials stored for a user
+     *
+     * @param string $userId
+     * @return int rows removed
+     */
+    public function erase($userId) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->delete(self::DB_TABLE)
+            ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
+        ;
+        return $qb->execute();
+    }
 
 }

lib/private/Security/TrustedDomainHelper.php

Indentation +59 added lines, -59 removed lines

@@ -32,68 +32,68 @@
  * @package OC\Security
  */
 class TrustedDomainHelper {
-	/** @var IConfig */
-	private $config;
+    /** @var IConfig */
+    private $config;
 
-	/**
-	 * @param IConfig $config
-	 */
-	function __construct(IConfig $config) {
-		$this->config = $config;
-	}
+    /**
+     * @param IConfig $config
+     */
+    function __construct(IConfig $config) {
+        $this->config = $config;
+    }
 
-	/**
-	 * Strips a potential port from a domain (in format domain:port)
-	 * @param string $host
-	 * @return string $host without appended port
-	 */
-	private function getDomainWithoutPort($host) {
-		$pos = strrpos($host, ':');
-		if ($pos !== false) {
-			$port = substr($host, $pos + 1);
-			if (is_numeric($port)) {
-				$host = substr($host, 0, $pos);
-			}
-		}
-		return $host;
-	}
+    /**
+     * Strips a potential port from a domain (in format domain:port)
+     * @param string $host
+     * @return string $host without appended port
+     */
+    private function getDomainWithoutPort($host) {
+        $pos = strrpos($host, ':');
+        if ($pos !== false) {
+            $port = substr($host, $pos + 1);
+            if (is_numeric($port)) {
+                $host = substr($host, 0, $pos);
+            }
+        }
+        return $host;
+    }
 
-	/**
-	 * Checks whether a domain is considered as trusted from the list
-	 * of trusted domains. If no trusted domains have been configured, returns
-	 * true.
-	 * This is used to prevent Host Header Poisoning.
-	 * @param string $domainWithPort
-	 * @return bool true if the given domain is trusted or if no trusted domains
-	 * have been configured
-	 */
-	public function isTrustedDomain($domainWithPort) {
-		$domain = $this->getDomainWithoutPort($domainWithPort);
+    /**
+     * Checks whether a domain is considered as trusted from the list
+     * of trusted domains. If no trusted domains have been configured, returns
+     * true.
+     * This is used to prevent Host Header Poisoning.
+     * @param string $domainWithPort
+     * @return bool true if the given domain is trusted or if no trusted domains
+     * have been configured
+     */
+    public function isTrustedDomain($domainWithPort) {
+        $domain = $this->getDomainWithoutPort($domainWithPort);
 
-		// Read trusted domains from config
-		$trustedList = $this->config->getSystemValue('trusted_domains', []);
-		if (!is_array($trustedList)) {
-			return false;
-		}
+        // Read trusted domains from config
+        $trustedList = $this->config->getSystemValue('trusted_domains', []);
+        if (!is_array($trustedList)) {
+            return false;
+        }
 
-		// Always allow access from localhost
-		if (preg_match(Request::REGEX_LOCALHOST, $domain) === 1) {
-			return true;
-		}
-		// Reject misformed domains in any case
-		if (strpos($domain,'-') === 0 || strpos($domain,'..') !== false) {
-			return false;
-		}
-		// Match, allowing for * wildcards
-		foreach ($trustedList as $trusted) {
-			if (gettype($trusted) !== 'string') {
-				break;
-			}
-			$regex = '/^' . join('[-\.a-zA-Z0-9]*', array_map(function($v) { return preg_quote($v, '/'); }, explode('*', $trusted))) . '$/';
-			if (preg_match($regex, $domain) || preg_match($regex, $domainWithPort)) {
- 				return true;
- 			}
- 		}
- 		return false;
-	}
+        // Always allow access from localhost
+        if (preg_match(Request::REGEX_LOCALHOST, $domain) === 1) {
+            return true;
+        }
+        // Reject misformed domains in any case
+        if (strpos($domain,'-') === 0 || strpos($domain,'..') !== false) {
+            return false;
+        }
+        // Match, allowing for * wildcards
+        foreach ($trustedList as $trusted) {
+            if (gettype($trusted) !== 'string') {
+                break;
+            }
+            $regex = '/^' . join('[-\.a-zA-Z0-9]*', array_map(function($v) { return preg_quote($v, '/'); }, explode('*', $trusted))) . '$/';
+            if (preg_match($regex, $domain) || preg_match($regex, $domainWithPort)) {
+                    return true;
+                }
+            }
+            return false;
+    }
 }

lib/private/Security/Hasher.php

Indentation +111 added lines, -111 removed lines

@@ -46,116 +46,116 @@
  * @package OC\Security
  */
 class Hasher implements IHasher {
-	/** @var IConfig */
-	private $config;
-	/** @var array Options passed to password_hash and password_needs_rehash */
-	private $options = array();
-	/** @var string Salt used for legacy passwords */
-	private $legacySalt = null;
-	/** @var int Current version of the generated hash */
-	private $currentVersion = 1;
-
-	/**
-	 * @param IConfig $config
-	 */
-	function __construct(IConfig $config) {
-		$this->config = $config;
-
-		$hashingCost = $this->config->getSystemValue('hashingCost', null);
-		if(!is_null($hashingCost)) {
-			$this->options['cost'] = $hashingCost;
-		}
-	}
-
-	/**
-	 * Hashes a message using PHP's `password_hash` functionality.
-	 * Please note that the size of the returned string is not guaranteed
-	 * and can be up to 255 characters.
-	 *
-	 * @param string $message Message to generate hash from
-	 * @return string Hash of the message with appended version parameter
-	 */
-	public function hash($message) {
-		return $this->currentVersion . '|' . password_hash($message, PASSWORD_DEFAULT, $this->options);
-	}
-
-	/**
-	 * Get the version and hash from a prefixedHash
-	 * @param string $prefixedHash
-	 * @return null|array Null if the hash is not prefixed, otherwise array('version' => 1, 'hash' => 'foo')
-	 */
-	protected function splitHash($prefixedHash) {
-		$explodedString = explode('|', $prefixedHash, 2);
-		if(sizeof($explodedString) === 2) {
-			if((int)$explodedString[0] > 0) {
-				return array('version' => (int)$explodedString[0], 'hash' => $explodedString[1]);
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * Verify legacy hashes
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash
-	 * @return bool Whether $hash is a valid hash of $message
-	 */
-	protected function legacyHashVerify($message, $hash, &$newHash = null) {
-		if(empty($this->legacySalt)) {
-			$this->legacySalt = $this->config->getSystemValue('passwordsalt', '');
-		}
-
-		// Verify whether it matches a legacy PHPass or SHA1 string
-		$hashLength = strlen($hash);
-		if($hashLength === 60 && password_verify($message.$this->legacySalt, $hash) ||
-			$hashLength === 40 && hash_equals($hash, sha1($message))) {
-			$newHash = $this->hash($message);
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Verify V1 hashes
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
-	 * @return bool Whether $hash is a valid hash of $message
-	 */
-	protected function verifyHashV1($message, $hash, &$newHash = null) {
-		if(password_verify($message, $hash)) {
-			if(password_needs_rehash($hash, PASSWORD_DEFAULT, $this->options)) {
-				$newHash = $this->hash($message);
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
-	 * @return bool Whether $hash is a valid hash of $message
-	 */
-	public function verify($message, $hash, &$newHash = null) {
-		$splittedHash = $this->splitHash($hash);
-
-		if(isset($splittedHash['version'])) {
-			switch ($splittedHash['version']) {
-				case 1:
-					return $this->verifyHashV1($message, $splittedHash['hash'], $newHash);
-			}
-		} else {
-			return $this->legacyHashVerify($message, $hash, $newHash);
-		}
-
-
-		return false;
-	}
+    /** @var IConfig */
+    private $config;
+    /** @var array Options passed to password_hash and password_needs_rehash */
+    private $options = array();
+    /** @var string Salt used for legacy passwords */
+    private $legacySalt = null;
+    /** @var int Current version of the generated hash */
+    private $currentVersion = 1;
+
+    /**
+     * @param IConfig $config
+     */
+    function __construct(IConfig $config) {
+        $this->config = $config;
+
+        $hashingCost = $this->config->getSystemValue('hashingCost', null);
+        if(!is_null($hashingCost)) {
+            $this->options['cost'] = $hashingCost;
+        }
+    }
+
+    /**
+     * Hashes a message using PHP's `password_hash` functionality.
+     * Please note that the size of the returned string is not guaranteed
+     * and can be up to 255 characters.
+     *
+     * @param string $message Message to generate hash from
+     * @return string Hash of the message with appended version parameter
+     */
+    public function hash($message) {
+        return $this->currentVersion . '|' . password_hash($message, PASSWORD_DEFAULT, $this->options);
+    }
+
+    /**
+     * Get the version and hash from a prefixedHash
+     * @param string $prefixedHash
+     * @return null|array Null if the hash is not prefixed, otherwise array('version' => 1, 'hash' => 'foo')
+     */
+    protected function splitHash($prefixedHash) {
+        $explodedString = explode('|', $prefixedHash, 2);
+        if(sizeof($explodedString) === 2) {
+            if((int)$explodedString[0] > 0) {
+                return array('version' => (int)$explodedString[0], 'hash' => $explodedString[1]);
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Verify legacy hashes
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash
+     * @return bool Whether $hash is a valid hash of $message
+     */
+    protected function legacyHashVerify($message, $hash, &$newHash = null) {
+        if(empty($this->legacySalt)) {
+            $this->legacySalt = $this->config->getSystemValue('passwordsalt', '');
+        }
+
+        // Verify whether it matches a legacy PHPass or SHA1 string
+        $hashLength = strlen($hash);
+        if($hashLength === 60 && password_verify($message.$this->legacySalt, $hash) ||
+            $hashLength === 40 && hash_equals($hash, sha1($message))) {
+            $newHash = $this->hash($message);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Verify V1 hashes
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
+     * @return bool Whether $hash is a valid hash of $message
+     */
+    protected function verifyHashV1($message, $hash, &$newHash = null) {
+        if(password_verify($message, $hash)) {
+            if(password_needs_rehash($hash, PASSWORD_DEFAULT, $this->options)) {
+                $newHash = $this->hash($message);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
+     * @return bool Whether $hash is a valid hash of $message
+     */
+    public function verify($message, $hash, &$newHash = null) {
+        $splittedHash = $this->splitHash($hash);
+
+        if(isset($splittedHash['version'])) {
+            switch ($splittedHash['version']) {
+                case 1:
+                    return $this->verifyHashV1($message, $splittedHash['hash'], $newHash);
+            }
+        } else {
+            return $this->legacyHashVerify($message, $hash, $newHash);
+        }
+
+
+        return false;
+    }
 
 }