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