]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - inc/poche/WallabagEBooks.class.php
fix #1238
[github/wallabag/wallabag.git] / inc / poche / WallabagEBooks.class.php
index 5f42308ebd108d88ebb40ecd485acf8aba7cf048..ec1e4b2719d6b3e6abb8e423b27e3f626602805b 100644 (file)
@@ -16,6 +16,7 @@ class WallabagEBooks
     protected $entries;
     protected $bookTitle;
     protected $bookFileName;
+    protected $author = 'wallabag';
 
     public function __construct(Poche $wallabag, $method, $value)
     {
@@ -32,12 +33,15 @@ class WallabagEBooks
                 $entry = $this->wallabag->store->retrieveOneById($entryID, $this->wallabag->user->getId());
                 $this->entries = array($entry);
                 $this->bookTitle = $entry['title'];
-                $this->bookFileName = substr($this->bookTitle, 0, 200);
+                $this->bookFileName = str_replace('/', '_', substr($this->bookTitle, 0, 200));
+                $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);
                 break;
             case 'all':
                 $this->entries = $this->wallabag->store->retrieveAll($this->wallabag->user->getId());
                 $this->bookTitle = sprintf(_('All my articles on %s'), date(_('d.m.y'))); #translatable because each country has it's own date format system
                 $this->bookFileName = _('Allarticles') . date(_('dmY'));
+                Tools::logm('Producing ebook from all articles');
                 break;
             case 'tag':
                 $tag = filter_var($this->value, FILTER_SANITIZE_STRING);
@@ -46,22 +50,25 @@ class WallabagEBooks
                 $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);
+                Tools::logm('Producing ebook from tag ' . $tag);
                 break;
             case 'category':
                 $category = filter_var($this->value, FILTER_SANITIZE_STRING);
                 $this->entries = $this->wallabag->store->getEntriesByView($category, $this->wallabag->user->getId());
-                $this->bookTitle = sprintf(_('All articles in category %s'), $category);
+                $this->bookTitle = sprintf(_('Articles in category %s'), $category);
                 $this->bookFileName = substr(sprintf(_('Category %s'), $category), 0, 200);
+                Tools::logm('Producing ebook from category ' . $category);
                 break;
             case 'search':
                 $search = filter_var($this->value, FILTER_SANITIZE_STRING);
                 Tools::logm($search);
                 $this->entries = $this->wallabag->store->search($search, $this->wallabag->user->getId());
-                $this->bookTitle = sprintf(_('All articles for search %s'), $search);
+                $this->bookTitle = sprintf(_('Articles for search %s'), $search);
                 $this->bookFileName = substr(sprintf(_('Search %s'), $search), 0, 200);
+                Tools::logm('Producing ebook from search ' . $search);
                 break;
             case 'default':
-                die(_('Uh, there is a problem while generating epub.'));
+                die(_('Uh, there is a problem while generating eBook.'));
         }
     }
 }
@@ -73,19 +80,22 @@ class WallabagEpub extends WallabagEBooks
      */
     public function produceEpub()
     {
+        Tools::logm('Starting to produce ePub 3 file');
+
+        try {
+
         $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"
-            . "<title>wallabag articles book</title>\n"
+            . "<title>" . _("wallabag articles book") . "</title>\n"
             . "</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()");
@@ -95,11 +105,13 @@ class WallabagEpub extends WallabagEBooks
         $log->logLine("getCurrentServerURL: " . $book->getCurrentServerURL());
         $log->logLine("getCurrentPageURL..: " . $book->getCurrentPageURL());
 
+        Tools::logm('Filling metadata for ePub...');
+
         $book->setTitle($this->bookTitle);
         $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"));
-        $book->setAuthor("wallabag", "wallabag");
+        $book->setAuthor($this->author,$this->author);
         $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.
@@ -108,13 +120,17 @@ class WallabagEpub extends WallabagEBooks
         $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";
-
+        /* 
+        * Line not used but planned to be used
+       *        
+        *$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");
 
         $fullTitle = "<h1> " . $this->bookTitle . "</h1>\n";
 
-        $book->setCoverImage("Cover.png", file_get_contents("themes/baggy/img/apple-touch-icon-152.png"), "image/png", $fullTitle);
+        $book->setCoverImage("Cover.png", file_get_contents("themes/_global/img/appicon/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;
 
@@ -123,6 +139,8 @@ class WallabagEpub extends WallabagEBooks
 
         $book->buildTOC();
 
+        Tools::logm('Adding actual content...');
+
         foreach ($this->entries as $entry) { //set tags as subjects
             $tags = $this->wallabag->store->retrieveTagsByEntry($entry['id']);
             foreach ($tags as $tag) {
@@ -138,9 +156,16 @@ class WallabagEpub extends WallabagEBooks
 
         if (DEBUG_POCHE) {
             $book->addChapter("Log", "Log.html", $content_start . $log->getLog() . "\n</pre>" . $bookEnd); // log generation
+            Tools::logm('Production log available in produced file');
         }
         $book->finalize();
         $zipData = $book->sendBook($this->bookFileName);
+        Tools::logm('Ebook produced');
+       }
+        catch (Exception $e) {
+            Tools::logm('PHPePub has encountered an error : '.$e->getMessage());
+            $this->wallabag->messages->add('e', $e->getMessage());
+        }
     }
 } 
 
@@ -151,25 +176,26 @@ class WallabagMobi extends WallabagEBooks
        * @author Sander Kromwijk
        */
 
-    private $_kindle_email;
-
-       public function produceMobi($sendByMail = FALSE)
+       public function produceMobi()
        {
-
+               try {
+        Tools::logm('Starting to produce Mobi file');
         $mobi = new MOBI();
         $content = new MOBIFile();
 
-        $messages = new Messages(); // for later
-            
+        Tools::logm('Filling metadata for Mobi...');
+
         $content->set("title", $this->bookTitle);
-        $content->set("author", "wallabag");
+        $content->set("author", $this->author);
         $content->set("subject", $this->bookTitle);
 
         # introduction
         $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>');
-        $content->appendImage(imagecreatefrompng("themes/baggy/img/apple-touch-icon-152.png"));
+        $content->appendImage(imagecreatefrompng("themes/_global/img/appicon/apple-touch-icon-152.png"));
         $content->appendPageBreak();
 
+        Tools::logm('Adding actual content...');
+
         foreach ($this->entries as $item) {
             $content->appendChapterTitle($item['title']);
             $content->appendParagraph($item['content']);
@@ -177,55 +203,16 @@ class WallabagMobi extends WallabagEBooks
         }
         $mobi->setContentProvider($content);
 
-        if (!$sendByMail) {
-            // we offer file to download
-            $mobi->download($this->bookFileName.'.mobi');
-        }
-        else {
-            // we send file to kindle
-
-            $char_in = array('/', '.', ',', ':', '|'); # we sanitize filename to avoid conflicts with special characters (for instance, / goes for a directory)
-            $mobiExportName = preg_replace('/\s+/', '-', str_replace($char_in, '-', $this->bookFileName)) . '.mobi';
-            
-            $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
-            if ($this->wallabag->user->getConfigValue('kindleemail')) 
-            {
-                #do a try...exeption here
-                mail( $this->wallabag->user->getConfigValue('kindleemail'), '[wallabag] ' . $this->bookTitle, "", $header );
-                $messages->add('s', _('The email has been sent to your kindle !'));
-            }
-            else
-            {
-                $messages->add('e', _('You didn\'t set your kindle\'s email adress !'));
-            }
+        // the browser inside Kindle Devices doesn't likes special caracters either, we limit to A-z/0-9
+        $this->bookFileName = preg_replace('/[^A-Za-z0-9\-]/', '', $this->bookFileName);
+
+        // we offer file to download
+        $mobi->download($this->bookFileName.'.mobi');
+        Tools::logm('Mobi file produced');
+       }
+        catch (Exception $e) {
+            Tools::logm('PHPMobi has encountered an error : '.$e->getMessage());
+            $this->wallabag->messages->add('e', $e->getMessage());
         }
     }
 }
@@ -234,51 +221,51 @@ class WallabagPDF extends WallabagEbooks
 {
        public function producePDF()
        {
-               $mpdf = new mPDF('c'); 
-
-        # intro
 
-        $html = '<h1>' . $this->bookTitle . '<bookmark content="Cover" /></h1><div style="text-align:center;" >
-        <p>' . _('Produced by wallabag with mPDF') . '</p>
+        Tools::logm('Starting to produce PDF file');
+        @define ('K_TCPDF_THROW_EXCEPTION_ERROR', TRUE);
+        try {
+        $pdf = new TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
+
+        Tools::logm('Filling metadata for PDF...');
+        $pdf->SetCreator(PDF_CREATOR);
+        $pdf->SetAuthor('wallabag');
+        $pdf->SetTitle($this->bookTitle);
+        $pdf->SetSubject('Articles via wallabag');
+        $pdf->SetKeywords('wallabag');
+               
+        Tools::logm('Adding introduction...');
+        $pdf->AddPage();
+        $intro = '<h1>' . $this->bookTitle . '</h1><div style="text-align:center;" >
+        <p>' . _('Produced by wallabag with tcpdf') . '</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;
+        <img src="themes/_global/img/appicon/apple-touch-icon-152.png" /></div>';
+
 
+        $pdf->writeHTMLCell(0, 0, '', '', $intro, 0, 1, 0, true, '', true);
+
+        Tools::logm('Adding actual content...');
         foreach ($this->entries as $item) {
-            $html .= '<h1>' . $item['title'] . '<bookmark content="' . $item['title'] . '" /></h1>';
-            $html .= '<indexentry content="'. $item['title'] .'" />';
+               $tags = $this->wallabag->store->retrieveTagsByEntry($item['id']);
+               foreach ($tags as $tag) {
+                $pdf->SetKeywords($tag['value']);
+            }
+            $pdf->AddPage();
+            $html = '<h1>' . $item['title'] . '</h1>';
             $html .= $item['content'];
-            $html .= '<pagebreak type="next-odd" />';
-            $i = $i+1;
+            $pdf->writeHTMLCell(0, 0, '', '', $html, 0, 1, 0, true, '', true);
         }
 
+        // set image scale factor
+        $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
+        
+        
+        $pdf->Output('cache/' . $this->bookFileName . '.pdf', 'FD');
+        }
+        catch (Exception $e) {
+            Tools::logm('TCPDF has encountered an error : '.$e->getMessage());
+            $this->wallabag->messages->add('e', $e->getMessage());
+            }
 
-        # headers
-        $mpdf->SetHeader('{DATE j-m-Y}|{PAGENO}/{nb}|Produced with wallabag');
-        $mpdf->SetFooter('{PAGENO}');
-               
-        $mpdf->WriteHTML($html);
-
-        # remove characters that make mpdf bug
-        $char_in = array('/', '.', ',', ':', '|');
-        $pdfExportName = preg_replace('/\s+/', '-', str_replace($char_in, '-', $this->bookFileName . '.pdf'));
-
-        # 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);
-               
-        $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);
-
-        //exit;
        }
-}
\ No newline at end of file
+}