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');
303 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
305 $this->getUser()->getId()
308 if (false === $entry) {
309 $entry = new Entry($this->getUser());
310 $entry->setUrl($url);
313 $this->upsertEntry($entry, $request);
315 return $this->sendResponse($entry);
319 * Change several properties of an entry.
323 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
326 * {"name"="title", "dataType"="string", "required"=false},
327 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
328 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
329 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
330 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
331 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
332 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
333 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
334 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
338 * @return JsonResponse
340 public function patchEntriesAction(Entry
$entry, Request
$request)
342 $this->validateAuthentication();
343 $this->validateUserAccess($entry->getUser()->getId());
345 $this->upsertEntry($entry, $request, true);
347 return $this->sendResponse($entry);
352 * 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).
356 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
360 * @return JsonResponse
362 public function patchEntriesReloadAction(Entry
$entry)
364 $this->validateAuthentication();
365 $this->validateUserAccess($entry->getUser()->getId());
368 $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
369 } catch (\Exception
$e) {
370 $this->get('logger')->error('Error while saving an entry', [
375 return new JsonResponse([], 304);
378 // if refreshing entry failed, don't save it
379 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
380 return new JsonResponse([], 304);
383 $em = $this->getDoctrine()->getManager();
384 $em->persist($entry);
387 // entry saved, dispatch event about it!
388 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
390 return $this->sendResponse($entry);
394 * Delete **permanently** an entry.
398 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
402 * @return JsonResponse
404 public function deleteEntriesAction(Entry
$entry)
406 $this->validateAuthentication();
407 $this->validateUserAccess($entry->getUser()->getId());
409 $em = $this->getDoctrine()->getManager();
413 // entry deleted, dispatch event about it!
414 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
416 return $this->sendResponse($entry);
420 * Retrieve all tags for an entry.
424 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
428 * @return JsonResponse
430 public function getEntriesTagsAction(Entry
$entry)
432 $this->validateAuthentication();
433 $this->validateUserAccess($entry->getUser()->getId());
435 return $this->sendResponse($entry->getTags());
439 * Add one or more tags to an entry.
443 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
446 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
450 * @return JsonResponse
452 public function postEntriesTagsAction(Request
$request, Entry
$entry)
454 $this->validateAuthentication();
455 $this->validateUserAccess($entry->getUser()->getId());
457 $tags = $request->request
->get('tags', '');
459 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
462 $em = $this->getDoctrine()->getManager();
463 $em->persist($entry);
466 return $this->sendResponse($entry);
470 * Permanently remove one tag for an entry.
474 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
475 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
479 * @return JsonResponse
481 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
483 $this->validateAuthentication();
484 $this->validateUserAccess($entry->getUser()->getId());
486 $entry->removeTag($tag);
487 $em = $this->getDoctrine()->getManager();
488 $em->persist($entry);
491 return $this->sendResponse($entry);
495 * Handles an entries list delete tags from them.
499 * {"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."}
503 * @return JsonResponse
505 public function deleteEntriesTagsListAction(Request
$request)
507 $this->validateAuthentication();
509 $list = json_decode($request->query
->get('list', []));
512 return $this->sendResponse([]);
515 // handle multiple urls
518 foreach ($list as $key => $element) {
519 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
521 $this->getUser()->getId()
524 $results[$key]['url'] = $element->url
;
525 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
527 $tags = $element->tags
;
529 if (false !== $entry && !(empty($tags))) {
530 $tags = explode(',', $tags);
531 foreach ($tags as $label) {
532 $label = trim($label);
534 $tag = $this->getDoctrine()
535 ->getRepository('WallabagCoreBundle:Tag')
536 ->findOneByLabel($label);
538 if (false !== $tag) {
539 $entry->removeTag($tag);
543 $em = $this->getDoctrine()->getManager();
544 $em->persist($entry);
549 return $this->sendResponse($results);
553 * Handles an entries list and add tags to them.
557 * {"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."}
561 * @return JsonResponse
563 public function postEntriesTagsListAction(Request
$request)
565 $this->validateAuthentication();
567 $list = json_decode($request->query
->get('list', []));
570 return $this->sendResponse([]);
575 // handle multiple urls
576 foreach ($list as $key => $element) {
577 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
579 $this->getUser()->getId()
582 $results[$key]['url'] = $element->url
;
583 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
585 $tags = $element->tags
;
587 if (false !== $entry && !(empty($tags))) {
588 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
590 $em = $this->getDoctrine()->getManager();
591 $em->persist($entry);
596 return $this->sendResponse($results);
600 * Shortcut to send data serialized in json.
604 * @return JsonResponse
606 private function sendResponse($data)
608 $json = $this->get('serializer')->serialize($data, 'json');
610 return (new JsonResponse())->setJson($json);
614 * Update or Insert a new entry.
616 * @param Entry $entry
617 * @param Request $request
618 * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
620 private function upsertEntry(Entry
$entry, Request
$request, $disableContentUpdate = false)
622 $title = $request->request
->get('title');
623 $tags = $request->request
->get('tags', []);
624 $isArchived = $request->request
->get('archive');
625 $isStarred = $request->request
->get('starred');
626 $content = $request->request
->get('content');
627 $language = $request->request
->get('language');
628 $picture = $request->request
->get('preview_picture');
629 $publishedAt = $request->request
->get('published_at');
630 $authors = $request->request
->get('authors', '');
633 $this->get('wallabag_core.content_proxy')->updateEntry(
637 'title' => !empty($title) ? $title : $entry->getTitle(),
638 'html' => !empty($content) ? $content : $entry->getContent(),
639 'url' => $entry->getUrl(),
640 'language' => !empty($language) ? $language : $entry->getLanguage(),
641 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
642 // faking the open graph preview picture
644 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
646 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
648 $disableContentUpdate
650 } catch (\Exception
$e) {
651 $this->get('logger')->error('Error while saving an entry', [
657 if (!is_null($isArchived)) {
658 $entry->setArchived((bool) $isArchived);
661 if (!is_null($isStarred)) {
662 $entry->setStarred((bool) $isStarred);
666 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
669 $em = $this->getDoctrine()->getManager();
670 $em->persist($entry);
673 // entry saved, dispatch event about it!
674 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));