xref: /plugin/dw2pdf/action.php (revision 6e2ec302972985fb7771857ff5bf3fa3de4c7db1) 
1<?php
2 /**
3  * dw2Pdf Plugin: Conversion from dokuwiki content to pdf.
4  *
5  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6  * @author     Luigi Micco <l.micco@tiscali.it>
7  * @author     Andreas Gohr <andi@splitbrain.org>
8  */
9
10// must be run within Dokuwiki
11if (!defined('DOKU_INC')) die();
12
13class action_plugin_dw2pdf extends DokuWiki_Action_Plugin {
14
15    private $tpl;
16
17    /**
18     * Constructor. Sets the correct template
19     */
20    public function __construct(){
21        $tpl = false;
22        if(isset($_REQUEST['tpl'])){
23            $tpl = trim(preg_replace('/[^A-Za-z0-9_\-]+/','',$_REQUEST['tpl']));
24        }
25        if(!$tpl) $tpl = $this->getConf('template');
26        if(!$tpl) $tpl = 'default';
27        if(!is_dir(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl)) $tpl = 'default';
28
29        $this->tpl = $tpl;
30    }
31
32    /**
33     * Register the events
34     */
35    public function register(Doku_Event_Handler $controller) {
36        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'convert', array());
37        $controller->register_hook('TEMPLATE_PAGETOOLS_DISPLAY', 'BEFORE', $this, 'addbutton', array());
38    }
39
40    /**
41     * Do the HTML to PDF conversion work
42     *
43     * @param Doku_Event $event
44     * @param array      $param
45     * @return bool
46     */
47    public function convert(&$event, $param) {
48        global $ACT;
49        global $REV;
50        global $ID;
51        global $INPUT, $conf;
52
53        // our event?
54        if (( $ACT != 'export_pdfbook' ) && ( $ACT != 'export_pdf' ) && ( $ACT != 'export_pdfns' )) return false;
55
56        // check user's rights
57        if ( auth_quickaclcheck($ID) < AUTH_READ ) return false;
58
59        // one or multiple pages?
60        $list  = array();
61
62        if($ACT == 'export_pdf') {
63            $list[0] = $ID;
64            $title = p_get_first_heading($ID);
65
66        } elseif($ACT == 'export_pdfns') {
67            //check input for title and ns
68            if(!$title = $INPUT->str('pdfns_title')) {
69                $this->showPageWithErrorMsg($event, 'needtitle');
70                return false;
71            }
72            $pdfnamespace = cleanID($INPUT->str('pdfns_ns'));
73            if(!@is_dir(dirname(wikiFN($pdfnamespace . ':dummy')))) {
74                $this->showPageWithErrorMsg($event, 'needns');
75                return false;
76            }
77
78            //sort order
79            $order = $INPUT->str('pdfns_order', 'natural', true);
80            $sortoptions = array('pagename', 'date', 'natural');
81            if(!in_array($order, $sortoptions)) {
82                $order = 'natural';
83            }
84
85            //search depth
86            $depth = $INPUT->int('pdfns_depth', 0);
87            if($depth < 0) {
88                $depth = 0;
89            }
90
91            //page search
92            $result = array();
93            $opts = array('depth' => $depth); //recursive all levels
94            $dir = utf8_encodeFN(str_replace(':', '/', $pdfnamespace));
95            search($result, $conf['datadir'], 'search_allpages', $opts, $dir);
96
97            //sorting
98            if(count($result) > 0) {
99                if($order == 'date') {
100                    usort($result, array($this, '_datesort'));
101                } elseif($order == 'pagename') {
102                    usort($result, array($this, '_pagenamesort'));
103                }
104            }
105
106            foreach($result as $item) {
107                $list[] = $item['id'];
108            }
109
110        } elseif(isset($_COOKIE['list-pagelist']) && !empty($_COOKIE['list-pagelist'])) {
111            //is in Bookmanager of bookcreator plugin a title given?
112            if(!$title = $INPUT->str('pdfbook_title')) {  //TODO when title is changed, the cached file contains the old title
113                $this->showPageWithErrorMsg($event, 'needtitle');
114                return false;
115            } else {
116                $list = explode("|", $_COOKIE['list-pagelist']);
117            }
118
119        } else {
120            //show empty bookcreator message
121            $this->showPageWithErrorMsg($event, 'empty');
122            return false;
123        }
124
125        // it's ours, no one else's
126        $event->preventDefault();
127
128        // decide on the paper setup from param or config
129        $pagesize    = $INPUT->str('pagesize', $this->getConf('pagesize'), true);
130        $orientation = $INPUT->str('orientation', $this->getConf('orientation'), true);
131
132        // prepare cache
133        $cache = new cache(join(',',$list).$REV.$this->tpl.$pagesize.$orientation,'.dw2.pdf');
134        $depends['files']   = array_map('wikiFN',$list);
135        $depends['files'][] = __FILE__;
136        $depends['files'][] = dirname(__FILE__).'/renderer.php';
137        $depends['files'][] = dirname(__FILE__).'/mpdf/mpdf.php';
138        $depends['files']   = array_merge($depends['files'], getConfigFiles('main'));
139
140        // hard work only when no cache available
141        if(!$this->getConf('usecache') || !$cache->useCache($depends)){
142            // initialize PDF library
143            require_once(dirname(__FILE__)."/DokuPDF.class.php");
144
145            $mpdf = new DokuPDF($pagesize, $orientation);
146
147            // let mpdf fix local links
148            $self = parse_url(DOKU_URL);
149            $url  = $self['scheme'].'://'.$self['host'];
150            if($self['port']) $url .= ':'.$self['port'];
151            $mpdf->setBasePath($url);
152
153            // Set the title
154            $mpdf->SetTitle($title);
155
156            // some default settings
157            $mpdf->mirrorMargins = 1;
158            $mpdf->useOddEven    = 1;
159            $mpdf->setAutoTopMargin = 'stretch';
160            $mpdf->setAutoBottomMargin = 'stretch';
161
162            // load the template
163            $template = $this->load_template($title);
164
165            // prepare HTML header styles
166            $html  = '<html><head>';
167            $html .= '<style type="text/css">';
168            $html .= $this->load_css();
169            $html .= '@page { size:auto; '.$template['page'].'}';
170            $html .= '@page :first {'.$template['first'].'}';
171            $html .= '</style>';
172            $html .= '</head><body>';
173            $html .= $template['html'];
174            $html .= '<div class="dokuwiki">';
175
176            // insert the cover page
177            $html .= $template['cover'];
178
179            // loop over all pages
180            $cnt = count($list);
181            for($n=0; $n<$cnt; $n++){
182                $page = $list[$n];
183
184                $html .= p_cached_output(wikiFN($page,$REV),'dw2pdf',$page);
185                $html .= $this->page_depend_replacements($template['cite'], cleanID($page));
186                if ($n < ($cnt - 1)){
187                    $html .= '<pagebreak />';
188                }
189            }
190
191            $html .= '</div>';
192            $html .= '</body>';
193            $html .= '</html>';
194
195            //Return html for debugging
196            if($conf['allowdebug'] && $_GET['debughtml'] == 'html') {
197                echo $html;
198                exit();
199            };
200
201            $mpdf->WriteHTML($html);
202
203            // write to cache file
204            $mpdf->Output($cache->cache, 'F');
205        }
206
207        // deliver the file
208        header('Content-Type: application/pdf');
209        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
210        header('Pragma: public');
211        http_conditionalRequest(filemtime($cache->cache));
212
213        $filename = rawurlencode(cleanID(strtr($title, ':/;"','    ')));
214        if($this->getConf('output') == 'file'){
215            header('Content-Disposition: attachment; filename="'.$filename.'.pdf";');
216        }else{
217            header('Content-Disposition: inline; filename="'.$filename.'.pdf";');
218        }
219
220        //try to send file, and exit if done
221        http_sendfile($cache->cache);
222
223        $fp = @fopen($cache->cache,"rb");
224        if($fp){
225            http_rangeRequest($fp,filesize($cache->cache),'application/pdf');
226        }else{
227            header("HTTP/1.0 500 Internal Server Error");
228            print "Could not read file - bad permissions?";
229        }
230        exit();
231    }
232
233    /**
234     * Add 'export pdf'-button to pagetools
235     *
236     * @param Doku_Event $event
237     * @param mixed      $param not defined
238     */
239    public function addbutton(&$event, $param) {
240        global $ID, $REV;
241
242        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
243            $params = array('do' => 'export_pdf');
244            if($REV) $params['rev'] = $REV;
245
246            // insert button at position before last (up to top)
247            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
248                                    array('export_pdf' =>
249                                          '<li>'
250                                          .'<a href='.wl($ID, $params).'  class="action export_pdf" rel="nofollow" title="'.$this->getLang('export_pdf_button').'">'
251                                          .'<span>'.$this->getLang('export_pdf_button').'</span>'
252                                          .'</a>'
253                                          .'</li>'
254                                    ) +
255                                    array_slice($event->data['items'], -1 , 1, true);
256        }
257    }
258
259    /**
260     * Load the various template files and prepare the HTML/CSS for insertion
261     */
262    protected function load_template($title){
263        global $ID;
264        global $conf;
265        $tpl = $this->tpl;
266
267        // this is what we'll return
268        $output = array(
269            'cover' => '',
270            'html'  => '',
271            'page'  => '',
272            'first' => '',
273            'cite'  => '',
274        );
275
276        // prepare header/footer elements
277        $html = '';
278        foreach(array('header','footer') as $t){
279            foreach(array('','_odd','_even','_first') as $h){
280                if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html')){
281                    $html .= '<htmlpage'.$t.' name="'.$t.$h.'">'.DOKU_LF;
282                    $html .= file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html').DOKU_LF;
283                    $html .= '</htmlpage'.$t.'>'.DOKU_LF;
284
285                    // register the needed pseudo CSS
286                    if($h == '_first'){
287                        $output['first'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
288                    }elseif($h == '_even'){
289                        $output['page'] .= 'even-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
290                    }elseif($h == '_odd'){
291                        $output['page'] .= 'odd-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
292                    }else{
293                        $output['page'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
294                    }
295                }
296            }
297        }
298
299        // prepare replacements
300        $replace = array(
301                '@PAGE@'    => '{PAGENO}',
302                '@PAGES@'   => '{nb}',
303                '@TITLE@'   => hsc($title),
304                '@WIKI@'    => $conf['title'],
305                '@WIKIURL@' => DOKU_URL,
306                '@DATE@'    => dformat(time()),
307                '@BASE@'    => DOKU_BASE,
308                '@TPLBASE@' => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$tpl.'/'
309        );
310
311        // set HTML element
312        $html = str_replace(array_keys($replace), array_values($replace), $html);
313        //TODO For bookcreator $ID (= bookmanager page) makes no sense
314        $output['html'] = $this->page_depend_replacements($html, $ID);
315
316        // cover page
317        if(file_exists(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl . '/cover.html')) {
318            $output['cover'] = file_get_contents(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl . '/cover.html');
319            $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
320            $output['cover'] .= '<pagebreak />';
321
322        }
323
324        // citation box
325        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html')){
326            $output['cite'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html');
327            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
328        }
329
330        return $output;
331    }
332
333    /**
334     * @param string $raw code with placeholders
335     * @param string $id  pageid
336     * @return string
337     */
338    protected function page_depend_replacements($raw, $id){
339        global $REV;
340
341        // generate qr code for this page using google infographics api
342        $qr_code = '';
343        if ($this->getConf('qrcodesize')) {
344            $url = urlencode(wl($id,'','&',true));
345            $qr_code = '<img src="https://chart.googleapis.com/chart?chs='.
346                $this->getConf('qrcodesize').'&cht=qr&chl='.$url.'" />';
347        }
348        // prepare replacements
349        $replace['@ID@']      = $id;
350        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
351        $replace['@PAGEURL@'] = wl($id, ($REV) ? array('rev'=> $REV) : false, true, "&");
352        $replace['@QRCODE@']  = $qr_code;
353
354        return str_replace(array_keys($replace), array_values($replace), $raw);
355    }
356
357    /**
358     * Load all the style sheets and apply the needed replacements
359     */
360    protected function load_css(){
361        global $conf;
362        //reusue the CSS dispatcher functions without triggering the main function
363        define('SIMPLE_TEST',1);
364        require_once(DOKU_INC.'lib/exe/css.php');
365
366        // prepare CSS files
367        $files = array_merge(
368                    array(
369                        DOKU_INC.'lib/styles/screen.css'
370                            => DOKU_BASE.'lib/styles/',
371                        DOKU_INC.'lib/styles/print.css'
372                            => DOKU_BASE.'lib/styles/',
373                    ),
374                    css_pluginstyles('all'),
375                    $this->css_pluginPDFstyles(),
376                    array(
377                        DOKU_PLUGIN.'dw2pdf/conf/style.css'
378                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
379                        DOKU_PLUGIN.'dw2pdf/tpl/'.$this->tpl.'/style.css'
380                            => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$this->tpl.'/',
381                        DOKU_PLUGIN.'dw2pdf/conf/style.local.css'
382                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
383                    )
384                 );
385        $css = '';
386        foreach($files as $file => $location){
387            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
388            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
389            $css .= css_loadfile($file, $location);
390        }
391
392        if(function_exists('css_parseless')) {
393            // apply pattern replacements
394            $styleini = css_styleini($conf['template']);
395            $css = css_applystyle($css, $styleini['replacements']);
396
397            // parse less
398            $css = css_parseless($css);
399        } else {
400            // @deprecated 2013-12-19: fix backward compatibility
401            $css = css_applystyle($css,DOKU_INC.'lib/tpl/'.$conf['template'].'/');
402        }
403
404        return $css;
405    }
406
407    /**
408     * Returns a list of possible Plugin PDF Styles
409     *
410     * Checks for a pdf.css, falls back to print.css
411     *
412     * @author Andreas Gohr <andi@splitbrain.org>
413     */
414    protected function css_pluginPDFstyles(){
415        $list = array();
416        $plugins = plugin_list();
417
418        $usestyle = explode(',',$this->getConf('usestyles'));
419        foreach ($plugins as $p){
420            if(in_array($p,$usestyle)){
421                $list[DOKU_PLUGIN."$p/screen.css"] = DOKU_BASE."lib/plugins/$p/";
422                $list[DOKU_PLUGIN."$p/style.css"] = DOKU_BASE."lib/plugins/$p/";
423            }
424
425            if(file_exists(DOKU_PLUGIN."$p/pdf.css")){
426                $list[DOKU_PLUGIN."$p/pdf.css"] = DOKU_BASE."lib/plugins/$p/";
427            }else{
428                $list[DOKU_PLUGIN."$p/print.css"] = DOKU_BASE."lib/plugins/$p/";
429            }
430        }
431        return $list;
432    }
433
434    /**
435     * usort callback to sort by file lastmodified time
436     */
437    public function _datesort($a, $b) {
438        if($b['rev'] < $a['rev']) return -1;
439        if($b['rev'] > $a['rev']) return 1;
440        return strcmp($b['id'], $a['id']);
441    }
442
443    /**
444     * usort callback to sort by page id
445     */
446    public function _pagenamesort($a, $b) {
447        if($a['id'] <= $b['id']) return -1;
448        if($a['id'] > $b['id']) return 1;
449        return 0;
450    }
451
452    /**
453     * Set error notification and reload page again
454     *
455     * @param Doku_Event $event
456     * @param string     $msglangkey key of translation key
457     */
458    private function showPageWithErrorMsg(&$event, $msglangkey) {
459        msg($this->getLang($msglangkey), -1);
460
461        $event->data = 'show';
462        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
463    }
464}
465