namespace Wallabag\CoreBundle\Helper;
+use JMS\Serializer;
+use JMS\Serializer\SerializationContext;
+use JMS\Serializer\SerializerBuilder;
use PHPePub\Core\EPub;
use PHPePub\Core\Structure\OPF\DublinCore;
+use Symfony\Component\HttpFoundation\Response;
+/**
+ * This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest.
+ */
class EntriesExport
{
- private $format;
- private $method;
- private $title;
- private $entries;
- private $authors = array('wallabag');
- private $language;
- private $tags;
-
- public function __construct($entries)
+ private $wallabagUrl;
+ private $logoPath;
+ private $title = '';
+ private $entries = [];
+ private $authors = ['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
+ */
+ public function __construct($wallabagUrl, $logoPath)
{
- $this->entries = $entries;
+ $this->wallabagUrl = $wallabagUrl;
+ $this->logoPath = $logoPath;
+ }
- foreach ($entries as $entry) {
- $this->tags[] = $entry->getTags();
- }
- if (count($entries) === 1) {
- $this->language = $entries[0]->getLanguage();
+ /**
+ * Define entries.
+ *
+ * @param array|Entry $entries An array of entries or one entry
+ *
+ * @return EntriesExport
+ */
+ public function setEntries($entries)
+ {
+ if (!is_array($entries)) {
+ $this->language = $entries->getLanguage();
+ $entries = [$entries];
}
+
+ $this->entries = $entries;
+
+ 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 setMethod($method)
+ public function updateTitle($method)
{
- $this->method = $method;
-
- switch ($this->method) {
- case 'All':
- $this->title = 'All Articles';
- break;
- case 'Unread':
- $this->title = 'Unread articles';
- break;
- case 'Starred':
- $this->title = 'Starred articles';
- break;
- case 'Archive':
- $this->title = 'Archived articles';
- break;
- case 'entry':
- $this->title = $this->entries[0]->getTitle();
- break;
- default:
- break;
+ $this->title = $method . ' articles';
+
+ if ('entry' === $method) {
+ $this->title = $this->entries[0]->getTitle();
}
+
+ return $this;
}
/**
* Sets the output format.
*
* @param string $format
+ *
+ * @return Response
*/
public function exportAs($format)
{
- $this->format = $format;
-
- switch ($this->format) {
- case 'epub':
- $this->produceEpub();
- break;
-
- case 'mobi':
- $this->produceMobi();
- break;
-
- case 'pdf':
- $this->producePDF();
- break;
+ $functionName = 'produce' . ucfirst($format);
+ if (method_exists($this, $functionName)) {
+ return $this->$functionName();
+ }
- case 'csv':
- $this->produceCSV();
- break;
+ throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
+ }
- default:
- break;
- }
+ 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);
- $book->setIdentifier($this->title, EPub::IDENTIFIER_URI); // Could also be the ISBN number, prefered for published books, or a UUID.
- $book->setLanguage($this->language); // 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->setDescription(_('Some articles saved on my wallabag'));
+ // 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->setPublisher('wallabag', 'wallabag'); // I hope this is a non existant address :)
- $book->setDate(time()); // Strictly not needed as the book date defaults to time().
- $book->setSourceURL("http://$_SERVER[HTTP_HOST]");
+ // I hope this is a non existant address :)
+ $book->setPublisher('wallabag', 'wallabag');
+ // Strictly not needed as the book date defaults to time().
+ $book->setDate(time());
+ $book->setSourceURL($this->wallabagUrl);
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'PHP');
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'wallabag');
/*
* Front page
*/
-
- $book->setCoverImage('Cover.png', file_get_contents('themes/_global/img/appicon/apple-touch-icon-152.png'), 'image/png');
-
- $cover = $content_start.'<div style="text-align:center;"><p>'._('Produced by wallabag with PHPePub').'</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>'.$bookEnd;
-
- $book->addChapter('Notices', 'Cover2.html', $cover);
+ if (file_exists($this->logoPath)) {
+ $book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png');
+ }
$book->buildTOC();
* Adding actual entries
*/
- foreach ($this->entries as $entry) { //set tags as subjects
- foreach ($this->tags as $tag) {
- $book->setSubject($tag['value']);
- }
+ // set tags as subjects
+ foreach ($this->entries as $entry) {
+ foreach ($entry->getTags() as $tag) {
+ $book->setSubject($tag->getLabel());
+ }
+
+ // 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());
- $chapter = $content_start.$entry->getContent().$bookEnd;
- $book->addChapter($entry->getTitle(), htmlspecialchars($entry->getTitle()).'.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
+ $chapter = $content_start . $entry->getContent() . $bookEnd;
+ $book->addChapter($entry->getTitle(), htmlspecialchars($filename) . '.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
}
- $book->finalize();
- $book->sendBook($this->title);
+
+ $book->addChapter('Notices', 'Cover2.html', $content_start . $this->getExportInformation('PHPePub') . $bookEnd);
+
+ return Response::create(
+ $book->getBook(),
+ 200,
+ [
+ 'Content-Description' => 'File Transfer',
+ 'Content-type' => 'application/epub+zip',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.epub"',
+ 'Content-Transfer-Encoding' => 'binary',
+ ]
+ );
}
+ /**
+ * Use PHPMobi to dump a .mobi file.
+ *
+ * @return Response
+ */
private function produceMobi()
{
$mobi = new \MOBI();
/*
* Book metadata
*/
-
$content->set('title', $this->title);
$content->set('author', implode($this->authors));
$content->set('subject', $this->title);
/*
* Front page
*/
-
- $content->appendParagraph('<div style="text-align:center;" ><p>'._('Produced by wallabag with PHPMobi').'</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>');
- $content->appendImage(imagecreatefrompng('themes/_global/img/appicon/apple-touch-icon-152.png'));
+ $content->appendParagraph($this->getExportInformation('PHPMobi'));
+ if (file_exists($this->logoPath)) {
+ $content->appendImage(imagecreatefrompng($this->logoPath));
+ }
$content->appendPageBreak();
/*
* Adding actual entries
*/
-
foreach ($this->entries as $entry) {
$content->appendChapterTitle($entry->getTitle());
$content->appendParagraph($entry->getContent());
// 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);
- // we offer file to download
- $mobi->download($this->title.'.mobi');
+ 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-Transfer-Encoding' => 'binary',
+ ]
+ );
}
- private function producePDF()
+ /**
+ * Use TCPDF to dump a .pdf file.
+ *
+ * @return Response
+ */
+ private function producePdf()
{
$pdf = new \TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
/*
* Book metadata
*/
-
$pdf->SetCreator(PDF_CREATOR);
$pdf->SetAuthor('wallabag');
$pdf->SetTitle($this->title);
/*
* Front page
*/
-
$pdf->AddPage();
- $intro = '<h1>'.$this->title.'</h1><div style="text-align:center;" >
- <p>'._('Produced by wallabag with tcpdf').'</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>
- <img src="themes/_global/img/appicon/apple-touch-icon-152.png" /></div>';
+ $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());
}
$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);
}
// set image scale factor
$pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
- $pdf->Output($this->title.'.pdf', 'D');
+ return Response::create(
+ $pdf->Output('', 'S'),
+ 200,
+ [
+ 'Content-Description' => 'File Transfer',
+ 'Content-type' => 'application/pdf',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.pdf"',
+ 'Content-Transfer-Encoding' => 'binary',
+ ]
+ );
}
- private function produceCSV()
+ /**
+ * Inspired from CsvFileDumper.
+ *
+ * @return Response
+ */
+ private function produceCsv()
{
- header('Content-type: application/csv');
- header('Content-Disposition: attachment; filename="'.$this->title.'.csv"');
- header('Content-Transfer-Encoding: UTF-8');
+ $delimiter = ';';
+ $enclosure = '"';
+ $handle = fopen('php://memory', 'rb+');
- $output = fopen('php://output', 'a');
+ fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure);
- fputcsv($output, array('Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language'));
foreach ($this->entries as $entry) {
- fputcsv($output, array($entry->getTitle(),
- $entry->getURL(),
- $entry->getContent(),
- implode(', ', $entry->getTags()->toArray()),
- $entry->getMimetype(),
- $entry->getLanguage(), ));
+ fputcsv(
+ $handle,
+ [
+ $entry->getTitle(),
+ $entry->getURL(),
+ // remove new line to avoid crazy results
+ 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
+ );
}
- fclose($output);
- exit();
+
+ rewind($handle);
+ $output = stream_get_contents($handle);
+ fclose($handle);
+
+ return Response::create(
+ $output,
+ 200,
+ [
+ 'Content-type' => 'application/csv',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.csv"',
+ 'Content-Transfer-Encoding' => 'UTF-8',
+ ]
+ );
+ }
+
+ /**
+ * Dump a JSON file.
+ *
+ * @return Response
+ */
+ private function produceJson()
+ {
+ return Response::create(
+ $this->prepareSerializingContent('json'),
+ 200,
+ [
+ 'Content-type' => 'application/json',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.json"',
+ 'Content-Transfer-Encoding' => 'UTF-8',
+ ]
+ );
+ }
+
+ /**
+ * Dump a XML file.
+ *
+ * @return Response
+ */
+ private function produceXml()
+ {
+ return Response::create(
+ $this->prepareSerializingContent('xml'),
+ 200,
+ [
+ 'Content-type' => 'application/xml',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.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";
+ }
+
+ return Response::create(
+ $content,
+ 200,
+ [
+ 'Content-type' => 'text/plain',
+ 'Content-Disposition' => 'attachment; filename="' . $this->title . '.txt"',
+ 'Content-Transfer-Encoding' => 'UTF-8',
+ ]
+ );
+ }
+
+ /**
+ * Return a Serializer object for producing processes that need it (JSON & XML).
+ *
+ * @param string $format
+ *
+ * @return Serializer
+ */
+ private function prepareSerializingContent($format)
+ {
+ $serializer = SerializerBuilder::create()->build();
+
+ return $serializer->serialize(
+ $this->entries,
+ $format,
+ SerializationContext::create()->setGroups(['entries_for_user'])
+ );
+ }
+
+ /**
+ * Return a kind of footer / information for the epub.
+ *
+ * @param string $type Generator of the export, can be: tdpdf, PHPePub, PHPMobi
+ *
+ * @return string
+ */
+ private function getExportInformation($type)
+ {
+ $info = str_replace('%EXPORT_METHOD%', $type, $this->footerTemplate);
+
+ if ('tcpdf' === $type) {
+ return str_replace('%IMAGE%', '<img src="' . $this->logoPath . '" />', $info);
+ }
+
+ return str_replace('%IMAGE%', '', $info);
}
}
projects / github / wallabag / wallabag.git / blobdiff