245 lines
		
	
	
		
			6.1 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			245 lines
		
	
	
		
			6.1 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php declare(strict_types = 1);
 | 
						|
/**
 | 
						|
 * Timing and profiling output for HTML pages.
 | 
						|
 *
 | 
						|
 * @package query-monitor
 | 
						|
 */
 | 
						|
 | 
						|
if ( ! defined( 'ABSPATH' ) ) {
 | 
						|
	exit;
 | 
						|
}
 | 
						|
 | 
						|
class QM_Output_Html_Timing extends QM_Output_Html {
 | 
						|
 | 
						|
	/**
 | 
						|
	 * Collector instance.
 | 
						|
	 *
 | 
						|
	 * @var QM_Collector_Timing Collector.
 | 
						|
	 */
 | 
						|
	protected $collector;
 | 
						|
 | 
						|
	public function __construct( QM_Collector $collector ) {
 | 
						|
		parent::__construct( $collector );
 | 
						|
		add_filter( 'qm/output/menus', array( $this, 'admin_menu' ), 46 );
 | 
						|
	}
 | 
						|
 | 
						|
	/**
 | 
						|
	 * @return string
 | 
						|
	 */
 | 
						|
	public function name() {
 | 
						|
		return __( 'Timing', 'query-monitor' );
 | 
						|
	}
 | 
						|
 | 
						|
	/**
 | 
						|
	 * @return void
 | 
						|
	 */
 | 
						|
	public function output() {
 | 
						|
		/** @var QM_Data_Timing $data */
 | 
						|
		$data = $this->collector->get_data();
 | 
						|
 | 
						|
		if ( empty( $data->timing ) && empty( $data->warning ) ) {
 | 
						|
			$this->before_non_tabular_output();
 | 
						|
 | 
						|
			$notice = sprintf(
 | 
						|
				/* translators: %s: Link to help article */
 | 
						|
				__( 'No data logged. <a href="%s">Read about timing and profiling in Query Monitor</a>.', 'query-monitor' ),
 | 
						|
				'https://querymonitor.com/blog/2018/07/profiling-and-logging/'
 | 
						|
			);
 | 
						|
			echo $this->build_notice( $notice ); // WPCS: XSS ok.
 | 
						|
 | 
						|
			$this->after_non_tabular_output();
 | 
						|
 | 
						|
			return;
 | 
						|
		}
 | 
						|
 | 
						|
		$this->before_tabular_output();
 | 
						|
 | 
						|
		echo '<thead>';
 | 
						|
		echo '<tr>';
 | 
						|
		echo '<th scope="col">' . esc_html__( 'Tracked Function', 'query-monitor' ) . '</th>';
 | 
						|
		echo '<th scope="col" class="qm-num">' . esc_html__( 'Started', 'query-monitor' ) . '</th>';
 | 
						|
		echo '<th scope="col" class="qm-num">' . esc_html__( 'Stopped', 'query-monitor' ) . '</th>';
 | 
						|
		echo '<th scope="col" class="qm-num">' . esc_html__( 'Time', 'query-monitor' ) . '</th>';
 | 
						|
		echo '<th scope="col" class="qm-num">' . esc_html__( 'Memory', 'query-monitor' ) . '</th>';
 | 
						|
		echo '<th scope="col">' . esc_html__( 'Component', 'query-monitor' ) . '</th>';
 | 
						|
		echo '</tr>';
 | 
						|
		echo '</thead>';
 | 
						|
 | 
						|
		echo '<tbody>';
 | 
						|
 | 
						|
		if ( ! empty( $data->timing ) ) {
 | 
						|
			foreach ( $data->timing as $row ) {
 | 
						|
 | 
						|
				$component = $row['component'];
 | 
						|
				$trace = $row['filtered_trace'];
 | 
						|
				$file = self::output_filename( $row['function'], $trace[0]['file'], $trace[0]['line'] );
 | 
						|
 | 
						|
				echo '<tr>';
 | 
						|
 | 
						|
				if ( self::has_clickable_links() ) {
 | 
						|
					echo '<td class="qm-ltr">';
 | 
						|
					echo $file; // WPCS: XSS ok.
 | 
						|
					echo '</td>';
 | 
						|
				} else {
 | 
						|
					echo '<td class="qm-ltr qm-has-toggle">';
 | 
						|
					echo self::build_toggler(); // WPCS: XSS ok;
 | 
						|
					echo '<ol>';
 | 
						|
					echo '<li>';
 | 
						|
					echo $file; // WPCS: XSS ok.
 | 
						|
					echo '</li>';
 | 
						|
					echo '</ol></td>';
 | 
						|
				}
 | 
						|
 | 
						|
				printf(
 | 
						|
					'<td class="qm-num">%s</td>',
 | 
						|
					esc_html( number_format_i18n( $row['start_time'], 4 ) )
 | 
						|
				);
 | 
						|
 | 
						|
				printf(
 | 
						|
					'<td class="qm-num">%s</td>',
 | 
						|
					esc_html( number_format_i18n( $row['end_time'], 4 ) )
 | 
						|
				);
 | 
						|
 | 
						|
				printf(
 | 
						|
					'<td class="qm-num">%s</td>',
 | 
						|
					esc_html( number_format_i18n( $row['function_time'], 4 ) )
 | 
						|
				);
 | 
						|
 | 
						|
				$mem = sprintf(
 | 
						|
					/* translators: %s: Approximate memory used in kilobytes */
 | 
						|
					__( '~%s kB', 'query-monitor' ),
 | 
						|
					number_format_i18n( $row['function_memory'] / 1024 )
 | 
						|
				);
 | 
						|
				printf(
 | 
						|
					'<td class="qm-num">%s</td>',
 | 
						|
					esc_html( $mem )
 | 
						|
				);
 | 
						|
				printf(
 | 
						|
					'<td class="qm-nowrap">%s</td>',
 | 
						|
					esc_html( $component->name )
 | 
						|
				);
 | 
						|
 | 
						|
				echo '</tr>';
 | 
						|
 | 
						|
				if ( ! empty( $row['laps'] ) ) {
 | 
						|
					foreach ( $row['laps'] as $lap_id => $lap ) {
 | 
						|
						echo '<tr>';
 | 
						|
 | 
						|
						echo '<td class="qm-ltr"><code>— ';
 | 
						|
						echo esc_html( $row['function'] . ': ' . $lap_id );
 | 
						|
						echo '</code></td>';
 | 
						|
 | 
						|
						echo '<td class="qm-num"></td>';
 | 
						|
						echo '<td class="qm-num"></td>';
 | 
						|
 | 
						|
						printf(
 | 
						|
							'<td class="qm-num">%s</td>',
 | 
						|
							esc_html( number_format_i18n( $lap['time_used'], 4 ) )
 | 
						|
						);
 | 
						|
 | 
						|
						$mem = sprintf(
 | 
						|
							/* translators: %s: Approximate memory used in kilobytes */
 | 
						|
							__( '~%s kB', 'query-monitor' ),
 | 
						|
							number_format_i18n( $lap['memory_used'] / 1024 )
 | 
						|
						);
 | 
						|
						printf(
 | 
						|
							'<td class="qm-num">%s</td>',
 | 
						|
							esc_html( $mem )
 | 
						|
						);
 | 
						|
						echo '<td class="qm-nowrap"></td>';
 | 
						|
 | 
						|
						echo '</tr>';
 | 
						|
					}
 | 
						|
				}
 | 
						|
			}
 | 
						|
		}
 | 
						|
 | 
						|
		if ( ! empty( $data->warning ) ) {
 | 
						|
			foreach ( $data->warning as $row ) {
 | 
						|
				$component = $row['component'];
 | 
						|
				$trace = $row['filtered_trace'];
 | 
						|
				$file = self::output_filename( $row['function'], $trace[0]['file'], $trace[0]['line'] );
 | 
						|
 | 
						|
				echo '<tr class="qm-warn">';
 | 
						|
				if ( self::has_clickable_links() ) {
 | 
						|
					echo '<td class="qm-ltr">';
 | 
						|
					echo $file; // WPCS: XSS ok.
 | 
						|
					echo '</td>';
 | 
						|
				} else {
 | 
						|
					echo '<td class="qm-ltr qm-has-toggle">';
 | 
						|
					echo self::build_toggler(); // WPCS: XSS ok;
 | 
						|
					echo '<ol>';
 | 
						|
					echo '<li>';
 | 
						|
					echo $file; // WPCS: XSS ok.
 | 
						|
					echo '</li>';
 | 
						|
					echo '</ol></td>';
 | 
						|
				}
 | 
						|
 | 
						|
				printf(
 | 
						|
					'<td colspan="4">%1$s%2$s</td>',
 | 
						|
					// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 | 
						|
					QueryMonitor::icon( 'warning' ),
 | 
						|
					esc_html( $row['message'] )
 | 
						|
				);
 | 
						|
 | 
						|
				printf(
 | 
						|
					'<td class="qm-nowrap">%s</td>',
 | 
						|
					esc_html( $component->name )
 | 
						|
				);
 | 
						|
			}
 | 
						|
		}
 | 
						|
 | 
						|
		echo '</tbody>';
 | 
						|
 | 
						|
		$this->after_tabular_output();
 | 
						|
	}
 | 
						|
 | 
						|
	/**
 | 
						|
	 * @param array<string, mixed[]> $menu
 | 
						|
	 * @return array<string, mixed[]>
 | 
						|
	 */
 | 
						|
	public function admin_menu( array $menu ) {
 | 
						|
		/** @var QM_Data_Timing $data */
 | 
						|
		$data = $this->collector->get_data();
 | 
						|
		$count = 0;
 | 
						|
 | 
						|
		if ( ! empty( $data->timing ) || ! empty( $data->warning ) ) {
 | 
						|
			if ( ! empty( $data->timing ) ) {
 | 
						|
				$count += count( $data->timing );
 | 
						|
			}
 | 
						|
			if ( ! empty( $data->warning ) ) {
 | 
						|
				$count += count( $data->warning );
 | 
						|
			}
 | 
						|
			/* translators: %s: Number of function timing results that are available */
 | 
						|
			$label = __( 'Timings (%s)', 'query-monitor' );
 | 
						|
		} else {
 | 
						|
			$label = __( 'Timings', 'query-monitor' );
 | 
						|
		}
 | 
						|
 | 
						|
		$menu[ $this->collector->id() ] = $this->menu( array(
 | 
						|
			'title' => esc_html( sprintf(
 | 
						|
				$label,
 | 
						|
				number_format_i18n( $count )
 | 
						|
			) ),
 | 
						|
		) );
 | 
						|
 | 
						|
		return $menu;
 | 
						|
	}
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
 * @param array<string, QM_Output> $output
 | 
						|
 * @param QM_Collectors $collectors
 | 
						|
 * @return array<string, QM_Output>
 | 
						|
 */
 | 
						|
function register_qm_output_html_timing( array $output, QM_Collectors $collectors ) {
 | 
						|
	$collector = QM_Collectors::get( 'timing' );
 | 
						|
	if ( $collector ) {
 | 
						|
		$output['timing'] = new QM_Output_Html_Timing( $collector );
 | 
						|
	}
 | 
						|
	return $output;
 | 
						|
}
 | 
						|
 | 
						|
add_filter( 'qm/outputter/html', 'register_qm_output_html_timing', 15, 2 );
 |