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\HttpFoundation\Request;
   9 use Symfony\Component\HttpFoundation\JsonResponse;
  10 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  11 use Wallabag\CoreBundle\Entity\Entry;
  12 use Wallabag\CoreBundle\Entity\Tag;
  13 use Wallabag\CoreBundle\Event\EntrySavedEvent;
  14 use Wallabag\CoreBundle\Event\EntryDeletedEvent;
  15
  16 class EntryRestController extends WallabagRestController
  17 {
  18     /**
  19      * Check if an entry exist by url.
  20      *
  21      * @ApiDoc(
  22      *       parameters={
  23      *          {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
  24      *          {"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"}
  25      *       }
  26      * )
  27      *
  28      * @return JsonResponse
  29      */
  30     public function getEntriesExistsAction(Request $request)
  31     {
  32         $this->validateAuthentication();
  33
  34         $urls = $request->query->get('urls', []);
  35
  36         // handle multiple urls first
  37         if (!empty($urls)) {
  38             $results = [];
  39             foreach ($urls as $url) {
  40                 $res = $this->getDoctrine()
  41                     ->getRepository('WallabagCoreBundle:Entry')
  42                     ->findByUrlAndUserId($url, $this->getUser()->getId());
  43
  44                 $results[$url] = $res instanceof Entry ? $res->getId() : false;
  45             }
  46
  47             $json = $this->get('serializer')->serialize($results, 'json');
  48
  49             return (new JsonResponse())->setJson($json);
  50         }
  51
  52         // let's see if it is a simple url?
  53         $url = $request->query->get('url', '');
  54
  55         if (empty($url)) {
  56             throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
  57         }
  58
  59         $res = $this->getDoctrine()
  60             ->getRepository('WallabagCoreBundle:Entry')
  61             ->findByUrlAndUserId($url, $this->getUser()->getId());
  62
  63         $exists = $res instanceof Entry ? $res->getId() : false;
  64
  65         $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
  66
  67         return (new JsonResponse())->setJson($json);
  68     }
  69
  70     /**
  71      * Retrieve all entries. It could be filtered by many options.
  72      *
  73      * @ApiDoc(
  74      *       parameters={
  75      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
  76      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
  77      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  78      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  79      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  80      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  81      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  82      *          {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
  83      *       }
  84      * )
  85      *
  86      * @return JsonResponse
  87      */
  88     public function getEntriesAction(Request $request)
  89     {
  90         $this->validateAuthentication();
  91
  92         $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
  93         $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
  94         $sort = $request->query->get('sort', 'created');
  95         $order = $request->query->get('order', 'desc');
  96         $page = (int) $request->query->get('page', 1);
  97         $perPage = (int) $request->query->get('perPage', 30);
  98         $tags = $request->query->get('tags', '');
  99         $since = $request->query->get('since', 0);
 100
 101         $pager = $this->getDoctrine()
 102             ->getRepository('WallabagCoreBundle:Entry')
 103             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
 104
 105         $pager->setCurrentPage($page);
 106         $pager->setMaxPerPage($perPage);
 107
 108         $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
 109         $paginatedCollection = $pagerfantaFactory->createRepresentation(
 110             $pager,
 111             new Route(
 112                 'api_get_entries',
 113                 [
 114                     'archive' => $isArchived,
 115                     'starred' => $isStarred,
 116                     'sort' => $sort,
 117                     'order' => $order,
 118                     'page' => $page,
 119                     'perPage' => $perPage,
 120                     'tags' => $tags,
 121                     'since' => $since,
 122                 ],
 123                 UrlGeneratorInterface::ABSOLUTE_URL
 124             )
 125         );
 126
 127         $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
 128
 129         return (new JsonResponse())->setJson($json);
 130     }
 131
 132     /**
 133      * Retrieve a single entry.
 134      *
 135      * @ApiDoc(
 136      *      requirements={
 137      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 138      *      }
 139      * )
 140      *
 141      * @return JsonResponse
 142      */
 143     public function getEntryAction(Entry $entry)
 144     {
 145         $this->validateAuthentication();
 146         $this->validateUserAccess($entry->getUser()->getId());
 147
 148         $json = $this->get('serializer')->serialize($entry, 'json');
 149
 150         return (new JsonResponse())->setJson($json);
 151     }
 152
 153     /**
 154      * Retrieve a single entry as a predefined format.
 155      *
 156      * @ApiDoc(
 157      *      requirements={
 158      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 159      *      }
 160      * )
 161      *
 162      * @return Response
 163      */
 164     public function getEntryExportAction(Entry $entry, Request $request)
 165     {
 166         $this->validateAuthentication();
 167         $this->validateUserAccess($entry->getUser()->getId());
 168
 169         return $this->get('wallabag_core.helper.entries_export')
 170             ->setEntries($entry)
 171             ->updateTitle('entry')
 172             ->exportAs($request->attributes->get('_format'));
 173     }
 174
 175     /**
 176      * Create an entry.
 177      *
 178      * @ApiDoc(
 179      *       parameters={
 180      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 181      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 182      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 183      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
 184      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
 185      *       }
 186      * )
 187      *
 188      * @return JsonResponse
 189      */
 190     public function postEntriesAction(Request $request)
 191     {
 192         $this->validateAuthentication();
 193
 194         $url = $request->request->get('url');
 195         $title = $request->request->get('title');
 196         $isArchived = $request->request->get('archive');
 197         $isStarred = $request->request->get('starred');
 198
 199         $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
 200
 201         if (false === $entry) {
 202             $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 203                 new Entry($this->getUser()),
 204                 $url
 205             );
 206         }
 207
 208         if (!is_null($title)) {
 209             $entry->setTitle($title);
 210         }
 211
 212         $tags = $request->request->get('tags', '');
 213         if (!empty($tags)) {
 214             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 215         }
 216
 217         if (!is_null($isStarred)) {
 218             $entry->setStarred((bool) $isStarred);
 219         }
 220
 221         if (!is_null($isArchived)) {
 222             $entry->setArchived((bool) $isArchived);
 223         }
 224
 225         $em = $this->getDoctrine()->getManager();
 226         $em->persist($entry);
 227         $em->flush();
 228
 229         // entry saved, dispatch event about it!
 230         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 231
 232         $json = $this->get('serializer')->serialize($entry, 'json');
 233
 234         return (new JsonResponse())->setJson($json);
 235     }
 236
 237     /**
 238      * Change several properties of an entry.
 239      *
 240      * @ApiDoc(
 241      *      requirements={
 242      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 243      *      },
 244      *      parameters={
 245      *          {"name"="title", "dataType"="string", "required"=false},
 246      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 247      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
 248      *          {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
 249      *      }
 250      * )
 251      *
 252      * @return JsonResponse
 253      */
 254     public function patchEntriesAction(Entry $entry, Request $request)
 255     {
 256         $this->validateAuthentication();
 257         $this->validateUserAccess($entry->getUser()->getId());
 258
 259         $title = $request->request->get('title');
 260         $isArchived = $request->request->get('archive');
 261         $isStarred = $request->request->get('starred');
 262
 263         if (!is_null($title)) {
 264             $entry->setTitle($title);
 265         }
 266
 267         if (!is_null($isArchived)) {
 268             $entry->setArchived((bool) $isArchived);
 269         }
 270
 271         if (!is_null($isStarred)) {
 272             $entry->setStarred((bool) $isStarred);
 273         }
 274
 275         $tags = $request->request->get('tags', '');
 276         if (!empty($tags)) {
 277             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 278         }
 279
 280         $em = $this->getDoctrine()->getManager();
 281         $em->flush();
 282
 283         $json = $this->get('serializer')->serialize($entry, 'json');
 284
 285         return (new JsonResponse())->setJson($json);
 286     }
 287
 288     /**
 289      * Reload an entry.
 290      * 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).
 291      *
 292      * @ApiDoc(
 293      *      requirements={
 294      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 295      *      }
 296      * )
 297      *
 298      * @return JsonResponse
 299      */
 300     public function patchEntriesReloadAction(Entry $entry)
 301     {
 302         $this->validateAuthentication();
 303         $this->validateUserAccess($entry->getUser()->getId());
 304
 305         try {
 306             $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
 307         } catch (\Exception $e) {
 308             $this->get('logger')->error('Error while saving an entry', [
 309                 'exception' => $e,
 310                 'entry' => $entry,
 311             ]);
 312
 313             return new JsonResponse([], 304);
 314         }
 315
 316         // if refreshing entry failed, don't save it
 317         if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
 318             return new JsonResponse([], 304);
 319         }
 320
 321         $em = $this->getDoctrine()->getManager();
 322         $em->persist($entry);
 323         $em->flush();
 324
 325         // entry saved, dispatch event about it!
 326         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 327
 328         $json = $this->get('serializer')->serialize($entry, 'json');
 329
 330         return (new JsonResponse())->setJson($json);
 331     }
 332
 333     /**
 334      * Delete **permanently** an entry.
 335      *
 336      * @ApiDoc(
 337      *      requirements={
 338      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 339      *      }
 340      * )
 341      *
 342      * @return JsonResponse
 343      */
 344     public function deleteEntriesAction(Entry $entry)
 345     {
 346         $this->validateAuthentication();
 347         $this->validateUserAccess($entry->getUser()->getId());
 348
 349         $em = $this->getDoctrine()->getManager();
 350         $em->remove($entry);
 351         $em->flush();
 352
 353         // entry deleted, dispatch event about it!
 354         $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 355
 356         $json = $this->get('serializer')->serialize($entry, 'json');
 357
 358         return (new JsonResponse())->setJson($json);
 359     }
 360
 361     /**
 362      * Retrieve all tags for an entry.
 363      *
 364      * @ApiDoc(
 365      *      requirements={
 366      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 367      *      }
 368      * )
 369      *
 370      * @return JsonResponse
 371      */
 372     public function getEntriesTagsAction(Entry $entry)
 373     {
 374         $this->validateAuthentication();
 375         $this->validateUserAccess($entry->getUser()->getId());
 376
 377         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 378
 379         return (new JsonResponse())->setJson($json);
 380     }
 381
 382     /**
 383      * Add one or more tags to an entry.
 384      *
 385      * @ApiDoc(
 386      *      requirements={
 387      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 388      *      },
 389      *      parameters={
 390      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 391      *       }
 392      * )
 393      *
 394      * @return JsonResponse
 395      */
 396     public function postEntriesTagsAction(Request $request, Entry $entry)
 397     {
 398         $this->validateAuthentication();
 399         $this->validateUserAccess($entry->getUser()->getId());
 400
 401         $tags = $request->request->get('tags', '');
 402         if (!empty($tags)) {
 403             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 404         }
 405
 406         $em = $this->getDoctrine()->getManager();
 407         $em->persist($entry);
 408         $em->flush();
 409
 410         $json = $this->get('serializer')->serialize($entry, 'json');
 411
 412         return (new JsonResponse())->setJson($json);
 413     }
 414
 415     /**
 416      * Permanently remove one tag for an entry.
 417      *
 418      * @ApiDoc(
 419      *      requirements={
 420      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 421      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 422      *      }
 423      * )
 424      *
 425      * @return JsonResponse
 426      */
 427     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 428     {
 429         $this->validateAuthentication();
 430         $this->validateUserAccess($entry->getUser()->getId());
 431
 432         $entry->removeTag($tag);
 433         $em = $this->getDoctrine()->getManager();
 434         $em->persist($entry);
 435         $em->flush();
 436
 437         $json = $this->get('serializer')->serialize($entry, 'json');
 438
 439         return (new JsonResponse())->setJson($json);
 440     }
 441 }