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