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