xref: /plugin/dw2pdf/action.php (revision 2d9cd424718a79eba5075b2fef7fdcca748c0f02)
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) {
58*2d9cd424SGerrit Uitslag        global $ID, $REV, $DATE_AT;
59*2d9cd424SGerrit Uitslag        global $conf, $INPUT;
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
73*2d9cd424SGerrit Uitslag        if($event->data === 'export_pdf' && ($REV || $DATE_AT)) {
7427195d5bSMichael Große            $tempFilename = tempnam($conf['tmpdir'], 'dw2pdf_');
75f00df45eSMichael Große            $generateNewPdf = true;
7627d48100SMichael Große            $isTempFile = true;
77f00df45eSMichael Große        } else {
78a58f45f0SGerrit Uitslag            // prepare cache and its dependencies
79a58f45f0SGerrit Uitslag            $depends = array();
8003352761SKirsten Roschanski            $cache = $this->prepareCache($depends);
81f00df45eSMichael Große            $tempFilename = $cache->cache;
8227195d5bSMichael Große            $generateNewPdf = !$this->getConf('usecache')
8327195d5bSMichael Große                || $this->getExportConfig('isDebug')
8427195d5bSMichael Große                || !$cache->useCache($depends);
8527d48100SMichael Große            $isTempFile = false;
86f00df45eSMichael Große        }
87d63e7fe7SGerrit Uitslag
88bd977188SGerrit Uitslag        // hard work only when no cache available or needed for debugging
89f00df45eSMichael Große        if($generateNewPdf) {
90e5f6c2cbSMichael Große            // generating the pdf may take a long time for larger wikis / namespaces with many pages
91e5f6c2cbSMichael Große            set_time_limit(0);
92b34cb34eSSzymon Olewniczak            try {
93*2d9cd424SGerrit Uitslag                $this->generatePDF($tempFilename, $event);
94b34cb34eSSzymon Olewniczak            } catch(Mpdf\MpdfException $e) {
95*2d9cd424SGerrit Uitslag                if($INPUT->has('selection')) {
96*2d9cd424SGerrit Uitslag                    http_status(400);
97*2d9cd424SGerrit Uitslag                    print $e->getMessage();
98*2d9cd424SGerrit Uitslag                    exit();
99*2d9cd424SGerrit Uitslag                } else {
100b34cb34eSSzymon Olewniczak                    //prevent act_export()
101*2d9cd424SGerrit Uitslag                    $event->data = 'show';
102b34cb34eSSzymon Olewniczak                    msg($e->getMessage(), -1);
103*2d9cd424SGerrit Uitslag                    $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
104b34cb34eSSzymon Olewniczak                    return false;
105b34cb34eSSzymon Olewniczak                }
106d63e7fe7SGerrit Uitslag            }
107*2d9cd424SGerrit Uitslag        }
108*2d9cd424SGerrit Uitslag
109*2d9cd424SGerrit Uitslag        $event->preventDefault(); // after prevent, $event->data cannot be changed
110d63e7fe7SGerrit Uitslag
111d63e7fe7SGerrit Uitslag        // deliver the file
112f00df45eSMichael Große        $this->sendPDFFile($tempFilename);
11327d48100SMichael Große        if($isTempFile) {
11427d48100SMichael Große            unlink($tempFilename);
11527d48100SMichael Große        }
116*2d9cd424SGerrit Uitslag
117d63e7fe7SGerrit Uitslag        return true;
118d63e7fe7SGerrit Uitslag    }
119d63e7fe7SGerrit Uitslag
120d63e7fe7SGerrit Uitslag    /**
121d63e7fe7SGerrit Uitslag     * Obtain list of pages and title, based on url parameters
122d63e7fe7SGerrit Uitslag     *
123d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
124d63e7fe7SGerrit Uitslag     * @return string|bool
125d63e7fe7SGerrit Uitslag     */
126d63e7fe7SGerrit Uitslag    protected function collectExportPages(Doku_Event $event) {
12736a7917dSGerrit Uitslag        global $ID, $REV;
128d63e7fe7SGerrit Uitslag        global $INPUT;
129d63e7fe7SGerrit Uitslag        global $conf;
130d63e7fe7SGerrit Uitslag
131d63e7fe7SGerrit Uitslag        // list of one or multiple pages
132d63e7fe7SGerrit Uitslag        $list = array();
13328e636eaSGerrit Uitslag
1344b4cebc2SLarsDW223        if($event->data == 'export_pdf') {
135d63e7fe7SGerrit Uitslag            $list[0] = $ID;
13603352761SKirsten Roschanski            $this->title = $INPUT->str('pdftitle'); //DEPRECATED
13703352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
13803352761SKirsten Roschanski            if(empty($this->title)) {
13903352761SKirsten Roschanski                $this->title = p_get_first_heading($ID);
14015923cb9SGerrit Uitslag            }
141ad18f4e1SGerrit Uitslag
14236a7917dSGerrit Uitslag            $filename = wikiFN($ID, $REV);
14336a7917dSGerrit Uitslag            if(!file_exists($filename)) {
14436a7917dSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'notexist');
14536a7917dSGerrit Uitslag                return false;
14636a7917dSGerrit Uitslag            }
14736a7917dSGerrit Uitslag
1484b4cebc2SLarsDW223        } elseif($event->data == 'export_pdfns') {
149ad18f4e1SGerrit Uitslag            //check input for title and ns
15003352761SKirsten Roschanski            if(!$this->title = $INPUT->str('book_title')) {
15126be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
152ad18f4e1SGerrit Uitslag                return false;
153ad18f4e1SGerrit Uitslag            }
154177a7d30SGerrit Uitslag            $pdfnamespace = cleanID($INPUT->str('book_ns'));
155ad18f4e1SGerrit Uitslag            if(!@is_dir(dirname(wikiFN($pdfnamespace . ':dummy')))) {
15626be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needns');
157ad18f4e1SGerrit Uitslag                return false;
158ad18f4e1SGerrit Uitslag            }
159ad18f4e1SGerrit Uitslag
16026be4eceSGerrit Uitslag            //sort order
161177a7d30SGerrit Uitslag            $order = $INPUT->str('book_order', 'natural', true);
162ad18f4e1SGerrit Uitslag            $sortoptions = array('pagename', 'date', 'natural');
163ad18f4e1SGerrit Uitslag            if(!in_array($order, $sortoptions)) {
164ad18f4e1SGerrit Uitslag                $order = 'natural';
165ad18f4e1SGerrit Uitslag            }
166ad18f4e1SGerrit Uitslag
16726be4eceSGerrit Uitslag            //search depth
168177a7d30SGerrit Uitslag            $depth = $INPUT->int('book_nsdepth', 0);
169ad18f4e1SGerrit Uitslag            if($depth < 0) {
170ad18f4e1SGerrit Uitslag                $depth = 0;
171ad18f4e1SGerrit Uitslag            }
17226be4eceSGerrit Uitslag
173ad18f4e1SGerrit Uitslag            //page search
174ad18f4e1SGerrit Uitslag            $result = array();
175ad18f4e1SGerrit Uitslag            $opts = array('depth' => $depth); //recursive all levels
176ad18f4e1SGerrit Uitslag            $dir = utf8_encodeFN(str_replace(':', '/', $pdfnamespace));
177ad18f4e1SGerrit Uitslag            search($result, $conf['datadir'], 'search_allpages', $opts, $dir);
178ad18f4e1SGerrit Uitslag
17926be4eceSGerrit Uitslag            //sorting
180ad18f4e1SGerrit Uitslag            if(count($result) > 0) {
181ad18f4e1SGerrit Uitslag                if($order == 'date') {
182ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_datesort'));
183ad18f4e1SGerrit Uitslag                } elseif($order == 'pagename') {
184ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_pagenamesort'));
185ad18f4e1SGerrit Uitslag                }
186ad18f4e1SGerrit Uitslag            }
187ad18f4e1SGerrit Uitslag
188ad18f4e1SGerrit Uitslag            foreach($result as $item) {
189d63e7fe7SGerrit Uitslag                $list[] = $item['id'];
190ad18f4e1SGerrit Uitslag            }
191ad18f4e1SGerrit Uitslag
192baa31dc5SGerrit Uitslag            if ($pdfnamespace !== '') {
193baa31dc5SGerrit Uitslag                if (!in_array($pdfnamespace . ':' . $conf['start'], $list, true)) {
194baa31dc5SGerrit Uitslag                    if (file_exists(wikiFN(rtrim($pdfnamespace,':')))) {
195baa31dc5SGerrit Uitslag                        array_unshift($list,rtrim($pdfnamespace,':'));
196baa31dc5SGerrit Uitslag                    }
197baa31dc5SGerrit Uitslag                }
198baa31dc5SGerrit Uitslag            }
199baa31dc5SGerrit Uitslag
200737417c6SKlap-in        } elseif(isset($_COOKIE['list-pagelist']) && !empty($_COOKIE['list-pagelist'])) {
201b3eed6e3SGerrit Uitslag            /** @deprecated  April 2016 replaced by localStorage version of Bookcreator*/
20226be4eceSGerrit Uitslag            //is in Bookmanager of bookcreator plugin a title given?
20303352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
20403352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
20503352761SKirsten Roschanski            if(empty($this->title)) {
20626be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
207737417c6SKlap-in                return false;
20826be4eceSGerrit Uitslag            } else {
209d63e7fe7SGerrit Uitslag                $list = explode("|", $_COOKIE['list-pagelist']);
21026be4eceSGerrit Uitslag            }
211ad18f4e1SGerrit Uitslag
212b3eed6e3SGerrit Uitslag        } elseif($INPUT->has('selection')) {
213b3eed6e3SGerrit Uitslag            //handle Bookcreator requests based at localStorage
214b3eed6e3SGerrit Uitslag//            if(!checkSecurityToken()) {
215b3eed6e3SGerrit Uitslag//                http_status(403);
216b3eed6e3SGerrit Uitslag//                print $this->getLang('empty');
217b3eed6e3SGerrit Uitslag//                exit();
218b3eed6e3SGerrit Uitslag//            }
219b3eed6e3SGerrit Uitslag
220b3eed6e3SGerrit Uitslag            $json = new JSON(JSON_LOOSE_TYPE);
221b3eed6e3SGerrit Uitslag            $list = $json->decode($INPUT->post->str('selection', '', true));
222b3eed6e3SGerrit Uitslag            if(!is_array($list) || empty($list)) {
223b3eed6e3SGerrit Uitslag                http_status(400);
224b3eed6e3SGerrit Uitslag                print $this->getLang('empty');
225b3eed6e3SGerrit Uitslag                exit();
226b3eed6e3SGerrit Uitslag            }
227b3eed6e3SGerrit Uitslag
22803352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
22903352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
23003352761SKirsten Roschanski            if(empty($this->title)) {
231b3eed6e3SGerrit Uitslag                http_status(400);
232b3eed6e3SGerrit Uitslag                print $this->getLang('needtitle');
233b3eed6e3SGerrit Uitslag                exit();
234b3eed6e3SGerrit Uitslag            }
235b3eed6e3SGerrit Uitslag
236737417c6SKlap-in        } else {
23726be4eceSGerrit Uitslag            //show empty bookcreator message
23826be4eceSGerrit Uitslag            $this->showPageWithErrorMsg($event, 'empty');
239737417c6SKlap-in            return false;
240737417c6SKlap-in        }
241737417c6SKlap-in
242719256adSGerrit Uitslag        $list = array_map('cleanID', $list);
243c7138b3fSGerrit Uitslag
244c7138b3fSGerrit Uitslag        $skippedpages = array();
245c7138b3fSGerrit Uitslag        foreach($list as $index => $pageid) {
246c7138b3fSGerrit Uitslag            if(auth_quickaclcheck($pageid) < AUTH_READ) {
247c7138b3fSGerrit Uitslag                $skippedpages[] = $pageid;
248c7138b3fSGerrit Uitslag                unset($list[$index]);
249c7138b3fSGerrit Uitslag            }
250c7138b3fSGerrit Uitslag        }
251c7138b3fSGerrit Uitslag        $list = array_filter($list); //removes also pages mentioned '0'
252c7138b3fSGerrit Uitslag
253c7138b3fSGerrit Uitslag        //if selection contains forbidden pages throw (overridable) warning
254c7138b3fSGerrit Uitslag        if(!$INPUT->bool('book_skipforbiddenpages') && !empty($skippedpages)) {
255c7138b3fSGerrit Uitslag            $msg = hsc(join(', ', $skippedpages));
256c7138b3fSGerrit Uitslag            if($INPUT->has('selection')) {
257c7138b3fSGerrit Uitslag                http_status(400);
258c7138b3fSGerrit Uitslag                print sprintf($this->getLang('forbidden'), $msg);
259c7138b3fSGerrit Uitslag                exit();
260c7138b3fSGerrit Uitslag            } else {
261c7138b3fSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'forbidden', $msg);
262c7138b3fSGerrit Uitslag                return false;
263c7138b3fSGerrit Uitslag            }
264c7138b3fSGerrit Uitslag
265c7138b3fSGerrit Uitslag        }
266c7138b3fSGerrit Uitslag
26703352761SKirsten Roschanski        return array($this->title, $list);
268d63e7fe7SGerrit Uitslag    }
269d63e7fe7SGerrit Uitslag
270a58f45f0SGerrit Uitslag    /**
271a58f45f0SGerrit Uitslag     * Prepare cache
272a58f45f0SGerrit Uitslag     *
273a58f45f0SGerrit Uitslag     * @param array  $depends (reference) array with dependencies
274a58f45f0SGerrit Uitslag     * @return cache
275a58f45f0SGerrit Uitslag     */
27603352761SKirsten Roschanski    protected function prepareCache(&$depends) {
277a58f45f0SGerrit Uitslag        global $REV;
278a58f45f0SGerrit Uitslag
279ee19bac3SLuigi Micco        $cachekey = join(',', $this->list)
280ee19bac3SLuigi Micco            . $REV
281ee19bac3SLuigi Micco            . $this->getExportConfig('template')
282ee19bac3SLuigi Micco            . $this->getExportConfig('pagesize')
283ee19bac3SLuigi Micco            . $this->getExportConfig('orientation')
284d83760efSGerrit Uitslag            . $this->getExportConfig('font-size')
285ee19bac3SLuigi Micco            . $this->getExportConfig('doublesided')
286ee19bac3SLuigi Micco            . ($this->getExportConfig('hasToC') ? join('-', $this->getExportConfig('levels')) : '0')
28703352761SKirsten Roschanski            . $this->title;
288ee19bac3SLuigi Micco        $cache = new cache($cachekey, '.dw2.pdf');
289ee19bac3SLuigi Micco
290ee19bac3SLuigi Micco        $dependencies = array();
291ee19bac3SLuigi Micco        foreach($this->list as $pageid) {
292ee19bac3SLuigi Micco            $relations = p_get_metadata($pageid, 'relation');
293ee19bac3SLuigi Micco
294ee19bac3SLuigi Micco            if(is_array($relations)) {
295ee19bac3SLuigi Micco                if(array_key_exists('media', $relations) && is_array($relations['media'])) {
296ee19bac3SLuigi Micco                    foreach($relations['media'] as $mediaid => $exists) {
297ee19bac3SLuigi Micco                        if($exists) {
298ee19bac3SLuigi Micco                            $dependencies[] = mediaFN($mediaid);
299ee19bac3SLuigi Micco                        }
300ee19bac3SLuigi Micco                    }
301ee19bac3SLuigi Micco                }
302ee19bac3SLuigi Micco
303ee19bac3SLuigi Micco                if(array_key_exists('haspart', $relations) && is_array($relations['haspart'])) {
304ee19bac3SLuigi Micco                    foreach($relations['haspart'] as $part_pageid => $exists) {
305ee19bac3SLuigi Micco                        if($exists) {
306ee19bac3SLuigi Micco                            $dependencies[] = wikiFN($part_pageid);
307ee19bac3SLuigi Micco                        }
308ee19bac3SLuigi Micco                    }
309ee19bac3SLuigi Micco                }
310ee19bac3SLuigi Micco            }
311ee19bac3SLuigi Micco
312ee19bac3SLuigi Micco            $dependencies[] = metaFN($pageid, '.meta');
313ee19bac3SLuigi Micco        }
314ee19bac3SLuigi Micco
315ee19bac3SLuigi Micco        $depends['files'] = array_map('wikiFN', $this->list);
316ee19bac3SLuigi Micco        $depends['files'][] = __FILE__;
317ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/renderer.php';
318ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/mpdf/mpdf.php';
319ee19bac3SLuigi Micco        $depends['files'] = array_merge(
320ee19bac3SLuigi Micco            $depends['files'],
321ee19bac3SLuigi Micco            $dependencies,
322ee19bac3SLuigi Micco            getConfigFiles('main')
323ee19bac3SLuigi Micco        );
324a58f45f0SGerrit Uitslag        return $cache;
325ee19bac3SLuigi Micco    }
326ee19bac3SLuigi Micco
327d63e7fe7SGerrit Uitslag    /**
328d63e7fe7SGerrit Uitslag     * Set error notification and reload page again
329d63e7fe7SGerrit Uitslag     *
330d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
331d63e7fe7SGerrit Uitslag     * @param string $msglangkey key of translation key
332c7138b3fSGerrit Uitslag     * @param string $replacement
333d63e7fe7SGerrit Uitslag     */
334c7138b3fSGerrit Uitslag    private function showPageWithErrorMsg(Doku_Event $event, $msglangkey, $replacement=null) {
335c7138b3fSGerrit Uitslag        if(empty($replacement)) {
336c7138b3fSGerrit Uitslag            $msg = $this->getLang($msglangkey);
337c7138b3fSGerrit Uitslag        } else {
338c7138b3fSGerrit Uitslag            $msg = sprintf($this->getLang($msglangkey), $replacement);
339c7138b3fSGerrit Uitslag        }
340c7138b3fSGerrit Uitslag        msg($msg, -1);
341d63e7fe7SGerrit Uitslag
342d63e7fe7SGerrit Uitslag        $event->data = 'show';
343d63e7fe7SGerrit Uitslag        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
344d63e7fe7SGerrit Uitslag    }
345d63e7fe7SGerrit Uitslag
346d63e7fe7SGerrit Uitslag    /**
347e53f1ec0SSzymon Olewniczak     * Returns the parsed Wikitext in dw2pdf for the given id and revision
348e53f1ec0SSzymon Olewniczak     *
349e53f1ec0SSzymon Olewniczak     * @param string     $id  page id
350e53f1ec0SSzymon Olewniczak     * @param string|int $rev revision timestamp or empty string
351e53f1ec0SSzymon Olewniczak     * @param string     $date_at
352e53f1ec0SSzymon Olewniczak     * @return null|string
353e53f1ec0SSzymon Olewniczak     */
354e53f1ec0SSzymon Olewniczak    protected function p_wiki_dw2pdf($id, $rev = '', $date_at = '') {
355e53f1ec0SSzymon Olewniczak        $file = wikiFN($id, $rev);
356e53f1ec0SSzymon Olewniczak
357e53f1ec0SSzymon Olewniczak        if(!file_exists($file)) return '';
358e53f1ec0SSzymon Olewniczak
359e53f1ec0SSzymon Olewniczak        //ensure $id is in global $ID (needed for parsing)
360e53f1ec0SSzymon Olewniczak        global $ID;
361e53f1ec0SSzymon Olewniczak        $keep = $ID;
362e53f1ec0SSzymon Olewniczak        $ID   = $id;
363e53f1ec0SSzymon Olewniczak
364e53f1ec0SSzymon Olewniczak        if($rev || $date_at) {
365e53f1ec0SSzymon Olewniczak            $ret = p_render('dw2pdf', p_get_instructions(io_readWikiPage($file, $id, $rev)), $info, $date_at); //no caching on old revisions
366e53f1ec0SSzymon Olewniczak        } else {
367e53f1ec0SSzymon Olewniczak            $ret = p_cached_output($file, 'dw2pdf', $id);
368e53f1ec0SSzymon Olewniczak        }
369e53f1ec0SSzymon Olewniczak
370e53f1ec0SSzymon Olewniczak        //restore ID (just in case)
371e53f1ec0SSzymon Olewniczak        $ID = $keep;
372e53f1ec0SSzymon Olewniczak
373e53f1ec0SSzymon Olewniczak        return $ret;
374e53f1ec0SSzymon Olewniczak    }
375e53f1ec0SSzymon Olewniczak
376e53f1ec0SSzymon Olewniczak    /**
377d63e7fe7SGerrit Uitslag     * Build a pdf from the html
378d63e7fe7SGerrit Uitslag     *
379d63e7fe7SGerrit Uitslag     * @param string $cachefile
380d63e7fe7SGerrit Uitslag     */
381*2d9cd424SGerrit Uitslag    protected function generatePDF($cachefile, $event) {
382*2d9cd424SGerrit Uitslag        global $REV, $INPUT, $DATE_AT;
383e53f1ec0SSzymon Olewniczak
384*2d9cd424SGerrit Uitslag        if ($event->data == 'export_pdf') { //only one page is exported
385e53f1ec0SSzymon Olewniczak            $rev = $REV;
386e53f1ec0SSzymon Olewniczak            $date_at = $DATE_AT;
387e53f1ec0SSzymon Olewniczak        } else { //we are exporting entre namespace, ommit revisions
388e53f1ec0SSzymon Olewniczak            $rev = $date_at = '';
389e53f1ec0SSzymon Olewniczak        }
39087c86ddaSAndreas Gohr
39102f9a447SGerrit Uitslag        //some shortcuts to export settings
39202f9a447SGerrit Uitslag        $hasToC = $this->getExportConfig('hasToC');
39302f9a447SGerrit Uitslag        $levels = $this->getExportConfig('levels');
39402f9a447SGerrit Uitslag        $isDebug = $this->getExportConfig('isDebug');
3956ea88a05SAndreas Gohr
3961ef68647SAndreas Gohr        // initialize PDF library
397cde5a1b3SAndreas Gohr        require_once(dirname(__FILE__) . "/DokuPDF.class.php");
3986ea88a05SAndreas Gohr
3994870b378SLarsDW223        $mpdf = new DokuPDF($this->getExportConfig('pagesize'),
4004870b378SLarsDW223                            $this->getExportConfig('orientation'),
4014870b378SLarsDW223                            $this->getExportConfig('font-size'));
402ee19bac3SLuigi Micco
403d62df65bSAndreas Gohr        // let mpdf fix local links
404d62df65bSAndreas Gohr        $self = parse_url(DOKU_URL);
405d62df65bSAndreas Gohr        $url = $self['scheme'] . '://' . $self['host'];
40602f9a447SGerrit Uitslag        if($self['port']) {
40702f9a447SGerrit Uitslag            $url .= ':' . $self['port'];
40802f9a447SGerrit Uitslag        }
409d62df65bSAndreas Gohr        $mpdf->setBasePath($url);
410d62df65bSAndreas Gohr
41156d13144SAndreas Gohr        // Set the title
41203352761SKirsten Roschanski        $mpdf->SetTitle($this->title);
41356d13144SAndreas Gohr
414d63e7fe7SGerrit Uitslag        // some default document settings
415d63e7fe7SGerrit Uitslag        //note: double-sided document, starts at an odd page (first page is a right-hand side page)
416213fdb75SGerrit Uitslag        //      single-side document has only odd pages
417213fdb75SGerrit Uitslag        $mpdf->mirrorMargins = $this->getExportConfig('doublesided');
418daa70883SAndreas Gohr        $mpdf->setAutoTopMargin = 'stretch';
419daa70883SAndreas Gohr        $mpdf->setAutoBottomMargin = 'stretch';
42002f9a447SGerrit Uitslag//            $mpdf->pagenumSuffix = '/'; //prefix for {nbpg}
42102f9a447SGerrit Uitslag        if($hasToC) {
42202f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => 'i', 'suppress' => 'off'); //use italic pageno until ToC
42302f9a447SGerrit Uitslag            $mpdf->h2toc = $levels;
42402f9a447SGerrit Uitslag        } else {
42502f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => '1', 'suppress' => 'off');
42602f9a447SGerrit Uitslag        }
4272eedf77dSAndreas Gohr
42856d13144SAndreas Gohr        // load the template
42903352761SKirsten Roschanski        $template = $this->load_template();
430ee19bac3SLuigi Micco
4311ef68647SAndreas Gohr        // prepare HTML header styles
432a2c33768SGerrit Uitslag        $html = '';
43302f9a447SGerrit Uitslag        if($isDebug) {
434a2c33768SGerrit Uitslag            $html .= '<html><head>';
435737417c6SKlap-in            $html .= '<style type="text/css">';
436a2c33768SGerrit Uitslag        }
437db1aa1bfSKirsten Roschanski
438db1aa1bfSKirsten Roschanski        $styles = '@page { size:auto; ' . $template['page'] . '}';
439a2c33768SGerrit Uitslag        $styles .= '@page :first {' . $template['first'] . '}';
440254467c4SGerrit Uitslag
441254467c4SGerrit Uitslag        $styles .= '@page landscape-page { size:landscape }';
442254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-landscape { page:landscape-page }';
443254467c4SGerrit Uitslag        $styles .= '@page portrait-page { size:portrait }';
444254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-portrait { page:portrait-page }';
445db1aa1bfSKirsten Roschanski        $styles .= $this->load_css();
446254467c4SGerrit Uitslag
447a2c33768SGerrit Uitslag        $mpdf->WriteHTML($styles, 1);
448a2c33768SGerrit Uitslag
44902f9a447SGerrit Uitslag        if($isDebug) {
450a2c33768SGerrit Uitslag            $html .= $styles;
4511ef68647SAndreas Gohr            $html .= '</style>';
4521ef68647SAndreas Gohr            $html .= '</head><body>';
453a2c33768SGerrit Uitslag        }
454a2c33768SGerrit Uitslag
455a2c33768SGerrit Uitslag        $body_start = $template['html'];
456a2c33768SGerrit Uitslag        $body_start .= '<div class="dokuwiki">';
4572eedf77dSAndreas Gohr
4581e45476bSmnapp        // insert the cover page
459a2c33768SGerrit Uitslag        $body_start .= $template['cover'];
460a2c33768SGerrit Uitslag
461a2c33768SGerrit Uitslag        $mpdf->WriteHTML($body_start, 2, true, false); //start body html
46202f9a447SGerrit Uitslag        if($isDebug) {
463a2c33768SGerrit Uitslag            $html .= $body_start;
464a2c33768SGerrit Uitslag        }
46502f9a447SGerrit Uitslag        if($hasToC) {
46602f9a447SGerrit 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
46702f9a447SGerrit Uitslag            //      - first page of ToC starts always at odd page (so eventually an additional blank page is included before)
46802f9a447SGerrit Uitslag            //      - there is no page numbering at the pages of the ToC
46902f9a447SGerrit Uitslag            $mpdf->TOCpagebreakByArray(
47002f9a447SGerrit Uitslag                array(
471230b098dSGerrit Uitslag                    'toc-preHTML' => '<h2>' . $this->getLang('tocheader') . '</h2>',
472230b098dSGerrit Uitslag                    'toc-bookmarkText' => $this->getLang('tocheader'),
47302f9a447SGerrit Uitslag                    'links' => true,
47402f9a447SGerrit Uitslag                    'outdent' => '1em',
47502f9a447SGerrit Uitslag                    'resetpagenum' => true, //start pagenumbering after ToC
47602f9a447SGerrit Uitslag                    'pagenumstyle' => '1'
47702f9a447SGerrit Uitslag                )
47802f9a447SGerrit Uitslag            );
47902f9a447SGerrit Uitslag            $html .= '<tocpagebreak>';
48002f9a447SGerrit Uitslag        }
48102f9a447SGerrit Uitslag
4821ef68647SAndreas Gohr        // loop over all pages
483c7138b3fSGerrit Uitslag        $counter = 0;
484c7138b3fSGerrit Uitslag        $no_pages = count($this->list);
485c7138b3fSGerrit Uitslag        foreach($this->list as $page) {
486c7138b3fSGerrit Uitslag            $counter++;
487b3eed6e3SGerrit Uitslag
48879be256fSMichael Große            $pagehtml = $this->p_wiki_dw2pdf($page, $rev, $date_at);
489e53f1ec0SSzymon Olewniczak            //file doesn't exists
490e53f1ec0SSzymon Olewniczak            if($pagehtml == '') {
491b3eed6e3SGerrit Uitslag                continue;
492b3eed6e3SGerrit Uitslag            }
493719256adSGerrit Uitslag            $pagehtml .= $this->page_depend_replacements($template['cite'], $page);
494c7138b3fSGerrit Uitslag            if($counter < $no_pages) {
495a2c33768SGerrit Uitslag                $pagehtml .= '<pagebreak />';
496a2c33768SGerrit Uitslag            }
497a2c33768SGerrit Uitslag
498a2c33768SGerrit Uitslag            $mpdf->WriteHTML($pagehtml, 2, false, false); //intermediate body html
49902f9a447SGerrit Uitslag            if($isDebug) {
500a2c33768SGerrit Uitslag                $html .= $pagehtml;
5011ef68647SAndreas Gohr            }
502ee19bac3SLuigi Micco        }
503ee19bac3SLuigi Micco
50433c15297SGerrit Uitslag        // insert the back page
505a2c33768SGerrit Uitslag        $body_end = $template['back'];
50633c15297SGerrit Uitslag
507a2c33768SGerrit Uitslag        $body_end .= '</div>';
508a2c33768SGerrit Uitslag
509d63e7fe7SGerrit Uitslag        $mpdf->WriteHTML($body_end, 2, false, true); // finish body html
51002f9a447SGerrit Uitslag        if($isDebug) {
511a2c33768SGerrit Uitslag            $html .= $body_end;
512eeb17e15SAndreas Gohr            $html .= '</body>';
513eeb17e15SAndreas Gohr            $html .= '</html>';
514a2c33768SGerrit Uitslag        }
515f765508eSGerrit Uitslag
516f765508eSGerrit Uitslag        //Return html for debugging
51702f9a447SGerrit Uitslag        if($isDebug) {
51802f9a447SGerrit Uitslag            if($INPUT->str('debughtml', 'text', true) == 'html') {
51926be4eceSGerrit Uitslag                echo $html;
520a2c33768SGerrit Uitslag            } else {
521a2c33768SGerrit Uitslag                header('Content-Type: text/plain; charset=utf-8');
522a2c33768SGerrit Uitslag                echo $html;
523a2c33768SGerrit Uitslag            }
52426be4eceSGerrit Uitslag            exit();
52526be4eceSGerrit Uitslag        };
526f765508eSGerrit Uitslag
52787c86ddaSAndreas Gohr        // write to cache file
528d63e7fe7SGerrit Uitslag        $mpdf->Output($cachefile, 'F');
52987c86ddaSAndreas Gohr    }
53087c86ddaSAndreas Gohr
531d63e7fe7SGerrit Uitslag    /**
532d63e7fe7SGerrit Uitslag     * @param string $cachefile
533d63e7fe7SGerrit Uitslag     */
53403352761SKirsten Roschanski    protected function sendPDFFile($cachefile) {
53587c86ddaSAndreas Gohr        header('Content-Type: application/pdf');
536b853b723SAndreas Gohr        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
53787c86ddaSAndreas Gohr        header('Pragma: public');
538d63e7fe7SGerrit Uitslag        http_conditionalRequest(filemtime($cachefile));
539c0956f69SMichael Große        global $INPUT;
540f7b24f48SMichael Große        $outputTarget = $INPUT->str('outputTarget', $this->getConf('output'));
54187c86ddaSAndreas Gohr
54203352761SKirsten Roschanski        $filename = rawurlencode(cleanID(strtr($this->title, ':/;"', '    ')));
543c0956f69SMichael Große        if($outputTarget === 'file') {
5449a3c8d9fSAndreas Gohr            header('Content-Disposition: attachment; filename="' . $filename . '.pdf";');
54587c86ddaSAndreas Gohr        } else {
5469a3c8d9fSAndreas Gohr            header('Content-Disposition: inline; filename="' . $filename . '.pdf";');
54787c86ddaSAndreas Gohr        }
548ee19bac3SLuigi Micco
549b3eed6e3SGerrit Uitslag        //Bookcreator uses jQuery.fileDownload.js, which requires a cookie.
550b3eed6e3SGerrit Uitslag        header('Set-Cookie: fileDownload=true; path=/');
551b3eed6e3SGerrit Uitslag
552e993da11SGerrit Uitslag        //try to send file, and exit if done
553d63e7fe7SGerrit Uitslag        http_sendfile($cachefile);
55487c86ddaSAndreas Gohr
555d63e7fe7SGerrit Uitslag        $fp = @fopen($cachefile, "rb");
55687c86ddaSAndreas Gohr        if($fp) {
557d63e7fe7SGerrit Uitslag            http_rangeRequest($fp, filesize($cachefile), 'application/pdf');
55887c86ddaSAndreas Gohr        } else {
55987c86ddaSAndreas Gohr            header("HTTP/1.0 500 Internal Server Error");
56087c86ddaSAndreas Gohr            print "Could not read file - bad permissions?";
56187c86ddaSAndreas Gohr        }
5621ef68647SAndreas Gohr        exit();
5631ef68647SAndreas Gohr    }
5641ef68647SAndreas Gohr
5656be736bfSGerrit Uitslag    /**
5662eedf77dSAndreas Gohr     * Load the various template files and prepare the HTML/CSS for insertion
56744e8e8fbSGerrit Uitslag     *
56844e8e8fbSGerrit Uitslag     * @return array
5691ef68647SAndreas Gohr     */
57003352761SKirsten Roschanski    protected function load_template() {
5711ef68647SAndreas Gohr        global $ID;
5721ef68647SAndreas Gohr        global $conf;
5731ef68647SAndreas Gohr
5742eedf77dSAndreas Gohr        // this is what we'll return
5752eedf77dSAndreas Gohr        $output = array(
5761e45476bSmnapp            'cover' => '',
5772eedf77dSAndreas Gohr            'html'  => '',
5782eedf77dSAndreas Gohr            'page'  => '',
5792eedf77dSAndreas Gohr            'first' => '',
5802eedf77dSAndreas Gohr            'cite'  => '',
5812eedf77dSAndreas Gohr        );
5822eedf77dSAndreas Gohr
5832eedf77dSAndreas Gohr        // prepare header/footer elements
5842eedf77dSAndreas Gohr        $html = '';
58533c15297SGerrit Uitslag        foreach(array('header', 'footer') as $section) {
58633c15297SGerrit Uitslag            foreach(array('', '_odd', '_even', '_first') as $order) {
58702f9a447SGerrit Uitslag                $file = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/' . $section . $order . '.html';
58833c15297SGerrit Uitslag                if(file_exists($file)) {
58933c15297SGerrit Uitslag                    $html .= '<htmlpage' . $section . ' name="' . $section . $order . '">' . DOKU_LF;
59033c15297SGerrit Uitslag                    $html .= file_get_contents($file) . DOKU_LF;
59133c15297SGerrit Uitslag                    $html .= '</htmlpage' . $section . '>' . DOKU_LF;
5922eedf77dSAndreas Gohr
5932eedf77dSAndreas Gohr                    // register the needed pseudo CSS
59433c15297SGerrit Uitslag                    if($order == '_first') {
59533c15297SGerrit Uitslag                        $output['first'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
59633c15297SGerrit Uitslag                    } elseif($order == '_even') {
59733c15297SGerrit Uitslag                        $output['page'] .= 'even-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
59833c15297SGerrit Uitslag                    } elseif($order == '_odd') {
59933c15297SGerrit Uitslag                        $output['page'] .= 'odd-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
600daa70883SAndreas Gohr                    } else {
60133c15297SGerrit Uitslag                        $output['page'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
6022eedf77dSAndreas Gohr                    }
6032eedf77dSAndreas Gohr                }
6042eedf77dSAndreas Gohr            }
6052eedf77dSAndreas Gohr        }
6062eedf77dSAndreas Gohr
6071ef68647SAndreas Gohr        // prepare replacements
6081ef68647SAndreas Gohr        $replace = array(
6091ef68647SAndreas Gohr            '@PAGE@'    => '{PAGENO}',
61002f9a447SGerrit Uitslag            '@PAGES@'   => '{nbpg}', //see also $mpdf->pagenumSuffix = ' / '
61103352761SKirsten Roschanski            '@TITLE@'   => hsc($this->title),
6121ef68647SAndreas Gohr            '@WIKI@'    => $conf['title'],
6131ef68647SAndreas Gohr            '@WIKIURL@' => DOKU_URL,
6141ef68647SAndreas Gohr            '@DATE@'    => dformat(time()),
6155d6fbaeaSAndreas Gohr            '@BASE@'    => DOKU_BASE,
616893987a2SAndreas Gohr            '@INC@'     => DOKU_INC,
617893987a2SAndreas Gohr            '@TPLBASE@' => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
618893987a2SAndreas Gohr            '@TPLINC@'  => DOKU_INC . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/'
6191ef68647SAndreas Gohr        );
6201ef68647SAndreas Gohr
6212eedf77dSAndreas Gohr        // set HTML element
622a180c973SKlap-in        $html = str_replace(array_keys($replace), array_values($replace), $html);
623a180c973SKlap-in        //TODO For bookcreator $ID (= bookmanager page) makes no sense
624a180c973SKlap-in        $output['html'] = $this->page_depend_replacements($html, $ID);
6251ef68647SAndreas Gohr
6261e45476bSmnapp        // cover page
62702f9a447SGerrit Uitslag        $coverfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/cover.html';
62833c15297SGerrit Uitslag        if(file_exists($coverfile)) {
62933c15297SGerrit Uitslag            $output['cover'] = file_get_contents($coverfile);
6301e45476bSmnapp            $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
6319b071da5SMichael            $output['cover'] = $this->page_depend_replacements($output['cover'], $ID);
6326e2ec302SGerrit Uitslag            $output['cover'] .= '<pagebreak />';
6331e45476bSmnapp        }
6341e45476bSmnapp
63533c15297SGerrit Uitslag        // cover page
63602f9a447SGerrit Uitslag        $backfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/back.html';
63733c15297SGerrit Uitslag        if(file_exists($backfile)) {
63833c15297SGerrit Uitslag            $output['back'] = '<pagebreak />';
63933c15297SGerrit Uitslag            $output['back'] .= file_get_contents($backfile);
64033c15297SGerrit Uitslag            $output['back'] = str_replace(array_keys($replace), array_values($replace), $output['back']);
6419b071da5SMichael            $output['back'] = $this->page_depend_replacements($output['back'], $ID);
64233c15297SGerrit Uitslag        }
64333c15297SGerrit Uitslag
6442eedf77dSAndreas Gohr        // citation box
64502f9a447SGerrit Uitslag        $citationfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/citation.html';
64633c15297SGerrit Uitslag        if(file_exists($citationfile)) {
64733c15297SGerrit Uitslag            $output['cite'] = file_get_contents($citationfile);
6482eedf77dSAndreas Gohr            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
6492eedf77dSAndreas Gohr        }
6501ef68647SAndreas Gohr
6512eedf77dSAndreas Gohr        return $output;
6521ef68647SAndreas Gohr    }
6531ef68647SAndreas Gohr
6541ef68647SAndreas Gohr    /**
655a180c973SKlap-in     * @param string $raw code with placeholders
656a180c973SKlap-in     * @param string $id  pageid
657a180c973SKlap-in     * @return string
658a180c973SKlap-in     */
659a180c973SKlap-in    protected function page_depend_replacements($raw, $id) {
660e53f1ec0SSzymon Olewniczak        global $REV, $DATE_AT;
661a180c973SKlap-in
662a180c973SKlap-in        // generate qr code for this page using google infographics api
663a180c973SKlap-in        $qr_code = '';
664a180c973SKlap-in        if($this->getConf('qrcodesize')) {
665a180c973SKlap-in            $url = urlencode(wl($id, '', '&', true));
666a180c973SKlap-in            $qr_code = '<img src="https://chart.googleapis.com/chart?chs=' .
667a180c973SKlap-in                $this->getConf('qrcodesize') . '&cht=qr&chl=' . $url . '" />';
668a180c973SKlap-in        }
669a180c973SKlap-in        // prepare replacements
670a180c973SKlap-in        $replace['@ID@']      = $id;
671a180c973SKlap-in        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
672e53f1ec0SSzymon Olewniczak
673e53f1ec0SSzymon Olewniczak        $params = array();
674e53f1ec0SSzymon Olewniczak        if($DATE_AT) {
675e53f1ec0SSzymon Olewniczak            $params['at'] = $DATE_AT;
676e53f1ec0SSzymon Olewniczak        } elseif($REV) {
677e53f1ec0SSzymon Olewniczak            $params['rev'] = $REV;
678e53f1ec0SSzymon Olewniczak        }
679e53f1ec0SSzymon Olewniczak        $replace['@PAGEURL@'] = wl($id, $params, true, "&");
680a180c973SKlap-in        $replace['@QRCODE@']  = $qr_code;
681a180c973SKlap-in
682e3d68265SGerrit Uitslag        $content = str_replace(array_keys($replace), array_values($replace), $raw);
683e3d68265SGerrit Uitslag
684e3d68265SGerrit Uitslag        // @DATE(<date>[, <format>])@
685e3d68265SGerrit Uitslag        $content = preg_replace_callback(
686e3d68265SGerrit Uitslag            '/@DATE\((.*?)(?:,\s*(.*?))?\)@/',
687e3d68265SGerrit Uitslag            array($this, 'replacedate'),
688e3d68265SGerrit Uitslag            $content
689e3d68265SGerrit Uitslag        );
690e3d68265SGerrit Uitslag
691e3d68265SGerrit Uitslag        return $content;
692a180c973SKlap-in    }
693a180c973SKlap-in
694e3d68265SGerrit Uitslag
695e3d68265SGerrit Uitslag    /**
696e3d68265SGerrit Uitslag     * (callback) Replace date by request datestring
697e3d68265SGerrit Uitslag     * e.g. '%m(30-11-1975)' is replaced by '11'
698e3d68265SGerrit Uitslag     *
699e3d68265SGerrit Uitslag     * @param array $match with [0]=>whole match, [1]=> first subpattern, [2] => second subpattern
700e3d68265SGerrit Uitslag     * @return string
701e3d68265SGerrit Uitslag     */
702e3d68265SGerrit Uitslag    function replacedate($match) {
703e3d68265SGerrit Uitslag        global $conf;
704e3d68265SGerrit Uitslag        //no 2nd argument for default date format
705e3d68265SGerrit Uitslag        if($match[2] == null) {
706e3d68265SGerrit Uitslag            $match[2] = $conf['dformat'];
707e3d68265SGerrit Uitslag        }
708e3d68265SGerrit Uitslag        return strftime($match[2], strtotime($match[1]));
709e3d68265SGerrit Uitslag    }
710e3d68265SGerrit Uitslag
711a180c973SKlap-in    /**
7121c14c879SAndreas Gohr     * Load all the style sheets and apply the needed replacements
7131ef68647SAndreas Gohr     */
7141c14c879SAndreas Gohr    protected function load_css() {
715737417c6SKlap-in        global $conf;
7161c14c879SAndreas Gohr        //reusue the CSS dispatcher functions without triggering the main function
7171c14c879SAndreas Gohr        define('SIMPLE_TEST', 1);
7181c14c879SAndreas Gohr        require_once(DOKU_INC . 'lib/exe/css.php');
719ee19bac3SLuigi Micco
7201c14c879SAndreas Gohr        // prepare CSS files
7211c14c879SAndreas Gohr        $files = array_merge(
7221c14c879SAndreas Gohr            array(
7231c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/screen.css'
7241c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7251c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/print.css'
7261c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7271c14c879SAndreas Gohr            ),
72858e6409eSAndreas Gohr            $this->css_pluginPDFstyles(),
7291c14c879SAndreas Gohr            array(
7301c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.css'
7311c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7321c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/style.css'
7331c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
7341c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.local.css'
7351c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7361c14c879SAndreas Gohr            )
7371c14c879SAndreas Gohr        );
7381c14c879SAndreas Gohr        $css = '';
7391c14c879SAndreas Gohr        foreach($files as $file => $location) {
74028e636eaSGerrit Uitslag            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
74128e636eaSGerrit Uitslag            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
7421c14c879SAndreas Gohr            $css .= css_loadfile($file, $location);
7431ef68647SAndreas Gohr        }
7441ef68647SAndreas Gohr
74528e636eaSGerrit Uitslag        if(function_exists('css_parseless')) {
7461c14c879SAndreas Gohr            // apply pattern replacements
74728e636eaSGerrit Uitslag            $styleini = css_styleini($conf['template']);
74828e636eaSGerrit Uitslag            $css = css_applystyle($css, $styleini['replacements']);
74928e636eaSGerrit Uitslag
75028e636eaSGerrit Uitslag            // parse less
75128e636eaSGerrit Uitslag            $css = css_parseless($css);
75228e636eaSGerrit Uitslag        } else {
75328e636eaSGerrit Uitslag            // @deprecated 2013-12-19: fix backward compatibility
7541c14c879SAndreas Gohr            $css = css_applystyle($css, DOKU_INC . 'lib/tpl/' . $conf['template'] . '/');
75528e636eaSGerrit Uitslag        }
7561ef68647SAndreas Gohr
7571c14c879SAndreas Gohr        return $css;
758ee19bac3SLuigi Micco    }
7591c14c879SAndreas Gohr
76058e6409eSAndreas Gohr    /**
76158e6409eSAndreas Gohr     * Returns a list of possible Plugin PDF Styles
76258e6409eSAndreas Gohr     *
76358e6409eSAndreas Gohr     * Checks for a pdf.css, falls back to print.css
76458e6409eSAndreas Gohr     *
76558e6409eSAndreas Gohr     * @author Andreas Gohr <andi@splitbrain.org>
76658e6409eSAndreas Gohr     */
7676be736bfSGerrit Uitslag    protected function css_pluginPDFstyles() {
76858e6409eSAndreas Gohr        $list = array();
76958e6409eSAndreas Gohr        $plugins = plugin_list();
770f54b51f7SAndreas Gohr
771f54b51f7SAndreas Gohr        $usestyle = explode(',', $this->getConf('usestyles'));
77258e6409eSAndreas Gohr        foreach($plugins as $p) {
773f54b51f7SAndreas Gohr            if(in_array($p, $usestyle)) {
774f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/screen.css"] = DOKU_BASE . "lib/plugins/$p/";
7758003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/screen.less"] = DOKU_BASE . "lib/plugins/$p/";
7768003b493SGerrit Uitslag
777f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/style.css"] = DOKU_BASE . "lib/plugins/$p/";
7788003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/style.less"] = DOKU_BASE . "lib/plugins/$p/";
779f54b51f7SAndreas Gohr            }
780f54b51f7SAndreas Gohr
7818003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.css"] = DOKU_BASE . "lib/plugins/$p/";
7828003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.less"] = DOKU_BASE . "lib/plugins/$p/";
7838003b493SGerrit Uitslag
78458e6409eSAndreas Gohr            if(file_exists(DOKU_PLUGIN . "$p/pdf.css")) {
78558e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/pdf.css"] = DOKU_BASE . "lib/plugins/$p/";
7868003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/pdf.less"] = DOKU_BASE . "lib/plugins/$p/";
78758e6409eSAndreas Gohr            } else {
78858e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/print.css"] = DOKU_BASE . "lib/plugins/$p/";
7898003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/print.less"] = DOKU_BASE . "lib/plugins/$p/";
79058e6409eSAndreas Gohr            }
79158e6409eSAndreas Gohr        }
79258e6409eSAndreas Gohr        return $list;
79358e6409eSAndreas Gohr    }
794ad18f4e1SGerrit Uitslag
795ad18f4e1SGerrit Uitslag    /**
79660e59de7SGerrit Uitslag     * Returns array of pages which will be included in the exported pdf
79760e59de7SGerrit Uitslag     *
79860e59de7SGerrit Uitslag     * @return array
79960e59de7SGerrit Uitslag     */
80060e59de7SGerrit Uitslag    public function getExportedPages() {
80160e59de7SGerrit Uitslag        return $this->list;
80260e59de7SGerrit Uitslag    }
80360e59de7SGerrit Uitslag
80460e59de7SGerrit Uitslag    /**
805ad18f4e1SGerrit Uitslag     * usort callback to sort by file lastmodified time
80644e8e8fbSGerrit Uitslag     *
80744e8e8fbSGerrit Uitslag     * @param array $a
80844e8e8fbSGerrit Uitslag     * @param array $b
80944e8e8fbSGerrit Uitslag     * @return int
810ad18f4e1SGerrit Uitslag     */
811ad18f4e1SGerrit Uitslag    public function _datesort($a, $b) {
812ad18f4e1SGerrit Uitslag        if($b['rev'] < $a['rev']) return -1;
813ad18f4e1SGerrit Uitslag        if($b['rev'] > $a['rev']) return 1;
814ad18f4e1SGerrit Uitslag        return strcmp($b['id'], $a['id']);
815ad18f4e1SGerrit Uitslag    }
816ad18f4e1SGerrit Uitslag
817ad18f4e1SGerrit Uitslag    /**
818ad18f4e1SGerrit Uitslag     * usort callback to sort by page id
81944e8e8fbSGerrit Uitslag     * @param array $a
82044e8e8fbSGerrit Uitslag     * @param array $b
82144e8e8fbSGerrit Uitslag     * @return int
822ad18f4e1SGerrit Uitslag     */
823ad18f4e1SGerrit Uitslag    public function _pagenamesort($a, $b) {
824eea6fd2cSMichael Große        // do not sort numbers before namespace separators
825eea6fd2cSMichael Große        $aID = str_replace(':', '/', $a['id']);
826eea6fd2cSMichael Große        $bID = str_replace(':', '/', $b['id']);
827eea6fd2cSMichael Große        if($aID <= $bID) return -1;
828eea6fd2cSMichael Große        if($aID > $bID) return 1;
829ad18f4e1SGerrit Uitslag        return 0;
830ad18f4e1SGerrit Uitslag    }
83126be4eceSGerrit Uitslag
83226be4eceSGerrit Uitslag    /**
83302f9a447SGerrit Uitslag     * Return settings read from:
83402f9a447SGerrit Uitslag     *   1. url parameters
83502f9a447SGerrit Uitslag     *   2. plugin config
83602f9a447SGerrit Uitslag     *   3. global config
83702f9a447SGerrit Uitslag     *
83802f9a447SGerrit Uitslag     * @return array
83902f9a447SGerrit Uitslag     */
84002f9a447SGerrit Uitslag    protected function loadExportConfig() {
84102f9a447SGerrit Uitslag        global $INPUT;
84202f9a447SGerrit Uitslag        global $conf;
84302f9a447SGerrit Uitslag
84402f9a447SGerrit Uitslag        $this->exportConfig = array();
84502f9a447SGerrit Uitslag
84602f9a447SGerrit Uitslag        // decide on the paper setup from param or config
84702f9a447SGerrit Uitslag        $this->exportConfig['pagesize'] = $INPUT->str('pagesize', $this->getConf('pagesize'), true);
84802f9a447SGerrit Uitslag        $this->exportConfig['orientation'] = $INPUT->str('orientation', $this->getConf('orientation'), true);
84902f9a447SGerrit Uitslag
8504870b378SLarsDW223        // decide on the font-size from param or config
8514870b378SLarsDW223        $this->exportConfig['font-size'] = $INPUT->str('font-size', $this->getConf('font-size'), true);
8524870b378SLarsDW223
853213fdb75SGerrit Uitslag        $doublesided = $INPUT->bool('doublesided', (bool) $this->getConf('doublesided'));
854213fdb75SGerrit Uitslag        $this->exportConfig['doublesided'] = $doublesided ? '1' : '0';
855213fdb75SGerrit Uitslag
856213fdb75SGerrit Uitslag        $hasToC = $INPUT->bool('toc', (bool) $this->getConf('toc'));
85702f9a447SGerrit Uitslag        $levels = array();
85802f9a447SGerrit Uitslag        if($hasToC) {
85902f9a447SGerrit Uitslag            $toclevels = $INPUT->str('toclevels', $this->getConf('toclevels'), true);
86002f9a447SGerrit Uitslag            list($top_input, $max_input) = explode('-', $toclevels, 2);
86102f9a447SGerrit Uitslag            list($top_conf, $max_conf) = explode('-', $this->getConf('toclevels'), 2);
86202f9a447SGerrit Uitslag            $bounds_input = array(
86302f9a447SGerrit Uitslag                'top' => array(
86402f9a447SGerrit Uitslag                    (int) $top_input,
86502f9a447SGerrit Uitslag                    (int) $top_conf
86602f9a447SGerrit Uitslag                ),
86702f9a447SGerrit Uitslag                'max' => array(
86802f9a447SGerrit Uitslag                    (int) $max_input,
86902f9a447SGerrit Uitslag                    (int) $max_conf
87002f9a447SGerrit Uitslag                )
87102f9a447SGerrit Uitslag            );
87202f9a447SGerrit Uitslag            $bounds = array(
87302f9a447SGerrit Uitslag                'top' => $conf['toptoclevel'],
87402f9a447SGerrit Uitslag                'max' => $conf['maxtoclevel']
87502f9a447SGerrit Uitslag
87602f9a447SGerrit Uitslag            );
87702f9a447SGerrit Uitslag            foreach($bounds_input as $bound => $values) {
87802f9a447SGerrit Uitslag                foreach($values as $value) {
87902f9a447SGerrit Uitslag                    if($value > 0 && $value <= 5) {
88002f9a447SGerrit Uitslag                        //stop at valid value and store
88102f9a447SGerrit Uitslag                        $bounds[$bound] = $value;
88202f9a447SGerrit Uitslag                        break;
88302f9a447SGerrit Uitslag                    }
88402f9a447SGerrit Uitslag                }
88502f9a447SGerrit Uitslag            }
88602f9a447SGerrit Uitslag
88702f9a447SGerrit Uitslag            if($bounds['max'] < $bounds['top']) {
88802f9a447SGerrit Uitslag                $bounds['max'] = $bounds['top'];
88902f9a447SGerrit Uitslag            }
89002f9a447SGerrit Uitslag
89102f9a447SGerrit Uitslag            for($level = $bounds['top']; $level <= $bounds['max']; $level++) {
89202f9a447SGerrit Uitslag                $levels["H$level"] = $level - 1;
89302f9a447SGerrit Uitslag            }
89402f9a447SGerrit Uitslag        }
89502f9a447SGerrit Uitslag        $this->exportConfig['hasToC'] = $hasToC;
89602f9a447SGerrit Uitslag        $this->exportConfig['levels'] = $levels;
89702f9a447SGerrit Uitslag
89802f9a447SGerrit Uitslag        $this->exportConfig['maxbookmarks'] = $INPUT->int('maxbookmarks', $this->getConf('maxbookmarks'), true);
89902f9a447SGerrit Uitslag
90002f9a447SGerrit Uitslag        $tplconf = $this->getConf('template');
90105d2b507SGerrit Uitslag        $tpl = $INPUT->str('tpl', $tplconf, true);
90202f9a447SGerrit Uitslag        if(!is_dir(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl)) {
90302f9a447SGerrit Uitslag            $tpl = $tplconf;
90402f9a447SGerrit Uitslag        }
90502f9a447SGerrit Uitslag        if(!$tpl){
90602f9a447SGerrit Uitslag            $tpl = 'default';
90702f9a447SGerrit Uitslag        }
90802f9a447SGerrit Uitslag        $this->exportConfig['template'] = $tpl;
90902f9a447SGerrit Uitslag
91002f9a447SGerrit Uitslag        $this->exportConfig['isDebug'] = $conf['allowdebug'] && $INPUT->has('debughtml');
91102f9a447SGerrit Uitslag    }
91202f9a447SGerrit Uitslag
91302f9a447SGerrit Uitslag    /**
91402f9a447SGerrit Uitslag     * Returns requested config
91502f9a447SGerrit Uitslag     *
91602f9a447SGerrit Uitslag     * @param string $name
91702f9a447SGerrit Uitslag     * @param mixed  $notset
91802f9a447SGerrit Uitslag     * @return mixed|bool
91902f9a447SGerrit Uitslag     */
92002f9a447SGerrit Uitslag    public function getExportConfig($name, $notset = false) {
92102f9a447SGerrit Uitslag        if ($this->exportConfig === null){
92202f9a447SGerrit Uitslag            $this->loadExportConfig();
92302f9a447SGerrit Uitslag        }
92402f9a447SGerrit Uitslag
92502f9a447SGerrit Uitslag        if(isset($this->exportConfig[$name])){
92602f9a447SGerrit Uitslag            return $this->exportConfig[$name];
92702f9a447SGerrit Uitslag        }else{
92802f9a447SGerrit Uitslag            return $notset;
92902f9a447SGerrit Uitslag        }
93002f9a447SGerrit Uitslag    }
931d63e7fe7SGerrit Uitslag
932d63e7fe7SGerrit Uitslag    /**
933d63e7fe7SGerrit Uitslag     * Add 'export pdf'-button to pagetools
934d63e7fe7SGerrit Uitslag     *
935d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
936d63e7fe7SGerrit Uitslag     */
93744e8e8fbSGerrit Uitslag    public function addbutton(Doku_Event $event) {
938e53f1ec0SSzymon Olewniczak        global $ID, $REV, $DATE_AT;
939d63e7fe7SGerrit Uitslag
940d63e7fe7SGerrit Uitslag        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
941d63e7fe7SGerrit Uitslag            $params = array('do' => 'export_pdf');
942e53f1ec0SSzymon Olewniczak            if($DATE_AT) {
943e53f1ec0SSzymon Olewniczak                $params['at'] = $DATE_AT;
944e53f1ec0SSzymon Olewniczak            } elseif($REV) {
945d63e7fe7SGerrit Uitslag                $params['rev'] = $REV;
946d63e7fe7SGerrit Uitslag            }
947d63e7fe7SGerrit Uitslag
948d63e7fe7SGerrit Uitslag            // insert button at position before last (up to top)
949d63e7fe7SGerrit Uitslag            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
950d63e7fe7SGerrit Uitslag                array('export_pdf' =>
951d63e7fe7SGerrit Uitslag                          '<li>'
95272cadc31SChristian Paul                          . '<a href="' . wl($ID, $params) . '"  class="action export_pdf" rel="nofollow" title="' . $this->getLang('export_pdf_button') . '">'
953d63e7fe7SGerrit Uitslag                          . '<span>' . $this->getLang('export_pdf_button') . '</span>'
954d63e7fe7SGerrit Uitslag                          . '</a>'
955d63e7fe7SGerrit Uitslag                          . '</li>'
956d63e7fe7SGerrit Uitslag                ) +
957d63e7fe7SGerrit Uitslag                array_slice($event->data['items'], -1, 1, true);
958d63e7fe7SGerrit Uitslag        }
959d63e7fe7SGerrit Uitslag    }
960026b594bSAndreas Gohr
961026b594bSAndreas Gohr    /**
962026b594bSAndreas Gohr     * Add 'export pdf' button to page tools, new SVG based mechanism
963026b594bSAndreas Gohr     *
964026b594bSAndreas Gohr     * @param Doku_Event $event
965026b594bSAndreas Gohr     */
966026b594bSAndreas Gohr    public function addsvgbutton(Doku_Event $event) {
9674c493e44SGerrit Uitslag        global $INFO;
9684c493e44SGerrit Uitslag        if($event->data['view'] != 'page' || !$this->getConf('showexportbutton')) {
9694c493e44SGerrit Uitslag            return;
9704c493e44SGerrit Uitslag        }
9714c493e44SGerrit Uitslag
9724c493e44SGerrit Uitslag        if(!$INFO['exists']) {
9734c493e44SGerrit Uitslag            return;
9744c493e44SGerrit Uitslag        }
9754c493e44SGerrit Uitslag
976026b594bSAndreas Gohr        array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dw2pdf\MenuItem()]);
977026b594bSAndreas Gohr    }
978ee19bac3SLuigi Micco}
979