src/Wallabag/ApiBundle/Controller/WallabagRestController.php

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