Merge pull request #3055 from wallabag/api-bulk-add-tags

Added API endpoint to handle a list of URL and to add/delete tags

src/Wallabag/ApiBundle/Controller/EntryRestController.php

@@ -438,4 +438,107 @@ class EntryRestController extends WallabagRestController
 
         return (new JsonResponse())->setJson($json);
     }
+
+    /**
+     * Handles an entries list delete tags from them.
+     *
+     * @ApiDoc(
+     *       parameters={
+     *          {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
+     *       }
+     * )
+     *
+     * @return JsonResponse
+     */
+    public function deleteEntriesTagsListAction(Request $request)
+    {
+        $this->validateAuthentication();
+
+        $list = json_decode($request->query->get('list', []));
+        $results = [];
+
+        // handle multiple urls
+        if (!empty($list)) {
+            foreach ($list as $key => $element) {
+                $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+                    $element->url,
+                    $this->getUser()->getId()
+                );
+
+                $results[$key]['url'] = $element->url;
+                $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
+
+                $tags = $element->tags;
+
+                if (false !== $entry && !(empty($tags))) {
+                    $tags = explode(',', $tags);
+                    foreach ($tags as $label) {
+                        $label = trim($label);
+
+                        $tag = $this->getDoctrine()
+                            ->getRepository('WallabagCoreBundle:Tag')
+                            ->findOneByLabel($label);
+
+                        if (false !== $tag) {
+                            $entry->removeTag($tag);
+                        }
+                    }
+
+                    $em = $this->getDoctrine()->getManager();
+                    $em->persist($entry);
+                    $em->flush();
+                }
+            }
+        }
+
+        $json = $this->get('serializer')->serialize($results, 'json');
+
+        return (new JsonResponse())->setJson($json);
+    }
+
+    /**
+     * Handles an entries list and add tags to them.
+     *
+     * @ApiDoc(
+     *       parameters={
+     *          {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
+     *       }
+     * )
+     *
+     * @return JsonResponse
+     */
+    public function postEntriesTagsListAction(Request $request)
+    {
+        $this->validateAuthentication();
+
+        $list = json_decode($request->query->get('list', []));
+        $results = [];
+
+        // handle multiple urls
+        if (!empty($list)) {
+            foreach ($list as $key => $element) {
+                $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+                    $element->url,
+                    $this->getUser()->getId()
+                );
+
+                $results[$key]['url'] = $element->url;
+                $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
+
+                $tags = $element->tags;
+
+                if (false !== $entry && !(empty($tags))) {
+                    $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
+
+                    $em = $this->getDoctrine()->getManager();
+                    $em->persist($entry);
+                    $em->flush();
+                }
+            }
+        }
+
+        $json = $this->get('serializer')->serialize($results, 'json');
+
+        return (new JsonResponse())->setJson($json);
+    }
 }

src/Wallabag/ApiBundle/Controller/TagRestController.php

@@ -31,7 +31,7 @@ class TagRestController extends WallabagRestController
     }
 
     /**
-     * Permanently remove one tag from **every** entry.
+     * Permanently remove one tag from **every** entry by passing the Tag label.
      *
      * @ApiDoc(
      *      requirements={
@@ -106,7 +106,7 @@ class TagRestController extends WallabagRestController
     }
 
     /**
-     * Permanently remove one tag from **every** entry.
+     * Permanently remove one tag from **every** entry by passing the Tag ID.
      *
      * @ApiDoc(
      *      requirements={

tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php

@@ -298,7 +298,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
         $entry = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagCoreBundle:Entry')
-            ->findOneByUser(1);
+            ->findOneByUser(1, ['id' => 'asc']);
 
         if (!$entry) {
             $this->markTestSkipped('No content found in db.');
@@ -714,4 +714,72 @@ class EntryRestControllerTest extends WallabagApiTestCase
 
         $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
     }
+
+    public function testPostEntriesTagsListAction()
+    {
+        $entry = $this->client->getContainer()->get('doctrine.orm.entity_manager')
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->findByUrlAndUserId('http://0.0.0.0/entry4', 1);
+
+        $tags = $entry->getTags();
+
+        $this->assertCount(2, $tags);
+
+        $list = [
+            [
+                'url' => 'http://0.0.0.0/entry4',
+                'tags' => 'new tag 1, new tag 2',
+            ],
+        ];
+
+        $this->client->request('POST', '/api/entries/tags/lists?list='.json_encode($list));
+
+        $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
+
+        $content = json_decode($this->client->getResponse()->getContent(), true);
+
+        $this->assertInternalType('int', $content[0]['entry']);
+        $this->assertEquals('http://0.0.0.0/entry4', $content[0]['url']);
+
+        $entry = $this->client->getContainer()->get('doctrine.orm.entity_manager')
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->findByUrlAndUserId('http://0.0.0.0/entry4', 1);
+
+        $tags = $entry->getTags();
+        $this->assertCount(4, $tags);
+    }
+
+    public function testDeleteEntriesTagsListAction()
+    {
+        $entry = $this->client->getContainer()->get('doctrine.orm.entity_manager')
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->findByUrlAndUserId('http://0.0.0.0/entry4', 1);
+
+        $tags = $entry->getTags();
+
+        $this->assertCount(4, $tags);
+
+        $list = [
+            [
+                'url' => 'http://0.0.0.0/entry4',
+                'tags' => 'new tag 1, new tag 2',
+            ],
+        ];
+
+        $this->client->request('DELETE', '/api/entries/tags/list?list='.json_encode($list));
+
+        $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
+
+        $content = json_decode($this->client->getResponse()->getContent(), true);
+
+        $this->assertInternalType('int', $content[0]['entry']);
+        $this->assertEquals('http://0.0.0.0/entry4', $content[0]['url']);
+
+        $entry = $this->client->getContainer()->get('doctrine.orm.entity_manager')
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->findByUrlAndUserId('http://0.0.0.0/entry4', 1);
+
+        $tags = $entry->getTags();
+        $this->assertCount(2, $tags);
+    }
 }