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\EntryTaggedEvent
;
16 use Wallabag\CoreBundle\Event\EntryUpdatedEvent
;
17 use Wallabag\CoreBundle\Event\EntryDeletedEvent
;
19 class EntryRestController
extends WallabagRestController
22 * Check if an entry exist by url.
26 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
27 * {"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"}
31 * @return JsonResponse
33 public function getEntriesExistsAction(Request
$request)
35 $this->validateAuthentication();
37 $urls = $request->query
->get('urls', []);
39 // handle multiple urls first
42 foreach ($urls as $url) {
43 $res = $this->getDoctrine()
44 ->getRepository('WallabagCoreBundle:Entry')
45 ->findByUrlAndUserId($url, $this->getUser()->getId());
47 $results[$url] = $res instanceof Entry
? $res->getId() : false;
50 return $this->sendResponse($results);
53 // let's see if it is a simple url?
54 $url = $request->query
->get('url', '');
57 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
60 $res = $this->getDoctrine()
61 ->getRepository('WallabagCoreBundle:Entry')
62 ->findByUrlAndUserId($url, $this->getUser()->getId());
64 $exists = $res instanceof Entry
? $res->getId() : false;
66 return $this->sendResponse(['exists' => $exists]);
70 * Retrieve all entries. It could be filtered by many options.
74 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
75 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
76 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
77 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
78 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
79 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
80 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
81 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
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 $sort = $request->query
->get('sort', 'created');
94 $order = $request->query
->get('order', 'desc');
95 $page = (int) $request->query
->get('page', 1);
96 $perPage = (int) $request->query
->get('perPage', 30);
97 $tags = $request->query
->get('tags', '');
98 $since = $request->query
->get('since', 0);
100 /** @var \Pagerfanta\Pagerfanta $pager */
101 $pager = $this->getDoctrine()
102 ->getRepository('WallabagCoreBundle:Entry')
103 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
105 $pager->setMaxPerPage($perPage);
106 $pager->setCurrentPage($page);
108 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
109 $paginatedCollection = $pagerfantaFactory->createRepresentation(
114 'archive' => $isArchived,
115 'starred' => $isStarred,
119 'perPage' => $perPage,
123 UrlGeneratorInterface
::ABSOLUTE_URL
127 return $this->sendResponse($paginatedCollection);
131 * Retrieve a single entry.
135 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
139 * @return JsonResponse
141 public function getEntryAction(Entry
$entry)
143 $this->validateAuthentication();
144 $this->validateUserAccess($entry->getUser()->getId());
146 return $this->sendResponse($entry);
150 * Retrieve a single entry as a predefined format.
154 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
160 public function getEntryExportAction(Entry
$entry, Request
$request)
162 $this->validateAuthentication();
163 $this->validateUserAccess($entry->getUser()->getId());
165 return $this->get('wallabag_core.helper.entries_export')
167 ->updateTitle('entry')
168 ->exportAs($request->attributes
->get('_format'));
172 * Handles an entries list and delete URL.
176 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
180 * @return JsonResponse
182 public function deleteEntriesListAction(Request
$request)
184 $this->validateAuthentication();
186 $urls = json_decode($request->query
->get('urls', []));
189 return $this->sendResponse([]);
194 // handle multiple urls
195 foreach ($urls as $key => $url) {
196 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
198 $this->getUser()->getId()
201 $results[$key]['url'] = $url;
203 if (false !== $entry) {
204 $em = $this->getDoctrine()->getManager();
208 // entry deleted, dispatch event about it!
209 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
212 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
215 return $this->sendResponse($results);
219 * Handles an entries list and create URL.
223 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
227 * @return JsonResponse
229 * @throws HttpException When limit is reached
231 public function postEntriesListAction(Request
$request)
233 $this->validateAuthentication();
235 $urls = json_decode($request->query
->get('urls', []));
238 $limit = $this->container
->getParameter('wallabag_core.api_limit_mass_actions');
240 if (count($urls) > $limit) {
241 throw new HttpException(400, 'API limit reached');
244 // handle multiple urls
246 foreach ($urls as $key => $url) {
247 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
249 $this->getUser()->getId()
252 $results[$key]['url'] = $url;
254 if (false === $entry) {
255 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
256 new Entry($this->getUser()),
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));
272 return $this->sendResponse($results);
280 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
281 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
282 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
283 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
284 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
288 * @return JsonResponse
290 public function postEntriesAction(Request
$request)
292 $this->validateAuthentication();
294 $url = $request->request
->get('url');
295 $title = $request->request
->get('title');
296 $isArchived = $request->request
->get('archive');
297 $isStarred = $request->request
->get('starred');
299 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
301 if (false === $entry) {
302 $entry = new Entry($this->getUser());
304 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
308 } catch (\Exception
$e) {
309 $this->get('logger')->error('Error while saving an entry', [
313 $entry->setUrl($url);
317 if (!is_null($title)) {
318 $entry->setTitle($title);
321 $tags = $request->request
->get('tags', '');
323 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
326 if (!is_null($isStarred)) {
327 $entry->setStarred((bool) $isStarred);
330 if (!is_null($isArchived)) {
331 $entry->setArchived((bool) $isArchived);
334 $em = $this->getDoctrine()->getManager();
335 $em->persist($entry);
338 // entry saved, dispatch event about it!
339 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
341 return $this->sendResponse($entry);
345 * Change several properties of an entry.
349 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
352 * {"name"="title", "dataType"="string", "required"=false},
353 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
354 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
355 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
359 * @return JsonResponse
361 public function patchEntriesAction(Entry
$entry, Request
$request)
363 $this->validateAuthentication();
364 $this->validateUserAccess($entry->getUser()->getId());
366 $title = $request->request
->get('title');
367 $isArchived = $request->request
->get('archive');
368 $isStarred = $request->request
->get('starred');
370 if (!is_null($title)) {
371 $entry->setTitle($title);
374 if (!is_null($isArchived)) {
375 $entry->setArchived((bool) $isArchived);
378 if (!is_null($isStarred)) {
379 $entry->setStarred((bool) $isStarred);
382 $tags = $request->request
->get('tags', '');
384 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
387 $em = $this->getDoctrine()->getManager();
390 $this->get('event_dispatcher')->dispatch(EntryUpdatedEvent
::NAME
, new EntryUpdatedEvent($entry));
392 return $this->sendResponse($entry);
397 * 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).
401 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
405 * @return JsonResponse
407 public function patchEntriesReloadAction(Entry
$entry)
409 $this->validateAuthentication();
410 $this->validateUserAccess($entry->getUser()->getId());
413 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
414 } catch (\Exception
$e) {
415 $this->get('logger')->error('Error while saving an entry', [
420 return new JsonResponse([], 304);
423 // if refreshing entry failed, don't save it
424 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
425 return new JsonResponse([], 304);
428 $em = $this->getDoctrine()->getManager();
429 $em->persist($entry);
432 // entry saved, dispatch event about it!
433 $this->get('event_dispatcher')->dispatch(EntryUpdatedEvent
::NAME
, new EntryUpdatedEvent($entry));
434 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
436 return $this->sendResponse($entry);
440 * Delete **permanently** an entry.
444 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
448 * @return JsonResponse
450 public function deleteEntriesAction(Entry
$entry)
452 $this->validateAuthentication();
453 $this->validateUserAccess($entry->getUser()->getId());
455 $em = $this->getDoctrine()->getManager();
459 // entry deleted, dispatch event about it!
460 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
462 return $this->sendResponse($entry);
466 * Retrieve all tags for an entry.
470 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
474 * @return JsonResponse
476 public function getEntriesTagsAction(Entry
$entry)
478 $this->validateAuthentication();
479 $this->validateUserAccess($entry->getUser()->getId());
481 return $this->sendResponse($entry->getTags());
485 * Add one or more tags to an entry.
489 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
492 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
496 * @return JsonResponse
498 public function postEntriesTagsAction(Request
$request, Entry
$entry)
500 $this->validateAuthentication();
501 $this->validateUserAccess($entry->getUser()->getId());
503 $tags = $request->request
->get('tags', '');
506 $tagsEntries = $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
509 $em = $this->getDoctrine()->getManager();
510 $em->persist($entry);
513 $this->get('event_dispatcher')->dispatch(EntryTaggedEvent
::NAME
, new EntryTaggedEvent($entry, $tagsEntries));
515 return $this->sendResponse($entry);
519 * Permanently remove one tag for an entry.
523 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
524 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
528 * @return JsonResponse
530 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
532 $this->validateAuthentication();
533 $this->validateUserAccess($entry->getUser()->getId());
535 $entry->removeTag($tag);
536 $em = $this->getDoctrine()->getManager();
537 $em->persist($entry);
540 return $this->sendResponse($entry);
544 * Handles an entries list delete tags from them.
548 * {"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."}
552 * @return JsonResponse
554 public function deleteEntriesTagsListAction(Request
$request)
556 $this->validateAuthentication();
558 $list = json_decode($request->query
->get('list', []));
561 return $this->sendResponse([]);
564 // handle multiple urls
567 foreach ($list as $key => $element) {
568 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
570 $this->getUser()->getId()
573 $results[$key]['url'] = $element->url
;
574 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
576 $tags = $element->tags
;
578 if (false !== $entry && !(empty($tags))) {
579 $tags = explode(',', $tags);
580 foreach ($tags as $label) {
581 $label = trim($label);
583 $tag = $this->getDoctrine()
584 ->getRepository('WallabagCoreBundle:Tag')
585 ->findOneByLabel($label);
587 if (false !== $tag) {
588 $entry->removeTag($tag);
592 $em = $this->getDoctrine()->getManager();
593 $em->persist($entry);
598 return $this->sendResponse($results);
602 * Handles an entries list and add tags to them.
606 * {"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."}
610 * @return JsonResponse
612 public function postEntriesTagsListAction(Request
$request)
614 $this->validateAuthentication();
616 $list = json_decode($request->query
->get('list', []));
619 return $this->sendResponse([]);
624 // handle multiple urls
625 foreach ($list as $key => $element) {
626 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
628 $this->getUser()->getId()
631 $results[$key]['url'] = $element->url
;
632 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
634 $tags = $element->tags
;
636 if (false !== $entry && !(empty($tags))) {
637 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
639 $em = $this->getDoctrine()->getManager();
640 $em->persist($entry);
645 return $this->sendResponse($results);
649 * Shortcut to send data serialized in json.
653 * @return JsonResponse
655 private function sendResponse($data)
657 $json = $this->get('serializer')->serialize($data, 'json');
659 return (new JsonResponse())->setJson($json);
663 * Gets history since a date.
667 * {"name"="since", "dataType"="integer", "required"=true, "format"="A timestamp", "description"="Timestamp of the history's start"},
671 * @return JsonResponse
673 public function getEntriesHistoryAction(Request
$request)
675 $this->validateAuthentication();
677 $res = $this->getDoctrine()
678 ->getRepository('WallabagCoreBundle:Change')
679 ->findChangesSinceDate($request->query
->get('since'));
681 $json = $this->get('serializer')->serialize($res, 'json');
683 return (new JsonResponse())->setJson($json);