]>
Commit | Line | Data |
---|---|---|
f8bf8952 NL |
1 | <?php |
2 | ||
769e19dc | 3 | namespace Wallabag\ApiBundle\Controller; |
f8bf8952 | 4 | |
fcb1fba5 | 5 | use FOS\RestBundle\Controller\FOSRestController; |
619cc453 JB |
6 | use Hateoas\Configuration\Route; |
7 | use Hateoas\Representation\Factory\PagerfantaFactory; | |
f8bf8952 | 8 | use Nelmio\ApiDocBundle\Annotation\ApiDoc; |
27f15aa4 | 9 | use Symfony\Component\HttpFoundation\Request; |
b0cce9e6 | 10 | use Symfony\Component\HttpFoundation\Response; |
1d76102a | 11 | use Symfony\Component\Routing\Generator\UrlGeneratorInterface; |
b0b893ea | 12 | use Symfony\Component\Security\Core\Exception\AccessDeniedException; |
be463487 | 13 | use Wallabag\CoreBundle\Entity\Entry; |
653e8be4 | 14 | use Wallabag\CoreBundle\Entity\Tag; |
f8bf8952 | 15 | |
fcb1fba5 | 16 | class WallabagRestController extends FOSRestController |
f8bf8952 | 17 | { |
77273253 NL |
18 | private function validateAuthentication() |
19 | { | |
18f8f32f | 20 | if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) { |
77273253 NL |
21 | throw new AccessDeniedException(); |
22 | } | |
23 | } | |
24 | ||
f8bf8952 | 25 | /** |
a8c90c5c | 26 | * Retrieve all entries. It could be filtered by many options. |
f8bf8952 NL |
27 | * |
28 | * @ApiDoc( | |
a8c90c5c | 29 | * parameters={ |
189ef634 TC |
30 | * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."}, |
31 | * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."}, | |
a8c90c5c NL |
32 | * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."}, |
33 | * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."}, | |
34 | * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."}, | |
35 | * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."}, | |
189ef634 | 36 | * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."}, |
e5fb89e5 | 37 | * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."}, |
a8c90c5c | 38 | * } |
f8bf8952 | 39 | * ) |
4346a860 | 40 | * |
8eedc8cf | 41 | * @return Response |
f8bf8952 | 42 | */ |
27f15aa4 | 43 | public function getEntriesAction(Request $request) |
f8bf8952 | 44 | { |
77273253 NL |
45 | $this->validateAuthentication(); |
46 | ||
0135c98b NL |
47 | $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive'); |
48 | $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred'); | |
8ce32af6 JB |
49 | $sort = $request->query->get('sort', 'created'); |
50 | $order = $request->query->get('order', 'desc'); | |
51 | $page = (int) $request->query->get('page', 1); | |
52 | $perPage = (int) $request->query->get('perPage', 30); | |
e43c78ab | 53 | $since = $request->query->get('since', 0); |
a8c90c5c | 54 | |
fc732227 | 55 | $pager = $this->getDoctrine() |
be463487 | 56 | ->getRepository('WallabagCoreBundle:Entry') |
e5fb89e5 | 57 | ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since); |
a8c90c5c | 58 | |
6e22bd73 WD |
59 | $pager->setCurrentPage($page); |
60 | $pager->setMaxPerPage($perPage); | |
61 | ||
8ce32af6 | 62 | $pagerfantaFactory = new PagerfantaFactory('page', 'perPage'); |
6e22bd73 WD |
63 | $paginatedCollection = $pagerfantaFactory->createRepresentation( |
64 | $pager, | |
1d76102a | 65 | new Route('api_get_entries', [], UrlGeneratorInterface::ABSOLUTE_URL) |
6e22bd73 WD |
66 | ); |
67 | ||
68 | $json = $this->get('serializer')->serialize($paginatedCollection, 'json'); | |
0f006880 | 69 | |
769e19dc | 70 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
71 | } |
72 | ||
73 | /** | |
4346a860 | 74 | * Retrieve a single entry. |
f8bf8952 NL |
75 | * |
76 | * @ApiDoc( | |
77 | * requirements={ | |
78 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
79 | * } | |
80 | * ) | |
4346a860 | 81 | * |
8eedc8cf | 82 | * @return Response |
f8bf8952 | 83 | */ |
be463487 | 84 | public function getEntryAction(Entry $entry) |
f8bf8952 | 85 | { |
77273253 | 86 | $this->validateAuthentication(); |
fcb1fba5 | 87 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 88 | |
aa4d6562 | 89 | $json = $this->get('serializer')->serialize($entry, 'json'); |
0f006880 | 90 | |
769e19dc | 91 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
92 | } |
93 | ||
94 | /** | |
4346a860 | 95 | * Create an entry. |
f8bf8952 NL |
96 | * |
97 | * @ApiDoc( | |
a8c90c5c NL |
98 | * parameters={ |
99 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, | |
100 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, | |
101 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
189ef634 TC |
102 | * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"}, |
103 | * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"}, | |
a8c90c5c | 104 | * } |
f8bf8952 | 105 | * ) |
4346a860 | 106 | * |
8eedc8cf | 107 | * @return Response |
f8bf8952 | 108 | */ |
843dbe51 | 109 | public function postEntriesAction(Request $request) |
f8bf8952 | 110 | { |
77273253 NL |
111 | $this->validateAuthentication(); |
112 | ||
c3235553 | 113 | $url = $request->request->get('url'); |
51a15609 | 114 | $title = $request->request->get('title'); |
873e3806 YE |
115 | $isArchived = $request->request->get('archive'); |
116 | $isStarred = $request->request->get('starred'); | |
c3235553 | 117 | |
3107f92a TC |
118 | $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId()); |
119 | ||
120 | if (false === $entry) { | |
121 | $entry = $this->get('wallabag_core.content_proxy')->updateEntry( | |
122 | new Entry($this->getUser()), | |
123 | $url | |
124 | ); | |
125 | } | |
092ca707 | 126 | |
51a15609 NL |
127 | if (!is_null($title)) { |
128 | $entry->setTitle($title); | |
129 | } | |
130 | ||
0ca374e6 NL |
131 | $tags = $request->request->get('tags', ''); |
132 | if (!empty($tags)) { | |
c2656f96 | 133 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 134 | } |
092ca707 | 135 | |
bc2b947c TC |
136 | if (!is_null($isStarred)) { |
137 | $entry->setStarred((bool) $isStarred); | |
138 | } | |
816ad405 | 139 | |
bc2b947c TC |
140 | if (!is_null($isArchived)) { |
141 | $entry->setArchived((bool) $isArchived); | |
142 | } | |
816ad405 | 143 | |
843dbe51 NL |
144 | $em = $this->getDoctrine()->getManager(); |
145 | $em->persist($entry); | |
816ad405 | 146 | |
843dbe51 NL |
147 | $em->flush(); |
148 | ||
aa4d6562 NL |
149 | $json = $this->get('serializer')->serialize($entry, 'json'); |
150 | ||
769e19dc | 151 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
152 | } |
153 | ||
154 | /** | |
4346a860 | 155 | * Change several properties of an entry. |
f8bf8952 NL |
156 | * |
157 | * @ApiDoc( | |
158 | * requirements={ | |
159 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
160 | * }, |
161 | * parameters={ | |
162 | * {"name"="title", "dataType"="string", "required"=false}, | |
163 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
189ef634 TC |
164 | * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."}, |
165 | * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."}, | |
1d147791 | 166 | * } |
f8bf8952 | 167 | * ) |
4346a860 | 168 | * |
8eedc8cf | 169 | * @return Response |
f8bf8952 | 170 | */ |
be463487 | 171 | public function patchEntriesAction(Entry $entry, Request $request) |
f8bf8952 | 172 | { |
77273253 | 173 | $this->validateAuthentication(); |
fcb1fba5 | 174 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 175 | |
8ce32af6 | 176 | $title = $request->request->get('title'); |
614a0bfd YE |
177 | $isArchived = $request->request->get('archive'); |
178 | $isStarred = $request->request->get('starred'); | |
2c093b03 NL |
179 | |
180 | if (!is_null($title)) { | |
181 | $entry->setTitle($title); | |
182 | } | |
183 | ||
184 | if (!is_null($isArchived)) { | |
189ef634 | 185 | $entry->setArchived((bool) $isArchived); |
2c093b03 NL |
186 | } |
187 | ||
2c093b03 | 188 | if (!is_null($isStarred)) { |
189ef634 | 189 | $entry->setStarred((bool) $isStarred); |
2c093b03 NL |
190 | } |
191 | ||
0ca374e6 NL |
192 | $tags = $request->request->get('tags', ''); |
193 | if (!empty($tags)) { | |
c2656f96 | 194 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 195 | } |
092ca707 | 196 | |
2c093b03 | 197 | $em = $this->getDoctrine()->getManager(); |
2c093b03 NL |
198 | $em->flush(); |
199 | ||
0ca374e6 NL |
200 | $json = $this->get('serializer')->serialize($entry, 'json'); |
201 | ||
769e19dc | 202 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
203 | } |
204 | ||
205 | /** | |
4346a860 | 206 | * Delete **permanently** an entry. |
f8bf8952 NL |
207 | * |
208 | * @ApiDoc( | |
a8c90c5c NL |
209 | * requirements={ |
210 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
211 | * } | |
f8bf8952 | 212 | * ) |
4346a860 | 213 | * |
8eedc8cf | 214 | * @return Response |
f8bf8952 | 215 | */ |
be463487 | 216 | public function deleteEntriesAction(Entry $entry) |
f8bf8952 | 217 | { |
77273253 | 218 | $this->validateAuthentication(); |
fcb1fba5 | 219 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 220 | |
42a90646 | 221 | $em = $this->getDoctrine()->getManager(); |
1d147791 | 222 | $em->remove($entry); |
42a90646 NL |
223 | $em->flush(); |
224 | ||
1d147791 NL |
225 | $json = $this->get('serializer')->serialize($entry, 'json'); |
226 | ||
769e19dc | 227 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
228 | } |
229 | ||
230 | /** | |
4346a860 | 231 | * Retrieve all tags for an entry. |
f8bf8952 NL |
232 | * |
233 | * @ApiDoc( | |
234 | * requirements={ | |
235 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
236 | * } | |
237 | * ) | |
8eedc8cf JB |
238 | * |
239 | * @return Response | |
f8bf8952 | 240 | */ |
be463487 | 241 | public function getEntriesTagsAction(Entry $entry) |
7df80cb3 | 242 | { |
77273253 | 243 | $this->validateAuthentication(); |
fcb1fba5 | 244 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 245 | |
1bd12b62 | 246 | $json = $this->get('serializer')->serialize($entry->getTags(), 'json'); |
0a018fe0 | 247 | |
769e19dc | 248 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
249 | } |
250 | ||
251 | /** | |
4346a860 | 252 | * Add one or more tags to an entry. |
f8bf8952 NL |
253 | * |
254 | * @ApiDoc( | |
255 | * requirements={ | |
256 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
257 | * }, |
258 | * parameters={ | |
259 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
260 | * } | |
f8bf8952 | 261 | * ) |
8eedc8cf JB |
262 | * |
263 | * @return Response | |
f8bf8952 | 264 | */ |
a36737f4 | 265 | public function postEntriesTagsAction(Request $request, Entry $entry) |
7df80cb3 | 266 | { |
77273253 | 267 | $this->validateAuthentication(); |
fcb1fba5 | 268 | $this->validateUserAccess($entry->getUser()->getId()); |
a36737f4 | 269 | |
0ca374e6 NL |
270 | $tags = $request->request->get('tags', ''); |
271 | if (!empty($tags)) { | |
c2656f96 | 272 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 273 | } |
092ca707 | 274 | |
a36737f4 NL |
275 | $em = $this->getDoctrine()->getManager(); |
276 | $em->persist($entry); | |
277 | $em->flush(); | |
278 | ||
279 | $json = $this->get('serializer')->serialize($entry, 'json'); | |
280 | ||
769e19dc | 281 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
282 | } |
283 | ||
284 | /** | |
4346a860 | 285 | * Permanently remove one tag for an entry. |
f8bf8952 NL |
286 | * |
287 | * @ApiDoc( | |
288 | * requirements={ | |
769e19dc | 289 | * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"}, |
f8bf8952 NL |
290 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} |
291 | * } | |
292 | * ) | |
8eedc8cf JB |
293 | * |
294 | * @return Response | |
f8bf8952 | 295 | */ |
653e8be4 | 296 | public function deleteEntriesTagsAction(Entry $entry, Tag $tag) |
f8bf8952 | 297 | { |
77273253 | 298 | $this->validateAuthentication(); |
fcb1fba5 | 299 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 NL |
300 | |
301 | $entry->removeTag($tag); | |
302 | $em = $this->getDoctrine()->getManager(); | |
303 | $em->persist($entry); | |
304 | $em->flush(); | |
305 | ||
306 | $json = $this->get('serializer')->serialize($entry, 'json'); | |
307 | ||
769e19dc | 308 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
309 | } |
310 | ||
311 | /** | |
4346a860 | 312 | * Retrieve all tags. |
f8bf8952 | 313 | * |
092ca707 | 314 | * @ApiDoc() |
8eedc8cf JB |
315 | * |
316 | * @return Response | |
f8bf8952 | 317 | */ |
092ca707 | 318 | public function getTagsAction() |
7df80cb3 | 319 | { |
77273253 | 320 | $this->validateAuthentication(); |
fc732227 JB |
321 | |
322 | $tags = $this->getDoctrine() | |
323 | ->getRepository('WallabagCoreBundle:Tag') | |
324 | ->findAllTags($this->getUser()->getId()); | |
325 | ||
326 | $json = $this->get('serializer')->serialize($tags, 'json'); | |
092ca707 | 327 | |
769e19dc | 328 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
329 | } |
330 | ||
f8bf8952 | 331 | /** |
4346a860 | 332 | * Permanently remove one tag from **every** entry. |
f8bf8952 NL |
333 | * |
334 | * @ApiDoc( | |
335 | * requirements={ | |
769e19dc | 336 | * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"} |
f8bf8952 NL |
337 | * } |
338 | * ) | |
8eedc8cf JB |
339 | * |
340 | * @return Response | |
f8bf8952 | 341 | */ |
653e8be4 | 342 | public function deleteTagAction(Tag $tag) |
f8bf8952 | 343 | { |
77273253 | 344 | $this->validateAuthentication(); |
fc732227 JB |
345 | |
346 | $this->getDoctrine() | |
347 | ->getRepository('WallabagCoreBundle:Entry') | |
348 | ->removeTag($this->getUser()->getId(), $tag); | |
092ca707 | 349 | |
092ca707 NL |
350 | $json = $this->get('serializer')->serialize($tag, 'json'); |
351 | ||
769e19dc J |
352 | return $this->renderJsonResponse($json); |
353 | } | |
2b477030 | 354 | /** |
6f8310b4 TC |
355 | * Retrieve version number. |
356 | * | |
357 | * @ApiDoc() | |
2b477030 V |
358 | * |
359 | * @return Response | |
360 | */ | |
361 | public function getVersionAction() | |
362 | { | |
363 | $version = $this->container->getParameter('wallabag_core.version'); | |
364 | ||
365 | $json = $this->get('serializer')->serialize($version, 'json'); | |
366 | ||
367 | return $this->renderJsonResponse($json); | |
368 | } | |
769e19dc J |
369 | |
370 | /** | |
371 | * Validate that the first id is equal to the second one. | |
4346a860 | 372 | * If not, throw exception. It means a user try to access information from an other user. |
769e19dc | 373 | * |
4346a860 | 374 | * @param int $requestUserId User id from the requested source |
769e19dc | 375 | */ |
fcb1fba5 | 376 | private function validateUserAccess($requestUserId) |
769e19dc | 377 | { |
18f8f32f | 378 | $user = $this->get('security.token_storage')->getToken()->getUser(); |
fcb1fba5 NL |
379 | if ($requestUserId != $user->getId()) { |
380 | throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId()); | |
769e19dc J |
381 | } |
382 | } | |
383 | ||
384 | /** | |
385 | * Send a JSON Response. | |
4346a860 | 386 | * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string. |
769e19dc J |
387 | * |
388 | * @param string $json | |
389 | * | |
390 | * @return Response | |
391 | */ | |
392 | private function renderJsonResponse($json) | |
393 | { | |
4094ea47 | 394 | return new Response($json, 200, ['application/json']); |
f8bf8952 | 395 | } |
7df80cb3 | 396 | } |