Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
93.04%
428 / 460
80.00%
32 / 40
 CRAP
0.00%
0 / 1
Dashboard_Data
93.04%
428 / 460
80.00%
32 / 40
 138.95
0.00%
0 / 1
 rest_reads
0.00%
0 / 6
0.00%
0 / 1
 2
 rest_read_paths
0.00%
0 / 6
0.00%
0 / 1
 2
 register_rest_reads
0.00%
0 / 12
0.00%
0 / 1
 6
 permission_check
100.00%
1 / 1
100.00%
1 / 1
 1
 register_rest_settings
100.00%
17 / 17
100.00%
1 / 1
 2
 force_setting_args
100.00%
13 / 13
100.00%
1 / 1
 3
 read_boolean_setting
100.00%
3 / 3
100.00%
1 / 1
 3
 option_names
100.00%
9 / 9
100.00%
1 / 1
 1
 settings_definitions
100.00%
69 / 69
100.00%
1 / 1
 1
 title_format_schemas
100.00%
48 / 48
100.00%
1 / 1
 2
 front_page_description_option
100.00%
3 / 3
100.00%
1 / 1
 2
 has_legacy_front_page_meta
100.00%
1 / 1
100.00%
1 / 1
 2
 get_front_page_meta_description
100.00%
3 / 3
100.00%
1 / 1
 2
 get_front_page_meta_description_without_helper
100.00%
4 / 4
100.00%
1 / 1
 3
 is_jetpack_seo_enabled
100.00%
3 / 3
100.00%
1 / 1
 2
 is_jetpack_seo_enabled_without_helper
100.00%
1 / 1
100.00%
1 / 1
 1
 after_setting_write
100.00%
2 / 2
100.00%
1 / 1
 2
 after_settings_request
100.00%
9 / 9
100.00%
1 / 1
 8
 has_module
100.00%
3 / 3
100.00%
1 / 1
 3
 switch_module
100.00%
15 / 15
100.00%
1 / 1
 4
 is_site_private
100.00%
1 / 1
100.00%
1 / 1
 2
 is_site_coming_soon
100.00%
1 / 1
100.00%
1 / 1
 2
 block_publishing_a_private_site
100.00%
5 / 5
100.00%
1 / 1
 6
 sanitize_front_page_description
100.00%
5 / 5
100.00%
1 / 1
 2
 sanitize_title_formats
100.00%
13 / 13
100.00%
1 / 1
 8
 sanitize_verification_codes
100.00%
14 / 14
100.00%
1 / 1
 7
 module_settings
100.00%
5 / 5
100.00%
1 / 1
 1
 register_module_routes
100.00%
13 / 13
100.00%
1 / 1
 2
 update_modules
100.00%
19 / 19
100.00%
1 / 1
 4
 apply_module_setting
100.00%
16 / 16
100.00%
1 / 1
 6
 get_overview_data
95.24%
20 / 21
0.00%
0 / 1
 2
 normalize_title_formats
100.00%
14 / 14
100.00%
1 / 1
 10
 get_settings_data
97.50%
39 / 40
0.00%
0 / 1
 12
 get_google_verify_data
90.00%
9 / 10
0.00%
0 / 1
 3.01
 get_geo_data
100.00%
19 / 19
100.00%
1 / 1
 5
 get_content_data
100.00%
3 / 3
100.00%
1 / 1
 1
 get_output_data
100.00%
4 / 4
100.00%
1 / 1
 1
 get_site_data
92.31%
12 / 13
0.00%
0 / 1
 4.01
 get_default_title_separator
100.00%
6 / 6
100.00%
1 / 1
 2
 get_reachable_sitemap_url
60.00%
6 / 10
0.00%
0 / 1
 10.14
1<?php
2/**
3 * The SEO dashboard's REST surface: the read-only routes behind each data-backed
4 * tab (preloaded onto the page so a normal load resolves them with no request),
5 * the settings the dashboard writes, and the one write that isn't a setting.
6 *
7 * Writes go through WordPress core's `/wp/v2/settings` wherever the value is an
8 * option — see {@see self::register_rest_settings()} — so the dashboard depends
9 * on nothing but core REST. Module activation is the one thing `register_setting()`
10 * can't express, and has its own small route ({@see self::register_module_routes()}).
11 *
12 * @package automattic/jetpack-seo-package
13 */
14
15namespace Automattic\Jetpack\SEO;
16
17use Automattic\Jetpack\Modules;
18use Automattic\Jetpack\Status;
19use Automattic\Jetpack\Status\Host;
20use Jetpack_SEO_Utils;
21use WP_Error;
22use WP_REST_Request;
23
24/**
25 * Registers the dashboard's REST routes and settings, and builds their payloads.
26 */
27class Dashboard_Data {
28
29    /**
30     * REST namespace, shared with the package's other Jetpack routes.
31     *
32     * @var string
33     */
34    const REST_NAMESPACE = 'jetpack/v4';
35
36    /**
37     * Route, relative to the namespace, for the dashboard toggles that map to
38     * Jetpack module activation rather than to an option.
39     *
40     * @var string
41     */
42    const MODULES_REST_BASE = '/seo/modules';
43
44    /**
45     * Settings API group the package registers its options under.
46     *
47     * Only the Settings API's `options.php` form handler reads groups, and the
48     * dashboard doesn't go through it — `register_setting()` requires a group, and
49     * it's otherwise inert here.
50     *
51     * @var string
52     */
53    const SETTINGS_GROUP = 'jetpack_seo';
54
55    /**
56     * Option holding the site's verification service codes, one per service.
57     *
58     * @var string
59     */
60    const VERIFICATION_CODES_OPTION = 'verification_services_codes';
61
62    /**
63     * Option holding the SEO page title structures.
64     *
65     * @var string
66     */
67    const TITLE_FORMATS_OPTION = 'advanced_seo_title_formats';
68
69    /**
70     * Option holding the front page meta description.
71     *
72     * Mirrors `Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION`, which the package can't
73     * rely on being loaded. Doubles as the REST key for the setting, which stays
74     * stable even when the value is stored in the legacy option instead
75     * ({@see self::front_page_description_option()}).
76     *
77     * @var string
78     */
79    const FRONT_PAGE_META_OPTION = 'advanced_seo_front_page_description';
80
81    /**
82     * Option holding the AI SEO Enhancer's on/off state.
83     *
84     * @var string
85     */
86    const AI_SEO_ENHANCER_OPTION = 'ai_seo_enhancer_enabled';
87
88    /**
89     * Legacy option the front page meta description is stored in on WordPress.com
90     * sites that set one while SEO tools were free for every Simple site. Mirrors
91     * `Jetpack_SEO_Utils::LEGACY_META_OPTION`.
92     *
93     * @var string
94     */
95    const LEGACY_FRONT_PAGE_META_OPTION = 'seo_meta_description';
96
97    /**
98     * Map of read-only dashboard routes: tab slug => data-builder callable. The
99     * single source of truth for both the registered routes and the paths
100     * preloaded onto the page, so the two can't drift.
101     *
102     * @return array<string, callable>
103     */
104    private static function rest_reads() {
105        return array(
106            'overview' => array( __CLASS__, 'get_overview_data' ),
107            'settings' => array( __CLASS__, 'get_settings_data' ),
108            'geo'      => array( __CLASS__, 'get_geo_data' ),
109            'content'  => array( __CLASS__, 'get_content_data' ),
110        );
111    }
112
113    /**
114     * REST paths the dashboard reads its initial state from, preloaded into the
115     * page (see {@see Admin_Page::inject_script_data()}) and fetched by the app.
116     *
117     * @return string[]
118     */
119    public static function rest_read_paths() {
120        return array_map(
121            static function ( $slug ) {
122                return '/' . self::REST_NAMESPACE . '/seo/' . $slug;
123            },
124            array_keys( self::rest_reads() )
125        );
126    }
127
128    /**
129     * Register the read-only REST routes the dashboard hydrates from — one per
130     * data-backed tab, each returning the same builder payload previously injected
131     * synchronously onto the page. Read-only and gated to the page's own
132     * `manage_options`; writes still go through their existing endpoints.
133     *
134     * @return void
135     */
136    public static function register_rest_reads() {
137        foreach ( self::rest_reads() as $slug => $builder ) {
138            register_rest_route(
139                self::REST_NAMESPACE,
140                '/seo/' . $slug,
141                array(
142                    'methods'             => \WP_REST_Server::READABLE,
143                    'callback'            => static function () use ( $builder ) {
144                        return rest_ensure_response( call_user_func( $builder ) );
145                    },
146                    'permission_callback' => array( __CLASS__, 'permission_check' ),
147                )
148            );
149        }
150    }
151
152    /**
153     * Capability gate for the dashboard's REST routes — the same `manage_options`
154     * the SEO admin page itself requires, and the same capability the core settings
155     * controller enforces on the settings the dashboard writes there.
156     *
157     * @return bool
158     */
159    public static function permission_check() {
160        return current_user_can( 'manage_options' );
161    }
162
163    /**
164     * Expose every option the SEO dashboard writes to WordPress core's
165     * `/wp/v2/settings` endpoint.
166     *
167     * The dashboard used to save these through the Jetpack plugin's
168     * `/jetpack/v4/settings` route, which doesn't exist everywhere the package
169     * runs — WordPress.com Simple sites boot Jetpack from a small file list that
170     * doesn't include it, so every write 404'd there. Core's settings endpoint is
171     * registered by WordPress itself, needs no new route, and enforces the same
172     * `manage_options` capability, so it works on every platform with one code path.
173     *
174     * Only settings registered with `show_in_rest` round-trip through that
175     * endpoint, and it silently ignores keys that aren't registered — which is why
176     * this runs behind the same `seo-tools` gate as the rest of the settings
177     * surface, and why the dashboard hides its controls when that module is off.
178     *
179     * Hooked on `rest_api_init`, not earlier: which option the front page description is
180     * stored in depends on `jetpack_disable_seo_tools`, and a conflicting SEO plugin can
181     * add that filter from anywhere up to the end of `init`. Registering here settles the
182     * question after every one of those has had its say, and still before core builds the
183     * settings route from the registry at priority 99.
184     *
185     * @return void
186     */
187    public static function register_rest_settings() {
188        // Search-engine visibility is a WordPress core option, not a Jetpack one.
189        register_setting(
190            'reading',
191            'blog_public',
192            array(
193                'show_in_rest' => true,
194                'type'         => 'integer',
195                'default'      => 1,
196            )
197        );
198
199        // Refuse an indexing write that would publish a private site. Scoped to core's
200        // settings route rather than attached as `blog_public`'s sanitizer, because a
201        // `register_setting()` sanitizer applies to every writer of the option for the
202        // rest of the request — including the site's own visibility control, which must
203        // stay able to change it.
204        add_filter( 'rest_pre_update_setting', array( __CLASS__, 'block_publishing_a_private_site' ), 10, 3 );
205
206        foreach ( self::settings_definitions() as $option => $args ) {
207            register_setting( self::SETTINGS_GROUP, $option, $args );
208        }
209
210        // `verification_services_codes` is also registered by the verification-tools
211        // module, and the last `register_setting()` for an option name replaces the
212        // registry entry — which would drop the `show_in_rest` exposure the dashboard
213        // saves through, leaving core to ignore the write and still answer 200. Rather
214        // than depend on hook order, force our own arguments back on for the options we
215        // own, whoever registers them and whenever. Added after the loop above so our
216        // own registrations don't recurse through it.
217        add_filter( 'register_setting_args', array( __CLASS__, 'force_setting_args' ), 10, 4 );
218        add_filter( 'rest_pre_get_setting', array( __CLASS__, 'read_boolean_setting' ), 10, 3 );
219
220        // The one thing that has to happen after the write rather than during it:
221        // dropping the superseded legacy front-page option. Both actions pass the
222        // option name first, and `added_option` covers a first write, which
223        // `update_option()` routes through `add_option()`.
224        add_action( 'add_option_' . self::FRONT_PAGE_META_OPTION, array( __CLASS__, 'after_setting_write' ) );
225        add_action( 'update_option_' . self::FRONT_PAGE_META_OPTION, array( __CLASS__, 'after_setting_write' ) );
226        add_filter( 'rest_request_after_callbacks', array( __CLASS__, 'after_settings_request' ), 10, 3 );
227    }
228
229    /**
230     * Keep the REST contract of the options this package owns authoritative, no matter
231     * who else registers them or in what order.
232     *
233     * Only the three arguments that decide whether and how the option round-trips
234     * through `/wp/v2/settings` are forced. Everything else is the caller's: its label
235     * and description still describe its own surface, and leaving its `sanitize_callback`
236     * in place is what keeps the verification-tools module's `jetpack_verification_validate`
237     * attached — and with it the `jetpack_site_verification_validate` action its consumers
238     * listen for. Our own sanitizer is attached by our own `register_setting()` call and
239     * stays attached alongside it, since sanitize filters accumulate.
240     *
241     * @param array  $args     Arguments the caller passed to `register_setting()`.
242     * @param array  $defaults Default arguments.
243     * @param string $group    Setting group (unused).
244     * @param string $option   Option name.
245     * @return array
246     */
247    public static function force_setting_args( $args, $defaults, $group, $option ) {
248        // Cheap membership test first. This filter fires for every `register_setting()`
249        // call in the request — core alone registers ~20 — and building the definitions
250        // rebuilds the title-format schemas and re-decides which description option is live.
251        if ( ! in_array( $option, self::option_names(), true ) ) {
252            return $args;
253        }
254
255        $ours = self::settings_definitions();
256        if ( ! isset( $ours[ $option ] ) ) {
257            return $args;
258        }
259
260        return array_merge(
261            $args,
262            array(
263                'type'         => $ours[ $option ]['type'],
264                // `filter_default_option()` reads this key unconditionally once the option
265                // is registered, so it has to survive a caller that didn't set one.
266                'default'      => $ours[ $option ]['default'],
267                'show_in_rest' => $ours[ $option ]['show_in_rest'],
268            )
269        );
270    }
271
272    /**
273     * Normalize false options stored as empty strings so core REST returns a boolean, not null.
274     *
275     * @param mixed  $value Existing filtered setting value.
276     * @param string $name REST setting name.
277     * @param array  $args REST setting registration arguments.
278     * @return mixed Filtered setting value.
279     */
280    public static function read_boolean_setting( $value, $name, $args ) {
281        if ( null !== $value || ! in_array( $name, array( self::AI_SEO_ENHANCER_OPTION, Llms_Txt::OPTION ), true ) ) {
282            return $value;
283        }
284
285        return (bool) get_option( $args['option_name'], $args['schema']['default'] );
286    }
287
288    /**
289     * Every option name this package can own, including both homes the front page
290     * description can have. A flat list so {@see self::force_setting_args()} can rule
291     * an option out without building the definitions.
292     *
293     * @return string[]
294     */
295    private static function option_names() {
296        return array(
297            self::AI_SEO_ENHANCER_OPTION,
298            Llms_Txt::OPTION,
299            Ai_Crawlers::OPTION,
300            self::TITLE_FORMATS_OPTION,
301            self::VERIFICATION_CODES_OPTION,
302            self::FRONT_PAGE_META_OPTION,
303            self::LEGACY_FRONT_PAGE_META_OPTION,
304        );
305    }
306
307    /**
308     * The SEO options exposed to `/wp/v2/settings`, keyed by option name.
309     *
310     * Types, defaults and sanitizers mirror what `/jetpack/v4/settings` enforces for
311     * the keys it also exposes, so a save behaves the same through either route.
312     *
313     * @return array<string, array>
314     */
315    private static function settings_definitions() {
316        return array(
317            self::AI_SEO_ENHANCER_OPTION          => array(
318                'type'         => 'boolean',
319                'default'      => false,
320                'show_in_rest' => true,
321            ),
322            Llms_Txt::OPTION                      => array(
323                'type'         => 'boolean',
324                'default'      => false,
325                'show_in_rest' => true,
326            ),
327            Ai_Crawlers::OPTION                   => array(
328                'type'              => 'object',
329                'default'           => array(),
330                'sanitize_callback' => array( Ai_Crawlers::class, 'sanitize_blocked' ),
331                'show_in_rest'      => array(
332                    'schema' => array(
333                        'type'       => 'object',
334                        'properties' => array_fill_keys(
335                            Ai_Crawlers::GROUPS,
336                            array(
337                                // Core needs `type` here as well as in `anyOf` (rest_default_additional_properties_to_false()).
338                                'type'  => array( 'string', 'array' ),
339                                'anyOf' => array(
340                                    array(
341                                        'type' => 'string',
342                                        'enum' => array( 'all' ),
343                                    ),
344                                    array(
345                                        'type'  => 'array',
346                                        'items' => array( 'type' => 'string' ),
347                                    ),
348                                ),
349                            )
350                        ),
351                    ),
352                ),
353            ),
354            self::TITLE_FORMATS_OPTION            => array(
355                'type'              => 'object',
356                'default'           => array(),
357                'sanitize_callback' => array( __CLASS__, 'sanitize_title_formats' ),
358                'show_in_rest'      => array(
359                    'schema' => array(
360                        'type'       => 'object',
361                        'properties' => self::title_format_schemas(),
362                    ),
363                ),
364            ),
365            self::VERIFICATION_CODES_OPTION       => array(
366                'type'              => 'object',
367                'default'           => array(),
368                'sanitize_callback' => array( __CLASS__, 'sanitize_verification_codes' ),
369                'show_in_rest'      => array(
370                    'schema' => array(
371                        'type'       => 'object',
372                        'properties' => array_fill_keys(
373                            array( 'google', 'bing', 'pinterest', 'yandex', 'facebook' ),
374                            array( 'type' => 'string' )
375                        ),
376                    ),
377                ),
378            ),
379            self::front_page_description_option() => array(
380                'type'              => 'string',
381                'default'           => '',
382                'sanitize_callback' => array( __CLASS__, 'sanitize_front_page_description' ),
383                // The REST key stays the modern option name even when the value lives in
384                // the legacy one, so the client never has to know which is in play.
385                'show_in_rest'      => array( 'name' => self::FRONT_PAGE_META_OPTION ),
386            ),
387        );
388    }
389
390    /**
391     * Per-page-type schema for a title structure, restoring the contract
392     * `Jetpack_SEO_Titles::are_valid_title_formats()` enforced on the Jetpack settings
393     * endpoint: both keys are required (the renderer reads `type` on every public
394     * request), and a token has to be one this page type actually offers.
395     *
396     * @return array<string, array>
397     */
398    private static function title_format_schemas() {
399        // Mirrors `Jetpack_SEO_Titles::get_allowed_tokens()`. Duplicated rather than
400        // called: that class ships with the Jetpack plugin, and the schema has to hold
401        // wherever the package runs.
402        $allowed_tokens = array(
403            'front_page' => array( 'site_name', 'tagline' ),
404            'posts'      => array( 'site_name', 'tagline', 'post_title' ),
405            'pages'      => array( 'site_name', 'tagline', 'page_title' ),
406            'groups'     => array( 'site_name', 'tagline', 'group_title' ),
407            'archives'   => array( 'site_name', 'tagline', 'date', 'archive_title' ),
408        );
409
410        $schemas = array();
411        foreach ( $allowed_tokens as $page_type => $tokens ) {
412            $schemas[ $page_type ] = array(
413                'type'  => 'array',
414                'items' => array(
415                    'type'       => 'object',
416                    // Both keys required: the front-end renderer reads `type` on every
417                    // public request, so a token missing it must never reach storage.
418                    'required'   => array( 'type', 'value' ),
419                    'properties' => array(
420                        'type'  => array(
421                            'type' => 'string',
422                            'enum' => array( 'string', 'token' ),
423                        ),
424                        'value' => array( 'type' => 'string' ),
425                    ),
426                    // Which values `value` may take depends on `type`, which one flat
427                    // object can't say. Core applies `oneOf` first and then the shape
428                    // above, so the two together are the old helper's contract.
429                    'oneOf'      => array(
430                        array(
431                            'type'       => 'object',
432                            'properties' => array(
433                                'type' => array(
434                                    'type' => 'string',
435                                    'enum' => array( 'string' ),
436                                ),
437                            ),
438                        ),
439                        array(
440                            'type'       => 'object',
441                            'properties' => array(
442                                'type'  => array(
443                                    'type' => 'string',
444                                    'enum' => array( 'token' ),
445                                ),
446                                'value' => array(
447                                    'type' => 'string',
448                                    'enum' => $tokens,
449                                ),
450                            ),
451                        ),
452                    ),
453                ),
454            );
455        }
456
457        return $schemas;
458    }
459
460    /**
461     * Select the description option that the site currently reads for output.
462     *
463     * @return string
464     */
465    private static function front_page_description_option() {
466        return self::has_legacy_front_page_meta()
467            ? self::LEGACY_FRONT_PAGE_META_OPTION
468            : self::FRONT_PAGE_META_OPTION;
469    }
470
471    /**
472     * Whether the front page description still lives in the legacy option — Jetpack's
473     * SEO output is off for this site and a description is stored there, so that's what
474     * the front end reads and what an edit has to write back to.
475     *
476     * The rule `Jetpack_SEO_Utils::has_legacy_front_page_meta()` applies, evaluated from
477     * the site's own state so that the read path, the write path and the front end can't
478     * disagree on a site where that class isn't loaded.
479     *
480     * @return bool
481     */
482    private static function has_legacy_front_page_meta() {
483        return ! self::is_jetpack_seo_enabled() && (bool) get_option( self::LEGACY_FRONT_PAGE_META_OPTION );
484    }
485
486    /**
487     * The front page meta description this site's front end actually emits.
488     *
489     * `Jetpack_SEO_Utils::get_front_page_meta_description()` reproduced for sites that
490     * don't load it — which includes WordPress.com Simple, where reading it through
491     * `class_exists()` returned `''` for every site and left the Settings field blank
492     * over a live description. Same shape as {@see self::is_jetpack_seo_enabled()}:
493     * defer to the helper wherever it's loaded, reproduce it exactly everywhere else,
494     * so the field the user edits is the value the front end reads.
495     *
496     * @return string
497     */
498    private static function get_front_page_meta_description() {
499        if ( class_exists( 'Jetpack_SEO_Utils' ) ) {
500            // @phan-suppress-next-line PhanUndeclaredClassMethod -- Jetpack_SEO_Utils lives in plugins/jetpack and is guarded by class_exists.
501            return (string) Jetpack_SEO_Utils::get_front_page_meta_description();
502        }
503
504        return self::get_front_page_meta_description_without_helper();
505    }
506
507    /**
508     * `Jetpack_SEO_Utils::get_front_page_meta_description()` reproduced for sites that
509     * don't load it — which includes WordPress.com Simple.
510     *
511     * Split out from {@see self::get_front_page_meta_description()} so this branch is
512     * reachable from a test even where the helper class is loaded, the same way
513     * {@see self::is_jetpack_seo_enabled_without_helper()} is.
514     *
515     * @return string
516     */
517    private static function get_front_page_meta_description_without_helper() {
518        if ( self::is_jetpack_seo_enabled_without_helper() ) {
519            $modern = get_option( self::FRONT_PAGE_META_OPTION );
520            return (string) ( $modern ? $modern : get_option( self::LEGACY_FRONT_PAGE_META_OPTION, '' ) );
521        }
522
523        return (string) get_option( self::LEGACY_FRONT_PAGE_META_OPTION, '' );
524    }
525
526    /**
527     * Whether Jetpack's SEO output is live for this site, which is what decides
528     * where the front page description is stored and read from.
529     *
530     * Defers to `Jetpack_SEO_Utils` wherever it's loaded, because that helper is what the
531     * front end reads the description by and the two must not disagree. Everywhere else
532     * {@see self::is_jetpack_seo_enabled_without_helper()} reproduces it.
533     *
534     * @return bool
535     */
536    private static function is_jetpack_seo_enabled() {
537        if ( class_exists( 'Jetpack_SEO_Utils' ) ) {
538            // @phan-suppress-next-line PhanUndeclaredClassMethod -- Jetpack_SEO_Utils lives in plugins/jetpack and is guarded by class_exists.
539            return (bool) Jetpack_SEO_Utils::is_enabled_jetpack_seo();
540        }
541
542        return self::is_jetpack_seo_enabled_without_helper();
543    }
544
545    /**
546     * Match the helper's conflict policy when the host does not load it.
547     *
548     * @return bool
549     */
550    private static function is_jetpack_seo_enabled_without_helper() {
551        return ! Seo_Tools::is_disabled();
552    }
553
554    /**
555     * Drop the superseded legacy front page description once a modern one is saved.
556     *
557     * The front end falls back to the legacy option whenever the modern value is
558     * empty, so leaving it in place would let a cleared description resurrect text the
559     * site set years ago. Matches what the Jetpack settings endpoint did on the same
560     * write, including its condition: only where Jetpack's SEO output is actually live,
561     * so a site with disabled output keeps its legacy description.
562     *
563     * Hooked to the option-scoped `add_option_*` / `update_option_*` actions rather
564     * than the site-wide ones, so it fires on a real change to this one option instead
565     * of being consulted on every option write in the request.
566     *
567     * @return void
568     */
569    public static function after_setting_write() {
570        if ( self::is_jetpack_seo_enabled() ) {
571            delete_option( self::LEGACY_FRONT_PAGE_META_OPTION );
572        }
573    }
574
575    /**
576     * Clear legacy text after a successful empty save, including an unchanged modern option.
577     *
578     * An unchanged option does not fire the add/update hooks, so an explicit REST clear
579     * must also remove legacy text that the front end would otherwise use as a fallback.
580     *
581     * @param mixed           $response REST response.
582     * @param array           $handler  Route handler (unused).
583     * @param WP_REST_Request $request  REST request.
584     * @return mixed
585     */
586    public static function after_settings_request( $response, $handler, WP_REST_Request $request ) {
587        if ( is_wp_error( $response ) || rest_ensure_response( $response )->get_status() >= 400
588            || ! preg_match( '#^/wp/v2/(?:sites/[^/]+/)?settings$#', $request->get_route() )
589            || ! in_array( $request->get_method(), array( 'POST', 'PUT', 'PATCH' ), true )
590            || '' !== $request->get_param( self::FRONT_PAGE_META_OPTION ) ) {
591            return $response;
592        }
593
594        $settings = get_registered_settings();
595        if ( isset( $settings[ self::FRONT_PAGE_META_OPTION ] ) && '' === get_option( self::FRONT_PAGE_META_OPTION, '' ) ) {
596            self::after_setting_write();
597        }
598
599        return $response;
600    }
601
602    /**
603     * Whether this site has the given Jetpack module at all.
604     *
605     * Deliberately not `Modules::is_module()`: that's a path-traversal check, and it
606     * passes every slug on a site whose module list is empty — which is the case this
607     * has to detect. WordPress.com Simple ships no Jetpack modules and provides the
608     * behavior itself.
609     *
610     * @param string $module Module slug.
611     * @return bool
612     */
613    private static function has_module( $module ) {
614        // Simple's platform-managed generator is not controlled by module activation.
615        if ( 'sitemaps' === $module && ( new Host() )->is_wpcom_simple() ) {
616            return false;
617        }
618
619        return in_array( $module, ( new Modules() )->get_available(), true );
620    }
621
622    /**
623     * Switch a module without persisting wpcomsh's temporary private-site suppression.
624     *
625     * `Modules::is_active()` reads through `jetpack_active_modules`, where wpcomsh
626     * hides `sitemaps` and `verification-tools` on private and coming-soon sites.
627     * That filtered state cannot tell whether a saved preference is already off:
628     * it reports false even when the module remains in the site's stored list.
629     * Deactivation also reads that list through the filter, so lifting the callback
630     * only for the initial check or final read-back would still leave the switch broken.
631     *
632     * Lift only wpcomsh's callback for the entire read-modify-write. Other filters
633     * still count, so a module genuinely held off remains an error. An isolated hook
634     * copy and the finally block restore the original suppression even after a failure;
635     * saving a module preference does not change the site's visibility.
636     *
637     * @param string $module  Module slug.
638     * @param bool   $enabled Whether the setting is on.
639     * @return bool Whether the module now matches the setting.
640     */
641    private static function switch_module( $module, $enabled ) {
642        global $wp_filter;
643
644        $modules  = new Modules();
645        $hook     = 'jetpack_active_modules';
646        $callback = '\Private_Site\filter_jetpack_active_modules';
647        $priority = has_filter( $hook, $callback );
648        $original = null;
649
650        if ( false !== $priority ) {
651            $original = $wp_filter[ $hook ];
652
653            // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restore the original hook after the switch.
654            $wp_filter[ $hook ] = clone $original;
655            remove_filter( $hook, $callback, $priority );
656        }
657
658        try {
659            if ( $modules->is_active( $module ) === $enabled ) {
660                return true;
661            }
662
663            $modules->update_status( $module, $enabled, false, false );
664
665            return $modules->is_active( $module ) === $enabled;
666        } finally {
667            if ( null !== $original ) {
668                // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restore the untouched original hook.
669                $wp_filter[ $hook ] = $original;
670            }
671        }
672    }
673
674    /**
675     * Whether a WordPress.com site is unpublished: private (a negative `blog_public`)
676     * or Coming Soon. Always false on self-hosted, where the option is a plain 0/1.
677     *
678     * @return bool
679     */
680    private static function is_site_private() {
681        return (int) get_option( 'blog_public', 1 ) < 0 || self::is_site_coming_soon();
682    }
683
684    /**
685     * Whether the site is in WordPress.com's Coming Soon mode, which normally keeps
686     * `blog_public` at 0, so only the platform's own flag tells it from a discouraged site.
687     *
688     * @return bool
689     */
690    private static function is_site_coming_soon() {
691        return ( new Host() )->is_wpcom_platform() && (bool) ( new Status() )->is_coming_soon();
692    }
693
694    /**
695     * Refuse an indexing write that would publish a private WordPress.com site or launch a Coming Soon one.
696     *
697     * Needed because jetpack-mu-wpcom ends Coming Soon on any `blog_public` move away from 0. Hooked on
698     * core's settings route, not the option's sanitizer, so the site's own visibility control still works.
699     *
700     * @param bool   $handled Whether another handler already wrote the setting.
701     * @param string $name    Setting name.
702     * @param mixed  $value   Submitted value.
703     * @return bool True to report the write as handled, which skips it.
704     */
705    public static function block_publishing_a_private_site( $handled, $name, $value ) {
706        if ( $handled || 'blog_public' !== $name ) {
707            return $handled;
708        }
709
710        if ( (int) get_option( 'blog_public', 1 ) < 0 ) {
711            return (int) $value >= 0;
712        }
713
714        // A null write deletes the option, which reads back as the registered default of 1.
715        return self::is_site_coming_soon() && ( null === $value || (int) $value > 0 );
716    }
717
718    /**
719     * Clamp the front page meta description to plain text of a bounded length.
720     *
721     * @param string $value Submitted description.
722     * @return string
723     */
724    public static function sanitize_front_page_description( $value ) {
725        $value = wp_strip_all_tags( (string) $value );
726
727        /** This filter is documented in projects/plugins/jetpack/modules/seo-tools/class-jetpack-seo-utils.php */
728        $max_length = (int) apply_filters( 'jetpack_seo_front_page_description_max_length', 300 );
729
730        return function_exists( 'mb_substr' )
731            ? mb_substr( $value, 0, $max_length )
732            : substr( $value, 0, $max_length );
733    }
734
735    /**
736     * Strip markup out of the literal text a title structure joins its tokens with.
737     *
738     * Deliberately not `wp_strip_all_tags()`: that trims, and the spacing around a
739     * separator ("Post Title | Site Name") is exactly what the user typed and has to
740     * survive. Token values are left alone — the schema already limits a token to a
741     * string, and an unrecognized one simply renders as itself.
742     *
743     * @param array $value Submitted title structures, keyed by page type.
744     * @return array
745     */
746    public static function sanitize_title_formats( $value ) {
747        if ( ! is_array( $value ) ) {
748            return array();
749        }
750
751        foreach ( $value as $page_type => $tokens ) {
752            if ( ! is_array( $tokens ) ) {
753                unset( $value[ $page_type ] );
754                continue;
755            }
756
757            foreach ( $tokens as $index => $token ) {
758                if ( ! isset( $token['value'] ) || ! isset( $token['type'] ) || 'string' !== $token['type'] ) {
759                    continue;
760                }
761
762                $text = preg_replace( '@<(script|style)[^>]*?>.*?</\\1>@si', '', (string) $token['value'] );
763                $text = strip_tags( $text ); // phpcs:ignore WordPress.WP.AlternativeFunctions.strip_tags_strip_tags -- wp_strip_all_tags() trims, and leading/trailing spacing is meaningful here.
764
765                $value[ $page_type ][ $index ]['value'] = preg_replace( '/[\r\n\t ]+/', ' ', $text );
766            }
767        }
768
769        return $value;
770    }
771
772    /**
773     * Reduce each submitted verification entry to the bare code, merged over the
774     * codes already stored.
775     *
776     * Services hand out a whole `<meta name="…" content="…">` tag and site owners
777     * paste it verbatim, so keep only the content attribute — the same thing the
778     * verification-tools module does when it renders the tag. Merging rather than
779     * replacing keeps any service the dashboard doesn't offer intact.
780     *
781     * @param array $value Submitted codes, keyed by service.
782     * @return array
783     */
784    public static function sanitize_verification_codes( $value ) {
785        $stored = get_option( self::VERIFICATION_CODES_OPTION, array() );
786        if ( ! is_array( $stored ) ) {
787            $stored = array();
788        }
789
790        if ( ! is_array( $value ) ) {
791            return $stored;
792        }
793
794        foreach ( $value as $service => $code ) {
795            $service = sanitize_key( $service );
796            $code    = (string) $code;
797
798            // Anything that isn't already a bare code has to yield one, by unwrapping the
799            // whole `<meta …>` tag a service hands out. A value that yields no code at
800            // all is not a verification code, and the stored one is kept rather than
801            // overwritten: the old `/jetpack/v4/settings` route rejected that input with
802            // a 400 and left the saved code intact, and silently destroying it is the
803            // worse of the two failures. (Keeping it also survives the verification-tools
804            // module's own sanitizer running after ours, which sees a valid bare code.)
805            // An empty string is a deliberate clear, not a failed parse, so it passes.
806            if ( '' !== $code && ! preg_match( '/^[a-z0-9_-]+$/i', $code ) ) {
807                if ( ! preg_match( '/content=["\']?([^"\' ]*)["\' ]/i', $code, $matches ) ) {
808                    continue;
809                }
810                $code = urldecode( $matches[1] );
811            }
812
813            // 100 chars is the cap the verification-tools module stores by.
814            $stored[ $service ] = substr( sanitize_text_field( trim( $code ) ), 0, 100 );
815        }
816
817        return $stored;
818    }
819
820    /**
821     * Map the dashboard's module-backed fields to module slugs.
822     *
823     * These are the settings core's `/wp/v2/settings` cannot own. Switching a module
824     * can fail, and that failure must reach the user rather than return a successful
825     * response with an unchanged stored value. A `register_setting()` sanitizer is
826     * also the wrong place for the switch: it runs before the write and can run on
827     * paths where nothing is persisted. The module route switches the module, checks
828     * the result, and returns a real error when the requested state was not reached.
829     *
830     * @return array<string, string>
831     */
832    private static function module_settings() {
833        return array(
834            'sitemap_active'            => 'sitemaps',
835            'canonical_active'          => 'canonical-urls',
836            'verification_tools_active' => 'verification-tools',
837        );
838    }
839
840    /**
841     * Register the write route for the dashboard settings that switch a Jetpack module.
842     *
843     * Write-only: the current state is already served by `/jetpack/v4/seo/settings`,
844     * which the dashboard reads on load.
845     *
846     * @return void
847     */
848    public static function register_module_routes() {
849        $args = array();
850        foreach ( array_keys( self::module_settings() ) as $field ) {
851            // All optional: the dashboard sends only what changed.
852            $args[ $field ] = array( 'type' => 'boolean' );
853        }
854
855        register_rest_route(
856            self::REST_NAMESPACE,
857            self::MODULES_REST_BASE,
858            array(
859                'methods'             => \WP_REST_Server::EDITABLE,
860                'callback'            => array( __CLASS__, 'update_modules' ),
861                'permission_callback' => array( __CLASS__, 'permission_check' ),
862                'args'                => $args,
863            )
864        );
865    }
866
867    /**
868     * Apply the submitted module-backed settings, and report what was applied.
869     *
870     * @param WP_REST_Request $request The REST request.
871     * @return \WP_REST_Response|WP_Error
872     */
873    public static function update_modules( WP_REST_Request $request ) {
874        $applied = array();
875
876        foreach ( self::module_settings() as $field => $module ) {
877            if ( null === $request[ $field ] ) {
878                continue;
879            }
880
881            $enabled = (bool) $request[ $field ];
882
883            $error = self::apply_module_setting( $module, $enabled );
884            if ( is_wp_error( $error ) ) {
885                // No rollback across fields — module activation fires hooks that other
886                // code has already reacted to, and undoing those is riskier than the
887                // inconsistency. Report which field failed and what did land instead, so
888                // the client can be specific about it.
889                $error->add_data(
890                    array_merge(
891                        (array) $error->get_error_data(),
892                        array(
893                            'field'   => $field,
894                            'applied' => $applied,
895                        )
896                    )
897                );
898                return $error;
899            }
900
901            $applied[ $field ] = $enabled;
902        }
903
904        return rest_ensure_response( $applied );
905    }
906
907    /**
908     * Switch a module and report a failure instead of saving a duplicate option.
909     *
910     * Module state is the source of truth; there is no second option to write or roll
911     * back. Simple has no modules, so its canonical switch is {@see Canonical_Urls::OPTION}.
912     *
913     * @param string $module  Module slug.
914     * @param bool   $enabled Requested state.
915     * @return true|WP_Error
916     */
917    private static function apply_module_setting( $module, $enabled ) {
918        if ( 'canonical-urls' === $module && ( new Host() )->is_wpcom_simple() ) {
919            update_option( Canonical_Urls::OPTION, $enabled ? 1 : 0 );
920            return true;
921        }
922
923        if ( ! self::has_module( $module ) ) {
924            return new WP_Error(
925                'jetpack_seo_module_unavailable',
926                /* translators: %s: name of a Jetpack module, e.g. "sitemaps". */
927                sprintf( __( 'This site has no %s module to switch.', 'jetpack-seo' ), $module ),
928                array( 'status' => 400 )
929            );
930        }
931
932        if ( self::switch_module( $module, $enabled ) ) {
933            return true;
934        }
935
936        return new WP_Error(
937            'jetpack_seo_module_toggle_failed',
938            /* translators: %s: name of a Jetpack module, e.g. "sitemaps". */
939            sprintf( __( 'The %s module could not be switched.', 'jetpack-seo' ), $module ),
940            array( 'status' => 500 )
941        );
942    }
943
944    /**
945     * Build the aggregated Overview state the dashboard renders.
946     *
947     * @return array
948     */
949    public static function get_overview_data() {
950        $modules = new Modules();
951
952        $codes = get_option( 'verification_services_codes', array() );
953        if ( ! is_array( $codes ) ) {
954            $codes = array();
955        }
956
957        return array(
958            'site_visibility'         => array(
959                'search_engines_visible' => (int) get_option( 'blog_public', 1 ) === 1,
960                'site_is_private'        => self::is_site_private(),
961                'sitemap_active'         => $modules->is_active( 'sitemaps' ),
962                'seo_tools_active'       => $modules->is_active( 'seo-tools' ),
963            ),
964            // Per-service booleans (a code is set or not) for the Overview's
965            // Site verification card.
966            'site_verification'       => array(
967                'google'    => ! empty( $codes['google'] ),
968                'bing'      => ! empty( $codes['bing'] ),
969                'pinterest' => ! empty( $codes['pinterest'] ),
970                'yandex'    => ! empty( $codes['yandex'] ),
971                'facebook'  => ! empty( $codes['facebook'] ),
972            ),
973            'content_coverage'        => Content_Coverage::get(),
974            // Whether the site-verification toggle can do anything here. False where
975            // that module isn't present — WordPress.com Simple ships no Jetpack modules
976            // and reports every one of them active — so the dashboard hides the control
977            // rather than offering a toggle the route would refuse.
978            'verification_switchable' => self::has_module( 'verification-tools' ),
979        );
980    }
981
982    /**
983     * Coerce the stored title formats into one `{ type, value }` token list per page type.
984     *
985     * The site-settings API stores a cleared page type as `''` (see JETPACK-2284), so the
986     * option is looser than the Settings tab's type; anything not a token list becomes `array()`.
987     *
988     * @since 0.9.5
989     *
990     * @param mixed $stored Raw option value.
991     * @return array<string, array<int, array{type: string, value: string}>>
992     */
993    public static function normalize_title_formats( $stored ) {
994        if ( ! is_array( $stored ) ) {
995            return array();
996        }
997
998        $normalized = array();
999        foreach ( $stored as $page_type => $format ) {
1000            $tokens = array();
1001            if ( is_array( $format ) ) {
1002                foreach ( $format as $item ) {
1003                    if ( is_array( $item ) && isset( $item['type'] ) && isset( $item['value'] ) && is_string( $item['type'] ) && is_string( $item['value'] ) ) {
1004                        $tokens[] = array(
1005                            'type'  => $item['type'],
1006                            'value' => $item['value'],
1007                        );
1008                    }
1009                }
1010            }
1011            $normalized[ (string) $page_type ] = $tokens;
1012        }
1013
1014        return $normalized;
1015    }
1016
1017    /**
1018     * Build the editable Settings state the Settings tab hydrates from.
1019     *
1020     * Read-only bootstrap only. Writes go to core's `/wp/v2/settings` for every field
1021     * backed by an option alone ({@see self::register_rest_settings()}), and to the
1022     * package's own routes for the three settings whose write switches a Jetpack module
1023     * — sitemap, canonical URLs and site verification ({@see self::module_settings()})
1024     * — and for the nested Schema container; bootstrapping them all here keeps the
1025     * Settings UI hydrated without a second request.
1026     *
1027     * @return array
1028     */
1029    public static function get_settings_data() {
1030        $modules = new Modules();
1031
1032        // Read the stored values directly: Jetpack_SEO_Titles::get_custom_title_formats()
1033        // intentionally hides them while another SEO plugin controls output, but the
1034        // dashboard must still show the saved values without allowing edits.
1035        $title_formats          = self::normalize_title_formats( get_option( 'advanced_seo_title_formats', array() ) );
1036        $title_formats_editable = self::is_jetpack_seo_enabled();
1037        $front_page_desc        = self::get_front_page_meta_description();
1038
1039        if ( Seo_Tools::is_disabled() ) {
1040            // Same for the description, which the helper swaps for the legacy fallback while
1041            // another plugin owns the output. Show the one Jetpack resumes with; it's locked.
1042            $modern          = get_option( self::FRONT_PAGE_META_OPTION );
1043            $front_page_desc = $modern ? $modern : get_option( self::LEGACY_FRONT_PAGE_META_OPTION, '' );
1044        }
1045
1046        // Keep the description source consistent with the option selected for saves.
1047        $has_legacy_front_page_meta = self::has_legacy_front_page_meta();
1048
1049        $codes = get_option( 'verification_services_codes', array() );
1050        if ( ! is_array( $codes ) ) {
1051            $codes = array();
1052        }
1053
1054        $sitemap_active = $modules->is_active( 'sitemaps' );
1055        $simple         = ( new Host() )->is_wpcom_simple();
1056
1057        // Ask the conflict check, not the disable filter: anyone can hook that filter just to turn the tags off.
1058        // @phan-suppress-next-line PhanUndeclaredFunction -- guarded by function_exists; lives in plugins/jetpack.
1059        $canonical_conflicted = function_exists( 'jetpack_canonical_urls_check_conflicts' ) && jetpack_canonical_urls_check_conflicts( false );
1060
1061        return array(
1062            'search_engines_visible'     => (int) get_option( 'blog_public', 1 ) === 1,
1063            // A private or Coming Soon WordPress.com site isn't hidden from search by an
1064            // SEO setting and can't be unhidden by one — see {@see self::block_publishing_a_private_site()}.
1065            'site_is_private'            => self::is_site_private(),
1066            'site_is_coming_soon'        => self::is_site_coming_soon(),
1067            'site_visibility_url'        => Ai_Crawlers::privacy_settings_url(),
1068            'sitemap_active'             => $sitemap_active,
1069            'sitemap_switchable'         => self::has_module( 'sitemaps' ),
1070            // The reachable sitemap URL (Jetpack serves a valid sitemap here as soon as
1071            // it's on + the site is public), or '' when sitemaps are off, so the Settings
1072            // tab shows the "View sitemap" link exactly when there's a sitemap to view.
1073            'sitemap_url'                => self::get_reachable_sitemap_url( $sitemap_active ),
1074            // Simple reports every module active, so read its own switch ({@see Canonical_Urls}).
1075            'canonical_active'           => $simple ? Canonical_Urls::is_enabled() : $modules->is_active( 'canonical-urls' ),
1076            'canonical_switchable'       => $simple || self::has_module( 'canonical-urls' ),
1077            'canonical_conflicted'       => $canonical_conflicted,
1078            // Cast to object so an empty format set serializes as `{}`, not `[]`.
1079            'title_formats'              => (object) $title_formats,
1080            // Separator WordPress joins default document-title parts with. A page type
1081            // with no stored format keeps the default title: `get_custom_title()` returns
1082            // the incoming value untouched, so core composes the title itself and the
1083            // Settings tab replays that composition to preview it.
1084            'title_separator'            => self::get_default_title_separator(),
1085            'title_formats_editable'     => $title_formats_editable,
1086            'front_page_description'     => (string) $front_page_desc,
1087            'has_legacy_front_page_meta' => $has_legacy_front_page_meta,
1088            'verification_tools_active'  => $modules->is_active( 'verification-tools' ),
1089            'verification'               => array(
1090                'google'    => isset( $codes['google'] ) ? (string) $codes['google'] : '',
1091                'bing'      => isset( $codes['bing'] ) ? (string) $codes['bing'] : '',
1092                'pinterest' => isset( $codes['pinterest'] ) ? (string) $codes['pinterest'] : '',
1093                'yandex'    => isset( $codes['yandex'] ) ? (string) $codes['yandex'] : '',
1094                'facebook'  => isset( $codes['facebook'] ) ? (string) $codes['facebook'] : '',
1095            ),
1096            'schema'                     => Schema_Settings::get_editable(),
1097        );
1098    }
1099
1100    /**
1101     * Build the Google site-verification state for the Settings tab.
1102     *
1103     * The Settings verification card lets a connected user verify with Google via a
1104     * WordPress.com keyring OAuth popup (in addition to pasting a meta-tag code). This
1105     * bootstraps the keyring connect URL and whether the current user is connected —
1106     * the live verified status is fetched client-side from `/jetpack/v4/verify-site/google`
1107     * (a wpcom round-trip we don't want to make on every page load).
1108     *
1109     * Both `Keyring_Helper` (Publicize package) and the connection `Manager` are provided
1110     * by the host Jetpack plugin, so they're guarded with `class_exists` like the
1111     * `Jetpack_SEO_*` helpers. On a disconnected self-hosted site `is_connected` is false
1112     * and the UI falls back to manual code entry only.
1113     *
1114     * @return array
1115     */
1116    public static function get_google_verify_data() {
1117        $connect_url = '';
1118        if ( class_exists( 'Automattic\\Jetpack\\Publicize\\Keyring_Helper' ) ) {
1119            // @phan-suppress-next-line PhanUndeclaredClassMethod -- guarded; Publicize package is provided by the host plugin.
1120            $connect_url = (string) \Automattic\Jetpack\Publicize\Keyring_Helper::connect_url( 'google_site_verification', 'other' );
1121        }
1122
1123        $is_connected = false;
1124        if ( class_exists( 'Automattic\\Jetpack\\Connection\\Manager' ) ) {
1125            $is_connected = ( new \Automattic\Jetpack\Connection\Manager() )->is_user_connected();
1126        }
1127
1128        return array(
1129            'connect_url'  => $connect_url,
1130            'is_connected' => (bool) $is_connected,
1131        );
1132    }
1133
1134    /**
1135     * Build the GEO tab's initial state.
1136     *
1137     * The AI SEO Enhancer auto-generates SEO titles/descriptions/alt-text in the
1138     * editor (the generation itself is wpcom/AI-Assistant side); this exposes only
1139     * its persisted on/off toggle, whether it's available, and whether the AI SEO
1140     * control it sits under is on. Availability mirrors the legacy Traffic page:
1141     * the `ai_seo_enhancer_enabled` feature filter must be on (it still depends on
1142     * AI being available) AND the site's plan must support the `ai-seo-enhancer`
1143     * feature. The toggle writes the `ai_seo_enhancer_enabled` option through core's
1144     * `/wp/v2/settings` endpoint.
1145     *
1146     * `aiSeoEnabled` is reported separately rather than folded into availability:
1147     * with the control off the card is disabled, not hidden, so the saved choice
1148     * stays visible — the same treatment the Traffic page gives it. `aiEnabled`
1149     * reports the site-wide Jetpack AI switch so the tab can name which one is off.
1150     *
1151     * @return array
1152     */
1153    public static function get_geo_data() {
1154        $filter_on = (bool) apply_filters( 'ai_seo_enhancer_enabled', true );
1155
1156        // Jetpack_AI_Settings lives in plugins/jetpack, which bundles this package; guarded
1157        // like the other host-plugin classes here. Without the method the AI SEO control
1158        // does not exist, so the enhancer keeps its pre-control behavior.
1159        // @phan-suppress-next-line PhanUndeclaredClassMethod -- Jetpack_AI_Settings lives in plugins/jetpack and is guarded by is_callable.
1160        $ai_seo_on = ! is_callable( array( 'Jetpack_AI_Settings', 'is_ai_seo_enabled' ) ) || \Jetpack_AI_Settings::is_ai_seo_enabled();
1161        // @phan-suppress-next-line PhanUndeclaredClassMethod -- Jetpack_AI_Settings lives in plugins/jetpack and is guarded by is_callable.
1162        $ai_on = ! is_callable( array( 'Jetpack_AI_Settings', 'is_ai_enabled' ) ) || \Jetpack_AI_Settings::is_ai_enabled();
1163
1164        // Current_Plan comes from the jetpack-plans package (a dependency of this
1165        // package since the plan-gating work), so it's always available here; the
1166        // class_exists guard is kept as belt-and-suspenders for older bundled snapshots.
1167        $plan_supports = class_exists( 'Automattic\\Jetpack\\Current_Plan' )
1168            && \Automattic\Jetpack\Current_Plan::supports( 'ai-seo-enhancer' );
1169
1170        return array(
1171            'enhancer' => array(
1172                'available'    => $filter_on && $plan_supports,
1173                'enabled'      => (bool) get_option( 'ai_seo_enhancer_enabled', false ),
1174                'aiSeoEnabled' => $ai_seo_on,
1175                'aiEnabled'    => $ai_on,
1176            ),
1177            'llmsTxt'  => array(
1178                'enabled'  => Llms_Txt::is_enabled(),
1179                'url'      => home_url( '/llms.txt' ),
1180                'canServe' => Llms_Txt::can_serve(),
1181            ),
1182            'crawlers' => Ai_Crawlers::get_bootstrap_data(),
1183        );
1184    }
1185
1186    /**
1187     * Build the supported post type options for the Content tab.
1188     *
1189     * @return array{post_types:array<int,array{slug:string,label:string}>}
1190     */
1191    public static function get_content_data() {
1192        return array(
1193            'post_types' => Post_Types::get_supported_content_type_options(),
1194        );
1195    }
1196
1197    /**
1198     * Whether Jetpack's SEO output is paused, and the plugin that owns it when one does.
1199     * Every tab reads this one bootstrap for its banner and locked cards.
1200     *
1201     * @since 0.11.0
1202     *
1203     * @return array{paused: bool, conflicting_plugin: string}
1204     */
1205    public static function get_output_data() {
1206        return array(
1207            'paused'             => Seo_Tools::is_disabled(),
1208            'conflicting_plugin' => Seo_Tools::get_conflicting_plugin() ?? '',
1209        );
1210    }
1211
1212    /**
1213     * Site identity used to render the homepage search/social previews on the
1214     * Settings tab: title, tagline, URL, and representative images. The front-page
1215     * description that completes the preview is read from the Settings form
1216     * (it's editable there), not bootstrapped here.
1217     *
1218     * @return array
1219     */
1220    public static function get_site_data() {
1221        $icon_url = (string) get_site_icon_url();
1222
1223        $logo_id  = (int) get_theme_mod( 'custom_logo' );
1224        $logo_url = $logo_id ? (string) wp_get_attachment_image_url( $logo_id, 'full' ) : '';
1225        if ( class_exists( 'Jetpack_Redux_State_Helper' ) ) {
1226            // @phan-suppress-next-line PhanUndeclaredClassMethod -- Jetpack_Redux_State_Helper lives in plugins/jetpack and is guarded by class_exists.
1227            $image_url = (string) \Jetpack_Redux_State_Helper::get_site_image();
1228        } else {
1229            $image_url = $logo_url ? $logo_url : $icon_url;
1230        }
1231
1232        return array(
1233            'title'   => (string) get_bloginfo( 'name' ),
1234            'tagline' => (string) get_bloginfo( 'description' ),
1235            'url'     => (string) home_url(),
1236            'icon'    => $icon_url,
1237            'image'   => $image_url,
1238        );
1239    }
1240
1241    /**
1242     * The separator, as rendered, that WordPress joins default document-title parts
1243     * with — for previewing the title a page type with no stored format produces.
1244     *
1245     * `document_title_separator` alone is not what a visitor sees. `wp_get_document_title()`
1246     * composes the parts, then passes the whole title through the `document_title`
1247     * filter, which WordPress texturizes by default — turning the default spaced
1248     * hyphen into an en dash. Previewing the raw filter value would show `-` on a site
1249     * that renders `–`, which is every site running core's defaults.
1250     *
1251     * This applies only to the default title. A stored format short-circuits
1252     * `pre_get_document_title`, which returns before the `document_title` filter, so a
1253     * custom format keeps the separator the user typed verbatim — the front end renders
1254     * `Site - MARKER - Page` for a custom format while producing `Page – Site` for the
1255     * default one.
1256     *
1257     * @return string The rendered separator.
1258     */
1259    private static function get_default_title_separator() {
1260        $separator = (string) apply_filters( 'document_title_separator', '-' );
1261
1262        // Only texturize when the title itself would be: a site that unhooks
1263        // `wptexturize` renders the raw separator, and the preview should match.
1264        if ( has_filter( 'document_title', 'wptexturize' ) ) {
1265            $separator = trim(
1266                html_entity_decode( wptexturize( ' ' . $separator . ' ' ), ENT_QUOTES, 'UTF-8' )
1267            );
1268        }
1269
1270        return $separator;
1271    }
1272
1273    /**
1274     * The public URL of the XML sitemap, or an empty string when none is reachable.
1275     *
1276     * A sitemap is reachable as soon as generation is enabled and the site is public:
1277     * Jetpack serves a valid (empty-until-built) sitemap at a stable URL — never a 404 —
1278     * so the link is safe to surface immediately, without waiting on (or gating against)
1279     * the cron build. A prior gate looked the master sitemap up by a mis-built filename
1280     * and so never matched, which is what left the Settings tab stuck on "Generating…".
1281     *
1282     * `jetpack_sitemap_uri()` / `jp_sitemap_filename()` and the JP_MASTER_SITEMAP_TYPE
1283     * constant live in the Jetpack plugin's Sitemaps module (loaded only for an active
1284     * module on a public site), so they are guarded; in the package-only context they
1285     * are absent and the sitemap is reported as not reachable.
1286     *
1287     * @param bool $sitemap_active Whether sitemap generation is enabled.
1288     * @return string The sitemap URL, or '' when not reachable.
1289     */
1290    private static function get_reachable_sitemap_url( $sitemap_active ) {
1291        // Jetpack only serves sitemaps when generation is on and the site is public.
1292        if ( ! $sitemap_active || (int) get_option( 'blog_public', 1 ) !== 1 ) {
1293            return '';
1294        }
1295
1296        // The `JP_MASTER_SITEMAP_TYPE` constant and the `jp_sitemap_filename()` /
1297        // `jetpack_sitemap_uri()` helpers all live together in plugins/jetpack and load
1298        // as a unit, so this single guard covers every symbol used below.
1299        if (
1300            ! defined( 'JP_MASTER_SITEMAP_TYPE' )
1301            || ! function_exists( 'jp_sitemap_filename' )
1302            || ! function_exists( 'jetpack_sitemap_uri' )
1303        ) {
1304            return '';
1305        }
1306
1307        // `jp_sitemap_filename()` returns an error string ("error-not-int-…") unless a
1308        // non-null number is passed; the master ignores the number, so pass 0 (matching
1309        // Jetpack's own call sites). Fail safe: the master file is always 'sitemap.xml',
1310        // so if a bundled Jetpack ever returns something else, report not-reachable
1311        // rather than surface a broken URL — the exact failure this method shipped with
1312        // before (the missing number silently produced an "error-not-int-…" link).
1313        // @phan-suppress-next-line PhanUndeclaredFunction -- guarded above; symbols live in plugins/jetpack.
1314        $filename = (string) jp_sitemap_filename( JP_MASTER_SITEMAP_TYPE, 0 );
1315        if ( 'sitemap.xml' !== $filename ) {
1316            return '';
1317        }
1318
1319        // esc_url_raw (not esc_url): transported via script data and rendered by React,
1320        // so it must not be HTML-entity-encoded (e.g. the plain-permalink
1321        // `?jetpack-sitemap=` form keeps its raw `&`).
1322        // @phan-suppress-next-line PhanUndeclaredFunction -- guarded above; symbols live in plugins/jetpack.
1323        return esc_url_raw( (string) jetpack_sitemap_uri( $filename ) );
1324    }
1325}