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', []));
236 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
238 if (count($urls) > $limit) {
239 throw new HttpException(400, 'API limit reached');
242 // handle multiple urls
244 foreach ($urls as $key => $url) {
245 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
247 $this->getUser()->getId()
250 $results[$key]['url'] = $url;
252 if (false === $entry) {
253 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
254 new Entry($this->getUser()),
259 $em = $this->getDoctrine()->getManager();
260 $em->persist($entry);
263 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
265 // entry saved, dispatch event about it!
266 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
270 return $this->sendResponse($results);
276 * 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**.
277 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
281 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
282 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
283 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
284 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
285 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
286 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
287 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
288 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
289 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
290 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
294 * @return JsonResponse
296 public function postEntriesAction(Request
$request)
298 $this->validateAuthentication();
300 $url = $request->request
->get('url');
301 $title = $request->request
->get('title');
302 $tags = $request->request
->get('tags', []);
303 $isArchived = $request->request
->get('archive');
304 $isStarred = $request->request
->get('starred');
305 $content = $request->request
->get('content');
306 $language = $request->request
->get('language');
307 $picture = $request->request
->get('preview_picture');
308 $publishedAt = $request->request
->get('published_at');
309 $authors = $request->request
->get('authors', '');
311 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
313 if (false === $entry) {
314 $entry = new Entry($this->getUser());
318 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
325 'language' => $language,
326 'date' => $publishedAt,
327 // faking the preview picture
329 'og_image' => $picture,
331 'authors' => explode(',', $authors),
334 } catch (\Exception
$e) {
335 $this->get('logger')->error('Error while saving an entry', [
339 $entry->setUrl($url);
343 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
346 if (!is_null($isStarred)) {
347 $entry->setStarred((bool) $isStarred);
350 if (!is_null($isArchived)) {
351 $entry->setArchived((bool) $isArchived);
354 $em = $this->getDoctrine()->getManager();
355 $em->persist($entry);
358 // entry saved, dispatch event about it!
359 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
361 return $this->sendResponse($entry);
365 * Change several properties of an entry.
369 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
372 * {"name"="title", "dataType"="string", "required"=false},
373 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
374 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
375 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
379 * @return JsonResponse
381 public function patchEntriesAction(Entry
$entry, Request
$request)
383 $this->validateAuthentication();
384 $this->validateUserAccess($entry->getUser()->getId());
386 $title = $request->request
->get('title');
387 $isArchived = $request->request
->get('archive');
388 $isStarred = $request->request
->get('starred');
390 if (!is_null($title)) {
391 $entry->setTitle($title);
394 if (!is_null($isArchived)) {
395 $entry->setArchived((bool) $isArchived);
398 if (!is_null($isStarred)) {
399 $entry->setStarred((bool) $isStarred);
402 $tags = $request->request
->get('tags', '');
404 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
407 $em = $this->getDoctrine()->getManager();
410 return $this->sendResponse($entry);
415 * 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).
419 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
423 * @return JsonResponse
425 public function patchEntriesReloadAction(Entry
$entry)
427 $this->validateAuthentication();
428 $this->validateUserAccess($entry->getUser()->getId());
431 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
432 } catch (\Exception
$e) {
433 $this->get('logger')->error('Error while saving an entry', [
438 return new JsonResponse([], 304);
441 // if refreshing entry failed, don't save it
442 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
443 return new JsonResponse([], 304);
446 $em = $this->getDoctrine()->getManager();
447 $em->persist($entry);
450 // entry saved, dispatch event about it!
451 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
453 return $this->sendResponse($entry);
457 * Delete **permanently** an entry.
461 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
465 * @return JsonResponse
467 public function deleteEntriesAction(Entry
$entry)
469 $this->validateAuthentication();
470 $this->validateUserAccess($entry->getUser()->getId());
472 $em = $this->getDoctrine()->getManager();
476 // entry deleted, dispatch event about it!
477 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
479 return $this->sendResponse($entry);
483 * Retrieve all tags for an entry.
487 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
491 * @return JsonResponse
493 public function getEntriesTagsAction(Entry
$entry)
495 $this->validateAuthentication();
496 $this->validateUserAccess($entry->getUser()->getId());
498 return $this->sendResponse($entry->getTags());
502 * Add one or more tags to an entry.
506 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
509 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
513 * @return JsonResponse
515 public function postEntriesTagsAction(Request
$request, Entry
$entry)
517 $this->validateAuthentication();
518 $this->validateUserAccess($entry->getUser()->getId());
520 $tags = $request->request
->get('tags', '');
522 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
525 $em = $this->getDoctrine()->getManager();
526 $em->persist($entry);
529 return $this->sendResponse($entry);
533 * Permanently remove one tag for an entry.
537 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
538 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
542 * @return JsonResponse
544 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
546 $this->validateAuthentication();
547 $this->validateUserAccess($entry->getUser()->getId());
549 $entry->removeTag($tag);
550 $em = $this->getDoctrine()->getManager();
551 $em->persist($entry);
554 return $this->sendResponse($entry);
558 * Handles an entries list delete tags from them.
562 * {"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."}
566 * @return JsonResponse
568 public function deleteEntriesTagsListAction(Request
$request)
570 $this->validateAuthentication();
572 $list = json_decode($request->query
->get('list', []));
575 return $this->sendResponse([]);
578 // handle multiple urls
581 foreach ($list as $key => $element) {
582 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
584 $this->getUser()->getId()
587 $results[$key]['url'] = $element->url
;
588 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
590 $tags = $element->tags
;
592 if (false !== $entry && !(empty($tags))) {
593 $tags = explode(',', $tags);
594 foreach ($tags as $label) {
595 $label = trim($label);
597 $tag = $this->getDoctrine()
598 ->getRepository('WallabagCoreBundle:Tag')
599 ->findOneByLabel($label);
601 if (false !== $tag) {
602 $entry->removeTag($tag);
606 $em = $this->getDoctrine()->getManager();
607 $em->persist($entry);
612 return $this->sendResponse($results);
616 * Handles an entries list and add tags to them.
620 * {"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."}
624 * @return JsonResponse
626 public function postEntriesTagsListAction(Request
$request)
628 $this->validateAuthentication();
630 $list = json_decode($request->query
->get('list', []));
633 return $this->sendResponse([]);
638 // handle multiple urls
639 foreach ($list as $key => $element) {
640 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
642 $this->getUser()->getId()
645 $results[$key]['url'] = $element->url
;
646 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
648 $tags = $element->tags
;
650 if (false !== $entry && !(empty($tags))) {
651 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
653 $em = $this->getDoctrine()->getManager();
654 $em->persist($entry);
659 return $this->sendResponse($results);
663 * Shortcut to send data serialized in json.
667 * @return JsonResponse
669 private function sendResponse($data)
671 $json = $this->get('serializer')->serialize($data, 'json');
673 return (new JsonResponse())->setJson($json);