X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=src%2FWallabag%2FCoreBundle%2FHelper%2FEntriesExport.php;h=f981ee50e61b8a323ae091f97f1139b82896de17;hb=3c5aa05311d057c8fed83f085e6fb6ecc874fca4;hp=de259e7ffc25246acbab2299078b63afd38778cd;hpb=52b84c11a5b5474cd45271d937a46c6adfdf2749;p=github%2Fwallabag%2Fwallabag.git
diff --git a/src/Wallabag/CoreBundle/Helper/EntriesExport.php b/src/Wallabag/CoreBundle/Helper/EntriesExport.php
index de259e7f..f981ee50 100644
--- a/src/Wallabag/CoreBundle/Helper/EntriesExport.php
+++ b/src/Wallabag/CoreBundle/Helper/EntriesExport.php
@@ -2,11 +2,13 @@
namespace Wallabag\CoreBundle\Helper;
+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 Symfony\Component\Translation\TranslatorInterface;
use Wallabag\CoreBundle\Entity\Entry;
/**
@@ -16,21 +18,20 @@ class EntriesExport
{
private $wallabagUrl;
private $logoPath;
+ private $translator;
private $title = '';
private $entries = [];
private $author = 'wallabag';
private $language = '';
- private $footerTemplate = '
-
Produced by wallabag with %EXPORT_METHOD%
-
Please open an issue if you have trouble with the display of this E-Book on your device.
-
';
/**
- * @param string $wallabagUrl Wallabag instance url
- * @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($wallabagUrl, $logoPath)
+ public function __construct(TranslatorInterface $translator, $wallabagUrl, $logoPath)
{
+ $this->translator = $translator;
$this->wallabagUrl = $wallabagUrl;
$this->logoPath = $logoPath;
}
@@ -44,7 +45,7 @@ class EntriesExport
*/
public function setEntries($entries)
{
- if (!is_array($entries)) {
+ if (!\is_array($entries)) {
$this->language = $entries->getLanguage();
$entries = [$entries];
}
@@ -84,7 +85,7 @@ class EntriesExport
public function updateAuthor($method)
{
if ('entry' !== $method) {
- $this->author = $method . ' authors';
+ $this->author = 'Various authors';
return $this;
}
@@ -149,8 +150,6 @@ class EntriesExport
*/
$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');
@@ -166,14 +165,9 @@ class EntriesExport
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'PHP');
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'wallabag');
- /*
- * Front page
- */
- if (file_exists($this->logoPath)) {
- $book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png');
- }
-
- $book->buildTOC();
+ $entryIds = [];
+ $entryCount = \count($this->entries);
+ $i = 0;
/*
* Adding actual entries
@@ -181,27 +175,56 @@ class EntriesExport
// set tags as subjects
foreach ($this->entries as $entry) {
+ ++$i;
+
+ /*
+ * Front page
+ * Set if there's only one entry in the given set
+ */
+ if (1 === $entryCount && null !== $entry->getPreviewPicture()) {
+ $book->setCoverImage($entry->getPreviewPicture());
+ }
+
foreach ($entry->getTags() as $tag) {
$book->setSubject($tag->getLabel());
}
+ $filename = sha1(sprintf('%s:%s', $entry->getUrl(), $entry->getTitle()));
- // the reader in Kobo Devices doesn't likes special caracters
- // in filenames, we limit to A-z/0-9
- $filename = preg_replace('/[^A-Za-z0-9\-]/', '', $entry->getTitle());
+ $publishedBy = $entry->getPublishedBy();
+ $authors = $this->translator->trans('export.unknown');
+ if (!empty($publishedBy)) {
+ $authors = implode(',', $publishedBy);
+ }
+ $titlepage = $content_start .
+ '' . $entry->getTitle() . '
' .
+ '' .
+ '- ' . $this->translator->trans('entry.view.published_by') . '
- ' . $authors . '
' .
+ '- ' . $this->translator->trans('entry.metadata.reading_time') . '
- ' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '
' .
+ '- ' . $this->translator->trans('entry.metadata.added_on') . '
- ' . $entry->getCreatedAt()->format('Y-m-d') . '
' .
+ '- ' . $this->translator->trans('entry.metadata.address') . '
- ' . $entry->getUrl() . '
' .
+ '
' .
+ $bookEnd;
+ $book->addChapter("Entry {$i} of {$entryCount}", "{$filename}_cover.html", $titlepage, true, EPub::EXTERNAL_REF_ADD);
$chapter = $content_start . $entry->getContent() . $bookEnd;
- $book->addChapter($entry->getTitle(), htmlspecialchars($filename) . '.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
+
+ $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,
[
'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',
]
);
@@ -243,9 +266,6 @@ class EntriesExport
}
$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,
@@ -253,7 +273,7 @@ class EntriesExport
'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',
]
);
@@ -277,14 +297,6 @@ class EntriesExport
$pdf->SetSubject('Articles via wallabag');
$pdf->SetKeywords('wallabag');
- /*
- * Front page
- */
- $pdf->AddPage();
- $intro = '' . $this->title . '
' . $this->getExportInformation('tcpdf');
-
- $pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
-
/*
* Adding actual entries
*/
@@ -293,6 +305,22 @@ class EntriesExport
$pdf->SetKeywords($tag->getLabel());
}
+ $publishedBy = $entry->getPublishedBy();
+ $authors = $this->translator->trans('export.unknown');
+ if (!empty($publishedBy)) {
+ $authors = implode(',', $publishedBy);
+ }
+
+ $pdf->addPage();
+ $html = '' . $entry->getTitle() . '
' .
+ '' .
+ '- ' . $this->translator->trans('entry.view.published_by') . '
- ' . $authors . '
' .
+ '- ' . $this->translator->trans('entry.metadata.reading_time') . '
- ' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '
' .
+ '- ' . $this->translator->trans('entry.metadata.added_on') . '
- ' . $entry->getCreatedAt()->format('Y-m-d') . '
' .
+ '- ' . $this->translator->trans('entry.metadata.address') . '
- ' . $entry->getUrl() . '
' .
+ '
';
+ $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
+
$pdf->AddPage();
$html = '' . $entry->getTitle() . '
';
$html .= $entry->getContent();
@@ -300,6 +328,14 @@ class EntriesExport
$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);
@@ -309,7 +345,7 @@ class EntriesExport
[
'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',
]
);
@@ -324,7 +360,7 @@ class EntriesExport
{
$delimiter = ';';
$enclosure = '"';
- $handle = fopen('php://memory', 'rb+');
+ $handle = fopen('php://memory', 'b+r');
fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure);
@@ -355,7 +391,7 @@ class EntriesExport
200,
[
'Content-type' => 'application/csv',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.csv"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.csv"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
@@ -373,7 +409,7 @@ class EntriesExport
200,
[
'Content-type' => 'application/json',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.json"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.json"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
@@ -391,7 +427,7 @@ class EntriesExport
200,
[
'Content-type' => 'application/xml',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.xml"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.xml"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
@@ -408,7 +444,8 @@ class EntriesExport
$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";
+ $html = new Html2Text($entry->getContent(), ['do_links' => 'none', 'width' => 100]);
+ $content .= $html->getText();
}
return Response::create(
@@ -416,7 +453,7 @@ class EntriesExport
200,
[
'Content-type' => 'text/plain',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.txt"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.txt"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
@@ -449,7 +486,9 @@ class EntriesExport
*/
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%', '', $info);
@@ -457,4 +496,15 @@ class EntriesExport
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));
+ }
}