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\Entries;
  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 Entries
  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:Entries')
  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 Entries
  64      */
  65     public function getEntryAction(Entries $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      */
  81     public function postEntriesAction(Request $request)
  82     {
  83         //TODO gérer si on passe les tags
  84         $url = $request->request->get('url');
  85
  86         $content = Extractor::extract($url);
  87         $entry = new Entries();
  88         $entry->setUserId(1);
  89         $entry->setUrl($url);
  90         $entry->setTitle($request->request->get('title') ?: $content->getTitle());
  91         $entry->setContent($content->getBody());
  92         $em = $this->getDoctrine()->getManager();
  93         $em->persist($entry);
  94         $em->flush();
  95
  96         return $entry;
  97     }
  98
  99     /**
 100      * Change several properties of an entry
 101      *
 102      * @ApiDoc(
 103      *      requirements={
 104      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 105      *      },
 106      *      parameters={
 107      *          {"name"="title", "dataType"="string", "required"=false},
 108      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 109      *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
 110      *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
 111      *          {"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.."},
 112      *       }
 113      * )
 114      */
 115     public function patchEntriesAction(Entries $entry, Request $request)
 116     {
 117         $title      = $request->request->get("title");
 118         $tags       = $request->request->get("tags", array());
 119         $isArchived = $request->request->get("archive");
 120         $isDeleted  = $request->request->get("delete");
 121         $isStarred  = $request->request->get("star");
 122
 123         if (!is_null($title)) {
 124             $entry->setTitle($title);
 125         }
 126
 127         if (!is_null($isArchived)) {
 128             $entry->setRead($isArchived);
 129         }
 130
 131         if (!is_null($isDeleted)) {
 132             $entry->setDeleted($isDeleted);
 133         }
 134
 135         if (!is_null($isStarred)) {
 136             $entry->setFav($isStarred);
 137         }
 138
 139         $em = $this->getDoctrine()->getManager();
 140         $em->flush();
 141
 142         return $entry;
 143     }
 144
 145     /**
 146      * Delete **permanently** an entry
 147      *
 148      * @ApiDoc(
 149      *      requirements={
 150      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 151      *      }
 152      * )
 153      */
 154     public function deleteEntriesAction(Entries $entry)
 155     {
 156         if ($entry->isDeleted()) {
 157             throw new NotFoundHttpException('This entry is already deleted');
 158         }
 159
 160         $em = $this->getDoctrine()->getManager();
 161         $entry->setDeleted(1);
 162         $em->flush();
 163
 164         return $entry;
 165     }
 166
 167     /**
 168      * Retrieve all tags for an entry
 169      *
 170      * @ApiDoc(
 171      *      requirements={
 172      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 173      *      }
 174      * )
 175      */
 176     public function getEntriesTagsAction(Entries $entry)
 177     {
 178     }
 179
 180     /**
 181      * Add one or more tags to an entry
 182      *
 183      * @ApiDoc(
 184      *      requirements={
 185      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 186      *      },
 187      *      parameters={
 188      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 189      *       }
 190      * )
 191      */
 192     public function postEntriesTagsAction(Entries $entry)
 193     {
 194     }
 195
 196     /**
 197      * Permanently remove one tag for an entry
 198      *
 199      * @ApiDoc(
 200      *      requirements={
 201      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 202      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 203      *      }
 204      * )
 205      */
 206     public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
 207     {
 208     }
 209
 210     /**
 211      * Retrieve all tags
 212      *
 213      * @ApiDoc(
 214      * )
 215      */
 216     public function getTagsAction()
 217     {
 218     }
 219
 220     /**
 221      * Retrieve a single tag
 222      *
 223      * @ApiDoc(
 224      *       requirements={
 225      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 226      *       }
 227      * )
 228      */
 229     public function getTagAction(Tags $tag)
 230     {
 231     }
 232
 233     /**
 234      * Permanently remove one tag from **every** entry
 235      *
 236      * @ApiDoc(
 237      *      requirements={
 238      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 239      *      }
 240      * )
 241      */
 242     public function deleteTagAction(Tags $tag)
 243     {
 244     }
 245 }