]> source.dussan.org Git - nextcloud-server.git/commitdiff
Add an activity when managing favorites
authorJoas Schilling <coding@schilljs.com>
Sun, 4 Dec 2016 11:14:10 +0000 (12:14 +0100)
committerJoas Schilling <coding@schilljs.com>
Sun, 4 Dec 2016 11:16:49 +0000 (12:16 +0100)
Signed-off-by: Joas Schilling <coding@schilljs.com>
apps/files/appinfo/info.xml
apps/files/lib/Activity/FavoriteProvider.php [new file with mode: 0644]
apps/files/lib/Activity/Settings/FavoriteAction.php [new file with mode: 0644]
apps/files/lib/AppInfo/Application.php
apps/files/lib/Service/TagService.php

index 1992b94a03cd75a4cabc54f053e0a36033bda306..35e58b7202ebf6107671e923e77aedc15fb0f742 100644 (file)
@@ -19,6 +19,7 @@
 
        <activity>
                <settings>
+                       <setting>OCA\Files\Activity\Settings\FavoriteAction</setting>
                        <setting>OCA\Files\Activity\Settings\FileChanged</setting>
                        <setting>OCA\Files\Activity\Settings\FileCreated</setting>
                        <setting>OCA\Files\Activity\Settings\FileDeleted</setting>
@@ -32,6 +33,7 @@
                </filters>
 
                <providers>
+                       <provider>OCA\Files\Activity\FavoriteProvider</provider>
                        <provider>OCA\Files\Activity\Provider</provider>
                </providers>
        </activity>
diff --git a/apps/files/lib/Activity/FavoriteProvider.php b/apps/files/lib/Activity/FavoriteProvider.php
new file mode 100644 (file)
index 0000000..8047eb1
--- /dev/null
@@ -0,0 +1,151 @@
+<?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\Activity;
+
+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 {
+
+       const SUBJECT_ADDED = 'added_favorite';
+       const SUBJECT_REMOVED = 'removed_favorite';
+
+       /** @var IFactory */
+       protected $languageFactory;
+
+       /** @var IL10N */
+       protected $l;
+
+       /** @var IURLGenerator */
+       protected $url;
+
+       /** @var IManager */
+       protected $activityManager;
+
+       /** @var IEventMerger */
+       protected $eventMerger;
+
+       /**
+        * @param IFactory $languageFactory
+        * @param IURLGenerator $url
+        * @param IManager $activityManager
+        * @param IEventMerger $eventMerger
+        */
+       public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IEventMerger $eventMerger) {
+               $this->languageFactory = $languageFactory;
+               $this->url = $url;
+               $this->activityManager = $activityManager;
+               $this->eventMerger = $eventMerger;
+       }
+
+       /**
+        * @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' || $event->getType() !== 'favorite') {
+                       throw new \InvalidArgumentException();
+               }
+
+               $this->l = $this->languageFactory->get('files', $language);
+
+               if ($this->activityManager->isFormattingFilteredObject()) {
+                       try {
+                               return $this->parseShortVersion($event);
+                       } catch (\InvalidArgumentException $e) {
+                               // Ignore and simply use the long version...
+                       }
+               }
+
+               return $this->parseLongVersion($event, $previousEvent);
+       }
+
+       /**
+        * @param IEvent $event
+        * @return IEvent
+        * @throws \InvalidArgumentException
+        * @since 11.0.0
+        */
+       public function parseShortVersion(IEvent $event) {
+
+               if ($event->getSubject() === self::SUBJECT_ADDED) {
+                       $event->setParsedSubject($this->l->t('Added to favorites'))
+                               ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.svg')));
+               } else if ($event->getSubject() === self::SUBJECT_REMOVED) {
+                       $event->setParsedSubject($this->l->t('Removed from favorites'))
+                               ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.svg')));
+               } else {
+                       throw new \InvalidArgumentException();
+               }
+
+               return $event;
+       }
+
+       /**
+        * @param IEvent $event
+        * @param IEvent|null $previousEvent
+        * @return IEvent
+        * @throws \InvalidArgumentException
+        * @since 11.0.0
+        */
+       public function parseLongVersion(IEvent $event, IEvent $previousEvent = null) {
+
+               if ($event->getSubject() === self::SUBJECT_ADDED) {
+                       $subject = $this->l->t('You added {file} to your favorites');
+                       $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/starred.svg')));
+               } else if ($event->getSubject() === self::SUBJECT_REMOVED) {
+                       $subject = $this->l->t('You removed {file} from your favorites');
+                       $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star.svg')));
+               } else {
+                       throw new \InvalidArgumentException();
+               }
+
+               $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) {
+               $parameter = [
+                       'type' => 'file',
+                       'id' => $event->getObjectId(),
+                       'name' => basename($event->getObjectName()),
+                       'path' => $event->getObjectName(),
+               ];
+
+               $event->setParsedSubject(str_replace('{file}', trim($parameter['path'], '/'), $subject))
+                       ->setRichSubject($subject, ['file' => $parameter]);
+       }
+}
diff --git a/apps/files/lib/Activity/Settings/FavoriteAction.php b/apps/files/lib/Activity/Settings/FavoriteAction.php
new file mode 100644 (file)
index 0000000..509c088
--- /dev/null
@@ -0,0 +1,98 @@
+<?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\Activity\Settings;
+
+
+use OCP\Activity\ISetting;
+use OCP\IL10N;
+
+class FavoriteAction implements ISetting {
+
+       /** @var IL10N */
+       protected $l;
+
+       /**
+        * @param IL10N $l
+        */
+       public function __construct(IL10N $l) {
+               $this->l = $l;
+       }
+
+       /**
+        * @return string Lowercase a-z and underscore only identifier
+        * @since 11.0.0
+        */
+       public function getIdentifier() {
+               return 'favorite';
+       }
+
+       /**
+        * @return string A translated string
+        * @since 11.0.0
+        */
+       public function getName() {
+               return $this->l->t('A file has been added to or removed from your <strong>favorites</strong>');
+       }
+
+       /**
+        * @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 5;
+       }
+
+       /**
+        * @return bool True when the option can be changed for the stream
+        * @since 11.0.0
+        */
+       public function canChangeStream() {
+               return true;
+       }
+
+       /**
+        * @return bool True when the option can be changed for the stream
+        * @since 11.0.0
+        */
+       public function isDefaultEnabledStream() {
+               return true;
+       }
+
+       /**
+        * @return bool True when the option can be changed for the mail
+        * @since 11.0.0
+        */
+       public function canChangeMail() {
+               return true;
+       }
+
+       /**
+        * @return bool True when the option can be changed for the stream
+        * @since 11.0.0
+        */
+       public function isDefaultEnabledMail() {
+               return false;
+       }
+}
+
index fc91e05ba7e66ebfc5fefc2a41f1c4b6ee67f7fa..4e5ec03eecfeeb943b328a415c8bfa769ced8cf3 100644 (file)
@@ -84,6 +84,7 @@ class Application extends App {
                        $homeFolder = $c->query('ServerContainer')->getUserFolder();
                        return new TagService(
                                $c->query('ServerContainer')->getUserSession(),
+                               $c->query('ServerContainer')->getActivityManager(),
                                $c->query('Tagger'),
                                $homeFolder
                        );
index 4482fb45371be667e9a6352311f9acd70a18b9b5..cf80d780eaf8879ef709f1d4ac695e3a2eb7e402 100644 (file)
 
 namespace OCA\Files\Service;
 
-use OC\Files\FileInfo;
-use OCP\Files\Node;
+use OC\Tags;
+use OCA\Files\Activity\FavoriteProvider;
+use OCP\Activity\IManager;
+use OCP\Files\Folder;
+use OCP\ITags;
+use OCP\IUser;
+use OCP\IUserSession;
 
 /**
  * Service class to manage tags on files.
  */
 class TagService {
 
-       /**
-        * @var \OCP\IUserSession
-        */
+       /** @var IUserSession */
        private $userSession;
-
-       /**
-        * @var \OCP\ITags
-        */
+       /** @var IManager */
+       private $activityManager;
+       /** @var ITags */
        private $tagger;
+       /** @var Folder */
+       private $homeFolder;
 
        /**
-        * @var \OCP\Files\Folder
+        * @param IUserSession $userSession
+        * @param IManager $activityManager
+        * @param ITags $tagger
+        * @param Folder $homeFolder
         */
-       private $homeFolder;
-
        public function __construct(
-               \OCP\IUserSession $userSession,
-               \OCP\ITags $tagger,
-               \OCP\Files\Folder $homeFolder
+               IUserSession $userSession,
+               IManager $activityManager,
+               ITags $tagger,
+               Folder $homeFolder
        ) {
                $this->userSession = $userSession;
+               $this->activityManager = $activityManager;
                $this->tagger = $tagger;
                $this->homeFolder = $homeFolder;
        }
@@ -79,10 +86,16 @@ class TagService {
 
                $newTags = array_diff($tags, $currentTags);
                foreach ($newTags as $tag) {
+                       if ($tag === Tags::TAG_FAVORITE) {
+                               $this->addActivity(true, $fileId, $path);
+                       }
                        $this->tagger->tagAs($fileId, $tag);
                }
                $deletedTags = array_diff($currentTags, $tags);
                foreach ($deletedTags as $tag) {
+                       if ($tag === Tags::TAG_FAVORITE) {
+                               $this->addActivity(false, $fileId, $path);
+                       }
                        $this->tagger->unTag($fileId, $tag);
                }
 
@@ -90,5 +103,27 @@ class TagService {
                // list is up to date, in case of concurrent changes ?
                return $tags;
        }
+
+       /**
+        * @param bool $addToFavorite
+        * @param int $fileId
+        * @param string $path
+        */
+       protected function addActivity($addToFavorite, $fileId, $path) {
+               $user = $this->userSession->getUser();
+               if (!$user instanceof IUser) {
+                       return;
+               }
+
+               $event = $this->activityManager->generateEvent();
+               $event->setApp('files')
+                       ->setObject('files', $fileId, $path)
+                       ->setType('favorite')
+                       ->setAuthor($user->getUID())
+                       ->setAffectedUser($user->getUID())
+                       ->setTimestamp(time())
+                       ->setSubject($addToFavorite ? FavoriteProvider::SUBJECT_ADDED : FavoriteProvider::SUBJECT_REMOVED);
+               $this->activityManager->publish($event);
+       }
 }