use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory;
+use JMS\Serializer\SerializationContext;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
-use Symfony\Component\HttpKernel\Exception\HttpException;
-use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+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);
}
return $this->sendResponse($results);
$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;
+ $exists = $this->returnExistInformation($res, $returnId);
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');
- $sort = $request->query->get('sort', 'created');
- $order = $request->query->get('order', 'desc');
+ $isPublic = (null === $request->query->get('public')) ? null : (bool) $request->query->get('public');
+ $sort = strtolower($request->query->get('sort', 'created'));
+ $order = strtolower($request->query->get('order', 'desc'));
$page = (int) $request->query->get('page', 1);
$perPage = (int) $request->query->get('perPage', 30);
- $tags = $request->query->get('tags', '');
+ $tags = \is_array($request->query->get('tags')) ? '' : (string) $request->query->get('tags', '');
$since = $request->query->get('since', 0);
- /** @var \Pagerfanta\Pagerfanta $pager */
- $pager = $this->getDoctrine()
- ->getRepository('WallabagCoreBundle:Entry')
- ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
+ try {
+ /** @var \Pagerfanta\Pagerfanta $pager */
+ $pager = $this->get('wallabag_core.entry_repository')->findEntries(
+ $this->getUser()->getId(),
+ $isArchived,
+ $isStarred,
+ $isPublic,
+ $sort,
+ $order,
+ $since,
+ $tags
+ );
+ } catch (\Exception $e) {
+ throw new BadRequestHttpException($e->getMessage());
+ }
$pager->setMaxPerPage($perPage);
$pager->setCurrentPage($page);
[
'archive' => $isArchived,
'starred' => $isStarred,
+ 'public' => $isPublic,
'sort' => $sort,
'order' => $order,
'page' => $page,
return $this->get('wallabag_core.helper.entries_export')
->setEntries($entry)
->updateTitle('entry')
+ ->updateAuthor('entry')
->exportAs($request->attributes->get('_format'));
}
* }
* )
*
- * @return JsonResponse
- *
* @throws HttpException When limit is reached
+ *
+ * @return JsonResponse
*/
public function postEntriesListAction(Request $request)
{
$limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
- if (count($urls) > $limit) {
+ if (\count($urls) > $limit) {
throw new HttpException(400, 'API limit reached');
}
* {"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"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
* {"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"},
+ * {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
* }
* )
*
$entry->setUrl($url);
}
- $this->upsertEntry($entry, $request);
+ $data = $this->retrieveValueFromRequest($request);
+
+ try {
+ $this->get('wallabag_core.content_proxy')->updateEntry(
+ $entry,
+ $entry->getUrl(),
+ [
+ 'title' => !empty($data['title']) ? $data['title'] : $entry->getTitle(),
+ 'html' => !empty($data['content']) ? $data['content'] : $entry->getContent(),
+ 'url' => $entry->getUrl(),
+ 'language' => !empty($data['language']) ? $data['language'] : $entry->getLanguage(),
+ 'date' => !empty($data['publishedAt']) ? $data['publishedAt'] : $entry->getPublishedAt(),
+ // faking the open graph preview picture
+ 'open_graph' => [
+ 'og_image' => !empty($data['picture']) ? $data['picture'] : $entry->getPreviewPicture(),
+ ],
+ 'authors' => \is_string($data['authors']) ? explode(',', $data['authors']) : $entry->getPublishedBy(),
+ ]
+ );
+ } catch (\Exception $e) {
+ $this->get('logger')->error('Error while saving an entry', [
+ 'exception' => $e,
+ 'entry' => $entry,
+ ]);
+ }
+
+ if (null !== $data['isArchived']) {
+ $entry->setArchived((bool) $data['isArchived']);
+ }
+
+ if (null !== $data['isStarred']) {
+ $entry->updateStar((bool) $data['isStarred']);
+ }
+
+ if (!empty($data['tags'])) {
+ $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
+ }
+
+ if (!empty($data['origin_url'])) {
+ $entry->setOriginUrl($data['origin_url']);
+ }
+
+ if (null !== $data['isPublic']) {
+ if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
+ $entry->generateUid();
+ } elseif (false === (bool) $data['isPublic']) {
+ $entry->cleanUid();
+ }
+ }
+
+ if (empty($entry->getDomainName())) {
+ $this->get('wallabag_core.content_proxy')->setEntryDomainName($entry);
+ }
+
+ if (empty($entry->getTitle())) {
+ $this->get('wallabag_core.content_proxy')->setDefaultEntryTitle($entry);
+ }
+
+ $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 $this->sendResponse($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"},
+ * {"name"="origin_url", "dataType"="string", "required"=false, "format"="http://www.test.com/article.html", "description"="Origin url for the entry (from where you found it)."},
* }
* )
*
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
- $this->upsertEntry($entry, $request, true);
+ $contentProxy = $this->get('wallabag_core.content_proxy');
+
+ $data = $this->retrieveValueFromRequest($request);
+
+ // this is a special case where user want to manually update the entry content
+ // the ContentProxy will only cleanup the html
+ // and also we force to not re-fetch the content in case of error
+ if (!empty($data['content'])) {
+ try {
+ $contentProxy->updateEntry(
+ $entry,
+ $entry->getUrl(),
+ [
+ 'html' => $data['content'],
+ ],
+ true
+ );
+ } catch (\Exception $e) {
+ $this->get('logger')->error('Error while saving an entry', [
+ 'exception' => $e,
+ 'entry' => $entry,
+ ]);
+ }
+ }
+
+ if (!empty($data['title'])) {
+ $entry->setTitle($data['title']);
+ }
+
+ if (!empty($data['language'])) {
+ $contentProxy->updateLanguage($entry, $data['language']);
+ }
+
+ if (!empty($data['authors']) && \is_string($data['authors'])) {
+ $entry->setPublishedBy(explode(',', $data['authors']));
+ }
+
+ if (!empty($data['picture'])) {
+ $contentProxy->updatePreviewPicture($entry, $data['picture']);
+ }
+
+ if (!empty($data['publishedAt'])) {
+ $contentProxy->updatePublishedAt($entry, $data['publishedAt']);
+ }
+
+ if (null !== $data['isArchived']) {
+ $entry->setArchived((bool) $data['isArchived']);
+ }
+
+ if (null !== $data['isStarred']) {
+ $entry->updateStar((bool) $data['isStarred']);
+ }
+
+ if (!empty($data['tags'])) {
+ $entry->removeAllTags();
+ $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']);
+ }
+
+ if (null !== $data['isPublic']) {
+ if (true === (bool) $data['isPublic'] && null === $entry->getUid()) {
+ $entry->generateUid();
+ } elseif (false === (bool) $data['isPublic']) {
+ $entry->cleanUid();
+ }
+ }
+
+ if (!empty($data['origin_url'])) {
+ $entry->setOriginUrl($data['origin_url']);
+ }
+
+ if (empty($entry->getDomainName())) {
+ $this->get('wallabag_core.content_proxy')->setEntryDomainName($entry);
+ }
+
+ if (empty($entry->getTitle())) {
+ $this->get('wallabag_core.content_proxy')->setDefaultEntryTitle($entry);
+ }
+
+ $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 $this->sendResponse($entry);
}
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
+ // We copy $entry to keep id in returned object
+ $e = $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));
- return $this->sendResponse($entry);
+ return $this->sendResponse($e);
}
/**
*/
private function sendResponse($data)
{
- $json = $this->get('serializer')->serialize($data, 'json');
+ // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
+ $context = new SerializationContext();
+ $context->setSerializeNull(true);
+
+ $json = $this->get('jms_serializer')->serialize($data, 'json', $context);
return (new JsonResponse())->setJson($json);
}
/**
- * Update or Insert a new entry.
+ * Retrieve value from the request.
+ * Used for POST & PATCH on a an 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)
+ *
+ * @return array
*/
- private function upsertEntry(Entry $entry, Request $request, $disableContentUpdate = false)
+ private function retrieveValueFromRequest(Request $request)
{
- $title = $request->request->get('title');
- $tags = $request->request->get('tags', []);
- $isArchived = $request->request->get('archive');
- $isStarred = $request->request->get('starred');
- $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 (!is_null($isArchived)) {
- $entry->setArchived((bool) $isArchived);
- }
-
- if (!is_null($isStarred)) {
- $entry->setStarred((bool) $isStarred);
- }
+ return [
+ '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', ''),
+ 'origin_url' => $request->request->get('origin_url', ''),
+ ];
+ }
- if (!empty($tags)) {
- $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
+ /**
+ * 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;
}
- $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 $entry instanceof Entry;
}
}
projects / github / wallabag / wallabag.git / blobdiff