jetpack / modules / notes.php

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

230 lines 6.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	// phpcs:ignore WordPress.Security.NonceVerification
86	if ( 'admin.php' === $pagenow && isset( $_GET['page'] ) && 'gutenberg-edit-site' === $_GET['page'] ) {
87	return;
88	}
89
90	add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 );
91	add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 );
92	add_action( 'admin_head', array( $this, 'styles_and_scripts' ) );
93	}
94
95	/**
96	* Enqueues and registers styles/scripts for notifications.
97	*
98	* @return void
99	*/
100	public function styles_and_scripts() {
101	$is_rtl = is_rtl();
102
103	if ( Jetpack::is_module_active( 'masterbar' ) ) {
104	/**
105	* Can be used to force Notifications to display in RTL style.
106	*
107	* @module notes
108	*
109	* @since 4.8.0
110	*
111	* @param bool true Should notifications be displayed in RTL style. Defaults to false.
112	*/
113	$is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
114	}
115
116	if ( ! $is_rtl ) {
117	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 );
118	} else {
119	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 );
120	}
121
122	wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
123
124	$this->print_js();
125
126	// attempt to use core or plugin libraries if registered.
127	$script_handles = array();
128	if ( ! wp_script_is( 'mustache', 'registered' ) ) {
129	wp_register_script( 'mustache', $this->wpcom_static_url( '/wp-content/js/mustache.js' ), null, JETPACK_NOTES__CACHE_BUSTER, true );
130	}
131	$script_handles[] = 'mustache';
132	if ( ! wp_script_is( 'underscore', 'registered' ) ) {
133	wp_register_script( 'underscore', $this->wpcom_static_url( '/wp-includes/js/underscore.min.js' ), null, JETPACK_NOTES__CACHE_BUSTER, true );
134	}
135	$script_handles[] = 'underscore';
136	if ( ! wp_script_is( 'backbone', 'registered' ) ) {
137	wp_register_script( 'backbone', $this->wpcom_static_url( '/wp-includes/js/backbone.min.js' ), array( 'underscore' ), JETPACK_NOTES__CACHE_BUSTER, true );
138	}
139	$script_handles[] = 'backbone';
140
141	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 );
142	$script_handles[] = 'wpcom-notes-common';
143	$script_handles[] = 'jquery';
144	$script_handles[] = 'jquery-migrate';
145	$script_handles[] = 'jquery-core';
146	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 );
147	$script_handles[] = 'wpcom-notes-admin-bar';
148
149	if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
150	add_filter(
151	'script_loader_tag',
152	function ( $tag, $handle ) use ( $script_handles ) {
153	if ( in_array( $handle, $script_handles, true ) ) {
154	$tag = preg_replace( '/(?<=<script)(?=\s\|>)/i', ' data-ampdevmode', $tag );
155	}
156	return $tag;
157	},
158	10,
159	2
160	);
161	}
162	}
163
164	/**
165	* Adds notifications bubble to the admin bar.
166	*
167	* @return void
168	*/
169	public function admin_bar_menu() {
170	global $wp_admin_bar;
171
172	if ( ! is_object( $wp_admin_bar ) ) {
173	return;
174	}
175
176	$wpcom_locale = get_locale();
177
178	if ( ! class_exists( 'GP_Locales' ) ) {
179	if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
180	require JETPACK__GLOTPRESS_LOCALES_PATH;
181	}
182	}
183
184	if ( class_exists( 'GP_Locales' ) ) {
185	$wpcom_locale_object = GP_Locales::by_field( 'wp_locale', $wpcom_locale );
186	if ( $wpcom_locale_object instanceof GP_Locale ) {
187	$wpcom_locale = $wpcom_locale_object->slug;
188	}
189	}
190
191	$classes = 'wpnt-loading wpn-read';
192	$wp_admin_bar->add_menu(
193	array(
194	'id' => 'notes',
195	'title' => '<span id="wpnt-notes-unread-count" class="' . esc_attr( $classes ) . '">
196	<span class="noticon noticon-notification"></span>
197	</span>',
198	'meta' => array(
199	'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>',
200	'class' => 'menupop',
201	),
202	'parent' => 'top-secondary',
203	)
204	);
205	}
206
207	/**
208	* Echos the Notes JS.
209	*
210	* @return void
211	*/
212	public function print_js() {
213	$link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
214	?>
215	<script data-ampdevmode type="text/javascript">
216	/* <![CDATA[ */
217	var wpNotesIsJetpackClient = true;
218	var wpNotesIsJetpackClientV2 = true;
219	<?php if ( $link_accounts_url ) : ?>
220	var wpNotesLinkAccountsURL = '<?php echo esc_url( $link_accounts_url ); ?>';
221	<?php endif; ?>
222	/* ]]> */
223	</script>
224	<?php
225	}
226
227	}
228
229	Jetpack_Notifications::init();
230