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 Nelmio\ApiDocBundle\Annotation\ApiDoc;
   8 use Symfony\Component\HttpKernel\Exception\HttpException;
   9 use Symfony\Component\HttpFoundation\Request;
  10 use Symfony\Component\HttpFoundation\JsonResponse;
  11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  12 use Wallabag\CoreBundle\Entity\Entry;
  13 use Wallabag\CoreBundle\Entity\Tag;
  14 use Wallabag\CoreBundle\Event\EntrySavedEvent;
  15 use Wallabag\CoreBundle\Event\EntryDeletedEvent;
  16
  17 class EntryRestController extends WallabagRestController
  18 {
  19     /**
  20      * Check if an entry exist by url.
  21      *
  22      * @ApiDoc(
  23      *       parameters={
  24      *          {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
  25      *          {"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"}
  26      *       }
  27      * )
  28      *
  29      * @return JsonResponse
  30      */
  31     public function getEntriesExistsAction(Request $request)
  32     {
  33         $this->validateAuthentication();
  34
  35         $urls = $request->query->get('urls', []);
  36
  37         // handle multiple urls first
  38         if (!empty($urls)) {
  39             $results = [];
  40             foreach ($urls as $url) {
  41                 $res = $this->getDoctrine()
  42                     ->getRepository('WallabagCoreBundle:Entry')
  43                     ->findByUrlAndUserId($url, $this->getUser()->getId());
  44
  45                 $results[$url] = $res instanceof Entry ? $res->getId() : false;
  46             }
  47
  48             return $this->sendResponse($results);
  49         }
  50
  51         // let's see if it is a simple url?
  52         $url = $request->query->get('url', '');
  53
  54         if (empty($url)) {
  55             throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
  56         }
  57
  58         $res = $this->getDoctrine()
  59             ->getRepository('WallabagCoreBundle:Entry')
  60             ->findByUrlAndUserId($url, $this->getUser()->getId());
  61
  62         $exists = $res instanceof Entry ? $res->getId() : false;
  63
  64         return $this->sendResponse(['exists' => $exists]);
  65     }
  66
  67     /**
  68      * Retrieve all entries. It could be filtered by many options.
  69      *
  70      * @ApiDoc(
  71      *       parameters={
  72      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
  73      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
  74      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  75      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  76      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  77      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  78      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  79      *          {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
  80      *       }
  81      * )
  82      *
  83      * @return JsonResponse
  84      */
  85     public function getEntriesAction(Request $request)
  86     {
  87         $this->validateAuthentication();
  88
  89         $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
  90         $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
  91         $sort = $request->query->get('sort', 'created');
  92         $order = $request->query->get('order', 'desc');
  93         $page = (int) $request->query->get('page', 1);
  94         $perPage = (int) $request->query->get('perPage', 30);
  95         $tags = $request->query->get('tags', '');
  96         $since = $request->query->get('since', 0);
  97
  98         /** @var \Pagerfanta\Pagerfanta $pager */
  99         $pager = $this->getDoctrine()
 100             ->getRepository('WallabagCoreBundle:Entry')
 101             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
 102
 103         $pager->setMaxPerPage($perPage);
 104         $pager->setCurrentPage($page);
 105
 106         $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
 107         $paginatedCollection = $pagerfantaFactory->createRepresentation(
 108             $pager,
 109             new Route(
 110                 'api_get_entries',
 111                 [
 112                     'archive' => $isArchived,
 113                     'starred' => $isStarred,
 114                     'sort' => $sort,
 115                     'order' => $order,
 116                     'page' => $page,
 117                     'perPage' => $perPage,
 118                     'tags' => $tags,
 119                     'since' => $since,
 120                 ],
 121                 UrlGeneratorInterface::ABSOLUTE_URL
 122             )
 123         );
 124
 125         return $this->sendResponse($paginatedCollection);
 126     }
 127
 128     /**
 129      * Retrieve a single entry.
 130      *
 131      * @ApiDoc(
 132      *      requirements={
 133      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 134      *      }
 135      * )
 136      *
 137      * @return JsonResponse
 138      */
 139     public function getEntryAction(Entry $entry)
 140     {
 141         $this->validateAuthentication();
 142         $this->validateUserAccess($entry->getUser()->getId());
 143
 144         return $this->sendResponse($entry);
 145     }
 146
 147     /**
 148      * Retrieve a single entry as a predefined format.
 149      *
 150      * @ApiDoc(
 151      *      requirements={
 152      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 153      *      }
 154      * )
 155      *
 156      * @return Response
 157      */
 158     public function getEntryExportAction(Entry $entry, Request $request)
 159     {
 160         $this->validateAuthentication();
 161         $this->validateUserAccess($entry->getUser()->getId());
 162
 163         return $this->get('wallabag_core.helper.entries_export')
 164             ->setEntries($entry)
 165             ->updateTitle('entry')
 166             ->exportAs($request->attributes->get('_format'));
 167     }
 168
 169     /**
 170      * Handles an entries list and delete URL.
 171      *
 172      * @ApiDoc(
 173      *       parameters={
 174      *          {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
 175      *       }
 176      * )
 177      *
 178      * @return JsonResponse
 179      */
 180     public function deleteEntriesListAction(Request $request)
 181     {
 182         $this->validateAuthentication();
 183
 184         $urls = json_decode($request->query->get('urls', []));
 185
 186         if (empty($urls)) {
 187             return $this->sendResponse([]);
 188         }
 189
 190         $results = [];
 191
 192         // handle multiple urls
 193         foreach ($urls as $key => $url) {
 194             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 195                 $url,
 196                 $this->getUser()->getId()
 197             );
 198
 199             $results[$key]['url'] = $url;
 200
 201             if (false !== $entry) {
 202                 $em = $this->getDoctrine()->getManager();
 203                 $em->remove($entry);
 204                 $em->flush();
 205
 206                 // entry deleted, dispatch event about it!
 207                 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 208             }
 209
 210             $results[$key]['entry'] = $entry instanceof Entry ? true : false;
 211         }
 212
 213         return $this->sendResponse($results);
 214     }
 215
 216     /**
 217      * Handles an entries list and create URL.
 218      *
 219      * @ApiDoc(
 220      *       parameters={
 221      *          {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
 222      *       }
 223      * )
 224      *
 225      * @return JsonResponse
 226      *
 227      * @throws HttpException When limit is reached
 228      */
 229     public function postEntriesListAction(Request $request)
 230     {
 231         $this->validateAuthentication();
 232
 233         $urls = json_decode($request->query->get('urls', []));
 234         $results = [];
 235
 236         $limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
 237
 238         if (count($urls) > $limit) {
 239             throw new HttpException(400, 'API limit reached');
 240         }
 241
 242         // handle multiple urls
 243         if (!empty($urls)) {
 244             foreach ($urls as $key => $url) {
 245                 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 246                     $url,
 247                     $this->getUser()->getId()
 248                 );
 249
 250                 $results[$key]['url'] = $url;
 251
 252                 if (false === $entry) {
 253                     $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 254                         new Entry($this->getUser()),
 255                         $url
 256                     );
 257                 }
 258
 259                 $em = $this->getDoctrine()->getManager();
 260                 $em->persist($entry);
 261                 $em->flush();
 262
 263                 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 264
 265                 // entry saved, dispatch event about it!
 266                 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 267             }
 268         }
 269
 270         return $this->sendResponse($results);
 271     }
 272
 273     /**
 274      * Create an entry.
 275      *
 276      * @ApiDoc(
 277      *       parameters={
 278      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 279      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 280      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 281      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
 282      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
 283      *       }
 284      * )
 285      *
 286      * @return JsonResponse
 287      */
 288     public function postEntriesAction(Request $request)
 289     {
 290         $this->validateAuthentication();
 291
 292         $url = $request->request->get('url');
 293         $title = $request->request->get('title');
 294         $isArchived = $request->request->get('archive');
 295         $isStarred = $request->request->get('starred');
 296
 297         $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
 298
 299         if (false === $entry) {
 300             $entry = new Entry($this->getUser());
 301             try {
 302                 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 303                     $entry,
 304                     $url
 305                 );
 306             } catch (\Exception $e) {
 307                 $this->get('logger')->error('Error while saving an entry', [
 308                     'exception' => $e,
 309                     'entry' => $entry,
 310                 ]);
 311                 $entry->setUrl($url);
 312             }
 313         }
 314
 315         if (!is_null($title)) {
 316             $entry->setTitle($title);
 317         }
 318
 319         $tags = $request->request->get('tags', '');
 320         if (!empty($tags)) {
 321             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 322         }
 323
 324         if (!is_null($isStarred)) {
 325             $entry->setStarred((bool) $isStarred);
 326         }
 327
 328         if (!is_null($isArchived)) {
 329             $entry->setArchived((bool) $isArchived);
 330         }
 331
 332         $em = $this->getDoctrine()->getManager();
 333         $em->persist($entry);
 334         $em->flush();
 335
 336         // entry saved, dispatch event about it!
 337         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 338
 339         return $this->sendResponse($entry);
 340     }
 341
 342     /**
 343      * Change several properties of an entry.
 344      *
 345      * @ApiDoc(
 346      *      requirements={
 347      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 348      *      },
 349      *      parameters={
 350      *          {"name"="title", "dataType"="string", "required"=false},
 351      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 352      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
 353      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
 354      *      }
 355      * )
 356      *
 357      * @return JsonResponse
 358      */
 359     public function patchEntriesAction(Entry $entry, Request $request)
 360     {
 361         $this->validateAuthentication();
 362         $this->validateUserAccess($entry->getUser()->getId());
 363
 364         $title = $request->request->get('title');
 365         $isArchived = $request->request->get('archive');
 366         $isStarred = $request->request->get('starred');
 367
 368         if (!is_null($title)) {
 369             $entry->setTitle($title);
 370         }
 371
 372         if (!is_null($isArchived)) {
 373             $entry->setArchived((bool) $isArchived);
 374         }
 375
 376         if (!is_null($isStarred)) {
 377             $entry->setStarred((bool) $isStarred);
 378         }
 379
 380         $tags = $request->request->get('tags', '');
 381         if (!empty($tags)) {
 382             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 383         }
 384
 385         $em = $this->getDoctrine()->getManager();
 386         $em->flush();
 387
 388         return $this->sendResponse($entry);
 389     }
 390
 391     /**
 392      * Reload an entry.
 393      * 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).
 394      *
 395      * @ApiDoc(
 396      *      requirements={
 397      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 398      *      }
 399      * )
 400      *
 401      * @return JsonResponse
 402      */
 403     public function patchEntriesReloadAction(Entry $entry)
 404     {
 405         $this->validateAuthentication();
 406         $this->validateUserAccess($entry->getUser()->getId());
 407
 408         try {
 409             $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
 410         } catch (\Exception $e) {
 411             $this->get('logger')->error('Error while saving an entry', [
 412                 'exception' => $e,
 413                 'entry' => $entry,
 414             ]);
 415
 416             return new JsonResponse([], 304);
 417         }
 418
 419         // if refreshing entry failed, don't save it
 420         if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
 421             return new JsonResponse([], 304);
 422         }
 423
 424         $em = $this->getDoctrine()->getManager();
 425         $em->persist($entry);
 426         $em->flush();
 427
 428         // entry saved, dispatch event about it!
 429         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 430
 431         return $this->sendResponse($entry);
 432     }
 433
 434     /**
 435      * Delete **permanently** an entry.
 436      *
 437      * @ApiDoc(
 438      *      requirements={
 439      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 440      *      }
 441      * )
 442      *
 443      * @return JsonResponse
 444      */
 445     public function deleteEntriesAction(Entry $entry)
 446     {
 447         $this->validateAuthentication();
 448         $this->validateUserAccess($entry->getUser()->getId());
 449
 450         $em = $this->getDoctrine()->getManager();
 451         $em->remove($entry);
 452         $em->flush();
 453
 454         // entry deleted, dispatch event about it!
 455         $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 456
 457         return $this->sendResponse($entry);
 458     }
 459
 460     /**
 461      * Retrieve all tags for an entry.
 462      *
 463      * @ApiDoc(
 464      *      requirements={
 465      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 466      *      }
 467      * )
 468      *
 469      * @return JsonResponse
 470      */
 471     public function getEntriesTagsAction(Entry $entry)
 472     {
 473         $this->validateAuthentication();
 474         $this->validateUserAccess($entry->getUser()->getId());
 475
 476         return $this->sendResponse($entry->getTags());
 477     }
 478
 479     /**
 480      * Add one or more tags to an entry.
 481      *
 482      * @ApiDoc(
 483      *      requirements={
 484      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 485      *      },
 486      *      parameters={
 487      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 488      *       }
 489      * )
 490      *
 491      * @return JsonResponse
 492      */
 493     public function postEntriesTagsAction(Request $request, Entry $entry)
 494     {
 495         $this->validateAuthentication();
 496         $this->validateUserAccess($entry->getUser()->getId());
 497
 498         $tags = $request->request->get('tags', '');
 499         if (!empty($tags)) {
 500             $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 501         }
 502
 503         $em = $this->getDoctrine()->getManager();
 504         $em->persist($entry);
 505         $em->flush();
 506
 507         return $this->sendResponse($entry);
 508     }
 509
 510     /**
 511      * Permanently remove one tag for an entry.
 512      *
 513      * @ApiDoc(
 514      *      requirements={
 515      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 516      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 517      *      }
 518      * )
 519      *
 520      * @return JsonResponse
 521      */
 522     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 523     {
 524         $this->validateAuthentication();
 525         $this->validateUserAccess($entry->getUser()->getId());
 526
 527         $entry->removeTag($tag);
 528         $em = $this->getDoctrine()->getManager();
 529         $em->persist($entry);
 530         $em->flush();
 531
 532         return $this->sendResponse($entry);
 533     }
 534
 535     /**
 536      * Handles an entries list delete tags from them.
 537      *
 538      * @ApiDoc(
 539      *       parameters={
 540      *          {"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."}
 541      *       }
 542      * )
 543      *
 544      * @return JsonResponse
 545      */
 546     public function deleteEntriesTagsListAction(Request $request)
 547     {
 548         $this->validateAuthentication();
 549
 550         $list = json_decode($request->query->get('list', []));
 551
 552         if (empty($list)) {
 553             return $this->sendResponse([]);
 554         }
 555
 556         // handle multiple urls
 557         $results = [];
 558
 559         foreach ($list as $key => $element) {
 560             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 561                 $element->url,
 562                 $this->getUser()->getId()
 563             );
 564
 565             $results[$key]['url'] = $element->url;
 566             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 567
 568             $tags = $element->tags;
 569
 570             if (false !== $entry && !(empty($tags))) {
 571                 $tags = explode(',', $tags);
 572                 foreach ($tags as $label) {
 573                     $label = trim($label);
 574
 575                     $tag = $this->getDoctrine()
 576                         ->getRepository('WallabagCoreBundle:Tag')
 577                         ->findOneByLabel($label);
 578
 579                     if (false !== $tag) {
 580                         $entry->removeTag($tag);
 581                     }
 582                 }
 583
 584                 $em = $this->getDoctrine()->getManager();
 585                 $em->persist($entry);
 586                 $em->flush();
 587             }
 588         }
 589
 590         return $this->sendResponse($results);
 591     }
 592
 593     /**
 594      * Handles an entries list and add tags to them.
 595      *
 596      * @ApiDoc(
 597      *       parameters={
 598      *          {"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."}
 599      *       }
 600      * )
 601      *
 602      * @return JsonResponse
 603      */
 604     public function postEntriesTagsListAction(Request $request)
 605     {
 606         $this->validateAuthentication();
 607
 608         $list = json_decode($request->query->get('list', []));
 609
 610         if (empty($list)) {
 611             return $this->sendResponse([]);
 612         }
 613
 614         $results = [];
 615
 616         // handle multiple urls
 617         foreach ($list as $key => $element) {
 618             $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
 619                 $element->url,
 620                 $this->getUser()->getId()
 621             );
 622
 623             $results[$key]['url'] = $element->url;
 624             $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
 625
 626             $tags = $element->tags;
 627
 628             if (false !== $entry && !(empty($tags))) {
 629                 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
 630
 631                 $em = $this->getDoctrine()->getManager();
 632                 $em->persist($entry);
 633                 $em->flush();
 634             }
 635         }
 636
 637         return $this->sendResponse($results);
 638     }
 639
 640     /**
 641      * Shortcut to send data serialized in json.
 642      *
 643      * @param mixed $data
 644      *
 645      * @return JsonResponse
 646      */
 647     private function sendResponse($data)
 648     {
 649         $json = $this->get('serializer')->serialize($data, 'json');
 650
 651         return (new JsonResponse())->setJson($json);
 652     }
 653 }