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\HttpFoundation\Request
;
9 use Symfony\Component\HttpFoundation\JsonResponse
;
10 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
11 use Wallabag\CoreBundle\Entity\Entry
;
12 use Wallabag\CoreBundle\Entity\Tag
;
13 use Wallabag\CoreBundle\Event\EntrySavedEvent
;
14 use Wallabag\CoreBundle\Event\EntryDeletedEvent
;
16 class EntryRestController
extends WallabagRestController
19 * Check if an entry exist by url.
23 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
24 * {"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"}
28 * @return JsonResponse
30 public function getEntriesExistsAction(Request
$request)
32 $this->validateAuthentication();
34 $urls = $request->query
->get('urls', []);
36 // handle multiple urls first
39 foreach ($urls as $url) {
40 $res = $this->getDoctrine()
41 ->getRepository('WallabagCoreBundle:Entry')
42 ->findByUrlAndUserId($url, $this->getUser()->getId());
44 $results[$url] = $res instanceof Entry
? $res->getId() : false;
47 $json = $this->get('serializer')->serialize($results, 'json');
49 return (new JsonResponse())->setJson($json);
52 // let's see if it is a simple url?
53 $url = $request->query
->get('url', '');
56 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
59 $res = $this->getDoctrine()
60 ->getRepository('WallabagCoreBundle:Entry')
61 ->findByUrlAndUserId($url, $this->getUser()->getId());
63 $exists = $res instanceof Entry
? $res->getId() : false;
65 $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
67 return (new JsonResponse())->setJson($json);
71 * Retrieve all entries. It could be filtered by many options.
75 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
76 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
77 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
78 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
79 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
80 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
81 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
82 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
86 * @return JsonResponse
88 public function getEntriesAction(Request
$request)
90 $this->validateAuthentication();
92 $isArchived = (null === $request->query
->get('archive')) ? null : (bool) $request->query
->get('archive');
93 $isStarred = (null === $request->query
->get('starred')) ? null : (bool) $request->query
->get('starred');
94 $sort = $request->query
->get('sort', 'created');
95 $order = $request->query
->get('order', 'desc');
96 $page = (int) $request->query
->get('page', 1);
97 $perPage = (int) $request->query
->get('perPage', 30);
98 $tags = $request->query
->get('tags', '');
99 $since = $request->query
->get('since', 0);
101 $pager = $this->getDoctrine()
102 ->getRepository('WallabagCoreBundle:Entry')
103 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
105 $pager->setCurrentPage($page);
106 $pager->setMaxPerPage($perPage);
108 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
109 $paginatedCollection = $pagerfantaFactory->createRepresentation(
114 'archive' => $isArchived,
115 'starred' => $isStarred,
119 'perPage' => $perPage,
123 UrlGeneratorInterface
::ABSOLUTE_URL
127 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
129 return (new JsonResponse())->setJson($json);
133 * Retrieve a single entry.
137 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
141 * @return JsonResponse
143 public function getEntryAction(Entry
$entry)
145 $this->validateAuthentication();
146 $this->validateUserAccess($entry->getUser()->getId());
148 $json = $this->get('serializer')->serialize($entry, 'json');
150 return (new JsonResponse())->setJson($json);
154 * Retrieve a single entry as a predefined format.
158 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
164 public function getEntryExportAction(Entry
$entry, Request
$request)
166 $this->validateAuthentication();
167 $this->validateUserAccess($entry->getUser()->getId());
169 return $this->get('wallabag_core.helper.entries_export')
171 ->updateTitle('entry')
172 ->exportAs($request->attributes
->get('_format'));
176 * Handles an entries list and create or remove URL.
180 * {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...', 'action': 'delete'}, {'url': 'http://...', 'action': 'add'}]", "description"="Urls (as an array) to handle."}
184 * @return JsonResponse
186 public function postEntriesListAction(Request
$request)
188 $this->validateAuthentication();
190 $list = json_decode($request->query
->get('list', []));
193 // handle multiple urls
196 foreach ($list as $key => $element) {
197 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
199 $this->getUser()->getId()
202 $results[$key]['url'] = $element->url
;
203 $results[$key]['action'] = $element->action
;
205 switch ($element->action
) {
207 if (false !== $entry) {
208 $em = $this->getDoctrine()->getManager();
212 // entry deleted, dispatch event about it!
213 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
216 $results[$key]['entry'] = $entry instanceof Entry
? true : false;
220 if (false === $entry) {
221 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
222 new Entry($this->getUser()),
227 $em = $this->getDoctrine()->getManager();
228 $em->persist($entry);
231 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
233 // entry saved, dispatch event about it!
234 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
241 $json = $this->get('serializer')->serialize($results, 'json');
243 return (new JsonResponse())->setJson($json);
251 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
252 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
253 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
254 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
255 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
259 * @return JsonResponse
261 public function postEntriesAction(Request
$request)
263 $this->validateAuthentication();
265 $url = $request->request
->get('url');
266 $title = $request->request
->get('title');
267 $isArchived = $request->request
->get('archive');
268 $isStarred = $request->request
->get('starred');
270 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
272 if (false === $entry) {
273 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
274 new Entry($this->getUser()),
279 if (!is_null($title)) {
280 $entry->setTitle($title);
283 $tags = $request->request
->get('tags', '');
285 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
288 if (!is_null($isStarred)) {
289 $entry->setStarred((bool) $isStarred);
292 if (!is_null($isArchived)) {
293 $entry->setArchived((bool) $isArchived);
296 $em = $this->getDoctrine()->getManager();
297 $em->persist($entry);
300 // entry saved, dispatch event about it!
301 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
303 $json = $this->get('serializer')->serialize($entry, 'json');
305 return (new JsonResponse())->setJson($json);
309 * Change several properties of an entry.
313 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
316 * {"name"="title", "dataType"="string", "required"=false},
317 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
318 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
319 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
323 * @return JsonResponse
325 public function patchEntriesAction(Entry
$entry, Request
$request)
327 $this->validateAuthentication();
328 $this->validateUserAccess($entry->getUser()->getId());
330 $title = $request->request
->get('title');
331 $isArchived = $request->request
->get('archive');
332 $isStarred = $request->request
->get('starred');
334 if (!is_null($title)) {
335 $entry->setTitle($title);
338 if (!is_null($isArchived)) {
339 $entry->setArchived((bool) $isArchived);
342 if (!is_null($isStarred)) {
343 $entry->setStarred((bool) $isStarred);
346 $tags = $request->request
->get('tags', '');
348 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
351 $em = $this->getDoctrine()->getManager();
354 $json = $this->get('serializer')->serialize($entry, 'json');
356 return (new JsonResponse())->setJson($json);
361 * 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).
365 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
369 * @return JsonResponse
371 public function patchEntriesReloadAction(Entry
$entry)
373 $this->validateAuthentication();
374 $this->validateUserAccess($entry->getUser()->getId());
377 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
378 } catch (\Exception
$e) {
379 $this->get('logger')->error('Error while saving an entry', [
384 return new JsonResponse([], 304);
387 // if refreshing entry failed, don't save it
388 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
389 return new JsonResponse([], 304);
392 $em = $this->getDoctrine()->getManager();
393 $em->persist($entry);
396 // entry saved, dispatch event about it!
397 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
399 $json = $this->get('serializer')->serialize($entry, 'json');
401 return (new JsonResponse())->setJson($json);
405 * Delete **permanently** an entry.
409 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
413 * @return JsonResponse
415 public function deleteEntriesAction(Entry
$entry)
417 $this->validateAuthentication();
418 $this->validateUserAccess($entry->getUser()->getId());
420 $em = $this->getDoctrine()->getManager();
424 // entry deleted, dispatch event about it!
425 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
427 $json = $this->get('serializer')->serialize($entry, 'json');
429 return (new JsonResponse())->setJson($json);
433 * Retrieve all tags for an entry.
437 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
441 * @return JsonResponse
443 public function getEntriesTagsAction(Entry
$entry)
445 $this->validateAuthentication();
446 $this->validateUserAccess($entry->getUser()->getId());
448 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
450 return (new JsonResponse())->setJson($json);
454 * Add one or more tags to an entry.
458 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
461 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
465 * @return JsonResponse
467 public function postEntriesTagsAction(Request
$request, Entry
$entry)
469 $this->validateAuthentication();
470 $this->validateUserAccess($entry->getUser()->getId());
472 $tags = $request->request
->get('tags', '');
474 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
477 $em = $this->getDoctrine()->getManager();
478 $em->persist($entry);
481 $json = $this->get('serializer')->serialize($entry, 'json');
483 return (new JsonResponse())->setJson($json);
487 * Permanently remove one tag for an entry.
491 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
492 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
496 * @return JsonResponse
498 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
500 $this->validateAuthentication();
501 $this->validateUserAccess($entry->getUser()->getId());
503 $entry->removeTag($tag);
504 $em = $this->getDoctrine()->getManager();
505 $em->persist($entry);
508 $json = $this->get('serializer')->serialize($entry, 'json');
510 return (new JsonResponse())->setJson($json);
514 * Handles an entries list delete tags from them.
518 * {"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."}
522 * @return JsonResponse
524 public function deleteEntriesTagsListAction(Request
$request)
526 $this->validateAuthentication();
528 $list = json_decode($request->query
->get('list', []));
531 // handle multiple urls
533 foreach ($list as $key => $element) {
534 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
536 $this->getUser()->getId()
539 $results[$key]['url'] = $element->url
;
540 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
542 $tags = $element->tags
;
544 if (false !== $entry && !(empty($tags))) {
545 $tags = explode(',', $tags);
546 foreach ($tags as $label) {
547 $label = trim($label);
549 $tag = $this->getDoctrine()
550 ->getRepository('WallabagCoreBundle:Tag')
551 ->findOneByLabel($label);
553 if (false !== $tag) {
554 $entry->removeTag($tag);
558 $em = $this->getDoctrine()->getManager();
559 $em->persist($entry);
565 $json = $this->get('serializer')->serialize($results, 'json');
567 return (new JsonResponse())->setJson($json);
571 * Handles an entries list and add tags to them.
575 * {"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."}
579 * @return JsonResponse
581 public function postEntriesTagsListAction(Request
$request)
583 $this->validateAuthentication();
585 $list = json_decode($request->query
->get('list', []));
588 // handle multiple urls
590 foreach ($list as $key => $element) {
591 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
593 $this->getUser()->getId()
596 $results[$key]['url'] = $element->url
;
597 $results[$key]['entry'] = $entry instanceof Entry
? $entry->getId() : false;
599 $tags = $element->tags
;
601 if (false !== $entry && !(empty($tags))) {
602 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
604 $em = $this->getDoctrine()->getManager();
605 $em->persist($entry);
611 $json = $this->get('serializer')->serialize($results, 'json');
613 return (new JsonResponse())->setJson($json);