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