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