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."},
83 * @return JsonResponse
85 public function getEntriesAction(Request
$request)
87 $this->validateAuthentication();
89 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
90 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
91 $sort = $request->query
->get('sort', 'created');
92 $order = $request->query
->get('order', 'desc');
93 $page = (int) $request->query
->get('page', 1);
94 $perPage = (int) $request->query
->get('perPage', 30);
95 $tags = $request->query
->get('tags', '');
96 $since = $request->query
->get('since', 0);
98 /** @var \Pagerfanta\Pagerfanta $pager */
99 $pager = $this->getDoctrine()
100 ->getRepository('WallabagCoreBundle:Entry')
101 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
103 $pager->setMaxPerPage($perPage);
104 $pager->setCurrentPage($page);
106 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
107 $paginatedCollection = $pagerfantaFactory->createRepresentation(
112 'archive' => $isArchived,
113 'starred' => $isStarred,
117 'perPage' => $perPage,
121 UrlGeneratorInterface
::ABSOLUTE_URL
125 return $this->sendResponse($paginatedCollection);
129 * Retrieve a single entry.
133 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
137 * @return JsonResponse
139 public function getEntryAction(Entry
$entry)
141 $this->validateAuthentication();
142 $this->validateUserAccess($entry->getUser()->getId());
144 return $this->sendResponse($entry);
148 * Retrieve a single entry as a predefined format.
152 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
158 public function getEntryExportAction(Entry
$entry, Request
$request)
160 $this->validateAuthentication();
161 $this->validateUserAccess($entry->getUser()->getId());
163 return $this->get('wallabag_core.helper.entries_export')
165 ->updateTitle('entry')
166 ->exportAs($request->attributes
->get('_format'));
170 * Handles an entries list and delete URL.
174 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
178 * @return JsonResponse
180 public function deleteEntriesListAction(Request
$request)
182 $this->validateAuthentication();
184 $urls = json_decode($request->query
->get('urls', []));
187 return $this->sendResponse([]);
192 // handle multiple urls
193 foreach ($urls as $key => $url) {
194 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
196 $this->getUser()->getId()
199 $results[$key]['url'] = $url;
201 if (false !== $entry) {
202 $em = $this->getDoctrine()->getManager();
206 // entry deleted, dispatch event about it!
207 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
210 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
213 return $this->sendResponse($results);
217 * Handles an entries list and create URL.
221 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
225 * @return JsonResponse
227 * @throws HttpException When limit is reached
229 public function postEntriesListAction(Request
$request)
231 $this->validateAuthentication();
233 $urls = json_decode($request->query
->get('urls', []));
235 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
237 if (count($urls) > $limit) {
238 throw new HttpException(400, 'API limit reached');
243 return $this->sendResponse($results);
246 // handle multiple urls
247 foreach ($urls as $key => $url) {
248 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
250 $this->getUser()->getId()
253 $results[$key]['url'] = $url;
255 if (false === $entry) {
256 $entry = new Entry($this->getUser());
258 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
261 $em = $this->getDoctrine()->getManager();
262 $em->persist($entry);
265 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
267 // entry saved, dispatch event about it!
268 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
271 return $this->sendResponse($results);
277 * 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**.
278 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
282 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
283 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
284 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
285 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
286 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
287 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
288 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
289 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
290 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
291 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
295 * @return JsonResponse
297 public function postEntriesAction(Request
$request)
299 $this->validateAuthentication();
301 $url = $request->request
->get('url');
302 $title = $request->request
->get('title');
303 $tags = $request->request
->get('tags', []);
304 $isArchived = $request->request
->get('archive');
305 $isStarred = $request->request
->get('starred');
306 $content = $request->request
->get('content');
307 $language = $request->request
->get('language');
308 $picture = $request->request
->get('preview_picture');
309 $publishedAt = $request->request
->get('published_at');
310 $authors = $request->request
->get('authors', '');
312 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
314 if (false === $entry) {
315 $entry = new Entry($this->getUser());
319 $this->get('wallabag_core.content_proxy')->updateEntry(
326 'language' => $language,
327 'date' => $publishedAt,
328 // faking the preview picture
330 'og_image' => $picture,
332 'authors' => explode(',', $authors),
335 } catch (\Exception
$e) {
336 $this->get('logger')->error('Error while saving an entry', [
340 $entry->setUrl($url);
344 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
347 if (!is_null($isStarred)) {
348 $entry->setStarred((bool) $isStarred);
351 if (!is_null($isArchived)) {
352 $entry->setArchived((bool) $isArchived);
355 $em = $this->getDoctrine()->getManager();
356 $em->persist($entry);
359 // entry saved, dispatch event about it!
360 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
362 return $this->sendResponse($entry);
366 * Change several properties of an entry.
370 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
373 * {"name"="title", "dataType"="string", "required"=false},
374 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
375 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
376 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
380 * @return JsonResponse
382 public function patchEntriesAction(Entry
$entry, Request
$request)
384 $this->validateAuthentication();
385 $this->validateUserAccess($entry->getUser()->getId());
387 $title = $request->request
->get('title');
388 $isArchived = $request->request
->get('archive');
389 $isStarred = $request->request
->get('starred');
391 if (!is_null($title)) {
392 $entry->setTitle($title);
395 if (!is_null($isArchived)) {
396 $entry->setArchived((bool) $isArchived);
399 if (!is_null($isStarred)) {
400 $entry->setStarred((bool) $isStarred);
403 $tags = $request->request
->get('tags', '');
405 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
408 $em = $this->getDoctrine()->getManager();
411 return $this->sendResponse($entry);
416 * 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).
420 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
424 * @return JsonResponse
426 public function patchEntriesReloadAction(Entry
$entry)
428 $this->validateAuthentication();
429 $this->validateUserAccess($entry->getUser()->getId());
432 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
433 } catch (\Exception
$e) {
434 $this->get('logger')->error('Error while saving an entry', [
439 return new JsonResponse([], 304);
442 // if refreshing entry failed, don't save it
443 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
444 return new JsonResponse([], 304);
447 $em = $this->getDoctrine()->getManager();
448 $em->persist($entry);
451 // entry saved, dispatch event about it!
452 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
454 return $this->sendResponse($entry);
458 * Delete **permanently** an entry.
462 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
466 * @return JsonResponse
468 public function deleteEntriesAction(Entry
$entry)
470 $this->validateAuthentication();
471 $this->validateUserAccess($entry->getUser()->getId());
473 $em = $this->getDoctrine()->getManager();
477 // entry deleted, dispatch event about it!
478 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
480 return $this->sendResponse($entry);
484 * Retrieve all tags for an entry.
488 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
492 * @return JsonResponse
494 public function getEntriesTagsAction(Entry
$entry)
496 $this->validateAuthentication();
497 $this->validateUserAccess($entry->getUser()->getId());
499 return $this->sendResponse($entry->getTags());
503 * Add one or more tags to an entry.
507 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
510 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
514 * @return JsonResponse
516 public function postEntriesTagsAction(Request
$request, Entry
$entry)
518 $this->validateAuthentication();
519 $this->validateUserAccess($entry->getUser()->getId());
521 $tags = $request->request
->get('tags', '');
523 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
526 $em = $this->getDoctrine()->getManager();
527 $em->persist($entry);
530 return $this->sendResponse($entry);
534 * Permanently remove one tag for an entry.
538 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
539 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
543 * @return JsonResponse
545 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
547 $this->validateAuthentication();
548 $this->validateUserAccess($entry->getUser()->getId());
550 $entry->removeTag($tag);
551 $em = $this->getDoctrine()->getManager();
552 $em->persist($entry);
555 return $this->sendResponse($entry);
559 * Handles an entries list delete tags from them.
563 * {"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."}
567 * @return JsonResponse
569 public function deleteEntriesTagsListAction(Request
$request)
571 $this->validateAuthentication();
573 $list = json_decode($request->query
->get('list', []));
576 return $this->sendResponse([]);
579 // handle multiple urls
582 foreach ($list as $key => $element) {
583 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
585 $this->getUser()->getId()
588 $results[$key]['url'] = $element->url
;
589 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
591 $tags = $element->tags
;
593 if (false !== $entry && !(empty($tags))) {
594 $tags = explode(',', $tags);
595 foreach ($tags as $label) {
596 $label = trim($label);
598 $tag = $this->getDoctrine()
599 ->getRepository('WallabagCoreBundle:Tag')
600 ->findOneByLabel($label);
602 if (false !== $tag) {
603 $entry->removeTag($tag);
607 $em = $this->getDoctrine()->getManager();
608 $em->persist($entry);
613 return $this->sendResponse($results);
617 * Handles an entries list and add tags to them.
621 * {"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."}
625 * @return JsonResponse
627 public function postEntriesTagsListAction(Request
$request)
629 $this->validateAuthentication();
631 $list = json_decode($request->query
->get('list', []));
634 return $this->sendResponse([]);
639 // handle multiple urls
640 foreach ($list as $key => $element) {
641 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
643 $this->getUser()->getId()
646 $results[$key]['url'] = $element->url
;
647 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
649 $tags = $element->tags
;
651 if (false !== $entry && !(empty($tags))) {
652 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
654 $em = $this->getDoctrine()->getManager();
655 $em->persist($entry);
660 return $this->sendResponse($results);
664 * Shortcut to send data serialized in json.
668 * @return JsonResponse
670 private function sendResponse($data)
672 $json = $this->get('serializer')->serialize($data, 'json');
674 return (new JsonResponse())->setJson($json);