3 * wallabag, self hostable application allowing you to not miss any content anymore
6 * @author Nicolas LÅ“uillet <nicolas@loeuillet.org>
8 * @license http://opensource.org/licenses/MIT see COPYING file
18 protected $bookFileName;
19 protected $author = 'wallabag';
21 public function __construct(Poche
$wallabag, $method, $value)
23 $this->wallabag
= $wallabag;
24 $this->method
= $method;
25 $this->value
= $value;
28 public function prepareData()
30 switch ($this->method
) {
32 $entryID = filter_var($this->value
, FILTER_SANITIZE_NUMBER_INT
);
33 $entry = $this->wallabag
->store
->retrieveOneById($entryID, $this->wallabag
->user
->getId());
34 $this->entries
= array($entry);
35 $this->bookTitle
= $entry['title'];
36 $this->bookFileName
= str_replace('/', '_', substr($this->bookTitle
, 0, 200));
37 $this->author
= preg_replace('#^w{3}.#', '', Tools
::getdomain($entry["url"])); # if only one article, set author to domain name (we strip the eventual www part)
38 Tools
::logm('Producing ebook from article ' . $this->bookTitle
);
41 $this->entries
= $this->wallabag
->store
->retrieveAll($this->wallabag
->user
->getId());
42 $this->bookTitle
= sprintf(_('All my articles on %s'), date(_('d.m.y'))); #translatable because each country has it's own date format system
43 $this->bookFileName
= _('Allarticles') . date(_('dmY'));
44 Tools
::logm('Producing ebook from all articles');
47 $tag = filter_var($this->value
, FILTER_SANITIZE_STRING
);
48 $tags_id = $this->wallabag
->store
->retrieveAllTags($this->wallabag
->user
->getId(), $tag);
49 $tag_id = $tags_id[0]["id"]; // we take the first result, which is supposed to match perfectly. There must be a workaround.
50 $this->entries
= $this->wallabag
->store
->retrieveEntriesByTag($tag_id, $this->wallabag
->user
->getId());
51 $this->bookTitle
= sprintf(_('Articles tagged %s'), $tag);
52 $this->bookFileName
= substr(sprintf(_('Tag %s'), $tag), 0, 200);
53 Tools
::logm('Producing ebook from tag ' . $tag);
56 $category = filter_var($this->value
, FILTER_SANITIZE_STRING
);
57 $this->entries
= $this->wallabag
->store
->getEntriesByView($category, $this->wallabag
->user
->getId());
58 $this->bookTitle
= sprintf(_('Articles in category %s'), $category);
59 $this->bookFileName
= substr(sprintf(_('Category %s'), $category), 0, 200);
60 Tools
::logm('Producing ebook from category ' . $category);
63 $search = filter_var($this->value
, FILTER_SANITIZE_STRING
);
65 $this->entries
= $this->wallabag
->store
->search($search, $this->wallabag
->user
->getId());
66 $this->bookTitle
= sprintf(_('Articles for search %s'), $search);
67 $this->bookFileName
= substr(sprintf(_('Search %s'), $search), 0, 200);
68 Tools
::logm('Producing ebook from search ' . $search);
71 die(_('Uh, there is a problem while generating eBook.'));
76 class WallabagEpub
extends WallabagEBooks
81 public function produceEpub()
83 Tools
::logm('Starting to produce ePub 3 file');
88 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
89 . "<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
91 . "<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
92 . "<title>" . _("wallabag articles book") . "</title>\n"
96 $bookEnd = "</body>\n</html>\n";
98 $log = new Logger("wallabag", TRUE);
101 $book = new EPub(EPub
::BOOK_VERSION_EPUB3
, DEBUG_POCHE
);
102 $log->logLine("new EPub()");
103 $log->logLine("EPub class version: " . EPub
::VERSION
);
104 $log->logLine("EPub Req. Zip version: " . EPub
::REQ_ZIP_VERSION
);
105 $log->logLine("Zip version: " . Zip
::VERSION
);
106 $log->logLine("getCurrentServerURL: " . $book->getCurrentServerURL());
107 $log->logLine("getCurrentPageURL..: " . $book->getCurrentPageURL());
109 Tools
::logm('Filling metadata for ePub...');
111 $book->setTitle($this->bookTitle
);
112 $book->setIdentifier("http://$_SERVER[HTTP_HOST]", EPub
::IDENTIFIER_URI
); // Could also be the ISBN number, prefered for published books, or a UUID.
113 //$book->setLanguage("en"); // 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.
114 $book->setDescription(_("Some articles saved on my wallabag"));
115 $book->setAuthor($this->author
,$this->author
);
116 $book->setPublisher("wallabag", "wallabag"); // I hope this is a non existant address :)
117 $book->setDate(time()); // Strictly not needed as the book date defaults to time().
118 //$book->setRights("Copyright and licence information specific for the book."); // As this is generated, this _could_ contain the name or licence information of the user who purchased the book, if needed. If this is used that way, the identifier must also be made unique for the book.
119 $book->setSourceURL("http://$_SERVER[HTTP_HOST]");
121 $book->addDublinCoreMetadata(DublinCore
::CONTRIBUTOR
, "PHP");
122 $book->addDublinCoreMetadata(DublinCore
::CONTRIBUTOR
, "wallabag");
124 $cssData = "body {\n margin-left: .5em;\n margin-right: .5em;\n text-align: justify;\n}\n\np {\n font-family: serif;\n font-size: 10pt;\n text-align: justify;\n text-indent: 1em;\n margin-top: 0px;\n margin-bottom: 1ex;\n}\n\nh1, h2 {\n font-family: sans-serif;\n font-style: italic;\n text-align: center;\n background-color: #6b879c;\n color: white;\n width: 100%;\n}\n\nh1 {\n margin-bottom: 2px;\n}\n\nh2 {\n margin-top: -2px;\n margin-bottom: 2px;\n}\n";
126 $log->logLine("Add Cover");
128 $fullTitle = "<h1> " . $this->bookTitle
. "</h1>\n";
130 $book->setCoverImage("Cover.png", file_get_contents("themes/_global/img/appicon/apple-touch-icon-152.png"), "image/png", $fullTitle);
132 $cover = $content_start . '<div style="text-align:center;"><p>' . _('Produced by wallabag with PHPePub') . '</p><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></div>' . $bookEnd;
134 //$book->addChapter("Table of Contents", "TOC.xhtml", NULL, false, EPub::EXTERNAL_REF_IGNORE);
135 $book->addChapter("Notices", "Cover2.html", $cover);
139 Tools
::logm('Adding actual content...');
141 foreach ($this->entries
as $entry) { //set tags as subjects
142 $tags = $this->wallabag
->store
->retrieveTagsByEntry($entry['id']);
143 foreach ($tags as $tag) {
144 $book->setSubject($tag['value']);
147 $log->logLine("Set up parameters");
149 $chapter = $content_start . $entry['content'] . $bookEnd;
150 $book->addChapter($entry['title'], htmlspecialchars($entry['title']) . ".html", $chapter, true, EPub
::EXTERNAL_REF_ADD
);
151 $log->logLine("Added chapter " . $entry['title']);
155 $book->addChapter("Log", "Log.html", $content_start . $log->getLog() . "\n</pre>" . $bookEnd); // log generation
156 Tools
::logm('Production log available in produced file');
159 $zipData = $book->sendBook($this->bookFileName
);
160 Tools
::logm('Ebook produced');
162 catch (Exception
$e) {
163 Tools
::logm('PHPePub has encountered an error : '.$e->getMessage());
164 $this->wallabag
->messages
->add('e', $e->getMessage());
169 class WallabagMobi
extends WallabagEBooks
173 * @author Sander Kromwijk
176 public function produceMobi()
179 Tools
::logm('Starting to produce Mobi file');
181 $content = new MOBIFile();
183 $messages = new Messages(); // for later
185 Tools
::logm('Filling metadata for Mobi...');
187 $content->set("title", $this->bookTitle
);
188 $content->set("author", $this->author
);
189 $content->set("subject", $this->bookTitle
);
192 $content->appendParagraph('<div style="text-align:center;" ><p>' . _('Produced by wallabag with PHPMobi') . '</p><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></div>');
193 $content->appendImage(imagecreatefrompng("themes/_global/img/appicon/apple-touch-icon-152.png"));
194 $content->appendPageBreak();
196 Tools
::logm('Adding actual content...');
198 foreach ($this->entries
as $item) {
199 $content->appendChapterTitle($item['title']);
200 $content->appendParagraph($item['content']);
201 $content->appendPageBreak();
203 $mobi->setContentProvider($content);
205 // the browser inside Kindle Devices doesn't likes special caracters either, we limit to A-z/0-9
206 $this->bookFileName
= preg_replace('/[^A-Za-z0-9\-]/', '', $this->bookFileName
);
208 // we offer file to download
209 $mobi->download($this->bookFileName
.'.mobi');
210 Tools
::logm('Mobi file produced');
212 catch (Exception
$e) {
213 Tools
::logm('PHPMobi has encountered an error : '.$e->getMessage());
214 $this->wallabag
->messages
->add('e', $e->getMessage());
219 class WallabagPDF
extends WallabagEbooks
221 public function producePDF()
224 Tools
::logm('Starting to produce PDF file');
225 @define ('K_TCPDF_THROW_EXCEPTION_ERROR', TRUE);
227 $pdf = new TCPDF(PDF_PAGE_ORIENTATION
, PDF_UNIT
, PDF_PAGE_FORMAT
, true, 'UTF-8', false);
229 Tools
::logm('Filling metadata for PDF...');
230 $pdf->SetCreator(PDF_CREATOR
);
231 $pdf->SetAuthor('wallabag');
232 $pdf->SetTitle($this->bookTitle
);
233 $pdf->SetSubject('Articles via wallabag');
234 $pdf->SetKeywords('wallabag');
236 Tools
::logm('Adding introduction...');
238 $intro = '<h1>' . $this->bookTitle
. '</h1><div style="text-align:center;" >
239 <p>' . _('Produced by wallabag with tcpdf') . '</p>
240 <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>
241 <img src="themes/_global/img/appicon/apple-touch-icon-152.png" /></div>';
244 $pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
247 Tools
::logm('Adding actual content...');
248 foreach ($this->entries
as $item) {
249 $tags = $this->wallabag
->store
->retrieveTagsByEntry($entry['id']);
250 foreach ($tags as $tag) {
251 $pdf->SetKeywords($tag['value']);
254 $html = '<h1>' . $item['title'] . '</h1>';
255 $html .= $item['content'];
256 $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
259 // set image scale factor
260 $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO
);
263 $pdf->Output($this->bookFileName
. '.pdf', 'FD');
265 catch (Exception
$e) {
266 Tools
::logm('TCPDF has encountered an error : '.$e->getMessage());
267 $this->wallabag
->messages
->add('e', $e->getMessage());