xref: /plugin/dw2pdf/action.php (revision 4c493e449877723b55db5e8d5af0df60046d0fbe)
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 Micco
130639157eSGerrit Uitslag/**
140639157eSGerrit Uitslag * Class action_plugin_dw2pdf
150639157eSGerrit Uitslag *
160639157eSGerrit Uitslag * Export hmtl content to pdf, for different url parameter configurations
170639157eSGerrit Uitslag * DokuPDF which extends mPDF is used for generating the pdf from html.
180639157eSGerrit Uitslag */
191ef68647SAndreas Gohrclass action_plugin_dw2pdf extends DokuWiki_Action_Plugin {
2002f9a447SGerrit Uitslag    /**
2102f9a447SGerrit Uitslag     * Settings for current export, collected from url param, plugin config, global config
2202f9a447SGerrit Uitslag     *
2302f9a447SGerrit Uitslag     * @var array
2402f9a447SGerrit Uitslag     */
25213fdb75SGerrit Uitslag    protected $exportConfig = null;
2660e59de7SGerrit Uitslag    protected $tpl;
2703352761SKirsten Roschanski    protected $title;
2860e59de7SGerrit Uitslag    protected $list = array();
291c14c879SAndreas Gohr
301c14c879SAndreas Gohr    /**
311c14c879SAndreas Gohr     * Constructor. Sets the correct template
3203352761SKirsten Roschanski     *
3303352761SKirsten Roschanski     * @param string $title
341c14c879SAndreas Gohr     */
3503352761SKirsten Roschanski    public function __construct($title=null) {
3602f9a447SGerrit Uitslag        $this->tpl   = $this->getExportConfig('template');
3703352761SKirsten Roschanski        $this->title = $title ? $title : '';
381c14c879SAndreas Gohr    }
391c14c879SAndreas Gohr
40ee19bac3SLuigi Micco    /**
41ee19bac3SLuigi Micco     * Register the events
42177a7d30SGerrit Uitslag     *
43177a7d30SGerrit Uitslag     * @param Doku_Event_Handler $controller
44ee19bac3SLuigi Micco     */
456be736bfSGerrit Uitslag    public function register(Doku_Event_Handler $controller) {
46ee19bac3SLuigi Micco        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'convert', array());
476be736bfSGerrit Uitslag        $controller->register_hook('TEMPLATE_PAGETOOLS_DISPLAY', 'BEFORE', $this, 'addbutton', array());
48026b594bSAndreas Gohr        $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'addsvgbutton', array());
49ee19bac3SLuigi Micco    }
50ee19bac3SLuigi Micco
511c14c879SAndreas Gohr    /**
521c14c879SAndreas Gohr     * Do the HTML to PDF conversion work
53737417c6SKlap-in     *
54737417c6SKlap-in     * @param Doku_Event $event
55737417c6SKlap-in     * @return bool
561c14c879SAndreas Gohr     */
5744e8e8fbSGerrit Uitslag    public function convert(Doku_Event $event) {
58ee19bac3SLuigi Micco        global $ID;
5927195d5bSMichael Große        global $REV, $DATE_AT, $conf;
60ee19bac3SLuigi Micco
611ef68647SAndreas Gohr        // our event?
6252738244SLarsDW223        if(($event->data != 'export_pdfbook') && ($event->data != 'export_pdf') && ($event->data != 'export_pdfns')) return false;
63ee19bac3SLuigi Micco
641ef68647SAndreas Gohr        // check user's rights
651ef68647SAndreas Gohr        if(auth_quickaclcheck($ID) < AUTH_READ) return false;
661ef68647SAndreas Gohr
67d63e7fe7SGerrit Uitslag        if($data = $this->collectExportPages($event)) {
6803352761SKirsten Roschanski            list($this->title, $this->list) = $data;
69d63e7fe7SGerrit Uitslag        } else {
70d63e7fe7SGerrit Uitslag            return false;
71d63e7fe7SGerrit Uitslag        }
72d63e7fe7SGerrit Uitslag
73d63e7fe7SGerrit Uitslag        // it's ours, no one else's
74d63e7fe7SGerrit Uitslag        $event->preventDefault();
75d63e7fe7SGerrit Uitslag
7627195d5bSMichael Große        if ($ACT === 'export_pdf' && ($REV || $DATE_AT)) {
7727195d5bSMichael Große            $tempFilename = tempnam($conf['tmpdir'], 'dw2pdf_');
78f00df45eSMichael Große            $generateNewPdf = true;
7927d48100SMichael Große            $isTempFile = true;
80f00df45eSMichael Große        } else {
81a58f45f0SGerrit Uitslag            // prepare cache and its dependencies
82a58f45f0SGerrit Uitslag            $depends = array();
8303352761SKirsten Roschanski            $cache = $this->prepareCache($depends);
84f00df45eSMichael Große            $tempFilename = $cache->cache;
8527195d5bSMichael Große            $generateNewPdf = !$this->getConf('usecache')
8627195d5bSMichael Große                || $this->getExportConfig('isDebug')
8727195d5bSMichael Große                || !$cache->useCache($depends);
8827d48100SMichael Große            $isTempFile = false;
89f00df45eSMichael Große        }
90d63e7fe7SGerrit Uitslag
91bd977188SGerrit Uitslag        // hard work only when no cache available or needed for debugging
92f00df45eSMichael Große        if($generateNewPdf) {
93e5f6c2cbSMichael Große            // generating the pdf may take a long time for larger wikis / namespaces with many pages
94e5f6c2cbSMichael Große            set_time_limit(0);
95b34cb34eSSzymon Olewniczak            try {
96f00df45eSMichael Große                $this->generatePDF($tempFilename);
97b34cb34eSSzymon Olewniczak            } catch (Mpdf\MpdfException $e) {
98b34cb34eSSzymon Olewniczak                //prevent act_export()
99b34cb34eSSzymon Olewniczak                $ACT = 'show';
100b34cb34eSSzymon Olewniczak                msg($e->getMessage(), -1);
101b34cb34eSSzymon Olewniczak                return false;
102b34cb34eSSzymon Olewniczak            }
103e5f6c2cbSMichael Große
104d63e7fe7SGerrit Uitslag        }
105d63e7fe7SGerrit Uitslag
106d63e7fe7SGerrit Uitslag        // deliver the file
107f00df45eSMichael Große        $this->sendPDFFile($tempFilename);
10827d48100SMichael Große        if ($isTempFile) {
10927d48100SMichael Große            unlink($tempFilename);
11027d48100SMichael Große        }
111d63e7fe7SGerrit Uitslag        return true;
112d63e7fe7SGerrit Uitslag    }
113d63e7fe7SGerrit Uitslag
114d63e7fe7SGerrit Uitslag    /**
115d63e7fe7SGerrit Uitslag     * Obtain list of pages and title, based on url parameters
116d63e7fe7SGerrit Uitslag     *
117d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
118d63e7fe7SGerrit Uitslag     * @return string|bool
119d63e7fe7SGerrit Uitslag     */
120d63e7fe7SGerrit Uitslag    protected function collectExportPages(Doku_Event $event) {
121d63e7fe7SGerrit Uitslag        global $ID;
122d63e7fe7SGerrit Uitslag        global $INPUT;
123d63e7fe7SGerrit Uitslag        global $conf;
124d63e7fe7SGerrit Uitslag
125d63e7fe7SGerrit Uitslag        // list of one or multiple pages
126d63e7fe7SGerrit Uitslag        $list = array();
12728e636eaSGerrit Uitslag
1284b4cebc2SLarsDW223        if($event->data == 'export_pdf') {
129d63e7fe7SGerrit Uitslag            $list[0] = $ID;
13003352761SKirsten Roschanski            $this->title = $INPUT->str('pdftitle'); //DEPRECATED
13103352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
13203352761SKirsten Roschanski            if(empty($this->title)) {
13303352761SKirsten Roschanski                $this->title = p_get_first_heading($ID);
13415923cb9SGerrit Uitslag            }
135ad18f4e1SGerrit Uitslag
1364b4cebc2SLarsDW223        } elseif($event->data == 'export_pdfns') {
137ad18f4e1SGerrit Uitslag            //check input for title and ns
13803352761SKirsten Roschanski            if(!$this->title = $INPUT->str('book_title')) {
13926be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
140ad18f4e1SGerrit Uitslag                return false;
141ad18f4e1SGerrit Uitslag            }
142177a7d30SGerrit Uitslag            $pdfnamespace = cleanID($INPUT->str('book_ns'));
143ad18f4e1SGerrit Uitslag            if(!@is_dir(dirname(wikiFN($pdfnamespace . ':dummy')))) {
14426be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needns');
145ad18f4e1SGerrit Uitslag                return false;
146ad18f4e1SGerrit Uitslag            }
147ad18f4e1SGerrit Uitslag
14826be4eceSGerrit Uitslag            //sort order
149177a7d30SGerrit Uitslag            $order = $INPUT->str('book_order', 'natural', true);
150ad18f4e1SGerrit Uitslag            $sortoptions = array('pagename', 'date', 'natural');
151ad18f4e1SGerrit Uitslag            if(!in_array($order, $sortoptions)) {
152ad18f4e1SGerrit Uitslag                $order = 'natural';
153ad18f4e1SGerrit Uitslag            }
154ad18f4e1SGerrit Uitslag
15526be4eceSGerrit Uitslag            //search depth
156177a7d30SGerrit Uitslag            $depth = $INPUT->int('book_nsdepth', 0);
157ad18f4e1SGerrit Uitslag            if($depth < 0) {
158ad18f4e1SGerrit Uitslag                $depth = 0;
159ad18f4e1SGerrit Uitslag            }
16026be4eceSGerrit Uitslag
161ad18f4e1SGerrit Uitslag            //page search
162ad18f4e1SGerrit Uitslag            $result = array();
163ad18f4e1SGerrit Uitslag            $opts = array('depth' => $depth); //recursive all levels
164ad18f4e1SGerrit Uitslag            $dir = utf8_encodeFN(str_replace(':', '/', $pdfnamespace));
165ad18f4e1SGerrit Uitslag            search($result, $conf['datadir'], 'search_allpages', $opts, $dir);
166ad18f4e1SGerrit Uitslag
16726be4eceSGerrit Uitslag            //sorting
168ad18f4e1SGerrit Uitslag            if(count($result) > 0) {
169ad18f4e1SGerrit Uitslag                if($order == 'date') {
170ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_datesort'));
171ad18f4e1SGerrit Uitslag                } elseif($order == 'pagename') {
172ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_pagenamesort'));
173ad18f4e1SGerrit Uitslag                }
174ad18f4e1SGerrit Uitslag            }
175ad18f4e1SGerrit Uitslag
176ad18f4e1SGerrit Uitslag            foreach($result as $item) {
177d63e7fe7SGerrit Uitslag                $list[] = $item['id'];
178ad18f4e1SGerrit Uitslag            }
179ad18f4e1SGerrit Uitslag
180baa31dc5SGerrit Uitslag            if ($pdfnamespace !== '') {
181baa31dc5SGerrit Uitslag                if (!in_array($pdfnamespace . ':' . $conf['start'], $list, true)) {
182baa31dc5SGerrit Uitslag                    if (file_exists(wikiFN(rtrim($pdfnamespace,':')))) {
183baa31dc5SGerrit Uitslag                        array_unshift($list,rtrim($pdfnamespace,':'));
184baa31dc5SGerrit Uitslag                    }
185baa31dc5SGerrit Uitslag                }
186baa31dc5SGerrit Uitslag            }
187baa31dc5SGerrit Uitslag
188737417c6SKlap-in        } elseif(isset($_COOKIE['list-pagelist']) && !empty($_COOKIE['list-pagelist'])) {
189b3eed6e3SGerrit Uitslag            /** @deprecated  April 2016 replaced by localStorage version of Bookcreator*/
19026be4eceSGerrit Uitslag            //is in Bookmanager of bookcreator plugin a title given?
19103352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
19203352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
19303352761SKirsten Roschanski            if(empty($this->title)) {
19426be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
195737417c6SKlap-in                return false;
19626be4eceSGerrit Uitslag            } else {
197d63e7fe7SGerrit Uitslag                $list = explode("|", $_COOKIE['list-pagelist']);
19826be4eceSGerrit Uitslag            }
199ad18f4e1SGerrit Uitslag
200b3eed6e3SGerrit Uitslag        } elseif($INPUT->has('selection')) {
201b3eed6e3SGerrit Uitslag            //handle Bookcreator requests based at localStorage
202b3eed6e3SGerrit Uitslag//            if(!checkSecurityToken()) {
203b3eed6e3SGerrit Uitslag//                http_status(403);
204b3eed6e3SGerrit Uitslag//                print $this->getLang('empty');
205b3eed6e3SGerrit Uitslag//                exit();
206b3eed6e3SGerrit Uitslag//            }
207b3eed6e3SGerrit Uitslag
208b3eed6e3SGerrit Uitslag            $json = new JSON(JSON_LOOSE_TYPE);
209b3eed6e3SGerrit Uitslag            $list = $json->decode($INPUT->post->str('selection', '', true));
210b3eed6e3SGerrit Uitslag            if(!is_array($list) || empty($list)) {
211b3eed6e3SGerrit Uitslag                http_status(400);
212b3eed6e3SGerrit Uitslag                print $this->getLang('empty');
213b3eed6e3SGerrit Uitslag                exit();
214b3eed6e3SGerrit Uitslag            }
215b3eed6e3SGerrit Uitslag
21603352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
21703352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
21803352761SKirsten Roschanski            if(empty($this->title)) {
219b3eed6e3SGerrit Uitslag                http_status(400);
220b3eed6e3SGerrit Uitslag                print $this->getLang('needtitle');
221b3eed6e3SGerrit Uitslag                exit();
222b3eed6e3SGerrit Uitslag            }
223b3eed6e3SGerrit Uitslag
224737417c6SKlap-in        } else {
22526be4eceSGerrit Uitslag            //show empty bookcreator message
22626be4eceSGerrit Uitslag            $this->showPageWithErrorMsg($event, 'empty');
227737417c6SKlap-in            return false;
228737417c6SKlap-in        }
229737417c6SKlap-in
230719256adSGerrit Uitslag        $list = array_map('cleanID', $list);
231c7138b3fSGerrit Uitslag
232c7138b3fSGerrit Uitslag        $skippedpages = array();
233c7138b3fSGerrit Uitslag        foreach($list as $index => $pageid) {
234c7138b3fSGerrit Uitslag            if(auth_quickaclcheck($pageid) < AUTH_READ) {
235c7138b3fSGerrit Uitslag                $skippedpages[] = $pageid;
236c7138b3fSGerrit Uitslag                unset($list[$index]);
237c7138b3fSGerrit Uitslag            }
238c7138b3fSGerrit Uitslag        }
239c7138b3fSGerrit Uitslag        $list = array_filter($list); //removes also pages mentioned '0'
240c7138b3fSGerrit Uitslag
241c7138b3fSGerrit Uitslag        //if selection contains forbidden pages throw (overridable) warning
242c7138b3fSGerrit Uitslag        if(!$INPUT->bool('book_skipforbiddenpages') && !empty($skippedpages)) {
243c7138b3fSGerrit Uitslag            $msg = hsc(join(', ', $skippedpages));
244c7138b3fSGerrit Uitslag            if($INPUT->has('selection')) {
245c7138b3fSGerrit Uitslag                http_status(400);
246c7138b3fSGerrit Uitslag                print sprintf($this->getLang('forbidden'), $msg);
247c7138b3fSGerrit Uitslag                exit();
248c7138b3fSGerrit Uitslag            } else {
249c7138b3fSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'forbidden', $msg);
250c7138b3fSGerrit Uitslag                return false;
251c7138b3fSGerrit Uitslag            }
252c7138b3fSGerrit Uitslag
253c7138b3fSGerrit Uitslag        }
254c7138b3fSGerrit Uitslag
25503352761SKirsten Roschanski        return array($this->title, $list);
256d63e7fe7SGerrit Uitslag    }
257d63e7fe7SGerrit Uitslag
258a58f45f0SGerrit Uitslag    /**
259a58f45f0SGerrit Uitslag     * Prepare cache
260a58f45f0SGerrit Uitslag     *
261a58f45f0SGerrit Uitslag     * @param array  $depends (reference) array with dependencies
262a58f45f0SGerrit Uitslag     * @return cache
263a58f45f0SGerrit Uitslag     */
26403352761SKirsten Roschanski    protected function prepareCache(&$depends) {
265a58f45f0SGerrit Uitslag        global $REV;
266a58f45f0SGerrit Uitslag
267ee19bac3SLuigi Micco        $cachekey = join(',', $this->list)
268ee19bac3SLuigi Micco            . $REV
269ee19bac3SLuigi Micco            . $this->getExportConfig('template')
270ee19bac3SLuigi Micco            . $this->getExportConfig('pagesize')
271ee19bac3SLuigi Micco            . $this->getExportConfig('orientation')
272d83760efSGerrit Uitslag            . $this->getExportConfig('font-size')
273ee19bac3SLuigi Micco            . $this->getExportConfig('doublesided')
274ee19bac3SLuigi Micco            . ($this->getExportConfig('hasToC') ? join('-', $this->getExportConfig('levels')) : '0')
27503352761SKirsten Roschanski            . $this->title;
276ee19bac3SLuigi Micco        $cache = new cache($cachekey, '.dw2.pdf');
277ee19bac3SLuigi Micco
278ee19bac3SLuigi Micco        $dependencies = array();
279ee19bac3SLuigi Micco        foreach($this->list as $pageid) {
280ee19bac3SLuigi Micco            $relations = p_get_metadata($pageid, 'relation');
281ee19bac3SLuigi Micco
282ee19bac3SLuigi Micco            if(is_array($relations)) {
283ee19bac3SLuigi Micco                if(array_key_exists('media', $relations) && is_array($relations['media'])) {
284ee19bac3SLuigi Micco                    foreach($relations['media'] as $mediaid => $exists) {
285ee19bac3SLuigi Micco                        if($exists) {
286ee19bac3SLuigi Micco                            $dependencies[] = mediaFN($mediaid);
287ee19bac3SLuigi Micco                        }
288ee19bac3SLuigi Micco                    }
289ee19bac3SLuigi Micco                }
290ee19bac3SLuigi Micco
291ee19bac3SLuigi Micco                if(array_key_exists('haspart', $relations) && is_array($relations['haspart'])) {
292ee19bac3SLuigi Micco                    foreach($relations['haspart'] as $part_pageid => $exists) {
293ee19bac3SLuigi Micco                        if($exists) {
294ee19bac3SLuigi Micco                            $dependencies[] = wikiFN($part_pageid);
295ee19bac3SLuigi Micco                        }
296ee19bac3SLuigi Micco                    }
297ee19bac3SLuigi Micco                }
298ee19bac3SLuigi Micco            }
299ee19bac3SLuigi Micco
300ee19bac3SLuigi Micco            $dependencies[] = metaFN($pageid, '.meta');
301ee19bac3SLuigi Micco        }
302ee19bac3SLuigi Micco
303ee19bac3SLuigi Micco        $depends['files'] = array_map('wikiFN', $this->list);
304ee19bac3SLuigi Micco        $depends['files'][] = __FILE__;
305ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/renderer.php';
306ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/mpdf/mpdf.php';
307ee19bac3SLuigi Micco        $depends['files'] = array_merge(
308ee19bac3SLuigi Micco            $depends['files'],
309ee19bac3SLuigi Micco            $dependencies,
310ee19bac3SLuigi Micco            getConfigFiles('main')
311ee19bac3SLuigi Micco        );
312a58f45f0SGerrit Uitslag        return $cache;
313ee19bac3SLuigi Micco    }
314ee19bac3SLuigi Micco
315d63e7fe7SGerrit Uitslag    /**
316d63e7fe7SGerrit Uitslag     * Set error notification and reload page again
317d63e7fe7SGerrit Uitslag     *
318d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
319d63e7fe7SGerrit Uitslag     * @param string $msglangkey key of translation key
320c7138b3fSGerrit Uitslag     * @param string $replacement
321d63e7fe7SGerrit Uitslag     */
322c7138b3fSGerrit Uitslag    private function showPageWithErrorMsg(Doku_Event $event, $msglangkey, $replacement=null) {
323c7138b3fSGerrit Uitslag        if(empty($replacement)) {
324c7138b3fSGerrit Uitslag            $msg = $this->getLang($msglangkey);
325c7138b3fSGerrit Uitslag        } else {
326c7138b3fSGerrit Uitslag            $msg = sprintf($this->getLang($msglangkey), $replacement);
327c7138b3fSGerrit Uitslag        }
328c7138b3fSGerrit Uitslag        msg($msg, -1);
329d63e7fe7SGerrit Uitslag
330d63e7fe7SGerrit Uitslag        $event->data = 'show';
331d63e7fe7SGerrit Uitslag        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
332d63e7fe7SGerrit Uitslag    }
333d63e7fe7SGerrit Uitslag
334d63e7fe7SGerrit Uitslag    /**
335e53f1ec0SSzymon Olewniczak     * Returns the parsed Wikitext in dw2pdf for the given id and revision
336e53f1ec0SSzymon Olewniczak     *
337e53f1ec0SSzymon Olewniczak     * @param string     $id  page id
338e53f1ec0SSzymon Olewniczak     * @param string|int $rev revision timestamp or empty string
339e53f1ec0SSzymon Olewniczak     * @param string     $date_at
340e53f1ec0SSzymon Olewniczak     * @return null|string
341e53f1ec0SSzymon Olewniczak     */
342e53f1ec0SSzymon Olewniczak    protected function p_wiki_dw2pdf($id, $rev = '', $date_at = '') {
343e53f1ec0SSzymon Olewniczak        $file = wikiFN($id, $rev);
344e53f1ec0SSzymon Olewniczak
345e53f1ec0SSzymon Olewniczak        if(!file_exists($file)) return '';
346e53f1ec0SSzymon Olewniczak
347e53f1ec0SSzymon Olewniczak        //ensure $id is in global $ID (needed for parsing)
348e53f1ec0SSzymon Olewniczak        global $ID;
349e53f1ec0SSzymon Olewniczak        $keep = $ID;
350e53f1ec0SSzymon Olewniczak        $ID   = $id;
351e53f1ec0SSzymon Olewniczak
352e53f1ec0SSzymon Olewniczak        $ret  = '';
353e53f1ec0SSzymon Olewniczak
354e53f1ec0SSzymon Olewniczak        if($rev || $date_at) {
355e53f1ec0SSzymon Olewniczak            $ret = p_render('dw2pdf', p_get_instructions(io_readWikiPage($file, $id, $rev)), $info, $date_at); //no caching on old revisions
356e53f1ec0SSzymon Olewniczak        } else {
357e53f1ec0SSzymon Olewniczak            $ret = p_cached_output($file, 'dw2pdf', $id);
358e53f1ec0SSzymon Olewniczak        }
359e53f1ec0SSzymon Olewniczak
360e53f1ec0SSzymon Olewniczak        //restore ID (just in case)
361e53f1ec0SSzymon Olewniczak        $ID = $keep;
362e53f1ec0SSzymon Olewniczak
363e53f1ec0SSzymon Olewniczak        return $ret;
364e53f1ec0SSzymon Olewniczak    }
365e53f1ec0SSzymon Olewniczak
366e53f1ec0SSzymon Olewniczak    /**
367d63e7fe7SGerrit Uitslag     * Build a pdf from the html
368d63e7fe7SGerrit Uitslag     *
369d63e7fe7SGerrit Uitslag     * @param string $cachefile
370d63e7fe7SGerrit Uitslag     */
37103352761SKirsten Roschanski    protected function generatePDF($cachefile) {
372e53f1ec0SSzymon Olewniczak        global $ID, $REV, $INPUT, $DATE_AT, $ACT;
373e53f1ec0SSzymon Olewniczak
374e53f1ec0SSzymon Olewniczak        if ($ACT == 'export_pdf') { //only one page is exported
375e53f1ec0SSzymon Olewniczak            $rev = $REV;
376e53f1ec0SSzymon Olewniczak            $date_at = $DATE_AT;
377e53f1ec0SSzymon Olewniczak        } else { //we are exporting entre namespace, ommit revisions
378e53f1ec0SSzymon Olewniczak            $rev = $date_at = '';
379e53f1ec0SSzymon Olewniczak        }
38087c86ddaSAndreas Gohr
38102f9a447SGerrit Uitslag        //some shortcuts to export settings
38202f9a447SGerrit Uitslag        $hasToC = $this->getExportConfig('hasToC');
38302f9a447SGerrit Uitslag        $levels = $this->getExportConfig('levels');
38402f9a447SGerrit Uitslag        $isDebug = $this->getExportConfig('isDebug');
3856ea88a05SAndreas Gohr
3861ef68647SAndreas Gohr        // initialize PDF library
387cde5a1b3SAndreas Gohr        require_once(dirname(__FILE__) . "/DokuPDF.class.php");
3886ea88a05SAndreas Gohr
3894870b378SLarsDW223        $mpdf = new DokuPDF($this->getExportConfig('pagesize'),
3904870b378SLarsDW223                            $this->getExportConfig('orientation'),
3914870b378SLarsDW223                            $this->getExportConfig('font-size'));
392ee19bac3SLuigi Micco
393d62df65bSAndreas Gohr        // let mpdf fix local links
394d62df65bSAndreas Gohr        $self = parse_url(DOKU_URL);
395d62df65bSAndreas Gohr        $url = $self['scheme'] . '://' . $self['host'];
39602f9a447SGerrit Uitslag        if($self['port']) {
39702f9a447SGerrit Uitslag            $url .= ':' . $self['port'];
39802f9a447SGerrit Uitslag        }
399d62df65bSAndreas Gohr        $mpdf->setBasePath($url);
400d62df65bSAndreas Gohr
40156d13144SAndreas Gohr        // Set the title
40203352761SKirsten Roschanski        $mpdf->SetTitle($this->title);
40356d13144SAndreas Gohr
404d63e7fe7SGerrit Uitslag        // some default document settings
405d63e7fe7SGerrit Uitslag        //note: double-sided document, starts at an odd page (first page is a right-hand side page)
406213fdb75SGerrit Uitslag        //      single-side document has only odd pages
407213fdb75SGerrit Uitslag        $mpdf->mirrorMargins = $this->getExportConfig('doublesided');
408daa70883SAndreas Gohr        $mpdf->setAutoTopMargin = 'stretch';
409daa70883SAndreas Gohr        $mpdf->setAutoBottomMargin = 'stretch';
41002f9a447SGerrit Uitslag//            $mpdf->pagenumSuffix = '/'; //prefix for {nbpg}
41102f9a447SGerrit Uitslag        if($hasToC) {
41202f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => 'i', 'suppress' => 'off'); //use italic pageno until ToC
41302f9a447SGerrit Uitslag            $mpdf->h2toc = $levels;
41402f9a447SGerrit Uitslag        } else {
41502f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => '1', 'suppress' => 'off');
41602f9a447SGerrit Uitslag        }
4172eedf77dSAndreas Gohr
41856d13144SAndreas Gohr        // load the template
41903352761SKirsten Roschanski        $template = $this->load_template();
420ee19bac3SLuigi Micco
4211ef68647SAndreas Gohr        // prepare HTML header styles
422a2c33768SGerrit Uitslag        $html = '';
42302f9a447SGerrit Uitslag        if($isDebug) {
424a2c33768SGerrit Uitslag            $html .= '<html><head>';
425737417c6SKlap-in            $html .= '<style type="text/css">';
426a2c33768SGerrit Uitslag        }
427db1aa1bfSKirsten Roschanski
428db1aa1bfSKirsten Roschanski        $styles = '@page { size:auto; ' . $template['page'] . '}';
429a2c33768SGerrit Uitslag        $styles .= '@page :first {' . $template['first'] . '}';
430254467c4SGerrit Uitslag
431254467c4SGerrit Uitslag        $styles .= '@page landscape-page { size:landscape }';
432254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-landscape { page:landscape-page }';
433254467c4SGerrit Uitslag        $styles .= '@page portrait-page { size:portrait }';
434254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-portrait { page:portrait-page }';
435db1aa1bfSKirsten Roschanski        $styles .= $this->load_css();
436254467c4SGerrit Uitslag
437a2c33768SGerrit Uitslag        $mpdf->WriteHTML($styles, 1);
438a2c33768SGerrit Uitslag
43902f9a447SGerrit Uitslag        if($isDebug) {
440a2c33768SGerrit Uitslag            $html .= $styles;
4411ef68647SAndreas Gohr            $html .= '</style>';
4421ef68647SAndreas Gohr            $html .= '</head><body>';
443a2c33768SGerrit Uitslag        }
444a2c33768SGerrit Uitslag
445a2c33768SGerrit Uitslag        $body_start = $template['html'];
446a2c33768SGerrit Uitslag        $body_start .= '<div class="dokuwiki">';
4472eedf77dSAndreas Gohr
4481e45476bSmnapp        // insert the cover page
449a2c33768SGerrit Uitslag        $body_start .= $template['cover'];
450a2c33768SGerrit Uitslag
451a2c33768SGerrit Uitslag        $mpdf->WriteHTML($body_start, 2, true, false); //start body html
45202f9a447SGerrit Uitslag        if($isDebug) {
453a2c33768SGerrit Uitslag            $html .= $body_start;
454a2c33768SGerrit Uitslag        }
45502f9a447SGerrit Uitslag        if($hasToC) {
45602f9a447SGerrit Uitslag            //Note: - for double-sided document the ToC is always on an even number of pages, so that the following content is on a correct odd/even page
45702f9a447SGerrit Uitslag            //      - first page of ToC starts always at odd page (so eventually an additional blank page is included before)
45802f9a447SGerrit Uitslag            //      - there is no page numbering at the pages of the ToC
45902f9a447SGerrit Uitslag            $mpdf->TOCpagebreakByArray(
46002f9a447SGerrit Uitslag                array(
461230b098dSGerrit Uitslag                    'toc-preHTML' => '<h2>' . $this->getLang('tocheader') . '</h2>',
462230b098dSGerrit Uitslag                    'toc-bookmarkText' => $this->getLang('tocheader'),
46302f9a447SGerrit Uitslag                    'links' => true,
46402f9a447SGerrit Uitslag                    'outdent' => '1em',
46502f9a447SGerrit Uitslag                    'resetpagenum' => true, //start pagenumbering after ToC
46602f9a447SGerrit Uitslag                    'pagenumstyle' => '1'
46702f9a447SGerrit Uitslag                )
46802f9a447SGerrit Uitslag            );
46902f9a447SGerrit Uitslag            $html .= '<tocpagebreak>';
47002f9a447SGerrit Uitslag        }
47102f9a447SGerrit Uitslag
4721ef68647SAndreas Gohr        // loop over all pages
473c7138b3fSGerrit Uitslag        $counter = 0;
474c7138b3fSGerrit Uitslag        $no_pages = count($this->list);
475c7138b3fSGerrit Uitslag        foreach($this->list as $page) {
476c7138b3fSGerrit Uitslag            $counter++;
477b3eed6e3SGerrit Uitslag
47879be256fSMichael Große            $pagehtml = $this->p_wiki_dw2pdf($page, $rev, $date_at);
479e53f1ec0SSzymon Olewniczak            //file doesn't exists
480e53f1ec0SSzymon Olewniczak            if($pagehtml == '') {
481b3eed6e3SGerrit Uitslag                continue;
482b3eed6e3SGerrit Uitslag            }
483719256adSGerrit Uitslag            $pagehtml .= $this->page_depend_replacements($template['cite'], $page);
484c7138b3fSGerrit Uitslag            if($counter < $no_pages) {
485a2c33768SGerrit Uitslag                $pagehtml .= '<pagebreak />';
486a2c33768SGerrit Uitslag            }
487a2c33768SGerrit Uitslag
488a2c33768SGerrit Uitslag            $mpdf->WriteHTML($pagehtml, 2, false, false); //intermediate body html
48902f9a447SGerrit Uitslag            if($isDebug) {
490a2c33768SGerrit Uitslag                $html .= $pagehtml;
4911ef68647SAndreas Gohr            }
492ee19bac3SLuigi Micco        }
493ee19bac3SLuigi Micco
49433c15297SGerrit Uitslag        // insert the back page
495a2c33768SGerrit Uitslag        $body_end = $template['back'];
49633c15297SGerrit Uitslag
497a2c33768SGerrit Uitslag        $body_end .= '</div>';
498a2c33768SGerrit Uitslag
499d63e7fe7SGerrit Uitslag        $mpdf->WriteHTML($body_end, 2, false, true); // finish body html
50002f9a447SGerrit Uitslag        if($isDebug) {
501a2c33768SGerrit Uitslag            $html .= $body_end;
502eeb17e15SAndreas Gohr            $html .= '</body>';
503eeb17e15SAndreas Gohr            $html .= '</html>';
504a2c33768SGerrit Uitslag        }
505f765508eSGerrit Uitslag
506f765508eSGerrit Uitslag        //Return html for debugging
50702f9a447SGerrit Uitslag        if($isDebug) {
50802f9a447SGerrit Uitslag            if($INPUT->str('debughtml', 'text', true) == 'html') {
50926be4eceSGerrit Uitslag                echo $html;
510a2c33768SGerrit Uitslag            } else {
511a2c33768SGerrit Uitslag                header('Content-Type: text/plain; charset=utf-8');
512a2c33768SGerrit Uitslag                echo $html;
513a2c33768SGerrit Uitslag            }
51426be4eceSGerrit Uitslag            exit();
51526be4eceSGerrit Uitslag        };
516f765508eSGerrit Uitslag
51787c86ddaSAndreas Gohr        // write to cache file
518d63e7fe7SGerrit Uitslag        $mpdf->Output($cachefile, 'F');
51987c86ddaSAndreas Gohr    }
52087c86ddaSAndreas Gohr
521d63e7fe7SGerrit Uitslag    /**
522d63e7fe7SGerrit Uitslag     * @param string $cachefile
523d63e7fe7SGerrit Uitslag     */
52403352761SKirsten Roschanski    protected function sendPDFFile($cachefile) {
52587c86ddaSAndreas Gohr        header('Content-Type: application/pdf');
526b853b723SAndreas Gohr        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
52787c86ddaSAndreas Gohr        header('Pragma: public');
528d63e7fe7SGerrit Uitslag        http_conditionalRequest(filemtime($cachefile));
529c0956f69SMichael Große        global $INPUT;
530f7b24f48SMichael Große        $outputTarget = $INPUT->str('outputTarget', $this->getConf('output'));
53187c86ddaSAndreas Gohr
53203352761SKirsten Roschanski        $filename = rawurlencode(cleanID(strtr($this->title, ':/;"', '    ')));
533c0956f69SMichael Große        if($outputTarget === 'file') {
5349a3c8d9fSAndreas Gohr            header('Content-Disposition: attachment; filename="' . $filename . '.pdf";');
53587c86ddaSAndreas Gohr        } else {
5369a3c8d9fSAndreas Gohr            header('Content-Disposition: inline; filename="' . $filename . '.pdf";');
53787c86ddaSAndreas Gohr        }
538ee19bac3SLuigi Micco
539b3eed6e3SGerrit Uitslag        //Bookcreator uses jQuery.fileDownload.js, which requires a cookie.
540b3eed6e3SGerrit Uitslag        header('Set-Cookie: fileDownload=true; path=/');
541b3eed6e3SGerrit Uitslag
542e993da11SGerrit Uitslag        //try to send file, and exit if done
543d63e7fe7SGerrit Uitslag        http_sendfile($cachefile);
54487c86ddaSAndreas Gohr
545d63e7fe7SGerrit Uitslag        $fp = @fopen($cachefile, "rb");
54687c86ddaSAndreas Gohr        if($fp) {
547d63e7fe7SGerrit Uitslag            http_rangeRequest($fp, filesize($cachefile), 'application/pdf');
54887c86ddaSAndreas Gohr        } else {
54987c86ddaSAndreas Gohr            header("HTTP/1.0 500 Internal Server Error");
55087c86ddaSAndreas Gohr            print "Could not read file - bad permissions?";
55187c86ddaSAndreas Gohr        }
5521ef68647SAndreas Gohr        exit();
5531ef68647SAndreas Gohr    }
5541ef68647SAndreas Gohr
5556be736bfSGerrit Uitslag    /**
5562eedf77dSAndreas Gohr     * Load the various template files and prepare the HTML/CSS for insertion
55744e8e8fbSGerrit Uitslag     *
55844e8e8fbSGerrit Uitslag     * @return array
5591ef68647SAndreas Gohr     */
56003352761SKirsten Roschanski    protected function load_template() {
5611ef68647SAndreas Gohr        global $ID;
5621ef68647SAndreas Gohr        global $conf;
5631ef68647SAndreas Gohr
5642eedf77dSAndreas Gohr        // this is what we'll return
5652eedf77dSAndreas Gohr        $output = array(
5661e45476bSmnapp            'cover' => '',
5672eedf77dSAndreas Gohr            'html'  => '',
5682eedf77dSAndreas Gohr            'page'  => '',
5692eedf77dSAndreas Gohr            'first' => '',
5702eedf77dSAndreas Gohr            'cite'  => '',
5712eedf77dSAndreas Gohr        );
5722eedf77dSAndreas Gohr
5732eedf77dSAndreas Gohr        // prepare header/footer elements
5742eedf77dSAndreas Gohr        $html = '';
57533c15297SGerrit Uitslag        foreach(array('header', 'footer') as $section) {
57633c15297SGerrit Uitslag            foreach(array('', '_odd', '_even', '_first') as $order) {
57702f9a447SGerrit Uitslag                $file = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/' . $section . $order . '.html';
57833c15297SGerrit Uitslag                if(file_exists($file)) {
57933c15297SGerrit Uitslag                    $html .= '<htmlpage' . $section . ' name="' . $section . $order . '">' . DOKU_LF;
58033c15297SGerrit Uitslag                    $html .= file_get_contents($file) . DOKU_LF;
58133c15297SGerrit Uitslag                    $html .= '</htmlpage' . $section . '>' . DOKU_LF;
5822eedf77dSAndreas Gohr
5832eedf77dSAndreas Gohr                    // register the needed pseudo CSS
58433c15297SGerrit Uitslag                    if($order == '_first') {
58533c15297SGerrit Uitslag                        $output['first'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
58633c15297SGerrit Uitslag                    } elseif($order == '_even') {
58733c15297SGerrit Uitslag                        $output['page'] .= 'even-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
58833c15297SGerrit Uitslag                    } elseif($order == '_odd') {
58933c15297SGerrit Uitslag                        $output['page'] .= 'odd-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
590daa70883SAndreas Gohr                    } else {
59133c15297SGerrit Uitslag                        $output['page'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
5922eedf77dSAndreas Gohr                    }
5932eedf77dSAndreas Gohr                }
5942eedf77dSAndreas Gohr            }
5952eedf77dSAndreas Gohr        }
5962eedf77dSAndreas Gohr
5971ef68647SAndreas Gohr        // prepare replacements
5981ef68647SAndreas Gohr        $replace = array(
5991ef68647SAndreas Gohr            '@PAGE@'    => '{PAGENO}',
60002f9a447SGerrit Uitslag            '@PAGES@'   => '{nbpg}', //see also $mpdf->pagenumSuffix = ' / '
60103352761SKirsten Roschanski            '@TITLE@'   => hsc($this->title),
6021ef68647SAndreas Gohr            '@WIKI@'    => $conf['title'],
6031ef68647SAndreas Gohr            '@WIKIURL@' => DOKU_URL,
6041ef68647SAndreas Gohr            '@DATE@'    => dformat(time()),
6055d6fbaeaSAndreas Gohr            '@BASE@'    => DOKU_BASE,
606893987a2SAndreas Gohr            '@INC@'     => DOKU_INC,
607893987a2SAndreas Gohr            '@TPLBASE@' => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
608893987a2SAndreas Gohr            '@TPLINC@'  => DOKU_INC . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/'
6091ef68647SAndreas Gohr        );
6101ef68647SAndreas Gohr
6112eedf77dSAndreas Gohr        // set HTML element
612a180c973SKlap-in        $html = str_replace(array_keys($replace), array_values($replace), $html);
613a180c973SKlap-in        //TODO For bookcreator $ID (= bookmanager page) makes no sense
614a180c973SKlap-in        $output['html'] = $this->page_depend_replacements($html, $ID);
6151ef68647SAndreas Gohr
6161e45476bSmnapp        // cover page
61702f9a447SGerrit Uitslag        $coverfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/cover.html';
61833c15297SGerrit Uitslag        if(file_exists($coverfile)) {
61933c15297SGerrit Uitslag            $output['cover'] = file_get_contents($coverfile);
6201e45476bSmnapp            $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
6219b071da5SMichael            $output['cover'] = $this->page_depend_replacements($output['cover'], $ID);
6226e2ec302SGerrit Uitslag            $output['cover'] .= '<pagebreak />';
6231e45476bSmnapp        }
6241e45476bSmnapp
62533c15297SGerrit Uitslag        // cover page
62602f9a447SGerrit Uitslag        $backfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/back.html';
62733c15297SGerrit Uitslag        if(file_exists($backfile)) {
62833c15297SGerrit Uitslag            $output['back'] = '<pagebreak />';
62933c15297SGerrit Uitslag            $output['back'] .= file_get_contents($backfile);
63033c15297SGerrit Uitslag            $output['back'] = str_replace(array_keys($replace), array_values($replace), $output['back']);
6319b071da5SMichael            $output['back'] = $this->page_depend_replacements($output['back'], $ID);
63233c15297SGerrit Uitslag        }
63333c15297SGerrit Uitslag
6342eedf77dSAndreas Gohr        // citation box
63502f9a447SGerrit Uitslag        $citationfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/citation.html';
63633c15297SGerrit Uitslag        if(file_exists($citationfile)) {
63733c15297SGerrit Uitslag            $output['cite'] = file_get_contents($citationfile);
6382eedf77dSAndreas Gohr            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
6392eedf77dSAndreas Gohr        }
6401ef68647SAndreas Gohr
6412eedf77dSAndreas Gohr        return $output;
6421ef68647SAndreas Gohr    }
6431ef68647SAndreas Gohr
6441ef68647SAndreas Gohr    /**
645a180c973SKlap-in     * @param string $raw code with placeholders
646a180c973SKlap-in     * @param string $id  pageid
647a180c973SKlap-in     * @return string
648a180c973SKlap-in     */
649a180c973SKlap-in    protected function page_depend_replacements($raw, $id) {
650e53f1ec0SSzymon Olewniczak        global $REV, $DATE_AT;
651a180c973SKlap-in
652a180c973SKlap-in        // generate qr code for this page using google infographics api
653a180c973SKlap-in        $qr_code = '';
654a180c973SKlap-in        if($this->getConf('qrcodesize')) {
655a180c973SKlap-in            $url = urlencode(wl($id, '', '&', true));
656a180c973SKlap-in            $qr_code = '<img src="https://chart.googleapis.com/chart?chs=' .
657a180c973SKlap-in                $this->getConf('qrcodesize') . '&cht=qr&chl=' . $url . '" />';
658a180c973SKlap-in        }
659a180c973SKlap-in        // prepare replacements
660a180c973SKlap-in        $replace['@ID@']      = $id;
661a180c973SKlap-in        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
662e53f1ec0SSzymon Olewniczak
663e53f1ec0SSzymon Olewniczak        $params = array();
664e53f1ec0SSzymon Olewniczak        if($DATE_AT) {
665e53f1ec0SSzymon Olewniczak            $params['at'] = $DATE_AT;
666e53f1ec0SSzymon Olewniczak        } elseif($REV) {
667e53f1ec0SSzymon Olewniczak            $params['rev'] = $REV;
668e53f1ec0SSzymon Olewniczak        }
669e53f1ec0SSzymon Olewniczak        $replace['@PAGEURL@'] = wl($id, $params, true, "&");
670a180c973SKlap-in        $replace['@QRCODE@']  = $qr_code;
671a180c973SKlap-in
672e3d68265SGerrit Uitslag        $content = str_replace(array_keys($replace), array_values($replace), $raw);
673e3d68265SGerrit Uitslag
674e3d68265SGerrit Uitslag        // @DATE(<date>[, <format>])@
675e3d68265SGerrit Uitslag        $content = preg_replace_callback(
676e3d68265SGerrit Uitslag            '/@DATE\((.*?)(?:,\s*(.*?))?\)@/',
677e3d68265SGerrit Uitslag            array($this, 'replacedate'),
678e3d68265SGerrit Uitslag            $content
679e3d68265SGerrit Uitslag        );
680e3d68265SGerrit Uitslag
681e3d68265SGerrit Uitslag        return $content;
682a180c973SKlap-in    }
683a180c973SKlap-in
684e3d68265SGerrit Uitslag
685e3d68265SGerrit Uitslag    /**
686e3d68265SGerrit Uitslag     * (callback) Replace date by request datestring
687e3d68265SGerrit Uitslag     * e.g. '%m(30-11-1975)' is replaced by '11'
688e3d68265SGerrit Uitslag     *
689e3d68265SGerrit Uitslag     * @param array $match with [0]=>whole match, [1]=> first subpattern, [2] => second subpattern
690e3d68265SGerrit Uitslag     * @return string
691e3d68265SGerrit Uitslag     */
692e3d68265SGerrit Uitslag    function replacedate($match) {
693e3d68265SGerrit Uitslag        global $conf;
694e3d68265SGerrit Uitslag        //no 2nd argument for default date format
695e3d68265SGerrit Uitslag        if($match[2] == null) {
696e3d68265SGerrit Uitslag            $match[2] = $conf['dformat'];
697e3d68265SGerrit Uitslag        }
698e3d68265SGerrit Uitslag        return strftime($match[2], strtotime($match[1]));
699e3d68265SGerrit Uitslag    }
700e3d68265SGerrit Uitslag
701a180c973SKlap-in    /**
7021c14c879SAndreas Gohr     * Load all the style sheets and apply the needed replacements
7031ef68647SAndreas Gohr     */
7041c14c879SAndreas Gohr    protected function load_css() {
705737417c6SKlap-in        global $conf;
7061c14c879SAndreas Gohr        //reusue the CSS dispatcher functions without triggering the main function
7071c14c879SAndreas Gohr        define('SIMPLE_TEST', 1);
7081c14c879SAndreas Gohr        require_once(DOKU_INC . 'lib/exe/css.php');
709ee19bac3SLuigi Micco
7101c14c879SAndreas Gohr        // prepare CSS files
7111c14c879SAndreas Gohr        $files = array_merge(
7121c14c879SAndreas Gohr            array(
7131c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/screen.css'
7141c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7151c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/print.css'
7161c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7171c14c879SAndreas Gohr            ),
71858e6409eSAndreas Gohr            $this->css_pluginPDFstyles(),
7191c14c879SAndreas Gohr            array(
7201c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.css'
7211c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7221c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/style.css'
7231c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
7241c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.local.css'
7251c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7261c14c879SAndreas Gohr            )
7271c14c879SAndreas Gohr        );
7281c14c879SAndreas Gohr        $css = '';
7291c14c879SAndreas Gohr        foreach($files as $file => $location) {
73028e636eaSGerrit Uitslag            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
73128e636eaSGerrit Uitslag            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
7321c14c879SAndreas Gohr            $css .= css_loadfile($file, $location);
7331ef68647SAndreas Gohr        }
7341ef68647SAndreas Gohr
73528e636eaSGerrit Uitslag        if(function_exists('css_parseless')) {
7361c14c879SAndreas Gohr            // apply pattern replacements
73728e636eaSGerrit Uitslag            $styleini = css_styleini($conf['template']);
73828e636eaSGerrit Uitslag            $css = css_applystyle($css, $styleini['replacements']);
73928e636eaSGerrit Uitslag
74028e636eaSGerrit Uitslag            // parse less
74128e636eaSGerrit Uitslag            $css = css_parseless($css);
74228e636eaSGerrit Uitslag        } else {
74328e636eaSGerrit Uitslag            // @deprecated 2013-12-19: fix backward compatibility
7441c14c879SAndreas Gohr            $css = css_applystyle($css, DOKU_INC . 'lib/tpl/' . $conf['template'] . '/');
74528e636eaSGerrit Uitslag        }
7461ef68647SAndreas Gohr
7471c14c879SAndreas Gohr        return $css;
748ee19bac3SLuigi Micco    }
7491c14c879SAndreas Gohr
75058e6409eSAndreas Gohr    /**
75158e6409eSAndreas Gohr     * Returns a list of possible Plugin PDF Styles
75258e6409eSAndreas Gohr     *
75358e6409eSAndreas Gohr     * Checks for a pdf.css, falls back to print.css
75458e6409eSAndreas Gohr     *
75558e6409eSAndreas Gohr     * @author Andreas Gohr <andi@splitbrain.org>
75658e6409eSAndreas Gohr     */
7576be736bfSGerrit Uitslag    protected function css_pluginPDFstyles() {
75858e6409eSAndreas Gohr        $list = array();
75958e6409eSAndreas Gohr        $plugins = plugin_list();
760f54b51f7SAndreas Gohr
761f54b51f7SAndreas Gohr        $usestyle = explode(',', $this->getConf('usestyles'));
76258e6409eSAndreas Gohr        foreach($plugins as $p) {
763f54b51f7SAndreas Gohr            if(in_array($p, $usestyle)) {
764f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/screen.css"] = DOKU_BASE . "lib/plugins/$p/";
7658003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/screen.less"] = DOKU_BASE . "lib/plugins/$p/";
7668003b493SGerrit Uitslag
767f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/style.css"] = DOKU_BASE . "lib/plugins/$p/";
7688003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/style.less"] = DOKU_BASE . "lib/plugins/$p/";
769f54b51f7SAndreas Gohr            }
770f54b51f7SAndreas Gohr
7718003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.css"] = DOKU_BASE . "lib/plugins/$p/";
7728003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.less"] = DOKU_BASE . "lib/plugins/$p/";
7738003b493SGerrit Uitslag
77458e6409eSAndreas Gohr            if(file_exists(DOKU_PLUGIN . "$p/pdf.css")) {
77558e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/pdf.css"] = DOKU_BASE . "lib/plugins/$p/";
7768003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/pdf.less"] = DOKU_BASE . "lib/plugins/$p/";
77758e6409eSAndreas Gohr            } else {
77858e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/print.css"] = DOKU_BASE . "lib/plugins/$p/";
7798003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/print.less"] = DOKU_BASE . "lib/plugins/$p/";
78058e6409eSAndreas Gohr            }
78158e6409eSAndreas Gohr        }
78258e6409eSAndreas Gohr        return $list;
78358e6409eSAndreas Gohr    }
784ad18f4e1SGerrit Uitslag
785ad18f4e1SGerrit Uitslag    /**
78660e59de7SGerrit Uitslag     * Returns array of pages which will be included in the exported pdf
78760e59de7SGerrit Uitslag     *
78860e59de7SGerrit Uitslag     * @return array
78960e59de7SGerrit Uitslag     */
79060e59de7SGerrit Uitslag    public function getExportedPages() {
79160e59de7SGerrit Uitslag        return $this->list;
79260e59de7SGerrit Uitslag    }
79360e59de7SGerrit Uitslag
79460e59de7SGerrit Uitslag    /**
795ad18f4e1SGerrit Uitslag     * usort callback to sort by file lastmodified time
79644e8e8fbSGerrit Uitslag     *
79744e8e8fbSGerrit Uitslag     * @param array $a
79844e8e8fbSGerrit Uitslag     * @param array $b
79944e8e8fbSGerrit Uitslag     * @return int
800ad18f4e1SGerrit Uitslag     */
801ad18f4e1SGerrit Uitslag    public function _datesort($a, $b) {
802ad18f4e1SGerrit Uitslag        if($b['rev'] < $a['rev']) return -1;
803ad18f4e1SGerrit Uitslag        if($b['rev'] > $a['rev']) return 1;
804ad18f4e1SGerrit Uitslag        return strcmp($b['id'], $a['id']);
805ad18f4e1SGerrit Uitslag    }
806ad18f4e1SGerrit Uitslag
807ad18f4e1SGerrit Uitslag    /**
808ad18f4e1SGerrit Uitslag     * usort callback to sort by page id
80944e8e8fbSGerrit Uitslag     * @param array $a
81044e8e8fbSGerrit Uitslag     * @param array $b
81144e8e8fbSGerrit Uitslag     * @return int
812ad18f4e1SGerrit Uitslag     */
813ad18f4e1SGerrit Uitslag    public function _pagenamesort($a, $b) {
814eea6fd2cSMichael Große        // do not sort numbers before namespace separators
815eea6fd2cSMichael Große        $aID = str_replace(':', '/', $a['id']);
816eea6fd2cSMichael Große        $bID = str_replace(':', '/', $b['id']);
817eea6fd2cSMichael Große        if($aID <= $bID) return -1;
818eea6fd2cSMichael Große        if($aID > $bID) return 1;
819ad18f4e1SGerrit Uitslag        return 0;
820ad18f4e1SGerrit Uitslag    }
82126be4eceSGerrit Uitslag
82226be4eceSGerrit Uitslag    /**
82302f9a447SGerrit Uitslag     * Return settings read from:
82402f9a447SGerrit Uitslag     *   1. url parameters
82502f9a447SGerrit Uitslag     *   2. plugin config
82602f9a447SGerrit Uitslag     *   3. global config
82702f9a447SGerrit Uitslag     *
82802f9a447SGerrit Uitslag     * @return array
82902f9a447SGerrit Uitslag     */
83002f9a447SGerrit Uitslag    protected function loadExportConfig() {
83102f9a447SGerrit Uitslag        global $INPUT;
83202f9a447SGerrit Uitslag        global $conf;
83302f9a447SGerrit Uitslag
83402f9a447SGerrit Uitslag        $this->exportConfig = array();
83502f9a447SGerrit Uitslag
83602f9a447SGerrit Uitslag        // decide on the paper setup from param or config
83702f9a447SGerrit Uitslag        $this->exportConfig['pagesize'] = $INPUT->str('pagesize', $this->getConf('pagesize'), true);
83802f9a447SGerrit Uitslag        $this->exportConfig['orientation'] = $INPUT->str('orientation', $this->getConf('orientation'), true);
83902f9a447SGerrit Uitslag
8404870b378SLarsDW223        // decide on the font-size from param or config
8414870b378SLarsDW223        $this->exportConfig['font-size'] = $INPUT->str('font-size', $this->getConf('font-size'), true);
8424870b378SLarsDW223
843213fdb75SGerrit Uitslag        $doublesided = $INPUT->bool('doublesided', (bool) $this->getConf('doublesided'));
844213fdb75SGerrit Uitslag        $this->exportConfig['doublesided'] = $doublesided ? '1' : '0';
845213fdb75SGerrit Uitslag
846213fdb75SGerrit Uitslag        $hasToC = $INPUT->bool('toc', (bool) $this->getConf('toc'));
84702f9a447SGerrit Uitslag        $levels = array();
84802f9a447SGerrit Uitslag        if($hasToC) {
84902f9a447SGerrit Uitslag            $toclevels = $INPUT->str('toclevels', $this->getConf('toclevels'), true);
85002f9a447SGerrit Uitslag            list($top_input, $max_input) = explode('-', $toclevels, 2);
85102f9a447SGerrit Uitslag            list($top_conf, $max_conf) = explode('-', $this->getConf('toclevels'), 2);
85202f9a447SGerrit Uitslag            $bounds_input = array(
85302f9a447SGerrit Uitslag                'top' => array(
85402f9a447SGerrit Uitslag                    (int) $top_input,
85502f9a447SGerrit Uitslag                    (int) $top_conf
85602f9a447SGerrit Uitslag                ),
85702f9a447SGerrit Uitslag                'max' => array(
85802f9a447SGerrit Uitslag                    (int) $max_input,
85902f9a447SGerrit Uitslag                    (int) $max_conf
86002f9a447SGerrit Uitslag                )
86102f9a447SGerrit Uitslag            );
86202f9a447SGerrit Uitslag            $bounds = array(
86302f9a447SGerrit Uitslag                'top' => $conf['toptoclevel'],
86402f9a447SGerrit Uitslag                'max' => $conf['maxtoclevel']
86502f9a447SGerrit Uitslag
86602f9a447SGerrit Uitslag            );
86702f9a447SGerrit Uitslag            foreach($bounds_input as $bound => $values) {
86802f9a447SGerrit Uitslag                foreach($values as $value) {
86902f9a447SGerrit Uitslag                    if($value > 0 && $value <= 5) {
87002f9a447SGerrit Uitslag                        //stop at valid value and store
87102f9a447SGerrit Uitslag                        $bounds[$bound] = $value;
87202f9a447SGerrit Uitslag                        break;
87302f9a447SGerrit Uitslag                    }
87402f9a447SGerrit Uitslag                }
87502f9a447SGerrit Uitslag            }
87602f9a447SGerrit Uitslag
87702f9a447SGerrit Uitslag            if($bounds['max'] < $bounds['top']) {
87802f9a447SGerrit Uitslag                $bounds['max'] = $bounds['top'];
87902f9a447SGerrit Uitslag            }
88002f9a447SGerrit Uitslag
88102f9a447SGerrit Uitslag            for($level = $bounds['top']; $level <= $bounds['max']; $level++) {
88202f9a447SGerrit Uitslag                $levels["H$level"] = $level - 1;
88302f9a447SGerrit Uitslag            }
88402f9a447SGerrit Uitslag        }
88502f9a447SGerrit Uitslag        $this->exportConfig['hasToC'] = $hasToC;
88602f9a447SGerrit Uitslag        $this->exportConfig['levels'] = $levels;
88702f9a447SGerrit Uitslag
88802f9a447SGerrit Uitslag        $this->exportConfig['maxbookmarks'] = $INPUT->int('maxbookmarks', $this->getConf('maxbookmarks'), true);
88902f9a447SGerrit Uitslag
89002f9a447SGerrit Uitslag        $tplconf = $this->getConf('template');
89105d2b507SGerrit Uitslag        $tpl = $INPUT->str('tpl', $tplconf, true);
89202f9a447SGerrit Uitslag        if(!is_dir(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl)) {
89302f9a447SGerrit Uitslag            $tpl = $tplconf;
89402f9a447SGerrit Uitslag        }
89502f9a447SGerrit Uitslag        if(!$tpl){
89602f9a447SGerrit Uitslag            $tpl = 'default';
89702f9a447SGerrit Uitslag        }
89802f9a447SGerrit Uitslag        $this->exportConfig['template'] = $tpl;
89902f9a447SGerrit Uitslag
90002f9a447SGerrit Uitslag        $this->exportConfig['isDebug'] = $conf['allowdebug'] && $INPUT->has('debughtml');
90102f9a447SGerrit Uitslag    }
90202f9a447SGerrit Uitslag
90302f9a447SGerrit Uitslag    /**
90402f9a447SGerrit Uitslag     * Returns requested config
90502f9a447SGerrit Uitslag     *
90602f9a447SGerrit Uitslag     * @param string $name
90702f9a447SGerrit Uitslag     * @param mixed  $notset
90802f9a447SGerrit Uitslag     * @return mixed|bool
90902f9a447SGerrit Uitslag     */
91002f9a447SGerrit Uitslag    public function getExportConfig($name, $notset = false) {
91102f9a447SGerrit Uitslag        if ($this->exportConfig === null){
91202f9a447SGerrit Uitslag            $this->loadExportConfig();
91302f9a447SGerrit Uitslag        }
91402f9a447SGerrit Uitslag
91502f9a447SGerrit Uitslag        if(isset($this->exportConfig[$name])){
91602f9a447SGerrit Uitslag            return $this->exportConfig[$name];
91702f9a447SGerrit Uitslag        }else{
91802f9a447SGerrit Uitslag            return $notset;
91902f9a447SGerrit Uitslag        }
92002f9a447SGerrit Uitslag    }
921d63e7fe7SGerrit Uitslag
922d63e7fe7SGerrit Uitslag    /**
923d63e7fe7SGerrit Uitslag     * Add 'export pdf'-button to pagetools
924d63e7fe7SGerrit Uitslag     *
925d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
926d63e7fe7SGerrit Uitslag     */
92744e8e8fbSGerrit Uitslag    public function addbutton(Doku_Event $event) {
928e53f1ec0SSzymon Olewniczak        global $ID, $REV, $DATE_AT;
929d63e7fe7SGerrit Uitslag
930d63e7fe7SGerrit Uitslag        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
931d63e7fe7SGerrit Uitslag            $params = array('do' => 'export_pdf');
932e53f1ec0SSzymon Olewniczak            if($DATE_AT) {
933e53f1ec0SSzymon Olewniczak                $params['at'] = $DATE_AT;
934e53f1ec0SSzymon Olewniczak            } elseif($REV) {
935d63e7fe7SGerrit Uitslag                $params['rev'] = $REV;
936d63e7fe7SGerrit Uitslag            }
937d63e7fe7SGerrit Uitslag
938d63e7fe7SGerrit Uitslag            // insert button at position before last (up to top)
939d63e7fe7SGerrit Uitslag            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
940d63e7fe7SGerrit Uitslag                array('export_pdf' =>
941d63e7fe7SGerrit Uitslag                          '<li>'
94272cadc31SChristian Paul                          . '<a href="' . wl($ID, $params) . '"  class="action export_pdf" rel="nofollow" title="' . $this->getLang('export_pdf_button') . '">'
943d63e7fe7SGerrit Uitslag                          . '<span>' . $this->getLang('export_pdf_button') . '</span>'
944d63e7fe7SGerrit Uitslag                          . '</a>'
945d63e7fe7SGerrit Uitslag                          . '</li>'
946d63e7fe7SGerrit Uitslag                ) +
947d63e7fe7SGerrit Uitslag                array_slice($event->data['items'], -1, 1, true);
948d63e7fe7SGerrit Uitslag        }
949d63e7fe7SGerrit Uitslag    }
950026b594bSAndreas Gohr
951026b594bSAndreas Gohr    /**
952026b594bSAndreas Gohr     * Add 'export pdf' button to page tools, new SVG based mechanism
953026b594bSAndreas Gohr     *
954026b594bSAndreas Gohr     * @param Doku_Event $event
955026b594bSAndreas Gohr     */
956026b594bSAndreas Gohr    public function addsvgbutton(Doku_Event $event) {
957*4c493e44SGerrit Uitslag        global $INFO;
958*4c493e44SGerrit Uitslag        if($event->data['view'] != 'page' || !$this->getConf('showexportbutton')) {
959*4c493e44SGerrit Uitslag            return;
960*4c493e44SGerrit Uitslag        }
961*4c493e44SGerrit Uitslag
962*4c493e44SGerrit Uitslag        if(!$INFO['exists']) {
963*4c493e44SGerrit Uitslag            return;
964*4c493e44SGerrit Uitslag        }
965*4c493e44SGerrit Uitslag
966026b594bSAndreas Gohr        array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dw2pdf\MenuItem()]);
967026b594bSAndreas Gohr    }
968ee19bac3SLuigi Micco}
969