3 namespace Wallabag\ApiBundle\Controller
;
5 use Hateoas\Configuration\Route
;
6 use Hateoas\Representation\Factory\PagerfantaFactory
;
7 use JMS\Serializer\SerializationContext
;
8 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
9 use Symfony\Component\HttpFoundation\JsonResponse
;
10 use Symfony\Component\HttpFoundation\Request
;
11 use Symfony\Component\HttpFoundation\Response
;
12 use Symfony\Component\HttpKernel\Exception\HttpException
;
13 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
14 use Wallabag\CoreBundle\Entity\Entry
;
15 use Wallabag\CoreBundle\Entity\Tag
;
16 use Wallabag\CoreBundle\Event\EntryDeletedEvent
;
17 use Wallabag\CoreBundle\Event\EntrySavedEvent
;
19 class EntryRestController
extends WallabagRestController
22 * Check if an entry exist by url.
23 * Return ID if entry(ies) exist (and if you give the return_id parameter).
24 * Otherwise it returns false.
26 * @todo Remove that `return_id` in the next major release
30 * {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"},
31 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
32 * {"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"}
36 * @return JsonResponse
38 public function getEntriesExistsAction(Request
$request)
40 $this->validateAuthentication();
42 $returnId = (null === $request->query
->get('return_id')) ? false : (bool) $request->query
->get('return_id');
43 $urls = $request->query
->get('urls', []);
45 // handle multiple urls first
48 foreach ($urls as $url) {
49 $res = $this->getDoctrine()
50 ->getRepository('WallabagCoreBundle:Entry')
51 ->findByUrlAndUserId($url, $this->getUser()->getId());
53 $results[$url] = $this->returnExistInformation($res, $returnId);
56 return $this->sendResponse($results);
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 = $this->returnExistInformation($res, $returnId);
72 return $this->sendResponse(['exists' => $exists]);
76 * Retrieve all entries. It could be filtered by many options.
80 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
81 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
82 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
83 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
84 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
85 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
86 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
87 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
88 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
92 * @return JsonResponse
94 public function getEntriesAction(Request
$request)
96 $this->validateAuthentication();
98 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
99 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
100 $isPublic = (null === $request->query
->get('public')) ? null : (bool) $request->query
->get('public');
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 = is_array($request->query
->get('tags')) ? '' : (string) $request->query
->get('tags', '');
106 $since = $request->query
->get('since', 0);
108 /** @var \Pagerfanta\Pagerfanta $pager */
109 $pager = $this->get('wallabag_core.entry_repository')->findEntries(
110 $this->getUser()->getId(),
120 $pager->setMaxPerPage($perPage);
121 $pager->setCurrentPage($page);
123 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
124 $paginatedCollection = $pagerfantaFactory->createRepresentation(
129 'archive' => $isArchived,
130 'starred' => $isStarred,
131 'public' => $isPublic,
135 'perPage' => $perPage,
139 UrlGeneratorInterface
::ABSOLUTE_URL
143 return $this->sendResponse($paginatedCollection);
147 * Retrieve a single entry.
151 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
155 * @return JsonResponse
157 public function getEntryAction(Entry
$entry)
159 $this->validateAuthentication();
160 $this->validateUserAccess($entry->getUser()->getId());
162 return $this->sendResponse($entry);
166 * Retrieve a single entry as a predefined format.
170 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
176 public function getEntryExportAction(Entry
$entry, Request
$request)
178 $this->validateAuthentication();
179 $this->validateUserAccess($entry->getUser()->getId());
181 return $this->get('wallabag_core.helper.entries_export')
183 ->updateTitle('entry')
184 ->updateAuthor('entry')
185 ->exportAs($request->attributes
->get('_format'));
189 * Handles an entries list and delete URL.
193 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
197 * @return JsonResponse
199 public function deleteEntriesListAction(Request
$request)
201 $this->validateAuthentication();
203 $urls = json_decode($request->query
->get('urls', []));
206 return $this->sendResponse([]);
211 // handle multiple urls
212 foreach ($urls as $key => $url) {
213 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
215 $this->getUser()->getId()
218 $results[$key]['url'] = $url;
220 if (false !== $entry) {
221 $em = $this->getDoctrine()->getManager();
225 // entry deleted, dispatch event about it!
226 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
229 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
232 return $this->sendResponse($results);
236 * Handles an entries list and create URL.
240 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
244 * @throws HttpException When limit is reached
246 * @return JsonResponse
248 public function postEntriesListAction(Request
$request)
250 $this->validateAuthentication();
252 $urls = json_decode($request->query
->get('urls', []));
254 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
256 if (count($urls) > $limit) {
257 throw new HttpException(400, 'API limit reached');
262 return $this->sendResponse($results);
265 // handle multiple urls
266 foreach ($urls as $key => $url) {
267 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
269 $this->getUser()->getId()
272 $results[$key]['url'] = $url;
274 if (false === $entry) {
275 $entry = new Entry($this->getUser());
277 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
280 $em = $this->getDoctrine()->getManager();
281 $em->persist($entry);
284 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
286 // entry saved, dispatch event about it!
287 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
290 return $this->sendResponse($results);
296 * 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**.
297 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
301 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
302 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
303 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
304 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
305 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
306 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
307 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
308 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
309 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
310 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
311 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
312 * {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
316 * @return JsonResponse
318 public function postEntriesAction(Request
$request)
320 $this->validateAuthentication();
322 $url = $request->request
->get('url');
324 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
326 $this->getUser()->getId()
329 if (false === $entry) {
330 $entry = new Entry($this->getUser());
331 $entry->setUrl($url);
334 $data = $this->retrieveValueFromRequest($request);
337 $this->get('wallabag_core.content_proxy')->updateEntry(
341 'title' => !empty($data['title']) ? $data['title'] : $entry->getTitle(),
342 'html' => !empty($data['content']) ? $data['content'] : $entry->getContent(),
343 'url' => $entry->getUrl(),
344 'language' => !empty($data['language']) ? $data['language'] : $entry->getLanguage(),
345 'date' => !empty($data['publishedAt']) ? $data['publishedAt'] : $entry->getPublishedAt(),
346 // faking the open graph preview picture
348 'og_image' => !empty($data['picture']) ? $data['picture'] : $entry->getPreviewPicture(),
350 'authors' => is_string($data['authors']) ? explode(',', $data['authors']) : $entry->getPublishedBy(),
353 } catch (\Exception
$e) {
354 $this->get('logger')->error('Error while saving an entry', [
360 if (null !== $data['isArchived']) {
361 $entry->setArchived((bool) $data['isArchived']);
364 if (null !== $data['isStarred']) {
365 $entry->updateStar((bool) $data['isStarred']);
368 if (!empty($data['tags'])) {
369 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
372 if (!empty($data['origin_url'])) {
373 $entry->setOriginUrl($data['origin_url']);
376 if (null !== $data['isPublic']) {
377 if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
378 $entry->generateUid();
379 } elseif (false === (bool) $data['isPublic']) {
384 $em = $this->getDoctrine()->getManager();
385 $em->persist($entry);
388 // entry saved, dispatch event about it!
389 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
391 return $this->sendResponse($entry);
395 * Change several properties of an entry.
399 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
402 * {"name"="title", "dataType"="string", "required"=false},
403 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
404 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
405 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
406 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
407 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
408 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
409 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
410 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
411 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
412 * {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
416 * @return JsonResponse
418 public function patchEntriesAction(Entry
$entry, Request
$request)
420 $this->validateAuthentication();
421 $this->validateUserAccess($entry->getUser()->getId());
423 $contentProxy = $this->get('wallabag_core.content_proxy');
425 $data = $this->retrieveValueFromRequest($request);
427 // this is a special case where user want to manually update the entry content
428 // the ContentProxy will only cleanup the html
429 // and also we force to not re-fetch the content in case of error
430 if (!empty($data['content'])) {
432 $contentProxy->updateEntry(
436 'html' => $data['content'],
440 } catch (\Exception
$e) {
441 $this->get('logger')->error('Error while saving an entry', [
448 if (!empty($data['title'])) {
449 $entry->setTitle($data['title']);
452 if (!empty($data['language'])) {
453 $contentProxy->updateLanguage($entry, $data['language']);
456 if (!empty($data['authors']) && is_string($data['authors'])) {
457 $entry->setPublishedBy(explode(',', $data['authors']));
460 if (!empty($data['picture'])) {
461 $contentProxy->updatePreviewPicture($entry, $data['picture']);
464 if (!empty($data['publishedAt'])) {
465 $contentProxy->updatePublishedAt($entry, $data['publishedAt']);
468 if (null !== $data['isArchived']) {
469 $entry->setArchived((bool) $data['isArchived']);
472 if (null !== $data['isStarred']) {
473 $entry->updateStar((bool) $data['isStarred']);
476 if (!empty($data['tags'])) {
477 $entry->removeAllTags();
478 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
481 if (null !== $data['isPublic']) {
482 if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
483 $entry->generateUid();
484 } elseif (false === (bool) $data['isPublic']) {
489 if (!empty($data['origin_url'])) {
490 $entry->setOriginUrl($data['origin_url']);
493 $em = $this->getDoctrine()->getManager();
494 $em->persist($entry);
497 // entry saved, dispatch event about it!
498 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
500 return $this->sendResponse($entry);
505 * 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).
509 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
513 * @return JsonResponse
515 public function patchEntriesReloadAction(Entry
$entry)
517 $this->validateAuthentication();
518 $this->validateUserAccess($entry->getUser()->getId());
521 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
522 } catch (\Exception
$e) {
523 $this->get('logger')->error('Error while saving an entry', [
528 return new JsonResponse([], 304);
531 // if refreshing entry failed, don't save it
532 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
533 return new JsonResponse([], 304);
536 $em = $this->getDoctrine()->getManager();
537 $em->persist($entry);
540 // entry saved, dispatch event about it!
541 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
543 return $this->sendResponse($entry);
547 * Delete **permanently** an entry.
551 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
555 * @return JsonResponse
557 public function deleteEntriesAction(Entry
$entry)
559 $this->validateAuthentication();
560 $this->validateUserAccess($entry->getUser()->getId());
562 $em = $this->getDoctrine()->getManager();
566 // entry deleted, dispatch event about it!
567 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
569 return $this->sendResponse($entry);
573 * Retrieve all tags for an entry.
577 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
581 * @return JsonResponse
583 public function getEntriesTagsAction(Entry
$entry)
585 $this->validateAuthentication();
586 $this->validateUserAccess($entry->getUser()->getId());
588 return $this->sendResponse($entry->getTags());
592 * Add one or more tags to an entry.
596 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
599 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
603 * @return JsonResponse
605 public function postEntriesTagsAction(Request
$request, Entry
$entry)
607 $this->validateAuthentication();
608 $this->validateUserAccess($entry->getUser()->getId());
610 $tags = $request->request
->get('tags', '');
612 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
615 $em = $this->getDoctrine()->getManager();
616 $em->persist($entry);
619 return $this->sendResponse($entry);
623 * Permanently remove one tag for an entry.
627 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
628 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
632 * @return JsonResponse
634 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
636 $this->validateAuthentication();
637 $this->validateUserAccess($entry->getUser()->getId());
639 $entry->removeTag($tag);
640 $em = $this->getDoctrine()->getManager();
641 $em->persist($entry);
644 return $this->sendResponse($entry);
648 * Handles an entries list delete tags from them.
652 * {"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."}
656 * @return JsonResponse
658 public function deleteEntriesTagsListAction(Request
$request)
660 $this->validateAuthentication();
662 $list = json_decode($request->query
->get('list', []));
665 return $this->sendResponse([]);
668 // handle multiple urls
671 foreach ($list as $key => $element) {
672 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
674 $this->getUser()->getId()
677 $results[$key]['url'] = $element->url
;
678 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
680 $tags = $element->tags
;
682 if (false !== $entry && !(empty($tags))) {
683 $tags = explode(',', $tags);
684 foreach ($tags as $label) {
685 $label = trim($label);
687 $tag = $this->getDoctrine()
688 ->getRepository('WallabagCoreBundle:Tag')
689 ->findOneByLabel($label);
691 if (false !== $tag) {
692 $entry->removeTag($tag);
696 $em = $this->getDoctrine()->getManager();
697 $em->persist($entry);
702 return $this->sendResponse($results);
706 * Handles an entries list and add tags to them.
710 * {"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."}
714 * @return JsonResponse
716 public function postEntriesTagsListAction(Request
$request)
718 $this->validateAuthentication();
720 $list = json_decode($request->query
->get('list', []));
723 return $this->sendResponse([]);
728 // handle multiple urls
729 foreach ($list as $key => $element) {
730 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
732 $this->getUser()->getId()
735 $results[$key]['url'] = $element->url
;
736 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
738 $tags = $element->tags
;
740 if (false !== $entry && !(empty($tags))) {
741 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
743 $em = $this->getDoctrine()->getManager();
744 $em->persist($entry);
749 return $this->sendResponse($results);
753 * Shortcut to send data serialized in json.
757 * @return JsonResponse
759 private function sendResponse($data)
761 // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
762 $context = new SerializationContext();
763 $context->setSerializeNull(true);
765 $json = $this->get('jms_serializer')->serialize($data, 'json', $context);
767 return (new JsonResponse())->setJson($json);
771 * Retrieve value from the request.
772 * Used for POST & PATCH on a an entry.
774 * @param Request $request
778 private function retrieveValueFromRequest(Request
$request)
781 'title' => $request->request
->get('title'),
782 'tags' => $request->request
->get('tags', []),
783 'isArchived' => $request->request
->get('archive'),
784 'isStarred' => $request->request
->get('starred'),
785 'isPublic' => $request->request
->get('public'),
786 'content' => $request->request
->get('content'),
787 'language' => $request->request
->get('language'),
788 'picture' => $request->request
->get('preview_picture'),
789 'publishedAt' => $request->request
->get('published_at'),
790 'authors' => $request->request
->get('authors', ''),
791 'origin_url' => $request->request
->get('origin_url', ''),
796 * Return information about the entry if it exist and depending on the id or not.
798 * @param Entry|null $entry
799 * @param bool $returnId
803 private function returnExistInformation($entry, $returnId)
806 return $entry instanceof Entry
? $entry->getId() : null;
809 return $entry instanceof Entry
;