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         $em = $this->getDoctrine()->getManager();
 385         $em->persist($entry);
 386         $em->flush();
 387
 388         // entry saved, dispatch event about it!
 389         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 390
 391         return $this->sendResponse($entry);
 392     }
 393
 394     /**
 395      * Change several properties of an entry.
 396      *
 397      * @ApiDoc(
 398      *      requirements={
 399      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 400      *      },
 401      *      parameters={
 402      *          {"name"="title", "dataType"="string", "required"=false},
 403      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 404      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
 405      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
 406      *          {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
 407      *          {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
 408      *          {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
 409      *          {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
 410      *          {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
 411      *          {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
 412      *          {"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)."},
 413      *      }
 414      * )
 415      *
 416      * @return JsonResponse
 417      */
 418     public function patchEntriesAction(Entry $entry, Request $request)
 419     {
 420         $this->validateAuthentication();
 421         $this->validateUserAccess($entry->getUser()->getId());
 422
 423         $contentProxy = $this->get('wallabag_core.content_proxy');
 424
 425         $data = $this->retrieveValueFromRequest($request);
 426
 427         // this is a special case where user want to manually update the entry content
 428         // the ContentProxy will only cleanup the html
 429         // and also we force to not re-fetch the content in case of error
 430         if (!empty($data['content'])) {
 431             try {
 432                 $contentProxy->updateEntry(
 433                     $entry,
 434                     $entry->getUrl(),
 435                     [
 436                         'html' => $data['content'],
 437                     ],
 438                     true
 439                 );
 440             } catch (\Exception $e) {
 441                 $this->get('logger')->error('Error while saving an entry', [
 442                     'exception' => $e,
 443                     'entry' => $entry,
 444                 ]);
 445             }
 446         }
 447
 448         if (!empty($data['title'])) {
 449             $entry->setTitle($data['title']);
 450         }
 451
 452         if (!empty($data['language'])) {
 453             $contentProxy->updateLanguage($entry, $data['language']);
 454         }
 455
 456         if (!empty($data['authors']) && is_string($data['authors'])) {
 457             $entry->setPublishedBy(explode(',', $data['authors']));
 458         }
 459
 460         if (!empty($data['picture'])) {
 461             $contentProxy->updatePreviewPicture($entry, $data['picture']);
 462         }
 463
 464         if (!empty($data['publishedAt'])) {
 465             $contentProxy->updatePublishedAt($entry, $data['publishedAt']);
 466         }
 467
 468         if (null !== $data['isArchived']) {
 469             $entry->setArchived((bool) $data['isArchived']);
 470         }
 471
 472         if (null !== $data['isStarred']) {
 473             $entry->updateStar((bool) $data['isStarred']);
 474         }
 475
 476         if (!empty($data['tags'])) {
 477             $entry->removeAllTags();
 478             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
 479         }
 480
 481         if (null !== $data['isPublic']) {
 482             if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
 483                 $entry->generateUid();
 484             } elseif (false === (bool) $data['isPublic']) {
 485                 $entry->cleanUid();
 486             }
 487         }
 488
 489         if (!empty($data['origin_url'])) {
 490             $entry->setOriginUrl($data['origin_url']);
 491         }
 492
 493         $em = $this->getDoctrine()->getManager();
 494         $em->persist($entry);
 495         $em->flush();
 496
 497         // entry saved, dispatch event about it!
 498         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 499
 500         return $this->sendResponse($entry);
 501     }
 502
 503     /**
 504      * Reload an entry.
 505      * 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).
 506      *
 507      * @ApiDoc(
 508      *      requirements={
 509      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 510      *      }
 511      * )
 512      *
 513      * @return JsonResponse
 514      */
 515     public function patchEntriesReloadAction(Entry $entry)
 516     {
 517         $this->validateAuthentication();
 518         $this->validateUserAccess($entry->getUser()->getId());
 519
 520         try {
 521             $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
 522         } catch (\Exception $e) {
 523             $this->get('logger')->error('Error while saving an entry', [
 524                 'exception' => $e,
 525                 'entry' => $entry,
 526             ]);
 527
 528             return new JsonResponse([], 304);
 529         }
 530
 531         // if refreshing entry failed, don't save it
 532         if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
 533             return new JsonResponse([], 304);
 534         }
 535
 536         $em = $this->getDoctrine()->getManager();
 537         $em->persist($entry);
 538         $em->flush();
 539
 540         // entry saved, dispatch event about it!
 541         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 542
 543         return $this->sendResponse($entry);
 544     }
 545
 546     /**
 547      * Delete **permanently** an entry.
 548      *
 549      * @ApiDoc(
 550      *      requirements={
 551      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 552      *      }
 553      * )
 554      *
 555      * @return JsonResponse
 556      */
 557     public function deleteEntriesAction(Entry $entry)
 558     {
 559         $this->validateAuthentication();
 560         $this->validateUserAccess($entry->getUser()->getId());
 561
 562         $em = $this->getDoctrine()->getManager();
 563         $em->remove($entry);
 564         $em->flush();
 565
 566         // entry deleted, dispatch event about it!
 567         $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 568
 569         return $this->sendResponse($entry);
 570     }
 571
 572     /**
 573      * Retrieve all tags for an entry.
 574      *
 575      * @ApiDoc(
 576      *      requirements={
 577      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 578      *      }
 579      * )
 580      *
 581      * @return JsonResponse
 582      */
 583     public function getEntriesTagsAction(Entry $entry)
 584     {
 585         $this->validateAuthentication();
 586         $this->validateUserAccess($entry->getUser()->getId());
 587
 588         return $this->sendResponse($entry->getTags());
 589     }
 590
 591     /**
 592      * Add one or more tags to an entry.
 593      *
 594      * @ApiDoc(
 595      *      requirements={
 596      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 597      *      },
 598      *      parameters={
 599      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 600      *       }
 601      * )
 602      *
 603      * @return JsonResponse
 604      */
 605     public function postEntriesTagsAction(Request $request, Entry $entry)
 606     {
 607         $this->validateAuthentication();
 608         $this->validateUserAccess($entry->getUser()->getId());
 609
 610         $tags = $request->request->get('tags', '');
 611         if (!empty($tags)) {
 612             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 613         }
 614
 615         $em = $this->getDoctrine()->getManager();
 616         $em->persist($entry);
 617         $em->flush();
 618
 619         return $this->sendResponse($entry);
 620     }
 621
 622     /**
 623      * Permanently remove one tag for an entry.
 624      *
 625      * @ApiDoc(
 626      *      requirements={
 627      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 628      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 629      *      }
 630      * )
 631      *
 632      * @return JsonResponse
 633      */
 634     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 635     {
 636         $this->validateAuthentication();
 637         $this->validateUserAccess($entry->getUser()->getId());
 638
 639         $entry->removeTag($tag);
 640         $em = $this->getDoctrine()->getManager();
 641         $em->persist($entry);
 642         $em->flush();
 643
 644         return $this->sendResponse($entry);
 645     }
 646
 647     /**
 648      * Handles an entries list delete tags from them.
 649      *
 650      * @ApiDoc(
 651      *       parameters={
 652      *          {"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."}
 653      *       }
 654      * )
 655      *
 656      * @return JsonResponse
 657      */
 658     public function deleteEntriesTagsListAction(Request $request)
 659     {
 660         $this->validateAuthentication();
 661
 662         $list = json_decode($request->query->get('list', []));
 663
 664         if (empty($list)) {
 665             return $this->sendResponse([]);
 666         }
 667
 668         // handle multiple urls
 669         $results = [];
 670
 671         foreach ($list as $key => $element) {
 672             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 673                 $element->url,
 674                 $this->getUser()->getId()
 675             );
 676
 677             $results[$key]['url'] = $element->url;
 678             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 679
 680             $tags = $element->tags;
 681
 682             if (false !== $entry && !(empty($tags))) {
 683                 $tags = explode(',', $tags);
 684                 foreach ($tags as $label) {
 685                     $label = trim($label);
 686
 687                     $tag = $this->getDoctrine()
 688                         ->getRepository('WallabagCoreBundle:Tag')
 689                         ->findOneByLabel($label);
 690
 691                     if (false !== $tag) {
 692                         $entry->removeTag($tag);
 693                     }
 694                 }
 695
 696                 $em = $this->getDoctrine()->getManager();
 697                 $em->persist($entry);
 698                 $em->flush();
 699             }
 700         }
 701
 702         return $this->sendResponse($results);
 703     }
 704
 705     /**
 706      * Handles an entries list and add tags to them.
 707      *
 708      * @ApiDoc(
 709      *       parameters={
 710      *          {"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."}
 711      *       }
 712      * )
 713      *
 714      * @return JsonResponse
 715      */
 716     public function postEntriesTagsListAction(Request $request)
 717     {
 718         $this->validateAuthentication();
 719
 720         $list = json_decode($request->query->get('list', []));
 721
 722         if (empty($list)) {
 723             return $this->sendResponse([]);
 724         }
 725
 726         $results = [];
 727
 728         // handle multiple urls
 729         foreach ($list as $key => $element) {
 730             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 731                 $element->url,
 732                 $this->getUser()->getId()
 733             );
 734
 735             $results[$key]['url'] = $element->url;
 736             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 737
 738             $tags = $element->tags;
 739
 740             if (false !== $entry && !(empty($tags))) {
 741                 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 742
 743                 $em = $this->getDoctrine()->getManager();
 744                 $em->persist($entry);
 745                 $em->flush();
 746             }
 747         }
 748
 749         return $this->sendResponse($results);
 750     }
 751
 752     /**
 753      * Shortcut to send data serialized in json.
 754      *
 755      * @param mixed $data
 756      *
 757      * @return JsonResponse
 758      */
 759     private function sendResponse($data)
 760     {
 761         // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
 762         $context = new SerializationContext();
 763         $context->setSerializeNull(true);
 764
 765         $json = $this->get('jms_serializer')->serialize($data, 'json', $context);
 766
 767         return (new JsonResponse())->setJson($json);
 768     }
 769
 770     /**
 771      * Retrieve value from the request.
 772      * Used for POST & PATCH on a an entry.
 773      *
 774      * @param Request $request
 775      *
 776      * @return array
 777      */
 778     private function retrieveValueFromRequest(Request $request)
 779     {
 780         return [
 781             'title' => $request->request->get('title'),
 782             'tags' => $request->request->get('tags', []),
 783             'isArchived' => $request->request->get('archive'),
 784             'isStarred' => $request->request->get('starred'),
 785             'isPublic' => $request->request->get('public'),
 786             'content' => $request->request->get('content'),
 787             'language' => $request->request->get('language'),
 788             'picture' => $request->request->get('preview_picture'),
 789             'publishedAt' => $request->request->get('published_at'),
 790             'authors' => $request->request->get('authors', ''),
 791             'origin_url' => $request->request->get('origin_url', ''),
 792         ];
 793     }
 794
 795     /**
 796      * Return information about the entry if it exist and depending on the id or not.
 797      *
 798      * @param Entry|null $entry
 799      * @param bool       $returnId
 800      *
 801      * @return bool|int
 802      */
 803     private function returnExistInformation($entry, $returnId)
 804     {
 805         if ($returnId) {
 806             return $entry instanceof Entry ? $entry->getId() : null;
 807         }
 808
 809         return $entry instanceof Entry;
 810     }
 811 }