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         $content = $this->get('wallabag_core.graby')->fetchContent($url);
 150
 151         $entry = new Entry($this->getUser());
 152         $entry->setUrl($content['url'] ?: $url);
 153         $entry->setTitle($request->request->get('title') ?: $content['title']);
 154         $entry->setContent($content['html']);
 155         $entry->setMimetype($content['content_type']);
 156         if (isset($content['open_graph']['og_image'])) {
 157             $entry->setPreviewPicture($content['open_graph']['og_image']);
 158         }
 159
 160         $tags = $request->request->get('tags', '');
 161         if (!empty($tags)) {
 162             $this->assignTagsToEntry($entry, $tags);
 163         }
 164
 165         $em = $this->getDoctrine()->getManager();
 166         $em->persist($entry);
 167         $em->flush();
 168
 169         $json = $this->get('serializer')->serialize($entry, 'json');
 170
 171         return $this->renderJsonResponse($json);
 172     }
 173
 174     /**
 175      * Change several properties of an entry.
 176      *
 177      * @ApiDoc(
 178      *      requirements={
 179      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 180      *      },
 181      *      parameters={
 182      *          {"name"="title", "dataType"="string", "required"=false},
 183      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 184      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 185      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 186      *      }
 187      * )
 188      *
 189      * @return Entry
 190      */
 191     public function patchEntriesAction(Entry $entry, Request $request)
 192     {
 193         $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
 194
 195         $title = $request->request->get('title');
 196         $isArchived = $request->request->get('is_archived');
 197         $isStarred = $request->request->get('is_starred');
 198
 199         if (!is_null($title)) {
 200             $entry->setTitle($title);
 201         }
 202
 203         if (!is_null($isArchived)) {
 204             $entry->setArchived($isArchived);
 205         }
 206
 207         if (!is_null($isStarred)) {
 208             $entry->setStarred($isStarred);
 209         }
 210
 211         $tags = $request->request->get('tags', '');
 212         if (!empty($tags)) {
 213             $this->assignTagsToEntry($entry, $tags);
 214         }
 215
 216         $em = $this->getDoctrine()->getManager();
 217         $em->flush();
 218
 219         $json = $this->get('serializer')->serialize($entry, 'json');
 220
 221         return $this->renderJsonResponse($json);
 222     }
 223
 224     /**
 225      * Delete **permanently** an entry.
 226      *
 227      * @ApiDoc(
 228      *      requirements={
 229      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 230      *      }
 231      * )
 232      *
 233      * @return Entry
 234      */
 235     public function deleteEntriesAction(Entry $entry)
 236     {
 237         $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
 238
 239         $em = $this->getDoctrine()->getManager();
 240         $em->remove($entry);
 241         $em->flush();
 242
 243         $json = $this->get('serializer')->serialize($entry, 'json');
 244
 245         return $this->renderJsonResponse($json);
 246     }
 247
 248     /**
 249      * Retrieve all tags for an entry.
 250      *
 251      * @ApiDoc(
 252      *      requirements={
 253      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 254      *      }
 255      * )
 256      */
 257     public function getEntriesTagsAction(Entry $entry)
 258     {
 259         $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
 260
 261         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 262
 263         return $this->renderJsonResponse($json);
 264     }
 265
 266     /**
 267      * Add one or more tags to an entry.
 268      *
 269      * @ApiDoc(
 270      *      requirements={
 271      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 272      *      },
 273      *      parameters={
 274      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 275      *       }
 276      * )
 277      */
 278     public function postEntriesTagsAction(Request $request, Entry $entry)
 279     {
 280         $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
 281
 282         $tags = $request->request->get('tags', '');
 283         if (!empty($tags)) {
 284             $this->assignTagsToEntry($entry, $tags);
 285         }
 286
 287         $em = $this->getDoctrine()->getManager();
 288         $em->persist($entry);
 289         $em->flush();
 290
 291         $json = $this->get('serializer')->serialize($entry, 'json');
 292
 293         return $this->renderJsonResponse($json);
 294     }
 295
 296     /**
 297      * Permanently remove one tag for an entry.
 298      *
 299      * @ApiDoc(
 300      *      requirements={
 301      *          {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
 302      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 303      *      }
 304      * )
 305      */
 306     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 307     {
 308         $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
 309
 310         $entry->removeTag($tag);
 311         $em = $this->getDoctrine()->getManager();
 312         $em->persist($entry);
 313         $em->flush();
 314
 315         $json = $this->get('serializer')->serialize($entry, 'json');
 316
 317         return $this->renderJsonResponse($json);
 318     }
 319
 320     /**
 321      * Retrieve all tags.
 322      *
 323      * @ApiDoc()
 324      */
 325     public function getTagsAction()
 326     {
 327         $json = $this->get('serializer')->serialize($this->getUser()->getTags(), '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     public function deleteTagAction(Tag $tag)
 342     {
 343         $this->validateUserAccess($tag->getUser()->getId(), $this->getUser()->getId());
 344
 345         $em = $this->getDoctrine()->getManager();
 346         $em->remove($tag);
 347         $em->flush();
 348
 349         $json = $this->get('serializer')->serialize($tag, 'json');
 350
 351         return $this->renderJsonResponse($json);
 352     }
 353
 354     /**
 355      * Validate that the first id is equal to the second one.
 356      * If not, throw exception. It means a user try to access information from an other user.
 357      *
 358      * @param int $requestUserId User id from the requested source
 359      * @param int $currentUserId User id from the retrieved source
 360      */
 361     private function validateUserAccess($requestUserId, $currentUserId)
 362     {
 363         if ($requestUserId != $currentUserId) {
 364             throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$currentUserId);
 365         }
 366     }
 367
 368     /**
 369      * Send a JSON Response.
 370      * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
 371      *
 372      * @param string $json
 373      *
 374      * @return Response
 375      */
 376     private function renderJsonResponse($json)
 377     {
 378         return new Response($json, 200, array('application/json'));
 379     }
 380 }