xref: /plugin/dw2pdf/action.php (revision 9b2636c8e79a622a49a8e1dbd87160f4a79b9da6)
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();
299b288b2aSGerrit Uitslag    protected $onetimefile = false;
301c14c879SAndreas Gohr
311c14c879SAndreas Gohr    /**
321c14c879SAndreas Gohr     * Constructor. Sets the correct template
3303352761SKirsten Roschanski     *
3403352761SKirsten Roschanski     * @param string $title
351c14c879SAndreas Gohr     */
3603352761SKirsten Roschanski    public function __construct($title=null) {
3702f9a447SGerrit Uitslag        $this->tpl   = $this->getExportConfig('template');
3803352761SKirsten Roschanski        $this->title = $title ? $title : '';
391c14c879SAndreas Gohr    }
401c14c879SAndreas Gohr
41ee19bac3SLuigi Micco    /**
429b288b2aSGerrit Uitslag     * Delete cached files that were for one-time use
439b288b2aSGerrit Uitslag     */
449b288b2aSGerrit Uitslag    public function __destruct() {
459b288b2aSGerrit Uitslag        if($this->onetimefile) {
469b288b2aSGerrit Uitslag            unlink($this->onetimefile);
479b288b2aSGerrit Uitslag        }
489b288b2aSGerrit Uitslag    }
499b288b2aSGerrit Uitslag
509b288b2aSGerrit Uitslag    /**
51ee19bac3SLuigi Micco     * Register the events
52177a7d30SGerrit Uitslag     *
53177a7d30SGerrit Uitslag     * @param Doku_Event_Handler $controller
54ee19bac3SLuigi Micco     */
556be736bfSGerrit Uitslag    public function register(Doku_Event_Handler $controller) {
56ee19bac3SLuigi Micco        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'convert', array());
576be736bfSGerrit Uitslag        $controller->register_hook('TEMPLATE_PAGETOOLS_DISPLAY', 'BEFORE', $this, 'addbutton', array());
58026b594bSAndreas Gohr        $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'addsvgbutton', array());
59ee19bac3SLuigi Micco    }
60ee19bac3SLuigi Micco
611c14c879SAndreas Gohr    /**
621c14c879SAndreas Gohr     * Do the HTML to PDF conversion work
63737417c6SKlap-in     *
64737417c6SKlap-in     * @param Doku_Event $event
651c14c879SAndreas Gohr     */
6644e8e8fbSGerrit Uitslag    public function convert(Doku_Event $event) {
672d9cd424SGerrit Uitslag        global $ID, $REV, $DATE_AT;
682d9cd424SGerrit Uitslag        global $conf, $INPUT;
69ee19bac3SLuigi Micco
701ef68647SAndreas Gohr        // our event?
71d9c13ec7SGerrit Uitslag        if(($event->data != 'export_pdfbook') && ($event->data != 'export_pdf') && ($event->data != 'export_pdfns')) return;
72ee19bac3SLuigi Micco
731ef68647SAndreas Gohr        // check user's rights
74d9c13ec7SGerrit Uitslag        if(auth_quickaclcheck($ID) < AUTH_READ) return;
751ef68647SAndreas Gohr
76d63e7fe7SGerrit Uitslag        if($data = $this->collectExportPages($event)) {
7703352761SKirsten Roschanski            list($this->title, $this->list) = $data;
78d63e7fe7SGerrit Uitslag        } else {
79d9c13ec7SGerrit Uitslag            return;
80d63e7fe7SGerrit Uitslag        }
81d63e7fe7SGerrit Uitslag
822d9cd424SGerrit Uitslag        if($event->data === 'export_pdf' && ($REV || $DATE_AT)) {
839b288b2aSGerrit Uitslag            $cachefile = tempnam($conf['tmpdir'] . '/dwpdf', 'dw2pdf_');
849b288b2aSGerrit Uitslag            $this->onetimefile = $cachefile;
85f00df45eSMichael Große            $generateNewPdf = true;
86f00df45eSMichael Große        } else {
87a58f45f0SGerrit Uitslag            // prepare cache and its dependencies
88a58f45f0SGerrit Uitslag            $depends = array();
8903352761SKirsten Roschanski            $cache = $this->prepareCache($depends);
909b288b2aSGerrit Uitslag            $cachefile = $cache->cache;
9127195d5bSMichael Große            $generateNewPdf = !$this->getConf('usecache')
9227195d5bSMichael Große                || $this->getExportConfig('isDebug')
9327195d5bSMichael Große                || !$cache->useCache($depends);
94f00df45eSMichael Große        }
95d63e7fe7SGerrit Uitslag
96bd977188SGerrit Uitslag        // hard work only when no cache available or needed for debugging
97f00df45eSMichael Große        if($generateNewPdf) {
98e5f6c2cbSMichael Große            // generating the pdf may take a long time for larger wikis / namespaces with many pages
99e5f6c2cbSMichael Große            set_time_limit(0);
100b34cb34eSSzymon Olewniczak            try {
1019b288b2aSGerrit Uitslag                $this->generatePDF($cachefile, $event);
102b34cb34eSSzymon Olewniczak            } catch(Mpdf\MpdfException $e) {
1032d9cd424SGerrit Uitslag                if($INPUT->has('selection')) {
1042d9cd424SGerrit Uitslag                    http_status(400);
1052d9cd424SGerrit Uitslag                    print $e->getMessage();
1062d9cd424SGerrit Uitslag                    exit();
1072d9cd424SGerrit Uitslag                } else {
108b34cb34eSSzymon Olewniczak                    //prevent act_export()
1092d9cd424SGerrit Uitslag                    $event->data = 'show';
110b34cb34eSSzymon Olewniczak                    msg($e->getMessage(), -1);
1112d9cd424SGerrit Uitslag                    $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
112d9c13ec7SGerrit Uitslag                    return;
113b34cb34eSSzymon Olewniczak                }
114d63e7fe7SGerrit Uitslag            }
1152d9cd424SGerrit Uitslag        }
1162d9cd424SGerrit Uitslag
1172d9cd424SGerrit Uitslag        $event->preventDefault(); // after prevent, $event->data cannot be changed
118d63e7fe7SGerrit Uitslag
119d63e7fe7SGerrit Uitslag        // deliver the file
1209b288b2aSGerrit Uitslag        $this->sendPDFFile($cachefile);  //exits
121d63e7fe7SGerrit Uitslag    }
122d63e7fe7SGerrit Uitslag
123d63e7fe7SGerrit Uitslag    /**
124d63e7fe7SGerrit Uitslag     * Obtain list of pages and title, based on url parameters
125d63e7fe7SGerrit Uitslag     *
126d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
127d63e7fe7SGerrit Uitslag     * @return string|bool
128d63e7fe7SGerrit Uitslag     */
129d63e7fe7SGerrit Uitslag    protected function collectExportPages(Doku_Event $event) {
13036a7917dSGerrit Uitslag        global $ID, $REV;
131d63e7fe7SGerrit Uitslag        global $INPUT;
132d63e7fe7SGerrit Uitslag        global $conf;
133d63e7fe7SGerrit Uitslag
134d63e7fe7SGerrit Uitslag        // list of one or multiple pages
135d63e7fe7SGerrit Uitslag        $list = array();
13628e636eaSGerrit Uitslag
1374b4cebc2SLarsDW223        if($event->data == 'export_pdf') {
138d63e7fe7SGerrit Uitslag            $list[0] = $ID;
13903352761SKirsten Roschanski            $this->title = $INPUT->str('pdftitle'); //DEPRECATED
14003352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
14103352761SKirsten Roschanski            if(empty($this->title)) {
14203352761SKirsten Roschanski                $this->title = p_get_first_heading($ID);
14315923cb9SGerrit Uitslag            }
144ad18f4e1SGerrit Uitslag
14536a7917dSGerrit Uitslag            $filename = wikiFN($ID, $REV);
14636a7917dSGerrit Uitslag            if(!file_exists($filename)) {
14736a7917dSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'notexist');
14836a7917dSGerrit Uitslag                return false;
14936a7917dSGerrit Uitslag            }
15036a7917dSGerrit Uitslag
1514b4cebc2SLarsDW223        } elseif($event->data == 'export_pdfns') {
152ad18f4e1SGerrit Uitslag            //check input for title and ns
15303352761SKirsten Roschanski            if(!$this->title = $INPUT->str('book_title')) {
15426be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
155ad18f4e1SGerrit Uitslag                return false;
156ad18f4e1SGerrit Uitslag            }
157177a7d30SGerrit Uitslag            $pdfnamespace = cleanID($INPUT->str('book_ns'));
158ad18f4e1SGerrit Uitslag            if(!@is_dir(dirname(wikiFN($pdfnamespace . ':dummy')))) {
15926be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needns');
160ad18f4e1SGerrit Uitslag                return false;
161ad18f4e1SGerrit Uitslag            }
162ad18f4e1SGerrit Uitslag
16326be4eceSGerrit Uitslag            //sort order
164177a7d30SGerrit Uitslag            $order = $INPUT->str('book_order', 'natural', true);
165ad18f4e1SGerrit Uitslag            $sortoptions = array('pagename', 'date', 'natural');
166ad18f4e1SGerrit Uitslag            if(!in_array($order, $sortoptions)) {
167ad18f4e1SGerrit Uitslag                $order = 'natural';
168ad18f4e1SGerrit Uitslag            }
169ad18f4e1SGerrit Uitslag
17026be4eceSGerrit Uitslag            //search depth
171177a7d30SGerrit Uitslag            $depth = $INPUT->int('book_nsdepth', 0);
172ad18f4e1SGerrit Uitslag            if($depth < 0) {
173ad18f4e1SGerrit Uitslag                $depth = 0;
174ad18f4e1SGerrit Uitslag            }
17526be4eceSGerrit Uitslag
176ad18f4e1SGerrit Uitslag            //page search
177ad18f4e1SGerrit Uitslag            $result = array();
178ad18f4e1SGerrit Uitslag            $opts = array('depth' => $depth); //recursive all levels
179ad18f4e1SGerrit Uitslag            $dir = utf8_encodeFN(str_replace(':', '/', $pdfnamespace));
180ad18f4e1SGerrit Uitslag            search($result, $conf['datadir'], 'search_allpages', $opts, $dir);
181ad18f4e1SGerrit Uitslag
18226be4eceSGerrit Uitslag            //sorting
183ad18f4e1SGerrit Uitslag            if(count($result) > 0) {
184ad18f4e1SGerrit Uitslag                if($order == 'date') {
185ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_datesort'));
186ad18f4e1SGerrit Uitslag                } elseif($order == 'pagename') {
187ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_pagenamesort'));
188ad18f4e1SGerrit Uitslag                }
189ad18f4e1SGerrit Uitslag            }
190ad18f4e1SGerrit Uitslag
191ad18f4e1SGerrit Uitslag            foreach($result as $item) {
192d63e7fe7SGerrit Uitslag                $list[] = $item['id'];
193ad18f4e1SGerrit Uitslag            }
194ad18f4e1SGerrit Uitslag
195baa31dc5SGerrit Uitslag            if ($pdfnamespace !== '') {
196baa31dc5SGerrit Uitslag                if (!in_array($pdfnamespace . ':' . $conf['start'], $list, true)) {
197baa31dc5SGerrit Uitslag                    if (file_exists(wikiFN(rtrim($pdfnamespace,':')))) {
198baa31dc5SGerrit Uitslag                        array_unshift($list,rtrim($pdfnamespace,':'));
199baa31dc5SGerrit Uitslag                    }
200baa31dc5SGerrit Uitslag                }
201baa31dc5SGerrit Uitslag            }
202baa31dc5SGerrit Uitslag
203737417c6SKlap-in        } elseif(isset($_COOKIE['list-pagelist']) && !empty($_COOKIE['list-pagelist'])) {
204b3eed6e3SGerrit Uitslag            /** @deprecated  April 2016 replaced by localStorage version of Bookcreator*/
20526be4eceSGerrit Uitslag            //is in Bookmanager of bookcreator plugin a title given?
20603352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
20703352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
20803352761SKirsten Roschanski            if(empty($this->title)) {
20926be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
210737417c6SKlap-in                return false;
21126be4eceSGerrit Uitslag            } else {
212d63e7fe7SGerrit Uitslag                $list = explode("|", $_COOKIE['list-pagelist']);
21326be4eceSGerrit Uitslag            }
214ad18f4e1SGerrit Uitslag
215b3eed6e3SGerrit Uitslag        } elseif($INPUT->has('selection')) {
216b3eed6e3SGerrit Uitslag            //handle Bookcreator requests based at localStorage
217b3eed6e3SGerrit Uitslag//            if(!checkSecurityToken()) {
218b3eed6e3SGerrit Uitslag//                http_status(403);
219b3eed6e3SGerrit Uitslag//                print $this->getLang('empty');
220b3eed6e3SGerrit Uitslag//                exit();
221b3eed6e3SGerrit Uitslag//            }
222b3eed6e3SGerrit Uitslag
223b3eed6e3SGerrit Uitslag            $json = new JSON(JSON_LOOSE_TYPE);
224b3eed6e3SGerrit Uitslag            $list = $json->decode($INPUT->post->str('selection', '', true));
225b3eed6e3SGerrit Uitslag            if(!is_array($list) || empty($list)) {
226b3eed6e3SGerrit Uitslag                http_status(400);
227b3eed6e3SGerrit Uitslag                print $this->getLang('empty');
228b3eed6e3SGerrit Uitslag                exit();
229b3eed6e3SGerrit Uitslag            }
230b3eed6e3SGerrit Uitslag
23103352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
23203352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
23303352761SKirsten Roschanski            if(empty($this->title)) {
234b3eed6e3SGerrit Uitslag                http_status(400);
235b3eed6e3SGerrit Uitslag                print $this->getLang('needtitle');
236b3eed6e3SGerrit Uitslag                exit();
237b3eed6e3SGerrit Uitslag            }
238b3eed6e3SGerrit Uitslag
239737417c6SKlap-in        } else {
24026be4eceSGerrit Uitslag            //show empty bookcreator message
24126be4eceSGerrit Uitslag            $this->showPageWithErrorMsg($event, 'empty');
242737417c6SKlap-in            return false;
243737417c6SKlap-in        }
244737417c6SKlap-in
245719256adSGerrit Uitslag        $list = array_map('cleanID', $list);
246c7138b3fSGerrit Uitslag
247c7138b3fSGerrit Uitslag        $skippedpages = array();
248c7138b3fSGerrit Uitslag        foreach($list as $index => $pageid) {
249c7138b3fSGerrit Uitslag            if(auth_quickaclcheck($pageid) < AUTH_READ) {
250c7138b3fSGerrit Uitslag                $skippedpages[] = $pageid;
251c7138b3fSGerrit Uitslag                unset($list[$index]);
252c7138b3fSGerrit Uitslag            }
253c7138b3fSGerrit Uitslag        }
254c7138b3fSGerrit Uitslag        $list = array_filter($list); //removes also pages mentioned '0'
255c7138b3fSGerrit Uitslag
256c7138b3fSGerrit Uitslag        //if selection contains forbidden pages throw (overridable) warning
257c7138b3fSGerrit Uitslag        if(!$INPUT->bool('book_skipforbiddenpages') && !empty($skippedpages)) {
258c7138b3fSGerrit Uitslag            $msg = hsc(join(', ', $skippedpages));
259c7138b3fSGerrit Uitslag            if($INPUT->has('selection')) {
260c7138b3fSGerrit Uitslag                http_status(400);
261c7138b3fSGerrit Uitslag                print sprintf($this->getLang('forbidden'), $msg);
262c7138b3fSGerrit Uitslag                exit();
263c7138b3fSGerrit Uitslag            } else {
264c7138b3fSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'forbidden', $msg);
265c7138b3fSGerrit Uitslag                return false;
266c7138b3fSGerrit Uitslag            }
267c7138b3fSGerrit Uitslag
268c7138b3fSGerrit Uitslag        }
269c7138b3fSGerrit Uitslag
27003352761SKirsten Roschanski        return array($this->title, $list);
271d63e7fe7SGerrit Uitslag    }
272d63e7fe7SGerrit Uitslag
273a58f45f0SGerrit Uitslag    /**
274a58f45f0SGerrit Uitslag     * Prepare cache
275a58f45f0SGerrit Uitslag     *
276a58f45f0SGerrit Uitslag     * @param array  $depends (reference) array with dependencies
277a58f45f0SGerrit Uitslag     * @return cache
278a58f45f0SGerrit Uitslag     */
27903352761SKirsten Roschanski    protected function prepareCache(&$depends) {
280a58f45f0SGerrit Uitslag        global $REV;
281a58f45f0SGerrit Uitslag
282ee19bac3SLuigi Micco        $cachekey = join(',', $this->list)
283ee19bac3SLuigi Micco            . $REV
284ee19bac3SLuigi Micco            . $this->getExportConfig('template')
285ee19bac3SLuigi Micco            . $this->getExportConfig('pagesize')
286ee19bac3SLuigi Micco            . $this->getExportConfig('orientation')
287d83760efSGerrit Uitslag            . $this->getExportConfig('font-size')
288ee19bac3SLuigi Micco            . $this->getExportConfig('doublesided')
289ee19bac3SLuigi Micco            . ($this->getExportConfig('hasToC') ? join('-', $this->getExportConfig('levels')) : '0')
29003352761SKirsten Roschanski            . $this->title;
291ee19bac3SLuigi Micco        $cache = new cache($cachekey, '.dw2.pdf');
292ee19bac3SLuigi Micco
293ee19bac3SLuigi Micco        $dependencies = array();
294ee19bac3SLuigi Micco        foreach($this->list as $pageid) {
295ee19bac3SLuigi Micco            $relations = p_get_metadata($pageid, 'relation');
296ee19bac3SLuigi Micco
297ee19bac3SLuigi Micco            if(is_array($relations)) {
298ee19bac3SLuigi Micco                if(array_key_exists('media', $relations) && is_array($relations['media'])) {
299ee19bac3SLuigi Micco                    foreach($relations['media'] as $mediaid => $exists) {
300ee19bac3SLuigi Micco                        if($exists) {
301ee19bac3SLuigi Micco                            $dependencies[] = mediaFN($mediaid);
302ee19bac3SLuigi Micco                        }
303ee19bac3SLuigi Micco                    }
304ee19bac3SLuigi Micco                }
305ee19bac3SLuigi Micco
306ee19bac3SLuigi Micco                if(array_key_exists('haspart', $relations) && is_array($relations['haspart'])) {
307ee19bac3SLuigi Micco                    foreach($relations['haspart'] as $part_pageid => $exists) {
308ee19bac3SLuigi Micco                        if($exists) {
309ee19bac3SLuigi Micco                            $dependencies[] = wikiFN($part_pageid);
310ee19bac3SLuigi Micco                        }
311ee19bac3SLuigi Micco                    }
312ee19bac3SLuigi Micco                }
313ee19bac3SLuigi Micco            }
314ee19bac3SLuigi Micco
315ee19bac3SLuigi Micco            $dependencies[] = metaFN($pageid, '.meta');
316ee19bac3SLuigi Micco        }
317ee19bac3SLuigi Micco
318ee19bac3SLuigi Micco        $depends['files'] = array_map('wikiFN', $this->list);
319ee19bac3SLuigi Micco        $depends['files'][] = __FILE__;
320ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/renderer.php';
321ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/mpdf/mpdf.php';
322ee19bac3SLuigi Micco        $depends['files'] = array_merge(
323ee19bac3SLuigi Micco            $depends['files'],
324ee19bac3SLuigi Micco            $dependencies,
325ee19bac3SLuigi Micco            getConfigFiles('main')
326ee19bac3SLuigi Micco        );
327a58f45f0SGerrit Uitslag        return $cache;
328ee19bac3SLuigi Micco    }
329ee19bac3SLuigi Micco
330d63e7fe7SGerrit Uitslag    /**
331d63e7fe7SGerrit Uitslag     * Set error notification and reload page again
332d63e7fe7SGerrit Uitslag     *
333d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
334d63e7fe7SGerrit Uitslag     * @param string $msglangkey key of translation key
335c7138b3fSGerrit Uitslag     * @param string $replacement
336d63e7fe7SGerrit Uitslag     */
337c7138b3fSGerrit Uitslag    private function showPageWithErrorMsg(Doku_Event $event, $msglangkey, $replacement=null) {
338c7138b3fSGerrit Uitslag        if(empty($replacement)) {
339c7138b3fSGerrit Uitslag            $msg = $this->getLang($msglangkey);
340c7138b3fSGerrit Uitslag        } else {
341c7138b3fSGerrit Uitslag            $msg = sprintf($this->getLang($msglangkey), $replacement);
342c7138b3fSGerrit Uitslag        }
343c7138b3fSGerrit Uitslag        msg($msg, -1);
344d63e7fe7SGerrit Uitslag
345d63e7fe7SGerrit Uitslag        $event->data = 'show';
346d63e7fe7SGerrit Uitslag        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
347d63e7fe7SGerrit Uitslag    }
348d63e7fe7SGerrit Uitslag
349d63e7fe7SGerrit Uitslag    /**
350e53f1ec0SSzymon Olewniczak     * Returns the parsed Wikitext in dw2pdf for the given id and revision
351e53f1ec0SSzymon Olewniczak     *
352e53f1ec0SSzymon Olewniczak     * @param string     $id  page id
353e53f1ec0SSzymon Olewniczak     * @param string|int $rev revision timestamp or empty string
354e53f1ec0SSzymon Olewniczak     * @param string     $date_at
355e53f1ec0SSzymon Olewniczak     * @return null|string
356e53f1ec0SSzymon Olewniczak     */
357e53f1ec0SSzymon Olewniczak    protected function p_wiki_dw2pdf($id, $rev = '', $date_at = '') {
358e53f1ec0SSzymon Olewniczak        $file = wikiFN($id, $rev);
359e53f1ec0SSzymon Olewniczak
360e53f1ec0SSzymon Olewniczak        if(!file_exists($file)) return '';
361e53f1ec0SSzymon Olewniczak
362e53f1ec0SSzymon Olewniczak        //ensure $id is in global $ID (needed for parsing)
363e53f1ec0SSzymon Olewniczak        global $ID;
364e53f1ec0SSzymon Olewniczak        $keep = $ID;
365e53f1ec0SSzymon Olewniczak        $ID   = $id;
366e53f1ec0SSzymon Olewniczak
367e53f1ec0SSzymon Olewniczak        if($rev || $date_at) {
368e53f1ec0SSzymon Olewniczak            $ret = p_render('dw2pdf', p_get_instructions(io_readWikiPage($file, $id, $rev)), $info, $date_at); //no caching on old revisions
369e53f1ec0SSzymon Olewniczak        } else {
370e53f1ec0SSzymon Olewniczak            $ret = p_cached_output($file, 'dw2pdf', $id);
371e53f1ec0SSzymon Olewniczak        }
372e53f1ec0SSzymon Olewniczak
373e53f1ec0SSzymon Olewniczak        //restore ID (just in case)
374e53f1ec0SSzymon Olewniczak        $ID = $keep;
375e53f1ec0SSzymon Olewniczak
376e53f1ec0SSzymon Olewniczak        return $ret;
377e53f1ec0SSzymon Olewniczak    }
378e53f1ec0SSzymon Olewniczak
379e53f1ec0SSzymon Olewniczak    /**
380d63e7fe7SGerrit Uitslag     * Build a pdf from the html
381d63e7fe7SGerrit Uitslag     *
382d63e7fe7SGerrit Uitslag     * @param string $cachefile
383d9c13ec7SGerrit Uitslag     * @param Doku_Event $event
384d63e7fe7SGerrit Uitslag     */
3852d9cd424SGerrit Uitslag    protected function generatePDF($cachefile, $event) {
3862d9cd424SGerrit Uitslag        global $REV, $INPUT, $DATE_AT;
387e53f1ec0SSzymon Olewniczak
3882d9cd424SGerrit Uitslag        if ($event->data == 'export_pdf') { //only one page is exported
389e53f1ec0SSzymon Olewniczak            $rev = $REV;
390e53f1ec0SSzymon Olewniczak            $date_at = $DATE_AT;
391e53f1ec0SSzymon Olewniczak        } else { //we are exporting entre namespace, ommit revisions
392e53f1ec0SSzymon Olewniczak            $rev = $date_at = '';
393e53f1ec0SSzymon Olewniczak        }
39487c86ddaSAndreas Gohr
39502f9a447SGerrit Uitslag        //some shortcuts to export settings
39602f9a447SGerrit Uitslag        $hasToC = $this->getExportConfig('hasToC');
39702f9a447SGerrit Uitslag        $levels = $this->getExportConfig('levels');
39802f9a447SGerrit Uitslag        $isDebug = $this->getExportConfig('isDebug');
3996ea88a05SAndreas Gohr
4001ef68647SAndreas Gohr        // initialize PDF library
401cde5a1b3SAndreas Gohr        require_once(dirname(__FILE__) . "/DokuPDF.class.php");
4026ea88a05SAndreas Gohr
4034870b378SLarsDW223        $mpdf = new DokuPDF($this->getExportConfig('pagesize'),
4044870b378SLarsDW223                            $this->getExportConfig('orientation'),
4054870b378SLarsDW223                            $this->getExportConfig('font-size'));
406ee19bac3SLuigi Micco
407d62df65bSAndreas Gohr        // let mpdf fix local links
408d62df65bSAndreas Gohr        $self = parse_url(DOKU_URL);
409d62df65bSAndreas Gohr        $url = $self['scheme'] . '://' . $self['host'];
41002f9a447SGerrit Uitslag        if($self['port']) {
41102f9a447SGerrit Uitslag            $url .= ':' . $self['port'];
41202f9a447SGerrit Uitslag        }
413d9c13ec7SGerrit Uitslag        $mpdf->SetBasePath($url);
414d62df65bSAndreas Gohr
41556d13144SAndreas Gohr        // Set the title
41603352761SKirsten Roschanski        $mpdf->SetTitle($this->title);
41756d13144SAndreas Gohr
418d63e7fe7SGerrit Uitslag        // some default document settings
419d63e7fe7SGerrit Uitslag        //note: double-sided document, starts at an odd page (first page is a right-hand side page)
420213fdb75SGerrit Uitslag        //      single-side document has only odd pages
421213fdb75SGerrit Uitslag        $mpdf->mirrorMargins = $this->getExportConfig('doublesided');
422daa70883SAndreas Gohr        $mpdf->setAutoTopMargin = 'stretch';
423daa70883SAndreas Gohr        $mpdf->setAutoBottomMargin = 'stretch';
42402f9a447SGerrit Uitslag//            $mpdf->pagenumSuffix = '/'; //prefix for {nbpg}
42502f9a447SGerrit Uitslag        if($hasToC) {
42602f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => 'i', 'suppress' => 'off'); //use italic pageno until ToC
42702f9a447SGerrit Uitslag            $mpdf->h2toc = $levels;
42802f9a447SGerrit Uitslag        } else {
42902f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => '1', 'suppress' => 'off');
43002f9a447SGerrit Uitslag        }
4312eedf77dSAndreas Gohr
43256d13144SAndreas Gohr        // load the template
43303352761SKirsten Roschanski        $template = $this->load_template();
434ee19bac3SLuigi Micco
4351ef68647SAndreas Gohr        // prepare HTML header styles
436a2c33768SGerrit Uitslag        $html = '';
43702f9a447SGerrit Uitslag        if($isDebug) {
438a2c33768SGerrit Uitslag            $html .= '<html><head>';
439737417c6SKlap-in            $html .= '<style type="text/css">';
440a2c33768SGerrit Uitslag        }
441db1aa1bfSKirsten Roschanski
442db1aa1bfSKirsten Roschanski        $styles = '@page { size:auto; ' . $template['page'] . '}';
443a2c33768SGerrit Uitslag        $styles .= '@page :first {' . $template['first'] . '}';
444254467c4SGerrit Uitslag
445254467c4SGerrit Uitslag        $styles .= '@page landscape-page { size:landscape }';
446254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-landscape { page:landscape-page }';
447254467c4SGerrit Uitslag        $styles .= '@page portrait-page { size:portrait }';
448254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-portrait { page:portrait-page }';
449db1aa1bfSKirsten Roschanski        $styles .= $this->load_css();
450254467c4SGerrit Uitslag
451a2c33768SGerrit Uitslag        $mpdf->WriteHTML($styles, 1);
452a2c33768SGerrit Uitslag
45302f9a447SGerrit Uitslag        if($isDebug) {
454a2c33768SGerrit Uitslag            $html .= $styles;
4551ef68647SAndreas Gohr            $html .= '</style>';
4561ef68647SAndreas Gohr            $html .= '</head><body>';
457a2c33768SGerrit Uitslag        }
458a2c33768SGerrit Uitslag
459a2c33768SGerrit Uitslag        $body_start = $template['html'];
460a2c33768SGerrit Uitslag        $body_start .= '<div class="dokuwiki">';
4612eedf77dSAndreas Gohr
4621e45476bSmnapp        // insert the cover page
463a2c33768SGerrit Uitslag        $body_start .= $template['cover'];
464a2c33768SGerrit Uitslag
465a2c33768SGerrit Uitslag        $mpdf->WriteHTML($body_start, 2, true, false); //start body html
46602f9a447SGerrit Uitslag        if($isDebug) {
467a2c33768SGerrit Uitslag            $html .= $body_start;
468a2c33768SGerrit Uitslag        }
46902f9a447SGerrit Uitslag        if($hasToC) {
47002f9a447SGerrit 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
47102f9a447SGerrit Uitslag            //      - first page of ToC starts always at odd page (so eventually an additional blank page is included before)
47202f9a447SGerrit Uitslag            //      - there is no page numbering at the pages of the ToC
47302f9a447SGerrit Uitslag            $mpdf->TOCpagebreakByArray(
47402f9a447SGerrit Uitslag                array(
475230b098dSGerrit Uitslag                    'toc-preHTML' => '<h2>' . $this->getLang('tocheader') . '</h2>',
476230b098dSGerrit Uitslag                    'toc-bookmarkText' => $this->getLang('tocheader'),
47702f9a447SGerrit Uitslag                    'links' => true,
47802f9a447SGerrit Uitslag                    'outdent' => '1em',
47902f9a447SGerrit Uitslag                    'resetpagenum' => true, //start pagenumbering after ToC
48002f9a447SGerrit Uitslag                    'pagenumstyle' => '1'
48102f9a447SGerrit Uitslag                )
48202f9a447SGerrit Uitslag            );
48302f9a447SGerrit Uitslag            $html .= '<tocpagebreak>';
48402f9a447SGerrit Uitslag        }
48502f9a447SGerrit Uitslag
4861ef68647SAndreas Gohr        // loop over all pages
487c7138b3fSGerrit Uitslag        $counter = 0;
488c7138b3fSGerrit Uitslag        $no_pages = count($this->list);
489c7138b3fSGerrit Uitslag        foreach($this->list as $page) {
490c7138b3fSGerrit Uitslag            $counter++;
491b3eed6e3SGerrit Uitslag
49279be256fSMichael Große            $pagehtml = $this->p_wiki_dw2pdf($page, $rev, $date_at);
493e53f1ec0SSzymon Olewniczak            //file doesn't exists
494e53f1ec0SSzymon Olewniczak            if($pagehtml == '') {
495b3eed6e3SGerrit Uitslag                continue;
496b3eed6e3SGerrit Uitslag            }
497719256adSGerrit Uitslag            $pagehtml .= $this->page_depend_replacements($template['cite'], $page);
498c7138b3fSGerrit Uitslag            if($counter < $no_pages) {
499a2c33768SGerrit Uitslag                $pagehtml .= '<pagebreak />';
500a2c33768SGerrit Uitslag            }
501a2c33768SGerrit Uitslag
502a2c33768SGerrit Uitslag            $mpdf->WriteHTML($pagehtml, 2, false, false); //intermediate body html
50302f9a447SGerrit Uitslag            if($isDebug) {
504a2c33768SGerrit Uitslag                $html .= $pagehtml;
5051ef68647SAndreas Gohr            }
506ee19bac3SLuigi Micco        }
507ee19bac3SLuigi Micco
50833c15297SGerrit Uitslag        // insert the back page
509a2c33768SGerrit Uitslag        $body_end = $template['back'];
51033c15297SGerrit Uitslag
511a2c33768SGerrit Uitslag        $body_end .= '</div>';
512a2c33768SGerrit Uitslag
513d63e7fe7SGerrit Uitslag        $mpdf->WriteHTML($body_end, 2, false, true); // finish body html
51402f9a447SGerrit Uitslag        if($isDebug) {
515a2c33768SGerrit Uitslag            $html .= $body_end;
516eeb17e15SAndreas Gohr            $html .= '</body>';
517eeb17e15SAndreas Gohr            $html .= '</html>';
518a2c33768SGerrit Uitslag        }
519f765508eSGerrit Uitslag
520f765508eSGerrit Uitslag        //Return html for debugging
52102f9a447SGerrit Uitslag        if($isDebug) {
52202f9a447SGerrit Uitslag            if($INPUT->str('debughtml', 'text', true) == 'html') {
52326be4eceSGerrit Uitslag                echo $html;
524a2c33768SGerrit Uitslag            } else {
525a2c33768SGerrit Uitslag                header('Content-Type: text/plain; charset=utf-8');
526a2c33768SGerrit Uitslag                echo $html;
527a2c33768SGerrit Uitslag            }
52826be4eceSGerrit Uitslag            exit();
52926be4eceSGerrit Uitslag        };
530f765508eSGerrit Uitslag
53187c86ddaSAndreas Gohr        // write to cache file
532d63e7fe7SGerrit Uitslag        $mpdf->Output($cachefile, 'F');
53387c86ddaSAndreas Gohr    }
53487c86ddaSAndreas Gohr
535d63e7fe7SGerrit Uitslag    /**
536d63e7fe7SGerrit Uitslag     * @param string $cachefile
537d63e7fe7SGerrit Uitslag     */
53803352761SKirsten Roschanski    protected function sendPDFFile($cachefile) {
53987c86ddaSAndreas Gohr        header('Content-Type: application/pdf');
540b853b723SAndreas Gohr        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
54187c86ddaSAndreas Gohr        header('Pragma: public');
542d63e7fe7SGerrit Uitslag        http_conditionalRequest(filemtime($cachefile));
543c0956f69SMichael Große        global $INPUT;
544f7b24f48SMichael Große        $outputTarget = $INPUT->str('outputTarget', $this->getConf('output'));
54587c86ddaSAndreas Gohr
54603352761SKirsten Roschanski        $filename = rawurlencode(cleanID(strtr($this->title, ':/;"', '    ')));
547c0956f69SMichael Große        if($outputTarget === 'file') {
5489a3c8d9fSAndreas Gohr            header('Content-Disposition: attachment; filename="' . $filename . '.pdf";');
54987c86ddaSAndreas Gohr        } else {
5509a3c8d9fSAndreas Gohr            header('Content-Disposition: inline; filename="' . $filename . '.pdf";');
55187c86ddaSAndreas Gohr        }
552ee19bac3SLuigi Micco
553b3eed6e3SGerrit Uitslag        //Bookcreator uses jQuery.fileDownload.js, which requires a cookie.
554b3eed6e3SGerrit Uitslag        header('Set-Cookie: fileDownload=true; path=/');
555b3eed6e3SGerrit Uitslag
556e993da11SGerrit Uitslag        //try to send file, and exit if done
557d63e7fe7SGerrit Uitslag        http_sendfile($cachefile);
55887c86ddaSAndreas Gohr
559d63e7fe7SGerrit Uitslag        $fp = @fopen($cachefile, "rb");
56087c86ddaSAndreas Gohr        if($fp) {
561d63e7fe7SGerrit Uitslag            http_rangeRequest($fp, filesize($cachefile), 'application/pdf');
56287c86ddaSAndreas Gohr        } else {
56387c86ddaSAndreas Gohr            header("HTTP/1.0 500 Internal Server Error");
56487c86ddaSAndreas Gohr            print "Could not read file - bad permissions?";
56587c86ddaSAndreas Gohr        }
5661ef68647SAndreas Gohr        exit();
5671ef68647SAndreas Gohr    }
5681ef68647SAndreas Gohr
5696be736bfSGerrit Uitslag    /**
5702eedf77dSAndreas Gohr     * Load the various template files and prepare the HTML/CSS for insertion
57144e8e8fbSGerrit Uitslag     *
57244e8e8fbSGerrit Uitslag     * @return array
5731ef68647SAndreas Gohr     */
57403352761SKirsten Roschanski    protected function load_template() {
5751ef68647SAndreas Gohr        global $ID;
5761ef68647SAndreas Gohr        global $conf;
5771ef68647SAndreas Gohr
5782eedf77dSAndreas Gohr        // this is what we'll return
5792eedf77dSAndreas Gohr        $output = array(
5801e45476bSmnapp            'cover' => '',
5812eedf77dSAndreas Gohr            'html'  => '',
5822eedf77dSAndreas Gohr            'page'  => '',
5832eedf77dSAndreas Gohr            'first' => '',
5842eedf77dSAndreas Gohr            'cite'  => '',
5852eedf77dSAndreas Gohr        );
5862eedf77dSAndreas Gohr
5872eedf77dSAndreas Gohr        // prepare header/footer elements
5882eedf77dSAndreas Gohr        $html = '';
58933c15297SGerrit Uitslag        foreach(array('header', 'footer') as $section) {
59033c15297SGerrit Uitslag            foreach(array('', '_odd', '_even', '_first') as $order) {
59102f9a447SGerrit Uitslag                $file = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/' . $section . $order . '.html';
59233c15297SGerrit Uitslag                if(file_exists($file)) {
59333c15297SGerrit Uitslag                    $html .= '<htmlpage' . $section . ' name="' . $section . $order . '">' . DOKU_LF;
59433c15297SGerrit Uitslag                    $html .= file_get_contents($file) . DOKU_LF;
59533c15297SGerrit Uitslag                    $html .= '</htmlpage' . $section . '>' . DOKU_LF;
5962eedf77dSAndreas Gohr
5972eedf77dSAndreas Gohr                    // register the needed pseudo CSS
59833c15297SGerrit Uitslag                    if($order == '_first') {
59933c15297SGerrit Uitslag                        $output['first'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
60033c15297SGerrit Uitslag                    } elseif($order == '_even') {
60133c15297SGerrit Uitslag                        $output['page'] .= 'even-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
60233c15297SGerrit Uitslag                    } elseif($order == '_odd') {
60333c15297SGerrit Uitslag                        $output['page'] .= 'odd-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
604daa70883SAndreas Gohr                    } else {
60533c15297SGerrit Uitslag                        $output['page'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
6062eedf77dSAndreas Gohr                    }
6072eedf77dSAndreas Gohr                }
6082eedf77dSAndreas Gohr            }
6092eedf77dSAndreas Gohr        }
6102eedf77dSAndreas Gohr
6111ef68647SAndreas Gohr        // prepare replacements
6121ef68647SAndreas Gohr        $replace = array(
6131ef68647SAndreas Gohr            '@PAGE@'    => '{PAGENO}',
61402f9a447SGerrit Uitslag            '@PAGES@'   => '{nbpg}', //see also $mpdf->pagenumSuffix = ' / '
61503352761SKirsten Roschanski            '@TITLE@'   => hsc($this->title),
6161ef68647SAndreas Gohr            '@WIKI@'    => $conf['title'],
6171ef68647SAndreas Gohr            '@WIKIURL@' => DOKU_URL,
6181ef68647SAndreas Gohr            '@DATE@'    => dformat(time()),
6195d6fbaeaSAndreas Gohr            '@BASE@'    => DOKU_BASE,
620893987a2SAndreas Gohr            '@INC@'     => DOKU_INC,
621893987a2SAndreas Gohr            '@TPLBASE@' => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
622893987a2SAndreas Gohr            '@TPLINC@'  => DOKU_INC . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/'
6231ef68647SAndreas Gohr        );
6241ef68647SAndreas Gohr
6252eedf77dSAndreas Gohr        // set HTML element
626a180c973SKlap-in        $html = str_replace(array_keys($replace), array_values($replace), $html);
627a180c973SKlap-in        //TODO For bookcreator $ID (= bookmanager page) makes no sense
628a180c973SKlap-in        $output['html'] = $this->page_depend_replacements($html, $ID);
6291ef68647SAndreas Gohr
6301e45476bSmnapp        // cover page
63102f9a447SGerrit Uitslag        $coverfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/cover.html';
63233c15297SGerrit Uitslag        if(file_exists($coverfile)) {
63333c15297SGerrit Uitslag            $output['cover'] = file_get_contents($coverfile);
6341e45476bSmnapp            $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
6359b071da5SMichael            $output['cover'] = $this->page_depend_replacements($output['cover'], $ID);
6366e2ec302SGerrit Uitslag            $output['cover'] .= '<pagebreak />';
6371e45476bSmnapp        }
6381e45476bSmnapp
63933c15297SGerrit Uitslag        // cover page
64002f9a447SGerrit Uitslag        $backfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/back.html';
64133c15297SGerrit Uitslag        if(file_exists($backfile)) {
64233c15297SGerrit Uitslag            $output['back'] = '<pagebreak />';
64333c15297SGerrit Uitslag            $output['back'] .= file_get_contents($backfile);
64433c15297SGerrit Uitslag            $output['back'] = str_replace(array_keys($replace), array_values($replace), $output['back']);
6459b071da5SMichael            $output['back'] = $this->page_depend_replacements($output['back'], $ID);
64633c15297SGerrit Uitslag        }
64733c15297SGerrit Uitslag
6482eedf77dSAndreas Gohr        // citation box
64902f9a447SGerrit Uitslag        $citationfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/citation.html';
65033c15297SGerrit Uitslag        if(file_exists($citationfile)) {
65133c15297SGerrit Uitslag            $output['cite'] = file_get_contents($citationfile);
6522eedf77dSAndreas Gohr            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
6532eedf77dSAndreas Gohr        }
6541ef68647SAndreas Gohr
6552eedf77dSAndreas Gohr        return $output;
6561ef68647SAndreas Gohr    }
6571ef68647SAndreas Gohr
6581ef68647SAndreas Gohr    /**
659a180c973SKlap-in     * @param string $raw code with placeholders
660a180c973SKlap-in     * @param string $id  pageid
661a180c973SKlap-in     * @return string
662a180c973SKlap-in     */
663a180c973SKlap-in    protected function page_depend_replacements($raw, $id) {
664e53f1ec0SSzymon Olewniczak        global $REV, $DATE_AT;
665a180c973SKlap-in
666*9b2636c8SDiego Belmar        // generate qr code for this page using quickchart.io (Google infographics api was deprecated in March 14, 2019)
667a180c973SKlap-in        $qr_code = '';
668a180c973SKlap-in        if($this->getConf('qrcodesize')) {
669a180c973SKlap-in            $url = urlencode(wl($id, '', '&', true));
670*9b2636c8SDiego Belmar            $qr_code = '<img src="https://quickchart.io/qr?size=' .
671*9b2636c8SDiego Belmar                $this->getConf('qrcodesize') . '&text=' . $url . '&margin=1&ecLevel=Q" />';
672a180c973SKlap-in        }
673a180c973SKlap-in        // prepare replacements
674a180c973SKlap-in        $replace['@ID@']      = $id;
675a180c973SKlap-in        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
676e53f1ec0SSzymon Olewniczak
677e53f1ec0SSzymon Olewniczak        $params = array();
678e53f1ec0SSzymon Olewniczak        if($DATE_AT) {
679e53f1ec0SSzymon Olewniczak            $params['at'] = $DATE_AT;
680e53f1ec0SSzymon Olewniczak        } elseif($REV) {
681e53f1ec0SSzymon Olewniczak            $params['rev'] = $REV;
682e53f1ec0SSzymon Olewniczak        }
683e53f1ec0SSzymon Olewniczak        $replace['@PAGEURL@'] = wl($id, $params, true, "&");
684a180c973SKlap-in        $replace['@QRCODE@']  = $qr_code;
685a180c973SKlap-in
686e3d68265SGerrit Uitslag        $content = str_replace(array_keys($replace), array_values($replace), $raw);
687e3d68265SGerrit Uitslag
688e3d68265SGerrit Uitslag        // @DATE(<date>[, <format>])@
689e3d68265SGerrit Uitslag        $content = preg_replace_callback(
690e3d68265SGerrit Uitslag            '/@DATE\((.*?)(?:,\s*(.*?))?\)@/',
691e3d68265SGerrit Uitslag            array($this, 'replacedate'),
692e3d68265SGerrit Uitslag            $content
693e3d68265SGerrit Uitslag        );
694e3d68265SGerrit Uitslag
695e3d68265SGerrit Uitslag        return $content;
696a180c973SKlap-in    }
697a180c973SKlap-in
698e3d68265SGerrit Uitslag
699e3d68265SGerrit Uitslag    /**
700e3d68265SGerrit Uitslag     * (callback) Replace date by request datestring
701e3d68265SGerrit Uitslag     * e.g. '%m(30-11-1975)' is replaced by '11'
702e3d68265SGerrit Uitslag     *
703e3d68265SGerrit Uitslag     * @param array $match with [0]=>whole match, [1]=> first subpattern, [2] => second subpattern
704e3d68265SGerrit Uitslag     * @return string
705e3d68265SGerrit Uitslag     */
706e3d68265SGerrit Uitslag    function replacedate($match) {
707e3d68265SGerrit Uitslag        global $conf;
708e3d68265SGerrit Uitslag        //no 2nd argument for default date format
709e3d68265SGerrit Uitslag        if($match[2] == null) {
710e3d68265SGerrit Uitslag            $match[2] = $conf['dformat'];
711e3d68265SGerrit Uitslag        }
712e3d68265SGerrit Uitslag        return strftime($match[2], strtotime($match[1]));
713e3d68265SGerrit Uitslag    }
714e3d68265SGerrit Uitslag
715a180c973SKlap-in    /**
7161c14c879SAndreas Gohr     * Load all the style sheets and apply the needed replacements
7171ef68647SAndreas Gohr     */
7181c14c879SAndreas Gohr    protected function load_css() {
719737417c6SKlap-in        global $conf;
7201c14c879SAndreas Gohr        //reusue the CSS dispatcher functions without triggering the main function
7211c14c879SAndreas Gohr        define('SIMPLE_TEST', 1);
7221c14c879SAndreas Gohr        require_once(DOKU_INC . 'lib/exe/css.php');
723ee19bac3SLuigi Micco
7241c14c879SAndreas Gohr        // prepare CSS files
7251c14c879SAndreas Gohr        $files = array_merge(
7261c14c879SAndreas Gohr            array(
7271c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/screen.css'
7281c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7291c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/print.css'
7301c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7311c14c879SAndreas Gohr            ),
73258e6409eSAndreas Gohr            $this->css_pluginPDFstyles(),
7331c14c879SAndreas Gohr            array(
7341c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.css'
7351c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7361c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/style.css'
7371c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
7381c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.local.css'
7391c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7401c14c879SAndreas Gohr            )
7411c14c879SAndreas Gohr        );
7421c14c879SAndreas Gohr        $css = '';
7431c14c879SAndreas Gohr        foreach($files as $file => $location) {
74428e636eaSGerrit Uitslag            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
74528e636eaSGerrit Uitslag            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
7461c14c879SAndreas Gohr            $css .= css_loadfile($file, $location);
7471ef68647SAndreas Gohr        }
7481ef68647SAndreas Gohr
74928e636eaSGerrit Uitslag        if(function_exists('css_parseless')) {
7501c14c879SAndreas Gohr            // apply pattern replacements
7517c6ca3bcSMichael Große            if (function_exists('css_styleini')) {
7527c6ca3bcSMichael Große                // compatiblity layer for pre-Greebo releases of DokuWiki
75328e636eaSGerrit Uitslag                $styleini = css_styleini($conf['template']);
7547c6ca3bcSMichael Große            } else {
7557c6ca3bcSMichael Große                // Greebo functionality
7567c6ca3bcSMichael Große                $styleUtils = new \dokuwiki\StyleUtils();
7577c6ca3bcSMichael Große                $styleini = $styleUtils->cssStyleini($conf['template']);
7587c6ca3bcSMichael Große            }
75928e636eaSGerrit Uitslag            $css = css_applystyle($css, $styleini['replacements']);
76028e636eaSGerrit Uitslag
76128e636eaSGerrit Uitslag            // parse less
76228e636eaSGerrit Uitslag            $css = css_parseless($css);
76328e636eaSGerrit Uitslag        } else {
76428e636eaSGerrit Uitslag            // @deprecated 2013-12-19: fix backward compatibility
7651c14c879SAndreas Gohr            $css = css_applystyle($css, DOKU_INC . 'lib/tpl/' . $conf['template'] . '/');
76628e636eaSGerrit Uitslag        }
7671ef68647SAndreas Gohr
7681c14c879SAndreas Gohr        return $css;
769ee19bac3SLuigi Micco    }
7701c14c879SAndreas Gohr
77158e6409eSAndreas Gohr    /**
77258e6409eSAndreas Gohr     * Returns a list of possible Plugin PDF Styles
77358e6409eSAndreas Gohr     *
77458e6409eSAndreas Gohr     * Checks for a pdf.css, falls back to print.css
77558e6409eSAndreas Gohr     *
77658e6409eSAndreas Gohr     * @author Andreas Gohr <andi@splitbrain.org>
77758e6409eSAndreas Gohr     */
7786be736bfSGerrit Uitslag    protected function css_pluginPDFstyles() {
77958e6409eSAndreas Gohr        $list = array();
78058e6409eSAndreas Gohr        $plugins = plugin_list();
781f54b51f7SAndreas Gohr
782f54b51f7SAndreas Gohr        $usestyle = explode(',', $this->getConf('usestyles'));
78358e6409eSAndreas Gohr        foreach($plugins as $p) {
784f54b51f7SAndreas Gohr            if(in_array($p, $usestyle)) {
785f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/screen.css"] = DOKU_BASE . "lib/plugins/$p/";
7868003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/screen.less"] = DOKU_BASE . "lib/plugins/$p/";
7878003b493SGerrit Uitslag
788f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/style.css"] = DOKU_BASE . "lib/plugins/$p/";
7898003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/style.less"] = DOKU_BASE . "lib/plugins/$p/";
790f54b51f7SAndreas Gohr            }
791f54b51f7SAndreas Gohr
7928003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.css"] = DOKU_BASE . "lib/plugins/$p/";
7938003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.less"] = DOKU_BASE . "lib/plugins/$p/";
7948003b493SGerrit Uitslag
795ab96d816SMichael Große            if(file_exists(DOKU_PLUGIN . "$p/pdf.css") || file_exists(DOKU_PLUGIN . "$p/pdf.less")) {
79658e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/pdf.css"] = DOKU_BASE . "lib/plugins/$p/";
7978003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/pdf.less"] = DOKU_BASE . "lib/plugins/$p/";
79858e6409eSAndreas Gohr            } else {
79958e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/print.css"] = DOKU_BASE . "lib/plugins/$p/";
8008003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/print.less"] = DOKU_BASE . "lib/plugins/$p/";
80158e6409eSAndreas Gohr            }
80258e6409eSAndreas Gohr        }
80358e6409eSAndreas Gohr        return $list;
80458e6409eSAndreas Gohr    }
805ad18f4e1SGerrit Uitslag
806ad18f4e1SGerrit Uitslag    /**
80760e59de7SGerrit Uitslag     * Returns array of pages which will be included in the exported pdf
80860e59de7SGerrit Uitslag     *
80960e59de7SGerrit Uitslag     * @return array
81060e59de7SGerrit Uitslag     */
81160e59de7SGerrit Uitslag    public function getExportedPages() {
81260e59de7SGerrit Uitslag        return $this->list;
81360e59de7SGerrit Uitslag    }
81460e59de7SGerrit Uitslag
81560e59de7SGerrit Uitslag    /**
816ad18f4e1SGerrit Uitslag     * usort callback to sort by file lastmodified time
81744e8e8fbSGerrit Uitslag     *
81844e8e8fbSGerrit Uitslag     * @param array $a
81944e8e8fbSGerrit Uitslag     * @param array $b
82044e8e8fbSGerrit Uitslag     * @return int
821ad18f4e1SGerrit Uitslag     */
822ad18f4e1SGerrit Uitslag    public function _datesort($a, $b) {
823ad18f4e1SGerrit Uitslag        if($b['rev'] < $a['rev']) return -1;
824ad18f4e1SGerrit Uitslag        if($b['rev'] > $a['rev']) return 1;
825ad18f4e1SGerrit Uitslag        return strcmp($b['id'], $a['id']);
826ad18f4e1SGerrit Uitslag    }
827ad18f4e1SGerrit Uitslag
828ad18f4e1SGerrit Uitslag    /**
829ad18f4e1SGerrit Uitslag     * usort callback to sort by page id
83044e8e8fbSGerrit Uitslag     * @param array $a
83144e8e8fbSGerrit Uitslag     * @param array $b
83244e8e8fbSGerrit Uitslag     * @return int
833ad18f4e1SGerrit Uitslag     */
834ad18f4e1SGerrit Uitslag    public function _pagenamesort($a, $b) {
835eea6fd2cSMichael Große        // do not sort numbers before namespace separators
836eea6fd2cSMichael Große        $aID = str_replace(':', '/', $a['id']);
837eea6fd2cSMichael Große        $bID = str_replace(':', '/', $b['id']);
838eea6fd2cSMichael Große        if($aID <= $bID) return -1;
839eea6fd2cSMichael Große        if($aID > $bID) return 1;
840ad18f4e1SGerrit Uitslag        return 0;
841ad18f4e1SGerrit Uitslag    }
84226be4eceSGerrit Uitslag
84326be4eceSGerrit Uitslag    /**
84402f9a447SGerrit Uitslag     * Return settings read from:
84502f9a447SGerrit Uitslag     *   1. url parameters
84602f9a447SGerrit Uitslag     *   2. plugin config
84702f9a447SGerrit Uitslag     *   3. global config
84802f9a447SGerrit Uitslag     *
84902f9a447SGerrit Uitslag     * @return array
85002f9a447SGerrit Uitslag     */
85102f9a447SGerrit Uitslag    protected function loadExportConfig() {
85202f9a447SGerrit Uitslag        global $INPUT;
85302f9a447SGerrit Uitslag        global $conf;
85402f9a447SGerrit Uitslag
85502f9a447SGerrit Uitslag        $this->exportConfig = array();
85602f9a447SGerrit Uitslag
85702f9a447SGerrit Uitslag        // decide on the paper setup from param or config
85802f9a447SGerrit Uitslag        $this->exportConfig['pagesize'] = $INPUT->str('pagesize', $this->getConf('pagesize'), true);
85902f9a447SGerrit Uitslag        $this->exportConfig['orientation'] = $INPUT->str('orientation', $this->getConf('orientation'), true);
86002f9a447SGerrit Uitslag
8614870b378SLarsDW223        // decide on the font-size from param or config
8624870b378SLarsDW223        $this->exportConfig['font-size'] = $INPUT->str('font-size', $this->getConf('font-size'), true);
8634870b378SLarsDW223
864213fdb75SGerrit Uitslag        $doublesided = $INPUT->bool('doublesided', (bool) $this->getConf('doublesided'));
865213fdb75SGerrit Uitslag        $this->exportConfig['doublesided'] = $doublesided ? '1' : '0';
866213fdb75SGerrit Uitslag
867213fdb75SGerrit Uitslag        $hasToC = $INPUT->bool('toc', (bool) $this->getConf('toc'));
86802f9a447SGerrit Uitslag        $levels = array();
86902f9a447SGerrit Uitslag        if($hasToC) {
87002f9a447SGerrit Uitslag            $toclevels = $INPUT->str('toclevels', $this->getConf('toclevels'), true);
87102f9a447SGerrit Uitslag            list($top_input, $max_input) = explode('-', $toclevels, 2);
87202f9a447SGerrit Uitslag            list($top_conf, $max_conf) = explode('-', $this->getConf('toclevels'), 2);
87302f9a447SGerrit Uitslag            $bounds_input = array(
87402f9a447SGerrit Uitslag                'top' => array(
87502f9a447SGerrit Uitslag                    (int) $top_input,
87602f9a447SGerrit Uitslag                    (int) $top_conf
87702f9a447SGerrit Uitslag                ),
87802f9a447SGerrit Uitslag                'max' => array(
87902f9a447SGerrit Uitslag                    (int) $max_input,
88002f9a447SGerrit Uitslag                    (int) $max_conf
88102f9a447SGerrit Uitslag                )
88202f9a447SGerrit Uitslag            );
88302f9a447SGerrit Uitslag            $bounds = array(
88402f9a447SGerrit Uitslag                'top' => $conf['toptoclevel'],
88502f9a447SGerrit Uitslag                'max' => $conf['maxtoclevel']
88602f9a447SGerrit Uitslag
88702f9a447SGerrit Uitslag            );
88802f9a447SGerrit Uitslag            foreach($bounds_input as $bound => $values) {
88902f9a447SGerrit Uitslag                foreach($values as $value) {
89002f9a447SGerrit Uitslag                    if($value > 0 && $value <= 5) {
89102f9a447SGerrit Uitslag                        //stop at valid value and store
89202f9a447SGerrit Uitslag                        $bounds[$bound] = $value;
89302f9a447SGerrit Uitslag                        break;
89402f9a447SGerrit Uitslag                    }
89502f9a447SGerrit Uitslag                }
89602f9a447SGerrit Uitslag            }
89702f9a447SGerrit Uitslag
89802f9a447SGerrit Uitslag            if($bounds['max'] < $bounds['top']) {
89902f9a447SGerrit Uitslag                $bounds['max'] = $bounds['top'];
90002f9a447SGerrit Uitslag            }
90102f9a447SGerrit Uitslag
90202f9a447SGerrit Uitslag            for($level = $bounds['top']; $level <= $bounds['max']; $level++) {
90302f9a447SGerrit Uitslag                $levels["H$level"] = $level - 1;
90402f9a447SGerrit Uitslag            }
90502f9a447SGerrit Uitslag        }
90602f9a447SGerrit Uitslag        $this->exportConfig['hasToC'] = $hasToC;
90702f9a447SGerrit Uitslag        $this->exportConfig['levels'] = $levels;
90802f9a447SGerrit Uitslag
90902f9a447SGerrit Uitslag        $this->exportConfig['maxbookmarks'] = $INPUT->int('maxbookmarks', $this->getConf('maxbookmarks'), true);
91002f9a447SGerrit Uitslag
91102f9a447SGerrit Uitslag        $tplconf = $this->getConf('template');
91205d2b507SGerrit Uitslag        $tpl = $INPUT->str('tpl', $tplconf, true);
91302f9a447SGerrit Uitslag        if(!is_dir(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl)) {
91402f9a447SGerrit Uitslag            $tpl = $tplconf;
91502f9a447SGerrit Uitslag        }
91602f9a447SGerrit Uitslag        if(!$tpl){
91702f9a447SGerrit Uitslag            $tpl = 'default';
91802f9a447SGerrit Uitslag        }
91902f9a447SGerrit Uitslag        $this->exportConfig['template'] = $tpl;
92002f9a447SGerrit Uitslag
92102f9a447SGerrit Uitslag        $this->exportConfig['isDebug'] = $conf['allowdebug'] && $INPUT->has('debughtml');
92202f9a447SGerrit Uitslag    }
92302f9a447SGerrit Uitslag
92402f9a447SGerrit Uitslag    /**
92502f9a447SGerrit Uitslag     * Returns requested config
92602f9a447SGerrit Uitslag     *
92702f9a447SGerrit Uitslag     * @param string $name
92802f9a447SGerrit Uitslag     * @param mixed  $notset
92902f9a447SGerrit Uitslag     * @return mixed|bool
93002f9a447SGerrit Uitslag     */
93102f9a447SGerrit Uitslag    public function getExportConfig($name, $notset = false) {
93202f9a447SGerrit Uitslag        if ($this->exportConfig === null){
93302f9a447SGerrit Uitslag            $this->loadExportConfig();
93402f9a447SGerrit Uitslag        }
93502f9a447SGerrit Uitslag
93602f9a447SGerrit Uitslag        if(isset($this->exportConfig[$name])){
93702f9a447SGerrit Uitslag            return $this->exportConfig[$name];
93802f9a447SGerrit Uitslag        }else{
93902f9a447SGerrit Uitslag            return $notset;
94002f9a447SGerrit Uitslag        }
94102f9a447SGerrit Uitslag    }
942d63e7fe7SGerrit Uitslag
943d63e7fe7SGerrit Uitslag    /**
944d63e7fe7SGerrit Uitslag     * Add 'export pdf'-button to pagetools
945d63e7fe7SGerrit Uitslag     *
946d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
947d63e7fe7SGerrit Uitslag     */
94844e8e8fbSGerrit Uitslag    public function addbutton(Doku_Event $event) {
949e53f1ec0SSzymon Olewniczak        global $ID, $REV, $DATE_AT;
950d63e7fe7SGerrit Uitslag
951d63e7fe7SGerrit Uitslag        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
952d63e7fe7SGerrit Uitslag            $params = array('do' => 'export_pdf');
953e53f1ec0SSzymon Olewniczak            if($DATE_AT) {
954e53f1ec0SSzymon Olewniczak                $params['at'] = $DATE_AT;
955e53f1ec0SSzymon Olewniczak            } elseif($REV) {
956d63e7fe7SGerrit Uitslag                $params['rev'] = $REV;
957d63e7fe7SGerrit Uitslag            }
958d63e7fe7SGerrit Uitslag
959d63e7fe7SGerrit Uitslag            // insert button at position before last (up to top)
960d63e7fe7SGerrit Uitslag            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
961d63e7fe7SGerrit Uitslag                array('export_pdf' =>
962d63e7fe7SGerrit Uitslag                          '<li>'
96372cadc31SChristian Paul                          . '<a href="' . wl($ID, $params) . '"  class="action export_pdf" rel="nofollow" title="' . $this->getLang('export_pdf_button') . '">'
964d63e7fe7SGerrit Uitslag                          . '<span>' . $this->getLang('export_pdf_button') . '</span>'
965d63e7fe7SGerrit Uitslag                          . '</a>'
966d63e7fe7SGerrit Uitslag                          . '</li>'
967d63e7fe7SGerrit Uitslag                ) +
968d63e7fe7SGerrit Uitslag                array_slice($event->data['items'], -1, 1, true);
969d63e7fe7SGerrit Uitslag        }
970d63e7fe7SGerrit Uitslag    }
971026b594bSAndreas Gohr
972026b594bSAndreas Gohr    /**
973026b594bSAndreas Gohr     * Add 'export pdf' button to page tools, new SVG based mechanism
974026b594bSAndreas Gohr     *
975026b594bSAndreas Gohr     * @param Doku_Event $event
976026b594bSAndreas Gohr     */
977026b594bSAndreas Gohr    public function addsvgbutton(Doku_Event $event) {
9784c493e44SGerrit Uitslag        global $INFO;
9794c493e44SGerrit Uitslag        if($event->data['view'] != 'page' || !$this->getConf('showexportbutton')) {
9804c493e44SGerrit Uitslag            return;
9814c493e44SGerrit Uitslag        }
9824c493e44SGerrit Uitslag
9834c493e44SGerrit Uitslag        if(!$INFO['exists']) {
9844c493e44SGerrit Uitslag            return;
9854c493e44SGerrit Uitslag        }
9864c493e44SGerrit Uitslag
987026b594bSAndreas Gohr        array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dw2pdf\MenuItem()]);
988026b594bSAndreas Gohr    }
989ee19bac3SLuigi Micco}
990