Completed
Push — instant-search-master ( 95535d...2c1eb1 )
by
unknown
22:37 queued 16:04
created

Jetpack_React_Page::page_admin_scripts()   A

Complexity

Conditions 5
Paths 5

Size

Total Lines 30

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
nc 5
nop 0
dl 0
loc 30
rs 9.1288
c 0
b 0
f 0
1
<?php
2
use Automattic\Jetpack\Status;
3
use Automattic\Jetpack\Partner;
4
5
include_once( 'class.jetpack-admin-page.php' );
6
7
// Builds the landing page and its menu
8
class Jetpack_React_Page extends Jetpack_Admin_Page {
9
10
	protected $dont_show_if_not_active = false;
11
12
	protected $is_redirecting = false;
13
14
	function get_page_hook() {
15
		// Add the main admin Jetpack menu
16
		return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
17
	}
18
19
	function add_page_actions( $hook ) {
20
		/** This action is documented in class.jetpack.php */
21
		do_action( 'jetpack_admin_menu', $hook );
22
23
		// Place the Jetpack menu item on top and others in the order they appear
24
		add_filter( 'custom_menu_order',         '__return_true' );
25
		add_filter( 'menu_order',                array( $this, 'jetpack_menu_order' ) );
26
27
		if ( ! isset( $_GET['page'] ) || 'jetpack' !== $_GET['page'] ) {
28
			return; // No need to handle the fallback redirection if we are not on the Jetpack page
29
		}
30
31
		// Adding a redirect meta tag if the REST API is disabled
32
		if ( ! $this->is_rest_api_enabled() ) {
33
			$this->is_redirecting = true;
34
			add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
35
		}
36
37
		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
38
		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
39
40
		// If this is the first time the user is viewing the admin, don't show JITMs.
41
		// This filter is added just in time because this function is called on admin_menu
42
		// and JITMs are initialized on admin_init
43
		if ( Jetpack::is_active() && ! Jetpack_Options::get_option( 'first_admin_view', false ) ) {
44
			Jetpack_Options::update_option( 'first_admin_view', true );
45
			add_filter( 'jetpack_just_in_time_msgs', '__return_false' );
46
		}
47
	}
48
49
	/**
50
	 * Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
51
	 *
52
	 * Works in Dev Mode or when user is connected.
53
	 *
54
	 * @since 4.3.0
55
	 */
56
	function jetpack_add_dashboard_sub_nav_item() {
57 View Code Duplication
		if ( ( new Status() )->is_development_mode() || Jetpack::is_active() ) {
58
			global $submenu;
59
			if ( current_user_can( 'jetpack_admin_page' ) ) {
60
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
61
			}
62
		}
63
	}
64
65
	/**
66
	 * If user is allowed to see the Jetpack Admin, add Settings sub-link.
67
	 *
68
	 * @since 4.3.0
69
	 */
70
	function jetpack_add_settings_sub_nav_item() {
71 View Code Duplication
		if ( ( ( new Status() )->is_development_mode() || Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
72
			global $submenu;
73
			$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
74
		}
75
	}
76
77
	function add_fallback_head_meta() {
78
		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
79
	}
80
81
	function add_noscript_head_meta() {
82
		echo '<noscript>';
83
		$this->add_fallback_head_meta();
84
		echo '</noscript>';
85
	}
86
87 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
88
		$jp_menu_order = array();
89
90
		foreach ( $menu_order as $index => $item ) {
91
			if ( $item != 'jetpack' )
92
				$jp_menu_order[] = $item;
93
94
			if ( $index == 0 )
95
				$jp_menu_order[] = 'jetpack';
96
		}
97
98
		return $jp_menu_order;
99
	}
100
101
	function page_render() {
102
		/** This action is already documented in views/admin/admin-page.php */
103
		do_action( 'jetpack_notices' );
104
105
		// Try fetching by patch
106
		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
107
108
		if ( false === $static_html ) {
109
110
			// If we still have nothing, display an error
111
			echo '<p>';
112
			esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
113
			echo '<code>yarn distclean && yarn build</code>';
114
			echo '</p>';
115
		} else {
116
117
			// We got the static.html so let's display it
118
			echo $static_html;
119
		}
120
	}
121
122
	/**
123
	 * Gets array of any Jetpack notices that have been dismissed.
124
	 *
125
	 * @since 4.0.1
126
	 * @return mixed|void
127
	 */
128
	function get_dismissed_jetpack_notices() {
129
		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
130
		/**
131
		 * Array of notices that have been dismissed.
132
		 *
133
		 * @since 4.0.1
134
		 *
135
		 * @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
136
		 */
137
		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
138
		return $dismissed_notices;
139
	}
140
141
	function additional_styles() {
142
		Jetpack_Admin_Page::load_wrapper_styles();
143
	}
144
145
	function page_admin_scripts() {
146
		if ( $this->is_redirecting ) {
147
			return; // No need for scripts on a fallback page
148
		}
149
150
151
		$is_development_mode = ( new Status() )->is_development_mode();
152
		$script_deps_path    = JETPACK__PLUGIN_DIR . '_inc/build/admin.asset.php';
153
		$script_dependencies = array( 'wp-polyfill' );
154
		if ( file_exists( $script_deps_path ) ) {
155
			$asset_manifest      = include $script_deps_path;
156
			$script_dependencies = $asset_manifest['dependencies'];
157
		}
158
159
		wp_enqueue_script(
160
			'react-plugin',
161
			plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
162
			$script_dependencies,
163
			JETPACK__VERSION,
164
			true
165
		);
166
167
		if ( ! $is_development_mode && Jetpack::is_active() ) {
168
			// Required for Analytics.
169
			wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
170
		}
171
172
		// Add objects to be passed to the initial state of the app.
173
		wp_localize_script( 'react-plugin', 'Initial_State', $this->get_initial_state() );
174
	}
175
176
	function get_initial_state() {
177
		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
178
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
179
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
180
		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
181
		$modules = $moduleListEndpoint->get_modules();
182
183
		// Preparing translated fields for JSON encoding by transforming all HTML entities to
184
		// respective characters.
185
		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...
186
			$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
187
			$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
188
			$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
189
			$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
190
		}
191
192
		// Collecting roles that can view site stats.
193
		$stats_roles = array();
194
		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
195
196
		if ( ! function_exists( 'get_editable_roles' ) ) {
197
			require_once ABSPATH . 'wp-admin/includes/user.php';
198
		}
199
		foreach ( get_editable_roles() as $slug => $role ) {
200
			$stats_roles[ $slug ] = array(
201
				'name' => translate_user_role( $role['name'] ),
202
				'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
203
			);
204
		}
205
206
		// Get information about current theme.
207
		$current_theme = wp_get_theme();
208
209
		// Get all themes that Infinite Scroll provides support for natively.
210
		$inf_scr_support_themes = array();
211
		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
212
			if ( is_readable( $path ) ) {
213
				$inf_scr_support_themes[] = basename( $path, '.php' );
214
			}
215
		}
216
217
		// Get last post, to build the link to Customizer in the Related Posts module.
218
		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
219
		$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...
220
			? get_permalink( $last_post[0]->ID )
221
			: get_home_url();
222
223
		$current_user_data = jetpack_current_user_data();
224
225
		$status = new Status();
226
227
		return array(
228
			'WP_API_root'                 => esc_url_raw( rest_url() ),
229
			'WP_API_nonce'                => wp_create_nonce( 'wp_rest' ),
230
			'pluginBaseUrl'               => plugins_url( '', JETPACK__PLUGIN_FILE ),
231
			'connectionStatus'            => array(
232
				'isActive'           => Jetpack::is_active(),
233
				'isStaging'          => $status->is_staging_site(),
234
				'devMode'            => array(
235
					'isActive' => $status->is_development_mode(),
236
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
237
					'url'      => site_url() && false === strpos( site_url(), '.' ),
238
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
239
				),
240
				'isPublic'           => '1' == get_option( 'blog_public' ), // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
241
				'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
242
				'sandboxDomain'      => JETPACK__SANDBOX_DOMAIN,
243
			),
244
			'connectUrl'                  => false == $current_user_data['isConnected'] // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
245
				? Jetpack::init()->build_connect_url( true, false, false )
246
				: '',
247
			'dismissedNotices'            => $this->get_dismissed_jetpack_notices(),
248
			'isDevVersion'                => Jetpack::is_development_version(),
249
			'currentVersion'              => JETPACK__VERSION,
250
			'is_gutenberg_available'      => true,
251
			'getModules'                  => $modules,
252
			'rawUrl'                      => Jetpack::build_raw_urls( get_home_url() ),
253
			'adminUrl'                    => esc_url( admin_url() ),
254
			'stats'                       => array(
255
				// data is populated asynchronously on page load.
256
				'data'  => array(
257
					'general' => false,
258
					'day'     => false,
259
					'week'    => false,
260
					'month'   => false,
261
				),
262
				'roles' => $stats_roles,
263
			),
264
			'aff'                         => Partner::init()->get_partner_code( Partner::AFFILIATE_CODE ),
265
			'partnerSubsidiaryId'         => Partner::init()->get_partner_code( Partner::SUBSIDIARY_CODE ),
266
			'settings'                    => $this->get_flattened_settings( $modules ),
0 ignored issues
show
Bug introduced by
It seems like $modules defined by $moduleListEndpoint->get_modules() on line 181 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...
267
			'userData'                    => array(
268
				'currentUser' => $current_user_data,
269
			),
270
			'siteData'                    => array(
271
				'icon'                       => has_site_icon()
272
					? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
273
					: '',
274
				'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ), // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
275
				/**
276
				 * Whether promotions are visible or not.
277
				 *
278
				 * @since 4.8.0
279
				 *
280
				 * @param bool $are_promotions_active Status of promotions visibility. True by default.
281
				 */
282
				'showPromotions'             => apply_filters( 'jetpack_show_promotions', true ),
283
				'isAtomicSite'               => jetpack_is_atomic_site(),
284
				'plan'                       => Jetpack_Plan::get(),
285
				'showBackups'                => Jetpack::show_backups_ui(),
286
				'isMultisite'                => is_multisite(),
287
			),
288
			'themeData'                   => array(
289
				'name'      => $current_theme->get( 'Name' ),
290
				'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
291
				'support'   => array(
292
					'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) || in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes, true ),
293
				),
294
			),
295
			'locale'                      => Jetpack::get_i18n_data_json(),
296
			'localeSlug'                  => join( '-', explode( '_', get_user_locale() ) ),
297
			'jetpackStateNotices'         => array(
298
				'messageCode'      => Jetpack::state( 'message' ),
299
				'errorCode'        => Jetpack::state( 'error' ),
300
				'errorDescription' => Jetpack::state( 'error_description' ),
301
			),
302
			'tracksUserData'              => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
303
			'currentIp'                   => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
304
			'lastPostUrl'                 => esc_url( $last_post ),
305
			'externalServicesConnectUrls' => $this->get_external_services_connect_urls(),
306
			'calypsoEnv'                  => Jetpack::get_calypso_env(),
307
		);
308
	}
309
310
	function get_external_services_connect_urls() {
311
		$connect_urls = array();
312
		jetpack_require_lib( 'class.jetpack-keyring-service-helper' );
313
		foreach ( Jetpack_Keyring_Service_Helper::$SERVICES as $service_name => $service_info ) {
314
			$connect_urls[ $service_name ] = Jetpack_Keyring_Service_Helper::connect_url( $service_name, $service_info[ 'for' ] );
315
		}
316
		return $connect_urls;
317
	}
318
319
	/**
320
	 * Returns an array of modules and settings both as first class members of the object.
321
	 *
322
	 * @param array $modules the result of an API request to get all modules.
323
	 *
324
	 * @return array flattened settings with modules.
325
	 */
326
	function get_flattened_settings( $modules ) {
327
		$core_api_endpoint = new Jetpack_Core_API_Data();
328
		$settings = $core_api_endpoint->get_all_options();
329
		return $settings->data;
330
	}
331
}
332
333
/**
334
 * Gather data about the current user.
335
 *
336
 * @since 4.1.0
337
 *
338
 * @return array
339
 */
340
function jetpack_current_user_data() {
341
	$current_user   = wp_get_current_user();
342
	$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
343
	$dotcom_data    = Jetpack::get_connected_user_data();
344
345
	// Add connected user gravatar to the returned dotcom_data.
346
	$dotcom_data['avatar'] = ( ! empty( $dotcom_data['email'] ) ?
347
		get_avatar_url(
348
			$dotcom_data['email'],
349
			array(
350
				'size'    => 64,
351
				'default' => 'mysteryman',
352
			)
353
		)
354
		: false );
355
356
	$current_user_data = array(
357
		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
358
		'isMaster'    => $is_master_user,
359
		'username'    => $current_user->user_login,
360
		'id'          => $current_user->ID,
361
		'wpcomUser'   => $dotcom_data,
362
		'gravatar'    => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
363
		'permissions' => array(
364
			'admin_page'         => current_user_can( 'jetpack_admin_page' ),
365
			'connect'            => current_user_can( 'jetpack_connect' ),
366
			'disconnect'         => current_user_can( 'jetpack_disconnect' ),
367
			'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
368
			'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
369
			'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
370
			'edit_posts'         => current_user_can( 'edit_posts' ),
371
			'publish_posts'      => current_user_can( 'publish_posts' ),
372
			'manage_options'     => current_user_can( 'manage_options' ),
373
			'view_stats'		 => current_user_can( 'view_stats' ),
374
			'manage_plugins'	 => current_user_can( 'install_plugins' )
375
									&& current_user_can( 'activate_plugins' )
376
									&& current_user_can( 'update_plugins' )
377
									&& current_user_can( 'delete_plugins' ),
378
		),
379
	);
380
381
	return $current_user_data;
382
}
383