]> git.immae.eu Git - github/wallabag/wallabag.git/blame - src/Wallabag/CoreBundle/Controller/WallabagRestController.php
fix tests
[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Controller / WallabagRestController.php
CommitLineData
f8bf8952
NL
1<?php
2
3namespace Wallabag\CoreBundle\Controller;
4
5use Nelmio\ApiDocBundle\Annotation\ApiDoc;
f8bf8952 6use Symfony\Bundle\FrameworkBundle\Controller\Controller;
27f15aa4 7use Symfony\Component\HttpFoundation\Request;
b0cce9e6 8use Symfony\Component\HttpFoundation\Response;
be463487 9use Wallabag\CoreBundle\Entity\Entry;
653e8be4 10use Wallabag\CoreBundle\Entity\Tag;
843dbe51 11use Wallabag\CoreBundle\Service\Extractor;
f8bf8952 12
a8c90c5c 13class WallabagRestController extends Controller
f8bf8952 14{
092ca707
NL
15 /**
16 * @param Entry $entry
17 * @param string $tags
18 */
19 private function assignTagsToEntry(Entry $entry, $tags)
20 {
21 foreach (explode(',', $tags) as $label) {
22 $label = trim($label);
23 $tagEntity = $this
24 ->getDoctrine()
25 ->getRepository('WallabagCoreBundle:Tag')
26 ->findOneByLabel($label);
27
28 if (is_null($tagEntity)) {
29 $tagEntity = new Tag($this->getUser());
30 $tagEntity->setLabel($label);
31 }
32
33 // only add the tag on the entry if the relation doesn't exist
34 if (!$entry->getTags()->contains($tagEntity)) {
35 $entry->addTag($tagEntity);
36 }
37 }
38 }
39
c5e8ba25
NL
40 /**
41 * Retrieve salt for a giver user.
42 *
6ee416a0 43 * @ApiDoc()
874e3e10 44 * @return array
c5e8ba25 45 */
6ee416a0 46 public function getSaltAction($username)
c5e8ba25
NL
47 {
48 $user = $this
49 ->getDoctrine()
50 ->getRepository('WallabagCoreBundle:User')
6ee416a0 51 ->findOneByUsername($username);
c5e8ba25
NL
52
53 if (is_null($user)) {
54 throw $this->createNotFoundException();
55 }
56
f170f315 57 return array($user->getSalt() ?: null);
c5e8ba25 58 }
f8bf8952 59 /**
a8c90c5c 60 * Retrieve all entries. It could be filtered by many options.
f8bf8952
NL
61 *
62 * @ApiDoc(
a8c90c5c 63 * parameters={
2c093b03
NL
64 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
65 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
a8c90c5c
NL
66 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
67 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
68 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
69 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
70 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
71 * }
f8bf8952 72 * )
be463487 73 * @return Entry
f8bf8952 74 */
27f15aa4 75 public function getEntriesAction(Request $request)
f8bf8952 76 {
6e334aba
NL
77 $isArchived = $request->query->get('archive');
78 $isStarred = $request->query->get('star');
a8c90c5c
NL
79 $sort = $request->query->get('sort', 'created');
80 $order = $request->query->get('order', 'desc');
81 $page = $request->query->get('page', 1);
82 $perPage = $request->query->get('perPage', 30);
83 $tags = $request->query->get('tags', array());
84
85 $entries = $this
86 ->getDoctrine()
be463487 87 ->getRepository('WallabagCoreBundle:Entry')
1d147791 88 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
a8c90c5c 89
3d3368cf 90 if (!($entries)) {
a8c90c5c
NL
91 throw $this->createNotFoundException();
92 }
93
aa4d6562 94 $json = $this->get('serializer')->serialize($entries, 'json');
0f006880 95
db2b4bf6 96 return new Response($json, 200, array('application/json'));
f8bf8952
NL
97 }
98
99 /**
a8c90c5c 100 * Retrieve a single entry
f8bf8952
NL
101 *
102 * @ApiDoc(
103 * requirements={
104 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
105 * }
106 * )
be463487 107 * @return Entry
f8bf8952 108 */
be463487 109 public function getEntryAction(Entry $entry)
f8bf8952 110 {
092ca707
NL
111 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
112 throw $this->createAccessDeniedException();
113 }
114
aa4d6562 115 $json = $this->get('serializer')->serialize($entry, 'json');
0f006880 116
db2b4bf6 117 return new Response($json, 200, array('application/json'));
f8bf8952
NL
118 }
119
120 /**
a8c90c5c 121 * Create an entry
f8bf8952
NL
122 *
123 * @ApiDoc(
a8c90c5c
NL
124 * parameters={
125 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
126 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
127 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
128 * }
f8bf8952 129 * )
be463487 130 * @return Entry
f8bf8952 131 */
843dbe51 132 public function postEntriesAction(Request $request)
f8bf8952 133 {
c3235553
NL
134 $url = $request->request->get('url');
135
136 $content = Extractor::extract($url);
d4c029f4 137 $entry = new Entry($this->getUser());
c3235553 138 $entry->setUrl($url);
9e0fff7c 139 $entry->setTitle($request->request->get('title') ?: $content->getTitle());
843dbe51 140 $entry->setContent($content->getBody());
092ca707 141
0ca374e6
NL
142 $tags = $request->request->get('tags', '');
143 if (!empty($tags)) {
144 $this->assignTagsToEntry($entry, $tags);
145 }
092ca707 146
843dbe51
NL
147 $em = $this->getDoctrine()->getManager();
148 $em->persist($entry);
149 $em->flush();
150
aa4d6562
NL
151 $json = $this->get('serializer')->serialize($entry, 'json');
152
db2b4bf6 153 return new Response($json, 200, array('application/json'));
f8bf8952
NL
154 }
155
156 /**
a8c90c5c 157 * Change several properties of an entry
f8bf8952
NL
158 *
159 * @ApiDoc(
160 * requirements={
161 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
a8c90c5c
NL
162 * },
163 * parameters={
164 * {"name"="title", "dataType"="string", "required"=false},
165 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
2c093b03
NL
166 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
167 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
1d147791 168 * }
f8bf8952 169 * )
be463487 170 * @return Entry
f8bf8952 171 */
be463487 172 public function patchEntriesAction(Entry $entry, Request $request)
f8bf8952 173 {
092ca707
NL
174 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
175 throw $this->createAccessDeniedException();
176 }
177
2c093b03 178 $title = $request->request->get("title");
2c093b03 179 $isArchived = $request->request->get("archive");
2c093b03
NL
180 $isStarred = $request->request->get("star");
181
182 if (!is_null($title)) {
183 $entry->setTitle($title);
184 }
185
186 if (!is_null($isArchived)) {
905ae369 187 $entry->setArchived($isArchived);
2c093b03
NL
188 }
189
2c093b03 190 if (!is_null($isStarred)) {
905ae369 191 $entry->setStarred($isStarred);
2c093b03
NL
192 }
193
0ca374e6
NL
194 $tags = $request->request->get('tags', '');
195 if (!empty($tags)) {
196 $this->assignTagsToEntry($entry, $tags);
197 }
092ca707 198
2c093b03 199 $em = $this->getDoctrine()->getManager();
2c093b03
NL
200 $em->flush();
201
0ca374e6
NL
202 $json = $this->get('serializer')->serialize($entry, 'json');
203
db2b4bf6 204 return new Response($json, 200, array('application/json'));
f8bf8952
NL
205 }
206
207 /**
a8c90c5c 208 * Delete **permanently** an entry
f8bf8952
NL
209 *
210 * @ApiDoc(
a8c90c5c
NL
211 * requirements={
212 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
213 * }
f8bf8952 214 * )
be463487 215 * @return Entry
f8bf8952 216 */
be463487 217 public function deleteEntriesAction(Entry $entry)
f8bf8952 218 {
092ca707
NL
219 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
220 throw $this->createAccessDeniedException();
221 }
222
42a90646 223 $em = $this->getDoctrine()->getManager();
1d147791 224 $em->remove($entry);
42a90646
NL
225 $em->flush();
226
1d147791
NL
227 $json = $this->get('serializer')->serialize($entry, 'json');
228
db2b4bf6 229 return new Response($json, 200, array('application/json'));
f8bf8952
NL
230 }
231
232 /**
a8c90c5c 233 * Retrieve all tags for an entry
f8bf8952
NL
234 *
235 * @ApiDoc(
236 * requirements={
237 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
238 * }
239 * )
240 */
be463487 241 public function getEntriesTagsAction(Entry $entry)
7df80cb3 242 {
092ca707
NL
243 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
244 throw $this->createAccessDeniedException();
245 }
246
1bd12b62 247 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
0a018fe0 248
b0cce9e6 249 return new Response($json, 200, array('application/json'));
f8bf8952
NL
250 }
251
252 /**
a8c90c5c 253 * Add one or more tags to an entry
f8bf8952
NL
254 *
255 * @ApiDoc(
256 * requirements={
257 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
a8c90c5c
NL
258 * },
259 * parameters={
260 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
261 * }
f8bf8952
NL
262 * )
263 */
a36737f4 264 public function postEntriesTagsAction(Request $request, Entry $entry)
7df80cb3 265 {
092ca707
NL
266 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
267 throw $this->createAccessDeniedException();
a36737f4
NL
268 }
269
0ca374e6
NL
270 $tags = $request->request->get('tags', '');
271 if (!empty($tags)) {
272 $this->assignTagsToEntry($entry, $tags);
273 }
092ca707 274
a36737f4
NL
275 $em = $this->getDoctrine()->getManager();
276 $em->persist($entry);
277 $em->flush();
278
279 $json = $this->get('serializer')->serialize($entry, 'json');
280
db2b4bf6 281 return new Response($json, 200, array('application/json'));
f8bf8952
NL
282 }
283
284 /**
a8c90c5c 285 * Permanently remove one tag for an entry
f8bf8952
NL
286 *
287 * @ApiDoc(
288 * requirements={
289 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
290 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
291 * }
292 * )
293 */
653e8be4 294 public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
f8bf8952 295 {
092ca707
NL
296 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
297 throw $this->createAccessDeniedException();
298 }
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
db2b4bf6 307 return new Response($json, 200, array('application/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
db2b4bf6 319 return new Response($json, 200, array('application/json'));
f8bf8952
NL
320 }
321
f8bf8952 322 /**
a8c90c5c 323 * Permanently remove one tag from **every** entry
f8bf8952
NL
324 *
325 * @ApiDoc(
326 * requirements={
327 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
328 * }
329 * )
330 */
653e8be4 331 public function deleteTagAction(Tag $tag)
f8bf8952 332 {
092ca707
NL
333 if ($tag->getUser()->getId() != $this->getUser()->getId()) {
334 throw $this->createAccessDeniedException();
335 }
336
337 $em = $this->getDoctrine()->getManager();
338 $em->remove($tag);
339 $em->flush();
340
341 $json = $this->get('serializer')->serialize($tag, 'json');
342
db2b4bf6 343 return new Response($json, 200, array('application/json'));
f8bf8952 344 }
7df80cb3 345}