| Current File : /home/pacjaorg/public_html/2024/wp-content/plugins/bunyad-amp/src/DevTools/ErrorPage.php |
<?php
/**
* Class ErrorPage.
*
* @package AmpProject\AmpWP
*/
namespace AmpProject\AmpWP\DevTools;
use AmpProject\AmpWP\Infrastructure\Service;
use Error;
use Exception;
use InvalidArgumentException;
use Throwable;
/**
* Produces an error page similar to wp_die().
*
* The actual wp_die() function cannot be used within the AMP response
* preparation code, as its 'exit' argument is only usable from WP 5.1 onwards.
*
* @see wp_die()
* @package AmpProject\AmpWP
* @since 2.0.1
* @internal
*/
final class ErrorPage implements Service {
/**
* Title of the error page.
*
* @var string
*/
private $title = '';
/**
* Message of the error page.
*
* @var string
*/
private $message = '';
/**
* Back link URL.
*
* @var string
*/
private $link_url = '';
/**
* Back link text.
*
* @var string
*/
private $link_text = '';
/**
* Throwable of the error page.
*
* @var Throwable
*/
private $throwable;
/**
* Response code of the error page.
*
* @var int
*/
private $response_code = 500;
/**
* Culprit detection to use.
*
* @var LikelyCulpritDetector
*/
private $likely_culprit_detector;
/**
* ErrorPage constructor.
*
* @param LikelyCulpritDetector $likely_culprit_detector Culprit detection
* to use.
*/
public function __construct( LikelyCulpritDetector $likely_culprit_detector ) {
$this->likely_culprit_detector = $likely_culprit_detector;
}
/**
* Set the title of the error page.
*
* @param string $title Title to use.
* @return self
*/
public function with_title( $title ) {
$this->title = $title;
return $this;
}
/**
* Set the message of the error page.
*
* @param string $message Message to use.
* @return self
*/
public function with_message( $message ) {
$this->message = $message;
return $this;
}
/**
* Set the message of the error page.
*
* @param string $link_url Link URL.
* @param string $link_text Link text.
* @return self
*/
public function with_back_link( $link_url, $link_text ) {
$this->link_url = $link_url;
$this->link_text = $link_text;
return $this;
}
/**
* Set the throwable of the error page.
*
* @param Throwable|Exception $throwable Exception or Error to use. The Throwable type does not exist in PHP 5,
* which is why type is absent from the function parameter.
* @throws InvalidArgumentException If $throwable is not an Exception or an Error.
* @return self
*/
public function with_throwable( $throwable ) {
if ( ! ( $throwable instanceof Exception || $throwable instanceof Error ) ) {
throw new InvalidArgumentException( 'Parameter must be Throwable (Exception or Error).' );
}
$this->throwable = $throwable;
return $this;
}
/**
* Set the response_code of the error page.
*
* @param int $response_code Response code to use.
* @return self
*/
public function with_response_code( $response_code ) {
$this->response_code = $response_code;
return $this;
}
/**
* Render the error page.
*
* This first sets the required headers and then returns the HTML to send as
* output.
*
* @return string
*/
public function render() {
$this->send_to_error_log();
$this->set_headers();
$text_direction = function_exists( 'is_rtl' ) && is_rtl()
? 'rtl'
: 'ltr';
$styles = $this->get_styles( $text_direction );
$html = $this->get_html( $styles, $text_direction );
return $html;
}
/**
* Send the throwable that was caught to the error log.
*/
private function send_to_error_log() {
// Don't send to error log if fatal errors are not to be reported.
$error_level = error_reporting(); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.prevent_path_disclosure_error_reporting,WordPress.PHP.DiscouragedPHPFunctions.runtime_configuration_error_reporting
if ( ! (bool) ( $error_level & E_ERROR ) ) {
return;
}
if ( null !== $this->throwable ) {
error_log( // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
sprintf(
"%s - %s (%s) [%s]\n%s",
$this->message,
$this->throwable->getMessage(),
$this->throwable->getCode(),
get_class( $this->throwable ),
$this->throwable->getTraceAsString()
)
);
}
}
/**
* Sets the required headers.
*
* This will only adapt the headers if they haven't yet been sent.
*/
private function set_headers() {
if ( ! headers_sent() ) {
// Define the content type for the error page.
header( 'Content-Type: text/html; charset=utf-8' );
// Mark the page as a server failure so it won't get indexed.
status_header( $this->response_code );
// Let the browser know this result shouldn't get cached.
nocache_headers();
}
}
/**
* Get the HTML output for the error page.
*
* @param string $styles CSS styles to use.
* @param string $text_direction Text direction. Can be 'ltr' or 'rtl'.
* @return string HTML output.
*/
private function get_html( $styles, $text_direction ) {
$no_robots = get_option( 'blog_public' )
? "<meta name='robots' content='noindex,follow' />\n"
: "<meta name='robots' content='noindex,nofollow' />\n";
return <<<HTML
<!DOCTYPE html>
<html dir="{$text_direction}">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width">
{$no_robots}
<title>{$this->render_title()}</title>
{$styles}
</head>
<body id="error-page">
<h1>{$this->render_title()}</h1>
{$this->render_message()}
{$this->render_source()}
{$this->render_support_link()}
{$this->render_throwable()}
{$this->render_back_link()}
</body>
</html>
HTML;
}
/**
* Render title.
*
* @return string HTML-escaped title.
*/
private function render_title() {
return esc_html( $this->title );
}
/**
* Render message.
*
* @return string KSES-sanitized message.
*/
private function render_message() {
return '<p>' . wp_kses_post( $this->message ) . '</p>';
}
/**
* Render support link.
*
* @return string
*/
private function render_support_link() {
return '<p>' . wp_kses(
sprintf(
/* translators: %s is the AMP support forum URL. */
__( 'If you get stuck, you may want to share any details in a new topic on the plugin\'s <a href="%s" target="_blank" rel="noreferrer noopener">support forum</a>.', 'amp' ),
esc_url( __( 'https://wordpress.org/support/plugin/amp/', 'amp' ) )
),
[
'a' => [
'href' => true,
'target' => true,
'rel' => true,
],
]
) . '</p>';
}
/**
* Render the source of the throwable.
*
* @return string File source data.
*/
private function render_source() {
if ( null === $this->throwable ) {
return '';
}
$source = $this->likely_culprit_detector->analyze_throwable( $this->throwable );
if ( ! empty( $source['type'] ) && ! empty( $source['name'] ) ) {
$name_markup = "<strong><code>{$source['name']}</code></strong>";
switch ( $source['type'] ) {
case 'plugin':
/* translators: placeholder is the slug of the plugin */
$message = sprintf( __( 'It appears the plugin with slug %s is responsible; please contact the author.', 'amp' ), $name_markup );
break;
case 'mu-plugin':
/* translators: placeholder is the slug of the must-use plugin */
$message = sprintf( __( 'It appears the must-use plugin with slug %s is responsible; please contact the author.', 'amp' ), $name_markup );
break;
case 'theme':
/* translators: placeholder is the slug of the theme */
$message = sprintf( __( 'It appears the theme with slug %s is responsible; please contact the author.', 'amp' ), $name_markup );
break;
default:
return '';
}
return wp_kses(
"<p>{$message}</p>",
array_fill_keys( [ 'p', 'strong', 'code' ], [] )
);
}
return '';
}
/**
* Render the throwable of the error page.
*
* The exception/error details are only rendered if both WP_DEBUG and WP_DEBUG_DISPLAY are true.
*
* @return string HTML describing the exception/error that was thrown.
*/
private function render_throwable() {
if ( null === $this->throwable ) {
return '';
}
if (
! defined( 'WP_DEBUG' )
|| ! WP_DEBUG
|| ! defined( 'WP_DEBUG_DISPLAY' )
|| ! WP_DEBUG_DISPLAY
) {
return wpautop(
wp_kses_post(
__( 'The exact details of the error are hidden for security reasons. To learn more about this error, enable the WordPress debugging display (by setting both <code>WP_DEBUG</code> and <code>WP_DEBUG_DISPLAY</code> to <code>true</code>), or look into the PHP error log. Learn more about <a href="https://wordpress.org/support/article/debugging-in-wordpress/">Debugging in WordPress</a>.', 'amp' )
)
);
}
$contents = implode(
"\n",
[
sprintf(
'<strong>%s</strong> (%s) [<em>%s</em>]',
esc_html( $this->throwable->getMessage() ),
esc_html( $this->throwable->getCode() ),
esc_html( get_class( $this->throwable ) )
),
sprintf(
'<em>%s:%d</em>',
esc_html( $this->throwable->getFile() ),
esc_html( $this->throwable->getLine() )
),
'',
sprintf(
'<small>%s</small>',
esc_html( $this->throwable->getTraceAsString() )
),
]
);
return "<hr><pre class='throwable'>{$contents}</pre>";
}
/**
* Render back link.
*
* @return string Back link.
*/
private function render_back_link() {
if ( empty( $this->link_text ) || empty( $this->link_url ) ) {
return '';
}
return sprintf(
'<p><a href="%s" class="button button-large">%s</a></p>',
esc_url( $this->link_url ),
esc_html( $this->link_text )
);
}
/**
* Get the CSS styles to use for the error page.
*
* @see _default_wp_die_handler() Where styles are adapted from.
*
* @param string $text_direction Text direction. Can be 'ltr' or 'rtl'.
* @return string CSS styles to use.
*/
private function get_styles( $text_direction ) {
$rtl_font_tweak = 'rtl' === $text_direction
? 'body { font-family: Tahoma, Arial; }'
: '';
return <<<STYLES
<style type="text/css">
html {
background: #f1f1f1;
}
body {
background: #fff;
color: #444;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
margin: 2em auto;
padding: 1em 2em;
max-width: 700px;
-webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
}
h1 {
border-bottom: 1px solid #dadada;
clear: both;
color: #666;
font-size: 24px;
margin: 30px 0 0 0;
padding: 0;
padding-bottom: 7px;
}
hr {
margin: 20px 0;
border: none;
border-top: 1px solid #dadada;
}
#error-page {
margin-top: 50px;
}
#error-page p,
#error-page .wp-die-message {
font-size: 14px;
line-height: 1.5;
margin: 25px 0 20px;
}
#error-page .throwable,
code {
font-family: Consolas, Monaco, monospace;
overflow-x: auto;
}
ul li {
margin-bottom: 10px;
font-size: 14px ;
}
a {
color: #0073aa;
}
a:hover,
a:active {
color: #006799;
}
a:focus {
color: #124964;
-webkit-box-shadow:
0 0 0 1px #5b9dd9,
0 0 2px 1px rgba(30, 140, 190, 0.8);
box-shadow:
0 0 0 1px #5b9dd9,
0 0 2px 1px rgba(30, 140, 190, 0.8);
outline: none;
}
.button {
background: #f7f7f7;
border: 1px solid #ccc;
color: #555;
display: inline-block;
text-decoration: none;
font-size: 13px;
line-height: 2;
height: 28px;
margin: 0;
padding: 0 10px 1px;
cursor: pointer;
-webkit-border-radius: 3px;
-webkit-appearance: none;
border-radius: 3px;
white-space: nowrap;
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
-webkit-box-shadow: 0 1px 0 #ccc;
box-shadow: 0 1px 0 #ccc;
vertical-align: top;
}
.button.button-large {
height: 30px;
line-height: 2.15384615;
padding: 0 12px 2px;
}
.button:hover,
.button:focus {
background: #fafafa;
border-color: #999;
color: #23282d;
}
.button:focus {
border-color: #5b9dd9;
-webkit-box-shadow: 0 0 3px rgba(0, 115, 170, 0.8);
box-shadow: 0 0 3px rgba(0, 115, 170, 0.8);
outline: none;
}
.button:active {
background: #eee;
border-color: #999;
-webkit-box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
}
{$rtl_font_tweak}
</style>
STYLES;
}
}