]>
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; |
c5e8ba25 | 11 | use Wallabag\CoreBundle\Entity\User; |
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 | * ) | |
24 | * @return string | |
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 | ||
37 | return $user->getSalt(); | |
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 | |
7df80cb3 | 72 | if (!is_array($entries)) { |
a8c90c5c NL |
73 | throw $this->createNotFoundException(); |
74 | } | |
75 | ||
76 | return $entries; | |
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 NL |
90 | { |
91 | return $entry; | |
92 | } | |
93 | ||
94 | /** | |
a8c90c5c | 95 | * Create an entry |
f8bf8952 NL |
96 | * |
97 | * @ApiDoc( | |
a8c90c5c NL |
98 | * parameters={ |
99 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, | |
100 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, | |
101 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
102 | * } | |
f8bf8952 | 103 | * ) |
be463487 | 104 | * @return Entry |
f8bf8952 | 105 | */ |
843dbe51 | 106 | public function postEntriesAction(Request $request) |
f8bf8952 | 107 | { |
843dbe51 | 108 | //TODO gérer si on passe les tags |
c3235553 NL |
109 | $url = $request->request->get('url'); |
110 | ||
111 | $content = Extractor::extract($url); | |
c5e8ba25 | 112 | $entry = new Entry($this->getUser()->getId()); |
c3235553 | 113 | $entry->setUrl($url); |
9e0fff7c | 114 | $entry->setTitle($request->request->get('title') ?: $content->getTitle()); |
843dbe51 | 115 | $entry->setContent($content->getBody()); |
843dbe51 NL |
116 | $em = $this->getDoctrine()->getManager(); |
117 | $em->persist($entry); | |
118 | $em->flush(); | |
119 | ||
120 | return $entry; | |
f8bf8952 NL |
121 | } |
122 | ||
123 | /** | |
a8c90c5c | 124 | * Change several properties of an entry |
f8bf8952 NL |
125 | * |
126 | * @ApiDoc( | |
127 | * requirements={ | |
128 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
129 | * }, |
130 | * parameters={ | |
131 | * {"name"="title", "dataType"="string", "required"=false}, | |
132 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
2c093b03 NL |
133 | * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."}, |
134 | * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."}, | |
135 | * {"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 | 136 | * } |
f8bf8952 | 137 | * ) |
be463487 | 138 | * @return Entry |
f8bf8952 | 139 | */ |
be463487 | 140 | public function patchEntriesAction(Entry $entry, Request $request) |
f8bf8952 | 141 | { |
2c093b03 NL |
142 | $title = $request->request->get("title"); |
143 | $tags = $request->request->get("tags", array()); | |
144 | $isArchived = $request->request->get("archive"); | |
145 | $isDeleted = $request->request->get("delete"); | |
146 | $isStarred = $request->request->get("star"); | |
147 | ||
148 | if (!is_null($title)) { | |
149 | $entry->setTitle($title); | |
150 | } | |
151 | ||
152 | if (!is_null($isArchived)) { | |
905ae369 | 153 | $entry->setArchived($isArchived); |
2c093b03 NL |
154 | } |
155 | ||
156 | if (!is_null($isDeleted)) { | |
157 | $entry->setDeleted($isDeleted); | |
158 | } | |
159 | ||
160 | if (!is_null($isStarred)) { | |
905ae369 | 161 | $entry->setStarred($isStarred); |
2c093b03 NL |
162 | } |
163 | ||
164 | $em = $this->getDoctrine()->getManager(); | |
2c093b03 NL |
165 | $em->flush(); |
166 | ||
167 | return $entry; | |
f8bf8952 NL |
168 | } |
169 | ||
170 | /** | |
a8c90c5c | 171 | * Delete **permanently** an entry |
f8bf8952 NL |
172 | * |
173 | * @ApiDoc( | |
a8c90c5c NL |
174 | * requirements={ |
175 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
176 | * } | |
f8bf8952 | 177 | * ) |
be463487 | 178 | * @return Entry |
f8bf8952 | 179 | */ |
be463487 | 180 | public function deleteEntriesAction(Entry $entry) |
f8bf8952 | 181 | { |
42a90646 NL |
182 | if ($entry->isDeleted()) { |
183 | throw new NotFoundHttpException('This entry is already deleted'); | |
184 | } | |
185 | ||
186 | $em = $this->getDoctrine()->getManager(); | |
187 | $entry->setDeleted(1); | |
42a90646 NL |
188 | $em->flush(); |
189 | ||
190 | return $entry; | |
f8bf8952 NL |
191 | } |
192 | ||
193 | /** | |
a8c90c5c | 194 | * Retrieve all tags for an entry |
f8bf8952 NL |
195 | * |
196 | * @ApiDoc( | |
197 | * requirements={ | |
198 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
199 | * } | |
200 | * ) | |
201 | */ | |
be463487 | 202 | public function getEntriesTagsAction(Entry $entry) |
7df80cb3 | 203 | { |
f8bf8952 NL |
204 | } |
205 | ||
206 | /** | |
a8c90c5c | 207 | * Add one or more tags to an entry |
f8bf8952 NL |
208 | * |
209 | * @ApiDoc( | |
210 | * requirements={ | |
211 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
a8c90c5c NL |
212 | * }, |
213 | * parameters={ | |
214 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | |
215 | * } | |
f8bf8952 NL |
216 | * ) |
217 | */ | |
be463487 | 218 | public function postEntriesTagsAction(Entry $entry) |
7df80cb3 | 219 | { |
f8bf8952 NL |
220 | } |
221 | ||
222 | /** | |
a8c90c5c | 223 | * Permanently remove one tag for an entry |
f8bf8952 NL |
224 | * |
225 | * @ApiDoc( | |
226 | * requirements={ | |
227 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}, | |
228 | * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} | |
229 | * } | |
230 | * ) | |
231 | */ | |
be463487 | 232 | public function deleteEntriesTagsAction(Entry $entry, Tags $tag) |
f8bf8952 | 233 | { |
f8bf8952 NL |
234 | } |
235 | ||
236 | /** | |
a8c90c5c | 237 | * Retrieve all tags |
f8bf8952 NL |
238 | * |
239 | * @ApiDoc( | |
240 | * ) | |
241 | */ | |
7df80cb3 J |
242 | public function getTagsAction() |
243 | { | |
f8bf8952 NL |
244 | } |
245 | ||
246 | /** | |
a8c90c5c | 247 | * Retrieve a single tag |
f8bf8952 NL |
248 | * |
249 | * @ApiDoc( | |
a8c90c5c | 250 | * requirements={ |
f8bf8952 | 251 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} |
a8c90c5c | 252 | * } |
f8bf8952 NL |
253 | * ) |
254 | */ | |
7df80cb3 J |
255 | public function getTagAction(Tags $tag) |
256 | { | |
f8bf8952 NL |
257 | } |
258 | ||
259 | /** | |
a8c90c5c | 260 | * Permanently remove one tag from **every** entry |
f8bf8952 NL |
261 | * |
262 | * @ApiDoc( | |
263 | * requirements={ | |
264 | * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"} | |
265 | * } | |
266 | * ) | |
267 | */ | |
268 | public function deleteTagAction(Tags $tag) | |
269 | { | |
f8bf8952 | 270 | } |
7df80cb3 | 271 | } |