3 namespace Wallabag\ApiBundle\Controller
;
5 use FOS\RestBundle\Controller\FOSRestController
;
6 use Hateoas\Configuration\Route
;
7 use Hateoas\Representation\Factory\PagerfantaFactory
;
8 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
9 use Symfony\Component\HttpFoundation\Request
;
10 use Symfony\Component\HttpFoundation\Response
;
11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
12 use Symfony\Component\Security\Core\Exception\AccessDeniedException
;
13 use Wallabag\CoreBundle\Entity\Entry
;
14 use Wallabag\CoreBundle\Entity\Tag
;
16 class WallabagRestController
extends FOSRestController
18 private function validateAuthentication()
20 if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) {
21 throw new AccessDeniedException();
26 * Retrieve all entries. It could be filtered by many options.
30 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
31 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
32 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
33 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
34 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
35 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
36 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
42 public function getEntriesAction(Request
$request)
44 $this->validateAuthentication();
46 $isArchived = (int) $request->query
->get('archive');
47 $isStarred = (int) $request->query
->get('starred');
48 $sort = $request->query
->get('sort', 'created');
49 $order = $request->query
->get('order', 'desc');
50 $page = (int) $request->query
->get('page', 1);
51 $perPage = (int) $request->query
->get('perPage', 30);
53 $pager = $this->getDoctrine()
54 ->getRepository('WallabagCoreBundle:Entry')
55 ->findEntries($this->getUser()->getId(), (bool) $isArchived, (bool) $isStarred, $sort, $order);
57 $pager->setCurrentPage($page);
58 $pager->setMaxPerPage($perPage);
60 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
61 $paginatedCollection = $pagerfantaFactory->createRepresentation(
63 new Route('api_get_entries', [], UrlGeneratorInterface
::ABSOLUTE_URL
)
66 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
68 return $this->renderJsonResponse($json);
72 * Retrieve a single entry.
76 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
82 public function getEntryAction(Entry
$entry)
84 $this->validateAuthentication();
85 $this->validateUserAccess($entry->getUser()->getId());
87 $json = $this->get('serializer')->serialize($entry, 'json');
89 return $this->renderJsonResponse($json);
97 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
98 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
99 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
100 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
101 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
107 public function postEntriesAction(Request
$request)
109 $this->validateAuthentication();
111 $url = $request->request
->get('url');
112 $isArchived = (int) $request->request
->get('archive');
113 $isStarred = (int) $request->request
->get('starred');
115 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
117 if (false === $entry) {
118 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
119 new Entry($this->getUser()),
124 $tags = $request->request
->get('tags', '');
126 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
129 if (!is_null($isStarred)) {
130 $entry->setStarred((bool) $isStarred);
133 if (!is_null($isArchived)) {
134 $entry->setArchived((bool) $isArchived);
137 $em = $this->getDoctrine()->getManager();
138 $em->persist($entry);
142 $json = $this->get('serializer')->serialize($entry, 'json');
144 return $this->renderJsonResponse($json);
148 * Change several properties of an entry.
152 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
155 * {"name"="title", "dataType"="string", "required"=false},
156 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
157 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
158 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
164 public function patchEntriesAction(Entry
$entry, Request
$request)
166 $this->validateAuthentication();
167 $this->validateUserAccess($entry->getUser()->getId());
169 $title = $request->request
->get('title');
170 $isArchived = (int) $request->request
->get('archive');
171 $isStarred = (int) $request->request
->get('starred');
173 if (!is_null($title)) {
174 $entry->setTitle($title);
177 if (!is_null($isArchived)) {
178 $entry->setArchived((bool) $isArchived);
181 if (!is_null($isStarred)) {
182 $entry->setStarred((bool) $isStarred);
185 $tags = $request->request
->get('tags', '');
187 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
190 $em = $this->getDoctrine()->getManager();
193 $json = $this->get('serializer')->serialize($entry, 'json');
195 return $this->renderJsonResponse($json);
199 * Delete **permanently** an entry.
203 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
209 public function deleteEntriesAction(Entry
$entry)
211 $this->validateAuthentication();
212 $this->validateUserAccess($entry->getUser()->getId());
214 $em = $this->getDoctrine()->getManager();
218 $json = $this->get('serializer')->serialize($entry, 'json');
220 return $this->renderJsonResponse($json);
224 * Retrieve all tags for an entry.
228 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
234 public function getEntriesTagsAction(Entry
$entry)
236 $this->validateAuthentication();
237 $this->validateUserAccess($entry->getUser()->getId());
239 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
241 return $this->renderJsonResponse($json);
245 * Add one or more tags to an entry.
249 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
252 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
258 public function postEntriesTagsAction(Request
$request, Entry
$entry)
260 $this->validateAuthentication();
261 $this->validateUserAccess($entry->getUser()->getId());
263 $tags = $request->request
->get('tags', '');
265 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
268 $em = $this->getDoctrine()->getManager();
269 $em->persist($entry);
272 $json = $this->get('serializer')->serialize($entry, 'json');
274 return $this->renderJsonResponse($json);
278 * Permanently remove one tag for an entry.
282 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
283 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
289 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
291 $this->validateAuthentication();
292 $this->validateUserAccess($entry->getUser()->getId());
294 $entry->removeTag($tag);
295 $em = $this->getDoctrine()->getManager();
296 $em->persist($entry);
299 $json = $this->get('serializer')->serialize($entry, 'json');
301 return $this->renderJsonResponse($json);
311 public function getTagsAction()
313 $this->validateAuthentication();
315 $tags = $this->getDoctrine()
316 ->getRepository('WallabagCoreBundle:Tag')
317 ->findAllTags($this->getUser()->getId());
319 $json = $this->get('serializer')->serialize($tags, 'json');
321 return $this->renderJsonResponse($json);
325 * Permanently remove one tag from **every** entry.
329 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
335 public function deleteTagAction(Tag
$tag)
337 $this->validateAuthentication();
340 ->getRepository('WallabagCoreBundle:Entry')
341 ->removeTag($this->getUser()->getId(), $tag);
343 $json = $this->get('serializer')->serialize($tag, 'json');
345 return $this->renderJsonResponse($json);
348 * Retrieve version number.
354 public function getVersionAction()
356 $version = $this->container
->getParameter('wallabag_core.version');
358 $json = $this->get('serializer')->serialize($version, 'json');
360 return $this->renderJsonResponse($json);
364 * Validate that the first id is equal to the second one.
365 * If not, throw exception. It means a user try to access information from an other user.
367 * @param int $requestUserId User id from the requested source
369 private function validateUserAccess($requestUserId)
371 $user = $this->get('security.token_storage')->getToken()->getUser();
372 if ($requestUserId != $user->getId()) {
373 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
378 * Send a JSON Response.
379 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
381 * @param string $json
385 private function renderJsonResponse($json)
387 return new Response($json, 200, array('application/json'));