269 lines
8.2 KiB
PHP
269 lines
8.2 KiB
PHP
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
||
/**
|
||
* Module Name: Notifications
|
||
* Module Description: Receive real‑time notifications about site activity across your devices.
|
||
* Sort Order: 13
|
||
* First Introduced: 1.9
|
||
* Requires Connection: Yes
|
||
* Requires User Connection: Yes
|
||
* Auto Activate: Yes
|
||
* Module Tags: Other
|
||
* Feature: General
|
||
* Additional Search Queries: notification, notifications, toolbar, adminbar, push, comments
|
||
*
|
||
* @package automattic/jetpack
|
||
*/
|
||
|
||
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
|
||
use Automattic\Jetpack\Status\Host;
|
||
|
||
if ( ! defined( 'ABSPATH' ) ) {
|
||
exit( 0 );
|
||
}
|
||
|
||
if ( ! defined( 'JETPACK_NOTES__CACHE_BUSTER' ) ) {
|
||
define( 'JETPACK_NOTES__CACHE_BUSTER', JETPACK__VERSION . '-' . gmdate( 'oW' ) . '-lite' );
|
||
}
|
||
|
||
/**
|
||
* Notifications class.
|
||
*/
|
||
class Jetpack_Notifications {
|
||
/**
|
||
* Jetpack object.
|
||
*
|
||
* @var bool|Jetpack Jetpack object.
|
||
*/
|
||
public $jetpack = false;
|
||
|
||
/**
|
||
* Singleton
|
||
*
|
||
* @static
|
||
*/
|
||
public static function init() {
|
||
static $instance = array();
|
||
|
||
if ( ! $instance ) {
|
||
$instance[0] = new Jetpack_Notifications();
|
||
}
|
||
|
||
return $instance[0];
|
||
}
|
||
|
||
/**
|
||
* Constructor.
|
||
*/
|
||
private function __construct() {
|
||
$this->jetpack = Jetpack::init();
|
||
|
||
add_action( 'init', array( $this, 'action_init' ) );
|
||
}
|
||
|
||
/**
|
||
* Adds s0.wp.com to a file path.
|
||
*
|
||
* @param string $file File path.
|
||
*
|
||
* @return string
|
||
*/
|
||
public function wpcom_static_url( $file ) {
|
||
return 'https://s0.wp.com' . $file;
|
||
}
|
||
|
||
/**
|
||
* Init the notifications admin bar.
|
||
*
|
||
* @return void
|
||
*/
|
||
public function action_init() {
|
||
if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
|
||
return;
|
||
}
|
||
|
||
if ( ! has_filter( 'show_admin_bar', '__return_true' ) && ! is_user_logged_in() ) {
|
||
return;
|
||
}
|
||
|
||
// Do not show notifications in the Site Editor, which is always in fullscreen mode.
|
||
global $pagenow;
|
||
|
||
// Pre 13.7 pages that still need to be supported if < 13.7 is
|
||
// still installed.
|
||
$allowed_old_pages = array( 'admin.php', 'themes.php' );
|
||
$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
|
||
// For Gutenberg > 13.7, the core `site-editor.php` route is used instead
|
||
$is_site_editor_page = 'site-editor.php' === $pagenow;
|
||
|
||
if ( $is_site_editor_page || $is_old_site_editor_page ) {
|
||
return;
|
||
}
|
||
|
||
add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 );
|
||
add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 );
|
||
add_action( 'admin_head', array( $this, 'styles_and_scripts' ) );
|
||
}
|
||
|
||
/**
|
||
* Enqueues and registers styles/scripts for notifications.
|
||
*
|
||
* @return void
|
||
*/
|
||
public function styles_and_scripts() {
|
||
if ( self::is_block_editor() ) {
|
||
return;
|
||
}
|
||
$is_rtl = is_rtl();
|
||
|
||
if ( ( new Host() )->is_woa_site() ) {
|
||
/**
|
||
* Can be used to force Notifications to display in RTL style.
|
||
*
|
||
* @module notes
|
||
*
|
||
* @since 4.8.0
|
||
*
|
||
* @param bool true Should notifications be displayed in RTL style. Defaults to false.
|
||
*/
|
||
$is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
|
||
}
|
||
|
||
if ( ! $is_rtl ) {
|
||
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 );
|
||
} else {
|
||
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 );
|
||
}
|
||
|
||
wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
|
||
|
||
$this->print_js();
|
||
|
||
$script_handles = array();
|
||
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 );
|
||
$script_handles[] = 'wpcom-notes-common';
|
||
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 );
|
||
$script_handles[] = 'wpcom-notes-admin-bar';
|
||
|
||
$wp_notes_args = 'var wpNotesArgs = ' . wp_json_encode( array( 'cacheBuster' => JETPACK_NOTES__CACHE_BUSTER ), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';';
|
||
wp_add_inline_script( 'wpcom-notes-admin-bar', $wp_notes_args, 'before' );
|
||
|
||
if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
|
||
add_filter(
|
||
'script_loader_tag',
|
||
function ( $tag, $handle ) use ( $script_handles ) {
|
||
if ( in_array( $handle, $script_handles, true ) ) {
|
||
$tag = preg_replace( '/(?<=<script)(?=\s|>)/i', ' data-ampdevmode', $tag );
|
||
}
|
||
return $tag;
|
||
},
|
||
10,
|
||
2
|
||
);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Adds notifications bubble to the admin bar.
|
||
*
|
||
* @return void
|
||
*/
|
||
public function admin_bar_menu() {
|
||
global $wp_admin_bar;
|
||
|
||
if ( ! is_object( $wp_admin_bar ) ) {
|
||
return;
|
||
}
|
||
|
||
if ( self::is_block_editor() ) {
|
||
return;
|
||
}
|
||
|
||
$user_locale = get_user_locale();
|
||
|
||
if ( ! class_exists( 'GP_Locales' ) ) {
|
||
if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
|
||
require JETPACK__GLOTPRESS_LOCALES_PATH;
|
||
}
|
||
}
|
||
|
||
if ( class_exists( 'GP_Locales' ) ) {
|
||
$jetpack_locale_object = GP_Locales::by_field( 'slug', $user_locale );
|
||
if ( $jetpack_locale_object instanceof GP_Locale ) {
|
||
$user_locale = $jetpack_locale_object->slug;
|
||
}
|
||
}
|
||
|
||
$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>';
|
||
|
||
// Opt into the v3 notifications panel/iframe via the `notifications=v3` query parameter.
|
||
$notifications_version = sanitize_key( wp_unslash( $_GET['notifications'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
||
$panel_id = 'v3' === $notifications_version ? 'wpnt-notes-panel3' : 'wpnt-notes-panel2';
|
||
|
||
$title = self::get_notes_markup();
|
||
|
||
// The default fallback is `en_US`. Remove underscore if present, noting that lang codes can be more than three chars.
|
||
$user_locale = strtolower( explode( '_', $user_locale, 2 )[0] );
|
||
|
||
$wp_admin_bar->add_menu(
|
||
array(
|
||
'id' => 'notes',
|
||
'title' => $title,
|
||
'meta' => array(
|
||
'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,
|
||
'class' => 'menupop',
|
||
),
|
||
'parent' => 'top-secondary',
|
||
'href' => 'https://wordpress.com/reader/notifications',
|
||
)
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Returns the HTML markup for used by notification in top bar
|
||
*
|
||
* @return string
|
||
*/
|
||
private static function get_notes_markup() {
|
||
return '<span id="wpnt-notes-unread-count" class="wpnt-loading wpn-read"></span>
|
||
<span class="noticon noticon-bell ab-icon"></span>
|
||
<span class="screen-reader-text">' . esc_html__( 'Notifications', 'jetpack' ) . '</span>';
|
||
}
|
||
|
||
/**
|
||
* Echos the Notes JS.
|
||
*
|
||
* @return void
|
||
*/
|
||
public function print_js() {
|
||
$link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
|
||
$script_contents = <<<'JS'
|
||
var wpNotesIsJetpackClient = true;
|
||
var wpNotesIsJetpackClientV2 = true;
|
||
JS;
|
||
if ( $link_accounts_url ) {
|
||
$script_contents .= "\nvar wpNotesLinkAccountsURL = " . wp_json_encode( $link_accounts_url, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';';
|
||
}
|
||
wp_print_inline_script_tag(
|
||
$script_contents,
|
||
array(
|
||
'data-ampdevmode' => true,
|
||
)
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Checks to see if we're in the block editor.
|
||
*/
|
||
public static function is_block_editor() {
|
||
if ( function_exists( 'get_current_screen' ) ) {
|
||
$current_screen = get_current_screen();
|
||
if ( ! empty( $current_screen ) && $current_screen->is_block_editor() ) {
|
||
return true;
|
||
}
|
||
}
|
||
return false;
|
||
}
|
||
}
|
||
|
||
Jetpack_Notifications::init();
|