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