3 namespace Wallabag\ApiBundle\Controller
;
5 use Hateoas\Configuration\Route
;
6 use Hateoas\Representation\Factory\PagerfantaFactory
;
7 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
8 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security
;
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.
25 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
26 * {"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 * @Security("has_role('ROLE_READ')")
30 * @return JsonResponse
32 public function getEntriesExistsAction(Request
$request)
34 $this->validateAuthentication();
36 $urls = $request->query
->get('urls', []);
38 // handle multiple urls first
41 foreach ($urls as $url) {
42 $res = $this->getDoctrine()
43 ->getRepository('WallabagCoreBundle:Entry')
44 ->findByUrlAndUserId($url, $this->getUser()->getId());
46 $results[$url] = $res instanceof Entry
? $res->getId() : false;
49 return $this->sendResponse($results);
52 // let's see if it is a simple url?
53 $url = $request->query
->get('url', '');
56 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
59 $res = $this->getDoctrine()
60 ->getRepository('WallabagCoreBundle:Entry')
61 ->findByUrlAndUserId($url, $this->getUser()->getId());
63 $exists = $res instanceof Entry
? $res->getId() : false;
65 return $this->sendResponse(['exists' => $exists]);
69 * Retrieve all entries. It could be filtered by many options.
73 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
74 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
75 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
76 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
77 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
78 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
79 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
80 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
81 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
84 * @Security("has_role('ROLE_READ')")
85 * @return JsonResponse
87 public function getEntriesAction(Request
$request)
89 $this->validateAuthentication();
91 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
92 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
93 $isPublic = (null === $request->query
->get('public')) ? null : (bool) $request->query
->get('public');
94 $sort = $request->query
->get('sort', 'created');
95 $order = $request->query
->get('order', 'desc');
96 $page = (int) $request->query
->get('page', 1);
97 $perPage = (int) $request->query
->get('perPage', 30);
98 $tags = $request->query
->get('tags', '');
99 $since = $request->query
->get('since', 0);
101 /** @var \Pagerfanta\Pagerfanta $pager */
102 $pager = $this->get('wallabag_core.entry_repository')->findEntries(
103 $this->getUser()->getId(),
113 $pager->setMaxPerPage($perPage);
114 $pager->setCurrentPage($page);
116 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
117 $paginatedCollection = $pagerfantaFactory->createRepresentation(
122 'archive' => $isArchived,
123 'starred' => $isStarred,
124 'public' => $isPublic,
128 'perPage' => $perPage,
132 UrlGeneratorInterface
::ABSOLUTE_URL
136 return $this->sendResponse($paginatedCollection);
140 * Retrieve a single entry.
144 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
147 * @Security("has_role('ROLE_READ')")
148 * @return JsonResponse
150 public function getEntryAction(Entry
$entry)
152 $this->validateAuthentication();
153 $this->validateUserAccess($entry->getUser()->getId());
155 return $this->sendResponse($entry);
159 * Retrieve a single entry as a predefined format.
163 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
166 * @Security("has_role('ROLE_READ')")
169 public function getEntryExportAction(Entry
$entry, Request
$request)
171 $this->validateAuthentication();
172 $this->validateUserAccess($entry->getUser()->getId());
174 return $this->get('wallabag_core.helper.entries_export')
176 ->updateTitle('entry')
177 ->exportAs($request->attributes
->get('_format'));
181 * Handles an entries list and delete URL.
185 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
189 * @return JsonResponse
191 public function deleteEntriesListAction(Request
$request)
193 $this->validateAuthentication();
195 $urls = json_decode($request->query
->get('urls', []));
198 return $this->sendResponse([]);
203 // handle multiple urls
204 foreach ($urls as $key => $url) {
205 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
207 $this->getUser()->getId()
210 $results[$key]['url'] = $url;
212 if (false !== $entry) {
213 $em = $this->getDoctrine()->getManager();
217 // entry deleted, dispatch event about it!
218 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
221 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
224 return $this->sendResponse($results);
228 * Handles an entries list and create URL.
232 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
236 * @return JsonResponse
238 * @throws HttpException When limit is reached
240 public function postEntriesListAction(Request
$request)
242 $this->validateAuthentication();
244 $urls = json_decode($request->query
->get('urls', []));
246 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
248 if (count($urls) > $limit) {
249 throw new HttpException(400, 'API limit reached');
254 return $this->sendResponse($results);
257 // handle multiple urls
258 foreach ($urls as $key => $url) {
259 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
261 $this->getUser()->getId()
264 $results[$key]['url'] = $url;
266 if (false === $entry) {
267 $entry = new Entry($this->getUser());
269 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
272 $em = $this->getDoctrine()->getManager();
273 $em->persist($entry);
276 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
278 // entry saved, dispatch event about it!
279 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
282 return $this->sendResponse($results);
288 * 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**.
289 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
293 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
294 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
295 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
296 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
297 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
298 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
299 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
300 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
301 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
302 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
303 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
306 * @Security("has_role('ROLE_WRITE')")
307 * @return JsonResponse
309 public function postEntriesAction(Request
$request)
311 $this->validateAuthentication();
313 $url = $request->request
->get('url');
315 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
317 $this->getUser()->getId()
320 if (false === $entry) {
321 $entry = new Entry($this->getUser());
322 $entry->setUrl($url);
325 $this->upsertEntry($entry, $request);
327 return $this->sendResponse($entry);
331 * Change several properties of an entry.
335 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
338 * {"name"="title", "dataType"="string", "required"=false},
339 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
340 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
341 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
342 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
343 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
344 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
345 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
346 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
347 * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
350 * @Security("has_role('ROLE_WRITE')")
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"}
372 * @Security("has_role('ROLE_WRITE')")
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"}
414 * @Security("has_role('ROLE_WRITE')")
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"}
440 * @Security("has_role('ROLE_READ')")
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."},
462 * @Security("has_role('ROLE_WRITE')")
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"}
491 * @Security("has_role('ROLE_WRITE')")
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', '');
647 $this->get('wallabag_core.content_proxy')->updateEntry(
651 'title' => !empty($title) ? $title : $entry->getTitle(),
652 'html' => !empty($content) ? $content : $entry->getContent(),
653 'url' => $entry->getUrl(),
654 'language' => !empty($language) ? $language : $entry->getLanguage(),
655 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
656 // faking the open graph preview picture
658 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
660 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
662 $disableContentUpdate
664 } catch (\Exception
$e) {
665 $this->get('logger')->error('Error while saving an entry', [
671 if (!is_null($isArchived)) {
672 $entry->setArchived((bool) $isArchived);
675 if (!is_null($isStarred)) {
676 $entry->setStarred((bool) $isStarred);
680 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
683 if (!is_null($isPublic)) {
684 if (true === (bool) $isPublic && null === $entry->getUid()) {
685 $entry->generateUid();
686 } elseif (false === (bool) $isPublic) {
691 $em = $this->getDoctrine()->getManager();
692 $em->persist($entry);
695 // entry saved, dispatch event about it!
696 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));