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)
132 $this->validateAuthentication();
133 $this->validateUserAccess($entry->getUser()->getId());
135 $json = $this->get('serializer')->serialize($entry, 'json');
137 return (new JsonResponse())->setJson($json);
145 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
146 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
147 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
148 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
149 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
153 * @return JsonResponse
155 public function postEntriesAction(Request
$request)
157 $this->validateAuthentication();
159 $url = $request->request
->get('url');
160 $title = $request->request
->get('title');
161 $isArchived = $request->request
->get('archive');
162 $isStarred = $request->request
->get('starred');
164 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
166 if (false === $entry) {
167 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
168 new Entry($this->getUser()),
173 if (!is_null($title)) {
174 $entry->setTitle($title);
177 $tags = $request->request
->get('tags', '');
179 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
182 if (!is_null($isStarred)) {
183 $entry->setStarred((bool) $isStarred);
186 if (!is_null($isArchived)) {
187 $entry->setArchived((bool) $isArchived);
190 $em = $this->getDoctrine()->getManager();
191 $em->persist($entry);
195 $json = $this->get('serializer')->serialize($entry, 'json');
197 return (new JsonResponse())->setJson($json);
201 * Change several properties of an entry.
205 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
208 * {"name"="title", "dataType"="string", "required"=false},
209 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
210 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
211 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
215 * @return JsonResponse
217 public function patchEntriesAction(Entry
$entry, Request
$request)
219 $this->validateAuthentication();
220 $this->validateUserAccess($entry->getUser()->getId());
222 $title = $request->request
->get('title');
223 $isArchived = $request->request
->get('archive');
224 $isStarred = $request->request
->get('starred');
226 if (!is_null($title)) {
227 $entry->setTitle($title);
230 if (!is_null($isArchived)) {
231 $entry->setArchived((bool) $isArchived);
234 if (!is_null($isStarred)) {
235 $entry->setStarred((bool) $isStarred);
238 $tags = $request->request
->get('tags', '');
240 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
243 $em = $this->getDoctrine()->getManager();
246 $json = $this->get('serializer')->serialize($entry, 'json');
248 return (new JsonResponse())->setJson($json);
252 * Delete **permanently** an entry.
256 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
260 * @return JsonResponse
262 public function deleteEntriesAction(Entry
$entry)
264 $this->validateAuthentication();
265 $this->validateUserAccess($entry->getUser()->getId());
267 $em = $this->getDoctrine()->getManager();
271 $json = $this->get('serializer')->serialize($entry, 'json');
273 return (new JsonResponse())->setJson($json);
277 * Retrieve all tags for an entry.
281 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
285 * @return JsonResponse
287 public function getEntriesTagsAction(Entry
$entry)
289 $this->validateAuthentication();
290 $this->validateUserAccess($entry->getUser()->getId());
292 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
294 return (new JsonResponse())->setJson($json);
298 * Add one or more tags to an entry.
302 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
305 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
309 * @return JsonResponse
311 public function postEntriesTagsAction(Request
$request, Entry
$entry)
313 $this->validateAuthentication();
314 $this->validateUserAccess($entry->getUser()->getId());
316 $tags = $request->request
->get('tags', '');
318 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
321 $em = $this->getDoctrine()->getManager();
322 $em->persist($entry);
325 $json = $this->get('serializer')->serialize($entry, 'json');
327 return (new JsonResponse())->setJson($json);
331 * Permanently remove one tag for an entry.
335 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
336 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
340 * @return JsonResponse
342 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
344 $this->validateAuthentication();
345 $this->validateUserAccess($entry->getUser()->getId());
347 $entry->removeTag($tag);
348 $em = $this->getDoctrine()->getManager();
349 $em->persist($entry);
352 $json = $this->get('serializer')->serialize($entry, 'json');
354 return (new JsonResponse())->setJson($json);
362 * @return JsonResponse
364 public function getTagsAction()
366 $this->validateAuthentication();
368 $tags = $this->getDoctrine()
369 ->getRepository('WallabagCoreBundle:Tag')
370 ->findAllTagsWithEntries($this->getUser()->getId());
372 $json = $this->get('serializer')->serialize($tags, 'json');
374 return (new JsonResponse())->setJson($json);
378 * Permanently remove one tag from **every** entry.
382 * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
386 * @return JsonResponse
388 public function deleteTagLabelAction(Request
$request)
390 $this->validateAuthentication();
391 $label = $request->request
->get('tag', '');
393 $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
396 throw $this->createNotFoundException('Tag not found');
400 ->getRepository('WallabagCoreBundle:Entry')
401 ->removeTag($this->getUser()->getId(), $tag);
403 $json = $this->get('serializer')->serialize($tag, 'json');
405 return (new JsonResponse())->setJson($json);
409 * Permanently remove some tags from **every** entry.
413 * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
417 * @return JsonResponse
419 public function deleteTagsLabelAction(Request
$request)
421 $this->validateAuthentication();
423 $tagsLabels = $request->request
->get('tags', '');
427 foreach (explode(',', $tagsLabels) as $tagLabel) {
428 $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
430 if (!empty($tagEntity)) {
431 $tags[] = $tagEntity;
436 throw $this->createNotFoundException('Tags not found');
440 ->getRepository('WallabagCoreBundle:Entry')
441 ->removeTags($this->getUser()->getId(), $tags);
443 $json = $this->get('serializer')->serialize($tags, 'json');
445 return (new JsonResponse())->setJson($json);
449 * Permanently remove one tag from **every** entry.
453 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
457 * @return JsonResponse
459 public function deleteTagAction(Tag
$tag)
461 $this->validateAuthentication();
464 ->getRepository('WallabagCoreBundle:Entry')
465 ->removeTag($this->getUser()->getId(), $tag);
467 $json = $this->get('serializer')->serialize($tag, 'json');
469 return (new JsonResponse())->setJson($json);
473 * Retrieve version number.
477 * @return JsonResponse
479 public function getVersionAction()
481 $version = $this->container
->getParameter('wallabag_core.version');
483 $json = $this->get('serializer')->serialize($version, 'json');
485 return (new JsonResponse())->setJson($json);
489 * Validate that the first id is equal to the second one.
490 * If not, throw exception. It means a user try to access information from an other user.
492 * @param int $requestUserId User id from the requested source
494 private function validateUserAccess($requestUserId)
496 $user = $this->get('security.token_storage')->getToken()->getUser();
497 if ($requestUserId != $user->getId()) {
498 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());