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