xref: /plugin/dw2pdf/action.php (revision d9c13ec70e9b3ce4194a4bd836c13decad89792a)
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
551c14c879SAndreas Gohr     */
5644e8e8fbSGerrit Uitslag    public function convert(Doku_Event $event) {
572d9cd424SGerrit Uitslag        global $ID, $REV, $DATE_AT;
582d9cd424SGerrit Uitslag        global $conf, $INPUT;
59ee19bac3SLuigi Micco
601ef68647SAndreas Gohr        // our event?
61*d9c13ec7SGerrit Uitslag        if(($event->data != 'export_pdfbook') && ($event->data != 'export_pdf') && ($event->data != 'export_pdfns')) return;
62ee19bac3SLuigi Micco
631ef68647SAndreas Gohr        // check user's rights
64*d9c13ec7SGerrit Uitslag        if(auth_quickaclcheck($ID) < AUTH_READ) return;
651ef68647SAndreas Gohr
66d63e7fe7SGerrit Uitslag        if($data = $this->collectExportPages($event)) {
6703352761SKirsten Roschanski            list($this->title, $this->list) = $data;
68d63e7fe7SGerrit Uitslag        } else {
69*d9c13ec7SGerrit Uitslag            return;
70d63e7fe7SGerrit Uitslag        }
71d63e7fe7SGerrit Uitslag
722d9cd424SGerrit Uitslag        if($event->data === 'export_pdf' && ($REV || $DATE_AT)) {
7327195d5bSMichael Große            $tempFilename = tempnam($conf['tmpdir'], 'dw2pdf_');
74f00df45eSMichael Große            $generateNewPdf = true;
7527d48100SMichael Große            $isTempFile = true;
76f00df45eSMichael Große        } else {
77a58f45f0SGerrit Uitslag            // prepare cache and its dependencies
78a58f45f0SGerrit Uitslag            $depends = array();
7903352761SKirsten Roschanski            $cache = $this->prepareCache($depends);
80f00df45eSMichael Große            $tempFilename = $cache->cache;
8127195d5bSMichael Große            $generateNewPdf = !$this->getConf('usecache')
8227195d5bSMichael Große                || $this->getExportConfig('isDebug')
8327195d5bSMichael Große                || !$cache->useCache($depends);
8427d48100SMichael Große            $isTempFile = false;
85f00df45eSMichael Große        }
86d63e7fe7SGerrit Uitslag
87bd977188SGerrit Uitslag        // hard work only when no cache available or needed for debugging
88f00df45eSMichael Große        if($generateNewPdf) {
89e5f6c2cbSMichael Große            // generating the pdf may take a long time for larger wikis / namespaces with many pages
90e5f6c2cbSMichael Große            set_time_limit(0);
91b34cb34eSSzymon Olewniczak            try {
922d9cd424SGerrit Uitslag                $this->generatePDF($tempFilename, $event);
93b34cb34eSSzymon Olewniczak            } catch(Mpdf\MpdfException $e) {
942d9cd424SGerrit Uitslag                if($INPUT->has('selection')) {
952d9cd424SGerrit Uitslag                    http_status(400);
962d9cd424SGerrit Uitslag                    print $e->getMessage();
972d9cd424SGerrit Uitslag                    exit();
982d9cd424SGerrit Uitslag                } else {
99b34cb34eSSzymon Olewniczak                    //prevent act_export()
1002d9cd424SGerrit Uitslag                    $event->data = 'show';
101b34cb34eSSzymon Olewniczak                    msg($e->getMessage(), -1);
1022d9cd424SGerrit Uitslag                    $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
103*d9c13ec7SGerrit Uitslag                    return;
104b34cb34eSSzymon Olewniczak                }
105d63e7fe7SGerrit Uitslag            }
1062d9cd424SGerrit Uitslag        }
1072d9cd424SGerrit Uitslag
1082d9cd424SGerrit Uitslag        $event->preventDefault(); // after prevent, $event->data cannot be changed
109d63e7fe7SGerrit Uitslag
110d63e7fe7SGerrit Uitslag        // deliver the file
111f00df45eSMichael Große        $this->sendPDFFile($tempFilename);
11227d48100SMichael Große        if($isTempFile) {
11327d48100SMichael Große            unlink($tempFilename);
11427d48100SMichael Große        }
1152d9cd424SGerrit Uitslag
116d63e7fe7SGerrit Uitslag    }
117d63e7fe7SGerrit Uitslag
118d63e7fe7SGerrit Uitslag    /**
119d63e7fe7SGerrit Uitslag     * Obtain list of pages and title, based on url parameters
120d63e7fe7SGerrit Uitslag     *
121d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
122d63e7fe7SGerrit Uitslag     * @return string|bool
123d63e7fe7SGerrit Uitslag     */
124d63e7fe7SGerrit Uitslag    protected function collectExportPages(Doku_Event $event) {
12536a7917dSGerrit Uitslag        global $ID, $REV;
126d63e7fe7SGerrit Uitslag        global $INPUT;
127d63e7fe7SGerrit Uitslag        global $conf;
128d63e7fe7SGerrit Uitslag
129d63e7fe7SGerrit Uitslag        // list of one or multiple pages
130d63e7fe7SGerrit Uitslag        $list = array();
13128e636eaSGerrit Uitslag
1324b4cebc2SLarsDW223        if($event->data == 'export_pdf') {
133d63e7fe7SGerrit Uitslag            $list[0] = $ID;
13403352761SKirsten Roschanski            $this->title = $INPUT->str('pdftitle'); //DEPRECATED
13503352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
13603352761SKirsten Roschanski            if(empty($this->title)) {
13703352761SKirsten Roschanski                $this->title = p_get_first_heading($ID);
13815923cb9SGerrit Uitslag            }
139ad18f4e1SGerrit Uitslag
14036a7917dSGerrit Uitslag            $filename = wikiFN($ID, $REV);
14136a7917dSGerrit Uitslag            if(!file_exists($filename)) {
14236a7917dSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'notexist');
14336a7917dSGerrit Uitslag                return false;
14436a7917dSGerrit Uitslag            }
14536a7917dSGerrit Uitslag
1464b4cebc2SLarsDW223        } elseif($event->data == 'export_pdfns') {
147ad18f4e1SGerrit Uitslag            //check input for title and ns
14803352761SKirsten Roschanski            if(!$this->title = $INPUT->str('book_title')) {
14926be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
150ad18f4e1SGerrit Uitslag                return false;
151ad18f4e1SGerrit Uitslag            }
152177a7d30SGerrit Uitslag            $pdfnamespace = cleanID($INPUT->str('book_ns'));
153ad18f4e1SGerrit Uitslag            if(!@is_dir(dirname(wikiFN($pdfnamespace . ':dummy')))) {
15426be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needns');
155ad18f4e1SGerrit Uitslag                return false;
156ad18f4e1SGerrit Uitslag            }
157ad18f4e1SGerrit Uitslag
15826be4eceSGerrit Uitslag            //sort order
159177a7d30SGerrit Uitslag            $order = $INPUT->str('book_order', 'natural', true);
160ad18f4e1SGerrit Uitslag            $sortoptions = array('pagename', 'date', 'natural');
161ad18f4e1SGerrit Uitslag            if(!in_array($order, $sortoptions)) {
162ad18f4e1SGerrit Uitslag                $order = 'natural';
163ad18f4e1SGerrit Uitslag            }
164ad18f4e1SGerrit Uitslag
16526be4eceSGerrit Uitslag            //search depth
166177a7d30SGerrit Uitslag            $depth = $INPUT->int('book_nsdepth', 0);
167ad18f4e1SGerrit Uitslag            if($depth < 0) {
168ad18f4e1SGerrit Uitslag                $depth = 0;
169ad18f4e1SGerrit Uitslag            }
17026be4eceSGerrit Uitslag
171ad18f4e1SGerrit Uitslag            //page search
172ad18f4e1SGerrit Uitslag            $result = array();
173ad18f4e1SGerrit Uitslag            $opts = array('depth' => $depth); //recursive all levels
174ad18f4e1SGerrit Uitslag            $dir = utf8_encodeFN(str_replace(':', '/', $pdfnamespace));
175ad18f4e1SGerrit Uitslag            search($result, $conf['datadir'], 'search_allpages', $opts, $dir);
176ad18f4e1SGerrit Uitslag
17726be4eceSGerrit Uitslag            //sorting
178ad18f4e1SGerrit Uitslag            if(count($result) > 0) {
179ad18f4e1SGerrit Uitslag                if($order == 'date') {
180ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_datesort'));
181ad18f4e1SGerrit Uitslag                } elseif($order == 'pagename') {
182ad18f4e1SGerrit Uitslag                    usort($result, array($this, '_pagenamesort'));
183ad18f4e1SGerrit Uitslag                }
184ad18f4e1SGerrit Uitslag            }
185ad18f4e1SGerrit Uitslag
186ad18f4e1SGerrit Uitslag            foreach($result as $item) {
187d63e7fe7SGerrit Uitslag                $list[] = $item['id'];
188ad18f4e1SGerrit Uitslag            }
189ad18f4e1SGerrit Uitslag
190baa31dc5SGerrit Uitslag            if ($pdfnamespace !== '') {
191baa31dc5SGerrit Uitslag                if (!in_array($pdfnamespace . ':' . $conf['start'], $list, true)) {
192baa31dc5SGerrit Uitslag                    if (file_exists(wikiFN(rtrim($pdfnamespace,':')))) {
193baa31dc5SGerrit Uitslag                        array_unshift($list,rtrim($pdfnamespace,':'));
194baa31dc5SGerrit Uitslag                    }
195baa31dc5SGerrit Uitslag                }
196baa31dc5SGerrit Uitslag            }
197baa31dc5SGerrit Uitslag
198737417c6SKlap-in        } elseif(isset($_COOKIE['list-pagelist']) && !empty($_COOKIE['list-pagelist'])) {
199b3eed6e3SGerrit Uitslag            /** @deprecated  April 2016 replaced by localStorage version of Bookcreator*/
20026be4eceSGerrit Uitslag            //is in Bookmanager of bookcreator plugin a title given?
20103352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
20203352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
20303352761SKirsten Roschanski            if(empty($this->title)) {
20426be4eceSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'needtitle');
205737417c6SKlap-in                return false;
20626be4eceSGerrit Uitslag            } else {
207d63e7fe7SGerrit Uitslag                $list = explode("|", $_COOKIE['list-pagelist']);
20826be4eceSGerrit Uitslag            }
209ad18f4e1SGerrit Uitslag
210b3eed6e3SGerrit Uitslag        } elseif($INPUT->has('selection')) {
211b3eed6e3SGerrit Uitslag            //handle Bookcreator requests based at localStorage
212b3eed6e3SGerrit Uitslag//            if(!checkSecurityToken()) {
213b3eed6e3SGerrit Uitslag//                http_status(403);
214b3eed6e3SGerrit Uitslag//                print $this->getLang('empty');
215b3eed6e3SGerrit Uitslag//                exit();
216b3eed6e3SGerrit Uitslag//            }
217b3eed6e3SGerrit Uitslag
218b3eed6e3SGerrit Uitslag            $json = new JSON(JSON_LOOSE_TYPE);
219b3eed6e3SGerrit Uitslag            $list = $json->decode($INPUT->post->str('selection', '', true));
220b3eed6e3SGerrit Uitslag            if(!is_array($list) || empty($list)) {
221b3eed6e3SGerrit Uitslag                http_status(400);
222b3eed6e3SGerrit Uitslag                print $this->getLang('empty');
223b3eed6e3SGerrit Uitslag                exit();
224b3eed6e3SGerrit Uitslag            }
225b3eed6e3SGerrit Uitslag
22603352761SKirsten Roschanski            $this->title = $INPUT->str('pdfbook_title'); //DEPRECATED
22703352761SKirsten Roschanski            $this->title = $INPUT->str('book_title', $this->title, true);
22803352761SKirsten Roschanski            if(empty($this->title)) {
229b3eed6e3SGerrit Uitslag                http_status(400);
230b3eed6e3SGerrit Uitslag                print $this->getLang('needtitle');
231b3eed6e3SGerrit Uitslag                exit();
232b3eed6e3SGerrit Uitslag            }
233b3eed6e3SGerrit Uitslag
234737417c6SKlap-in        } else {
23526be4eceSGerrit Uitslag            //show empty bookcreator message
23626be4eceSGerrit Uitslag            $this->showPageWithErrorMsg($event, 'empty');
237737417c6SKlap-in            return false;
238737417c6SKlap-in        }
239737417c6SKlap-in
240719256adSGerrit Uitslag        $list = array_map('cleanID', $list);
241c7138b3fSGerrit Uitslag
242c7138b3fSGerrit Uitslag        $skippedpages = array();
243c7138b3fSGerrit Uitslag        foreach($list as $index => $pageid) {
244c7138b3fSGerrit Uitslag            if(auth_quickaclcheck($pageid) < AUTH_READ) {
245c7138b3fSGerrit Uitslag                $skippedpages[] = $pageid;
246c7138b3fSGerrit Uitslag                unset($list[$index]);
247c7138b3fSGerrit Uitslag            }
248c7138b3fSGerrit Uitslag        }
249c7138b3fSGerrit Uitslag        $list = array_filter($list); //removes also pages mentioned '0'
250c7138b3fSGerrit Uitslag
251c7138b3fSGerrit Uitslag        //if selection contains forbidden pages throw (overridable) warning
252c7138b3fSGerrit Uitslag        if(!$INPUT->bool('book_skipforbiddenpages') && !empty($skippedpages)) {
253c7138b3fSGerrit Uitslag            $msg = hsc(join(', ', $skippedpages));
254c7138b3fSGerrit Uitslag            if($INPUT->has('selection')) {
255c7138b3fSGerrit Uitslag                http_status(400);
256c7138b3fSGerrit Uitslag                print sprintf($this->getLang('forbidden'), $msg);
257c7138b3fSGerrit Uitslag                exit();
258c7138b3fSGerrit Uitslag            } else {
259c7138b3fSGerrit Uitslag                $this->showPageWithErrorMsg($event, 'forbidden', $msg);
260c7138b3fSGerrit Uitslag                return false;
261c7138b3fSGerrit Uitslag            }
262c7138b3fSGerrit Uitslag
263c7138b3fSGerrit Uitslag        }
264c7138b3fSGerrit Uitslag
26503352761SKirsten Roschanski        return array($this->title, $list);
266d63e7fe7SGerrit Uitslag    }
267d63e7fe7SGerrit Uitslag
268a58f45f0SGerrit Uitslag    /**
269a58f45f0SGerrit Uitslag     * Prepare cache
270a58f45f0SGerrit Uitslag     *
271a58f45f0SGerrit Uitslag     * @param array  $depends (reference) array with dependencies
272a58f45f0SGerrit Uitslag     * @return cache
273a58f45f0SGerrit Uitslag     */
27403352761SKirsten Roschanski    protected function prepareCache(&$depends) {
275a58f45f0SGerrit Uitslag        global $REV;
276a58f45f0SGerrit Uitslag
277ee19bac3SLuigi Micco        $cachekey = join(',', $this->list)
278ee19bac3SLuigi Micco            . $REV
279ee19bac3SLuigi Micco            . $this->getExportConfig('template')
280ee19bac3SLuigi Micco            . $this->getExportConfig('pagesize')
281ee19bac3SLuigi Micco            . $this->getExportConfig('orientation')
282d83760efSGerrit Uitslag            . $this->getExportConfig('font-size')
283ee19bac3SLuigi Micco            . $this->getExportConfig('doublesided')
284ee19bac3SLuigi Micco            . ($this->getExportConfig('hasToC') ? join('-', $this->getExportConfig('levels')) : '0')
28503352761SKirsten Roschanski            . $this->title;
286ee19bac3SLuigi Micco        $cache = new cache($cachekey, '.dw2.pdf');
287ee19bac3SLuigi Micco
288ee19bac3SLuigi Micco        $dependencies = array();
289ee19bac3SLuigi Micco        foreach($this->list as $pageid) {
290ee19bac3SLuigi Micco            $relations = p_get_metadata($pageid, 'relation');
291ee19bac3SLuigi Micco
292ee19bac3SLuigi Micco            if(is_array($relations)) {
293ee19bac3SLuigi Micco                if(array_key_exists('media', $relations) && is_array($relations['media'])) {
294ee19bac3SLuigi Micco                    foreach($relations['media'] as $mediaid => $exists) {
295ee19bac3SLuigi Micco                        if($exists) {
296ee19bac3SLuigi Micco                            $dependencies[] = mediaFN($mediaid);
297ee19bac3SLuigi Micco                        }
298ee19bac3SLuigi Micco                    }
299ee19bac3SLuigi Micco                }
300ee19bac3SLuigi Micco
301ee19bac3SLuigi Micco                if(array_key_exists('haspart', $relations) && is_array($relations['haspart'])) {
302ee19bac3SLuigi Micco                    foreach($relations['haspart'] as $part_pageid => $exists) {
303ee19bac3SLuigi Micco                        if($exists) {
304ee19bac3SLuigi Micco                            $dependencies[] = wikiFN($part_pageid);
305ee19bac3SLuigi Micco                        }
306ee19bac3SLuigi Micco                    }
307ee19bac3SLuigi Micco                }
308ee19bac3SLuigi Micco            }
309ee19bac3SLuigi Micco
310ee19bac3SLuigi Micco            $dependencies[] = metaFN($pageid, '.meta');
311ee19bac3SLuigi Micco        }
312ee19bac3SLuigi Micco
313ee19bac3SLuigi Micco        $depends['files'] = array_map('wikiFN', $this->list);
314ee19bac3SLuigi Micco        $depends['files'][] = __FILE__;
315ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/renderer.php';
316ee19bac3SLuigi Micco        $depends['files'][] = dirname(__FILE__) . '/mpdf/mpdf.php';
317ee19bac3SLuigi Micco        $depends['files'] = array_merge(
318ee19bac3SLuigi Micco            $depends['files'],
319ee19bac3SLuigi Micco            $dependencies,
320ee19bac3SLuigi Micco            getConfigFiles('main')
321ee19bac3SLuigi Micco        );
322a58f45f0SGerrit Uitslag        return $cache;
323ee19bac3SLuigi Micco    }
324ee19bac3SLuigi Micco
325d63e7fe7SGerrit Uitslag    /**
326d63e7fe7SGerrit Uitslag     * Set error notification and reload page again
327d63e7fe7SGerrit Uitslag     *
328d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
329d63e7fe7SGerrit Uitslag     * @param string $msglangkey key of translation key
330c7138b3fSGerrit Uitslag     * @param string $replacement
331d63e7fe7SGerrit Uitslag     */
332c7138b3fSGerrit Uitslag    private function showPageWithErrorMsg(Doku_Event $event, $msglangkey, $replacement=null) {
333c7138b3fSGerrit Uitslag        if(empty($replacement)) {
334c7138b3fSGerrit Uitslag            $msg = $this->getLang($msglangkey);
335c7138b3fSGerrit Uitslag        } else {
336c7138b3fSGerrit Uitslag            $msg = sprintf($this->getLang($msglangkey), $replacement);
337c7138b3fSGerrit Uitslag        }
338c7138b3fSGerrit Uitslag        msg($msg, -1);
339d63e7fe7SGerrit Uitslag
340d63e7fe7SGerrit Uitslag        $event->data = 'show';
341d63e7fe7SGerrit Uitslag        $_SERVER['REQUEST_METHOD'] = 'POST'; //clears url
342d63e7fe7SGerrit Uitslag    }
343d63e7fe7SGerrit Uitslag
344d63e7fe7SGerrit Uitslag    /**
345e53f1ec0SSzymon Olewniczak     * Returns the parsed Wikitext in dw2pdf for the given id and revision
346e53f1ec0SSzymon Olewniczak     *
347e53f1ec0SSzymon Olewniczak     * @param string     $id  page id
348e53f1ec0SSzymon Olewniczak     * @param string|int $rev revision timestamp or empty string
349e53f1ec0SSzymon Olewniczak     * @param string     $date_at
350e53f1ec0SSzymon Olewniczak     * @return null|string
351e53f1ec0SSzymon Olewniczak     */
352e53f1ec0SSzymon Olewniczak    protected function p_wiki_dw2pdf($id, $rev = '', $date_at = '') {
353e53f1ec0SSzymon Olewniczak        $file = wikiFN($id, $rev);
354e53f1ec0SSzymon Olewniczak
355e53f1ec0SSzymon Olewniczak        if(!file_exists($file)) return '';
356e53f1ec0SSzymon Olewniczak
357e53f1ec0SSzymon Olewniczak        //ensure $id is in global $ID (needed for parsing)
358e53f1ec0SSzymon Olewniczak        global $ID;
359e53f1ec0SSzymon Olewniczak        $keep = $ID;
360e53f1ec0SSzymon Olewniczak        $ID   = $id;
361e53f1ec0SSzymon Olewniczak
362e53f1ec0SSzymon Olewniczak        if($rev || $date_at) {
363e53f1ec0SSzymon Olewniczak            $ret = p_render('dw2pdf', p_get_instructions(io_readWikiPage($file, $id, $rev)), $info, $date_at); //no caching on old revisions
364e53f1ec0SSzymon Olewniczak        } else {
365e53f1ec0SSzymon Olewniczak            $ret = p_cached_output($file, 'dw2pdf', $id);
366e53f1ec0SSzymon Olewniczak        }
367e53f1ec0SSzymon Olewniczak
368e53f1ec0SSzymon Olewniczak        //restore ID (just in case)
369e53f1ec0SSzymon Olewniczak        $ID = $keep;
370e53f1ec0SSzymon Olewniczak
371e53f1ec0SSzymon Olewniczak        return $ret;
372e53f1ec0SSzymon Olewniczak    }
373e53f1ec0SSzymon Olewniczak
374e53f1ec0SSzymon Olewniczak    /**
375d63e7fe7SGerrit Uitslag     * Build a pdf from the html
376d63e7fe7SGerrit Uitslag     *
377d63e7fe7SGerrit Uitslag     * @param string $cachefile
378*d9c13ec7SGerrit Uitslag     * @param Doku_Event $event
379d63e7fe7SGerrit Uitslag     */
3802d9cd424SGerrit Uitslag    protected function generatePDF($cachefile, $event) {
3812d9cd424SGerrit Uitslag        global $REV, $INPUT, $DATE_AT;
382e53f1ec0SSzymon Olewniczak
3832d9cd424SGerrit Uitslag        if ($event->data == 'export_pdf') { //only one page is exported
384e53f1ec0SSzymon Olewniczak            $rev = $REV;
385e53f1ec0SSzymon Olewniczak            $date_at = $DATE_AT;
386e53f1ec0SSzymon Olewniczak        } else { //we are exporting entre namespace, ommit revisions
387e53f1ec0SSzymon Olewniczak            $rev = $date_at = '';
388e53f1ec0SSzymon Olewniczak        }
38987c86ddaSAndreas Gohr
39002f9a447SGerrit Uitslag        //some shortcuts to export settings
39102f9a447SGerrit Uitslag        $hasToC = $this->getExportConfig('hasToC');
39202f9a447SGerrit Uitslag        $levels = $this->getExportConfig('levels');
39302f9a447SGerrit Uitslag        $isDebug = $this->getExportConfig('isDebug');
3946ea88a05SAndreas Gohr
3951ef68647SAndreas Gohr        // initialize PDF library
396cde5a1b3SAndreas Gohr        require_once(dirname(__FILE__) . "/DokuPDF.class.php");
3976ea88a05SAndreas Gohr
3984870b378SLarsDW223        $mpdf = new DokuPDF($this->getExportConfig('pagesize'),
3994870b378SLarsDW223                            $this->getExportConfig('orientation'),
4004870b378SLarsDW223                            $this->getExportConfig('font-size'));
401ee19bac3SLuigi Micco
402d62df65bSAndreas Gohr        // let mpdf fix local links
403d62df65bSAndreas Gohr        $self = parse_url(DOKU_URL);
404d62df65bSAndreas Gohr        $url = $self['scheme'] . '://' . $self['host'];
40502f9a447SGerrit Uitslag        if($self['port']) {
40602f9a447SGerrit Uitslag            $url .= ':' . $self['port'];
40702f9a447SGerrit Uitslag        }
408*d9c13ec7SGerrit Uitslag        $mpdf->SetBasePath($url);
409d62df65bSAndreas Gohr
41056d13144SAndreas Gohr        // Set the title
41103352761SKirsten Roschanski        $mpdf->SetTitle($this->title);
41256d13144SAndreas Gohr
413d63e7fe7SGerrit Uitslag        // some default document settings
414d63e7fe7SGerrit Uitslag        //note: double-sided document, starts at an odd page (first page is a right-hand side page)
415213fdb75SGerrit Uitslag        //      single-side document has only odd pages
416213fdb75SGerrit Uitslag        $mpdf->mirrorMargins = $this->getExportConfig('doublesided');
417daa70883SAndreas Gohr        $mpdf->setAutoTopMargin = 'stretch';
418daa70883SAndreas Gohr        $mpdf->setAutoBottomMargin = 'stretch';
41902f9a447SGerrit Uitslag//            $mpdf->pagenumSuffix = '/'; //prefix for {nbpg}
42002f9a447SGerrit Uitslag        if($hasToC) {
42102f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => 'i', 'suppress' => 'off'); //use italic pageno until ToC
42202f9a447SGerrit Uitslag            $mpdf->h2toc = $levels;
42302f9a447SGerrit Uitslag        } else {
42402f9a447SGerrit Uitslag            $mpdf->PageNumSubstitutions[] = array('from' => 1, 'reset' => 0, 'type' => '1', 'suppress' => 'off');
42502f9a447SGerrit Uitslag        }
4262eedf77dSAndreas Gohr
42756d13144SAndreas Gohr        // load the template
42803352761SKirsten Roschanski        $template = $this->load_template();
429ee19bac3SLuigi Micco
4301ef68647SAndreas Gohr        // prepare HTML header styles
431a2c33768SGerrit Uitslag        $html = '';
43202f9a447SGerrit Uitslag        if($isDebug) {
433a2c33768SGerrit Uitslag            $html .= '<html><head>';
434737417c6SKlap-in            $html .= '<style type="text/css">';
435a2c33768SGerrit Uitslag        }
436db1aa1bfSKirsten Roschanski
437db1aa1bfSKirsten Roschanski        $styles = '@page { size:auto; ' . $template['page'] . '}';
438a2c33768SGerrit Uitslag        $styles .= '@page :first {' . $template['first'] . '}';
439254467c4SGerrit Uitslag
440254467c4SGerrit Uitslag        $styles .= '@page landscape-page { size:landscape }';
441254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-landscape { page:landscape-page }';
442254467c4SGerrit Uitslag        $styles .= '@page portrait-page { size:portrait }';
443254467c4SGerrit Uitslag        $styles .= 'div.dw2pdf-portrait { page:portrait-page }';
444db1aa1bfSKirsten Roschanski        $styles .= $this->load_css();
445254467c4SGerrit Uitslag
446a2c33768SGerrit Uitslag        $mpdf->WriteHTML($styles, 1);
447a2c33768SGerrit Uitslag
44802f9a447SGerrit Uitslag        if($isDebug) {
449a2c33768SGerrit Uitslag            $html .= $styles;
4501ef68647SAndreas Gohr            $html .= '</style>';
4511ef68647SAndreas Gohr            $html .= '</head><body>';
452a2c33768SGerrit Uitslag        }
453a2c33768SGerrit Uitslag
454a2c33768SGerrit Uitslag        $body_start = $template['html'];
455a2c33768SGerrit Uitslag        $body_start .= '<div class="dokuwiki">';
4562eedf77dSAndreas Gohr
4571e45476bSmnapp        // insert the cover page
458a2c33768SGerrit Uitslag        $body_start .= $template['cover'];
459a2c33768SGerrit Uitslag
460a2c33768SGerrit Uitslag        $mpdf->WriteHTML($body_start, 2, true, false); //start body html
46102f9a447SGerrit Uitslag        if($isDebug) {
462a2c33768SGerrit Uitslag            $html .= $body_start;
463a2c33768SGerrit Uitslag        }
46402f9a447SGerrit Uitslag        if($hasToC) {
46502f9a447SGerrit 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
46602f9a447SGerrit Uitslag            //      - first page of ToC starts always at odd page (so eventually an additional blank page is included before)
46702f9a447SGerrit Uitslag            //      - there is no page numbering at the pages of the ToC
46802f9a447SGerrit Uitslag            $mpdf->TOCpagebreakByArray(
46902f9a447SGerrit Uitslag                array(
470230b098dSGerrit Uitslag                    'toc-preHTML' => '<h2>' . $this->getLang('tocheader') . '</h2>',
471230b098dSGerrit Uitslag                    'toc-bookmarkText' => $this->getLang('tocheader'),
47202f9a447SGerrit Uitslag                    'links' => true,
47302f9a447SGerrit Uitslag                    'outdent' => '1em',
47402f9a447SGerrit Uitslag                    'resetpagenum' => true, //start pagenumbering after ToC
47502f9a447SGerrit Uitslag                    'pagenumstyle' => '1'
47602f9a447SGerrit Uitslag                )
47702f9a447SGerrit Uitslag            );
47802f9a447SGerrit Uitslag            $html .= '<tocpagebreak>';
47902f9a447SGerrit Uitslag        }
48002f9a447SGerrit Uitslag
4811ef68647SAndreas Gohr        // loop over all pages
482c7138b3fSGerrit Uitslag        $counter = 0;
483c7138b3fSGerrit Uitslag        $no_pages = count($this->list);
484c7138b3fSGerrit Uitslag        foreach($this->list as $page) {
485c7138b3fSGerrit Uitslag            $counter++;
486b3eed6e3SGerrit Uitslag
48779be256fSMichael Große            $pagehtml = $this->p_wiki_dw2pdf($page, $rev, $date_at);
488e53f1ec0SSzymon Olewniczak            //file doesn't exists
489e53f1ec0SSzymon Olewniczak            if($pagehtml == '') {
490b3eed6e3SGerrit Uitslag                continue;
491b3eed6e3SGerrit Uitslag            }
492719256adSGerrit Uitslag            $pagehtml .= $this->page_depend_replacements($template['cite'], $page);
493c7138b3fSGerrit Uitslag            if($counter < $no_pages) {
494a2c33768SGerrit Uitslag                $pagehtml .= '<pagebreak />';
495a2c33768SGerrit Uitslag            }
496a2c33768SGerrit Uitslag
497a2c33768SGerrit Uitslag            $mpdf->WriteHTML($pagehtml, 2, false, false); //intermediate body html
49802f9a447SGerrit Uitslag            if($isDebug) {
499a2c33768SGerrit Uitslag                $html .= $pagehtml;
5001ef68647SAndreas Gohr            }
501ee19bac3SLuigi Micco        }
502ee19bac3SLuigi Micco
50333c15297SGerrit Uitslag        // insert the back page
504a2c33768SGerrit Uitslag        $body_end = $template['back'];
50533c15297SGerrit Uitslag
506a2c33768SGerrit Uitslag        $body_end .= '</div>';
507a2c33768SGerrit Uitslag
508d63e7fe7SGerrit Uitslag        $mpdf->WriteHTML($body_end, 2, false, true); // finish body html
50902f9a447SGerrit Uitslag        if($isDebug) {
510a2c33768SGerrit Uitslag            $html .= $body_end;
511eeb17e15SAndreas Gohr            $html .= '</body>';
512eeb17e15SAndreas Gohr            $html .= '</html>';
513a2c33768SGerrit Uitslag        }
514f765508eSGerrit Uitslag
515f765508eSGerrit Uitslag        //Return html for debugging
51602f9a447SGerrit Uitslag        if($isDebug) {
51702f9a447SGerrit Uitslag            if($INPUT->str('debughtml', 'text', true) == 'html') {
51826be4eceSGerrit Uitslag                echo $html;
519a2c33768SGerrit Uitslag            } else {
520a2c33768SGerrit Uitslag                header('Content-Type: text/plain; charset=utf-8');
521a2c33768SGerrit Uitslag                echo $html;
522a2c33768SGerrit Uitslag            }
52326be4eceSGerrit Uitslag            exit();
52426be4eceSGerrit Uitslag        };
525f765508eSGerrit Uitslag
52687c86ddaSAndreas Gohr        // write to cache file
527d63e7fe7SGerrit Uitslag        $mpdf->Output($cachefile, 'F');
52887c86ddaSAndreas Gohr    }
52987c86ddaSAndreas Gohr
530d63e7fe7SGerrit Uitslag    /**
531d63e7fe7SGerrit Uitslag     * @param string $cachefile
532d63e7fe7SGerrit Uitslag     */
53303352761SKirsten Roschanski    protected function sendPDFFile($cachefile) {
53487c86ddaSAndreas Gohr        header('Content-Type: application/pdf');
535b853b723SAndreas Gohr        header('Cache-Control: must-revalidate, no-transform, post-check=0, pre-check=0');
53687c86ddaSAndreas Gohr        header('Pragma: public');
537d63e7fe7SGerrit Uitslag        http_conditionalRequest(filemtime($cachefile));
538c0956f69SMichael Große        global $INPUT;
539f7b24f48SMichael Große        $outputTarget = $INPUT->str('outputTarget', $this->getConf('output'));
54087c86ddaSAndreas Gohr
54103352761SKirsten Roschanski        $filename = rawurlencode(cleanID(strtr($this->title, ':/;"', '    ')));
542c0956f69SMichael Große        if($outputTarget === 'file') {
5439a3c8d9fSAndreas Gohr            header('Content-Disposition: attachment; filename="' . $filename . '.pdf";');
54487c86ddaSAndreas Gohr        } else {
5459a3c8d9fSAndreas Gohr            header('Content-Disposition: inline; filename="' . $filename . '.pdf";');
54687c86ddaSAndreas Gohr        }
547ee19bac3SLuigi Micco
548b3eed6e3SGerrit Uitslag        //Bookcreator uses jQuery.fileDownload.js, which requires a cookie.
549b3eed6e3SGerrit Uitslag        header('Set-Cookie: fileDownload=true; path=/');
550b3eed6e3SGerrit Uitslag
551e993da11SGerrit Uitslag        //try to send file, and exit if done
552d63e7fe7SGerrit Uitslag        http_sendfile($cachefile);
55387c86ddaSAndreas Gohr
554d63e7fe7SGerrit Uitslag        $fp = @fopen($cachefile, "rb");
55587c86ddaSAndreas Gohr        if($fp) {
556d63e7fe7SGerrit Uitslag            http_rangeRequest($fp, filesize($cachefile), 'application/pdf');
55787c86ddaSAndreas Gohr        } else {
55887c86ddaSAndreas Gohr            header("HTTP/1.0 500 Internal Server Error");
55987c86ddaSAndreas Gohr            print "Could not read file - bad permissions?";
56087c86ddaSAndreas Gohr        }
5611ef68647SAndreas Gohr        exit();
5621ef68647SAndreas Gohr    }
5631ef68647SAndreas Gohr
5646be736bfSGerrit Uitslag    /**
5652eedf77dSAndreas Gohr     * Load the various template files and prepare the HTML/CSS for insertion
56644e8e8fbSGerrit Uitslag     *
56744e8e8fbSGerrit Uitslag     * @return array
5681ef68647SAndreas Gohr     */
56903352761SKirsten Roschanski    protected function load_template() {
5701ef68647SAndreas Gohr        global $ID;
5711ef68647SAndreas Gohr        global $conf;
5721ef68647SAndreas Gohr
5732eedf77dSAndreas Gohr        // this is what we'll return
5742eedf77dSAndreas Gohr        $output = array(
5751e45476bSmnapp            'cover' => '',
5762eedf77dSAndreas Gohr            'html'  => '',
5772eedf77dSAndreas Gohr            'page'  => '',
5782eedf77dSAndreas Gohr            'first' => '',
5792eedf77dSAndreas Gohr            'cite'  => '',
5802eedf77dSAndreas Gohr        );
5812eedf77dSAndreas Gohr
5822eedf77dSAndreas Gohr        // prepare header/footer elements
5832eedf77dSAndreas Gohr        $html = '';
58433c15297SGerrit Uitslag        foreach(array('header', 'footer') as $section) {
58533c15297SGerrit Uitslag            foreach(array('', '_odd', '_even', '_first') as $order) {
58602f9a447SGerrit Uitslag                $file = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/' . $section . $order . '.html';
58733c15297SGerrit Uitslag                if(file_exists($file)) {
58833c15297SGerrit Uitslag                    $html .= '<htmlpage' . $section . ' name="' . $section . $order . '">' . DOKU_LF;
58933c15297SGerrit Uitslag                    $html .= file_get_contents($file) . DOKU_LF;
59033c15297SGerrit Uitslag                    $html .= '</htmlpage' . $section . '>' . DOKU_LF;
5912eedf77dSAndreas Gohr
5922eedf77dSAndreas Gohr                    // register the needed pseudo CSS
59333c15297SGerrit Uitslag                    if($order == '_first') {
59433c15297SGerrit Uitslag                        $output['first'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
59533c15297SGerrit Uitslag                    } elseif($order == '_even') {
59633c15297SGerrit Uitslag                        $output['page'] .= 'even-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
59733c15297SGerrit Uitslag                    } elseif($order == '_odd') {
59833c15297SGerrit Uitslag                        $output['page'] .= 'odd-' . $section . '-name: html_' . $section . $order . ';' . DOKU_LF;
599daa70883SAndreas Gohr                    } else {
60033c15297SGerrit Uitslag                        $output['page'] .= $section . ': html_' . $section . $order . ';' . DOKU_LF;
6012eedf77dSAndreas Gohr                    }
6022eedf77dSAndreas Gohr                }
6032eedf77dSAndreas Gohr            }
6042eedf77dSAndreas Gohr        }
6052eedf77dSAndreas Gohr
6061ef68647SAndreas Gohr        // prepare replacements
6071ef68647SAndreas Gohr        $replace = array(
6081ef68647SAndreas Gohr            '@PAGE@'    => '{PAGENO}',
60902f9a447SGerrit Uitslag            '@PAGES@'   => '{nbpg}', //see also $mpdf->pagenumSuffix = ' / '
61003352761SKirsten Roschanski            '@TITLE@'   => hsc($this->title),
6111ef68647SAndreas Gohr            '@WIKI@'    => $conf['title'],
6121ef68647SAndreas Gohr            '@WIKIURL@' => DOKU_URL,
6131ef68647SAndreas Gohr            '@DATE@'    => dformat(time()),
6145d6fbaeaSAndreas Gohr            '@BASE@'    => DOKU_BASE,
615893987a2SAndreas Gohr            '@INC@'     => DOKU_INC,
616893987a2SAndreas Gohr            '@TPLBASE@' => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
617893987a2SAndreas Gohr            '@TPLINC@'  => DOKU_INC . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/'
6181ef68647SAndreas Gohr        );
6191ef68647SAndreas Gohr
6202eedf77dSAndreas Gohr        // set HTML element
621a180c973SKlap-in        $html = str_replace(array_keys($replace), array_values($replace), $html);
622a180c973SKlap-in        //TODO For bookcreator $ID (= bookmanager page) makes no sense
623a180c973SKlap-in        $output['html'] = $this->page_depend_replacements($html, $ID);
6241ef68647SAndreas Gohr
6251e45476bSmnapp        // cover page
62602f9a447SGerrit Uitslag        $coverfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/cover.html';
62733c15297SGerrit Uitslag        if(file_exists($coverfile)) {
62833c15297SGerrit Uitslag            $output['cover'] = file_get_contents($coverfile);
6291e45476bSmnapp            $output['cover'] = str_replace(array_keys($replace), array_values($replace), $output['cover']);
6309b071da5SMichael            $output['cover'] = $this->page_depend_replacements($output['cover'], $ID);
6316e2ec302SGerrit Uitslag            $output['cover'] .= '<pagebreak />';
6321e45476bSmnapp        }
6331e45476bSmnapp
63433c15297SGerrit Uitslag        // cover page
63502f9a447SGerrit Uitslag        $backfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/back.html';
63633c15297SGerrit Uitslag        if(file_exists($backfile)) {
63733c15297SGerrit Uitslag            $output['back'] = '<pagebreak />';
63833c15297SGerrit Uitslag            $output['back'] .= file_get_contents($backfile);
63933c15297SGerrit Uitslag            $output['back'] = str_replace(array_keys($replace), array_values($replace), $output['back']);
6409b071da5SMichael            $output['back'] = $this->page_depend_replacements($output['back'], $ID);
64133c15297SGerrit Uitslag        }
64233c15297SGerrit Uitslag
6432eedf77dSAndreas Gohr        // citation box
64402f9a447SGerrit Uitslag        $citationfile = DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/citation.html';
64533c15297SGerrit Uitslag        if(file_exists($citationfile)) {
64633c15297SGerrit Uitslag            $output['cite'] = file_get_contents($citationfile);
6472eedf77dSAndreas Gohr            $output['cite'] = str_replace(array_keys($replace), array_values($replace), $output['cite']);
6482eedf77dSAndreas Gohr        }
6491ef68647SAndreas Gohr
6502eedf77dSAndreas Gohr        return $output;
6511ef68647SAndreas Gohr    }
6521ef68647SAndreas Gohr
6531ef68647SAndreas Gohr    /**
654a180c973SKlap-in     * @param string $raw code with placeholders
655a180c973SKlap-in     * @param string $id  pageid
656a180c973SKlap-in     * @return string
657a180c973SKlap-in     */
658a180c973SKlap-in    protected function page_depend_replacements($raw, $id) {
659e53f1ec0SSzymon Olewniczak        global $REV, $DATE_AT;
660a180c973SKlap-in
661a180c973SKlap-in        // generate qr code for this page using google infographics api
662a180c973SKlap-in        $qr_code = '';
663a180c973SKlap-in        if($this->getConf('qrcodesize')) {
664a180c973SKlap-in            $url = urlencode(wl($id, '', '&', true));
665a180c973SKlap-in            $qr_code = '<img src="https://chart.googleapis.com/chart?chs=' .
666a180c973SKlap-in                $this->getConf('qrcodesize') . '&cht=qr&chl=' . $url . '" />';
667a180c973SKlap-in        }
668a180c973SKlap-in        // prepare replacements
669a180c973SKlap-in        $replace['@ID@']      = $id;
670a180c973SKlap-in        $replace['@UPDATE@']  = dformat(filemtime(wikiFN($id, $REV)));
671e53f1ec0SSzymon Olewniczak
672e53f1ec0SSzymon Olewniczak        $params = array();
673e53f1ec0SSzymon Olewniczak        if($DATE_AT) {
674e53f1ec0SSzymon Olewniczak            $params['at'] = $DATE_AT;
675e53f1ec0SSzymon Olewniczak        } elseif($REV) {
676e53f1ec0SSzymon Olewniczak            $params['rev'] = $REV;
677e53f1ec0SSzymon Olewniczak        }
678e53f1ec0SSzymon Olewniczak        $replace['@PAGEURL@'] = wl($id, $params, true, "&");
679a180c973SKlap-in        $replace['@QRCODE@']  = $qr_code;
680a180c973SKlap-in
681e3d68265SGerrit Uitslag        $content = str_replace(array_keys($replace), array_values($replace), $raw);
682e3d68265SGerrit Uitslag
683e3d68265SGerrit Uitslag        // @DATE(<date>[, <format>])@
684e3d68265SGerrit Uitslag        $content = preg_replace_callback(
685e3d68265SGerrit Uitslag            '/@DATE\((.*?)(?:,\s*(.*?))?\)@/',
686e3d68265SGerrit Uitslag            array($this, 'replacedate'),
687e3d68265SGerrit Uitslag            $content
688e3d68265SGerrit Uitslag        );
689e3d68265SGerrit Uitslag
690e3d68265SGerrit Uitslag        return $content;
691a180c973SKlap-in    }
692a180c973SKlap-in
693e3d68265SGerrit Uitslag
694e3d68265SGerrit Uitslag    /**
695e3d68265SGerrit Uitslag     * (callback) Replace date by request datestring
696e3d68265SGerrit Uitslag     * e.g. '%m(30-11-1975)' is replaced by '11'
697e3d68265SGerrit Uitslag     *
698e3d68265SGerrit Uitslag     * @param array $match with [0]=>whole match, [1]=> first subpattern, [2] => second subpattern
699e3d68265SGerrit Uitslag     * @return string
700e3d68265SGerrit Uitslag     */
701e3d68265SGerrit Uitslag    function replacedate($match) {
702e3d68265SGerrit Uitslag        global $conf;
703e3d68265SGerrit Uitslag        //no 2nd argument for default date format
704e3d68265SGerrit Uitslag        if($match[2] == null) {
705e3d68265SGerrit Uitslag            $match[2] = $conf['dformat'];
706e3d68265SGerrit Uitslag        }
707e3d68265SGerrit Uitslag        return strftime($match[2], strtotime($match[1]));
708e3d68265SGerrit Uitslag    }
709e3d68265SGerrit Uitslag
710a180c973SKlap-in    /**
7111c14c879SAndreas Gohr     * Load all the style sheets and apply the needed replacements
7121ef68647SAndreas Gohr     */
7131c14c879SAndreas Gohr    protected function load_css() {
714737417c6SKlap-in        global $conf;
7151c14c879SAndreas Gohr        //reusue the CSS dispatcher functions without triggering the main function
7161c14c879SAndreas Gohr        define('SIMPLE_TEST', 1);
7171c14c879SAndreas Gohr        require_once(DOKU_INC . 'lib/exe/css.php');
718ee19bac3SLuigi Micco
7191c14c879SAndreas Gohr        // prepare CSS files
7201c14c879SAndreas Gohr        $files = array_merge(
7211c14c879SAndreas Gohr            array(
7221c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/screen.css'
7231c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7241c14c879SAndreas Gohr                DOKU_INC . 'lib/styles/print.css'
7251c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/styles/',
7261c14c879SAndreas Gohr            ),
72758e6409eSAndreas Gohr            $this->css_pluginPDFstyles(),
7281c14c879SAndreas Gohr            array(
7291c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.css'
7301c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7311c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/tpl/' . $this->tpl . '/style.css'
7321c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/tpl/' . $this->tpl . '/',
7331c14c879SAndreas Gohr                DOKU_PLUGIN . 'dw2pdf/conf/style.local.css'
7341c14c879SAndreas Gohr                    => DOKU_BASE . 'lib/plugins/dw2pdf/conf/',
7351c14c879SAndreas Gohr            )
7361c14c879SAndreas Gohr        );
7371c14c879SAndreas Gohr        $css = '';
7381c14c879SAndreas Gohr        foreach($files as $file => $location) {
73928e636eaSGerrit Uitslag            $display = str_replace(fullpath(DOKU_INC), '', fullpath($file));
74028e636eaSGerrit Uitslag            $css .= "\n/* XXXXXXXXX $display XXXXXXXXX */\n";
7411c14c879SAndreas Gohr            $css .= css_loadfile($file, $location);
7421ef68647SAndreas Gohr        }
7431ef68647SAndreas Gohr
74428e636eaSGerrit Uitslag        if(function_exists('css_parseless')) {
7451c14c879SAndreas Gohr            // apply pattern replacements
74628e636eaSGerrit Uitslag            $styleini = css_styleini($conf['template']);
74728e636eaSGerrit Uitslag            $css = css_applystyle($css, $styleini['replacements']);
74828e636eaSGerrit Uitslag
74928e636eaSGerrit Uitslag            // parse less
75028e636eaSGerrit Uitslag            $css = css_parseless($css);
75128e636eaSGerrit Uitslag        } else {
75228e636eaSGerrit Uitslag            // @deprecated 2013-12-19: fix backward compatibility
7531c14c879SAndreas Gohr            $css = css_applystyle($css, DOKU_INC . 'lib/tpl/' . $conf['template'] . '/');
75428e636eaSGerrit Uitslag        }
7551ef68647SAndreas Gohr
7561c14c879SAndreas Gohr        return $css;
757ee19bac3SLuigi Micco    }
7581c14c879SAndreas Gohr
75958e6409eSAndreas Gohr    /**
76058e6409eSAndreas Gohr     * Returns a list of possible Plugin PDF Styles
76158e6409eSAndreas Gohr     *
76258e6409eSAndreas Gohr     * Checks for a pdf.css, falls back to print.css
76358e6409eSAndreas Gohr     *
76458e6409eSAndreas Gohr     * @author Andreas Gohr <andi@splitbrain.org>
76558e6409eSAndreas Gohr     */
7666be736bfSGerrit Uitslag    protected function css_pluginPDFstyles() {
76758e6409eSAndreas Gohr        $list = array();
76858e6409eSAndreas Gohr        $plugins = plugin_list();
769f54b51f7SAndreas Gohr
770f54b51f7SAndreas Gohr        $usestyle = explode(',', $this->getConf('usestyles'));
77158e6409eSAndreas Gohr        foreach($plugins as $p) {
772f54b51f7SAndreas Gohr            if(in_array($p, $usestyle)) {
773f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/screen.css"] = DOKU_BASE . "lib/plugins/$p/";
7748003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/screen.less"] = DOKU_BASE . "lib/plugins/$p/";
7758003b493SGerrit Uitslag
776f54b51f7SAndreas Gohr                $list[DOKU_PLUGIN . "$p/style.css"] = DOKU_BASE . "lib/plugins/$p/";
7778003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/style.less"] = DOKU_BASE . "lib/plugins/$p/";
778f54b51f7SAndreas Gohr            }
779f54b51f7SAndreas Gohr
7808003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.css"] = DOKU_BASE . "lib/plugins/$p/";
7818003b493SGerrit Uitslag            $list[DOKU_PLUGIN . "$p/all.less"] = DOKU_BASE . "lib/plugins/$p/";
7828003b493SGerrit Uitslag
78358e6409eSAndreas Gohr            if(file_exists(DOKU_PLUGIN . "$p/pdf.css")) {
78458e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/pdf.css"] = DOKU_BASE . "lib/plugins/$p/";
7858003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/pdf.less"] = DOKU_BASE . "lib/plugins/$p/";
78658e6409eSAndreas Gohr            } else {
78758e6409eSAndreas Gohr                $list[DOKU_PLUGIN . "$p/print.css"] = DOKU_BASE . "lib/plugins/$p/";
7888003b493SGerrit Uitslag                $list[DOKU_PLUGIN . "$p/print.less"] = DOKU_BASE . "lib/plugins/$p/";
78958e6409eSAndreas Gohr            }
79058e6409eSAndreas Gohr        }
79158e6409eSAndreas Gohr        return $list;
79258e6409eSAndreas Gohr    }
793ad18f4e1SGerrit Uitslag
794ad18f4e1SGerrit Uitslag    /**
79560e59de7SGerrit Uitslag     * Returns array of pages which will be included in the exported pdf
79660e59de7SGerrit Uitslag     *
79760e59de7SGerrit Uitslag     * @return array
79860e59de7SGerrit Uitslag     */
79960e59de7SGerrit Uitslag    public function getExportedPages() {
80060e59de7SGerrit Uitslag        return $this->list;
80160e59de7SGerrit Uitslag    }
80260e59de7SGerrit Uitslag
80360e59de7SGerrit Uitslag    /**
804ad18f4e1SGerrit Uitslag     * usort callback to sort by file lastmodified time
80544e8e8fbSGerrit Uitslag     *
80644e8e8fbSGerrit Uitslag     * @param array $a
80744e8e8fbSGerrit Uitslag     * @param array $b
80844e8e8fbSGerrit Uitslag     * @return int
809ad18f4e1SGerrit Uitslag     */
810ad18f4e1SGerrit Uitslag    public function _datesort($a, $b) {
811ad18f4e1SGerrit Uitslag        if($b['rev'] < $a['rev']) return -1;
812ad18f4e1SGerrit Uitslag        if($b['rev'] > $a['rev']) return 1;
813ad18f4e1SGerrit Uitslag        return strcmp($b['id'], $a['id']);
814ad18f4e1SGerrit Uitslag    }
815ad18f4e1SGerrit Uitslag
816ad18f4e1SGerrit Uitslag    /**
817ad18f4e1SGerrit Uitslag     * usort callback to sort by page id
81844e8e8fbSGerrit Uitslag     * @param array $a
81944e8e8fbSGerrit Uitslag     * @param array $b
82044e8e8fbSGerrit Uitslag     * @return int
821ad18f4e1SGerrit Uitslag     */
822ad18f4e1SGerrit Uitslag    public function _pagenamesort($a, $b) {
823eea6fd2cSMichael Große        // do not sort numbers before namespace separators
824eea6fd2cSMichael Große        $aID = str_replace(':', '/', $a['id']);
825eea6fd2cSMichael Große        $bID = str_replace(':', '/', $b['id']);
826eea6fd2cSMichael Große        if($aID <= $bID) return -1;
827eea6fd2cSMichael Große        if($aID > $bID) return 1;
828ad18f4e1SGerrit Uitslag        return 0;
829ad18f4e1SGerrit Uitslag    }
83026be4eceSGerrit Uitslag
83126be4eceSGerrit Uitslag    /**
83202f9a447SGerrit Uitslag     * Return settings read from:
83302f9a447SGerrit Uitslag     *   1. url parameters
83402f9a447SGerrit Uitslag     *   2. plugin config
83502f9a447SGerrit Uitslag     *   3. global config
83602f9a447SGerrit Uitslag     *
83702f9a447SGerrit Uitslag     * @return array
83802f9a447SGerrit Uitslag     */
83902f9a447SGerrit Uitslag    protected function loadExportConfig() {
84002f9a447SGerrit Uitslag        global $INPUT;
84102f9a447SGerrit Uitslag        global $conf;
84202f9a447SGerrit Uitslag
84302f9a447SGerrit Uitslag        $this->exportConfig = array();
84402f9a447SGerrit Uitslag
84502f9a447SGerrit Uitslag        // decide on the paper setup from param or config
84602f9a447SGerrit Uitslag        $this->exportConfig['pagesize'] = $INPUT->str('pagesize', $this->getConf('pagesize'), true);
84702f9a447SGerrit Uitslag        $this->exportConfig['orientation'] = $INPUT->str('orientation', $this->getConf('orientation'), true);
84802f9a447SGerrit Uitslag
8494870b378SLarsDW223        // decide on the font-size from param or config
8504870b378SLarsDW223        $this->exportConfig['font-size'] = $INPUT->str('font-size', $this->getConf('font-size'), true);
8514870b378SLarsDW223
852213fdb75SGerrit Uitslag        $doublesided = $INPUT->bool('doublesided', (bool) $this->getConf('doublesided'));
853213fdb75SGerrit Uitslag        $this->exportConfig['doublesided'] = $doublesided ? '1' : '0';
854213fdb75SGerrit Uitslag
855213fdb75SGerrit Uitslag        $hasToC = $INPUT->bool('toc', (bool) $this->getConf('toc'));
85602f9a447SGerrit Uitslag        $levels = array();
85702f9a447SGerrit Uitslag        if($hasToC) {
85802f9a447SGerrit Uitslag            $toclevels = $INPUT->str('toclevels', $this->getConf('toclevels'), true);
85902f9a447SGerrit Uitslag            list($top_input, $max_input) = explode('-', $toclevels, 2);
86002f9a447SGerrit Uitslag            list($top_conf, $max_conf) = explode('-', $this->getConf('toclevels'), 2);
86102f9a447SGerrit Uitslag            $bounds_input = array(
86202f9a447SGerrit Uitslag                'top' => array(
86302f9a447SGerrit Uitslag                    (int) $top_input,
86402f9a447SGerrit Uitslag                    (int) $top_conf
86502f9a447SGerrit Uitslag                ),
86602f9a447SGerrit Uitslag                'max' => array(
86702f9a447SGerrit Uitslag                    (int) $max_input,
86802f9a447SGerrit Uitslag                    (int) $max_conf
86902f9a447SGerrit Uitslag                )
87002f9a447SGerrit Uitslag            );
87102f9a447SGerrit Uitslag            $bounds = array(
87202f9a447SGerrit Uitslag                'top' => $conf['toptoclevel'],
87302f9a447SGerrit Uitslag                'max' => $conf['maxtoclevel']
87402f9a447SGerrit Uitslag
87502f9a447SGerrit Uitslag            );
87602f9a447SGerrit Uitslag            foreach($bounds_input as $bound => $values) {
87702f9a447SGerrit Uitslag                foreach($values as $value) {
87802f9a447SGerrit Uitslag                    if($value > 0 && $value <= 5) {
87902f9a447SGerrit Uitslag                        //stop at valid value and store
88002f9a447SGerrit Uitslag                        $bounds[$bound] = $value;
88102f9a447SGerrit Uitslag                        break;
88202f9a447SGerrit Uitslag                    }
88302f9a447SGerrit Uitslag                }
88402f9a447SGerrit Uitslag            }
88502f9a447SGerrit Uitslag
88602f9a447SGerrit Uitslag            if($bounds['max'] < $bounds['top']) {
88702f9a447SGerrit Uitslag                $bounds['max'] = $bounds['top'];
88802f9a447SGerrit Uitslag            }
88902f9a447SGerrit Uitslag
89002f9a447SGerrit Uitslag            for($level = $bounds['top']; $level <= $bounds['max']; $level++) {
89102f9a447SGerrit Uitslag                $levels["H$level"] = $level - 1;
89202f9a447SGerrit Uitslag            }
89302f9a447SGerrit Uitslag        }
89402f9a447SGerrit Uitslag        $this->exportConfig['hasToC'] = $hasToC;
89502f9a447SGerrit Uitslag        $this->exportConfig['levels'] = $levels;
89602f9a447SGerrit Uitslag
89702f9a447SGerrit Uitslag        $this->exportConfig['maxbookmarks'] = $INPUT->int('maxbookmarks', $this->getConf('maxbookmarks'), true);
89802f9a447SGerrit Uitslag
89902f9a447SGerrit Uitslag        $tplconf = $this->getConf('template');
90005d2b507SGerrit Uitslag        $tpl = $INPUT->str('tpl', $tplconf, true);
90102f9a447SGerrit Uitslag        if(!is_dir(DOKU_PLUGIN . 'dw2pdf/tpl/' . $tpl)) {
90202f9a447SGerrit Uitslag            $tpl = $tplconf;
90302f9a447SGerrit Uitslag        }
90402f9a447SGerrit Uitslag        if(!$tpl){
90502f9a447SGerrit Uitslag            $tpl = 'default';
90602f9a447SGerrit Uitslag        }
90702f9a447SGerrit Uitslag        $this->exportConfig['template'] = $tpl;
90802f9a447SGerrit Uitslag
90902f9a447SGerrit Uitslag        $this->exportConfig['isDebug'] = $conf['allowdebug'] && $INPUT->has('debughtml');
91002f9a447SGerrit Uitslag    }
91102f9a447SGerrit Uitslag
91202f9a447SGerrit Uitslag    /**
91302f9a447SGerrit Uitslag     * Returns requested config
91402f9a447SGerrit Uitslag     *
91502f9a447SGerrit Uitslag     * @param string $name
91602f9a447SGerrit Uitslag     * @param mixed  $notset
91702f9a447SGerrit Uitslag     * @return mixed|bool
91802f9a447SGerrit Uitslag     */
91902f9a447SGerrit Uitslag    public function getExportConfig($name, $notset = false) {
92002f9a447SGerrit Uitslag        if ($this->exportConfig === null){
92102f9a447SGerrit Uitslag            $this->loadExportConfig();
92202f9a447SGerrit Uitslag        }
92302f9a447SGerrit Uitslag
92402f9a447SGerrit Uitslag        if(isset($this->exportConfig[$name])){
92502f9a447SGerrit Uitslag            return $this->exportConfig[$name];
92602f9a447SGerrit Uitslag        }else{
92702f9a447SGerrit Uitslag            return $notset;
92802f9a447SGerrit Uitslag        }
92902f9a447SGerrit Uitslag    }
930d63e7fe7SGerrit Uitslag
931d63e7fe7SGerrit Uitslag    /**
932d63e7fe7SGerrit Uitslag     * Add 'export pdf'-button to pagetools
933d63e7fe7SGerrit Uitslag     *
934d63e7fe7SGerrit Uitslag     * @param Doku_Event $event
935d63e7fe7SGerrit Uitslag     */
93644e8e8fbSGerrit Uitslag    public function addbutton(Doku_Event $event) {
937e53f1ec0SSzymon Olewniczak        global $ID, $REV, $DATE_AT;
938d63e7fe7SGerrit Uitslag
939d63e7fe7SGerrit Uitslag        if($this->getConf('showexportbutton') && $event->data['view'] == 'main') {
940d63e7fe7SGerrit Uitslag            $params = array('do' => 'export_pdf');
941e53f1ec0SSzymon Olewniczak            if($DATE_AT) {
942e53f1ec0SSzymon Olewniczak                $params['at'] = $DATE_AT;
943e53f1ec0SSzymon Olewniczak            } elseif($REV) {
944d63e7fe7SGerrit Uitslag                $params['rev'] = $REV;
945d63e7fe7SGerrit Uitslag            }
946d63e7fe7SGerrit Uitslag
947d63e7fe7SGerrit Uitslag            // insert button at position before last (up to top)
948d63e7fe7SGerrit Uitslag            $event->data['items'] = array_slice($event->data['items'], 0, -1, true) +
949d63e7fe7SGerrit Uitslag                array('export_pdf' =>
950d63e7fe7SGerrit Uitslag                          '<li>'
95172cadc31SChristian Paul                          . '<a href="' . wl($ID, $params) . '"  class="action export_pdf" rel="nofollow" title="' . $this->getLang('export_pdf_button') . '">'
952d63e7fe7SGerrit Uitslag                          . '<span>' . $this->getLang('export_pdf_button') . '</span>'
953d63e7fe7SGerrit Uitslag                          . '</a>'
954d63e7fe7SGerrit Uitslag                          . '</li>'
955d63e7fe7SGerrit Uitslag                ) +
956d63e7fe7SGerrit Uitslag                array_slice($event->data['items'], -1, 1, true);
957d63e7fe7SGerrit Uitslag        }
958d63e7fe7SGerrit Uitslag    }
959026b594bSAndreas Gohr
960026b594bSAndreas Gohr    /**
961026b594bSAndreas Gohr     * Add 'export pdf' button to page tools, new SVG based mechanism
962026b594bSAndreas Gohr     *
963026b594bSAndreas Gohr     * @param Doku_Event $event
964026b594bSAndreas Gohr     */
965026b594bSAndreas Gohr    public function addsvgbutton(Doku_Event $event) {
9664c493e44SGerrit Uitslag        global $INFO;
9674c493e44SGerrit Uitslag        if($event->data['view'] != 'page' || !$this->getConf('showexportbutton')) {
9684c493e44SGerrit Uitslag            return;
9694c493e44SGerrit Uitslag        }
9704c493e44SGerrit Uitslag
9714c493e44SGerrit Uitslag        if(!$INFO['exists']) {
9724c493e44SGerrit Uitslag            return;
9734c493e44SGerrit Uitslag        }
9744c493e44SGerrit Uitslag
975026b594bSAndreas Gohr        array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dw2pdf\MenuItem()]);
976026b594bSAndreas Gohr    }
977ee19bac3SLuigi Micco}
978