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