Completed
Push — update/publicize-settings-ui ( 6f3aeb...ae05fe )
by
unknown
07:30
created

Jetpack_React_Page::jetpack_menu_order()   A

Complexity

Conditions 4
Paths 5

Size

Total Lines 13

Duplication

Lines 13
Ratio 100 %

Importance

Changes 0
Metric Value
cc 4
nc 5
nop 1
dl 13
loc 13
rs 9.8333
c 0
b 0
f 0
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
	 *
46
	 * Works in Dev Mode or when user is connected.
47
	 *
48
	 * @since 4.3.0
49
	 */
50
	function jetpack_add_dashboard_sub_nav_item() {
51 View Code Duplication
		if ( Jetpack::is_development_mode() || Jetpack::is_active() ) {
52
			global $submenu;
53
			if ( current_user_can( 'jetpack_admin_page' ) ) {
54
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
55
			}
56
		}
57
	}
58
59
	/**
60
	 * If user is allowed to see the Jetpack Admin, add Settings sub-link.
61
	 *
62
	 * @since 4.3.0
63
	 */
64
	function jetpack_add_settings_sub_nav_item() {
65 View Code Duplication
		if ( ( Jetpack::is_development_mode() || Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
66
			global $submenu;
67
			$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
68
		}
69
	}
70
71
	function add_fallback_head_meta() {
72
		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
73
	}
74
75
	function add_noscript_head_meta() {
76
		echo '<noscript>';
77
		$this->add_fallback_head_meta();
78
		echo '</noscript>';
79
	}
80
81
	function add_legacy_browsers_head_script() {
82
		echo
83
			"<script type=\"text/javascript\">\n"
84
			. "/*@cc_on\n"
85
			. "if ( @_jscript_version <= 10) {\n"
86
			. "window.location.href = '?page=jetpack_modules';\n"
87
			. "}\n"
88
			. "@*/\n"
89
			. "</script>";
90
	}
91
92 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
93
		$jp_menu_order = array();
94
95
		foreach ( $menu_order as $index => $item ) {
96
			if ( $item != 'jetpack' )
97
				$jp_menu_order[] = $item;
98
99
			if ( $index == 0 )
100
				$jp_menu_order[] = 'jetpack';
101
		}
102
103
		return $jp_menu_order;
104
	}
105
106
	// Render the configuration page for the module if it exists and an error
107
	// screen if the module is not configurable
108
	// @todo remove when real settings are in place
109
	function render_nojs_configurable( $module_name ) {
110
		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );
111
112
		echo '<div class="wrap configure-module">';
113
114
		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
115
			Jetpack::admin_screen_configure_module( $module_name );
116
		} else {
117
			echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
118
		}
119
120
		echo '</div><!-- /wrap -->';
121
	}
122
123
	function page_render() {
124
		// Handle redirects to configuration pages
125
		if ( ! empty( $_GET['configure'] ) ) {
126
			return $this->render_nojs_configurable( $_GET['configure'] );
127
		}
128
129
		/** This action is already documented in views/admin/admin-page.php */
130
		do_action( 'jetpack_notices' );
131
132
		// Try fetching by patch
133
		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
134
135
		if ( false === $static_html ) {
136
137
			// If we still have nothing, display an error
138
			echo '<p>';
139
			esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
140
			echo '<code>yarn distclean && yarn build</code>';
141
			echo '</p>';
142
		} else {
143
144
			// We got the static.html so let's display it
145
			echo $static_html;
146
		}
147
	}
148
149
	/**
150
	 * Gets array of any Jetpack notices that have been dismissed.
151
	 *
152
	 * @since 4.0.1
153
	 * @return mixed|void
154
	 */
155
	function get_dismissed_jetpack_notices() {
156
		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
157
		/**
158
		 * Array of notices that have been dismissed.
159
		 *
160
		 * @since 4.0.1
161
		 *
162
		 * @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
163
		 */
164
		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
165
		return $dismissed_notices;
166
	}
167
168
	function additional_styles() {
169
		Jetpack_Admin_Page::load_wrapper_styles();
170
	}
171
172
	function page_admin_scripts() {
173
		if ( $this->is_redirecting || isset( $_GET['configure'] ) ) {
174
			return; // No need for scripts on a fallback page
175
		}
176
177
		$is_dev_mode = Jetpack::is_development_mode();
178
179
		// Enqueue jp.js and localize it
180
		wp_enqueue_script( 'react-plugin', plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION, true );
181
182
		if ( ! $is_dev_mode && Jetpack::is_active() ) {
183
			// Required for Analytics
184
			wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
185
		}
186
187
		// Collecting roles that can view site stats.
188
		$stats_roles = array();
189
		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
190
191
		if ( ! function_exists( 'get_editable_roles' ) ) {
192
			require_once ABSPATH . 'wp-admin/includes/user.php';
193
		}
194
		foreach ( get_editable_roles() as $slug => $role ) {
195
			$stats_roles[ $slug ] = array(
196
				'name' => translate_user_role( $role['name'] ),
197
				'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
198
			);
199
		}
200
201
		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
202
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
203
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
204
		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
205
		$modules = $moduleListEndpoint->get_modules();
206
207
		// Preparing translated fields for JSON encoding by transforming all HTML entities to
208
		// respective characters.
209
		foreach( $modules as $slug => $data ) {
0 ignored issues
show
Bug introduced by
The expression $modules of type string|array is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
210
			$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
211
			$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
212
			$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
213
			$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
214
		}
215
216
		// Get last post, to build the link to Customizer in the Related Posts module.
217
		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
218
		$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...
219
			? get_permalink( $last_post[0]->ID )
220
			: get_home_url();
221
222
		// Get information about current theme.
223
		$current_theme = wp_get_theme();
224
225
		// Get all themes that Infinite Scroll provides support for natively.
226
		$inf_scr_support_themes = array();
227
		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
228
			if ( is_readable( $path ) ) {
229
				$inf_scr_support_themes[] = basename( $path, '.php' );
230
			}
231
		}
232
233
		// Add objects to be passed to the initial state of the app
234
		wp_localize_script( 'react-plugin', 'Initial_State', array(
235
			'WP_API_root' => esc_url_raw( rest_url() ),
236
			'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
237
			'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
238
			'connectionStatus' => array(
239
				'isActive'  => Jetpack::is_active(),
240
				'isStaging' => Jetpack::is_staging_site(),
241
				'devMode'   => array(
242
					'isActive' => $is_dev_mode,
243
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
244
					'url'      => site_url() && false === strpos( site_url(), '.' ),
245
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
246
				),
247
				'isPublic'	=> '1' == get_option( 'blog_public' ),
248
				'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
249
			),
250
			'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
251
			'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
252
			'isDevVersion' => Jetpack::is_development_version(),
253
			'currentVersion' => JETPACK__VERSION,
254
			'getModules' => $modules,
255
			'showJumpstart' => jetpack_show_jumpstart(),
256
			'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
257
			'adminUrl' => esc_url( admin_url() ),
258
			'stats' => array(
259
				// data is populated asynchronously on page load
260
				'data'  => array(
261
					'general' => false,
262
					'day'     => false,
263
					'week'    => false,
264
					'month'   => false,
265
				),
266
				'roles' => $stats_roles,
267
			),
268
			'settings' => $this->get_flattened_settings( $modules ),
0 ignored issues
show
Bug introduced by
It seems like $modules defined by $moduleListEndpoint->get_modules() on line 205 can also be of type string; however, Jetpack_React_Page::get_flattened_settings() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
269
			'userData' => array(
270
//				'othersLinked' => Jetpack::get_other_linked_admins(),
271
				'currentUser'  => jetpack_current_user_data(),
272
			),
273
			'siteData' => array(
274
				'icon' => has_site_icon()
275
					? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
276
					: '',
277
				'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
278
				/**
279
				 * Whether promotions are visible or not.
280
				 *
281
				 * @since 4.8.0
282
				 *
283
				 * @param bool $are_promotions_active Status of promotions visibility. True by default.
284
				 */
285
				'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
286
				'isAtomicSite' => jetpack_is_atomic_site(),
287
				'plan' => Jetpack::get_active_plan(),
288
				'showBackups' => Jetpack::show_backups_ui(),
289
			),
290
			'themeData' => array(
291
				'name'      => $current_theme->get( 'Name' ),
292
				'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
293
				'support'   => array(
294
					'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) || in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
295
				),
296
			),
297
			'locale' => Jetpack::get_i18n_data_json(),
298
			'localeSlug' => join( '-', explode( '_', jetpack_get_user_locale() ) ),
299
			'jetpackStateNotices' => array(
300
				'messageCode' => Jetpack::state( 'message' ),
301
				'errorCode' => Jetpack::state( 'error' ),
302
				'errorDescription' => Jetpack::state( 'error_description' ),
303
			),
304
			'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
305
			'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
306
			'lastPostUrl' => esc_url( $last_post ),
307
		) );
308
	}
309
310
	/**
311
	 * Returns an array of modules and settings both as first class members of the object.
312
	 *
313
	 * @param array $modules the result of an API request to get all modules.
314
	 *
315
	 * @return array flattened settings with modules.
316
	 */
317
	function get_flattened_settings( $modules ) {
318
		$core_api_endpoint = new Jetpack_Core_API_Data();
319
		$settings = $core_api_endpoint->get_all_options();
320
		return $settings->data;
321
	}
322
}
323
324
/*
325
 * Only show Jump Start on first activation.
326
 * Any option 'jumpstart' other than 'new connection' will hide it.
327
 *
328
 * The option can be of 4 things, and will be stored as such:
329
 * new_connection      : Brand new connection - Show
330
 * jumpstart_activated : Jump Start has been activated - dismiss
331
 * jetpack_action_taken: Manual activation of a module already happened - dismiss
332
 * jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
333
 *
334
 * @todo move to functions.global.php when available
335
 * @since 3.6
336
 * @return bool | show or hide
337
 */
338
function jetpack_show_jumpstart() {
339
	if ( ! Jetpack::is_active() ) {
340
		return false;
341
	}
342
	$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );
343
344
	$hide_options = array(
345
		'jumpstart_activated',
346
		'jetpack_action_taken',
347
		'jumpstart_dismissed'
348
	);
349
350
	if ( ! $jumpstart_option || in_array( $jumpstart_option, $hide_options ) ) {
351
		return false;
352
	}
353
354
	return true;
355
}
356
357
/**
358
 * Gather data about the current user.
359
 *
360
 * @since 4.1.0
361
 *
362
 * @return array
363
 */
364
function jetpack_current_user_data() {
365
	$current_user = wp_get_current_user();
366
	$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
367
	$dotcom_data    = Jetpack::get_connected_user_data();
368
	// Add connected user gravatar to the returned dotcom_data.
369
	$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );
370
371
	$current_user_data = array(
372
		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
373
		'isMaster'    => $is_master_user,
374
		'username'    => $current_user->user_login,
375
		'id'          => $current_user->ID,
376
		'wpcomUser'   => $dotcom_data,
377
		'gravatar'    => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
378
		'permissions' => array(
379
			'admin_page'         => current_user_can( 'jetpack_admin_page' ),
380
			'connect'            => current_user_can( 'jetpack_connect' ),
381
			'disconnect'         => current_user_can( 'jetpack_disconnect' ),
382
			'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
383
			'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
384
			'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
385
			'edit_posts'         => current_user_can( 'edit_posts' ),
386
			'publish_posts'      => current_user_can( 'publish_posts' ),
387
			'manage_options'     => current_user_can( 'manage_options' ),
388
			'view_stats'		 => current_user_can( 'view_stats' ),
389
			'manage_plugins'	 => current_user_can( 'install_plugins' )
390
									&& current_user_can( 'activate_plugins' )
391
									&& current_user_can( 'update_plugins' )
392
									&& current_user_can( 'delete_plugins' ),
393
		),
394
	);
395
396
	return $current_user_data;
397
}
398