jetpack / modules / notes.php

notes.php in Jetpack – WP Security, Backup, Speed, & Growth 14.4, at modules/notes.php

259 lines 7.7 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Module Name: Notifications
4	* Module Description: Receive instant notifications of site comments and likes.
5	* Sort Order: 13
6	* First Introduced: 1.9
7	* Requires Connection: Yes
8	* Requires User Connection: Yes
9	* Auto Activate: Yes
10	* Module Tags: Other
11	* Feature: General
12	* Additional Search Queries: notification, notifications, toolbar, adminbar, push, comments
13	*
14	* @package automattic/jetpack
15	*/
16
17	use Automattic\Jetpack\Connection\Manager as Connection_Manager;
18	use Automattic\Jetpack\Status\Host;
19
20	if ( ! defined( 'JETPACK_NOTES__CACHE_BUSTER' ) ) {
21	define( 'JETPACK_NOTES__CACHE_BUSTER', JETPACK__VERSION . '-' . gmdate( 'oW' ) . '-lite' );
22	}
23
24	/**
25	* Notifications class.
26	*/
27	class Jetpack_Notifications {
28	/**
29	* Jetpack object.
30	*
31	* @var bool\|Jetpack Jetpack object.
32	*/
33	public $jetpack = false;
34
35	/**
36	* Singleton
37	*
38	* @static
39	*/
40	public static function init() {
41	static $instance = array();
42
43	if ( ! $instance ) {
44	$instance[0] = new Jetpack_Notifications();
45	}
46
47	return $instance[0];
48	}
49
50	/**
51	* Constructor.
52	*/
53	private function __construct() {
54	$this->jetpack = Jetpack::init();
55
56	add_action( 'init', array( $this, 'action_init' ) );
57	}
58
59	/**
60	* Adds s0.wp.com to a file path.
61	*
62	* @param string $file File path.
63	*
64	* @return string
65	*/
66	public function wpcom_static_url( $file ) {
67	return 'https://s0.wp.com' . $file;
68	}
69
70	/**
71	* Init the notifications admin bar.
72	*
73	* @return void
74	*/
75	public function action_init() {
76	if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
77	return;
78	}
79
80	if ( ! has_filter( 'show_admin_bar', '__return_true' ) && ! is_user_logged_in() ) {
81	return;
82	}
83
84	// Do not show notifications in the Site Editor, which is always in fullscreen mode.
85	global $pagenow;
86
87	// Pre 13.7 pages that still need to be supported if < 13.7 is
88	// still installed.
89	$allowed_old_pages = array( 'admin.php', 'themes.php' );
90	$is_old_site_editor_page = in_array( $pagenow, $allowed_old_pages, true ) && isset( $_GET['page'] ) && 'gutenberg-edit-site' === $_GET['page']; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
91	// For Gutenberg > 13.7, the core `site-editor.php` route is used instead
92	$is_site_editor_page = 'site-editor.php' === $pagenow;
93
94	if ( $is_site_editor_page \|\| $is_old_site_editor_page ) {
95	return;
96	}
97
98	add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 );
99	add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 );
100	add_action( 'admin_head', array( $this, 'styles_and_scripts' ) );
101	}
102
103	/**
104	* Enqueues and registers styles/scripts for notifications.
105	*
106	* @return void
107	*/
108	public function styles_and_scripts() {
109	if ( self::is_block_editor() ) {
110	return;
111	}
112	$is_rtl = is_rtl();
113
114	if ( ( new Host() )->is_woa_site() ) {
115	/**
116	* Can be used to force Notifications to display in RTL style.
117	*
118	* @module notes
119	*
120	* @since 4.8.0
121	*
122	* @param bool true Should notifications be displayed in RTL style. Defaults to false.
123	*/
124	$is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
125	}
126
127	if ( ! $is_rtl ) {
128	wp_enqueue_style( 'wpcom-notes-admin-bar', $this->wpcom_static_url( '/wp-content/mu-plugins/notes/admin-bar-v2.css' ), array( 'admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
129	} else {
130	wp_enqueue_style( 'wpcom-notes-admin-bar', $this->wpcom_static_url( '/wp-content/mu-plugins/notes/rtl/admin-bar-v2-rtl.css' ), array( 'admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
131	}
132
133	wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
134
135	$this->print_js();
136
137	$script_handles = array();
138	wp_register_script( 'wpcom-notes-common', $this->wpcom_static_url( '/wp-content/mu-plugins/notes/notes-common-lite.min.js' ), array(), JETPACK_NOTES__CACHE_BUSTER, true );
139	$script_handles[] = 'wpcom-notes-common';
140	wp_enqueue_script( 'wpcom-notes-admin-bar', $this->wpcom_static_url( '/wp-content/mu-plugins/notes/admin-bar-v2.js' ), array( 'wpcom-notes-common' ), JETPACK_NOTES__CACHE_BUSTER, true );
141	$script_handles[] = 'wpcom-notes-admin-bar';
142
143	$wp_notes_args = 'var wpNotesArgs = ' . wp_json_encode( array( 'cacheBuster' => JETPACK_NOTES__CACHE_BUSTER ) ) . ';';
144	wp_add_inline_script( 'wpcom-notes-admin-bar', $wp_notes_args, 'before' );
145
146	if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
147	add_filter(
148	'script_loader_tag',
149	function ( $tag, $handle ) use ( $script_handles ) {
150	if ( in_array( $handle, $script_handles, true ) ) {
151	$tag = preg_replace( '/(?<=<script)(?=\s\|>)/i', ' data-ampdevmode', $tag );
152	}
153	return $tag;
154	},
155	10,
156	2
157	);
158	}
159	}
160
161	/**
162	* Adds notifications bubble to the admin bar.
163	*
164	* @return void
165	*/
166	public function admin_bar_menu() {
167	global $wp_admin_bar;
168
169	if ( ! is_object( $wp_admin_bar ) ) {
170	return;
171	}
172
173	if ( self::is_block_editor() ) {
174	return;
175	}
176
177	$user_locale = get_user_locale();
178
179	if ( ! class_exists( 'GP_Locales' ) ) {
180	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
181	require JETPACK__GLOTPRESS_LOCALES_PATH;
182	}
183	}
184
185	if ( class_exists( 'GP_Locales' ) ) {
186	$jetpack_locale_object = GP_Locales::by_field( 'slug', $user_locale );
187	if ( $jetpack_locale_object instanceof GP_Locale ) {
188	$user_locale = $jetpack_locale_object->slug;
189	}
190	}
191
192	$third_party_cookie_check_iframe = '<span style="display:none;"><iframe class="jetpack-notes-cookie-check" src="https://widgets.wp.com/3rd-party-cookie-check/index.html"></iframe></span>';
193
194	$title = self::get_notes_markup();
195
196	// The default fallback is `en_US`. Remove underscore if present, noting that lang codes can be more than three chars.
197	$user_locale = strtolower( explode( '_', $user_locale, 2 )[0] );
198
199	$wp_admin_bar->add_menu(
200	array(
201	'id' => 'notes',
202	'title' => $title,
203	'meta' => array(
204	'html' => '<div id="wpnt-notes-panel2" class="intrinsic-ignore" style="display:none" lang="' . esc_attr( $user_locale ) . '" dir="' . ( is_rtl() ? 'rtl' : 'ltr' ) . '"><div class="wpnt-notes-panel-header"><span class="wpnt-notes-header">' . __( 'Notifications', 'jetpack' ) . '</span><span class="wpnt-notes-panel-link"></span></div></div>' . $third_party_cookie_check_iframe,
205	'class' => 'menupop',
206	),
207	'parent' => 'top-secondary',
208	'href' => 'https://wordpress.com/notifications',
209	)
210	);
211	}
212
213	/**
214	* Returns the HTML markup for used by notification in top bar
215	*
216	* @return string
217	*/
218	private static function get_notes_markup() {
219	return '<span id="wpnt-notes-unread-count" class="wpnt-loading wpn-read"></span>
220	<span class="noticon noticon-bell ab-icon"></span>
221	<span class="screen-reader-text">' . esc_html__( 'Notifications', 'jetpack' ) . '</span>';
222	}
223
224	/**
225	* Echos the Notes JS.
226	*
227	* @return void
228	*/
229	public function print_js() {
230	$link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
231	?>
232	<script data-ampdevmode type="text/javascript">
233	/* <![CDATA[ */
234	var wpNotesIsJetpackClient = true;
235	var wpNotesIsJetpackClientV2 = true;
236	<?php if ( $link_accounts_url ) : ?>
237	var wpNotesLinkAccountsURL = '<?php echo esc_url( $link_accounts_url ); ?>';
238	<?php endif; ?>
239	/* ]]> */
240	</script>
241	<?php
242	}
243
244	/**
245	* Checks to see if we're in the block editor.
246	*/
247	public static function is_block_editor() {
248	if ( function_exists( 'get_current_screen' ) ) {
249	$current_screen = get_current_screen();
250	if ( ! empty( $current_screen ) && $current_screen->is_block_editor() ) {
251	return true;
252	}
253	}
254	return false;
255	}
256	}
257
258	Jetpack_Notifications::init();
259