Jetpack_Sync_Module_Plugins::on_upgrader_completion() - Code Metrics - Inspection of "Add: Sync Plugin Updated event." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-update-event-plugin ( 330147 )

unknown

created 2018-01-29 23:46 UTC

on_upgrader_completion() D

↳ Parent: Jetpack_Sync_Module_Plugins

Complexity

Conditions	17
Paths	183

Size

Total Lines	95
Code Lines	33

Duplication

Lines	34
Ratio	35.79 %

Importance

Changes

Metric	Value
cc	17
eloc	33
nc	183
nop	2
dl	34
loc	95
rs	4.5364
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

class Jetpack_Sync_Module_Plugins extends Jetpack_Sync_Module {

	private $action_handler;
	private $plugin_info = array();

	public function name() {
		return 'plugins';
	}

	public function init_listeners( $callable ) {
		$this->action_handler = $callable;

		add_action( 'deleted_plugin',  array( $this, 'deleted_plugin' ), 10, 2 );
		add_action( 'activated_plugin', $callable, 10, 2 );
		add_action( 'deactivated_plugin', $callable, 10, 2 );
		add_action( 'delete_plugin',  array( $this, 'delete_plugin') );
		add_action( 'upgrader_process_complete', array( $this, 'on_upgrader_completion' ), 10, 2 );
		add_action( 'jetpack_plugin_installed', $callable, 10, 1 );
		add_action( 'jetpack_plugin_update_failed', $callable, 10, 3 );
		add_action( 'jetpack_plugins_updated', $callable, 10, 1 );
		add_action( 'admin_action_update', array( $this, 'check_plugin_edit') );
		add_action( 'jetpack_edited_plugin', $callable, 10, 2 );
		add_action( 'wp_ajax_edit-theme-plugin-file', array( $this, 'plugin_edit_ajax' ), 0 );
	}

	public function init_before_send() {
		add_filter( 'jetpack_sync_before_send_activated_plugin', array( $this, 'expand_plugin_data' ) );
		add_filter( 'jetpack_sync_before_send_deactivated_plugin', array( $this, 'expand_plugin_data' ) );
		//Note that we don't simply 'expand_plugin_data' on the 'delete_plugin' action here because the plugin file is deleted when that action finishes
	}

	public function on_upgrader_completion( $upgrader, $details ) {
		if ( ! isset( $details['type'] ) ) {
			return;
		}
		if ( 'plugin' != $details['type'] ) {
			return;
		}

		if ( ! isset( $details['action'] ) ) {
			return;
		}

		$plugins =  ( isset( $details['plugins'] ) ? $details['plugins'] : null );
		if ( empty( $plugins ) ) {
			$plugins = ( isset( $details['plugin'] ) ? array( $details['plugin'] ) : null );
		}

		// for plugin installer
		if ( empty( $plugins ) && method_exists( $upgrader, 'plugin_info' ) ) {
			$plugins = array( $upgrader->plugin_info() );
		}

		if ( empty( $plugins ) ) {
			return; // We shouldn't be here
		}

		switch ( $details['action'] ) {
			case 'update':
				$errors = $this->get_errors( $upgrader->skin );
				var_dump( $plugins );

				if ( $errors ) {
					foreach ( $plugins as $slug ) {
						/**
						 * Sync that a plugin update failed
						 *
						 * @since 5.8.0
						 *
						 * @module sync
						 *
						 * @param string $plugin, Plugin slug
						 * @param string Error code
						 * @param string Error message
						 */
						do_action( 'jetpack_plugin_update_failed', $this->get_plugin_info( $slug ), $errors['code'], $errors['message'] );
					}
					return;
				}
				/**
				 * Sync that a plugin update
				 *
				 * @since 5.8.0
				 *
				 * @module sync
				 *
				 * @param array() $plugin, Plugin Data

				 */
				do_action( 'jetpack_plugins_updated', array_map( array( $this, 'get_plugin_info' ), $plugins ) );
				break;
			case 'install':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

		}

		if ( 'install' === $details['action'] ) {
			$errors = $this->get_errors( $upgrader->skin );
			if ( $errors ) {
				foreach ( $plugins as $slug ) {
					/**
					 * Sync that a plugin update failed
					 *
					 * @since 5.8.0
					 *
					 * @module sync
					 *
					 * @param string $plugin, Plugin slug
					 * @param string Error code
					 * @param string Error message
					 */
					do_action( 'jetpack_plugin_install_failed', $this->get_plugin_info( $slug ), $errors['code'], $errors['message'] );
				}
				return;
			}
			/**
			 * Signals to the sync listener that a plugin was installed and a sync action
			 * reflecting the installation and the plugin info should be sent
			 *
			 * @since 5.8.0
			 *
			 * @module sync
			 *
			 * @param array() $plugin, Plugin Data

			 */
			do_action( 'jetpack_plugin_installed',  array_map( array( $this, 'get_plugin_info' ), $plugins ) );
			return;
		}
	}

	private function get_plugin_info( $slug ) {
		$plugins = get_plugins();
		return isset( $plugins[ $slug ] ) ? array_merge( array( 'slug' => $slug), $plugins[ $slug ] ): array( 'slug' => $slug );
	}

	private function get_errors( $skin ) {
		$errors = method_exists( $skin, 'get_errors' ) ? $skin->get_errors() : null;
		if ( is_wp_error( $errors ) ) {

			if ( ! empty( $errors->get_error_code() ) ) {
				return array( 'code' => $errors->get_error_code(), 'message' => $errors->get_error_message() );
			}
		}

		if ( isset( $skin->result ) ) {
			$errors = $skin->result;
			if ( is_wp_error( $errors ) ) {
				return array( 'code' => $errors->get_error_code(), 'message' => $errors->get_error_message() );
			}

			if ( false == $skin->result ) {
				return array( 'code' => 'unknown', 'message' => __( 'Unknown Plugin Update Failure', 'jetpack' ) );
			}
		}
		return false;
	}

	public function check_plugin_edit() {
		$screen = get_current_screen();
		if ( 'plugin-editor' !== $screen->base ||
			! isset( $_POST['newcontent'] ) ||
			! isset( $_POST['plugin'] )
		) {
			return;
		}

		$plugin = $_POST['plugin'];
		$plugins = get_plugins();
		if ( ! isset( $plugins[ $plugin ] ) ) {
			return;
		}

		/**
		 * Helps Sync log that a plugin was edited
		 *
		 * @since 4.9.0
		 *
		 * @param string $plugin, Plugin slug
		 * @param mixed $plugins[ $plugin ], Array of plugin data
		 */
		do_action( 'jetpack_edited_plugin', $plugin, $plugins[ $plugin ] );
	}

	public function plugin_edit_ajax() {
		// this validation is based on wp_edit_theme_plugin_file()
		$args = wp_unslash( $_POST );
		if ( empty( $args['file'] ) ) {
			return;
		}

		$file = $args['file'];
		if ( 0 !== validate_file( $file ) ) {
			return;
		}

		if ( ! isset( $args['newcontent'] ) ) {
			return;
		}

		if ( ! isset( $args['nonce'] ) ) {
			return;
		}

		if ( empty( $args['plugin'] ) ) {
			return;
		}

		$plugin = $args['plugin'];
		if ( ! current_user_can( 'edit_plugins' ) ) {
			return;
		}

		if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
			return;
		}
		$plugins = get_plugins();
		if ( ! array_key_exists( $plugin, $plugins ) ) {
			return;
		}

		if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
			return;
		}

		$real_file = WP_PLUGIN_DIR . '/' . $file;

		if ( ! is_writeable( $real_file ) ) {
			return;
		}

		$file_pointer = fopen( $real_file, 'w+' );
		if ( false === $file_pointer ) {
			return;
		}

		/**
		 * This action is documented already in this file
		 */
		do_action( 'jetpack_edited_plugin', $plugin, $plugins[ $plugin ] );
	}

	public function delete_plugin( $plugin_path ) {
		$full_plugin_path = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . $plugin_path;

		//Checking for file existence because some sync plugin module tests simulate plugin installation and deletion without putting file on disk
		if ( file_exists( $full_plugin_path ) ) {
			$all_plugin_data = get_plugin_data( $full_plugin_path );
			$data = array(
				'name' => $all_plugin_data['Name'],
				'version' => $all_plugin_data['Version'],
			);
		} else {
			$data = array(
				'name' => $plugin_path,
				'version' => 'unknown',
			);
		}

		$this->plugin_info[ $plugin_path ] = $data;
	}

	public function deleted_plugin( $plugin_path, $is_deleted ) {
		call_user_func( $this->action_handler, $plugin_path, $is_deleted, $this->plugin_info[ $plugin_path ] );
		unset( $this->plugin_info[ $plugin_path ] );
	}

	public function expand_plugin_data( $args ) {
		$plugin_path = $args[0];
		$plugin_data = array();

		if ( ! function_exists( 'get_plugins' ) ) {
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
		}
		$all_plugins = get_plugins();
		if ( isset( $all_plugins[ $plugin_path ] ) ) {
			$all_plugin_data = $all_plugins[ $plugin_path ];
			$plugin_data['name'] = $all_plugin_data['Name'];
			$plugin_data['version'] = $all_plugin_data['Version'];
		}

		return array(
			$args[0],
			$args[1],
			$plugin_data,
		);
	}
}


1		<?php
2
3		class Jetpack_Sync_Module_Plugins extends Jetpack_Sync_Module {
4
5		private $action_handler;
6		private $plugin_info = array();
7
8		public function name() {
9		return 'plugins';
10		}
11
12		public function init_listeners( $callable ) {
13		$this->action_handler = $callable;
14
15		add_action( 'deleted_plugin', array( $this, 'deleted_plugin' ), 10, 2 );
16		add_action( 'activated_plugin', $callable, 10, 2 );
17		add_action( 'deactivated_plugin', $callable, 10, 2 );
18		add_action( 'delete_plugin', array( $this, 'delete_plugin') );
19		add_action( 'upgrader_process_complete', array( $this, 'on_upgrader_completion' ), 10, 2 );
20		add_action( 'jetpack_plugin_installed', $callable, 10, 1 );
21		add_action( 'jetpack_plugin_update_failed', $callable, 10, 3 );
22		add_action( 'jetpack_plugins_updated', $callable, 10, 1 );
23		add_action( 'admin_action_update', array( $this, 'check_plugin_edit') );
24		add_action( 'jetpack_edited_plugin', $callable, 10, 2 );
25		add_action( 'wp_ajax_edit-theme-plugin-file', array( $this, 'plugin_edit_ajax' ), 0 );
26		}
27
28		public function init_before_send() {
29		add_filter( 'jetpack_sync_before_send_activated_plugin', array( $this, 'expand_plugin_data' ) );
30		add_filter( 'jetpack_sync_before_send_deactivated_plugin', array( $this, 'expand_plugin_data' ) );
31		//Note that we don't simply 'expand_plugin_data' on the 'delete_plugin' action here because the plugin file is deleted when that action finishes
32		}
33
34		public function on_upgrader_completion( $upgrader, $details ) {
35		if ( ! isset( $details['type'] ) ) {
36		return;
37		}
38		if ( 'plugin' != $details['type'] ) {
39		return;
40		}
41
42		if ( ! isset( $details['action'] ) ) {
43		return;
44		}
45
46		$plugins = ( isset( $details['plugins'] ) ? $details['plugins'] : null );
47		if ( empty( $plugins ) ) {
48		$plugins = ( isset( $details['plugin'] ) ? array( $details['plugin'] ) : null );
49		}
50
51		// for plugin installer
52		if ( empty( $plugins ) && method_exists( $upgrader, 'plugin_info' ) ) {
53		$plugins = array( $upgrader->plugin_info() );
54		}
55
56		if ( empty( $plugins ) ) {
57		return; // We shouldn't be here
58		}
59
60		switch ( $details['action'] ) {
61		case 'update':
62		$errors = $this->get_errors( $upgrader->skin );
63		var_dump( $plugins );
		0 ignored issues – show Security Debugging Code introduced 2018-01-30 00:52 UTC by Report Bug Copy Issue Report `var_dump($plugins);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
64	View Code Duplication	if ( $errors ) {
65		foreach ( $plugins as $slug ) {
66		/**
67		* Sync that a plugin update failed
68		*
69		* @since 5.8.0
70		*
71		* @module sync
72		*
73		* @param string $plugin, Plugin slug
74		* @param string Error code
75		* @param string Error message
76		*/
77		do_action( 'jetpack_plugin_update_failed', $this->get_plugin_info( $slug ), $errors['code'], $errors['message'] );
78		}
79		return;
80		}
81		/**
82		* Sync that a plugin update
83		*
84		* @since 5.8.0
85		*
86		* @module sync
87		*
88		* @param array() $plugin, Plugin Data
		0 ignored issues – show Documentation introduced 2018-01-30 00:52 UTC by Report Bug Copy Issue Report The doc-type `array()` could not be parsed: Expected "\|" or "end of type", but got "(" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
89		*/
90		do_action( 'jetpack_plugins_updated', array_map( array( $this, 'get_plugin_info' ), $plugins ) );
91		break;
92		case 'install':
		0 ignored issues – show Coding Style introduced 2018-01-30 00:52 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
93
94		}
95
96		if ( 'install' === $details['action'] ) {
97		$errors = $this->get_errors( $upgrader->skin );
98	View Code Duplication	if ( $errors ) {
99		foreach ( $plugins as $slug ) {
100		/**
101		* Sync that a plugin update failed
102		*
103		* @since 5.8.0
104		*
105		* @module sync
106		*
107		* @param string $plugin, Plugin slug
108		* @param string Error code
109		* @param string Error message
110		*/
111		do_action( 'jetpack_plugin_install_failed', $this->get_plugin_info( $slug ), $errors['code'], $errors['message'] );
112		}
113		return;
114		}
115		/**
116		* Signals to the sync listener that a plugin was installed and a sync action
117		* reflecting the installation and the plugin info should be sent
118		*
119		* @since 5.8.0
120		*
121		* @module sync
122		*
123		* @param array() $plugin, Plugin Data
		0 ignored issues – show Documentation introduced 2018-01-30 00:52 UTC by Report Bug Copy Issue Report The doc-type `array()` could not be parsed: Expected "\|" or "end of type", but got "(" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
124		*/
125		do_action( 'jetpack_plugin_installed', array_map( array( $this, 'get_plugin_info' ), $plugins ) );
126		return;
127		}
128		}
129
130		private function get_plugin_info( $slug ) {
131		$plugins = get_plugins();
132		return isset( $plugins[ $slug ] ) ? array_merge( array( 'slug' => $slug), $plugins[ $slug ] ): array( 'slug' => $slug );
133		}
134
135		private function get_errors( $skin ) {
136		$errors = method_exists( $skin, 'get_errors' ) ? $skin->get_errors() : null;
137		if ( is_wp_error( $errors ) ) {
138
139		if ( ! empty( $errors->get_error_code() ) ) {
140		return array( 'code' => $errors->get_error_code(), 'message' => $errors->get_error_message() );
141		}
142		}
143
144		if ( isset( $skin->result ) ) {
145		$errors = $skin->result;
146		if ( is_wp_error( $errors ) ) {
147		return array( 'code' => $errors->get_error_code(), 'message' => $errors->get_error_message() );
148		}
149
150		if ( false == $skin->result ) {
151		return array( 'code' => 'unknown', 'message' => __( 'Unknown Plugin Update Failure', 'jetpack' ) );
152		}
153		}
154		return false;
155		}
156
157		public function check_plugin_edit() {
158		$screen = get_current_screen();
159		if ( 'plugin-editor' !== $screen->base \|\|
160		! isset( $_POST['newcontent'] ) \|\|
161		! isset( $_POST['plugin'] )
162		) {
163		return;
164		}
165
166		$plugin = $_POST['plugin'];
167		$plugins = get_plugins();
168		if ( ! isset( $plugins[ $plugin ] ) ) {
169		return;
170		}
171
172		/**
173		* Helps Sync log that a plugin was edited
174		*
175		* @since 4.9.0
176		*
177		* @param string $plugin, Plugin slug
178		* @param mixed $plugins[ $plugin ], Array of plugin data
179		*/
180		do_action( 'jetpack_edited_plugin', $plugin, $plugins[ $plugin ] );
181		}
182
183		public function plugin_edit_ajax() {
184		// this validation is based on wp_edit_theme_plugin_file()
185		$args = wp_unslash( $_POST );
186		if ( empty( $args['file'] ) ) {
187		return;
188		}
189
190		$file = $args['file'];
191		if ( 0 !== validate_file( $file ) ) {
192		return;
193		}
194
195		if ( ! isset( $args['newcontent'] ) ) {
196		return;
197		}
198
199		if ( ! isset( $args['nonce'] ) ) {
200		return;
201		}
202
203		if ( empty( $args['plugin'] ) ) {
204		return;
205		}
206
207		$plugin = $args['plugin'];
208		if ( ! current_user_can( 'edit_plugins' ) ) {
209		return;
210		}
211
212		if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
213		return;
214		}
215		$plugins = get_plugins();
216		if ( ! array_key_exists( $plugin, $plugins ) ) {
217		return;
218		}
219
220		if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
221		return;
222		}
223
224		$real_file = WP_PLUGIN_DIR . '/' . $file;
225
226		if ( ! is_writeable( $real_file ) ) {
227		return;
228		}
229
230		$file_pointer = fopen( $real_file, 'w+' );
231		if ( false === $file_pointer ) {
232		return;
233		}
234
235		/**
236		* This action is documented already in this file
237		*/
238		do_action( 'jetpack_edited_plugin', $plugin, $plugins[ $plugin ] );
239		}
240
241		public function delete_plugin( $plugin_path ) {
242		$full_plugin_path = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . $plugin_path;
243
244		//Checking for file existence because some sync plugin module tests simulate plugin installation and deletion without putting file on disk
245		if ( file_exists( $full_plugin_path ) ) {
246		$all_plugin_data = get_plugin_data( $full_plugin_path );
247		$data = array(
248		'name' => $all_plugin_data['Name'],
249		'version' => $all_plugin_data['Version'],
250		);
251		} else {
252		$data = array(
253		'name' => $plugin_path,
254		'version' => 'unknown',
255		);
256		}
257
258		$this->plugin_info[ $plugin_path ] = $data;
259		}
260
261		public function deleted_plugin( $plugin_path, $is_deleted ) {
262		call_user_func( $this->action_handler, $plugin_path, $is_deleted, $this->plugin_info[ $plugin_path ] );
263		unset( $this->plugin_info[ $plugin_path ] );
264		}
265
266		public function expand_plugin_data( $args ) {
267		$plugin_path = $args[0];
268		$plugin_data = array();
269
270		if ( ! function_exists( 'get_plugins' ) ) {
271		require_once ABSPATH . 'wp-admin/includes/plugin.php';
272		}
273		$all_plugins = get_plugins();
274		if ( isset( $all_plugins[ $plugin_path ] ) ) {
275		$all_plugin_data = $all_plugins[ $plugin_path ];
276		$plugin_data['name'] = $all_plugin_data['Name'];
277		$plugin_data['version'] = $all_plugin_data['Version'];
278		}
279
280		return array(
281		$args[0],
282		$args[1],
283		$plugin_data,
284		);
285		}
286		}
287

Automattic / jetpack

Push — add/sync-update-event-plugin ( 330147 )

on_upgrader_completion() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like