]>
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."}, | |
46 | * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted status."}, | |
a8c90c5c NL |
47 | * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."}, |
48 | * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."}, | |
49 | * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."}, | |
50 | * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."}, | |
51 | * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."}, | |
52 | * } | |
f8bf8952 | 53 | * ) |
be463487 | 54 | * @return Entry |
f8bf8952 | 55 | */ |
27f15aa4 | 56 | public function getEntriesAction(Request $request) |
f8bf8952 | 57 | { |
6e334aba NL |
58 | $isArchived = $request->query->get('archive'); |
59 | $isStarred = $request->query->get('star'); | |
6079aaa3 | 60 | $isDeleted = $request->query->get('delete', 0); |
a8c90c5c NL |
61 | $sort = $request->query->get('sort', 'created'); |
62 | $order = $request->query->get('order', 'desc'); | |
63 | $page = $request->query->get('page', 1); | |
64 | $perPage = $request->query->get('perPage', 30); | |
65 | $tags = $request->query->get('tags', array()); | |
66 | ||
67 | $entries = $this | |
68 | ->getDoctrine() | |
be463487 | 69 | ->getRepository('WallabagCoreBundle:Entry') |
d29bfaf1 | 70 | ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order); |
a8c90c5c | 71 | |
3d3368cf | 72 | if (!($entries)) { |
a8c90c5c NL |
73 | throw $this->createNotFoundException(); |
74 | } | |
75 | ||
aa4d6562 | 76 | $json = $this->get('serializer')->serialize($entries, 'json'); |
0f006880 | 77 | |
0ed63022 | 78 | return new Response($json, 200, array('application/json')); |
f8bf8952 NL |
79 | } |
80 | ||
81 | /** | |
a8c90c5c | 82 | * Retrieve a single entry |
f8bf8952 NL |
83 | * |
84 | * @ApiDoc( | |
85 | * requirements={ | |
86 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
87 | * } | |
88 | * ) | |
be463487 | 89 | * @return Entry |
f8bf8952 | 90 | */ |
be463487 | 91 | public function getEntryAction(Entry $entry) |
f8bf8952 | 92 | { |
aa4d6562 | 93 | $json = $this->get('serializer')->serialize($entry, 'json'); |
0f006880 NL |
94 | |
95 | return new Response($json, 200, array('application/json')); | |
f8bf8952 NL |
96 | } |
97 | ||
98 | /** | |
a8c90c5c | 99 | * Create an entry |
f8bf8952 NL |
100 | * |
101 | * @ApiDoc( | |
a8c90c5c NL |
102 | * parameters={ |
103 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, | |
104 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, | |
105 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
106 | * } | |
f8bf8952 | 107 | * ) |
be463487 | 108 | * @return Entry |
f8bf8952 | 109 | */ |
843dbe51 | 110 | public function postEntriesAction(Request $request) |
f8bf8952 | 111 | { |
843dbe51 | 112 | //TODO gérer si on passe les tags |
c3235553 NL |
113 | $url = $request->request->get('url'); |
114 | ||
115 | $content = Extractor::extract($url); | |
d4c029f4 | 116 | $entry = new Entry($this->getUser()); |
c3235553 | 117 | $entry->setUrl($url); |
9e0fff7c | 118 | $entry->setTitle($request->request->get('title') ?: $content->getTitle()); |
843dbe51 | 119 | $entry->setContent($content->getBody()); |
843dbe51 NL |
120 | $em = $this->getDoctrine()->getManager(); |
121 | $em->persist($entry); | |
122 | $em->flush(); | |
123 | ||
aa4d6562 NL |
124 | $json = $this->get('serializer')->serialize($entry, 'json'); |
125 | ||
126 | return new Response($json, 200, array('application/json')); | |
f8bf8952 NL |
127 | } |
128 | ||
129 | /** | |
a8c90c5c | 130 | * Change several properties of an entry |
f8bf8952 NL |
131 | * |
132 | * @ApiDoc( | |
133 | * requirements={ | |
134 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
135 | * }, |
136 | * parameters={ | |
137 | * {"name"="title", "dataType"="string", "required"=false}, | |
138 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
2c093b03 NL |
139 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."}, |
140 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."}, | |
141 | * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."}, | |
a8c90c5c | 142 | * } |
f8bf8952 | 143 | * ) |
be463487 | 144 | * @return Entry |
f8bf8952 | 145 | */ |
be463487 | 146 | public function patchEntriesAction(Entry $entry, Request $request) |
f8bf8952 | 147 | { |
2c093b03 NL |
148 | $title = $request->request->get("title"); |
149 | $tags = $request->request->get("tags", array()); | |
150 | $isArchived = $request->request->get("archive"); | |
151 | $isDeleted = $request->request->get("delete"); | |
152 | $isStarred = $request->request->get("star"); | |
153 | ||
154 | if (!is_null($title)) { | |
155 | $entry->setTitle($title); | |
156 | } | |
157 | ||
158 | if (!is_null($isArchived)) { | |
905ae369 | 159 | $entry->setArchived($isArchived); |
2c093b03 NL |
160 | } |
161 | ||
162 | if (!is_null($isDeleted)) { | |
163 | $entry->setDeleted($isDeleted); | |
164 | } | |
165 | ||
166 | if (!is_null($isStarred)) { | |
905ae369 | 167 | $entry->setStarred($isStarred); |
2c093b03 NL |
168 | } |
169 | ||
170 | $em = $this->getDoctrine()->getManager(); | |
2c093b03 NL |
171 | $em->flush(); |
172 | ||
173 | return $entry; | |
f8bf8952 NL |
174 | } |
175 | ||
176 | /** | |
a8c90c5c | 177 | * Delete **permanently** an entry |
f8bf8952 NL |
178 | * |
179 | * @ApiDoc( | |
a8c90c5c NL |
180 | * requirements={ |
181 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
182 | * } | |
f8bf8952 | 183 | * ) |
be463487 | 184 | * @return Entry |
f8bf8952 | 185 | */ |
be463487 | 186 | public function deleteEntriesAction(Entry $entry) |
f8bf8952 | 187 | { |
42a90646 NL |
188 | if ($entry->isDeleted()) { |
189 | throw new NotFoundHttpException('This entry is already deleted'); | |
190 | } | |
191 | ||
192 | $em = $this->getDoctrine()->getManager(); | |
193 | $entry->setDeleted(1); | |
42a90646 NL |
194 | $em->flush(); |
195 | ||
196 | return $entry; | |
f8bf8952 NL |
197 | } |
198 | ||
199 | /** | |
a8c90c5c | 200 | * Retrieve all tags for an entry |
f8bf8952 NL |
201 | * |
202 | * @ApiDoc( | |
203 | * requirements={ | |
204 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
205 | * } | |
206 | * ) | |
207 | */ | |
be463487 | 208 | public function getEntriesTagsAction(Entry $entry) |
7df80cb3 | 209 | { |
f8bf8952 NL |
210 | } |
211 | ||
212 | /** | |
a8c90c5c | 213 | * Add one or more tags to an entry |
f8bf8952 NL |
214 | * |
215 | * @ApiDoc( | |
216 | * requirements={ | |
217 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
218 | * }, |
219 | * parameters={ | |
220 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
221 | * } | |
f8bf8952 NL |
222 | * ) |
223 | */ | |
be463487 | 224 | public function postEntriesTagsAction(Entry $entry) |
7df80cb3 | 225 | { |
f8bf8952 NL |
226 | } |
227 | ||
228 | /** | |
a8c90c5c | 229 | * Permanently remove one tag for an entry |
f8bf8952 NL |
230 | * |
231 | * @ApiDoc( | |
232 | * requirements={ | |
233 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}, | |
234 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
235 | * } | |
236 | * ) | |
237 | */ | |
653e8be4 | 238 | public function deleteEntriesTagsAction(Entry $entry, Tag $tag) |
f8bf8952 | 239 | { |
f8bf8952 NL |
240 | } |
241 | ||
242 | /** | |
a8c90c5c | 243 | * Retrieve all tags |
f8bf8952 NL |
244 | * |
245 | * @ApiDoc( | |
246 | * ) | |
247 | */ | |
7df80cb3 J |
248 | public function getTagsAction() |
249 | { | |
f8bf8952 NL |
250 | } |
251 | ||
252 | /** | |
a8c90c5c | 253 | * Retrieve a single tag |
f8bf8952 NL |
254 | * |
255 | * @ApiDoc( | |
a8c90c5c | 256 | * requirements={ |
f8bf8952 | 257 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} |
a8c90c5c | 258 | * } |
f8bf8952 NL |
259 | * ) |
260 | */ | |
653e8be4 | 261 | public function getTagAction(Tag $tag) |
7df80cb3 | 262 | { |
f8bf8952 NL |
263 | } |
264 | ||
265 | /** | |
a8c90c5c | 266 | * Permanently remove one tag from **every** entry |
f8bf8952 NL |
267 | * |
268 | * @ApiDoc( | |
269 | * requirements={ | |
270 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} | |
271 | * } | |
272 | * ) | |
273 | */ | |
653e8be4 | 274 | public function deleteTagAction(Tag $tag) |
f8bf8952 | 275 | { |
f8bf8952 | 276 | } |
7df80cb3 | 277 | } |