xref: /plugin/combo/action/snippets.php (revision c3437056399326d621a01da73b649707fbb0ae69)

<?php

use ComboStrap\CacheManager;
use ComboStrap\DokuPath;
use ComboStrap\ExceptionCombo;
use ComboStrap\LogUtility;
use ComboStrap\PluginUtility;
use ComboStrap\Resources;
use ComboStrap\Snippet;
use ComboStrap\SnippetManager;
use dokuwiki\Cache\CacheParser;

if (!defined('DOKU_INC')) die();

/**
 *
 *
 * Add the snippet needed by the components
 *
 */
class action_plugin_combo_snippets extends DokuWiki_Action_Plugin
{

    /**
     * @var bool - to trace if the header output was called
     */
    private $headerOutputWasCalled = false;

    function __construct()
    {
        // enable direct access to language strings
        // ie $this->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());


    }

    /**
     * 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
         */
        SnippetManager::init();

    }

    /**
     * Dokuwiki has already a canonical methodology
     * https://www.dokuwiki.org/canonical
     *
     * @param $event
     */
    function componentSnippetHead($event)
    {


        global $ID;
        if (empty($ID)) {

            global $_SERVER;
            $scriptName = $_SERVER['SCRIPT_NAME'];

            /**
             * If this is an ajax call, return
             * only if this not from webcode
             */
            if (strpos($scriptName, "/lib/exe/ajax.php") !== false) {
                global $_REQUEST;
                $call = $_REQUEST['call'];
                if ($call != action_plugin_combo_webcode::CALL_ID) {
                    return;
                }
            } else if (!(strpos($scriptName, "/lib/exe/detail.php") !== false)) {
                /**
                 * Image page has an header and footer that may needs snippet
                 * We return only if this is not a image/detail page
                 */
                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();
        $cacheManager = CacheManager::getOrCreate();

        /**
         * For each processed bar in the page
         *   * retrieve the snippets from the cache or store the process one
         *   * add the cache information in meta
         */
        $slots = $cacheManager->getXhtmlCacheSlotResultsForRequestedPage();
        foreach ($slots as $slotId => $servedFromCache) {

            /**
             * The local file location of the slot
             */
            $slotLocalFilePath = DokuPath::createPagePathFromId($slotId)
                ->toLocalPath()
                ->toAbsolutePath()
                ->toString();

            /**
             * Using a cache parser, set the page id and will trigger
             * the parser cache use event in order to log/report the cache usage
             * At {@link action_plugin_combo_cache::logCacheUsage()}
             */
            $cache = new CacheParser($slotId, $slotLocalFilePath, "snippet.json");
            $cache->setEvent('PARSER_CACHE_USE'); // cache parser use already this event, just FYI
            $dependencies = array(
                "files" => [
                    $slotLocalFilePath,
                    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)) {

                    $jsonDecodeSnippets = json_decode($data, true);
                    $nativeSnippets = [];
                    foreach ($jsonDecodeSnippets as $type => $snippets) {
                        foreach ($snippets as $snippetId => $snippetArray) {
                            try {
                                $nativeSnippets[$type][$snippetId] = Snippet::createFromJson($snippetArray);
                            } catch (ExceptionCombo $e) {
                                LogUtility::msg("The snippet json array cannot be build into a snippet object. " . $e->getMessage());
                            }
                        }
                    }
                    $snippetManager->addSnippetsFromCacheForBar($slotId, $nativeSnippets);

                }

            } else {
                $jsonDecodeSnippets = $snippetManager->getSnippetsForBar($slotId);
                if ($jsonDecodeSnippets !== null) {
                    $data1 = json_encode($jsonDecodeSnippets);
                    $cache->storeCache($data1);
                }
            }

        }

        /**
         * Snippets
         */
        $allSnippets = $snippetManager->getSnippets();
        foreach ($allSnippets 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 .= "</$tagType>" . DOKU_LF;
                }

            }

            $snippetManager->close();

        }

    }


}