use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory;
+use JMS\Serializer\SerializationContext;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
-use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Wallabag\CoreBundle\Entity\Entry;
use Wallabag\CoreBundle\Entity\Tag;
-use Wallabag\CoreBundle\Event\EntrySavedEvent;
use Wallabag\CoreBundle\Event\EntryDeletedEvent;
+use Wallabag\CoreBundle\Event\EntrySavedEvent;
class EntryRestController extends WallabagRestController
{
/**
* Check if an entry exist by url.
+ * Return ID if entry(ies) exist (and if you give the return_id parameter).
+ * Otherwise it returns false.
+ *
+ * @todo Remove that `return_id` in the next major release
*
* @ApiDoc(
* parameters={
+ * {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"},
* {"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"}
* }
{
$this->validateAuthentication();
+ $returnId = (null === $request->query->get('return_id')) ? false : (bool) $request->query->get('return_id');
$urls = $request->query->get('urls', []);
// handle multiple urls first
->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId());
- $results[$url] = $res instanceof Entry ? $res->getId() : false;
+ $results[$url] = $this->returnExistInformation($res, $returnId);
}
- $json = $this->get('serializer')->serialize($results, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($results);
}
// 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());
+ throw $this->createAccessDeniedException('URL is empty?, logged user id: ' . $this->getUser()->getId());
}
$res = $this->getDoctrine()
->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId());
- $exists = $res instanceof Entry ? $res->getId() : false;
-
- $json = $this->get('serializer')->serialize(['exists' => $exists], 'json');
+ $exists = $this->returnExistInformation($res, $returnId);
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse(['exists' => $exists]);
}
/**
* {"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."},
+ * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by entries with a public link"},
* }
* )
*
$isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
$isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
+ $isPublic = (null === $request->query->get('public')) ? null : (bool) $request->query->get('public');
$sort = $request->query->get('sort', 'created');
$order = $request->query->get('order', 'desc');
$page = (int) $request->query->get('page', 1);
$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, $since, $tags);
+ /** @var \Pagerfanta\Pagerfanta $pager */
+ $pager = $this->get('wallabag_core.entry_repository')->findEntries(
+ $this->getUser()->getId(),
+ $isArchived,
+ $isStarred,
+ $isPublic,
+ $sort,
+ $order,
+ $since,
+ $tags
+ );
- $pager->setCurrentPage($page);
$pager->setMaxPerPage($perPage);
+ $pager->setCurrentPage($page);
$pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
$paginatedCollection = $pagerfantaFactory->createRepresentation(
[
'archive' => $isArchived,
'starred' => $isStarred,
+ 'public' => $isPublic,
'sort' => $sort,
'order' => $order,
'page' => $page,
)
);
- $json = $this->get('serializer')->serialize($paginatedCollection, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($paginatedCollection);
}
/**
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
}
/**
- * Create an entry.
+ * Handles an entries list and delete URL.
*
* @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"},
+ * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
* }
* )
*
* @return JsonResponse
*/
- public function postEntriesAction(Request $request)
+ public function deleteEntriesListAction(Request $request)
{
$this->validateAuthentication();
- $url = $request->request->get('url');
- $title = $request->request->get('title');
- $isArchived = $request->request->get('archive');
- $isStarred = $request->request->get('starred');
+ $urls = json_decode($request->query->get('urls', []));
- $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
+ if (empty($urls)) {
+ return $this->sendResponse([]);
+ }
- if (false === $entry) {
- $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
- new Entry($this->getUser()),
- $url
+ $results = [];
+
+ // handle multiple urls
+ foreach ($urls as $key => $url) {
+ $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+ $url,
+ $this->getUser()->getId()
);
- }
- if (!is_null($title)) {
- $entry->setTitle($title);
+ $results[$key]['url'] = $url;
+
+ if (false !== $entry) {
+ $em = $this->getDoctrine()->getManager();
+ $em->remove($entry);
+ $em->flush();
+
+ // entry deleted, dispatch event about it!
+ $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
+ }
+
+ $results[$key]['entry'] = $entry instanceof Entry ? true : false;
}
- $tags = $request->request->get('tags', '');
- if (!empty($tags)) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
+ return $this->sendResponse($results);
+ }
+
+ /**
+ * Handles an entries list and create URL.
+ *
+ * @ApiDoc(
+ * parameters={
+ * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
+ * }
+ * )
+ *
+ * @throws HttpException When limit is reached
+ *
+ * @return JsonResponse
+ */
+ public function postEntriesListAction(Request $request)
+ {
+ $this->validateAuthentication();
+
+ $urls = json_decode($request->query->get('urls', []));
+
+ $limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
+
+ if (count($urls) > $limit) {
+ throw new HttpException(400, 'API limit reached');
}
- if (!is_null($isStarred)) {
- $entry->setStarred((bool) $isStarred);
+ $results = [];
+ if (empty($urls)) {
+ return $this->sendResponse($results);
}
- if (!is_null($isArchived)) {
- $entry->setArchived((bool) $isArchived);
+ // handle multiple urls
+ foreach ($urls as $key => $url) {
+ $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+ $url,
+ $this->getUser()->getId()
+ );
+
+ $results[$key]['url'] = $url;
+
+ if (false === $entry) {
+ $entry = new Entry($this->getUser());
+
+ $this->get('wallabag_core.content_proxy')->updateEntry($entry, $url);
+ }
+
+ $em = $this->getDoctrine()->getManager();
+ $em->persist($entry);
+ $em->flush();
+
+ $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
+
+ // entry saved, dispatch event about it!
+ $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
}
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
- $em->flush();
+ return $this->sendResponse($results);
+ }
- // entry saved, dispatch event about it!
- $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
+ /**
+ * Create an entry.
+ *
+ * If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
+ * Otherwise, content will be fetched as normal from the url and values will be overwritten.
+ *
+ * @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"},
+ * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
+ * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
+ * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
+ * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
+ * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
+ * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
+ * }
+ * )
+ *
+ * @return JsonResponse
+ */
+ public function postEntriesAction(Request $request)
+ {
+ $this->validateAuthentication();
- $json = $this->get('serializer')->serialize($entry, 'json');
+ $url = $request->request->get('url');
- return (new JsonResponse())->setJson($json);
+ $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+ $url,
+ $this->getUser()->getId()
+ );
+
+ if (false === $entry) {
+ $entry = new Entry($this->getUser());
+ $entry->setUrl($url);
+ }
+
+ $this->upsertEntry($entry, $request);
+
+ return $this->sendResponse($entry);
}
/**
* {"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."},
+ * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
+ * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
+ * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
+ * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
+ * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
+ * {"name"="public", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="will generate a public link for the entry"},
* }
* )
*
$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();
+ $this->upsertEntry($entry, $request, true);
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
$this->validateUserAccess($entry->getUser()->getId());
try {
- $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
+ $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
} catch (\Exception $e) {
$this->get('logger')->error('Error while saving an entry', [
'exception' => $e,
// entry saved, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
// entry deleted, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
- $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry->getTags());
}
/**
$tags = $request->request->get('tags', '');
if (!empty($tags)) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
+ $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
}
$em = $this->getDoctrine()->getManager();
$em->persist($entry);
$em->flush();
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
$em->persist($entry);
$em->flush();
- $json = $this->get('serializer')->serialize($entry, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($entry);
}
/**
$this->validateAuthentication();
$list = json_decode($request->query->get('list', []));
- $results = [];
+
+ if (empty($list)) {
+ return $this->sendResponse([]);
+ }
// handle multiple urls
- if (!empty($list)) {
- foreach ($list as $key => $element) {
- $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
- $element->url,
- $this->getUser()->getId()
- );
-
- $results[$key]['url'] = $element->url;
- $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
-
- $tags = $element->tags;
-
- if (false !== $entry && !(empty($tags))) {
- $tags = explode(',', $tags);
- foreach ($tags as $label) {
- $label = trim($label);
-
- $tag = $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Tag')
- ->findOneByLabel($label);
-
- if (false !== $tag) {
- $entry->removeTag($tag);
- }
- }
+ $results = [];
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
- $em->flush();
+ foreach ($list as $key => $element) {
+ $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+ $element->url,
+ $this->getUser()->getId()
+ );
+
+ $results[$key]['url'] = $element->url;
+ $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
+
+ $tags = $element->tags;
+
+ if (false !== $entry && !(empty($tags))) {
+ $tags = explode(',', $tags);
+ foreach ($tags as $label) {
+ $label = trim($label);
+
+ $tag = $this->getDoctrine()
+ ->getRepository('WallabagCoreBundle:Tag')
+ ->findOneByLabel($label);
+
+ if (false !== $tag) {
+ $entry->removeTag($tag);
+ }
}
+
+ $em = $this->getDoctrine()->getManager();
+ $em->persist($entry);
+ $em->flush();
}
}
- $json = $this->get('serializer')->serialize($results, 'json');
-
- return (new JsonResponse())->setJson($json);
+ return $this->sendResponse($results);
}
/**
$this->validateAuthentication();
$list = json_decode($request->query->get('list', []));
+
+ if (empty($list)) {
+ return $this->sendResponse([]);
+ }
+
$results = [];
// handle multiple urls
- if (!empty($list)) {
- foreach ($list as $key => $element) {
- $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
- $element->url,
- $this->getUser()->getId()
- );
+ foreach ($list as $key => $element) {
+ $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
+ $element->url,
+ $this->getUser()->getId()
+ );
- $results[$key]['url'] = $element->url;
- $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
+ $results[$key]['url'] = $element->url;
+ $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
- $tags = $element->tags;
+ $tags = $element->tags;
- if (false !== $entry && !(empty($tags))) {
- $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
+ if (false !== $entry && !(empty($tags))) {
+ $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
- $em = $this->getDoctrine()->getManager();
- $em->persist($entry);
- $em->flush();
- }
+ $em = $this->getDoctrine()->getManager();
+ $em->persist($entry);
+ $em->flush();
}
}
- $json = $this->get('serializer')->serialize($results, 'json');
+ return $this->sendResponse($results);
+ }
+
+ /**
+ * Shortcut to send data serialized in json.
+ *
+ * @param mixed $data
+ *
+ * @return JsonResponse
+ */
+ private function sendResponse($data)
+ {
+ // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
+ $context = new SerializationContext();
+ $context->setSerializeNull(true);
+
+ $json = $this->get('serializer')->serialize($data, 'json', $context);
return (new JsonResponse())->setJson($json);
}
+
+ /**
+ * Update or Insert a new entry.
+ *
+ * @param Entry $entry
+ * @param Request $request
+ * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
+ */
+ private function upsertEntry(Entry $entry, Request $request, $disableContentUpdate = false)
+ {
+ $title = $request->request->get('title');
+ $tags = $request->request->get('tags', []);
+ $isArchived = $request->request->get('archive');
+ $isStarred = $request->request->get('starred');
+ $isPublic = $request->request->get('public');
+ $content = $request->request->get('content');
+ $language = $request->request->get('language');
+ $picture = $request->request->get('preview_picture');
+ $publishedAt = $request->request->get('published_at');
+ $authors = $request->request->get('authors', '');
+
+ try {
+ $this->get('wallabag_core.content_proxy')->updateEntry(
+ $entry,
+ $entry->getUrl(),
+ [
+ 'title' => !empty($title) ? $title : $entry->getTitle(),
+ 'html' => !empty($content) ? $content : $entry->getContent(),
+ 'url' => $entry->getUrl(),
+ 'language' => !empty($language) ? $language : $entry->getLanguage(),
+ 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
+ // faking the open graph preview picture
+ 'open_graph' => [
+ 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
+ ],
+ 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
+ ],
+ $disableContentUpdate
+ );
+ } catch (\Exception $e) {
+ $this->get('logger')->error('Error while saving an entry', [
+ 'exception' => $e,
+ 'entry' => $entry,
+ ]);
+ }
+
+ if (null !== $isArchived) {
+ $entry->setArchived((bool) $isArchived);
+ }
+
+ if (null !== $isStarred) {
+ $entry->setStarred((bool) $isStarred);
+ }
+
+ if (!empty($tags)) {
+ $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
+ }
+
+ if (null !== $isPublic) {
+ if (true === (bool) $isPublic && null === $entry->getUid()) {
+ $entry->generateUid();
+ } elseif (false === (bool) $isPublic) {
+ $entry->cleanUid();
+ }
+ }
+
+ $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));
+ }
+
+ /**
+ * Return information about the entry if it exist and depending on the id or not.
+ *
+ * @param Entry|null $entry
+ * @param bool $returnId
+ *
+ * @return bool|int
+ */
+ private function returnExistInformation($entry, $returnId)
+ {
+ if ($returnId) {
+ return $entry instanceof Entry ? $entry->getId() : null;
+ }
+
+ return $entry instanceof Entry;
+ }
}
projects / github / wallabag / wallabag.git / blobdiff