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"},
31 * {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"}
35 * @return JsonResponse
37 public function getEntriesExistsAction(Request
$request)
39 $this->validateAuthentication();
41 $urls = $request->query
->get('urls', []);
43 // handle multiple urls first
46 foreach ($urls as $url) {
47 $res = $this->getDoctrine()
48 ->getRepository('WallabagCoreBundle:Entry')
49 ->findByUrlAndUserId($url, $this->getUser()->getId());
51 $results[$url] = false === $res ? false : true;
54 $json = $this->get('serializer')->serialize($results, 'json');
56 return (new JsonResponse())->setJson($json);
59 // let's see if it is a simple url?
60 $url = $request->query
->get('url', '');
63 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
66 $res = $this->getDoctrine()
67 ->getRepository('WallabagCoreBundle:Entry')
68 ->findByUrlAndUserId($url, $this->getUser()->getId());
70 $exists = false === $res ? false : true;
72 $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
74 return (new JsonResponse())->setJson($json);
78 * Retrieve all entries. It could be filtered by many options.
82 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
83 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
84 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
85 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
86 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
87 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
88 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
89 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
93 * @return JsonResponse
95 public function getEntriesAction(Request
$request)
97 $this->validateAuthentication();
99 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
100 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
101 $sort = $request->query
->get('sort', 'created');
102 $order = $request->query
->get('order', 'desc');
103 $page = (int) $request->query
->get('page', 1);
104 $perPage = (int) $request->query
->get('perPage', 30);
105 $tags = $request->query
->get('tags', '');
106 $since = $request->query
->get('since', 0);
108 $pager = $this->getDoctrine()
109 ->getRepository('WallabagCoreBundle:Entry')
110 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
112 $pager->setCurrentPage($page);
113 $pager->setMaxPerPage($perPage);
115 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
116 $paginatedCollection = $pagerfantaFactory->createRepresentation(
121 'archive' => $isArchived,
122 'starred' => $isStarred,
126 'perPage' => $perPage,
130 UrlGeneratorInterface
::ABSOLUTE_URL
134 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
136 return (new JsonResponse())->setJson($json);
140 * Retrieve a single entry.
144 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
148 * @return JsonResponse
150 public function getEntryAction(Entry
$entry)
152 $this->validateAuthentication();
153 $this->validateUserAccess($entry->getUser()->getId());
155 $json = $this->get('serializer')->serialize($entry, 'json');
157 return (new JsonResponse())->setJson($json);
165 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
166 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
167 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
168 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
169 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
173 * @return JsonResponse
175 public function postEntriesAction(Request
$request)
177 $this->validateAuthentication();
179 $url = $request->request
->get('url');
180 $title = $request->request
->get('title');
181 $isArchived = $request->request
->get('archive');
182 $isStarred = $request->request
->get('starred');
184 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
186 if (false === $entry) {
187 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
188 new Entry($this->getUser()),
193 if (!is_null($title)) {
194 $entry->setTitle($title);
197 $tags = $request->request
->get('tags', '');
199 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
202 if (!is_null($isStarred)) {
203 $entry->setStarred((bool) $isStarred);
206 if (!is_null($isArchived)) {
207 $entry->setArchived((bool) $isArchived);
210 $em = $this->getDoctrine()->getManager();
211 $em->persist($entry);
215 $json = $this->get('serializer')->serialize($entry, 'json');
217 return (new JsonResponse())->setJson($json);
221 * Change several properties of an entry.
225 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
228 * {"name"="title", "dataType"="string", "required"=false},
229 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
230 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
231 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
235 * @return JsonResponse
237 public function patchEntriesAction(Entry
$entry, Request
$request)
239 $this->validateAuthentication();
240 $this->validateUserAccess($entry->getUser()->getId());
242 $title = $request->request
->get('title');
243 $isArchived = $request->request
->get('archive');
244 $isStarred = $request->request
->get('starred');
246 if (!is_null($title)) {
247 $entry->setTitle($title);
250 if (!is_null($isArchived)) {
251 $entry->setArchived((bool) $isArchived);
254 if (!is_null($isStarred)) {
255 $entry->setStarred((bool) $isStarred);
258 $tags = $request->request
->get('tags', '');
260 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
263 $em = $this->getDoctrine()->getManager();
266 $json = $this->get('serializer')->serialize($entry, 'json');
268 return (new JsonResponse())->setJson($json);
272 * Delete **permanently** an entry.
276 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
280 * @return JsonResponse
282 public function deleteEntriesAction(Entry
$entry)
284 $this->validateAuthentication();
285 $this->validateUserAccess($entry->getUser()->getId());
287 $em = $this->getDoctrine()->getManager();
291 $json = $this->get('serializer')->serialize($entry, 'json');
293 return (new JsonResponse())->setJson($json);
297 * Retrieve all tags for an entry.
301 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
305 * @return JsonResponse
307 public function getEntriesTagsAction(Entry
$entry)
309 $this->validateAuthentication();
310 $this->validateUserAccess($entry->getUser()->getId());
312 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
314 return (new JsonResponse())->setJson($json);
318 * Add one or more tags to an entry.
322 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
325 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
329 * @return JsonResponse
331 public function postEntriesTagsAction(Request
$request, Entry
$entry)
333 $this->validateAuthentication();
334 $this->validateUserAccess($entry->getUser()->getId());
336 $tags = $request->request
->get('tags', '');
338 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
341 $em = $this->getDoctrine()->getManager();
342 $em->persist($entry);
345 $json = $this->get('serializer')->serialize($entry, 'json');
347 return (new JsonResponse())->setJson($json);
351 * Permanently remove one tag for an entry.
355 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
356 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
360 * @return JsonResponse
362 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
364 $this->validateAuthentication();
365 $this->validateUserAccess($entry->getUser()->getId());
367 $entry->removeTag($tag);
368 $em = $this->getDoctrine()->getManager();
369 $em->persist($entry);
372 $json = $this->get('serializer')->serialize($entry, 'json');
374 return (new JsonResponse())->setJson($json);
382 * @return JsonResponse
384 public function getTagsAction()
386 $this->validateAuthentication();
388 $tags = $this->getDoctrine()
389 ->getRepository('WallabagCoreBundle:Tag')
390 ->findAllTagsWithEntries($this->getUser()->getId());
392 $json = $this->get('serializer')->serialize($tags, 'json');
394 return (new JsonResponse())->setJson($json);
398 * Permanently remove one tag from **every** entry.
402 * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
406 * @return JsonResponse
408 public function deleteTagLabelAction(Request
$request)
410 $this->validateAuthentication();
411 $label = $request->request
->get('tag', '');
413 $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
416 throw $this->createNotFoundException('Tag not found');
420 ->getRepository('WallabagCoreBundle:Entry')
421 ->removeTag($this->getUser()->getId(), $tag);
423 $this->cleanOrphanTag($tag);
425 $json = $this->get('serializer')->serialize($tag, 'json');
427 return (new JsonResponse())->setJson($json);
431 * Permanently remove some tags from **every** entry.
435 * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
439 * @return JsonResponse
441 public function deleteTagsLabelAction(Request
$request)
443 $this->validateAuthentication();
445 $tagsLabels = $request->request
->get('tags', '');
449 foreach (explode(',', $tagsLabels) as $tagLabel) {
450 $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
452 if (!empty($tagEntity)) {
453 $tags[] = $tagEntity;
458 throw $this->createNotFoundException('Tags not found');
462 ->getRepository('WallabagCoreBundle:Entry')
463 ->removeTags($this->getUser()->getId(), $tags);
465 $this->cleanOrphanTag($tags);
467 $json = $this->get('serializer')->serialize($tags, 'json');
469 return (new JsonResponse())->setJson($json);
473 * Permanently remove one tag from **every** entry.
477 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
481 * @return JsonResponse
483 public function deleteTagAction(Tag
$tag)
485 $this->validateAuthentication();
488 ->getRepository('WallabagCoreBundle:Entry')
489 ->removeTag($this->getUser()->getId(), $tag);
491 $this->cleanOrphanTag($tag);
493 $json = $this->get('serializer')->serialize($tag, 'json');
495 return (new JsonResponse())->setJson($json);
499 * Retrieve version number.
503 * @return JsonResponse
505 public function getVersionAction()
507 $version = $this->container
->getParameter('wallabag_core.version');
509 $json = $this->get('serializer')->serialize($version, 'json');
511 return (new JsonResponse())->setJson($json);
515 * Remove orphan tag in case no entries are associated to it.
517 * @param Tag|array $tags
519 private function cleanOrphanTag($tags)
521 if (!is_array($tags)) {
525 $em = $this->getDoctrine()->getManager();
527 foreach ($tags as $tag) {
528 if (count($tag->getEntries()) === 0) {
537 * Validate that the first id is equal to the second one.
538 * If not, throw exception. It means a user try to access information from an other user.
540 * @param int $requestUserId User id from the requested source
542 private function validateUserAccess($requestUserId)
544 $user = $this->get('security.token_storage')->getToken()->getUser();
545 if ($requestUserId != $user->getId()) {
546 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());