xref: /plugin/dw2pdf/action.php (revision fdd3d1212909d5036011864fde149ef11daf47b6) 
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();
12if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
13
14class action_plugin_dw2pdf extends DokuWiki_Action_Plugin {
15
16    private $tpl;
17
18    /**
19     * Constructor. Sets the correct template
20     */
21    function __construct(){
22        $tpl;
23        if(isset($_REQUEST['tpl'])){
24            $tpl = trim(preg_replace('/[^A-Za-z0-9_\-]+/','',$_REQUEST['tpl']));
25        }
26        if(!$tpl) $tpl = $this->getConf('template');
27        if(!$tpl) $tpl = 'default';
28        if(!is_dir(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl)) $tpl = 'default';
29
30        $this->tpl = $tpl;
31    }
32
33    /**
34     * Register the events
35     */
36    function register(&$controller) {
37        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'convert',array());
38    }
39
40    /**
41     * Do the HTML to PDF conversion work
42     */
43    function convert(&$event, $param) {
44        global $ACT;
45        global $REV;
46        global $ID;
47        global $conf;
48
49        // our event?
50        if (( $ACT != 'export_pdfbook' ) && ( $ACT != 'export_pdf' )) return false;
51
52        // check user's rights
53        if ( auth_quickaclcheck($ID) < AUTH_READ ) return false;
54
55        // it's ours, no one else's
56        $event->preventDefault();
57
58        // one or multiple pages?
59        $list = array();
60        if ( $ACT == 'export_pdf' ) {
61            $list[0] = $ID;
62        } elseif (isset($_COOKIE['list-pagelist'])) {
63            $list = explode("|", $_COOKIE['list-pagelist']);
64        }
65
66        // prepare cache
67        $cache = new cache(join(',',$list).$REV.$this->tpl,'.dw2.pdf');
68        $depends['files']   = array_map('wikiFN',$list);
69        $depends['files'][] = __FILE__;
70        $depends['files'][] = dirname(__FILE__).'/renderer.php';
71        $depends['files'][] = dirname(__FILE__).'/mpdf/mpdf.php';
72        $depends['files']   = array_merge($depends['files'], getConfigFiles('main'));
73
74        // hard work only when no cache available
75        if(!$this->getConf('usecache') || !$cache->useCache($depends)){
76            // initialize PDF library
77            require_once(dirname(__FILE__)."/DokuPDF.class.php");
78            $mpdf = new DokuPDF();
79
80            // let mpdf fix local links
81            $self = parse_url(DOKU_URL);
82            $url  = $self['scheme'].'://'.$self['host'];
83            if($self['port']) $url .= ':'.$port;
84            $mpdf->setBasePath($url);
85
86            // Set the title
87            $title = $_GET['pdfbook_title'];
88            if(!$title) $title = p_get_first_heading($ID);
89            $mpdf->SetTitle($title);
90
91            // some default settings
92            $mpdf->mirrorMargins = 1;
93            $mpdf->useOddEven    = 1;
94            $mpdf->setAutoTopMargin = 'stretch';
95            $mpdf->setAutoBottomMargin = 'stretch';
96
97            // load the template
98            $template = $this->load_template($title);
99
100            // prepare HTML header styles
101            $html  = '<html><head>';
102            $html .= '<style>';
103            $html .= $this->load_css();
104            $html .= '@page { size:auto; '.$template['page'].'}';
105            $html .= '@page :first {'.$template['first'].'}';
106            $html .= $template['css'];
107            $html .= '</style>';
108            $html .= '</head><body>';
109            $html .= $template['html'];
110            $html .= '<div class="dokuwiki">';
111
112            // loop over all pages
113            $cnt = count($list);
114            for($n=0; $n<$cnt; $n++){
115                $page = $list[$n];
116
117                $html .= p_cached_output(wikiFN($page,$REV),'dw2pdf',$page);
118                $html .= $template['cite'];
119                if ($n < ($cnt - 1)){
120                    $html .= '<pagebreak />';
121                }
122            }
123
124            $html .= '</div>';
125            $mpdf->WriteHTML($html);
126
127            // write to cache file
128            $mpdf->Output($cache->cache, 'F');
129        }
130
131        // deliver the file
132        header('Content-Type: application/pdf');
133        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
134        header('Pragma: public');
135        http_conditionalRequest(filemtime($cache->cache));
136
137        $filename = cleanID(strtr(':/;"','    ',$title))
138        if($this->getConf('output') == 'file'){
139            header('Content-Disposition: attachment; filename="'.rawurlencode($title).'.pdf";');
140        }else{
141            header('Content-Disposition: inline; filename="'.rawurlencode($title).'.pdf";');
142        }
143
144        if (http_sendfile($cache->cache)) exit;
145
146        $fp = @fopen($cache->cache,"rb");
147        if($fp){
148            http_rangeRequest($fp,filesize($cache->cache),'application/pdf');
149        }else{
150            header("HTTP/1.0 500 Internal Server Error");
151            print "Could not read file - bad permissions?";
152        }
153        exit();
154    }
155
156
157    /**
158     * Load the various template files and prepare the HTML/CSS for insertion
159     */
160    protected function load_template($title){
161        global $ID;
162        global $REV;
163        global $conf;
164        $tpl = $this->tpl;
165
166        // this is what we'll return
167        $output = array(
168            'html'  => '',
169            'css'   => '',
170            'page'  => '',
171            'first' => '',
172            'cite'  => '',
173        );
174
175        // prepare header/footer elements
176        $html = '';
177        foreach(array('header','footer') as $t){
178            foreach(array('','_odd','_even','_first') as $h){
179                if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html')){
180                    $html .= '<htmlpage'.$t.' name="'.$t.$h.'">'.DOKU_LF;
181                    $html .= file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html').DOKU_LF;
182                    $html .= '</htmlpage'.$t.'>'.DOKU_LF;
183
184                    // register the needed pseudo CSS
185                    if($h == '_first'){
186                        $output['first'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
187                    }elseif($h == '_even'){
188                        $output['page'] .= 'even-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
189                    }elseif($h == '_odd'){
190                        $output['page'] .= 'odd-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
191                    }else{
192                        $output['page'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
193                    }
194                }
195            }
196        }
197
198        // prepare replacements
199        $replace = array(
200                '@ID@'      => $ID,
201                '@PAGE@'    => '{PAGENO}',
202                '@PAGES@'   => '{nb}',
203                '@TITLE@'   => hsc($title),
204                '@WIKI@'    => $conf['title'],
205                '@WIKIURL@' => DOKU_URL,
206                '@UPDATE@'  => dformat(filemtime(wikiFN($ID,$REV))),
207                '@PAGEURL@' => wl($ID,($REV)?array('rev'=>$REV):false, true, "&"),
208                '@DATE@'    => dformat(time()),
209                '@BASE@'    => DOKU_BASE,
210                '@TPLBASE@' => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$tpl.'/',
211        );
212
213        // set HTML element
214        $output['html'] = str_replace(array_keys($replace), array_values($replace), $html);
215
216        // citation box
217        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html')){
218            $output['cite'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html');
219            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
220        }
221
222        // set custom styles
223        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/style.css')){
224            $output['css'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/style.css');
225        }
226
227        return $output;
228    }
229
230    /**
231     * Load all the style sheets and apply the needed replacements
232     */
233    protected function load_css(){
234        //reusue the CSS dispatcher functions without triggering the main function
235        define('SIMPLE_TEST',1);
236        require_once(DOKU_INC.'lib/exe/css.php');
237
238        // prepare CSS files
239        $files = array_merge(
240                    array(
241                        DOKU_INC.'lib/styles/screen.css'
242                            => DOKU_BASE.'lib/styles/',
243                        DOKU_INC.'lib/styles/print.css'
244                            => DOKU_BASE.'lib/styles/',
245                    ),
246                    css_pluginstyles('all'),
247                    $this->css_pluginPDFstyles(),
248                    array(
249                        DOKU_PLUGIN.'dw2pdf/conf/style.css'
250                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
251                        DOKU_PLUGIN.'dw2pdf/tpl/'.$this->tpl.'/style.css'
252                            => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$this->tpl.'/',
253                        DOKU_PLUGIN.'dw2pdf/conf/style.local.css'
254                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
255                    )
256                 );
257        $css = '';
258        foreach($files as $file => $location){
259            $css .= css_loadfile($file, $location);
260        }
261
262        // apply pattern replacements
263        $css = css_applystyle($css,DOKU_INC.'lib/tpl/'.$conf['template'].'/');
264
265        return $css;
266    }
267
268
269    /**
270     * Returns a list of possible Plugin PDF Styles
271     *
272     * Checks for a pdf.css, falls back to print.css
273     *
274     * @author Andreas Gohr <andi@splitbrain.org>
275     */
276    function css_pluginPDFstyles(){
277        global $lang;
278        $list = array();
279        $plugins = plugin_list();
280
281        $usestyle = explode(',',$this->getConf('usestyles'));
282        foreach ($plugins as $p){
283            if(in_array($p,$usestyle)){
284                $list[DOKU_PLUGIN."$p/screen.css"] = DOKU_BASE."lib/plugins/$p/";
285                $list[DOKU_PLUGIN."$p/style.css"] = DOKU_BASE."lib/plugins/$p/";
286            }
287
288            if(file_exists(DOKU_PLUGIN."$p/pdf.css")){
289                $list[DOKU_PLUGIN."$p/pdf.css"] = DOKU_BASE."lib/plugins/$p/";
290            }else{
291                $list[DOKU_PLUGIN."$p/print.css"] = DOKU_BASE."lib/plugins/$p/";
292            }
293        }
294        return $list;
295    }
296
297}
298