Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
77.31%
92 / 119
57.89%
11 / 19
 CRAP
0.00%
0 / 1
Jetpack_Activity_Log
77.78%
91 / 117
57.89%
11 / 19
 75.35
0.00%
0 / 1
 initialize
100.00%
9 / 9
100.00%
1 / 1
 4
 is_module_active
100.00%
1 / 1
100.00%
1 / 1
 1
 register_module
100.00%
4 / 4
100.00%
1 / 1
 2
 add_standalone_module
100.00%
2 / 2
100.00%
1 / 1
 1
 activate_standalone_default
83.33%
5 / 6
0.00%
0 / 1
 4.07
 add_wp_admin_submenu
89.29%
25 / 28
0.00%
0 / 1
 6.04
 is_available
71.43%
5 / 7
0.00%
0 / 1
 4.37
 admin_init
0.00%
0 / 5
0.00%
0 / 1
 20
 load_wp_build
23.08%
3 / 13
0.00%
0 / 1
 7.10
 load_wp_build_with_screen_alias
75.00%
9 / 12
0.00%
0 / 1
 2.06
 alias_screen_id_for_wp_build
100.00%
5 / 5
100.00%
1 / 1
 2
 restore_screen_id_after_wp_build
100.00%
5 / 5
100.00%
1 / 1
 3
 opt_out_of_jitms
100.00%
2 / 2
100.00%
1 / 1
 1
 hide_jitms_on_wp_build_dashboard
100.00%
3 / 3
100.00%
1 / 1
 3
 enqueue_initial_state
100.00%
9 / 9
100.00%
1 / 1
 3
 is_wpcom_simple
100.00%
1 / 1
100.00%
1 / 1
 1
 render_fallback
0.00%
0 / 1
0.00%
0 / 1
 2
 is_activity_log_admin_request
100.00%
3 / 3
100.00%
1 / 1
 3
 register_rest_routes
0.00%
0 / 1
0.00%
0 / 1
 2
1<?php
2/**
3 * Primary class for the Jetpack Activity Log package.
4 *
5 * @package automattic/jetpack-activity-log
6 */
7
8namespace Automattic\Jetpack\Activity_Log;
9
10if ( ! defined( 'ABSPATH' ) ) {
11    exit( 0 );
12}
13
14use Automattic\Jetpack\Activity_Log\Initial_State as Activity_Log_Initial_State;
15use Automattic\Jetpack\Admin_UI\Admin_Menu;
16use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
17use Automattic\Jetpack\Connection\Manager as Connection_Manager;
18use Automattic\Jetpack\Modules;
19use Automattic\Jetpack\Status\Host;
20use Automattic\Jetpack\WP_Build_Polyfills\WP_Build_Polyfills;
21use Automattic\Jetpack\WP_Build_Polyfills\WP_Build_Screen_Id;
22use Jetpack_Options;
23use function add_action;
24use function add_filter;
25use function add_submenu_page;
26use function class_exists;
27use function current_user_can;
28use function did_action;
29use function do_action;
30use function get_current_screen;
31use function is_admin;
32use function is_multisite;
33use function sanitize_text_field;
34use function wp_add_inline_script;
35use function wp_enqueue_script;
36use function wp_json_encode;
37use function wp_register_script;
38use function wp_unslash;
39use function wp_verify_nonce;
40
41/**
42 * Class Jetpack_Activity_Log
43 *
44 * Registers the Activity Log admin page and its REST routes inside the
45 * main Jetpack plugin.
46 */
47class Jetpack_Activity_Log {
48
49    /**
50     * Admin page slug.
51     *
52     * @var string
53     */
54    const PAGE_SLUG = 'jetpack-activity-log';
55
56    /**
57     * Slug of the Jetpack module that turns the Activity Log on and off.
58     *
59     * @var string
60     */
61    const MODULE_SLUG = 'activity-log';
62
63    /**
64     * Jetpack_Options key recording that the module was switched on for a site
65     * with no Jetpack plugin. See `activate_standalone_default()`.
66     *
67     * @var string
68     */
69    const DEFAULT_ACTIVATED_OPTION = 'activity_log_default_activated';
70
71    /**
72     * Page slug for the wp-build dashboard. Distinct from the wp-admin menu
73     * slug (`PAGE_SLUG`) so the user-facing URL stays `admin.php?page=jetpack-activity-log`;
74     * we alias the current screen id to this value so wp-build's
75     * screen-match enqueue callback fires. Must match the `page` in
76     * `routes/dashboard/package.json` and the `wpPlugin.pages` entry.
77     *
78     * @var string
79     */
80    const WP_BUILD_PAGE_SLUG = 'jetpack-activity-log-dashboard';
81
82    /**
83     * Handle for the classic script that carries the React initial state.
84     * The dashboard is a wp-build script module, so there is no classic
85     * bundle handle to attach inline data to — this empty handle exists
86     * purely to print `JPACTIVITYLOG_INITIAL_STATE` and the Connection
87     * initial state before boot runs.
88     *
89     * @var string
90     */
91    const DATA_SCRIPT_HANDLE = 'jetpack-activity-log-data';
92
93    /**
94     * Nonce action for refreshing the access flag after a checkout
95     * return. Used by `admin_init()` below and exposed to the client via
96     * Initial_State so the upsell CTA can embed a valid nonce in its
97     * `redirect_to`. Same shape as `Social_Admin_Page::REFRESH_PLAN_NONCE_ACTION`.
98     *
99     * @var string
100     */
101    const REFRESH_ACCESS_NONCE_ACTION = 'jetpack_activity_log_refresh_access';
102
103    /**
104     * The screen ID alias_screen_id_for_wp_build() replaced, until it is restored.
105     *
106     * @var string|null
107     */
108    private static $wp_build_original_screen_id = null;
109
110    /**
111     * The dashboard screen hide_jitms_on_wp_build_dashboard() opts out of JITMs.
112     *
113     * @var string|null
114     */
115    private static $jitm_opt_out_screen_id = null;
116
117    /**
118     * Entry point. Idempotent: safe to call from multiple bootstraps.
119     *
120     * Bootstraps only while the `activity-log` module is on, so the toggle
121     * means the same thing to the Jetpack plugin and to every standalone
122     * plugin that carries this package.
123     */
124    public static function initialize() {
125        // Simple has no module system, and jetpack-mu-wpcom registers the page itself via add_wp_admin_submenu().
126        if ( self::is_wpcom_simple() ) {
127            return;
128        }
129
130        self::register_module();
131
132        if ( did_action( 'jetpack_activity_log_initialized' ) || ! self::is_module_active() ) {
133            return;
134        }
135
136        add_action( 'admin_menu', array( __CLASS__, 'add_wp_admin_submenu' ) );
137        add_action( 'rest_api_init', array( __CLASS__, 'register_rest_routes' ) );
138        add_filter( 'jetpack_package_versions', array( Package_Version::class, 'send_package_version_to_tracker' ) );
139
140        /**
141         * Fires once the Jetpack Activity Log package has wired its hooks.
142         *
143         * @since 0.1.0
144         */
145        do_action( 'jetpack_activity_log_initialized' );
146    }
147
148    /**
149     * Whether the Activity Log module is switched on.
150     *
151     * @return bool
152     */
153    public static function is_module_active() {
154        return ( new Modules() )->is_active( self::MODULE_SLUG );
155    }
156
157    /**
158     * Make the module controllable, and give a site with no Jetpack plugin the
159     * same default-on state the Jetpack plugin gets from `Auto Activate: Yes`.
160     *
161     * @return void
162     */
163    private static function register_module() {
164        add_filter( 'jetpack_get_available_standalone_modules', array( __CLASS__, 'add_standalone_module' ) );
165
166        // `class_exists( 'Jetpack' )` is only reliable once every plugin file has
167        // loaded: `jetpack-backup/` sorts before `jetpack/` in active_plugins, so
168        // Backup reaches initialize() while the Jetpack class is still undefined.
169        if ( did_action( 'plugins_loaded' ) ) {
170            self::activate_standalone_default();
171        } else {
172            add_action( 'plugins_loaded', array( __CLASS__, 'activate_standalone_default' ) );
173        }
174    }
175
176    /**
177     * Make the module available to the module controller when the Jetpack
178     * plugin is not installed, so `jetpack_active_modules` is not inert there.
179     *
180     * @param array $modules Available standalone module slugs.
181     * @return array
182     */
183    public static function add_standalone_module( $modules ) {
184        $modules[] = self::MODULE_SLUG;
185
186        return array_values( array_unique( $modules ) );
187    }
188
189    /**
190     * Switch the module on once on a site with no Jetpack plugin.
191     *
192     * The Jetpack plugin activates the module for you via `Auto Activate: Yes`;
193     * a standalone install has no equivalent, so without this the page would
194     * disappear from every Backup/Boost/Protect/Search/VideoPress site on
195     * upgrade. Recorded in an option rather than repeated, so a later opt-out
196     * is not undone on the next request.
197     *
198     * @return void
199     */
200    public static function activate_standalone_default() {
201        if ( class_exists( 'Jetpack' ) || Jetpack_Options::get_option( self::DEFAULT_ACTIVATED_OPTION ) ) {
202            return;
203        }
204
205        if ( ! ( new Modules() )->activate( self::MODULE_SLUG, false, false ) ) {
206            return;
207        }
208
209        // Record before re-entering initialize(), which calls back into here.
210        Jetpack_Options::update_option( self::DEFAULT_ACTIVATED_OPTION, true );
211
212        // initialize() ran before this and found the module off, so wire up now
213        // rather than leaving the page missing for the rest of the request.
214        self::initialize();
215    }
216
217    /**
218     * Register the Activity Log submenu under Jetpack.
219     *
220     * Mirrors the gating used by the legacy my-jetpack "Activity Log" menu
221     * item (connected user + non-multisite). On WordPress.com Simple sites,
222     * jetpack-mu-wpcom calls this once it has built the Jetpack menu.
223     *
224     * @since 0.6.0 Registers the page on WordPress.com Simple sites.
225     *
226     * @return string|null The resulting page's hook suffix, if registered.
227     */
228    public static function add_wp_admin_submenu() {
229        if ( ! self::is_available() ) {
230            return null;
231        }
232
233        // Load wp-build only on the Activity Log request so its generated
234        // render function exists before the menu callback runs, and its
235        // enqueue pipeline/polyfills stay off every other admin page.
236        if ( self::is_activity_log_admin_request() ) {
237            self::load_wp_build_with_screen_alias();
238        }
239
240        // The menu item must appear on every admin page, but the generated
241        // render function is only loaded on the Activity Log request (above).
242        // The callback is only ever invoked while rendering our page — where
243        // the function is loaded — so the fallback is purely defensive.
244        $render_callback = function_exists( 'jetpack_activity_log_jetpack_activity_log_dashboard_wp_admin_render_page' )
245            ? 'jetpack_activity_log_jetpack_activity_log_dashboard_wp_admin_render_page'
246            : array( __CLASS__, 'render_fallback' );
247
248        if ( self::is_wpcom_simple() ) {
249            // jetpack-mu-wpcom calls this after Admin_Menu has already flushed its queue.
250            $page_suffix = add_submenu_page(
251                'jetpack',
252                /** "Activity Log" is a product name, do not translate. */
253                'Activity Log',
254                'Activity Log',
255                'manage_options',
256                self::PAGE_SLUG,
257                $render_callback
258            );
259        } else {
260            $page_suffix = Admin_Menu::add_menu(
261                /** "Activity Log" is a product name, do not translate. */
262                'Activity Log',
263                'Activity Log',
264                'manage_options',
265                self::PAGE_SLUG,
266                $render_callback
267            );
268        }
269
270        if ( ! $page_suffix ) {
271            return null;
272        }
273
274        add_action( 'load-' . $page_suffix, array( __CLASS__, 'admin_init' ) );
275        self::opt_out_of_jitms( $page_suffix );
276
277        return $page_suffix;
278    }
279
280    /**
281     * Whether the Activity Log page should be shown to the current user.
282     *
283     * @return bool
284     */
285    public static function is_available() {
286        if ( ! current_user_can( 'manage_options' ) ) {
287            return false;
288        }
289
290        // Simple sites need no Jetpack connection: their users are WordPress.com users.
291        if ( self::is_wpcom_simple() ) {
292            return true;
293        }
294
295        if ( is_multisite() ) {
296            return false;
297        }
298
299        return ( new Connection_Manager() )->is_user_connected();
300    }
301
302    /**
303     * Fires when the admin page is loaded.
304     *
305     * When the user is returning from a successful checkout, the upsell
306     * CTA appends `?refresh_access=1&_wpnonce=…` to the `redirect_to`
307     * value it hands off to WordPress.com. Detect that here, verify the
308     * nonce, and drop the cached paid-plan signal so
309     * `Initial_State::get_data()` (which runs later in the same request,
310     * when the bundle is enqueued) rehydrates from WPCOM instead of
311     * re-serving the pre-checkout value. Mirrors the pattern in
312     * `Automattic\Jetpack\Publicize\Social_Admin_Page::admin_init()`.
313     */
314    public static function admin_init() {
315        if ( isset( $_GET['refresh_access'] ) && isset( $_GET['_wpnonce'] ) ) {
316            $nonce = sanitize_text_field( wp_unslash( $_GET['_wpnonce'] ) );
317            if ( wp_verify_nonce( $nonce, self::REFRESH_ACCESS_NONCE_ACTION ) ) {
318                REST_Controller::clear_access_cache();
319            }
320        }
321
322        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_initial_state' ) );
323    }
324
325    /**
326     * Require the generated wp-build entry and register the script/module
327     * polyfills the boot bundle depends on.
328     *
329     * The boot bundle depends on `@wordpress/*` handles (e.g. `wp-theme`,
330     * pulled in via `@wordpress/ui`) that Core does not register on older
331     * WordPress versions. Without them WP_Scripts silently drops the bundle
332     * and the page renders blank, so register the polyfills here. Scoped to
333     * the Activity Log request by the sole caller, since the register() call
334     * can force-replace Core handles and must not fire on every admin page.
335     *
336     * @return void
337     */
338    private static function load_wp_build() {
339        $build_index = dirname( __DIR__ ) . '/build/build.php';
340
341        if ( ! file_exists( $build_index ) ) {
342            return;
343        }
344
345        require_once $build_index;
346
347        // The generated `modules.php` registers standalone script modules (the
348        // `@jetpack-activity-log/init` i18n bootstrap) on `wp_default_scripts`.
349        // We load wp-build lazily on `admin_menu`, which can run after that
350        // action has already fired — so the hook may be added too late and the
351        // init module never registers, leaving it out of the import map and
352        // breaking boot. Register directly here (mirroring the polyfills call
353        // below); the generated function guards against double-registration.
354        if ( function_exists( 'jetpack_activity_log_register_script_modules' ) ) {
355            jetpack_activity_log_register_script_modules(); // @phan-suppress-current-line PhanUndeclaredFunction -- Checked with function_exists(); defined in the generated build/modules.php, which Phan excludes.
356        }
357
358        WP_Build_Polyfills::register(
359            'jetpack-activity-log',
360            array_merge(
361                WP_Build_Polyfills::SCRIPT_HANDLES,
362                WP_Build_Polyfills::MODULE_IDS
363            )
364        );
365    }
366
367    /**
368     * Load wp-build with the screen ID aliased across its generated enqueue check.
369     *
370     * @see WP_Build_Screen_Id::load_with_alias()
371     * @return void
372     */
373    private static function load_wp_build_with_screen_alias() {
374        // Fallback: an older wp-build-polyfills under the jetpack-autoloader may predate load_with_alias().
375        if ( method_exists( WP_Build_Screen_Id::class, 'load_with_alias' ) ) {
376            WP_Build_Screen_Id::load_with_alias(
377                array( __CLASS__, 'alias_screen_id_for_wp_build' ),
378                array( __CLASS__, 'restore_screen_id_after_wp_build' ),
379                function () {
380                    self::load_wp_build();
381                }
382            );
383            return;
384        }
385
386        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'alias_screen_id_for_wp_build' ) );
387        self::load_wp_build();
388        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'restore_screen_id_after_wp_build' ) );
389    }
390
391    /**
392     * Alias the current screen id to the wp-build page slug.
393     *
394     * The wp-build-generated enqueue callback only fires when the screen id
395     * equals the wp-build page slug. Our menu slug stays `jetpack-activity-log`,
396     * so alias the screen id in place to make the check pass without changing
397     * the user-facing URL. Hooked only for the Activity Log request, so this
398     * never affects any other screen.
399     *
400     * @since 0.4.1 Takes no argument; hooked on `admin_enqueue_scripts`.
401     *
402     * @return void
403     */
404    public static function alias_screen_id_for_wp_build() {
405        $screen = get_current_screen();
406        if ( ! $screen ) {
407            return;
408        }
409
410        self::$wp_build_original_screen_id = $screen->id;
411        $screen->id                        = self::WP_BUILD_PAGE_SLUG;
412    }
413
414    /**
415     * Undo alias_screen_id_for_wp_build(), so code after the generated check sees the real screen ID.
416     *
417     * @since 0.4.1
418     *
419     * @return void
420     */
421    public static function restore_screen_id_after_wp_build() {
422        $screen = get_current_screen();
423        if ( ! $screen || null === self::$wp_build_original_screen_id ) {
424            return;
425        }
426
427        $screen->id                        = self::$wp_build_original_screen_id;
428        self::$wp_build_original_screen_id = null;
429    }
430
431    /**
432     * Opt the dashboard's screen out of JITMs.
433     *
434     * @param string $screen_id The hook suffix the page was registered under, which is its screen ID.
435     * @return void
436     */
437    private static function opt_out_of_jitms( $screen_id ) {
438        self::$jitm_opt_out_screen_id = $screen_id;
439        add_filter( 'jetpack_display_jitms_on_screen', array( __CLASS__, 'hide_jitms_on_wp_build_dashboard' ), 10, 2 );
440    }
441
442    /**
443     * Keep JITMs off the wp-build dashboard, which has no `#jp-admin-notices` to show them in.
444     *
445     * Fetching a JITM records a view, so one the page hides would still be counted.
446     *
447     * @since 0.4.1
448     *
449     * @param bool   $show      Whether to show JITMs on the screen.
450     * @param string $screen_id The screen ID.
451     * @return bool
452     */
453    public static function hide_jitms_on_wp_build_dashboard( $show, $screen_id ) {
454        if ( null !== self::$jitm_opt_out_screen_id && self::$jitm_opt_out_screen_id === $screen_id ) {
455            return false;
456        }
457
458        return $show;
459    }
460
461    /**
462     * Print the React initial state and the Connection initial state, and load
463     * the Tracks transport.
464     *
465     * The initial state is attached to a dedicated empty classic handle because
466     * the dashboard is a wp-build script module — there is no classic bundle
467     * handle to hang the inline data on. Boot defers its own execution to
468     * `DOMContentLoaded`, so this inline data is always set on `window` first.
469     *
470     * `jp-tracks` (stats.wp.com/w.js) is required for analytics: the dashboard's
471     * `@automattic/jetpack-analytics` events only queue into `window._tkq`
472     * (the package's own w.js loader is disabled), so without this handle no
473     * `jetpack_activity_log_*` event ever flushes. Mirrors Newsletter's
474     * `Settings::load_admin_scripts()`.
475     *
476     * @return void
477     */
478    public static function enqueue_initial_state() {
479        wp_register_script( self::DATA_SCRIPT_HANDLE, false, array(), Package_Version::PACKAGE_VERSION, true );
480        wp_enqueue_script( self::DATA_SCRIPT_HANDLE );
481
482        // wp-build has no `jetpackConfig` external, so @automattic/jetpack-config (via AdminPage) reads this global.
483        wp_add_inline_script( self::DATA_SCRIPT_HANDLE, 'window.jetpackConfig = ' . wp_json_encode( array( 'consumer_slug' => self::PAGE_SLUG ), JSON_HEX_TAG | JSON_HEX_AMP | JSON_UNESCAPED_SLASHES ) . ';', 'before' );
484        wp_add_inline_script( self::DATA_SCRIPT_HANDLE, ( new Activity_Log_Initial_State() )->render(), 'before' );
485
486        // Simple has no Jetpack connection to describe; the app treats a missing state as no connection errors.
487        if ( ! self::is_wpcom_simple() ) {
488            Connection_Initial_State::render_script( self::DATA_SCRIPT_HANDLE );
489        }
490
491        wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
492
493        // The dashboard is a wp-build script module: it externalizes
494        // `@wordpress/i18n` to the shared `wp.i18n` global but has no
495        // `wp_set_script_translations()` equivalent to load its JS catalog.
496        // Enqueue Jetpack's i18n loader (`wp.jpI18nLoader`, from jetpack-assets,
497        // registered on `wp_default_scripts`) so the `@jetpack-activity-log/init`
498        // boot module can fetch and install the translation catalog before the
499        // app renders. Without this the UI ships in English on non-English sites.
500        if ( wp_script_is( 'wp-jp-i18n-loader', 'registered' ) ) {
501            wp_enqueue_script( 'wp-jp-i18n-loader' );
502        }
503    }
504
505    /**
506     * Whether this is a WordPress.com Simple site.
507     *
508     * @since 0.6.0
509     *
510     * @return bool
511     */
512    public static function is_wpcom_simple() {
513        return ( new Host() )->is_wpcom_simple();
514    }
515
516    /**
517     * Fallback page body if the generated wp-build render function is
518     * unavailable (e.g. assets not built). Keeps the menu from fataling and
519     * still gives boot its mount container.
520     *
521     * @return void
522     */
523    public static function render_fallback() {
524        echo '<div class="wrap"><div id="jetpack-activity-log-dashboard-wp-admin-app"></div></div>';
525    }
526
527    /**
528     * Whether the current request targets the Activity Log admin page.
529     *
530     * The `$_GET['page']` value is populated by wp-admin/admin.php before any
531     * of our hooks fire, so this check is reliable from `admin_menu` onwards.
532     *
533     * @return bool
534     */
535    private static function is_activity_log_admin_request() {
536        if ( ! is_admin() || ! isset( $_GET['page'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
537            return false;
538        }
539
540        return sanitize_text_field( wp_unslash( $_GET['page'] ) ) === self::PAGE_SLUG; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
541    }
542
543    /**
544     * Register the REST routes backing the Activity Log UI.
545     *
546     * Routes are added in Phase 2. This method exists now so that the
547     * `jetpack/v4/activity-log` namespace is reserved and the hook is wired.
548     */
549    public static function register_rest_routes() {
550        REST_Controller::register_rest_routes();
551    }
552}