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