mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-09-25 04:50:04 +00:00
Code Issues Projects Releases Wiki Activity
wallabag/inc/poche/WallabagEBooks.class.php

314 lines
14 KiB
PHP
Raw Normal View History

Refactor
2014-07-12 17:01:11 +00:00
<?php
/**
* wallabag, self hostable application allowing you to not miss any content anymore
*
* @category wallabag
* @author Nicolas Lœuillet <nicolas@loeuillet.org>
* @copyright 2013
* @license http://opensource.org/licenses/MIT see COPYING file
*/
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
class WallabagEBooks
Refactor
2014-07-12 17:01:11 +00:00
{
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
protected $wallabag;
Refactor
2014-07-12 17:01:11 +00:00
protected $method;
protected $value;
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
protected $entries;
protected $bookTitle;
protected $bookFileName;
little better
2014-07-26 09:52:43 +00:00
protected $author = 'wallabag';
Refactor
2014-07-12 17:01:11 +00:00
fixed bug for epub export #755 ; also better metadata title
2014-07-19 22:45:45 +00:00
public function __construct(Poche $wallabag, $method, $value)
Refactor
2014-07-12 17:01:11 +00:00
{
$this->wallabag = $wallabag;
$this->method = $method;
$this->value = $value;
}
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
public function prepareData()
Refactor
2014-07-12 17:01:11 +00:00
{
switch ($this->method) {
case 'id':
fixed bug for epub export #755 ; also better metadata title
2014-07-19 22:45:45 +00:00
$entryID = filter_var($this->value, FILTER_SANITIZE_NUMBER_INT);
Refactor
2014-07-12 17:01:11 +00:00
$entry = $this->wallabag->store->retrieveOneById($entryID, $this->wallabag->user->getId());
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$this->entries = array($entry);
$this->bookTitle = $entry['title'];
$this->bookFileName = substr($this->bookTitle, 0, 200);
little better
2014-07-26 09:52:43 +00:00
$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)
Tools::logm('Producing ebook from article ' . $this->bookTitle);
Refactor
2014-07-12 17:01:11 +00:00
break;
case 'all':
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$this->entries = $this->wallabag->store->retrieveAll($this->wallabag->user->getId());
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$this->bookTitle = sprintf(_('All my articles on %s'), date(_('d.m.y'))); #translatable because each country has it's own date format system
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$this->bookFileName = _('Allarticles') . date(_('dmY'));
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Producing ebook from all articles');
Refactor
2014-07-12 17:01:11 +00:00
break;
case 'tag':
$tag = filter_var($this->value, FILTER_SANITIZE_STRING);
$tags_id = $this->wallabag->store->retrieveAllTags($this->wallabag->user->getId(), $tag);
$tag_id = $tags_id[0]["id"]; // we take the first result, which is supposed to match perfectly. There must be a workaround.
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$this->entries = $this->wallabag->store->retrieveEntriesByTag($tag_id, $this->wallabag->user->getId());
$this->bookTitle = sprintf(_('Articles tagged %s'), $tag);
$this->bookFileName = substr(sprintf(_('Tag %s'), $tag), 0, 200);
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Producing ebook from tag ' . $tag);
Refactor
2014-07-12 17:01:11 +00:00
break;
case 'category':
$category = filter_var($this->value, FILTER_SANITIZE_STRING);
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$this->entries = $this->wallabag->store->getEntriesByView($category, $this->wallabag->user->getId());
$this->bookTitle = sprintf(_('All articles in category %s'), $category);
$this->bookFileName = substr(sprintf(_('Category %s'), $category), 0, 200);
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Producing ebook from category ' . $category);
Refactor
2014-07-12 17:01:11 +00:00
break;
case 'search':
$search = filter_var($this->value, FILTER_SANITIZE_STRING);
use directly MOBIClass
2014-07-24 19:56:04 +00:00
Tools::logm($search);
$this->entries = $this->wallabag->store->search($search, $this->wallabag->user->getId());
$this->bookTitle = sprintf(_('All articles for search %s'), $search);
$this->bookFileName = substr(sprintf(_('Search %s'), $search), 0, 200);
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Producing ebook from search ' . $search);
Refactor
2014-07-12 17:01:11 +00:00
break;
case 'default':
little better
2014-07-26 09:52:43 +00:00
die(_('Uh, there is a problem while generating eBook.'));
Refactor
2014-07-12 17:01:11 +00:00
}
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
}
}
Refactor
2014-07-12 17:01:11 +00:00
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
class WallabagEpub extends WallabagEBooks
{
/**
* handle ePub
*/
public function produceEpub()
{
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Starting to produce ePub 3 file');
Refactor
2014-07-12 17:01:11 +00:00
$content_start =
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
. "<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\">\n"
. "<head>"
. "<meta http-equiv=\"Default-Style\" content=\"text/html; charset=utf-8\" />\n"
little better
2014-07-26 09:52:43 +00:00
. "<title>" . _("wallabag articles book") . "</title>\n"
Refactor
2014-07-12 17:01:11 +00:00
. "</head>\n"
. "<body>\n";
$bookEnd = "</body>\n</html>\n";
$log = new Logger("wallabag", TRUE);
$fileDir = CACHE;
$book = new EPub(EPub::BOOK_VERSION_EPUB3, DEBUG_POCHE);
$log->logLine("new EPub()");
$log->logLine("EPub class version: " . EPub::VERSION);
$log->logLine("EPub Req. Zip version: " . EPub::REQ_ZIP_VERSION);
$log->logLine("Zip version: " . Zip::VERSION);
$log->logLine("getCurrentServerURL: " . $book->getCurrentServerURL());
$log->logLine("getCurrentPageURL..: " . $book->getCurrentPageURL());
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Filling metadata for ePub...');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$book->setTitle($this->bookTitle);
Refactor
2014-07-12 17:01:11 +00:00
$book->setIdentifier("http://$_SERVER[HTTP_HOST]", EPub::IDENTIFIER_URI); // Could also be the ISBN number, prefered for published books, or a UUID.
//$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.
$book->setDescription(_("Some articles saved on my wallabag"));
little better
2014-07-26 09:52:43 +00:00
$book->setAuthor($this->author,$this->author);
Refactor
2014-07-12 17:01:11 +00:00
$book->setPublisher("wallabag", "wallabag"); // I hope this is a non existant address :)
$book->setDate(time()); // Strictly not needed as the book date defaults to time().
//$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.
$book->setSourceURL("http://$_SERVER[HTTP_HOST]");
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, "PHP");
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, "wallabag");
$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";
$log->logLine("Add Cover");
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$fullTitle = "<h1> " . $this->bookTitle . "</h1>\n";
Refactor
2014-07-12 17:01:11 +00:00
$book->setCoverImage("Cover.png", file_get_contents("themes/baggy/img/apple-touch-icon-152.png"), "image/png", $fullTitle);
$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;
//$book->addChapter("Table of Contents", "TOC.xhtml", NULL, false, EPub::EXTERNAL_REF_IGNORE);
$book->addChapter("Notices", "Cover2.html", $cover);
$book->buildTOC();
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Adding actual content...');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
foreach ($this->entries as $entry) { //set tags as subjects
Refactor
2014-07-12 17:01:11 +00:00
$tags = $this->wallabag->store->retrieveTagsByEntry($entry['id']);
foreach ($tags as $tag) {
$book->setSubject($tag['value']);
}
$log->logLine("Set up parameters");
$chapter = $content_start . $entry['content'] . $bookEnd;
$book->addChapter($entry['title'], htmlspecialchars($entry['title']) . ".html", $chapter, true, EPub::EXTERNAL_REF_ADD);
$log->logLine("Added chapter " . $entry['title']);
}
if (DEBUG_POCHE) {
$book->addChapter("Log", "Log.html", $content_start . $log->getLog() . "\n</pre>" . $bookEnd); // log generation
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Production log available in produced file');
Refactor
2014-07-12 17:01:11 +00:00
}
$book->finalize();
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$zipData = $book->sendBook($this->bookFileName);
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Ebook produced');
Refactor
2014-07-12 17:01:11 +00:00
}
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
}
class WallabagMobi extends WallabagEBooks
{
/**
use directly MOBIClass
2014-07-24 19:56:04 +00:00
* MOBI Class
* @author Sander Kromwijk
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
*/
send2kindle
2014-07-24 23:33:31 +00:00
public function produceMobi($sendByMail = FALSE)
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
{
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Starting to produce Mobi file');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$mobi = new MOBI();
$content = new MOBIFile();
send2kindle
2014-07-24 23:33:31 +00:00
$messages = new Messages(); // for later
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Filling metadata for Mobi...');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$content->set("title", $this->bookTitle);
little better
2014-07-26 09:52:43 +00:00
$content->set("author", $this->author);
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$content->set("subject", $this->bookTitle);
use directly MOBIClass
2014-07-24 19:56:04 +00:00
# introduction
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$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>');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$content->appendImage(imagecreatefrompng("themes/baggy/img/apple-touch-icon-152.png"));
$content->appendPageBreak();
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Adding actual content...');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
foreach ($this->entries as $item) {
$content->appendChapterTitle($item['title']);
$content->appendParagraph($item['content']);
$content->appendPageBreak();
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
}
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$mobi->setContentProvider($content);
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
send2kindle
2014-07-24 23:33:31 +00:00
if (!$sendByMail) {
// we offer file to download
$mobi->download($this->bookFileName.'.mobi');
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Mobi file produced');
send2kindle
2014-07-24 23:33:31 +00:00
}
else {
// we send file to kindle
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Preparing to send file by email');
$error = FALSE;
# testing Mail function
if (!function_exists('mail')) {
$error = _('Mail function is unavailable');
}
send2kindle
2014-07-24 23:33:31 +00:00
$char_in = array('/', '.', ',', ':', '|'); # we sanitize filename to avoid conflicts with special characters (for instance, / goes for a directory)
bug with extension in the filename
2014-07-24 23:38:28 +00:00
$mobiExportName = preg_replace('/\s+/', '-', str_replace($char_in, '-', $this->bookFileName)) . '.mobi';
send2kindle
2014-07-24 23:33:31 +00:00
$file = 'cache/' . $mobiExportName;
$mobi->save($file);
$file_size = filesize($file);
$filename = basename($file);
$handle = fopen($file, "r");
$content = fread($handle, $file_size);
fclose($handle);
$content = chunk_split(base64_encode($content));
$uid = md5(uniqid(time()));
//generate header for mail
$header = "From: wallabag <". $this->wallabag->user->email .">\r\n";
$header .= "MIME-Version: 1.0\r\n";
$header .= "Content-Type: multipart/mixed; boundary=\"".$uid."\"\r\n\r\n";
$header .= "This is a multi-part message in MIME format.\r\n";
$header .= "--".$uid."\r\n";
$header .= "Content-type:text/plain; charset=iso-8859-1\r\n";
$header .= "Content-Transfer-Encoding: 7bit\r\n\r\n";
$header .= "send via wallabag\r\n\r\n";
$header .= "--".$uid."\r\n";
$header .= "Content-Type: application/x-mobipocket-ebook; name=\"".$filename."\"\r\n";
$header .= "Content-Transfer-Encoding: base64\r\n";
$header .= "Content-Disposition: attachment; filename=\"".$filename."\"\r\n\r\n";
$header .= $content."\r\n\r\n";
$header .= "--".$uid."--";
# trying to get the kindle email adress
little better
2014-07-26 09:52:43 +00:00
if (!$this->wallabag->user->getConfigValue('kindleemail'))
send2kindle
2014-07-24 23:33:31 +00:00
{
little better
2014-07-26 09:52:43 +00:00
$error = _('You didn\'t set your kindle\'s email adress !');
send2kindle
2014-07-24 23:33:31 +00:00
}
little better
2014-07-26 09:52:43 +00:00
if (!$error) {
mail($this->wallabag->user->getConfigValue('kindleemail'), '[wallabag] ' . $this->bookTitle, "", $header );
$messages->add('s', _('The email has been sent to your kindle !'));
Tools::logm('Email sent');
} else {
$messages->add('e', $error);
Tools::logm($error);
send2kindle
2014-07-24 23:33:31 +00:00
}
}
use directly MOBIClass
2014-07-24 19:56:04 +00:00
}
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
}
class WallabagPDF extends WallabagEbooks
{
public function producePDF()
{
$mpdf = new mPDF('c');
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Starting to produce PDF file');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Filling metadata for PDF...');
# headers
$mpdf->SetHeader('{DATE j-m-Y}|{PAGENO}/{nb}|Produced with wallabag');
$mpdf->SetFooter('{PAGENO}');
# intro
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$html = '<h1>' . $this->bookTitle . '<bookmark content="Cover" /></h1><div style="text-align:center;" >
<p>' . _('Produced by wallabag with mPDF') . '</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>
<img src="themes/baggy/img/apple-touch-icon-152.png" /></div>';
$html .= '<pagebreak type="next-odd" />';
$i = 1;
use directly MOBIClass
2014-07-24 19:56:04 +00:00
little better
2014-07-26 09:52:43 +00:00
Tools::logm('Adding actual content...');
use directly MOBIClass
2014-07-24 19:56:04 +00:00
foreach ($this->entries as $item) {
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$html .= '<h1>' . $item['title'] . '<bookmark content="' . $item['title'] . '" /></h1>';
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$html .= '<indexentry content="'. $item['title'] .'" />';
$html .= $item['content'];
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
$html .= '<pagebreak type="next-odd" />';
$i = $i+1;
use directly MOBIClass
2014-07-24 19:56:04 +00:00
}
$mpdf->WriteHTML($html);
# remove characters that make mpdf bug
$char_in = array('/', '.', ',', ':', '|');
little better
2014-07-26 09:52:43 +00:00
$pdfExportName = preg_replace('/\s+/', '-', str_replace($char_in, '-', $this->bookFileName . '.pdf')); # maybe someone can make a proper regex of this ?
mobi (not tested on actual device) and pdf working
2014-07-24 22:33:19 +00:00
# index
$html = '<h2>Index<bookmark content="Index" /></h2>
<indexinsert cols="2" offset="5" usedivletters="on" div-font-size="15" gap="5" font="Trebuchet" div-font="sans-serif" links="on" />
';
$mpdf->WriteHTML($html);
use directly MOBIClass
2014-07-24 19:56:04 +00:00
$mpdf->Output('cache/' . $pdfExportName);
header('Content-Disposition: attachment; filename="' . $pdfExportName . '"');
header('Content-Transfer-Encoding: base64');
header('Content-Type: application/pdf');
echo file_get_contents('cache/' . $pdfExportName);
little better
2014-07-26 09:52:43 +00:00
Tools::logm('PDF file produced');
add pdf and mobi libraries
2014-07-24 13:49:36 +00:00
}
}
Reference in a new issue Copy permalink