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