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