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: '.$this->getUser()->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 $tags = $request->query
->get('tags', '');
86 $since = $request->query
->get('since', 0);
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(
101 'archive' => $isArchived,
102 'starred' => $isStarred,
106 'perPage' => $perPage,
110 UrlGeneratorInterface
::ABSOLUTE_URL
114 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
116 return (new JsonResponse())->setJson($json);
120 * Retrieve a single entry.
124 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
128 * @return JsonResponse
130 public function getEntryAction(Entry
$entry, $_format)
132 $this->validateAuthentication();
133 $this->validateUserAccess($entry->getUser()->getId());
135 if ($_format === 'epub') {
136 return $this->get('wallabag_core.helper.entries_export')
138 ->updateTitle('entry')
139 ->exportAs($_format);
142 $json = $this->get('serializer')->serialize($entry, 'json');
144 return (new JsonResponse())->setJson($json);
152 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
153 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
154 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
155 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
156 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
160 * @return JsonResponse
162 public function postEntriesAction(Request
$request)
164 $this->validateAuthentication();
166 $url = $request->request
->get('url');
167 $title = $request->request
->get('title');
168 $isArchived = $request->request
->get('archive');
169 $isStarred = $request->request
->get('starred');
171 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
173 if (false === $entry) {
174 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
175 new Entry($this->getUser()),
180 if (!is_null($title)) {
181 $entry->setTitle($title);
184 $tags = $request->request
->get('tags', '');
186 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
189 if (!is_null($isStarred)) {
190 $entry->setStarred((bool) $isStarred);
193 if (!is_null($isArchived)) {
194 $entry->setArchived((bool) $isArchived);
197 $em = $this->getDoctrine()->getManager();
198 $em->persist($entry);
202 $json = $this->get('serializer')->serialize($entry, 'json');
204 return (new JsonResponse())->setJson($json);
208 * Change several properties of an entry.
212 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
215 * {"name"="title", "dataType"="string", "required"=false},
216 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
217 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
218 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
222 * @return JsonResponse
224 public function patchEntriesAction(Entry
$entry, Request
$request)
226 $this->validateAuthentication();
227 $this->validateUserAccess($entry->getUser()->getId());
229 $title = $request->request
->get('title');
230 $isArchived = $request->request
->get('archive');
231 $isStarred = $request->request
->get('starred');
233 if (!is_null($title)) {
234 $entry->setTitle($title);
237 if (!is_null($isArchived)) {
238 $entry->setArchived((bool) $isArchived);
241 if (!is_null($isStarred)) {
242 $entry->setStarred((bool) $isStarred);
245 $tags = $request->request
->get('tags', '');
247 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
250 $em = $this->getDoctrine()->getManager();
253 $json = $this->get('serializer')->serialize($entry, 'json');
255 return (new JsonResponse())->setJson($json);
259 * Delete **permanently** an entry.
263 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
267 * @return JsonResponse
269 public function deleteEntriesAction(Entry
$entry)
271 $this->validateAuthentication();
272 $this->validateUserAccess($entry->getUser()->getId());
274 $em = $this->getDoctrine()->getManager();
278 $json = $this->get('serializer')->serialize($entry, 'json');
280 return (new JsonResponse())->setJson($json);
284 * Retrieve all tags for an entry.
288 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
292 * @return JsonResponse
294 public function getEntriesTagsAction(Entry
$entry)
296 $this->validateAuthentication();
297 $this->validateUserAccess($entry->getUser()->getId());
299 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
301 return (new JsonResponse())->setJson($json);
305 * Add one or more tags to an entry.
309 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
312 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
316 * @return JsonResponse
318 public function postEntriesTagsAction(Request
$request, Entry
$entry)
320 $this->validateAuthentication();
321 $this->validateUserAccess($entry->getUser()->getId());
323 $tags = $request->request
->get('tags', '');
325 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
328 $em = $this->getDoctrine()->getManager();
329 $em->persist($entry);
332 $json = $this->get('serializer')->serialize($entry, 'json');
334 return (new JsonResponse())->setJson($json);
338 * Permanently remove one tag for an entry.
342 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
343 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
347 * @return JsonResponse
349 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
351 $this->validateAuthentication();
352 $this->validateUserAccess($entry->getUser()->getId());
354 $entry->removeTag($tag);
355 $em = $this->getDoctrine()->getManager();
356 $em->persist($entry);
359 $json = $this->get('serializer')->serialize($entry, 'json');
361 return (new JsonResponse())->setJson($json);
369 * @return JsonResponse
371 public function getTagsAction()
373 $this->validateAuthentication();
375 $tags = $this->getDoctrine()
376 ->getRepository('WallabagCoreBundle:Tag')
377 ->findAllTagsWithEntries($this->getUser()->getId());
379 $json = $this->get('serializer')->serialize($tags, 'json');
381 return (new JsonResponse())->setJson($json);
385 * Permanently remove one tag from **every** entry.
389 * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
393 * @return JsonResponse
395 public function deleteTagLabelAction(Request
$request)
397 $this->validateAuthentication();
398 $label = $request->request
->get('tag', '');
400 $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
403 throw $this->createNotFoundException('Tag not found');
407 ->getRepository('WallabagCoreBundle:Entry')
408 ->removeTag($this->getUser()->getId(), $tag);
410 $json = $this->get('serializer')->serialize($tag, 'json');
412 return (new JsonResponse())->setJson($json);
416 * Permanently remove some tags from **every** entry.
420 * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
424 * @return JsonResponse
426 public function deleteTagsLabelAction(Request
$request)
428 $this->validateAuthentication();
430 $tagsLabels = $request->request
->get('tags', '');
434 foreach (explode(',', $tagsLabels) as $tagLabel) {
435 $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
437 if (!empty($tagEntity)) {
438 $tags[] = $tagEntity;
443 throw $this->createNotFoundException('Tags not found');
447 ->getRepository('WallabagCoreBundle:Entry')
448 ->removeTags($this->getUser()->getId(), $tags);
450 $json = $this->get('serializer')->serialize($tags, 'json');
452 return (new JsonResponse())->setJson($json);
456 * Permanently remove one tag from **every** entry.
460 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
464 * @return JsonResponse
466 public function deleteTagAction(Tag
$tag)
468 $this->validateAuthentication();
471 ->getRepository('WallabagCoreBundle:Entry')
472 ->removeTag($this->getUser()->getId(), $tag);
474 $json = $this->get('serializer')->serialize($tag, 'json');
476 return (new JsonResponse())->setJson($json);
480 * Retrieve version number.
484 * @return JsonResponse
486 public function getVersionAction()
488 $version = $this->container
->getParameter('wallabag_core.version');
490 $json = $this->get('serializer')->serialize($version, 'json');
492 return (new JsonResponse())->setJson($json);
496 * Validate that the first id is equal to the second one.
497 * If not, throw exception. It means a user try to access information from an other user.
499 * @param int $requestUserId User id from the requested source
501 private function validateUserAccess($requestUserId)
503 $user = $this->get('security.token_storage')->getToken()->getUser();
504 if ($requestUserId != $user->getId()) {
505 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());