jetpack / jetpack_vendor / automattic / jetpack-blaze / src / class-dashboard-config-data.php

class-dashboard-config-data.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-beta, at jetpack_vendor/automattic/jetpack-blaze/src/class-dashboard-config-data.php

216 lines 6.0 KB

Raw Download Zip

1	<?php
2	/**
3	* Blaze dashboard Initial State
4	*
5	* @package automattic/jetpack-blaze
6	*/
7
8	namespace Automattic\Jetpack\Blaze;
9
10	use Automattic\Jetpack\Connection\Manager;
11	use Automattic\Jetpack\Constants;
12	use Automattic\Jetpack\Current_Plan;
13	use Automattic\Jetpack\Status\Host;
14	use Jetpack_Options;
15
16	/**
17	* Class Dashboard_Config_Data
18	*/
19	class Dashboard_Config_Data {
20
21	/**
22	* Blaze dashboard admin page. Default is admin.php.
23	*
24	* @var string
25	*/
26	private $admin_page;
27
28	/**
29	* Blaze dashboard menu slug. Default is 'advertising'.
30	*
31	* @var string
32	*/
33	private $menu_slug;
34
35	/**
36	* Dashboard config constructor.
37	*
38	* @param string $admin_page Dashboard admin page. Default is admin.php.
39	* @param string $menu_slug Dashboard menu slug. Default is 'advertising'.
40	*/
41	public function __construct( $admin_page = 'admin.php', $menu_slug = 'advertising' ) {
42	$this->admin_page = $admin_page;
43	$this->menu_slug = $menu_slug;
44	}
45
46	/**
47	* Set configData to window.configData.
48	*
49	* @param array $config_data The config data.
50	*/
51	public function get_js_config_data( $config_data = null ) {
52	return 'window.configData = ' . wp_json_encode(
53	$config_data === null ? $this->get_data() : $config_data,
54	JSON_UNESCAPED_SLASHES \| JSON_HEX_TAG \| JSON_HEX_AMP
55	) . ';';
56	}
57
58	/**
59	* Return the config for the app.
60	*/
61	public function get_data() {
62	$blog_id = Jetpack_Options::get_option( 'id' );
63	$host = new Host();
64	$empty_object = json_decode( '{}' );
65
66	$user = $this->get_connected_user_identity();
67
68	$data = array(
69	'admin_page_base' => $this->get_admin_path(),
70	'api_root' => esc_url_raw( rest_url() ),
71	'blog_id' => $blog_id,
72	'enable_all_sections' => false,
73	'env_id' => 'production',
74	'google_analytics_key' => 'UA-10673494-15',
75	'hostname' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
76	'i18n_default_locale_slug' => 'en',
77	'mc_analytics_enabled' => false,
78	'meta' => array(),
79	'nonce' => wp_create_nonce( 'wp_rest' ),
80	'site_name' => \get_bloginfo( 'name' ),
81	'sections' => array(),
82	// Features are inlined in Calypso Blaze app (wp-calypso/apps/blaze-dashboard)
83	'features' => array(
84	'is_running_in_jetpack_site' => ! $host->is_wpcom_simple(),
85	),
86	'initial_state' => array(
87	'currentUser' => array(
88	'id' => $user['ID'],
89	'user' => $user,
90	'capabilities' => array(
91	"$blog_id" => $this->get_current_user_capabilities(),
92	),
93	),
94	'sites' => array(
95	'items' => array(
96	"$blog_id" => array(
97	'ID' => $blog_id,
98	'URL' => site_url(),
99	'jetpack' => ! $host->is_wpcom_simple(),
100	'visible' => true,
101	'capabilities' => $empty_object,
102	'products' => array(),
103	'plan' => $empty_object, // we need this empty object, otherwise the front end would crash on insight page.
104	'options' => array(
105	'admin_url' => admin_url(),
106	'gmt_offset' => $this->get_gmt_offset(),
107	'is_wpcom_atomic' => $host->is_woa_site(),
108	'is_wpcom_simple' => $host->is_wpcom_simple(),
109	'jetpack_version' => Constants::get_constant( 'JETPACK__VERSION' ),
110	),
111	),
112	),
113	'features' => array( "$blog_id" => array( 'data' => $this->get_plan_features() ) ),
114	),
115	),
116	);
117
118	/**
119	* Filter to allow modification of the Blaze dashboard config data.
120	*
121	* @param bool $data Blaze dashboard config data.
122	*
123	* @since 0.21.0
124	*/
125	return apply_filters( 'jetpack_blaze_dashboard_config_data', $data );
126	}
127
128	/**
129	* Gets the WordPress.com user's identity, if connected.
130	*
131	* @return array\|bool
132	*/
133	protected function get_connected_user_identity() {
134	$user_data = ( new Manager() )->get_connected_user_data();
135	if ( ! $user_data ) {
136	return array(
137	'ID' => 1000,
138	'username' => 'no-user',
139	'localeSlug' => $this->get_locale(),
140	'site_count' => 1,
141	);
142	}
143
144	return array(
145	'ID' => $user_data['ID'],
146	'username' => $user_data['login'],
147	'email' => $user_data['email'],
148	'localeSlug' => $this->get_locale(),
149	'site_count' => 1,
150	);
151	}
152
153	/**
154	* Get the current site GMT Offset.
155	*
156	* @return float The current site GMT Offset by hours.
157	*/
158	protected function get_gmt_offset() {
159	return (float) get_option( 'gmt_offset' );
160	}
161
162	/**
163	* Page base for the Calypso admin page.
164	*/
165	protected function get_admin_path() {
166	if ( ! isset( $_SERVER['PHP_SELF'] ) \|\| ! isset( $_SERVER['QUERY_STRING'] ) ) {
167	$admin_path = $this->admin_page . '?page=' . $this->menu_slug;
168	$parsed = wp_parse_url( admin_url( $admin_path ) );
169
170	return $parsed['path'] . '?' . $parsed['query'];
171	}
172	// We do this because page.js requires the exactly page base to be set otherwise it will not work properly.
173	// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
174	return wp_unslash( $_SERVER['PHP_SELF'] ) . '?' . wp_unslash( $_SERVER['QUERY_STRING'] );
175	}
176
177	/**
178	* Get the user's locale acceptable by Calypso.
179	*/
180	protected function get_locale() {
181	/**
182	* In WP, locales are formatted as LANGUAGE_REGION, for example `en`, `en_US`, `es_AR`,
183	* but Calypso expects language-region, e.g. `en-us`, `en`, `es-ar`. So we need to convert
184	* them to lower case and replace the underscore with a dash.
185	*/
186	$locale = strtolower( get_user_locale() );
187	$locale = str_replace( '_', '-', $locale );
188
189	return $locale;
190	}
191
192	/**
193	* Get the features of the current plan.
194	*/
195	protected function get_plan_features() {
196	$plan = Current_Plan::get();
197	if ( empty( $plan['features'] ) ) {
198	return array();
199	}
200	return $plan['features'];
201	}
202
203	/**
204	* Get the capabilities of the current user.
205	*
206	* @return array An array of capabilities.
207	*/
208	protected function get_current_user_capabilities() {
209	$user = wp_get_current_user();
210	if ( ! $user \|\| is_wp_error( $user ) ) {
211	return array();
212	}
213	return $user->allcaps;
214	}
215	}
216