php/archived-web-php
1
0
Fork 0
mirror of https://github.com/php/web-php.git synced 2026-03-23 23:02:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Display custom 404 page when legacy manuals found

Browse Source 
Closes GH-385.
This commit is contained in:
Anna Filina
2020-12-11 14:10:57 +01:00
committed by Christoph M. Becker
parent 497e577846
commit d56830dfce
4 changed files with 76 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
error.php
View File

@@ -636,6 +636,10 @@ if (preg_match("!^manual/([^/]+)/([^/]+).php$!", $URI, $match) &&
// ============================================================================
// 404 page for manual pages (eg. not built language)
if (strpos($URI, "manual/") === 0) {
$legacy_manual_urls = get_legacy_manual_urls($URI);
if (count($legacy_manual_urls) > 0) {
fallback_to_legacy_manuals($legacy_manual_urls);
}
error_404_manual();
}

64
include/errors.inc
View File

@@ -514,3 +514,67 @@ $snippets = array(
return isset($snippets[$term]) ? $snippets[$term] : false;
}
/**
* @param string $uri
* @return array<string, string>
*/
function get_legacy_manual_urls(string $uri): array
{
$filename = $_SERVER["DOCUMENT_ROOT"] . "/manual/legacyurls.json";
$pages_ids = json_decode(file_get_contents($filename), true);
$page_id = preg_replace_callback('/^manual\/.*\/(.*?)(\.php)?$/', function (array $matches): string {
if (count($matches) !== 3) {
return '';
}
return $matches[1] ;
}, $uri);
if (!isset($pages_ids[$page_id])) {
return [];
}
$legacy_urls = [];
foreach ($pages_ids[$page_id] as $php_version) {
$legacy_urls[$php_version] = convert_manual_uri_to_legacy($uri, $php_version);
}
return $legacy_urls;
}
/**
* @param array<string, string> $legacy_urls URLs to legacy manuals, indexed by major PHP version
*/
function fallback_to_legacy_manuals(array $legacy_urls): void
{
global $MYSITE;
status_header(404);
site_header('404 Not Found', array("noindex"));
$original_url = htmlspecialchars(substr($MYSITE, 0, -1) . $_SERVER['REQUEST_URI']);
$legacy_links = '';
foreach ($legacy_urls as $php_version => $url) {
$legacy_links .= '<li><a href="' . $url . '">PHP ' . $php_version . ' legacy manual</a></li>';
}
echo <<<HTML
<h1>Not Found</h1>
<p>The manual page you are looking for (<strong>$original_url</strong>) is not available.</p>
<p>However, this page exists in a legacy manual for the following PHP versions.</p>
<ul id="legacy-links">$legacy_links</ul>
<p>Please note that legacy manuals are maintained by Zend and not the PHP Documentation Group. Any questions about their content should be reported via the "Report a Bug" links on the appropriate pages.</p>
<p>If you were looking for this page in the current PHP version and believe this to be a mistake, please check back later, or if the problem persists, <a href="/contact.php">contact the webmasters</a>.</p>
HTML;
site_footer();
exit;
}
function convert_manual_uri_to_legacy(string $uri, int $php_version): string
{
$parts = explode('/', $uri);
return sprintf('https://php-legacy-docs.zend.com/manual/php%s/%s/%s', $php_version, $parts[1], $parts[2]);
}

7
js/common.js
View File

@@ -703,4 +703,11 @@ function getLanguage()
return document.documentElement.lang;
}
(function ($) {
$('#legacy-links a').each(function () {
let $link = $(this);
$link.attr('href', $link.attr('href') + window.location.hash)
});
})(jQuery);
// vim: set ts=4 sw=4 et:

1
manual/legacyurls.json Normal file
View File

File diff suppressed because one or more lines are too long