xref: /plugin/combo/ComboStrap/FetcherMarkupWebcode.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php

namespace ComboStrap;


use action_plugin_combo_css;
use ComboStrap\Api\ApiRouter;
use ComboStrap\Meta\Field\PageTemplateName;
use ComboStrap\Web\Url;
use ComboStrap\Web\UrlEndpoint;

/**
 *
 * This code permits to render a markup from a string passed as argument
 *
 * Technically, it's the same than {@link FetcherMarkup}
 * but:
 *   * it outputs the HTML within a minimal HTML page (no layout as in {@link FetcherPage})
 *   * it gets the input from the url query properties
 *
 * It's used primarily by {@link \syntax_plugin_combo_webcode}
 * that's why it's called webcode.
 *
 */
class FetcherMarkupWebcode extends IFetcherAbs implements IFetcherString
{

    const CANONICAL = "webcode";
    const NAME = "markup";

    public const MARKUP_PROPERTY = "markup";
    const TITLE_PROPERTY = "title";

    private string $requestedMarkup;
    private string $requestedTitle = "ComboStrap WebCode - Markup Renderer";

    public static function createFetcherMarkup(string $markup): FetcherMarkupWebcode
    {
        return (new FetcherMarkupWebcode())
            ->setRequestedMarkup($markup);
    }

    /**
     * @throws ExceptionBadState - the markup is mandatory
     */
    function getFetchUrl(Url $url = null): Url
    {
        $url = UrlEndpoint::createAjaxUrl()
            ->addQueryParameter(ApiRouter::AJAX_CALL_ATTRIBUTE, ApiRouter::AJAX_CALL_VALUE)
            ->addQueryParameter(self::MARKUP_PROPERTY, $this->getRequestedMarkup())
            ->addQueryParameter(self::TITLE_PROPERTY, $this->getRequestedTitle());
        return parent::getFetchUrl($url);
    }


    function getBuster(): string
    {
        try {
            return FileSystems::getCacheBuster(ClassUtility::getClassPath(FetcherMarkupWebcode::class));
        } catch (ExceptionNotFound|\ReflectionException $e) {
            LogUtility::internalError("The cache buster should be good. Error:{$e->getMessage()}", self::NAME);
            return "";
        }
    }

    public function buildFromTagAttributes(TagAttributes $tagAttributes): IFetcher
    {

        $markupProperty = self::MARKUP_PROPERTY;
        $markup = $tagAttributes->getValueAndRemove($markupProperty);
        if ($markup === null) {
            throw new ExceptionBadArgument("The markup property ($markupProperty) is mandatory");
        }
        $this->setRequestedMarkup($markup);
        $title = $tagAttributes->getValueAndRemove(self::TITLE_PROPERTY);
        if ($title !== null) {
            $this->setRequestedTitle($title);
        }
        return parent::buildFromTagAttributes($tagAttributes);
    }


    public function getMime(): Mime
    {
        return Mime::getHtml();
    }

    public function getFetcherName(): string
    {
        return self::NAME;
    }

    /**
     * @return string
     * @throws ExceptionBadState - if the markup was not defined
     * @throws ExceptionCompile - if any error
     */
    public function getFetchString(): string
    {

        /**
         * Conf
         */
        ExecutionContext::getActualOrCreateFromEnv()
            ->getConfig()
            ->setConf(action_plugin_combo_css::CONF_DISABLE_DOKUWIKI_STYLESHEET, true);

        $fetcherCache = FetcherCache::createFrom($this);
        if ($fetcherCache->isCacheUsable()) {
            try {
                return FileSystems::getContent($fetcherCache->getFile());
            } catch (ExceptionNotFound $e) {
                $message = "The cache file should exists";
                if (PluginUtility::isDevOrTest()) {
                    throw new ExceptionRuntimeInternal($message);
                }
                LogUtility::internalError($message);
            }
        }

        $requestedMarkup = $this->getRequestedMarkup();

        try {
            $mainContent = FetcherMarkup::confRoot()
                ->setRequestedMarkupString($requestedMarkup)
                ->setDeleteRootBlockElement(true)
                ->setRequestedMimeToXhtml()
                ->setRequestedContextPathWithDefault()
                ->setIsStandAloneCodeExecution(true)
                ->build()
                ->getFetchString();
        } catch (ExceptionNotExists|ExceptionCompile $e) {
            throw new ExceptionRuntimeInternal("An error has occurred while transforming the markup fragment to HTML. Error: {$e->getMessage()}", self::CANONICAL, 1, $e);
        }

        $title = $this->getRequestedTitle();

        $html = TemplateForWebPage::create()
            ->setRequestedTitle($title)
            ->setRequestedTemplateName(PageTemplateName::BLANK_TEMPLATE_VALUE)
            ->setRequestedEnableTaskRunner(false)
            ->setIsIframe(true)
            ->setMainContent($mainContent)
            ->render();

        $fetcherCache->storeCache($html);
        return $html;

    }

    public function setRequestedMarkup(string $markup): FetcherMarkupWebcode
    {
        $this->requestedMarkup = $markup;
        return $this;

    }

    public function setRequestedTitle(string $title): FetcherMarkupWebcode
    {
        $this->requestedTitle = $title;
        return $this;
    }

    /**
     * @throws ExceptionBadState
     */
    private function getRequestedMarkup(): string
    {
        if (!isset($this->requestedMarkup)) {
            throw new ExceptionBadState("The markup was not defined.", self::CANONICAL);
        }
        return $this->requestedMarkup;
    }

    private function getRequestedTitle(): string
    {
        return $this->requestedTitle;
    }


    public function getLabel(): string
    {
        return self::CANONICAL;
    }

}