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"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
31 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, 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%2Crest", "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 = $request->query
->get('archive');
47 $isStarred = $request->query
->get('star');
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(), $isArchived, $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"="boolean", "required"=false, "format"="true or false", "description"="entry already starred"},
101 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="entry already archived"},
107 public function postEntriesAction(Request
$request)
109 $this->validateAuthentication();
111 $url = $request->request
->get('url');
112 $isArchived = $request->request
->get('archive');
113 $isStarred = $request->request
->get('starred');
115 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
116 new Entry($this->getUser()),
120 $tags = $request->request
->get('tags', '');
122 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
125 if (true === (bool) $isStarred) {
126 $entry->setStarred(true);
129 if (true === (bool) $isArchived) {
130 $entry->setArchived(true);
133 $em = $this->getDoctrine()->getManager();
134 $em->persist($entry);
138 $json = $this->get('serializer')->serialize($entry, 'json');
140 return $this->renderJsonResponse($json);
144 * Change several properties of an entry.
148 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
151 * {"name"="title", "dataType"="string", "required"=false},
152 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
153 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
154 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
160 public function patchEntriesAction(Entry
$entry, Request
$request)
162 $this->validateAuthentication();
163 $this->validateUserAccess($entry->getUser()->getId());
165 $title = $request->request
->get('title');
166 $isArchived = $request->request
->get('archive');
167 $isStarred = $request->request
->get('star');
169 if (!is_null($title)) {
170 $entry->setTitle($title);
173 if (!is_null($isArchived)) {
174 $entry->setArchived($isArchived);
177 if (!is_null($isStarred)) {
178 $entry->setStarred($isStarred);
181 $tags = $request->request
->get('tags', '');
183 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
186 $em = $this->getDoctrine()->getManager();
189 $json = $this->get('serializer')->serialize($entry, 'json');
191 return $this->renderJsonResponse($json);
195 * Delete **permanently** an entry.
199 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
205 public function deleteEntriesAction(Entry
$entry)
207 $this->validateAuthentication();
208 $this->validateUserAccess($entry->getUser()->getId());
210 $em = $this->getDoctrine()->getManager();
214 $json = $this->get('serializer')->serialize($entry, 'json');
216 return $this->renderJsonResponse($json);
220 * Retrieve all tags for an entry.
224 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
230 public function getEntriesTagsAction(Entry
$entry)
232 $this->validateAuthentication();
233 $this->validateUserAccess($entry->getUser()->getId());
235 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
237 return $this->renderJsonResponse($json);
241 * Add one or more tags to an entry.
245 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
248 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
254 public function postEntriesTagsAction(Request
$request, Entry
$entry)
256 $this->validateAuthentication();
257 $this->validateUserAccess($entry->getUser()->getId());
259 $tags = $request->request
->get('tags', '');
261 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
264 $em = $this->getDoctrine()->getManager();
265 $em->persist($entry);
268 $json = $this->get('serializer')->serialize($entry, 'json');
270 return $this->renderJsonResponse($json);
274 * Permanently remove one tag for an entry.
278 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
279 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
285 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
287 $this->validateAuthentication();
288 $this->validateUserAccess($entry->getUser()->getId());
290 $entry->removeTag($tag);
291 $em = $this->getDoctrine()->getManager();
292 $em->persist($entry);
295 $json = $this->get('serializer')->serialize($entry, 'json');
297 return $this->renderJsonResponse($json);
307 public function getTagsAction()
309 $this->validateAuthentication();
311 $tags = $this->getDoctrine()
312 ->getRepository('WallabagCoreBundle:Tag')
313 ->findAllTags($this->getUser()->getId());
315 $json = $this->get('serializer')->serialize($tags, 'json');
317 return $this->renderJsonResponse($json);
321 * Permanently remove one tag from **every** entry.
325 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
331 public function deleteTagAction(Tag
$tag)
333 $this->validateAuthentication();
336 ->getRepository('WallabagCoreBundle:Entry')
337 ->removeTag($this->getUser()->getId(), $tag);
339 $json = $this->get('serializer')->serialize($tag, 'json');
341 return $this->renderJsonResponse($json);
344 * Retrieve version number.
350 public function getVersionAction()
352 $version = $this->container
->getParameter('wallabag_core.version');
354 $json = $this->get('serializer')->serialize($version, 'json');
356 return $this->renderJsonResponse($json);
360 * Validate that the first id is equal to the second one.
361 * If not, throw exception. It means a user try to access information from an other user.
363 * @param int $requestUserId User id from the requested source
365 private function validateUserAccess($requestUserId)
367 $user = $this->get('security.token_storage')->getToken()->getUser();
368 if ($requestUserId != $user->getId()) {
369 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
374 * Send a JSON Response.
375 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
377 * @param string $json
381 private function renderJsonResponse($json)
383 return new Response($json, 200, array('application/json'));