]> git.immae.eu Git - github/wallabag/wallabag.git/blame - src/Wallabag/CoreBundle/Helper/EntriesExport.php
put the equals bar outside the loop
[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Helper / EntriesExport.php
CommitLineData
03690d13
TC
1<?php
2
3namespace Wallabag\CoreBundle\Helper;
4
619cc453
JB
5use JMS\Serializer;
6use JMS\Serializer\SerializationContext;
7use JMS\Serializer\SerializerBuilder;
03690d13
TC
8use PHPePub\Core\EPub;
9use PHPePub\Core\Structure\OPF\DublinCore;
add597ba 10use Symfony\Component\HttpFoundation\Response;
63e40f2d 11use Craue\ConfigBundle\Util\Config;
03690d13 12
cceca9ea
JB
13/**
14 * This class doesn't have unit test BUT it's fully covered by a functional test with ExportControllerTest.
15 */
03690d13
TC
16class EntriesExport
17{
add597ba
JB
18 private $wallabagUrl;
19 private $logoPath;
20 private $title = '';
21 private $entries = array();
03690d13 22 private $authors = array('wallabag');
add597ba
JB
23 private $language = '';
24 private $tags = array();
25 private $footerTemplate = '<div style="text-align:center;">
26 <p>Produced by wallabag with %EXPORT_METHOD%</p>
27 <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>
28 </div';
03690d13 29
add597ba 30 /**
63e40f2d 31 * @param Config $craueConfig CraueConfig instance to get wallabag instance url from database
add597ba
JB
32 * @param string $logoPath Path to the logo FROM THE BUNDLE SCOPE
33 */
63e40f2d 34 public function __construct(Config $craueConfig, $logoPath)
03690d13 35 {
63e40f2d 36 $this->wallabagUrl = $craueConfig->get('wallabag_url');
add597ba
JB
37 $this->logoPath = $logoPath;
38 }
39
40 /**
41 * Define entries.
42 *
43 * @param array|Entry $entries An array of entries or one entry
44 */
45 public function setEntries($entries)
46 {
47 if (!is_array($entries)) {
48 $this->language = $entries->getLanguage();
49 $entries = array($entries);
50 }
51
03690d13
TC
52 $this->entries = $entries;
53
54 foreach ($entries as $entry) {
55 $this->tags[] = $entry->getTags();
56 }
add597ba
JB
57
58 return $this;
03690d13
TC
59 }
60
61 /**
62 * Sets the category of which we want to get articles, or just one entry.
63 *
64 * @param string $method Method to get articles
65 */
add597ba 66 public function updateTitle($method)
03690d13 67 {
add597ba
JB
68 $this->title = $method.' articles';
69
70 if ('entry' === $method) {
71 $this->title = $this->entries[0]->getTitle();
03690d13 72 }
add597ba
JB
73
74 return $this;
03690d13
TC
75 }
76
77 /**
78 * Sets the output format.
79 *
80 * @param string $format
81 */
82 public function exportAs($format)
83 {
add597ba 84 switch ($format) {
03690d13 85 case 'epub':
add597ba 86 return $this->produceEpub();
03690d13
TC
87
88 case 'mobi':
add597ba 89 return $this->produceMobi();
03690d13
TC
90
91 case 'pdf':
add597ba 92 return $this->producePDF();
03690d13
TC
93
94 case 'csv':
add597ba 95 return $this->produceCSV();
b3cc1a14
TC
96
97 case 'json':
98 return $this->produceJSON();
99
100 case 'xml':
101 return $this->produceXML();
6c08fb68
TC
102 case 'txt':
103 return $this->produceTXT();
03690d13 104 }
add597ba
JB
105
106 throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
03690d13
TC
107 }
108
add597ba
JB
109 /**
110 * Use PHPePub to dump a .epub file.
111 */
03690d13
TC
112 private function produceEpub()
113 {
114 /*
115 * Start and End of the book
116 */
117 $content_start =
118 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
119 ."<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
120 .'<head>'
121 ."<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
add597ba 122 ."<title>wallabag articles book</title>\n"
03690d13
TC
123 ."</head>\n"
124 ."<body>\n";
125
126 $bookEnd = "</body>\n</html>\n";
127
128 $book = new EPub(EPub::BOOK_VERSION_EPUB3);
129
130 /*
131 * Book metadata
132 */
133
134 $book->setTitle($this->title);
add597ba
JB
135 // Could also be the ISBN number, prefered for published books, or a UUID.
136 $book->setIdentifier($this->title, EPub::IDENTIFIER_URI);
137 // 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.
138 $book->setLanguage($this->language);
139 $book->setDescription('Some articles saved on my wallabag');
03690d13
TC
140
141 foreach ($this->authors as $author) {
142 $book->setAuthor($author, $author);
143 }
144
add597ba
JB
145 // I hope this is a non existant address :)
146 $book->setPublisher('wallabag', 'wallabag');
147 // Strictly not needed as the book date defaults to time().
148 $book->setDate(time());
149 $book->setSourceURL($this->wallabagUrl);
03690d13
TC
150
151 $book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'PHP');
152 $book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, 'wallabag');
153
154 /*
155 * Front page
156 */
add597ba
JB
157 if (file_exists($this->logoPath)) {
158 $book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png');
159 }
03690d13 160
add597ba 161 $book->addChapter('Notices', 'Cover2.html', $content_start.$this->getExportInformation('PHPePub').$bookEnd);
03690d13
TC
162
163 $book->buildTOC();
164
165 /*
166 * Adding actual entries
167 */
168
add597ba
JB
169 // set tags as subjects
170 foreach ($this->entries as $entry) {
171 foreach ($this->tags as $tag) {
172 $book->setSubject($tag['value']);
173 }
03690d13
TC
174
175 $chapter = $content_start.$entry->getContent().$bookEnd;
176 $book->addChapter($entry->getTitle(), htmlspecialchars($entry->getTitle()).'.html', $chapter, true, EPub::EXTERNAL_REF_ADD);
177 }
add597ba
JB
178
179 return Response::create(
180 $book->getBook(),
181 200,
182 array(
183 'Content-Description' => 'File Transfer',
184 'Content-type' => 'application/epub+zip',
185 'Content-Disposition' => 'attachment; filename="'.$this->title.'.epub"',
186 'Content-Transfer-Encoding' => 'binary',
187 )
188 )->send();
03690d13
TC
189 }
190
add597ba
JB
191 /**
192 * Use PHPMobi to dump a .mobi file.
193 */
03690d13
TC
194 private function produceMobi()
195 {
196 $mobi = new \MOBI();
197 $content = new \MOBIFile();
198
199 /*
200 * Book metadata
201 */
03690d13
TC
202 $content->set('title', $this->title);
203 $content->set('author', implode($this->authors));
204 $content->set('subject', $this->title);
205
206 /*
207 * Front page
208 */
add597ba
JB
209 $content->appendParagraph($this->getExportInformation('PHPMobi'));
210 if (file_exists($this->logoPath)) {
211 $content->appendImage(imagecreatefrompng($this->logoPath));
212 }
03690d13
TC
213 $content->appendPageBreak();
214
215 /*
216 * Adding actual entries
217 */
03690d13
TC
218 foreach ($this->entries as $entry) {
219 $content->appendChapterTitle($entry->getTitle());
220 $content->appendParagraph($entry->getContent());
221 $content->appendPageBreak();
222 }
223 $mobi->setContentProvider($content);
224
225 // the browser inside Kindle Devices doesn't likes special caracters either, we limit to A-z/0-9
226 $this->title = preg_replace('/[^A-Za-z0-9\-]/', '', $this->title);
227
add597ba
JB
228 return Response::create(
229 $mobi->toString(),
230 200,
231 array(
232 'Accept-Ranges' => 'bytes',
233 'Content-Description' => 'File Transfer',
234 'Content-type' => 'application/x-mobipocket-ebook',
235 'Content-Disposition' => 'attachment; filename="'.$this->title.'.mobi"',
236 'Content-Transfer-Encoding' => 'binary',
237 )
238 )->send();
03690d13
TC
239 }
240
add597ba
JB
241 /**
242 * Use TCPDF to dump a .pdf file.
243 */
03690d13
TC
244 private function producePDF()
245 {
246 $pdf = new \TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
247
248 /*
249 * Book metadata
250 */
03690d13
TC
251 $pdf->SetCreator(PDF_CREATOR);
252 $pdf->SetAuthor('wallabag');
253 $pdf->SetTitle($this->title);
254 $pdf->SetSubject('Articles via wallabag');
255 $pdf->SetKeywords('wallabag');
256
257 /*
258 * Front page
259 */
03690d13 260 $pdf->AddPage();
add597ba 261 $intro = '<h1>'.$this->title.'</h1>'.$this->getExportInformation('tcpdf');
03690d13
TC
262
263 $pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
264
265 /*
266 * Adding actual entries
267 */
03690d13
TC
268 foreach ($this->entries as $entry) {
269 foreach ($this->tags as $tag) {
270 $pdf->SetKeywords($tag['value']);
271 }
272
273 $pdf->AddPage();
274 $html = '<h1>'.$entry->getTitle().'</h1>';
275 $html .= $entry->getContent();
add597ba 276
03690d13
TC
277 $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
278 }
279
280 // set image scale factor
281 $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
282
add597ba
JB
283 return Response::create(
284 $pdf->Output('', 'S'),
285 200,
286 array(
287 'Content-Description' => 'File Transfer',
288 'Content-type' => 'application/pdf',
289 'Content-Disposition' => 'attachment; filename="'.$this->title.'.pdf"',
290 'Content-Transfer-Encoding' => 'binary',
291 )
292 )->send();
03690d13
TC
293 }
294
add597ba
JB
295 /**
296 * Inspired from CsvFileDumper.
297 */
03690d13
TC
298 private function produceCSV()
299 {
add597ba
JB
300 $delimiter = ';';
301 $enclosure = '"';
302 $handle = fopen('php://memory', 'rb+');
03690d13 303
add597ba 304 fputcsv($handle, array('Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language'), $delimiter, $enclosure);
03690d13 305
03690d13 306 foreach ($this->entries as $entry) {
add597ba
JB
307 fputcsv(
308 $handle,
309 array(
310 $entry->getTitle(),
311 $entry->getURL(),
cceca9ea
JB
312 // remove new line to avoid crazy results
313 str_replace(array("\r\n", "\r", "\n"), '', $entry->getContent()),
add597ba
JB
314 implode(', ', $entry->getTags()->toArray()),
315 $entry->getMimetype(),
316 $entry->getLanguage(),
317 ),
318 $delimiter,
319 $enclosure
320 );
321 }
322
323 rewind($handle);
324 $output = stream_get_contents($handle);
325 fclose($handle);
326
327 return Response::create(
328 $output,
329 200,
330 array(
331 'Content-type' => 'application/csv',
332 'Content-Disposition' => 'attachment; filename="'.$this->title.'.csv"',
333 'Content-Transfer-Encoding' => 'UTF-8',
334 )
335 )->send();
336 }
337
b3cc1a14
TC
338 private function produceJSON()
339 {
b3cc1a14 340 return Response::create(
8ac95cbf 341 $this->prepareSerializingContent('json'),
b3cc1a14
TC
342 200,
343 array(
344 'Content-type' => 'application/json',
345 'Content-Disposition' => 'attachment; filename="'.$this->title.'.json"',
346 'Content-Transfer-Encoding' => 'UTF-8',
347 )
348 )->send();
349 }
350
351 private function produceXML()
352 {
b3cc1a14 353 return Response::create(
8ac95cbf 354 $this->prepareSerializingContent('xml'),
b3cc1a14
TC
355 200,
356 array(
357 'Content-type' => 'application/xml',
358 'Content-Disposition' => 'attachment; filename="'.$this->title.'.xml"',
359 'Content-Transfer-Encoding' => 'UTF-8',
360 )
361 )->send();
362 }
8ac95cbf 363
6c08fb68
TC
364 private function produceTXT()
365 {
366 $content = '';
f1611224 367 $bar = str_repeat("=",100);
6c08fb68 368 foreach ($this->entries as $entry) {
f1611224 369 $content .= "\n\n" . $bar . "\n\n" . $entry->getTitle() . "\n\n" . $bar . "\n\n";
365a3898 370 $content .= trim(preg_replace('/\s+/S', ' ', strip_tags($entry->getContent()))) . "\n\n";
6c08fb68
TC
371 }
372 return Response::create(
373 $content,
374 200,
375 array(
376 'Content-type' => 'text/plain',
377 'Content-Disposition' => 'attachment; filename="'.$this->title.'.txt"',
378 'Content-Transfer-Encoding' => 'UTF-8',
379 )
380 )->send();
381 }
382
383
b3cc1a14
TC
384 /**
385 * Return a Serializer object for producing processes that need it (JSON & XML).
386 *
387 * @return Serializer
388 */
8ac95cbf 389 private function prepareSerializingContent($format)
b3cc1a14 390 {
268e9e72 391 $serializer = SerializerBuilder::create()->build();
b3cc1a14 392
cceca9ea
JB
393 return $serializer->serialize(
394 $this->entries,
395 $format,
396 SerializationContext::create()->setGroups(array('entries_for_user'))
397 );
b3cc1a14
TC
398 }
399
add597ba
JB
400 /**
401 * Return a kind of footer / information for the epub.
402 *
403 * @param string $type Generator of the export, can be: tdpdf, PHPePub, PHPMobi
404 *
405 * @return string
406 */
407 private function getExportInformation($type)
408 {
409 $info = str_replace('%EXPORT_METHOD%', $type, $this->footerTemplate);
410
411 if ('tcpdf' === $type) {
412 return str_replace('%IMAGE%', '<img src="'.$this->logoPath.'" />', $info);
03690d13 413 }
add597ba
JB
414
415 return str_replace('%IMAGE%', '', $info);
03690d13
TC
416 }
417}