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\JsonResponse
;
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 * Check if an entry exist by url.
30 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"}
34 * @return JsonResponse
36 public function getEntriesExistsAction(Request
$request)
38 $this->validateAuthentication();
40 $url = $request->query
->get('url', '');
43 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$user->getId());
46 $res = $this->getDoctrine()
47 ->getRepository('WallabagCoreBundle:Entry')
48 ->findByUrlAndUserId($url, $this->getUser()->getId());
50 $exists = false === $res ? false : true;
52 $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
54 return (new JsonResponse())->setJson($json);
58 * Retrieve all entries. It could be filtered by many options.
62 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
63 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
64 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
65 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
66 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
67 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
68 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
69 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
73 * @return JsonResponse
75 public function getEntriesAction(Request
$request)
77 $this->validateAuthentication();
79 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
80 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
81 $sort = $request->query
->get('sort', 'created');
82 $order = $request->query
->get('order', 'desc');
83 $page = (int) $request->query
->get('page', 1);
84 $perPage = (int) $request->query
->get('perPage', 30);
85 $since = $request->query
->get('since', 0);
86 $tags = $request->query
->get('tags', '');
88 $pager = $this->getDoctrine()
89 ->getRepository('WallabagCoreBundle:Entry')
90 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
92 $pager->setCurrentPage($page);
93 $pager->setMaxPerPage($perPage);
95 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
96 $paginatedCollection = $pagerfantaFactory->createRepresentation(
98 new Route('api_get_entries', [], UrlGeneratorInterface
::ABSOLUTE_URL
)
101 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
103 return (new JsonResponse())->setJson($json);
107 * Retrieve a single entry.
111 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
115 * @return JsonResponse
117 public function getEntryAction(Entry
$entry)
119 $this->validateAuthentication();
120 $this->validateUserAccess($entry->getUser()->getId());
122 $json = $this->get('serializer')->serialize($entry, 'json');
124 return (new JsonResponse())->setJson($json);
132 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
133 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
134 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
135 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
136 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
140 * @return JsonResponse
142 public function postEntriesAction(Request
$request)
144 $this->validateAuthentication();
146 $url = $request->request
->get('url');
147 $title = $request->request
->get('title');
148 $isArchived = $request->request
->get('archive');
149 $isStarred = $request->request
->get('starred');
151 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
153 if (false === $entry) {
154 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
155 new Entry($this->getUser()),
160 if (!is_null($title)) {
161 $entry->setTitle($title);
164 $tags = $request->request
->get('tags', '');
166 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
169 if (!is_null($isStarred)) {
170 $entry->setStarred((bool) $isStarred);
173 if (!is_null($isArchived)) {
174 $entry->setArchived((bool) $isArchived);
177 $em = $this->getDoctrine()->getManager();
178 $em->persist($entry);
182 $json = $this->get('serializer')->serialize($entry, 'json');
184 return (new JsonResponse())->setJson($json);
188 * Change several properties of an entry.
192 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
195 * {"name"="title", "dataType"="string", "required"=false},
196 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
197 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
198 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
202 * @return JsonResponse
204 public function patchEntriesAction(Entry
$entry, Request
$request)
206 $this->validateAuthentication();
207 $this->validateUserAccess($entry->getUser()->getId());
209 $title = $request->request
->get('title');
210 $isArchived = $request->request
->get('archive');
211 $isStarred = $request->request
->get('starred');
213 if (!is_null($title)) {
214 $entry->setTitle($title);
217 if (!is_null($isArchived)) {
218 $entry->setArchived((bool) $isArchived);
221 if (!is_null($isStarred)) {
222 $entry->setStarred((bool) $isStarred);
225 $tags = $request->request
->get('tags', '');
227 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
230 $em = $this->getDoctrine()->getManager();
233 $json = $this->get('serializer')->serialize($entry, 'json');
235 return (new JsonResponse())->setJson($json);
239 * Delete **permanently** an entry.
243 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
247 * @return JsonResponse
249 public function deleteEntriesAction(Entry
$entry)
251 $this->validateAuthentication();
252 $this->validateUserAccess($entry->getUser()->getId());
254 $em = $this->getDoctrine()->getManager();
258 $json = $this->get('serializer')->serialize($entry, 'json');
260 return (new JsonResponse())->setJson($json);
264 * Retrieve all tags for an entry.
268 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
272 * @return JsonResponse
274 public function getEntriesTagsAction(Entry
$entry)
276 $this->validateAuthentication();
277 $this->validateUserAccess($entry->getUser()->getId());
279 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
281 return (new JsonResponse())->setJson($json);
285 * Add one or more tags to an entry.
289 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
292 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
296 * @return JsonResponse
298 public function postEntriesTagsAction(Request
$request, Entry
$entry)
300 $this->validateAuthentication();
301 $this->validateUserAccess($entry->getUser()->getId());
303 $tags = $request->request
->get('tags', '');
305 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
308 $em = $this->getDoctrine()->getManager();
309 $em->persist($entry);
312 $json = $this->get('serializer')->serialize($entry, 'json');
314 return (new JsonResponse())->setJson($json);
318 * Permanently remove one tag for an entry.
322 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
323 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
327 * @return JsonResponse
329 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
331 $this->validateAuthentication();
332 $this->validateUserAccess($entry->getUser()->getId());
334 $entry->removeTag($tag);
335 $em = $this->getDoctrine()->getManager();
336 $em->persist($entry);
339 $json = $this->get('serializer')->serialize($entry, 'json');
341 return (new JsonResponse())->setJson($json);
349 * @return JsonResponse
351 public function getTagsAction()
353 $this->validateAuthentication();
355 $tags = $this->getDoctrine()
356 ->getRepository('WallabagCoreBundle:Tag')
357 ->findAllTagsWithEntries($this->getUser()->getId());
359 $json = $this->get('serializer')->serialize($tags, 'json');
361 return (new JsonResponse())->setJson($json);
365 * Permanently remove one tag from **every** entry.
369 * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
373 * @return JsonResponse
375 public function deleteTagLabelAction(Request
$request)
377 $this->validateAuthentication();
378 $label = $request->request
->get('tag', '');
380 $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
383 throw $this->createNotFoundException('Tag not found');
387 ->getRepository('WallabagCoreBundle:Entry')
388 ->removeTag($this->getUser()->getId(), $tag);
390 $json = $this->get('serializer')->serialize($tag, 'json');
392 return (new JsonResponse())->setJson($json);
396 * Permanently remove some tags from **every** entry.
400 * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
404 * @return JsonResponse
406 public function deleteTagsLabelAction(Request
$request)
408 $this->validateAuthentication();
410 $tagsLabels = $request->request
->get('tags', '');
414 foreach (explode(',', $tagsLabels) as $tagLabel) {
415 $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
417 if (!empty($tagEntity)) {
418 $tags[] = $tagEntity;
423 throw $this->createNotFoundException('Tags not found');
427 ->getRepository('WallabagCoreBundle:Entry')
428 ->removeTags($this->getUser()->getId(), $tags);
430 $json = $this->get('serializer')->serialize($tags, 'json');
432 return (new JsonResponse())->setJson($json);
436 * Permanently remove one tag from **every** entry.
440 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
444 * @return JsonResponse
446 public function deleteTagAction(Tag
$tag)
448 $this->validateAuthentication();
451 ->getRepository('WallabagCoreBundle:Entry')
452 ->removeTag($this->getUser()->getId(), $tag);
454 $json = $this->get('serializer')->serialize($tag, 'json');
456 return (new JsonResponse())->setJson($json);
460 * Retrieve version number.
464 * @return JsonResponse
466 public function getVersionAction()
468 $version = $this->container
->getParameter('wallabag_core.version');
470 $json = $this->get('serializer')->serialize($version, 'json');
472 return (new JsonResponse())->setJson($json);
476 * Validate that the first id is equal to the second one.
477 * If not, throw exception. It means a user try to access information from an other user.
479 * @param int $requestUserId User id from the requested source
481 private function validateUserAccess($requestUserId)
483 $user = $this->get('security.token_storage')->getToken()->getUser();
484 if ($requestUserId != $user->getId()) {
485 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());