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      *          {"name"="content", "dataType"="string", "required"=false, "format"="content", "description"="content you want to pass directly"},
 103      *       }
 104      * )
 105      *
 106      * @return Response
 107      */
 108     public function postEntriesAction(Request $request)
 109     {
 110         $this->validateAuthentication();
 111
 112         $url = $request->request->get('url');
 113         $content = $request->request->get('content');
 114         $isArchived = $request->request->get('archive');
 115         $isStarred = $request->request->get('starred');
 116
 117         $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
 118             new Entry($this->getUser()),
 119             $url
 120         );
 121
 122         $tags = $request->request->get('tags', '');
 123         if (!empty($tags)) {
 124             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 125         }
 126
 127         if (!empty($isStarred)) {
 128             $entry->setStarred($isStarred);
 129         }
 130
 131         if (!empty($isArchived)) {
 132             $entry->setArchived($isArchived);
 133         }
 134
 135         if (!empty($content)) {
 136             $entry->setContent($content);
 137         }
 138
 139         $em = $this->getDoctrine()->getManager();
 140         $em->persist($entry);
 141
 142         $em->flush();
 143
 144         $json = $this->get('serializer')->serialize($entry, 'json');
 145
 146         return $this->renderJsonResponse($json);
 147     }
 148
 149     /**
 150      * Change several properties of an entry.
 151      *
 152      * @ApiDoc(
 153      *      requirements={
 154      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 155      *      },
 156      *      parameters={
 157      *          {"name"="title", "dataType"="string", "required"=false},
 158      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 159      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 160      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 161      *      }
 162      * )
 163      *
 164      * @return Response
 165      */
 166     public function patchEntriesAction(Entry $entry, Request $request)
 167     {
 168         $this->validateAuthentication();
 169         $this->validateUserAccess($entry->getUser()->getId());
 170
 171         $title = $request->request->get('title');
 172         $isArchived = $request->request->get('archive');
 173         $isStarred = $request->request->get('star');
 174
 175         if (!is_null($title)) {
 176             $entry->setTitle($title);
 177         }
 178
 179         if (!is_null($isArchived)) {
 180             $entry->setArchived($isArchived);
 181         }
 182
 183         if (!is_null($isStarred)) {
 184             $entry->setStarred($isStarred);
 185         }
 186
 187         $tags = $request->request->get('tags', '');
 188         if (!empty($tags)) {
 189             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 190         }
 191
 192         $em = $this->getDoctrine()->getManager();
 193         $em->flush();
 194
 195         $json = $this->get('serializer')->serialize($entry, 'json');
 196
 197         return $this->renderJsonResponse($json);
 198     }
 199
 200     /**
 201      * Delete **permanently** an entry.
 202      *
 203      * @ApiDoc(
 204      *      requirements={
 205      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 206      *      }
 207      * )
 208      *
 209      * @return Response
 210      */
 211     public function deleteEntriesAction(Entry $entry)
 212     {
 213         $this->validateAuthentication();
 214         $this->validateUserAccess($entry->getUser()->getId());
 215
 216         $em = $this->getDoctrine()->getManager();
 217         $em->remove($entry);
 218         $em->flush();
 219
 220         $json = $this->get('serializer')->serialize($entry, 'json');
 221
 222         return $this->renderJsonResponse($json);
 223     }
 224
 225     /**
 226      * Retrieve all tags for an entry.
 227      *
 228      * @ApiDoc(
 229      *      requirements={
 230      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 231      *      }
 232      * )
 233      *
 234      * @return Response
 235      */
 236     public function getEntriesTagsAction(Entry $entry)
 237     {
 238         $this->validateAuthentication();
 239         $this->validateUserAccess($entry->getUser()->getId());
 240
 241         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 242
 243         return $this->renderJsonResponse($json);
 244     }
 245
 246     /**
 247      * Add one or more tags to an entry.
 248      *
 249      * @ApiDoc(
 250      *      requirements={
 251      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 252      *      },
 253      *      parameters={
 254      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 255      *       }
 256      * )
 257      *
 258      * @return Response
 259      */
 260     public function postEntriesTagsAction(Request $request, Entry $entry)
 261     {
 262         $this->validateAuthentication();
 263         $this->validateUserAccess($entry->getUser()->getId());
 264
 265         $tags = $request->request->get('tags', '');
 266         if (!empty($tags)) {
 267             $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
 268         }
 269
 270         $em = $this->getDoctrine()->getManager();
 271         $em->persist($entry);
 272         $em->flush();
 273
 274         $json = $this->get('serializer')->serialize($entry, 'json');
 275
 276         return $this->renderJsonResponse($json);
 277     }
 278
 279     /**
 280      * Permanently remove one tag for an entry.
 281      *
 282      * @ApiDoc(
 283      *      requirements={
 284      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 285      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 286      *      }
 287      * )
 288      *
 289      * @return Response
 290      */
 291     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 292     {
 293         $this->validateAuthentication();
 294         $this->validateUserAccess($entry->getUser()->getId());
 295
 296         $entry->removeTag($tag);
 297         $em = $this->getDoctrine()->getManager();
 298         $em->persist($entry);
 299         $em->flush();
 300
 301         $json = $this->get('serializer')->serialize($entry, 'json');
 302
 303         return $this->renderJsonResponse($json);
 304     }
 305
 306     /**
 307      * Retrieve all tags.
 308      *
 309      * @ApiDoc()
 310      *
 311      * @return Response
 312      */
 313     public function getTagsAction()
 314     {
 315         $this->validateAuthentication();
 316
 317         $tags = $this->getDoctrine()
 318             ->getRepository('WallabagCoreBundle:Tag')
 319             ->findAllTags($this->getUser()->getId());
 320
 321         $json = $this->get('serializer')->serialize($tags, 'json');
 322
 323         return $this->renderJsonResponse($json);
 324     }
 325
 326     /**
 327      * Permanently remove one tag from **every** entry.
 328      *
 329      * @ApiDoc(
 330      *      requirements={
 331      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
 332      *      }
 333      * )
 334      *
 335      * @return Response
 336      */
 337     public function deleteTagAction(Tag $tag)
 338     {
 339         $this->validateAuthentication();
 340
 341         $this->getDoctrine()
 342             ->getRepository('WallabagCoreBundle:Entry')
 343             ->removeTag($this->getUser()->getId(), $tag);
 344
 345         $json = $this->get('serializer')->serialize($tag, 'json');
 346
 347         return $this->renderJsonResponse($json);
 348     }
 349
 350     /**
 351      * Validate that the first id is equal to the second one.
 352      * If not, throw exception. It means a user try to access information from an other user.
 353      *
 354      * @param int $requestUserId User id from the requested source
 355      */
 356     private function validateUserAccess($requestUserId)
 357     {
 358         $user = $this->get('security.token_storage')->getToken()->getUser();
 359         if ($requestUserId != $user->getId()) {
 360             throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
 361         }
 362     }
 363
 364     /**
 365      * Send a JSON Response.
 366      * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
 367      *
 368      * @param string $json
 369      *
 370      * @return Response
 371      */
 372     private function renderJsonResponse($json)
 373     {
 374         return new Response($json, 200, array('application/json'));
 375     }
 376 }