notes.php
| 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 | $wp_notes_args = 'var wpNotesArgs = ' . wp_json_encode( array( 'cacheBuster' => JETPACK_NOTES__CACHE_BUSTER ) ) . ';'; |
| 143 | wp_add_inline_script( 'wpcom-notes-admin-bar', $wp_notes_args, 'before' ); |
| 144 | |
| 145 | if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) { |
| 146 | add_filter( |
| 147 | 'script_loader_tag', |
| 148 | function ( $tag, $handle ) use ( $script_handles ) { |
| 149 | if ( in_array( $handle, $script_handles, true ) ) { |
| 150 | $tag = preg_replace( '/(?<=<script)(?=\s|>)/i', ' data-ampdevmode', $tag ); |
| 151 | } |
| 152 | return $tag; |
| 153 | }, |
| 154 | 10, |
| 155 | 2 |
| 156 | ); |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Adds notifications bubble to the admin bar. |
| 162 | * |
| 163 | * @return void |
| 164 | */ |
| 165 | public function admin_bar_menu() { |
| 166 | global $wp_admin_bar; |
| 167 | |
| 168 | if ( ! is_object( $wp_admin_bar ) ) { |
| 169 | return; |
| 170 | } |
| 171 | |
| 172 | if ( self::is_block_editor() ) { |
| 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 | $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>'; |
| 192 | |
| 193 | $title = self::get_notes_markup(); |
| 194 | $wp_admin_bar->add_menu( |
| 195 | array( |
| 196 | 'id' => 'notes', |
| 197 | 'title' => $title, |
| 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>' . $third_party_cookie_check_iframe, |
| 200 | 'class' => 'menupop', |
| 201 | ), |
| 202 | 'parent' => 'top-secondary', |
| 203 | 'href' => 'https://wordpress.com/notifications', |
| 204 | ) |
| 205 | ); |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Returns the HTML markup for used by notification in top bar |
| 210 | * |
| 211 | * @return string |
| 212 | */ |
| 213 | private static function get_notes_markup() { |
| 214 | return '<span id="wpnt-notes-unread-count" class="wpnt-loading wpn-read"></span> |
| 215 | <span class="noticon noticon-bell"></span> |
| 216 | <span class="screen-reader-text">' . esc_html__( 'Notifications', 'jetpack' ) . '</span>'; |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Echos the Notes JS. |
| 221 | * |
| 222 | * @return void |
| 223 | */ |
| 224 | public function print_js() { |
| 225 | $link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false; |
| 226 | ?> |
| 227 | <script data-ampdevmode type="text/javascript"> |
| 228 | /* <![CDATA[ */ |
| 229 | var wpNotesIsJetpackClient = true; |
| 230 | var wpNotesIsJetpackClientV2 = true; |
| 231 | <?php if ( $link_accounts_url ) : ?> |
| 232 | var wpNotesLinkAccountsURL = '<?php echo esc_url( $link_accounts_url ); ?>'; |
| 233 | <?php endif; ?> |
| 234 | /* ]]> */ |
| 235 | window.addEventListener('message', function ( event ) { |
| 236 | // Confirm that the message is from the right origin. |
| 237 | if ('https://widgets.wp.com' !== event.origin) { |
| 238 | return; |
| 239 | } |
| 240 | // Check whether 3rd Party Cookies are blocked |
| 241 | var has3PCBlocked = 'WPCOM:3PC:blocked' === event.data; |
| 242 | |
| 243 | var tagerElement = document.getElementById('wp-admin-bar-notes'); |
| 244 | |
| 245 | if ( has3PCBlocked && tagerElement ) { |
| 246 | // Hide the notification button/icon |
| 247 | tagerElement.style.display = 'none'; |
| 248 | } |
| 249 | }, false ); |
| 250 | </script> |
| 251 | <?php |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Checks to see if we're in the block editor. |
| 256 | */ |
| 257 | public static function is_block_editor() { |
| 258 | if ( function_exists( 'get_current_screen' ) ) { |
| 259 | $current_screen = get_current_screen(); |
| 260 | if ( ! empty( $current_screen ) && $current_screen->is_block_editor() ) { |
| 261 | return true; |
| 262 | } |
| 263 | } |
| 264 | return false; |
| 265 | } |
| 266 | } |
| 267 | |
| 268 | Jetpack_Notifications::init(); |
| 269 |