Feature: share articles (back-end part)

AUTHORS.md

@@ -157,4 +157,10 @@
 * [waffshappen](mailto:[email protected])
 * [wizdude](mailto:[email protected])
 * [zero77](mailto:[email protected])
-* [Éloi Rivard](mailto:[email protected])
+* [Éloi Rivard](mailto:[email protected])
+* [Marco Nassabain](mailto:[email protected])
+* [Nicolas Wendling](mailto:[email protected])
+* [Jimmy Huynh](mailto:[email protected])
+* [Aurélien David](mailto:[email protected])
+* [Hamza Elhaddad](mailto:[email protected])
+* [Ilyes Chergui-Malih](mailto:[email protected])

CHANGELOG.md

@@ -25,6 +25,11 @@ The format is almost based on [Keep a Changelog](https://keepachangelog.com/en/1
 - Search: Add folder search (#1215)
 - Improve test coverage (#1263)
 - Allow directly adding a feed without going through the discovery process (#1265)
+- Implemented sharing news items between nextcloud users (#1191)
+- Updated the news items table in DB to include sharer data (#1191)
+- Added route for sharing news items (#1191)
+- Added share data in news items serialization (#1191)
+- Added tests for the news items share feature (#1191)
 
 ### Fixed
 - Do not show deleted feeds in item list (#1214)

appinfo/routes.php

@@ -52,6 +52,7 @@
 ['name' => 'item#read', 'url' => '/items/{itemId}/read', 'verb' => 'POST'],
 ['name' => 'item#read_multiple', 'url' => '/items/read/multiple', 'verb' => 'POST'],
 ['name' => 'item#star', 'url' => '/items/{feedId}/{guidHash}/star', 'verb' => 'POST'],
+['name' => 'item#share', 'url' => '/items/{itemId}/share/{shareRecipientId}', 'verb' => 'POST'],
 
 // export
 ['name' => 'export#opml', 'url' => '/export/opml', 'verb' => 'GET'],

lib/Controller/ItemController.php

@@ -24,6 +24,7 @@
 use \OCA\News\Service\Exceptions\ServiceException;
 use \OCA\News\Service\Exceptions\ServiceNotFoundException;
 use \OCA\News\Service\ItemServiceV2;
+use \OCA\News\Service\ShareService;
 use OCP\IUserSession;
 
 /**
@@ -43,6 +44,10 @@ class ItemController extends Controller
      * @var FeedServiceV2
      */
     private $feedService;
+    /**
+     * @var ShareService
+     */
+    private $shareService;
     /**
      * @var IConfig
      */
@@ -52,12 +57,14 @@ public function __construct(
         IRequest $request,
         FeedServiceV2 $feedService,
         ItemServiceV2 $itemService,
+        ShareService $shareService,
         IConfig $settings,
         ?IUserSession $userSession
     ) {
         parent::__construct($request, $userSession);
         $this->itemService = $itemService;
         $this->feedService = $feedService;
+        $this->shareService = $shareService;
         $this->settings = $settings;
     }
 
@@ -169,7 +176,8 @@ public function index(
                     );
                     break;
             }
-            $return['items'] = $items;
+            // Map sharer display names onto shared items
+            $return['items'] = $this->shareService->mapSharedByDisplayNames($items);
 
             // this gets thrown if there are no items
             // in that case just return an empty array
@@ -229,7 +237,8 @@ public function newItems(int $type, int $id, $lastModified = 0): array
             $return['newestItemId'] = $this->itemService->newest($this->getUserId())->getId();
             $return['feeds'] = $this->feedService->findAllForUser($this->getUserId());
             $return['starred'] = count($this->itemService->starred($this->getUserId()));
-            $return['items'] = $items;
+            // Map sharer display names onto shared items
+            $return['items'] = $this->shareService->mapSharedByDisplayNames($items);
 
             // this gets thrown if there are no items
             // in that case just return an empty array
@@ -318,4 +327,26 @@ public function readMultiple(array $itemIds): void
             }
         }
     }
+
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param int $itemId              Item to share
+     * @param string $shareRecipientId User to share the item with
+     */
+    public function share(int $itemId, string $shareRecipientId)
+    {
+        try {
+            $this->shareService->shareItemWithUser(
+                $this->getUserId(),
+                $itemId,
+                $shareRecipientId
+            );
+        } catch (ServiceNotFoundException $ex) {
+            return $this->error($ex, Http::STATUS_NOT_FOUND);
+        }
+
+        return [];
+    }
 }

lib/Db/Item.php

@@ -67,6 +67,10 @@ class Item extends Entity implements IAPI, \JsonSerializable
     protected $starred = false;
     /** @var string|null */
     protected $categoriesJson;
+    /** @var string|null */
+    protected $sharedBy;
+    /** @var string|null */
+    protected $sharedByDisplayName;
 
     public function __construct()
     {
@@ -90,6 +94,33 @@ public function __construct()
         $this->addType('unread', 'boolean');
         $this->addType('starred', 'boolean');
         $this->addType('categoriesJson', 'string');
+        $this->addType('sharedBy', 'string');
+    }
+
+    public function __clone()
+    {
+        $this->resetUpdatedFields();
+        $this->markFieldUpdated('contentHash');
+        $this->markFieldUpdated('guidHash');
+        $this->markFieldUpdated('guid');
+        $this->markFieldUpdated('url');
+        $this->markFieldUpdated('title');
+        $this->markFieldUpdated('author');
+        $this->markFieldUpdated('pubDate');
+        $this->markFieldUpdated('body');
+        $this->markFieldUpdated('enclosureMime');
+        $this->markFieldUpdated('enclosureLink');
+        $this->markFieldUpdated('mediaThumbnail');
+        $this->markFieldUpdated('mediaDescription');
+        $this->markFieldUpdated('feedId');
+        $this->markFieldUpdated('lastModified');
+        $this->markFieldUpdated('searchIndex');
+        $this->markFieldUpdated('rtl');
+        $this->markFieldUpdated('fingerprint');
+        $this->markFieldUpdated('unread');
+        $this->markFieldUpdated('starred');
+        $this->markFieldUpdated('categoriesJson');
+        $this->markFieldUpdated('sharedBy');
     }
 
     /**
@@ -285,6 +316,16 @@ public function isUnread(): bool
         return $this->unread;
     }
 
+    public function getSharedBy(): ?string
+    {
+        return $this->sharedBy;
+    }
+
+    public function getSharedByDisplayName(): ?string
+    {
+        return $this->sharedByDisplayName;
+    }
+
     /**
      * @return null|string
      */
@@ -327,7 +368,9 @@ public function jsonSerialize(): array
             'rtl' => $this->getRtl(),
             'intro' => $this->getIntro(),
             'fingerprint' => $this->getFingerprint(),
-            'categories' => $this->getCategories()
+            'categories' => $this->getCategories(),
+            'sharedBy' => $this->getSharedBy(),
+            'sharedByDisplayName' => $this->getSharedByDisplayName()
         ];
     }
 
@@ -509,6 +552,25 @@ public function setTitle(string $title = null): self
         return $this;
     }
 
+    public function setSharedBy(string $sharedBy = null): self
+    {
+        if ($this->sharedBy !== $sharedBy) {
+            $this->sharedBy = $sharedBy;
+            $this->markFieldUpdated('sharedBy');
+        }
+
+        return $this;
+    }
+
+    public function setSharedByDisplayName(string $sharedByDisplayName = null): self
+    {
+        if ($this->sharedByDisplayName !== $sharedByDisplayName) {
+            $this->sharedByDisplayName = $sharedByDisplayName;
+        }
+
+        return $this;
+    }
+
     public function setUnread(bool $unread): self
     {
         if ($this->unread !== $unread) {

lib/Migration/Version150400Date20210318215425.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\News\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Auto-generated migration step: Please modify to your needs!
+ */
+class Version150400Date20210318215425 extends SimpleMigrationStep {
+
+    /**
+     * @param IOutput $output
+     * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+     * @param array $options
+     */
+    public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+    }
+
+    /**
+     * @param IOutput $output
+     * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+     * @param array $options
+     * @return null|ISchemaWrapper
+     */
+    public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+        /** @var ISchemaWrapper $schema */
+        $schema = $schemaClosure();
+
+        if ($schema->hasTable('news_items')) {
+            $table = $schema->getTable('news_items');
+            $table->addColumn('shared_by', 'string', [
+                'notnull' => false,
+                'length' => 64
+            ]);
+        }
+
+        return $schema;
+    }
+
+    /**
+     * @param IOutput $output
+     * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+     * @param array $options
+     */
+    public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+    }
+}