| @@ -1,0 +1,247 @@ | ||
| 1 | +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName | |
| 2 | +/** | |
| 3 | + * Module Name: Notifications | |
| 4 | + * Module Description: Receive real‑time notifications about site activity across your devices. | |
| 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( 'ABSPATH' ) ) { | |
| 21 | + exit( 0 ); | |
| 22 | +} | |
| 23 | + | |
| 24 | +if ( ! defined( 'JETPACK_NOTES__CACHE_BUSTER' ) ) { | |
| 25 | + define( 'JETPACK_NOTES__CACHE_BUSTER', JETPACK__VERSION . '-' . gmdate( 'oW' ) . '-lite' ); | |
| 26 | +} | |
| 27 | + | |
| 28 | +/** | |
| 29 | + * Notifications class. | |
| 30 | + */ | |
| 31 | +class Jetpack_Notifications { | |
| 32 | + /** | |
| 33 | + * Jetpack object. | |
| 34 | + * | |
| 35 | + * @var bool|Jetpack Jetpack object. | |
| 36 | + */ | |
| 37 | + public $jetpack = false; | |
| 38 | + | |
| 39 | + /** | |
| 40 | + * Singleton | |
| 41 | + * | |
| 42 | + * @static | |
| 43 | + */ | |
| 44 | + public static function init() { | |
| 45 | + static $instance = array(); | |
| 46 | + | |
| 47 | + if ( ! $instance ) { | |
| 48 | + $instance[0] = new Jetpack_Notifications(); | |
| 49 | + } | |
| 50 | + | |
| 51 | + return $instance[0]; | |
| 52 | + } | |
| 53 | + | |
| 54 | + /** | |
| 55 | + * Constructor. | |
| 56 | + */ | |
| 57 | + private function __construct() { | |
| 58 | + $this->jetpack = Jetpack::init(); | |
| 59 | + | |
| 60 | + add_action( 'init', array( $this, 'action_init' ) ); | |
| 61 | + } | |
| 62 | + | |
| 63 | + /** | |
| 64 | + * Adds s0.wp.com to a file path. | |
| 65 | + * | |
| 66 | + * @param string $file File path. | |
| 67 | + * | |
| 68 | + * @return string | |
| 69 | + */ | |
| 70 | + public function wpcom_static_url( $file ) { | |
| 71 | + return 'https://s0.wp.com' . $file; | |
| 72 | + } | |
| 73 | + | |
| 74 | + /** | |
| 75 | + * Init the notifications admin bar. | |
| 76 | + * | |
| 77 | + * @return void | |
| 78 | + */ | |
| 79 | + public function action_init() { | |
| 80 | + if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) { | |
| 81 | + return; | |
| 82 | + } | |
| 83 | + | |
| 84 | + if ( ! has_filter( 'show_admin_bar', '__return_true' ) && ! is_user_logged_in() ) { | |
| 85 | + return; | |
| 86 | + } | |
| 87 | + | |
| 88 | + add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 ); | |
| 89 | + add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 ); | |
| 90 | + add_action( 'admin_head', array( $this, 'styles_and_scripts' ) ); | |
| 91 | + } | |
| 92 | + | |
| 93 | + /** | |
| 94 | + * Enqueues and registers styles/scripts for notifications. | |
| 95 | + * | |
| 96 | + * @return void | |
| 97 | + */ | |
| 98 | + public function styles_and_scripts() { | |
| 99 | + $is_rtl = is_rtl(); | |
| 100 | + | |
| 101 | + if ( ( new Host() )->is_woa_site() ) { | |
| 102 | + /** | |
| 103 | + * Can be used to force Notifications to display in RTL style. | |
| 104 | + * | |
| 105 | + * @module notes | |
| 106 | + * | |
| 107 | + * @since 4.8.0 | |
| 108 | + * | |
| 109 | + * @param bool true Should notifications be displayed in RTL style. Defaults to false. | |
| 110 | + */ | |
| 111 | + $is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false ); | |
| 112 | + } | |
| 113 | + | |
| 114 | + if ( ! $is_rtl ) { | |
| 115 | + 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 ); | |
| 116 | + } else { | |
| 117 | + 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 ); | |
| 118 | + } | |
| 119 | + | |
| 120 | + wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER ); | |
| 121 | + | |
| 122 | + $this->print_js(); | |
| 123 | + | |
| 124 | + $script_handles = array(); | |
| 125 | + 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 ); | |
| 126 | + $script_handles[] = 'wpcom-notes-common'; | |
| 127 | + 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 ); | |
| 128 | + $script_handles[] = 'wpcom-notes-admin-bar'; | |
| 129 | + | |
| 130 | + $wp_notes_args = 'var wpNotesArgs = ' . wp_json_encode( array( 'cacheBuster' => JETPACK_NOTES__CACHE_BUSTER ), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';'; | |
| 131 | + wp_add_inline_script( 'wpcom-notes-admin-bar', $wp_notes_args, 'before' ); | |
| 132 | + | |
| 133 | + if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) { | |
| 134 | + add_filter( | |
| 135 | + 'script_loader_tag', | |
| 136 | + function ( $tag, $handle ) use ( $script_handles ) { | |
| 137 | + if ( in_array( $handle, $script_handles, true ) ) { | |
| 138 | + $tag = preg_replace( '/(?<=<script)(?=\s|>)/i', ' data-ampdevmode', $tag ); | |
| 139 | + } | |
| 140 | + return $tag; | |
| 141 | + }, | |
| 142 | + 10, | |
| 143 | + 2 | |
| 144 | + ); | |
| 145 | + } | |
| 146 | + } | |
| 147 | + | |
| 148 | + /** | |
| 149 | + * Adds notifications bubble to the admin bar. | |
| 150 | + * | |
| 151 | + * @return void | |
| 152 | + */ | |
| 153 | + public function admin_bar_menu() { | |
| 154 | + global $wp_admin_bar; | |
| 155 | + | |
| 156 | + if ( ! is_object( $wp_admin_bar ) ) { | |
| 157 | + return; | |
| 158 | + } | |
| 159 | + | |
| 160 | + $user_locale = get_user_locale(); | |
| 161 | + | |
| 162 | + if ( ! class_exists( 'GP_Locales' ) ) { | |
| 163 | + if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) { | |
| 164 | + require JETPACK__GLOTPRESS_LOCALES_PATH; | |
| 165 | + } | |
| 166 | + } | |
| 167 | + | |
| 168 | + if ( class_exists( 'GP_Locales' ) ) { | |
| 169 | + $jetpack_locale_object = GP_Locales::by_field( 'slug', $user_locale ); | |
| 170 | + if ( $jetpack_locale_object instanceof GP_Locale ) { | |
| 171 | + $user_locale = $jetpack_locale_object->slug; | |
| 172 | + } | |
| 173 | + } | |
| 174 | + | |
| 175 | + $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>'; | |
| 176 | + | |
| 177 | + // Opt into the v3 notifications panel/iframe via the `notifications=v3` query parameter. | |
| 178 | + $notifications_version = sanitize_key( wp_unslash( $_GET['notifications'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended | |
| 179 | + $panel_id = 'v3' === $notifications_version ? 'wpnt-notes-panel3' : 'wpnt-notes-panel2'; | |
| 180 | + | |
| 181 | + $title = self::get_notes_markup(); | |
| 182 | + | |
| 183 | + // The default fallback is `en_US`. Remove underscore if present, noting that lang codes can be more than three chars. | |
| 184 | + $user_locale = strtolower( explode( '_', $user_locale, 2 )[0] ); | |
| 185 | + | |
| 186 | + $wp_admin_bar->add_menu( | |
| 187 | + array( | |
| 188 | + 'id' => 'notes', | |
| 189 | + 'title' => $title, | |
| 190 | + 'meta' => array( | |
| 191 | + 'html' => '<div id="' . esc_attr( $panel_id ) . '" 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, | |
| 192 | + 'class' => 'menupop', | |
| 193 | + ), | |
| 194 | + 'parent' => 'top-secondary', | |
| 195 | + 'href' => 'https://wordpress.com/reader/notifications', | |
| 196 | + ) | |
| 197 | + ); | |
| 198 | + } | |
| 199 | + | |
| 200 | + /** | |
| 201 | + * Returns the HTML markup for used by notification in top bar | |
| 202 | + * | |
| 203 | + * @return string | |
| 204 | + */ | |
| 205 | + private static function get_notes_markup() { | |
| 206 | + return '<span id="wpnt-notes-unread-count" class="wpnt-loading wpn-read"></span> | |
| 207 | +<span class="noticon noticon-bell ab-icon"></span> | |
| 208 | +<span class="screen-reader-text">' . esc_html__( 'Notifications', 'jetpack' ) . '</span>'; | |
| 209 | + } | |
| 210 | + | |
| 211 | + /** | |
| 212 | + * Echos the Notes JS. | |
| 213 | + * | |
| 214 | + * @return void | |
| 215 | + */ | |
| 216 | + public function print_js() { | |
| 217 | + $link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false; | |
| 218 | + $script_contents = <<<'JS' | |
| 219 | +var wpNotesIsJetpackClient = true; | |
| 220 | +var wpNotesIsJetpackClientV2 = true; | |
| 221 | +JS; | |
| 222 | + if ( $link_accounts_url ) { | |
| 223 | + $script_contents .= "\nvar wpNotesLinkAccountsURL = " . wp_json_encode( $link_accounts_url, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';'; | |
| 224 | + } | |
| 225 | + wp_print_inline_script_tag( | |
| 226 | + $script_contents, | |
| 227 | + array( | |
| 228 | + 'data-ampdevmode' => true, | |
| 229 | + ) | |
| 230 | + ); | |
| 231 | + } | |
| 232 | + | |
| 233 | + /** | |
| 234 | + * Checks to see if we're in the block editor. | |
| 235 | + */ | |
| 236 | + public static function is_block_editor() { | |
| 237 | + if ( function_exists( 'get_current_screen' ) ) { | |
| 238 | + $current_screen = get_current_screen(); | |
| 239 | + if ( ! empty( $current_screen ) && $current_screen->is_block_editor() ) { | |
| 240 | + return true; | |
| 241 | + } | |
| 242 | + } | |
| 243 | + return false; | |
| 244 | + } | |
| 245 | +} | |
| 246 | + | |
| 247 | +Jetpack_Notifications::init(); | |