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