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);
278 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
279 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
280 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
281 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
282 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
283 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
284 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
285 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
286 * {"name"="published_at", "dataType"="datetime", "format"="YYYY-MM-DDTHH:II:SS+TZ", "required"=false, "description"="Published date of the entry"},
290 * @return JsonResponse
292 public function postEntriesAction(Request
$request)
294 $this->validateAuthentication();
296 $url = $request->request
->get('url');
297 $title = $request->request
->get('title');
298 $isArchived = $request->request
->get('archive');
299 $isStarred = $request->request
->get('starred');
300 $content = $request->request
->get('content');
301 $language = $request->request
->get('language');
302 $picture = $request->request
->get('preview_picture');
303 $publishedAt = $request->request
->get('published_at');
305 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
307 if (false === $entry) {
308 $entry = new Entry($this->getUser());
312 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
319 'language' => $language,
320 'date' => $publishedAt,
321 // faking the preview picture
323 'og_image' => $picture,
327 } catch (\Exception
$e) {
328 $this->get('logger')->error('Error while saving an entry', [
332 $entry->setUrl($url);
335 $tags = $request->request
->get('tags', []);
337 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
340 if (!is_null($isStarred)) {
341 $entry->setStarred((bool) $isStarred);
344 if (!is_null($isArchived)) {
345 $entry->setArchived((bool) $isArchived);
348 $em = $this->getDoctrine()->getManager();
349 $em->persist($entry);
352 // entry saved, dispatch event about it!
353 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
355 return $this->sendResponse($entry);
359 * Change several properties of an entry.
363 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
366 * {"name"="title", "dataType"="string", "required"=false},
367 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
368 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
369 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
373 * @return JsonResponse
375 public function patchEntriesAction(Entry
$entry, Request
$request)
377 $this->validateAuthentication();
378 $this->validateUserAccess($entry->getUser()->getId());
380 $title = $request->request
->get('title');
381 $isArchived = $request->request
->get('archive');
382 $isStarred = $request->request
->get('starred');
384 if (!is_null($title)) {
385 $entry->setTitle($title);
388 if (!is_null($isArchived)) {
389 $entry->setArchived((bool) $isArchived);
392 if (!is_null($isStarred)) {
393 $entry->setStarred((bool) $isStarred);
396 $tags = $request->request
->get('tags', '');
398 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
401 $em = $this->getDoctrine()->getManager();
404 return $this->sendResponse($entry);
409 * 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).
413 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
417 * @return JsonResponse
419 public function patchEntriesReloadAction(Entry
$entry)
421 $this->validateAuthentication();
422 $this->validateUserAccess($entry->getUser()->getId());
425 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
426 } catch (\Exception
$e) {
427 $this->get('logger')->error('Error while saving an entry', [
432 return new JsonResponse([], 304);
435 // if refreshing entry failed, don't save it
436 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
437 return new JsonResponse([], 304);
440 $em = $this->getDoctrine()->getManager();
441 $em->persist($entry);
444 // entry saved, dispatch event about it!
445 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
447 return $this->sendResponse($entry);
451 * Delete **permanently** an entry.
455 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
459 * @return JsonResponse
461 public function deleteEntriesAction(Entry
$entry)
463 $this->validateAuthentication();
464 $this->validateUserAccess($entry->getUser()->getId());
466 $em = $this->getDoctrine()->getManager();
470 // entry deleted, dispatch event about it!
471 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
473 return $this->sendResponse($entry);
477 * Retrieve all tags for an entry.
481 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
485 * @return JsonResponse
487 public function getEntriesTagsAction(Entry
$entry)
489 $this->validateAuthentication();
490 $this->validateUserAccess($entry->getUser()->getId());
492 return $this->sendResponse($entry->getTags());
496 * Add one or more tags to an entry.
500 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
503 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
507 * @return JsonResponse
509 public function postEntriesTagsAction(Request
$request, Entry
$entry)
511 $this->validateAuthentication();
512 $this->validateUserAccess($entry->getUser()->getId());
514 $tags = $request->request
->get('tags', '');
516 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
519 $em = $this->getDoctrine()->getManager();
520 $em->persist($entry);
523 return $this->sendResponse($entry);
527 * Permanently remove one tag for an entry.
531 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
532 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
536 * @return JsonResponse
538 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
540 $this->validateAuthentication();
541 $this->validateUserAccess($entry->getUser()->getId());
543 $entry->removeTag($tag);
544 $em = $this->getDoctrine()->getManager();
545 $em->persist($entry);
548 return $this->sendResponse($entry);
552 * Handles an entries list delete tags from them.
556 * {"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."}
560 * @return JsonResponse
562 public function deleteEntriesTagsListAction(Request
$request)
564 $this->validateAuthentication();
566 $list = json_decode($request->query
->get('list', []));
569 return $this->sendResponse([]);
572 // handle multiple urls
575 foreach ($list as $key => $element) {
576 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
578 $this->getUser()->getId()
581 $results[$key]['url'] = $element->url
;
582 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
584 $tags = $element->tags
;
586 if (false !== $entry && !(empty($tags))) {
587 $tags = explode(',', $tags);
588 foreach ($tags as $label) {
589 $label = trim($label);
591 $tag = $this->getDoctrine()
592 ->getRepository('WallabagCoreBundle:Tag')
593 ->findOneByLabel($label);
595 if (false !== $tag) {
596 $entry->removeTag($tag);
600 $em = $this->getDoctrine()->getManager();
601 $em->persist($entry);
606 return $this->sendResponse($results);
610 * Handles an entries list and add tags to them.
614 * {"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."}
618 * @return JsonResponse
620 public function postEntriesTagsListAction(Request
$request)
622 $this->validateAuthentication();
624 $list = json_decode($request->query
->get('list', []));
627 return $this->sendResponse([]);
632 // handle multiple urls
633 foreach ($list as $key => $element) {
634 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
636 $this->getUser()->getId()
639 $results[$key]['url'] = $element->url
;
640 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
642 $tags = $element->tags
;
644 if (false !== $entry && !(empty($tags))) {
645 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
647 $em = $this->getDoctrine()->getManager();
648 $em->persist($entry);
653 return $this->sendResponse($results);
657 * Shortcut to send data serialized in json.
661 * @return JsonResponse
663 private function sendResponse($data)
665 $json = $this->get('serializer')->serialize($data, 'json');
667 return (new JsonResponse())->setJson($json);