3 namespace Wallabag\ApiBundle\Controller
;
5 use Hateoas\Configuration\Route
;
6 use Hateoas\Representation\Factory\PagerfantaFactory
;
7 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
8 use Symfony\Component\Config\Definition\Exception\Exception
;
9 use Symfony\Component\HttpFoundation\Request
;
10 use Symfony\Component\HttpFoundation\JsonResponse
;
11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
12 use Wallabag\CoreBundle\Entity\Entry
;
13 use Wallabag\CoreBundle\Entity\Tag
;
14 use Wallabag\CoreBundle\Event\EntrySavedEvent
;
15 use Wallabag\CoreBundle\Event\EntryDeletedEvent
;
17 class EntryRestController
extends WallabagRestController
20 * Check if an entry exist by url.
24 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
25 * {"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"}
29 * @return JsonResponse
31 public function getEntriesExistsAction(Request
$request)
33 $this->validateAuthentication();
35 $urls = $request->query
->get('urls', []);
37 // handle multiple urls first
40 foreach ($urls as $url) {
41 $res = $this->getDoctrine()
42 ->getRepository('WallabagCoreBundle:Entry')
43 ->findByUrlAndUserId($url, $this->getUser()->getId());
45 $results[$url] = $res instanceof Entry
? $res->getId() : false;
48 $json = $this->get('serializer')->serialize($results, 'json');
50 return (new JsonResponse())->setJson($json);
53 // let's see if it is a simple url?
54 $url = $request->query
->get('url', '');
57 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
60 $res = $this->getDoctrine()
61 ->getRepository('WallabagCoreBundle:Entry')
62 ->findByUrlAndUserId($url, $this->getUser()->getId());
64 $exists = $res instanceof Entry
? $res->getId() : false;
66 $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
68 return (new JsonResponse())->setJson($json);
72 * Retrieve all entries. It could be filtered by many options.
76 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
77 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
78 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
79 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
80 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
81 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
82 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
83 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
87 * @return JsonResponse
89 public function getEntriesAction(Request
$request)
91 $this->validateAuthentication();
93 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
94 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
95 $sort = $request->query
->get('sort', 'created');
96 $order = $request->query
->get('order', 'desc');
97 $page = (int) $request->query
->get('page', 1);
98 $perPage = (int) $request->query
->get('perPage', 30);
99 $tags = $request->query
->get('tags', '');
100 $since = $request->query
->get('since', 0);
102 $pager = $this->getDoctrine()
103 ->getRepository('WallabagCoreBundle:Entry')
104 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
106 $pager->setCurrentPage($page);
107 $pager->setMaxPerPage($perPage);
109 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
110 $paginatedCollection = $pagerfantaFactory->createRepresentation(
115 'archive' => $isArchived,
116 'starred' => $isStarred,
120 'perPage' => $perPage,
124 UrlGeneratorInterface
::ABSOLUTE_URL
128 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
130 return (new JsonResponse())->setJson($json);
134 * Retrieve a single entry.
138 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
142 * @return JsonResponse
144 public function getEntryAction(Entry
$entry)
146 $this->validateAuthentication();
147 $this->validateUserAccess($entry->getUser()->getId());
149 $json = $this->get('serializer')->serialize($entry, 'json');
151 return (new JsonResponse())->setJson($json);
155 * Retrieve a single entry as a predefined format.
159 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
165 public function getEntryExportAction(Entry
$entry, Request
$request)
167 $this->validateAuthentication();
168 $this->validateUserAccess($entry->getUser()->getId());
170 return $this->get('wallabag_core.helper.entries_export')
172 ->updateTitle('entry')
173 ->exportAs($request->attributes
->get('_format'));
177 * Handles an entries list and delete URL.
181 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
185 * @return JsonResponse
187 public function deleteEntriesListAction(Request
$request)
189 $this->validateAuthentication();
191 $urls = json_decode($request->query
->get('urls', []));
194 // handle multiple urls
197 foreach ($urls as $key => $url) {
198 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
200 $this->getUser()->getId()
203 $results[$key]['url'] = $url;
205 if (false !== $entry) {
206 $em = $this->getDoctrine()->getManager();
210 // entry deleted, dispatch event about it!
211 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
214 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
218 $json = $this->get('serializer')->serialize($results, 'json');
220 return (new JsonResponse())->setJson($json);
224 * Handles an entries list and create URL.
228 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
232 * @return JsonResponse
234 * @throws Symfony\Component\Config\Definition\Exception\Exception When limit is reached
236 public function postEntriesListAction(Request
$request)
238 $this->validateAuthentication();
240 $urls = json_decode($request->query
->get('urls', []));
243 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
245 if (count($urls) > $limit) {
246 throw new Exception('API limit reached');
249 // handle multiple urls
251 foreach ($urls as $key => $url) {
252 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
254 $this->getUser()->getId()
257 $results[$key]['url'] = $url;
259 if (false === $entry) {
260 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
261 new Entry($this->getUser()),
266 $em = $this->getDoctrine()->getManager();
267 $em->persist($entry);
270 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
272 // entry saved, dispatch event about it!
273 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
277 $json = $this->get('serializer')->serialize($results, 'json');
279 return (new JsonResponse())->setJson($json);
287 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
288 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
289 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
290 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
291 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
295 * @return JsonResponse
297 public function postEntriesAction(Request
$request)
299 $this->validateAuthentication();
301 $url = $request->request
->get('url');
302 $title = $request->request
->get('title');
303 $isArchived = $request->request
->get('archive');
304 $isStarred = $request->request
->get('starred');
306 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
308 if (false === $entry) {
309 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
310 new Entry($this->getUser()),
315 if (!is_null($title)) {
316 $entry->setTitle($title);
319 $tags = $request->request
->get('tags', '');
321 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
324 if (!is_null($isStarred)) {
325 $entry->setStarred((bool) $isStarred);
328 if (!is_null($isArchived)) {
329 $entry->setArchived((bool) $isArchived);
332 $em = $this->getDoctrine()->getManager();
333 $em->persist($entry);
336 // entry saved, dispatch event about it!
337 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
339 $json = $this->get('serializer')->serialize($entry, 'json');
341 return (new JsonResponse())->setJson($json);
345 * Change several properties of an entry.
349 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
352 * {"name"="title", "dataType"="string", "required"=false},
353 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
354 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
355 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
359 * @return JsonResponse
361 public function patchEntriesAction(Entry
$entry, Request
$request)
363 $this->validateAuthentication();
364 $this->validateUserAccess($entry->getUser()->getId());
366 $title = $request->request
->get('title');
367 $isArchived = $request->request
->get('archive');
368 $isStarred = $request->request
->get('starred');
370 if (!is_null($title)) {
371 $entry->setTitle($title);
374 if (!is_null($isArchived)) {
375 $entry->setArchived((bool) $isArchived);
378 if (!is_null($isStarred)) {
379 $entry->setStarred((bool) $isStarred);
382 $tags = $request->request
->get('tags', '');
384 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
387 $em = $this->getDoctrine()->getManager();
390 $json = $this->get('serializer')->serialize($entry, 'json');
392 return (new JsonResponse())->setJson($json);
397 * An empty response with HTTP Status 304 will be send if we weren't able to update the content (because it hasn't changed or we got an error).
401 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
405 * @return JsonResponse
407 public function patchEntriesReloadAction(Entry
$entry)
409 $this->validateAuthentication();
410 $this->validateUserAccess($entry->getUser()->getId());
413 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
414 } catch (\Exception
$e) {
415 $this->get('logger')->error('Error while saving an entry', [
420 return new JsonResponse([], 304);
423 // if refreshing entry failed, don't save it
424 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
425 return new JsonResponse([], 304);
428 $em = $this->getDoctrine()->getManager();
429 $em->persist($entry);
432 // entry saved, dispatch event about it!
433 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
435 $json = $this->get('serializer')->serialize($entry, 'json');
437 return (new JsonResponse())->setJson($json);
441 * Delete **permanently** an entry.
445 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
449 * @return JsonResponse
451 public function deleteEntriesAction(Entry
$entry)
453 $this->validateAuthentication();
454 $this->validateUserAccess($entry->getUser()->getId());
456 $em = $this->getDoctrine()->getManager();
460 // entry deleted, dispatch event about it!
461 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
463 $json = $this->get('serializer')->serialize($entry, 'json');
465 return (new JsonResponse())->setJson($json);
469 * Retrieve all tags for an entry.
473 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
477 * @return JsonResponse
479 public function getEntriesTagsAction(Entry
$entry)
481 $this->validateAuthentication();
482 $this->validateUserAccess($entry->getUser()->getId());
484 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
486 return (new JsonResponse())->setJson($json);
490 * Add one or more tags to an entry.
494 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
497 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
501 * @return JsonResponse
503 public function postEntriesTagsAction(Request
$request, Entry
$entry)
505 $this->validateAuthentication();
506 $this->validateUserAccess($entry->getUser()->getId());
508 $tags = $request->request
->get('tags', '');
510 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
513 $em = $this->getDoctrine()->getManager();
514 $em->persist($entry);
517 $json = $this->get('serializer')->serialize($entry, 'json');
519 return (new JsonResponse())->setJson($json);
523 * Permanently remove one tag for an entry.
527 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
528 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
532 * @return JsonResponse
534 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
536 $this->validateAuthentication();
537 $this->validateUserAccess($entry->getUser()->getId());
539 $entry->removeTag($tag);
540 $em = $this->getDoctrine()->getManager();
541 $em->persist($entry);
544 $json = $this->get('serializer')->serialize($entry, 'json');
546 return (new JsonResponse())->setJson($json);
550 * Handles an entries list delete tags from them.
554 * {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
558 * @return JsonResponse
560 public function deleteEntriesTagsListAction(Request
$request)
562 $this->validateAuthentication();
564 $list = json_decode($request->query
->get('list', []));
567 // handle multiple urls
569 foreach ($list as $key => $element) {
570 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
572 $this->getUser()->getId()
575 $results[$key]['url'] = $element->url
;
576 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
578 $tags = $element->tags
;
580 if (false !== $entry && !(empty($tags))) {
581 $tags = explode(',', $tags);
582 foreach ($tags as $label) {
583 $label = trim($label);
585 $tag = $this->getDoctrine()
586 ->getRepository('WallabagCoreBundle:Tag')
587 ->findOneByLabel($label);
589 if (false !== $tag) {
590 $entry->removeTag($tag);
594 $em = $this->getDoctrine()->getManager();
595 $em->persist($entry);
601 $json = $this->get('serializer')->serialize($results, 'json');
603 return (new JsonResponse())->setJson($json);
607 * Handles an entries list and add tags to them.
611 * {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
615 * @return JsonResponse
617 public function postEntriesTagsListAction(Request
$request)
619 $this->validateAuthentication();
621 $list = json_decode($request->query
->get('list', []));
624 // handle multiple urls
626 foreach ($list as $key => $element) {
627 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
629 $this->getUser()->getId()
632 $results[$key]['url'] = $element->url
;
633 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
635 $tags = $element->tags
;
637 if (false !== $entry && !(empty($tags))) {
638 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
640 $em = $this->getDoctrine()->getManager();
641 $em->persist($entry);
647 $json = $this->get('serializer')->serialize($results, 'json');
649 return (new JsonResponse())->setJson($json);