3 namespace Wallabag\ApiBundle\Controller
;
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 Wallabag\CoreBundle\Entity\Entry
;
10 use Wallabag\CoreBundle\Entity\Tag
;
11 use Wallabag\CoreBundle\Service\Extractor
;
12 use Hateoas\Configuration\Route
;
13 use Hateoas\Representation\Factory\PagerfantaFactory
;
15 class WallabagRestController
extends Controller
21 private function assignTagsToEntry(Entry
$entry, $tags)
23 foreach (explode(',', $tags) as $label) {
24 $label = trim($label);
27 ->getRepository('WallabagCoreBundle:Tag')
28 ->findOneByLabel($label);
30 if (is_null($tagEntity)) {
31 $tagEntity = new Tag($this->getUser());
32 $tagEntity->setLabel($label);
35 // only add the tag on the entry if the relation doesn't exist
36 if (!$entry->getTags()->contains($tagEntity)) {
37 $entry->addTag($tagEntity);
43 * Retrieve salt for a giver user.
47 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
53 public function getSaltAction($username)
57 ->getRepository('WallabagCoreBundle:User')
58 ->findOneByUsername($username);
61 throw $this->createNotFoundException();
64 return array($user->getSalt() ?: null);
68 * Retrieve all entries. It could be filtered by many options.
72 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
73 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
74 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
75 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
76 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
77 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
78 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
84 public function getEntriesAction(Request
$request)
86 $isArchived = $request->query
->get('archive');
87 $isStarred = $request->query
->get('star');
88 $sort = $request->query
->get('sort', 'created');
89 $order = $request->query
->get('order', 'desc');
90 $page = (int) $request->query
->get('page', 1);
91 $perPage = (int) $request->query
->get('perPage', 30);
92 $tags = $request->query
->get('tags', []);
96 ->getRepository('WallabagCoreBundle:Entry')
97 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
99 $pager->setCurrentPage($page);
100 $pager->setMaxPerPage($perPage);
102 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
103 $paginatedCollection = $pagerfantaFactory->createRepresentation(
105 new Route('api_get_entries', [], $absolute = true)
108 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
110 return $this->renderJsonResponse($json);
114 * Retrieve a single entry.
118 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
124 public function getEntryAction(Entry
$entry)
126 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
128 $json = $this->get('serializer')->serialize($entry, 'json');
130 return $this->renderJsonResponse($json);
138 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
139 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
140 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
146 public function postEntriesAction(Request
$request)
148 $url = $request->request
->get('url');
150 $content = Extractor
::extract($url);
151 $entry = new Entry($this->getUser());
152 $entry->setUrl($url);
153 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
154 $entry->setContent($content->getBody());
156 $tags = $request->request
->get('tags', '');
158 $this->assignTagsToEntry($entry, $tags);
161 $em = $this->getDoctrine()->getManager();
162 $em->persist($entry);
165 $json = $this->get('serializer')->serialize($entry, 'json');
167 return $this->renderJsonResponse($json);
171 * Change several properties of an entry.
175 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
178 * {"name"="title", "dataType"="string", "required"=false},
179 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
180 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
181 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
187 public function patchEntriesAction(Entry
$entry, Request
$request)
189 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
191 $title = $request->request
->get('title');
192 $isArchived = $request->request
->get('is_archived');
193 $isStarred = $request->request
->get('is_starred');
195 if (!is_null($title)) {
196 $entry->setTitle($title);
199 if (!is_null($isArchived)) {
200 $entry->setArchived($isArchived);
203 if (!is_null($isStarred)) {
204 $entry->setStarred($isStarred);
207 $tags = $request->request
->get('tags', '');
209 $this->assignTagsToEntry($entry, $tags);
212 $em = $this->getDoctrine()->getManager();
215 $json = $this->get('serializer')->serialize($entry, 'json');
217 return $this->renderJsonResponse($json);
221 * Delete **permanently** an entry.
225 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
231 public function deleteEntriesAction(Entry
$entry)
233 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
235 $em = $this->getDoctrine()->getManager();
239 $json = $this->get('serializer')->serialize($entry, 'json');
241 return $this->renderJsonResponse($json);
245 * Retrieve all tags for an entry.
249 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
253 public function getEntriesTagsAction(Entry
$entry)
255 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
257 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
259 return $this->renderJsonResponse($json);
263 * Add one or more tags to an entry.
267 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
270 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
274 public function postEntriesTagsAction(Request
$request, Entry
$entry)
276 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
278 $tags = $request->request
->get('tags', '');
280 $this->assignTagsToEntry($entry, $tags);
283 $em = $this->getDoctrine()->getManager();
284 $em->persist($entry);
287 $json = $this->get('serializer')->serialize($entry, 'json');
289 return $this->renderJsonResponse($json);
293 * Permanently remove one tag for an entry.
297 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
298 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
302 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
304 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
306 $entry->removeTag($tag);
307 $em = $this->getDoctrine()->getManager();
308 $em->persist($entry);
311 $json = $this->get('serializer')->serialize($entry, 'json');
313 return $this->renderJsonResponse($json);
321 public function getTagsAction()
323 $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
325 return $this->renderJsonResponse($json);
329 * Permanently remove one tag from **every** entry.
333 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
337 public function deleteTagAction(Tag
$tag)
339 $this->validateUserAccess($tag->getUser()->getId(), $this->getUser()->getId());
341 $em = $this->getDoctrine()->getManager();
345 $json = $this->get('serializer')->serialize($tag, 'json');
347 return $this->renderJsonResponse($json);
351 * Validate that the first id is equal to the second one.
352 * If not, throw exception. It means a user try to access information from an other user.
354 * @param int $requestUserId User id from the requested source
355 * @param int $currentUserId User id from the retrieved source
357 private function validateUserAccess($requestUserId, $currentUserId)
359 if ($requestUserId != $currentUserId) {
360 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$currentUserId);
365 * Send a JSON Response.
366 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
368 * @param string $json
372 private function renderJsonResponse($json)
374 return new Response($json, 200, array('application/json'));