lang $this->setupLocale(); } public function register(Doku_Event_Handler $controller) { /** * To add the snippets in the header */ $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'componentSnippetHead', array()); /** * To add the snippets in the content * if they have not been added to the header * * Not https://www.dokuwiki.org/devel:event:tpl_content_display TPL_ACT_RENDER * or https://www.dokuwiki.org/devel:event:tpl_act_render * because it works only for the main content * in {@link tpl_content()} * * We use * https://www.dokuwiki.org/devel:event:renderer_content_postprocess * that is in {@link p_render()} and takes into account also the slot page. */ $controller->register_hook('RENDERER_CONTENT_POSTPROCESS', 'AFTER', $this, 'componentSnippetContent', array()); /** * To reset the value */ $controller->register_hook('DOKUWIKI_DONE', 'BEFORE', $this, 'close', array()); /** * To log the cache used by bar */ $controller->register_hook('PARSER_CACHE_USE', 'AFTER', $this, 'barParsed', array()); } /** * Reset variable * Otherwise in test, when we call it two times, it just fail */ function close() { $this->headerOutputWasCalled = false; /** * Fighting the fact that in 7.2, * there is still a cache */ PluginUtility::initSnippetManager(); } /** * Dokuwiki has already a canonical methodology * https://www.dokuwiki.org/canonical * * @param $event */ function componentSnippetHead($event) { global $ID; if (empty($ID)) { global $_SERVER; $requestUri = $_SERVER['REQUEST_URI']; if (!strpos($requestUri, "/lib/exe/ajax.php") !== false) { global $_REQUEST; $call = $_REQUEST['call']; if ($call != action_plugin_combo_webcode::CALL_ID) { return; } } } /** * Advertise that the header output was called * If the user is using another template * than strap that does not put the component snippet * in the head * Used in */ $this->headerOutputWasCalled = true; $snippetManager = PluginUtility::getSnippetManager(); /** * For each processed bar in the page * * retrieve the snippets from the cache or store the process one * * add the cache information in meta */ $bars = $snippetManager->getBarsOfPage(); foreach ($bars as $barId => $servedFromCache) { // Add cache information into the head meta // to test $event->data["meta"][] = array("name" => self::COMBO_CACHE_PREFIX . $barId, "content" => var_export($servedFromCache, true)); // Get or store the data $cache = new \dokuwiki\Cache\Cache($barId, "snippet"); $barFileSystemPath = DokuPath::createPagePathFromPath(DokuPath::SEPARATOR . $barId)->getFileSystemPath(); $dependencies = array( "files" => [ $barFileSystemPath, Resources::getComboHome() . "/plugin.info.txt" ] ); // if the bar was served from the cache if ($servedFromCache && $cache->useCache($dependencies)) { // Retrieve snippets from previous run $data = $cache->retrieveCache(); if (!empty($data)) { $snippets = unserialize($data); $snippetManager->addSnippetsFromCacheForBar($barId, $snippets); if (Site::debugIsOn()) { LogUtility::log2file("Snippet cache file {$cache->cache} used", LogUtility::LVL_MSG_DEBUG); $event->data['script'][] = array( "type" => "application/json", "_data" => json_encode($snippets), "class" => "combo-snippet-cache-" . str_replace(":", "-", $barId)); } } } else { $snippets = $snippetManager->getSnippetsForBar($barId); if (!empty($snippets)) { $cache->storeCache(serialize($snippets)); } } } /** * Snippets */ foreach ($snippetManager->getSnippets() as $tagType => $tags) { foreach ($tags as $tag) { $event->data[$tagType][] = $tag; } } $snippetManager->close(); } /** * Used if the template does not run the content * before the calling of the header as strap does. * * In this case, the {@link \ComboStrap\SnippetManager::close()} has * not run, and the snippets are still in memory. * * We store them in the HTML and they * follows then the HTML cache of DokuWiki * @param $event */ function componentSnippetContent($event) { $format = $event->data[0]; if($format!=="xhtml"){ return; } /** * Run only if the header output was already called */ if ($this->headerOutputWasCalled) { $snippetManager = PluginUtility::getSnippetManager(); $xhtmlContent = &$event->data[1]; $snippets = $snippetManager->getSnippets(); foreach ($snippets as $tagType => $tags) { foreach ($tags as $tag) { $xhtmlContent .= DOKU_LF . "<$tagType"; $attributes = ""; $content = null; foreach ($tag as $attributeName => $attributeValue) { if ($attributeName != "_data") { $attributes .= " $attributeName=\"$attributeValue\""; } else { $content = $attributeValue; } } $xhtmlContent .= "$attributes>"; if (!empty($content)) { $xhtmlContent .= $content; } $xhtmlContent .= "" . DOKU_LF; } } $snippetManager->close(); } } /** * * @param $event */ function barParsed($event) { $data = $event->data; if ($data->mode == "xhtml") { /* @var CacheRenderer $data */ $pageId = $data->page; $cached = $event->result; PluginUtility::getSnippetManager()->addBar($pageId, $cached); } } }