src/Wallabag/ApiBundle/Controller/WallabagRestController.php

   1 <?php
   2
   3 namespace Wallabag\ApiBundle\Controller;
   4
   5 use FOS\RestBundle\Controller\FOSRestController;
   6 use Hateoas\Configuration\Route as HateoasRoute;
   7 use Hateoas\Representation\Factory\PagerfantaFactory;
   8 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
   9 use Symfony\Component\HttpFoundation\Request;
  10 use Symfony\Component\HttpFoundation\JsonResponse;
  11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  12 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  13 use Wallabag\CoreBundle\Entity\Entry;
  14 use Wallabag\CoreBundle\Entity\Tag;
  15 use FOS\RestBundle\Controller\Annotations\Route;
  16
  17 class WallabagRestController extends FOSRestController
  18 {
  19     private function validateAuthentication()
  20     {
  21         if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) {
  22             throw new AccessDeniedException();
  23         }
  24     }
  25
  26     /**
  27      * Check if an entry exist by url.
  28      *
  29      * @ApiDoc(
  30      *       parameters={
  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         $urls = $request->query->get('urls', []);
  43
  44         // handle multiple urls first
  45         if (!empty($urls)) {
  46             $results = [];
  47             foreach ($urls as $url) {
  48                 $res = $this->getDoctrine()
  49                     ->getRepository('WallabagCoreBundle:Entry')
  50                     ->findByUrlAndUserId($url, $this->getUser()->getId());
  51
  52                 $results[$url] = false === $res ? false : true;
  53             }
  54
  55             $json = $this->get('serializer')->serialize($results, 'json');
  56
  57             return (new JsonResponse())->setJson($json);
  58         }
  59
  60         // let's see if it is a simple url?
  61         $url = $request->query->get('url', '');
  62
  63         if (empty($url)) {
  64             throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
  65         }
  66
  67         $res = $this->getDoctrine()
  68             ->getRepository('WallabagCoreBundle:Entry')
  69             ->findByUrlAndUserId($url, $this->getUser()->getId());
  70
  71         $exists = false === $res ? false : true;
  72
  73         $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
  74
  75         return (new JsonResponse())->setJson($json);
  76     }
  77
  78     /**
  79      * Retrieve all entries. It could be filtered by many options.
  80      *
  81      * @ApiDoc(
  82      *       parameters={
  83      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
  84      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
  85      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  86      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  87      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  88      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  89      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  90      *          {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
  91      *       }
  92      * )
  93      *
  94      * @return JsonResponse
  95      */
  96     public function getEntriesAction(Request $request)
  97     {
  98         $this->validateAuthentication();
  99
 100         $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
 101         $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
 102         $sort = $request->query->get('sort', 'created');
 103         $order = $request->query->get('order', 'desc');
 104         $page = (int) $request->query->get('page', 1);
 105         $perPage = (int) $request->query->get('perPage', 30);
 106         $tags = $request->query->get('tags', '');
 107         $since = $request->query->get('since', 0);
 108
 109         $pager = $this->getDoctrine()
 110             ->getRepository('WallabagCoreBundle:Entry')
 111             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
 112
 113         $pager->setCurrentPage($page);
 114         $pager->setMaxPerPage($perPage);
 115
 116         $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
 117         $paginatedCollection = $pagerfantaFactory->createRepresentation(
 118             $pager,
 119             new HateoasRoute(
 120                 'api_get_entries',
 121                 [
 122                     'archive' => $isArchived,
 123                     'starred' => $isStarred,
 124                     'sort' => $sort,
 125                     'order' => $order,
 126                     'page' => $page,
 127                     'perPage' => $perPage,
 128                     'tags' => $tags,
 129                     'since' => $since,
 130                 ],
 131                 UrlGeneratorInterface::ABSOLUTE_URL
 132             )
 133         );
 134
 135         $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
 136
 137         return (new JsonResponse())->setJson($json);
 138     }
 139
 140     /**
 141      * Retrieve a single entry.
 142      *
 143      * @ApiDoc(
 144      *      requirements={
 145      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 146      *      }
 147      * )
 148      *
 149      * @return JsonResponse
 150      */
 151     public function getEntryAction(Entry $entry)
 152     {
 153         $this->validateAuthentication();
 154         $this->validateUserAccess($entry->getUser()->getId());
 155
 156         $json = $this->get('serializer')->serialize($entry, 'json');
 157
 158         return (new JsonResponse())->setJson($json);
 159     }
 160
 161     /**
 162      * Retrieve a single entry as a predefined format.
 163      *
 164      * @ApiDoc(
 165      *      requirements={
 166      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 167      *      }
 168      * )
 169      *
 170      * @return Response
 171      */
 172     public function getEntryExportAction(Entry $entry, Request $request)
 173     {
 174         $this->validateAuthentication();
 175         $this->validateUserAccess($entry->getUser()->getId());
 176
 177         return $this->get('wallabag_core.helper.entries_export')
 178             ->setEntries($entry)
 179             ->updateTitle('entry')
 180             ->exportAs($request->attributes->get('_format'));
 181     }
 182
 183     /**
 184      * Create an entry.
 185      *
 186      * @ApiDoc(
 187      *       parameters={
 188      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 189      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 190      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 191      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
 192      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
 193      *       }
 194      * )
 195      *
 196      * @return JsonResponse
 197      */
 198     public function postEntriesAction(Request $request)
 199     {
 200         $this->validateAuthentication();
 201
 202         $url = $request->request->get('url');
 203         $title = $request->request->get('title');
 204         $isArchived = $request->request->get('archive');
 205         $isStarred = $request->request->get('starred');
 206
 207         $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
 208
 209         if (false === $entry) {
 210             $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 211                 new Entry($this->getUser()),
 212                 $url
 213             );
 214         }
 215
 216         if (!is_null($title)) {
 217             $entry->setTitle($title);
 218         }
 219
 220         $tags = $request->request->get('tags', '');
 221         if (!empty($tags)) {
 222             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 223         }
 224
 225         if (!is_null($isStarred)) {
 226             $entry->setStarred((bool) $isStarred);
 227         }
 228
 229         if (!is_null($isArchived)) {
 230             $entry->setArchived((bool) $isArchived);
 231         }
 232
 233         $em = $this->getDoctrine()->getManager();
 234         $em->persist($entry);
 235
 236         $em->flush();
 237
 238         $json = $this->get('serializer')->serialize($entry, 'json');
 239
 240         return (new JsonResponse())->setJson($json);
 241     }
 242
 243     /**
 244      * Change several properties of an entry.
 245      *
 246      * @ApiDoc(
 247      *      requirements={
 248      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 249      *      },
 250      *      parameters={
 251      *          {"name"="title", "dataType"="string", "required"=false},
 252      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 253      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
 254      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
 255      *      }
 256      * )
 257      *
 258      * @return JsonResponse
 259      */
 260     public function patchEntriesAction(Entry $entry, Request $request)
 261     {
 262         $this->validateAuthentication();
 263         $this->validateUserAccess($entry->getUser()->getId());
 264
 265         $title = $request->request->get('title');
 266         $isArchived = $request->request->get('archive');
 267         $isStarred = $request->request->get('starred');
 268
 269         if (!is_null($title)) {
 270             $entry->setTitle($title);
 271         }
 272
 273         if (!is_null($isArchived)) {
 274             $entry->setArchived((bool) $isArchived);
 275         }
 276
 277         if (!is_null($isStarred)) {
 278             $entry->setStarred((bool) $isStarred);
 279         }
 280
 281         $tags = $request->request->get('tags', '');
 282         if (!empty($tags)) {
 283             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 284         }
 285
 286         $em = $this->getDoctrine()->getManager();
 287         $em->flush();
 288
 289         $json = $this->get('serializer')->serialize($entry, 'json');
 290
 291         return (new JsonResponse())->setJson($json);
 292     }
 293
 294     /**
 295      * Delete **permanently** an entry.
 296      *
 297      * @ApiDoc(
 298      *      requirements={
 299      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 300      *      }
 301      * )
 302      *
 303      * @return JsonResponse
 304      */
 305     public function deleteEntriesAction(Entry $entry)
 306     {
 307         $this->validateAuthentication();
 308         $this->validateUserAccess($entry->getUser()->getId());
 309
 310         $em = $this->getDoctrine()->getManager();
 311         $em->remove($entry);
 312         $em->flush();
 313
 314         $json = $this->get('serializer')->serialize($entry, 'json');
 315
 316         return (new JsonResponse())->setJson($json);
 317     }
 318
 319     /**
 320      * Retrieve all tags for an entry.
 321      *
 322      * @ApiDoc(
 323      *      requirements={
 324      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 325      *      }
 326      * )
 327      *
 328      * @return JsonResponse
 329      */
 330     public function getEntriesTagsAction(Entry $entry)
 331     {
 332         $this->validateAuthentication();
 333         $this->validateUserAccess($entry->getUser()->getId());
 334
 335         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 336
 337         return (new JsonResponse())->setJson($json);
 338     }
 339
 340     /**
 341      * Add one or more tags to an entry.
 342      *
 343      * @ApiDoc(
 344      *      requirements={
 345      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 346      *      },
 347      *      parameters={
 348      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 349      *       }
 350      * )
 351      *
 352      * @return JsonResponse
 353      */
 354     public function postEntriesTagsAction(Request $request, Entry $entry)
 355     {
 356         $this->validateAuthentication();
 357         $this->validateUserAccess($entry->getUser()->getId());
 358
 359         $tags = $request->request->get('tags', '');
 360         if (!empty($tags)) {
 361             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 362         }
 363
 364         $em = $this->getDoctrine()->getManager();
 365         $em->persist($entry);
 366         $em->flush();
 367
 368         $json = $this->get('serializer')->serialize($entry, 'json');
 369
 370         return (new JsonResponse())->setJson($json);
 371     }
 372
 373     /**
 374      * Permanently remove one tag for an entry.
 375      *
 376      * @ApiDoc(
 377      *      requirements={
 378      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 379      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 380      *      }
 381      * )
 382      *
 383      * @return JsonResponse
 384      */
 385     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 386     {
 387         $this->validateAuthentication();
 388         $this->validateUserAccess($entry->getUser()->getId());
 389
 390         $entry->removeTag($tag);
 391         $em = $this->getDoctrine()->getManager();
 392         $em->persist($entry);
 393         $em->flush();
 394
 395         $json = $this->get('serializer')->serialize($entry, 'json');
 396
 397         return (new JsonResponse())->setJson($json);
 398     }
 399
 400     /**
 401      * Retrieve all tags.
 402      *
 403      * @ApiDoc()
 404      *
 405      * @return JsonResponse
 406      */
 407     public function getTagsAction()
 408     {
 409         $this->validateAuthentication();
 410
 411         $tags = $this->getDoctrine()
 412             ->getRepository('WallabagCoreBundle:Tag')
 413             ->findAllTags($this->getUser()->getId());
 414
 415         $json = $this->get('serializer')->serialize($tags, 'json');
 416
 417         return (new JsonResponse())->setJson($json);
 418     }
 419
 420     /**
 421      * Permanently remove one tag from **every** entry.
 422      *
 423      * @ApiDoc(
 424      *      requirements={
 425      *          {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
 426      *      }
 427      * )
 428      *
 429      * @return JsonResponse
 430      */
 431     public function deleteTagLabelAction(Request $request)
 432     {
 433         $this->validateAuthentication();
 434         $label = $request->request->get('tag', '');
 435
 436         $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
 437
 438         if (empty($tag)) {
 439             throw $this->createNotFoundException('Tag not found');
 440         }
 441
 442         $this->getDoctrine()
 443             ->getRepository('WallabagCoreBundle:Entry')
 444             ->removeTag($this->getUser()->getId(), $tag);
 445
 446         $this->cleanOrphanTag($tag);
 447
 448         $json = $this->get('serializer')->serialize($tag, 'json');
 449
 450         return (new JsonResponse())->setJson($json);
 451     }
 452
 453     /**
 454      * Permanently remove some tags from **every** entry.
 455      *
 456      * @ApiDoc(
 457      *      requirements={
 458      *          {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
 459      *      }
 460      * )
 461      *
 462      * @return JsonResponse
 463      */
 464     public function deleteTagsLabelAction(Request $request)
 465     {
 466         $this->validateAuthentication();
 467
 468         $tagsLabels = $request->request->get('tags', '');
 469
 470         $tags = [];
 471
 472         foreach (explode(',', $tagsLabels) as $tagLabel) {
 473             $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
 474
 475             if (!empty($tagEntity)) {
 476                 $tags[] = $tagEntity;
 477             }
 478         }
 479
 480         if (empty($tags)) {
 481             throw $this->createNotFoundException('Tags not found');
 482         }
 483
 484         $this->getDoctrine()
 485             ->getRepository('WallabagCoreBundle:Entry')
 486             ->removeTags($this->getUser()->getId(), $tags);
 487
 488         $this->cleanOrphanTag($tags);
 489
 490         $json = $this->get('serializer')->serialize($tags, 'json');
 491
 492         return (new JsonResponse())->setJson($json);
 493     }
 494
 495     /**
 496      * Permanently remove one tag from **every** entry.
 497      *
 498      * @ApiDoc(
 499      *      requirements={
 500      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
 501      *      }
 502      * )
 503      *
 504      * @return JsonResponse
 505      */
 506     public function deleteTagAction(Tag $tag)
 507     {
 508         $this->validateAuthentication();
 509
 510         $this->getDoctrine()
 511             ->getRepository('WallabagCoreBundle:Entry')
 512             ->removeTag($this->getUser()->getId(), $tag);
 513
 514         $this->cleanOrphanTag($tag);
 515
 516         $json = $this->get('serializer')->serialize($tag, 'json');
 517
 518         return (new JsonResponse())->setJson($json);
 519     }
 520
 521     /**
 522      * Retrieve version number.
 523      *
 524      * @ApiDoc()
 525      *
 526      * @return JsonResponse
 527      */
 528     public function getVersionAction()
 529     {
 530         $version = $this->container->getParameter('wallabag_core.version');
 531
 532         $json = $this->get('serializer')->serialize($version, 'json');
 533
 534         return (new JsonResponse())->setJson($json);
 535     }
 536
 537     /**
 538      * Remove orphan tag in case no entries are associated to it.
 539      *
 540      * @param Tag|array $tags
 541      */
 542     private function cleanOrphanTag($tags)
 543     {
 544         if (!is_array($tags)) {
 545             $tags = [$tags];
 546         }
 547
 548         $em = $this->getDoctrine()->getManager();
 549
 550         foreach ($tags as $tag) {
 551             if (count($tag->getEntries()) === 0) {
 552                 $em->remove($tag);
 553             }
 554         }
 555
 556         $em->flush();
 557     }
 558
 559     /**
 560      * Validate that the first id is equal to the second one.
 561      * If not, throw exception. It means a user try to access information from an other user.
 562      *
 563      * @param int $requestUserId User id from the requested source
 564      */
 565     private function validateUserAccess($requestUserId)
 566     {
 567         $user = $this->get('security.token_storage')->getToken()->getUser();
 568         if ($requestUserId != $user->getId()) {
 569             throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
 570         }
 571     }
 572 }