Jetpack_Automatic_Plugin_Install_Skin - Code Metrics - Inspection of "Update Matrix per https://github.com/Automattic/je..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/travis-matrix-7 ( 497e3e...cc9f21 )

unknown

created 2016-01-05 22:19 UTC

Jetpack_Automatic_Plugin_Install_Skin A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Metric	Value
wmc	18
lcom	1
cbo	0
dl	0
loc	99
rs	10

7 Methods

Rating	Name	Size	Complexity
A	set_upgrader()	11	2
A	error()	5	2
A	set_main_error_code()	4	3
A	set_main_error_message()	4	3
A	get_main_error_code()	3	1
A	get_main_error_message()	3	1
B	feedback()	39	6

<?php

include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
include_once ABSPATH . 'wp-admin/includes/file.php';

class Jetpack_JSON_API_Plugins_Install_Endpoint extends Jetpack_JSON_API_Plugins_Endpoint {

	// POST /sites/%s/plugins/%s/install
	protected $needed_capabilities = 'install_plugins';
	protected $action              = 'install';
	protected $download_links      = array();

	protected function install() {
		foreach ( $this->plugins as $index => $slug ) {

			$skin      = new Jetpack_Automatic_Plugin_Install_Skin();
			$upgrader  = new Plugin_Upgrader( $skin );

			$result = $upgrader->install( $this->download_links[ $slug ] );

			if ( ! $this->bulk && is_wp_error( $result ) ) {
				return $result;
			}

			$plugin = self::get_plugin_id_by_slug( $slug );
			$error_code = 'install_error';
			if ( ! $plugin ) {
				$error = $this->log[ $slug ]['error'] = __( 'There was an error installing your plugin', 'jetpack' );
			}

			if ( ! $this->bulk && ! $result ) {
				$error_code = $upgrader->skin->get_main_error_code();
				$message = $upgrader->skin->get_main_error_message();
				$error = $this->log[ $slug ]['error'] = $message ? $message : __( 'An unknown error occurred during installation' , 'jetpack' );
			}

			$this->log[ $plugin ][] = $upgrader->skin->get_upgrade_messages();
		}

		if ( ! $this->bulk && isset( $error ) ) {
			return new WP_Error( $error_code, $this->log[ $slug ]['error'], 400 );
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.
		}

		// replace the slug with the actual plugin id
		$this->plugins[ $index ] = $plugin;
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.

		return true;
	}

	protected function validate_plugins() {
		if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
			return new WP_Error( 'missing_plugins', __( 'No plugins found.', 'jetpack' ) );
		}
		foreach( $this->plugins as $index => $slug ) {

			// make sure it is not already installed
			if ( self::get_plugin_id_by_slug( $slug ) ) {
				return new WP_Error( 'plugin_already_installed', __( 'The plugin is already installed', 'jetpack' ) );
			}

			$response    = wp_remote_get( "http://api.wordpress.org/plugins/info/1.0/$slug" );
			$plugin_data = unserialize( $response['body'] );
			if ( is_wp_error( $plugin_data ) ) {
				return $plugin_data;
			}

			$this->download_links[ $slug ] = $plugin_data->download_link;

		}
		return true;
	}

	protected static function get_plugin_id_by_slug( $slug ) {
		$plugins = get_plugins();
		if ( ! is_array( $plugins ) ) {
			return false;
		}
		foreach( $plugins as $id => $plugin_data ) {
			if ( strpos( $id, $slug ) !== false ) {
				return $id;
			}
		}
		return false;
	}
}
/**
 * Allows us to capture that the site doesn't have proper file system access.
 * In order to update the plugin.
 */
class Jetpack_Automatic_Plugin_Install_Skin extends Automatic_Upgrader_Skin {

	/**
	 * Stores the last error key;
	 **/
	protected $main_error_code = 'install_error';

	/**
	 * Stores the last error message.
	 **/
	protected $main_error_message = 'An unknown error occurred during installation';

	/**
	 * Overwrites the set_upgrader to be able to tell if we e ven have the ability to write to the files.
	 *
	 * @param WP_Upgrader $upgrader
	 *
	 */
	public function set_upgrader( &$upgrader ) {
		parent::set_upgrader( $upgrader );

		// Check if we even have permission to.
		$result = $upgrader->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
		if ( ! $result ) {
			// set the string here since they are not available just yet
			$upgrader->generic_strings();
			$this->feedback( 'fs_unavailable' );
		}
	}

	/**
	 * Overwrites the error function
	 */
	public function error( $error ) {
		if ( is_wp_error( $error ) ) {
			$this->feedback( $error );
		}
	}

	private function set_main_error_code( $code ) {
		// Don't set the process_failed as code since it is not that helpful unless we don't have one already set.
		$this->main_error_code = ( $code === 'process_failed' && $this->main_error_code  ? $this->main_error_code : $code );
	}

	private function set_main_error_message( $message, $code ) {
		// Don't set the process_failed as message since it is not that helpful unless we don't have one already set.
		$this->main_error_message = ( $code === 'process_failed' && $this->main_error_code ? $this->main_error_code : $message );
	}

	public function get_main_error_code() {
		return $this->main_error_code;
	}

	public function get_main_error_message() {
		return $this->main_error_message;
	}

	/**
	 * Overwrites the feedback function
	 */
	public function feedback( $data ) {

		$current_error = null;
		if ( is_wp_error( $data ) ) {
			$this->set_main_error_code( $data->get_error_code() );
			$string = $data->get_error_message();
		} elseif ( is_array( $data ) ) {
			return;
		} else {
			$string = $data;
		}

		if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
			$this->set_main_error_code( $string );

			$current_error = $string;
			$string = $this->upgrader->strings[ $string ];
		}

		if ( strpos( $string, '%' ) !== false ) {
			$args = func_get_args();
			$args = array_splice( $args, 1 );
			if ( ! empty( $args ) )
				$string = vsprintf( $string, $args );
		}

		$string = trim( $string );
		$string = wp_kses( $string, array(
			'a' => array(
				'href' => true
			),
			'br' => true,
			'em' => true,
			'strong' => true,
		) );

		$this->set_main_error_message( $string, $current_error );
		$this->messages[] = $string;
	}
}


1		<?php
2
3		include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
4		include_once ABSPATH . 'wp-admin/includes/file.php';
5
6		class Jetpack_JSON_API_Plugins_Install_Endpoint extends Jetpack_JSON_API_Plugins_Endpoint {
7
8		// POST /sites/%s/plugins/%s/install
9		protected $needed_capabilities = 'install_plugins';
10		protected $action = 'install';
11		protected $download_links = array();
12
13		protected function install() {
14		foreach ( $this->plugins as $index => $slug ) {
15
16		$skin = new Jetpack_Automatic_Plugin_Install_Skin();
17		$upgrader = new Plugin_Upgrader( $skin );
18
19		$result = $upgrader->install( $this->download_links[ $slug ] );
20
21		if ( ! $this->bulk && is_wp_error( $result ) ) {
22		return $result;
23		}
24
25		$plugin = self::get_plugin_id_by_slug( $slug );
26		$error_code = 'install_error';
27	View Code Duplication	if ( ! $plugin ) {
28		$error = $this->log[ $slug ]['error'] = __( 'There was an error installing your plugin', 'jetpack' );
29		}
30
31		if ( ! $this->bulk && ! $result ) {
32		$error_code = $upgrader->skin->get_main_error_code();
33		$message = $upgrader->skin->get_main_error_message();
34		$error = $this->log[ $slug ]['error'] = $message ? $message : __( 'An unknown error occurred during installation' , 'jetpack' );
35		}
36
37		$this->log[ $plugin ][] = $upgrader->skin->get_upgrade_messages();
38		}
39
40		if ( ! $this->bulk && isset( $error ) ) {
41		return new WP_Error( $error_code, $this->log[ $slug ]['error'], 400 );
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The variable `$slug` seems to be defined by a `foreach` iteration on line `14`. Are you sure the iterator is never empty, otherwise this variable is not defined? It seems like you are relying on a variable being defined by an iteration: foreach ($a as $b) { } // $b is defined here only if $a has elements, for example if $a is array() // then $b would not be defined here. To avoid that, we recommend to set a // default value for $b. // Better $b = 0; // or whatever default makes sense in your context foreach ($a as $b) { } // $b is now guaranteed to be defined here. Loading history... Bug introduced 2015-11-23 21:23 UTC by Report Bug Copy Issue Report The variable `$error_code` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
42		}
43
44		// replace the slug with the actual plugin id
45		$this->plugins[ $index ] = $plugin;
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The variable `$index` seems to be defined by a `foreach` iteration on line `14`. Are you sure the iterator is never empty, otherwise this variable is not defined? It seems like you are relying on a variable being defined by an iteration: foreach ($a as $b) { } // $b is defined here only if $a has elements, for example if $a is array() // then $b would not be defined here. To avoid that, we recommend to set a // default value for $b. // Better $b = 0; // or whatever default makes sense in your context foreach ($a as $b) { } // $b is now guaranteed to be defined here. Loading history... Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The variable `$plugin` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
46
47		return true;
48		}
49
50		protected function validate_plugins() {
51	View Code Duplication	if ( empty( $this->plugins ) \|\| ! is_array( $this->plugins ) ) {
52		return new WP_Error( 'missing_plugins', __( 'No plugins found.', 'jetpack' ) );
53		}
54		foreach( $this->plugins as $index => $slug ) {
55
56		// make sure it is not already installed
57		if ( self::get_plugin_id_by_slug( $slug ) ) {
58		return new WP_Error( 'plugin_already_installed', __( 'The plugin is already installed', 'jetpack' ) );
59		}
60
61		$response = wp_remote_get( "http://api.wordpress.org/plugins/info/1.0/$slug" );
62		$plugin_data = unserialize( $response['body'] );
63		if ( is_wp_error( $plugin_data ) ) {
64		return $plugin_data;
65		}
66
67		$this->download_links[ $slug ] = $plugin_data->download_link;
68
69		}
70		return true;
71		}
72
73		protected static function get_plugin_id_by_slug( $slug ) {
74		$plugins = get_plugins();
75		if ( ! is_array( $plugins ) ) {
76		return false;
77		}
78		foreach( $plugins as $id => $plugin_data ) {
79		if ( strpos( $id, $slug ) !== false ) {
80		return $id;
81		}
82		}
83		return false;
84		}
85		}
86		/**
87		* Allows us to capture that the site doesn't have proper file system access.
88		* In order to update the plugin.
89		*/
90		class Jetpack_Automatic_Plugin_Install_Skin extends Automatic_Upgrader_Skin {
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-23 21:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
91		/**
92		* Stores the last error key;
93		**/
94		protected $main_error_code = 'install_error';
95
96		/**
97		* Stores the last error message.
98		**/
99		protected $main_error_message = 'An unknown error occurred during installation';
100
101		/**
102		* Overwrites the set_upgrader to be able to tell if we e ven have the ability to write to the files.
103		*
104		* @param WP_Upgrader $upgrader
105		*
106		*/
107		public function set_upgrader( &$upgrader ) {
108		parent::set_upgrader( $upgrader );
109
110		// Check if we even have permission to.
111		$result = $upgrader->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
112		if ( ! $result ) {
113		// set the string here since they are not available just yet
114		$upgrader->generic_strings();
115		$this->feedback( 'fs_unavailable' );
116		}
117		}
118
119		/**
120		* Overwrites the error function
121		*/
122		public function error( $error ) {
123		if ( is_wp_error( $error ) ) {
124		$this->feedback( $error );
125		}
126		}
127
128		private function set_main_error_code( $code ) {
129		// Don't set the process_failed as code since it is not that helpful unless we don't have one already set.
130		$this->main_error_code = ( $code === 'process_failed' && $this->main_error_code ? $this->main_error_code : $code );
131		}
132
133		private function set_main_error_message( $message, $code ) {
134		// Don't set the process_failed as message since it is not that helpful unless we don't have one already set.
135		$this->main_error_message = ( $code === 'process_failed' && $this->main_error_code ? $this->main_error_code : $message );
136		}
137
138		public function get_main_error_code() {
139		return $this->main_error_code;
140		}
141
142		public function get_main_error_message() {
143		return $this->main_error_message;
144		}
145
146		/**
147		* Overwrites the feedback function
148		*/
149		public function feedback( $data ) {
150
151		$current_error = null;
152		if ( is_wp_error( $data ) ) {
153		$this->set_main_error_code( $data->get_error_code() );
154		$string = $data->get_error_message();
155		} elseif ( is_array( $data ) ) {
156		return;
157		} else {
158		$string = $data;
159		}
160
161		if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
162		$this->set_main_error_code( $string );
163
164		$current_error = $string;
165		$string = $this->upgrader->strings[ $string ];
166		}
167
168		if ( strpos( $string, '%' ) !== false ) {
169		$args = func_get_args();
170		$args = array_splice( $args, 1 );
171		if ( ! empty( $args ) )
172		$string = vsprintf( $string, $args );
173		}
174
175		$string = trim( $string );
176		$string = wp_kses( $string, array(
177		'a' => array(
178		'href' => true
179		),
180		'br' => true,
181		'em' => true,
182		'strong' => true,
183		) );
184
185		$this->set_main_error_message( $string, $current_error );
186		$this->messages[] = $string;
187		}
188		}
189

Automattic / jetpack

Push — update/travis-matrix-7 ( 497e3e...cc9f21 )

Jetpack_Automatic_Plugin_Install_Skin A

Complexity

Size/Duplication

Coupling/Cohesion

7 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like