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