namespace Wallabag\CoreBundle\Helper;
-use JMS\Serializer;
+use Html2Text\Html2Text;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\SerializerBuilder;
use PHPePub\Core\EPub;
use PHPePub\Core\Structure\OPF\DublinCore;
use Symfony\Component\HttpFoundation\Response;
-use Craue\ConfigBundle\Util\Config;
+use Symfony\Component\Translation\TranslatorInterface;
+use Wallabag\CoreBundle\Entity\Entry;
/**
* This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest.
{
private $wallabagUrl;
private $logoPath;
+ private $translator;
private $title = '';
- private $entries = array();
- private $authors = array('wallabag');
+ private $entries = [];
+ private $author = 'wallabag';
private $language = '';
- private $tags = array();
- private $footerTemplate = '<div style="text-align:center;">
- <p>Produced by wallabag with %EXPORT_METHOD%</p>
- <p>Please open <a href="https://github.com/wallabag/wallabag/issues">an issue</a> if you have trouble with the display of this E-Book on your device.</p>
- </div';
/**
- * @param Config $craueConfig CraueConfig instance to get wallabag instance url from database
- * @param string $logoPath Path to the logo FROM THE BUNDLE SCOPE
+ * @param TranslatorInterface $translator Translator service
+ * @param string $wallabagUrl Wallabag instance url
+ * @param string $logoPath Path to the logo FROM THE BUNDLE SCOPE
*/
- public function __construct(Config $craueConfig, $logoPath)
+ public function __construct(TranslatorInterface $translator, $wallabagUrl, $logoPath)
{
- $this->wallabagUrl = $craueConfig->get('wallabag_url');
+ $this->translator = $translator;
+ $this->wallabagUrl = $wallabagUrl;
$this->logoPath = $logoPath;
}
* Define entries.
*
* @param array|Entry $entries An array of entries or one entry
+ *
+ * @return EntriesExport
*/
public function setEntries($entries)
{
- if (!is_array($entries)) {
+ if (!\is_array($entries)) {
$this->language = $entries->getLanguage();
- $entries = array($entries);
+ $entries = [$entries];
}
$this->entries = $entries;
- foreach ($entries as $entry) {
- $this->tags[] = $entry->getTags();
- }
-
return $this;
}
* Sets the category of which we want to get articles, or just one entry.
*
* @param string $method Method to get articles
+ *
+ * @return EntriesExport
*/
public function updateTitle($method)
{
- $this->title = $method.' articles';
+ $this->title = $method . ' articles';
if ('entry' === $method) {
$this->title = $this->entries[0]->getTitle();
return $this;
}
+ /**
+ * Sets the author for one entry or category.
+ *
+ * The publishers are used, or the domain name if empty.
+ *
+ * @param string $method Method to get articles
+ *
+ * @return EntriesExport
+ */
+ public function updateAuthor($method)
+ {
+ if ('entry' !== $method) {
+ $this->author = 'Various authors';
+
+ return $this;
+ }
+
+ $this->author = $this->entries[0]->getDomainName();
+
+ $publishedBy = $this->entries[0]->getPublishedBy();
+ if (!empty($publishedBy)) {
+ $this->author = implode(', ', $publishedBy);
+ }
+
+ return $this;
+ }
+
/**
* Sets the output format.
*
* @param string $format
+ *
+ * @return Response
*/
public function exportAs($format)
{
- $functionName = 'produce'.ucfirst($format);
+ $functionName = 'produce' . ucfirst($format);
if (method_exists($this, $functionName)) {
return $this->$functionName();
}
throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
}
+ public function exportJsonData()
+ {
+ return $this->prepareSerializingContent('json');
+ }
+
/**
* Use PHPePub to dump a .epub file.
+ *
+ * @return Response
*/
private function produceEpub()
{
*/
$content_start =
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
- ."<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
- .'<head>'
- ."<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
- ."<title>wallabag articles book</title>\n"
- ."</head>\n"
- ."<body>\n";
+ . "<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
+ . '<head>'
+ . "<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
+ . "<title>wallabag articles book</title>\n"
+ . "</head>\n"
+ . "<body>\n";
$bookEnd = "</body>\n</html>\n";
*/
$book->setTitle($this->title);
- // Could also be the ISBN number, prefered for published books, or a UUID.
- $book->setIdentifier($this->title, EPub::IDENTIFIER_URI);
// Not needed, but included for the example, Language is mandatory, but EPub defaults to "en". Use RFC3066 Language codes, such as "en", "da", "fr" etc.
$book->setLanguage($this->language);
$book->setDescription('Some articles saved on my wallabag');
- foreach ($this->authors as $author) {
- $book->setAuthor($author, $author);
- }
+ $book->setAuthor($this->author, $this->author);
// I hope this is a non existant address :)
$book->setPublisher('wallabag', 'wallabag');
$book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png');
}
- $book->addChapter('Notices', 'Cover2.html', $content_start.$this->getExportInformation('PHPePub').$bookEnd);
-
- $book->buildTOC();
+ $entryIds = [];
+ $entryCount = \count($this->entries);
+ $i = 0;
/*
* Adding actual entries
// set tags as subjects
foreach ($this->entries as $entry) {
- foreach ($this->tags as $tag) {
- $book->setSubject($tag['value']);
+ ++$i;
+ foreach ($entry->getTags() as $tag) {
+ $book->setSubject($tag->getLabel());
+ }
+ $filename = sha1($entry->getTitle());
+
+ $publishedBy = $entry->getPublishedBy();
+ $authors = $this->translator->trans('export.unknown');
+ if (!empty($publishedBy)) {
+ $authors = implode(',', $publishedBy);
}
- $chapter = $content_start.$entry->getContent().$bookEnd;
- $book->addChapter($entry->getTitle(), htmlspecialchars($entry->getTitle()).'.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
+ $titlepage = $content_start .
+ '<h1>' . $entry->getTitle() . '</h1>' .
+ '<dl>' .
+ '<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' .
+ '</dl>' .
+ $bookEnd;
+ $book->addChapter("Entry {$i} of {$entryCount}", "{$filename}_cover.html", $titlepage, true, EPub::EXTERNAL_REF_ADD);
+ $chapter = $content_start . $entry->getContent() . $bookEnd;
+
+ $entryIds[] = $entry->getId();
+ $book->addChapter($entry->getTitle(), "{$filename}.html", $chapter, true, EPub::EXTERNAL_REF_ADD);
}
+ $book->addChapter('Notices', 'Cover2.html', $content_start . $this->getExportInformation('PHPePub') . $bookEnd);
+
+ // Could also be the ISBN number, prefered for published books, or a UUID.
+ $hash = sha1(sprintf('%s:%s', $this->wallabagUrl, implode(',', $entryIds)));
+ $book->setIdentifier(sprintf('urn:wallabag:%s', $hash), EPub::IDENTIFIER_URI);
+
return Response::create(
$book->getBook(),
200,
- array(
+ [
'Content-Description' => 'File Transfer',
'Content-type' => 'application/epub+zip',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.epub"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.epub"',
'Content-Transfer-Encoding' => 'binary',
- )
+ ]
);
}
/**
* Use PHPMobi to dump a .mobi file.
+ *
+ * @return Response
*/
private function produceMobi()
{
* Book metadata
*/
$content->set('title', $this->title);
- $content->set('author', implode($this->authors));
+ $content->set('author', $this->author);
$content->set('subject', $this->title);
/*
}
$mobi->setContentProvider($content);
- // the browser inside Kindle Devices doesn't likes special caracters either, we limit to A-z/0-9
- $this->title = preg_replace('/[^A-Za-z0-9\-]/', '', $this->title);
-
return Response::create(
$mobi->toString(),
200,
- array(
+ [
'Accept-Ranges' => 'bytes',
'Content-Description' => 'File Transfer',
'Content-type' => 'application/x-mobipocket-ebook',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.mobi"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.mobi"',
'Content-Transfer-Encoding' => 'binary',
- )
+ ]
);
}
/**
* Use TCPDF to dump a .pdf file.
+ *
+ * @return Response
*/
private function producePdf()
{
* Book metadata
*/
$pdf->SetCreator(PDF_CREATOR);
- $pdf->SetAuthor('wallabag');
+ $pdf->SetAuthor($this->author);
$pdf->SetTitle($this->title);
$pdf->SetSubject('Articles via wallabag');
$pdf->SetKeywords('wallabag');
- /*
- * Front page
- */
- $pdf->AddPage();
- $intro = '<h1>'.$this->title.'</h1>'.$this->getExportInformation('tcpdf');
-
- $pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
-
/*
* Adding actual entries
*/
foreach ($this->entries as $entry) {
- foreach ($this->tags as $tag) {
- $pdf->SetKeywords($tag['value']);
+ foreach ($entry->getTags() as $tag) {
+ $pdf->SetKeywords($tag->getLabel());
+ }
+
+ $publishedBy = $entry->getPublishedBy();
+ $authors = $this->translator->trans('export.unknown');
+ if (!empty($publishedBy)) {
+ $authors = implode(',', $publishedBy);
}
+ $pdf->addPage();
+ $html = '<h1>' . $entry->getTitle() . '</h1>' .
+ '<dl>' .
+ '<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' .
+ '<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' .
+ '</dl>';
+ $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
+
$pdf->AddPage();
- $html = '<h1>'.$entry->getTitle().'</h1>';
+ $html = '<h1>' . $entry->getTitle() . '</h1>';
$html .= $entry->getContent();
$pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
}
+ /*
+ * Last page
+ */
+ $pdf->AddPage();
+ $html = $this->getExportInformation('tcpdf');
+
+ $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
+
// set image scale factor
$pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
return Response::create(
$pdf->Output('', 'S'),
200,
- array(
+ [
'Content-Description' => 'File Transfer',
'Content-type' => 'application/pdf',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.pdf"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.pdf"',
'Content-Transfer-Encoding' => 'binary',
- )
+ ]
);
}
/**
* Inspired from CsvFileDumper.
+ *
+ * @return Response
*/
private function produceCsv()
{
$delimiter = ';';
$enclosure = '"';
- $handle = fopen('php://memory', 'rb+');
+ $handle = fopen('php://memory', 'b+r');
- fputcsv($handle, array('Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language'), $delimiter, $enclosure);
+ fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure);
foreach ($this->entries as $entry) {
fputcsv(
$handle,
- array(
+ [
$entry->getTitle(),
$entry->getURL(),
// remove new line to avoid crazy results
- str_replace(array("\r\n", "\r", "\n"), '', $entry->getContent()),
+ str_replace(["\r\n", "\r", "\n"], '', $entry->getContent()),
implode(', ', $entry->getTags()->toArray()),
$entry->getMimetype(),
$entry->getLanguage(),
- ),
+ $entry->getCreatedAt()->format('d/m/Y h:i:s'),
+ ],
$delimiter,
$enclosure
);
return Response::create(
$output,
200,
- array(
+ [
'Content-type' => 'application/csv',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.csv"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.csv"',
'Content-Transfer-Encoding' => 'UTF-8',
- )
+ ]
);
}
+ /**
+ * Dump a JSON file.
+ *
+ * @return Response
+ */
private function produceJson()
{
return Response::create(
$this->prepareSerializingContent('json'),
200,
- array(
+ [
'Content-type' => 'application/json',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.json"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.json"',
'Content-Transfer-Encoding' => 'UTF-8',
- )
+ ]
);
}
+ /**
+ * Dump a XML file.
+ *
+ * @return Response
+ */
private function produceXml()
{
return Response::create(
$this->prepareSerializingContent('xml'),
200,
- array(
+ [
'Content-type' => 'application/xml',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.xml"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.xml"',
'Content-Transfer-Encoding' => 'UTF-8',
- )
+ ]
);
}
+ /**
+ * Dump a TXT file.
+ *
+ * @return Response
+ */
private function produceTxt()
{
$content = '';
$bar = str_repeat('=', 100);
foreach ($this->entries as $entry) {
- $content .= "\n\n".$bar."\n\n".$entry->getTitle()."\n\n".$bar."\n\n";
- $content .= trim(preg_replace('/\s+/S', ' ', strip_tags($entry->getContent())))."\n\n";
+ $content .= "\n\n" . $bar . "\n\n" . $entry->getTitle() . "\n\n" . $bar . "\n\n";
+ $html = new Html2Text($entry->getContent(), ['do_links' => 'none', 'width' => 100]);
+ $content .= $html->getText();
}
return Response::create(
$content,
200,
- array(
+ [
'Content-type' => 'text/plain',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.txt"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.txt"',
'Content-Transfer-Encoding' => 'UTF-8',
- )
+ ]
);
}
/**
* Return a Serializer object for producing processes that need it (JSON & XML).
*
- * @return Serializer
+ * @param string $format
+ *
+ * @return string
*/
private function prepareSerializingContent($format)
{
return $serializer->serialize(
$this->entries,
$format,
- SerializationContext::create()->setGroups(array('entries_for_user'))
+ SerializationContext::create()->setGroups(['entries_for_user'])
);
}
*/
private function getExportInformation($type)
{
- $info = str_replace('%EXPORT_METHOD%', $type, $this->footerTemplate);
+ $info = $this->translator->trans('export.footer_template', [
+ '%method%' => $type,
+ ]);
if ('tcpdf' === $type) {
- return str_replace('%IMAGE%', '<img src="'.$this->logoPath.'" />', $info);
+ return str_replace('%IMAGE%', '<img src="' . $this->logoPath . '" />', $info);
}
return str_replace('%IMAGE%', '', $info);
}
+
+ /**
+ * Return a sanitized version of the title by applying translit iconv
+ * and removing non alphanumeric characters, - and space.
+ *
+ * @return string Sanitized filename
+ */
+ private function getSanitizedFilename()
+ {
+ return preg_replace('/[^A-Za-z0-9\- \']/', '', iconv('utf-8', 'us-ascii//TRANSLIT', $this->title));
+ }
}
projects / github / wallabag / wallabag.git / blobdiff