]>
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; |
7 | use JMS\Serializer\SerializerBuilder; | |
03690d13 TC |
8 | use PHPePub\Core\EPub; |
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 |
18 | { | |
add597ba JB |
19 | private $wallabagUrl; |
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 | * |
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 | } |
52 | ||
03690d13 TC |
53 | $this->entries = $entries; |
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 | * |
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 | |
73 | return $this; | |
03690d13 TC |
74 | } |
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 | * |
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)) { |
114 | return $this->$functionName(); | |
03690d13 | 115 | } |
add597ba JB |
116 | |
117 | throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format)); | |
03690d13 TC |
118 | } |
119 | ||
8303b037 TC |
120 | public function exportJsonData() |
121 | { | |
122 | return $this->prepareSerializingContent('json'); | |
123 | } | |
124 | ||
add597ba JB |
125 | /** |
126 | * Use PHPePub to dump a .epub file. | |
4094ea47 JB |
127 | * |
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 | ||
168 | /* | |
169 | * Front page | |
170 | */ | |
add597ba JB |
171 | if (file_exists($this->logoPath)) { |
172 | $book->setCoverImage('Cover.png', file_get_contents($this->logoPath), 'image/png'); | |
173 | } | |
03690d13 | 174 | |
bf22266a | 175 | $entryIds = []; |
edd1825b KD |
176 | $entryCount = \count($this->entries); |
177 | $i = 0; | |
bf22266a | 178 | |
03690d13 TC |
179 | /* |
180 | * Adding actual entries | |
181 | */ | |
182 | ||
add597ba JB |
183 | // set tags as subjects |
184 | foreach ($this->entries as $entry) { | |
edd1825b | 185 | ++$i; |
b0458874 JB |
186 | foreach ($entry->getTags() as $tag) { |
187 | $book->setSubject($tag->getLabel()); | |
add597ba | 188 | } |
edd1825b | 189 | $filename = sha1($entry->getTitle()); |
45d94a98 | 190 | |
4944703e KD |
191 | $publishedBy = $entry->getPublishedBy(); |
192 | if (!empty($publishedBy)) { | |
193 | $authors = implode(',', $publishedBy); | |
194 | } else { | |
195 | $authors = $this->translator->trans('export.unknown'); | |
196 | } | |
197 | ||
198 | $titlepage = $content_start . | |
199 | '<h1>' . $entry->getTitle() . '</h1>' . | |
200 | '<dl>' . | |
201 | '<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' . | |
202 | '<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' . | |
203 | '<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' . | |
204 | '<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' . | |
205 | '</dl>' . | |
206 | $bookEnd; | |
edd1825b | 207 | $book->addChapter("Entry {$i} of {$entryCount}", "{$filename}_cover.html", $titlepage, true, EPub::EXTERNAL_REF_ADD); |
15a6402f | 208 | $chapter = $content_start . $entry->getContent() . $bookEnd; |
bf22266a KD |
209 | |
210 | $entryIds[] = $entry->getId(); | |
edd1825b | 211 | $book->addChapter($entry->getTitle(), "{$filename}.html", $chapter, true, EPub::EXTERNAL_REF_ADD); |
03690d13 | 212 | } |
add597ba | 213 | |
30cf72bf KD |
214 | $book->addChapter('Notices', 'Cover2.html', $content_start . $this->getExportInformation('PHPePub') . $bookEnd); |
215 | ||
bf22266a KD |
216 | // Could also be the ISBN number, prefered for published books, or a UUID. |
217 | $hash = sha1(sprintf('%s:%s', $this->wallabagUrl, implode(',', $entryIds))); | |
218 | $book->setIdentifier(sprintf('urn:wallabag:%s', $hash), EPub::IDENTIFIER_URI); | |
219 | ||
add597ba JB |
220 | return Response::create( |
221 | $book->getBook(), | |
222 | 200, | |
4094ea47 | 223 | [ |
add597ba JB |
224 | 'Content-Description' => 'File Transfer', |
225 | 'Content-type' => 'application/epub+zip', | |
15a6402f | 226 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.epub"', |
add597ba | 227 | 'Content-Transfer-Encoding' => 'binary', |
4094ea47 | 228 | ] |
f898102c | 229 | ); |
03690d13 TC |
230 | } |
231 | ||
add597ba JB |
232 | /** |
233 | * Use PHPMobi to dump a .mobi file. | |
4094ea47 JB |
234 | * |
235 | * @return Response | |
add597ba | 236 | */ |
03690d13 TC |
237 | private function produceMobi() |
238 | { | |
239 | $mobi = new \MOBI(); | |
240 | $content = new \MOBIFile(); | |
241 | ||
242 | /* | |
243 | * Book metadata | |
244 | */ | |
03690d13 | 245 | $content->set('title', $this->title); |
07320a2b | 246 | $content->set('author', $this->author); |
03690d13 TC |
247 | $content->set('subject', $this->title); |
248 | ||
249 | /* | |
250 | * Front page | |
251 | */ | |
add597ba JB |
252 | $content->appendParagraph($this->getExportInformation('PHPMobi')); |
253 | if (file_exists($this->logoPath)) { | |
254 | $content->appendImage(imagecreatefrompng($this->logoPath)); | |
255 | } | |
03690d13 TC |
256 | $content->appendPageBreak(); |
257 | ||
258 | /* | |
259 | * Adding actual entries | |
260 | */ | |
03690d13 TC |
261 | foreach ($this->entries as $entry) { |
262 | $content->appendChapterTitle($entry->getTitle()); | |
263 | $content->appendParagraph($entry->getContent()); | |
264 | $content->appendPageBreak(); | |
265 | } | |
266 | $mobi->setContentProvider($content); | |
267 | ||
268 | // the browser inside Kindle Devices doesn't likes special caracters either, we limit to A-z/0-9 | |
269 | $this->title = preg_replace('/[^A-Za-z0-9\-]/', '', $this->title); | |
270 | ||
add597ba JB |
271 | return Response::create( |
272 | $mobi->toString(), | |
273 | 200, | |
4094ea47 | 274 | [ |
add597ba JB |
275 | 'Accept-Ranges' => 'bytes', |
276 | 'Content-Description' => 'File Transfer', | |
277 | 'Content-type' => 'application/x-mobipocket-ebook', | |
15a6402f | 278 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.mobi"', |
add597ba | 279 | 'Content-Transfer-Encoding' => 'binary', |
4094ea47 | 280 | ] |
f898102c | 281 | ); |
03690d13 TC |
282 | } |
283 | ||
add597ba JB |
284 | /** |
285 | * Use TCPDF to dump a .pdf file. | |
4094ea47 JB |
286 | * |
287 | * @return Response | |
add597ba | 288 | */ |
8f336fda | 289 | private function producePdf() |
03690d13 TC |
290 | { |
291 | $pdf = new \TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false); | |
292 | ||
293 | /* | |
294 | * Book metadata | |
295 | */ | |
03690d13 | 296 | $pdf->SetCreator(PDF_CREATOR); |
07320a2b | 297 | $pdf->SetAuthor($this->author); |
03690d13 TC |
298 | $pdf->SetTitle($this->title); |
299 | $pdf->SetSubject('Articles via wallabag'); | |
300 | $pdf->SetKeywords('wallabag'); | |
301 | ||
03690d13 TC |
302 | /* |
303 | * Adding actual entries | |
304 | */ | |
03690d13 | 305 | foreach ($this->entries as $entry) { |
b0458874 JB |
306 | foreach ($entry->getTags() as $tag) { |
307 | $pdf->SetKeywords($tag->getLabel()); | |
03690d13 TC |
308 | } |
309 | ||
ad5ef8bc KD |
310 | $publishedBy = $entry->getPublishedBy(); |
311 | if (!empty($publishedBy)) { | |
312 | $authors = implode(',', $publishedBy); | |
313 | } else { | |
314 | $authors = $this->translator->trans('export.unknown'); | |
315 | } | |
316 | ||
317 | $pdf->addPage(); | |
318 | $html = '<h1>' . $entry->getTitle() . '</h1>' . | |
319 | '<dl>' . | |
320 | '<dt>' . $this->translator->trans('entry.view.published_by') . '</dt><dd>' . $authors . '</dd>' . | |
321 | '<dt>' . $this->translator->trans('entry.metadata.reading_time') . '</dt><dd>' . $this->translator->trans('entry.metadata.reading_time_minutes_short', ['%readingTime%' => $entry->getReadingTime()]) . '</dd>' . | |
322 | '<dt>' . $this->translator->trans('entry.metadata.added_on') . '</dt><dd>' . $entry->getCreatedAt()->format('Y-m-d') . '</dd>' . | |
323 | '<dt>' . $this->translator->trans('entry.metadata.address') . '</dt><dd><a href="' . $entry->getUrl() . '">' . $entry->getUrl() . '</a></dd>' . | |
324 | '</dl>'; | |
325 | $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true); | |
326 | ||
03690d13 | 327 | $pdf->AddPage(); |
15a6402f | 328 | $html = '<h1>' . $entry->getTitle() . '</h1>'; |
03690d13 | 329 | $html .= $entry->getContent(); |
add597ba | 330 | |
03690d13 TC |
331 | $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true); |
332 | } | |
333 | ||
ad5ef8bc KD |
334 | /* |
335 | * Last page | |
336 | */ | |
337 | $pdf->AddPage(); | |
338 | $html = $this->getExportInformation('tcpdf'); | |
339 | ||
340 | $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true); | |
341 | ||
03690d13 TC |
342 | // set image scale factor |
343 | $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO); | |
344 | ||
add597ba JB |
345 | return Response::create( |
346 | $pdf->Output('', 'S'), | |
347 | 200, | |
4094ea47 | 348 | [ |
add597ba JB |
349 | 'Content-Description' => 'File Transfer', |
350 | 'Content-type' => 'application/pdf', | |
15a6402f | 351 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.pdf"', |
add597ba | 352 | 'Content-Transfer-Encoding' => 'binary', |
4094ea47 | 353 | ] |
f898102c | 354 | ); |
03690d13 TC |
355 | } |
356 | ||
add597ba JB |
357 | /** |
358 | * Inspired from CsvFileDumper. | |
4094ea47 JB |
359 | * |
360 | * @return Response | |
add597ba | 361 | */ |
8f336fda | 362 | private function produceCsv() |
03690d13 | 363 | { |
add597ba JB |
364 | $delimiter = ';'; |
365 | $enclosure = '"'; | |
2a1ceb67 | 366 | $handle = fopen('php://memory', 'b+r'); |
03690d13 | 367 | |
9401696f | 368 | fputcsv($handle, ['Title', 'URL', 'Content', 'Tags', 'MIME Type', 'Language', 'Creation date'], $delimiter, $enclosure); |
03690d13 | 369 | |
03690d13 | 370 | foreach ($this->entries as $entry) { |
add597ba JB |
371 | fputcsv( |
372 | $handle, | |
4094ea47 | 373 | [ |
add597ba JB |
374 | $entry->getTitle(), |
375 | $entry->getURL(), | |
cceca9ea | 376 | // remove new line to avoid crazy results |
4094ea47 | 377 | str_replace(["\r\n", "\r", "\n"], '', $entry->getContent()), |
add597ba JB |
378 | implode(', ', $entry->getTags()->toArray()), |
379 | $entry->getMimetype(), | |
380 | $entry->getLanguage(), | |
9401696f | 381 | $entry->getCreatedAt()->format('d/m/Y h:i:s'), |
4094ea47 | 382 | ], |
add597ba JB |
383 | $delimiter, |
384 | $enclosure | |
385 | ); | |
386 | } | |
387 | ||
388 | rewind($handle); | |
389 | $output = stream_get_contents($handle); | |
390 | fclose($handle); | |
391 | ||
392 | return Response::create( | |
393 | $output, | |
394 | 200, | |
4094ea47 | 395 | [ |
add597ba | 396 | 'Content-type' => 'application/csv', |
15a6402f | 397 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.csv"', |
add597ba | 398 | 'Content-Transfer-Encoding' => 'UTF-8', |
4094ea47 | 399 | ] |
f898102c | 400 | ); |
add597ba JB |
401 | } |
402 | ||
4094ea47 JB |
403 | /** |
404 | * Dump a JSON file. | |
405 | * | |
406 | * @return Response | |
407 | */ | |
8f336fda | 408 | private function produceJson() |
b3cc1a14 | 409 | { |
b3cc1a14 | 410 | return Response::create( |
8ac95cbf | 411 | $this->prepareSerializingContent('json'), |
b3cc1a14 | 412 | 200, |
4094ea47 | 413 | [ |
b3cc1a14 | 414 | 'Content-type' => 'application/json', |
15a6402f | 415 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.json"', |
b3cc1a14 | 416 | 'Content-Transfer-Encoding' => 'UTF-8', |
4094ea47 | 417 | ] |
f898102c | 418 | ); |
b3cc1a14 TC |
419 | } |
420 | ||
4094ea47 JB |
421 | /** |
422 | * Dump a XML file. | |
423 | * | |
424 | * @return Response | |
425 | */ | |
8f336fda | 426 | private function produceXml() |
b3cc1a14 | 427 | { |
b3cc1a14 | 428 | return Response::create( |
8ac95cbf | 429 | $this->prepareSerializingContent('xml'), |
b3cc1a14 | 430 | 200, |
4094ea47 | 431 | [ |
b3cc1a14 | 432 | 'Content-type' => 'application/xml', |
15a6402f | 433 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.xml"', |
b3cc1a14 | 434 | 'Content-Transfer-Encoding' => 'UTF-8', |
4094ea47 | 435 | ] |
f898102c | 436 | ); |
b3cc1a14 | 437 | } |
8ac95cbf | 438 | |
4094ea47 JB |
439 | /** |
440 | * Dump a TXT file. | |
441 | * | |
442 | * @return Response | |
443 | */ | |
8f336fda | 444 | private function produceTxt() |
6c08fb68 TC |
445 | { |
446 | $content = ''; | |
d3f31ec4 | 447 | $bar = str_repeat('=', 100); |
6c08fb68 | 448 | foreach ($this->entries as $entry) { |
15a6402f | 449 | $content .= "\n\n" . $bar . "\n\n" . $entry->getTitle() . "\n\n" . $bar . "\n\n"; |
c6608783 NH |
450 | $html = new Html2Text($entry->getContent(), ['do_links' => 'none', 'width' => 100]); |
451 | $content .= $html->getText(); | |
6c08fb68 | 452 | } |
d3f31ec4 | 453 | |
6c08fb68 TC |
454 | return Response::create( |
455 | $content, | |
456 | 200, | |
4094ea47 | 457 | [ |
6c08fb68 | 458 | 'Content-type' => 'text/plain', |
15a6402f | 459 | 'Content-Disposition' => 'attachment; filename="' . $this->title . '.txt"', |
6c08fb68 | 460 | 'Content-Transfer-Encoding' => 'UTF-8', |
4094ea47 | 461 | ] |
f898102c | 462 | ); |
6c08fb68 TC |
463 | } |
464 | ||
b3cc1a14 TC |
465 | /** |
466 | * Return a Serializer object for producing processes that need it (JSON & XML). | |
467 | * | |
0e49487b JB |
468 | * @param string $format |
469 | * | |
52b84c11 | 470 | * @return string |
b3cc1a14 | 471 | */ |
8ac95cbf | 472 | private function prepareSerializingContent($format) |
b3cc1a14 | 473 | { |
268e9e72 | 474 | $serializer = SerializerBuilder::create()->build(); |
b3cc1a14 | 475 | |
cceca9ea JB |
476 | return $serializer->serialize( |
477 | $this->entries, | |
478 | $format, | |
4094ea47 | 479 | SerializationContext::create()->setGroups(['entries_for_user']) |
cceca9ea | 480 | ); |
b3cc1a14 TC |
481 | } |
482 | ||
add597ba JB |
483 | /** |
484 | * Return a kind of footer / information for the epub. | |
485 | * | |
486 | * @param string $type Generator of the export, can be: tdpdf, PHPePub, PHPMobi | |
487 | * | |
488 | * @return string | |
489 | */ | |
490 | private function getExportInformation($type) | |
491 | { | |
b1428a1c NL |
492 | $info = $this->translator->trans('export.footer_template', [ |
493 | '%method%' => $type, | |
494 | ]); | |
add597ba JB |
495 | |
496 | if ('tcpdf' === $type) { | |
15a6402f | 497 | return str_replace('%IMAGE%', '<img src="' . $this->logoPath . '" />', $info); |
03690d13 | 498 | } |
add597ba JB |
499 | |
500 | return str_replace('%IMAGE%', '', $info); | |
03690d13 TC |
501 | } |
502 | } |