<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Class 'WP_Speculation_Rules'.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Speculative Loading

[5] Fix | Delete

* @since 6.8.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class representing a set of speculation rules.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 6.8.0

[12] Fix | Delete

* @access private

[13] Fix | Delete

*/

[14] Fix | Delete

final class WP_Speculation_Rules implements JsonSerializable {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Stored rules, as a map of `$mode => $rules` pairs.

[18] Fix | Delete

*

[19] Fix | Delete

* Every `$rules` value is a map of `$id => $rule` pairs.

[20] Fix | Delete

*

[21] Fix | Delete

* @since 6.8.0

[22] Fix | Delete

* @var array<string, array<string, mixed>>

[23] Fix | Delete

*/

[24] Fix | Delete

private $rules_by_mode = array();

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* The allowed speculation rules modes as a map, used for validation.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 6.8.0

[30] Fix | Delete

* @var array<string, bool>

[31] Fix | Delete

*/

[32] Fix | Delete

private static $mode_allowlist = array(

[33] Fix | Delete

'prefetch' => true,

[34] Fix | Delete

'prerender' => true,

[35] Fix | Delete

);

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* The allowed speculation rules eagerness levels as a map, used for validation.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 6.8.0

[41] Fix | Delete

* @var array<string, bool>

[42] Fix | Delete

*/

[43] Fix | Delete

private static $eagerness_allowlist = array(

[44] Fix | Delete

'immediate' => true,

[45] Fix | Delete

'eager' => true,

[46] Fix | Delete

'moderate' => true,

[47] Fix | Delete

'conservative' => true,

[48] Fix | Delete

);

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* The allowed speculation rules sources as a map, used for validation.

[52] Fix | Delete

*

[53] Fix | Delete

* @since 6.8.0

[54] Fix | Delete

* @var array<string, bool>

[55] Fix | Delete

*/

[56] Fix | Delete

private static $source_allowlist = array(

[57] Fix | Delete

'list' => true,

[58] Fix | Delete

'document' => true,

[59] Fix | Delete

);

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Adds a speculation rule to the speculation rules to consider.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 6.8.0

[65] Fix | Delete

*

[66] Fix | Delete

* @param string $mode Speculative loading mode. Either 'prefetch' or 'prerender'.

[67] Fix | Delete

* @param string $id Unique string identifier for the speculation rule.

[68] Fix | Delete

* @param array<string, mixed> $rule Associative array of rule arguments.

[69] Fix | Delete

* @return bool True on success, false if invalid parameters are provided.

[70] Fix | Delete

*/

[71] Fix | Delete

public function add_rule( string $mode, string $id, array $rule ): bool {

[72] Fix | Delete

if ( ! self::is_valid_mode( $mode ) ) {

[73] Fix | Delete

_doing_it_wrong(

[74] Fix | Delete

__METHOD__,

[75] Fix | Delete

sprintf(

[76] Fix | Delete

/* translators: %s: invalid mode value */

[77] Fix | Delete

__( 'The value "%s" is not a valid speculation rules mode.' ),

[78] Fix | Delete

esc_html( $mode )

[79] Fix | Delete

),

[80] Fix | Delete

'6.8.0'

[81] Fix | Delete

);

[82] Fix | Delete

return false;

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

if ( ! $this->is_valid_id( $id ) ) {

[86] Fix | Delete

_doing_it_wrong(

[87] Fix | Delete

__METHOD__,

[88] Fix | Delete

sprintf(

[89] Fix | Delete

/* translators: %s: invalid ID value */

[90] Fix | Delete

__( 'The value "%s" is not a valid ID for a speculation rule.' ),

[91] Fix | Delete

esc_html( $id )

[92] Fix | Delete

),

[93] Fix | Delete

'6.8.0'

[94] Fix | Delete

);

[95] Fix | Delete

return false;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

if ( $this->has_rule( $mode, $id ) ) {

[99] Fix | Delete

_doing_it_wrong(

[100] Fix | Delete

__METHOD__,

[101] Fix | Delete

sprintf(

[102] Fix | Delete

/* translators: %s: invalid ID value */

[103] Fix | Delete

__( 'A speculation rule with ID "%s" already exists.' ),

[104] Fix | Delete

esc_html( $id )

[105] Fix | Delete

),

[106] Fix | Delete

'6.8.0'

[107] Fix | Delete

);

[108] Fix | Delete

return false;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/*

[112] Fix | Delete

* Perform some basic speculation rule validation.

[113] Fix | Delete

* Every rule must have either a 'where' key or a 'urls' key, but not both.

[114] Fix | Delete

* The presence of a 'where' key implies a 'source' of 'document', while the presence of a 'urls' key implies

[115] Fix | Delete

* a 'source' of 'list'.

[116] Fix | Delete

*/

[117] Fix | Delete

if (

[118] Fix | Delete

( ! isset( $rule['where'] ) && ! isset( $rule['urls'] ) ) ||

[119] Fix | Delete

( isset( $rule['where'] ) && isset( $rule['urls'] ) )

[120] Fix | Delete

) {

[121] Fix | Delete

_doing_it_wrong(

[122] Fix | Delete

__METHOD__,

[123] Fix | Delete

sprintf(

[124] Fix | Delete

/* translators: 1: allowed key, 2: alternative allowed key */

[125] Fix | Delete

__( 'A speculation rule must include either a "%1$s" key or a "%2$s" key, but not both.' ),

[126] Fix | Delete

'where',

[127] Fix | Delete

'urls'

[128] Fix | Delete

),

[129] Fix | Delete

'6.8.0'

[130] Fix | Delete

);

[131] Fix | Delete

return false;

[132] Fix | Delete

}

[133] Fix | Delete

if ( isset( $rule['source'] ) ) {

[134] Fix | Delete

if ( ! self::is_valid_source( $rule['source'] ) ) {

[135] Fix | Delete

_doing_it_wrong(

[136] Fix | Delete

__METHOD__,

[137] Fix | Delete

sprintf(

[138] Fix | Delete

/* translators: %s: invalid source value */

[139] Fix | Delete

__( 'The value "%s" is not a valid source for a speculation rule.' ),

[140] Fix | Delete

esc_html( $rule['source'] )

[141] Fix | Delete

),

[142] Fix | Delete

'6.8.0'

[143] Fix | Delete

);

[144] Fix | Delete

return false;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

if ( 'list' === $rule['source'] && isset( $rule['where'] ) ) {

[148] Fix | Delete

_doing_it_wrong(

[149] Fix | Delete

__METHOD__,

[150] Fix | Delete

sprintf(

[151] Fix | Delete

/* translators: 1: source value, 2: forbidden key */

[152] Fix | Delete

__( 'A speculation rule of source "%1$s" must not include a "%2$s" key.' ),

[153] Fix | Delete

'list',

[154] Fix | Delete

'where'

[155] Fix | Delete

),

[156] Fix | Delete

'6.8.0'

[157] Fix | Delete

);

[158] Fix | Delete

return false;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

if ( 'document' === $rule['source'] && isset( $rule['urls'] ) ) {

[162] Fix | Delete

_doing_it_wrong(

[163] Fix | Delete

__METHOD__,

[164] Fix | Delete

sprintf(

[165] Fix | Delete

/* translators: 1: source value, 2: forbidden key */

[166] Fix | Delete

__( 'A speculation rule of source "%1$s" must not include a "%2$s" key.' ),

[167] Fix | Delete

'document',

[168] Fix | Delete

'urls'

[169] Fix | Delete

),

[170] Fix | Delete

'6.8.0'

[171] Fix | Delete

);

[172] Fix | Delete

return false;

[173] Fix | Delete

}

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

// If there is an 'eagerness' key specified, make sure it's valid.

[177] Fix | Delete

if ( isset( $rule['eagerness'] ) ) {

[178] Fix | Delete

if ( ! self::is_valid_eagerness( $rule['eagerness'] ) ) {

[179] Fix | Delete

_doing_it_wrong(

[180] Fix | Delete

__METHOD__,

[181] Fix | Delete

sprintf(

[182] Fix | Delete

/* translators: %s: invalid eagerness value */

[183] Fix | Delete

__( 'The value "%s" is not a valid eagerness for a speculation rule.' ),

[184] Fix | Delete

esc_html( $rule['eagerness'] )

[185] Fix | Delete

),

[186] Fix | Delete

'6.8.0'

[187] Fix | Delete

);

[188] Fix | Delete

return false;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

if ( isset( $rule['where'] ) && 'immediate' === $rule['eagerness'] ) {

[192] Fix | Delete

_doing_it_wrong(

[193] Fix | Delete

__METHOD__,

[194] Fix | Delete

sprintf(

[195] Fix | Delete

/* translators: %s: forbidden eagerness value */

[196] Fix | Delete

__( 'The eagerness value "%s" is forbidden for document-level speculation rules.' ),

[197] Fix | Delete

'immediate'

[198] Fix | Delete

),

[199] Fix | Delete

'6.8.0'

[200] Fix | Delete

);

[201] Fix | Delete

return false;

[202] Fix | Delete

}

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

if ( ! isset( $this->rules_by_mode[ $mode ] ) ) {

[206] Fix | Delete

$this->rules_by_mode[ $mode ] = array();

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

$this->rules_by_mode[ $mode ][ $id ] = $rule;

[210] Fix | Delete

return true;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Checks whether a speculation rule for the given mode and ID already exists.

[215] Fix | Delete

*

[216] Fix | Delete

* @since 6.8.0

[217] Fix | Delete

*

[218] Fix | Delete

* @param string $mode Speculative loading mode. Either 'prefetch' or 'prerender'.

[219] Fix | Delete

* @param string $id Unique string identifier for the speculation rule.

[220] Fix | Delete

* @return bool True if the rule already exists, false otherwise.

[221] Fix | Delete

*/

[222] Fix | Delete

public function has_rule( string $mode, string $id ): bool {

[223] Fix | Delete

return isset( $this->rules_by_mode[ $mode ][ $id ] );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Returns the speculation rules data ready to be JSON-encoded.

[228] Fix | Delete

*

[229] Fix | Delete

* @since 6.8.0

[230] Fix | Delete

*

[231] Fix | Delete

* @return array<string, array<string, mixed>> Speculation rules data.

[232] Fix | Delete

*/

[233] Fix | Delete

#[ReturnTypeWillChange]

[234] Fix | Delete

public function jsonSerialize() {

[235] Fix | Delete

// Strip the IDs for JSON output, since they are not relevant for the Speculation Rules API.

[236] Fix | Delete

return array_map(

[237] Fix | Delete

static function ( array $rules ) {

[238] Fix | Delete

return array_values( $rules );

[239] Fix | Delete

},

[240] Fix | Delete

array_filter( $this->rules_by_mode )

[241] Fix | Delete

);

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Checks whether the given ID is valid.

[246] Fix | Delete

*

[247] Fix | Delete

* @since 6.8.0

[248] Fix | Delete

*

[249] Fix | Delete

* @param string $id Unique string identifier for the speculation rule.

[250] Fix | Delete

* @return bool True if the ID is valid, false otherwise.

[251] Fix | Delete

*/

[252] Fix | Delete

private function is_valid_id( string $id ): bool {

[253] Fix | Delete

return (bool) preg_match( '/^[a-z][a-z0-9_-]+$/', $id );

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

/**

[257] Fix | Delete

* Checks whether the given speculation rules mode is valid.

[258] Fix | Delete

*

[259] Fix | Delete

* @since 6.8.0

[260] Fix | Delete

*

[261] Fix | Delete

* @param string $mode Speculation rules mode.

[262] Fix | Delete

* @return bool True if valid, false otherwise.

[263] Fix | Delete

*/

[264] Fix | Delete

public static function is_valid_mode( string $mode ): bool {

[265] Fix | Delete

return isset( self::$mode_allowlist[ $mode ] );

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Checks whether the given speculation rules eagerness is valid.

[270] Fix | Delete

*

[271] Fix | Delete

* @since 6.8.0

[272] Fix | Delete

*

[273] Fix | Delete

* @param string $eagerness Speculation rules eagerness.

[274] Fix | Delete

* @return bool True if valid, false otherwise.

[275] Fix | Delete

*/

[276] Fix | Delete

public static function is_valid_eagerness( string $eagerness ): bool {

[277] Fix | Delete

return isset( self::$eagerness_allowlist[ $eagerness ] );

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Checks whether the given speculation rules source is valid.

[282] Fix | Delete

*

[283] Fix | Delete

* @since 6.8.0

[284] Fix | Delete

*

[285] Fix | Delete

* @param string $source Speculation rules source.

[286] Fix | Delete

* @return bool True if valid, false otherwise.

[287] Fix | Delete

*/

[288] Fix | Delete

public static function is_valid_source( string $source ): bool {

[289] Fix | Delete

return isset( self::$source_allowlist[ $source ] );

[290] Fix | Delete

}

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete