942 lines
26 KiB
PHP
942 lines
26 KiB
PHP
<?php declare(strict_types = 1);
|
|
/**
|
|
* General HTML request dispatcher.
|
|
*
|
|
* @package query-monitor
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
class QM_Dispatcher_Html extends QM_Dispatcher {
|
|
|
|
/**
|
|
* Outputter instances.
|
|
*
|
|
* @var array<string, QM_Output_Html> Array of outputters.
|
|
*/
|
|
protected $outputters = array();
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
public $id = 'html';
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
public $did_footer = false;
|
|
|
|
/**
|
|
* @var array<string, mixed[]>
|
|
*/
|
|
protected $admin_bar_menu = array();
|
|
|
|
/**
|
|
* @var array<string, mixed[]>
|
|
*/
|
|
protected $panel_menu = array();
|
|
|
|
public function __construct( QM_Plugin $qm ) {
|
|
|
|
add_action( 'admin_bar_menu', array( $this, 'action_admin_bar_menu' ), 999 );
|
|
add_action( 'wp_ajax_qm_auth_on', array( $this, 'ajax_on' ) );
|
|
add_action( 'wp_ajax_qm_auth_off', array( $this, 'ajax_off' ) );
|
|
add_action( 'wp_ajax_qm_editor_set', array( $this, 'ajax_editor_set' ) );
|
|
add_action( 'wp_ajax_nopriv_qm_auth_off', array( $this, 'ajax_off' ) );
|
|
|
|
// 9 is a magic number, it's the latest we can realistically use due to plugins
|
|
// which call `fastcgi_finish_request()` in a `shutdown` callback hooked on the
|
|
// default priority of 10, and QM needs to dispatch its output before those.
|
|
add_action( 'shutdown', array( $this, 'dispatch' ), 9 );
|
|
|
|
add_action( 'wp_footer', array( $this, 'action_footer' ) );
|
|
add_action( 'admin_footer', array( $this, 'action_footer' ) );
|
|
add_action( 'login_footer', array( $this, 'action_footer' ) );
|
|
add_action( 'gp_footer', array( $this, 'action_footer' ) );
|
|
|
|
parent::__construct( $qm );
|
|
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function action_footer() {
|
|
$this->did_footer = true;
|
|
}
|
|
|
|
/**
|
|
* Helper function. Should the authentication cookie be secure?
|
|
*
|
|
* @return bool Should the authentication cookie be secure?
|
|
*/
|
|
public static function secure_cookie() {
|
|
return ( is_ssl() && ( 'https' === parse_url( home_url(), PHP_URL_SCHEME ) ) );
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function ajax_on() {
|
|
|
|
if ( ! current_user_can( 'view_query_monitor' ) || ! check_ajax_referer( 'qm-auth-on', 'nonce', false ) ) {
|
|
wp_send_json_error();
|
|
}
|
|
|
|
$expiration = time() + ( 2 * DAY_IN_SECONDS );
|
|
$secure = self::secure_cookie();
|
|
$cookie = wp_generate_auth_cookie( get_current_user_id(), $expiration, 'logged_in' );
|
|
$domain = COOKIE_DOMAIN ?: '';
|
|
|
|
setcookie( QM_COOKIE, $cookie, $expiration, COOKIEPATH, $domain, $secure, false );
|
|
|
|
wp_send_json_success();
|
|
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function ajax_off() {
|
|
|
|
if ( ! self::user_verified() || ! check_ajax_referer( 'qm-auth-off', 'nonce', false ) ) {
|
|
wp_send_json_error();
|
|
}
|
|
|
|
$expiration = time() - 31536000;
|
|
$domain = COOKIE_DOMAIN ?: '';
|
|
|
|
setcookie( QM_COOKIE, ' ', $expiration, COOKIEPATH, $domain );
|
|
|
|
wp_send_json_success();
|
|
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function ajax_editor_set() {
|
|
|
|
if ( ! current_user_can( 'view_query_monitor' ) || ! check_ajax_referer( 'qm-editor-set', 'nonce', false ) ) {
|
|
wp_send_json_error();
|
|
}
|
|
|
|
$expiration = time() + ( 2 * YEAR_IN_SECONDS );
|
|
$secure = self::secure_cookie();
|
|
$editor = wp_unslash( $_POST['editor'] );
|
|
$domain = COOKIE_DOMAIN ?: '';
|
|
|
|
setcookie( QM_EDITOR_COOKIE, $editor, $expiration, COOKIEPATH, $domain, $secure, false );
|
|
|
|
wp_send_json_success( $editor );
|
|
|
|
}
|
|
|
|
/**
|
|
* @param WP_Admin_Bar $wp_admin_bar
|
|
* @return void
|
|
*/
|
|
public function action_admin_bar_menu( WP_Admin_Bar $wp_admin_bar ) {
|
|
|
|
if ( ! self::user_can_view() ) {
|
|
return;
|
|
}
|
|
|
|
$title = __( 'Query Monitor', 'query-monitor' );
|
|
|
|
$wp_admin_bar->add_node( array(
|
|
'id' => 'query-monitor',
|
|
'title' => esc_html( $title ),
|
|
'href' => '#qm-overview',
|
|
) );
|
|
|
|
$wp_admin_bar->add_node( array(
|
|
'parent' => 'query-monitor',
|
|
'id' => 'query-monitor-placeholder',
|
|
'title' => esc_html( $title ),
|
|
'href' => '#qm-overview',
|
|
) );
|
|
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function init() {
|
|
|
|
if ( ! self::user_can_view() ) {
|
|
return;
|
|
}
|
|
|
|
if ( ! self::request_supported() ) {
|
|
return;
|
|
}
|
|
|
|
if ( ! file_exists( $this->qm->plugin_path( 'assets/query-monitor.css' ) ) ) {
|
|
add_action( 'admin_notices', array( $this, 'build_warning' ) );
|
|
return;
|
|
}
|
|
|
|
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ), -9999 );
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ), -9999 );
|
|
add_action( 'login_enqueue_scripts', array( $this, 'enqueue_assets' ), -9999 );
|
|
add_action( 'enqueue_embed_scripts', array( $this, 'enqueue_assets' ), -9999 );
|
|
|
|
add_action( 'gp_head', array( $this, 'manually_print_assets' ), 11 );
|
|
|
|
parent::init();
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function manually_print_assets() {
|
|
wp_print_scripts( array(
|
|
'query-monitor',
|
|
) );
|
|
wp_print_styles( array(
|
|
'query-monitor',
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function build_warning() {
|
|
printf(
|
|
'<div id="qm-built-nope" class="notice notice-error"><p>%s</p></div>',
|
|
sprintf(
|
|
/* translators: 1: CLI command to run, 2: plugin directory name */
|
|
esc_html__( 'Asset files for Query Monitor need to be built. Run %1$s from the %2$s directory.', 'query-monitor' ),
|
|
'<code>npm i && npm run build</code>',
|
|
sprintf(
|
|
'<code>%s</code>',
|
|
esc_html( QM_Util::standard_dir( untrailingslashit( $this->qm->plugin_path() ), '' ) )
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function enqueue_assets() {
|
|
global $wp_locale;
|
|
|
|
$deps = array(
|
|
'jquery',
|
|
);
|
|
|
|
if ( defined( 'QM_NO_JQUERY' ) && QM_NO_JQUERY ) {
|
|
$deps = array();
|
|
}
|
|
|
|
wp_enqueue_style(
|
|
'query-monitor',
|
|
$this->qm->plugin_url( 'assets/query-monitor.css' ),
|
|
array(),
|
|
QM_VERSION
|
|
);
|
|
wp_enqueue_script(
|
|
'query-monitor',
|
|
$this->qm->plugin_url( 'assets/query-monitor.js' ),
|
|
$deps,
|
|
QM_VERSION,
|
|
false
|
|
);
|
|
wp_localize_script(
|
|
'query-monitor',
|
|
'qm_number_format',
|
|
$wp_locale->number_format
|
|
);
|
|
wp_localize_script(
|
|
'query-monitor',
|
|
'qm_l10n',
|
|
array(
|
|
'ajax_error' => __( 'PHP Errors in Ajax Response', 'query-monitor' ),
|
|
'ajaxurl' => admin_url( 'admin-ajax.php' ),
|
|
'auth_nonce' => array(
|
|
'on' => wp_create_nonce( 'qm-auth-on' ),
|
|
'off' => wp_create_nonce( 'qm-auth-off' ),
|
|
'editor-set' => wp_create_nonce( 'qm-editor-set' ),
|
|
),
|
|
'fatal_error' => __( 'PHP Fatal Error', 'query-monitor' ),
|
|
)
|
|
);
|
|
|
|
/**
|
|
* Fires when assets for QM's HTML have been enqueued.
|
|
*
|
|
* @since 3.6.0
|
|
*
|
|
* @param \QM_Dispatcher_Html $dispatcher The HTML dispatcher.
|
|
*/
|
|
do_action( 'qm/output/enqueued-assets', $this );
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function dispatch() {
|
|
if ( ! $this->should_dispatch() ) {
|
|
return;
|
|
}
|
|
|
|
if ( $this->ceased ) {
|
|
$admin_bar_menu = array(
|
|
'top' => array(
|
|
'title' => 'Query Monitor',
|
|
),
|
|
'sub' => array(
|
|
'ceased' => array(
|
|
'title' => esc_html__( 'Data collection ceased', 'query-monitor' ),
|
|
'id' => 'query-monitor-ceased',
|
|
'href' => '#',
|
|
),
|
|
),
|
|
);
|
|
|
|
$json = array(
|
|
'menu' => $admin_bar_menu,
|
|
);
|
|
|
|
echo '<!-- Begin Query Monitor output -->' . "\n\n";
|
|
echo '<script type="text/javascript">' . "\n\n";
|
|
echo 'var qm = ' . json_encode( $json ) . ';' . "\n\n";
|
|
echo '</script>' . "\n\n";
|
|
echo '<div id="query-monitor-ceased"></div>';
|
|
echo '<!-- End Query Monitor output -->' . "\n\n";
|
|
return;
|
|
}
|
|
|
|
$switched_locale = self::switch_to_locale( get_user_locale() );
|
|
|
|
$this->before_output();
|
|
|
|
foreach ( $this->outputters as $id => $output ) {
|
|
$timer = new QM_Timer();
|
|
$timer->start();
|
|
|
|
printf(
|
|
"\n" . '<!-- Begin %1$s output -->' . "\n" . '<div class="qm-panel-container" id="qm-%1$s-container">' . "\n",
|
|
esc_html( $id )
|
|
);
|
|
$output->output();
|
|
printf(
|
|
"\n" . '</div>' . "\n" . '<!-- End %s output -->' . "\n",
|
|
esc_html( $id )
|
|
);
|
|
|
|
$output->set_timer( $timer->stop() );
|
|
}
|
|
|
|
$this->after_output();
|
|
|
|
if ( $switched_locale ) {
|
|
self::restore_previous_locale();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
protected function before_output() {
|
|
foreach ( (array) glob( $this->qm->plugin_path( 'output/html/*.php' ) ) as $file ) {
|
|
require_once $file;
|
|
}
|
|
|
|
/** @var array<string, QM_Output_Html> $outputters */
|
|
$outputters = $this->get_outputters( 'html' );
|
|
|
|
$this->outputters = $outputters;
|
|
|
|
/**
|
|
* Filters the menu items shown in Query Monitor's admin toolbar menu.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @param array<string, mixed[]> $menus Array of menus.
|
|
*/
|
|
$this->admin_bar_menu = apply_filters( 'qm/output/menus', array() );
|
|
|
|
/**
|
|
* Filters the menu items shown in the panel navigation menu in Query Monitor's output.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @param array<string, mixed[]> $admin_bar_menu Array of menus.
|
|
*/
|
|
$this->panel_menu = apply_filters( 'qm/output/panel_menus', $this->admin_bar_menu );
|
|
|
|
foreach ( $this->outputters as $output_id => $output ) {
|
|
$collector = $output->get_collector();
|
|
|
|
if ( ( ! empty( $collector->concerned_filters ) || ! empty( $collector->concerned_actions ) ) && isset( $this->panel_menu[ 'qm-' . $output_id ] ) ) {
|
|
$count = count( $collector->concerned_filters ) + count( $collector->concerned_actions );
|
|
$this->panel_menu[ 'qm-' . $output_id ]['children'][ 'qm-' . $output_id . '-concerned_hooks' ] = array(
|
|
'href' => esc_attr( '#' . $collector->id() . '-concerned_hooks' ),
|
|
'title' => sprintf(
|
|
/* translators: %s: Number of hooks */
|
|
__( 'Hooks in Use (%s)', 'query-monitor' ),
|
|
number_format_i18n( $count )
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
$class = array(
|
|
'qm-no-js',
|
|
);
|
|
|
|
if ( did_action( 'wp_head' ) ) {
|
|
$class[] = sprintf( 'qm-theme-%s', get_template() );
|
|
$class[] = sprintf( 'qm-theme-%s', get_stylesheet() );
|
|
}
|
|
|
|
if ( ! is_admin_bar_showing() ) {
|
|
$class[] = 'qm-peek';
|
|
}
|
|
|
|
$json = array(
|
|
'menu' => $this->js_admin_bar_menu(),
|
|
'ajax_errors' => array(), # @TODO move this into the php_errors collector
|
|
);
|
|
|
|
echo '<!-- Begin Query Monitor output -->' . "\n\n";
|
|
echo '<script type="text/javascript">' . "\n\n";
|
|
echo 'var qm = ' . json_encode( $json ) . ';' . "\n\n";
|
|
echo '</script>' . "\n\n";
|
|
|
|
echo '<svg id="qm-icon-container">';
|
|
foreach ( (array) glob( $this->qm->plugin_path( 'assets/icons/*.svg' ) ) as $icon ) {
|
|
if ( ! $icon ) {
|
|
continue;
|
|
}
|
|
|
|
$icon_name = basename( $icon, '.svg' );
|
|
$contents = (string) file_get_contents( $icon );
|
|
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo str_replace(
|
|
'<path ',
|
|
sprintf(
|
|
'<path id="qm-icon-%s" ',
|
|
$icon_name
|
|
),
|
|
$contents
|
|
);
|
|
}
|
|
echo '</svg>';
|
|
|
|
echo '<div id="query-monitor-main" data-theme="auto" class="' . implode( ' ', array_map( 'esc_attr', $class ) ) . '" dir="ltr">';
|
|
echo '<div id="qm-side-resizer" class="qm-resizer"></div>';
|
|
echo '<div id="qm-title" class="qm-resizer">';
|
|
echo '<h1 class="qm-title-heading">' . esc_html__( 'Query Monitor', 'query-monitor' ) . '</h1>';
|
|
echo '<div class="qm-title-heading">';
|
|
echo '<select>';
|
|
|
|
printf(
|
|
'<option value="%1$s">%2$s</option>',
|
|
'#qm-overview',
|
|
esc_html__( 'Overview', 'query-monitor' )
|
|
);
|
|
|
|
foreach ( $this->panel_menu as $menu ) {
|
|
printf(
|
|
'<option value="%1$s">%2$s</option>',
|
|
esc_attr( $menu['href'] ),
|
|
esc_html( $menu['title'] )
|
|
);
|
|
if ( ! empty( $menu['children'] ) ) {
|
|
foreach ( $menu['children'] as $child ) {
|
|
printf(
|
|
'<option value="%1$s">└ %2$s</option>',
|
|
esc_attr( $child['href'] ),
|
|
esc_html( $child['title'] )
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
printf(
|
|
'<option value="%1$s">%2$s</option>',
|
|
'#qm-settings',
|
|
esc_html__( 'Settings', 'query-monitor' )
|
|
);
|
|
|
|
echo '</select>';
|
|
|
|
$settings = QueryMonitor::icon( 'admin-generic' );
|
|
$toggle = QueryMonitor::icon( 'image-rotate-left' );
|
|
$close = QueryMonitor::icon( 'no-alt' );
|
|
|
|
echo '</div>';
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '<button class="qm-title-button qm-button-container-settings" aria-label="' . esc_attr__( 'Settings', 'query-monitor' ) . '">' . $settings . '</button>';
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '<button class="qm-title-button qm-button-container-position" aria-label="' . esc_html__( 'Toggle panel position', 'query-monitor' ) . '">' . $toggle . '</button>';
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '<button class="qm-title-button qm-button-container-close" aria-label="' . esc_attr__( 'Close Panel', 'query-monitor' ) . '">' . $close . '</button>';
|
|
echo '</div>'; // #qm-title
|
|
|
|
echo '<div id="qm-wrapper">';
|
|
echo '<nav id="qm-panel-menu" aria-labelledby="qm-panel-menu-caption">';
|
|
echo '<h2 class="qm-screen-reader-text" id="qm-panel-menu-caption">' . esc_html__( 'Query Monitor Menu', 'query-monitor' ) . '</h2>';
|
|
echo '<ul role="tablist">';
|
|
|
|
printf(
|
|
'<li role="presentation"><button role="tab" data-qm-href="%1$s">%2$s</button></li>',
|
|
'#qm-overview',
|
|
esc_html__( 'Overview', 'query-monitor' )
|
|
);
|
|
|
|
foreach ( $this->panel_menu as $id => $menu ) {
|
|
$this->do_panel_menu_item( $id, $menu );
|
|
}
|
|
|
|
echo '</ul>';
|
|
echo '</nav>'; // #qm-panel-menu
|
|
|
|
echo '<div id="qm-panels">';
|
|
|
|
}
|
|
|
|
/**
|
|
* @param string $id
|
|
* @param mixed[] $menu
|
|
* @return void
|
|
*/
|
|
protected function do_panel_menu_item( $id, array $menu ) {
|
|
printf(
|
|
'<li role="presentation"><button role="tab" data-qm-href="%1$s">%2$s</button>',
|
|
esc_attr( $menu['href'] ),
|
|
esc_html( $menu['title'] )
|
|
);
|
|
|
|
if ( ! empty( $menu['children'] ) ) {
|
|
echo '<ul role="presentation">';
|
|
foreach ( $menu['children'] as $child_id => $child ) {
|
|
$this->do_panel_menu_item( $child_id, $child );
|
|
}
|
|
echo '</ul>';
|
|
}
|
|
|
|
echo '</li>';
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
protected function after_output() {
|
|
|
|
$state = self::user_verified() ? 'on' : 'off';
|
|
$editor = self::editor_cookie();
|
|
$text = array(
|
|
'on' => __( 'Clear authentication cookie', 'query-monitor' ),
|
|
'off' => __( 'Set authentication cookie', 'query-monitor' ),
|
|
);
|
|
|
|
echo '<div class="qm qm-non-tabular" id="qm-settings" data-qm-state="' . esc_attr( $state ) . '">';
|
|
echo '<h2 class="qm-screen-reader-text">' . esc_html__( 'Settings', 'query-monitor' ) . '</h2>';
|
|
|
|
echo '<div class="qm-grid">';
|
|
echo '<section>';
|
|
echo '<h3>' . esc_html__( 'Authentication', 'query-monitor' ) . '</h3>';
|
|
|
|
echo '<p>' . esc_html__( 'You can set an authentication cookie which allows you to view Query Monitor output when you’re not logged in, or when you’re logged in as a different user.', 'query-monitor' ) . '</p>';
|
|
|
|
echo '<p><button class="qm-auth qm-button" data-qm-text-on="' . esc_attr( $text['on'] ) . '" data-qm-text-off="' . esc_attr( $text['off'] ) . '">' . esc_html( $text[ $state ] ) . '</button></p>';
|
|
|
|
$yes = QueryMonitor::icon( 'yes-alt' );
|
|
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '<p data-qm-state-visibility="on">' . $yes . ' ' . esc_html__( 'Authentication cookie is set', 'query-monitor' ) . '</p>';
|
|
|
|
echo '</section>';
|
|
|
|
echo '<section>';
|
|
|
|
echo '<h3>' . esc_html__( 'Editor', 'query-monitor' ) . '</h3>';
|
|
|
|
if ( ! has_filter( 'qm/output/file_link_format' ) ) {
|
|
echo '<p>' . esc_html__( 'You can set your editor here, so that when you click on stack trace links the file opens in your editor.', 'query-monitor' ) . '</p>';
|
|
|
|
echo '<p>';
|
|
echo '<select id="qm-editor-select" name="qm-editor-select" class="qm-filter">';
|
|
|
|
$editors = array(
|
|
'Default/Xdebug' => '',
|
|
'Atom' => 'atom',
|
|
'Netbeans' => 'netbeans',
|
|
'Nova' => 'nova',
|
|
'PhpStorm' => 'phpstorm',
|
|
'Sublime Text' => 'sublime',
|
|
'TextMate' => 'textmate',
|
|
'Visual Studio Code' => 'vscode',
|
|
);
|
|
|
|
foreach ( $editors as $name => $value ) {
|
|
echo '<option value="' . esc_attr( $value ) . '" ' . selected( $value, $editor, false ) . '>' . esc_html( $name ) . '</option>';
|
|
}
|
|
|
|
echo '</select>';
|
|
echo '</p><p>';
|
|
echo '<button class="qm-editor-button qm-button">' . esc_html__( 'Set editor cookie', 'query-monitor' ) . '</button>';
|
|
echo '</p>';
|
|
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '<p id="qm-editor-save-status">' . $yes . ' ' . esc_html__( 'Saved! Reload to apply changes.', 'query-monitor' ) . '</p>';
|
|
} else {
|
|
printf(
|
|
/* translators: %s: Name of WordPress filter */
|
|
esc_html__( 'The file link format for your editor is set by the %s filter.', 'query-monitor' ),
|
|
'<code>qm/output/file_link_format</code>'
|
|
);
|
|
echo '</p>';
|
|
}
|
|
|
|
echo '</section>';
|
|
|
|
echo '<section>';
|
|
echo '<h3>' . esc_html__( 'Appearance', 'query-monitor' ) . '</h3>';
|
|
|
|
echo '<p>' . esc_html__( 'Your browser color scheme is respected by default. You can override it here.', 'query-monitor' ) . '</p>';
|
|
|
|
echo '<ul>';
|
|
echo '<li><label><input type="radio" class="qm-theme-toggle qm-radio" name="qm-theme" value="auto" checked/>' . esc_html_x( 'Auto', 'colour scheme', 'query-monitor' ) . '</label></li>';
|
|
echo '<li><label><input type="radio" class="qm-theme-toggle qm-radio" name="qm-theme" value="light"/>' . esc_html_x( 'Light', 'colour scheme', 'query-monitor' ) . '</label></li>';
|
|
echo '<li><label><input type="radio" class="qm-theme-toggle qm-radio" name="qm-theme" value="dark"/>' . esc_html_x( 'Dark', 'colour scheme', 'query-monitor' ) . '</label></li>';
|
|
echo '</ul>';
|
|
echo '</section>';
|
|
echo '</div>';
|
|
|
|
echo '<div class="qm-boxed">';
|
|
$constants = array(
|
|
'QM_DB_EXPENSIVE' => array(
|
|
'label' => __( 'If an individual database query takes longer than this time to execute, it\'s considered "slow" and triggers a warning.', 'query-monitor' ),
|
|
'default' => 0.05,
|
|
),
|
|
'QM_DISABLED' => array(
|
|
'label' => __( 'Disable Query Monitor entirely.', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_DISABLE_ERROR_HANDLER' => array(
|
|
'label' => __( 'Disable the handling of PHP errors.', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_ENABLE_CAPS_PANEL' => array(
|
|
'label' => __( 'Enable the Capability Checks panel.', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_HIDE_CORE_ACTIONS' => array(
|
|
'label' => __( 'Hide WordPress core on the Hooks & Actions panel.', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_HIDE_SELF' => array(
|
|
'label' => __( 'Hide Query Monitor itself from various panels. Set to false if you want to see how Query Monitor hooks into WordPress.', 'query-monitor' ),
|
|
'default' => true,
|
|
),
|
|
'QM_NO_JQUERY' => array(
|
|
'label' => __( 'Don\'t specify jQuery as a dependency of Query Monitor. If jQuery isn\'t enqueued then Query Monitor will still operate, but with some reduced functionality.', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_SHOW_ALL_HOOKS' => array(
|
|
'label' => __( 'In the Hooks & Actions panel, show every hook that has an action or filter attached (instead of every action hook that fired during the request).', 'query-monitor' ),
|
|
'default' => false,
|
|
),
|
|
'QM_DB_SYMLINK' => array(
|
|
'label' => __( 'Allow the wp-content/db.php file symlink to be put into place during activation. Set to false to prevent the symlink creation.', 'query-monitor' ),
|
|
'default' => true,
|
|
),
|
|
);
|
|
|
|
/**
|
|
* Filters which PHP constants for configuring Query Monitor are displayed on its settings panel.
|
|
*
|
|
* @since 3.12.0
|
|
*
|
|
* @param array $constants The displayed settings constants.
|
|
* @phpstan-param array<string, array{
|
|
* label: string,
|
|
* default: mixed,
|
|
* }> $constants
|
|
*/
|
|
$constants = apply_filters( 'qm/constants', $constants );
|
|
|
|
echo '<section>';
|
|
echo '<h3>' . esc_html__( 'Configuration', 'query-monitor' ) . '</h3>';
|
|
echo '<p>';
|
|
printf(
|
|
/* translators: %s: Name of the config file */
|
|
esc_html__( 'The following PHP constants can be defined in your %s file in order to control the behavior of Query Monitor:', 'query-monitor' ),
|
|
'<code>wp-config.php</code>'
|
|
);
|
|
echo '</p>';
|
|
|
|
echo '<dl>';
|
|
|
|
foreach ( $constants as $name => $constant ) {
|
|
echo '<dt><code>' . esc_html( $name ) . '</code></dt>';
|
|
echo '<dd>';
|
|
echo esc_html( $constant['label'] );
|
|
|
|
$default_value = $constant['default'];
|
|
if ( is_bool( $default_value ) ) {
|
|
$default_value = ( $default_value ? 'true' : 'false' );
|
|
}
|
|
|
|
echo '<br><span class="qm-info">';
|
|
printf(
|
|
/* translators: %s: Default value for a PHP constant */
|
|
esc_html__( 'Default value: %s', 'query-monitor' ),
|
|
'<code>' . esc_html( (string) $default_value ) . '</code>'
|
|
);
|
|
echo '</span>';
|
|
|
|
if ( defined( $name ) && ( constant( $name ) !== $constant['default'] ) ) {
|
|
$current_value = constant( $name );
|
|
if ( is_bool( $current_value ) ) {
|
|
$current_value = QM_Collector::format_bool_constant( $name );
|
|
}
|
|
|
|
echo '<br><span class="qm-info">';
|
|
printf(
|
|
/* translators: %s: Current value for a PHP constant */
|
|
esc_html__( 'Current value: %s', 'query-monitor' ),
|
|
'<code>' . esc_html( $current_value ) . '</code>'
|
|
);
|
|
echo '</span>';
|
|
}
|
|
echo '</dd>';
|
|
}
|
|
|
|
echo '</dl>';
|
|
echo '</section>';
|
|
|
|
echo '</div>';
|
|
|
|
echo '</div>'; // #qm-settings
|
|
|
|
/**
|
|
* Fires after settings but before the panel closing tag.
|
|
*
|
|
* @since 3.1.0
|
|
*
|
|
* @param QM_Dispatcher_Html $dispatcher The HTML dispatcher instance.
|
|
* @param array<string, QM_Output_Html> $outputters Array of outputters.
|
|
*/
|
|
do_action( 'qm/output/after', $this, $this->outputters );
|
|
|
|
echo '</div>'; // #qm-panels
|
|
echo '</div>'; // #qm-wrapper
|
|
echo '</div>'; // #query-monitor-main
|
|
|
|
echo '<script type="text/javascript">' . "\n\n";
|
|
?>
|
|
window.addEventListener('load', function() {
|
|
var main = document.getElementById( 'query-monitor-main' );
|
|
var broken = document.getElementById( 'qm-broken' );
|
|
var menu_item = document.getElementById( 'wp-admin-bar-query-monitor' );
|
|
var admin_bar = document.getElementById( 'wpadminbar' );
|
|
|
|
if ( ( 'undefined' === typeof QM_i18n ) && ( ( 'undefined' === typeof jQuery ) || ! window.jQuery ) ) {
|
|
/* Fallback for worst case scenario */
|
|
|
|
if ( 'undefined' === typeof QM_i18n ) {
|
|
console.error( 'QM error from page: undefined QM_i18n' );
|
|
}
|
|
|
|
if ( main ) {
|
|
main.className += ' qm-broken';
|
|
}
|
|
|
|
if ( broken ) {
|
|
console.error( broken.textContent );
|
|
}
|
|
|
|
if ( 'undefined' === typeof jQuery ) {
|
|
console.error( 'QM error from page: undefined jQuery' );
|
|
} else if ( ! window.jQuery ) {
|
|
console.error( 'QM error from page: no jQuery' );
|
|
}
|
|
|
|
if ( menu_item && main ) {
|
|
menu_item.addEventListener( 'click', function() {
|
|
main.className += ' qm-show';
|
|
} );
|
|
}
|
|
} else if ( main && ! admin_bar ) {
|
|
main.className += ' qm-peek';
|
|
}
|
|
} );
|
|
<?php
|
|
echo '</script>' . "\n\n";
|
|
echo '<!-- End Query Monitor output -->' . "\n\n";
|
|
|
|
}
|
|
|
|
/**
|
|
* @param mixed $var
|
|
* @return int|Exception
|
|
*/
|
|
public static function size( $var ) {
|
|
$start_memory = memory_get_usage();
|
|
|
|
try {
|
|
$var = unserialize( serialize( $var ) ); // phpcs:ignore
|
|
} catch ( Exception $e ) {
|
|
return $e;
|
|
}
|
|
|
|
return memory_get_usage() - $start_memory - ( PHP_INT_SIZE * 8 );
|
|
}
|
|
|
|
/**
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function js_admin_bar_menu() {
|
|
|
|
/**
|
|
* Filters the CSS class names used on Query Monitor's admin toolbar menu.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $menu_classes Array of menu classes.
|
|
*/
|
|
$class = implode( ' ', apply_filters( 'qm/output/menu_class', array() ) );
|
|
|
|
if ( false === strpos( $class, 'qm-' ) ) {
|
|
$class .= ' qm-all-clear';
|
|
}
|
|
|
|
/**
|
|
* Filters the title used in Query Monitor's admin toolbar menu.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $output_title List of titles.
|
|
*/
|
|
$title = implode( ' ', apply_filters( 'qm/output/title', array() ) );
|
|
|
|
if ( empty( $title ) ) {
|
|
$title = esc_html__( 'Query Monitor', 'query-monitor' );
|
|
}
|
|
|
|
$admin_bar_menu = array(
|
|
'top' => array(
|
|
'title' => sprintf(
|
|
'<span class="ab-icon">QM</span><span class="ab-label">%s</span>',
|
|
$title
|
|
),
|
|
'classname' => $class,
|
|
),
|
|
'sub' => array(),
|
|
);
|
|
|
|
foreach ( $this->admin_bar_menu as $menu ) {
|
|
$admin_bar_menu['sub'][ $menu['id'] ] = $menu;
|
|
}
|
|
|
|
return $admin_bar_menu;
|
|
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public static function request_supported() {
|
|
// Don't dispatch if this is an async request:
|
|
if ( QM_Util::is_async() ) {
|
|
return false;
|
|
}
|
|
|
|
// Don't dispatch during a Customizer preview request:
|
|
if ( function_exists( 'is_customize_preview' ) && is_customize_preview() ) {
|
|
return false;
|
|
}
|
|
|
|
// Don't dispatch during an iframed request, eg the plugin info modal, an upgrader action, or the Customizer:
|
|
if ( defined( 'IFRAME_REQUEST' ) && IFRAME_REQUEST ) {
|
|
return false;
|
|
}
|
|
|
|
// Don't dispatch inside the Site Editor:
|
|
if ( isset( $_SERVER['SCRIPT_NAME'] ) && '/wp-admin/site-editor.php' === $_SERVER['SCRIPT_NAME'] ) {
|
|
return false;
|
|
}
|
|
|
|
// Don't dispatch on the interim login screen:
|
|
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
if ( ! empty( $_GET['interim-login'] ) ) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function is_active() {
|
|
|
|
if ( ! self::user_can_view() ) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! $this->did_footer ) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! self::request_supported() ) {
|
|
return false;
|
|
}
|
|
|
|
// Don't dispatch if the minimum required actions haven't fired:
|
|
if ( is_admin() ) {
|
|
if ( ! did_action( 'admin_init' ) ) {
|
|
return false;
|
|
}
|
|
} else {
|
|
if ( ! ( did_action( 'wp' ) || did_action( 'login_init' ) || did_action( 'gp_head' ) ) ) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/** Back-compat filter. Please use `qm/dispatch/html` instead */
|
|
if ( ! apply_filters( 'qm/process', true, is_admin_bar_showing() ) ) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! file_exists( $this->qm->plugin_path( 'assets/query-monitor.css' ) ) ) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
/**
|
|
* Cease without deactivating the dispatcher.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function cease() {
|
|
$this->ceased = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array<string, QM_Dispatcher> $dispatchers
|
|
* @param QM_Plugin $qm
|
|
* @return array<string, QM_Dispatcher>
|
|
*/
|
|
function register_qm_dispatcher_html( array $dispatchers, QM_Plugin $qm ) {
|
|
$dispatchers['html'] = new QM_Dispatcher_Html( $qm );
|
|
return $dispatchers;
|
|
}
|
|
|
|
add_filter( 'qm/dispatchers', 'register_qm_dispatcher_html', 10, 2 );
|