src/Wallabag/CoreBundle/Controller/WallabagRestController.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\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 Wallabag\CoreBundle\Service\Extractor;
  12 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  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      * @return array
  50      */
  51     public function getSaltAction($username)
  52     {
  53         $user = $this
  54             ->getDoctrine()
  55             ->getRepository('WallabagCoreBundle:User')
  56             ->findOneByUsername($username);
  57
  58         if (is_null($user)) {
  59             throw $this->createNotFoundException();
  60         }
  61
  62         return array($user->getSalt() ?: null);
  63     }
  64     /**
  65      * Retrieve all entries. It could be filtered by many options.
  66      *
  67      * @ApiDoc(
  68      *       parameters={
  69      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
  70      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
  71      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  72      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  73      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  74      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  75      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  76      *       }
  77      * )
  78      * @return Entry
  79      */
  80     public function getEntriesAction(Request $request)
  81     {
  82         $isArchived = $request->query->get('archive');
  83         $isStarred  = $request->query->get('star');
  84         $sort       = $request->query->get('sort', 'created');
  85         $order      = $request->query->get('order', 'desc');
  86         $page       = $request->query->get('page', 1);
  87         $perPage    = $request->query->get('perPage', 30);
  88         $tags       = $request->query->get('tags', array());
  89
  90         $entries = $this
  91             ->getDoctrine()
  92             ->getRepository('WallabagCoreBundle:Entry')
  93             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
  94
  95         if (!($entries)) {
  96             throw $this->createNotFoundException();
  97         }
  98
  99         $json = $this->get('serializer')->serialize($entries, 'json');
 100
 101         return new Response($json, 200, array('application/json'));
 102     }
 103
 104     /**
 105      * Retrieve a single entry
 106      *
 107      * @ApiDoc(
 108      *      requirements={
 109      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 110      *      }
 111      * )
 112      * @return Entry
 113      */
 114     public function getEntryAction(Entry $entry)
 115     {
 116         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 117             throw $this->createAccessDeniedException();
 118         }
 119
 120         $json = $this->get('serializer')->serialize($entry, 'json');
 121
 122         return new Response($json, 200, array('application/json'));
 123     }
 124
 125     /**
 126      * Create an entry
 127      *
 128      * @ApiDoc(
 129      *       parameters={
 130      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 131      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 132      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 133      *       }
 134      * )
 135      * @return Entry
 136      */
 137     public function postEntriesAction(Request $request)
 138     {
 139         $url = $request->request->get('url');
 140
 141         $content = Extractor::extract($url);
 142         $entry = new Entry($this->getUser());
 143         $entry->setUrl($url);
 144         $entry->setTitle($request->request->get('title') ?: $content->getTitle());
 145         $entry->setContent($content->getBody());
 146
 147         $this->assignTagsToEntry($entry, $request->request->get('tags', array()));
 148
 149         $em = $this->getDoctrine()->getManager();
 150         $em->persist($entry);
 151         $em->flush();
 152
 153         $json = $this->get('serializer')->serialize($entry, 'json');
 154
 155         return new Response($json, 200, array('application/json'));
 156     }
 157
 158     /**
 159      * Change several properties of an entry
 160      *
 161      * @ApiDoc(
 162      *      requirements={
 163      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 164      *      },
 165      *      parameters={
 166      *          {"name"="title", "dataType"="string", "required"=false},
 167      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 168      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 169      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 170      *      }
 171      * )
 172      * @return Entry
 173      */
 174     public function patchEntriesAction(Entry $entry, Request $request)
 175     {
 176         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 177             throw $this->createAccessDeniedException();
 178         }
 179
 180         $title      = $request->request->get("title");
 181         $isArchived = $request->request->get("archive");
 182         $isStarred  = $request->request->get("star");
 183
 184         if (!is_null($title)) {
 185             $entry->setTitle($title);
 186         }
 187
 188         if (!is_null($isArchived)) {
 189             $entry->setArchived($isArchived);
 190         }
 191
 192         if (!is_null($isStarred)) {
 193             $entry->setStarred($isStarred);
 194         }
 195
 196         $this->assignTagsToEntry($entry, $request->request->get('tags', array()));
 197
 198         $em = $this->getDoctrine()->getManager();
 199         $em->flush();
 200
 201         return $entry;
 202     }
 203
 204     /**
 205      * Delete **permanently** an entry
 206      *
 207      * @ApiDoc(
 208      *      requirements={
 209      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 210      *      }
 211      * )
 212      * @return Entry
 213      */
 214     public function deleteEntriesAction(Entry $entry)
 215     {
 216         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 217             throw $this->createAccessDeniedException();
 218         }
 219
 220         $em = $this->getDoctrine()->getManager();
 221         $em->remove($entry);
 222         $em->flush();
 223
 224         $json = $this->get('serializer')->serialize($entry, 'json');
 225
 226         return new Response($json, 200, array('application/json'));
 227     }
 228
 229     /**
 230      * Retrieve all tags for an entry
 231      *
 232      * @ApiDoc(
 233      *      requirements={
 234      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 235      *      }
 236      * )
 237      */
 238     public function getEntriesTagsAction(Entry $entry)
 239     {
 240         var_dump($entry->getUser()->getId());
 241         var_dump($this->getUser()->getId());
 242         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 243             throw $this->createAccessDeniedException();
 244         }
 245
 246         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 247
 248         return new Response($json, 200, array('application/json'));
 249     }
 250
 251     /**
 252      * Add one or more tags to an entry
 253      *
 254      * @ApiDoc(
 255      *      requirements={
 256      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 257      *      },
 258      *      parameters={
 259      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 260      *       }
 261      * )
 262      */
 263     public function postEntriesTagsAction(Request $request, Entry $entry)
 264     {
 265         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 266             throw $this->createAccessDeniedException();
 267         }
 268
 269         $this->assignTagsToEntry($entry, $request->request->get('tags', array()));
 270
 271         $em = $this->getDoctrine()->getManager();
 272         $em->persist($entry);
 273         $em->flush();
 274
 275         $json = $this->get('serializer')->serialize($entry, 'json');
 276
 277         return new Response($json, 200, array('application/json'));
 278     }
 279
 280     /**
 281      * Permanently remove one tag for an entry
 282      *
 283      * @ApiDoc(
 284      *      requirements={
 285      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 286      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 287      *      }
 288      * )
 289      */
 290     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 291     {
 292         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 293             throw $this->createAccessDeniedException();
 294         }
 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 new Response($json, 200, array('application/json'));
 304     }
 305
 306     /**
 307      * Retrieve all tags
 308      *
 309      * @ApiDoc()
 310      */
 311     public function getTagsAction()
 312     {
 313         $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
 314
 315         return new Response($json, 200, array('application/json'));
 316     }
 317
 318     /**
 319      * Permanently remove one tag from **every** entry
 320      *
 321      * @ApiDoc(
 322      *      requirements={
 323      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 324      *      }
 325      * )
 326      */
 327     public function deleteTagAction(Tag $tag)
 328     {
 329         if ($tag->getUser()->getId() != $this->getUser()->getId()) {
 330             throw $this->createAccessDeniedException();
 331         }
 332
 333         $em = $this->getDoctrine()->getManager();
 334         $em->remove($tag);
 335         $em->flush();
 336
 337         $json = $this->get('serializer')->serialize($tag, 'json');
 338
 339         return new Response($json, 200, array('application/json'));
 340     }
 341 }