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