namespace Wallabag\ApiBundle\Controller;
use FOS\RestBundle\Controller\FOSRestController;
-use Hateoas\Configuration\Route;
-use Hateoas\Representation\Factory\PagerfantaFactory;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
-use Wallabag\CoreBundle\Entity\Entry;
-use Wallabag\CoreBundle\Entity\Tag;
class WallabagRestController extends FOSRestController
{
- private function validateAuthentication()
- {
- if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) {
- throw new AccessDeniedException();
- }
- }
-
- /**
- * Retrieve all entries. It could be filtered by many options.
- *
- * @ApiDoc(
- * parameters={
- * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
- * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
- * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
- * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
- * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
- * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
- * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
- * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
- * }
- * )
- *
- * @return Response
- */
- public function getEntriesAction(Request $request)
- {
- $this->validateAuthentication();
-
- $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
- $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
- $sort = $request->query->get('sort', 'created');
- $order = $request->query->get('order', 'desc');
- $page = (int) $request->query->get('page', 1);
- $perPage = (int) $request->query->get('perPage', 30);
- $since = $request->query->get('since', 0);
- $tags = $request->query->get('tags', '');
-
- $pager = $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Entry')
- ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
-
- $pager->setCurrentPage($page);
- $pager->setMaxPerPage($perPage);
-
- $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
- $paginatedCollection = $pagerfantaFactory->createRepresentation(
- $pager,
- new Route('api_get_entries', [], UrlGeneratorInterface::ABSOLUTE_URL)
- );
-
- $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Retrieve a single entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * }
- * )
- *
- * @return Response
- */
- public function getEntryAction(Entry $entry)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Create an entry.
- *
- * @ApiDoc(
- * parameters={
- * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
- * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
- * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
- * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
- * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
- * }
- * )
- *
- * @return Response
- */
- public function postEntriesAction(Request $request)
- {
- $this->validateAuthentication();
-
- $url = $request->request->get('url');
- $title = $request->request->get('title');
- $isArchived = $request->request->get('archive');
- $isStarred = $request->request->get('starred');
-
- $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
-
- if (false === $entry) {
- $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
- new Entry($this->getUser()),
- $url
- );
- }
-
- if (!is_null($title)) {
- $entry->setTitle($title);
- }
-
- $tags = $request->request->get('tags', '');
- if (!empty($tags)) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
- }
-
- if (!is_null($isStarred)) {
- $entry->setStarred((bool) $isStarred);
- }
-
- if (!is_null($isArchived)) {
- $entry->setArchived((bool) $isArchived);
- }
-
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
-
- $em->flush();
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Change several properties of an entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * },
- * parameters={
- * {"name"="title", "dataType"="string", "required"=false},
- * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
- * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
- * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
- * }
- * )
- *
- * @return Response
- */
- public function patchEntriesAction(Entry $entry, Request $request)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $title = $request->request->get('title');
- $isArchived = $request->request->get('archive');
- $isStarred = $request->request->get('starred');
-
- if (!is_null($title)) {
- $entry->setTitle($title);
- }
-
- if (!is_null($isArchived)) {
- $entry->setArchived((bool) $isArchived);
- }
-
- if (!is_null($isStarred)) {
- $entry->setStarred((bool) $isStarred);
- }
-
- $tags = $request->request->get('tags', '');
- if (!empty($tags)) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
- }
-
- $em = $this->getDoctrine()->getManager();
- $em->flush();
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Delete **permanently** an entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * }
- * )
- *
- * @return Response
- */
- public function deleteEntriesAction(Entry $entry)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $em = $this->getDoctrine()->getManager();
- $em->remove($entry);
- $em->flush();
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
/**
- * Retrieve all tags for an entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * }
- * )
- *
- * @return Response
- */
- public function getEntriesTagsAction(Entry $entry)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Add one or more tags to an entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * },
- * parameters={
- * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
- * }
- * )
- *
- * @return Response
- */
- public function postEntriesTagsAction(Request $request, Entry $entry)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $tags = $request->request->get('tags', '');
- if (!empty($tags)) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
- }
-
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
- $em->flush();
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Permanently remove one tag for an entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
- * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
- * }
- * )
- *
- * @return Response
- */
- public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
- {
- $this->validateAuthentication();
- $this->validateUserAccess($entry->getUser()->getId());
-
- $entry->removeTag($tag);
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
- $em->flush();
-
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Retrieve all tags.
+ * Retrieve version number.
*
* @ApiDoc()
*
- * @return Response
- */
- public function getTagsAction()
- {
- $this->validateAuthentication();
-
- $tags = $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Tag')
- ->findAllTags($this->getUser()->getId());
-
- $json = $this->get('serializer')->serialize($tags, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Permanently remove one tag from **every** entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag"}
- * }
- * )
+ * @deprecated Should use info endpoint instead
*
- * @return Response
+ * @return JsonResponse
*/
- public function deleteTagAction(Tag $tag)
+ public function getVersionAction()
{
- $this->validateAuthentication();
-
- $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Entry')
- ->removeTag($this->getUser()->getId(), $tag);
-
- $json = $this->get('serializer')->serialize($tag, 'json');
+ $version = $this->container->getParameter('wallabag_core.version');
+ $json = $this->get('jms_serializer')->serialize($version, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
- * Permanently remove one tag from **every** entry.
+ * Retrieve information about the wallabag instance.
*
- * @ApiDoc(
- * requirements={
- * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag as a string"}
- * }
- * )
+ * @ApiDoc()
*
- * @return Response
+ * @return JsonResponse
*/
- public function deleteTagLabelAction(Request $request)
+ public function getInfoAction()
{
- $this->validateAuthentication();
- $label = $request->query->get('tag', '');
-
- $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
- $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Entry')
- ->removeTag($this->getUser()->getId(), $tag);
-
- $json = $this->get('serializer')->serialize($tag, 'json');
+ $info = [
+ 'appname' => 'wallabag',
+ 'version' => $this->container->getParameter('wallabag_core.version'),
+ 'allowed_registration' => $this->container->getParameter('wallabag_user.registration_enabled'),
+ ];
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($this->get('jms_serializer')->serialize($info, 'json'));
}
- /**
- * Permanently remove some tags from **every** entry.
- *
- * @ApiDoc(
- * requirements={
- * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="The tags as strings"}
- * }
- * )
- *
- * @return Response
- */
- public function deleteTagsLabelAction(Request $request)
+ protected function validateAuthentication()
{
- $this->validateAuthentication();
-
- $tagsLabels = $request->query->get('tags', '');
-
- $tags = array();
-
- foreach (explode(',', $tagsLabels) as $tagLabel) {
- $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
- $tags[] = $tagEntity;
+ if (false === $this->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_FULLY')) {
+ throw new AccessDeniedException();
}
-
- $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Entry')
- ->removeTags($this->getUser()->getId(), $tags);
-
- $json = $this->get('serializer')->serialize($tags, 'json');
-
- return $this->renderJsonResponse($json);
- }
-
- /**
- * Retrieve version number.
- *
- * @ApiDoc()
- *
- * @return Response
- */
- public function getVersionAction()
- {
- $version = $this->container->getParameter('wallabag_core.version');
-
- $json = $this->get('serializer')->serialize($version, 'json');
-
- return $this->renderJsonResponse($json);
}
/**
*
* @param int $requestUserId User id from the requested source
*/
- private function validateUserAccess($requestUserId)
+ protected function validateUserAccess($requestUserId)
{
$user = $this->get('security.token_storage')->getToken()->getUser();
- if ($requestUserId != $user->getId()) {
- throw $this->createAccessDeniedException('Access forbidden. Entry user id: '.$requestUserId.', logged user id: '.$user->getId());
+ if ($requestUserId !== $user->getId()) {
+ throw $this->createAccessDeniedException('Access forbidden. Entry user id: ' . $requestUserId . ', logged user id: ' . $user->getId());
}
}
-
- /**
- * Send a JSON Response.
- * We don't use the Symfony JsonRespone, because it takes an array as parameter instead of a JSON string.
- *
- * @param string $json
- *
- * @return Response
- */
- private function renderJsonResponse($json)
- {
- return new Response($json, 200, ['application/json']);
- }
}
projects / github / wallabag / wallabag.git / blobdiff