xref: /plugin/siteexport/syntax/toc.php (revision 8be943245f88931947d200f3e9f6e31dc320b46c) 
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
14use dokuwiki\File\PageResolver;
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 ( isset( $handler->CallWriter ) && $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 = page_exists( (new PageResolver(getNS($ID)))->resolveId($SID) );
122
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                $SID = (new PageResolver(getNS($ID)))->resolveId($SID);
258                $exists = page_exists( $SID );
259            } else {
260                // // print normal internal link (XHTML odt)
261                $renderer->internallink($LNID, $NAME, null);
262
263                // Display Description underneath
264                if ($renderer->meta['sitetoc']['showDescription'] === true) {
265                    $renderer->cdata(p_get_metadata($SID, 'description abstract', true));
266                }
267            }
268
269            // Render Metadata
270        } else if ($mode == 'metadata') {
271            if (!is_array($data) && $data == 'save__meta') {
272                $renderer->meta['sitetoc']['siteexportTOC'] = $this->savedToc;
273
274                foreach ($this->savedToc as $page) {
275                    $renderer->meta['relation']['references'][$page['id']] = $page['exists'];
276                }
277
278                $this->savedToc = array();
279            } else if (!isset($data['start']) && !isset($data['pos'])) {
280                $this->savedToc[] = $this->__addTocItem($SID, $NAME, $DEPTH, $renderer);
281            }
282        }
283
284        return true;
285    }
286
287    /*
288     * pull apart the ID and create an Entry for the TOC
289     */
290    private function __addTocItem($id, $name, $depth, $renderer) {
291        global $conf;
292        global $ID;
293
294        // Render Title
295        $default = $renderer->_simpleTitle($id);
296        $exists = false; $isImage = false; $linktype = null;
297        $id = (new PageResolver(getNS($ID)))->resolveId($Sid);
298        $name = $renderer->_getLinkTitle($name, $default, $isImage, $id, $linktype);
299
300        //keep hash anchor
301        list($id, $hash) = explode('#', $id, 2);
302        if (!empty($hash)) $hash = $renderer->_headerToLink($hash);
303
304        // Build Sitetoc Item
305        $item = array();
306        $item['id'] = $id;
307        $item['name'] = $name;
308        $item['anchor'] = $hash;
309        $item['depth'] = $depth;
310        $item['exists'] = $exists;
311        if (!$conf['skipacl'] && auth_quickaclcheck($item['id']) < AUTH_READ) {
312            return false;
313        }
314
315        return $item;
316    }
317
318    /*
319     * Render the output of one page
320     */
321    private function _render_output($renderer, $mode, $instr) {
322        global $ID;
323
324        // Section IDs
325        // $addID = sectionID($addID, $check);    //not possible to use a:b:c for id
326
327        if ($mode == 'xhtml') {
328
329            //--------RENDER
330            //renderer information(TOC build / Cache used)
331            $info = array();
332            $content = p_render($mode, $instr, $info);
333
334            //Remove TOC`s, section edit buttons and tags
335            $content = $this->_cleanXHTML($content);
336
337            // embed the included page
338            // $renderer->doc .= '<div class="include">';
339            //add an anchor to find start of a inserted page
340            // $renderer->doc .= "<a name='$addID' id='$addID'>";
341            $renderer->doc .= $content;
342            // $renderer->doc .= '</div>';
343        } else {
344
345            // Loop through the instructions
346            foreach ($instr as $instruction) {
347                // Execute the callback against the Renderer
348                call_user_func_array(array($renderer, $instruction[0]), $instruction[1]);
349            }
350        }
351    }
352
353    /*
354     * Corrects relative internal links and media and
355     * converts headers of included pages to subheaders of the current page
356     */
357    private function _convertInstructions($instr, $id, &$renderer, $depth = 1) {
358        global $ID;
359        global $conf;
360
361        $n = count($instr);
362
363        for ($i = 0; $i < $n; $i++) {
364            //internal links(links inside this wiki) an relative links
365            if ((substr($instr[$i][0], 0, 12) == 'internallink')) {
366                $this->_convert_link($renderer, $instr[$i], $id);
367            }
368            else if ((substr($instr[$i][0], 0, 13) == 'internalmedia')) {
369                $this->_convert_media($renderer, $instr[$i], $id);
370            }
371            else if ((substr($instr[$i][0], 0, 6) == 'header')) {
372                $this->_convert_header($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1
373            }
374            else if ((substr($instr[$i][0], 0, 12) == 'section_open')) {
375                $this->_convert_section($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1
376            }
377        }
378
379        //if its the document start, cut off the first element(document information)
380        if ($instr[0][0] == 'document_start')
381        return array_slice($instr, 1, -1);
382        else
383        return $instr;
384    }
385
386    /*
387     * Convert link of given instruction
388     */
389    private function _convert_link(&$renderer, &$instr, $id) {
390        global $ID;
391
392        $exists = false;
393
394        $instr[1][0] = (new PageResolver(getNS($id)))->resolveId($instr[1][0]);
395        list($pageID, $pageReference) = explode("#", $instr[1][0], 2);
396
397        if (in_array($pageID, $this->includedPages)) {
398            // Crate new internal Links
399            $check = null;
400
401            // Either get existing reference or create from first heading. If still not there take the alternate ID
402            $pageNameLink = empty($pageReference) ? sectionID($pageID, $check) : $pageReference;
403
404            $instr[1][0] = $ID . "#" . $pageNameLink;
405
406        } else {
407            // Convert external Links to plain Text
408
409            $instr = array(
410                        "cdata",
411            array($instr[1][1]),
412            $instr[2]
413            );
414        }
415    }
416
417    /*
418     * Convert internalmedia of given instruction
419     */
420    private function _convert_media(&$renderer, &$instr, $id) {
421        global $ID;
422
423        // Resolvemedia returns the absolute path to media by reference
424        $exists = false;
425        resolve_mediaid(getNS($id), $instr[1][0], $exists);
426    }
427
428    /**
429     * @param integer $depth
430     */
431    private function _convert_header(&$renderer, &$instr, $depth) {
432        // More Depth!
433        $instr[1][1] += $depth;
434    }
435
436    /**
437     * @param integer $depth
438     */
439    private function _convert_section(&$renderer, &$instr, $depth) {
440        // More Depth!
441        $instr[1][0] += $depth;
442    }
443
444    private function _mergeWithHeaders($existing, $newInstructions, $level = 1, $mergeHint = array()) {
445
446        $returnInstructions = array();
447        $preparedInstructions = array();
448        $existingStart = $existingEnd = 0;
449        $firstRun = true;
450
451        while ($this->_findNextHeaderSection($existing, $level, $existingStart, $existingEnd)) {
452
453            if ($firstRun) {
454                $returnInstructions = array_merge($returnInstructions, array_slice($existing, 0, $existingStart));
455                $firstRun = false;
456            }
457
458            $currentSlice = array_slice($existing, $existingStart, $existingEnd-$existingStart);
459
460            // Find matching part with headername
461            $newStart = $newEnd = 0;
462            if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd, $currentSlice[0][1][0])) {
463
464                $newSlice = array_slice($newInstructions, $newStart, $newEnd-$newStart);
465                if ($newSlice[0][0] == 'header')
466                    array_shift($newSlice); // Remove Heading
467
468                // merge found parts on next level.
469                $returnedInstructions = $this->_mergeWithHeaders($currentSlice, $newSlice, $level+1, $mergeHint);
470
471                // Put them at the end!
472                $preparedInstructions = array_merge($preparedInstructions, $returnedInstructions);
473
474                // Remove from input
475                array_splice($newInstructions, $newStart, $newEnd-$newStart);
476            } else {
477                // Nothing else found
478                $preparedInstructions = array_merge($preparedInstructions, $currentSlice);
479            }
480
481            $existingStart = $existingEnd;
482        }
483
484        // Append the rest
485        $returnInstructions = array_merge($returnInstructions, array_slice($existing, $existingStart));
486
487        // Check for section close inconsistencies and put one at the very end ...
488        $section_postpend = array();
489        if (
490            (
491                ($tmp1 = array_slice($newInstructions, -1))
492                && ($tmp1[0][0] == 'section_close')
493            )
494            &&
495            (
496                ($tmp2 = array_slice($newInstructions, -2))
497                && ($tmp2[0][0] == 'section_close')
498            )
499        ) {
500            $section_postpend = array_splice($newInstructions, -1);
501        }
502        if (
503            (
504                ($tmp3 = array_slice($returnInstructions, -1))
505                && ($tmp3[0][0] == 'section_close')
506            )
507            &&
508            (
509                ($tmp4 = array_slice($returnInstructions, -2))
510                && ($tmp4[0][0] == 'section_close')
511            )
512        ) {
513            $section_postpend = array_merge($section_postpend, array_splice($returnInstructions, -1));
514        }
515
516        // What if there are headings left inside the $newInstructions?????
517        // Find matching part with headername
518        $newStart = $newEnd = 0;
519        $section_prepend = array();
520        if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd)) {
521            // If there are header in here, build a prepend and have the rest at the end
522            $section_prepend = array_splice($newInstructions, 0, $newStart);
523        } else {
524            // If not, prepend all of it.
525            $section_prepend = $newInstructions;
526            $newInstructions = array();
527        }
528
529        $this->_insertMergeHint($section_prepend, $mergeHint);
530
531        $returnInstructions = array_merge($returnInstructions, $section_prepend, $preparedInstructions, $newInstructions, $section_postpend);
532
533        return $returnInstructions;
534    }
535
536    /**
537     * @param integer $level
538     */
539    private function _findNextHeaderSection($section, $level, &$start, &$end, $headerName = null) {
540
541        $inCount = count($section);
542        $currentSlice = -1;
543
544        // Find Level 1 Header that matches.
545        for ($i = $start; $i < $inCount; $i++) {
546
547            $instruction = $section[$i];
548            $end = $i; // Or it will be lost and a section close will be missing.
549
550            // First Level Header
551            if ($instruction[0] == 'header' && $instruction[1][1] == $level) {
552
553                if ($currentSlice > 0) {
554                    return true;
555                }
556
557                if ($headerName == null || ($headerName == $instruction[1][0])) {
558                    // Begin of new slice ...
559                    $start = $currentSlice = $i;
560                }
561            }
562        }
563
564        // Nothing found
565        $end = $i; // Or it will be lost and a section close will be missing.
566        return $currentSlice > 0;
567    }
568
569    private function _cleanAllInstructions(&$instr, $advanced=false) {
570        $this->_cleanInstructions($instr, '/p_(close|open)/');
571        $this->_cleanInstructions($instr, '/section_(close|open)/');
572        $this->_cleanInstructions($instr, '/listu_(close|open)/');
573        $this->_cleanInstructions($instr, '/listo_(close|open)/');
574
575        if ( !$advanced ) {
576            return false;
577        }
578
579        $currentMergeHint = null;
580        $listOfMergeHintNames= [];
581
582        for( $i=0; $i<count($instr); $i++ ) {
583
584            $hasMoreEntries = count($instr)-1 > $i;
585
586            if ( $instr[$i][0] == 'header' ) {
587                // reset after header
588                $currentMergeHint = null;
589            }
590
591            if ( $instr[$i][1][0] == 'siteexport_toctools' && $instr[$i][1][0][0] != 'pagebreak' ) {
592                if ( $currentMergeHint != null && $instr[$i][1][1][2] == $currentMergeHint[1][1][2] ) {
593
594                    if ( $instr[$i][1][1][1] == 'end' ) {
595                        // look ahead, if the next hint is also the same ID, if so: remove this ending hint.
596                        $shouldSpliceAway = false;
597                        for( $ii=$i+1; $ii<count($instr); $ii++ ) {
598                            if ( $instr[$ii][0] == 'header' ) {
599                                // Jumping over a section now ... we have to leave the last entry
600                                break;
601                            } else if ( $instr[$ii][1][0] == 'siteexport_toctools' && $instr[$ii][1][0][0] != 'pagebreak' ) {
602                                if ( $instr[$ii][1][1][2] == $currentMergeHint[1][1][2] && $instr[$ii][1][1][1] == 'start' ) {
603                                    // Found another one, that is identicall - so this will be removed.
604                                    // also remove the current ending element
605                                    $shouldSpliceAway = true;
606                                }
607
608                                // Okay, this was a toctools whatever ... but maybe not a start of the same type.
609                                // we're done.
610                                break;
611                            }
612                        }
613
614                        if ( !$shouldSpliceAway ) {
615                            // print "<pre>NOT Splicing away ". print_r($instr[$i], true) . "</pre>";
616                            continue;
617                        }
618                        // print "<pre>Splicing away ". print_r($instr[$i], true) . "</pre>";
619                    }
620
621                    // print "<p>Removing 'mergehint' in between  </p>";
622                    array_splice($instr, $i--, 1);
623                } else {
624                    // print "<p>Resetting Mergehint '" . $instr[$i][1][1][2] . "' == '" . $currentMergeHint[1][1][2] . "'</p>";
625                    $currentMergeHint = $instr[$i];
626                    $listOfMergeHintNames[] = $instr[$i][1][1][2];
627                }
628            }
629        }
630
631/*
632        print "<pre>" . print_r($instr, 1) . "</pre>";
633
634//*/
635
636        // There is only ONE distinct mergehint -> remove all
637        $listOfMergeHintNames = array_unique($listOfMergeHintNames);
638        if ( count($listOfMergeHintNames) == 1 ) {
639            for( $i=0; $i<count($instr); $i++ ) {
640                if ( $instr[$i][1][0] == 'siteexport_toctools' && $instr[$i][1][0][0] != 'pagebreak' ) {
641                    array_splice($instr, $i--, 1);
642                }
643            }
644        }
645
646        return count($listOfMergeHintNames) == 1;
647    }
648
649    /**
650     * @param string $tag
651     */
652    private function _cleanInstructions(&$instructions, $tag) {
653
654
655/*
656        print "<pre>";
657        print "$tag ->\n";
658        print_r($instructions);
659        print "</pre>";
660//*/
661        $inCount = count($instructions);
662        for ($i = 0; $i < $inCount; $i++) {
663
664            // Last instruction
665            if ($i == $inCount-1) {
666                break;
667            }
668
669            if (preg_match($tag, $instructions[$i][0]) && preg_match($tag, $instructions[$i+1][0]) && $instructions[$i][0] != $instructions[$i+1][0]) {
670/*
671        print "<pre>";
672        print "Removed ->\n";
673        print_r($instructions[$i-1]);
674        print "---\n";
675        print_r($instructions[$i]);
676        print_r($instructions[$i+1]);
677        print "---\n";
678        print_r($instructions[$i+2]);
679        print "</pre>";
680//*/
681
682                // found different tags, but both match the expression and follow each other - so they can be elliminated
683                array_splice($instructions, $i, 2);
684                $inCount -= 2;
685                $i--;
686            }
687        }
688/*
689        print "<pre>";
690        print "$tag ->\n";
691        print_r($instructions);
692        print "</pre>";
693//*/
694    }
695
696    /**
697     * Strip everything except for the headers
698     */
699    private function _initialHeaderStructure($instructions) {
700        $inCount = count($instructions);
701        for ($i = 0; $i < $inCount; $i++) {
702
703            // Last instruction
704            if ($i == $inCount-1) {
705                break;
706            }
707
708            if (!in_array($instructions[$i][0], array('header', 'section_open', 'section_close', 'p_open', 'p_close'))) {
709                // found non-matching
710                array_splice($instructions, $i, 1);
711                $inCount--;
712                $i--;
713            }
714        }
715        return $instructions;
716    }
717
718    private function _insertMergeHint(&$instructions, $mergeHint) {
719
720        // Surround new slice with a mergehint
721        if (empty($mergeHint)) { return; }
722
723        // No emtpy insruction sets.
724        $this->_cleanAllInstructions($instructions);
725
726        if (empty($instructions)) { return; }
727
728        $mergeHintPrepend = $this->_toctoolPrepends( $instructions );
729
730        // only section content should be surrounded.
731        if ($instructions[0][0] != 'section_open') { return; }
732
733        // save for later use
734        $mergeHintId = sectionid($mergeHint, $this->mergeHints);
735        $this->merghintIds[$mergeHintId] = $mergeHint;
736
737        // Insert section information
738        array_push( $mergeHintPrepend, array(
739            'plugin',
740            array(
741                'siteexport_toctools',
742                array(
743                    'mergehint',
744                    'start',
745                    $mergeHint,
746                    $mergeHintId
747                )
748            )
749        ) );
750
751        $mergeHintPostpend = array(array(
752            'plugin',
753            array(
754                'siteexport_toctools',
755                array(
756                    'mergehint',
757                    'end',
758                    $mergeHint
759                )
760            )
761        ));
762
763        $instructions = array_merge($mergeHintPrepend, $instructions, $mergeHintPostpend);
764/*
765        print "<pre>"; print_r($instructions); print "</pre>";
766//*/
767    }
768
769    private function _toctoolPrepends( &$instructions ) {
770
771        $mergeHintPrependPrepend = array();
772
773        // 2021-01-14 This did no good - if a merged page had two mergehints, the first was stripped.
774/*
775        if ( $instructions[0][0] == 'plugin' && $instructions[0][1][0] == 'siteexport_toctools' && $instructions[0][1][1][1] == 'start' ) {
776
777            // This is already section merge hint ... but it will have a section at its end ... hopefully
778            do {
779                $_instructions = array_shift( $instructions );
780                array_push( $mergeHintPrependPrepend, $_instructions);
781            } while( !($_instructions[0] == 'plugin' && $_instructions[1][0] == 'siteexport_toctools' && $_instructions[1][1][1] == 'end' ) ) ;
782            array_splice($mergeHintPrepend, 0, 0, $mergeHintPrependPrepend);
783        }
784//*/
785/*
786        print "<pre>"; print_r($instructions); print "</pre>";
787//*/
788        return $mergeHintPrependPrepend;
789    }
790
791    /**
792     * Remove TOC, section edit buttons and tags
793     */
794    private function _cleanXHTML($xhtml) {
795        $replace = array(
796            '!<div class="toc">.*?(</div>\n</div>)!s' => '', // remove TOCs
797            '#<!-- SECTION \[(\d*-\d*)\] -->#s'       => '', // remove section edit buttons
798            '!<div id="tags">.*?(</div>)!s'           => ''  // remove category tags
799        );
800        $xhtml = preg_replace(array_keys($replace), array_values($replace), $xhtml);
801        return $xhtml;
802    }
803
804    /**
805     * Allow the plugin to prevent DokuWiki creating a second instance of itself
806     *
807     * @return bool   true if the plugin can not be instantiated more than once
808     */
809    public function isSingleton() {
810        return true;
811    }
812}
813// vim:ts=4:sw=4:et:enc=utf-8:
814