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