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\Response;
  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      * Retrieve all entries. It could be filtered by many options.
  27      *
  28      * @ApiDoc(
  29      *       parameters={
  30      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
  31      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
  32      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  33      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  34      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  35      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  36      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  37      *       }
  38      * )
  39      *
  40      * @return Response
  41      */
  42     public function getEntriesAction(Request $request)
  43     {
  44         $this->validateAuthentication();
  45
  46         $isArchived = $request->query->get('archive');
  47         $isStarred = $request->query->get('star');
  48         $sort = $request->query->get('sort', 'created');
  49         $order = $request->query->get('order', 'desc');
  50         $page = (int) $request->query->get('page', 1);
  51         $perPage = (int) $request->query->get('perPage', 30);
  52
  53         $pager = $this->getDoctrine()
  54             ->getRepository('WallabagCoreBundle:Entry')
  55             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
  56
  57         $pager->setCurrentPage($page);
  58         $pager->setMaxPerPage($perPage);
  59
  60         $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
  61         $paginatedCollection = $pagerfantaFactory->createRepresentation(
  62             $pager,
  63             new Route('api_get_entries', [], UrlGeneratorInterface::ABSOLUTE_URL)
  64         );
  65
  66         $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
  67
  68         return $this->renderJsonResponse($json);
  69     }
  70
  71     /**
  72      * Retrieve a single entry.
  73      *
  74      * @ApiDoc(
  75      *      requirements={
  76      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
  77      *      }
  78      * )
  79      *
  80      * @return Response
  81      */
  82     public function getEntryAction(Entry $entry)
  83     {
  84         $this->validateAuthentication();
  85         $this->validateUserAccess($entry->getUser()->getId());
  86
  87         $json = $this->get('serializer')->serialize($entry, 'json');
  88
  89         return $this->renderJsonResponse($json);
  90     }
  91
  92     /**
  93      * Create an entry.
  94      *
  95      * @ApiDoc(
  96      *       parameters={
  97      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
  98      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
  99      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 100      *          {"name"="starred", "dataType"="boolean", "required"=false, "format"="true or false", "description"="entry already starred"},
 101      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="entry already archived"},
 102      *       }
 103      * )
 104      *
 105      * @return Response
 106      */
 107     public function postEntriesAction(Request $request)
 108     {
 109         $this->validateAuthentication();
 110
 111         $url = $request->request->get('url');
 112         $isArchived = $request->request->get('archive');
 113         $isStarred = $request->request->get('starred');
 114
 115         $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 116             new Entry($this->getUser()),
 117             $url
 118         );
 119
 120         $tags = $request->request->get('tags', '');
 121         if (!empty($tags)) {
 122             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 123         }
 124
 125         if (true === (bool) $isStarred) {
 126             $entry->setStarred(true);
 127         }
 128
 129         if (true === (bool) $isArchived) {
 130             $entry->setArchived(true);
 131         }
 132
 133         $em = $this->getDoctrine()->getManager();
 134         $em->persist($entry);
 135
 136         $em->flush();
 137
 138         $json = $this->get('serializer')->serialize($entry, 'json');
 139
 140         return $this->renderJsonResponse($json);
 141     }
 142
 143     /**
 144      * Change several properties of an entry.
 145      *
 146      * @ApiDoc(
 147      *      requirements={
 148      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 149      *      },
 150      *      parameters={
 151      *          {"name"="title", "dataType"="string", "required"=false},
 152      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 153      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 154      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 155      *      }
 156      * )
 157      *
 158      * @return Response
 159      */
 160     public function patchEntriesAction(Entry $entry, Request $request)
 161     {
 162         $this->validateAuthentication();
 163         $this->validateUserAccess($entry->getUser()->getId());
 164
 165         $title = $request->request->get('title');
 166         $isArchived = $request->request->get('archive');
 167         $isStarred = $request->request->get('star');
 168
 169         if (!is_null($title)) {
 170             $entry->setTitle($title);
 171         }
 172
 173         if (!is_null($isArchived)) {
 174             $entry->setArchived($isArchived);
 175         }
 176
 177         if (!is_null($isStarred)) {
 178             $entry->setStarred($isStarred);
 179         }
 180
 181         $tags = $request->request->get('tags', '');
 182         if (!empty($tags)) {
 183             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 184         }
 185
 186         $em = $this->getDoctrine()->getManager();
 187         $em->flush();
 188
 189         $json = $this->get('serializer')->serialize($entry, 'json');
 190
 191         return $this->renderJsonResponse($json);
 192     }
 193
 194     /**
 195      * Delete **permanently** an entry.
 196      *
 197      * @ApiDoc(
 198      *      requirements={
 199      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 200      *      }
 201      * )
 202      *
 203      * @return Response
 204      */
 205     public function deleteEntriesAction(Entry $entry)
 206     {
 207         $this->validateAuthentication();
 208         $this->validateUserAccess($entry->getUser()->getId());
 209
 210         $em = $this->getDoctrine()->getManager();
 211         $em->remove($entry);
 212         $em->flush();
 213
 214         $json = $this->get('serializer')->serialize($entry, 'json');
 215
 216         return $this->renderJsonResponse($json);
 217     }
 218
 219     /**
 220      * Retrieve all tags for an entry.
 221      *
 222      * @ApiDoc(
 223      *      requirements={
 224      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 225      *      }
 226      * )
 227      *
 228      * @return Response
 229      */
 230     public function getEntriesTagsAction(Entry $entry)
 231     {
 232         $this->validateAuthentication();
 233         $this->validateUserAccess($entry->getUser()->getId());
 234
 235         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 236
 237         return $this->renderJsonResponse($json);
 238     }
 239
 240     /**
 241      * Add one or more tags to an entry.
 242      *
 243      * @ApiDoc(
 244      *      requirements={
 245      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 246      *      },
 247      *      parameters={
 248      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 249      *       }
 250      * )
 251      *
 252      * @return Response
 253      */
 254     public function postEntriesTagsAction(Request $request, Entry $entry)
 255     {
 256         $this->validateAuthentication();
 257         $this->validateUserAccess($entry->getUser()->getId());
 258
 259         $tags = $request->request->get('tags', '');
 260         if (!empty($tags)) {
 261             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 262         }
 263
 264         $em = $this->getDoctrine()->getManager();
 265         $em->persist($entry);
 266         $em->flush();
 267
 268         $json = $this->get('serializer')->serialize($entry, 'json');
 269
 270         return $this->renderJsonResponse($json);
 271     }
 272
 273     /**
 274      * Permanently remove one tag for an entry.
 275      *
 276      * @ApiDoc(
 277      *      requirements={
 278      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 279      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 280      *      }
 281      * )
 282      *
 283      * @return Response
 284      */
 285     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 286     {
 287         $this->validateAuthentication();
 288         $this->validateUserAccess($entry->getUser()->getId());
 289
 290         $entry->removeTag($tag);
 291         $em = $this->getDoctrine()->getManager();
 292         $em->persist($entry);
 293         $em->flush();
 294
 295         $json = $this->get('serializer')->serialize($entry, 'json');
 296
 297         return $this->renderJsonResponse($json);
 298     }
 299
 300     /**
 301      * Retrieve all tags.
 302      *
 303      * @ApiDoc()
 304      *
 305      * @return Response
 306      */
 307     public function getTagsAction()
 308     {
 309         $this->validateAuthentication();
 310
 311         $tags = $this->getDoctrine()
 312             ->getRepository('WallabagCoreBundle:Tag')
 313             ->findAllTags($this->getUser()->getId());
 314
 315         $json = $this->get('serializer')->serialize($tags, 'json');
 316
 317         return $this->renderJsonResponse($json);
 318     }
 319
 320     /**
 321      * Permanently remove one tag from **every** entry.
 322      *
 323      * @ApiDoc(
 324      *      requirements={
 325      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
 326      *      }
 327      * )
 328      *
 329      * @return Response
 330      */
 331     public function deleteTagAction(Tag $tag)
 332     {
 333         $this->validateAuthentication();
 334
 335         $this->getDoctrine()
 336             ->getRepository('WallabagCoreBundle:Entry')
 337             ->removeTag($this->getUser()->getId(), $tag);
 338
 339         $json = $this->get('serializer')->serialize($tag, 'json');
 340
 341         return $this->renderJsonResponse($json);
 342     }
 343
 344     /**
 345      * Validate that the first id is equal to the second one.
 346      * If not, throw exception. It means a user try to access information from an other user.
 347      *
 348      * @param int $requestUserId User id from the requested source
 349      */
 350     private function validateUserAccess($requestUserId)
 351     {
 352         $user = $this->get('security.token_storage')->getToken()->getUser();
 353         if ($requestUserId != $user->getId()) {
 354             throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
 355         }
 356     }
 357
 358     /**
 359      * Send a JSON Response.
 360      * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
 361      *
 362      * @param string $json
 363      *
 364      * @return Response
 365      */
 366     private function renderJsonResponse($json)
 367     {
 368         return new Response($json, 200, array('application/json'));
 369     }
 370 }