%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Add small screen with information about queries of WP
*
* @package Debug Queries
* @subpackage Cache
* @author Frank Bültge
* @since 2.0.0
* @version 03/07/2014
*/
if ( ! function_exists( 'add_action' ) ) {
echo "Hi there! I'm just a part of plugin, not much I can do when called directly.";
exit;
}
if ( ! class_exists( 'Debug_Objects_Db_Query' ) ) {
// disable mySQL Session Cache
if ( ! defined( 'QUERY_CACHE_TYPE_OFF' ) ) {
define( 'QUERY_CACHE_TYPE_OFF', TRUE );
}
if ( ! defined( 'SAVEQUERIES' ) ) {
define( 'SAVEQUERIES', TRUE );
}
if ( ! defined( 'STACKTRACE' ) ) {
define( 'STACKTRACE', FALSE );
}
if ( ! defined( 'SQL_FORMATTING' ) ) {
define( 'SQL_FORMATTING', TRUE );
}
if ( SQL_FORMATTING ) {
require_once 'SqlFormatter/SqlFormatter.php';
}
class Debug_Objects_Db_Query extends Debug_Objects {
private static $replaced_functions = array( 'require_once', 'require', 'include', 'include_once' );
private static $replaced_actions = array( 'do_action, call_user_func_array' );
/**
* Stored Backtrace Data from hooked query
*
* @var array
*/
protected $_query = array();
protected $_content_query = array();
/**
* Stored Backtrace Data from global query
*
* @var array
*/
protected $_queries = array();
protected static $classobj = NULL;
/**
* Handler for the action 'init'. Instantiates this class.
*
* @access public
* @return \Debug_Objects_Db_Query|null $classobj
*/
public static function init() {
NULL === self::$classobj and self::$classobj = new self();
return self::$classobj;
}
public function __construct() {
if ( ! current_user_can( '_debug_objects' ) ) {
return;
}
add_filter( 'query', array( $this, 'store_queries' ) );
add_filter( 'debug_objects_tabs', array( $this, 'get_conditional_tab' ) );
}
/**
* Add Tabs and his context to output
*
* @param Array
*
* @return Array
*/
public function get_conditional_tab( $tabs ) {
$tabs[ ] = array(
'tab' => __( 'DB Queries' ),
'function' => array( $this, 'get_queries' )
);
$tabs[ ] = array(
'tab' => __( 'Plugin DB Queries' ),
'function' => array( $this, 'render_wp_plugins_data' )
);
$tabs[ ] = array(
'tab' => __( 'WP_Content DB Queries' ),
'function' => array( $this, 'render_wp_content_data' )
);
return $tabs;
}
/**
* Filters wpdb::query
* This filter stores all queries and their backtraces for later use
*
* @param string $query
*
* @return string
*/
public function store_queries( $query ) {
$trace = debug_backtrace();
array_splice( $trace, 0, 3 ); // Get rid of the tracer's fingerprint (and wpdb::query)
$this->_query[ ] = $this->_content_query[ ] = array(
'query' => $query,
'backtrace' => $trace
);
return $query;
}
/**
* Map Plugins to the queries and create array with data
*
* @return Array All data to query, if is a plugin query
*/
public function validate_wp_plugins_to_query() {
global $wpdb;
// Gather data about existing plugins
$root_data = array();
foreach ( get_plugins() as $filename => $data ) {
list( $root ) = explode( '/', $filename, 2 );
$root_data[ $root ] = array_change_key_case( $data );
}
// set var with query data
$raw_data = $this->_query;
// clear var
$this->_query = array();
$query_counter = 0;
foreach ( $raw_data as $key => $data ) {
foreach ( $data[ 'backtrace' ] as $call ) {
$function_chain[ ] = ( isset( $call[ 'class' ] ) ? "{$call['class']}::"
: '' ) . $call[ 'function' ];
// same strings in local and web envirement
$wp_plugin_dir = str_replace( '\\', '/', WP_PLUGIN_DIR );
if ( ! empty( $call[ 'file' ] ) ) {
$call[ 'file' ] = str_replace( '\\', '/', $call[ 'file' ] );
}
// if is a plugin
if ( ! empty( $call[ 'file' ] )
&& FALSE !== strpos( $call[ 'file' ], $wp_plugin_dir )
&& FALSE === strpos( $call[ 'file' ], 'Debug-Objects' )
) {
// get only the plugin file path, without plugin dir
list( $root ) = explode( '/', plugin_basename( $call[ 'file' ] ), 2 );
$file = str_replace( $wp_plugin_dir, '', $call[ 'file' ] );
// Make sure the array is set up
if ( ! isset( $this->_query[ $root ] ) ) {
$this->_query[ $root ] = $root_data[ $root ];
$this->_query[ $root ][ 'backtrace' ] = array();
}
// Make sure the backtrace for this file is set up
if ( ! isset( $this->_query[ $root ][ 'backtrace' ][ $file ] ) ) {
$this->_query[ $root ][ 'backtrace' ][ $file ] = array();
}
$data[ 'time' ] = 'FALSE';
// add time stamp of query
foreach ( $wpdb->queries as $key => $arr ) {
if ( FALSE !== strpos( $arr[ 0 ], $data[ 'query' ] ) ) {
$data[ 'time' ] = $arr[ 1 ];
}
}
// Save parsed data
$this->_query[ $root ][ 'backtrace' ][ $file ][ ] = array(
'line' => $call[ 'line' ],
'query' => $data[ 'query' ],
'time' => $data[ 'time' ],
'function_chain' => array_reverse( $function_chain ),
);
// add 1 to query counter
$query_counter ++;
}
}
}
// sorting
usort( $this->_query, array( $this, 'sort_by_name' ) );
$this->_query[ 'query_count' ] = $query_counter;
return $this->_query;
}
/**
* Map Queries from wp-content, typical from Theme, and create array with data
*
* @return Array All data to query, if is a query from wp-content
*/
public function validate_wp_content_to_query() {
global $wpdb;
// set var with query data
$raw_data = $this->_content_query;
// clear var
$this->_content_query = array();
$query_counter = 0;
foreach ( $raw_data as $key => $data ) {
foreach ( $data[ 'backtrace' ] as $call ) {
$function_chain[ ] = ( isset( $call[ 'class' ] ) ? "{$call['class']}::"
: '' ) . $call[ 'function' ];
// Same strings in local and web envirement
$wp_content_dir = str_replace( '\\', '/', WP_CONTENT_DIR );
// Same strings in local and web envirement
if ( ! empty( $call[ 'file' ] ) ) {
$call[ 'file' ] = str_replace( '\\', '/', $call[ 'file' ] );
}
// If is a part from wp-content
if ( ! empty( $call[ 'file' ] )
&& FALSE !== strpos( $call[ 'file' ], $wp_content_dir )
) {
$data[ 'time' ] = 'FALSE';
// add time stamp of query
foreach ( $wpdb->queries as $key => $arr ) {
if ( FALSE !== strpos( $arr[ 0 ], $data[ 'query' ] ) ) {
$data[ 'time' ] = $arr[ 1 ];
}
}
// Save parsed data
$this->_content_query[ ] = array(
'file' => $call[ 'file' ],
'line' => $call[ 'line' ],
'function' => $call[ 'function' ],
'query' => $data[ 'query' ],
'time' => $data[ 'time' ],
'function_chain' => array_reverse( $function_chain ),
);
// add 1 to query counter
$query_counter ++;
}
}
}
$this->_content_query[ 'query_count' ] = $query_counter;
return $this->_content_query;
}
/**
* Render tracer's data
*
* @param array $data
*/
public function render_wp_plugins_data( $data = NULL ) {
if ( NULL === $data ) {
$data = $this->validate_wp_plugins_to_query();
}
$plugin_count = count( $data ) - 1;
$output = '';
$output .= '<ul>' . "\n";
$output .= '<li><strong>' . __( 'Plugins Total:' ) . ' '
. $plugin_count . ' ' . '</strong></li>' . "\n";
$output .= '<li><strong>' . __( 'Queries Total:' ) . ' ' . $data[ 'query_count' ] . '</strong></li>' . "\n";
$output .= '</ul><hr />' . "\n";
// remove counter, not necassary from here
unset( $data[ 'query_count' ] );
$output .= '<ol>' . "\n";
$x = 1;
foreach ( $data as $plugin_data ) {
$output .= '<li><a href="#anker_' . $x . '">'
. $plugin_data[ 'name' ] . '</a></li>' . "\n";
$x ++;
}
$output .= '</ol><hr />' . "\n";
$x = 1;
foreach ( $data as $plugin_data ) {
$output .= '<h1 id="anker_' . $x . '">' . $x . '. ' . __(
'Plugin:'
) . ' ' . $plugin_data[ 'name' ] . '</h1>' . "\n";
foreach ( $plugin_data[ 'backtrace' ] as $filename => $data ) {
$filename = htmlspecialchars( $filename );
$output .= sprintf(
'<p><code>%s</code></p>
<table class="tablesorter">
<thead>
<tr>
<th>%s</th>
<th>%s</th>
</tr>
</thead>',
htmlspecialchars( $filename ),
__( 'Line' ),
__( 'Query & Function Chain' )
);
$class = '';
foreach ( $data as $query ) {
$class = ( ' class="alternate"' == $class ) ? '' : ' class="alternate"';
// format the query
$formatted_query = $query[ 'query' ];
if ( class_exists( 'SqlFormatter' ) ) {
$formatted_query = SqlFormatter::highlight( $formatted_query );
}
$query[ 'query' ] =
number_format_i18n( sprintf( '%0.1f', $query[ 'time' ] * 1000 ), 1 ) . __( 'ms' )
. ' (' . $query[ 'time' ] . __( 's)' )
. '<br><code>' . $formatted_query . '</code>';
// build function chain/backtrace
$function_chain = implode( ' → ', $query[ 'function_chain' ] );
$output .= '<tr' . $class . '>
<td>' . $query[ 'line' ] . '</td>
<td>' . $query[ 'query' ] . '</td>
</tr>';
if ( STACKTRACE ) {
$output .=
"<tr>
<td></td>
<td>$function_chain</td>
</tr>";
}
}
$output .= '</table>' . "\n";
}
$x ++;
}
echo $output;
}
/**
* Render tracer's data
*
* @param array $data
*/
public function render_wp_content_data( $data = NULL ) {
if ( NULL === $data ) {
$data = $this->validate_wp_content_to_query();
}
$output = '';
$output .= '<ul>' . "\n";
$output .= '<li><strong>' . __( 'Queries Total:' ) . ' ' . $data[ 'query_count' ] . '</strong></li>' . "\n";
$output .= '</ul><hr />' . "\n";
if ( 0 === $data[ 'query_count' ] ) {
$output .= __( 'No queries from wp-content.' );
}
if ( 0 !== $data[ 'query_count' ] ) {
// remove counter, not necassary from here
unset( $data[ 'query_count' ] );
$output .= '<ol>' . "\n";
$x = 1;
foreach ( $data as $content_data ) {
$output .= '<li><a href="#content_anker_' . $x . '">'
. $content_data[ 'function' ] . '</a></li>' . "\n";
$x ++;
}
$output .= '</ol><hr />' . "\n";
$x = 1;
$class = '';
foreach ( $data as $content_data ) {
$class = ( ' class="alternate"' == $class ) ? '' : ' class="alternate"';
$output .= '<h1 id="content_anker_' . $x . '">' . $x . '. ' . __(
'Function:'
) . ' ' . $content_data[ 'function' ] . '</h1>' . "\n";
$filename = htmlspecialchars( $content_data[ 'file' ] );
$output .= sprintf(
'<p><code>%s</code></p>
<table class="tablesorter">
<thead>
<tr>
<th>%s</th>
<th>%s</th>
</tr>
</thead>',
htmlspecialchars( $filename ),
__( 'Line' ),
__( 'Query & Function Chain' )
);
// format the query
$formatted_query = $content_data[ 'query' ];
if ( class_exists( 'SqlFormatter' ) ) {
$formatted_query = SqlFormatter::highlight( $formatted_query );
}
$content_data[ 'query' ] =
number_format_i18n( sprintf( '%0.1f', $content_data[ 'time' ] * 1000 ), 1 ) . __( 'ms' )
. ' (' . $content_data[ 'time' ] . __( 's)' )
. '<br><code>' . $formatted_query . '</code>';
// build function chain/backtrace
$function_chain = implode( ' → ', $content_data[ 'function_chain' ] );
$output .= '<tr' . $class . '>
<td>' . $content_data[ 'line' ] . '</td>
<td>' . $content_data[ 'query' ] . '</td>
</tr>';
if ( STACKTRACE ) {
$output .=
"<tr>
<td></td>
<td>$function_chain</td>
</tr>";
}
$output .= '</table>' . "\n";
$x ++;
}
}
echo $output;
}
/**
* Faux-private function for sorting data
*
* @param array $a
* @param array $b
*
* @return integer
*/
public function sort_by_name( $a, $b ) {
return strcmp( $a[ 'name' ], $b[ 'name' ] );
}
/**
* Get queries about the globals, incl. all queries
* Format the queries for readable output
*
* @param bool $echo Default is True, Use FALSE for return data
* @param int $sorting
*
* @return Mixed , Use SORT_DESC, SORT_ASC for Sorting direction; Use FALSE for deactivate the sorting
* @internal param $String
*/
public function get_queries( $echo = TRUE, $sorting = SORT_DESC ) {
global $wpdb, $EZSQL_ERROR;
$wpdb->flush();
// @see http://www.mysqlfaqs.net/mysql-faqs/Speed-Up-Queries/What-is-query-cache-in-MySQL
// Disable query cache for current client
if ( QUERY_CACHE_TYPE_OFF ) {
mysql_query( "SET SESSION query_cache_type = OFF" );
}
// return php warnings on the default Wpd-query
//$wpdb->query( "SET SESSION query_cache_type = OFF;" );
// save all queries in var
$this->_queries = $wpdb->queries;
$debug_queries = '';
$total_query_time = 0;
$x = 0;
$total_time = timer_stop( 0, 22 );
$total_query_time = 0;
$class = '';
if ( ! empty( $this->_queries ) ) {
$php_time = $total_time - $total_query_time;
// Create the percentages
if ( 0 < $total_time ) {
$mysqlper = number_format_i18n( $total_query_time / $total_time * 100, 2 );
$phpper = number_format_i18n( $php_time / $total_time * 100, 2 );
}
$debug_queries .= '<h3>' . __( 'Queries' ) . '</h3>';
$debug_queries .= '<ul>' . "\n";
$debug_queries .= '<li><strong>' . __( 'Total:' ) . ' '
. count( $this->_queries ) . ' ' . __( 'queries' )
. '</strong></li>';
$debug_queries .= '<li><strong>' . __( 'Page generated in' ) . ' '
. number_format_i18n( sprintf( '%0.1f', $total_time * 1000 ), 1 ) . __( 'ms ( ' )
. timer_stop() . __( 's' ) . ' )</strong></li>';
if ( count( $this->_queries ) != get_num_queries() ) {
$debug_queries .= '<li><strong>' . __( 'Total:' ) . ' '
. get_num_queries() . ' '
. __( 'num_queries.' ) . '</strong></li>' . "\n";
$debug_queries .= '<li>'
. __( '» Different values in num_query and query? - please set the constant' )
. ' <code>define( \'SAVEQUERIES\', TRUE );</code>' . __(
'in your'
) . ' <code>wp-config.php</code></li>' . "\n";
}
$debug_queries .= '</ul>' . "\n";
// Database errors
$debug_queries .= '<hr /><h3>' . __( 'Database Errors' ) . '</h3>';
if ( ! empty( $EZSQL_ERROR ) ) {
$debug_queries .= '<ol>';
foreach ( $EZSQL_ERROR as $e ) {
$query = nl2br( esc_html( $e[ 'query' ] ) );
$debug_queries .= "<li>$query<br/><div class='qdebug'>{$e['error_str']}</div></li>\n";
}
$debug_queries .= '</ol>';
} else {
$debug_queries .= '<ul><li>' . __( 'No database errors.' ) . '</li></ul>';
}
$debug_queries .= '<hr /><ol>' . "\n";
/**
* Hook to filter the queries array
*
* @since 09/13/13
*/
$this->_queries = apply_filters(
'debug_objects_sort_queries', $this->_queries, $sorting
);
foreach ( $this->_queries as $key => $row ) {
$queries[ $key ] = $row[ 0 ];
}
array_multisort( $queries, $sorting, $this->_queries );
foreach ( $this->_queries as $q ) {
$time = $q[ 1 ];
$time_ms = number_format( sprintf( '%0.1f', $time * 1000 ), 1, '.', ',' );
if ( '0.5' <= $time_ms ) {
$class = ' high_query_time';
} elseif ( '1.' <= $time_ms ) {
$class = ' big_query_time';
} else {
$class = '';
}
if ( $x % 2 != 0 ) {
$class = ' class="default' . $class . '"';
} else {
$class = ' class="alternate' . $class . '"';
}
$total_query_time += $time;
$debug_queries .= '<li' . $class . '><ul>';
$debug_queries .= '<li><strong>'
. __( 'Time:' ) . '</strong> '
. $time_ms . __( 'ms' )
. ' (' . $time . __( 's' ) . ')</li>';
if ( isset( $time ) ) {
$s = nl2br( $q[ 0 ] );
$s = trim( preg_replace( '/[[:space:]]+/', ' ', $s ) );
// format the query
if ( class_exists( 'SqlFormatter' ) ) {
$s = SqlFormatter::highlight( $s );
}
$debug_queries .= '<li><strong>'
. __( 'Query:' ) . '</strong> <code>'
. $s . '</code></li>';
}
if ( isset( $q[ 2 ] ) && ! empty( $q[ 2 ] ) ) {
$st = explode( ', ', $q[ 2 ] );
$st_array = array_diff( $st, self::$replaced_functions );
foreach ( $st_array as $s ) {
$markup_st[ ] = '<code>' . esc_html( $s ) . '</code>';
}
if ( ! STACKTRACE ) {
$debug_queries .= '<li><strong>Function:</strong> <code>'
. end( $st_array ) . '()</code></li>';
} else {
$st = implode( ', ', $markup_st );
$st = str_replace( self::$replaced_actions, array( 'do_action' ), $st );
$debug_queries .= '<li><strong>'
. '<a href="http://en.wikipedia.org/wiki/Stack_trace">Stack trace</a>:</strong> '
. $st . '</li>';
}
}
$debug_queries .= '</ul></li>' . "\n";
$x ++;
}
$debug_queries .= '</ol>' . "\n\n";
}
$php_time = $total_time - $total_query_time;
// Create the percentages
if ( 0 < $total_time ) {
$mysqlper = number_format_i18n( $total_query_time / $total_time * 100, 2 );
$phpper = number_format_i18n( $php_time / $total_time * 100, 2 );
}
$debug_queries .= '<ul>' . "\n";
$debug_queries .= '<li><strong>' . __( 'Total query time:' ) . ' '
. number_format_i18n( sprintf( '%0.1f', $total_query_time * 1000 ), 1 )
. __( 'ms for' ) . ' ' . count( $this->_queries ) . ' ' . __( 'queries (' )
. number_format_i18n( $total_query_time, 15 ) . __( 's) ' ) . '</strong></li>';
if ( count( $this->_queries ) != get_num_queries() ) {
$debug_queries .= '<li><strong>' . __( 'Total num_query time:' ) . ' '
. timer_stop() . ' ' . __( 'for' ) . ' ' . get_num_queries() . ' '
. __( 'num_queries.' ) . '</strong></li>' . "\n";
$debug_queries .= '<li>'
. __( '» Different values in num_query and query? - please set the constant' )
. ' <code>define( \'SAVEQUERIES\', TRUE );</code>' . __(
'in your'
) . ' <code>wp-config.php</code></li>' . "\n";
}
if ( $total_query_time == 0 ) {
$debug_queries .= '<li>' . __( '» Query time is null (0)? - please set the constant' )
. ' <code>SAVEQUERIES</code>' . ' ' . __( 'at' ) . ' <code>TRUE</code> ' . __( 'in your' )
. ' <code>wp-config.php</code></li>' . "\n";
}
if ( 0 < $total_time ) {
$debug_queries .= '<li>' . __( 'Page generated in' ) . ' '
. number_format_i18n( sprintf( '%0.1f', $total_time * 1000 ), 1 ) . __( 'ms; (' )
. $total_time . __( 's); ' )
. $phpper . __( '% PHP' ) . '; ' . $mysqlper
. __( '% MySQL' ) . '</li>' . "\n";
}
$debug_queries .= '</ul>' . "\n";
if ( $echo ) {
echo $debug_queries;
}
return $debug_queries;
}
} // end class
}// end if class exists
Zerion Mini Shell 1.0