jetpack / modules / notes.php

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

254 lines 7.9 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' ) );
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	$is_rtl = is_rtl();
109
110	if ( Jetpack::is_module_active( 'masterbar' ) ) {
111	/**
112	* Can be used to force Notifications to display in RTL style.
113	*
114	* @module notes
115	*
116	* @since 4.8.0
117	*
118	* @param bool true Should notifications be displayed in RTL style. Defaults to false.
119	*/
120	$is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
121	}
122
123	if ( ! $is_rtl ) {
124	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 );
125	} else {
126	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 );
127	}
128
129	wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
130
131	$this->print_js();
132
133	// attempt to use core or plugin libraries if registered.
134	$script_handles = array();
135	if ( ! wp_script_is( 'mustache', 'registered' ) ) {
136	wp_register_script( 'mustache', $this->wpcom_static_url( '/wp-content/js/mustache.js' ), null, JETPACK_NOTES__CACHE_BUSTER, true );
137	}
138	$script_handles[] = 'mustache';
139	if ( ! wp_script_is( 'underscore', 'registered' ) ) {
140	wp_register_script( 'underscore', $this->wpcom_static_url( '/wp-includes/js/underscore.min.js' ), null, JETPACK_NOTES__CACHE_BUSTER, true );
141	}
142	$script_handles[] = 'underscore';
143	if ( ! wp_script_is( 'backbone', 'registered' ) ) {
144	wp_register_script( 'backbone', $this->wpcom_static_url( '/wp-includes/js/backbone.min.js' ), array( 'underscore' ), JETPACK_NOTES__CACHE_BUSTER, true );
145	}
146	$script_handles[] = 'backbone';
147
148	wp_register_script( 'wpcom-notes-common', $this->wpcom_static_url( '/wp-content/mu-plugins/notes/notes-common-v2.js' ), array( 'jquery', 'underscore', 'backbone', 'mustache' ), JETPACK_NOTES__CACHE_BUSTER, true );
149	$script_handles[] = 'wpcom-notes-common';
150	$script_handles[] = 'jquery';
151	$script_handles[] = 'jquery-migrate';
152	$script_handles[] = 'jquery-core';
153	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 );
154	$script_handles[] = 'wpcom-notes-admin-bar';
155
156	if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
157	add_filter(
158	'script_loader_tag',
159	function ( $tag, $handle ) use ( $script_handles ) {
160	if ( in_array( $handle, $script_handles, true ) ) {
161	$tag = preg_replace( '/(?<=<script)(?=\s\|>)/i', ' data-ampdevmode', $tag );
162	}
163	return $tag;
164	},
165	10,
166	2
167	);
168	}
169	}
170
171	/**
172	* Adds notifications bubble to the admin bar.
173	*
174	* @return void
175	*/
176	public function admin_bar_menu() {
177	global $wp_admin_bar;
178
179	if ( ! is_object( $wp_admin_bar ) ) {
180	return;
181	}
182
183	$wpcom_locale = get_locale();
184
185	if ( ! class_exists( 'GP_Locales' ) ) {
186	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
187	require JETPACK__GLOTPRESS_LOCALES_PATH;
188	}
189	}
190
191	if ( class_exists( 'GP_Locales' ) ) {
192	$wpcom_locale_object = GP_Locales::by_field( 'wp_locale', $wpcom_locale );
193	if ( $wpcom_locale_object instanceof GP_Locale ) {
194	$wpcom_locale = $wpcom_locale_object->slug;
195	}
196	}
197
198	$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>';
199
200	$classes = 'wpnt-loading wpn-read';
201	$wp_admin_bar->add_menu(
202	array(
203	'id' => 'notes',
204	'title' => '<span id="wpnt-notes-unread-count" class="' . esc_attr( $classes ) . '">
205	<span class="noticon noticon-notification"></span>
206	</span>',
207	'meta' => array(
208	'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,
209	'class' => 'menupop',
210	),
211	'parent' => 'top-secondary',
212	)
213	);
214	}
215
216	/**
217	* Echos the Notes JS.
218	*
219	* @return void
220	*/
221	public function print_js() {
222	$link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
223	?>
224	<script data-ampdevmode type="text/javascript">
225	/* <![CDATA[ */
226	var wpNotesIsJetpackClient = true;
227	var wpNotesIsJetpackClientV2 = true;
228	<?php if ( $link_accounts_url ) : ?>
229	var wpNotesLinkAccountsURL = '<?php echo esc_url( $link_accounts_url ); ?>';
230	<?php endif; ?>
231	/* ]]> */
232	window.addEventListener('message', function ( event ) {
233	// Confirm that the message is from the right origin.
234	if ('https://widgets.wp.com' !== event.origin) {
235	return;
236	}
237	// Check whether 3rd Party Cookies are blocked
238	var has3PCBlocked = 'WPCOM:3PC:blocked' === event.data;
239
240	var tagerElement = document.getElementById('wp-admin-bar-notes');
241
242	if ( has3PCBlocked && tagerElement ) {
243	// Hide the notification button/icon
244	tagerElement.style.display = 'none';
245	}
246	}, false );
247	</script>
248	<?php
249	}
250
251	}
252
253	Jetpack_Notifications::init();
254