1 files changed, 150 insertions, 0 deletions
diff --git a/apps/files/lib/Activity/FavoriteProvider.php b/apps/files/lib/Activity/FavoriteProvider.php
new file mode 100644
index 00000000000..e56b13b902a
--- /dev/null
+++ b/apps/files/lib/Activity/FavoriteProvider.php
@@ -0,0 +1,150 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Files\Activity;
+
+use OCP\Activity\Exceptions\UnknownActivityException;
+use OCP\Activity\IEvent;
+use OCP\Activity\IEventMerger;
+use OCP\Activity\IManager;
+use OCP\Activity\IProvider;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\L10N\IFactory;
+
+class FavoriteProvider implements IProvider {
+	public const SUBJECT_ADDED = 'added_favorite';
+	public const SUBJECT_REMOVED = 'removed_favorite';
+
+	/** @var IL10N */
+	protected $l;
+
+	/**
+	 * @param IFactory $languageFactory
+	 * @param IURLGenerator $url
+	 * @param IManager $activityManager
+	 * @param IEventMerger $eventMerger
+	 */
+	public function __construct(
+		protected IFactory $languageFactory,
+		protected IURLGenerator $url,
+		protected IManager $activityManager,
+		protected IEventMerger $eventMerger,
+	) {
+	}
+
+	/**
+	 * @param string $language
+	 * @param IEvent $event
+	 * @param IEvent|null $previousEvent
+	 * @return IEvent
+	 * @throws UnknownActivityException
+	 * @since 11.0.0
+	 */
+	public function parse($language, IEvent $event, ?IEvent $previousEvent = null) {
+		if ($event->getApp() !== 'files' || $event->getType() !== 'favorite') {
+			throw new UnknownActivityException();
+		}
+
+		$this->l = $this->languageFactory->get('files', $language);
+
+		if ($this->activityManager->isFormattingFilteredObject()) {
+			try {
+				return $this->parseShortVersion($event);
+			} catch (UnknownActivityException) {
+				// Ignore and simply use the long version...
+			}
+		}
+
+		return $this->parseLongVersion($event, $previousEvent);
+	}
+
+	/**
+	 * @param IEvent $event
+	 * @return IEvent
+	 * @throws UnknownActivityException
+	 * @since 11.0.0
+	 */
+	public function parseShortVersion(IEvent $event): IEvent {
+		if ($event->getSubject() === self::SUBJECT_ADDED) {
+			$event->setParsedSubject($this->l->t('Added to favorites'));
+			if ($this->activityManager->getRequirePNG()) {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.png')));
+			} else {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.svg')));
+			}
+		} elseif ($event->getSubject() === self::SUBJECT_REMOVED) {
+			$event->setType('unfavorite');
+			$event->setParsedSubject($this->l->t('Removed from favorites'));
+			if ($this->activityManager->getRequirePNG()) {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.png')));
+			} else {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.svg')));
+			}
+		} else {
+			throw new UnknownActivityException();
+		}
+
+		return $event;
+	}
+
+	/**
+	 * @param IEvent $event
+	 * @param IEvent|null $previousEvent
+	 * @return IEvent
+	 * @throws UnknownActivityException
+	 * @since 11.0.0
+	 */
+	public function parseLongVersion(IEvent $event, ?IEvent $previousEvent = null): IEvent {
+		if ($event->getSubject() === self::SUBJECT_ADDED) {
+			$subject = $this->l->t('You added {file} to your favorites');
+			if ($this->activityManager->getRequirePNG()) {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.png')));
+			} else {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.svg')));
+			}
+		} elseif ($event->getSubject() === self::SUBJECT_REMOVED) {
+			$event->setType('unfavorite');
+			$subject = $this->l->t('You removed {file} from your favorites');
+			if ($this->activityManager->getRequirePNG()) {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.png')));
+			} else {
+				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.svg')));
+			}
+		} else {
+			throw new UnknownActivityException();
+		}
+
+		$this->setSubjects($event, $subject);
+		$event = $this->eventMerger->mergeEvents('file', $event, $previousEvent);
+		return $event;
+	}
+
+	/**
+	 * @param IEvent $event
+	 * @param string $subject
+	 */
+	protected function setSubjects(IEvent $event, $subject) {
+		$subjectParams = $event->getSubjectParameters();
+		if (empty($subjectParams)) {
+			// Try to fall back to the old way, but this does not work for emails.
+			// But at least old activities still work.
+			$subjectParams = [
+				'id' => $event->getObjectId(),
+				'path' => $event->getObjectName(),
+			];
+		}
+		$parameter = [
+			'type' => 'file',
+			'id' => (string)$subjectParams['id'],
+			'name' => basename($subjectParams['path']),
+			'path' => trim($subjectParams['path'], '/'),
+			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $subjectParams['id']]),
+		];
+
+		$event->setRichSubject($subject, ['file' => $parameter]);
+	}
+}