[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Helper / EntriesExport.php

<?php

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;

/**
 * This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest.
 */
class EntriesExport
{
    private $wallabagUrl;
    private $logoPath;
    private $translator;
    private $title = '';
    private $entries = [];
    private $author = 'wallabag';
    private $language = '';

    /**
     * @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(TranslatorInterface $translator, $wallabagUrl, $logoPath)
    {
        $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)) {
            $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 updateTitle($method)
    {
        $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);
        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()
    {
        /*
         * Start and End of the book
         */
        $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";

        $bookEnd = "</body>\n</html>\n";

        $book = new EPub(EPub::BOOK_VERSION_EPUB3);

        /*
         * Book metadata
         */

        $book->setTitle($this->title);
        // 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->setAuthor($this->author, $this->author);

        // 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');

        $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()));

            $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;

            $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->getSanitizedFilename() . '.epub"',
                'Content-Transfer-Encoding' => 'binary',
            ]
        );
    }

    /**
     * Use PHPMobi to dump a .mobi file.
     *
     * @return Response
     */
    private function produceMobi()
    {
        $mobi = new \MOBI();
        $content = new \MOBIFile();

        /*
         * Book metadata
         */
        $content->set('title', $this->title);
        $content->set('author', $this->author);
        $content->set('subject', $this->title);

        /*
         * Front page
         */
        $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());
            $content->appendPageBreak();
        }
        $mobi->setContentProvider($content);

        return Response::create(
            $mobi->toString(),
            200,
            [
                'Accept-Ranges' => 'bytes',
                'Content-Description' => 'File Transfer',
                'Content-type' => 'application/x-mobipocket-ebook',
                'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.mobi"',
                'Content-Transfer-Encoding' => 'binary',
            ]
        );
    }

    /**
     * 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($this->author);
        $pdf->SetTitle($this->title);
        $pdf->SetSubject('Articles via wallabag');
        $pdf->SetKeywords('wallabag');

        /*
         * Adding actual entries
         */
        foreach ($this->entries as $entry) {
            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 .= $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,
            [
                'Content-Description' => 'File Transfer',
                'Content-type' => 'application/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', 'b+r');

        fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure);

        foreach ($this->entries as $entry) {
            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
            );
        }

        rewind($handle);
        $output = stream_get_contents($handle);
        fclose($handle);

        return Response::create(
            $output,
            200,
            [
                'Content-type' => 'application/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,
            [
                'Content-type' => 'application/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,
            [
                'Content-type' => 'application/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";
            $html = new Html2Text($entry->getContent(), ['do_links' => 'none', 'width' => 100]);
            $content .= $html->getText();
        }

        return Response::create(
            $content,
            200,
            [
                'Content-type' => 'text/plain',
                'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.txt"',
                'Content-Transfer-Encoding' => 'UTF-8',
            ]
        );
    }

    /**
     * Return a Serializer object for producing processes that need it (JSON & XML).
     *
     * @param string $format
     *
     * @return string
     */
    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 = $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));
    }
}
Commit	Line	Data
03690d13 TC	1	<?php
	2
	3	namespace Wallabag\CoreBundle\Helper;
	4
c6608783	5	use Html2Text\Html2Text;
619cc453 JB	6	use JMS\Serializer\SerializationContext;
619cc453 JB	7	use JMS\Serializer\SerializerBuilder;
03690d13 TC	8	use PHPePub\Core\EPub;
03690d13 TC	9	use PHPePub\Core\Structure\OPF\DublinCore;
add597ba	10	use Symfony\Component\HttpFoundation\Response;
b1428a1c	11	use Symfony\Component\Translation\TranslatorInterface;
52b84c11	12	use Wallabag\CoreBundle\Entity\Entry;
03690d13	13
cceca9ea JB	14	/**
	15	* This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest.
	16	*/
03690d13 TC	17	class EntriesExport
03690d13 TC	18	{
add597ba JB	19	private $wallabagUrl;
add597ba JB	20	private $logoPath;
b1428a1c	21	private $translator;
add597ba	22	private $title = '';
4094ea47	23	private $entries = [];
07320a2b	24	private $author = 'wallabag';
add597ba	25	private $language = '';
03690d13	26
add597ba	27	/**
9dd67fa3 JB	28	* @param TranslatorInterface $translator Translator service
	29	* @param string $wallabagUrl Wallabag instance url
	30	* @param string $logoPath Path to the logo FROM THE BUNDLE SCOPE
add597ba	31	*/
dc7fa8df	32	public function __construct(TranslatorInterface $translator, $wallabagUrl, $logoPath)
03690d13	33	{
dc7fa8df	34	$this->translator = $translator;
4b3c983a	35	$this->wallabagUrl = $wallabagUrl;
add597ba JB	36	$this->logoPath = $logoPath;
	37	}
	38
	39	/**
	40	* Define entries.
	41	*
	42	* @param array\|Entry $entries An array of entries or one entry
4094ea47 JB	43	*
4094ea47 JB	44	* @return EntriesExport
add597ba JB	45	*/
	46	public function setEntries($entries)
	47	{
2a1ceb67	48	if (!\is_array($entries)) {
add597ba	49	$this->language = $entries->getLanguage();
4094ea47	50	$entries = [$entries];
add597ba JB	51	}
add597ba JB	52
03690d13 TC	53	$this->entries = $entries;
03690d13 TC	54
add597ba	55	return $this;
03690d13 TC	56	}
	57
	58	/**
	59	* Sets the category of which we want to get articles, or just one entry.
	60	*
	61	* @param string $method Method to get articles
4094ea47 JB	62	*
4094ea47 JB	63	* @return EntriesExport
03690d13	64	*/
add597ba	65	public function updateTitle($method)
03690d13	66	{
15a6402f	67	$this->title = $method . ' articles';
add597ba JB	68
	69	if ('entry' === $method) {
	70	$this->title = $this->entries[0]->getTitle();
03690d13	71	}
add597ba JB	72
add597ba JB	73	return $this;
03690d13 TC	74	}
03690d13 TC	75
07320a2b	76	/**
c57f69d9 ÉG	77	* Sets the author for one entry or category.
	78	*
	79	* The publishers are used, or the domain name if empty.
07320a2b ÉG	80	*
	81	* @param string $method Method to get articles
	82	*
	83	* @return EntriesExport
	84	*/
	85	public function updateAuthor($method)
	86	{
eeabca80	87	if ('entry' !== $method) {
f8108346	88	$this->author = 'Various authors';
07320a2b	89
eeabca80 ÉG	90	return $this;
	91	}
	92
	93	$this->author = $this->entries[0]->getDomainName();
	94
	95	$publishedBy = $this->entries[0]->getPublishedBy();
	96	if (!empty($publishedBy)) {
	97	$this->author = implode(', ', $publishedBy);
07320a2b ÉG	98	}
	99
	100	return $this;
	101	}
	102
03690d13 TC	103	/**
	104	* Sets the output format.
	105	*
	106	* @param string $format
4094ea47 JB	107	*
4094ea47 JB	108	* @return Response
03690d13 TC	109	*/
	110	public function exportAs($format)
	111	{
15a6402f	112	$functionName = 'produce' . ucfirst($format);
8f336fda JB	113	if (method_exists($this, $functionName)) {
8f336fda JB	114	return $this->$functionName();
03690d13	115	}
add597ba JB	116
add597ba JB	117	throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
03690d13 TC	118	}
03690d13 TC	119
8303b037 TC	120	public function exportJsonData()
	121	{
	122	return $this->prepareSerializingContent('json');
	123	}
	124
add597ba JB	125	/**
add597ba JB	126	* Use PHPePub to dump a .epub file.
4094ea47 JB	127	*
4094ea47 JB	128	* @return Response
add597ba	129	*/
03690d13 TC	130	private function produceEpub()
	131	{
	132	/*
	133	* Start and End of the book
	134	*/
	135	$content_start =
	136	"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
15a6402f JB	137	. "<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
	138	. '<head>'
	139	. "<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
	140	. "<title>wallabag articles book</title>\n"
	141	. "</head>\n"
	142	. "<body>\n";
03690d13 TC	143
	144	$bookEnd = "</body>\n</html>\n";
	145
	146	$book = new EPub(EPub::BOOK_VERSION_EPUB3);
	147
	148	/*
	149	* Book metadata
	150	*/
	151
	152	$book->setTitle($this->title);
add597ba JB	153	// 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.
	154	$book->setLanguage($this->language);
	155	$book->setDescription('Some articles saved on my wallabag');
03690d13	156
07320a2b	157	$book->setAuthor($this->author, $this->author);
03690d13	158
add597ba JB	159	// I hope this is a non existant address :)
	160	$book->setPublisher('wallabag', 'wallabag');
	161	// Strictly not needed as the book date defaults to time().
	162	$book->setDate(time());
	163	$book->setSourceURL($this->wallabagUrl);
03690d13 TC	164
	165	$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'PHP');
	166	$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'wallabag');
	167
bf22266a	168	$entryIds = [];
edd1825b KD	169	$entryCount = \count($this->entries);
edd1825b KD	170	$i = 0;
bf22266a	171
03690d13 TC	172	/*
	173	* Adding actual entries
	174	*/
	175
add597ba JB	176	// set tags as subjects
add597ba JB	177	foreach ($this->entries as $entry) {
edd1825b	178	++$i;
9a7a0e1e KD	179
	180	/*
	181	* Front page
	182	* Set if there's only one entry in the given set
	183	*/
	184	if (1 === $entryCount && null !== $entry->getPreviewPicture()) {
	185	$book->setCoverImage($entry->getPreviewPicture());
	186	}
	187
b0458874 JB	188	foreach ($entry->getTags() as $tag) {
b0458874 JB	189	$book->setSubject($tag->getLabel());
add597ba	190	}
41d476d7	191	$filename = sha1(sprintf('%s:%s', $entry->getUrl(), $entry->getTitle()));
45d94a98	192
4944703e	193	$publishedBy = $entry->getPublishedBy();
5e1f2776	194	$authors = $this->translator->trans('export.unknown');
4944703e KD	195	if (!empty($publishedBy)) {
4944703e KD	196	$authors = implode(',', $publishedBy);
4944703e KD	197	}
	198
	199	$titlepage = $content_start .
	200	'<h1>' . $entry->getTitle() . '</h1>' .
	201	'<dl>' .
	202	'<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' .
	203	'<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' .
	204	'<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' .
	205	'<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' .
	206	'</dl>' .
	207	$bookEnd;
edd1825b	208	$book->addChapter("Entry {$i} of {$entryCount}", "{$filename}_cover.html", $titlepage, true, EPub::EXTERNAL_REF_ADD);
15a6402f	209	$chapter = $content_start . $entry->getContent() . $bookEnd;
bf22266a KD	210
bf22266a KD	211	$entryIds[] = $entry->getId();
edd1825b	212	$book->addChapter($entry->getTitle(), "{$filename}.html", $chapter, true, EPub::EXTERNAL_REF_ADD);
03690d13	213	}
add597ba	214
30cf72bf KD	215	$book->addChapter('Notices', 'Cover2.html', $content_start . $this->getExportInformation('PHPePub') . $bookEnd);
30cf72bf KD	216
bf22266a KD	217	// Could also be the ISBN number, prefered for published books, or a UUID.
	218	$hash = sha1(sprintf('%s:%s', $this->wallabagUrl, implode(',', $entryIds)));
	219	$book->setIdentifier(sprintf('urn:wallabag:%s', $hash), EPub::IDENTIFIER_URI);
	220
add597ba JB	221	return Response::create(
	222	$book->getBook(),
	223	200,
4094ea47	224	[
add597ba JB	225	'Content-Description' => 'File Transfer',
add597ba JB	226	'Content-type' => 'application/epub+zip',
dac93644	227	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.epub"',
add597ba	228	'Content-Transfer-Encoding' => 'binary',
4094ea47	229	]
f898102c	230	);
03690d13 TC	231	}
03690d13 TC	232
add597ba JB	233	/**
add597ba JB	234	* Use PHPMobi to dump a .mobi file.
4094ea47 JB	235	*
4094ea47 JB	236	* @return Response
add597ba	237	*/
03690d13 TC	238	private function produceMobi()
	239	{
	240	$mobi = new \MOBI();
	241	$content = new \MOBIFile();
	242
	243	/*
	244	* Book metadata
	245	*/
03690d13	246	$content->set('title', $this->title);
07320a2b	247	$content->set('author', $this->author);
03690d13 TC	248	$content->set('subject', $this->title);
	249
	250	/*
	251	* Front page
	252	*/
add597ba JB	253	$content->appendParagraph($this->getExportInformation('PHPMobi'));
	254	if (file_exists($this->logoPath)) {
	255	$content->appendImage(imagecreatefrompng($this->logoPath));
	256	}
03690d13 TC	257	$content->appendPageBreak();
	258
	259	/*
	260	* Adding actual entries
	261	*/
03690d13 TC	262	foreach ($this->entries as $entry) {
	263	$content->appendChapterTitle($entry->getTitle());
	264	$content->appendParagraph($entry->getContent());
	265	$content->appendPageBreak();
	266	}
	267	$mobi->setContentProvider($content);
	268
add597ba JB	269	return Response::create(
	270	$mobi->toString(),
	271	200,
4094ea47	272	[
add597ba JB	273	'Accept-Ranges' => 'bytes',
	274	'Content-Description' => 'File Transfer',
	275	'Content-type' => 'application/x-mobipocket-ebook',
dac93644	276	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.mobi"',
add597ba	277	'Content-Transfer-Encoding' => 'binary',
4094ea47	278	]
f898102c	279	);
03690d13 TC	280	}
03690d13 TC	281
add597ba JB	282	/**
add597ba JB	283	* Use TCPDF to dump a .pdf file.
4094ea47 JB	284	*
4094ea47 JB	285	* @return Response
add597ba	286	*/
8f336fda	287	private function producePdf()
03690d13 TC	288	{
	289	$pdf = new \TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
	290
	291	/*
	292	* Book metadata
	293	*/
03690d13	294	$pdf->SetCreator(PDF_CREATOR);
07320a2b	295	$pdf->SetAuthor($this->author);
03690d13 TC	296	$pdf->SetTitle($this->title);
	297	$pdf->SetSubject('Articles via wallabag');
	298	$pdf->SetKeywords('wallabag');
	299
03690d13 TC	300	/*
	301	* Adding actual entries
	302	*/
03690d13	303	foreach ($this->entries as $entry) {
b0458874 JB	304	foreach ($entry->getTags() as $tag) {
b0458874 JB	305	$pdf->SetKeywords($tag->getLabel());
03690d13 TC	306	}
03690d13 TC	307
ad5ef8bc	308	$publishedBy = $entry->getPublishedBy();
5e1f2776	309	$authors = $this->translator->trans('export.unknown');
ad5ef8bc KD	310	if (!empty($publishedBy)) {
ad5ef8bc KD	311	$authors = implode(',', $publishedBy);
ad5ef8bc KD	312	}
	313
	314	$pdf->addPage();
	315	$html = '<h1>' . $entry->getTitle() . '</h1>' .
	316	'<dl>' .
	317	'<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' .
	318	'<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' .
	319	'<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' .
	320	'<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' .
	321	'</dl>';
	322	$pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
	323
03690d13	324	$pdf->AddPage();
15a6402f	325	$html = '<h1>' . $entry->getTitle() . '</h1>';
03690d13	326	$html .= $entry->getContent();
add597ba	327
03690d13 TC	328	$pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
	329	}
	330
ad5ef8bc KD	331	/*
	332	* Last page
	333	*/
	334	$pdf->AddPage();
	335	$html = $this->getExportInformation('tcpdf');
	336
	337	$pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
	338
03690d13 TC	339	// set image scale factor
	340	$pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
	341
add597ba JB	342	return Response::create(
	343	$pdf->Output('', 'S'),
	344	200,
4094ea47	345	[
add597ba JB	346	'Content-Description' => 'File Transfer',
add597ba JB	347	'Content-type' => 'application/pdf',
dac93644	348	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.pdf"',
add597ba	349	'Content-Transfer-Encoding' => 'binary',
4094ea47	350	]
f898102c	351	);
03690d13 TC	352	}
03690d13 TC	353
add597ba JB	354	/**
add597ba JB	355	* Inspired from CsvFileDumper.
4094ea47 JB	356	*
4094ea47 JB	357	* @return Response
add597ba	358	*/
8f336fda	359	private function produceCsv()
03690d13	360	{
add597ba JB	361	$delimiter = ';';
add597ba JB	362	$enclosure = '"';
2a1ceb67	363	$handle = fopen('php://memory', 'b+r');
03690d13	364
9401696f	365	fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure);
03690d13	366
03690d13	367	foreach ($this->entries as $entry) {
add597ba JB	368	fputcsv(
add597ba JB	369	$handle,
4094ea47	370	[
add597ba JB	371	$entry->getTitle(),
add597ba JB	372	$entry->getURL(),
cceca9ea	373	// remove new line to avoid crazy results
4094ea47	374	str_replace(["\r\n", "\r", "\n"], '', $entry->getContent()),
add597ba JB	375	implode(', ', $entry->getTags()->toArray()),
	376	$entry->getMimetype(),
	377	$entry->getLanguage(),
9401696f	378	$entry->getCreatedAt()->format('d/m/Y h:i:s'),
4094ea47	379	],
add597ba JB	380	$delimiter,
	381	$enclosure
	382	);
	383	}
	384
	385	rewind($handle);
	386	$output = stream_get_contents($handle);
	387	fclose($handle);
	388
	389	return Response::create(
	390	$output,
	391	200,
4094ea47	392	[
add597ba	393	'Content-type' => 'application/csv',
dac93644	394	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.csv"',
add597ba	395	'Content-Transfer-Encoding' => 'UTF-8',
4094ea47	396	]
f898102c	397	);
add597ba JB	398	}
add597ba JB	399
4094ea47 JB	400	/**
	401	* Dump a JSON file.
	402	*
	403	* @return Response
	404	*/
8f336fda	405	private function produceJson()
b3cc1a14	406	{
b3cc1a14	407	return Response::create(
8ac95cbf	408	$this->prepareSerializingContent('json'),
b3cc1a14	409	200,
4094ea47	410	[
b3cc1a14	411	'Content-type' => 'application/json',
dac93644	412	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.json"',
b3cc1a14	413	'Content-Transfer-Encoding' => 'UTF-8',
4094ea47	414	]
f898102c	415	);
b3cc1a14 TC	416	}
b3cc1a14 TC	417
4094ea47 JB	418	/**
	419	* Dump a XML file.
	420	*
	421	* @return Response
	422	*/
8f336fda	423	private function produceXml()
b3cc1a14	424	{
b3cc1a14	425	return Response::create(
8ac95cbf	426	$this->prepareSerializingContent('xml'),
b3cc1a14	427	200,
4094ea47	428	[
b3cc1a14	429	'Content-type' => 'application/xml',
dac93644	430	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.xml"',
b3cc1a14	431	'Content-Transfer-Encoding' => 'UTF-8',
4094ea47	432	]
f898102c	433	);
b3cc1a14	434	}
8ac95cbf	435
4094ea47 JB	436	/**
	437	* Dump a TXT file.
	438	*
	439	* @return Response
	440	*/
8f336fda	441	private function produceTxt()
6c08fb68 TC	442	{
6c08fb68 TC	443	$content = '';
d3f31ec4	444	$bar = str_repeat('=', 100);
6c08fb68	445	foreach ($this->entries as $entry) {
15a6402f	446	$content .= "\n\n" . $bar . "\n\n" . $entry->getTitle() . "\n\n" . $bar . "\n\n";
c6608783 NH	447	$html = new Html2Text($entry->getContent(), ['do_links' => 'none', 'width' => 100]);
c6608783 NH	448	$content .= $html->getText();
6c08fb68	449	}
d3f31ec4	450
6c08fb68 TC	451	return Response::create(
	452	$content,
	453	200,
4094ea47	454	[
6c08fb68	455	'Content-type' => 'text/plain',
dac93644	456	'Content-Disposition' => 'attachment; filename="' . $this->getSanitizedFilename() . '.txt"',
6c08fb68	457	'Content-Transfer-Encoding' => 'UTF-8',
4094ea47	458	]
f898102c	459	);
6c08fb68 TC	460	}
6c08fb68 TC	461
b3cc1a14 TC	462	/**
	463	* Return a Serializer object for producing processes that need it (JSON & XML).
	464	*
0e49487b JB	465	* @param string $format
0e49487b JB	466	*
52b84c11	467	* @return string
b3cc1a14	468	*/
8ac95cbf	469	private function prepareSerializingContent($format)
b3cc1a14	470	{
268e9e72	471	$serializer = SerializerBuilder::create()->build();
b3cc1a14	472
cceca9ea JB	473	return $serializer->serialize(
	474	$this->entries,
	475	$format,
4094ea47	476	SerializationContext::create()->setGroups(['entries_for_user'])
cceca9ea	477	);
b3cc1a14 TC	478	}
b3cc1a14 TC	479
add597ba JB	480	/**
	481	* Return a kind of footer / information for the epub.
	482	*
	483	* @param string $type Generator of the export, can be: tdpdf, PHPePub, PHPMobi
	484	*
	485	* @return string
	486	*/
	487	private function getExportInformation($type)
	488	{
b1428a1c NL	489	$info = $this->translator->trans('export.footer_template', [
	490	'%method%' => $type,
	491	]);
add597ba JB	492
add597ba JB	493	if ('tcpdf' === $type) {
15a6402f	494	return str_replace('%IMAGE%', '<img src="' . $this->logoPath . '" />', $info);
03690d13	495	}
add597ba JB	496
add597ba JB	497	return str_replace('%IMAGE%', '', $info);
03690d13	498	}
dac93644 KD	499
	500	/**
	501	* Return a sanitized version of the title by applying translit iconv
	502	* and removing non alphanumeric characters, - and space.
	503	*
	504	* @return string Sanitized filename
	505	*/
	506	private function getSanitizedFilename()
	507	{
	508	return preg_replace('/[^A-Za-z0-9\- \']/', '', iconv('utf-8', 'us-ascii//TRANSLIT', $this->title));
	509	}
03690d13	510	}