]>
Commit | Line | Data |
---|---|---|
f8bf8952 NL |
1 | <?php |
2 | ||
769e19dc | 3 | namespace Wallabag\ApiBundle\Controller; |
f8bf8952 | 4 | |
fcb1fba5 | 5 | use FOS\RestBundle\Controller\FOSRestController; |
f8bf8952 | 6 | use Nelmio\ApiDocBundle\Annotation\ApiDoc; |
27f15aa4 | 7 | use Symfony\Component\HttpFoundation\Request; |
b0cce9e6 | 8 | use Symfony\Component\HttpFoundation\Response; |
be463487 | 9 | use Wallabag\CoreBundle\Entity\Entry; |
653e8be4 | 10 | use Wallabag\CoreBundle\Entity\Tag; |
6e22bd73 WD |
11 | use Hateoas\Configuration\Route; |
12 | use Hateoas\Representation\Factory\PagerfantaFactory; | |
f8bf8952 | 13 | |
fcb1fba5 | 14 | class WallabagRestController extends FOSRestController |
f8bf8952 | 15 | { |
092ca707 NL |
16 | /** |
17 | * @param Entry $entry | |
18 | * @param string $tags | |
19 | */ | |
20 | private function assignTagsToEntry(Entry $entry, $tags) | |
21 | { | |
22 | foreach (explode(',', $tags) as $label) { | |
23 | $label = trim($label); | |
24 | $tagEntity = $this | |
25 | ->getDoctrine() | |
26 | ->getRepository('WallabagCoreBundle:Tag') | |
27 | ->findOneByLabel($label); | |
28 | ||
29 | if (is_null($tagEntity)) { | |
fc732227 | 30 | $tagEntity = new Tag(); |
092ca707 NL |
31 | $tagEntity->setLabel($label); |
32 | } | |
33 | ||
34 | // only add the tag on the entry if the relation doesn't exist | |
35 | if (!$entry->getTags()->contains($tagEntity)) { | |
36 | $entry->addTag($tagEntity); | |
37 | } | |
38 | } | |
39 | } | |
40 | ||
77273253 NL |
41 | private function validateAuthentication() |
42 | { | |
18f8f32f | 43 | if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) { |
77273253 NL |
44 | throw new AccessDeniedException(); |
45 | } | |
46 | } | |
47 | ||
f8bf8952 | 48 | /** |
a8c90c5c | 49 | * Retrieve all entries. It could be filtered by many options. |
f8bf8952 NL |
50 | * |
51 | * @ApiDoc( | |
a8c90c5c | 52 | * parameters={ |
2c093b03 NL |
53 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."}, |
54 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."}, | |
a8c90c5c NL |
55 | * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."}, |
56 | * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."}, | |
57 | * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."}, | |
58 | * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."}, | |
59 | * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."}, | |
60 | * } | |
f8bf8952 | 61 | * ) |
4346a860 | 62 | * |
8eedc8cf | 63 | * @return Response |
f8bf8952 | 64 | */ |
27f15aa4 | 65 | public function getEntriesAction(Request $request) |
f8bf8952 | 66 | { |
77273253 NL |
67 | $this->validateAuthentication(); |
68 | ||
6e334aba | 69 | $isArchived = $request->query->get('archive'); |
8ce32af6 JB |
70 | $isStarred = $request->query->get('star'); |
71 | $sort = $request->query->get('sort', 'created'); | |
72 | $order = $request->query->get('order', 'desc'); | |
73 | $page = (int) $request->query->get('page', 1); | |
74 | $perPage = (int) $request->query->get('perPage', 30); | |
75 | $tags = $request->query->get('tags', []); | |
a8c90c5c | 76 | |
fc732227 | 77 | $pager = $this->getDoctrine() |
be463487 | 78 | ->getRepository('WallabagCoreBundle:Entry') |
1d147791 | 79 | ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order); |
a8c90c5c | 80 | |
6e22bd73 WD |
81 | $pager->setCurrentPage($page); |
82 | $pager->setMaxPerPage($perPage); | |
83 | ||
8ce32af6 | 84 | $pagerfantaFactory = new PagerfantaFactory('page', 'perPage'); |
6e22bd73 WD |
85 | $paginatedCollection = $pagerfantaFactory->createRepresentation( |
86 | $pager, | |
87 | new Route('api_get_entries', [], $absolute = true) | |
88 | ); | |
89 | ||
90 | $json = $this->get('serializer')->serialize($paginatedCollection, 'json'); | |
0f006880 | 91 | |
769e19dc | 92 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
93 | } |
94 | ||
95 | /** | |
4346a860 | 96 | * Retrieve a single entry. |
f8bf8952 NL |
97 | * |
98 | * @ApiDoc( | |
99 | * requirements={ | |
100 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
101 | * } | |
102 | * ) | |
4346a860 | 103 | * |
8eedc8cf | 104 | * @return Response |
f8bf8952 | 105 | */ |
be463487 | 106 | public function getEntryAction(Entry $entry) |
f8bf8952 | 107 | { |
77273253 | 108 | $this->validateAuthentication(); |
fcb1fba5 | 109 | $this->validateUserAccess($entry->getUser()->getId()); |
092ca707 | 110 | |
aa4d6562 | 111 | $json = $this->get('serializer')->serialize($entry, 'json'); |
0f006880 | 112 | |
769e19dc | 113 | return $this->renderJsonResponse($json); |
f8bf8952 NL |
114 | } |
115 | ||
116 | /** | |
4346a860 | 117 | * Create an entry. |
f8bf8952 NL |
118 | * |
119 | * @ApiDoc( | |
a8c90c5c NL |
120 | * parameters={ |
121 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, | |
122 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, | |
123 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
124 | * } | |
f8bf8952 | 125 | * ) |
4346a860 | 126 | * |
8eedc8cf | 127 | * @return Response |
f8bf8952 | 128 | */ |
843dbe51 | 129 | public function postEntriesAction(Request $request) |
f8bf8952 | 130 | { |
77273253 NL |
131 | $this->validateAuthentication(); |
132 | ||
c3235553 NL |
133 | $url = $request->request->get('url'); |
134 | ||
558d9aab JB |
135 | $entry = $this->get('wallabag_core.content_proxy')->updateEntry( |
136 | new Entry($this->getUser()), | |
137 | $url | |
138 | ); | |
092ca707 | 139 | |
0ca374e6 NL |
140 | $tags = $request->request->get('tags', ''); |
141 | if (!empty($tags)) { | |
142 | $this->assignTagsToEntry($entry, $tags); | |
143 | } | |
092ca707 | 144 | |
843dbe51 NL |
145 | $em = $this->getDoctrine()->getManager(); |
146 | $em->persist($entry); | |
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."}, | |
2c093b03 NL |
164 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."}, |
165 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "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'); |
01fddd0c JB |
177 | $isArchived = $request->request->get('archive'); |
178 | $isStarred = $request->request->get('star'); | |
2c093b03 NL |
179 | |
180 | if (!is_null($title)) { | |
181 | $entry->setTitle($title); | |
182 | } | |
183 | ||
184 | if (!is_null($isArchived)) { | |
905ae369 | 185 | $entry->setArchived($isArchived); |
2c093b03 NL |
186 | } |
187 | ||
2c093b03 | 188 | if (!is_null($isStarred)) { |
905ae369 | 189 | $entry->setStarred($isStarred); |
2c093b03 NL |
190 | } |
191 | ||
0ca374e6 NL |
192 | $tags = $request->request->get('tags', ''); |
193 | if (!empty($tags)) { | |
194 | $this->assignTagsToEntry($entry, $tags); | |
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)) { | |
272 | $this->assignTagsToEntry($entry, $tags); | |
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 | } | |
354 | ||
355 | /** | |
356 | * Validate that the first id is equal to the second one. | |
4346a860 | 357 | * If not, throw exception. It means a user try to access information from an other user. |
769e19dc | 358 | * |
4346a860 | 359 | * @param int $requestUserId User id from the requested source |
769e19dc | 360 | */ |
fcb1fba5 | 361 | private function validateUserAccess($requestUserId) |
769e19dc | 362 | { |
18f8f32f | 363 | $user = $this->get('security.token_storage')->getToken()->getUser(); |
fcb1fba5 NL |
364 | if ($requestUserId != $user->getId()) { |
365 | throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId()); | |
769e19dc J |
366 | } |
367 | } | |
368 | ||
369 | /** | |
370 | * Send a JSON Response. | |
4346a860 | 371 | * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string. |
769e19dc J |
372 | * |
373 | * @param string $json | |
374 | * | |
375 | * @return Response | |
376 | */ | |
377 | private function renderJsonResponse($json) | |
378 | { | |
db2b4bf6 | 379 | return new Response($json, 200, array('application/json')); |
f8bf8952 | 380 | } |
7df80cb3 | 381 | } |