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 = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
47 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $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(), $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"="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 $title = $request->request
->get('title');
113 $isArchived = $request->request
->get('archive');
114 $isStarred = $request->request
->get('starred');
116 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
118 if (false === $entry) {
119 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
120 new Entry($this->getUser()),
125 if (!is_null($title)) {
126 $entry->setTitle($title);
129 $tags = $request->request
->get('tags', '');
131 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
134 if (!is_null($isStarred)) {
135 $entry->setStarred((bool) $isStarred);
138 if (!is_null($isArchived)) {
139 $entry->setArchived((bool) $isArchived);
142 $em = $this->getDoctrine()->getManager();
143 $em->persist($entry);
147 $json = $this->get('serializer')->serialize($entry, 'json');
149 return $this->renderJsonResponse($json);
153 * Change several properties of an entry.
157 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
160 * {"name"="title", "dataType"="string", "required"=false},
161 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
162 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
163 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
169 public function patchEntriesAction(Entry
$entry, Request
$request)
171 $this->validateAuthentication();
172 $this->validateUserAccess($entry->getUser()->getId());
174 $title = $request->request
->get('title');
175 $isArchived = $request->request
->get('archive');
176 $isStarred = $request->request
->get('starred');
178 if (!is_null($title)) {
179 $entry->setTitle($title);
182 if (!is_null($isArchived)) {
183 $entry->setArchived((bool) $isArchived);
186 if (!is_null($isStarred)) {
187 $entry->setStarred((bool) $isStarred);
190 $tags = $request->request
->get('tags', '');
192 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
195 $em = $this->getDoctrine()->getManager();
198 $json = $this->get('serializer')->serialize($entry, 'json');
200 return $this->renderJsonResponse($json);
204 * Delete **permanently** an entry.
208 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
214 public function deleteEntriesAction(Entry
$entry)
216 $this->validateAuthentication();
217 $this->validateUserAccess($entry->getUser()->getId());
219 $em = $this->getDoctrine()->getManager();
223 $json = $this->get('serializer')->serialize($entry, 'json');
225 return $this->renderJsonResponse($json);
229 * Retrieve all tags for an entry.
233 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
239 public function getEntriesTagsAction(Entry
$entry)
241 $this->validateAuthentication();
242 $this->validateUserAccess($entry->getUser()->getId());
244 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
246 return $this->renderJsonResponse($json);
250 * Add one or more tags to an entry.
254 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
257 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
263 public function postEntriesTagsAction(Request
$request, Entry
$entry)
265 $this->validateAuthentication();
266 $this->validateUserAccess($entry->getUser()->getId());
268 $tags = $request->request
->get('tags', '');
270 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
273 $em = $this->getDoctrine()->getManager();
274 $em->persist($entry);
277 $json = $this->get('serializer')->serialize($entry, 'json');
279 return $this->renderJsonResponse($json);
283 * Permanently remove one tag for an entry.
287 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
288 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
294 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
296 $this->validateAuthentication();
297 $this->validateUserAccess($entry->getUser()->getId());
299 $entry->removeTag($tag);
300 $em = $this->getDoctrine()->getManager();
301 $em->persist($entry);
304 $json = $this->get('serializer')->serialize($entry, 'json');
306 return $this->renderJsonResponse($json);
316 public function getTagsAction()
318 $this->validateAuthentication();
320 $tags = $this->getDoctrine()
321 ->getRepository('WallabagCoreBundle:Tag')
322 ->findAllTags($this->getUser()->getId());
324 $json = $this->get('serializer')->serialize($tags, 'json');
326 return $this->renderJsonResponse($json);
330 * Permanently remove one tag from **every** entry.
334 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
340 public function deleteTagAction(Tag
$tag)
342 $this->validateAuthentication();
345 ->getRepository('WallabagCoreBundle:Entry')
346 ->removeTag($this->getUser()->getId(), $tag);
348 $json = $this->get('serializer')->serialize($tag, 'json');
350 return $this->renderJsonResponse($json);
353 * Retrieve version number.
359 public function getVersionAction()
361 $version = $this->container
->getParameter('wallabag_core.version');
363 $json = $this->get('serializer')->serialize($version, 'json');
365 return $this->renderJsonResponse($json);
369 * Validate that the first id is equal to the second one.
370 * If not, throw exception. It means a user try to access information from an other user.
372 * @param int $requestUserId User id from the requested source
374 private function validateUserAccess($requestUserId)
376 $user = $this->get('security.token_storage')->getToken()->getUser();
377 if ($requestUserId != $user->getId()) {
378 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
383 * Send a JSON Response.
384 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
386 * @param string $json
390 private function renderJsonResponse($json)
392 return new Response($json, 200, ['application/json']);