xref: /plugin/combo/action/docustom.php (revision 49b8fb2440a8b019e2a082c98b66ddbf7fc707db)

<?php

use ComboStrap\DokuwikiId;
use ComboStrap\ExceptionNotFound;
use ComboStrap\ExceptionReporter;
use ComboStrap\ExecutionContext;
use ComboStrap\FetcherAppPages;
use ComboStrap\FetcherPage;
use ComboStrap\FetcherRailBar;
use ComboStrap\FileSystems;
use ComboStrap\HttpResponseStatus;
use ComboStrap\Identity;
use ComboStrap\IFetcher;
use ComboStrap\LogUtility;
use ComboStrap\MarkupPath;
use ComboStrap\Mime;
use ComboStrap\PluginUtility;
use ComboStrap\Site;
use ComboStrap\SiteConfig;
use ComboStrap\Web\Url;
use ComboStrap\Web\UrlRewrite;

/**
 * Implementation of custom do (ie ACT) to output {@link \ComboStrap\IFetcherString}
 *
 *
 *
 */
class action_plugin_combo_docustom extends DokuWiki_Action_Plugin
{

    const DO_PREFIX = "combo_";

    const TEMPLATE_CANONICAL = "template";

    /**
     * @var bool to avoid recursion that may happen using {@link tpl_content()}
     */
    private bool $doCustomActuallyExecuting = false;

    /**
     * @return bool
     */
    public static function isThemeSystemEnabled(): bool
    {
        $confValue = SiteConfig::getConfValue(SiteConfig::CONF_ENABLE_THEME_SYSTEM, SiteConfig::CONF_ENABLE_THEME_SYSTEM_DEFAULT);
        return $confValue === 1;
    }

    public static function getDoParameterValue(string $fetcherName): string
    {
        return self::DO_PREFIX . $fetcherName;
    }

    /**
     *
     * @param Doku_Event_Handler $controller
     * @return void
     */

    public function register(\Doku_Event_Handler $controller)
    {
        /**
         * Execute the combo action via an ACTION_ACT_PREPROCESS
         *
         * Not via the [TPL_ACT_UNKNOWN](https://www.dokuwiki.org/devel:event:tpl_act_unknown)
         * because it would otherwise put the content in the middle of the page
         * as an admin page.
         *
         * Not really useful if you want your own layout or do an export
         */
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'executeComboDoAction');

    }

    /**
     * @param Doku_Event $event
     * @param $param
     * @return void
     *
     */
    public function executeComboDoAction(Doku_Event $event, $param)
    {

        if ($this->doCustomActuallyExecuting) {
            return;
        }

        /**
         * The router may have done a redirection
         * (The Dokuwiki testRequest does not stop unfortunately)
         */
        $executionContext = ExecutionContext::getActualOrCreateFromEnv();
        $hasEnded = $executionContext
            ->response()
            ->hasEnded();
        if ($hasEnded) {
            if ($executionContext->isTestRun()) {
                /**
                 * This info helps the developer to see
                 * why nothing happens when it sends two dokuwiki {@link TestRequest}
                 *
                 * And not two {@link \ComboStrap\HttpResponse}
                 * that reinitialize the global scope
                 */
                LogUtility::info("ExecuteDoAction: The response has already be send (ended).");
            }
            return;
        }

        $urlRewrite = Site::getUrlRewrite();
        if ($urlRewrite == UrlRewrite::VALUE_DOKU_REWRITE) {
            UrlRewrite::sendErrorMessage();
            return;
        }

        $action = $event->data;

        $privateRailbar = $executionContext->getConfig()->getBooleanValue(FetcherRailBar::CONF_PRIVATE_RAIL_BAR, FetcherRailBar::CONF_PRIVATE_RAIL_BAR_DEFAULT);
        $isAnonymous = Identity::isAnonymous();
        if ($privateRailbar && $isAnonymous) {
            /**
             * To avoid the google console error: `Excluded by ‘noindex’ tag`
             * Example of URL
             * https://example.com/dat/bobj/central_management_server?tab_files=upload&do=media&tab_details=history&image=db:hana:hdb_thread_stat_systemdb.png&ns=web/resource
             */
            $privateAction = [ExecutionContext::MEDIA_ACTION, ExecutionContext::DIFF_ACTION, ExecutionContext::RECENT_ACTION];
            if (in_array($action, $privateAction)) {
                $executionContext->response()
                    ->setStatus(HttpResponseStatus::NOT_AUTHORIZED)
                    ->end();
                return;
            }
        }

        if (self::isThemeSystemEnabled()) {
            switch ($action) {
                case ExecutionContext::SHOW_ACTION:
                    try {
                        $id = Url::createFromGetOrPostGlobalVariable()->getPropertyValue(DokuwikiId::DOKUWIKI_ID_ATTRIBUTE);
                    } catch (ExceptionNotFound $e) {
                        // should not happen but yeah
                        return;
                    }
                    $path = MarkupPath::createMarkupFromId($id);
                    if (!FileSystems::exists($path)) {
                        return;
                    }
                    $action = self::getDoParameterValue(FetcherPage::NAME);
                    break;
                case ExecutionContext::LOGIN_ACTION:
                case ExecutionContext::REGISTER_ACTION:
                case ExecutionContext::RESEND_PWD_ACTION:
                case ExecutionContext::PROFILE_ACTION:
                case ExecutionContext::EDIT_ACTION:
                case ExecutionContext::PREVIEW_ACTION:
                case ExecutionContext::SEARCH_ACTION:
                case ExecutionContext::INDEX_ACTION:
                    //case ExecutionContext::REVISIONS_ACTION:
                    //case ExecutionContext::DIFF_ACTION: needs styling
                    $action = self::getDoParameterValue(FetcherAppPages::NAME);
                    break;
            }
        }


        if (!$this->isComboDoAction($action)) return;

        /**
         * To avoid recursion
         */
        $this->doCustomActuallyExecuting = true;


        try {
            $fetcherName = $this->getFetcherNameFromAction($action);
            $url = Url::createFromGetOrPostGlobalVariable()
                ->addQueryParameter(IFetcher::FETCHER_KEY, $fetcherName);
            $fetcher = $executionContext->createStringMainFetcherFromRequestedUrl($url);
            $body = $fetcher->getFetchString();
            $mime = $fetcher->getMime();
            $executionContext->response()
                ->setStatus(HttpResponseStatus::ALL_GOOD)
                ->setBody($body, $mime)
                ->end();
        } catch (\Exception $e) {


            $reporterMessage = "An error has occurred during the execution of the action ($action)";
            $html = ExceptionReporter::createForException($e)
                ->getHtmlPage($reporterMessage);
            if (PluginUtility::isDevOrTest()) {
                // Permits to throw the error to get the stack trace
                LogUtility::warning($reporterMessage, self::TEMPLATE_CANONICAL, $e);
            }
            $executionContext->response()
                ->setException($e)
                ->setBody($html, Mime::getHtml())
                ->end();

        } finally {
            $this->doCustomActuallyExecuting = false;
        }

    }


    private function isComboDoAction($actionName): bool
    {
        return strpos($actionName, self::DO_PREFIX) === 0;
    }

    private function getFetcherNameFromAction($actionName)
    {
        return substr($actionName, strlen(self::DO_PREFIX));
    }


}