445 lines
14 KiB
PHP
445 lines
14 KiB
PHP
<?php
|
||
/**
|
||
* Jetpack Debugger functionality allowing for self-service diagnostic information via the legacy jetpack debugger.
|
||
*
|
||
* @package jetpack
|
||
*/
|
||
|
||
/** Ensure the Jetpack_Debug_Data class is available. It should be via the library loaded, but defense is good. */
|
||
require_once 'class-jetpack-debug-data.php';
|
||
|
||
/**
|
||
* Class Jetpack_Debugger
|
||
*
|
||
* A namespacing class for functionality related to the legacy in-plugin diagnostic tooling.
|
||
*/
|
||
class Jetpack_Debugger {
|
||
|
||
/**
|
||
* Determine the active plan and normalize it for the debugger results.
|
||
*
|
||
* @return string The plan slug prepended with "JetpackPlan"
|
||
*/
|
||
private static function what_jetpack_plan() {
|
||
// Specifically not deprecating this function since it modifies the output of the Jetpack_Debug_Data::what_jetpack_plan return.
|
||
return 'JetpackPlan' . Jetpack_Debug_Data::what_jetpack_plan();
|
||
}
|
||
|
||
/**
|
||
* Convert seconds to human readable time.
|
||
*
|
||
* A dedication function instead of using Core functionality to allow for output in seconds.
|
||
*
|
||
* @deprecated 7.3.0
|
||
*
|
||
* @param int $seconds Number of seconds to convert to human time.
|
||
*
|
||
* @return string Human readable time.
|
||
*/
|
||
public static function seconds_to_time( $seconds ) {
|
||
_deprecated_function( 'Jetpack_Debugger::seconds_to_time', 'Jetpack 7.3.0', 'Jeptack_Debug_Data::seconds_to_time' );
|
||
return Jetpack_Debug_Data::seconds_to_time( $seconds );
|
||
}
|
||
|
||
/**
|
||
* Returns 30 for use with a filter.
|
||
*
|
||
* To allow time for WP.com to run upstream testing, this function exists to increase the http_request_timeout value
|
||
* to 30.
|
||
*
|
||
* @return int 30
|
||
*/
|
||
public static function jetpack_increase_timeout() {
|
||
return 30; // seconds.
|
||
}
|
||
|
||
/**
|
||
* Disconnect Jetpack and redirect user to connection flow.
|
||
*/
|
||
public static function disconnect_and_redirect() {
|
||
if ( ! ( isset( $_GET['nonce'] ) && wp_verify_nonce( $_GET['nonce'], 'jp_disconnect' ) ) ) {
|
||
return;
|
||
}
|
||
|
||
if ( isset( $_GET['disconnect'] ) && $_GET['disconnect'] ) {
|
||
if ( Jetpack::is_active() ) {
|
||
Jetpack::disconnect();
|
||
wp_safe_redirect( Jetpack::admin_url() );
|
||
exit;
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Handles output to the browser for the in-plugin debugger.
|
||
*/
|
||
public static function jetpack_debug_display_handler() {
|
||
global $wp_version;
|
||
if ( ! current_user_can( 'manage_options' ) ) {
|
||
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'jetpack' ) );
|
||
}
|
||
|
||
$support_url = Jetpack::is_development_version()
|
||
? 'https://jetpack.com/contact-support/beta-group/'
|
||
: 'https://jetpack.com/contact-support/';
|
||
|
||
$data = Jetpack_Debug_Data::debug_data();
|
||
$debug_info = '';
|
||
foreach ( $data as $datum ) {
|
||
$debug_info .= $datum['label'] . ': ' . $datum['value'] . "\r\n";
|
||
}
|
||
|
||
$debug_info .= "\r\n" . esc_html( 'PHP_VERSION: ' . PHP_VERSION );
|
||
$debug_info .= "\r\n" . esc_html( 'WORDPRESS_VERSION: ' . $GLOBALS['wp_version'] );
|
||
$debug_info .= "\r\n" . esc_html( 'SITE_URL: ' . site_url() );
|
||
$debug_info .= "\r\n" . esc_html( 'HOME_URL: ' . home_url() );
|
||
|
||
$debug_info .= "\r\n\r\nTEST RESULTS:\r\n\r\n";
|
||
|
||
$cxntests = new Jetpack_Cxn_Tests();
|
||
?>
|
||
<div class="wrap">
|
||
<h2><?php esc_html_e( 'Debugging Center', 'jetpack' ); ?></h2>
|
||
<h3><?php esc_html_e( "Testing your site's compatibility with Jetpack...", 'jetpack' ); ?></h3>
|
||
<div class="jetpack-debug-test-container">
|
||
<?php
|
||
if ( $cxntests->pass() ) {
|
||
echo '<div class="jetpack-tests-succeed">' . esc_html__( 'Your Jetpack setup looks a-okay!', 'jetpack' ) . '</div>';
|
||
$debug_info .= "All tests passed.\r\n";
|
||
$debug_info .= print_r( $cxntests->raw_results(), true ); //phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
|
||
} else {
|
||
$failures = $cxntests->list_fails();
|
||
foreach ( $failures as $fail ) {
|
||
echo '<div class="jetpack-test-error">';
|
||
echo '<p><a class="jetpack-test-heading" href="#">' . esc_html( $fail['message'] );
|
||
echo '<span class="noticon noticon-collapse"></span></a></p>';
|
||
echo '<p class="jetpack-test-details">' . esc_html( $fail['resolution'] ) . '</p>';
|
||
echo '</div>';
|
||
|
||
$debug_info .= "FAILED TESTS!\r\n";
|
||
$debug_info .= $fail['name'] . ': ' . $fail['message'] . "\r\n";
|
||
$debug_info .= print_r( $cxntests->raw_results(), true ); //phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
|
||
}
|
||
}
|
||
?>
|
||
</div>
|
||
<div class="entry-content">
|
||
<h3><?php esc_html_e( 'Trouble with Jetpack?', 'jetpack' ); ?></h3>
|
||
<h4><?php esc_html_e( 'It may be caused by one of these issues, which you can diagnose yourself:', 'jetpack' ); ?></h4>
|
||
<ol>
|
||
<li><b><em>
|
||
<?php
|
||
esc_html_e( 'A known issue.', 'jetpack' );
|
||
?>
|
||
</em></b>
|
||
<?php
|
||
echo sprintf(
|
||
wp_kses(
|
||
/* translators: URLs to Jetpack support pages. */
|
||
__( 'Some themes and plugins have <a href="%1$s" target="_blank">known conflicts</a> with Jetpack – check the <a href="%2$s" target="_blank">list</a>. (You can also browse the <a href="%3$s" target="_blank">Jetpack support pages</a> or <a href="%4$s" target="_blank">Jetpack support forum</a> to see if others have experienced and solved the problem.)', 'jetpack' ),
|
||
array(
|
||
'a' => array(
|
||
'href' => array(),
|
||
'target' => array(),
|
||
),
|
||
)
|
||
),
|
||
'http://jetpack.com/support/getting-started-with-jetpack/known-issues/',
|
||
'http://jetpack.com/support/getting-started-with-jetpack/known-issues/',
|
||
'http://jetpack.com/support/',
|
||
'https://wordpress.org/support/plugin/jetpack'
|
||
);
|
||
?>
|
||
</li>
|
||
<li><b><em><?php esc_html_e( 'An incompatible plugin.', 'jetpack' ); ?></em></b> <?php esc_html_e( "Find out by disabling all plugins except Jetpack. If the problem persists, it's not a plugin issue. If the problem is solved, turn your plugins on one by one until the problem pops up again – there's the culprit! Let us know, and we'll try to help.", 'jetpack' ); ?></li>
|
||
<li>
|
||
<b><em><?php esc_html_e( 'A theme conflict.', 'jetpack' ); ?></em></b>
|
||
<?php
|
||
$default_theme = wp_get_theme( WP_DEFAULT_THEME );
|
||
|
||
if ( $default_theme->exists() ) {
|
||
/* translators: %s is the name of a theme */
|
||
echo esc_html( sprintf( __( "If your problem isn't known or caused by a plugin, try activating %s (the default WordPress theme).", 'jetpack' ), $default_theme->get( 'Name' ) ) );
|
||
} else {
|
||
esc_html_e( "If your problem isn't known or caused by a plugin, try activating the default WordPress theme.", 'jetpack' );
|
||
}
|
||
?>
|
||
<?php esc_html_e( "If this solves the problem, something in your theme is probably broken – let the theme's author know.", 'jetpack' ); ?>
|
||
</li>
|
||
<li><b><em><?php esc_html_e( 'A problem with your XMLRPC file.', 'jetpack' ); ?></em></b>
|
||
<?php
|
||
echo sprintf(
|
||
wp_kses(
|
||
/* translators: The URL to the site's xmlrpc.php file. */
|
||
__( 'Load your <a href="%s">XMLRPC file</a>. It should say “XML-RPC server accepts POST requests only.” on a line by itself.', 'jetpack' ),
|
||
array( 'a' => array( 'href' => array() ) )
|
||
),
|
||
esc_attr( site_url( 'xmlrpc.php' ) )
|
||
);
|
||
?>
|
||
<ul>
|
||
<li>- <?php esc_html_e( "If it's not by itself, a theme or plugin is displaying extra characters. Try steps 2 and 3.", 'jetpack' ); ?></li>
|
||
<li>- <?php esc_html_e( 'If you get a 404 message, contact your web host. Their security may block XMLRPC.', 'jetpack' ); ?></li>
|
||
</ul>
|
||
</li>
|
||
<?php if ( current_user_can( 'jetpack_disconnect' ) && Jetpack::is_active() ) : ?>
|
||
<li>
|
||
<strong><em><?php esc_html_e( 'A connection problem with WordPress.com.', 'jetpack' ); ?></em></strong>
|
||
<?php
|
||
echo sprintf(
|
||
wp_kses(
|
||
/* translators: URL to disconnect and reconnect Jetpack. */
|
||
__( 'Jetpack works by connecting to WordPress.com for a lot of features. Sometimes, when the connection gets messed up, you need to disconnect and reconnect to get things working properly. <a href="%s">Disconnect from WordPress.com</a>', 'jetpack' ),
|
||
array(
|
||
'a' => array(
|
||
'href' => array(),
|
||
'class' => array(),
|
||
),
|
||
)
|
||
),
|
||
esc_attr(
|
||
wp_nonce_url(
|
||
Jetpack::admin_url(
|
||
array(
|
||
'page' => 'jetpack-debugger',
|
||
'disconnect' => true,
|
||
)
|
||
),
|
||
'jp_disconnect',
|
||
'nonce'
|
||
)
|
||
)
|
||
);
|
||
?>
|
||
</li>
|
||
<?php endif; ?>
|
||
</ol>
|
||
<h4><?php esc_html_e( 'Still having trouble?', 'jetpack' ); ?></h4>
|
||
<p><b><em><?php esc_html_e( 'Ask us for help!', 'jetpack' ); ?></em></b>
|
||
<?php
|
||
/**
|
||
* Offload to new WordPress debug data in WP 5.2+
|
||
*
|
||
* @todo remove fallback when 5.2 is the minimum supported.
|
||
*/
|
||
if ( version_compare( $wp_version, '5.2-alpha', '>=' ) ) {
|
||
echo sprintf(
|
||
wp_kses(
|
||
/* translators: URL for Jetpack support. URL for WordPress's Site Health */
|
||
__( '<a href="%1$s">Contact our Happiness team</a>. When you do, please include the <a href="%2$s">full debug information from your site</a>.', 'jetpack' ),
|
||
array( 'a' => array( 'href' => array() ) )
|
||
),
|
||
esc_url( $support_url ),
|
||
esc_url( admin_url() . 'site-health.php?tab=debug' )
|
||
);
|
||
$hide_debug = true;
|
||
} else { // Versions before 5.2, fallback.
|
||
echo sprintf(
|
||
wp_kses(
|
||
/* translators: URL for Jetpack support. */
|
||
__( '<a href="%s">Contact our Happiness team</a>. When you do, please include the full debug information below.', 'jetpack' ),
|
||
array( 'a' => array( 'href' => array() ) )
|
||
),
|
||
esc_url( $support_url )
|
||
);
|
||
$hide_debug = false;
|
||
}
|
||
?>
|
||
</p>
|
||
<hr />
|
||
<?php if ( Jetpack::is_active() ) : ?>
|
||
<div id="connected-user-details">
|
||
<h3><?php esc_html_e( 'More details about your Jetpack settings', 'jetpack' ); ?></h3>
|
||
<p>
|
||
<?php
|
||
printf(
|
||
wp_kses(
|
||
/* translators: %s is an e-mail address */
|
||
__( 'The primary connection is owned by <strong>%s</strong>\'s WordPress.com account.', 'jetpack' ),
|
||
array( 'strong' => array() )
|
||
),
|
||
esc_html( Jetpack::get_master_user_email() )
|
||
);
|
||
?>
|
||
</p>
|
||
</div>
|
||
<?php else : ?>
|
||
<div id="dev-mode-details">
|
||
<p>
|
||
<?php
|
||
printf(
|
||
wp_kses(
|
||
/* translators: Link to a Jetpack support page. */
|
||
__( 'Would you like to use Jetpack on your local development site? You can do so thanks to <a href="%s">Jetpack\'s development mode</a>.', 'jetpack' ),
|
||
array( 'a' => array( 'href' => array() ) )
|
||
),
|
||
'https://jetpack.com/support/development-mode/'
|
||
);
|
||
?>
|
||
</p>
|
||
</div>
|
||
<?php endif; ?>
|
||
<?php
|
||
if (
|
||
current_user_can( 'jetpack_manage_modules' )
|
||
&& ( Jetpack::is_development_mode() || Jetpack::is_active() )
|
||
) {
|
||
printf(
|
||
wp_kses(
|
||
'<p><a href="%1$s">%2$s</a></p>',
|
||
array(
|
||
'a' => array( 'href' => array() ),
|
||
'p' => array(),
|
||
)
|
||
),
|
||
esc_attr( Jetpack::admin_url( 'page=jetpack_modules' ) ),
|
||
esc_html__( 'Access the full list of Jetpack modules available on your site.', 'jetpack' )
|
||
);
|
||
}
|
||
?>
|
||
</div>
|
||
<hr />
|
||
<?php
|
||
if ( ! $hide_debug ) {
|
||
?>
|
||
<div id="toggle_debug_info"><?php esc_html_e( 'Advanced Debug Results', 'jetpack' ); ?></div>
|
||
<div id="debug_info_div">
|
||
<h4><?php esc_html_e( 'Debug Info', 'jetpack' ); ?></h4>
|
||
<div id="debug_info"><pre><?php echo esc_html( $debug_info ); ?></pre></div>
|
||
</div>
|
||
<?php
|
||
}
|
||
?>
|
||
</div>
|
||
<?php
|
||
}
|
||
|
||
/**
|
||
* Outputs html needed within the <head> for the in-plugin debugger page.
|
||
*/
|
||
public static function jetpack_debug_admin_head() {
|
||
|
||
Jetpack_Admin_Page::load_wrapper_styles();
|
||
?>
|
||
<style type="text/css">
|
||
|
||
.jetpack-debug-test-container {
|
||
margin-top: 20px;
|
||
margin-bottom: 30px;
|
||
}
|
||
|
||
.jetpack-tests-succeed {
|
||
font-size: large;
|
||
color: #8BAB3E;
|
||
}
|
||
|
||
.jetpack-test-details {
|
||
margin: 4px 6px;
|
||
padding: 10px;
|
||
overflow: auto;
|
||
display: none;
|
||
}
|
||
|
||
.jetpack-test-error {
|
||
margin-bottom: 10px;
|
||
background: #FFEBE8;
|
||
border: solid 1px #C00;
|
||
border-radius: 3px;
|
||
}
|
||
|
||
.jetpack-test-error p {
|
||
margin: 0;
|
||
padding: 0;
|
||
}
|
||
|
||
p.jetpack-test-details {
|
||
margin: 4px 6px;
|
||
padding: 10px;
|
||
}
|
||
|
||
.jetpack-test-error a.jetpack-test-heading {
|
||
padding: 4px 6px;
|
||
display: block;
|
||
text-decoration: none;
|
||
color: inherit;
|
||
}
|
||
|
||
.jetpack-test-error .noticon {
|
||
float: right;
|
||
}
|
||
|
||
.formbox {
|
||
margin: 0 0 25px 0;
|
||
}
|
||
|
||
.formbox input[type="text"], .formbox input[type="email"], .formbox input[type="url"], .formbox textarea, #debug_info_div {
|
||
border: 1px solid #e5e5e5;
|
||
border-radius: 11px;
|
||
box-shadow: inset 0 1px 1px rgba(0,0,0,0.1);
|
||
color: #666;
|
||
font-size: 14px;
|
||
padding: 10px;
|
||
width: 97%;
|
||
}
|
||
#debug_info_div {
|
||
border-radius: 0;
|
||
margin-top: 16px;
|
||
background: #FFF;
|
||
padding: 16px;
|
||
}
|
||
.formbox .contact-support input[type="submit"] {
|
||
float: right;
|
||
margin: 0 !important;
|
||
border-radius: 20px !important;
|
||
cursor: pointer;
|
||
font-size: 13pt !important;
|
||
height: auto !important;
|
||
margin: 0 0 2em 10px !important;
|
||
padding: 8px 16px !important;
|
||
background-color: #ddd;
|
||
border: 1px solid rgba(0,0,0,0.05);
|
||
border-top-color: rgba(255,255,255,0.1);
|
||
border-bottom-color: rgba(0,0,0,0.15);
|
||
color: #333;
|
||
font-weight: 400;
|
||
display: inline-block;
|
||
text-align: center;
|
||
text-decoration: none;
|
||
}
|
||
|
||
.formbox span.errormsg {
|
||
margin: 0 0 10px 10px;
|
||
color: #d00;
|
||
display: none;
|
||
}
|
||
|
||
.formbox.error span.errormsg {
|
||
display: block;
|
||
}
|
||
|
||
#debug_info_div, #toggle_debug_info, #debug_info_div p {
|
||
font-size: 12px;
|
||
}
|
||
|
||
#category_div ul li {
|
||
list-style-type: none;
|
||
}
|
||
|
||
</style>
|
||
<script type="text/javascript">
|
||
jQuery( document ).ready( function($) {
|
||
|
||
$( '#debug_info' ).prepend( 'jQuery version: ' + jQuery.fn.jquery + "\r\n" );
|
||
$( '#debug_form_info' ).prepend( 'jQuery version: ' + jQuery.fn.jquery + "\r\n" );
|
||
|
||
$( '.jetpack-test-error .jetpack-test-heading' ).on( 'click', function() {
|
||
$( this ).parents( '.jetpack-test-error' ).find( '.jetpack-test-details' ).slideToggle();
|
||
return false;
|
||
} );
|
||
|
||
} );
|
||
</script>
|
||
<?php
|
||
}
|
||
}
|