src/Wallabag/ApiBundle/Controller/EntryRestController.php

   1 <?php
   2
   3 namespace Wallabag\ApiBundle\Controller;
   4
   5 use Hateoas\Configuration\Route;
   6 use Hateoas\Representation\Factory\PagerfantaFactory;
   7 use JMS\Serializer\SerializationContext;
   8 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
   9 use Symfony\Component\HttpFoundation\JsonResponse;
  10 use Symfony\Component\HttpFoundation\Request;
  11 use Symfony\Component\HttpFoundation\Response;
  12 use Symfony\Component\HttpKernel\Exception\HttpException;
  13 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  14 use Wallabag\CoreBundle\Entity\Entry;
  15 use Wallabag\CoreBundle\Entity\Tag;
  16 use Wallabag\CoreBundle\Event\EntryDeletedEvent;
  17 use Wallabag\CoreBundle\Event\EntrySavedEvent;
  18
  19 class EntryRestController extends WallabagRestController
  20 {
  21     /**
  22      * Check if an entry exist by url.
  23      * Return ID if entry(ies) exist (and if you give the return_id parameter).
  24      * Otherwise it returns false.
  25      *
  26      * @todo Remove that `return_id` in the next major release
  27      *
  28      * @ApiDoc(
  29      *       parameters={
  30      *          {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"},
  31      *          {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
  32      *          {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"}
  33      *       }
  34      * )
  35      *
  36      * @return JsonResponse
  37      */
  38     public function getEntriesExistsAction(Request $request)
  39     {
  40         $this->validateAuthentication();
  41
  42         $returnId = (null === $request->query->get('return_id')) ? false : (bool) $request->query->get('return_id');
  43         $urls = $request->query->get('urls', []);
  44
  45         // handle multiple urls first
  46         if (!empty($urls)) {
  47             $results = [];
  48             foreach ($urls as $url) {
  49                 $res = $this->getDoctrine()
  50                     ->getRepository('WallabagCoreBundle:Entry')
  51                     ->findByUrlAndUserId($url, $this->getUser()->getId());
  52
  53                 $results[$url] = $this->returnExistInformation($res, $returnId);
  54             }
  55
  56             return $this->sendResponse($results);
  57         }
  58
  59         // let's see if it is a simple url?
  60         $url = $request->query->get('url', '');
  61
  62         if (empty($url)) {
  63             throw $this->createAccessDeniedException('URL is empty?, logged user id: ' . $this->getUser()->getId());
  64         }
  65
  66         $res = $this->getDoctrine()
  67             ->getRepository('WallabagCoreBundle:Entry')
  68             ->findByUrlAndUserId($url, $this->getUser()->getId());
  69
  70         $exists = $this->returnExistInformation($res, $returnId);
  71
  72         return $this->sendResponse(['exists' => $exists]);
  73     }
  74
  75     /**
  76      * Retrieve all entries. It could be filtered by many options.
  77      *
  78      * @ApiDoc(
  79      *       parameters={
  80      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
  81      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
  82      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  83      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  84      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  85      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  86      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  87      *          {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
  88      *          {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
  89      *       }
  90      * )
  91      *
  92      * @return JsonResponse
  93      */
  94     public function getEntriesAction(Request $request)
  95     {
  96         $this->validateAuthentication();
  97
  98         $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
  99         $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
 100         $isPublic = (null === $request->query->get('public')) ? null : (bool) $request->query->get('public');
 101         $sort = $request->query->get('sort', 'created');
 102         $order = $request->query->get('order', 'desc');
 103         $page = (int) $request->query->get('page', 1);
 104         $perPage = (int) $request->query->get('perPage', 30);
 105         $tags = \is_array($request->query->get('tags')) ? '' : (string) $request->query->get('tags', '');
 106         $since = $request->query->get('since', 0);
 107
 108         /** @var \Pagerfanta\Pagerfanta $pager */
 109         $pager = $this->get('wallabag_core.entry_repository')->findEntries(
 110             $this->getUser()->getId(),
 111             $isArchived,
 112             $isStarred,
 113             $isPublic,
 114             $sort,
 115             $order,
 116             $since,
 117             $tags
 118         );
 119
 120         $pager->setMaxPerPage($perPage);
 121         $pager->setCurrentPage($page);
 122
 123         $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
 124         $paginatedCollection = $pagerfantaFactory->createRepresentation(
 125             $pager,
 126             new Route(
 127                 'api_get_entries',
 128                 [
 129                     'archive' => $isArchived,
 130                     'starred' => $isStarred,
 131                     'public' => $isPublic,
 132                     'sort' => $sort,
 133                     'order' => $order,
 134                     'page' => $page,
 135                     'perPage' => $perPage,
 136                     'tags' => $tags,
 137                     'since' => $since,
 138                 ],
 139                 UrlGeneratorInterface::ABSOLUTE_URL
 140             )
 141         );
 142
 143         return $this->sendResponse($paginatedCollection);
 144     }
 145
 146     /**
 147      * Retrieve a single entry.
 148      *
 149      * @ApiDoc(
 150      *      requirements={
 151      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 152      *      }
 153      * )
 154      *
 155      * @return JsonResponse
 156      */
 157     public function getEntryAction(Entry $entry)
 158     {
 159         $this->validateAuthentication();
 160         $this->validateUserAccess($entry->getUser()->getId());
 161
 162         return $this->sendResponse($entry);
 163     }
 164
 165     /**
 166      * Retrieve a single entry as a predefined format.
 167      *
 168      * @ApiDoc(
 169      *      requirements={
 170      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 171      *      }
 172      * )
 173      *
 174      * @return Response
 175      */
 176     public function getEntryExportAction(Entry $entry, Request $request)
 177     {
 178         $this->validateAuthentication();
 179         $this->validateUserAccess($entry->getUser()->getId());
 180
 181         return $this->get('wallabag_core.helper.entries_export')
 182             ->setEntries($entry)
 183             ->updateTitle('entry')
 184             ->updateAuthor('entry')
 185             ->exportAs($request->attributes->get('_format'));
 186     }
 187
 188     /**
 189      * Handles an entries list and delete URL.
 190      *
 191      * @ApiDoc(
 192      *       parameters={
 193      *          {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
 194      *       }
 195      * )
 196      *
 197      * @return JsonResponse
 198      */
 199     public function deleteEntriesListAction(Request $request)
 200     {
 201         $this->validateAuthentication();
 202
 203         $urls = json_decode($request->query->get('urls', []));
 204
 205         if (empty($urls)) {
 206             return $this->sendResponse([]);
 207         }
 208
 209         $results = [];
 210
 211         // handle multiple urls
 212         foreach ($urls as $key => $url) {
 213             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 214                 $url,
 215                 $this->getUser()->getId()
 216             );
 217
 218             $results[$key]['url'] = $url;
 219
 220             if (false !== $entry) {
 221                 $em = $this->getDoctrine()->getManager();
 222                 $em->remove($entry);
 223                 $em->flush();
 224
 225                 // entry deleted, dispatch event about it!
 226                 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 227             }
 228
 229             $results[$key]['entry'] = $entry instanceof Entry ? true : false;
 230         }
 231
 232         return $this->sendResponse($results);
 233     }
 234
 235     /**
 236      * Handles an entries list and create URL.
 237      *
 238      * @ApiDoc(
 239      *       parameters={
 240      *          {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
 241      *       }
 242      * )
 243      *
 244      * @throws HttpException When limit is reached
 245      *
 246      * @return JsonResponse
 247      */
 248     public function postEntriesListAction(Request $request)
 249     {
 250         $this->validateAuthentication();
 251
 252         $urls = json_decode($request->query->get('urls', []));
 253
 254         $limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
 255
 256         if (\count($urls) > $limit) {
 257             throw new HttpException(400, 'API limit reached');
 258         }
 259
 260         $results = [];
 261         if (empty($urls)) {
 262             return $this->sendResponse($results);
 263         }
 264
 265         // handle multiple urls
 266         foreach ($urls as $key => $url) {
 267             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 268                 $url,
 269                 $this->getUser()->getId()
 270             );
 271
 272             $results[$key]['url'] = $url;
 273
 274             if (false === $entry) {
 275                 $entry = new Entry($this->getUser());
 276
 277                 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
 278             }
 279
 280             $em = $this->getDoctrine()->getManager();
 281             $em->persist($entry);
 282             $em->flush();
 283
 284             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 285
 286             // entry saved, dispatch event about it!
 287             $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 288         }
 289
 290         return $this->sendResponse($results);
 291     }
 292
 293     /**
 294      * Create an entry.
 295      *
 296      * If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
 297      * Otherwise, content will be fetched as normal from the url and values will be overwritten.
 298      *
 299      * @ApiDoc(
 300      *       parameters={
 301      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 302      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 303      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 304      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
 305      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
 306      *          {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
 307      *          {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
 308      *          {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
 309      *          {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
 310      *          {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
 311      *          {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
 312      *          {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
 313      *       }
 314      * )
 315      *
 316      * @return JsonResponse
 317      */
 318     public function postEntriesAction(Request $request)
 319     {
 320         $this->validateAuthentication();
 321
 322         $url = $request->request->get('url');
 323
 324         $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 325             $url,
 326             $this->getUser()->getId()
 327         );
 328
 329         if (false === $entry) {
 330             $entry = new Entry($this->getUser());
 331             $entry->setUrl($url);
 332         }
 333
 334         $data = $this->retrieveValueFromRequest($request);
 335
 336         try {
 337             $this->get('wallabag_core.content_proxy')->updateEntry(
 338                 $entry,
 339                 $entry->getUrl(),
 340                 [
 341                     'title' => !empty($data['title']) ? $data['title'] : $entry->getTitle(),
 342                     'html' => !empty($data['content']) ? $data['content'] : $entry->getContent(),
 343                     'url' => $entry->getUrl(),
 344                     'language' => !empty($data['language']) ? $data['language'] : $entry->getLanguage(),
 345                     'date' => !empty($data['publishedAt']) ? $data['publishedAt'] : $entry->getPublishedAt(),
 346                     // faking the open graph preview picture
 347                     'open_graph' => [
 348                         'og_image' => !empty($data['picture']) ? $data['picture'] : $entry->getPreviewPicture(),
 349                     ],
 350                     'authors' => \is_string($data['authors']) ? explode(',', $data['authors']) : $entry->getPublishedBy(),
 351                 ]
 352             );
 353         } catch (\Exception $e) {
 354             $this->get('logger')->error('Error while saving an entry', [
 355                 'exception' => $e,
 356                 'entry' => $entry,
 357             ]);
 358         }
 359
 360         if (null !== $data['isArchived']) {
 361             $entry->setArchived((bool) $data['isArchived']);
 362         }
 363
 364         if (null !== $data['isStarred']) {
 365             $entry->updateStar((bool) $data['isStarred']);
 366         }
 367
 368         if (!empty($data['tags'])) {
 369             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
 370         }
 371
 372         if (!empty($data['origin_url'])) {
 373             $entry->setOriginUrl($data['origin_url']);
 374         }
 375
 376         if (null !== $data['isPublic']) {
 377             if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
 378                 $entry->generateUid();
 379             } elseif (false === (bool) $data['isPublic']) {
 380                 $entry->cleanUid();
 381             }
 382         }
 383
 384         if (empty($entry->getDomainName())) {
 385             $this->get('wallabag_core.content_proxy')->setEntryDomainName($entry);
 386         }
 387
 388         if (empty($entry->getTitle())) {
 389             $this->get('wallabag_core.content_proxy')->setDefaultEntryTitle($entry);
 390         }
 391
 392         $em = $this->getDoctrine()->getManager();
 393         $em->persist($entry);
 394         $em->flush();
 395
 396         // entry saved, dispatch event about it!
 397         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 398
 399         return $this->sendResponse($entry);
 400     }
 401
 402     /**
 403      * Change several properties of an entry.
 404      *
 405      * @ApiDoc(
 406      *      requirements={
 407      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 408      *      },
 409      *      parameters={
 410      *          {"name"="title", "dataType"="string", "required"=false},
 411      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 412      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
 413      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
 414      *          {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
 415      *          {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
 416      *          {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
 417      *          {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
 418      *          {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
 419      *          {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
 420      *          {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
 421      *      }
 422      * )
 423      *
 424      * @return JsonResponse
 425      */
 426     public function patchEntriesAction(Entry $entry, Request $request)
 427     {
 428         $this->validateAuthentication();
 429         $this->validateUserAccess($entry->getUser()->getId());
 430
 431         $contentProxy = $this->get('wallabag_core.content_proxy');
 432
 433         $data = $this->retrieveValueFromRequest($request);
 434
 435         // this is a special case where user want to manually update the entry content
 436         // the ContentProxy will only cleanup the html
 437         // and also we force to not re-fetch the content in case of error
 438         if (!empty($data['content'])) {
 439             try {
 440                 $contentProxy->updateEntry(
 441                     $entry,
 442                     $entry->getUrl(),
 443                     [
 444                         'html' => $data['content'],
 445                     ],
 446                     true
 447                 );
 448             } catch (\Exception $e) {
 449                 $this->get('logger')->error('Error while saving an entry', [
 450                     'exception' => $e,
 451                     'entry' => $entry,
 452                 ]);
 453             }
 454         }
 455
 456         if (!empty($data['title'])) {
 457             $entry->setTitle($data['title']);
 458         }
 459
 460         if (!empty($data['language'])) {
 461             $contentProxy->updateLanguage($entry, $data['language']);
 462         }
 463
 464         if (!empty($data['authors']) && \is_string($data['authors'])) {
 465             $entry->setPublishedBy(explode(',', $data['authors']));
 466         }
 467
 468         if (!empty($data['picture'])) {
 469             $contentProxy->updatePreviewPicture($entry, $data['picture']);
 470         }
 471
 472         if (!empty($data['publishedAt'])) {
 473             $contentProxy->updatePublishedAt($entry, $data['publishedAt']);
 474         }
 475
 476         if (null !== $data['isArchived']) {
 477             $entry->setArchived((bool) $data['isArchived']);
 478         }
 479
 480         if (null !== $data['isStarred']) {
 481             $entry->updateStar((bool) $data['isStarred']);
 482         }
 483
 484         if (!empty($data['tags'])) {
 485             $entry->removeAllTags();
 486             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
 487         }
 488
 489         if (null !== $data['isPublic']) {
 490             if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
 491                 $entry->generateUid();
 492             } elseif (false === (bool) $data['isPublic']) {
 493                 $entry->cleanUid();
 494             }
 495         }
 496
 497         if (!empty($data['origin_url'])) {
 498             $entry->setOriginUrl($data['origin_url']);
 499         }
 500
 501         if (empty($entry->getDomainName())) {
 502             $this->get('wallabag_core.content_proxy')->setEntryDomainName($entry);
 503         }
 504
 505         if (empty($entry->getTitle())) {
 506             $this->get('wallabag_core.content_proxy')->setDefaultEntryTitle($entry);
 507         }
 508
 509         $em = $this->getDoctrine()->getManager();
 510         $em->persist($entry);
 511         $em->flush();
 512
 513         // entry saved, dispatch event about it!
 514         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 515
 516         return $this->sendResponse($entry);
 517     }
 518
 519     /**
 520      * Reload an entry.
 521      * An empty response with HTTP Status 304 will be send if we weren't able to update the content (because it hasn't changed or we got an error).
 522      *
 523      * @ApiDoc(
 524      *      requirements={
 525      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 526      *      }
 527      * )
 528      *
 529      * @return JsonResponse
 530      */
 531     public function patchEntriesReloadAction(Entry $entry)
 532     {
 533         $this->validateAuthentication();
 534         $this->validateUserAccess($entry->getUser()->getId());
 535
 536         try {
 537             $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
 538         } catch (\Exception $e) {
 539             $this->get('logger')->error('Error while saving an entry', [
 540                 'exception' => $e,
 541                 'entry' => $entry,
 542             ]);
 543
 544             return new JsonResponse([], 304);
 545         }
 546
 547         // if refreshing entry failed, don't save it
 548         if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
 549             return new JsonResponse([], 304);
 550         }
 551
 552         $em = $this->getDoctrine()->getManager();
 553         $em->persist($entry);
 554         $em->flush();
 555
 556         // entry saved, dispatch event about it!
 557         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 558
 559         return $this->sendResponse($entry);
 560     }
 561
 562     /**
 563      * Delete **permanently** an entry.
 564      *
 565      * @ApiDoc(
 566      *      requirements={
 567      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 568      *      }
 569      * )
 570      *
 571      * @return JsonResponse
 572      */
 573     public function deleteEntriesAction(Entry $entry)
 574     {
 575         $this->validateAuthentication();
 576         $this->validateUserAccess($entry->getUser()->getId());
 577
 578         // We copy $entry to keep id in returned object
 579         $e = $entry;
 580
 581         $em = $this->getDoctrine()->getManager();
 582         $em->remove($entry);
 583         $em->flush();
 584
 585         // entry deleted, dispatch event about it!
 586         $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 587
 588         return $this->sendResponse($e);
 589     }
 590
 591     /**
 592      * Retrieve all tags for an entry.
 593      *
 594      * @ApiDoc(
 595      *      requirements={
 596      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 597      *      }
 598      * )
 599      *
 600      * @return JsonResponse
 601      */
 602     public function getEntriesTagsAction(Entry $entry)
 603     {
 604         $this->validateAuthentication();
 605         $this->validateUserAccess($entry->getUser()->getId());
 606
 607         return $this->sendResponse($entry->getTags());
 608     }
 609
 610     /**
 611      * Add one or more tags to an entry.
 612      *
 613      * @ApiDoc(
 614      *      requirements={
 615      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 616      *      },
 617      *      parameters={
 618      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 619      *       }
 620      * )
 621      *
 622      * @return JsonResponse
 623      */
 624     public function postEntriesTagsAction(Request $request, Entry $entry)
 625     {
 626         $this->validateAuthentication();
 627         $this->validateUserAccess($entry->getUser()->getId());
 628
 629         $tags = $request->request->get('tags', '');
 630         if (!empty($tags)) {
 631             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 632         }
 633
 634         $em = $this->getDoctrine()->getManager();
 635         $em->persist($entry);
 636         $em->flush();
 637
 638         return $this->sendResponse($entry);
 639     }
 640
 641     /**
 642      * Permanently remove one tag for an entry.
 643      *
 644      * @ApiDoc(
 645      *      requirements={
 646      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 647      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 648      *      }
 649      * )
 650      *
 651      * @return JsonResponse
 652      */
 653     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 654     {
 655         $this->validateAuthentication();
 656         $this->validateUserAccess($entry->getUser()->getId());
 657
 658         $entry->removeTag($tag);
 659         $em = $this->getDoctrine()->getManager();
 660         $em->persist($entry);
 661         $em->flush();
 662
 663         return $this->sendResponse($entry);
 664     }
 665
 666     /**
 667      * Handles an entries list delete tags from them.
 668      *
 669      * @ApiDoc(
 670      *       parameters={
 671      *          {"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."}
 672      *       }
 673      * )
 674      *
 675      * @return JsonResponse
 676      */
 677     public function deleteEntriesTagsListAction(Request $request)
 678     {
 679         $this->validateAuthentication();
 680
 681         $list = json_decode($request->query->get('list', []));
 682
 683         if (empty($list)) {
 684             return $this->sendResponse([]);
 685         }
 686
 687         // handle multiple urls
 688         $results = [];
 689
 690         foreach ($list as $key => $element) {
 691             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 692                 $element->url,
 693                 $this->getUser()->getId()
 694             );
 695
 696             $results[$key]['url'] = $element->url;
 697             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 698
 699             $tags = $element->tags;
 700
 701             if (false !== $entry && !(empty($tags))) {
 702                 $tags = explode(',', $tags);
 703                 foreach ($tags as $label) {
 704                     $label = trim($label);
 705
 706                     $tag = $this->getDoctrine()
 707                         ->getRepository('WallabagCoreBundle:Tag')
 708                         ->findOneByLabel($label);
 709
 710                     if (false !== $tag) {
 711                         $entry->removeTag($tag);
 712                     }
 713                 }
 714
 715                 $em = $this->getDoctrine()->getManager();
 716                 $em->persist($entry);
 717                 $em->flush();
 718             }
 719         }
 720
 721         return $this->sendResponse($results);
 722     }
 723
 724     /**
 725      * Handles an entries list and add tags to them.
 726      *
 727      * @ApiDoc(
 728      *       parameters={
 729      *          {"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."}
 730      *       }
 731      * )
 732      *
 733      * @return JsonResponse
 734      */
 735     public function postEntriesTagsListAction(Request $request)
 736     {
 737         $this->validateAuthentication();
 738
 739         $list = json_decode($request->query->get('list', []));
 740
 741         if (empty($list)) {
 742             return $this->sendResponse([]);
 743         }
 744
 745         $results = [];
 746
 747         // handle multiple urls
 748         foreach ($list as $key => $element) {
 749             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 750                 $element->url,
 751                 $this->getUser()->getId()
 752             );
 753
 754             $results[$key]['url'] = $element->url;
 755             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 756
 757             $tags = $element->tags;
 758
 759             if (false !== $entry && !(empty($tags))) {
 760                 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 761
 762                 $em = $this->getDoctrine()->getManager();
 763                 $em->persist($entry);
 764                 $em->flush();
 765             }
 766         }
 767
 768         return $this->sendResponse($results);
 769     }
 770
 771     /**
 772      * Shortcut to send data serialized in json.
 773      *
 774      * @param mixed $data
 775      *
 776      * @return JsonResponse
 777      */
 778     private function sendResponse($data)
 779     {
 780         // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
 781         $context = new SerializationContext();
 782         $context->setSerializeNull(true);
 783
 784         $json = $this->get('jms_serializer')->serialize($data, 'json', $context);
 785
 786         return (new JsonResponse())->setJson($json);
 787     }
 788
 789     /**
 790      * Retrieve value from the request.
 791      * Used for POST & PATCH on a an entry.
 792      *
 793      * @param Request $request
 794      *
 795      * @return array
 796      */
 797     private function retrieveValueFromRequest(Request $request)
 798     {
 799         return [
 800             'title' => $request->request->get('title'),
 801             'tags' => $request->request->get('tags', []),
 802             'isArchived' => $request->request->get('archive'),
 803             'isStarred' => $request->request->get('starred'),
 804             'isPublic' => $request->request->get('public'),
 805             'content' => $request->request->get('content'),
 806             'language' => $request->request->get('language'),
 807             'picture' => $request->request->get('preview_picture'),
 808             'publishedAt' => $request->request->get('published_at'),
 809             'authors' => $request->request->get('authors', ''),
 810             'origin_url' => $request->request->get('origin_url', ''),
 811         ];
 812     }
 813
 814     /**
 815      * Return information about the entry if it exist and depending on the id or not.
 816      *
 817      * @param Entry|null $entry
 818      * @param bool       $returnId
 819      *
 820      * @return bool|int
 821      */
 822     private function returnExistInformation($entry, $returnId)
 823     {
 824         if ($returnId) {
 825             return $entry instanceof Entry ? $entry->getId() : null;
 826         }
 827
 828         return $entry instanceof Entry;
 829     }
 830 }