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\HttpKernel\Exception\NotFoundHttpException;
   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"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted 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         $isDeleted  = $request->query->get('delete', 0);
  60         $sort       = $request->query->get('sort', 'created');
  61         $order      = $request->query->get('order', 'desc');
  62         $page       = $request->query->get('page', 1);
  63         $perPage    = $request->query->get('perPage', 30);
  64         $tags       = $request->query->get('tags', array());
  65
  66         $entries = $this
  67             ->getDoctrine()
  68             ->getRepository('WallabagCoreBundle:Entry')
  69             ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order);
  70
  71         if (!($entries)) {
  72             throw $this->createNotFoundException();
  73         }
  74
  75         return $entries;
  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         return $entry;
  91     }
  92
  93     /**
  94      * Create an entry
  95      *
  96      * @ApiDoc(
  97      *       parameters={
  98      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
  99      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
 100      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 101      *       }
 102      * )
 103      * @return Entry
 104      */
 105     public function postEntriesAction(Request $request)
 106     {
 107         //TODO gérer si on passe les tags
 108         $url = $request->request->get('url');
 109
 110         $content = Extractor::extract($url);
 111         $entry = new Entry($this->getUser());
 112         $entry->setUrl($url);
 113         $entry->setTitle($request->request->get('title') ?: $content->getTitle());
 114         $entry->setContent($content->getBody());
 115         $em = $this->getDoctrine()->getManager();
 116         $em->persist($entry);
 117         $em->flush();
 118
 119         return $entry;
 120     }
 121
 122     /**
 123      * Change several properties of an entry
 124      *
 125      * @ApiDoc(
 126      *      requirements={
 127      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 128      *      },
 129      *      parameters={
 130      *          {"name"="title", "dataType"="string", "required"=false},
 131      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 132      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 133      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 134      *          {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
 135      *       }
 136      * )
 137      * @return Entry
 138      */
 139     public function patchEntriesAction(Entry $entry, Request $request)
 140     {
 141         $title      = $request->request->get("title");
 142         $tags       = $request->request->get("tags", array());
 143         $isArchived = $request->request->get("archive");
 144         $isDeleted  = $request->request->get("delete");
 145         $isStarred  = $request->request->get("star");
 146
 147         if (!is_null($title)) {
 148             $entry->setTitle($title);
 149         }
 150
 151         if (!is_null($isArchived)) {
 152             $entry->setArchived($isArchived);
 153         }
 154
 155         if (!is_null($isDeleted)) {
 156             $entry->setDeleted($isDeleted);
 157         }
 158
 159         if (!is_null($isStarred)) {
 160             $entry->setStarred($isStarred);
 161         }
 162
 163         $em = $this->getDoctrine()->getManager();
 164         $em->flush();
 165
 166         return $entry;
 167     }
 168
 169     /**
 170      * Delete **permanently** an entry
 171      *
 172      * @ApiDoc(
 173      *      requirements={
 174      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 175      *      }
 176      * )
 177      * @return Entry
 178      */
 179     public function deleteEntriesAction(Entry $entry)
 180     {
 181         if ($entry->isDeleted()) {
 182             throw new NotFoundHttpException('This entry is already deleted');
 183         }
 184
 185         $em = $this->getDoctrine()->getManager();
 186         $entry->setDeleted(1);
 187         $em->flush();
 188
 189         return $entry;
 190     }
 191
 192     /**
 193      * Retrieve all tags for an entry
 194      *
 195      * @ApiDoc(
 196      *      requirements={
 197      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 198      *      }
 199      * )
 200      */
 201     public function getEntriesTagsAction(Entry $entry)
 202     {
 203     }
 204
 205     /**
 206      * Add one or more tags to an entry
 207      *
 208      * @ApiDoc(
 209      *      requirements={
 210      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 211      *      },
 212      *      parameters={
 213      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 214      *       }
 215      * )
 216      */
 217     public function postEntriesTagsAction(Entry $entry)
 218     {
 219     }
 220
 221     /**
 222      * Permanently remove one tag for an entry
 223      *
 224      * @ApiDoc(
 225      *      requirements={
 226      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 227      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 228      *      }
 229      * )
 230      */
 231     public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
 232     {
 233     }
 234
 235     /**
 236      * Retrieve all tags
 237      *
 238      * @ApiDoc(
 239      * )
 240      */
 241     public function getTagsAction()
 242     {
 243     }
 244
 245     /**
 246      * Retrieve a single tag
 247      *
 248      * @ApiDoc(
 249      *       requirements={
 250      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 251      *       }
 252      * )
 253      */
 254     public function getTagAction(Tag $tag)
 255     {
 256     }
 257
 258     /**
 259      * Permanently remove one tag from **every** entry
 260      *
 261      * @ApiDoc(
 262      *      requirements={
 263      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 264      *      }
 265      * )
 266      */
 267     public function deleteTagAction(Tag $tag)
 268     {
 269     }
 270 }