OCA\Activity\GroupHelper

Complexity

Total Complexity

24

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

98.95%

Importance

Changes	3
Bugs	1	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setUser()	0	3	1
A	setL10n()	0	3	1
A	__construct()	0	6	1
C	addActivity()	0	62	9
A	closeOpenGroup()	0	9	2
A	getGroupKey()	0	15	3
A	getGroupParameter()	0	8	2
A	getEventFromArray()	0	14	1
B	getActivities()	0	26	4

<?php
/**
 * @author Joas Schilling <nickvergessen@owncloud.com>
 *
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Activity;

use OCA\Activity\Parameter\Collection;
use OCA\Activity\Parameter\IParameter;
use OCP\Activity\IEvent;
use OCP\Activity\IManager;
use OCP\IL10N;

class GroupHelper {
	/** @var array */
	protected $activities = array();

	/** @var array */
	protected $openGroup = array();

	/** @var string */
	protected $groupKey = '';

	/** @var int */
	protected $groupTime = 0;

	/** @var bool */
	protected $allowGrouping;

	/** @var \OCP\Activity\IManager */
	protected $activityManager;

	/** @var \OCA\Activity\DataHelper */
	protected $dataHelper;

	/**
	 * @param \OCP\Activity\IManager $activityManager
	 * @param \OCA\Activity\DataHelper $dataHelper
	 * @param bool $allowGrouping
	 */
	public function __construct(IManager $activityManager, DataHelper $dataHelper, $allowGrouping) {
		$this->allowGrouping = $allowGrouping;

		$this->activityManager = $activityManager;
		$this->dataHelper = $dataHelper;
	}

	/**
	 * @param string $user
	 */
	public function setUser($user) {
		$this->dataHelper->setUser($user);
	}

	/**
	 * @param IL10N $l
	 */
	public function setL10n(IL10N $l) {
		$this->dataHelper->setL10n($l);
	}

	/**
	 * Add an activity to the internal array
	 *
	 * @param array $activity
	 */
	public function addActivity($activity) {
		$activity['activity_id'] = (int) $activity['activity_id'];
		$activity['timestamp'] = (int) $activity['timestamp'];
		$activity['object_id'] = (int) $activity['object_id'];
		$activity['object_name'] = (string) $activity['file'];
		unset($activity['priority']);
		unset($activity['file']);

		$event = $this->getEventFromArray(array_merge($activity, [
			'subjectparams' => [],
			'messageparams' => [],
		]));

		$activity['subjectparams_array'] = $this->dataHelper->getParameters($event, 'subject', $activity['subjectparams']);
		$activity['messageparams_array'] = $this->dataHelper->getParameters($event, 'message', $activity['messageparams']);

		$groupKey = $this->getGroupKey($activity);
		if ($groupKey === false) {
			$this->closeOpenGroup();
			$this->activities[] = $activity;
			return;
		}

		// Only group when the event has the same group key
		// and the time difference is not bigger than 3 days.
		if ($groupKey === $this->groupKey &&
			abs($activity['timestamp'] - $this->groupTime) < (3 * 24 * 60 * 60)
			&& (!isset($this->openGroup['activity_ids']) || sizeof($this->openGroup['activity_ids']) <= 5)
		) {
			$parameter = $this->getGroupParameter($activity);
			if ($parameter !== false) {
				/** @var IParameter $parameterInstance */
				$parameterInstance = $this->openGroup['subjectparams_array'][$parameter];

				if (!($parameterInstance instanceof Collection)) {
					$collection = $this->dataHelper->createCollection();
					$collection->addParameter($parameterInstance);
					$parameterInstance = $collection;
				}

				/** @var Collection $parameterInstance */
				$parameterInstance->addParameter($activity['subjectparams_array'][$parameter]);
				$this->openGroup['subjectparams_array'][$parameter] = $parameterInstance;

				if (!isset($this->openGroup['activity_ids'])) {
					$this->openGroup['activity_ids'] = [(int) $this->openGroup['activity_id']];
					$this->openGroup['files'] = [
						$this->openGroup['object_id'] => $this->openGroup['object_name']
					];
				}
				$this->openGroup['activity_ids'][] = (int) $activity['activity_id'];

				$this->openGroup['files'][$activity['object_id']] = $activity['object_name'];
			}
		} else {
			$this->closeOpenGroup();

			$this->groupKey = $groupKey;
			$this->groupTime = $activity['timestamp'];
			$this->openGroup = $activity;
		}
	}

	/**
	 * Closes the currently open group and adds it to the list of activities
	 */
	protected function closeOpenGroup() {
		if (!empty($this->openGroup)) {
			$this->activities[] = $this->openGroup;
		}

		$this->openGroup = [];
		$this->groupKey = '';
		$this->groupTime = 0;
	}

	/**
	 * Get grouping key for an activity
	 *
	 * @param array $activity
	 * @return false|string False, if grouping is not allowed, grouping key otherwise
	 */
	protected function getGroupKey($activity) {
		if ($this->getGroupParameter($activity) === false) {
			return false;
		}

		// FIXME
		// Non-local users are currently not distinguishable, so grouping them might
		// remove the information how many different users performed the same action.
		// So we do not group them anymore, until we found another solution.
		if ($activity['user'] === '') {
			return false;
		}

		return $activity['app'] . '|' . $activity['user'] . '|' . $activity['subject'] . '|' . $activity['object_type'];
	}

	/**
	 * Get the parameter which is the varying part
	 *
	 * @param array $activity
	 * @return bool|int False if the activity should not be grouped, parameter position otherwise
	 */
	protected function getGroupParameter($activity) {
		if (!$this->allowGrouping) {
			return false;
		}

		// Allow other apps to group their notifications
		return $this->activityManager->getGroupParameter($activity);
	}

	/**
	 * Get the prepared activities
	 *
	 * @return array translated activities ready for use
	 */
	public function getActivities() {
		$this->closeOpenGroup();

		$return = array();
		foreach ($this->activities as $activity) {
			$this->activityManager->setFormattingObject($activity['object_type'], $activity['object_id']);
			$activity = $this->dataHelper->formatStrings($activity, 'subject');
			$activity = $this->dataHelper->formatStrings($activity, 'message');

			foreach ($activity['subjectparams'] as $i => $param) {

The expression $activity['subjectparams'] of type string is not traversable.

				/** @var IParameter $param */
				$activity['subjectparams'][$i] = $param->getParameterInfo();
			}
			foreach ($activity['messageparams'] as $i => $param) {

The expression $activity['messageparams'] of type string is not traversable.

				/** @var IParameter $param */
				$activity['messageparams'][$i] = $param->getParameterInfo();
			}

			$activity['typeicon'] = $this->activityManager->getTypeIcon($activity['type']);
			$return[] = $activity;
		}
		$this->activityManager->setFormattingObject('', 0);
		$this->activities = [];

		return $return;
	}

	/**
	 * @param array $activity
	 * @return IEvent
	 */
	public function getEventFromArray(array $activity) {
		$event = $this->activityManager->generateEvent();
		$event->setApp($activity['app'])
			->setType($activity['type'])
			->setAffectedUser($activity['affecteduser'])
			->setAuthor($activity['user'])
			->setTimestamp($activity['timestamp'])
			->setSubject($activity['subject'], $activity['subjectparams'])
			->setMessage($activity['message'], $activity['messageparams'])
			->setObject($activity['object_type'], $activity['object_id'], $activity['object_name'])
			->setLink($activity['link']);

		return $event;
	}
}