Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
8.85%
10 / 113
16.67%
2 / 12
 CRAP
0.00%
0 / 1
AI_Launchpad
10.87%
10 / 92
16.67%
2 / 12
 852.53
0.00%
0 / 1
 init
0.00%
0 / 9
0.00%
0 / 1
 6
 redirect_to_dashboard
0.00%
0 / 2
0.00%
0 / 1
 2
 maybe_redirect_dashboard_to_site_setup
0.00%
0 / 4
0.00%
0 / 1
 6
 should_redirect_dashboard_to_site_setup
100.00%
6 / 6
100.00%
1 / 1
 5
 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        add_action( 'load-index.php', array( __CLASS__, 'maybe_redirect_dashboard_to_site_setup' ) );
62
63        if ( ! self::is_ai_launchpad_request() ) {
64            return;
65        }
66
67        add_action( 'admin_page_access_denied', array( __CLASS__, 'redirect_to_dashboard' ) );
68
69        self::load_wp_build();
70        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_jwt_initial_state' ), 20 );
71        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_tracks' ), 20 );
72        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_script_translations' ), 20 );
73    }
74
75    /**
76     * Sends a Site Setup visit the page can't serve (done, dismissed, ineligible, not an admin) to the Dashboard
77     * instead of core's "not allowed" screen, e.g. a refresh right after the last task or an old bookmark.
78     *
79     * @return never
80     */
81    public static function redirect_to_dashboard() {
82        wp_safe_redirect( admin_url( 'index.php' ) );
83        exit;
84    }
85
86    /**
87     * Sends an AI-built site's first Dashboard visit to Site Setup, e.g. from the builder's "Return to WP Admin".
88     *
89     * @return void
90     */
91    public static function maybe_redirect_dashboard_to_site_setup() {
92        if ( ! self::should_redirect_dashboard_to_site_setup() ) {
93            return;
94        }
95
96        wp_safe_redirect( admin_url( 'admin.php?page=' . self::MENU_SLUG ) );
97        exit;
98    }
99
100    /**
101     * Whether this Dashboard visit goes to Site Setup: for an admin of an AI-built site where Site Setup never opened.
102     *
103     * Site Setup's first load records the builder's answers as the wizard option, so the redirect happens only once.
104     *
105     * @return bool
106     */
107    public static function should_redirect_dashboard_to_site_setup() {
108        return ! get_option( \AI_Launchpad_REST::OPTION_WIZARD )
109            // A list without wizard answers never gets them, and a finished one hides Site Setup: both would loop.
110            && ! get_option( \AI_Launchpad_REST::OPTION_AI_OUTPUT )
111            && current_user_can( 'manage_options' )
112            && self::is_eligible()
113            && wpcom_ai_launchpad_is_ai_built();
114    }
115
116    /**
117     * Whether the current request targets the AI Launchpad admin page.
118     *
119     * @return bool
120     */
121    private static function is_ai_launchpad_request() {
122        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
123        return is_admin() && isset( $_GET['page'] ) && self::MENU_SLUG === $_GET['page'];
124    }
125
126    /**
127     * Whether the current site is eligible for the AI Launchpad.
128     *
129     * Gate: enabled for the site (see is_enabled_for_site(), which also excludes a dismissed AI Launchpad).
130     *
131     * @return bool
132     */
133    public static function is_eligible() {
134        static $eligible = null;
135
136        if ( null === $eligible ) {
137            $eligible = self::is_enabled_for_site();
138        }
139
140        return $eligible;
141    }
142
143    /**
144     * Whether the AI Launchpad has been enabled for this site.
145     *
146     * Set at site creation for new onboarding sites, by the ?enable-ai-launchpad=1 dev handler, or manually.
147     *
148     * @return bool
149     */
150    private static function is_enabled_for_site() {
151        return (bool) get_option( 'wpcom_ai_launchpad_enabled' ) && ! wpcom_launchpad_is_no_guidance();
152    }
153
154    /**
155     * Register the top-level admin menu item for eligible users.
156     */
157    public static function register_menu() {
158        if ( ! self::is_eligible() ) {
159            return;
160        }
161
162        // Once every task is done, drop the launchpad from the sidebar. Separate from eligibility on purpose — the
163        // enable option stays set, so re-tailoring or a reset brings it back. Reads the latched flag, no rebuild.
164        if ( get_option( \AI_Launchpad_REST::OPTION_COMPLETED ) ) {
165            return;
166        }
167
168        // The render callback only exists once build/build.php is loaded, which happens on the AI Launchpad page itself.
169        $callback = function_exists( self::RENDER_CALLBACK )
170            ? self::RENDER_CALLBACK
171            : '__return_empty_string';
172
173        // The "border" glyph from @wordpress/icons — the same icon the launchpad list uses for a to-do task.
174        $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>';
175
176        add_menu_page(
177            __( 'Site Setup', 'jetpack-mu-wpcom' ),
178            __( 'Site Setup', 'jetpack-mu-wpcom' ),
179            'manage_options',
180            self::MENU_SLUG,
181            $callback,
182            '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.
183            1 // Above Dashboard (position 2): setup is the site's primary surface until it's done.
184        );
185    }
186
187    /**
188     * Load the wp-build generated asset registrations and the boot polyfills.
189     */
190    private static function load_wp_build() {
191        $wp_build_index = dirname( __DIR__, 3 ) . '/build/build.php';
192
193        if ( ! file_exists( $wp_build_index ) ) {
194            return;
195        }
196
197        require_once $wp_build_index;
198
199        // Register polyfills for WP < 7.0 (must run before enqueue).
200        WP_Build_Polyfills::register(
201            'jetpack-mu-wpcom',
202            array_merge(
203                WP_Build_Polyfills::SCRIPT_HANDLES,
204                WP_Build_Polyfills::MODULE_IDS
205            )
206        );
207    }
208
209    /**
210     * Attach the JWT preconditions to the page's prerequisites script:
211     * `JP_CONNECTION_INITIAL_STATE` (apiNonce + siteSuffix for requestJwt())
212     * and `Jetpack_Editor_Initial_State.wpcomBlogId`.
213     */
214    public static function enqueue_jwt_initial_state() {
215        $handle = self::MENU_SLUG . '-prerequisites';
216
217        if ( ! wp_script_is( $handle, 'registered' ) ) {
218            return;
219        }
220
221        Connection_Initial_State::render_script( $handle );
222
223        wp_localize_script(
224            $handle,
225            'Jetpack_Editor_Initial_State',
226            array(
227                'wpcomBlogId' => get_wpcom_blog_id(),
228            )
229        );
230    }
231
232    /**
233     * Install the JS translation catalogs on the prerequisites script, which runs before the boot
234     * module, so every `__()` in the route bundle evaluates translated.
235     */
236    public static function enqueue_script_translations() {
237        $handle    = self::MENU_SLUG . '-prerequisites';
238        $build_dir = dirname( __DIR__, 3 ) . '/build';
239        $constants = $build_dir . '/constants.php';
240
241        if ( ! wp_script_is( $handle, 'registered' ) || ! file_exists( $constants ) ) {
242            return;
243        }
244
245        // The same URL the generated route registrations use, so core resolves the same catalog names.
246        $build_constants = require $constants;
247        $translations    = wpcom_wp_build_script_translations( $build_dir . '/i18n-manifest.json', $build_constants['build_url'], 'site-setup' );
248
249        if ( null !== $translations ) {
250            wp_add_inline_script( $handle, $translations, 'before' );
251        }
252    }
253
254    /**
255     * Attach the page's Tracks preconditions: the transport itself on Atomic, and the standard
256     * event properties as a global the client recorder reads.
257     *
258     * On Simple, wpcom's stats.php loads the Tracks transport on every admin page and pushes
259     * identifyUser and the blog_id super prop with it. On Atomic nothing does — wpcomsh only
260     * enqueues jp-tracks inside the editor — so `window._tkq` stays an ordinary array, every
261     * push accumulates in it, and the whole client-side funnel is discarded on unload.
262     *
263     * The transport is only enqueued where tracking is actually permitted: "not Simple" also
264     * covers jurassic.ninja / jurassic.tube and self-hosted sites running this package, where
265     * the server recorder already stays silent under a declined ToS or offline mode. Gating
266     * here mirrors `wpcom_enqueue_tracking_scripts()` in `src/common/index.php`. The props/
267     * identity global below stays ungated: it is inert without the transport.
268     */
269    public static function enqueue_tracks() {
270        $handle = self::MENU_SLUG . '-prerequisites';
271
272        if ( ! wp_script_is( $handle, 'registered' ) ) {
273            return;
274        }
275
276        if ( ! ( new Host() )->is_wpcom_simple() ) {
277            $tracking = new Tracking( 'jetpack-mu-wpcom', new Connection_Manager() );
278            if ( $tracking->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
279                wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
280            }
281        }
282
283        // JSON rather than wp_localize_script(), which stringifies every value: blog_id would
284        // reach Tracks as a string instead of an int.
285        $bootstrap = wp_json_encode(
286            array(
287                'props'    => wpcom_ai_launchpad_standard_props(),
288                'identity' => wpcom_ai_launchpad_tracks_identity(),
289            ),
290            JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
291        );
292
293        // WordPress concatenates every `before` inline script queued for this handle into one
294        // <script> tag, so a false here (encode failure) would emit a syntax error that also
295        // takes out the other scripts sharing the handle — including JP_CONNECTION_INITIAL_STATE
296        // and Jetpack_Editor_Initial_State.wpcomBlogId, the JWT and blog id the page needs to
297        // function at all. Fall back to an empty object so this global stays inert instead.
298        if ( false === $bootstrap ) {
299            $bootstrap = '{}';
300        }
301
302        wp_add_inline_script( $handle, 'window.wpcomAiLaunchpadTracks = ' . $bootstrap . ';', 'before' );
303    }
304}