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 Hateoas\Configuration\Route
;
12 use Hateoas\Representation\Factory\PagerfantaFactory
;
14 class WallabagRestController
extends Controller
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 salt for a giver user.
46 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
52 public function getSaltAction($username)
56 ->getRepository('WallabagCoreBundle:User')
57 ->findOneByUsername($username);
60 throw $this->createNotFoundException();
63 return array($user->getSalt() ?: null);
67 * Retrieve all entries. It could be filtered by many options.
71 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
72 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
73 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
74 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
75 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
76 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
77 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
83 public function getEntriesAction(Request
$request)
85 $isArchived = $request->query
->get('archive');
86 $isStarred = $request->query
->get('star');
87 $sort = $request->query
->get('sort', 'created');
88 $order = $request->query
->get('order', 'desc');
89 $page = (int) $request->query
->get('page', 1);
90 $perPage = (int) $request->query
->get('perPage', 30);
91 $tags = $request->query
->get('tags', []);
95 ->getRepository('WallabagCoreBundle:Entry')
96 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
98 $pager->setCurrentPage($page);
99 $pager->setMaxPerPage($perPage);
101 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
102 $paginatedCollection = $pagerfantaFactory->createRepresentation(
104 new Route('api_get_entries', [], $absolute = true)
107 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
109 return $this->renderJsonResponse($json);
113 * Retrieve a single entry.
117 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
123 public function getEntryAction(Entry
$entry)
125 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
127 $json = $this->get('serializer')->serialize($entry, 'json');
129 return $this->renderJsonResponse($json);
137 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
138 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
139 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
145 public function postEntriesAction(Request
$request)
147 $url = $request->request
->get('url');
149 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
150 new Entry($this->getUser()),
154 $tags = $request->request
->get('tags', '');
156 $this->assignTagsToEntry($entry, $tags);
159 $em = $this->getDoctrine()->getManager();
160 $em->persist($entry);
163 $json = $this->get('serializer')->serialize($entry, 'json');
165 return $this->renderJsonResponse($json);
169 * Change several properties of an entry.
173 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
176 * {"name"="title", "dataType"="string", "required"=false},
177 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
178 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
179 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
185 public function patchEntriesAction(Entry
$entry, Request
$request)
187 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
189 $title = $request->request
->get('title');
190 $isArchived = $request->request
->get('is_archived');
191 $isStarred = $request->request
->get('is_starred');
193 if (!is_null($title)) {
194 $entry->setTitle($title);
197 if (!is_null($isArchived)) {
198 $entry->setArchived($isArchived);
201 if (!is_null($isStarred)) {
202 $entry->setStarred($isStarred);
205 $tags = $request->request
->get('tags', '');
207 $this->assignTagsToEntry($entry, $tags);
210 $em = $this->getDoctrine()->getManager();
213 $json = $this->get('serializer')->serialize($entry, 'json');
215 return $this->renderJsonResponse($json);
219 * Delete **permanently** an entry.
223 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
229 public function deleteEntriesAction(Entry
$entry)
231 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
233 $em = $this->getDoctrine()->getManager();
237 $json = $this->get('serializer')->serialize($entry, 'json');
239 return $this->renderJsonResponse($json);
243 * Retrieve all tags for an entry.
247 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
251 public function getEntriesTagsAction(Entry
$entry)
253 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
255 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
257 return $this->renderJsonResponse($json);
261 * Add one or more tags to an entry.
265 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
268 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
272 public function postEntriesTagsAction(Request
$request, Entry
$entry)
274 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
276 $tags = $request->request
->get('tags', '');
278 $this->assignTagsToEntry($entry, $tags);
281 $em = $this->getDoctrine()->getManager();
282 $em->persist($entry);
285 $json = $this->get('serializer')->serialize($entry, 'json');
287 return $this->renderJsonResponse($json);
291 * Permanently remove one tag for an entry.
295 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
296 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
300 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
302 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
304 $entry->removeTag($tag);
305 $em = $this->getDoctrine()->getManager();
306 $em->persist($entry);
309 $json = $this->get('serializer')->serialize($entry, 'json');
311 return $this->renderJsonResponse($json);
319 public function getTagsAction()
321 $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
323 return $this->renderJsonResponse($json);
327 * Permanently remove one tag from **every** entry.
331 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
335 public function deleteTagAction(Tag
$tag)
337 $this->validateUserAccess($tag->getUser()->getId(), $this->getUser()->getId());
339 $em = $this->getDoctrine()->getManager();
343 $json = $this->get('serializer')->serialize($tag, 'json');
345 return $this->renderJsonResponse($json);
349 * Validate that the first id is equal to the second one.
350 * If not, throw exception. It means a user try to access information from an other user.
352 * @param int $requestUserId User id from the requested source
353 * @param int $currentUserId User id from the retrieved source
355 private function validateUserAccess($requestUserId, $currentUserId)
357 if ($requestUserId != $currentUserId) {
358 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$currentUserId);
363 * Send a JSON Response.
364 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
366 * @param string $json
370 private function renderJsonResponse($json)
372 return new Response($json, 200, array('application/json'));