]>
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; |
0f006880 | 13 | use Hateoas\HateoasBuilder; |
f8bf8952 | 14 | |
a8c90c5c | 15 | class WallabagRestController extends Controller |
f8bf8952 | 16 | { |
c5e8ba25 NL |
17 | /** |
18 | * Retrieve salt for a giver user. | |
19 | * | |
20 | * @ApiDoc( | |
21 | * parameters={ | |
22 | * {"name"="username", "dataType"="string", "required"=true, "description"="username"} | |
23 | * } | |
24 | * ) | |
874e3e10 | 25 | * @return array |
c5e8ba25 NL |
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 | ||
f170f315 | 38 | return array($user->getSalt() ?: null); |
c5e8ba25 | 39 | } |
f8bf8952 | 40 | /** |
a8c90c5c | 41 | * Retrieve all entries. It could be filtered by many options. |
f8bf8952 NL |
42 | * |
43 | * @ApiDoc( | |
a8c90c5c | 44 | * parameters={ |
2c093b03 NL |
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."}, | |
a8c90c5c NL |
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 | * } | |
f8bf8952 | 54 | * ) |
be463487 | 55 | * @return Entry |
f8bf8952 | 56 | */ |
27f15aa4 | 57 | public function getEntriesAction(Request $request) |
f8bf8952 | 58 | { |
6e334aba NL |
59 | $isArchived = $request->query->get('archive'); |
60 | $isStarred = $request->query->get('star'); | |
6079aaa3 | 61 | $isDeleted = $request->query->get('delete', 0); |
a8c90c5c NL |
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() | |
be463487 | 70 | ->getRepository('WallabagCoreBundle:Entry') |
d29bfaf1 | 71 | ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order); |
a8c90c5c | 72 | |
3d3368cf | 73 | if (!($entries)) { |
a8c90c5c NL |
74 | throw $this->createNotFoundException(); |
75 | } | |
76 | ||
0f006880 NL |
77 | $hateoas = HateoasBuilder::create()->build(); |
78 | $json = $hateoas->serialize($entries, 'json'); | |
79 | ||
a8c90c5c | 80 | return $entries; |
f8bf8952 NL |
81 | } |
82 | ||
83 | /** | |
a8c90c5c | 84 | * Retrieve a single entry |
f8bf8952 NL |
85 | * |
86 | * @ApiDoc( | |
87 | * requirements={ | |
88 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
89 | * } | |
90 | * ) | |
be463487 | 91 | * @return Entry |
f8bf8952 | 92 | */ |
be463487 | 93 | public function getEntryAction(Entry $entry) |
f8bf8952 | 94 | { |
0f006880 NL |
95 | $hateoas = HateoasBuilder::create()->build(); |
96 | $json = $hateoas->serialize($entry, 'json'); | |
97 | ||
98 | return new Response($json, 200, array('application/json')); | |
f8bf8952 NL |
99 | } |
100 | ||
101 | /** | |
a8c90c5c | 102 | * Create an entry |
f8bf8952 NL |
103 | * |
104 | * @ApiDoc( | |
a8c90c5c NL |
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 | * } | |
f8bf8952 | 110 | * ) |
be463487 | 111 | * @return Entry |
f8bf8952 | 112 | */ |
843dbe51 | 113 | public function postEntriesAction(Request $request) |
f8bf8952 | 114 | { |
843dbe51 | 115 | //TODO gérer si on passe les tags |
c3235553 NL |
116 | $url = $request->request->get('url'); |
117 | ||
118 | $content = Extractor::extract($url); | |
d4c029f4 | 119 | $entry = new Entry($this->getUser()); |
c3235553 | 120 | $entry->setUrl($url); |
9e0fff7c | 121 | $entry->setTitle($request->request->get('title') ?: $content->getTitle()); |
843dbe51 | 122 | $entry->setContent($content->getBody()); |
843dbe51 NL |
123 | $em = $this->getDoctrine()->getManager(); |
124 | $em->persist($entry); | |
125 | $em->flush(); | |
126 | ||
127 | return $entry; | |
f8bf8952 NL |
128 | } |
129 | ||
130 | /** | |
a8c90c5c | 131 | * Change several properties of an entry |
f8bf8952 NL |
132 | * |
133 | * @ApiDoc( | |
134 | * requirements={ | |
135 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
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."}, | |
2c093b03 NL |
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.."}, | |
a8c90c5c | 143 | * } |
f8bf8952 | 144 | * ) |
be463487 | 145 | * @return Entry |
f8bf8952 | 146 | */ |
be463487 | 147 | public function patchEntriesAction(Entry $entry, Request $request) |
f8bf8952 | 148 | { |
2c093b03 NL |
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)) { | |
905ae369 | 160 | $entry->setArchived($isArchived); |
2c093b03 NL |
161 | } |
162 | ||
163 | if (!is_null($isDeleted)) { | |
164 | $entry->setDeleted($isDeleted); | |
165 | } | |
166 | ||
167 | if (!is_null($isStarred)) { | |
905ae369 | 168 | $entry->setStarred($isStarred); |
2c093b03 NL |
169 | } |
170 | ||
171 | $em = $this->getDoctrine()->getManager(); | |
2c093b03 NL |
172 | $em->flush(); |
173 | ||
174 | return $entry; | |
f8bf8952 NL |
175 | } |
176 | ||
177 | /** | |
a8c90c5c | 178 | * Delete **permanently** an entry |
f8bf8952 NL |
179 | * |
180 | * @ApiDoc( | |
a8c90c5c NL |
181 | * requirements={ |
182 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
183 | * } | |
f8bf8952 | 184 | * ) |
be463487 | 185 | * @return Entry |
f8bf8952 | 186 | */ |
be463487 | 187 | public function deleteEntriesAction(Entry $entry) |
f8bf8952 | 188 | { |
42a90646 NL |
189 | if ($entry->isDeleted()) { |
190 | throw new NotFoundHttpException('This entry is already deleted'); | |
191 | } | |
192 | ||
193 | $em = $this->getDoctrine()->getManager(); | |
194 | $entry->setDeleted(1); | |
42a90646 NL |
195 | $em->flush(); |
196 | ||
197 | return $entry; | |
f8bf8952 NL |
198 | } |
199 | ||
200 | /** | |
a8c90c5c | 201 | * Retrieve all tags for an entry |
f8bf8952 NL |
202 | * |
203 | * @ApiDoc( | |
204 | * requirements={ | |
205 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
206 | * } | |
207 | * ) | |
208 | */ | |
be463487 | 209 | public function getEntriesTagsAction(Entry $entry) |
7df80cb3 | 210 | { |
f8bf8952 NL |
211 | } |
212 | ||
213 | /** | |
a8c90c5c | 214 | * Add one or more tags to an entry |
f8bf8952 NL |
215 | * |
216 | * @ApiDoc( | |
217 | * requirements={ | |
218 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
219 | * }, |
220 | * parameters={ | |
221 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
222 | * } | |
f8bf8952 NL |
223 | * ) |
224 | */ | |
be463487 | 225 | public function postEntriesTagsAction(Entry $entry) |
7df80cb3 | 226 | { |
f8bf8952 NL |
227 | } |
228 | ||
229 | /** | |
a8c90c5c | 230 | * Permanently remove one tag for an entry |
f8bf8952 NL |
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 | */ | |
653e8be4 | 239 | public function deleteEntriesTagsAction(Entry $entry, Tag $tag) |
f8bf8952 | 240 | { |
f8bf8952 NL |
241 | } |
242 | ||
243 | /** | |
a8c90c5c | 244 | * Retrieve all tags |
f8bf8952 NL |
245 | * |
246 | * @ApiDoc( | |
247 | * ) | |
248 | */ | |
7df80cb3 J |
249 | public function getTagsAction() |
250 | { | |
f8bf8952 NL |
251 | } |
252 | ||
253 | /** | |
a8c90c5c | 254 | * Retrieve a single tag |
f8bf8952 NL |
255 | * |
256 | * @ApiDoc( | |
a8c90c5c | 257 | * requirements={ |
f8bf8952 | 258 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} |
a8c90c5c | 259 | * } |
f8bf8952 NL |
260 | * ) |
261 | */ | |
653e8be4 | 262 | public function getTagAction(Tag $tag) |
7df80cb3 | 263 | { |
f8bf8952 NL |
264 | } |
265 | ||
266 | /** | |
a8c90c5c | 267 | * Permanently remove one tag from **every** entry |
f8bf8952 NL |
268 | * |
269 | * @ApiDoc( | |
270 | * requirements={ | |
271 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} | |
272 | * } | |
273 | * ) | |
274 | */ | |
653e8be4 | 275 | public function deleteTagAction(Tag $tag) |
f8bf8952 | 276 | { |
f8bf8952 | 277 | } |
7df80cb3 | 278 | } |