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;
/**
{
private $wallabagUrl;
private $logoPath;
+ private $translator;
private $title = '';
private $entries = [];
private $author = 'wallabag';
private $language = '';
- 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 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;
}
*/
public function setEntries($entries)
{
- if (!is_array($entries)) {
+ if (!\is_array($entries)) {
$this->language = $entries->getLanguage();
$entries = [$entries];
}
public function updateAuthor($method)
{
if ('entry' !== $method) {
- $this->author = $method . ' authors';
+ $this->author = 'Various authors';
return $this;
}
*/
$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');
$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
// 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 .
+ '<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;
- $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',
]
);
}
$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,
'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',
]
);
$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
*/
$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 .= $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);
[
'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',
]
);
{
$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);
200,
[
'Content-type' => 'application/csv',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.csv"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.csv"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
200,
[
'Content-type' => 'application/json',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.json"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.json"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
200,
[
'Content-type' => 'application/xml',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.xml"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.xml"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
200,
[
'Content-type' => 'text/plain',
- 'Content-Disposition' => 'attachment; filename="' . $this->title . '.txt"',
+ 'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.txt"',
'Content-Transfer-Encoding' => 'UTF-8',
]
);
*/
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%', '', $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));
+ }
}