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