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