Event::generateObjectParameter() - Code Metrics - Inspection of "Merge pull request #19039 from nextcloud/dav-activ..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a1c1b3...a1f329 )

by Roeland

created 2020-04-30 07:11 UTC

Event::generateObjectParameter() B

↳ Parent: Event

Complexity

Conditions	7
Paths	7

Size

Total Lines	30
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	20
nc	7
nop	1
dl	0
loc	30
rs	8.6666
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016 Joas Schilling <[email protected]>
 *
 * @author Christoph Wurst <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Julius Härtl <[email protected]>
 * @author Thomas Citharel <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\DAV\CalDAV\Activity\Provider;

use OC_App;
use OCP\Activity\IEvent;
use OCP\Activity\IEventMerger;
use OCP\Activity\IManager;
use OCP\App\IAppManager;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory;

class Event extends Base {
	public const SUBJECT_OBJECT_ADD = 'object_add';
	public const SUBJECT_OBJECT_UPDATE = 'object_update';
	public const SUBJECT_OBJECT_DELETE = 'object_delete';

	/** @var IFactory */
	protected $languageFactory;

	/** @var IL10N */
	protected $l;

	/** @var IManager */
	protected $activityManager;

	/** @var IEventMerger */
	protected $eventMerger;

	/** @var IAppManager */
	protected $appManager;

	/**
	 * @param IFactory $languageFactory
	 * @param IURLGenerator $url
	 * @param IManager $activityManager
	 * @param IUserManager $userManager
	 * @param IGroupManager $groupManager
	 * @param IEventMerger $eventMerger
	 * @param IAppManager $appManager
	 */
	public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager, IGroupManager $groupManager, IEventMerger $eventMerger, IAppManager $appManager) {
		parent::__construct($userManager, $groupManager, $url);
		$this->languageFactory = $languageFactory;
		$this->activityManager = $activityManager;
		$this->eventMerger = $eventMerger;
		$this->appManager = $appManager;
	}

	/**
	 * @param array $eventData
	 * @return array
	 */
	protected function generateObjectParameter(array $eventData) {
		if (!isset($eventData['id']) || !isset($eventData['name'])) {
			throw new \InvalidArgumentException();
		}

		$params = [
			'type' => 'calendar-event',
			'id' => $eventData['id'],
			'name' => $eventData['name'],

		];
		if (isset($eventData['link']) && is_array($eventData['link']) && $this->appManager->isEnabledForUser('calendar')) {
			try {
				// The calendar app needs to be manually loaded for the routes to be loaded
				OC_App::loadApp('calendar');
				$linkData = $eventData['link'];
				$objectId = base64_encode('/remote.php/dav/calendars/' . $linkData['owner'] . '/' . $linkData['calendar_uri'] . '/' . $linkData['object_uri']);
				$link = [
					'view' => 'dayGridMonth',
					'timeRange' => 'now',
					'mode' => 'sidebar',
					'objectId' => $objectId,
					'recurrenceId' => 'next'
				];
				$params['link'] = $this->url->linkToRouteAbsolute('calendar.view.indexview.timerange.edit', $link);
			} catch (\Exception $error) {
				// Do nothing
			}
		}
		return $params;
	}

	/**
	 * @param string $language
	 * @param IEvent $event
	 * @param IEvent|null $previousEvent
	 * @return IEvent
	 * @throws \InvalidArgumentException
	 * @since 11.0.0
	 */
	public function parse($language, IEvent $event, IEvent $previousEvent = null) {
		if ($event->getApp() !== 'dav' || $event->getType() !== 'calendar_event') {
			throw new \InvalidArgumentException();
		}

		$this->l = $this->languageFactory->get('dav', $language);

		if ($this->activityManager->getRequirePNG()) {
			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.png')));
		} else {
			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar.svg')));
		}

		if ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event') {
			$subject = $this->l->t('{actor} created event {event} in calendar {calendar}');
		} elseif ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event_self') {
			$subject = $this->l->t('You created event {event} in calendar {calendar}');
		} elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event') {
			$subject = $this->l->t('{actor} deleted event {event} from calendar {calendar}');
		} elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event_self') {
			$subject = $this->l->t('You deleted event {event} from calendar {calendar}');
		} elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event') {
			$subject = $this->l->t('{actor} updated event {event} in calendar {calendar}');
		} elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event_self') {
			$subject = $this->l->t('You updated event {event} in calendar {calendar}');
		} else {
			throw new \InvalidArgumentException();
		}

		$parsedParameters = $this->getParameters($event);
		$this->setSubjects($event, $subject, $parsedParameters);

		$event = $this->eventMerger->mergeEvents('event', $event, $previousEvent);

		return $event;
	}

	/**
	 * @param IEvent $event
	 * @return array
	 */
	protected function getParameters(IEvent $event) {
		$subject = $event->getSubject();
		$parameters = $event->getSubjectParameters();

		// Nextcloud 13+
		if (isset($parameters['calendar'])) {
			switch ($subject) {
				case self::SUBJECT_OBJECT_ADD . '_event':
				case self::SUBJECT_OBJECT_DELETE . '_event':
				case self::SUBJECT_OBJECT_UPDATE . '_event':
					return [
						'actor' => $this->generateUserParameter($parameters['actor']),
						'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l),
						'event' => $this->generateClassifiedObjectParameter($parameters['object']),
					];
				case self::SUBJECT_OBJECT_ADD . '_event_self':
				case self::SUBJECT_OBJECT_DELETE . '_event_self':
				case self::SUBJECT_OBJECT_UPDATE . '_event_self':
					return [
						'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l),
						'event' => $this->generateClassifiedObjectParameter($parameters['object']),
					];
			}
		}

		// Legacy - Do NOT Remove unless necessary
		// Removing this will break parsing of activities that were created on
		// Nextcloud 12, so we should keep this as long as it's acceptable.
		// Otherwise if people upgrade over multiple releases in a short period,
		// they will get the dead entries in their stream.
		switch ($subject) {
			case self::SUBJECT_OBJECT_ADD . '_event':
			case self::SUBJECT_OBJECT_DELETE . '_event':
			case self::SUBJECT_OBJECT_UPDATE . '_event':
				return [
					'actor' => $this->generateUserParameter($parameters[0]),
					'calendar' => $this->generateLegacyCalendarParameter((int)$event->getObjectId(), $parameters[1]),
					'event' => $this->generateObjectParameter($parameters[2]),
				];
			case self::SUBJECT_OBJECT_ADD . '_event_self':
			case self::SUBJECT_OBJECT_DELETE . '_event_self':
			case self::SUBJECT_OBJECT_UPDATE . '_event_self':
				return [
					'calendar' => $this->generateLegacyCalendarParameter((int)$event->getObjectId(), $parameters[1]),
					'event' => $this->generateObjectParameter($parameters[2]),
				];
		}

		throw new \InvalidArgumentException();
	}

	private function generateClassifiedObjectParameter(array $eventData) {
		$parameter = $this->generateObjectParameter($eventData);
		if (!empty($eventData['classified'])) {
			$parameter['name'] = $this->l->t('Busy');
		}
		return $parameter;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016 Joas Schilling <[email protected]>
4			*
5			* @author Christoph Wurst <[email protected]>
6			* @author Joas Schilling <[email protected]>
7			* @author Julius Härtl <[email protected]>
8			* @author Thomas Citharel <[email protected]>
9			*
10			* @license GNU AGPL version 3 or any later version
11			*
12			* This program is free software: you can redistribute it and/or modify
13			* it under the terms of the GNU Affero General Public License as
14			* published by the Free Software Foundation, either version 3 of the
15			* License, or (at your option) any later version.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU Affero General Public License for more details.
21			*
22			* You should have received a copy of the GNU Affero General Public License
23			* along with this program. If not, see <http://www.gnu.org/licenses/>.
24			*
25			*/
26
27			namespace OCA\DAV\CalDAV\Activity\Provider;
28
29			use OC_App;
30			use OCP\Activity\IEvent;
31			use OCP\Activity\IEventMerger;
32			use OCP\Activity\IManager;
33			use OCP\App\IAppManager;
34			use OCP\IGroupManager;
35			use OCP\IL10N;
36			use OCP\IURLGenerator;
37			use OCP\IUserManager;
38			use OCP\L10N\IFactory;
39
40			class Event extends Base {
41			public const SUBJECT_OBJECT_ADD = 'object_add';
42			public const SUBJECT_OBJECT_UPDATE = 'object_update';
43			public const SUBJECT_OBJECT_DELETE = 'object_delete';
44
45			/** @var IFactory */
46			protected $languageFactory;
47
48			/** @var IL10N */
49			protected $l;
50
51			/** @var IManager */
52			protected $activityManager;
53
54			/** @var IEventMerger */
55			protected $eventMerger;
56
57			/** @var IAppManager */
58			protected $appManager;
59
60			/**
61			* @param IFactory $languageFactory
62			* @param IURLGenerator $url
63			* @param IManager $activityManager
64			* @param IUserManager $userManager
65			* @param IGroupManager $groupManager
66			* @param IEventMerger $eventMerger
67			* @param IAppManager $appManager
68			*/
69			public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager, IGroupManager $groupManager, IEventMerger $eventMerger, IAppManager $appManager) {
70			parent::__construct($userManager, $groupManager, $url);
71			$this->languageFactory = $languageFactory;
72			$this->activityManager = $activityManager;
73			$this->eventMerger = $eventMerger;
74			$this->appManager = $appManager;
75			}
76
77			/**
78			* @param array $eventData
79			* @return array
80			*/
81			protected function generateObjectParameter(array $eventData) {
82			if (!isset($eventData['id']) \|\| !isset($eventData['name'])) {
83			throw new \InvalidArgumentException();
84			}
85
86			$params = [
87			'type' => 'calendar-event',
88			'id' => $eventData['id'],
89			'name' => $eventData['name'],
90
91			];
92			if (isset($eventData['link']) && is_array($eventData['link']) && $this->appManager->isEnabledForUser('calendar')) {
93			try {
94			// The calendar app needs to be manually loaded for the routes to be loaded
95			OC_App::loadApp('calendar');
96			$linkData = $eventData['link'];
97			$objectId = base64_encode('/remote.php/dav/calendars/' . $linkData['owner'] . '/' . $linkData['calendar_uri'] . '/' . $linkData['object_uri']);
98			$link = [
99			'view' => 'dayGridMonth',
100			'timeRange' => 'now',
101			'mode' => 'sidebar',
102			'objectId' => $objectId,
103			'recurrenceId' => 'next'
104			];
105			$params['link'] = $this->url->linkToRouteAbsolute('calendar.view.indexview.timerange.edit', $link);
106			} catch (\Exception $error) {
107			// Do nothing
108			}
109			}
110			return $params;
111			}
112
113			/**
114			* @param string $language
115			* @param IEvent $event
116			* @param IEvent\|null $previousEvent
117			* @return IEvent
118			* @throws \InvalidArgumentException
119			* @since 11.0.0
120			*/
121			public function parse($language, IEvent $event, IEvent $previousEvent = null) {
122			if ($event->getApp() !== 'dav' \|\| $event->getType() !== 'calendar_event') {
123			throw new \InvalidArgumentException();
124			}
125
126			$this->l = $this->languageFactory->get('dav', $language);
127
128			if ($this->activityManager->getRequirePNG()) {
129			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.png')));
130			} else {
131			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar.svg')));
132			}
133
134			if ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event') {
135			$subject = $this->l->t('{actor} created event {event} in calendar {calendar}');
136			} elseif ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event_self') {
137			$subject = $this->l->t('You created event {event} in calendar {calendar}');
138			} elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event') {
139			$subject = $this->l->t('{actor} deleted event {event} from calendar {calendar}');
140			} elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event_self') {
141			$subject = $this->l->t('You deleted event {event} from calendar {calendar}');
142			} elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event') {
143			$subject = $this->l->t('{actor} updated event {event} in calendar {calendar}');
144			} elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event_self') {
145			$subject = $this->l->t('You updated event {event} in calendar {calendar}');
146			} else {
147			throw new \InvalidArgumentException();
148			}
149
150			$parsedParameters = $this->getParameters($event);
151			$this->setSubjects($event, $subject, $parsedParameters);
152
153			$event = $this->eventMerger->mergeEvents('event', $event, $previousEvent);
154
155			return $event;
156			}
157
158			/**
159			* @param IEvent $event
160			* @return array
161			*/
162			protected function getParameters(IEvent $event) {
163			$subject = $event->getSubject();
164			$parameters = $event->getSubjectParameters();
165
166			// Nextcloud 13+
167			if (isset($parameters['calendar'])) {
168			switch ($subject) {
169			case self::SUBJECT_OBJECT_ADD . '_event':
170			case self::SUBJECT_OBJECT_DELETE . '_event':
171			case self::SUBJECT_OBJECT_UPDATE . '_event':
172			return [
173			'actor' => $this->generateUserParameter($parameters['actor']),
174			'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l),
175			'event' => $this->generateClassifiedObjectParameter($parameters['object']),
176			];
177			case self::SUBJECT_OBJECT_ADD . '_event_self':
178			case self::SUBJECT_OBJECT_DELETE . '_event_self':
179			case self::SUBJECT_OBJECT_UPDATE . '_event_self':
180			return [
181			'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l),
182			'event' => $this->generateClassifiedObjectParameter($parameters['object']),
183			];
184			}
185			}
186
187			// Legacy - Do NOT Remove unless necessary
188			// Removing this will break parsing of activities that were created on
189			// Nextcloud 12, so we should keep this as long as it's acceptable.
190			// Otherwise if people upgrade over multiple releases in a short period,
191			// they will get the dead entries in their stream.
192			switch ($subject) {
193			case self::SUBJECT_OBJECT_ADD . '_event':
194			case self::SUBJECT_OBJECT_DELETE . '_event':
195			case self::SUBJECT_OBJECT_UPDATE . '_event':
196			return [
197			'actor' => $this->generateUserParameter($parameters[0]),
198			'calendar' => $this->generateLegacyCalendarParameter((int)$event->getObjectId(), $parameters[1]),
199			'event' => $this->generateObjectParameter($parameters[2]),
200			];
201			case self::SUBJECT_OBJECT_ADD . '_event_self':
202			case self::SUBJECT_OBJECT_DELETE . '_event_self':
203			case self::SUBJECT_OBJECT_UPDATE . '_event_self':
204			return [
205			'calendar' => $this->generateLegacyCalendarParameter((int)$event->getObjectId(), $parameters[1]),
206			'event' => $this->generateObjectParameter($parameters[2]),
207			];
208			}
209
210			throw new \InvalidArgumentException();
211			}
212
213			private function generateClassifiedObjectParameter(array $eventData) {
214			$parameter = $this->generateObjectParameter($eventData);
215			if (!empty($eventData['classified'])) {
216			$parameter['name'] = $this->l->t('Busy');
217			}
218			return $parameter;
219			}
220			}
221

nextcloud / server

Push — master ( a1c1b3...a1f329 )

Event::generateObjectParameter() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like