1c3437056SNickeau<?php 2c3437056SNickeau 3c3437056SNickeau 4c3437056SNickeau 5*04fd306cSNickeau 6c3437056SNickeauuse ComboStrap\DatabasePageRow; 7*04fd306cSNickeauuse ComboStrap\ExceptionBadArgument; 8*04fd306cSNickeauuse ComboStrap\ExceptionBadSyntax; 9*04fd306cSNickeauuse ComboStrap\ExceptionCompile; 10*04fd306cSNickeauuse ComboStrap\ExceptionSqliteNotAvailable; 11*04fd306cSNickeauuse ComboStrap\ExecutionContext; 12*04fd306cSNickeauuse ComboStrap\FileSystems; 13c3437056SNickeauuse ComboStrap\HttpResponse; 14*04fd306cSNickeauuse ComboStrap\HttpResponseStatus; 15c3437056SNickeauuse ComboStrap\Identity; 16c3437056SNickeauuse ComboStrap\LogUtility; 17*04fd306cSNickeauuse ComboStrap\MarkupPath; 18*04fd306cSNickeauuse ComboStrap\Meta\Field\AliasType; 19c3437056SNickeauuse ComboStrap\Mime; 20c3437056SNickeauuse ComboStrap\PageId; 21c3437056SNickeauuse ComboStrap\PageRules; 22c3437056SNickeauuse ComboStrap\PageUrlPath; 2382a60d03SNickeauuse ComboStrap\PageUrlType; 24*04fd306cSNickeauuse ComboStrap\RouterBestEndPage; 25c3437056SNickeauuse ComboStrap\Site; 26*04fd306cSNickeauuse ComboStrap\SiteConfig; 27c3437056SNickeauuse ComboStrap\Sqlite; 28*04fd306cSNickeauuse ComboStrap\Web\Url; 29*04fd306cSNickeauuse ComboStrap\WikiPath; 30c3437056SNickeau 31*04fd306cSNickeaurequire_once(__DIR__ . '/../vendor/autoload.php'); 32c3437056SNickeau 33c3437056SNickeau/** 34c3437056SNickeau * Class action_plugin_combo_url 35c3437056SNickeau * 36c3437056SNickeau * The actual URL manager 37c3437056SNickeau * 38c3437056SNickeau * 39c3437056SNickeau */ 40c3437056SNickeauclass action_plugin_combo_router extends DokuWiki_Action_Plugin 41c3437056SNickeau{ 42c3437056SNickeau 43c3437056SNickeau /** 44c3437056SNickeau * @deprecated 45c3437056SNickeau */ 46c3437056SNickeau const URL_MANAGER_ENABLE_CONF = "enableUrlManager"; 47c3437056SNickeau const ROUTER_ENABLE_CONF = "enableRouter"; 48c3437056SNickeau 49c3437056SNickeau // The redirect type 50c3437056SNickeau const REDIRECT_TRANSPARENT_METHOD = 'transparent'; // was (Id) 51c3437056SNickeau // For permanent, see https://developers.google.com/search/docs/advanced/crawling/301-redirects 52c3437056SNickeau const REDIRECT_PERMANENT_METHOD = 'permanent'; // was `Http` (301) 53c3437056SNickeau const REDIRECT_NOTFOUND_METHOD = "notfound"; // 404 (See other) (when best page name is calculated) 54c3437056SNickeau 55c3437056SNickeau public const PERMANENT_REDIRECT_CANONICAL = "permanent:redirect"; 56c3437056SNickeau 57c3437056SNickeau // Where the target id value comes from 58c3437056SNickeau const TARGET_ORIGIN_WELL_KNOWN = 'well-known'; 59c3437056SNickeau const TARGET_ORIGIN_PAGE_RULES = 'pageRules'; 60c3437056SNickeau /** 61c3437056SNickeau * Named Permalink (canonical) 62c3437056SNickeau */ 63c3437056SNickeau const TARGET_ORIGIN_CANONICAL = 'canonical'; 64c3437056SNickeau const TARGET_ORIGIN_ALIAS = 'alias'; 65c3437056SNickeau /** 66c3437056SNickeau * Identifier Permalink (full page id) 67c3437056SNickeau */ 68c3437056SNickeau const TARGET_ORIGIN_PERMALINK = "permalink"; 69c3437056SNickeau /** 70c3437056SNickeau * Extended Permalink (abbreviated page id at the end) 71c3437056SNickeau */ 72c3437056SNickeau const TARGET_ORIGIN_PERMALINK_EXTENDED = "extendedPermalink"; 73c3437056SNickeau const TARGET_ORIGIN_START_PAGE = 'startPage'; 74c3437056SNickeau const TARGET_ORIGIN_BEST_PAGE_NAME = 'bestPageName'; 75c3437056SNickeau const TARGET_ORIGIN_BEST_NAMESPACE = 'bestNamespace'; 76c3437056SNickeau const TARGET_ORIGIN_SEARCH_ENGINE = 'searchEngine'; 77c3437056SNickeau const TARGET_ORIGIN_BEST_END_PAGE_NAME = 'bestEndPageName'; 78c3437056SNickeau const TARGET_ORIGIN_SHADOW_BANNED = "shadowBanned"; 79c3437056SNickeau 80c3437056SNickeau 81c3437056SNickeau // The constant parameters 82c3437056SNickeau const GO_TO_SEARCH_ENGINE = 'GoToSearchEngine'; 83c3437056SNickeau const GO_TO_BEST_NAMESPACE = 'GoToBestNamespace'; 84c3437056SNickeau const GO_TO_BEST_PAGE_NAME = 'GoToBestPageName'; 85c3437056SNickeau const GO_TO_BEST_END_PAGE_NAME = 'GoToBestEndPageName'; 86c3437056SNickeau const GO_TO_NS_START_PAGE = 'GoToNsStartPage'; 87c3437056SNickeau const GO_TO_EDIT_MODE = 'GoToEditMode'; 88c3437056SNickeau const NOTHING = 'Nothing'; 89c3437056SNickeau 90c3437056SNickeau /** @var string - a name used in log and other places */ 91c3437056SNickeau const NAME = 'Url Manager'; 92c3437056SNickeau const CANONICAL = 'router'; 93c3437056SNickeau const PAGE_404 = "<html lang=\"en\"><body></body></html>"; 94c3437056SNickeau const REFRESH_HEADER_NAME = "Refresh"; 95c3437056SNickeau const REFRESH_HEADER_PREFIX = self::REFRESH_HEADER_NAME . ': 0;url='; 96*04fd306cSNickeau const LOCATION_HEADER_PREFIX = HttpResponse::LOCATION_HEADER_NAME . ": "; 97c3437056SNickeau public const URL_MANAGER_NAME = "Router"; 98c3437056SNickeau 99c3437056SNickeau 100c3437056SNickeau /** 101c3437056SNickeau * @var PageRules 102c3437056SNickeau */ 103c3437056SNickeau private $pageRules; 104c3437056SNickeau 105c3437056SNickeau 106c3437056SNickeau function __construct() 107c3437056SNickeau { 108c3437056SNickeau // enable direct access to language strings 109c3437056SNickeau // ie $this->lang 110c3437056SNickeau $this->setupLocale(); 111c3437056SNickeau 112c3437056SNickeau } 113c3437056SNickeau 114c3437056SNickeau /** 115*04fd306cSNickeau * @param string $refreshHeader 116c3437056SNickeau * @return false|string 117c3437056SNickeau */ 118*04fd306cSNickeau public static function getUrlFromRefresh(string $refreshHeader) 119c3437056SNickeau { 120c3437056SNickeau return substr($refreshHeader, strlen(action_plugin_combo_router::REFRESH_HEADER_PREFIX)); 121c3437056SNickeau } 122c3437056SNickeau 123c3437056SNickeau public static function getUrlFromLocation($refreshHeader) 124c3437056SNickeau { 125c3437056SNickeau return substr($refreshHeader, strlen(action_plugin_combo_router::LOCATION_HEADER_PREFIX)); 126c3437056SNickeau } 127c3437056SNickeau 128c3437056SNickeau /** 129c3437056SNickeau * @return array|mixed|string|string[] 130c3437056SNickeau * 131c3437056SNickeau * Unfortunately, DOKUWIKI_STARTED is not the first event 132c3437056SNickeau * The id may have been changed by 133c3437056SNickeau * {@link action_plugin_combo_metalang::load_lang()} 134c3437056SNickeau * function, that's why we have this function 135c3437056SNickeau * to get the original requested id 136c3437056SNickeau */ 137c3437056SNickeau private static function getOriginalIdFromRequest() 138c3437056SNickeau { 139c3437056SNickeau $originalId = $_GET["id"]; 140*04fd306cSNickeau return str_replace("/", WikiPath::NAMESPACE_SEPARATOR_DOUBLE_POINT, $originalId); 141c3437056SNickeau } 142c3437056SNickeau 143c3437056SNickeau /** 144c3437056SNickeau * Determine if the request should be banned based on the id 145c3437056SNickeau * 146c3437056SNickeau * @param string $id 147c3437056SNickeau * @return bool 148c3437056SNickeau * 149c3437056SNickeau * See also {@link https://perishablepress.com/7g-firewall/#features} 150c3437056SNickeau * for blocking rules on http request data such as: 151c3437056SNickeau * * query_string 152c3437056SNickeau * * user_agent, 153c3437056SNickeau * * remote host 154c3437056SNickeau */ 155c3437056SNickeau public static function isShadowBanned(string $id): bool 156c3437056SNickeau { 157c3437056SNickeau /** 158c3437056SNickeau * ie 159c3437056SNickeau * wp-json:api:flutter_woo:config_file 160c3437056SNickeau * wp-content:plugins:wpdiscuz:themes:default:style-rtl.css 161c3437056SNickeau * wp-admin 162c3437056SNickeau * 2020:wp-includes:wlwmanifest.xml 163c3437056SNickeau * wp-content:start 164c3437056SNickeau * wp-admin:css:start 165c3437056SNickeau * sito:wp-includes:wlwmanifest.xml 166c3437056SNickeau * site:wp-includes:wlwmanifest.xml 167c3437056SNickeau * cms:wp-includes:wlwmanifest.xml 168c3437056SNickeau * test:wp-includes:wlwmanifest.xml 169c3437056SNickeau * media:wp-includes:wlwmanifest.xml 170c3437056SNickeau * wp2:wp-includes:wlwmanifest.xml 171c3437056SNickeau * 2019:wp-includes:wlwmanifest.xml 172c3437056SNickeau * shop:wp-includes:wlwmanifest.xml 173c3437056SNickeau * wp1:wp-includes:wlwmanifest.xml 174c3437056SNickeau * news:wp-includes:wlwmanifest.xml 175c3437056SNickeau * 2018:wp-includes:wlwmanifest.xml 176c3437056SNickeau */ 177c3437056SNickeau if (strpos($id, 'wp-') !== false) { 178c3437056SNickeau return true; 179c3437056SNickeau } 180c3437056SNickeau 181c3437056SNickeau /** 182c3437056SNickeau * db:oracle:long_or_1_utl_inaddr.get_host_address_chr_33_chr_126_chr_33_chr_65_chr_66_chr_67_chr_49_chr_52_chr_53_chr_90_chr_81_chr_54_chr_50_chr_68_chr_87_chr_81_chr_65_chr_70_chr_80_chr_79_chr_73_chr_89_chr_67_chr_70_chr_68_chr_33_chr_126_chr_33 183c3437056SNickeau * db:oracle:999999.9:union:all:select_null:from_dual 184c3437056SNickeau * db:oracle:999999.9:union:all:select_null:from_dual_and_0_0 185c3437056SNickeau */ 186c3437056SNickeau if (preg_match('/_chr_|_0_0/', $id) === 1) { 187c3437056SNickeau return true; 188c3437056SNickeau } 189c3437056SNickeau 190c3437056SNickeau 191c3437056SNickeau /** 192c3437056SNickeau * ie 193c3437056SNickeau * git:objects: 194c3437056SNickeau * git:refs:heads:stable 195c3437056SNickeau * git:logs:refs:heads:main 196c3437056SNickeau * git:logs:refs:heads:stable 197c3437056SNickeau * git:hooks:pre-push.sample 198c3437056SNickeau * git:hooks:pre-receive.sample 199c3437056SNickeau */ 200c3437056SNickeau if (strpos($id, "git:") === 0) { 201c3437056SNickeau return true; 202c3437056SNickeau } 203c3437056SNickeau 204c3437056SNickeau return false; 205c3437056SNickeau 206c3437056SNickeau } 207c3437056SNickeau 208c3437056SNickeau /** 209c3437056SNickeau * @param string $id 210c3437056SNickeau * @return bool 211c3437056SNickeau * well-known:traffic-advice = https://github.com/buettner/private-prefetch-proxy/blob/main/traffic-advice.md 212c3437056SNickeau * .well-known/security.txt, id=well-known:security.txt = https://securitytxt.org/ 213c3437056SNickeau * well-known:dnt-policy.txt 214c3437056SNickeau */ 215c3437056SNickeau public static function isWellKnownFile(string $id): bool 216c3437056SNickeau { 217c3437056SNickeau return strpos($id, "well-known") === 0; 218c3437056SNickeau } 219c3437056SNickeau 220c3437056SNickeau 221c3437056SNickeau function register(Doku_Event_Handler $controller) 222c3437056SNickeau { 223c3437056SNickeau 224*04fd306cSNickeau if (SiteConfig::getConfValue(self::ROUTER_ENABLE_CONF, 1)) { 225*04fd306cSNickeau 226c3437056SNickeau /** 227c3437056SNickeau * This will call the function {@link action_plugin_combo_router::_router()} 228c3437056SNickeau * The event is not DOKUWIKI_STARTED because this is not the first one 229c3437056SNickeau * 230c3437056SNickeau * https://www.dokuwiki.org/devel:event:init_lang_load 231c3437056SNickeau */ 232c3437056SNickeau $controller->register_hook('DOKUWIKI_STARTED', 233*04fd306cSNickeau 'BEFORE', 234c3437056SNickeau $this, 235c3437056SNickeau 'router', 236c3437056SNickeau array()); 237c3437056SNickeau 238c3437056SNickeau /** 239c3437056SNickeau * This is the real first call of Dokuwiki 240c3437056SNickeau * Unfortunately, it does not create the environment 241c3437056SNickeau * We just ban to spare server resources 242c3437056SNickeau * 243c3437056SNickeau * https://www.dokuwiki.org/devel:event:init_lang_load 244c3437056SNickeau */ 245c3437056SNickeau $controller->register_hook('INIT_LANG_LOAD', 'BEFORE', $this, 'ban', array()); 246c3437056SNickeau 247c3437056SNickeau } 248c3437056SNickeau 249c3437056SNickeau 250c3437056SNickeau } 251c3437056SNickeau 252c3437056SNickeau /** 253c3437056SNickeau * 254c3437056SNickeau * We have created a spacial ban function that is 255c3437056SNickeau * called before the first function 256c3437056SNickeau * {@link action_plugin_combo_metalang::load_lang()} 257c3437056SNickeau * to spare CPU. 258c3437056SNickeau * 259c3437056SNickeau * @param $event 260c3437056SNickeau * @throws Exception 261c3437056SNickeau */ 262c3437056SNickeau function ban(&$event) 263c3437056SNickeau { 264c3437056SNickeau 265c3437056SNickeau $id = self::getOriginalIdFromRequest(); 266*04fd306cSNickeau $page = MarkupPath::createMarkupFromId($id); 267*04fd306cSNickeau if (!FileSystems::exists($page)) { 268c3437056SNickeau // Well known 269c3437056SNickeau if (self::isWellKnownFile($id)) { 270c3437056SNickeau $this->logRedirection($id, "", self::TARGET_ORIGIN_WELL_KNOWN, self::REDIRECT_NOTFOUND_METHOD); 271*04fd306cSNickeau ExecutionContext::getActualOrCreateFromEnv() 272*04fd306cSNickeau ->response() 273*04fd306cSNickeau ->setStatus(HttpResponseStatus::NOT_FOUND) 274*04fd306cSNickeau ->end(); 275c3437056SNickeau return; 276c3437056SNickeau } 277c3437056SNickeau 278c3437056SNickeau // Shadow banned 279c3437056SNickeau if (self::isShadowBanned($id)) { 280*04fd306cSNickeau $webSiteHomePage = Site::getIndexPageName(); 281c3437056SNickeau $this->executeTransparentRedirect($webSiteHomePage, self::TARGET_ORIGIN_SHADOW_BANNED); 282c3437056SNickeau } 283c3437056SNickeau } 284c3437056SNickeau } 285c3437056SNickeau 286c3437056SNickeau /** 287c3437056SNickeau * @param $event Doku_Event 288c3437056SNickeau * @param $param 289c3437056SNickeau * @return void 290c3437056SNickeau * @throws Exception 291c3437056SNickeau */ 292c3437056SNickeau function router(&$event, $param) 293c3437056SNickeau { 294c3437056SNickeau 295*04fd306cSNickeau /** 296*04fd306cSNickeau * Just the {@link ExecutionContext::SHOW_ACTION} 297*04fd306cSNickeau * may be redirected 298*04fd306cSNickeau */ 299*04fd306cSNickeau $executionContext = ExecutionContext::getActualOrCreateFromEnv(); 300*04fd306cSNickeau if ($executionContext->getExecutingAction()!==ExecutionContext::SHOW_ACTION) { 301*04fd306cSNickeau return; 302*04fd306cSNickeau } 303c3437056SNickeau 304c3437056SNickeau 305c3437056SNickeau global $ID; 306c3437056SNickeau 307c3437056SNickeau /** 308c3437056SNickeau * Without SQLite, this module does not work further 309c3437056SNickeau */ 310*04fd306cSNickeau try { 311*04fd306cSNickeau Sqlite::createOrGetSqlite(); 312*04fd306cSNickeau } catch (ExceptionSqliteNotAvailable $e) { 313c3437056SNickeau return; 314c3437056SNickeau } 315c3437056SNickeau 316*04fd306cSNickeau $this->pageRules = new PageRules(); 317*04fd306cSNickeau 318*04fd306cSNickeau 319c3437056SNickeau /** 320c3437056SNickeau * Unfortunately, DOKUWIKI_STARTED is not the first event 321c3437056SNickeau * The id may have been changed by 322*04fd306cSNickeau * {@link action_plugin_combo_lang::load_lang()} 323c3437056SNickeau * function, that's why we check against the {@link $_REQUEST} 324c3437056SNickeau * and not the global ID 325c3437056SNickeau */ 326c3437056SNickeau $originalId = self::getOriginalIdFromRequest(); 327c3437056SNickeau 328c3437056SNickeau /** 329c3437056SNickeau * Page is an existing id ? 330c3437056SNickeau */ 331*04fd306cSNickeau $requestedMarkupPath = MarkupPath::createMarkupFromId($ID); 332*04fd306cSNickeau if (FileSystems::exists($requestedMarkupPath)) { 333c3437056SNickeau 334c3437056SNickeau /** 335c3437056SNickeau * If this is not the root home page 336c3437056SNickeau * and if the canonical id is the not the same, 337c3437056SNickeau * and if this is not a historical page (revision) 338c3437056SNickeau * redirect 339c3437056SNickeau */ 340c3437056SNickeau if ( 341*04fd306cSNickeau $originalId !== $requestedMarkupPath->getUrlId() // The id may have been changed 342*04fd306cSNickeau && $ID != Site::getIndexPageName() 343c3437056SNickeau && !isset($_REQUEST["rev"]) 344c3437056SNickeau ) { 3454cadd4f8SNickeau /** 3464cadd4f8SNickeau * TODO: When saving for the first time, the page is not stored in the database 3474cadd4f8SNickeau * but that's not the case actually 3484cadd4f8SNickeau */ 349*04fd306cSNickeau $databasePageRow = $requestedMarkupPath->getDatabasePage(); 350*04fd306cSNickeau if ($databasePageRow->exists()) { 351*04fd306cSNickeau /** 352*04fd306cSNickeau * A move may leave the database in a bad state, 353*04fd306cSNickeau * unfortunately (ie page is not in index, unable to update, ...) 354*04fd306cSNickeau * We test therefore if the database page id exists 355*04fd306cSNickeau */ 356*04fd306cSNickeau $targetPageId = $databasePageRow->getFromRow("id"); 357*04fd306cSNickeau $targetPath = WikiPath::createMarkupPathFromId($targetPageId); 358*04fd306cSNickeau if(FileSystems::exists($targetPath)) { 359c3437056SNickeau $this->executePermanentRedirect( 360*04fd306cSNickeau $requestedMarkupPath->getCanonicalUrl()->toAbsoluteUrlString(), 361c3437056SNickeau self::TARGET_ORIGIN_PERMALINK_EXTENDED 362c3437056SNickeau ); 363c3437056SNickeau } 3644cadd4f8SNickeau } 365*04fd306cSNickeau } 366c3437056SNickeau return; 367c3437056SNickeau } 368c3437056SNickeau 369c3437056SNickeau 370c3437056SNickeau $identifier = $ID; 371c3437056SNickeau 372c3437056SNickeau 373c3437056SNickeau /** 374c3437056SNickeau * Page Id Website / root Permalink ? 375c3437056SNickeau */ 376*04fd306cSNickeau $shortPageId = PageUrlPath::getShortEncodedPageIdFromUrlId($requestedMarkupPath->getPathObject()->getLastNameWithoutExtension()); 377c3437056SNickeau if ($shortPageId !== null) { 378c3437056SNickeau $pageId = PageUrlPath::decodePageId($shortPageId); 379*04fd306cSNickeau if ($requestedMarkupPath->getParent() === null && $pageId !== null) { 380*04fd306cSNickeau $page = DatabasePageRow::createFromPageId($pageId)->getMarkupPath(); 381c3437056SNickeau if ($page !== null && $page->exists()) { 38282a60d03SNickeau $this->executePermanentRedirect( 383*04fd306cSNickeau $page->getCanonicalUrl()->toAbsoluteUrlString(), 38482a60d03SNickeau self::TARGET_ORIGIN_PERMALINK 38582a60d03SNickeau ); 386c3437056SNickeau } 387c3437056SNickeau } 388c3437056SNickeau 389c3437056SNickeau /** 390c3437056SNickeau * Page Id Abbr ? 391c3437056SNickeau * {@link PageUrlType::CONF_CANONICAL_URL_TYPE} 392c3437056SNickeau */ 393c3437056SNickeau if ( 394c3437056SNickeau $pageId !== null 395c3437056SNickeau ) { 396*04fd306cSNickeau $page = DatabasePageRow::createFromPageIdAbbr($pageId)->getMarkupPath(); 397c3437056SNickeau if ($page === null) { 398c3437056SNickeau // or the length of the abbr has changed 399*04fd306cSNickeau $canonicalDatabasePage = new DatabasePageRow(); 400*04fd306cSNickeau $row = $canonicalDatabasePage->getDatabaseRowFromAttribute("substr(" . PageId::PROPERTY_NAME . ", 1, " . strlen($pageId) . ")", $pageId); 4014cadd4f8SNickeau if ($row !== null) { 402*04fd306cSNickeau $canonicalDatabasePage->setRow($row); 403*04fd306cSNickeau $page = $canonicalDatabasePage->getMarkupPath(); 404c3437056SNickeau } 405c3437056SNickeau } 406c3437056SNickeau if ($page !== null && $page->exists()) { 407c3437056SNickeau /** 408c3437056SNickeau * If the url canonical id has changed, we show it 409c3437056SNickeau * to the writer by performing a permanent redirect 410c3437056SNickeau */ 411c3437056SNickeau if ($identifier != $page->getUrlId()) { 412c3437056SNickeau // Google asks for a redirect 413c3437056SNickeau // https://developers.google.com/search/docs/advanced/crawling/301-redirects 414c3437056SNickeau // People access your site through several different URLs. 415c3437056SNickeau // If, for example, your home page can be reached in multiple ways 416c3437056SNickeau // (for instance, http://example.com/home, http://home.example.com, or http://www.example.com), 417c3437056SNickeau // it's a good idea to pick one of those URLs as your preferred (canonical) destination, 418c3437056SNickeau // and use redirects to send traffic from the other URLs to your preferred URL. 419c3437056SNickeau $this->executePermanentRedirect( 420*04fd306cSNickeau $page->getCanonicalUrl()->toAbsoluteUrlString(), 421c3437056SNickeau self::TARGET_ORIGIN_PERMALINK_EXTENDED 422c3437056SNickeau ); 423c3437056SNickeau return; 424c3437056SNickeau } 4254cadd4f8SNickeau 426*04fd306cSNickeau $this->executeTransparentRedirect($page->getWikiId(), self::TARGET_ORIGIN_PERMALINK_EXTENDED); 427c3437056SNickeau return; 428c3437056SNickeau 429c3437056SNickeau } 430c3437056SNickeau // permanent url not yet in the database 431c3437056SNickeau // Other permanent such as permanent canonical ? 432c3437056SNickeau // We let the process go with the new identifier 433c3437056SNickeau 434c3437056SNickeau } 435c3437056SNickeau 436c3437056SNickeau } 437c3437056SNickeau 438c3437056SNickeau // Global variable needed in the process 439c3437056SNickeau global $conf; 440c3437056SNickeau 441c3437056SNickeau /** 442c3437056SNickeau * Identifier is a Canonical ? 443c3437056SNickeau */ 444*04fd306cSNickeau $canonicalDatabasePage = DatabasePageRow::createFromCanonical($identifier); 445*04fd306cSNickeau $canonicalPage = $canonicalDatabasePage->getMarkupPath(); 446*04fd306cSNickeau if ($canonicalPage !== null && $canonicalPage->exists()) { 44782a60d03SNickeau /** 44882a60d03SNickeau * Does the canonical url is canonical name based 44982a60d03SNickeau * ie {@link PageUrlType::CONF_VALUE_CANONICAL_PATH} 45082a60d03SNickeau */ 451*04fd306cSNickeau if ($canonicalPage->getUrlId() === $identifier) { 45282a60d03SNickeau $res = $this->executeTransparentRedirect( 453*04fd306cSNickeau $canonicalPage->getWikiId(), 45482a60d03SNickeau self::TARGET_ORIGIN_CANONICAL 45582a60d03SNickeau ); 45682a60d03SNickeau } else { 45782a60d03SNickeau $res = $this->executePermanentRedirect( 458*04fd306cSNickeau $canonicalPage->getWikiId(), // not the url because, it allows to add url query redirection property 45982a60d03SNickeau self::TARGET_ORIGIN_CANONICAL 46082a60d03SNickeau ); 46182a60d03SNickeau } 462c3437056SNickeau if ($res) { 463c3437056SNickeau return; 464c3437056SNickeau } 465c3437056SNickeau } 466c3437056SNickeau 467c3437056SNickeau /** 468c3437056SNickeau * Identifier is an alias 469c3437056SNickeau */ 470*04fd306cSNickeau $aliasRequestedPage = DatabasePageRow::createFromAlias($identifier)->getMarkupPath(); 471c3437056SNickeau if ( 472*04fd306cSNickeau $aliasRequestedPage !== null 473*04fd306cSNickeau && $aliasRequestedPage->exists() 474c3437056SNickeau // The build alias is the file system metadata alias 475c3437056SNickeau // it may be null if the replication in the database was not successful 476*04fd306cSNickeau && $aliasRequestedPage->getBuildAlias() !== null 477c3437056SNickeau ) { 478*04fd306cSNickeau $buildAlias = $aliasRequestedPage->getBuildAlias(); 479c3437056SNickeau switch ($buildAlias->getType()) { 480c3437056SNickeau case AliasType::REDIRECT: 481*04fd306cSNickeau $res = $this->executePermanentRedirect($aliasRequestedPage->getCanonicalUrl()->toAbsoluteUrlString(), self::TARGET_ORIGIN_ALIAS); 482c3437056SNickeau if ($res) { 483c3437056SNickeau return; 484c3437056SNickeau } 485c3437056SNickeau break; 486c3437056SNickeau case AliasType::SYNONYM: 487*04fd306cSNickeau $res = $this->executeTransparentRedirect($aliasRequestedPage->getWikiId(), self::TARGET_ORIGIN_ALIAS); 488c3437056SNickeau if ($res) { 489c3437056SNickeau return; 490c3437056SNickeau } 491c3437056SNickeau break; 492c3437056SNickeau default: 493c3437056SNickeau LogUtility::msg("The alias type ({$buildAlias->getType()}) is unknown. A permanent redirect was performed for the alias $identifier"); 494*04fd306cSNickeau $res = $this->executePermanentRedirect($aliasRequestedPage->getCanonicalUrl()->toAbsoluteUrlString(), self::TARGET_ORIGIN_ALIAS); 495c3437056SNickeau if ($res) { 496c3437056SNickeau return; 497c3437056SNickeau } 498c3437056SNickeau break; 499c3437056SNickeau } 500c3437056SNickeau } 501c3437056SNickeau 502c3437056SNickeau 503c3437056SNickeau // If there is a redirection defined in the page rules 504c3437056SNickeau $result = $this->processingPageRules(); 505c3437056SNickeau if ($result) { 506c3437056SNickeau // A redirection has occurred 507c3437056SNickeau // finish the process 508c3437056SNickeau return; 509c3437056SNickeau } 510c3437056SNickeau 511c3437056SNickeau /** 512c3437056SNickeau * 513c3437056SNickeau * There was no redirection found, redirect to edit mode if writer 514c3437056SNickeau * 515c3437056SNickeau */ 516c3437056SNickeau if (Identity::isWriter() && $this->getConf(self::GO_TO_EDIT_MODE) == 1) { 517c3437056SNickeau 518c3437056SNickeau $this->gotToEditMode($event); 519c3437056SNickeau // Stop here 520c3437056SNickeau return; 521c3437056SNickeau 522c3437056SNickeau } 523c3437056SNickeau 524*04fd306cSNickeau /** 525c3437056SNickeau * We are still a reader, the redirection does not exist the user is not allowed to edit the page (public of other) 526c3437056SNickeau */ 527c3437056SNickeau if ($this->getConf('ActionReaderFirst') == self::NOTHING) { 528c3437056SNickeau return; 529c3437056SNickeau } 530c3437056SNickeau 531c3437056SNickeau // We are reader and their is no redirection set, we apply the algorithm 532c3437056SNickeau $readerAlgorithms = array(); 533c3437056SNickeau $readerAlgorithms[0] = $this->getConf('ActionReaderFirst'); 534c3437056SNickeau $readerAlgorithms[1] = $this->getConf('ActionReaderSecond'); 535c3437056SNickeau $readerAlgorithms[2] = $this->getConf('ActionReaderThird'); 536c3437056SNickeau 537c3437056SNickeau while ( 538c3437056SNickeau ($algorithm = array_shift($readerAlgorithms)) != null 539c3437056SNickeau ) { 540c3437056SNickeau 541c3437056SNickeau switch ($algorithm) { 542c3437056SNickeau 543c3437056SNickeau case self::NOTHING: 544c3437056SNickeau return; 545c3437056SNickeau 546c3437056SNickeau case self::GO_TO_BEST_END_PAGE_NAME: 547c3437056SNickeau 548*04fd306cSNickeau /** 549*04fd306cSNickeau * @var MarkupPath $bestEndPage 550*04fd306cSNickeau */ 551*04fd306cSNickeau list($bestEndPage, $method) = RouterBestEndPage::process($requestedMarkupPath); 552*04fd306cSNickeau if ($bestEndPage != null) { 553c3437056SNickeau $res = false; 554c3437056SNickeau switch ($method) { 555c3437056SNickeau case self::REDIRECT_PERMANENT_METHOD: 556*04fd306cSNickeau $res = $this->executePermanentRedirect($bestEndPage->getWikiId(), self::TARGET_ORIGIN_BEST_END_PAGE_NAME); 557c3437056SNickeau break; 558c3437056SNickeau case self::REDIRECT_NOTFOUND_METHOD: 559*04fd306cSNickeau $res = $this->performNotFoundRedirect($bestEndPage->getWikiId(), self::TARGET_ORIGIN_BEST_END_PAGE_NAME); 560c3437056SNickeau break; 561c3437056SNickeau default: 562c3437056SNickeau LogUtility::msg("This redirection method ($method) was not expected for the redirection algorithm ($algorithm)"); 563c3437056SNickeau } 564c3437056SNickeau if ($res) { 565c3437056SNickeau // Redirection has succeeded 566c3437056SNickeau return; 567c3437056SNickeau } 568c3437056SNickeau } 569c3437056SNickeau break; 570c3437056SNickeau 571c3437056SNickeau case self::GO_TO_NS_START_PAGE: 572c3437056SNickeau 573c3437056SNickeau // Start page with the conf['start'] parameter 574c3437056SNickeau $startPage = getNS($identifier) . ':' . $conf['start']; 575c3437056SNickeau if (page_exists($startPage)) { 576c3437056SNickeau $res = $this->performNotFoundRedirect($startPage, self::TARGET_ORIGIN_START_PAGE); 577c3437056SNickeau if ($res) { 578c3437056SNickeau return; 579c3437056SNickeau } 580c3437056SNickeau } 581c3437056SNickeau 582c3437056SNickeau // Start page with the same name than the namespace 583c3437056SNickeau $startPage = getNS($identifier) . ':' . curNS($identifier); 584c3437056SNickeau if (page_exists($startPage)) { 585c3437056SNickeau $res = $this->performNotFoundRedirect($startPage, self::TARGET_ORIGIN_START_PAGE); 586c3437056SNickeau if ($res) { 587c3437056SNickeau return; 588c3437056SNickeau } 589c3437056SNickeau } 590c3437056SNickeau break; 591c3437056SNickeau 592c3437056SNickeau case self::GO_TO_BEST_PAGE_NAME: 593c3437056SNickeau 594c3437056SNickeau $bestPageId = null; 595c3437056SNickeau 596c3437056SNickeau $bestPage = $this->getBestPage($identifier); 597c3437056SNickeau $bestPageId = $bestPage['id']; 598c3437056SNickeau $scorePageName = $bestPage['score']; 599c3437056SNickeau 600c3437056SNickeau // Get Score from a Namespace 601c3437056SNickeau $bestNamespace = $this->scoreBestNamespace($identifier); 602c3437056SNickeau $bestNamespaceId = $bestNamespace['namespace']; 603c3437056SNickeau $namespaceScore = $bestNamespace['score']; 604c3437056SNickeau 605c3437056SNickeau // Compare the two score 606c3437056SNickeau if ($scorePageName > 0 or $namespaceScore > 0) { 607c3437056SNickeau if ($scorePageName > $namespaceScore) { 608c3437056SNickeau $this->performNotFoundRedirect($bestPageId, self::TARGET_ORIGIN_BEST_PAGE_NAME); 609c3437056SNickeau } else { 610c3437056SNickeau $this->performNotFoundRedirect($bestNamespaceId, self::TARGET_ORIGIN_BEST_PAGE_NAME); 611c3437056SNickeau } 612c3437056SNickeau return; 613c3437056SNickeau } 614c3437056SNickeau break; 615c3437056SNickeau 616c3437056SNickeau case self::GO_TO_BEST_NAMESPACE: 617c3437056SNickeau 618c3437056SNickeau $scoreNamespace = $this->scoreBestNamespace($identifier); 619c3437056SNickeau $bestNamespaceId = $scoreNamespace['namespace']; 620c3437056SNickeau $score = $scoreNamespace['score']; 621c3437056SNickeau 622c3437056SNickeau if ($score > 0) { 623c3437056SNickeau $this->performNotFoundRedirect($bestNamespaceId, self::TARGET_ORIGIN_BEST_NAMESPACE); 624c3437056SNickeau return; 625c3437056SNickeau } 626c3437056SNickeau break; 627c3437056SNickeau 628c3437056SNickeau case self::GO_TO_SEARCH_ENGINE: 629c3437056SNickeau 630c3437056SNickeau $this->redirectToSearchEngine(); 631c3437056SNickeau 632c3437056SNickeau return; 633c3437056SNickeau 634c3437056SNickeau // End Switch Action 635c3437056SNickeau } 636c3437056SNickeau 637c3437056SNickeau // End While Action 638c3437056SNickeau } 639c3437056SNickeau 640c3437056SNickeau 641c3437056SNickeau } 642c3437056SNickeau 643c3437056SNickeau 644c3437056SNickeau /** 645c3437056SNickeau * getBestNamespace 646c3437056SNickeau * Return a list with 'BestNamespaceId Score' 647c3437056SNickeau * @param $id 648c3437056SNickeau * @return array 649c3437056SNickeau */ 650c3437056SNickeau private 651c3437056SNickeau function scoreBestNamespace($id) 652c3437056SNickeau { 653c3437056SNickeau 654c3437056SNickeau global $conf; 655c3437056SNickeau 656c3437056SNickeau // Parameters 657c3437056SNickeau $pageNameSpace = getNS($id); 658c3437056SNickeau 659c3437056SNickeau // If the page has an existing namespace start page take it, other search other namespace 660c3437056SNickeau $startPageNameSpace = $pageNameSpace . ":"; 661c3437056SNickeau $dateAt = ''; 662c3437056SNickeau // $startPageNameSpace will get a full path (ie with start or the namespace 663c3437056SNickeau resolve_pageid($pageNameSpace, $startPageNameSpace, $exists, $dateAt, true); 664c3437056SNickeau if (page_exists($startPageNameSpace)) { 665c3437056SNickeau $nameSpaces = array($startPageNameSpace); 666c3437056SNickeau } else { 667c3437056SNickeau $nameSpaces = ft_pageLookup($conf['start']); 668c3437056SNickeau } 669c3437056SNickeau 670c3437056SNickeau // Parameters and search the best namespace 671c3437056SNickeau $pathNames = explode(':', $pageNameSpace); 672c3437056SNickeau $bestNbWordFound = 0; 673c3437056SNickeau $bestNamespaceId = ''; 674c3437056SNickeau foreach ($nameSpaces as $nameSpace) { 675c3437056SNickeau 676c3437056SNickeau $nbWordFound = 0; 677c3437056SNickeau foreach ($pathNames as $pathName) { 678c3437056SNickeau if (strlen($pathName) > 2) { 679c3437056SNickeau $nbWordFound = $nbWordFound + substr_count($nameSpace, $pathName); 680c3437056SNickeau } 681c3437056SNickeau } 682c3437056SNickeau if ($nbWordFound > $bestNbWordFound) { 683c3437056SNickeau // Take only the smallest namespace 684c3437056SNickeau if (strlen($nameSpace) < strlen($bestNamespaceId) or $nbWordFound > $bestNbWordFound) { 685c3437056SNickeau $bestNbWordFound = $nbWordFound; 686c3437056SNickeau $bestNamespaceId = $nameSpace; 687c3437056SNickeau } 688c3437056SNickeau } 689c3437056SNickeau } 690c3437056SNickeau 691c3437056SNickeau $startPageFactor = $this->getConf('WeightFactorForStartPage'); 692c3437056SNickeau $nameSpaceFactor = $this->getConf('WeightFactorForSameNamespace'); 693c3437056SNickeau if ($bestNbWordFound > 0) { 694c3437056SNickeau $bestNamespaceScore = $bestNbWordFound * $nameSpaceFactor + $startPageFactor; 695c3437056SNickeau } else { 696c3437056SNickeau $bestNamespaceScore = 0; 697c3437056SNickeau } 698c3437056SNickeau 699c3437056SNickeau 700c3437056SNickeau return array( 701c3437056SNickeau 'namespace' => $bestNamespaceId, 702c3437056SNickeau 'score' => $bestNamespaceScore 703c3437056SNickeau ); 704c3437056SNickeau 705c3437056SNickeau } 706c3437056SNickeau 707c3437056SNickeau /** 708c3437056SNickeau * @param $event 709c3437056SNickeau */ 710c3437056SNickeau private 711c3437056SNickeau function gotToEditMode(&$event) 712c3437056SNickeau { 713c3437056SNickeau global $ACT; 714c3437056SNickeau $ACT = 'edit'; 715c3437056SNickeau 716c3437056SNickeau } 717c3437056SNickeau 718c3437056SNickeau 719c3437056SNickeau /** 720c3437056SNickeau * Redirect to an internal page ie: 721c3437056SNickeau * * on the same domain 722c3437056SNickeau * * no HTTP redirect 723c3437056SNickeau * * id rewrite 724c3437056SNickeau * @param string $targetPageId - target page id 725c3437056SNickeau * @param string $targetOriginId - the source of the target (redirect) 726c3437056SNickeau * @return bool - return true if the user has the permission and that the redirect was done 727c3437056SNickeau * @throws Exception 728c3437056SNickeau */ 729c3437056SNickeau private 730c3437056SNickeau function executeTransparentRedirect(string $targetPageId, string $targetOriginId): bool 731c3437056SNickeau { 732c3437056SNickeau /** 733c3437056SNickeau * Because we set the ID globally for the ID redirect 734*04fd306cSNickeau * we make sure that this is not a {@link MarkupPath} 735c3437056SNickeau * object otherwise we got an error in the {@link \ComboStrap\AnalyticsMenuItem} 736c3437056SNickeau * because the constructor takes it {@link \dokuwiki\Menu\Item\AbstractItem} 737c3437056SNickeau */ 738c3437056SNickeau if (is_object($targetPageId)) { 739c3437056SNickeau $class = get_class($targetPageId); 740c3437056SNickeau LogUtility::msg("The parameters targetPageId ($targetPageId) is an object of the class ($class) and it should be a page id"); 741c3437056SNickeau } 742c3437056SNickeau 743c3437056SNickeau if (is_object($targetOriginId)) { 744c3437056SNickeau $class = get_class($targetOriginId); 745c3437056SNickeau LogUtility::msg("The parameters targetOriginId ($targetOriginId) is an object of the class ($class) and it should be a page id"); 746c3437056SNickeau } 747c3437056SNickeau 748c3437056SNickeau // If the user does not have the right to see the target page 749c3437056SNickeau // don't do anything 750c3437056SNickeau if (!(Identity::isReader($targetPageId))) { 751c3437056SNickeau return false; 752c3437056SNickeau } 753c3437056SNickeau 754c3437056SNickeau // Change the id 755c3437056SNickeau global $ID; 756c3437056SNickeau global $INFO; 757c3437056SNickeau $sourceId = $ID; 758c3437056SNickeau $ID = $targetPageId; 759*04fd306cSNickeau if (isset($_REQUEST["id"])) { 760*04fd306cSNickeau $_REQUEST["id"] = $targetPageId; 761*04fd306cSNickeau } 762*04fd306cSNickeau if (isset($_GET["id"])) { 763*04fd306cSNickeau $_GET["id"] = $targetPageId; 764*04fd306cSNickeau } 7654cadd4f8SNickeau 766c3437056SNickeau /** 7674cadd4f8SNickeau * Refresh the $INFO data 7684cadd4f8SNickeau * 7694cadd4f8SNickeau * the info attributes are used elsewhere 7704cadd4f8SNickeau * 'id': for the sidebar 7714cadd4f8SNickeau * 'exist' : for the meta robot = noindex,follow, see {@link tpl_metaheaders()} 7724cadd4f8SNickeau * 'rev' : for the edit button to be sure that the page is still the same 773c3437056SNickeau */ 7744cadd4f8SNickeau $INFO = pageinfo(); 775c3437056SNickeau 776c3437056SNickeau /** 777c3437056SNickeau * Not compatible with 778c3437056SNickeau * https://www.dokuwiki.org/config:send404 is enabled 779c3437056SNickeau * 780c3437056SNickeau * This check happens before that dokuwiki is started 781c3437056SNickeau * and send an header in doku.php 782c3437056SNickeau * 783c3437056SNickeau * We send a warning 784c3437056SNickeau */ 785c3437056SNickeau global $conf; 786c3437056SNickeau if ($conf['send404'] == true) { 787c3437056SNickeau LogUtility::msg("The <a href=\"https://www.dokuwiki.org/config:send404\">dokuwiki send404 configuration</a> is on and should be disabled when using the url manager", LogUtility::LVL_MSG_ERROR, self::CANONICAL); 788c3437056SNickeau } 789c3437056SNickeau 790c3437056SNickeau // Redirection 791c3437056SNickeau $this->logRedirection($sourceId, $targetPageId, $targetOriginId, self::REDIRECT_TRANSPARENT_METHOD); 792c3437056SNickeau 793c3437056SNickeau return true; 794c3437056SNickeau 795c3437056SNickeau } 796c3437056SNickeau 797*04fd306cSNickeau private function executePermanentRedirect(string $targetIdOrUrl, $targetOrigin): bool 798c3437056SNickeau { 799*04fd306cSNickeau return $this->executeHttpRedirect($targetIdOrUrl, $targetOrigin, self::REDIRECT_PERMANENT_METHOD); 800c3437056SNickeau } 801c3437056SNickeau 802c3437056SNickeau /** 803c3437056SNickeau * The general HTTP Redirect method to an internal page 804c3437056SNickeau * where the redirection method decide which type of redirection 805*04fd306cSNickeau * @param string $targetIdOrUrl - a dokuwiki id or an url 806c3437056SNickeau * @param string $targetOrigin - the origin of the target (the algorithm used to get the target origin) 807c3437056SNickeau * @param string $method - the redirection method 808c3437056SNickeau */ 809c3437056SNickeau private 810*04fd306cSNickeau function executeHttpRedirect(string $targetIdOrUrl, string $targetOrigin, string $method): bool 811c3437056SNickeau { 812c3437056SNickeau 813c3437056SNickeau global $ID; 814c3437056SNickeau 815c3437056SNickeau 816c3437056SNickeau // Log the redirections 817*04fd306cSNickeau $this->logRedirection($ID, $targetIdOrUrl, $targetOrigin, $method); 818c3437056SNickeau 819c3437056SNickeau 820*04fd306cSNickeau // An http external url ? 821*04fd306cSNickeau try { 822*04fd306cSNickeau $isValid = Url::createFromString($targetIdOrUrl)->isHttpUrl(); 823*04fd306cSNickeau } catch (ExceptionBadSyntax|ExceptionBadArgument $e) { 824*04fd306cSNickeau $isValid = false; 825*04fd306cSNickeau } 826*04fd306cSNickeau 82782a60d03SNickeau // If there is a bug in the isValid function for an internal url 82882a60d03SNickeau // We get a loop. 82982a60d03SNickeau // The Url becomes the id, the id is unknown and we do a redirect again 83082a60d03SNickeau // 83182a60d03SNickeau // We check then if the target starts with the base url 83282a60d03SNickeau // if this is the case, it's valid 833*04fd306cSNickeau if (!$isValid && strpos($targetIdOrUrl, DOKU_URL) === 0) { 83482a60d03SNickeau $isValid = true; 83582a60d03SNickeau } 83682a60d03SNickeau if ($isValid) { 837c3437056SNickeau 838c3437056SNickeau // defend against HTTP Response Splitting 839c3437056SNickeau // https://owasp.org/www-community/attacks/HTTP_Response_Splitting 840*04fd306cSNickeau $targetUrl = stripctl($targetIdOrUrl); 841c3437056SNickeau 842c3437056SNickeau } else { 843c3437056SNickeau 844c3437056SNickeau 845c3437056SNickeau // Explode the page ID and the anchor (#) 846*04fd306cSNickeau $link = explode('#', $targetIdOrUrl, 2); 847c3437056SNickeau 848c3437056SNickeau // Query String to pass the message 849c3437056SNickeau $urlParams = []; 850c3437056SNickeau if ($targetOrigin != self::TARGET_ORIGIN_PERMALINK) { 851c3437056SNickeau $urlParams = array( 852c3437056SNickeau action_plugin_combo_routermessage::ORIGIN_PAGE => $ID, 853c3437056SNickeau action_plugin_combo_routermessage::ORIGIN_TYPE => $targetOrigin 854c3437056SNickeau ); 855c3437056SNickeau } 856c3437056SNickeau 857c3437056SNickeau // if this is search engine redirect 858c3437056SNickeau if ($targetOrigin == self::TARGET_ORIGIN_SEARCH_ENGINE) { 859c3437056SNickeau $replacementPart = array(':', '_', '-'); 860c3437056SNickeau $query = str_replace($replacementPart, ' ', $ID); 861c3437056SNickeau $urlParams["do"] = "search"; 862c3437056SNickeau $urlParams["q"] = $query; 863c3437056SNickeau } 864c3437056SNickeau 865c3437056SNickeau $targetUrl = wl($link[0], $urlParams, true, '&'); 866c3437056SNickeau // %3A back to : 867c3437056SNickeau $targetUrl = str_replace("%3A", ":", $targetUrl); 868c3437056SNickeau if ($link[1]) { 869c3437056SNickeau $targetUrl .= '#' . rawurlencode($link[1]); 870c3437056SNickeau } 871c3437056SNickeau 872c3437056SNickeau } 873c3437056SNickeau 874c3437056SNickeau /** 875c3437056SNickeau * The dokuwiki function {@link send_redirect()} 876c3437056SNickeau * set the `Location header` and in php, the header function 877c3437056SNickeau * in this case change the status code to 302 Arghhhh. 878c3437056SNickeau * The code below is adapted from this function {@link send_redirect()} 879c3437056SNickeau */ 880c3437056SNickeau global $MSG; // are there any undisplayed messages? keep them in session for display 881c3437056SNickeau if (isset($MSG) && count($MSG) && !defined('NOSESSION')) { 882c3437056SNickeau //reopen session, store data and close session again 883c3437056SNickeau @session_start(); 884c3437056SNickeau $_SESSION[DOKU_COOKIE]['msg'] = $MSG; 885c3437056SNickeau } 886c3437056SNickeau session_write_close(); // always close the session 887c3437056SNickeau 888c3437056SNickeau switch ($method) { 889c3437056SNickeau case self::REDIRECT_PERMANENT_METHOD: 890*04fd306cSNickeau ExecutionContext::getActualOrCreateFromEnv() 891*04fd306cSNickeau ->response() 892*04fd306cSNickeau ->setStatus(HttpResponseStatus::PERMANENT_REDIRECT) 893c3437056SNickeau ->addHeader(self::LOCATION_HEADER_PREFIX . $targetUrl) 894*04fd306cSNickeau ->end(); 895c3437056SNickeau return true; 896c3437056SNickeau case self::REDIRECT_NOTFOUND_METHOD: 897c3437056SNickeau 898c3437056SNickeau // Empty 404 body to not get the standard 404 page of the browser 899c3437056SNickeau // but a blank page to avoid a sort of FOUC. 900c3437056SNickeau // ie the user see a page briefly 901*04fd306cSNickeau ExecutionContext::getActualOrCreateFromEnv() 902*04fd306cSNickeau ->response() 903*04fd306cSNickeau ->setStatus(HttpResponseStatus::NOT_FOUND) 904c3437056SNickeau ->addHeader(self::REFRESH_HEADER_PREFIX . $targetUrl) 905*04fd306cSNickeau ->setBody(self::PAGE_404, Mime::getHtml()) 906*04fd306cSNickeau ->end(); 907c3437056SNickeau return true; 908c3437056SNickeau 909c3437056SNickeau default: 910c3437056SNickeau LogUtility::msg("The method ($method) is not an http redirection"); 911c3437056SNickeau return false; 912c3437056SNickeau } 913c3437056SNickeau 914c3437056SNickeau 915c3437056SNickeau } 916c3437056SNickeau 917c3437056SNickeau /** 918c3437056SNickeau * @param $id 919c3437056SNickeau * @return array 920c3437056SNickeau */ 921c3437056SNickeau private 922c3437056SNickeau function getBestPage($id): array 923c3437056SNickeau { 924c3437056SNickeau 925c3437056SNickeau // The return parameters 926c3437056SNickeau $bestPageId = null; 927c3437056SNickeau $scorePageName = null; 928c3437056SNickeau 929c3437056SNickeau // Get Score from a page 930c3437056SNickeau $pageName = noNS($id); 931c3437056SNickeau $pagesWithSameName = ft_pageLookup($pageName); 932c3437056SNickeau if (count($pagesWithSameName) > 0) { 933c3437056SNickeau 934c3437056SNickeau // Search same namespace in the page found than in the Id page asked. 935c3437056SNickeau $bestNbWordFound = 0; 936c3437056SNickeau 937c3437056SNickeau 938c3437056SNickeau $wordsInPageSourceId = explode(':', $id); 939c3437056SNickeau foreach ($pagesWithSameName as $targetPageId => $title) { 940c3437056SNickeau 941c3437056SNickeau // Nb of word found in the target page id 942c3437056SNickeau // that are in the source page id 943c3437056SNickeau $nbWordFound = 0; 944c3437056SNickeau foreach ($wordsInPageSourceId as $word) { 945c3437056SNickeau $nbWordFound = $nbWordFound + substr_count($targetPageId, $word); 946c3437056SNickeau } 947c3437056SNickeau 948c3437056SNickeau if ($bestPageId == null) { 949c3437056SNickeau 950c3437056SNickeau $bestNbWordFound = $nbWordFound; 951c3437056SNickeau $bestPageId = $targetPageId; 952c3437056SNickeau 953c3437056SNickeau } else { 954c3437056SNickeau 955c3437056SNickeau if ($nbWordFound >= $bestNbWordFound && strlen($bestPageId) > strlen($targetPageId)) { 956c3437056SNickeau 957c3437056SNickeau $bestNbWordFound = $nbWordFound; 958c3437056SNickeau $bestPageId = $targetPageId; 959c3437056SNickeau 960c3437056SNickeau } 961c3437056SNickeau 962c3437056SNickeau } 963c3437056SNickeau 964c3437056SNickeau } 965c3437056SNickeau $scorePageName = $this->getConf('WeightFactorForSamePageName') + ($bestNbWordFound - 1) * $this->getConf('WeightFactorForSameNamespace'); 966c3437056SNickeau return array( 967c3437056SNickeau 'id' => $bestPageId, 968c3437056SNickeau 'score' => $scorePageName); 969c3437056SNickeau } 970c3437056SNickeau return array( 971c3437056SNickeau 'id' => $bestPageId, 972c3437056SNickeau 'score' => $scorePageName 973c3437056SNickeau ); 974c3437056SNickeau 975c3437056SNickeau } 976c3437056SNickeau 977c3437056SNickeau 978c3437056SNickeau /** 979c3437056SNickeau * Redirect to the search engine 980c3437056SNickeau */ 981c3437056SNickeau private 982c3437056SNickeau function redirectToSearchEngine() 983c3437056SNickeau { 984c3437056SNickeau 985c3437056SNickeau global $ID; 986c3437056SNickeau $this->performNotFoundRedirect($ID, self::TARGET_ORIGIN_SEARCH_ENGINE); 987c3437056SNickeau 988c3437056SNickeau } 989c3437056SNickeau 990c3437056SNickeau 991c3437056SNickeau /** 992c3437056SNickeau * 993c3437056SNickeau * * For a conf file, it will update the Redirection Action Data as Referrer, Count Of Redirection, Redirection Date 994c3437056SNickeau * * For a SQlite database, it will add a row into the log 995c3437056SNickeau * 996c3437056SNickeau * @param string $sourcePageId 997c3437056SNickeau * @param $targetPageId 998c3437056SNickeau * @param $algorithmic 999c3437056SNickeau * @param $method - http or rewrite 1000c3437056SNickeau */ 1001c3437056SNickeau function logRedirection(string $sourcePageId, $targetPageId, $algorithmic, $method) 1002c3437056SNickeau { 1003c3437056SNickeau 1004c3437056SNickeau $row = array( 1005c3437056SNickeau "TIMESTAMP" => date("c"), 1006c3437056SNickeau "SOURCE" => $sourcePageId, 1007c3437056SNickeau "TARGET" => $targetPageId, 1008c3437056SNickeau "REFERRER" => $_SERVER['HTTP_REFERER'], 1009c3437056SNickeau "TYPE" => $algorithmic, 1010c3437056SNickeau "METHOD" => $method 1011c3437056SNickeau ); 1012c3437056SNickeau $request = Sqlite::createOrGetBackendSqlite() 1013c3437056SNickeau ->createRequest() 1014c3437056SNickeau ->setTableRow('redirections_log', $row); 1015c3437056SNickeau try { 1016c3437056SNickeau $request 1017c3437056SNickeau ->execute(); 1018*04fd306cSNickeau } catch (ExceptionCompile $e) { 1019c3437056SNickeau LogUtility::msg("Redirection Log Insert Error. {$e->getMessage()}"); 1020c3437056SNickeau } finally { 1021c3437056SNickeau $request->close(); 1022c3437056SNickeau } 1023c3437056SNickeau 1024c3437056SNickeau 1025c3437056SNickeau } 1026c3437056SNickeau 1027c3437056SNickeau /** 1028c3437056SNickeau * This function check if there is a redirection declared 1029c3437056SNickeau * in the redirection table 1030c3437056SNickeau * @return bool - true if a rewrite or redirection occurs 1031c3437056SNickeau * @throws Exception 1032c3437056SNickeau */ 1033c3437056SNickeau private function processingPageRules(): bool 1034c3437056SNickeau { 1035c3437056SNickeau global $ID; 1036c3437056SNickeau 1037c3437056SNickeau $calculatedTarget = null; 1038c3437056SNickeau $ruleMatcher = null; // Used in a warning message if the target page does not exist 1039c3437056SNickeau // Known redirection in the table 1040c3437056SNickeau // Get the page from redirection data 1041c3437056SNickeau $rules = $this->pageRules->getRules(); 1042c3437056SNickeau foreach ($rules as $rule) { 1043c3437056SNickeau 1044c3437056SNickeau $ruleMatcher = strtolower($rule[PageRules::MATCHER_NAME]); 1045c3437056SNickeau $ruleTarget = $rule[PageRules::TARGET_NAME]; 1046c3437056SNickeau 1047c3437056SNickeau // Glob to Rexgexp 1048*04fd306cSNickeau $regexpPattern = '/' . str_replace("*", "(.*)", $ruleMatcher) . '/i'; 1049c3437056SNickeau 1050c3437056SNickeau // Match ? 1051c3437056SNickeau // https://www.php.net/manual/en/function.preg-match.php 105286867397Sgerardnico $pregMatchResult = @preg_match($regexpPattern, $ID, $matches); 105386867397Sgerardnico if ($pregMatchResult === false) { 105486867397Sgerardnico // The `if` to take into account this problem 105586867397Sgerardnico // PHP Warning: preg_match(): Unknown modifier 'd' in /opt/www/datacadamia.com/lib/plugins/combo/action/router.php on line 972 105686867397Sgerardnico LogUtility::log2file("processing Page Rules An error occurred with the pattern ($regexpPattern)", LogUtility::LVL_MSG_WARNING); 105786867397Sgerardnico return false; 105886867397Sgerardnico } 105986867397Sgerardnico if ($pregMatchResult) { 1060c3437056SNickeau $calculatedTarget = $ruleTarget; 1061c3437056SNickeau foreach ($matches as $key => $match) { 1062c3437056SNickeau if ($key == 0) { 1063c3437056SNickeau continue; 1064c3437056SNickeau } else { 1065c3437056SNickeau $calculatedTarget = str_replace('$' . $key, $match, $calculatedTarget); 1066c3437056SNickeau } 1067c3437056SNickeau } 1068c3437056SNickeau break; 1069c3437056SNickeau } 1070c3437056SNickeau } 1071c3437056SNickeau 1072c3437056SNickeau if ($calculatedTarget == null) { 1073c3437056SNickeau return false; 1074c3437056SNickeau } 1075c3437056SNickeau 1076c3437056SNickeau // If this is an external redirect (other domain) 1077*04fd306cSNickeau try { 1078*04fd306cSNickeau $isHttpUrl = Url::createFromString($calculatedTarget)->isHttpUrl(); 1079*04fd306cSNickeau } catch (ExceptionBadSyntax $e) { 1080*04fd306cSNickeau $isHttpUrl = false; 1081*04fd306cSNickeau } 1082*04fd306cSNickeau if ($isHttpUrl) { 1083c3437056SNickeau $this->executeHttpRedirect($calculatedTarget, self::TARGET_ORIGIN_PAGE_RULES, self::REDIRECT_PERMANENT_METHOD); 1084c3437056SNickeau return true; 1085c3437056SNickeau } 1086c3437056SNickeau 1087c3437056SNickeau // If the page exist 1088c3437056SNickeau if (page_exists($calculatedTarget)) { 1089c3437056SNickeau 1090c3437056SNickeau // This is DokuWiki Id and should always be lowercase 1091c3437056SNickeau // The page rule may have change that 1092c3437056SNickeau $calculatedTarget = strtolower($calculatedTarget); 1093d0abe7fcSgerardnico $res = $this->executeHttpRedirect($calculatedTarget, self::TARGET_ORIGIN_PAGE_RULES, self::REDIRECT_PERMANENT_METHOD); 1094c3437056SNickeau if ($res) { 1095c3437056SNickeau return true; 1096c3437056SNickeau } else { 1097c3437056SNickeau return false; 1098c3437056SNickeau } 1099c3437056SNickeau 1100c3437056SNickeau } else { 1101c3437056SNickeau 1102c3437056SNickeau LogUtility::msg("The calculated target page ($calculatedTarget) (for the non-existing page `$ID` with the matcher `$ruleMatcher`) does not exist", LogUtility::LVL_MSG_ERROR); 1103c3437056SNickeau return false; 1104c3437056SNickeau 1105c3437056SNickeau } 1106c3437056SNickeau 1107c3437056SNickeau } 1108c3437056SNickeau 1109c3437056SNickeau private function performNotFoundRedirect(string $targetId, string $origin): bool 1110c3437056SNickeau { 1111c3437056SNickeau return $this->executeHttpRedirect($targetId, $origin, self::REDIRECT_NOTFOUND_METHOD); 1112c3437056SNickeau } 1113c3437056SNickeau 1114c3437056SNickeau 1115c3437056SNickeau} 1116