* @author Gerry Weissbach */ // must be run within Dokuwiki if (!defined('DOKU_INC')) die(); if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/'); require_once(DOKU_PLUGIN . 'syntax.php'); class syntax_plugin_siteexport_toc extends DokuWiki_Syntax_Plugin { var $insideToc = false; var $savedToc = array(); var $options = array(); var $mergedPages = array(); var $includedPages = array(); function getType() { return 'protected'; } function getPType() { return 'block'; } function getAllowedTypes() { return array('container'); } function getSort() { return 100; } /** * Connect pattern to lexer */ function connectTo($mode) { $this->Lexer->addEntryPattern('(?=.*?)', $mode, 'plugin_siteexport_toc'); $this->Lexer->addEntryPattern('(?=.*?)', $mode, 'plugin_siteexport_toc'); $this->Lexer->addSpecialPattern("\[\[.+?\]\]", $mode, 'plugin_siteexport_toc'); } function postConnect() { $this->Lexer->addExitPattern('', 'plugin_siteexport_toc'); } function handle($match, $state, $pos, Doku_Handler $handler) { global $ID, $INFO; switch ($state) { case DOKU_LEXER_ENTER: $this->insideToc = true; $this->options = explode(' ', substr($match, 5, -1)); return array('start' => true, 'pos' => $pos, 'options' => $this->options); break; case DOKU_LEXER_SPECIAL: if ($this->insideToc) { $link = preg_replace(array('/^\[\[/', '/\]\]$/u'), '', $match); // Split title from URL $link = explode('|', $link, 2); if (!isset($link[1])) { $link[1] = NULL; } else if (preg_match('/^\{\{[^\}]+\}\}$/', $link[1])) { // If the title is an image, convert it to an array containing the image details $link[1] = Doku_Handler_Parse_Media($link[1]); } $link[0] = trim($link[0]); if (!(preg_match('/^[a-zA-Z0-9\.]+>{1}.*$/u', $link[0]) || preg_match('/^\\\\\\\\[\w.:?\-;,]+?\\\\/u', $link[0]) || preg_match('#^([a-z0-9\-\.+]+?)://#i', $link[0]) || preg_match('<' . PREG_PATTERN_VALID_EMAIL . '>', $link[0]) || preg_match('!^#.+!', $link[0])) ) { // Get current depth from call stack $depth = 1; if ($handler->CallWriter instanceof Doku_Handler_List) { $calls = array_reverse($handler->CallWriter->calls); $call = $calls[0]; foreach ($calls as $item) { if (in_array($item[0], array('list_item', 'list_open'))) { $call = $item; break; } } $depth = $handler->CallWriter->interpretSyntax($call[1][0], $listType)-1; // Minus one because of plus one inside the interpret function } if (empty($link[0])) { break; } // No empty elements. This would lead to problems return array($link[0], $link[1], $depth); break; } else { // use parser! - but with another p $handler->internallink($match, $state, $pos); } } else { // use parser! $handler->internallink($match, $state, $pos); } return false; case DOKU_LEXER_UNMATCHED: $handler->_addCall('cdata', array($match), $pos); return false; break; case DOKU_LEXER_EXIT: $this->insideToc = false; return 'save__meta'; break; } return false; } function render($mode, Doku_Renderer $renderer, $data) { global $ID, $lang, $INFO; list($SID, $NAME, $DEPTH) = $data; resolve_pageid(getNS($ID), $SID, $exists); // $SID = cleanID($SID); // hier kein cleanID, da sonst moeglicherweise der anker verloren geht // Render XHTML and ODT if ($mode == 'xhtml' || $mode == 'odt') { // TOC Title if (is_array($data) && $data['start'] == true) { if (is_Array($data['options'])) { foreach ($data['options'] as $opt) { switch ($opt) { case 'description' : $renderer->meta['sitetoc']['showDescription'] = true; break; case 'notoc' : $renderer->meta['sitetoc']['noTOC'] = true; break; case 'merge' : $renderer->meta['sitetoc']['mergeDoc'] = true; break; case 'nohead' : $renderer->meta['sitetoc']['noTocHeader'] = true; break; case 'mergeheader' : $renderer->meta['sitetoc']['mergeHeader'] = true; break; case 'pagebreak' : $renderer->meta['sitetoc']['pagebreak'] = true; break; } } } $renderer->section_open("1 sitetoc"); if ($renderer->meta['sitetoc']['noTocHeader'] === false) { $renderer->header($lang['toc'], 1, $data['pos']); } return true; } else // All Output has been done if (!is_array($data) && $data == 'save__meta') { // Close TOC $renderer->section_close(); if ($renderer->meta['sitetoc']['noTOC'] === true) { $renderer->doc = preg_replace("/doc); } // If this is not set, we may have it as Metadata if (!$this->mergedPages && $renderer->meta['sitetoc']['mergeDoc']) { $toc = $renderer->meta['sitetoc']['siteexportTOC']; if (is_array($toc)) { foreach ($toc as $tocItem) { $this->mergedPages[] = array($tocItem['id'], $tocItem['depth']); } } } // If there is some data to be merged if (count($this->mergedPages) > 0) { $renderer->doc = ''; // Start fresh! $renderer->section_open("1 mergedsite"); // Prepare lookup Array foreach ($this->mergedPages as $tocItem) { $this->includedPages[] = array_shift(explode('#', $tocItem[0])); } // Load the instructions $instr = array(); foreach ($this->mergedPages as $tocElement) { list($tocItem, $depth) = $tocElement; $file = wikiFN($tocItem); if (@file_exists($file)) { $instructions = p_cached_instructions($file, false, $tocItem); } else { $instructions = p_get_instructions(io_readWikiPage($file, $tocItem)); } // Convert Link and header instructions $instructions = $this->_convertInstructions($instructions, $addID, $renderer, $depth); if ($renderer->meta['sitetoc']['mergeHeader'] && !empty($instr)) { // Merge $instr = $this->_mergeWithHeaders($instr, $instructions, 1); } else if ($renderer->meta['sitetoc']['pagebreak']) { $instr = array_merge($instr, $instructions, $this->_convertInstructions(p_get_instructions(''), $addID, $renderer, $depth)); } else { // Concat $instr = array_merge($instr, $instructions); } } if (!empty($instr)) { $this->_cleanInstructions($instr, '/section_(close|open)/'); $this->_cleanInstructions($instr, '/listu_(close|open)/'); $this->_cleanInstructions($instr, '/listo_(close|open)/'); //if its the document start, cut off the first element(document information) if ($instr[count($instr)-1][1][0] == 'siteexport_pagebreak') { $instr = array_slice($instr, 0, -1); } $this->_render_output($renderer, $mode, $instr); } $renderer->section_close(); } return true; } // Save the current ID $LNID = $SID; // Add ID to flags['mergeDoc'] if ($renderer->meta['sitetoc']['mergeDoc'] === true) { // || (count($renderer->meta['sitetoc']['siteexportTOC']) > 0 && $renderer->meta['sitetoc']['siteexportMergeDoc'] === true) ) { $this->mergedPages[] = array($SID, $DEPTH); $default = $renderer->_simpleTitle($SID); $isImage = false; resolve_pageid(getNS($ID), $SID, $exists); $NAME = empty($NAME) ? p_get_first_heading($SID, true) : $NAME; $LNID = "$ID#" . sectionID($SID, $check); } else { // // print normal internal link (XHTML odt) $renderer->internallink($LNID, $NAME, null); // Display Description underneath if ($renderer->meta['sitetoc']['showDescription'] === true) { // $renderer->p_open(); $renderer->cdata(p_get_metadata($SID, 'description abstract', true)); // $renderer->p_close(); } } // Render Metadata } else if ($mode == 'metadata') { if (!is_array($data) && $data == 'save__meta') { $renderer->meta['sitetoc']['siteexportTOC'] = $this->savedToc; foreach ($this->savedToc as $page) { $renderer->meta['relation']['references'][$page['id']] = $page['exists']; } $this->savedToc = array(); } else if (!isset($data['start']) && !isset($data['pos'])) { $this->savedToc[] = $this->__addTocItem($SID, $NAME, $DEPTH, $renderer); } } else { return false; } return true; } /* * pull apart the ID and create an Entry for the TOC */ function __addTocItem($id, $name, $depth, $renderer) { global $conf; global $ID; // Render Title $default = $renderer->_simpleTitle($id); $exists = false; $isImage = false; $linktype = null; resolve_pageid(getNS($ID), $id, $exists); $name = $renderer->_getLinkTitle($name, $default, $isImage, $id, $linktype); //keep hash anchor list($id, $hash) = explode('#', $id, 2); if (!empty($hash)) $hash = $renderer->_headerToLink($hash); // Build Sitetoc Item $item = array(); $item['id'] = $id; $item['name'] = $name; $item['anchor'] = $hash; $item['depth'] = $depth; $item['exists'] = $exists; if (!$conf['skipacl'] && auth_quickaclcheck($item['id']) < AUTH_READ) { return false; } return $item; } /* * Render the output of one page */ function _render_output($renderer, $mode, $instr) { global $ID; // Section IDs // $addID = sectionID($addID, $check); //not possible to use a:b:c for id if ($mode == 'xhtml') { //--------RENDER //renderer information(TOC build / Cache used) $info = array(); $content = p_render($mode, $instr, $info); //Remove TOC`s, section edit buttons and tags $content = $this->_cleanXHTML($content); // embed the included page // $renderer->doc .= '

'; //add an anchor to find start of a inserted page // $renderer->doc .= ""; $renderer->doc .= $content; // $renderer->doc .= '

'; } else if ($mode == 'odt') { // Loop through the instructions foreach ($instr as $instruction) { // Execute the callback against the Renderer call_user_func_array(array($renderer, $instruction[0]), $instruction[1]); } } } /* * Corrects relative internal links and media and * converts headers of included pages to subheaders of the current page */ function _convertInstructions($instr, $id, &$renderer, $depth = 1) { global $ID; global $conf; $n = count($instr); for ($i = 0; $i < $n; $i++) { //internal links(links inside this wiki) an relative links if ((substr($instr[$i][0], 0, 12) == 'internallink')) { $this->_convert_link($renderer, $instr[$i], $id); } else if ((substr($instr[$i][0], 0, 13) == 'internalmedia')) { $this->_convert_media($renderer, $instr[$i], $id); } else if ((substr($instr[$i][0], 0, 6) == 'header')) { $this->_convert_header($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1 } else if ((substr($instr[$i][0], 0, 12) == 'section_open')) { $this->_convert_section($renderer, $instr[$i], $depth-1); // -1 because the depth starts at 1 } } //if its the document start, cut off the first element(document information) if ($instr[0][0] == 'document_start') return array_slice($instr, 1, -1); else return $instr; } /* * Convert link of given instruction */ function _convert_link(&$renderer, &$instr, $id) { global $ID; $exists = false; resolve_pageid(getNS($id), $instr[1][0], $exists); list($pageID, $pageReference) = explode("#", $instr[1][0], 2); if (in_array($pageID, $this->includedPages)) { // Crate new internal Links $check = null; // Either get existing reference or create from first heading. If still not there take the alternate ID $pageNameLink = empty($pageReference) ? sectionID($pageID, $check) : $pageReference; $instr[1][0] = $ID . "#" . $pageNameLink; } else { // Convert external Links to plain Text $instr = array( "cdata", array($instr[1][1]), $instr[2] ); } } /* * Convert internalmedia of given instruction */ function _convert_media(&$renderer, &$instr, $id) { global $ID; // Resolvemedia returns the absolute path to media by reference $exists = false; resolve_mediaid(getNS($id), $instr[1][0], $exists); } /** * @param integer $depth */ function _convert_header(&$renderer, &$instr, $depth) { // More Depth! $instr[1][1] += $depth; } /** * @param integer $depth */ function _convert_section(&$renderer, &$instr, $depth) { // More Depth! $instr[1][0] += $depth; } function _mergeWithHeaders($existing, $newInstructions, $level = 1) { $returnInstructions = array(); $preparedInstructions = array(); $existingStart = $existingEnd = 0; $firstRun = true; while ($this->_findNextHeaderSection($existing, $level, $existingStart, $existingEnd)) { if ($firstRun) { $returnInstructions = array_merge($returnInstructions, array_slice($existing, 0, $existingStart)); $firstRun = false; } $currentSlice = array_slice($existing, $existingStart, $existingEnd-$existingStart); // Find matching part with headername $newStart = $newEnd = 0; if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd, $currentSlice[0][1][0])) { $newSlice = array_slice($newInstructions, $newStart, $newEnd-$newStart); if ($newSlice[0][0] == 'header') array_shift($newSlice); // Remove Heading // merge found parts on next level. $returnedInstructions = $this->_mergeWithHeaders($currentSlice, $newSlice, $level+1); // Put them at the end! $preparedInstructions = array_merge($preparedInstructions, $returnedInstructions); // Remove from input array_splice($newInstructions, $newStart, $newEnd-$newStart); } else { $preparedInstructions = array_merge($preparedInstructions, $currentSlice); } $existingStart = $existingEnd; } // Append the rest $returnInstructions = array_merge($returnInstructions, array_slice($existing, $existingStart)); // Check for section close inconsistencies and put one at the very end ... $section_postpend = array(); if ( ( ($tmp = array_slice($newInstructions, -1)) && ($tmp[0][0] == 'section_close') ) && ( ($tmp = array_slice($newInstructions, -2)) && ($tmp[0][0] == 'section_close') ) ) { $section_postpend = array_splice($newInstructions, -1); } if ( ( ($tmp = array_slice($returnInstructions, -1)) && ($tmp[0][0] == 'section_close') ) && ( ($tmp = array_slice($returnInstructions, -2)) && ($tmp[0][0] == 'section_close') ) ) { $section_postpend = array_merge($section_postpend, array_splice($returnInstructions, -1)); } // What if there are headings left inside the $newInstructions????? // Find matching part with headername $newStart = $newEnd = 0; $section_prepend = array(); if ($this->_findNextHeaderSection($newInstructions, $level, $newStart, $newEnd)) { // If there are header in here, build a prepend and have the rest at the end $section_prepend = array_splice($newInstructions, 0, $newStart); } else { // If not, prepend all of it. $section_prepend = $newInstructions; $newInstructions = array(); } $returnInstructions = array_merge($returnInstructions, $section_prepend, $preparedInstructions, $newInstructions, $section_postpend); return $returnInstructions; } /** * @param integer $level */ function _findNextHeaderSection($section, $level, &$start, &$end, $headerName = null) { $inCount = count($section); $currentSlice = -1; // Find Level 1 Header that matches. for ($i = $start; $i < $inCount; $i++) { $instruction = $section[$i]; $end = $i; // Or it will be lost and a section close will be missing. // First Level Header if ($instruction[0] == 'header' && $instruction[1][1] == $level) { if ($currentSlice > 0) { return true; } if ($headerName == null || ($headerName == $instruction[1][0])) { // Begin of new slice ... $start = $currentSlice = $i; } } } // Nothing found $end = $i; // Or it will be lost and a section close will be missing. return $currentSlice > 0; } /** * @param string $tag */ function _cleanInstructions(&$instructions, $tag) { $inCount = count($instructions); for ($i = 0; $i < $inCount; $i++) { // Last instruction if ($i == $inCount-1) { break; } if (preg_match($tag, $instructions[$i][0]) && preg_match($tag, $instructions[$i+1][0]) && $instructions[$i][0] != $instructions[$i+1][0]) { // found different tags, but both match the expression and follow each other - so they can be elliminated array_splice($instructions, $i, 2); $inCount -= 2; $i--; } } } /** * Remove TOC, section edit buttons and tags */ function _cleanXHTML($xhtml) { $replace = array( '!

\n)!s' => '', // remove TOCs '##e' => '', // remove section edit buttons '!

.*?(

)!s' => '' // remove category tags ); $xhtml = preg_replace(array_keys($replace), array_values($replace), $xhtml); return $xhtml; } /** * Allow the plugin to prevent DokuWiki creating a second instance of itself * * @return bool true if the plugin can not be instantiated more than once */ function isSingleton() { return true; } } // vim:ts=4:sw=4:et:enc=utf-8: