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