3 namespace Wallabag\ApiBundle\Controller
;
5 use FOS\RestBundle\Controller\FOSRestController
;
6 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
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 Hateoas\Configuration\Route
;
12 use Hateoas\Representation\Factory\PagerfantaFactory
;
14 class WallabagRestController
extends FOSRestController
20 private function assignTagsToEntry(Entry
$entry, $tags)
22 foreach (explode(',', $tags) as $label) {
23 $label = trim($label);
26 ->getRepository('WallabagCoreBundle:Tag')
27 ->findOneByLabel($label);
29 if (is_null($tagEntity)) {
30 $tagEntity = new Tag($this->getUser());
31 $tagEntity->setLabel($label);
34 // only add the tag on the entry if the relation doesn't exist
35 if (!$entry->getTags()->contains($tagEntity)) {
36 $entry->addTag($tagEntity);
42 * Retrieve all entries. It could be filtered by many options.
46 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
47 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred 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."},
58 public function getEntriesAction(Request
$request)
60 $isArchived = $request->query
->get('archive');
61 $isStarred = $request->query
->get('star');
62 $sort = $request->query
->get('sort', 'created');
63 $order = $request->query
->get('order', 'desc');
64 $page = (int) $request->query
->get('page', 1);
65 $perPage = (int) $request->query
->get('perPage', 30);
66 $tags = $request->query
->get('tags', []);
70 ->getRepository('WallabagCoreBundle:Entry')
71 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
73 $pager->setCurrentPage($page);
74 $pager->setMaxPerPage($perPage);
76 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
77 $paginatedCollection = $pagerfantaFactory->createRepresentation(
79 new Route('api_get_entries', [], $absolute = true)
82 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
84 return $this->renderJsonResponse($json);
88 * Retrieve a single entry.
92 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
98 public function getEntryAction(Entry
$entry)
100 $this->validateUserAccess($entry->getUser()->getId());
102 $json = $this->get('serializer')->serialize($entry, 'json');
104 return $this->renderJsonResponse($json);
112 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
113 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
114 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
120 public function postEntriesAction(Request
$request)
122 $url = $request->request
->get('url');
124 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
125 new Entry($this->getUser()),
129 $tags = $request->request
->get('tags', '');
131 $this->assignTagsToEntry($entry, $tags);
134 $em = $this->getDoctrine()->getManager();
135 $em->persist($entry);
138 $json = $this->get('serializer')->serialize($entry, 'json');
140 return $this->renderJsonResponse($json);
144 * Change several properties of an entry.
148 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
151 * {"name"="title", "dataType"="string", "required"=false},
152 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
153 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
154 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
160 public function patchEntriesAction(Entry
$entry, Request
$request)
162 $this->validateUserAccess($entry->getUser()->getId());
164 $title = $request->request
->get('title');
165 $isArchived = $request->request
->get('is_archived');
166 $isStarred = $request->request
->get('is_starred');
168 if (!is_null($title)) {
169 $entry->setTitle($title);
172 if (!is_null($isArchived)) {
173 $entry->setArchived($isArchived);
176 if (!is_null($isStarred)) {
177 $entry->setStarred($isStarred);
180 $tags = $request->request
->get('tags', '');
182 $this->assignTagsToEntry($entry, $tags);
185 $em = $this->getDoctrine()->getManager();
188 $json = $this->get('serializer')->serialize($entry, 'json');
190 return $this->renderJsonResponse($json);
194 * Delete **permanently** an entry.
198 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
204 public function deleteEntriesAction(Entry
$entry)
206 $this->validateUserAccess($entry->getUser()->getId());
208 $em = $this->getDoctrine()->getManager();
212 $json = $this->get('serializer')->serialize($entry, 'json');
214 return $this->renderJsonResponse($json);
218 * Retrieve all tags for an entry.
222 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
226 public function getEntriesTagsAction(Entry
$entry)
228 $this->validateUserAccess($entry->getUser()->getId());
230 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
232 return $this->renderJsonResponse($json);
236 * Add one or more tags to an entry.
240 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
243 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
247 public function postEntriesTagsAction(Request
$request, Entry
$entry)
249 $this->validateUserAccess($entry->getUser()->getId());
251 $tags = $request->request
->get('tags', '');
253 $this->assignTagsToEntry($entry, $tags);
256 $em = $this->getDoctrine()->getManager();
257 $em->persist($entry);
260 $json = $this->get('serializer')->serialize($entry, 'json');
262 return $this->renderJsonResponse($json);
266 * Permanently remove one tag for an entry.
270 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
271 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
275 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
277 $this->validateUserAccess($entry->getUser()->getId());
279 $entry->removeTag($tag);
280 $em = $this->getDoctrine()->getManager();
281 $em->persist($entry);
284 $json = $this->get('serializer')->serialize($entry, 'json');
286 return $this->renderJsonResponse($json);
294 public function getTagsAction()
296 $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
298 return $this->renderJsonResponse($json);
302 * Permanently remove one tag from **every** entry.
306 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
310 public function deleteTagAction(Tag
$tag)
312 $this->validateUserAccess($tag->getUser()->getId());
314 $em = $this->getDoctrine()->getManager();
318 $json = $this->get('serializer')->serialize($tag, 'json');
320 return $this->renderJsonResponse($json);
324 * Validate that the first id is equal to the second one.
325 * If not, throw exception. It means a user try to access information from an other user.
327 * @param int $requestUserId User id from the requested source
329 private function validateUserAccess($requestUserId)
331 $user = $this->get('security.context')->getToken()->getUser();
332 if ($requestUserId != $user->getId()) {
333 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
338 * Send a JSON Response.
339 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
341 * @param string $json
345 private function renderJsonResponse($json)
347 return new Response($json, 200, array('application/json'));