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