3 namespace Wallabag\ApiBundle\Controller
;
5 use FOS\RestBundle\Controller\FOSRestController
;
6 use Hateoas\Configuration\Route
;
7 use Hateoas\Representation\Factory\PagerfantaFactory
;
8 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
9 use Symfony\Component\HttpFoundation\Request
;
10 use Symfony\Component\HttpFoundation\Response
;
11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface
;
12 use Symfony\Component\Security\Core\Exception\AccessDeniedException
;
13 use Wallabag\CoreBundle\Entity\Entry
;
14 use Wallabag\CoreBundle\Entity\Tag
;
16 class WallabagRestController
extends FOSRestController
18 private function validateAuthentication()
20 if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) {
21 throw new AccessDeniedException();
26 * Retrieve all entries. It could be filtered by many options.
30 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
31 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
32 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
33 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
34 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
35 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
36 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
42 public function getEntriesAction(Request
$request)
44 $this->validateAuthentication();
46 $isArchived = $request->query
->get('archive');
47 $isStarred = $request->query
->get('star');
48 $sort = $request->query
->get('sort', 'created');
49 $order = $request->query
->get('order', 'desc');
50 $page = (int) $request->query
->get('page', 1);
51 $perPage = (int) $request->query
->get('perPage', 30);
53 $pager = $this->getDoctrine()
54 ->getRepository('WallabagCoreBundle:Entry')
55 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
57 $pager->setCurrentPage($page);
58 $pager->setMaxPerPage($perPage);
60 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
61 $paginatedCollection = $pagerfantaFactory->createRepresentation(
63 new Route('api_get_entries', [], UrlGeneratorInterface
::ABSOLUTE_URL
)
66 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
68 return $this->renderJsonResponse($json);
72 * Retrieve a single entry.
76 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
82 public function getEntryAction(Entry
$entry)
84 $this->validateAuthentication();
85 $this->validateUserAccess($entry->getUser()->getId());
87 $json = $this->get('serializer')->serialize($entry, 'json');
89 return $this->renderJsonResponse($json);
97 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
98 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
99 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
105 public function postEntriesAction(Request
$request)
107 $this->validateAuthentication();
109 $url = $request->request
->get('url');
111 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
112 new Entry($this->getUser()),
116 $tags = $request->request
->get('tags', '');
118 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
121 $em = $this->getDoctrine()->getManager();
122 $em->persist($entry);
125 $json = $this->get('serializer')->serialize($entry, 'json');
127 return $this->renderJsonResponse($json);
131 * Change several properties of an entry.
135 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
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."},
147 public function patchEntriesAction(Entry
$entry, Request
$request)
149 $this->validateAuthentication();
150 $this->validateUserAccess($entry->getUser()->getId());
152 $title = $request->request
->get('title');
153 $isArchived = $request->request
->get('archive');
154 $isStarred = $request->request
->get('star');
156 if (!is_null($title)) {
157 $entry->setTitle($title);
160 if (!is_null($isArchived)) {
161 $entry->setArchived($isArchived);
164 if (!is_null($isStarred)) {
165 $entry->setStarred($isStarred);
168 $tags = $request->request
->get('tags', '');
170 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
173 $em = $this->getDoctrine()->getManager();
176 $json = $this->get('serializer')->serialize($entry, 'json');
178 return $this->renderJsonResponse($json);
182 * Delete **permanently** an entry.
186 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
192 public function deleteEntriesAction(Entry
$entry)
194 $this->validateAuthentication();
195 $this->validateUserAccess($entry->getUser()->getId());
197 $em = $this->getDoctrine()->getManager();
201 $json = $this->get('serializer')->serialize($entry, 'json');
203 return $this->renderJsonResponse($json);
207 * Retrieve all tags for an entry.
211 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
217 public function getEntriesTagsAction(Entry
$entry)
219 $this->validateAuthentication();
220 $this->validateUserAccess($entry->getUser()->getId());
222 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
224 return $this->renderJsonResponse($json);
228 * Add one or more tags to an entry.
232 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
235 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
241 public function postEntriesTagsAction(Request
$request, Entry
$entry)
243 $this->validateAuthentication();
244 $this->validateUserAccess($entry->getUser()->getId());
246 $tags = $request->request
->get('tags', '');
248 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
251 $em = $this->getDoctrine()->getManager();
252 $em->persist($entry);
255 $json = $this->get('serializer')->serialize($entry, 'json');
257 return $this->renderJsonResponse($json);
261 * Permanently remove one tag for an entry.
265 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
266 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
272 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
274 $this->validateAuthentication();
275 $this->validateUserAccess($entry->getUser()->getId());
277 $entry->removeTag($tag);
278 $em = $this->getDoctrine()->getManager();
279 $em->persist($entry);
282 $json = $this->get('serializer')->serialize($entry, 'json');
284 return $this->renderJsonResponse($json);
294 public function getTagsAction()
296 $this->validateAuthentication();
298 $tags = $this->getDoctrine()
299 ->getRepository('WallabagCoreBundle:Tag')
300 ->findAllTags($this->getUser()->getId());
302 $json = $this->get('serializer')->serialize($tags, 'json');
304 return $this->renderJsonResponse($json);
308 * Permanently remove one tag from **every** entry.
312 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
318 public function deleteTagAction(Tag
$tag)
320 $this->validateAuthentication();
323 ->getRepository('WallabagCoreBundle:Entry')
324 ->removeTag($this->getUser()->getId(), $tag);
326 $json = $this->get('serializer')->serialize($tag, 'json');
328 return $this->renderJsonResponse($json);
332 * Validate that the first id is equal to the second one.
333 * If not, throw exception. It means a user try to access information from an other user.
335 * @param int $requestUserId User id from the requested source
337 private function validateUserAccess($requestUserId)
339 $user = $this->get('security.token_storage')->getToken()->getUser();
340 if ($requestUserId != $user->getId()) {
341 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
346 * Send a JSON Response.
347 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
349 * @param string $json
353 private function renderJsonResponse($json)
355 return new Response($json, 200, array('application/json'));