1<?php
2/**
3 * Search with Scopes
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     i-net software <tools@inetsoftware.de>
7 * @author     Gerry Weissbach <gweissbach@inetsoftware.de>
8 */
9
10// must be run within Dokuwiki
11if (!defined('DOKU_INC')) die();
12if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
13
14require_once(DOKU_PLUGIN . 'syntax.php');
15
16class syntax_plugin_siteexport_toc extends DokuWiki_Syntax_Plugin {
17
18    private $insideToc = false;
19    private $savedToc = array();
20    private $options = array();
21
22    private $mergedPages = array();
23    private $includedPages = array();
24    private $merghintIds = array();
25    private $mergeHints = array();
26
27    public function getType() { return 'protected'; }
28    public function getPType() { return 'block'; }
29    public function getAllowedTypes() { return array('container'); }
30    public function getSort() { return 100; }
31
32    /**
33     * Connect pattern to lexer
34     */
35    public function connectTo($mode) {
36        $this->Lexer->addEntryPattern('<toc>(?=.*?</toc>)', $mode, 'plugin_siteexport_toc');
37        $this->Lexer->addEntryPattern('<toc .+?>(?=.*?</toc>)', $mode, 'plugin_siteexport_toc');
38        $this->Lexer->addSpecialPattern("\[\[.+?\]\]", $mode, 'plugin_siteexport_toc');
39    }
40
41    public function postConnect() {
42        $this->Lexer->addExitPattern('</toc.*?>', 'plugin_siteexport_toc');
43    }
44
45    public function handle($match, $state, $pos, Doku_Handler $handler) {
46        global $ID, $INFO;
47
48        switch ($state) {
49            case DOKU_LEXER_ENTER:
50
51                $this->insideToc = true;
52                $this->options = explode(' ', substr($match, 5, -1)?:"");
53                return array('start' => true, 'pos' => $pos, 'options' => $this->options);
54
55            case DOKU_LEXER_SPECIAL:
56
57                if ($this->insideToc) {
58
59                    $link = preg_replace(array('/^\[\[/', '/\]\]$/u'), '', $match);
60                    // Split title from URL
61                    $link = explode('|', $link, 2);
62                    if (!isset($link[1])) {
63                        $link[1] = NULL;
64                    } else if (preg_match('/^\{\{[^\}]+\}\}$/', $link[1])) {
65                        // If the title is an image, convert it to an array containing the image details
66                        $link[1] = Doku_Handler_Parse_Media($link[1]);
67                    }
68                    $link[0] = trim($link[0]);
69
70                    if (!(preg_match('/^[a-zA-Z0-9\.]+>{1}.*$/u', $link[0]) ||
71                    preg_match('/^\\\\\\\\[\w.:?\-;,]+?\\\\/u', $link[0]) ||
72                    preg_match('#^([a-z0-9\-\.+]+?)://#i', $link[0]) ||
73                    preg_match('<' . PREG_PATTERN_VALID_EMAIL . '>', $link[0]) ||
74                    preg_match('!^#.+!', $link[0]))
75                    ) {
76
77                        // Get current depth from call stack
78                        $depth = 1;
79                        if ($handler->CallWriter instanceof Doku_Handler_List) {
80
81                            $calls = array_reverse($handler->CallWriter->calls);
82                            $call = $calls[0];
83                            foreach ($calls as $item) {
84                                if (in_array($item[0], array('list_item', 'list_open'))) { $call = $item; break; }
85                            }
86
87                            $listType = null;
88                            $depth = $handler->CallWriter->interpretSyntax($call[1][0], $listType)-1; // Minus one because of plus one inside the interpret function
89                        }
90
91                        if (empty($link[0])) { break; } // No empty elements. This would lead to problems
92                        return array($link[0], $link[1], $depth);
93                    } else {
94                        // use parser! - but with another p
95                        $handler->internallink($match, $state, $pos);
96                    }
97                } else {
98                    // use parser!
99                    $handler->internallink($match, $state, $pos);
100                }
101
102                return false;
103            case DOKU_LEXER_UNMATCHED:
104
105                $handler->_addCall('cdata', array($match), $pos);
106
107                return false;
108            case DOKU_LEXER_EXIT:
109
110                $this->insideToc = false;
111                return 'save__meta';
112        }
113        return false;
114    }
115
116    public function render($mode, Doku_Renderer $renderer, $data) {
117        global $ID, $lang, $INFO;
118
119        list($SID, $NAME, $DEPTH) = $data;
120
121        $exists = null;
122        resolve_pageid(getNS($ID), $SID, $exists);
123//        $SID = cleanID($SID); // hier kein cleanID, da sonst moeglicherweise der anker verloren geht
124
125        //    Render XHTML and ODT
126        if ($mode != 'metadata' ) {
127
128            // TOC Title
129            if (is_array($data) && $data['start'] == true) {
130
131                if (is_Array($data['options'])) {
132                    foreach ($data['options'] as $opt) {
133                        switch ($opt) {
134                            case 'description' : $renderer->meta['sitetoc']['showDescription'] = true; break;
135                            case 'notoc' : $renderer->meta['sitetoc']['noTOC'] = true; break;
136                            case 'merge' : $renderer->meta['sitetoc']['mergeDoc'] = true; break;
137                            case 'nohead' : $renderer->meta['sitetoc']['noTocHeader'] = true; break;
138                            case 'mergeheader' : $renderer->meta['sitetoc']['mergeHeader'] = true; break;
139                            case 'pagebreak' : $renderer->meta['sitetoc']['pagebreak'] = true; break;
140                            case 'mergehint' : $renderer->meta['sitetoc']['mergehint'] = true; break;
141                        }
142                    }
143                }
144
145                $renderer->section_open("1 sitetoc");
146                if ($renderer->meta['sitetoc']['noTocHeader'] === false) {
147                    $renderer->header($lang['toc'], 1, $data['pos']);
148                }
149
150                return true;
151            } else
152
153            // All Output has been done
154            if (!is_array($data) && $data == 'save__meta') {
155
156                // Close TOC
157                $renderer->section_close();
158
159                if ($renderer->meta['sitetoc']['noTOC'] === true) {
160                    $renderer->doc = preg_replace("/<div.*?sitetoc.*?$/si", "", $renderer->doc);
161                }
162
163                // If this is not set, we may have it as Metadata
164                if (empty($this->mergedPages) && $renderer->meta['sitetoc']['mergeDoc']) {
165                    $toc = $renderer->meta['sitetoc']['siteexportTOC'];
166
167                    if (is_array($toc)) {
168                        foreach ($toc as $tocItem) {
169                            $this->mergedPages[] = array($tocItem['id'], $tocItem['depth']);
170                        }
171                    }
172
173                }
174
175                // If there is some data to be merged
176                if (count($this->mergedPages) > 0) {
177
178                    $renderer->doc = ''; // Start fresh!
179
180                    $renderer->section_open("1 mergedsite" . ($renderer->meta['sitetoc']['mergehint'] && count($this->mergedPages) > 1 ? ' mergehint' : ''));
181
182                    // Prepare lookup Array
183                    foreach ($this->mergedPages as $tocItem) {
184                        list($this->includedPages[]) = explode('#', $tocItem[0]);
185                    }
186
187                    // Load the instructions
188                    $instr = array();
189                    foreach ($this->mergedPages as $tocElement) {
190
191                        list($tocItem, $depth) = $tocElement;
192                        $file = wikiFN($tocItem);
193
194                        if (@file_exists($file)) {
195                            $instructions = p_cached_instructions($file, false, $tocItem);
196                        } else {
197                            $instructions = p_get_instructions(io_readWikiPage($file, $tocItem));
198                        }
199
200                        // Convert Link and header instructions
201                        $instructions = $this->_convertInstructions($instructions, $addID = null, $renderer, $depth);
202
203                        if ($renderer->meta['sitetoc']['mergeHeader'] && count($this->mergedPages) > 1) {
204                            // get a hint for merged pages
205                            if ($renderer->meta['sitetoc']['mergehint']) {
206                                // only if the first section is already there
207                                $mergeHint = p_get_metadata($tocItem, 'mergehint', METADATA_RENDER_USING_SIMPLE_CACHE);
208                                if (empty($mergeHint)) { $mergeHint = p_get_metadata($tocItem, 'thema', METADATA_RENDER_USING_SIMPLE_CACHE); }
209                                if (empty($mergeHint)) { $mergeHint = tpl_pagetitle($tocItem, true); }
210                                $instructions = $this->_mergeWithHeaders($this->_initialHeaderStructure($instructions), $instructions, 1, $mergeHint);
211                            }
212                            // Merge
213                            $instr = $this->_mergeWithHeaders($instr, $instructions, 1);
214
215                        } else
216                        if ($renderer->meta['sitetoc']['pagebreak']) {
217                            $sitepagebreak = array(array(
218                                'plugin',
219                                array(
220                                    'siteexport_toctools',
221                                    array(
222                                        'pagebreak',
223                                        null,
224                                        null
225                                    )
226                                )
227                            ));
228                            $instr = array_merge($instr, $instructions, $sitepagebreak);
229                        } else {
230                            // Concat
231                            $instr = array_merge($instr, $instructions);
232                        }
233                    }
234
235                    if (!empty($instr)) {
236                        if ( $this->_cleanAllInstructions($instr, true) ) {
237                            // There are no toc elements, remove the mergesite mergehint
238                            $renderer->doc = preg_replace( '/(class=".*?\s)mergedsite/', '\1', $renderer->doc );
239                            $renderer->doc = preg_replace( '/(class=".*?\s)mergehint/', '\1', $renderer->doc );
240                        }
241
242                        // print "<pre>"; print_r($instr); print "</pre>";
243                        $this->_render_output($renderer, $mode, $instr);
244                    }
245
246                    $renderer->section_close();
247                }
248                return true;
249            }
250
251            // Save the current ID
252            $LNID = $SID;
253
254            // Add ID to flags['mergeDoc']
255            if ($renderer->meta['sitetoc']['mergeDoc'] === true) { // || (count($renderer->meta['sitetoc']['siteexportTOC']) > 0 && $renderer->meta['sitetoc']['siteexportMergeDoc'] === true) ) {
256                $this->mergedPages[] = array($SID, $DEPTH);
257                resolve_pageid(getNS($ID), $SID, $exists);
258            } else {
259                // // print normal internal link (XHTML odt)
260                $renderer->internallink($LNID, $NAME, null);
261
262                // Display Description underneath
263                if ($renderer->meta['sitetoc']['showDescription'] === true) {
264                    $renderer->cdata(p_get_metadata($SID, 'description abstract', true));
265                }
266            }
267
268            // Render Metadata
269        } else if ($mode == 'metadata') {
270            if (!is_array($data) && $data == 'save__meta') {
271                $renderer->meta['sitetoc']['siteexportTOC'] = $this->savedToc;
272
273                foreach ($this->savedToc as $page) {
274                    $renderer->meta['relation']['references'][$page['id']] = $page['exists'];
275                }
276
277                $this->savedToc = array();
278            } else if (!isset($data['start']) && !isset($data['pos'])) {
279                $this->savedToc[] = $this->__addTocItem($SID, $NAME, $DEPTH, $renderer);
280            }
281        }
282
283        return true;
284    }
285
286    /*
287     * pull apart the ID and create an Entry for the TOC
288     */
289    private function __addTocItem($id, $name, $depth, $renderer) {
290        global $conf;
291        global $ID;
292
293        // Render Title
294        $default = $renderer->_simpleTitle($id);
295        $exists = false; $isImage = false; $linktype = null;
296        resolve_pageid(getNS($ID), $id, $exists);
297        $name = $renderer->_getLinkTitle($name, $default, $isImage, $id, $linktype);
298
299        //keep hash anchor
300        list($id, $hash) = explode('#', $id, 2);
301        if (!empty($hash)) $hash = $renderer->_headerToLink($hash);
302
303        // Build Sitetoc Item
304        $item = array();
305        $item['id'] = $id;
306        $item['name'] = $name;
307        $item['anchor'] = $hash;
308        $item['depth'] = $depth;
309        $item['exists'] = $exists;
310        if (!$conf['skipacl'] && auth_quickaclcheck($item['id']) < AUTH_READ) {
311            return false;
312        }
313
314        return $item;
315    }
316
317    /*
318     * Render the output of one page
319     */
320    private function _render_output($renderer, $mode, $instr) {
321        global $ID;
322
323        // Section IDs
324        // $addID = sectionID($addID, $check);    //not possible to use a:b:c for id
325
326        if ($mode == 'xhtml') {
327
328            //--------RENDER
329            //renderer information(TOC build / Cache used)
330            $info = array();
331            $content = p_render($mode, $instr, $info);
332
333            //Remove TOC`s, section edit buttons and tags
334            $content = $this->_cleanXHTML($content);
335
336            // embed the included page
337            // $renderer->doc .= '<div class="include">';
338            //add an anchor to find start of a inserted page
339            // $renderer->doc .= "<a name='$addID' id='$addID'>";
340            $renderer->doc .= $content;
341            // $renderer->doc .= '</div>';
342        } else {
343
344            // Loop through the instructions
345            foreach ($instr as $instruction) {
346                // Execute the callback against the Renderer
347                call_user_func_array(array($renderer, $instruction[0]), $instruction[1]);
348            }
349        }
350    }
351
352    /*
353     * Corrects relative internal links and media and
354     * converts headers of included pages to subheaders of the current page
355     */
356    private function _convertInstructions($instr, $id, &$renderer, $depth = 1) {
357        global $ID;
358        global $conf;
359
360        $n = count($instr);
361
362        for ($i = 0; $i < $n; $i++) {
363            //internal links(links inside this wiki) an relative links
364            if ((substr($instr[$i][0], 0, 12) == 'internallink')) {
365                $this->_convert_link($renderer, $instr[$i], $id);
366            }
367            else if ((substr($instr[$i][0], 0, 13) == 'internalmedia')) {
368                $this->_convert_media($renderer, $instr[$i], $id);
369            }
370            else if ((substr($instr[$i][0], 0, 6) == 'header')) {
371                $this->_convert_header($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1
372            }
373            else if ((substr($instr[$i][0], 0, 12) == 'section_open')) {
374                $this->_convert_section($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1
375            }
376        }
377
378        //if its the document start, cut off the first element(document information)
379        if ($instr[0][0] == 'document_start')
380        return array_slice($instr, 1, -1);
381        else
382        return $instr;
383    }
384
385    /*
386     * Convert link of given instruction
387     */
388    private function _convert_link(&$renderer, &$instr, $id) {
389        global $ID;
390
391        $exists = false;
392
393        resolve_pageid(getNS($id), $instr[1][0], $exists);
394        list($pageID, $pageReference) = explode("#", $instr[1][0], 2);
395
396        if (in_array($pageID, $this->includedPages)) {
397            // Crate new internal Links
398            $check = null;
399
400            // Either get existing reference or create from first heading. If still not there take the alternate ID
401            $pageNameLink = empty($pageReference) ? sectionID($pageID, $check) : $pageReference;
402
403            $instr[1][0] = $ID . "#" . $pageNameLink;
404
405        } else {
406            // Convert external Links to plain Text
407
408            $instr = array(
409                        "cdata",
410            array($instr[1][1]),
411            $instr[2]
412            );
413        }
414    }
415
416    /*
417     * Convert internalmedia of given instruction
418     */
419    private function _convert_media(&$renderer, &$instr, $id) {
420        global $ID;
421
422        // Resolvemedia returns the absolute path to media by reference
423        $exists = false;
424        resolve_mediaid(getNS($id), $instr[1][0], $exists);
425    }
426
427    /**
428     * @param integer $depth
429     */
430    private function _convert_header(&$renderer, &$instr, $depth) {
431        // More Depth!
432        $instr[1][1] += $depth;
433    }
434
435    /**
436     * @param integer $depth
437     */
438    private function _convert_section(&$renderer, &$instr, $depth) {
439        // More Depth!
440        $instr[1][0] += $depth;
441    }
442
443    private function _mergeWithHeaders($existing, $newInstructions, $level = 1, $mergeHint = array()) {
444
445        $returnInstructions = array();
446        $preparedInstructions = array();
447        $existingStart = $existingEnd = 0;
448        $firstRun = true;
449
450        while ($this->_findNextHeaderSection($existing, $level, $existingStart, $existingEnd)) {
451
452            if ($firstRun) {
453                $returnInstructions = array_merge($returnInstructions, array_slice($existing, 0, $existingStart));
454                $firstRun = false;
455            }
456
457            $currentSlice = array_slice($existing, $existingStart, $existingEnd-$existingStart);
458
459            // Find matching part with headername
460            $newStart = $newEnd = 0;
461            if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd, $currentSlice[0][1][0])) {
462
463                $newSlice = array_slice($newInstructions, $newStart, $newEnd-$newStart);
464                if ($newSlice[0][0] == 'header')
465                    array_shift($newSlice); // Remove Heading
466
467                // merge found parts on next level.
468                $returnedInstructions = $this->_mergeWithHeaders($currentSlice, $newSlice, $level+1, $mergeHint);
469
470                // Put them at the end!
471                $preparedInstructions = array_merge($preparedInstructions, $returnedInstructions);
472
473                // Remove from input
474                array_splice($newInstructions, $newStart, $newEnd-$newStart);
475            } else {
476                // Nothing else found
477                $preparedInstructions = array_merge($preparedInstructions, $currentSlice);
478            }
479
480            $existingStart = $existingEnd;
481        }
482
483        // Append the rest
484        $returnInstructions = array_merge($returnInstructions, array_slice($existing, $existingStart));
485
486        // Check for section close inconsistencies and put one at the very end ...
487        $section_postpend = array();
488        if (
489            (
490                ($tmp1 = array_slice($newInstructions, -1))
491                && ($tmp1[0][0] == 'section_close')
492            )
493            &&
494            (
495                ($tmp2 = array_slice($newInstructions, -2))
496                && ($tmp2[0][0] == 'section_close')
497            )
498        ) {
499            $section_postpend = array_splice($newInstructions, -1);
500        }
501        if (
502            (
503                ($tmp3 = array_slice($returnInstructions, -1))
504                && ($tmp3[0][0] == 'section_close')
505            )
506            &&
507            (
508                ($tmp4 = array_slice($returnInstructions, -2))
509                && ($tmp4[0][0] == 'section_close')
510            )
511        ) {
512            $section_postpend = array_merge($section_postpend, array_splice($returnInstructions, -1));
513        }
514
515        // What if there are headings left inside the $newInstructions?????
516        // Find matching part with headername
517        $newStart = $newEnd = 0;
518        $section_prepend = array();
519        if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd)) {
520            // If there are header in here, build a prepend and have the rest at the end
521            $section_prepend = array_splice($newInstructions, 0, $newStart);
522        } else {
523            // If not, prepend all of it.
524            $section_prepend = $newInstructions;
525            $newInstructions = array();
526        }
527
528        $this->_insertMergeHint($section_prepend, $mergeHint);
529
530        $returnInstructions = array_merge($returnInstructions, $section_prepend, $preparedInstructions, $newInstructions, $section_postpend);
531
532        return $returnInstructions;
533    }
534
535    /**
536     * @param integer $level
537     */
538    private function _findNextHeaderSection($section, $level, &$start, &$end, $headerName = null) {
539
540        $inCount = count($section);
541        $currentSlice = -1;
542
543        // Find Level 1 Header that matches.
544        for ($i = $start; $i < $inCount; $i++) {
545
546            $instruction = $section[$i];
547            $end = $i; // Or it will be lost and a section close will be missing.
548
549            // First Level Header
550            if ($instruction[0] == 'header' && $instruction[1][1] == $level) {
551
552                if ($currentSlice > 0) {
553                    return true;
554                }
555
556                if ($headerName == null || ($headerName == $instruction[1][0])) {
557                    // Begin of new slice ...
558                    $start = $currentSlice = $i;
559                }
560            }
561        }
562
563        // Nothing found
564        $end = $i; // Or it will be lost and a section close will be missing.
565        return $currentSlice > 0;
566    }
567
568    private function _cleanAllInstructions(&$instr, $advanced=false) {
569        $this->_cleanInstructions($instr, '/p_(close|open)/');
570        $this->_cleanInstructions($instr, '/section_(close|open)/');
571        $this->_cleanInstructions($instr, '/listu_(close|open)/');
572        $this->_cleanInstructions($instr, '/listo_(close|open)/');
573
574        if ( !$advanced ) {
575            return false;
576        }
577
578        $currentMergeHint = null;
579        $listOfMergeHintNames= [];
580
581        for( $i=0; $i<count($instr); $i++ ) {
582
583            $hasMoreEntries = count($instr)-1 > $i;
584
585            if ( $instr[$i][0] == 'header' ) {
586                // reset after header
587                $currentMergeHint = null;
588            }
589
590            if ( $instr[$i][1][0] == 'siteexport_toctools' && $instr[$i][1][0][0] != 'pagebreak' ) {
591                if ( $currentMergeHint != null && $instr[$i][1][1][2] == $currentMergeHint[1][1][2] ) {
592
593                    if ( $instr[$i][1][1][1] == 'end' ) {
594                        // look ahead, if the next hint is also the same ID, if so: remove this ending hint.
595                        $shouldSpliceAway = false;
596                        for( $ii=$i+1; $ii<count($instr); $ii++ ) {
597                            if ( $instr[$ii][0] == 'header' ) {
598                                // Jumping over a section now ... we have to leave the last entry
599                                break;
600                            } else if ( $instr[$ii][1][0] == 'siteexport_toctools' && $instr[$ii][1][0][0] != 'pagebreak' ) {
601                                if ( $instr[$ii][1][1][2] == $currentMergeHint[1][1][2] && $instr[$ii][1][1][1] == 'start' ) {
602                                    // Found another one, that is identicall - so this will be removed.
603                                    // also remove the current ending element
604                                    $shouldSpliceAway = true;
605                                }
606
607                                // Okay, this was a toctools whatever ... but maybe not a start of the same type.
608                                // we're done.
609                                break;
610                            }
611                        }
612
613                        if ( !$shouldSpliceAway ) {
614                            // print "<pre>NOT Splicing away ". print_r($instr[$i], true) . "</pre>";
615                            continue;
616                        }
617                        // print "<pre>Splicing away ". print_r($instr[$i], true) . "</pre>";
618                    }
619
620                    // print "<p>Removing 'mergehint' in between  </p>";
621                    array_splice($instr, $i--, 1);
622                } else {
623                    // print "<p>Resetting Mergehint '" . $instr[$i][1][1][2] . "' == '" . $currentMergeHint[1][1][2] . "'</p>";
624                    $currentMergeHint = $instr[$i];
625                    $listOfMergeHintNames[] = $instr[$i][1][1][2];
626                }
627            }
628        }
629
630/*
631        print "<pre>" . print_r($instr, 1) . "</pre>";
632
633//*/
634
635        // There is only ONE distinct mergehint -> remove all
636        $listOfMergeHintNames = array_unique($listOfMergeHintNames);
637        if ( count($listOfMergeHintNames) == 1 ) {
638            for( $i=0; $i<count($instr); $i++ ) {
639                if ( $instr[$i][1][0] == 'siteexport_toctools' && $instr[$i][1][0][0] != 'pagebreak' ) {
640                    array_splice($instr, $i--, 1);
641                }
642            }
643        }
644
645        return count($listOfMergeHintNames) == 1;
646    }
647
648    /**
649     * @param string $tag
650     */
651    private function _cleanInstructions(&$instructions, $tag) {
652
653
654/*
655        print "<pre>";
656        print "$tag ->\n";
657        print_r($instructions);
658        print "</pre>";
659//*/
660        $inCount = count($instructions);
661        for ($i = 0; $i < $inCount; $i++) {
662
663            // Last instruction
664            if ($i == $inCount-1) {
665                break;
666            }
667
668            if (preg_match($tag, $instructions[$i][0]) && preg_match($tag, $instructions[$i+1][0]) && $instructions[$i][0] != $instructions[$i+1][0]) {
669/*
670        print "<pre>";
671        print "Removed ->\n";
672        print_r($instructions[$i-1]);
673        print "---\n";
674        print_r($instructions[$i]);
675        print_r($instructions[$i+1]);
676        print "---\n";
677        print_r($instructions[$i+2]);
678        print "</pre>";
679//*/
680
681                // found different tags, but both match the expression and follow each other - so they can be elliminated
682                array_splice($instructions, $i, 2);
683                $inCount -= 2;
684                $i--;
685            }
686        }
687/*
688        print "<pre>";
689        print "$tag ->\n";
690        print_r($instructions);
691        print "</pre>";
692//*/
693    }
694
695    /**
696     * Strip everything except for the headers
697     */
698    private function _initialHeaderStructure($instructions) {
699        $inCount = count($instructions);
700        for ($i = 0; $i < $inCount; $i++) {
701
702            // Last instruction
703            if ($i == $inCount-1) {
704                break;
705            }
706
707            if (!in_array($instructions[$i][0], array('header', 'section_open', 'section_close', 'p_open', 'p_close'))) {
708                // found non-matching
709                array_splice($instructions, $i, 1);
710                $inCount--;
711                $i--;
712            }
713        }
714        return $instructions;
715    }
716
717    private function _insertMergeHint(&$instructions, $mergeHint) {
718
719        // Surround new slice with a mergehint
720        if (empty($mergeHint)) { return; }
721
722        // No emtpy insruction sets.
723        $this->_cleanAllInstructions($instructions);
724
725        if (empty($instructions)) { return; }
726
727        $mergeHintPrepend = $this->_toctoolPrepends( $instructions );
728
729        // only section content should be surrounded.
730        if ($instructions[0][0] != 'section_open') { return; }
731
732        // save for later use
733        $mergeHintId = sectionid($mergeHint, $this->mergeHints);
734        $this->merghintIds[$mergeHintId] = $mergeHint;
735
736        // Insert section information
737        array_push( $mergeHintPrepend, array(
738            'plugin',
739            array(
740                'siteexport_toctools',
741                array(
742                    'mergehint',
743                    'start',
744                    $mergeHint,
745                    $mergeHintId
746                )
747            )
748        ) );
749
750        $mergeHintPostpend = array(array(
751            'plugin',
752            array(
753                'siteexport_toctools',
754                array(
755                    'mergehint',
756                    'end',
757                    $mergeHint
758                )
759            )
760        ));
761
762        $instructions = array_merge($mergeHintPrepend, $instructions, $mergeHintPostpend);
763/*
764        print "<pre>"; print_r($instructions); print "</pre>";
765//*/
766    }
767
768    private function _toctoolPrepends( &$instructions ) {
769
770        $mergeHintPrependPrepend = array();
771
772        // 2021-01-14 This did no good - if a merged page had two mergehints, the first was stripped.
773/*
774        if ( $instructions[0][0] == 'plugin' && $instructions[0][1][0] == 'siteexport_toctools' && $instructions[0][1][1][1] == 'start' ) {
775
776            // This is already section merge hint ... but it will have a section at its end ... hopefully
777            do {
778                $_instructions = array_shift( $instructions );
779                array_push( $mergeHintPrependPrepend, $_instructions);
780            } while( !($_instructions[0] == 'plugin' && $_instructions[1][0] == 'siteexport_toctools' && $_instructions[1][1][1] == 'end' ) ) ;
781            array_splice($mergeHintPrepend, 0, 0, $mergeHintPrependPrepend);
782        }
783//*/
784/*
785        print "<pre>"; print_r($instructions); print "</pre>";
786//*/
787        return $mergeHintPrependPrepend;
788    }
789
790    /**
791     * Remove TOC, section edit buttons and tags
792     */
793    private function _cleanXHTML($xhtml) {
794        $replace = array(
795            '!<div class="toc">.*?(</div>\n</div>)!s' => '', // remove TOCs
796            '#<!-- SECTION \[(\d*-\d*)\] -->#s'       => '', // remove section edit buttons
797            '!<div id="tags">.*?(</div>)!s'           => ''  // remove category tags
798        );
799        $xhtml = preg_replace(array_keys($replace), array_values($replace), $xhtml);
800        return $xhtml;
801    }
802
803    /**
804     * Allow the plugin to prevent DokuWiki creating a second instance of itself
805     *
806     * @return bool   true if the plugin can not be instantiated more than once
807     */
808    public function isSingleton() {
809        return true;
810    }
811}
812// vim:ts=4:sw=4:et:enc=utf-8:
813