Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00%
0 / 99
0.00%
0 / 9
 CRAP
0.00%
0 / 1
Jetpack_Notifications
0.00%
0 / 94
0.00%
0 / 9
 1560
0.00%
0 / 1
 init
0.00%
0 / 4
0.00%
0 / 1
 6
 __construct
0.00%
0 / 2
0.00%
0 / 1
 2
 wpcom_static_url
0.00%
0 / 1
0.00%
0 / 1
 2
 action_init
0.00%
0 / 12
0.00%
0 / 1
 90
 styles_and_scripts
0.00%
0 / 28
0.00%
0 / 1
 56
 admin_bar_menu
0.00%
0 / 29
0.00%
0 / 1
 110
 get_notes_markup
0.00%
0 / 2
0.00%
0 / 1
 2
 print_js
0.00%
0 / 11
0.00%
0 / 1
 20
 is_block_editor
0.00%
0 / 5
0.00%
0 / 1
 20
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
17use Automattic\Jetpack\Connection\Manager as Connection_Manager;
18use Automattic\Jetpack\Status\Host;
19
20if ( ! defined( 'ABSPATH' ) ) {
21    exit( 0 );
22}
23
24if ( ! defined( 'JETPACK_NOTES__CACHE_BUSTER' ) ) {
25    define( 'JETPACK_NOTES__CACHE_BUSTER', JETPACK__VERSION . '-' . gmdate( 'oW' ) . '-lite' );
26}
27
28/**
29 * Notifications class.
30 */
31class 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        // Do not show notifications in the Site Editor, which is always in fullscreen mode.
89        global $pagenow;
90
91        // Pre 13.7 pages that still need to be supported if < 13.7 is
92        // still installed.
93        $allowed_old_pages       = array( 'admin.php', 'themes.php' );
94        $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
95        // For Gutenberg > 13.7, the core `site-editor.php` route is used instead
96        $is_site_editor_page = 'site-editor.php' === $pagenow;
97
98        if ( $is_site_editor_page || $is_old_site_editor_page ) {
99            return;
100        }
101
102        add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 120 );
103        add_action( 'wp_head', array( $this, 'styles_and_scripts' ), 120 );
104        add_action( 'admin_head', array( $this, 'styles_and_scripts' ) );
105    }
106
107    /**
108     * Enqueues and registers styles/scripts for notifications.
109     *
110     * @return void
111     */
112    public function styles_and_scripts() {
113        if ( self::is_block_editor() ) {
114            return;
115        }
116        $is_rtl = is_rtl();
117
118        if ( ( new Host() )->is_woa_site() ) {
119            /**
120             * Can be used to force Notifications to display in RTL style.
121             *
122             * @module notes
123             *
124             * @since 4.8.0
125             *
126             * @param bool true Should notifications be displayed in RTL style. Defaults to false.
127             */
128            $is_rtl = apply_filters( 'a8c_wpcom_masterbar_enqueue_rtl_notification_styles', false );
129        }
130
131        if ( ! $is_rtl ) {
132            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 );
133        } else {
134            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 );
135        }
136
137        wp_enqueue_style( 'noticons', $this->wpcom_static_url( '/i/noticons/noticons.css' ), array( 'wpcom-notes-admin-bar' ), JETPACK_NOTES__CACHE_BUSTER );
138
139        $this->print_js();
140
141        $script_handles = array();
142        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 );
143        $script_handles[] = 'wpcom-notes-common';
144        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 );
145        $script_handles[] = 'wpcom-notes-admin-bar';
146
147        $wp_notes_args = 'var wpNotesArgs = ' . wp_json_encode( array( 'cacheBuster' => JETPACK_NOTES__CACHE_BUSTER ), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';';
148        wp_add_inline_script( 'wpcom-notes-admin-bar', $wp_notes_args, 'before' );
149
150        if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
151            add_filter(
152                'script_loader_tag',
153                function ( $tag, $handle ) use ( $script_handles ) {
154                    if ( in_array( $handle, $script_handles, true ) ) {
155                        $tag = preg_replace( '/(?<=<script)(?=\s|>)/i', ' data-ampdevmode', $tag );
156                    }
157                    return $tag;
158                },
159                10,
160                2
161            );
162        }
163    }
164
165    /**
166     * Adds notifications bubble to the admin bar.
167     *
168     * @return void
169     */
170    public function admin_bar_menu() {
171        global $wp_admin_bar;
172
173        if ( ! is_object( $wp_admin_bar ) ) {
174            return;
175        }
176
177        if ( self::is_block_editor() ) {
178            return;
179        }
180
181        $user_locale = get_user_locale();
182
183        if ( ! class_exists( 'GP_Locales' ) ) {
184            if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
185                require JETPACK__GLOTPRESS_LOCALES_PATH;
186            }
187        }
188
189        if ( class_exists( 'GP_Locales' ) ) {
190            $jetpack_locale_object = GP_Locales::by_field( 'slug', $user_locale );
191            if ( $jetpack_locale_object instanceof GP_Locale ) {
192                $user_locale = $jetpack_locale_object->slug;
193            }
194        }
195
196        $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>';
197
198        // Opt into the v3 notifications panel/iframe via the `notifications=v3` query parameter.
199        $notifications_version = sanitize_key( wp_unslash( $_GET['notifications'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
200        $panel_id              = 'v3' === $notifications_version ? 'wpnt-notes-panel3' : 'wpnt-notes-panel2';
201
202        $title = self::get_notes_markup();
203
204        // The default fallback is `en_US`. Remove underscore if present, noting that lang codes can be more than three chars.
205        $user_locale = strtolower( explode( '_', $user_locale, 2 )[0] );
206
207        $wp_admin_bar->add_menu(
208            array(
209                'id'     => 'notes',
210                'title'  => $title,
211                'meta'   => array(
212                    '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,
213                    'class' => 'menupop',
214                ),
215                'parent' => 'top-secondary',
216                'href'   => 'https://wordpress.com/reader/notifications',
217            )
218        );
219    }
220
221    /**
222     * Returns the HTML markup for used by notification in top bar
223     *
224     * @return string
225     */
226    private static function get_notes_markup() {
227        return '<span id="wpnt-notes-unread-count" class="wpnt-loading wpn-read"></span>
228<span class="noticon noticon-bell ab-icon"></span>
229<span class="screen-reader-text">' . esc_html__( 'Notifications', 'jetpack' ) . '</span>';
230    }
231
232    /**
233     * Echos the Notes JS.
234     *
235     * @return void
236     */
237    public function print_js() {
238        $link_accounts_url = is_user_logged_in() && ! ( new Connection_Manager( 'jetpack' ) )->is_user_connected() ? Jetpack::admin_url() : false;
239        $script_contents   = <<<'JS'
240var wpNotesIsJetpackClient = true;
241var wpNotesIsJetpackClientV2 = true;
242JS;
243        if ( $link_accounts_url ) {
244            $script_contents .= "\nvar wpNotesLinkAccountsURL = " . wp_json_encode( $link_accounts_url, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';';
245        }
246        wp_print_inline_script_tag(
247            $script_contents,
248            array(
249                'data-ampdevmode' => true,
250            )
251        );
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
268Jetpack_Notifications::init();