xref: /plugin/combo/ComboStrap/ExecutionContext.php (revision 94bd64624391aac031cc0626cae58a5718ca10d8)

<?php

namespace ComboStrap;


use ComboStrap\Meta\Store\MetadataDbStore;
use ComboStrap\Meta\Store\MetadataDokuWikiStore;
use ComboStrap\Tag\WebCodeTag;
use ComboStrap\Web\Url;
use dokuwiki\ActionRouter;
use dokuwiki\Extension\EventHandler;
use TestRequest;


/**
 * An execution object permits to manage the variable state for
 * an execution (ie one HTTP request)
 *
 *
 * Note that normally every page has a page context
 * meaning that you can go from an admin page to show the page.
 *
 *
 * When an execution context has finished, it should be {@link ExecutionContext::close() closed}
 * or destroyed
 *
 * You can get the actual execution context with {@link ExecutionContext::getActualOrCreateFromEnv()}
 *
 *
 * Same concept than [routing context](https://vertx.io/docs/apidocs/index.html?io/vertx/ext/web/RoutingContext.html)
 * (Not yet fully implemented)
 * ```java
 * if (pet.isPresent())
 *    routingContext
 *     .response()
 *      .setStatusCode(200)
 *       .putHeader(HttpHeaders.CONTENT_TYPE, "application/json")
 *      .end(pet.get().encode()); // (4)
 * else
 *    routingContext.fail(404, new Exception("Pet not found"));
 * }
 * ```
 */
class ExecutionContext
{

    /**
     * Dokuwiki do attribute
     */
    const DO_ATTRIBUTE = "do";


    const CANONICAL = "execution-context";

    /**
     * All action (handler)
     * That's what you will found in the `do` parameters
     */
    const SHOW_ACTION = "show";
    const EDIT_ACTION = "edit";
    /**
     * Preview is also used to
     * set the {@link FetcherMarkup::isFragment()}
     * processing to fragment
     */
    const PREVIEW_ACTION = "preview";
    const ADMIN_ACTION = "admin";
    const DRAFT_ACTION = "draft";
    const SEARCH_ACTION = "search";
    const LOGIN_ACTION = "login";
    const SAVE_ACTION = "save";
    const DRAFT_DEL_ACTION = "draftdel";
    const REDIRECT_ACTION = "redirect";

    /**
     * private actions does not render a page to be indexed
     * by a search engine (ie no redirect)
     * May be easier, if not `show`, not public
     */
    const PRIVATES_ACTION_NO_REDIRECT = [
        self::EDIT_ACTION,
        self::PREVIEW_ACTION,
        self::ADMIN_ACTION,
        self::DRAFT_ACTION,
        self::DRAFT_DEL_ACTION,
        self::SEARCH_ACTION,
        self::LOGIN_ACTION,
        self::SAVE_ACTION,
        self::REDIRECT_ACTION,
        self::REGISTER_ACTION,
        self::RESEND_PWD_ACTION,
        self::PROFILE_ACTION,
    ];
    const REGISTER_ACTION = "register";
    const RESEND_PWD_ACTION = "resendpwd";
    const PROFILE_ACTION = "profile";
    const REVISIONS_ACTION = "revisions";
    const DIFF_ACTION = "diff";
    const INDEX_ACTION = "index";


    /**
     * @var array of objects that are scoped to this request
     */
    private array $executionScopedVariables = [];

    private CacheManager $cacheManager;

    private Site $app;

    /**
     * A root execution context if any
     * Null because you can not unset a static variable
     */
    private static ?ExecutionContext $actualExecutionContext = null;

    private ?string $capturedGlobalId;
    /**
     * It may be an array when preview/save/cancel
     * @var array|string|null
     */
    private $capturedAct;


    private Url $url;


    public HttpResponse $response;

    /**
     * @var IFetcher - the fetcher that takes into account the HTTP request
     */
    private IFetcher $executingMainFetcher;

    /**
     * @var array - a stack of:
     *   * markup handler executing (ie handler that is taking a markup (file, string) and making it a HTML, pdf, ...)
     *   * and old global environement, $executingId, $contextExecutingId, $act
     *
     * This fetcher is called by the main fetcher or by the {@link self::setExecutingMarkupHandler()}
     */
    private array $executingMarkupHandlerStack = [];

    /**
     * @var TemplateForWebPage - the page template fetcher running (when a fetcher creates a page, it would uses this fetcher)
     * This class is called by the main fetcher to create a page
     */
    private TemplateForWebPage $executingPageTemplate;
    private string $creationTime;


    public function __construct()
    {

        $this->creationTime = Iso8601Date::createFromNow()->toIsoStringMs();

        $this->url = Url::createFromGetOrPostGlobalVariable();

        $this->response = HttpResponse::createFromExecutionContext($this);

        /**
         * The requested action
         */
        global $ACT;
        $this->capturedAct = $ACT;
        try {
            $urlAct = $this->url->getQueryPropertyValue(self::DO_ATTRIBUTE);
        } catch (ExceptionNotFound $e) {
            /**
             * The value is unknown
             * (in doku.php, the default is `show`,
             * we take the dokuwiki value because the execution context may be
             * created after the dokuwiki init)
             */
            $urlAct = $ACT;
        }
        $ACT = $urlAct;

        /**
         * The requested id
         */
        global $ID;
        $this->capturedGlobalId = $ID;
        try {

            $urlId = $this->url->getQueryPropertyValue(DokuwikiId::DOKUWIKI_ID_ATTRIBUTE);
            if (is_array($urlId)) {
                /**
                 * hack because the dokuwiki request global object as `ID` and `id` as array
                 * but our own {@link Url object} don't allow that and makes an array instead
                 * We don't use this data anyway, anymore ...
                 */
                $urlId = $urlId[0];
            }
            $ID = $urlId;

        } catch (ExceptionNotFound $e) {
            // none
            $ID = null;
        }


    }


    /**
     * @throws ExceptionNotFound
     */
    public static function getExecutionContext(): ExecutionContext
    {
        if (!isset(self::$actualExecutionContext)) {
            throw new ExceptionNotFound("No root context");
        }
        return self::$actualExecutionContext;
    }

    /**
     * Utility class to set the requested id (used only in test,
     * normally the environment is set from global PHP environment variable
     * that get the HTTP request
     * @param string $requestedId
     * @return ExecutionContext
     * @deprecated use {@link self::setDefaultContextPath()} if you want to set a context path
     * without using a {@link TemplateForWebPage} or {@link FetcherMarkup}
     */
    public static function getOrCreateFromRequestedWikiId(string $requestedId): ExecutionContext
    {

        return self::getActualOrCreateFromEnv()
            ->setDefaultContextPath(WikiPath::createMarkupPathFromId($requestedId));

    }


    /**
     * @return ExecutionContext
     * @deprecated uses {@link self::createBlank()} instead
     */
    public static function createFromEnvironmentVariable(): ExecutionContext
    {
        return self::createBlank();
    }


    public static function createBlank(): ExecutionContext
    {

        if (self::$actualExecutionContext !== null) {
            throw new ExceptionRuntimeInternal("The previous root context should be closed first");
        }
        $rootExecutionContext = (new ExecutionContext());
        self::$actualExecutionContext = $rootExecutionContext;
        return $rootExecutionContext;

    }

    /**
     * @return ExecutionContext - return the actual context or create a new one from the environment
     */
    public static function getActualOrCreateFromEnv(): ExecutionContext
    {
        try {
            return self::getExecutionContext();
        } catch (ExceptionNotFound $e) {
            return self::createBlank();
        }
    }

    /**
     * We create the id manager in the execution
     * context
     * (because in case a user choose to not use templating, the {@link FetcherMarkup}
     * is not available)
     * And all dynamic component such as {@link \syntax_plugin_combo_dropdown} would not
     * work anymore.
     *
     * @return IdManager
     */
    public function getIdManager(): IdManager
    {
        if (!isset($this->idManager)) {
            $this->idManager = new IdManager($this);
        }
        return $this->idManager;
    }

    /**
     * Return the actual context path
     */
    public function getContextNamespacePath(): WikiPath
    {
        $requestedPath = $this->getContextPath();
        try {
            return $requestedPath->getParent();
        } catch (ExceptionNotFound $e) {
            // root
            return $requestedPath;
        }

    }


    /**
     * @throws ExceptionNotFound
     */
    public function getExecutingWikiId(): string
    {
        global $ID;
        if (empty($ID)) {
            throw new ExceptionNotFound("No executing id was found");
        }
        return $ID;
    }


    /**
     * @return void close the execution context
     */
    public function close()
    {

        /**
         * Check that this execution context was not closed
         */
        if (self::$actualExecutionContext->creationTime !== $this->creationTime) {
            throw new ExceptionRuntimeInternal("This execution context was already closed");
        }

        /**
         * Restore the global $conf of dokuwiki
         */
        $this->getApp()->getConfig()->restoreConfigState();

        /** global dokuwiki messages variable */
        global $MSG;
        unset($MSG);

        /**
         * Environment restoration
         * Execution context, change for now only this
         * global variables
         */
        global $ACT;
        $ACT = $this->getCapturedAct();
        global $ID;
        $ID = $this->getCapturedRunningId();
        global $TOC;
        unset($TOC);

        // global scope store
        MetadataDbStore::resetAll();
        MetadataDokuWikiStore::unsetGlobalVariables();

        // Router: dokuwiki global
        // reset event handler
        global $EVENT_HANDLER;
        $EVENT_HANDLER = new EventHandler();
        /**
         * We can't give the getInstance, a true value
         * because it will otherwise start the routing process
         * {@link ActionRouter::getInstance()}
         */


        /**
         * Close execution variables
         * (and therefore also {@link Sqlite}
         */
        $this->closeExecutionVariables();

        /**
         * Is this really needed ?
         * as we unset the execution context below
         */
        unset($this->executingMainFetcher);
        unset($this->executingMarkupHandlerStack);
        unset($this->cacheManager);
        unset($this->idManager);

        /**
         * Deleting
         */
        self::$actualExecutionContext = null;


    }


    public function getCapturedRunningId(): ?string
    {
        return $this->capturedGlobalId;
    }

    public function getCapturedAct()
    {
        return $this->capturedAct;
    }

    public function getCacheManager(): CacheManager
    {
        $root = self::$actualExecutionContext;
        if (!isset($root->cacheManager)) {
            $root->cacheManager = new CacheManager($this);
        }
        return $root->cacheManager;

    }

    /**
     * Return the root path if nothing is found
     */
    public function getRequestedPath(): WikiPath
    {
        /**
         * Do we have a template page executing ?
         */
        try {
            return $this->getExecutingPageTemplate()
                ->getRequestedContextPath();
        } catch (ExceptionNotFound $e) {
            try {
                /**
                 * Case when the main handler
                 * run the main content before
                 * to inject it in the template page
                 * {@link TemplateForWebPage::render()}
                 */
                return $this->getExecutingMarkupHandler()
                    ->getRequestedContextPath();
            } catch (ExceptionNotFound $e) {


                /**
                 * not a template engine running
                 * The id notion is a little bit everywhere
                 * That's why we just don't check the action ($ACT)
                 *
                 * Example:
                 * * `id` may be asked by acl to determine the right
                 * * ...
                 */
                global $INPUT;
                $inputId = $INPUT->str("id");
                if (!empty($inputId)) {
                    return WikiPath::createMarkupPathFromId($inputId);
                }

                global $ID;
                if (!empty($ID)) {
                    return WikiPath::createMarkupPathFromId($ID);
                }

                /**
                 * This should be less used
                 * but shows where the requested id is spilled in dokuwiki
                 *
                 * If the component is in a sidebar, we don't want the ID of the sidebar
                 * but the ID of the page.
                 */
                global $INFO;
                if ($INFO !== null) {
                    $callingId = $INFO['id'];
                    if (!empty($callingId)) {
                        return WikiPath::createMarkupPathFromId($callingId);
                    }
                }

                /**
                 * This is the case with event triggered
                 * before DokuWiki such as
                 * https://www.dokuwiki.org/devel:event:init_lang_load
                 * REQUEST is a mixed of post and get parameters
                 */
                global $_REQUEST;
                if (isset($_REQUEST[DokuwikiId::DOKUWIKI_ID_ATTRIBUTE])) {
                    $requestId = $_REQUEST[DokuwikiId::DOKUWIKI_ID_ATTRIBUTE];
                    if (!empty($requestId)) {
                        return WikiPath::createMarkupPathFromId($requestId);
                    }
                }

                // not that show action is the default even if it's not set
                // we can't then control if the id should exists or not
                // markup based on string (test) or snippet of code
                // return the default context path (ie the root page)
                return $this->getConfig()->getDefaultContextPath();
            }

        }

    }

    /**
     * @throws ExceptionNotFound
     */
    public function &getRuntimeObject(string $objectIdentifier)
    {
        if (isset($this->executionScopedVariables[$objectIdentifier])) {
            return $this->executionScopedVariables[$objectIdentifier];
        }
        throw new ExceptionNotFound("No object $objectIdentifier found");
    }

    public function setRuntimeObject($objectIdentifier, &$object): ExecutionContext
    {
        $this->executionScopedVariables[$objectIdentifier] = &$object;
        return $this;
    }

    public function getUrl(): Url
    {
        return $this->url;
    }


    /**
     * @param string $key
     * @param $value
     * @param string|null $pluginNamespace - if null, stored in the global conf namespace
     * @return $this
     * @deprecated use {@link SiteConfig::setConf()} instead
     */
    public function setConf(string $key, $value, ?string $pluginNamespace = PluginUtility::PLUGIN_BASE_NAME): ExecutionContext
    {
        $this->getApp()->getConfig()->setConf($key, $value, $pluginNamespace);
        return $this;
    }

    /**
     * @param string $key
     * @param string|null $default
     * @return mixed|null
     * @deprecated use
     */
    public function getConfValue(string $key, string $default = null)
    {
        return $this->getApp()->getConfig()->getValue($key, $default);
    }

    public function setRuntimeBoolean(string $key, bool $b): ExecutionContext
    {
        $this->executionScopedVariables[$key] = $b;
        return $this;
    }

    /**
     * @throws ExceptionNotFound
     */
    public function getRuntimeBoolean(string $name): bool
    {
        $var = $this->executionScopedVariables[$name];
        if (!isset($var)) {
            throw new ExceptionNotFound("No $name runtime env was found");
        }
        return DataType::toBoolean($var);
    }

    /**
     * @return $this
     * @deprecated uses {@link SiteConfig::setCacheXhtmlOn()}
     */
    public function setCacheXhtmlOn(): ExecutionContext
    {
        $this->getApp()->getConfig()->setCacheXhtmlOn();
        return $this;
    }

    /**
     *
     * @return $this
     * @deprecated use the {@link SiteConfig::setConsoleOn} instead
     */
    public function setConsoleOn(): ExecutionContext
    {
        $this->getApp()->getConfig()->setCacheXhtmlOn();
        return $this;
    }

    public function setConsoleOff(): ExecutionContext
    {
        $this->getConfig()->setConsoleOff();
        return $this;
    }

    /**
     * @return $this
     * @deprecated use {@link SiteConfig::setDisableThemeSystem()}
     */
    public function setDisableTemplating(): ExecutionContext
    {
        $this->getApp()->getConfig()->setDisableThemeSystem();
        return $this;
    }


    /**
     * @return bool
     * @deprecated use the {@link SiteConfig::isConsoleOn()} instead
     */
    public function isConsoleOn(): bool
    {
        return $this->getApp()->getConfig()->isConsoleOn();
    }


    /**
     * Dokuwiki handler name
     * @return array|mixed|string
     */
    public function getExecutingAction()
    {
        global $ACT;
        return $ACT;
    }

    public function setLogExceptionToError(): ExecutionContext
    {
        $this->getConfig()->setLogExceptionToError();
        return $this;
    }

    /**
     * @return SnippetSystem
     * It's not attached to the {@link FetcherMarkup}
     * because the user may choose to not use it (ie {@link SiteConfig::isThemeSystemEnabled()}
     */
    public function getSnippetSystem(): SnippetSystem
    {
        return SnippetSystem::getFromContext();
    }

    /**
     * @return bool - does the action create a publication (render a page)
     */
    public function isPublicationAction(): bool
    {

        $act = $this->getExecutingAction();
        if (in_array($act, self::PRIVATES_ACTION_NO_REDIRECT)) {
            return false;
        }

        return true;

    }

    public function setEnableSectionEditing(): ExecutionContext
    {
        $this->setConf('maxseclevel', 999, null);
        return $this;
    }

    /**
     * @param string $value
     * @return $this
     * @deprecated use the {@link SiteConfig::setCanonicalUrlType()} instead
     */
    public function setCanonicalUrlType(string $value): ExecutionContext
    {
        $this->getConfig()->setCanonicalUrlType($value);
        return $this;
    }

    public function setUseHeadingAsTitle(): ExecutionContext
    {
        // https://www.dokuwiki.org/config:useheading
        $this->setConf('useheading', 1, null);
        return $this;
    }

    public function response(): HttpResponse
    {
        return $this->response;
    }

    /**
     * @param string|null $executingId
     * @return void
     */
    private function setExecutingId(?string $executingId): void
    {
        global $ID;
        if ($executingId == null) {
            // ID should not be null
            // to be able to check the ACL
            return;
        }
        $executingId = WikiPath::removeRootSepIfPresent($executingId);
        $ID = $executingId;
    }

    public function setConfGlobal(string $key, string $value): ExecutionContext
    {
        $this->setConf($key, $value, null);
        return $this;
    }

    /**
     * @return bool - if this execution is a test running
     */
    public function isTestRun(): bool
    {
        /**
         * Test Requested is loaded only in a test run
         * Does not exist in a normal installation
         * and is not found, triggering an exception
         */
        if (class_exists('TestRequest')) {
            $testRequest = TestRequest::getRunning();
            return $testRequest !== null;
        }
        return false;

    }

    private function setExecutingAction(?string $runningAct): ExecutionContext
    {
        global $ACT;
        $ACT = $runningAct;
        return $this;
    }


    /**
     * Set the main fetcher, the entry point of the request (ie the url of the browser)
     * that will return a string
     * @throws ExceptionBadArgument
     * @throws ExceptionInternal
     * @throws ExceptionNotFound
     */
    public function createStringMainFetcherFromRequestedUrl(Url $fetchUrl): IFetcherString
    {
        $this->executingMainFetcher = FetcherSystem::createFetcherStringFromUrl($fetchUrl);
        return $this->executingMainFetcher;
    }


    /**
     * Set the main fetcher (with the url of the browser)
     * that will return a path (image, ...)
     * @throws ExceptionBadArgument
     * @throws ExceptionInternal
     * @throws ExceptionNotFound
     */
    public function createPathMainFetcherFromUrl(Url $fetchUrl): IFetcherPath
    {
        $this->executingMainFetcher = FetcherSystem::createPathFetcherFromUrl($fetchUrl);
        return $this->executingMainFetcher;
    }

    public function closeMainExecutingFetcher(): ExecutionContext
    {
        unset($this->executingMainFetcher);
        /**
         * Snippet are not yet fully coupled to the {@link FetcherMarkup}
         */
        $this->closeAndRemoveRuntimeVariableIfExists(Snippet::CANONICAL);
        return $this;
    }

    /**
     * This function sets the markup running context object globally,
     * so that code may access it via this global variable
     * (Fighting dokuwiki global scope)
     * @param FetcherMarkup $markupHandler
     * @return $this
     */
    public function setExecutingMarkupHandler(FetcherMarkup $markupHandler): ExecutionContext
    {


        /**
         * Act
         */
        $oldAct = $this->getExecutingAction();
        if (!$markupHandler->isPathExecution() && $oldAct !== ExecutionContext::PREVIEW_ACTION) {
            /**
             * Not sure that is is still needed
             * as we have now the notion of document/fragment
             * {@link FetcherMarkup::isDocument()}
             */
            $runningAct = FetcherMarkup::MARKUP_DYNAMIC_EXECUTION_NAME;
            $this->setExecutingAction($runningAct);
        }

        /**
         * Id
         */
        try {
            $oldExecutingId = $this->getExecutingWikiId();
        } catch (ExceptionNotFound $e) {
            $oldExecutingId = null;
        }
        try {

            $executingPath = $markupHandler->getRequestedExecutingPath();
            $executingId = $executingPath->toAbsoluteId();
            $this->setExecutingId($executingId);
        } catch (ExceptionNotFound $e) {
            // no executing path dynamic markup execution
        }

        /**
         * $INFO  (Fragment run, ...)
         * We don't use {@link pageinfo()} for now
         * We just advertise if this is a fragment run
         * via the `id`
         */
        global $INFO;
        $oldContextId = $INFO['id'] ?? null;
        if ($markupHandler->isFragment()) {
            $contextPath = $markupHandler->getRequestedContextPath();
            $INFO['id'] = $contextPath->getWikiId();
        }

        /**
         * Call to Fetcher Markup can be recursive,
         * we try to break a loop
         *
         * Note that the same object may call recursively:
         * * the {@link FetcherMarkup::processMetaEventually()} metadata may call the {@link FetcherMarkup::getInstructions() instructions},
         */
        $id = $markupHandler->getId();
        if (array_key_exists($id, $this->executingMarkupHandlerStack)) {
            LogUtility::internalError("The markup ($id) is already executing");
            $id = "$id-already-in-stack";
        }
        $this->executingMarkupHandlerStack[$id] = [$markupHandler, $oldExecutingId, $oldContextId, $oldAct];
        return $this;
    }

    public
    function closeExecutingMarkupHandler(): ExecutionContext
    {
        /** @noinspection PhpUnusedLocalVariableInspection */
        [$markupHandler, $oldExecutingId, $oldContextId, $oldAct] = array_pop($this->executingMarkupHandlerStack);

        $this
            ->setExecutingAction($oldAct)
            ->setExecutingId($oldExecutingId);

        global $INFO;
        if ($oldExecutingId === null) {
            unset($INFO['id']);
        } else {
            $INFO['id'] = $oldContextId;
        }
        return $this;
    }


    /**
     * @throws ExceptionNotFound - if there is no markup handler execution running
     */
    public
    function getExecutingMarkupHandler(): FetcherMarkup
    {
        $count = count($this->executingMarkupHandlerStack);
        if ($count >= 1) {
            return $this->executingMarkupHandlerStack[array_key_last($this->executingMarkupHandlerStack)][0];
        }
        throw new ExceptionNotFound("No markup handler running");
    }

    /**
     * @throws ExceptionNotFound - if there is no parent markup handler execution found
     */
    public
    function getExecutingParentMarkupHandler(): FetcherMarkup
    {
        return $this->getExecutingMarkupHandler()->getParent();
    }

    /**
     * This function sets the default context path.
     *
     * Mostly used in test, to determine relative path
     * when testing {@link LinkMarkup} and {@link WikiPath}
     * and not use a {@link FetcherMarkup}
     *
     * @param WikiPath $contextPath - a markup file context path used (not a namespace)
     * @return $this
     * @deprecated
     */
    public
    function setDefaultContextPath(WikiPath $contextPath): ExecutionContext
    {
        $this->getConfig()->setDefaultContextPath($contextPath);
        return $this;
    }


    /**
     * @return WikiPath - the context path is a markup file that gives context.
     * Ie this is the equivalent of the current directory.
     * When a link/path is empty or relative, the program will check for the context path
     * to calculate the absolute path
     */
    public
    function getContextPath(): WikiPath
    {

        try {

            /**
             * Do we a fetcher markup running ?
             * (It's first as we may change it
             * for a slot for instance)
             */
            return $this
                ->getExecutingMarkupHandler()
                ->getRequestedContextPath();

        } catch (ExceptionNotFound $e) {
            try {

                /**
                 * Do we have a template page executing ?
                 */
                return $this->getExecutingPageTemplate()
                    ->getRequestedContextPath();

            } catch (ExceptionNotFound $e) {

                /**
                 * Hack, hack, hack
                 * In  preview mode, the context path is the last visited page
                 * for a slot
                 */
                global $ACT;
                if ($ACT === ExecutionContext::PREVIEW_ACTION) {
                    global $ID;
                    if (!empty($ID)) {
                        try {
                            $markupPath = MarkupPath::createMarkupFromId($ID);
                            if ($markupPath->isSlot()) {
                                return SlotSystem::getContextPath()->toWikiPath();
                            }
                        } catch (ExceptionCast|ExceptionNotFound $e) {
                            // ok
                        }
                    }
                }

                /**
                 * Nope ? This is a dokuwiki run (admin page, ...)
                 */
                return $this->getConfig()->getDefaultContextPath();

            }

        }


    }


    /**
     * @return WikiPath
     * @deprecated uses {@link SiteConfig::getDefaultContextPath()}
     */
    public
    function getDefaultContextPath(): WikiPath
    {
        return $this->getConfig()->getDefaultContextPath();
    }

    /**
     * The page global context object
     * @throws ExceptionNotFound
     */
    public
    function getExecutingPageTemplate(): TemplateForWebPage
    {
        if (isset($this->executingPageTemplate)) {
            return $this->executingPageTemplate;
        }
        throw new ExceptionNotFound("No page template execution running");
    }

    /**
     * Set the page template that is executing.
     * It's the context object for all page related
     * (mostly header event)
     * @param TemplateForWebPage $pageTemplate
     * @return $this
     */
    public
    function setExecutingPageTemplate(TemplateForWebPage $pageTemplate): ExecutionContext
    {
        $this->executingPageTemplate = $pageTemplate;
        return $this;
    }

    public
    function closeExecutingPageTemplate(): ExecutionContext
    {
        unset($this->executingPageTemplate);
        return $this;
    }

    public
    function getApp(): Site
    {
        if (isset($this->app)) {
            return $this->app;
        }
        $this->app = new Site($this);
        return $this->app;
    }

    /**
     * @return SiteConfig short utility function to get access to the global app config
     */
    public
    function getConfig(): SiteConfig
    {
        return $this->getApp()->getConfig();
    }

    /**
     * @throws ExceptionNotFound - when there is no executing id (markup execution)
     */
    public
    function getExecutingWikiPath(): WikiPath
    {
        try {
            return $this->getExecutingMarkupHandler()
                ->getRequestedExecutingPath()
                ->toWikiPath();
        } catch (ExceptionCast|ExceptionNotFound $e) {
            // Execution without templating (ie without fetcher markup)
            return WikiPath::createMarkupPathFromId($this->getExecutingWikiId());
        }

    }

    /**
     * @return array - data in context
     * This is the central point to get data in context as there is no
     * content object in dokuwiki
     *
     * It takes care of returning the context path
     * (in case of slot via the {@link self::getContextPath()}
     */
    public
    function getContextData(): array
    {

        try {

            /**
             * Context data may be dynamically given
             * by the {@link \syntax_plugin_combo_iterator}
             */
            return $this
                ->getExecutingMarkupHandler()
                ->getContextData();

        } catch (ExceptionNotFound $e) {

            /**
             * Preview / slot
             */
            return MarkupPath::createPageFromPathObject($this->getContextPath())->getMetadataForRendering();

        }

    }

    /**
     * This method will delete the global identifier
     * and call the 'close' method if the method exists.
     * @param string $globalObjectIdentifier
     * @return void
     */
    public
    function closeAndRemoveRuntimeVariableIfExists(string $globalObjectIdentifier)
    {

        if (!isset($this->executionScopedVariables[$globalObjectIdentifier])) {
            return;
        }

        /**
         * Get the object references
         */
        $object = &$this->executionScopedVariables[$globalObjectIdentifier];


        /**
         * Call the close method
         */
        if (is_object($object)) {
            if (method_exists($object, 'close')) {
                $object->close();
            }
        }

        /**
         * Close it really by setting null
         *
         * (Forwhatever reason, sqlite closing in php
         * is putting the variable to null)
         */
        $object = null;

        /**
         * Delete it from the array
         */
        unset($this->executionScopedVariables[$globalObjectIdentifier]);

    }

    /**
     * Close all execution variables
     */
    public
    function closeExecutionVariables(): ExecutionContext
    {
        $scopedVariables = array_keys($this->executionScopedVariables);
        foreach ($scopedVariables as $executionScopedVariableKey) {
            $this->closeAndRemoveRuntimeVariableIfExists($executionScopedVariableKey);
        }
        return $this;
    }

    public
    function __toString()
    {
        return $this->creationTime;
    }

    public
    function isExecutingPageTemplate(): bool
    {
        try {
            $this->getExecutingPageTemplate();
            return true;
        } catch (ExceptionNotFound $e) {
            return false;
        }
    }

    public
    function hasExecutingMarkupHandler(): bool
    {
        try {
            $this->getExecutingMarkupHandler();
            return true;
        } catch (ExceptionNotFound $e) {
            return false;
        }
    }


}