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