X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2FWallabag%2FCoreBundle%2FHelper%2FEntriesExport.php;h=3d36a4c89e40c91c3ae635c5c8aad1d5641ea835;hb=3e7a843aa998442148061347e7978722b8cd87d2;hp=965a40b6a1ec190bb06c4f0bb0956fcd0f709ada;hpb=27c837dcd1640a7f5f0ed197e882eefd53ba8273;p=github%2Fwallabag%2Fwallabag.git diff --git a/src/Wallabag/CoreBundle/Helper/EntriesExport.php b/src/Wallabag/CoreBundle/Helper/EntriesExport.php index 965a40b6..3d36a4c8 100644 --- a/src/Wallabag/CoreBundle/Helper/EntriesExport.php +++ b/src/Wallabag/CoreBundle/Helper/EntriesExport.php @@ -8,7 +8,6 @@ use JMS\Serializer\SerializerBuilder; use PHPePub\Core\EPub; use PHPePub\Core\Structure\OPF\DublinCore; use Symfony\Component\HttpFoundation\Response; -use Craue\ConfigBundle\Util\Config; /** * This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest. @@ -18,22 +17,21 @@ class EntriesExport private $wallabagUrl; private $logoPath; private $title = ''; - private $entries = array(); - private $authors = array('wallabag'); + private $entries = []; + private $authors = ['wallabag']; private $language = ''; - private $tags = array(); 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 Config $craueConfig CraueConfig instance to get wallabag instance url from database + * @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($wallabagUrl, $logoPath) { - $this->wallabagUrl = $craueConfig->get('wallabag_url'); + $this->wallabagUrl = $wallabagUrl; $this->logoPath = $logoPath; } @@ -41,20 +39,18 @@ class EntriesExport * 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 = array($entries); + $entries = [$entries]; } $this->entries = $entries; - foreach ($entries as $entry) { - $this->tags[] = $entry->getTags(); - } - return $this; } @@ -62,6 +58,8 @@ class EntriesExport * 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) { @@ -78,34 +76,28 @@ class EntriesExport * Sets the output format. * * @param string $format + * + * @return Response */ public function exportAs($format) { - switch ($format) { - case 'epub': - return $this->produceEpub(); - - case 'mobi': - return $this->produceMobi(); - - case 'pdf': - return $this->producePDF(); - - case 'csv': - return $this->produceCSV(); - - case 'json': - return $this->produceJSON(); - - case 'xml': - return $this->produceXML(); + $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() { @@ -156,8 +148,6 @@ class EntriesExport $book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png'); } - $book->addChapter('Notices', 'Cover2.html', $content_start.$this->getExportInformation('PHPePub').$bookEnd); - $book->buildTOC(); /* @@ -166,28 +156,36 @@ class EntriesExport // set tags as subjects foreach ($this->entries as $entry) { - foreach ($this->tags as $tag) { - $book->setSubject($tag['value']); + 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); + $book->addChapter($entry->getTitle(), htmlspecialchars($filename).'.html', $chapter, true, EPub::EXTERNAL_REF_ADD); } + $book->addChapter('Notices', 'Cover2.html', $content_start.$this->getExportInformation('PHPePub').$bookEnd); + return Response::create( $book->getBook(), 200, - array( + [ 'Content-Description' => 'File Transfer', 'Content-type' => 'application/epub+zip', 'Content-Disposition' => 'attachment; filename="'.$this->title.'.epub"', 'Content-Transfer-Encoding' => 'binary', - ) - )->send(); + ] + ); } /** * Use PHPMobi to dump a .mobi file. + * + * @return Response */ private function produceMobi() { @@ -226,20 +224,22 @@ class EntriesExport 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-Transfer-Encoding' => 'binary', - ) - )->send(); + ] + ); } /** * Use TCPDF to dump a .pdf file. + * + * @return Response */ - private function producePDF() + private function producePdf() { $pdf = new \TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false); @@ -264,8 +264,8 @@ class EntriesExport * 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(); @@ -281,38 +281,41 @@ class EntriesExport return Response::create( $pdf->Output('', 'S'), 200, - array( + [ 'Content-Description' => 'File Transfer', 'Content-type' => 'application/pdf', 'Content-Disposition' => 'attachment; filename="'.$this->title.'.pdf"', 'Content-Transfer-Encoding' => 'binary', - ) - )->send(); + ] + ); } /** * Inspired from CsvFileDumper. + * + * @return Response */ - private function produceCSV() + private function produceCsv() { $delimiter = ';'; $enclosure = '"'; $handle = fopen('php://memory', 'rb+'); - 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 ); @@ -325,43 +328,80 @@ class EntriesExport return Response::create( $output, 200, - array( + [ 'Content-type' => 'application/csv', 'Content-Disposition' => 'attachment; filename="'.$this->title.'.csv"', 'Content-Transfer-Encoding' => 'UTF-8', - ) - )->send(); + ] + ); } - private function produceJSON() + /** + * 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-Transfer-Encoding' => 'UTF-8', - ) - )->send(); + ] + ); } - private function produceXML() + /** + * 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-Transfer-Encoding' => 'UTF-8', - ) - )->send(); + ] + ); + } + + /** + * 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) @@ -371,7 +411,7 @@ class EntriesExport return $serializer->serialize( $this->entries, $format, - SerializationContext::create()->setGroups(array('entries_for_user')) + SerializationContext::create()->setGroups(['entries_for_user']) ); }