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

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

229 lines 6.2 KB

Raw Download Zip

1	<?php
2	/**
3	* A class that adds a Blaze dashboard to wp-admin.
4	*
5	* @since 0.7.0
6	*
7	* @package automattic/jetpack-blaze
8	*/
9
10	namespace Automattic\Jetpack\Blaze;
11
12	use Automattic\Jetpack\Assets;
13
14	/**
15	* Responsible for adding a Blaze dashboard menu to wp-admin.
16	* The screen content itself is rendered remotely.
17	*/
18	class Dashboard {
19	/**
20	* Package version.
21	*
22	* @var string
23	*/
24	const PACKAGE_VERSION = '0.29.7';
25
26	/**
27	* List of dependencies needed to render the dashboard in wp-admin.
28	*
29	* @var array
30	*/
31	const JS_DEPENDENCIES = array( 'lodash', 'react', 'react-dom', 'wp-components', 'wp-compose', 'wp-i18n', 'wp-is-shallow-equal', 'wp-primitives', 'wp-url', 'moment' );
32
33	/**
34	* URL where we load the Blaze dashboard remotely.
35	*
36	* @var string
37	*/
38	const CDN_URL = 'https://widgets.wp.com/blaze-dashboard/%s/%s';
39
40	/**
41	* Script handle for the JS file we enqueue in the dashboard page.
42	*
43	* @var string
44	*/
45	const SCRIPT_HANDLE = 'jetpack-blaze-dashboard';
46
47	/**
48	* We bump the asset version when the Jetpack back end is not compatible anymore.
49	*
50	* @var string
51	*/
52	const BLAZEDASH_VERSION = 'v1';
53
54	/**
55	* Cache key for the cache buster.
56	*
57	* @var string
58	*/
59	const BLAZEDASH_CACHE_BUSTER_CACHE_KEY = 'jetpack_blaze_admin_asset_cache_buster';
60
61	/**
62	* Blaze dashboard admin page. Default is admin.php.
63	*
64	* @var string
65	*/
66	private $admin_page;
67
68	/**
69	* Blaze dashboard menu slug. Default is 'advertising'.
70	*
71	* @var string
72	*/
73	private $menu_slug;
74
75	/**
76	* Blaze dashboard css prefix. Default is 'jp-blaze'.
77	*
78	* @var string
79	*/
80	private $css_prefix;
81
82	/**
83	* Dashboard constructor.
84	*
85	* @param string $admin_page Dashboard admin page. Default is admin.php.
86	* @param string $menu_slug Dashboard menu slug. Default is 'advertising'.
87	* @param string $css_prefix Dashboard css prefix. Default is 'jp-blaze'.
88	*/
89	public function __construct( $admin_page = 'admin.php', $menu_slug = 'advertising', $css_prefix = 'jp-blaze' ) {
90	$this->admin_page = $admin_page;
91	$this->menu_slug = $menu_slug;
92	$this->css_prefix = $css_prefix;
93	}
94
95	/**
96	* Override render funtion
97	*
98	* @return void
99	*/
100	public function render() {
101	?>
102	<div id="wpcom" class="<?php echo esc_attr( $this->css_prefix ); ?>-dashboard" style="min-height: calc(100vh - 100px);">
103	<div class="hide-if-js"><?php esc_html_e( 'Your Jetpack Blaze dashboard requires JavaScript to function properly.', 'jetpack-blaze' ); ?></div>
104	<div class="hide-if-no-js" style="height: 100%">
105	<img
106	class="<?php echo esc_attr( $this->css_prefix ); ?>-dashboard-loading-spinner"
107	width="32"
108	height="32"
109	style="position: absolute; left: 50%; top: 50%;"
110	alt=<?php echo esc_attr( __( 'Loading', 'jetpack-blaze' ) ); ?>
111	src="//en.wordpress.com/i/loading/loading-64.gif"
112	/>
113	</div>
114	</div>
115	<script>
116	jQuery(document).ready(function($) {
117	// Load SVG sprite.
118	$.get("https://widgets.wp.com/blaze-dashboard/common/gridicons-506499ddac13811fee8e.svg", function(data) {
119	var div = document.createElement("div");
120	div.innerHTML = new XMLSerializer().serializeToString(data.documentElement);
121	div.style = 'display: none';
122	document.body.insertBefore(div, document.body.childNodes[0]);
123	});
124	// we intercept on all anchor tags and change it to hashbang style.
125	$("#wpcom").on('click', 'a', function (e) {
126	const link = e && e.currentTarget && e.currentTarget.attributes && e.currentTarget.attributes.href && e.currentTarget.attributes.href.value;
127	if (link && link.startsWith( '/<?php echo esc_attr( $this->menu_slug ); ?>' ) ) {
128	location.hash = `#!${link}`;
129	return false;
130	}
131	});
132	});
133	</script>
134	<?php
135	}
136
137	/**
138	* Initialize the admin resources.
139	*/
140	public function admin_init() {
141	add_action( 'admin_enqueue_scripts', array( $this, 'load_admin_scripts' ) );
142	}
143
144	/**
145	* Load the admin scripts.
146	*
147	* @param string $hook The current admin page.
148	*/
149	public function load_admin_scripts( $hook ) {
150	if ( ! str_ends_with( $hook, 'page_' . $this->menu_slug ) ) {
151	return;
152	}
153
154	$asset_handle = self::SCRIPT_HANDLE;
155	$asset_name = 'build.min';
156
157	$dashboard_config = new Dashboard_Config_Data( $this->admin_page, $this->menu_slug );
158
159	$config_data = $dashboard_config->get_data();
160
161	if ( file_exists( __DIR__ . "/../dist/{$asset_name}.js" ) ) {
162	// Load local assets for the convenience of development.
163	Assets::register_script(
164	$asset_handle,
165	"../dist/{$asset_name}.js",
166	__FILE__,
167	array(
168	'enqueue' => true,
169	'in_footer' => true,
170	'textdomain' => 'jetpack-blaze',
171	)
172	);
173	} else {
174	$css_url = $asset_name . ( is_rtl() ? '.rtl' : '' ) . '.css';
175	$css_handle = $asset_handle . '-style';
176
177	wp_enqueue_script(
178	$asset_handle,
179	sprintf( self::CDN_URL, self::BLAZEDASH_VERSION, "{$asset_name}.js" ),
180	self::JS_DEPENDENCIES,
181	$this->get_cdn_asset_cache_buster(),
182	true
183	);
184	wp_enqueue_style(
185	$css_handle,
186	sprintf( self::CDN_URL, self::BLAZEDASH_VERSION, $css_url ),
187	array(),
188	$this->get_cdn_asset_cache_buster()
189	);
190	}
191
192	wp_add_inline_script(
193	$asset_handle,
194	$dashboard_config->get_js_config_data( $config_data ),
195	'before'
196	);
197	}
198
199	/**
200	* Returns cache buster string for assets.
201	* Development mode doesn't need this, as it's handled by `Assets` class.
202	*/
203	protected function get_cdn_asset_cache_buster() {
204	// Use cached cache buster in production.
205	$remote_asset_version = get_transient( self::BLAZEDASH_CACHE_BUSTER_CACHE_KEY );
206	if ( ! empty( $remote_asset_version ) ) {
207	return $remote_asset_version;
208	}
209
210	// If no cached cache buster, we fetch it from CDN and set to transient.
211	$response = wp_remote_get( sprintf( self::CDN_URL, self::BLAZEDASH_VERSION, 'build_meta.json' ), array( 'timeout' => 5 ) );
212
213	if ( is_wp_error( $response ) ) {
214	// fallback to the package version.
215	return self::PACKAGE_VERSION;
216	}
217
218	$build_meta = json_decode( wp_remote_retrieve_body( $response ), true );
219	if ( ! empty( $build_meta['cache_buster'] ) ) {
220	// Cache the cache buster for 15 mins.
221	set_transient( self::BLAZEDASH_CACHE_BUSTER_CACHE_KEY, $build_meta['cache_buster'], 15 * MINUTE_IN_SECONDS );
222	return $build_meta['cache_buster'];
223	}
224
225	// fallback to the package version.
226	return self::PACKAGE_VERSION;
227	}
228	}
229