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\JsonResponse;
   9 use Wallabag\CoreBundle\Entity\Entry;
  10 use Wallabag\CoreBundle\Entity\Tag;
  11 use Wallabag\CoreBundle\Service\Extractor;
  12
  13 class WallabagRestController extends Controller
  14 {
  15     /**
  16      * @param Entry  $entry
  17      * @param string $tags
  18      */
  19     private function assignTagsToEntry(Entry $entry, $tags)
  20     {
  21         foreach (explode(',', $tags) as $label) {
  22             $label = trim($label);
  23             $tagEntity = $this
  24                 ->getDoctrine()
  25                 ->getRepository('WallabagCoreBundle:Tag')
  26                 ->findOneByLabel($label);
  27
  28             if (is_null($tagEntity)) {
  29                 $tagEntity = new Tag($this->getUser());
  30                 $tagEntity->setLabel($label);
  31             }
  32
  33             // only add the tag on the entry if the relation doesn't exist
  34             if (!$entry->getTags()->contains($tagEntity)) {
  35                 $entry->addTag($tagEntity);
  36             }
  37         }
  38     }
  39
  40     /**
  41      * Retrieve salt for a giver user.
  42      *
  43      * @ApiDoc(
  44      *       parameters={
  45      *          {"name"="username", "dataType"="string", "required"=true, "description"="username"}
  46      *       }
  47      * )
  48      * @return array
  49      */
  50     public function getSaltAction(Request $request)
  51     {
  52         $user = $this
  53             ->getDoctrine()
  54             ->getRepository('WallabagCoreBundle:User')
  55             ->findOneByUsername($request->query->get('username'));
  56
  57         if (is_null($user)) {
  58             throw $this->createNotFoundException();
  59         }
  60
  61         return array($user->getSalt() ?: null);
  62     }
  63     /**
  64      * Retrieve all entries. It could be filtered by many options.
  65      *
  66      * @ApiDoc(
  67      *       parameters={
  68      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
  69      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
  70      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  71      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  72      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  73      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  74      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  75      *       }
  76      * )
  77      * @return Entry
  78      */
  79     public function getEntriesAction(Request $request)
  80     {
  81         $isArchived = $request->query->get('archive');
  82         $isStarred  = $request->query->get('star');
  83         $sort       = $request->query->get('sort', 'created');
  84         $order      = $request->query->get('order', 'desc');
  85         $page       = $request->query->get('page', 1);
  86         $perPage    = $request->query->get('perPage', 30);
  87         $tags       = $request->query->get('tags', array());
  88
  89         $entries = $this
  90             ->getDoctrine()
  91             ->getRepository('WallabagCoreBundle:Entry')
  92             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
  93
  94         if (!($entries)) {
  95             throw $this->createNotFoundException();
  96         }
  97
  98         $json = $this->get('serializer')->serialize($entries, 'json');
  99
 100         return new JsonResponse($json, 200);
 101     }
 102
 103     /**
 104      * Retrieve a single entry
 105      *
 106      * @ApiDoc(
 107      *      requirements={
 108      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 109      *      }
 110      * )
 111      * @return Entry
 112      */
 113     public function getEntryAction(Entry $entry)
 114     {
 115         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 116             throw $this->createAccessDeniedException();
 117         }
 118
 119         $json = $this->get('serializer')->serialize($entry, 'json');
 120
 121         return new JsonResponse($json, 200);
 122     }
 123
 124     /**
 125      * Create an entry
 126      *
 127      * @ApiDoc(
 128      *       parameters={
 129      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
 130      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 131      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 132      *       }
 133      * )
 134      * @return Entry
 135      */
 136     public function postEntriesAction(Request $request)
 137     {
 138         $url = $request->request->get('url');
 139
 140         $content = Extractor::extract($url);
 141         $entry = new Entry($this->getUser());
 142         $entry->setUrl($url);
 143         $entry->setTitle($request->request->get('title') ?: $content->getTitle());
 144         $entry->setContent($content->getBody());
 145
 146         $tags = $request->request->get('tags', '');
 147         if (!empty($tags)) {
 148             $this->assignTagsToEntry($entry, $tags);
 149         }
 150
 151         $em = $this->getDoctrine()->getManager();
 152         $em->persist($entry);
 153         $em->flush();
 154
 155         $json = $this->get('serializer')->serialize($entry, 'json');
 156
 157         return new JsonResponse($json, 200);
 158     }
 159
 160     /**
 161      * Change several properties of an entry
 162      *
 163      * @ApiDoc(
 164      *      requirements={
 165      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 166      *      },
 167      *      parameters={
 168      *          {"name"="title", "dataType"="string", "required"=false},
 169      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 170      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 171      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 172      *      }
 173      * )
 174      * @return Entry
 175      */
 176     public function patchEntriesAction(Entry $entry, Request $request)
 177     {
 178         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 179             throw $this->createAccessDeniedException();
 180         }
 181
 182         $title      = $request->request->get("title");
 183         $isArchived = $request->request->get("archive");
 184         $isStarred  = $request->request->get("star");
 185
 186         if (!is_null($title)) {
 187             $entry->setTitle($title);
 188         }
 189
 190         if (!is_null($isArchived)) {
 191             $entry->setArchived($isArchived);
 192         }
 193
 194         if (!is_null($isStarred)) {
 195             $entry->setStarred($isStarred);
 196         }
 197
 198         $tags = $request->request->get('tags', '');
 199         if (!empty($tags)) {
 200             $this->assignTagsToEntry($entry, $tags);
 201         }
 202
 203         $em = $this->getDoctrine()->getManager();
 204         $em->flush();
 205
 206         $json = $this->get('serializer')->serialize($entry, 'json');
 207
 208         return new JsonResponse($json, 200);
 209     }
 210
 211     /**
 212      * Delete **permanently** an entry
 213      *
 214      * @ApiDoc(
 215      *      requirements={
 216      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 217      *      }
 218      * )
 219      * @return Entry
 220      */
 221     public function deleteEntriesAction(Entry $entry)
 222     {
 223         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 224             throw $this->createAccessDeniedException();
 225         }
 226
 227         $em = $this->getDoctrine()->getManager();
 228         $em->remove($entry);
 229         $em->flush();
 230
 231         $json = $this->get('serializer')->serialize($entry, 'json');
 232
 233         return new JsonResponse($json, 200);
 234     }
 235
 236     /**
 237      * Retrieve all tags for an entry
 238      *
 239      * @ApiDoc(
 240      *      requirements={
 241      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 242      *      }
 243      * )
 244      */
 245     public function getEntriesTagsAction(Entry $entry)
 246     {
 247         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 248             throw $this->createAccessDeniedException();
 249         }
 250
 251         $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
 252
 253         return new JsonResponse($json, 200);
 254     }
 255
 256     /**
 257      * Add one or more tags to an entry
 258      *
 259      * @ApiDoc(
 260      *      requirements={
 261      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 262      *      },
 263      *      parameters={
 264      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 265      *       }
 266      * )
 267      */
 268     public function postEntriesTagsAction(Request $request, Entry $entry)
 269     {
 270         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 271             throw $this->createAccessDeniedException();
 272         }
 273
 274         $tags = $request->request->get('tags', '');
 275         if (!empty($tags)) {
 276             $this->assignTagsToEntry($entry, $tags);
 277         }
 278
 279         $em = $this->getDoctrine()->getManager();
 280         $em->persist($entry);
 281         $em->flush();
 282
 283         $json = $this->get('serializer')->serialize($entry, 'json');
 284
 285         return new JsonResponse($json, 200);
 286     }
 287
 288     /**
 289      * Permanently remove one tag for an entry
 290      *
 291      * @ApiDoc(
 292      *      requirements={
 293      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 294      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 295      *      }
 296      * )
 297      */
 298     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 299     {
 300         if ($entry->getUser()->getId() != $this->getUser()->getId()) {
 301             throw $this->createAccessDeniedException();
 302         }
 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 new JsonResponse($json, 200);
 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 new JsonResponse($json, 200);
 324     }
 325
 326     /**
 327      * Permanently remove one tag from **every** entry
 328      *
 329      * @ApiDoc(
 330      *      requirements={
 331      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 332      *      }
 333      * )
 334      */
 335     public function deleteTagAction(Tag $tag)
 336     {
 337         if ($tag->getUser()->getId() != $this->getUser()->getId()) {
 338             throw $this->createAccessDeniedException();
 339         }
 340
 341         $em = $this->getDoctrine()->getManager();
 342         $em->remove($tag);
 343         $em->flush();
 344
 345         $json = $this->get('serializer')->serialize($tag, 'json');
 346
 347         return new JsonResponse($json, 200);
 348     }
 349 }