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\HttpKernel\Exception\HttpException
;
10 use Symfony\Component\HttpFoundation\Request
;
11 use Symfony\Component\HttpFoundation\JsonResponse
;
12 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
13 use Wallabag\CoreBundle\Entity\Entry
;
14 use Wallabag\CoreBundle\Entity\Tag
;
15 use Wallabag\CoreBundle\Event\EntrySavedEvent
;
16 use Wallabag\CoreBundle\Event\EntryDeletedEvent
;
18 class EntryRestController
extends WallabagRestController
21 * Check if an entry exist by url.
22 * Return ID if entry(ies) exist (and if you give the return_id parameter).
23 * Otherwise it returns false.
25 * @todo Remove that `return_id` in the next major release
29 * {"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"},
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 $returnId = (null === $request->query
->get('return_id')) ? 0 : (bool) $request->query
->get('return_id');
42 $urls = $request->query
->get('urls', []);
44 // handle multiple urls first
47 foreach ($urls as $url) {
48 $res = $this->getDoctrine()
49 ->getRepository('WallabagCoreBundle:Entry')
50 ->findByUrlAndUserId($url, $this->getUser()->getId());
52 $results[$url] = $this->returnExistInformation($res, $returnId);
55 return $this->sendResponse($results);
58 // let's see if it is a simple url?
59 $url = $request->query
->get('url', '');
62 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
65 $res = $this->getDoctrine()
66 ->getRepository('WallabagCoreBundle:Entry')
67 ->findByUrlAndUserId($url, $this->getUser()->getId());
69 $exists = $this->returnExistInformation($res, $returnId);
71 return $this->sendResponse(['exists' => $exists]);
75 * Retrieve all entries. It could be filtered by many options.
79 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
80 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
81 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
82 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
83 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
84 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
85 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
86 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
87 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
91 * @return JsonResponse
93 public function getEntriesAction(Request
$request)
95 $this->validateAuthentication();
97 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
98 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
99 $isPublic = (null === $request->query
->get('public')) ? null : (bool) $request->query
->get('public');
100 $sort = $request->query
->get('sort', 'created');
101 $order = $request->query
->get('order', 'desc');
102 $page = (int) $request->query
->get('page', 1);
103 $perPage = (int) $request->query
->get('perPage', 30);
104 $tags = $request->query
->get('tags', '');
105 $since = $request->query
->get('since', 0);
107 /** @var \Pagerfanta\Pagerfanta $pager */
108 $pager = $this->get('wallabag_core.entry_repository')->findEntries(
109 $this->getUser()->getId(),
119 $pager->setMaxPerPage($perPage);
120 $pager->setCurrentPage($page);
122 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
123 $paginatedCollection = $pagerfantaFactory->createRepresentation(
128 'archive' => $isArchived,
129 'starred' => $isStarred,
130 'public' => $isPublic,
134 'perPage' => $perPage,
138 UrlGeneratorInterface
::ABSOLUTE_URL
142 return $this->sendResponse($paginatedCollection);
146 * Retrieve a single entry.
150 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
154 * @return JsonResponse
156 public function getEntryAction(Entry
$entry)
158 $this->validateAuthentication();
159 $this->validateUserAccess($entry->getUser()->getId());
161 return $this->sendResponse($entry);
165 * Retrieve a single entry as a predefined format.
169 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
175 public function getEntryExportAction(Entry
$entry, Request
$request)
177 $this->validateAuthentication();
178 $this->validateUserAccess($entry->getUser()->getId());
180 return $this->get('wallabag_core.helper.entries_export')
182 ->updateTitle('entry')
183 ->exportAs($request->attributes
->get('_format'));
187 * Handles an entries list and delete URL.
191 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
195 * @return JsonResponse
197 public function deleteEntriesListAction(Request
$request)
199 $this->validateAuthentication();
201 $urls = json_decode($request->query
->get('urls', []));
204 return $this->sendResponse([]);
209 // handle multiple urls
210 foreach ($urls as $key => $url) {
211 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
213 $this->getUser()->getId()
216 $results[$key]['url'] = $url;
218 if (false !== $entry) {
219 $em = $this->getDoctrine()->getManager();
223 // entry deleted, dispatch event about it!
224 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
227 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
230 return $this->sendResponse($results);
234 * Handles an entries list and create URL.
238 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
242 * @return JsonResponse
244 * @throws HttpException When limit is reached
246 public function postEntriesListAction(Request
$request)
248 $this->validateAuthentication();
250 $urls = json_decode($request->query
->get('urls', []));
252 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
254 if (count($urls) > $limit) {
255 throw new HttpException(400, 'API limit reached');
260 return $this->sendResponse($results);
263 // handle multiple urls
264 foreach ($urls as $key => $url) {
265 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
267 $this->getUser()->getId()
270 $results[$key]['url'] = $url;
272 if (false === $entry) {
273 $entry = new Entry($this->getUser());
275 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
278 $em = $this->getDoctrine()->getManager();
279 $em->persist($entry);
282 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
284 // entry saved, dispatch event about it!
285 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
288 return $this->sendResponse($results);
294 * 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**.
295 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
299 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
300 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
301 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
302 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
303 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
304 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
305 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
306 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
307 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
308 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
309 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
313 * @return JsonResponse
315 public function postEntriesAction(Request
$request)
317 $this->validateAuthentication();
319 $url = $request->request
->get('url');
321 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
323 $this->getUser()->getId()
326 if (false === $entry) {
327 $entry = new Entry($this->getUser());
328 $entry->setUrl($url);
331 $this->upsertEntry($entry, $request);
333 return $this->sendResponse($entry);
337 * Change several properties of an entry.
341 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
344 * {"name"="title", "dataType"="string", "required"=false},
345 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
346 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
347 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
348 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
349 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
350 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
351 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
352 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
353 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
357 * @return JsonResponse
359 public function patchEntriesAction(Entry
$entry, Request
$request)
361 $this->validateAuthentication();
362 $this->validateUserAccess($entry->getUser()->getId());
364 $this->upsertEntry($entry, $request, true);
366 return $this->sendResponse($entry);
371 * 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).
375 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
379 * @return JsonResponse
381 public function patchEntriesReloadAction(Entry
$entry)
383 $this->validateAuthentication();
384 $this->validateUserAccess($entry->getUser()->getId());
387 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
388 } catch (\Exception
$e) {
389 $this->get('logger')->error('Error while saving an entry', [
394 return new JsonResponse([], 304);
397 // if refreshing entry failed, don't save it
398 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
399 return new JsonResponse([], 304);
402 $em = $this->getDoctrine()->getManager();
403 $em->persist($entry);
406 // entry saved, dispatch event about it!
407 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
409 return $this->sendResponse($entry);
413 * Delete **permanently** an entry.
417 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
421 * @return JsonResponse
423 public function deleteEntriesAction(Entry
$entry)
425 $this->validateAuthentication();
426 $this->validateUserAccess($entry->getUser()->getId());
428 $em = $this->getDoctrine()->getManager();
432 // entry deleted, dispatch event about it!
433 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
435 return $this->sendResponse($entry);
439 * Retrieve all tags for an entry.
443 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
447 * @return JsonResponse
449 public function getEntriesTagsAction(Entry
$entry)
451 $this->validateAuthentication();
452 $this->validateUserAccess($entry->getUser()->getId());
454 return $this->sendResponse($entry->getTags());
458 * Add one or more tags to an entry.
462 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
465 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
469 * @return JsonResponse
471 public function postEntriesTagsAction(Request
$request, Entry
$entry)
473 $this->validateAuthentication();
474 $this->validateUserAccess($entry->getUser()->getId());
476 $tags = $request->request
->get('tags', '');
478 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
481 $em = $this->getDoctrine()->getManager();
482 $em->persist($entry);
485 return $this->sendResponse($entry);
489 * Permanently remove one tag for an entry.
493 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
494 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
498 * @return JsonResponse
500 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
502 $this->validateAuthentication();
503 $this->validateUserAccess($entry->getUser()->getId());
505 $entry->removeTag($tag);
506 $em = $this->getDoctrine()->getManager();
507 $em->persist($entry);
510 return $this->sendResponse($entry);
514 * Handles an entries list delete tags from them.
518 * {"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."}
522 * @return JsonResponse
524 public function deleteEntriesTagsListAction(Request
$request)
526 $this->validateAuthentication();
528 $list = json_decode($request->query
->get('list', []));
531 return $this->sendResponse([]);
534 // handle multiple urls
537 foreach ($list as $key => $element) {
538 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
540 $this->getUser()->getId()
543 $results[$key]['url'] = $element->url
;
544 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
546 $tags = $element->tags
;
548 if (false !== $entry && !(empty($tags))) {
549 $tags = explode(',', $tags);
550 foreach ($tags as $label) {
551 $label = trim($label);
553 $tag = $this->getDoctrine()
554 ->getRepository('WallabagCoreBundle:Tag')
555 ->findOneByLabel($label);
557 if (false !== $tag) {
558 $entry->removeTag($tag);
562 $em = $this->getDoctrine()->getManager();
563 $em->persist($entry);
568 return $this->sendResponse($results);
572 * Handles an entries list and add tags to them.
576 * {"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."}
580 * @return JsonResponse
582 public function postEntriesTagsListAction(Request
$request)
584 $this->validateAuthentication();
586 $list = json_decode($request->query
->get('list', []));
589 return $this->sendResponse([]);
594 // handle multiple urls
595 foreach ($list as $key => $element) {
596 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
598 $this->getUser()->getId()
601 $results[$key]['url'] = $element->url
;
602 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
604 $tags = $element->tags
;
606 if (false !== $entry && !(empty($tags))) {
607 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
609 $em = $this->getDoctrine()->getManager();
610 $em->persist($entry);
615 return $this->sendResponse($results);
619 * Shortcut to send data serialized in json.
623 * @return JsonResponse
625 private function sendResponse($data)
627 // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
628 $context = new SerializationContext();
629 $context->setSerializeNull(true);
631 $json = $this->get('serializer')->serialize($data, 'json', $context);
633 return (new JsonResponse())->setJson($json);
637 * Update or Insert a new entry.
639 * @param Entry $entry
640 * @param Request $request
641 * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
643 private function upsertEntry(Entry
$entry, Request
$request, $disableContentUpdate = false)
645 $title = $request->request
->get('title');
646 $tags = $request->request
->get('tags', []);
647 $isArchived = $request->request
->get('archive');
648 $isStarred = $request->request
->get('starred');
649 $isPublic = $request->request
->get('public');
650 $content = $request->request
->get('content');
651 $language = $request->request
->get('language');
652 $picture = $request->request
->get('preview_picture');
653 $publishedAt = $request->request
->get('published_at');
654 $authors = $request->request
->get('authors', '');
657 $this->get('wallabag_core.content_proxy')->updateEntry(
661 'title' => !empty($title) ? $title : $entry->getTitle(),
662 'html' => !empty($content) ? $content : $entry->getContent(),
663 'url' => $entry->getUrl(),
664 'language' => !empty($language) ? $language : $entry->getLanguage(),
665 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
666 // faking the open graph preview picture
668 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
670 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
672 $disableContentUpdate
674 } catch (\Exception
$e) {
675 $this->get('logger')->error('Error while saving an entry', [
681 if (!is_null($isArchived)) {
682 $entry->setArchived((bool) $isArchived);
685 if (!is_null($isStarred)) {
686 $entry->setStarred((bool) $isStarred);
690 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
693 if (!is_null($isPublic)) {
694 if (true === (bool) $isPublic && null === $entry->getUid()) {
695 $entry->generateUid();
696 } elseif (false === (bool) $isPublic) {
701 $em = $this->getDoctrine()->getManager();
702 $em->persist($entry);
705 // entry saved, dispatch event about it!
706 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
710 * Return information about the entry if it exist and depending on the id or not.
712 * @param Entry|null $entry
713 * @param bool $returnId
717 private function returnExistInformation($entry, $returnId)
720 return $entry instanceof Entry
? $entry->getId() : null;
723 return $entry instanceof Entry
? true : false;