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] = false === $res ? false : true;
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 = false === $res ? false : true;
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'));
180 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
181 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
182 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
183 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
184 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
188 * @return JsonResponse
190 public function postEntriesAction(Request
$request)
192 $this->validateAuthentication();
194 $url = $request->request
->get('url');
195 $title = $request->request
->get('title');
196 $isArchived = $request->request
->get('archive');
197 $isStarred = $request->request
->get('starred');
199 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
201 if (false === $entry) {
202 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
203 new Entry($this->getUser()),
208 if (!is_null($title)) {
209 $entry->setTitle($title);
212 $tags = $request->request
->get('tags', '');
214 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
217 if (!is_null($isStarred)) {
218 $entry->setStarred((bool) $isStarred);
221 if (!is_null($isArchived)) {
222 $entry->setArchived((bool) $isArchived);
225 $em = $this->getDoctrine()->getManager();
226 $em->persist($entry);
229 // entry saved, dispatch event about it!
230 $this->get('event_dispatcher')->dispatch(EntrySavedEvent
::NAME
, new EntrySavedEvent($entry));
232 $json = $this->get('serializer')->serialize($entry, 'json');
234 return (new JsonResponse())->setJson($json);
238 * Change several properties of an entry.
242 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
245 * {"name"="title", "dataType"="string", "required"=false},
246 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
247 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
248 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
252 * @return JsonResponse
254 public function patchEntriesAction(Entry
$entry, Request
$request)
256 $this->validateAuthentication();
257 $this->validateUserAccess($entry->getUser()->getId());
259 $title = $request->request
->get('title');
260 $isArchived = $request->request
->get('archive');
261 $isStarred = $request->request
->get('starred');
263 if (!is_null($title)) {
264 $entry->setTitle($title);
267 if (!is_null($isArchived)) {
268 $entry->setArchived((bool) $isArchived);
271 if (!is_null($isStarred)) {
272 $entry->setStarred((bool) $isStarred);
275 $tags = $request->request
->get('tags', '');
277 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
280 $em = $this->getDoctrine()->getManager();
283 $json = $this->get('serializer')->serialize($entry, 'json');
285 return (new JsonResponse())->setJson($json);
289 * Delete **permanently** an entry.
293 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
297 * @return JsonResponse
299 public function deleteEntriesAction(Entry
$entry)
301 $this->validateAuthentication();
302 $this->validateUserAccess($entry->getUser()->getId());
304 $em = $this->getDoctrine()->getManager();
308 // entry deleted, dispatch event about it!
309 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent
::NAME
, new EntryDeletedEvent($entry));
311 $json = $this->get('serializer')->serialize($entry, 'json');
313 return (new JsonResponse())->setJson($json);
317 * Retrieve all tags for an entry.
321 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
325 * @return JsonResponse
327 public function getEntriesTagsAction(Entry
$entry)
329 $this->validateAuthentication();
330 $this->validateUserAccess($entry->getUser()->getId());
332 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
334 return (new JsonResponse())->setJson($json);
338 * Add one or more tags to an entry.
342 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
345 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
349 * @return JsonResponse
351 public function postEntriesTagsAction(Request
$request, Entry
$entry)
353 $this->validateAuthentication();
354 $this->validateUserAccess($entry->getUser()->getId());
356 $tags = $request->request
->get('tags', '');
358 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
361 $em = $this->getDoctrine()->getManager();
362 $em->persist($entry);
365 $json = $this->get('serializer')->serialize($entry, 'json');
367 return (new JsonResponse())->setJson($json);
371 * Permanently remove one tag for an entry.
375 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
376 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
380 * @return JsonResponse
382 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
384 $this->validateAuthentication();
385 $this->validateUserAccess($entry->getUser()->getId());
387 $entry->removeTag($tag);
388 $em = $this->getDoctrine()->getManager();
389 $em->persist($entry);
392 $json = $this->get('serializer')->serialize($entry, 'json');
394 return (new JsonResponse())->setJson($json);