Completed
Push — add/sync-rest-2 ( f15b08...cc5c19 )
by
unknown
433:14 queued 423:41
created

Jetpack_Admin::admin_menu_sync()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
rs 10
cc 1
eloc 3
nc 1
nop 0
1
<?php
2
3
4
// Build the Jetpack admin menu as a whole
5
class Jetpack_Admin {
6
7
	/**
8
	 * @var Jetpack_Admin
9
	 **/
10
	private static $instance = null;
11
12
	/**
13
	 * @var Jetpack
14
	 **/
15
	private $jetpack;
16
17
	static function init() {
18
		if ( is_null( self::$instance ) ) {
19
			self::$instance = new Jetpack_Admin;
20
		}
21
		return self::$instance;
22
	}
23
24
	private function __construct() {
25
		$this->jetpack = Jetpack::init();
26
27
		jetpack_require_lib( 'admin-pages/class.jetpack-landing-page' );
28
		$this->landing_page = new Jetpack_Landing_Page;
0 ignored issues
show
Bug introduced by
The property landing_page does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
29
30
		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
31
		$this->settings_page = new Jetpack_Settings_Page;
0 ignored issues
show
Bug introduced by
The property settings_page does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
32
33
		jetpack_require_lib( 'admin-pages/class.jetpack-my-jetpack-page' );
34
		$this->my_jetpack_page = new Jetpack_My_Jetpack_Page;
0 ignored issues
show
Bug introduced by
The property my_jetpack_page does not seem to exist. Did you mean jetpack?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
35
36
		if ( isset( $_POST['jetpack-set-master-user'] ) ) {
37
			add_action( 'init', array( $this->my_jetpack_page, 'jetpack_my_jetpack_change_user' ) );
0 ignored issues
show
Bug introduced by
The property my_jetpack_page does not seem to exist. Did you mean jetpack?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
38
		}
39
40
		// Add hooks for admin menus
41
		add_action( 'admin_menu',                    array( $this->landing_page, 'add_actions' ), 998 );
42
		add_action( 'jetpack_admin_menu',            array( $this, 'admin_menu_debugger' ) );
43
		add_action( 'jetpack_admin_menu',            array( $this, 'admin_menu_sync' ) );
44
		add_action( 'jetpack_admin_menu',            array( $this->settings_page, 'add_actions' ) );
45
		add_action( 'jetpack_admin_menu',            array( $this->my_jetpack_page, 'add_actions' ) );
0 ignored issues
show
Bug introduced by
The property my_jetpack_page does not seem to exist. Did you mean jetpack?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
46
47
48
		// Add redirect to current page for activation/deactivation of modules
49
		add_action( 'jetpack_pre_activate_module',   array( $this, 'fix_redirect' ), 10, 2 );
50
		add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) );
51
52
		// Add module bulk actions handler
53
		add_action( 'jetpack_unrecognized_action',   array( $this, 'handle_unrecognized_action' ) );
54
	}
55
56 View Code Duplication
	static function sort_requires_connection_last( $module1, $module2 ) {
57
		if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
58
			return 0;
59
		} elseif ( $module1['requires_connection'] ) {
60
			return 1;
61
		} elseif ( $module2['requires_connection'] ) {
62
			return -1;
63
		}
64
65
		return 0;
66
	}
67
68
	// Produce JS understandable objects of modules containing information for
69
	// presentation like description, name, configuration url, etc.
70
	function get_modules() {
71
		include_once( JETPACK__PLUGIN_DIR . 'modules/module-info.php' );
72
		$available_modules = $this->jetpack->get_available_modules();
73
		$active_modules    = $this->jetpack->get_active_modules();
74
		$modules           = array();
75
		$jetpack_active = Jetpack::is_active() || Jetpack::is_development_mode();
76
		foreach ( $available_modules as $module ) {
77
			if ( $module_array = $this->jetpack->get_module( $module ) ) {
78
				/**
79
				 * Filters each module's short description.
80
				 *
81
				 * @since 3.0.0
82
				 *
83
				 * @param string $module_array['description'] Module description.
84
				 * @param string $module Module slug.
85
				 */
86
				$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
87
				// Fix: correct multibyte strings truncate with checking for mbstring extension
88
				$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
89
							? ( ( mb_strlen( $short_desc ) > 143 )
90
								? mb_substr( $short_desc, 0, 140 ) . '...'
91
								: $short_desc )
92
							: ( ( strlen( $short_desc ) > 143 )
93
								? substr( $short_desc, 0, 140 ) . '...'
94
								: $short_desc );
95
96
				$module_array['module']            = $module;
97
				$module_array['activated']         = ( $jetpack_active ? in_array( $module, $active_modules ) : false );
98
				$module_array['deactivate_nonce']  = wp_create_nonce( 'jetpack_deactivate-' . $module );
99
				$module_array['activate_nonce']    = wp_create_nonce( 'jetpack_activate-' . $module );
100
				$module_array['available']         = self::is_module_available( $module_array );
101
				$module_array['short_description'] = $short_desc_trunc;
102
				$module_array['configure_url']     = Jetpack::module_configuration_url( $module );
103
104
				ob_start();
105
				/**
106
				 * Allow the display of a "Learn More" button.
107
				 * The dynamic part of the action, $module, is the module slug.
108
				 *
109
				 * @since 3.0.0
110
				 */
111
				do_action( 'jetpack_learn_more_button_' . $module );
112
				$module_array['learn_more_button'] = ob_get_clean();
113
114
				ob_start();
115
				/**
116
				 * Allow the display of information text when Jetpack is connected to WordPress.com.
117
				 * The dynamic part of the action, $module, is the module slug.
118
				 *
119
				 * @since 3.0.0
120
				 */
121
				do_action( 'jetpack_module_more_info_' . $module );
122
123
				/**
124
				* Filter the long description of a module.
125
	 			*
126
	 			* @since 3.5.0
127
	 			*
128
	 			* @param string ob_get_clean() The module long description.
129
				* @param string $module The module name.
130
	 			*/
131
				$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
132
133
				ob_start();
134
				/**
135
				 * Filter the search terms for a module
136
				 *
137
				 * Search terms are typically added to the module headers, under "Additional Search Queries".
138
				 *
139
				 * Use syntax:
140
				 * function jetpack_$module_search_terms( $terms ) {
141
				 *  $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
142
				 *  return $terms;
143
				 * }
144
				 * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
145
				 *
146
				 * @since 3.5.0
147
				 *
148
				 * @param string The search terms (comma separated).
149
				 */
150
				echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
151
				$module_array['search_terms'] = ob_get_clean();
152
153
				$module_array['configurable'] = false;
154
				if (
155
					current_user_can( 'manage_options' ) &&
156
					/**
157
					 * Allow the display of a configuration link in the Jetpack Settings screen.
158
					 *
159
					 * @since 3.0.0
160
					 *
161
					 * @param string $module Module name.
162
					 * @param bool false Should the Configure module link be displayed? Default to false.
163
					 */
164
					apply_filters( 'jetpack_module_configurable_' . $module, false )
165
				) {
166
					$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( Jetpack::module_configuration_url( $module ) ), __( 'Configure', 'jetpack' ) );
167
				}
168
169
				$modules[ $module ] = $module_array;
170
			}
171
		}
172
173
		uasort( $modules, array( $this->jetpack, 'sort_modules' ) );
174
175
		if ( ! Jetpack::is_active() ) {
176
			uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
177
		}
178
179
		return $modules;
180
	}
181
182
	static function is_module_available( $module ) {
183
		if ( ! is_array( $module ) || empty( $module ) )
184
			return false;
185
186
		/**
187
		 * We never want to show VaultPress as activatable through Jetpack.
188
		 */
189
		if ( 'vaultpress' === $module['module'] ) {
190
			return false;
191
		}
192
193
		if ( Jetpack::is_development_mode() ) {
194
			return ! ( $module['requires_connection'] );
195
		} else {
196
			return Jetpack::is_active();
197
		}
198
	}
199
200
	function handle_unrecognized_action( $action ) {
201
		switch( $action ) {
202
			case 'bulk-activate' :
203
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
204
					break;
205
				}
206
207
				$modules = (array) $_GET['modules'];
208
				$modules = array_map( 'sanitize_key', $modules );
209
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
210
				foreach( $modules as $module ) {
211
					Jetpack::log( 'activate', $module );
212
					Jetpack::activate_module( $module, false );
213
				}
214
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
215
				wp_safe_redirect( wp_get_referer() );
216
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method handle_unrecognized_action() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
217 View Code Duplication
			case 'bulk-deactivate' :
218
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
219
					break;
220
				}
221
222
				$modules = (array) $_GET['modules'];
223
				$modules = array_map( 'sanitize_key', $modules );
224
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
225
				foreach ( $modules as $module ) {
226
					Jetpack::log( 'deactivate', $module );
227
					Jetpack::deactivate_module( $module );
228
					Jetpack::state( 'message', 'module_deactivated' );
229
				}
230
				Jetpack::state( 'module', $modules );
0 ignored issues
show
Documentation introduced by
$modules is of type array, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
231
				wp_safe_redirect( wp_get_referer() );
232
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method handle_unrecognized_action() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
233
			default:
234
				return;
235
		}
236
	}
237
238
	function fix_redirect( $module, $redirect = true ) {
239
		if ( ! $redirect ) {
240
			return;
241
		}
242
		if ( wp_get_referer() ) {
243
			add_filter( 'wp_redirect', 'wp_get_referer' );
244
		}
245
	}
246
247
	function admin_menu_debugger() {
248
		$debugger_hook = add_submenu_page( null, __( 'Jetpack Debugging Center', 'jetpack' ), '', 'manage_options', 'jetpack-debugger', array( $this, 'debugger_page' ) );
249
		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
250
	}
251
252
	function admin_menu_sync() {
253
		$sync_hook = add_submenu_page( null, __( 'Jetpack Sync Status', 'jetpack' ), '', 'manage_options', 'jetpack-sync', array( 'Jetpack_Sync_Dashboard', 'dashboard_ui' ) );
254
		add_action( "admin_head-$sync_hook", array( 'Jetpack_Sync_Dashboard', 'jetpack_sync_admin_head' ) );
255
	}
256
257
	function debugger_page() {
258
		nocache_headers();
259
		if ( ! current_user_can( 'manage_options' ) ) {
260
			die( '-1' );
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
261
		}
262
		Jetpack_Debugger::jetpack_debug_display_handler();
263
	}
264
}
265
Jetpack_Admin::init();
266