namespace Wallabag\ApiBundle\Controller;
use FOS\RestBundle\Controller\FOSRestController;
-use Hateoas\Configuration\Route;
+use Hateoas\Configuration\Route as HateoasRoute;
use Hateoas\Representation\Factory\PagerfantaFactory;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Wallabag\CoreBundle\Entity\Entry;
use Wallabag\CoreBundle\Entity\Tag;
+use Wallabag\AnnotationBundle\Entity\Annotation;
+use Wallabag\CoreBundle\Event\EntrySavedEvent;
+use Wallabag\CoreBundle\Event\EntryDeletedEvent;
class WallabagRestController extends FOSRestController
{
}
}
+ /**
+ * Check if an entry exist by url.
+ *
+ * @ApiDoc(
+ * parameters={
+ * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
+ * {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"}
+ * }
+ * )
+ *
+ * @return JsonResponse
+ */
+ public function getEntriesExistsAction(Request $request)
+ {
+ $this->validateAuthentication();
+
+ $urls = $request->query->get('urls', []);
+
+ // handle multiple urls first
+ if (!empty($urls)) {
+ $results = [];
+ foreach ($urls as $url) {
+ $res = $this->getDoctrine()
+ ->getRepository('WallabagCoreBundle:Entry')
+ ->findByUrlAndUserId($url, $this->getUser()->getId());
+
+ $results[$url] = false === $res ? false : true;
+ }
+
+ $json = $this->get('serializer')->serialize($results, 'json');
+
+ return (new JsonResponse())->setJson($json);
+ }
+
+ // let's see if it is a simple url?
+ $url = $request->query->get('url', '');
+
+ if (empty($url)) {
+ throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
+ }
+
+ $res = $this->getDoctrine()
+ ->getRepository('WallabagCoreBundle:Entry')
+ ->findByUrlAndUserId($url, $this->getUser()->getId());
+
+ $exists = false === $res ? false : true;
+
+ $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
+
+ return (new JsonResponse())->setJson($json);
+ }
+
/**
* Retrieve all entries. It could be filtered by many options.
*
* {"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
+ * @return JsonResponse
*/
public function getEntriesAction(Request $request)
{
$this->validateAuthentication();
- $isArchived = (null === $request->query->get('archive')) ? null : (bool) (int) $request->query->get('archive');
- $isStarred = (null === $request->query->get('starred')) ? null : (bool) (int) $request->query->get('starred');
+ $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);
+ $tags = $request->query->get('tags', '');
+ $since = $request->query->get('since', 0);
$pager = $this->getDoctrine()
->getRepository('WallabagCoreBundle:Entry')
- ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
+ ->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)
+ new HateoasRoute(
+ 'api_get_entries',
+ [
+ 'archive' => $isArchived,
+ 'starred' => $isStarred,
+ 'sort' => $sort,
+ 'order' => $order,
+ 'page' => $page,
+ 'perPage' => $perPage,
+ 'tags' => $tags,
+ 'since' => $since,
+ ],
+ UrlGeneratorInterface::ABSOLUTE_URL
+ )
);
$json = $this->get('serializer')->serialize($paginatedCollection, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function getEntryAction(Entry $entry)
{
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
+ }
+
+ /**
+ * Retrieve a single entry as a predefined format.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
+ * }
+ * )
+ *
+ * @return Response
+ */
+ public function getEntryExportAction(Entry $entry, Request $request)
+ {
+ $this->validateAuthentication();
+ $this->validateUserAccess($entry->getUser()->getId());
+
+ return $this->get('wallabag_core.helper.entries_export')
+ ->setEntries($entry)
+ ->updateTitle('entry')
+ ->exportAs($request->attributes->get('_format'));
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function postEntriesAction(Request $request)
{
$this->validateAuthentication();
$url = $request->request->get('url');
- $isArchived = (int) $request->request->get('archive');
- $isStarred = (int) $request->request->get('starred');
+ $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 (!is_null($title)) {
+ $entry->setTitle($title);
+ }
+
$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();
+ // entry saved, dispatch event about it!
+ $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function patchEntriesAction(Entry $entry, Request $request)
{
$this->validateUserAccess($entry->getUser()->getId());
$title = $request->request->get('title');
- $isArchived = (int) $request->request->get('archive');
- $isStarred = (int) $request->request->get('starred');
+ $isArchived = $request->request->get('archive');
+ $isStarred = $request->request->get('starred');
if (!is_null($title)) {
$entry->setTitle($title);
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function deleteEntriesAction(Entry $entry)
{
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
+ // entry deleted, dispatch event about it!
+ $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+
$em = $this->getDoctrine()->getManager();
$em->remove($entry);
$em->flush();
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function getEntriesTagsAction(Entry $entry)
{
$json = $this->get('serializer')->serialize($entry->getTags(), 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function postEntriesTagsAction(Request $request, Entry $entry)
{
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
{
$json = $this->get('serializer')->serialize($entry, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
}
/**
*
* @ApiDoc()
*
- * @return Response
+ * @return JsonResponse
*/
public function getTagsAction()
{
$json = $this->get('serializer')->serialize($tags, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
+ }
+
+ /**
+ * Permanently remove one tag from **every** entry.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="tag", "dataType"="string", "required"=true, "requirement"="\w+", "description"="Tag as a string"}
+ * }
+ * )
+ *
+ * @return JsonResponse
+ */
+ public function deleteTagLabelAction(Request $request)
+ {
+ $this->validateAuthentication();
+ $label = $request->request->get('tag', '');
+
+ $tag = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($label);
+
+ if (empty($tag)) {
+ throw $this->createNotFoundException('Tag not found');
+ }
+
+ $this->getDoctrine()
+ ->getRepository('WallabagCoreBundle:Entry')
+ ->removeTag($this->getUser()->getId(), $tag);
+
+ $this->cleanOrphanTag($tag);
+
+ $json = $this->get('serializer')->serialize($tag, 'json');
+
+ return (new JsonResponse())->setJson($json);
+ }
+
+ /**
+ * Permanently remove some tags from **every** entry.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="tags", "dataType"="string", "required"=true, "format"="tag1,tag2", "description"="Tags as strings (comma splitted)"}
+ * }
+ * )
+ *
+ * @return JsonResponse
+ */
+ public function deleteTagsLabelAction(Request $request)
+ {
+ $this->validateAuthentication();
+
+ $tagsLabels = $request->request->get('tags', '');
+
+ $tags = [];
+
+ foreach (explode(',', $tagsLabels) as $tagLabel) {
+ $tagEntity = $this->getDoctrine()->getRepository('WallabagCoreBundle:Tag')->findOneByLabel($tagLabel);
+
+ if (!empty($tagEntity)) {
+ $tags[] = $tagEntity;
+ }
+ }
+
+ if (empty($tags)) {
+ throw $this->createNotFoundException('Tags not found');
+ }
+
+ $this->getDoctrine()
+ ->getRepository('WallabagCoreBundle:Entry')
+ ->removeTags($this->getUser()->getId(), $tags);
+
+ $this->cleanOrphanTag($tags);
+
+ $json = $this->get('serializer')->serialize($tags, 'json');
+
+ return (new JsonResponse())->setJson($json);
}
/**
* }
* )
*
- * @return Response
+ * @return JsonResponse
*/
public function deleteTagAction(Tag $tag)
{
->getRepository('WallabagCoreBundle:Entry')
->removeTag($this->getUser()->getId(), $tag);
+ $this->cleanOrphanTag($tag);
+
$json = $this->get('serializer')->serialize($tag, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
+ }
+
+ /**
+ * Retrieve annotations for an entry.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
+ * }
+ * )
+ *
+ * @param Entry $entry
+ *
+ * @return JsonResponse
+ */
+ public function getAnnotationsAction(Entry $entry)
+ {
+ $this->validateAuthentication();
+
+ return $this->forward('WallabagAnnotationBundle:WallabagAnnotation:getAnnotations', [
+ 'entry' => $entry,
+ ]);
+ }
+
+ /**
+ * Creates a new annotation.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="ranges", "dataType"="array", "requirement"="\w+", "description"="The range array for the annotation"},
+ * {"name"="quote", "dataType"="string", "required"=false, "description"="Optional, quote for the annotation"},
+ * {"name"="text", "dataType"="string", "required"=true, "description"=""},
+ * }
+ * )
+ *
+ * @param Request $request
+ * @param Entry $entry
+ *
+ * @return JsonResponse
+ */
+ public function postAnnotationAction(Request $request, Entry $entry)
+ {
+ $this->validateAuthentication();
+
+ return $this->forward('WallabagAnnotationBundle:WallabagAnnotation:postAnnotation', [
+ 'request' => $request,
+ 'entry' => $entry,
+ ]);
+ }
+
+ /**
+ * Updates an annotation.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
+ * }
+ * )
+ *
+ * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
+ *
+ * @param Annotation $annotation
+ * @param Request $request
+ *
+ * @return JsonResponse
+ */
+ public function putAnnotationAction(Annotation $annotation, Request $request)
+ {
+ $this->validateAuthentication();
+
+ return $this->forward('WallabagAnnotationBundle:WallabagAnnotation:putAnnotation', [
+ 'annotation' => $annotation,
+ 'request' => $request,
+ ]);
+ }
+
+ /**
+ * Removes an annotation.
+ *
+ * @ApiDoc(
+ * requirements={
+ * {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
+ * }
+ * )
+ *
+ * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
+ *
+ * @param Annotation $annotation
+ *
+ * @return JsonResponse
+ */
+ public function deleteAnnotationAction(Annotation $annotation)
+ {
+ $this->validateAuthentication();
+
+ return $this->forward('WallabagAnnotationBundle:WallabagAnnotation:deleteAnnotation', [
+ 'annotation' => $annotation,
+ ]);
}
+
/**
* Retrieve version number.
*
* @ApiDoc()
*
- * @return Response
+ * @return JsonResponse
*/
public function getVersionAction()
{
$json = $this->get('serializer')->serialize($version, 'json');
- return $this->renderJsonResponse($json);
+ return (new JsonResponse())->setJson($json);
+ }
+
+ /**
+ * Remove orphan tag in case no entries are associated to it.
+ *
+ * @param Tag|array $tags
+ */
+ private function cleanOrphanTag($tags)
+ {
+ if (!is_array($tags)) {
+ $tags = [$tags];
+ }
+
+ $em = $this->getDoctrine()->getManager();
+
+ foreach ($tags as $tag) {
+ if (count($tag->getEntries()) === 0) {
+ $em->remove($tag);
+ }
+ }
+
+ $em->flush();
}
/**
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, array('application/json'));
- }
}
projects / github / wallabag / wallabag.git / blobdiff