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.
21 * Return ID if entry(ies) exist (and if you give the return_id parameter).
22 * Otherwise it returns false.
26 * {"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"},
27 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
28 * {"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"}
32 * @return JsonResponse
34 public function getEntriesExistsAction(Request
$request)
36 $this->validateAuthentication();
38 $returnId = (null === $request->query
->get('return_id')) ? 0 : (bool) $request->query
->get('return_id');
39 $urls = $request->query
->get('urls', []);
41 // handle multiple urls first
44 foreach ($urls as $url) {
45 $res = $this->getDoctrine()
46 ->getRepository('WallabagCoreBundle:Entry')
47 ->findByUrlAndUserId($url, $this->getUser()->getId());
49 $results[$url] = $res instanceof Entry
? ($returnId ? $res->getId() : true) : false;
52 return $this->sendResponse($results);
55 // let's see if it is a simple url?
56 $url = $request->query
->get('url', '');
59 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
62 $res = $this->getDoctrine()
63 ->getRepository('WallabagCoreBundle:Entry')
64 ->findByUrlAndUserId($url, $this->getUser()->getId());
66 $exists = $res instanceof Entry
? ($returnId ? $res->getId() : true) : false;
68 return $this->sendResponse(['exists' => $exists]);
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."},
84 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
88 * @return JsonResponse
90 public function getEntriesAction(Request
$request)
92 $this->validateAuthentication();
94 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
95 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
96 $isPublic = (null === $request->query
->get('public')) ? null : (bool) $request->query
->get('public');
97 $sort = $request->query
->get('sort', 'created');
98 $order = $request->query
->get('order', 'desc');
99 $page = (int) $request->query
->get('page', 1);
100 $perPage = (int) $request->query
->get('perPage', 30);
101 $tags = $request->query
->get('tags', '');
102 $since = $request->query
->get('since', 0);
104 /** @var \Pagerfanta\Pagerfanta $pager */
105 $pager = $this->get('wallabag_core.entry_repository')->findEntries(
106 $this->getUser()->getId(),
116 $pager->setMaxPerPage($perPage);
117 $pager->setCurrentPage($page);
119 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
120 $paginatedCollection = $pagerfantaFactory->createRepresentation(
125 'archive' => $isArchived,
126 'starred' => $isStarred,
127 'public' => $isPublic,
131 'perPage' => $perPage,
135 UrlGeneratorInterface
::ABSOLUTE_URL
139 return $this->sendResponse($paginatedCollection);
143 * Retrieve a single entry.
147 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
151 * @return JsonResponse
153 public function getEntryAction(Entry
$entry)
155 $this->validateAuthentication();
156 $this->validateUserAccess($entry->getUser()->getId());
158 return $this->sendResponse($entry);
162 * Retrieve a single entry as a predefined format.
166 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
172 public function getEntryExportAction(Entry
$entry, Request
$request)
174 $this->validateAuthentication();
175 $this->validateUserAccess($entry->getUser()->getId());
177 return $this->get('wallabag_core.helper.entries_export')
179 ->updateTitle('entry')
180 ->exportAs($request->attributes
->get('_format'));
184 * Handles an entries list and delete URL.
188 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
192 * @return JsonResponse
194 public function deleteEntriesListAction(Request
$request)
196 $this->validateAuthentication();
198 $urls = json_decode($request->query
->get('urls', []));
201 return $this->sendResponse([]);
206 // handle multiple urls
207 foreach ($urls as $key => $url) {
208 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
210 $this->getUser()->getId()
213 $results[$key]['url'] = $url;
215 if (false !== $entry) {
216 $em = $this->getDoctrine()->getManager();
220 // entry deleted, dispatch event about it!
221 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
224 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
227 return $this->sendResponse($results);
231 * Handles an entries list and create URL.
235 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
239 * @return JsonResponse
241 * @throws HttpException When limit is reached
243 public function postEntriesListAction(Request
$request)
245 $this->validateAuthentication();
247 $urls = json_decode($request->query
->get('urls', []));
249 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
251 if (count($urls) > $limit) {
252 throw new HttpException(400, 'API limit reached');
257 return $this->sendResponse($results);
260 // handle multiple urls
261 foreach ($urls as $key => $url) {
262 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
264 $this->getUser()->getId()
267 $results[$key]['url'] = $url;
269 if (false === $entry) {
270 $entry = new Entry($this->getUser());
272 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
275 $em = $this->getDoctrine()->getManager();
276 $em->persist($entry);
279 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
281 // entry saved, dispatch event about it!
282 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
285 return $this->sendResponse($results);
291 * 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**.
292 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
296 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
297 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
298 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
299 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
300 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
301 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
302 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
303 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
304 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
305 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
306 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
310 * @return JsonResponse
312 public function postEntriesAction(Request
$request)
314 $this->validateAuthentication();
316 $url = $request->request
->get('url');
318 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
320 $this->getUser()->getId()
323 if (false === $entry) {
324 $entry = new Entry($this->getUser());
325 $entry->setUrl($url);
328 $this->upsertEntry($entry, $request);
330 return $this->sendResponse($entry);
334 * Change several properties of an entry.
338 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
341 * {"name"="title", "dataType"="string", "required"=false},
342 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
343 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
344 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
345 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
346 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
347 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
348 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
349 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
350 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
354 * @return JsonResponse
356 public function patchEntriesAction(Entry
$entry, Request
$request)
358 $this->validateAuthentication();
359 $this->validateUserAccess($entry->getUser()->getId());
361 $this->upsertEntry($entry, $request, true);
363 return $this->sendResponse($entry);
368 * 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).
372 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
376 * @return JsonResponse
378 public function patchEntriesReloadAction(Entry
$entry)
380 $this->validateAuthentication();
381 $this->validateUserAccess($entry->getUser()->getId());
384 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
385 } catch (\Exception
$e) {
386 $this->get('logger')->error('Error while saving an entry', [
391 return new JsonResponse([], 304);
394 // if refreshing entry failed, don't save it
395 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
396 return new JsonResponse([], 304);
399 $em = $this->getDoctrine()->getManager();
400 $em->persist($entry);
403 // entry saved, dispatch event about it!
404 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
406 return $this->sendResponse($entry);
410 * Delete **permanently** an entry.
414 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
418 * @return JsonResponse
420 public function deleteEntriesAction(Entry
$entry)
422 $this->validateAuthentication();
423 $this->validateUserAccess($entry->getUser()->getId());
425 $em = $this->getDoctrine()->getManager();
429 // entry deleted, dispatch event about it!
430 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
432 return $this->sendResponse($entry);
436 * Retrieve all tags for an entry.
440 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
444 * @return JsonResponse
446 public function getEntriesTagsAction(Entry
$entry)
448 $this->validateAuthentication();
449 $this->validateUserAccess($entry->getUser()->getId());
451 return $this->sendResponse($entry->getTags());
455 * Add one or more tags to an entry.
459 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
462 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
466 * @return JsonResponse
468 public function postEntriesTagsAction(Request
$request, Entry
$entry)
470 $this->validateAuthentication();
471 $this->validateUserAccess($entry->getUser()->getId());
473 $tags = $request->request
->get('tags', '');
475 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
478 $em = $this->getDoctrine()->getManager();
479 $em->persist($entry);
482 return $this->sendResponse($entry);
486 * Permanently remove one tag for an entry.
490 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
491 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
495 * @return JsonResponse
497 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
499 $this->validateAuthentication();
500 $this->validateUserAccess($entry->getUser()->getId());
502 $entry->removeTag($tag);
503 $em = $this->getDoctrine()->getManager();
504 $em->persist($entry);
507 return $this->sendResponse($entry);
511 * Handles an entries list delete tags from them.
515 * {"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."}
519 * @return JsonResponse
521 public function deleteEntriesTagsListAction(Request
$request)
523 $this->validateAuthentication();
525 $list = json_decode($request->query
->get('list', []));
528 return $this->sendResponse([]);
531 // handle multiple urls
534 foreach ($list as $key => $element) {
535 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
537 $this->getUser()->getId()
540 $results[$key]['url'] = $element->url
;
541 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
543 $tags = $element->tags
;
545 if (false !== $entry && !(empty($tags))) {
546 $tags = explode(',', $tags);
547 foreach ($tags as $label) {
548 $label = trim($label);
550 $tag = $this->getDoctrine()
551 ->getRepository('WallabagCoreBundle:Tag')
552 ->findOneByLabel($label);
554 if (false !== $tag) {
555 $entry->removeTag($tag);
559 $em = $this->getDoctrine()->getManager();
560 $em->persist($entry);
565 return $this->sendResponse($results);
569 * Handles an entries list and add tags to them.
573 * {"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."}
577 * @return JsonResponse
579 public function postEntriesTagsListAction(Request
$request)
581 $this->validateAuthentication();
583 $list = json_decode($request->query
->get('list', []));
586 return $this->sendResponse([]);
591 // handle multiple urls
592 foreach ($list as $key => $element) {
593 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
595 $this->getUser()->getId()
598 $results[$key]['url'] = $element->url
;
599 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
601 $tags = $element->tags
;
603 if (false !== $entry && !(empty($tags))) {
604 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
606 $em = $this->getDoctrine()->getManager();
607 $em->persist($entry);
612 return $this->sendResponse($results);
616 * Shortcut to send data serialized in json.
620 * @return JsonResponse
622 private function sendResponse($data)
624 $json = $this->get('serializer')->serialize($data, 'json');
626 return (new JsonResponse())->setJson($json);
630 * Update or Insert a new entry.
632 * @param Entry $entry
633 * @param Request $request
634 * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
636 private function upsertEntry(Entry
$entry, Request
$request, $disableContentUpdate = false)
638 $title = $request->request
->get('title');
639 $tags = $request->request
->get('tags', []);
640 $isArchived = $request->request
->get('archive');
641 $isStarred = $request->request
->get('starred');
642 $isPublic = $request->request
->get('public');
643 $content = $request->request
->get('content');
644 $language = $request->request
->get('language');
645 $picture = $request->request
->get('preview_picture');
646 $publishedAt = $request->request
->get('published_at');
647 $authors = $request->request
->get('authors', '');
650 $this->get('wallabag_core.content_proxy')->updateEntry(
654 'title' => !empty($title) ? $title : $entry->getTitle(),
655 'html' => !empty($content) ? $content : $entry->getContent(),
656 'url' => $entry->getUrl(),
657 'language' => !empty($language) ? $language : $entry->getLanguage(),
658 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
659 // faking the open graph preview picture
661 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
663 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
665 $disableContentUpdate
667 } catch (\Exception
$e) {
668 $this->get('logger')->error('Error while saving an entry', [
674 if (!is_null($isArchived)) {
675 $entry->setArchived((bool) $isArchived);
678 if (!is_null($isStarred)) {
679 $entry->setStarred((bool) $isStarred);
683 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
686 if (!is_null($isPublic)) {
687 if (true === (bool) $isPublic && null === $entry->getUid()) {
688 $entry->generateUid();
689 } elseif (false === (bool) $isPublic) {
694 $em = $this->getDoctrine()->getManager();
695 $em->persist($entry);
698 // entry saved, dispatch event about it!
699 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));