Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
3.92%
4 / 102
10.00%
1 / 10
 CRAP
0.00%
0 / 1
AI_Launchpad
4.94%
4 / 81
10.00%
1 / 10
 653.25
0.00%
0 / 1
 init
0.00%
0 / 8
0.00%
0 / 1
 6
 redirect_to_dashboard
0.00%
0 / 2
0.00%
0 / 1
 2
 is_ai_launchpad_request
0.00%
0 / 1
0.00%
0 / 1
 12
 is_eligible
100.00%
4 / 4
100.00%
1 / 1
 2
 is_enabled_for_site
0.00%
0 / 1
0.00%
0 / 1
 6
 register_menu
0.00%
0 / 17
0.00%
0 / 1
 20
 load_wp_build
0.00%
0 / 11
0.00%
0 / 1
 6
 enqueue_jwt_initial_state
0.00%
0 / 11
0.00%
0 / 1
 6
 enqueue_script_translations
0.00%
0 / 9
0.00%
0 / 1
 20
 enqueue_tracks
0.00%
0 / 17
0.00%
0 / 1
 30
1<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName -- Feature entry file, named after the feature, also holds the AI_Launchpad bootstrap class.
2/**
3 * AI Launchpad: an AI-tailored onboarding tasklist on a top-level wp-admin page.
4 *
5 * @package automattic/jetpack-mu-wpcom
6 */
7
8namespace Automattic\Jetpack\Jetpack_Mu_Wpcom;
9
10use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
11use Automattic\Jetpack\Connection\Manager as Connection_Manager;
12use Automattic\Jetpack\Status;
13use Automattic\Jetpack\Status\Host;
14use Automattic\Jetpack\Terms_Of_Service;
15use Automattic\Jetpack\Tracking;
16use Automattic\Jetpack\WP_Build_Polyfills\WP_Build_Polyfills;
17
18// helpers.php defines the shared option reader the listeners depend on, so it loads first.
19require_once __DIR__ . '/helpers.php';
20require_once __DIR__ . '/../../common/wp-build-script-translations.php';
21require_once __DIR__ . '/../../common/launchpad-no-guidance.php';
22require_once __DIR__ . '/eligibility.php';
23require_once __DIR__ . '/class-ai-launchpad-memberships.php';
24require_once __DIR__ . '/class-ai-launchpad-difm-offer.php';
25require_once __DIR__ . '/class-ai-launchpad-task-registry.php';
26require_once __DIR__ . '/class-ai-launchpad-rest.php';
27require_once __DIR__ . '/class-ai-launchpad-listeners.php';
28require_once __DIR__ . '/class-ai-launchpad-theme-listener.php';
29require_once __DIR__ . '/class-ai-launchpad-social-listener.php';
30require_once __DIR__ . '/class-ai-launchpad-subscribers-listener.php';
31require_once __DIR__ . '/class-ai-launchpad-subscribe-block-listener.php';
32require_once __DIR__ . '/class-ai-launchpad-about-page-listener.php';
33require_once __DIR__ . '/class-ai-launchpad-gallery-page-listener.php';
34require_once __DIR__ . '/class-ai-launchpad-contact-page-listener.php';
35require_once __DIR__ . '/class-ai-launchpad-events-page-listener.php';
36require_once __DIR__ . '/class-ai-launchpad-video-page-listener.php';
37require_once __DIR__ . '/class-ai-launchpad-portfolio-piece-listener.php';
38require_once __DIR__ . '/class-ai-launchpad-first-post-listener.php';
39require_once __DIR__ . '/class-ai-launchpad-dev-enable.php';
40
41/**
42 * Registers the AI Launchpad admin page and its wp-build assets.
43 */
44class AI_Launchpad {
45
46    /**
47     * Admin page slug. The `-wp-admin` suffix is the wp-build convention for pages that integrate with wp-admin chrome.
48     */
49    const MENU_SLUG = 'site-setup-wp-admin';
50
51    /**
52     * Render callback generated by wp-build in build/pages/site-setup/page-wp-admin.php.
53     */
54    const RENDER_CALLBACK = 'jetpack_mu_wpcom_site_setup_wp_admin_render_page';
55
56    /**
57     * Initialize the feature.
58     */
59    public static function init() {
60        add_action( 'admin_menu', array( __CLASS__, 'register_menu' ) );
61
62        if ( ! self::is_ai_launchpad_request() ) {
63            return;
64        }
65
66        add_action( 'admin_page_access_denied', array( __CLASS__, 'redirect_to_dashboard' ) );
67
68        self::load_wp_build();
69        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_jwt_initial_state' ), 20 );
70        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_tracks' ), 20 );
71        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_script_translations' ), 20 );
72    }
73
74    /**
75     * Sends a Site Setup visit the page can't serve (done, dismissed, ineligible, not an admin) to the Dashboard
76     * instead of core's "not allowed" screen, e.g. a refresh right after the last task or an old bookmark.
77     *
78     * @return never
79     */
80    public static function redirect_to_dashboard() {
81        wp_safe_redirect( admin_url( 'index.php' ) );
82        exit;
83    }
84
85    /**
86     * Whether the current request targets the AI Launchpad admin page.
87     *
88     * @return bool
89     */
90    private static function is_ai_launchpad_request() {
91        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
92        return is_admin() && isset( $_GET['page'] ) && self::MENU_SLUG === $_GET['page'];
93    }
94
95    /**
96     * Whether the current site is eligible for the AI Launchpad.
97     *
98     * Gate: enabled for the site (see is_enabled_for_site(), which also excludes a dismissed AI Launchpad).
99     *
100     * @return bool
101     */
102    public static function is_eligible() {
103        static $eligible = null;
104
105        if ( null === $eligible ) {
106            $eligible = self::is_enabled_for_site();
107        }
108
109        return $eligible;
110    }
111
112    /**
113     * Whether the AI Launchpad has been enabled for this site.
114     *
115     * Set at site creation for new onboarding sites, by the ?enable-ai-launchpad=1 dev handler, or manually.
116     *
117     * @return bool
118     */
119    private static function is_enabled_for_site() {
120        return (bool) get_option( 'wpcom_ai_launchpad_enabled' ) && ! wpcom_launchpad_is_no_guidance();
121    }
122
123    /**
124     * Register the top-level admin menu item for eligible users.
125     */
126    public static function register_menu() {
127        if ( ! self::is_eligible() ) {
128            return;
129        }
130
131        // Once every task is done, drop the launchpad from the sidebar. Separate from eligibility on purpose — the
132        // enable option stays set, so re-tailoring or a reset brings it back. Reads the latched flag, no rebuild.
133        if ( get_option( \AI_Launchpad_REST::OPTION_COMPLETED ) ) {
134            return;
135        }
136
137        // The render callback only exists once build/build.php is loaded, which happens on the AI Launchpad page itself.
138        $callback = function_exists( self::RENDER_CALLBACK )
139            ? self::RENDER_CALLBACK
140            : '__return_empty_string';
141
142        // The "border" glyph from @wordpress/icons — the same icon the launchpad list uses for a to-do task.
143        $icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="#fff" d="m6.6 15.6-1.2.8c.6.9 1.3 1.6 2.2 2.2l.8-1.2c-.7-.5-1.3-1.1-1.8-1.8zM5.5 12c0-.4 0-.9.1-1.3l-1.5-.3c0 .5-.1 1.1-.1 1.6s.1 1.1.2 1.6l1.5-.3c-.2-.4-.2-.9-.2-1.3zm11.9-3.6 1.2-.8c-.6-.9-1.3-1.6-2.2-2.2l-.8 1.2c.7.5 1.3 1.1 1.8 1.8zM5.3 7.6l1.2.8c.5-.7 1.1-1.3 1.8-1.8l-.7-1.3c-.9.6-1.7 1.4-2.3 2.3zm14.5 2.8-1.5.3c.1.4.1.8.1 1.3s0 .9-.1 1.3l1.5.3c.1-.5.2-1 .2-1.6s-.1-1.1-.2-1.6zM12 18.5c-.4 0-.9 0-1.3-.1l-.3 1.5c.5.1 1 .2 1.6.2s1.1-.1 1.6-.2l-.3-1.5c-.4.1-.9.1-1.3.1zm3.6-1.1.8 1.2c.9-.6 1.6-1.3 2.2-2.2l-1.2-.8c-.5.7-1.1 1.3-1.8 1.8zM10.4 4.2l.3 1.5c.4-.1.8-.1 1.3-.1s.9 0 1.3.1l.3-1.5c-.5-.1-1.1-.2-1.6-.2s-1.1.1-1.6.2z"/></svg>';
144
145        add_menu_page(
146            __( 'Site Setup', 'jetpack-mu-wpcom' ),
147            __( 'Site Setup', 'jetpack-mu-wpcom' ),
148            'manage_options',
149            self::MENU_SLUG,
150            $callback,
151            'data:image/svg+xml;base64,' . base64_encode( $icon ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- Encoding an inline SVG for the menu icon data URI.
152            1 // Above Dashboard (position 2): setup is the site's primary surface until it's done.
153        );
154    }
155
156    /**
157     * Load the wp-build generated asset registrations and the boot polyfills.
158     */
159    private static function load_wp_build() {
160        $wp_build_index = dirname( __DIR__, 3 ) . '/build/build.php';
161
162        if ( ! file_exists( $wp_build_index ) ) {
163            return;
164        }
165
166        require_once $wp_build_index;
167
168        // Register polyfills for WP < 7.0 (must run before enqueue).
169        WP_Build_Polyfills::register(
170            'jetpack-mu-wpcom',
171            array_merge(
172                WP_Build_Polyfills::SCRIPT_HANDLES,
173                WP_Build_Polyfills::MODULE_IDS
174            )
175        );
176    }
177
178    /**
179     * Attach the JWT preconditions to the page's prerequisites script:
180     * `JP_CONNECTION_INITIAL_STATE` (apiNonce + siteSuffix for requestJwt())
181     * and `Jetpack_Editor_Initial_State.wpcomBlogId`.
182     */
183    public static function enqueue_jwt_initial_state() {
184        $handle = self::MENU_SLUG . '-prerequisites';
185
186        if ( ! wp_script_is( $handle, 'registered' ) ) {
187            return;
188        }
189
190        Connection_Initial_State::render_script( $handle );
191
192        wp_localize_script(
193            $handle,
194            'Jetpack_Editor_Initial_State',
195            array(
196                'wpcomBlogId' => get_wpcom_blog_id(),
197            )
198        );
199    }
200
201    /**
202     * Install the JS translation catalogs on the prerequisites script, which runs before the boot
203     * module, so every `__()` in the route bundle evaluates translated.
204     */
205    public static function enqueue_script_translations() {
206        $handle    = self::MENU_SLUG . '-prerequisites';
207        $build_dir = dirname( __DIR__, 3 ) . '/build';
208        $constants = $build_dir . '/constants.php';
209
210        if ( ! wp_script_is( $handle, 'registered' ) || ! file_exists( $constants ) ) {
211            return;
212        }
213
214        // The same URL the generated route registrations use, so core resolves the same catalog names.
215        $build_constants = require $constants;
216        $translations    = wpcom_wp_build_script_translations( $build_dir . '/i18n-manifest.json', $build_constants['build_url'], 'site-setup' );
217
218        if ( null !== $translations ) {
219            wp_add_inline_script( $handle, $translations, 'before' );
220        }
221    }
222
223    /**
224     * Attach the page's Tracks preconditions: the transport itself on Atomic, and the standard
225     * event properties as a global the client recorder reads.
226     *
227     * On Simple, wpcom's stats.php loads the Tracks transport on every admin page and pushes
228     * identifyUser and the blog_id super prop with it. On Atomic nothing does — wpcomsh only
229     * enqueues jp-tracks inside the editor — so `window._tkq` stays an ordinary array, every
230     * push accumulates in it, and the whole client-side funnel is discarded on unload.
231     *
232     * The transport is only enqueued where tracking is actually permitted: "not Simple" also
233     * covers jurassic.ninja / jurassic.tube and self-hosted sites running this package, where
234     * the server recorder already stays silent under a declined ToS or offline mode. Gating
235     * here mirrors `wpcom_enqueue_tracking_scripts()` in `src/common/index.php`. The props/
236     * identity global below stays ungated: it is inert without the transport.
237     */
238    public static function enqueue_tracks() {
239        $handle = self::MENU_SLUG . '-prerequisites';
240
241        if ( ! wp_script_is( $handle, 'registered' ) ) {
242            return;
243        }
244
245        if ( ! ( new Host() )->is_wpcom_simple() ) {
246            $tracking = new Tracking( 'jetpack-mu-wpcom', new Connection_Manager() );
247            if ( $tracking->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
248                wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
249            }
250        }
251
252        // JSON rather than wp_localize_script(), which stringifies every value: blog_id would
253        // reach Tracks as a string instead of an int.
254        $bootstrap = wp_json_encode(
255            array(
256                'props'    => wpcom_ai_launchpad_standard_props(),
257                'identity' => wpcom_ai_launchpad_tracks_identity(),
258            ),
259            JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
260        );
261
262        // WordPress concatenates every `before` inline script queued for this handle into one
263        // <script> tag, so a false here (encode failure) would emit a syntax error that also
264        // takes out the other scripts sharing the handle — including JP_CONNECTION_INITIAL_STATE
265        // and Jetpack_Editor_Initial_State.wpcomBlogId, the JWT and blog id the page needs to
266        // function at all. Fall back to an empty object so this global stays inert instead.
267        if ( false === $bootstrap ) {
268            $bootstrap = '{}';
269        }
270
271        wp_add_inline_script( $handle, 'window.wpcomAiLaunchpadTracks = ' . $bootstrap . ';', 'before' );
272    }
273}