]>
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={ |
2c093b03 NL |
30 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."}, |
31 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, 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."}, | |
36 | * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."}, | |
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 | ||
6e334aba | 46 | $isArchived = $request->query->get('archive'); |
8ce32af6 JB |
47 | $isStarred = $request->query->get('star'); |
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') |
1d147791 | 55 | ->findEntries($this->getUser()->getId(), $isArchived, $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."}, | |
816ad405 TC |
100 | * {"name"="starred", "dataType"="boolean", "required"=false, "format"="true or false", "description"="entry already starred"}, |
101 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "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'); |
816ad405 TC |
112 | $isArchived = $request->request->get('archive'); |
113 | $isStarred = $request->request->get('starred'); | |
c3235553 | 114 | |
558d9aab JB |
115 | $entry = $this->get('wallabag_core.content_proxy')->updateEntry( |
116 | new Entry($this->getUser()), | |
117 | $url | |
118 | ); | |
092ca707 | 119 | |
0ca374e6 NL |
120 | $tags = $request->request->get('tags', ''); |
121 | if (!empty($tags)) { | |
c2656f96 | 122 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 123 | } |
092ca707 | 124 | |
11a45281 TC |
125 | if (true === (bool) $isStarred) { |
126 | $entry->setStarred(true); | |
816ad405 TC |
127 | } |
128 | ||
11a45281 TC |
129 | if (true === (bool) $isArchived) { |
130 | $entry->setArchived(true); | |
816ad405 TC |
131 | } |
132 | ||
843dbe51 NL |
133 | $em = $this->getDoctrine()->getManager(); |
134 | $em->persist($entry); | |
816ad405 | 135 | |
843dbe51 NL |
136 | $em->flush(); |
137 | ||
aa4d6562 NL |
138 | $json = $this->get('serializer')->serialize($entry, 'json'); |
139 | ||
769e19dc | 140 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
141 | } |
142 | ||
143 | /** | |
4346a860 | 144 | * Change several properties of an entry. |
f8bf8952 NL |
145 | * |
146 | * @ApiDoc( | |
147 | * requirements={ | |
148 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
149 | * }, |
150 | * parameters={ | |
151 | * {"name"="title", "dataType"="string", "required"=false}, | |
152 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
2c093b03 NL |
153 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."}, |
154 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."}, | |
1d147791 | 155 | * } |
f8bf8952 | 156 | * ) |
4346a860 | 157 | * |
8eedc8cf | 158 | * @return Response |
f8bf8952 | 159 | */ |
be463487 | 160 | public function patchEntriesAction(Entry $entry, Request $request) |
f8bf8952 | 161 | { |
77273253 | 162 | $this->validateAuthentication(); |
fcb1fba5 | 163 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 164 | |
8ce32af6 | 165 | $title = $request->request->get('title'); |
01fddd0c JB |
166 | $isArchived = $request->request->get('archive'); |
167 | $isStarred = $request->request->get('star'); | |
2c093b03 NL |
168 | |
169 | if (!is_null($title)) { | |
170 | $entry->setTitle($title); | |
171 | } | |
172 | ||
173 | if (!is_null($isArchived)) { | |
905ae369 | 174 | $entry->setArchived($isArchived); |
2c093b03 NL |
175 | } |
176 | ||
2c093b03 | 177 | if (!is_null($isStarred)) { |
905ae369 | 178 | $entry->setStarred($isStarred); |
2c093b03 NL |
179 | } |
180 | ||
0ca374e6 NL |
181 | $tags = $request->request->get('tags', ''); |
182 | if (!empty($tags)) { | |
c2656f96 | 183 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 184 | } |
092ca707 | 185 | |
2c093b03 | 186 | $em = $this->getDoctrine()->getManager(); |
2c093b03 NL |
187 | $em->flush(); |
188 | ||
0ca374e6 NL |
189 | $json = $this->get('serializer')->serialize($entry, 'json'); |
190 | ||
769e19dc | 191 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
192 | } |
193 | ||
194 | /** | |
4346a860 | 195 | * Delete **permanently** an entry. |
f8bf8952 NL |
196 | * |
197 | * @ApiDoc( | |
a8c90c5c NL |
198 | * requirements={ |
199 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
200 | * } | |
f8bf8952 | 201 | * ) |
4346a860 | 202 | * |
8eedc8cf | 203 | * @return Response |
f8bf8952 | 204 | */ |
be463487 | 205 | public function deleteEntriesAction(Entry $entry) |
f8bf8952 | 206 | { |
77273253 | 207 | $this->validateAuthentication(); |
fcb1fba5 | 208 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 209 | |
42a90646 | 210 | $em = $this->getDoctrine()->getManager(); |
1d147791 | 211 | $em->remove($entry); |
42a90646 NL |
212 | $em->flush(); |
213 | ||
1d147791 NL |
214 | $json = $this->get('serializer')->serialize($entry, 'json'); |
215 | ||
769e19dc | 216 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
217 | } |
218 | ||
219 | /** | |
4346a860 | 220 | * Retrieve all tags for an entry. |
f8bf8952 NL |
221 | * |
222 | * @ApiDoc( | |
223 | * requirements={ | |
224 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
225 | * } | |
226 | * ) | |
8eedc8cf JB |
227 | * |
228 | * @return Response | |
f8bf8952 | 229 | */ |
be463487 | 230 | public function getEntriesTagsAction(Entry $entry) |
7df80cb3 | 231 | { |
77273253 | 232 | $this->validateAuthentication(); |
fcb1fba5 | 233 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 234 | |
1bd12b62 | 235 | $json = $this->get('serializer')->serialize($entry->getTags(), 'json'); |
0a018fe0 | 236 | |
769e19dc | 237 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
238 | } |
239 | ||
240 | /** | |
4346a860 | 241 | * Add one or more tags to an entry. |
f8bf8952 NL |
242 | * |
243 | * @ApiDoc( | |
244 | * requirements={ | |
245 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
246 | * }, |
247 | * parameters={ | |
248 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
249 | * } | |
f8bf8952 | 250 | * ) |
8eedc8cf JB |
251 | * |
252 | * @return Response | |
f8bf8952 | 253 | */ |
a36737f4 | 254 | public function postEntriesTagsAction(Request $request, Entry $entry) |
7df80cb3 | 255 | { |
77273253 | 256 | $this->validateAuthentication(); |
fcb1fba5 | 257 | $this->validateUserAccess($entry->getUser()->getId()); |
a36737f4 | 258 | |
0ca374e6 NL |
259 | $tags = $request->request->get('tags', ''); |
260 | if (!empty($tags)) { | |
c2656f96 | 261 | $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags); |
0ca374e6 | 262 | } |
092ca707 | 263 | |
a36737f4 NL |
264 | $em = $this->getDoctrine()->getManager(); |
265 | $em->persist($entry); | |
266 | $em->flush(); | |
267 | ||
268 | $json = $this->get('serializer')->serialize($entry, 'json'); | |
269 | ||
769e19dc | 270 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
271 | } |
272 | ||
273 | /** | |
4346a860 | 274 | * Permanently remove one tag for an entry. |
f8bf8952 NL |
275 | * |
276 | * @ApiDoc( | |
277 | * requirements={ | |
769e19dc | 278 | * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"}, |
f8bf8952 NL |
279 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} |
280 | * } | |
281 | * ) | |
8eedc8cf JB |
282 | * |
283 | * @return Response | |
f8bf8952 | 284 | */ |
653e8be4 | 285 | public function deleteEntriesTagsAction(Entry $entry, Tag $tag) |
f8bf8952 | 286 | { |
77273253 | 287 | $this->validateAuthentication(); |
fcb1fba5 | 288 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 NL |
289 | |
290 | $entry->removeTag($tag); | |
291 | $em = $this->getDoctrine()->getManager(); | |
292 | $em->persist($entry); | |
293 | $em->flush(); | |
294 | ||
295 | $json = $this->get('serializer')->serialize($entry, 'json'); | |
296 | ||
769e19dc | 297 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
298 | } |
299 | ||
300 | /** | |
4346a860 | 301 | * Retrieve all tags. |
f8bf8952 | 302 | * |
092ca707 | 303 | * @ApiDoc() |
8eedc8cf JB |
304 | * |
305 | * @return Response | |
f8bf8952 | 306 | */ |
092ca707 | 307 | public function getTagsAction() |
7df80cb3 | 308 | { |
77273253 | 309 | $this->validateAuthentication(); |
fc732227 JB |
310 | |
311 | $tags = $this->getDoctrine() | |
312 | ->getRepository('WallabagCoreBundle:Tag') | |
313 | ->findAllTags($this->getUser()->getId()); | |
314 | ||
315 | $json = $this->get('serializer')->serialize($tags, 'json'); | |
092ca707 | 316 | |
769e19dc | 317 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
318 | } |
319 | ||
f8bf8952 | 320 | /** |
4346a860 | 321 | * Permanently remove one tag from **every** entry. |
f8bf8952 NL |
322 | * |
323 | * @ApiDoc( | |
324 | * requirements={ | |
769e19dc | 325 | * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"} |
f8bf8952 NL |
326 | * } |
327 | * ) | |
8eedc8cf JB |
328 | * |
329 | * @return Response | |
f8bf8952 | 330 | */ |
653e8be4 | 331 | public function deleteTagAction(Tag $tag) |
f8bf8952 | 332 | { |
77273253 | 333 | $this->validateAuthentication(); |
fc732227 JB |
334 | |
335 | $this->getDoctrine() | |
336 | ->getRepository('WallabagCoreBundle:Entry') | |
337 | ->removeTag($this->getUser()->getId(), $tag); | |
092ca707 | 338 | |
092ca707 NL |
339 | $json = $this->get('serializer')->serialize($tag, 'json'); |
340 | ||
769e19dc J |
341 | return $this->renderJsonResponse($json); |
342 | } | |
2b477030 | 343 | /** |
6f8310b4 TC |
344 | * Retrieve version number. |
345 | * | |
346 | * @ApiDoc() | |
2b477030 V |
347 | * |
348 | * @return Response | |
349 | */ | |
350 | public function getVersionAction() | |
351 | { | |
352 | $version = $this->container->getParameter('wallabag_core.version'); | |
353 | ||
354 | $json = $this->get('serializer')->serialize($version, 'json'); | |
355 | ||
356 | return $this->renderJsonResponse($json); | |
357 | } | |
769e19dc J |
358 | |
359 | /** | |
360 | * Validate that the first id is equal to the second one. | |
4346a860 | 361 | * If not, throw exception. It means a user try to access information from an other user. |
769e19dc | 362 | * |
4346a860 | 363 | * @param int $requestUserId User id from the requested source |
769e19dc | 364 | */ |
fcb1fba5 | 365 | private function validateUserAccess($requestUserId) |
769e19dc | 366 | { |
18f8f32f | 367 | $user = $this->get('security.token_storage')->getToken()->getUser(); |
fcb1fba5 NL |
368 | if ($requestUserId != $user->getId()) { |
369 | throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId()); | |
769e19dc J |
370 | } |
371 | } | |
372 | ||
373 | /** | |
374 | * Send a JSON Response. | |
4346a860 | 375 | * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string. |
769e19dc J |
376 | * |
377 | * @param string $json | |
378 | * | |
379 | * @return Response | |
380 | */ | |
381 | private function renderJsonResponse($json) | |
382 | { | |
db2b4bf6 | 383 | return new Response($json, 200, array('application/json')); |
f8bf8952 | 384 | } |
7df80cb3 | 385 | } |