xref: /plugin/dw2pdf/action.php (revision 1e45476b091ec90918baeee735bbf8ca4efd9809) 
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 .= $output['cover'];
178            $html .= '<pagebreak />';
179
180            // loop over all pages
181            $cnt = count($list);
182            for($n=0; $n<$cnt; $n++){
183                $page = $list[$n];
184
185                $html .= p_cached_output(wikiFN($page,$REV),'dw2pdf',$page);
186                $html .= $this->page_depend_replacements($template['cite'], cleanID($page));
187                if ($n < ($cnt - 1)){
188                    $html .= '<pagebreak />';
189                }
190            }
191
192            $html .= '</div>';
193            $html .= '</body>';
194            $html .= '</html>';
195
196            //Return html for debugging
197            if($conf['allowdebug'] && $_GET['debughtml'] == 'html') {
198                echo $html;
199                exit();
200            };
201
202            $mpdf->WriteHTML($html);
203
204            // write to cache file
205            $mpdf->Output($cache->cache, 'F');
206        }
207
208        // deliver the file
209        header('Content-Type: application/pdf');
210        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
211        header('Pragma: public');
212        http_conditionalRequest(filemtime($cache->cache));
213
214        $filename = rawurlencode(cleanID(strtr($title, ':/;"','    ')));
215        if($this->getConf('output') == 'file'){
216            header('Content-Disposition: attachment; filename="'.$filename.'.pdf";');
217        }else{
218            header('Content-Disposition: inline; filename="'.$filename.'.pdf";');
219        }
220
221        //try to send file, and exit if done
222        http_sendfile($cache->cache);
223
224        $fp = @fopen($cache->cache,"rb");
225        if($fp){
226            http_rangeRequest($fp,filesize($cache->cache),'application/pdf');
227        }else{
228            header("HTTP/1.0 500 Internal Server Error");
229            print "Could not read file - bad permissions?";
230        }
231        exit();
232    }
233
234    /**
235     * Add 'export pdf'-button to pagetools
236     *
237     * @param Doku_Event $event
238     * @param mixed      $param not defined
239     */
240    public function addbutton(&$event, $param) {
241        global $ID, $REV;
242
243        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
244            $params = array('do' => 'export_pdf');
245            if($REV) $params['rev'] = $REV;
246
247            // insert button at position before last (up to top)
248            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
249                                    array('export_pdf' =>
250                                          '<li>'
251                                          .'<a href='.wl($ID, $params).'  class="action export_pdf" rel="nofollow" title="'.$this->getLang('export_pdf_button').'">'
252                                          .'<span>'.$this->getLang('export_pdf_button').'</span>'
253                                          .'</a>'
254                                          .'</li>'
255                                    ) +
256                                    array_slice($event->data['items'], -1 , 1, true);
257        }
258    }
259
260    /**
261     * Load the various template files and prepare the HTML/CSS for insertion
262     */
263    protected function load_template($title){
264        global $ID;
265        global $conf;
266        $tpl = $this->tpl;
267
268        // this is what we'll return
269        $output = array(
270            'cover' => '',
271            'html'  => '',
272            'page'  => '',
273            'first' => '',
274            'cite'  => '',
275        );
276
277        // prepare header/footer elements
278        $html = '';
279        foreach(array('header','footer') as $t){
280            foreach(array('','_odd','_even','_first') as $h){
281                if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html')){
282                    $html .= '<htmlpage'.$t.' name="'.$t.$h.'">'.DOKU_LF;
283                    $html .= file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html').DOKU_LF;
284                    $html .= '</htmlpage'.$t.'>'.DOKU_LF;
285
286                    // register the needed pseudo CSS
287                    if($h == '_first'){
288                        $output['first'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
289                    }elseif($h == '_even'){
290                        $output['page'] .= 'even-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
291                    }elseif($h == '_odd'){
292                        $output['page'] .= 'odd-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
293                    }else{
294                        $output['page'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
295                    }
296                }
297            }
298        }
299
300        // prepare replacements
301        $replace = array(
302                '@PAGE@'    => '{PAGENO}',
303                '@PAGES@'   => '{nb}',
304                '@TITLE@'   => hsc($title),
305                '@WIKI@'    => $conf['title'],
306                '@WIKIURL@' => DOKU_URL,
307                '@DATE@'    => dformat(time()),
308                '@BASE@'    => DOKU_BASE,
309                '@TPLBASE@' => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$tpl.'/'
310        );
311
312        // set HTML element
313        $html = str_replace(array_keys($replace), array_values($replace), $html);
314        //TODO For bookcreator $ID (= bookmanager page) makes no sense
315        $output['html'] = $this->page_depend_replacements($html, $ID);
316
317        // cover page
318        if($output['cover']){
319          $output['cover'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/cover.html');
320          $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
321            }
322
323        // citation box
324        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html')){
325            $output['cite'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html');
326            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
327        }
328
329        return $output;
330    }
331
332    /**
333     * @param string $raw code with placeholders
334     * @param string $id  pageid
335     * @return string
336     */
337    protected function page_depend_replacements($raw, $id){
338        global $REV;
339
340        // generate qr code for this page using google infographics api
341        $qr_code = '';
342        if ($this->getConf('qrcodesize')) {
343            $url = urlencode(wl($id,'','&',true));
344            $qr_code = '<img src="https://chart.googleapis.com/chart?chs='.
345                $this->getConf('qrcodesize').'&cht=qr&chl='.$url.'" />';
346        }
347        // prepare replacements
348        $replace['@ID@']      = $id;
349        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
350        $replace['@PAGEURL@'] = wl($id, ($REV) ? array('rev'=> $REV) : false, true, "&");
351        $replace['@QRCODE@']  = $qr_code;
352
353        return str_replace(array_keys($replace), array_values($replace), $raw);
354    }
355
356    /**
357     * Load all the style sheets and apply the needed replacements
358     */
359    protected function load_css(){
360        global $conf;
361        //reusue the CSS dispatcher functions without triggering the main function
362        define('SIMPLE_TEST',1);
363        require_once(DOKU_INC.'lib/exe/css.php');
364
365        // prepare CSS files
366        $files = array_merge(
367                    array(
368                        DOKU_INC.'lib/styles/screen.css'
369                            => DOKU_BASE.'lib/styles/',
370                        DOKU_INC.'lib/styles/print.css'
371                            => DOKU_BASE.'lib/styles/',
372                    ),
373                    css_pluginstyles('all'),
374                    $this->css_pluginPDFstyles(),
375                    array(
376                        DOKU_PLUGIN.'dw2pdf/conf/style.css'
377                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
378                        DOKU_PLUGIN.'dw2pdf/tpl/'.$this->tpl.'/style.css'
379                            => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$this->tpl.'/',
380                        DOKU_PLUGIN.'dw2pdf/conf/style.local.css'
381                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
382                    )
383                 );
384        $css = '';
385        foreach($files as $file => $location){
386            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
387            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
388            $css .= css_loadfile($file, $location);
389        }
390
391        if(function_exists('css_parseless')) {
392            // apply pattern replacements
393            $styleini = css_styleini($conf['template']);
394            $css = css_applystyle($css, $styleini['replacements']);
395
396            // parse less
397            $css = css_parseless($css);
398        } else {
399            // @deprecated 2013-12-19: fix backward compatibility
400            $css = css_applystyle($css,DOKU_INC.'lib/tpl/'.$conf['template'].'/');
401        }
402
403        return $css;
404    }
405
406    /**
407     * Returns a list of possible Plugin PDF Styles
408     *
409     * Checks for a pdf.css, falls back to print.css
410     *
411     * @author Andreas Gohr <andi@splitbrain.org>
412     */
413    protected function css_pluginPDFstyles(){
414        $list = array();
415        $plugins = plugin_list();
416
417        $usestyle = explode(',',$this->getConf('usestyles'));
418        foreach ($plugins as $p){
419            if(in_array($p,$usestyle)){
420                $list[DOKU_PLUGIN."$p/screen.css"] = DOKU_BASE."lib/plugins/$p/";
421                $list[DOKU_PLUGIN."$p/style.css"] = DOKU_BASE."lib/plugins/$p/";
422            }
423
424            if(file_exists(DOKU_PLUGIN."$p/pdf.css")){
425                $list[DOKU_PLUGIN."$p/pdf.css"] = DOKU_BASE."lib/plugins/$p/";
426            }else{
427                $list[DOKU_PLUGIN."$p/print.css"] = DOKU_BASE."lib/plugins/$p/";
428            }
429        }
430        return $list;
431    }
432
433    /**
434     * usort callback to sort by file lastmodified time
435     */
436    public function _datesort($a, $b) {
437        if($b['rev'] < $a['rev']) return -1;
438        if($b['rev'] > $a['rev']) return 1;
439        return strcmp($b['id'], $a['id']);
440    }
441
442    /**
443     * usort callback to sort by page id
444     */
445    public function _pagenamesort($a, $b) {
446        if($a['id'] <= $b['id']) return -1;
447        if($a['id'] > $b['id']) return 1;
448        return 0;
449    }
450
451    /**
452     * Set error notification and reload page again
453     *
454     * @param Doku_Event $event
455     * @param string     $msglangkey key of translation key
456     */
457    private function showPageWithErrorMsg(&$event, $msglangkey) {
458        msg($this->getLang($msglangkey), -1);
459
460        $event->data = 'show';
461        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
462    }
463}
464