WC_Admin_Status - Code Metrics - Inspection of "System Status Tools API" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11647)

unknown

created 2016-08-08 18:33 UTC

WC_Admin_Status B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	236
Duplicated Lines	8.05 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	19
loc	236
rs	8.3999
wmc	46
lcom	1
cbo	2

11 Methods

Rating	Name	Duplication	Size	Complexity
A	output()	0	3	1
A	status_report()	0	3	1
B	status_tools()	0	23	6
A	get_tools()	0	4	1
B	status_logs()	0	18	6
B	get_file_version()	0	25	4
A	get_log_file_handle()	0	3	2
B	scan_template_files()	0	24	6
B	scan_log_files()	0	19	6
D	get_latest_theme_version()	16	43	9
A	remove_log()	3	13	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like WC_Admin_Status often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use WC_Admin_Status, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Debug/Status page
 *
 * @author      WooThemes
 * @category    Admin
 * @package     WooCommerce/Admin/System Status
 * @version     2.2.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * WC_Admin_Status Class.
 */
class WC_Admin_Status {

	/**
	 * Handles output of the reports page in admin.
	 */
	public static function output() {
		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status.php' );
	}

	/**
	 * Handles output of report.
	 */
	public static function status_report() {
		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status-report.php' );
	}

	/**
	 * Handles output of tools.
	 */
	public static function status_tools() {
		global $wpdb;

		$tools = self::get_tools();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		if ( ! empty( $_GET['action'] ) && ! empty( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( $_REQUEST['_wpnonce'], 'debug_action' ) ) {
			$tools_controller = new WC_REST_System_Status_Tools_Controller;
			$response = $tools_controller->execute_tool( $_GET['action'] );

			if ( $response['success'] ) {
				echo '<div class="updated inline"><p>' . $response['message'] . '</p></div>';
			} else {
				echo '<div class="error inline"><p>' . $response['message'] . '</p></div>';
			}
		}

		// Display message if settings settings have been saved
		if ( isset( $_REQUEST['settings-updated'] ) ) {
			echo '<div class="updated inline"><p>' . __( 'Your changes have been saved.', 'woocommerce' ) . '</p></div>';
		}

		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status-tools.php' );
	}

	/**
	 * Get tools.
	 * @return array of tools
	 */
	public static function get_tools() {
		$tools_controller = new WC_REST_System_Status_Tools_Controller;
		return $tools_controller->get_tools();
	}

	/**
	 * Show the logs page.
	 */
	public static function status_logs() {

		$logs = self::scan_log_files();

		if ( ! empty( $_REQUEST['log_file'] ) && isset( $logs[ sanitize_title( $_REQUEST['log_file'] ) ] ) ) {
			$viewed_log = $logs[ sanitize_title( $_REQUEST['log_file'] ) ];
		} elseif ( ! empty( $logs ) ) {
			$viewed_log = current( $logs );
		}

		$handle = ! empty( $viewed_log ) ? self::get_log_file_handle( $viewed_log ) : '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		if ( ! empty( $_REQUEST[ 'handle' ] ) ) {
			self::remove_log();
		}

		include_once( 'views/html-admin-page-status-logs.php' );
	}

	/**
	 * Retrieve metadata from a file. Based on WP Core's get_file_data function.
	 * @since  2.1.1
	 * @param  string $file Path to the file
	 * @return string
	 */
	public static function get_file_version( $file ) {

		// Avoid notices if file does not exist
		if ( ! file_exists( $file ) ) {
			return '';
		}

		// We don't need to write to the file, so just open for reading.
		$fp = fopen( $file, 'r' );

		// Pull only the first 8kiB of the file in.
		$file_data = fread( $fp, 8192 );

		// PHP will close file handle, but we are good citizens.
		fclose( $fp );

		// Make sure we catch CR-only line endings.
		$file_data = str_replace( "\r", "\n", $file_data );
		$version   = '';

		if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( '@version', '/' ) . '(.*)$/mi', $file_data, $match ) && $match[1] )
			$version = _cleanup_header_comment( $match[1] );

		return $version ;
	}

	/**
	 * Return the log file handle.
	 *
	 * @param string $filename
	 * @return string
	 */
	public static function get_log_file_handle( $filename ) {
		return substr( $filename, 0, strlen( $filename ) > 37 ? strlen( $filename ) - 37 : strlen( $filename ) - 4 );
	}

	/**
	 * Scan the template files.
	 * @param  string $template_path
	 * @return array
	 */
	public static function scan_template_files( $template_path ) {

		$files  = @scandir( $template_path );
		$result = array();

		if ( ! empty( $files ) ) {

			foreach ( $files as $key => $value ) {

				if ( ! in_array( $value, array( ".",".." ) ) ) {

					if ( is_dir( $template_path . DIRECTORY_SEPARATOR . $value ) ) {
						$sub_files = self::scan_template_files( $template_path . DIRECTORY_SEPARATOR . $value );
						foreach ( $sub_files as $sub_file ) {
							$result[] = $value . DIRECTORY_SEPARATOR . $sub_file;
						}
					} else {
						$result[] = $value;
					}
				}
			}
		}
		return $result;
	}

	/**
	 * Scan the log files.
	 * @return array
	 */
	public static function scan_log_files() {
		$files  = @scandir( WC_LOG_DIR );
		$result = array();

		if ( ! empty( $files ) ) {

			foreach ( $files as $key => $value ) {

				if ( ! in_array( $value, array( '.', '..' ) ) ) {
					if ( ! is_dir( $value ) && strstr( $value, '.log' ) ) {
						$result[ sanitize_title( $value ) ] = $value;
					}
				}
			}

		}

		return $result;
	}

	/**
	 * Get latest version of a theme by slug.
	 * @param  object $theme WP_Theme object.
	 * @return string Version number if found.
	 */
	public static function get_latest_theme_version( $theme ) {
		$api = themes_api( 'theme_information', array(
			'slug'     => $theme->get_stylesheet(),
			'fields'   => array(
				'sections' => false,
				'tags'     => false,
			)
		) );

		$update_theme_version = 0;

		// Check .org for updates.
		if ( is_object( $api ) && ! is_wp_error( $api ) ) {
			$update_theme_version = $api->version;

		// Check WooThemes Theme Version.
		} elseif ( strstr( $theme->{'Author URI'}, 'woothemes' ) ) {
			$theme_dir = substr( strtolower( str_replace( ' ','', $theme->Name ) ), 0, 45 );

			if ( false === ( $theme_version_data = get_transient( $theme_dir . '_version_data' ) ) ) {

				$theme_changelog = wp_safe_remote_get( 'http://dzv365zjfbd8v.cloudfront.net/changelogs/' . $theme_dir . '/changelog.txt' );
				$cl_lines  = explode( "\n", wp_remote_retrieve_body( $theme_changelog ) );
				if ( ! empty( $cl_lines ) ) {
					foreach ( $cl_lines as $line_num => $cl_line ) {
						if ( preg_match( '/^[0-9]/', $cl_line ) ) {
							$theme_date         = str_replace( '.' , '-' , trim( substr( $cl_line , 0 , strpos( $cl_line , '-' ) ) ) );
							$theme_version      = preg_replace( '~[^0-9,.]~' , '' ,stristr( $cl_line , "version" ) );
							$theme_update       = trim( str_replace( "*" , "" , $cl_lines[ $line_num + 1 ] ) );
							$theme_version_data = array( 'date' => $theme_date , 'version' => $theme_version , 'update' => $theme_update , 'changelog' => $theme_changelog );
							set_transient( $theme_dir . '_version_data', $theme_version_data , DAY_IN_SECONDS );
							break;
						}
					}
				}
			}

			if ( ! empty( $theme_version_data['version'] ) ) {
				$update_theme_version = $theme_version_data['version'];
			}
		}

		return $update_theme_version;
	}

	/**
	 * Remove/delete the chosen file.
	 */
	public static function remove_log() {
		if ( empty( $_REQUEST[ '_wpnonce' ] ) || ! wp_verify_nonce( $_REQUEST[ '_wpnonce' ], 'remove_log' ) ) {

			wp_die( __( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
		}

		if ( ! empty( $_REQUEST[ 'handle' ] ) ) {
			$logger = wc_get_logger();
			$logger->remove( $_REQUEST[ 'handle' ] );
		}

		wp_safe_redirect( esc_url_raw( admin_url( 'admin.php?page=wc-status&tab=logs' ) ) );
		exit();
	}
}


1		<?php
2		/**
3		* Debug/Status page
4		*
5		* @author WooThemes
6		* @category Admin
7		* @package WooCommerce/Admin/System Status
8		* @version 2.2.0
9		*/
10
11		if ( ! defined( 'ABSPATH' ) ) {
12		exit;
13		}
14
15		/**
16		* WC_Admin_Status Class.
17		*/
18		class WC_Admin_Status {
19
20		/**
21		* Handles output of the reports page in admin.
22		*/
23		public static function output() {
24		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status.php' );
25		}
26
27		/**
28		* Handles output of report.
29		*/
30		public static function status_report() {
31		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status-report.php' );
32		}
33
34		/**
35		* Handles output of tools.
36		*/
37		public static function status_tools() {
38		global $wpdb;
39
40		$tools = self::get_tools();
		0 ignored issues – show Unused Code introduced 2016-08-08 18:41 UTC by Report Bug Copy Issue Report `$tools` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
41
42		if ( ! empty( $_GET['action'] ) && ! empty( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( $_REQUEST['_wpnonce'], 'debug_action' ) ) {
43		$tools_controller = new WC_REST_System_Status_Tools_Controller;
44		$response = $tools_controller->execute_tool( $_GET['action'] );
45
46		if ( $response['success'] ) {
47		echo '<div class="updated inline"><p>' . $response['message'] . '</p></div>';
48		} else {
49		echo '<div class="error inline"><p>' . $response['message'] . '</p></div>';
50		}
51		}
52
53		// Display message if settings settings have been saved
54		if ( isset( $_REQUEST['settings-updated'] ) ) {
55		echo '<div class="updated inline"><p>' . __( 'Your changes have been saved.', 'woocommerce' ) . '</p></div>';
56		}
57
58		include_once( dirname( __FILE__ ) . '/views/html-admin-page-status-tools.php' );
59		}
60
61		/**
62		* Get tools.
63		* @return array of tools
64		*/
65		public static function get_tools() {
66		$tools_controller = new WC_REST_System_Status_Tools_Controller;
67		return $tools_controller->get_tools();
68		}
69
70		/**
71		* Show the logs page.
72		*/
73		public static function status_logs() {
74
75		$logs = self::scan_log_files();
76
77		if ( ! empty( $_REQUEST['log_file'] ) && isset( $logs[ sanitize_title( $_REQUEST['log_file'] ) ] ) ) {
78		$viewed_log = $logs[ sanitize_title( $_REQUEST['log_file'] ) ];
79		} elseif ( ! empty( $logs ) ) {
80		$viewed_log = current( $logs );
81		}
82
83		$handle = ! empty( $viewed_log ) ? self::get_log_file_handle( $viewed_log ) : '';
		0 ignored issues – show Unused Code introduced 2016-07-05 00:17 UTC by Report Bug Copy Issue Report `$handle` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
84
85		if ( ! empty( $_REQUEST[ 'handle' ] ) ) {
86		self::remove_log();
87		}
88
89		include_once( 'views/html-admin-page-status-logs.php' );
90		}
91
92		/**
93		* Retrieve metadata from a file. Based on WP Core's get_file_data function.
94		* @since 2.1.1
95		* @param string $file Path to the file
96		* @return string
97		*/
98		public static function get_file_version( $file ) {
99
100		// Avoid notices if file does not exist
101		if ( ! file_exists( $file ) ) {
102		return '';
103		}
104
105		// We don't need to write to the file, so just open for reading.
106		$fp = fopen( $file, 'r' );
107
108		// Pull only the first 8kiB of the file in.
109		$file_data = fread( $fp, 8192 );
110
111		// PHP will close file handle, but we are good citizens.
112		fclose( $fp );
113
114		// Make sure we catch CR-only line endings.
115		$file_data = str_replace( "\r", "\n", $file_data );
116		$version = '';
117
118		if ( preg_match( '/^[ \t\/#@]' . preg_quote( '@version', '/' ) . '(.*)$/mi', $file_data, $match ) && $match[1] )
119		$version = _cleanup_header_comment( $match[1] );
120
121		return $version ;
122		}
123
124		/**
125		* Return the log file handle.
126		*
127		* @param string $filename
128		* @return string
129		*/
130		public static function get_log_file_handle( $filename ) {
131		return substr( $filename, 0, strlen( $filename ) > 37 ? strlen( $filename ) - 37 : strlen( $filename ) - 4 );
132		}
133
134		/**
135		* Scan the template files.
136		* @param string $template_path
137		* @return array
138		*/
139		public static function scan_template_files( $template_path ) {
140
141		$files = @scandir( $template_path );
142		$result = array();
143
144		if ( ! empty( $files ) ) {
145
146		foreach ( $files as $key => $value ) {
147
148		if ( ! in_array( $value, array( ".",".." ) ) ) {
149
150		if ( is_dir( $template_path . DIRECTORY_SEPARATOR . $value ) ) {
151		$sub_files = self::scan_template_files( $template_path . DIRECTORY_SEPARATOR . $value );
152		foreach ( $sub_files as $sub_file ) {
153		$result[] = $value . DIRECTORY_SEPARATOR . $sub_file;
154		}
155		} else {
156		$result[] = $value;
157		}
158		}
159		}
160		}
161		return $result;
162		}
163
164		/**
165		* Scan the log files.
166		* @return array
167		*/
168		public static function scan_log_files() {
169		$files = @scandir( WC_LOG_DIR );
170		$result = array();
171
172		if ( ! empty( $files ) ) {
173
174		foreach ( $files as $key => $value ) {
175
176		if ( ! in_array( $value, array( '.', '..' ) ) ) {
177		if ( ! is_dir( $value ) && strstr( $value, '.log' ) ) {
178		$result[ sanitize_title( $value ) ] = $value;
179		}
180		}
181		}
182
183		}
184
185		return $result;
186		}
187
188		/**
189		* Get latest version of a theme by slug.
190		* @param object $theme WP_Theme object.
191		* @return string Version number if found.
192		*/
193		public static function get_latest_theme_version( $theme ) {
194		$api = themes_api( 'theme_information', array(
195		'slug' => $theme->get_stylesheet(),
196		'fields' => array(
197		'sections' => false,
198		'tags' => false,
199		)
200		) );
201
202		$update_theme_version = 0;
203
204		// Check .org for updates.
205		if ( is_object( $api ) && ! is_wp_error( $api ) ) {
206		$update_theme_version = $api->version;
207
208		// Check WooThemes Theme Version.
209		} elseif ( strstr( $theme->{'Author URI'}, 'woothemes' ) ) {
210		$theme_dir = substr( strtolower( str_replace( ' ','', $theme->Name ) ), 0, 45 );
211
212	View Code Duplication	if ( false === ( $theme_version_data = get_transient( $theme_dir . '_version_data' ) ) ) {
		0 ignored issues – show Duplication introduced 2015-11-21 02:57 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
213		$theme_changelog = wp_safe_remote_get( 'http://dzv365zjfbd8v.cloudfront.net/changelogs/' . $theme_dir . '/changelog.txt' );
214		$cl_lines = explode( "\n", wp_remote_retrieve_body( $theme_changelog ) );
215		if ( ! empty( $cl_lines ) ) {
216		foreach ( $cl_lines as $line_num => $cl_line ) {
217		if ( preg_match( '/^[0-9]/', $cl_line ) ) {
218		$theme_date = str_replace( '.' , '-' , trim( substr( $cl_line , 0 , strpos( $cl_line , '-' ) ) ) );
219		$theme_version = preg_replace( '~[^0-9,.]~' , '' ,stristr( $cl_line , "version" ) );
220		$theme_update = trim( str_replace( "*" , "" , $cl_lines[ $line_num + 1 ] ) );
221		$theme_version_data = array( 'date' => $theme_date , 'version' => $theme_version , 'update' => $theme_update , 'changelog' => $theme_changelog );
222		set_transient( $theme_dir . '_version_data', $theme_version_data , DAY_IN_SECONDS );
223		break;
224		}
225		}
226		}
227		}
228
229		if ( ! empty( $theme_version_data['version'] ) ) {
230		$update_theme_version = $theme_version_data['version'];
231		}
232		}
233
234		return $update_theme_version;
235		}
236
237		/**
238		* Remove/delete the chosen file.
239		*/
240		public static function remove_log() {
241	View Code Duplication	if ( empty( $_REQUEST[ '_wpnonce' ] ) \|\| ! wp_verify_nonce( $_REQUEST[ '_wpnonce' ], 'remove_log' ) ) {
		0 ignored issues – show Duplication introduced 2016-07-05 00:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
242		wp_die( __( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
243		}
244
245		if ( ! empty( $_REQUEST[ 'handle' ] ) ) {
246		$logger = wc_get_logger();
247		$logger->remove( $_REQUEST[ 'handle' ] );
248		}
249
250		wp_safe_redirect( esc_url_raw( admin_url( 'admin.php?page=wc-status&tab=logs' ) ) );
251		exit();
252		}
253		}
254

woothemes / woocommerce