Jetpack_Import_Stats::get_calling_class() - Code Metrics - Inspection of "Start at the next item in the stack" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/importer-stats ( 7e9415...6df637 )

unknown

created 2019-03-07 21:30 UTC

Jetpack_Import_Stats::get_calling_class() B

↳ Parent: Jetpack_Import_Stats

Complexity

Conditions	10
Paths	21

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
nc	21
nop	0
dl	0
loc	42
rs	7.6666
c	0
b	0
f	0

How to fix Complexity

<?php

class Jetpack_Import_Stats {
	static $known_importers = array(
		'Blogger_Importer' => 'blogger',
		'LJ_API_Import' => 'livejournal',
		'MT_Import' => 'mt',
		'RSS_Import' => 'rss',
		'WP_Import' => 'wordpress',
	);

	static $action_event_name_map = array(
		'import_start' => 'jetpack_import_start',
		'import_done'  => 'jetpack_import_done',
		'import_end'   => 'jetpack_import_done',
	);

	public static function init() {
		// Only handle import actions for sites that have agreed to TOS 
		if ( Jetpack::jetpack_tos_agreed() ) {
			add_action( 'import_start', array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
			add_action( 'import_done',  array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
			add_action( 'import_end',   array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
		}
	}

	private static function get_calling_class() {
		// If WP_Importer doesn't exist, neither will any importer that extends it
		if ( ! class_exists( 'WP_Importer' ) ){
			return 'unknown';
		}

		$action = current_filter();
		$backtrace = wp_debug_backtrace_summary( null, 0, false );

		$do_action_pos = -1;
		for ( $i = 0; $i < count( $backtrace ); $i++ ) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			// Find the location in the stack of the calling action
			if ( preg_match( "/^do_action\\(\'([^\']+)/", $backtrace[ $i ], $matches ) ) {
				if ( $matches[1] === $action ) {
					$do_action_pos = $i;
					break;
				}
			}
		}

		// if the action wasn't called, the calling class is unknown
		if ( -1 === $do_action_pos ) {
			return 'unknown';
		}

		// continue iterating the stack looking for a caller that extends WP_Import
		for ( $i = $do_action_pos + 1; $i < count( $backtrace ); $i++ ) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			// grab only class_name from the trace
			list( $class_name ) = explode( '->', $backtrace[ $i ] );

			// check if the class extends WP_Importer
			if ( class_exists( $class_name ) ) {
				$parents = class_parents( $class_name );
				if ( $parents && in_array( 'WP_Importer', $parents ) ) {

					return $class_name;
				}
			}
		}

		// If we've exhausted the stack without a match, the calling class is unknown
		return 'unknown';
	}

	public static function log_import_progress( $importer ) {
		// prefer self-reported importer-names
		if ( ! $importer ) {
			// fall back to inferring by calling class name
			$importer = self::get_calling_class();
		}
		
		// Give known importers a "friendly" name
		if ( isset( self::$known_importers[ $importer ] ) ) {
			$importer = self::$known_importers[ $importer ];
		}
		$action = current_filter();
		// map action to event name
		$event_name = self::$action_event_name_map[ $action ];
		
		$current_user = wp_get_current_user();

		// Record event to Tracks
		jetpack_tracks_record_event( $current_user, $event_name, array(
			'importer' => $importer,
		) );
	}
}

add_action( 'init', array( 'Jetpack_Import_Stats', 'init' ) );


1			<?php
2
3			class Jetpack_Import_Stats {
4			static $known_importers = array(
5			'Blogger_Importer' => 'blogger',
6			'LJ_API_Import' => 'livejournal',
7			'MT_Import' => 'mt',
8			'RSS_Import' => 'rss',
9			'WP_Import' => 'wordpress',
10			);
11
12			static $action_event_name_map = array(
13			'import_start' => 'jetpack_import_start',
14			'import_done' => 'jetpack_import_done',
15			'import_end' => 'jetpack_import_done',
16			);
17
18			public static function init() {
19			// Only handle import actions for sites that have agreed to TOS
20			if ( Jetpack::jetpack_tos_agreed() ) {
21			add_action( 'import_start', array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
22			add_action( 'import_done', array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
23			add_action( 'import_end', array( 'Jetpack_Import_Stats', 'log_import_progress' ) );
24			}
25			}
26
27			private static function get_calling_class() {
28			// If WP_Importer doesn't exist, neither will any importer that extends it
29			if ( ! class_exists( 'WP_Importer' ) ){
30			return 'unknown';
31			}
32
33			$action = current_filter();
34			$backtrace = wp_debug_backtrace_summary( null, 0, false );
35
36			$do_action_pos = -1;
37			for ( $i = 0; $i < count( $backtrace ); $i++ ) {
			0 ignored issues – show Performance Best Practice introduced 2019-03-07 20:14 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
38			// Find the location in the stack of the calling action
39			if ( preg_match( "/^do_action\\(\'([^\']+)/", $backtrace[ $i ], $matches ) ) {
40			if ( $matches[1] === $action ) {
41			$do_action_pos = $i;
42			break;
43			}
44			}
45			}
46
47			// if the action wasn't called, the calling class is unknown
48			if ( -1 === $do_action_pos ) {
49			return 'unknown';
50			}
51
52			// continue iterating the stack looking for a caller that extends WP_Import
53			for ( $i = $do_action_pos + 1; $i < count( $backtrace ); $i++ ) {
			0 ignored issues – show Performance Best Practice introduced 2019-03-07 21:40 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
54			// grab only class_name from the trace
55			list( $class_name ) = explode( '->', $backtrace[ $i ] );
56
57			// check if the class extends WP_Importer
58			if ( class_exists( $class_name ) ) {
59			$parents = class_parents( $class_name );
60			if ( $parents && in_array( 'WP_Importer', $parents ) ) {
			0 ignored issues – show Bug Best Practice introduced 2019-03-07 21:40 UTC by Report Bug Copy Issue Report The expression `$parents` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
61			return $class_name;
62			}
63			}
64			}
65
66			// If we've exhausted the stack without a match, the calling class is unknown
67			return 'unknown';
68			}
69
70			public static function log_import_progress( $importer ) {
71			// prefer self-reported importer-names
72			if ( ! $importer ) {
73			// fall back to inferring by calling class name
74			$importer = self::get_calling_class();
75			}
76
77			// Give known importers a "friendly" name
78			if ( isset( self::$known_importers[ $importer ] ) ) {
79			$importer = self::$known_importers[ $importer ];
80			}
81			$action = current_filter();
82			// map action to event name
83			$event_name = self::$action_event_name_map[ $action ];
84
85			$current_user = wp_get_current_user();
86
87			// Record event to Tracks
88			jetpack_tracks_record_event( $current_user, $event_name, array(
89			'importer' => $importer,
90			) );
91			}
92			}
93
94			add_action( 'init', array( 'Jetpack_Import_Stats', 'init' ) );
95

Automattic / jetpack

Push — add/importer-stats ( 7e9415...6df637 )

Jetpack_Import_Stats::get_calling_class() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like