Jetpack_JSON_API_Plugins_Install_Endpoint::install() - Code Metrics - Inspection of "Minor variable name glitches." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v2/videopress ( 946a33...00803f )

by George

created 2016-01-22 18:06 UTC

install() C

↳ Parent: Jetpack_JSON_API_Plugins_Install_Endpoint

Complexity

Conditions	11
Paths	22

Size

Total Lines	43
Code Lines	23

Duplication

Lines	3
Ratio	6.98 %

Metric	Value
dl	3
loc	43
rs	5.2653
cc	11
eloc	23
nc	22
nop	0

How to fix Complexity

<?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 function install() {
		foreach ( $this->plugins as $index => $slug ) {

			$skin      = new Jetpack_Automatic_Plugin_Install_Skin();
			$upgrader  = new Plugin_Upgrader( $skin );
			$zip_url   = self::generate_wordpress_org_plugin_download_link( $slug );

			$result = $upgrader->install( $zip_url );

			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 ) ) {

			if ( 'download_failed' === $error_code ) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				// For backwards compatibility: versions prior to 3.9 would return no_package instead of download_failed.
				$error_code = 'no_package';
			}

			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' ) );
			}

		}
		return true;
	}

	protected static function generate_wordpress_org_plugin_download_link( $plugin_slug ) {
		return "https://downloads.wordpress.org/plugin/{$plugin_slug}.latest-stable.zip";
	}

	protected static function get_plugin_id_by_slug( $slug ) {
		$plugins = get_plugins();
		if ( ! is_array( $plugins ) ) {
			return false;
		}
		foreach( $plugins as $plugin_file => $plugin_data ) {
			if ( self::get_slug_from_file_path( $plugin_file ) === $slug ) {
				return $plugin_file;
			}
		}
		return false;
	}

	protected static function get_slug_from_file_path( $plugin_file ) {
		// Simular to get_plugin_slug() method.
		$slug = dirname( $plugin_file );
		if ( '.' === $slug ) {
			$slug = preg_replace("/(.+)\.php$/", "$1", $plugin_file );
		}
		return $slug;
	}
}
/**
 * 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;
	}
}


Push — v2/videopress ( 946a33...00803f )

install() C

Complexity

Size

Duplication

How to fix Complexity

Long Method

Available Fixes

Available Fixes

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
12		protected function install() {
13		foreach ( $this->plugins as $index => $slug ) {
14
15		$skin = new Jetpack_Automatic_Plugin_Install_Skin();
16		$upgrader = new Plugin_Upgrader( $skin );
17		$zip_url = self::generate_wordpress_org_plugin_download_link( $slug );
18
19		$result = $upgrader->install( $zip_url );
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
42		if ( 'download_failed' === $error_code ) {
		0 ignored issues – show Bug introduced 2016-01-14 15:37 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...
43		// For backwards compatibility: versions prior to 3.9 would return no_package instead of download_failed.
44		$error_code = 'no_package';
45		}
46
47		return new WP_Error( $error_code, $this->log[ $slug ]['error'], 400 );
		0 ignored issues – show Bug introduced 2016-01-07 06:07 UTC by Report Bug Copy Issue Report The variable `$slug` seems to be defined by a `foreach` iteration on line `13`. 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...
48		}
49
50		// replace the slug with the actual plugin id
51		$this->plugins[ $index ] = $plugin;
		0 ignored issues – show Bug introduced 2016-01-07 06:07 UTC by Report Bug Copy Issue Report The variable `$index` seems to be defined by a `foreach` iteration on line `13`. 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...
52
53		return true;
54		}
55
56		protected function validate_plugins() {
57	View Code Duplication	if ( empty( $this->plugins ) \|\| ! is_array( $this->plugins ) ) {
58		return new WP_Error( 'missing_plugins', __( 'No plugins found.', 'jetpack' ) );
59		}
60		foreach( $this->plugins as $index => $slug ) {
61		// make sure it is not already installed
62		if ( self::get_plugin_id_by_slug( $slug ) ) {
63		return new WP_Error( 'plugin_already_installed', __( 'The plugin is already installed', 'jetpack' ) );
64		}
65
66		}
67		return true;
68		}
69
70		protected static function generate_wordpress_org_plugin_download_link( $plugin_slug ) {
71		return "https://downloads.wordpress.org/plugin/{$plugin_slug}.latest-stable.zip";
72		}
73
74		protected static function get_plugin_id_by_slug( $slug ) {
75		$plugins = get_plugins();
76		if ( ! is_array( $plugins ) ) {
77		return false;
78		}
79		foreach( $plugins as $plugin_file => $plugin_data ) {
80		if ( self::get_slug_from_file_path( $plugin_file ) === $slug ) {
81		return $plugin_file;
82		}
83		}
84		return false;
85		}
86
87		protected static function get_slug_from_file_path( $plugin_file ) {
88		// Simular to get_plugin_slug() method.
89		$slug = dirname( $plugin_file );
90		if ( '.' === $slug ) {
91		$slug = preg_replace("/(.+)\.php$/", "$1", $plugin_file );
92		}
93		return $slug;
94		}
95		}
96		/**
97		* Allows us to capture that the site doesn't have proper file system access.
98		* In order to update the plugin.
99		*/
100		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...
101		/**
102		* Stores the last error key;
103		**/
104		protected $main_error_code = 'install_error';
105
106		/**
107		* Stores the last error message.
108		**/
109		protected $main_error_message = 'An unknown error occurred during installation';
110
111		/**
112		* Overwrites the set_upgrader to be able to tell if we e ven have the ability to write to the files.
113		*
114		* @param WP_Upgrader $upgrader
115		*
116		*/
117		public function set_upgrader( &$upgrader ) {
118		parent::set_upgrader( $upgrader );
119
120		// Check if we even have permission to.
121		$result = $upgrader->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
122		if ( ! $result ) {
123		// set the string here since they are not available just yet
124		$upgrader->generic_strings();
125		$this->feedback( 'fs_unavailable' );
126		}
127		}
128
129		/**
130		* Overwrites the error function
131		*/
132		public function error( $error ) {
133		if ( is_wp_error( $error ) ) {
134		$this->feedback( $error );
135		}
136		}
137
138		private function set_main_error_code( $code ) {
139		// Don't set the process_failed as code since it is not that helpful unless we don't have one already set.
140		$this->main_error_code = ( $code === 'process_failed' && $this->main_error_code ? $this->main_error_code : $code );
141		}
142
143		private function set_main_error_message( $message, $code ) {
144		// Don't set the process_failed as message since it is not that helpful unless we don't have one already set.
145		$this->main_error_message = ( $code === 'process_failed' && $this->main_error_code ? $this->main_error_code : $message );
146		}
147
148		public function get_main_error_code() {
149		return $this->main_error_code;
150		}
151
152		public function get_main_error_message() {
153		return $this->main_error_message;
154		}
155
156		/**
157		* Overwrites the feedback function
158		*/
159		public function feedback( $data ) {
160
161		$current_error = null;
162		if ( is_wp_error( $data ) ) {
163		$this->set_main_error_code( $data->get_error_code() );
164		$string = $data->get_error_message();
165		} elseif ( is_array( $data ) ) {
166		return;
167		} else {
168		$string = $data;
169		}
170
171		if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
172		$this->set_main_error_code( $string );
173
174		$current_error = $string;
175		$string = $this->upgrader->strings[ $string ];
176		}
177
178		if ( strpos( $string, '%' ) !== false ) {
179		$args = func_get_args();
180		$args = array_splice( $args, 1 );
181		if ( ! empty( $args ) )
182		$string = vsprintf( $string, $args );
183		}
184
185		$string = trim( $string );
186		$string = wp_kses( $string, array(
187		'a' => array(
188		'href' => true
189		),
190		'br' => true,
191		'em' => true,
192		'strong' => true,
193		) );
194
195		$this->set_main_error_message( $string, $current_error );
196		$this->messages[] = $string;
197		}
198		}
199

Automattic / jetpack

Push — v2/videopress ( 946a33...00803f )

install() C

Complexity

Size

Duplication

How to fix Complexity

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like