xref: /plugin/dw2pdf/action.php (revision f54b51f7e976d8be0692e20fe9dd9352652b89bd)
1ee19bac3SLuigi Micco<?php
2ee19bac3SLuigi Micco /**
3ee19bac3SLuigi Micco  * dw2Pdf Plugin: Conversion from dokuwiki content to pdf.
4ee19bac3SLuigi Micco  *
5ee19bac3SLuigi Micco  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6ee19bac3SLuigi Micco  * @author     Luigi Micco <l.micco@tiscali.it>
75db42babSAndreas Gohr  * @author     Andreas Gohr <andi@splitbrain.org>
8ee19bac3SLuigi Micco  */
9ee19bac3SLuigi Micco
10ee19bac3SLuigi Micco// must be run within Dokuwiki
11ee19bac3SLuigi Miccoif (!defined('DOKU_INC')) die();
12ee19bac3SLuigi Miccoif (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
13ee19bac3SLuigi Micco
141ef68647SAndreas Gohrclass action_plugin_dw2pdf extends DokuWiki_Action_Plugin {
15ee19bac3SLuigi Micco
161c14c879SAndreas Gohr    private $tpl;
171c14c879SAndreas Gohr
181c14c879SAndreas Gohr    /**
191c14c879SAndreas Gohr     * Constructor. Sets the correct template
201c14c879SAndreas Gohr     */
211c14c879SAndreas Gohr    function __construct(){
221c14c879SAndreas Gohr        $tpl;
231c14c879SAndreas Gohr        if(isset($_REQUEST['tpl'])){
241c14c879SAndreas Gohr            $tpl = trim(preg_replace('/[^A-Za-z0-9_\-]+/','',$_REQUEST['tpl']));
251c14c879SAndreas Gohr        }
261c14c879SAndreas Gohr        if(!$tpl) $tpl = $this->getConf('template');
271c14c879SAndreas Gohr        if(!$tpl) $tpl = 'default';
281c14c879SAndreas Gohr        if(!is_dir(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl)) $tpl = 'default';
291c14c879SAndreas Gohr
301c14c879SAndreas Gohr        $this->tpl = $tpl;
311c14c879SAndreas Gohr    }
321c14c879SAndreas Gohr
33ee19bac3SLuigi Micco    /**
34ee19bac3SLuigi Micco     * Register the events
35ee19bac3SLuigi Micco     */
361ef68647SAndreas Gohr    function register(&$controller) {
37ee19bac3SLuigi Micco        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'convert',array());
38ee19bac3SLuigi Micco    }
39ee19bac3SLuigi Micco
401c14c879SAndreas Gohr    /**
411c14c879SAndreas Gohr     * Do the HTML to PDF conversion work
421c14c879SAndreas Gohr     */
431ef68647SAndreas Gohr    function convert(&$event, $param) {
44ee19bac3SLuigi Micco        global $ACT;
45ee19bac3SLuigi Micco        global $REV;
46ee19bac3SLuigi Micco        global $ID;
47ee19bac3SLuigi Micco        global $conf;
48ee19bac3SLuigi Micco
491ef68647SAndreas Gohr        // our event?
501ef68647SAndreas Gohr        if (( $ACT != 'export_pdfbook' ) && ( $ACT != 'export_pdf' )) return false;
51ee19bac3SLuigi Micco
521ef68647SAndreas Gohr        // check user's rights
531ef68647SAndreas Gohr        if ( auth_quickaclcheck($ID) < AUTH_READ ) return false;
541ef68647SAndreas Gohr
551ef68647SAndreas Gohr        // it's ours, no one else's
56ee19bac3SLuigi Micco        $event->preventDefault();
57ee19bac3SLuigi Micco
5887c86ddaSAndreas Gohr        // one or multiple pages?
5987c86ddaSAndreas Gohr        $list = array();
6087c86ddaSAndreas Gohr        if ( $ACT == 'export_pdf' ) {
6187c86ddaSAndreas Gohr            $list[0] = $ID;
6287c86ddaSAndreas Gohr        } elseif (isset($_COOKIE['list-pagelist'])) {
6387c86ddaSAndreas Gohr            $list = explode("|", $_COOKIE['list-pagelist']);
6487c86ddaSAndreas Gohr        }
6587c86ddaSAndreas Gohr
6687c86ddaSAndreas Gohr        // prepare cache
671c14c879SAndreas Gohr        $cache = new cache(join(',',$list).$REV.$this->tpl,'.dw2.pdf');
6887c86ddaSAndreas Gohr        $depends['files']   = array_map('wikiFN',$list);
6987c86ddaSAndreas Gohr        $depends['files'][] = __FILE__;
7087c86ddaSAndreas Gohr        $depends['files'][] = dirname(__FILE__).'/renderer.php';
7187c86ddaSAndreas Gohr        $depends['files'][] = dirname(__FILE__).'/mpdf/mpdf.php';
7287c86ddaSAndreas Gohr
73d01d2a42SAndreas Gohr        // hard work only when no cache available
7487c86ddaSAndreas Gohr        if(!$this->getConf('usecache') || !$cache->useCache($depends)){
751ef68647SAndreas Gohr            // initialize PDF library
76cde5a1b3SAndreas Gohr            require_once(dirname(__FILE__)."/DokuPDF.class.php");
771ef68647SAndreas Gohr            $mpdf = new DokuPDF();
78ee19bac3SLuigi Micco
79d62df65bSAndreas Gohr            // let mpdf fix local links
80d62df65bSAndreas Gohr            $self = parse_url(DOKU_URL);
81d62df65bSAndreas Gohr            $url  = $self['scheme'].'://'.$self['host'];
82d62df65bSAndreas Gohr            if($self['port']) $url .= ':'.$port;
83d62df65bSAndreas Gohr            $mpdf->setBasePath($url);
84d62df65bSAndreas Gohr
8556d13144SAndreas Gohr            // Set the title
8656d13144SAndreas Gohr            $title = $_GET['pdfbook_title'];
8756d13144SAndreas Gohr            if(!$title) $title = p_get_first_heading($ID);
8856d13144SAndreas Gohr            $mpdf->SetTitle($title);
8956d13144SAndreas Gohr
901ef68647SAndreas Gohr            // some default settings
91daa70883SAndreas Gohr            $mpdf->mirrorMargins = 1;
92daa70883SAndreas Gohr            $mpdf->useOddEven    = 1;
93daa70883SAndreas Gohr            $mpdf->setAutoTopMargin = 'stretch';
94daa70883SAndreas Gohr            $mpdf->setAutoBottomMargin = 'stretch';
952eedf77dSAndreas Gohr
9656d13144SAndreas Gohr            // load the template
971c14c879SAndreas Gohr            $template = $this->load_template($title);
98ee19bac3SLuigi Micco
991ef68647SAndreas Gohr            // prepare HTML header styles
100ee19bac3SLuigi Micco            $html  = '<html><head>';
1011ef68647SAndreas Gohr            $html .= '<style>';
1021c14c879SAndreas Gohr            $html .= $this->load_css();
103daa70883SAndreas Gohr            $html .= '@page { size:auto; '.$template['page'].'}';
1042eedf77dSAndreas Gohr            $html .= '@page :first {'.$template['first'].'}';
1052eedf77dSAndreas Gohr            $html .= $template['css'];
1061ef68647SAndreas Gohr            $html .= '</style>';
1071ef68647SAndreas Gohr            $html .= '</head><body>';
1082eedf77dSAndreas Gohr            $html .= $template['html'];
1091c14c879SAndreas Gohr            $html .= '<div class="dokuwiki">';
1102eedf77dSAndreas Gohr
1111ef68647SAndreas Gohr            // loop over all pages
1121ef68647SAndreas Gohr            $cnt = count($list);
1131ef68647SAndreas Gohr            for($n=0; $n<$cnt; $n++){
114ee19bac3SLuigi Micco                $page = $list[$n];
115ee19bac3SLuigi Micco
116a876b55bSAndreas Gohr                $html .= p_cached_output(wikiFN($page,$REV),'dw2pdf',$page);
1172eedf77dSAndreas Gohr                $html .= $template['cite'];
1181ef68647SAndreas Gohr                if ($n < ($cnt - 1)){
1191ef68647SAndreas Gohr                    $html .= '<pagebreak />';
1201ef68647SAndreas Gohr                }
121ee19bac3SLuigi Micco            }
122ee19bac3SLuigi Micco
1231c14c879SAndreas Gohr            $html .= '</div>';
124ee19bac3SLuigi Micco            $mpdf->WriteHTML($html);
125a06728a6SAndreas Gohr
12687c86ddaSAndreas Gohr            // write to cache file
12787c86ddaSAndreas Gohr            $mpdf->Output($cache->cache, 'F');
12887c86ddaSAndreas Gohr        }
12987c86ddaSAndreas Gohr
13087c86ddaSAndreas Gohr        // deliver the file
13187c86ddaSAndreas Gohr        header('Content-Type: application/pdf');
132b853b723SAndreas Gohr        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
13387c86ddaSAndreas Gohr        header('Pragma: public');
13487c86ddaSAndreas Gohr        http_conditionalRequest(filemtime($cache->cache));
13587c86ddaSAndreas Gohr
13687c86ddaSAndreas Gohr        if($this->getConf('output') == 'file'){
13756d13144SAndreas Gohr            header('Content-Disposition: attachment; filename="'.rawurlencode($title).'.pdf";');
13887c86ddaSAndreas Gohr        }else{
13956d13144SAndreas Gohr            header('Content-Disposition: inline; filename="'.rawurlencode($title).'.pdf";');
14087c86ddaSAndreas Gohr        }
141ee19bac3SLuigi Micco
14287c86ddaSAndreas Gohr        if (http_sendfile($cache->cache)) exit;
14387c86ddaSAndreas Gohr
14487c86ddaSAndreas Gohr        $fp = @fopen($cache->cache,"rb");
14587c86ddaSAndreas Gohr        if($fp){
14687c86ddaSAndreas Gohr            http_rangeRequest($fp,filesize($cache->cache),'application/pdf');
14787c86ddaSAndreas Gohr        }else{
14887c86ddaSAndreas Gohr            header("HTTP/1.0 500 Internal Server Error");
14987c86ddaSAndreas Gohr            print "Could not read file - bad permissions?";
15087c86ddaSAndreas Gohr        }
1511ef68647SAndreas Gohr        exit();
1521ef68647SAndreas Gohr    }
1531ef68647SAndreas Gohr
154d01d2a42SAndreas Gohr
155d01d2a42SAndreas Gohr    /**
1562eedf77dSAndreas Gohr     * Load the various template files and prepare the HTML/CSS for insertion
1571ef68647SAndreas Gohr     */
1581c14c879SAndreas Gohr    protected function load_template($title){
1591ef68647SAndreas Gohr        global $ID;
1601ef68647SAndreas Gohr        global $REV;
1611ef68647SAndreas Gohr        global $conf;
1621c14c879SAndreas Gohr        $tpl = $this->tpl;
1631ef68647SAndreas Gohr
1642eedf77dSAndreas Gohr        // this is what we'll return
1652eedf77dSAndreas Gohr        $output = array(
1662eedf77dSAndreas Gohr            'html'  => '',
1672eedf77dSAndreas Gohr            'css'   => '',
1682eedf77dSAndreas Gohr            'page'  => '',
1692eedf77dSAndreas Gohr            'first' => '',
1702eedf77dSAndreas Gohr            'cite'  => '',
1712eedf77dSAndreas Gohr        );
1722eedf77dSAndreas Gohr
1732eedf77dSAndreas Gohr        // prepare header/footer elements
1742eedf77dSAndreas Gohr        $html = '';
1752eedf77dSAndreas Gohr        foreach(array('header','footer') as $t){
1769e6e41f4SAndreas Gohr            foreach(array('','_odd','_even','_first') as $h){
1772eedf77dSAndreas Gohr                if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html')){
1782eedf77dSAndreas Gohr                    $html .= '<htmlpage'.$t.' name="'.$t.$h.'">'.DOKU_LF;
1792eedf77dSAndreas Gohr                    $html .= file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/'.$t.$h.'.html').DOKU_LF;
1802eedf77dSAndreas Gohr                    $html .= '</htmlpage'.$t.'>'.DOKU_LF;
1812eedf77dSAndreas Gohr
1822eedf77dSAndreas Gohr                    // register the needed pseudo CSS
1839e6e41f4SAndreas Gohr                    if($h == '_first'){
1842eedf77dSAndreas Gohr                        $output['first'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
1852eedf77dSAndreas Gohr                    }elseif($h == '_even'){
1862eedf77dSAndreas Gohr                        $output['page'] .= 'even-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
187daa70883SAndreas Gohr                    }elseif($h == '_odd'){
1882eedf77dSAndreas Gohr                        $output['page'] .= 'odd-'.$t.'-name: html_'.$t.$h.';'.DOKU_LF;
189daa70883SAndreas Gohr                    }else{
190daa70883SAndreas Gohr                        $output['page'] .= $t.': html_'.$t.$h.';'.DOKU_LF;
1912eedf77dSAndreas Gohr                    }
1922eedf77dSAndreas Gohr                }
1932eedf77dSAndreas Gohr            }
1942eedf77dSAndreas Gohr        }
1952eedf77dSAndreas Gohr
1961ef68647SAndreas Gohr        // prepare replacements
1971ef68647SAndreas Gohr        $replace = array(
1981ef68647SAndreas Gohr                '@ID@'      => $ID,
1991ef68647SAndreas Gohr                '@PAGE@'    => '{PAGENO}',
2001ef68647SAndreas Gohr                '@PAGES@'   => '{nb}',
2012eedf77dSAndreas Gohr                '@TITLE@'   => hsc($title),
2021ef68647SAndreas Gohr                '@WIKI@'    => $conf['title'],
2031ef68647SAndreas Gohr                '@WIKIURL@' => DOKU_URL,
2043ae7a8dfSAndreas Gohr                '@UPDATE@'  => dformat(filemtime(wikiFN($ID,$REV))),
2053ae7a8dfSAndreas Gohr                '@PAGEURL@' => wl($ID,($REV)?array('rev'=>$REV):false, true, "&"),
2061ef68647SAndreas Gohr                '@DATE@'    => dformat(time()),
2075d6fbaeaSAndreas Gohr                '@BASE@'    => DOKU_BASE,
2085d6fbaeaSAndreas Gohr                '@TPLBASE@' => DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/',
2091ef68647SAndreas Gohr        );
2101ef68647SAndreas Gohr
2112eedf77dSAndreas Gohr        // set HTML element
2122eedf77dSAndreas Gohr        $output['html'] = str_replace(array_keys($replace), array_values($replace), $html);
2131ef68647SAndreas Gohr
2142eedf77dSAndreas Gohr        // citation box
2152eedf77dSAndreas Gohr        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html')){
2162eedf77dSAndreas Gohr            $output['cite'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/citation.html');
2172eedf77dSAndreas Gohr            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
2182eedf77dSAndreas Gohr        }
2191ef68647SAndreas Gohr
2202eedf77dSAndreas Gohr        // set custom styles
2212eedf77dSAndreas Gohr        if(file_exists(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/style.css')){
2222eedf77dSAndreas Gohr            $output['css'] = file_get_contents(DOKU_PLUGIN.'dw2pdf/tpl/'.$tpl.'/style.css');
2232eedf77dSAndreas Gohr        }
2242eedf77dSAndreas Gohr
2252eedf77dSAndreas Gohr        return $output;
2261ef68647SAndreas Gohr    }
2271ef68647SAndreas Gohr
2281ef68647SAndreas Gohr    /**
2291c14c879SAndreas Gohr     * Load all the style sheets and apply the needed replacements
2301ef68647SAndreas Gohr     */
2311c14c879SAndreas Gohr    protected function load_css(){
2321c14c879SAndreas Gohr        //reusue the CSS dispatcher functions without triggering the main function
2331c14c879SAndreas Gohr        define('SIMPLE_TEST',1);
2341c14c879SAndreas Gohr        require_once(DOKU_INC.'lib/exe/css.php');
235ee19bac3SLuigi Micco
2361c14c879SAndreas Gohr        // prepare CSS files
2371c14c879SAndreas Gohr        $files = array_merge(
2381c14c879SAndreas Gohr                    array(
2391c14c879SAndreas Gohr                        DOKU_INC.'lib/styles/screen.css'
2401c14c879SAndreas Gohr                            => DOKU_BASE.'lib/styles/',
2411c14c879SAndreas Gohr                        DOKU_INC.'lib/styles/print.css'
2421c14c879SAndreas Gohr                            => DOKU_BASE.'lib/styles/',
2431c14c879SAndreas Gohr                    ),
2441c14c879SAndreas Gohr                    css_pluginstyles('all'),
24558e6409eSAndreas Gohr                    $this->css_pluginPDFstyles(),
2461c14c879SAndreas Gohr                    array(
2471c14c879SAndreas Gohr                        DOKU_PLUGIN.'dw2pdf/conf/style.css'
2481c14c879SAndreas Gohr                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
2491c14c879SAndreas Gohr                        DOKU_PLUGIN.'dw2pdf/tpl/'.$this->tpl.'/style.css'
2501c14c879SAndreas Gohr                            => DOKU_BASE.'lib/plugins/dw2pdf/tpl/'.$this->tpl.'/',
2511c14c879SAndreas Gohr                        DOKU_PLUGIN.'dw2pdf/conf/style.local.css'
2521c14c879SAndreas Gohr                            => DOKU_BASE.'lib/plugins/dw2pdf/conf/',
2531c14c879SAndreas Gohr                    )
2541c14c879SAndreas Gohr                 );
2551c14c879SAndreas Gohr        $css = '';
2561c14c879SAndreas Gohr        foreach($files as $file => $location){
2571c14c879SAndreas Gohr            $css .= css_loadfile($file, $location);
2581ef68647SAndreas Gohr        }
2591ef68647SAndreas Gohr
2601c14c879SAndreas Gohr        // apply pattern replacements
2611c14c879SAndreas Gohr        $css = css_applystyle($css,DOKU_INC.'lib/tpl/'.$conf['template'].'/');
2621ef68647SAndreas Gohr
2631c14c879SAndreas Gohr        return $css;
264ee19bac3SLuigi Micco    }
2651c14c879SAndreas Gohr
26658e6409eSAndreas Gohr
26758e6409eSAndreas Gohr    /**
26858e6409eSAndreas Gohr     * Returns a list of possible Plugin PDF Styles
26958e6409eSAndreas Gohr     *
27058e6409eSAndreas Gohr     * Checks for a pdf.css, falls back to print.css
27158e6409eSAndreas Gohr     *
27258e6409eSAndreas Gohr     * @author Andreas Gohr <andi@splitbrain.org>
27358e6409eSAndreas Gohr     */
27458e6409eSAndreas Gohr    function css_pluginPDFstyles(){
27558e6409eSAndreas Gohr        global $lang;
27658e6409eSAndreas Gohr        $list = array();
27758e6409eSAndreas Gohr        $plugins = plugin_list();
278*f54b51f7SAndreas Gohr
279*f54b51f7SAndreas Gohr        $usestyle = explode(',',$this->getConf('usestyles'));
28058e6409eSAndreas Gohr        foreach ($plugins as $p){
281*f54b51f7SAndreas Gohr            if(in_array($p,$usestyle)){
282*f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN."$p/screen.css"] = DOKU_BASE."lib/plugins/$p/";
283*f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN."$p/style.css"] = DOKU_BASE."lib/plugins/$p/";
284*f54b51f7SAndreas Gohr            }
285*f54b51f7SAndreas Gohr
28658e6409eSAndreas Gohr            if(file_exists(DOKU_PLUGIN."$p/pdf.css")){
28758e6409eSAndreas Gohr                $list[DOKU_PLUGIN."$p/pdf.css"] = DOKU_BASE."lib/plugins/$p/";
28858e6409eSAndreas Gohr            }else{
28958e6409eSAndreas Gohr                $list[DOKU_PLUGIN."$p/print.css"] = DOKU_BASE."lib/plugins/$p/";
29058e6409eSAndreas Gohr            }
29158e6409eSAndreas Gohr        }
29258e6409eSAndreas Gohr        return $list;
29358e6409eSAndreas Gohr    }
29458e6409eSAndreas Gohr
295ee19bac3SLuigi Micco}
296