X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2FWallabag%2FCoreBundle%2FHelper%2FEntriesExport.php;h=cd74cc4f866a8e6e2b2a3d7e5b7fa63fe52008d0;hb=71e1cbc8eb5928d393b0772055d6b711e90a09b3;hp=e073606cf9dfe155df5f9d176f4f3f243efc6896;hpb=8ac95cbfcc2fa3e115bef369be216f7aa30f7311;p=github%2Fwallabag%2Fwallabag.git
diff --git a/src/Wallabag/CoreBundle/Helper/EntriesExport.php b/src/Wallabag/CoreBundle/Helper/EntriesExport.php
index e073606c..cd74cc4f 100644
--- a/src/Wallabag/CoreBundle/Helper/EntriesExport.php
+++ b/src/Wallabag/CoreBundle/Helper/EntriesExport.php
@@ -2,27 +2,28 @@
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;
-use Symfony\Component\Serializer\Serializer;
-use Symfony\Component\Serializer\Encoder\XmlEncoder;
-use Symfony\Component\Serializer\Encoder\JsonEncoder;
-use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+/**
+ * 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 $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 string $wallabagUrl Wallabag instance url
@@ -38,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;
}
@@ -59,10 +58,12 @@ 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)
{
- $this->title = $method.' articles';
+ $this->title = $method . ' articles';
if ('entry' === $method) {
$this->title = $this->entries[0]->getTitle();
@@ -75,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()
{
@@ -111,12 +106,12 @@ class EntriesExport
*/
$content_start =
"\n"
- ."\n"
- .''
- ."\n"
- ."wallabag articles book\n"
- ."\n"
- ."\n";
+ . "\n"
+ . ''
+ . "\n"
+ . "wallabag articles book\n"
+ . "\n"
+ . "\n";
$bookEnd = "\n\n";
@@ -153,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();
/*
@@ -163,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());
}
- $chapter = $content_start.$entry->getContent().$bookEnd;
- $book->addChapter($entry->getTitle(), htmlspecialchars($entry->getTitle()).'.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
+ // 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($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-Disposition' => 'attachment; filename="' . $this->title . '.epub"',
'Content-Transfer-Encoding' => 'binary',
- )
- )->send();
+ ]
+ );
}
/**
* Use PHPMobi to dump a .mobi file.
+ *
+ * @return Response
*/
private function produceMobi()
{
@@ -223,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-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);
@@ -253,7 +256,7 @@ class EntriesExport
* Front page
*/
$pdf->AddPage();
- $intro = ''.$this->title.'
'.$this->getExportInformation('tcpdf');
+ $intro = '' . $this->title . '
' . $this->getExportInformation('tcpdf');
$pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
@@ -261,12 +264,12 @@ 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();
- $html = ''.$entry->getTitle().'
';
+ $html = '' . $entry->getTitle() . '
';
$html .= $entry->getContent();
$pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
@@ -278,37 +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-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(),
- $entry->getContent(),
+ // 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
);
@@ -321,53 +328,91 @@ class EntriesExport
return Response::create(
$output,
200,
- array(
+ [
'Content-type' => 'application/csv',
- 'Content-Disposition' => 'attachment; filename="'.$this->title.'.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-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-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',
- )
- )->send();
+ ]
+ );
}
/**
* Return a Serializer object for producing processes that need it (JSON & XML).
*
+ * @param string $format
+ *
* @return Serializer
*/
private function prepareSerializingContent($format)
{
- $encoders = array(new XmlEncoder(), new JsonEncoder());
- $normalizers = array(new ObjectNormalizer());
- $normalizers[0]->setIgnoredAttributes(array('user', 'createdAt', 'updatedAt'));
- $serializer = new Serializer($normalizers, $encoders);
+ $serializer = SerializerBuilder::create()->build();
- return $serializer->serialize($this->entries, $format);
+ return $serializer->serialize(
+ $this->entries,
+ $format,
+ SerializationContext::create()->setGroups(['entries_for_user'])
+ );
}
/**
@@ -382,7 +427,7 @@ class EntriesExport
$info = str_replace('%EXPORT_METHOD%', $type, $this->footerTemplate);
if ('tcpdf' === $type) {
- return str_replace('%IMAGE%', '', $info);
+ return str_replace('%IMAGE%', '', $info);
}
return str_replace('%IMAGE%', '', $info);