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