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\HttpKernel\Exception\HttpException
;
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 return $this->sendResponse($results);
51 // let's see if it is a simple url?
52 $url = $request->query
->get('url', '');
55 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
58 $res = $this->getDoctrine()
59 ->getRepository('WallabagCoreBundle:Entry')
60 ->findByUrlAndUserId($url, $this->getUser()->getId());
62 $exists = $res instanceof Entry
? $res->getId() : false;
64 return $this->sendResponse(['exists' => $exists]);
68 * Retrieve all entries. It could be filtered by many options.
72 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
73 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
74 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
75 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
76 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
77 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
78 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
79 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
80 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
84 * @return JsonResponse
86 public function getEntriesAction(Request
$request)
88 $this->validateAuthentication();
90 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
91 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
92 $isPublic = (null === $request->query
->get('public')) ? null : (bool) $request->query
->get('public');
93 $sort = $request->query
->get('sort', 'created');
94 $order = $request->query
->get('order', 'desc');
95 $page = (int) $request->query
->get('page', 1);
96 $perPage = (int) $request->query
->get('perPage', 30);
97 $tags = $request->query
->get('tags', '');
98 $since = $request->query
->get('since', 0);
100 /** @var \Pagerfanta\Pagerfanta $pager */
101 $pager = $this->get('wallabag_core.entry_repository')->findEntries(
102 $this->getUser()->getId(),
112 $pager->setMaxPerPage($perPage);
113 $pager->setCurrentPage($page);
115 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
116 $paginatedCollection = $pagerfantaFactory->createRepresentation(
121 'archive' => $isArchived,
122 'starred' => $isStarred,
123 'public' => $isPublic,
127 'perPage' => $perPage,
131 UrlGeneratorInterface
::ABSOLUTE_URL
135 return $this->sendResponse($paginatedCollection);
139 * Retrieve a single entry.
143 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
147 * @return JsonResponse
149 public function getEntryAction(Entry
$entry)
151 $this->validateAuthentication();
152 $this->validateUserAccess($entry->getUser()->getId());
154 return $this->sendResponse($entry);
158 * Retrieve a single entry as a predefined format.
162 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
168 public function getEntryExportAction(Entry
$entry, Request
$request)
170 $this->validateAuthentication();
171 $this->validateUserAccess($entry->getUser()->getId());
173 return $this->get('wallabag_core.helper.entries_export')
175 ->updateTitle('entry')
176 ->exportAs($request->attributes
->get('_format'));
180 * Handles an entries list and delete URL.
184 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
188 * @return JsonResponse
190 public function deleteEntriesListAction(Request
$request)
192 $this->validateAuthentication();
194 $urls = json_decode($request->query
->get('urls', []));
197 return $this->sendResponse([]);
202 // handle multiple urls
203 foreach ($urls as $key => $url) {
204 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
206 $this->getUser()->getId()
209 $results[$key]['url'] = $url;
211 if (false !== $entry) {
212 $em = $this->getDoctrine()->getManager();
216 // entry deleted, dispatch event about it!
217 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
220 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
223 return $this->sendResponse($results);
227 * Handles an entries list and create URL.
231 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
235 * @return JsonResponse
237 * @throws HttpException When limit is reached
239 public function postEntriesListAction(Request
$request)
241 $this->validateAuthentication();
243 $urls = json_decode($request->query
->get('urls', []));
245 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
247 if (count($urls) > $limit) {
248 throw new HttpException(400, 'API limit reached');
253 return $this->sendResponse($results);
256 // handle multiple urls
257 foreach ($urls as $key => $url) {
258 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
260 $this->getUser()->getId()
263 $results[$key]['url'] = $url;
265 if (false === $entry) {
266 $entry = new Entry($this->getUser());
268 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
271 $em = $this->getDoctrine()->getManager();
272 $em->persist($entry);
275 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
277 // entry saved, dispatch event about it!
278 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
281 return $this->sendResponse($results);
287 * If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
288 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
292 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
293 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
294 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
295 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
296 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
297 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
298 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
299 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
300 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
301 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
302 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
306 * @return JsonResponse
308 public function postEntriesAction(Request
$request)
310 $this->validateAuthentication();
312 $url = $request->request
->get('url');
314 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
316 $this->getUser()->getId()
319 if (false === $entry) {
320 $entry = new Entry($this->getUser());
321 $entry->setUrl($url);
324 $this->upsertEntry($entry, $request);
326 return $this->sendResponse($entry);
330 * Change several properties of an entry.
334 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
337 * {"name"="title", "dataType"="string", "required"=false},
338 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
339 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
340 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
341 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
342 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
343 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
344 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
345 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
346 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
347 * {"name"="progress", "dataType"="integer", "required"=false, "format"="A percentage between 0 and 100", "description"="changed progress."},
351 * @return JsonResponse
353 public function patchEntriesAction(Entry
$entry, Request
$request)
355 $this->validateAuthentication();
356 $this->validateUserAccess($entry->getUser()->getId());
358 $this->upsertEntry($entry, $request, true);
360 return $this->sendResponse($entry);
365 * 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).
369 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
373 * @return JsonResponse
375 public function patchEntriesReloadAction(Entry
$entry)
377 $this->validateAuthentication();
378 $this->validateUserAccess($entry->getUser()->getId());
381 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
382 } catch (\Exception
$e) {
383 $this->get('logger')->error('Error while saving an entry', [
388 return new JsonResponse([], 304);
391 // if refreshing entry failed, don't save it
392 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
393 return new JsonResponse([], 304);
396 $em = $this->getDoctrine()->getManager();
397 $em->persist($entry);
400 // entry saved, dispatch event about it!
401 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
403 return $this->sendResponse($entry);
407 * Delete **permanently** an entry.
411 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
415 * @return JsonResponse
417 public function deleteEntriesAction(Entry
$entry)
419 $this->validateAuthentication();
420 $this->validateUserAccess($entry->getUser()->getId());
422 $em = $this->getDoctrine()->getManager();
426 // entry deleted, dispatch event about it!
427 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
429 return $this->sendResponse($entry);
433 * Retrieve all tags for an entry.
437 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
441 * @return JsonResponse
443 public function getEntriesTagsAction(Entry
$entry)
445 $this->validateAuthentication();
446 $this->validateUserAccess($entry->getUser()->getId());
448 return $this->sendResponse($entry->getTags());
452 * Add one or more tags to an entry.
456 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
459 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
463 * @return JsonResponse
465 public function postEntriesTagsAction(Request
$request, Entry
$entry)
467 $this->validateAuthentication();
468 $this->validateUserAccess($entry->getUser()->getId());
470 $tags = $request->request
->get('tags', '');
472 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
475 $em = $this->getDoctrine()->getManager();
476 $em->persist($entry);
479 return $this->sendResponse($entry);
483 * Permanently remove one tag for an entry.
487 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
488 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
492 * @return JsonResponse
494 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
496 $this->validateAuthentication();
497 $this->validateUserAccess($entry->getUser()->getId());
499 $entry->removeTag($tag);
500 $em = $this->getDoctrine()->getManager();
501 $em->persist($entry);
504 return $this->sendResponse($entry);
508 * Handles an entries list delete tags from them.
512 * {"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."}
516 * @return JsonResponse
518 public function deleteEntriesTagsListAction(Request
$request)
520 $this->validateAuthentication();
522 $list = json_decode($request->query
->get('list', []));
525 return $this->sendResponse([]);
528 // handle multiple urls
531 foreach ($list as $key => $element) {
532 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
534 $this->getUser()->getId()
537 $results[$key]['url'] = $element->url
;
538 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
540 $tags = $element->tags
;
542 if (false !== $entry && !(empty($tags))) {
543 $tags = explode(',', $tags);
544 foreach ($tags as $label) {
545 $label = trim($label);
547 $tag = $this->getDoctrine()
548 ->getRepository('WallabagCoreBundle:Tag')
549 ->findOneByLabel($label);
551 if (false !== $tag) {
552 $entry->removeTag($tag);
556 $em = $this->getDoctrine()->getManager();
557 $em->persist($entry);
562 return $this->sendResponse($results);
566 * Handles an entries list and add tags to them.
570 * {"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."}
574 * @return JsonResponse
576 public function postEntriesTagsListAction(Request
$request)
578 $this->validateAuthentication();
580 $list = json_decode($request->query
->get('list', []));
583 return $this->sendResponse([]);
588 // handle multiple urls
589 foreach ($list as $key => $element) {
590 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
592 $this->getUser()->getId()
595 $results[$key]['url'] = $element->url
;
596 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
598 $tags = $element->tags
;
600 if (false !== $entry && !(empty($tags))) {
601 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
603 $em = $this->getDoctrine()->getManager();
604 $em->persist($entry);
609 return $this->sendResponse($results);
613 * Shortcut to send data serialized in json.
617 * @return JsonResponse
619 private function sendResponse($data)
621 $json = $this->get('serializer')->serialize($data, 'json');
623 return (new JsonResponse())->setJson($json);
627 * Update or Insert a new entry.
629 * @param Entry $entry
630 * @param Request $request
631 * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
633 private function upsertEntry(Entry
$entry, Request
$request, $disableContentUpdate = false)
635 $title = $request->request
->get('title');
636 $tags = $request->request
->get('tags', []);
637 $isArchived = $request->request
->get('archive');
638 $isStarred = $request->request
->get('starred');
639 $isPublic = $request->request
->get('public');
640 $content = $request->request
->get('content');
641 $language = $request->request
->get('language');
642 $picture = $request->request
->get('preview_picture');
643 $publishedAt = $request->request
->get('published_at');
644 $authors = $request->request
->get('authors', '');
645 $progress = $request->request
->get('progress');
648 $this->get('wallabag_core.content_proxy')->updateEntry(
652 'title' => !empty($title) ? $title : $entry->getTitle(),
653 'html' => !empty($content) ? $content : $entry->getContent(),
654 'url' => $entry->getUrl(),
655 'language' => !empty($language) ? $language : $entry->getLanguage(),
656 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
657 // faking the open graph preview picture
659 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
661 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
663 $disableContentUpdate
665 } catch (\Exception
$e) {
666 $this->get('logger')->error('Error while saving an entry', [
672 if (null !== $isArchived) {
673 $entry->setArchived((bool)$isArchived);
676 if (null !== $isStarred) {
677 $entry->setStarred((bool)$isStarred);
681 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
684 if (null !== $isPublic) {
685 if (true === (bool)$isPublic && null === $entry->getUid()) {
686 $entry->generateUid();
687 } elseif (false === (bool)$isPublic) {
692 if (null !== $progress) {
693 $progress = (int) $progress;
694 if ($progress >= 0 && $progress <= 100) {
695 $entry->setProgress($progress);
699 $em = $this->getDoctrine()->getManager();
700 $em->persist($entry);
703 // entry saved, dispatch event about it!
704 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
708 * Get the progress of an entry.
712 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
716 * @param Entry $entry
718 * @return JsonResponse
720 public function getEntriesProgressAction(Entry
$entry)
722 $this->validateAuthentication();
723 $this->validateUserAccess($entry->getUser()->getId());
725 $json = $this->get('serializer')->serialize($entry->getProgress(), 'json');
727 return (new JsonResponse())->setJson($json);