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"}
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."},
82 public function getEntriesAction(Request
$request)
84 $isArchived = $request->query
->get('archive');
85 $isStarred = $request->query
->get('star');
86 $sort = $request->query
->get('sort', 'created');
87 $order = $request->query
->get('order', 'desc');
88 $page = (int) $request->query
->get('page', 1);
89 $perPage = (int) $request->query
->get('perPage', 30);
90 $tags = $request->query
->get('tags', []);
94 ->getRepository('WallabagCoreBundle:Entry')
95 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
97 $pager->setCurrentPage($page);
98 $pager->setMaxPerPage($perPage);
100 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
101 $paginatedCollection = $pagerfantaFactory->createRepresentation(
103 new Route('api_get_entries', [], $absolute = true)
106 $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
108 return $this->renderJsonResponse($json);
112 * Retrieve a single entry
116 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
121 public function getEntryAction(Entry
$entry)
123 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
125 $json = $this->get('serializer')->serialize($entry, 'json');
127 return $this->renderJsonResponse($json);
135 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
136 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
137 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
142 public function postEntriesAction(Request
$request)
144 $url = $request->request
->get('url');
146 $content = Extractor
::extract($url);
147 $entry = new Entry($this->getUser());
148 $entry->setUrl($url);
149 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
150 $entry->setContent($content->getBody());
152 $tags = $request->request
->get('tags', '');
154 $this->assignTagsToEntry($entry, $tags);
157 $em = $this->getDoctrine()->getManager();
158 $em->persist($entry);
161 $json = $this->get('serializer')->serialize($entry, 'json');
163 return $this->renderJsonResponse($json);
167 * Change several properties of an entry
171 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
174 * {"name"="title", "dataType"="string", "required"=false},
175 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
176 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
177 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
182 public function patchEntriesAction(Entry
$entry, Request
$request)
184 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
186 $title = $request->request
->get("title");
187 $isArchived = $request->request
->get("archive");
188 $isStarred = $request->request
->get("star");
190 if (!is_null($title)) {
191 $entry->setTitle($title);
194 if (!is_null($isArchived)) {
195 $entry->setArchived($isArchived);
198 if (!is_null($isStarred)) {
199 $entry->setStarred($isStarred);
202 $tags = $request->request
->get('tags', '');
204 $this->assignTagsToEntry($entry, $tags);
207 $em = $this->getDoctrine()->getManager();
210 $json = $this->get('serializer')->serialize($entry, 'json');
212 return $this->renderJsonResponse($json);
216 * Delete **permanently** an entry
220 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
225 public function deleteEntriesAction(Entry
$entry)
227 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
229 $em = $this->getDoctrine()->getManager();
233 $json = $this->get('serializer')->serialize($entry, 'json');
235 return $this->renderJsonResponse($json);
239 * Retrieve all tags for an entry
243 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
247 public function getEntriesTagsAction(Entry
$entry)
249 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
251 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
253 return $this->renderJsonResponse($json);
257 * Add one or more tags to an entry
261 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
264 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
268 public function postEntriesTagsAction(Request
$request, Entry
$entry)
270 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
272 $tags = $request->request
->get('tags', '');
274 $this->assignTagsToEntry($entry, $tags);
277 $em = $this->getDoctrine()->getManager();
278 $em->persist($entry);
281 $json = $this->get('serializer')->serialize($entry, 'json');
283 return $this->renderJsonResponse($json);
287 * Permanently remove one tag for an entry
291 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
292 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
296 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
298 $this->validateUserAccess($entry->getUser()->getId(), $this->getUser()->getId());
300 $entry->removeTag($tag);
301 $em = $this->getDoctrine()->getManager();
302 $em->persist($entry);
305 $json = $this->get('serializer')->serialize($entry, 'json');
307 return $this->renderJsonResponse($json);
315 public function getTagsAction()
317 $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
319 return $this->renderJsonResponse($json);
323 * Permanently remove one tag from **every** entry
327 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
331 public function deleteTagAction(Tag
$tag)
333 $this->validateUserAccess($tag->getUser()->getId(), $this->getUser()->getId());
335 $em = $this->getDoctrine()->getManager();
339 $json = $this->get('serializer')->serialize($tag, 'json');
341 return $this->renderJsonResponse($json);
345 * Validate that the first id is equal to the second one.
346 * If not, throw exception. It means a user try to access information from an other user
348 * @param integer $requestUserId User id from the requested source
349 * @param integer $currentUserId User id from the retrieved source
351 private function validateUserAccess($requestUserId, $currentUserId)
353 if ($requestUserId != $currentUserId) {
354 throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$currentUserId);
359 * Send a JSON Response.
360 * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string
362 * @param string $json
366 private function renderJsonResponse($json)
368 return new Response($json, 200, array('application/json'));