jetpack / modules / notes.php

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

256 lines 7.5 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
19	if ( ! defined( 'JETPACK_NOTES__CACHE_BUSTER' ) ) {
20	define( 'JETPACK_NOTES__CACHE_BUSTER', JETPACK__VERSION . '-' . gmdate( 'oW' ) . '-lite' );
21	}
22
23	/**
24	* Notifications class.
25	*/
26	class Jetpack_Notifications {
27	/**
28	* Jetpack object.
29	*
30	* @var bool\|Jetpack Jetpack object.
31	*/
32	public $jetpack = false;
33
34	/**
35	* Singleton
36	*
37	* @static
38	*/
39	public static function init() {
40	static $instance = array();
41
42	if ( ! $instance ) {
43	$instance[0] = new Jetpack_Notifications();
44	}
45
46	return $instance[0];
47	}
48
49	/**
50	* Constructor.
51	*/
52	private function __construct() {
53	$this->jetpack = Jetpack::init();
54
55	add_action( 'init', array( $this, 'action_init' ) );
56	}
57
58	/**
59	* Adds s0.wp.com to a file path.
60	*
61	* @param string $file File path.
62	*
63	* @return string
64	*/
65	public function wpcom_static_url( $file ) {
66	return 'https://s0.wp.com' . $file;
67	}
68
69	/**
70	* Init the notifications admin bar.
71	*
72	* @return void
73	*/
74	public function action_init() {
75	if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
76	return;
77	}
78
79	if ( ! has_filter( 'show_admin_bar', '__return_true' ) && ! is_user_logged_in() ) {
80	return;
81	}
82
83	// Do not show notifications in the Site Editor, which is always in fullscreen mode.
84	global $pagenow;
85
86	// Pre 13.7 pages that still need to be supported if < 13.7 is
87	// still installed.
88	$allowed_old_pages = array( 'admin.php', 'themes.php' );
89	$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
90	// For Gutenberg > 13.7, the core `site-editor.php` route is used instead
91	$is_site_editor_page = 'site-editor.php' === $pagenow;
92
93	if ( $is_site_editor_page \|\| $is_old_site_editor_page ) {
94	return;
95	}
96
97	add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 );
98	add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 );
99	add_action( 'admin_head', array( $this, 'styles_and_scripts' ) );
100	}
101
102	/**
103	* Enqueues and registers styles/scripts for notifications.
104	*
105	* @return void
106	*/
107	public function styles_and_scripts() {
108	if ( self::is_block_editor() ) {
109	return;
110	}
111	$is_rtl = is_rtl();
112
113	if ( Jetpack::is_module_active( 'masterbar' ) ) {
114	/**
115	* Can be used to force Notifications to display in RTL style.
116	*
117	* @module notes
118	*
119	* @since 4.8.0
120	*
121	* @param bool true Should notifications be displayed in RTL style. Defaults to false.
122	*/
123	$is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
124	}
125
126	if ( ! $is_rtl ) {
127	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 );
128	} else {
129	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 );
130	}
131
132	wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
133
134	$this->print_js();
135
136	$script_handles = array();
137	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 );
138	$script_handles[] = 'wpcom-notes-common';
139	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 );
140	$script_handles[] = 'wpcom-notes-admin-bar';
141
142	if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
143	add_filter(
144	'script_loader_tag',
145	function ( $tag, $handle ) use ( $script_handles ) {
146	if ( in_array( $handle, $script_handles, true ) ) {
147	$tag = preg_replace( '/(?<=<script)(?=\s\|>)/i', ' data-ampdevmode', $tag );
148	}
149	return $tag;
150	},
151	10,
152	2
153	);
154	}
155	}
156
157	/**
158	* Adds notifications bubble to the admin bar.
159	*
160	* @return void
161	*/
162	public function admin_bar_menu() {
163	global $wp_admin_bar;
164
165	if ( ! is_object( $wp_admin_bar ) ) {
166	return;
167	}
168
169	if ( self::is_block_editor() ) {
170	return;
171	}
172
173	$wpcom_locale = get_locale();
174
175	if ( ! class_exists( 'GP_Locales' ) ) {
176	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
177	require JETPACK__GLOTPRESS_LOCALES_PATH;
178	}
179	}
180
181	if ( class_exists( 'GP_Locales' ) ) {
182	$wpcom_locale_object = GP_Locales::by_field( 'wp_locale', $wpcom_locale );
183	if ( $wpcom_locale_object instanceof GP_Locale ) {
184	$wpcom_locale = $wpcom_locale_object->slug;
185	}
186	}
187
188	$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>';
189
190	$classes = 'wpnt-loading wpn-read';
191	$wp_admin_bar->add_menu(
192	array(
193	'id' => 'notes',
194	'title' => '<span id="wpnt-notes-unread-count" class="' . esc_attr( $classes ) . '">
195	<span class="noticon noticon-notification"></span>
196	</span>',
197	'meta' => array(
198	'html' => '<div id="wpnt-notes-panel2" class="intrinsic-ignore" style="display:none" lang="' . esc_attr( $wpcom_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,
199	'class' => 'menupop',
200	),
201	'parent' => 'top-secondary',
202	)
203	);
204	}
205
206	/**
207	* Echos the Notes JS.
208	*
209	* @return void
210	*/
211	public function print_js() {
212	$link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
213	?>
214	<script data-ampdevmode type="text/javascript">
215	/* <![CDATA[ */
216	var wpNotesIsJetpackClient = true;
217	var wpNotesIsJetpackClientV2 = true;
218	<?php if ( $link_accounts_url ) : ?>
219	var wpNotesLinkAccountsURL = '<?php echo esc_url( $link_accounts_url ); ?>';
220	<?php endif; ?>
221	/* ]]> */
222	window.addEventListener('message', function ( event ) {
223	// Confirm that the message is from the right origin.
224	if ('https://widgets.wp.com' !== event.origin) {
225	return;
226	}
227	// Check whether 3rd Party Cookies are blocked
228	var has3PCBlocked = 'WPCOM:3PC:blocked' === event.data;
229
230	var tagerElement = document.getElementById('wp-admin-bar-notes');
231
232	if ( has3PCBlocked && tagerElement ) {
233	// Hide the notification button/icon
234	tagerElement.style.display = 'none';
235	}
236	}, false );
237	</script>
238	<?php
239	}
240
241	/**
242	* Checks to see if we're in the block editor.
243	*/
244	public static function is_block_editor() {
245	if ( function_exists( 'get_current_screen' ) ) {
246	$current_screen = get_current_screen();
247	if ( ! empty( $current_screen ) && $current_screen->is_block_editor() ) {
248	return true;
249	}
250	}
251	return false;
252	}
253	}
254
255	Jetpack_Notifications::init();
256