summaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/lib/Activity/Providers/Base.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_sharing/lib/Activity/Providers/Base.php')
-rw-r--r--apps/files_sharing/lib/Activity/Providers/Base.php184
1 files changed, 184 insertions, 0 deletions
diff --git a/apps/files_sharing/lib/Activity/Providers/Base.php b/apps/files_sharing/lib/Activity/Providers/Base.php
new file mode 100644
index 00000000000..3b73c23786e
--- /dev/null
+++ b/apps/files_sharing/lib/Activity/Providers/Base.php
@@ -0,0 +1,184 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
+ *
+ * @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\Files_Sharing\Activity\Providers;
+
+use OCP\Activity\IEvent;
+use OCP\Activity\IManager;
+use OCP\Activity\IProvider;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\L10N\IFactory;
+
+abstract class Base implements IProvider {
+
+ /** @var IFactory */
+ protected $languageFactory;
+
+ /** @var IL10N */
+ protected $l;
+
+ /** @var IURLGenerator */
+ protected $url;
+
+ /** @var IManager */
+ protected $activityManager;
+
+ /** @var IUserManager */
+ protected $userManager;
+
+ /** @var array */
+ protected $displayNames = [];
+
+ /**
+ * @param IFactory $languageFactory
+ * @param IURLGenerator $url
+ * @param IManager $activityManager
+ * @param IUserManager $userManager
+ */
+ public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager) {
+ $this->languageFactory = $languageFactory;
+ $this->url = $url;
+ $this->activityManager = $activityManager;
+ $this->userManager = $userManager;
+ }
+
+ /**
+ * @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() !== 'files_sharing') {
+ throw new \InvalidArgumentException();
+ }
+
+ $this->l = $this->languageFactory->get('files_sharing', $language);
+
+ if ($this->activityManager->isFormattingFilteredObject()) {
+ try {
+ return $this->parseShortVersion($event);
+ } catch (\InvalidArgumentException $e) {
+ // Ignore and simply use the long version...
+ }
+ }
+
+ return $this->parseLongVersion($event);
+ }
+
+ /**
+ * @param IEvent $event
+ * @return IEvent
+ * @throws \InvalidArgumentException
+ * @since 11.0.0
+ */
+ abstract protected function parseShortVersion(IEvent $event);
+
+ /**
+ * @param IEvent $event
+ * @return IEvent
+ * @throws \InvalidArgumentException
+ * @since 11.0.0
+ */
+ abstract protected function parseLongVersion(IEvent $event);
+
+ /**
+ * @param IEvent $event
+ * @param string $subject
+ * @param array $parameters
+ * @throws \InvalidArgumentException
+ */
+ protected function setSubjects(IEvent $event, $subject, array $parameters) {
+ $placeholders = $replacements = [];
+ foreach ($parameters as $placeholder => $parameter) {
+ $placeholders[] = '{' . $placeholder . '}';
+ if ($parameter['type'] === 'file') {
+ $replacements[] = $parameter['path'];
+ } else {
+ $replacements[] = $parameter['name'];
+ }
+ }
+
+ $event->setParsedSubject(str_replace($placeholders, $replacements, $subject))
+ ->setRichSubject($subject, $parameters);
+ }
+
+ /**
+ * @param array|string $parameter
+ * @param IEvent|null $event
+ * @return array
+ * @throws \InvalidArgumentException
+ */
+ protected function getFile($parameter, IEvent $event = null) {
+ if (is_array($parameter)) {
+ $path = reset($parameter);
+ $id = (string) key($parameter);
+ } else if ($event !== null) {
+ // Legacy from before ownCloud 8.2
+ $path = $parameter;
+ $id = $event->getObjectId();
+ } else {
+ throw new \InvalidArgumentException('Could not generate file parameter');
+ }
+
+ return [
+ 'type' => 'file',
+ 'id' => $id,
+ 'name' => basename($path),
+ 'path' => trim($path, '/'),
+ 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+ ];
+ }
+
+ /**
+ * @param string $uid
+ * @return array
+ */
+ protected function getUser($uid) {
+ if (!isset($this->displayNames[$uid])) {
+ $this->displayNames[$uid] = $this->getDisplayName($uid);
+ }
+
+ return [
+ 'type' => 'user',
+ 'id' => $uid,
+ 'name' => $this->displayNames[$uid],
+ ];
+ }
+
+ /**
+ * @param string $uid
+ * @return string
+ */
+ protected function getDisplayName($uid) {
+ $user = $this->userManager->get($uid);
+ if ($user instanceof IUser) {
+ return $user->getDisplayName();
+ } else {
+ return $uid;
+ }
+ }
+}