Completed
Push — kraftbj-patch-2 ( 82c983...ae9d16 )
by
unknown
513:58 queued 503:20
created

Jetpack_React_Page::page_admin_scripts()   F

Complexity

Conditions 18
Paths 289

Size

Total Lines 133
Code Lines 85

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 18
eloc 85
nc 289
nop 0
dl 0
loc 133
rs 3.6714
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
include_once( 'class.jetpack-admin-page.php' );
3
4
// Builds the landing page and its menu
5
class Jetpack_React_Page extends Jetpack_Admin_Page {
6
7
	protected $dont_show_if_not_active = false;
8
9
	protected $is_redirecting = false;
10
11
	function get_page_hook() {
12
		$title = _x( 'Jetpack', 'The menu item label', 'jetpack' );
13
14
		// Add the main admin Jetpack menu
15
		return add_menu_page( 'Jetpack', $title, 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
16
	}
17
18
	function add_page_actions( $hook ) {
19
		/** This action is documented in class.jetpack.php */
20
		do_action( 'jetpack_admin_menu', $hook );
21
22
		// Place the Jetpack menu item on top and others in the order they appear
23
		add_filter( 'custom_menu_order',         '__return_true' );
24
		add_filter( 'menu_order',                array( $this, 'jetpack_menu_order' ) );
25
26
		if ( ! isset( $_GET['page'] ) || 'jetpack' !== $_GET['page'] || ! empty( $_GET['configure'] ) ) {
27
			return; // No need to handle the fallback redirection if we are not on the Jetpack page
28
		}
29
30
		// Adding a redirect meta tag for older WordPress versions or if the REST API is disabled
31
		if ( $this->is_wp_version_too_old() || ! $this->is_rest_api_enabled() ) {
32
			$this->is_redirecting = true;
33
			add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
34
		}
35
36
		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
37
		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
38
39
		// Adding a redirect tag wrapped in browser conditional comments
40
		add_action( 'admin_head', array( $this, 'add_legacy_browsers_head_script' ) );
41
	}
42
43
	/**
44
	 * Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
45
	 * Otherwise and only if user is allowed to see the Jetpack Admin, the Dashboard sub-link is added but pointed to Apps tab.
46
	 *
47
	 * Works in Dev Mode or when user is connected.
48
	 *
49
	 * @since 4.3.0
50
	 */
51
	function jetpack_add_dashboard_sub_nav_item() {
52
		if ( Jetpack::is_development_mode() || Jetpack::is_active() ) {
53
			global $submenu;
54
			if ( current_user_can( 'jetpack_manage_modules' ) || Jetpack::is_module_active( 'protect' ) || current_user_can( 'view_stats' ) ) {
55
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', Jetpack::admin_url( 'page=jetpack#/dashboard' ) );
56
			} elseif ( current_user_can( 'jetpack_admin_page' ) ) {
57
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', Jetpack::admin_url( 'page=jetpack#/apps' ) );
58
			}
59
		}
60
	}
61
62
	/**
63
	 * If user is allowed to see the Jetpack Admin, add Settings sub-link.
64
	 *
65
	 * @since 4.3.0
66
	 */
67
	function jetpack_add_settings_sub_nav_item() {
68
		if ( ( Jetpack::is_development_mode() || Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
69
			global $submenu;
70
			$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', Jetpack::admin_url( 'page=jetpack#/settings' ) );
71
		}
72
	}
73
74
	function add_fallback_head_meta() {
75
		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
76
	}
77
78
	function add_noscript_head_meta() {
79
		echo '<noscript>';
80
		$this->add_fallback_head_meta();
81
		echo '</noscript>';
82
	}
83
84
	function add_legacy_browsers_head_script() {
85
		echo
86
			"<script type=\"text/javascript\">\n"
87
			. "/*@cc_on\n"
88
			. "if ( @_jscript_version <= 10) {\n"
89
			. "window.location.href = '?page=jetpack_modules';\n"
90
			. "}\n"
91
			. "@*/\n"
92
			. "</script>";
93
	}
94
95 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
96
		$jp_menu_order = array();
97
98
		foreach ( $menu_order as $index => $item ) {
99
			if ( $item != 'jetpack' )
100
				$jp_menu_order[] = $item;
101
102
			if ( $index == 0 )
103
				$jp_menu_order[] = 'jetpack';
104
		}
105
106
		return $jp_menu_order;
107
	}
108
109
	// Render the configuration page for the module if it exists and an error
110
	// screen if the module is not configurable
111
	// @todo remove when real settings are in place
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
112
	function render_nojs_configurable( $module_name ) {
0 ignored issues
show
Unused Code introduced by
The parameter $module_name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
113
		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );
114
115
		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
116
		echo '<div class="wrap configure-module">';
117
118
		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
119
			Jetpack::admin_screen_configure_module( $module_name );
120
		} else {
121
			echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
122
		}
123
124
		echo '</div><!-- /wrap -->';
125
	}
126
127
	function page_render() {
128
		// Handle redirects to configuration pages
129
		if ( ! empty( $_GET['configure'] ) ) {
130
			return $this->render_nojs_configurable( $_GET['configure'] );
131
		}
132
133
		/** This action is already documented in views/admin/admin-page.php */
134
		do_action( 'jetpack_notices' );
135
136
		// Try fetching by patch
137
		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
138
139 View Code Duplication
		if ( false === $static_html ) {
140
141
			// If we still have nothing, display an error
142
			echo '<p>';
143
			esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
144
			echo '<code>yarn distclean && yarn build</code>';
145
			echo '</p>';
146
		} else {
147
148
			// We got the static.html so let's display it
149
			echo $static_html;
150
		}
151
	}
152
153
	function get_i18n_data() {
154
155
		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';
156
157
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
158
			$locale_data = @file_get_contents( $i18n_json );
159
			if ( $locale_data ) {
160
				return $locale_data;
161
			}
162
		}
163
164
		// Return empty if we have nothing to return so it doesn't fail when parsed in JS
165
		return '{}';
166
	}
167
168
	/**
169
	 * Gets array of any Jetpack notices that have been dismissed.
170
	 *
171
	 * @since 4.0.1
172
	 * @return mixed|void
173
	 */
174
	function get_dismissed_jetpack_notices() {
175
		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
176
		/**
177
		 * Array of notices that have been dismissed.
178
		 *
179
		 * @since 4.0.1
180
		 *
181
		 * @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
182
		 */
183
		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
184
		return $dismissed_notices;
185
	}
186
187
	function additional_styles() {
188
		$rtl = is_rtl() ? '.rtl' : '';
189
190
		wp_enqueue_style( 'dops-css', plugins_url( "_inc/build/admin.dops-style$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
191
		wp_enqueue_style( 'components-css', plugins_url( "_inc/build/style.min$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
192
	}
193
194
	function page_admin_scripts() {
195
		if ( $this->is_redirecting ) {
196
			return; // No need for scripts on a fallback page
197
		}
198
199
		$is_dev_mode = Jetpack::is_development_mode();
200
201
		// Enqueue jp.js and localize it
202
		wp_enqueue_script( 'react-plugin', plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION, true );
203
204
		if ( ! $is_dev_mode ) {
205
			// Required for Analytics
206
			wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
207
		}
208
209
		$localeSlug = explode( '_', jetpack_get_user_locale() );
210
		$localeSlug = $localeSlug[0];
211
212
		// Collecting roles that can view site stats
213
		$stats_roles = array();
214
		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
215
		foreach( get_editable_roles() as $slug => $role ) {
216
			$stats_roles[ $slug ] = array(
217
				'name' => translate_user_role( $role['name'] ),
218
				'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
219
			);
220
		}
221
222
		$response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/module/all' ) );
223
		$modules = $response->get_data();
224
225
		// Preparing translated fields for JSON encoding by transforming all HTML entities to
226
		// respective characters.
227
		foreach( $modules as $slug => $data ) {
228
			$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
229
			$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
230
			$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
231
			$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
232
		}
233
234
		// Get last post, to build the link to Customizer in the Related Posts module.
235
		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
236
		$last_post = isset( $last_post[0] ) && $last_post[0] instanceof WP_Post
0 ignored issues
show
Bug introduced by
The class WP_Post does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
237
			? get_permalink( $last_post[0]->ID )
238
			: get_home_url();
239
240
		// Get information about current theme.
241
		$current_theme = wp_get_theme();
242
243
		// Get all themes that Infinite Scroll provides support for natively.
244
		$inf_scr_support_themes = array();
245
		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes/*.php' ) as $path ) {
246
			if ( is_readable( $path ) ) {
247
				$inf_scr_support_themes[] = basename( $path, '.php' );
248
			}
249
		}
250
251
		// Add objects to be passed to the initial state of the app
252
		wp_localize_script( 'react-plugin', 'Initial_State', array(
253
			'WP_API_root' => esc_url_raw( rest_url() ),
254
			'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
255
			'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
256
			'connectionStatus' => array(
257
				'isActive'  => Jetpack::is_active(),
258
				'isStaging' => Jetpack::is_staging_site(),
259
				'devMode'   => array(
260
					'isActive' => $is_dev_mode,
261
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
262
					'url'      => site_url() && false === strpos( site_url(), '.' ),
263
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
264
				),
265
				'isPublic'	=> '1' == get_option( 'blog_public' ),
266
				'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
267
			),
268
			'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
269
			'isDevVersion' => Jetpack::is_development_version(),
270
			'currentVersion' => JETPACK__VERSION,
271
			'getModules' => $modules,
272
			'showJumpstart' => jetpack_show_jumpstart(),
273
			'showHolidaySnow' => function_exists( 'jetpack_show_holiday_snow_option' ) ? jetpack_show_holiday_snow_option() : false,
274
			'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
275
			'adminUrl' => esc_url( admin_url() ),
276
			'stats' => array(
277
				// data is populated asynchronously on page load
278
				'data'  => array(
279
					'general' => false,
280
					'day'     => false,
281
					'week'    => false,
282
					'month'   => false,
283
				),
284
				'roles' => $stats_roles,
285
			),
286
			'settings' => $this->get_flattened_settings( $modules ),
287
			'settingNames' => array(
288
				'jetpack_holiday_snow_enabled' => function_exists( 'jetpack_holiday_snow_option_name' ) ? jetpack_holiday_snow_option_name() : false,
289
			),
290
			'userData' => array(
291
//				'othersLinked' => Jetpack::get_other_linked_admins(),
292
				'currentUser'  => jetpack_current_user_data(),
293
			),
294
			'siteData' => array(
295
				'icon' => has_site_icon()
296
					? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
297
					: '',
298
				'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
299
				/**
300
				 * Whether promotions are visible or not.
301
				 *
302
				 * @since 4.8.0
303
				 *
304
				 * @param bool $are_promotions_active Status of promotions visibility. True by default.
305
				 */
306
				'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
307
			),
308
			'themeData' => array(
309
				'name'      => $current_theme->get( 'Name' ),
310
				'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
311
				'support'   => array(
312
					'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) || in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
313
				),
314
			),
315
			'locale' => $this->get_i18n_data(),
316
			'localeSlug' => $localeSlug,
317
			'jetpackStateNotices' => array(
318
				'messageCode' => Jetpack::state( 'message' ),
319
				'errorCode' => Jetpack::state( 'error' ),
320
				'errorDescription' => Jetpack::state( 'error_description' ),
321
			),
322
			'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
323
			'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
324
			'lastPostUrl' => esc_url( $last_post ),
325
		) );
326
	}
327
328
	/**
329
	 * Returns an array of modules and settings both as first class members of the object.
330
	 *
331
	 * @param array $modules the result of an API request to get all modules.
332
	 *
333
	 * @return array flattened settings with modules.
334
	 */
335
	function get_flattened_settings( $modules ) {
0 ignored issues
show
Unused Code introduced by
The parameter $modules is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
336
		$core_api_endpoint = new Jetpack_Core_API_Data();
337
		$settings = $core_api_endpoint->get_all_options();
338
		return $settings->data;
339
	}
340
}
341
342
/*
343
 * Only show Jump Start on first activation.
344
 * Any option 'jumpstart' other than 'new connection' will hide it.
345
 *
346
 * The option can be of 4 things, and will be stored as such:
347
 * new_connection      : Brand new connection - Show
348
 * jumpstart_activated : Jump Start has been activated - dismiss
349
 * jetpack_action_taken: Manual activation of a module already happened - dismiss
350
 * jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
351
 *
352
 * @todo move to functions.global.php when available
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
353
 * @since 3.6
354
 * @return bool | show or hide
355
 */
356
function jetpack_show_jumpstart() {
357
	if ( ! Jetpack::is_active() ) {
358
		return false;
359
	}
360
	$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );
361
362
	$hide_options = array(
363
		'jumpstart_activated',
364
		'jetpack_action_taken',
365
		'jumpstart_dismissed'
366
	);
367
368
	if ( ! $jumpstart_option || in_array( $jumpstart_option, $hide_options ) ) {
369
		return false;
370
	}
371
372
	return true;
373
}
374
375
/**
376
 * Gather data about the current user.
377
 *
378
 * @since 4.1.0
379
 *
380
 * @return array
381
 */
382
function jetpack_current_user_data() {
383
	$current_user = wp_get_current_user();
384
	$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
385
	$dotcom_data    = Jetpack::get_connected_user_data();
386
	// Add connected user gravatar to the returned dotcom_data.
387
	$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );
388
389
	$current_user_data = array(
390
		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
391
		'isMaster'    => $is_master_user,
392
		'username'    => $current_user->user_login,
393
		'wpcomUser'   => $dotcom_data,
394
		'gravatar'    => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
395
		'permissions' => array(
396
			'admin_page'         => current_user_can( 'jetpack_admin_page' ),
397
			'connect'            => current_user_can( 'jetpack_connect' ),
398
			'disconnect'         => current_user_can( 'jetpack_disconnect' ),
399
			'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
400
			'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
401
			'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
402
			'edit_posts'         => current_user_can( 'edit_posts' ),
403
			'publish_posts'      => current_user_can( 'publish_posts' ),
404
			'manage_options'     => current_user_can( 'manage_options' ),
405
			'view_stats'		 => current_user_can( 'view_stats' ),
406
			'manage_plugins'	 => current_user_can( 'install_plugins' )
407
									&& current_user_can( 'activate_plugins' )
408
									&& current_user_can( 'update_plugins' )
409
									&& current_user_can( 'delete_plugins' ),
410
		),
411
	);
412
413
	return $current_user_data;
414
}
415
416
/**
417
 * Set the admin language, based on user language.
418
 *
419
 * @since 4.5.0
420
 *
421
 * @return string
422
 *
423
 * @todo Remove this function when WordPress 4.8 is released
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
424
 * and replace `jetpack_get_user_locale()` in this file with `get_user_locale()`.
425
 */
426
function jetpack_get_user_locale() {
427
	$locale = get_locale();
428
429
	if ( function_exists( 'get_user_locale' ) ) {
430
		$locale = get_user_locale();
431
	}
432
433
	return $locale;
434
}
435