| @@ -107,9 +107,48 @@ | ||
| 107 | 107 | 'usqp', |
| 108 | 108 | '~utm_[a-zA-Z0-9_-]+', |
| 109 | 109 | ); |
| 110 | 110 | |
| 111 | + /** | |
| 112 | + * Click and campaign IDs added to the defaults in 1.3.6. | |
| 113 | + * | |
| 114 | + * Each is unique per click and never changes the page, yet each one | |
| 115 | + * bypassed the page cache and, with xSpeed Pro, was a new CSS entry to | |
| 116 | + * build: Google Merchant's `srsltid` and Ads' `gad_*`/`gbraid`/`wbraid`, | |
| 117 | + * GA4's cross-domain `_gl`, TikTok, X, Instagram, Yandex, HubSpot email | |
| 118 | + * and LinkedIn IDs. Kept as their own list so the upgrade can add exactly | |
| 119 | + * these to a saved list without re-adding anything a site removed. | |
| 120 | + * | |
| 121 | + * @var string[] | |
| 122 | + */ | |
| 123 | + public const TRACKING_PARAMS_1_3_6 = array( | |
| 124 | + '_gl', | |
| 125 | + '_hsenc', | |
| 126 | + '_hsmi', | |
| 127 | + 'gad_campaignid', | |
| 128 | + 'gad_source', | |
| 129 | + 'gbraid', | |
| 130 | + 'igshid', | |
| 131 | + 'li_fat_id', | |
| 132 | + 'srsltid', | |
| 133 | + 'ttclid', | |
| 134 | + 'twclid', | |
| 135 | + 'wbraid', | |
| 136 | + 'yclid', | |
| 137 | + ); | |
| 111 | 138 | |
| 139 | + | |
| 140 | + /** | |
| 141 | + * The shipped default list: the base list plus later additions, sorted. | |
| 142 | + * | |
| 143 | + * @return string[] | |
| 144 | + */ | |
| 145 | + public static function default_ignored_query_params(): array { | |
| 146 | + $all = array_values( array_unique( array_merge( self::DEFAULT_IGNORED_QUERY_PARAMS, self::TRACKING_PARAMS_1_3_6 ) ) ); | |
| 147 | + sort( $all ); | |
| 148 | + return $all; | |
| 149 | + } | |
| 150 | + | |
| 112 | 151 | public const SLUG = 'cache'; |
| 113 | 152 | public const TIER = self::TIER_FREE; |
| 114 | 153 | public const VERSION = '1.0.0'; |
| 115 | 154 | |
| @@ -128,9 +167,10 @@ | ||
| 128 | 167 | public function ui_metadata(): array { |
| 129 | 168 | return array( |
| 130 | 169 | 'label' => __( 'Page Cache', 'xspeed' ), |
| 131 | 170 | 'icon' => 'Database', |
| 132 | - 'description' => __( 'Page caching for non-logged-in visitors.', 'xspeed' ), | |
| 171 | + 'description' => __( 'Saves each page as a file and serves it to logged-out visitors.', 'xspeed' ), | |
| 172 | + 'group' => 'cache', | |
| 133 | 173 | ); |
| 134 | 174 | } |
| 135 | 175 | |
| 136 | 176 | /** |
| @@ -145,9 +185,9 @@ | ||
| 145 | 185 | return array(); |
| 146 | 186 | } |
| 147 | 187 | |
| 148 | 188 | public function settings_schema(): array { |
| 149 | - return array( | |
| 189 | + $schema = array( | |
| 150 | 190 | 'cache_expiry' => array( |
| 151 | 191 | 'type' => 'int', |
| 152 | 192 | // Matches the wizard's Balanced preset, which is what a fresh |
| 153 | 193 | // install starts on — a shorter module default meant the two |
| @@ -154,11 +194,11 @@ | ||
| 154 | 194 | // disagreed about what "default" means. (#284) |
| 155 | 195 | 'default' => self::DEFAULT_EXPIRY_HOURS, |
| 156 | 196 | 'min' => 1, |
| 157 | 197 | 'max' => 720, |
| 158 | - 'label' => __( 'Cache Expiry (hours)', 'xspeed' ), | |
| 198 | + 'label' => __( 'Cache expiry (hours)', 'xspeed' ), | |
| 159 | 199 | 'unit' => 'hours', |
| 160 | - 'description' => __( 'How long cached pages live before regenerating. 1 to 720 hours (30 days).', 'xspeed' ), | |
| 200 | + 'description' => __( 'How long a cached page is kept before xSpeed builds it again. 1 to 720 hours (30 days).', 'xspeed' ), | |
| 161 | 201 | ), |
| 162 | 202 | 'excluded_urls' => array( |
| 163 | 203 | 'type' => 'list', |
| 164 | 204 | // Comprehensive LiteSpeed / WP Rocket-parity default URL |
| @@ -170,9 +210,11 @@ | ||
| 170 | 210 | '/xmlrpc.php', |
| 171 | 211 | '~wp-.*\.php', |
| 172 | 212 | '/feed/', |
| 173 | 213 | 'index.php', |
| 174 | - '~sitemap(_index)?\.xml', | |
| 214 | + // `sitemaps?` — SEOPress generates sitemaps.xml (plural). | |
| 215 | + '~sitemaps?(_index)?\.xml', | |
| 216 | + '/robots.txt', | |
| 175 | 217 | // Bare (no trailing slash) so "contains" matches both |
| 176 | 218 | // /cart and /cart/items — WooCommerce serves both forms. |
| 177 | 219 | '/cart', |
| 178 | 220 | '/checkout', |
| @@ -183,11 +225,12 @@ | ||
| 183 | 225 | '/wc-api', |
| 184 | 226 | '/edd-api', |
| 185 | 227 | '/wp-login', |
| 186 | 228 | ), |
| 187 | - 'item_type' => 'string', | |
| 229 | + // `path`: kept as typed, percent-encoded slugs included. | |
| 230 | + 'item_type' => 'path', | |
| 188 | 231 | 'label' => __( 'Excluded URLs', 'xspeed' ), |
| 189 | - 'description' => __( 'One pattern per line. Plain text matches anywhere in the URL (e.g. /cart). Use glob for anchored matches (/cart/* matches /cart/items but not /foo/cart/bar; *.pdf matches PDFs). Prefix with ~ for a raw regex (e.g. ~wp-.*\.php).', 'xspeed' ), | |
| 232 | + 'description' => __( 'Pages whose URL matches a line here are never cached. Plain text matches anywhere (/cart). A pattern with * matches from the start of the path: /cart/* matches /cart/items but not /shop/cart/items. ~ starts a regex.', 'xspeed' ), | |
| 190 | 233 | ), |
| 191 | 234 | 'excluded_cookies' => array( |
| 192 | 235 | 'type' => 'list', |
| 193 | 236 | // Cookies that signal a logged-in / transactional visitor |
| @@ -194,17 +237,17 @@ | ||
| 194 | 237 | // whose response must not be served from a shared cache. |
| 195 | 238 | // `~` prefix = raw regex (e.g. ~wordpress_[a-f0-9]+). (FBS-82181) |
| 196 | 239 | 'default' => self::DEFAULT_EXCLUDED_COOKIES, |
| 197 | 240 | 'item_type' => 'string', |
| 198 | - 'label' => __( 'Excluded Cookies', 'xspeed' ), | |
| 199 | - 'description' => __( 'Skip cache for any visitor whose request carries a cookie whose NAME matches one of these patterns. Plain text = "contains"; glob (woocommerce_*) and ~regex (~wordpress_[a-f0-9]+) supported. One per line.', 'xspeed' ), | |
| 241 | + 'label' => __( 'Excluded cookies', 'xspeed' ), | |
| 242 | + 'description' => __( 'Visitors with a cookie whose name matches a line here always get a fresh page. One per line; * and ~regex work.', 'xspeed' ), | |
| 200 | 243 | ), |
| 201 | 244 | 'bypass_user_agents' => array( |
| 202 | 245 | 'type' => 'list', |
| 203 | 246 | 'default' => array(), |
| 204 | 247 | 'item_type' => 'string', |
| 205 | - 'label' => __( 'Bypass User Agents', 'xspeed' ), | |
| 206 | - 'description' => __( 'Substring match against the visitor User-Agent. Matched UAs bypass cache (useful for screenshot bots, internal previews, monitoring). Glob + ~regex supported. One per line.', 'xspeed' ), | |
| 248 | + 'label' => __( 'Excluded browsers and bots', 'xspeed' ), | |
| 249 | + 'description' => __( 'Visitors whose user agent contains a line here always get a fresh page. Useful for screenshot bots and uptime monitors.', 'xspeed' ), | |
| 207 | 250 | ), |
| 208 | 251 | 'ignored_query_params' => array( |
| 209 | 252 | 'type' => 'list', |
| 210 | 253 | // Analytics / ad / session query keys stripped before the |
| @@ -211,26 +254,102 @@ | ||
| 211 | 254 | // cache key is computed, so /post?utm_source=x and /post |
| 212 | 255 | // share one entry. `~` prefix = raw regex. (FBS-82181) |
| 213 | 256 | // Matched whole-name, so every entry here means the param |
| 214 | 257 | // it names and nothing that merely contains it. |
| 215 | - 'default' => self::DEFAULT_IGNORED_QUERY_PARAMS, | |
| 258 | + 'default' => self::default_ignored_query_params(), | |
| 216 | 259 | 'item_type' => 'string', |
| 217 | - 'label' => __( 'Ignored Query Parameters', 'xspeed' ), | |
| 218 | - 'description' => __( 'Query keys removed from the URL before computing the cache key, so /post?utm_source=x and /post share a cache entry. Defaults cover the common analytics + ad + session params. Each entry matches a whole param name — plain text is an exact name, and glob (utm_*) or ~regex are anchored too, so "ref" does not also match "preference". One per line.', 'xspeed' ), | |
| 260 | + 'label' => __( 'Ignored query parameters', 'xspeed' ), | |
| 261 | + 'advanced' => true, | |
| 262 | + 'description' => __( 'URL parameters to ignore, so /post?utm_source=x gets the same cached page as /post. Each line matches a whole parameter name.', 'xspeed' ), | |
| 219 | 263 | ), |
| 220 | 264 | 'purge_on_upgrade' => array( |
| 221 | 265 | 'type' => 'bool', |
| 222 | 266 | 'default' => true, |
| 223 | - 'label' => __( 'Purge After Updates', 'xspeed' ), | |
| 224 | - 'description' => __( 'Clear the page cache when a plugin, theme or WordPress core is updated. Cached HTML is produced by the code being replaced, so leaving it in place serves pre-update markup — and links to minified assets that no longer exist — until the cache expires. Translation updates are ignored, since a language pack changes no markup a cached page depends on. Updates to xSpeed itself always purge, regardless of this setting.', 'xspeed' ), | |
| 267 | + 'label' => __( 'Clear cache after updates', 'xspeed' ), | |
| 268 | + 'description' => __( 'Clear the page cache when a plugin, theme or WordPress is updated, so visitors never get old pages with broken asset links.', 'xspeed' ), | |
| 225 | 269 | ), |
| 270 | + 'purge_affected_only' => array( | |
| 271 | + 'type' => 'bool', | |
| 272 | + 'default' => true, | |
| 273 | + 'label' => __( 'Clear only the pages a change affects', 'xspeed' ), | |
| 274 | + 'description' => __( 'When you publish, edit or delete a post, clear that post, the pages that list it and its feeds instead of the whole site. Pages with a post grid from a page builder, a block plugin or the theme are noted as they are built and cleared when the change can affect their list; turn this off if a grid still shows an old list.', 'xspeed' ), | |
| 275 | + 'info_title' => __( 'Which pages are cleared', 'xspeed' ), | |
| 276 | + 'info' => __( 'The post, its old address if it moved, the home page, the blog page, its categories, tags and author pages with every page of each, the date archives, feeds, the posts next to it, pages that show a Latest Posts or Query Loop block, directly or in a synced pattern, and pages noted running a post grid of their own (a page builder, block plugin, related-posts or theme list) that the change can affect. If your theme shows a list that can be on any page, and the change alters it, xSpeed clears the whole site instead: a Recent Posts, Archives or Calendar widget, a post list block, or a latest-posts grid from a page builder or plugin (usually a new post, or an edit to one of the newest few it shows), a page list or menu (a page published, withdrawn, renamed or moved), or a Categories or Tag Cloud list (a post moved to other categories or tags).', 'xspeed' ), | |
| 277 | + ), | |
| 226 | 278 | 'mobile_separate' => array( |
| 227 | 279 | 'type' => 'bool', |
| 228 | 280 | 'default' => false, |
| 229 | - 'label' => __( 'Separate Mobile Cache', 'xspeed' ), | |
| 230 | - 'description' => __( 'Keep mobile and desktop responses in separate cache buckets. Turn on for AMP, mobile-specific themes (WPtouch / Jetpack mobile theme), or any setup that serves different HTML by device.', 'xspeed' ), | |
| 281 | + 'label' => __( 'Separate mobile cache', 'xspeed' ), | |
| 282 | + 'description' => __( 'Keep a separate cached copy for phones. Turn on only if your theme or plugins show different pages on mobile.', 'xspeed' ), | |
| 231 | 283 | ), |
| 284 | + 'edge_provider' => array( | |
| 285 | + 'type' => 'enum', | |
| 286 | + 'default' => 'auto', | |
| 287 | + 'options' => array( 'auto', 'off', 'cloudflare', 'fastly', 'varnish', 'nginx', 'akamai', 'cloudfront', 'google', 'keycdn', 'bunny', 'sucuri', 'incapsula', 'generic', 'custom' ), | |
| 288 | + 'option_labels' => array( | |
| 289 | + 'auto' => 'Detect automatically', | |
| 290 | + 'off' => 'Off (no edge lifetime or cache tags)', | |
| 291 | + 'cloudflare' => 'Cloudflare', | |
| 292 | + 'varnish' => 'Varnish', | |
| 293 | + 'nginx' => 'nginx proxy cache', | |
| 294 | + 'cloudfront' => 'Amazon CloudFront', | |
| 295 | + 'google' => 'Google Cloud CDN', | |
| 296 | + 'keycdn' => 'KeyCDN', | |
| 297 | + 'bunny' => 'Bunny', | |
| 298 | + // These four cannot be presented as supported on the same | |
| 299 | + // footing as the ones above. Vendor documentation either | |
| 300 | + // does not establish that they honour what we send, or | |
| 301 | + // establishes that they ignore origin cache headers until | |
| 302 | + // the property is configured to respect them — Akamai | |
| 303 | + // caches for a theoretically infinite time by default, and | |
| 304 | + // Sucuri's default caching level ignores the headers | |
| 305 | + // outright. Naming them without the caveat would promise a | |
| 306 | + // protection the CDN is not currently giving. | |
| 307 | + 'fastly' => 'Fastly (needs CDN configuration)', | |
| 308 | + 'akamai' => 'Akamai (needs CDN configuration)', | |
| 309 | + 'sucuri' => 'Sucuri (needs CDN configuration)', | |
| 310 | + 'incapsula' => 'Imperva / Incapsula (needs CDN configuration)', | |
| 311 | + 'generic' => 'Something else', | |
| 312 | + 'custom' => 'Custom headers', | |
| 313 | + ), | |
| 314 | + 'label' => __( 'CDN or proxy in front', 'xspeed' ), | |
| 315 | + 'description' => __( 'Tells your CDN or proxy not to store pages xSpeed does not cache. Leave on Detect automatically unless you know your provider.', 'xspeed' ), | |
| 316 | + 'advanced' => true, | |
| 317 | + 'info_title' => __( 'Cache in front of this site', 'xspeed' ), | |
| 318 | + 'info' => __( 'Naming your provider narrows the headers to the one it reads. Detect automatically works it out per request and otherwise sends a set every cache ignores unless it understands it, so it is safe not to know. Off stops the edge lifetime and cache tags. When an add-on that manages the edge, such as a Cloudflare Enterprise add-on, is active, the "don\'t store" headers for logged-in, cart and search pages still go out. Run "wp xspeed cache edge" to see what was detected and what gets sent.', 'xspeed' ) | |
| 319 | + ), | |
| 320 | + 'edge_custom_headers' => array( | |
| 321 | + 'type' => 'list', | |
| 322 | + 'default' => array(), | |
| 323 | + 'item_type' => 'string', | |
| 324 | + 'label' => __( 'Custom CDN headers', 'xspeed' ), | |
| 325 | + 'advanced' => true, | |
| 326 | + 'dependsOn' => array( 'field' => 'edge_provider', 'value' => 'custom' ), | |
| 327 | + 'description' => __( 'One header per line, as Name: value, for example "Surrogate-Control: no-store". Lines starting with # are ignored.', 'xspeed' ), | |
| 328 | + 'info_title' => __( 'Custom edge headers', 'xspeed' ), | |
| 329 | + 'info' => __( 'These replace the headers xSpeed would have picked for your CDN. Two baselines are still added underneath: a Cache-Control, and "X-Accel-Expires: 0" for a page cache running in nginx on your own server. Name either one yourself and yours is used instead. Values containing $, % or a backslash are dropped — the same pairs go into nginx and Apache directives, where those cannot be escaped safely. Content-Length, Content-Encoding, Content-Type, Transfer-Encoding, Set-Cookie and Location are refused.', 'xspeed' ) | |
| 330 | + ), | |
| 232 | 331 | ); |
| 332 | + | |
| 333 | + // LiteSpeed-only opt-in (#509): meaningless on any other server, so | |
| 334 | + // the field only exists in the schema where it can act — elsewhere the | |
| 335 | + // stored value survives via preserved_keys(). Inserted right after | |
| 336 | + // mobile_separate, its sibling static-fast-path trade-off. | |
| 337 | + if ( \XSpeed\Server::LITESPEED === \XSpeed\Server::type() ) { | |
| 338 | + $litespeed = array( | |
| 339 | + 'litespeed_static_rewrite' => array( | |
| 340 | + 'type' => 'bool', | |
| 341 | + 'default' => false, | |
| 342 | + 'label' => __( 'LiteSpeed static fast path', 'xspeed' ), | |
| 343 | + 'advanced' => true, | |
| 344 | + 'description' => __( 'LiteSpeed serves cached pages without running PHP, which is faster on slow hosts. These visits are not counted in the dashboard hit ratio.', 'xspeed' ), | |
| 345 | + ), | |
| 346 | + ); | |
| 347 | + $pos = (int) array_search( 'mobile_separate', array_keys( $schema ), true ) + 1; | |
| 348 | + $schema = array_slice( $schema, 0, $pos, true ) + $litespeed + array_slice( $schema, $pos, null, true ); | |
| 349 | + } | |
| 350 | + | |
| 351 | + return $schema; | |
| 233 | 352 | } |
| 234 | 353 | |
| 235 | 354 | /** |
| 236 | 355 | * `mobile_separate_review` lives outside the schema: migration sets it |
| @@ -243,9 +362,18 @@ | ||
| 243 | 362 | * |
| 244 | 363 | * @return string[] |
| 245 | 364 | */ |
| 246 | 365 | public function preserved_keys(): array { |
| 247 | - return array( 'mobile_separate_review' ); | |
| 366 | + $keys = array( 'mobile_separate_review' ); | |
| 367 | + // On non-LiteSpeed servers the litespeed_static_rewrite field is not | |
| 368 | + // in the schema (see settings_schema()), so a schema-driven save | |
| 369 | + // would silently drop a value chosen while the site ran LiteSpeed. | |
| 370 | + // Preserve it so moving LiteSpeed → other → LiteSpeed keeps the | |
| 371 | + // user's choice. On LiteSpeed itself the schema owns the key. | |
| 372 | + if ( \XSpeed\Server::LITESPEED !== \XSpeed\Server::type() ) { | |
| 373 | + $keys[] = 'litespeed_static_rewrite'; | |
| 374 | + } | |
| 375 | + return $keys; | |
| 248 | 376 | } |
| 249 | 377 | |
| 250 | 378 | /** |
| 251 | 379 | * Seed per-module option from the legacy xspeed_options blob if we |
| @@ -395,9 +523,9 @@ | ||
| 395 | 523 | 'synopsis' => array( |
| 396 | 524 | array( |
| 397 | 525 | 'type' => 'assoc', |
| 398 | 526 | 'name' => 'type', |
| 399 | - 'description' => 'What to clear: all (default), page, object, cloudflare, cdn — or a group name (edge). Comma-separate to clear several.', | |
| 527 | + 'description' => 'What to clear: all (default), page, object, cloudflare, xcloud (sites with xCloud\'s purge plugin), cdn — or a group name (edge). Comma-separate to clear several.', | |
| 400 | 528 | 'optional' => true, |
| 401 | 529 | ), |
| 402 | 530 | array( |
| 403 | 531 | 'type' => 'assoc', |
| @@ -416,35 +544,49 @@ | ||
| 416 | 544 | ), |
| 417 | 545 | array( |
| 418 | 546 | 'name' => 'xspeed cache', |
| 419 | 547 | 'callback' => array( $this, 'cli_handler' ), |
| 420 | - 'shortdesc' => 'Inspect the Cache module: `status` (settings), `inventory` (which pages are cached, and how old), `size` (where the disk usage goes), `purge-log` (what cleared the cache, when and why), `purge-url <url>` to clear one page, `recheck-rewrite` to re-run the static-rewrite probe, or `nginx-config` to print the unified nginx server-block for pasting into a vhost. To clear the whole site use `wp xspeed purge`.', | |
| 548 | + 'shortdesc' => 'Inspect the Cache module: `status` (settings), `inventory` (which pages are cached, and how old), `size` (where the disk usage goes), `purge-log` (what cleared the cache, when and why), `purge` to clear everything (same as `wp xspeed purge`), `purge <url>` or `purge-url <url>` to clear one page, `recheck-rewrite` to re-run the static-rewrite probe, or `nginx-config` to print the unified nginx server-block for pasting into a vhost, or `edge` to show which cache is in front of the site and what xSpeed tells it, or `listings` to show which pages were recorded running a post list of their own (cleared by a narrow purge when a save may change that list). To clear the whole site use `wp xspeed purge`.', | |
| 421 | 549 | 'synopsis' => array( |
| 422 | 550 | array( |
| 423 | 551 | 'type' => 'positional', |
| 424 | 552 | 'name' => 'action', |
| 425 | - 'options' => array( 'status', 'inventory', 'size', 'purge-log', 'purge-url', 'recheck-rewrite', 'nginx-config' ), | |
| 553 | + 'options' => array( 'status', 'inventory', 'size', 'purge', 'purge-log', 'purge-url', 'recheck-rewrite', 'nginx-config', 'edge', 'listings' ), | |
| 426 | 554 | 'optional' => true, |
| 427 | 555 | ), |
| 428 | 556 | array( |
| 429 | - 'type' => 'positional', | |
| 430 | - 'name' => 'url', | |
| 431 | - 'optional' => true, | |
| 557 | + 'type' => 'positional', | |
| 558 | + 'name' => 'url', | |
| 559 | + 'description' => 'For purge and purge-url: the page to clear, as a URL on this site or a path such as /about/. Without it, purge clears everything.', | |
| 560 | + 'optional' => true, | |
| 432 | 561 | ), |
| 433 | 562 | array( |
| 434 | 563 | 'type' => 'assoc', |
| 435 | 564 | 'name' => 'limit', |
| 436 | - 'description' => 'Rows to print for inventory / purge-log. Default 20.', | |
| 565 | + 'description' => 'Rows to print for inventory / purge-log (default 20), or sample pages for listings (default 5).', | |
| 437 | 566 | 'optional' => true, |
| 438 | 567 | ), |
| 439 | 568 | array( |
| 440 | 569 | 'type' => 'assoc', |
| 441 | 570 | 'name' => 'cause', |
| 442 | - 'description' => 'Label recorded in the purge log for purge-url. Default "CLI".', | |
| 571 | + 'description' => 'Label recorded in the purge log for purge and purge-url. Default "CLI".', | |
| 443 | 572 | 'optional' => true, |
| 444 | 573 | ), |
| 445 | 574 | array( |
| 446 | 575 | 'type' => 'assoc', |
| 576 | + 'name' => 'type', | |
| 577 | + 'description' => 'For purge without a URL: what to clear, as in `wp xspeed purge --type`. Default all.', | |
| 578 | + 'optional' => true, | |
| 579 | + ), | |
| 580 | + array( | |
| 581 | + 'type' => 'assoc', | |
| 582 | + 'name' => 'format', | |
| 583 | + 'description' => 'For purge without a URL: table (default) or json.', | |
| 584 | + 'optional' => true, | |
| 585 | + 'options' => array( 'table', 'json' ), | |
| 586 | + ), | |
| 587 | + array( | |
| 588 | + 'type' => 'assoc', | |
| 447 | 589 | 'name' => 'server', |
| 448 | 590 | 'description' => 'Server type to assume for nginx-config, skipping detection. Detection needs SERVER_SOFTWARE, which the command line does not have; an undetectable host is assumed to be nginx anyway, so this is for stating it outright — or for the case detection is positively wrong, such as nginx in front of Apache.', |
| 449 | 591 | 'options' => array( 'nginx', 'apache', 'litespeed' ), |
| 450 | 592 | 'optional' => true, |
| @@ -596,9 +738,16 @@ | ||
| 596 | 738 | foreach ( $report['types'] as $row ) { |
| 597 | 739 | switch ( $row['status'] ) { |
| 598 | 740 | case \XSpeed\Purge_Runner::CLEARED: |
| 599 | 741 | ++$cleared; |
| 600 | - \WP_CLI::log( sprintf( ' cleared %s%s', $row['label'], self::purge_amount( $row ) ) ); | |
| 742 | + \WP_CLI::log( | |
| 743 | + sprintf( | |
| 744 | + ' cleared %s%s%s', | |
| 745 | + $row['label'], | |
| 746 | + self::purge_amount( $row ), | |
| 747 | + '' !== $row['reason'] ? '; ' . $row['reason'] : '' | |
| 748 | + ) | |
| 749 | + ); | |
| 601 | 750 | break; |
| 602 | 751 | case \XSpeed\Purge_Runner::FAILED: |
| 603 | 752 | ++$failed; |
| 604 | 753 | \WP_CLI::log( sprintf( ' FAILED %s — %s', $row['label'], $row['reason'] ) ); |
| @@ -632,8 +781,65 @@ | ||
| 632 | 781 | \WP_CLI::success( sprintf( 'Purged %d cache store(s); %d skipped.', $cleared, $skipped ) ); |
| 633 | 782 | } |
| 634 | 783 | |
| 635 | 784 | /** |
| 785 | + * Clear one page: `wp xspeed cache purge-url <url>` and | |
| 786 | + * `wp xspeed cache purge <url>`. | |
| 787 | + * | |
| 788 | + * A string purge_url() cannot act on (another scheme, a scheme with no | |
| 789 | + * host, a bare word) is refused with an error. purge_url() returns 0 for | |
| 790 | + * it, which read as "already cold" and exited 0. | |
| 791 | + * | |
| 792 | + * @param string $url Absolute URL or site-relative path. | |
| 793 | + * @param array<string,string> $assoc Flags; only --cause is read. | |
| 794 | + */ | |
| 795 | + private function cli_purge_url( string $url, array $assoc ): void { | |
| 796 | + if ( ! self::is_purgeable_url( $url ) ) { | |
| 797 | + \WP_CLI::error( sprintf( 'Not a page URL: %s. Give an http(s) URL on this site or a path starting with /, such as /about/.', $url ) ); | |
| 798 | + return; | |
| 799 | + } | |
| 800 | + $cause = isset( $assoc['cause'] ) && '' !== trim( (string) $assoc['cause'] ) ? trim( (string) $assoc['cause'] ) : 'CLI'; | |
| 801 | + $result = \XSpeed\Cache::purge_url_reported( $url, $cause ); | |
| 802 | + $removed = $result['removed']; | |
| 803 | + $forwarded = implode( ', ', $result['forwarded'] ); | |
| 804 | + if ( $removed > 0 ) { | |
| 805 | + \WP_CLI::success( | |
| 806 | + '' === $forwarded | |
| 807 | + ? sprintf( 'Purged %d cache file(s) for %s', $removed, $url ) | |
| 808 | + : sprintf( 'Purged %d cache file(s) for %s, and sent the purge to %s', $removed, $url, $forwarded ) | |
| 809 | + ); | |
| 810 | + } elseif ( '' !== $forwarded ) { | |
| 811 | + // xSpeed's own cache held nothing, but a cache in front of | |
| 812 | + // PHP took the purge: that copy is the one visitors get. | |
| 813 | + \WP_CLI::success( sprintf( 'Sent the purge for %s to %s. xSpeed\'s own cache held no copy.', $url, $forwarded ) ); | |
| 814 | + } else { | |
| 815 | + \WP_CLI::log( sprintf( 'No cache entries found for %s (already cold, or the URL never cached).', $url ) ); | |
| 816 | + } | |
| 817 | + } | |
| 818 | + | |
| 819 | + /** | |
| 820 | + * Whether purge_url() can act on this string: an http(s) URL with a | |
| 821 | + * host, a host without a scheme (`site.test/page/`), or a path starting | |
| 822 | + * with `/`. The same rules purge_url() applies before it returns 0. | |
| 823 | + * | |
| 824 | + * @param string $url What the operator typed. | |
| 825 | + */ | |
| 826 | + private static function is_purgeable_url( string $url ): bool { | |
| 827 | + $parts = wp_parse_url( $url ); | |
| 828 | + if ( ! is_array( $parts ) ) { | |
| 829 | + return false; | |
| 830 | + } | |
| 831 | + if ( isset( $parts['scheme'] ) ) { | |
| 832 | + return in_array( strtolower( (string) $parts['scheme'] ), array( 'http', 'https' ), true ) && ! empty( $parts['host'] ); | |
| 833 | + } | |
| 834 | + if ( isset( $parts['host'] ) ) { | |
| 835 | + return true; | |
| 836 | + } | |
| 837 | + $path = isset( $parts['path'] ) ? (string) $parts['path'] : ''; | |
| 838 | + return '' !== $path && '/' === $path[0]; | |
| 839 | + } | |
| 840 | + | |
| 841 | + /** | |
| 636 | 842 | * The " — 42 entries (1.3 MB)" tail on a cleared line. |
| 637 | 843 | * |
| 638 | 844 | * Entries and bytes are both optional: a Redis FLUSHALL reports neither, |
| 639 | 845 | * and printing "0 entries" for it would read as an empty cache rather |
| @@ -656,8 +862,29 @@ | ||
| 656 | 862 | public function cli_handler( array $args, array $assoc ): void { |
| 657 | 863 | $action = isset( $args[0] ) ? (string) $args[0] : 'status'; |
| 658 | 864 | $limit = isset( $assoc['limit'] ) ? max( 1, (int) $assoc['limit'] ) : 20; |
| 659 | 865 | |
| 866 | + // `wp xspeed cache purge` is what people type. It runs the same | |
| 867 | + // purge as `wp xspeed purge`; before it was listed, WP-CLI rejected | |
| 868 | + // it with "Invalid value specified for positional arg". Given a URL | |
| 869 | + // it clears that one page, as purge-url does: it used to drop the | |
| 870 | + // URL and clear the whole site. | |
| 871 | + if ( 'purge' === $action ) { | |
| 872 | + $url = isset( $args[1] ) ? trim( (string) $args[1] ) : ''; | |
| 873 | + if ( '' === $url ) { | |
| 874 | + $this->cli_purge( array(), $assoc ); | |
| 875 | + return; | |
| 876 | + } | |
| 877 | + foreach ( array( 'type', 'format' ) as $flag ) { | |
| 878 | + if ( isset( $assoc[ $flag ] ) ) { | |
| 879 | + \WP_CLI::error( sprintf( '--%s applies to a full purge, not to one URL. Run `wp xspeed cache purge %s` without it, or drop the URL to purge everything.', $flag, $url ) ); | |
| 880 | + return; | |
| 881 | + } | |
| 882 | + } | |
| 883 | + $this->cli_purge_url( $url, $assoc ); | |
| 884 | + return; | |
| 885 | + } | |
| 886 | + | |
| 660 | 887 | /* |
| 661 | 888 | * Print the unified nginx server-block so an installer, provisioning |
| 662 | 889 | * script, or another plugin can fetch it non-interactively and write |
| 663 | 890 | * it into a vhost. Previously this was only reachable via |
| @@ -784,8 +1011,15 @@ | ||
| 784 | 1011 | // HIT (php). See Cache::qualify_rewrite_probe(). |
| 785 | 1012 | $probe = \XSpeed\Cache::qualify_rewrite_probe( \XSpeed\Cache::recheck_static_rewrite() ); |
| 786 | 1013 | $blocked = '' !== (string) $probe['block_reason']; |
| 787 | 1014 | |
| 1015 | + // Whether the installed rules are the ones these settings | |
| 1016 | + // generate. Reported before the verdict below because it is the | |
| 1017 | + // question someone running this command has just acted on — they | |
| 1018 | + // pasted a block and want to know if it took — and because | |
| 1019 | + // "active" is true for a stale block too. | |
| 1020 | + $this->cli_report_rules_state( (array) ( $probe['rules'] ?? array() ) ); | |
| 1021 | + | |
| 788 | 1022 | if ( $probe['active'] ) { |
| 789 | 1023 | \WP_CLI::success( 'Static rewrite is active — the web server is serving cache hits directly.' ); |
| 790 | 1024 | return; |
| 791 | 1025 | } |
| @@ -807,15 +1041,9 @@ | ||
| 807 | 1041 | if ( '' === $url ) { |
| 808 | 1042 | \WP_CLI::error( 'Usage: wp xspeed cache purge-url <url-or-path>' ); |
| 809 | 1043 | return; |
| 810 | 1044 | } |
| 811 | - $cause = isset( $assoc['cause'] ) && '' !== trim( (string) $assoc['cause'] ) ? trim( (string) $assoc['cause'] ) : 'CLI'; | |
| 812 | - $removed = \XSpeed\Cache::purge_url( $url, $cause ); | |
| 813 | - if ( $removed > 0 ) { | |
| 814 | - \WP_CLI::success( sprintf( 'Purged %d cache file(s) for %s', $removed, $url ) ); | |
| 815 | - } else { | |
| 816 | - \WP_CLI::log( sprintf( 'No cache entries found for %s (already cold, or the URL never cached).', $url ) ); | |
| 817 | - } | |
| 1045 | + $this->cli_purge_url( $url, $assoc ); | |
| 818 | 1046 | return; |
| 819 | 1047 | } |
| 820 | 1048 | |
| 821 | 1049 | if ( 'inventory' === $action ) { |
| @@ -832,8 +1060,18 @@ | ||
| 832 | 1060 | $this->cli_purge_log( $limit ); |
| 833 | 1061 | return; |
| 834 | 1062 | } |
| 835 | 1063 | |
| 1064 | + if ( 'edge' === $action ) { | |
| 1065 | + $this->cli_edge(); | |
| 1066 | + return; | |
| 1067 | + } | |
| 1068 | + | |
| 1069 | + if ( 'listings' === $action ) { | |
| 1070 | + $this->cli_listings( isset( $assoc['limit'] ) ? $limit : 5 ); | |
| 1071 | + return; | |
| 1072 | + } | |
| 1073 | + | |
| 836 | 1074 | $opts = Settings_Manager::get( self::SLUG ); |
| 837 | 1075 | \WP_CLI::log( 'cache_expiry ' . $opts['cache_expiry'] . 'h' ); |
| 838 | 1076 | \WP_CLI::log( 'excluded_urls ' . count( $opts['excluded_urls'] ) . ' entries' ); |
| 839 | 1077 | foreach ( $opts['excluded_urls'] as $u ) { |
| @@ -838,8 +1076,205 @@ | ||
| 838 | 1076 | \WP_CLI::log( 'excluded_urls ' . count( $opts['excluded_urls'] ) . ' entries' ); |
| 839 | 1077 | foreach ( $opts['excluded_urls'] as $u ) { |
| 840 | 1078 | \WP_CLI::log( ' - ' . $u ); |
| 841 | 1079 | } |
| 1080 | + $edge = \XSpeed\Edge_Provider::detect(); | |
| 1081 | + \WP_CLI::log( 'edge ' . ( '' !== $edge['provider'] ? $edge['provider'] : $edge['confidence'] ) . ' (' . $edge['source'] . ')' ); | |
| 1082 | + } | |
| 1083 | + | |
| 1084 | + /** | |
| 1085 | + * `wp xspeed cache edge` — what we think is in front, and what we say to it. | |
| 1086 | + * | |
| 1087 | + * Worth printing even when nothing is held back. "You are behind | |
| 1088 | + * Cloudflare, and a Cache Rule set to ignore origin headers overrides | |
| 1089 | + * anything xSpeed sends" is the answer to a support question that | |
| 1090 | + * otherwise costs someone a week, and it is true whether or not a hold | |
| 1091 | + * ever fires. | |
| 1092 | + */ | |
| 1093 | + private function cli_edge(): void { | |
| 1094 | + $answer = \XSpeed\Edge_Provider::detect(); | |
| 1095 | + | |
| 1096 | + \WP_CLI::log( 'provider ' . ( '' !== $answer['provider'] ? $answer['provider'] : '(none named)' ) ); | |
| 1097 | + \WP_CLI::log( 'confidence ' . $answer['confidence'] ); | |
| 1098 | + \WP_CLI::log( 'source ' . $answer['source'] ); | |
| 1099 | + | |
| 1100 | + // A pin outranks detection by design, so nothing re-checks it on the | |
| 1101 | + // site's behalf. Saying the two disagree is the whole mechanism by | |
| 1102 | + // which a site that changed CDN ever finds out. | |
| 1103 | + $sniffed = \XSpeed\Edge_Provider::sniffed(); | |
| 1104 | + if ( in_array( $answer['source'], array( 'setting', 'constant', 'filter' ), true ) | |
| 1105 | + && '' !== $sniffed['provider'] | |
| 1106 | + && $sniffed['provider'] !== $answer['provider'] ) { | |
| 1107 | + \WP_CLI::warning( | |
| 1108 | + sprintf( | |
| 1109 | + 'This request looks like %s, but the provider is pinned to %s. If the site moved, change it — the pinned answer is also baked into the drop-in and the server rules.', | |
| 1110 | + $sniffed['provider'], | |
| 1111 | + '' !== $answer['provider'] ? $answer['provider'] : 'off' | |
| 1112 | + ) | |
| 1113 | + ); | |
| 1114 | + } | |
| 1115 | + | |
| 1116 | + if ( \XSpeed\Edge_Provider::is_off( $answer ) ) { | |
| 1117 | + \WP_CLI::log( '' ); | |
| 1118 | + \WP_CLI::log( 'Nothing is sent: this is switched off.' ); | |
| 1119 | + return; | |
| 1120 | + } | |
| 1121 | + | |
| 1122 | + // Resolved through edge_headers_for() rather than straight off the | |
| 1123 | + // provider, so this prints what the serve path would ACTUALLY send — | |
| 1124 | + // including `X-XSpeed-Edge-Hold`, and including the evidence gate. | |
| 1125 | + // Listing the provider's raw set ignored that gate and told operators | |
| 1126 | + // a first render would be held on a site where it would not be. | |
| 1127 | + // | |
| 1128 | + // `bake`, not `request`. Two reasons, and the second one matters: | |
| 1129 | + // this command answers for the site rather than for one response, and | |
| 1130 | + // `request` fires `xspeed_edge_optimization_pending`, whose Pro | |
| 1131 | + // listener resolves the CSS plan — which by its own description is | |
| 1132 | + // what queues a build. A read-only command must not burn a build | |
| 1133 | + // slot, quarantine an entry or purge a page just by being run, and | |
| 1134 | + // under WP-CLI it would do all three against the home page. | |
| 1135 | + $bypass = \XSpeed\Cache::edge_headers_for( 'BYPASS', 'bake', 'logged-in' ); | |
| 1136 | + $miss = \XSpeed\Cache::edge_headers_for( 'MISS', 'bake' ); | |
| 1137 | + | |
| 1138 | + \WP_CLI::log( '' ); | |
| 1139 | + \WP_CLI::log( 'On a page xSpeed refuses to cache (a cart, a logged-in view):' ); | |
| 1140 | + foreach ( $bypass as $name => $value ) { | |
| 1141 | + \WP_CLI::log( sprintf( ' %s: %s', $name, $value ) ); | |
| 1142 | + } | |
| 1143 | + | |
| 1144 | + \WP_CLI::log( '' ); | |
| 1145 | + if ( array() === $miss ) { | |
| 1146 | + \WP_CLI::log( 'On a first render: nothing. A MISS is a performance hedge, so it is held only where a cache in front was detected — and none was. Name the provider in Cache In Front Of This Site to cover first renders too.' ); | |
| 1147 | + } else { | |
| 1148 | + \WP_CLI::log( 'On a first render:' ); | |
| 1149 | + foreach ( $miss as $name => $value ) { | |
| 1150 | + \WP_CLI::log( sprintf( ' %s: %s', $name, $value ) ); | |
| 1151 | + } | |
| 1152 | + } | |
| 1153 | + | |
| 1154 | + // The same bake the drop-in gets, so it asks no per-page question. | |
| 1155 | + $variant = \XSpeed\Cache::query_variant_edge_headers(); | |
| 1156 | + | |
| 1157 | + \WP_CLI::log( '' ); | |
| 1158 | + if ( array() === $variant ) { | |
| 1159 | + \WP_CLI::log( 'A cached page requested with an ignored parameter (?utm_source=x) gets the same headers as without one. It is held only where a cache in front was detected, and with Separate Mobile Cache on every page is held already.' ); | |
| 1160 | + } else { | |
| 1161 | + \WP_CLI::log( 'On a cached page requested with an ignored parameter (?utm_source=x), a cached search or a query-form feed:' ); | |
| 1162 | + foreach ( $variant as $name => $value ) { | |
| 1163 | + \WP_CLI::log( sprintf( ' %s: %s', $name, $value ) ); | |
| 1164 | + } | |
| 1165 | + } | |
| 1166 | + | |
| 1167 | + \WP_CLI::log( '' ); | |
| 1168 | + \WP_CLI::log( 'X-XSpeed-Edge-Hold names why a response was held: bypass, bypass-shape, miss, mobile-split, pending or query-variant. No header means nothing was held.' ); | |
| 1169 | + | |
| 1170 | + if ( 'cloudflare' === $answer['provider'] ) { | |
| 1171 | + \WP_CLI::log( '' ); | |
| 1172 | + \WP_CLI::log( 'A Cloudflare Cache Rule whose Edge TTL is "Ignore cache-control header and use this TTL" overrides all of the above. Use "Respect origin TTL" on that rule if pages are still being stored.' ); | |
| 1173 | + } | |
| 1174 | + } | |
| 1175 | + | |
| 1176 | + /** | |
| 1177 | + * `wp xspeed cache listings`: the pages recorded running a post list | |
| 1178 | + * outside the main loop, which a narrow purge adds when a save may | |
| 1179 | + * change that list. | |
| 1180 | + * | |
| 1181 | + * For measuring how wide that set gets on a real site: close to every | |
| 1182 | + * page means a narrow purge saves little there. | |
| 1183 | + * | |
| 1184 | + * @param int $samples Pages to print. | |
| 1185 | + */ | |
| 1186 | + private function cli_listings( int $samples ): void { | |
| 1187 | + $narrow = ! empty( Settings_Manager::get( self::SLUG )['purge_affected_only'] ); | |
| 1188 | + $stats = \XSpeed\Listing_Pages::stats( $samples ); | |
| 1189 | + $limit = \XSpeed\Affected_Pages::LIMIT; | |
| 1190 | + | |
| 1191 | + \WP_CLI::log( 'narrow purge ' . ( $narrow ? 'on' : 'off' ) ); | |
| 1192 | + \WP_CLI::log( 'recording ' . ( \XSpeed\Listing_Pages::enabled() ? 'on' : 'off' ) ); | |
| 1193 | + \WP_CLI::log( 'directory ' . $stats['dir'] ); | |
| 1194 | + | |
| 1195 | + \WP_CLI::log( '' ); | |
| 1196 | + \WP_CLI::log( 'Newest-N lists (' . count( $stats['specs'] ) . ' of ' . \XSpeed\Listing_Pages::SPEC_CAP . '): a change to one of the newest N clears the whole site.' ); | |
| 1197 | + foreach ( $stats['specs'] as $spec ) { | |
| 1198 | + \WP_CLI::log( sprintf( ' newest %d of %s%s', $spec['n'], implode( ', ', $spec['types'] ), $spec['sticky'] ? ', sticky posts first' : '' ) ); | |
| 1199 | + } | |
| 1200 | + | |
| 1201 | + \WP_CLI::log( '' ); | |
| 1202 | + \WP_CLI::log( sprintf( 'Pages with other lists: %d recorded (%d files, cap %d); %d posts in the shown-on index.', $stats['pages'], $stats['files'], \XSpeed\Listing_Pages::CAP, $stats['posts'] ) ); | |
| 1203 | + foreach ( $stats['types'] as $type => $counts ) { | |
| 1204 | + \WP_CLI::log( | |
| 1205 | + sprintf( | |
| 1206 | + ' %-14s %d pages, %d not precise%s', | |
| 1207 | + $type, | |
| 1208 | + $counts['all'], | |
| 1209 | + $counts['loose'], | |
| 1210 | + $counts['loose'] > $limit | |
| 1211 | + ? ' (over ' . $limit . ' not precise: any change to a post of this type clears the whole site)' | |
| 1212 | + : ( $counts['all'] > $limit ? ' (over ' . $limit . ': a change that is not a plain edit clears the whole site)' : '' ) | |
| 1213 | + ) | |
| 1214 | + ); | |
| 1215 | + } | |
| 1216 | + | |
| 1217 | + if ( null !== $stats['full'] ) { | |
| 1218 | + \WP_CLI::warning( | |
| 1219 | + sprintf( | |
| 1220 | + 'The record is full, and pages listing %s went unrecorded: a change to a post of those types clears the whole site until a save finds the record under the cap.', | |
| 1221 | + implode( ', ', array_map( 'strval', (array) ( $stats['full']['types'] ?? array( 'any' ) ) ) ) | |
| 1222 | + ) | |
| 1223 | + ); | |
| 1224 | + } | |
| 1225 | + if ( array() === $stats['samples'] ) { | |
| 1226 | + return; | |
| 1227 | + } | |
| 1228 | + \WP_CLI::log( '' ); | |
| 1229 | + foreach ( $stats['samples'] as $record ) { | |
| 1230 | + \WP_CLI::log( | |
| 1231 | + sprintf( | |
| 1232 | + ' %s [%s] %s', | |
| 1233 | + $record['url'], | |
| 1234 | + implode( ', ', $record['types'] ), | |
| 1235 | + $record['precise'] ? 'precise, ' . count( $record['ids'] ) . ' post(s) shown' : 'not precise' | |
| 1236 | + ) | |
| 1237 | + ); | |
| 1238 | + } | |
| 1239 | + } | |
| 1240 | + | |
| 1241 | + /** | |
| 1242 | + * Say which version of the cache rules the server is running. | |
| 1243 | + * | |
| 1244 | + * The generated block stamps every static hit with a hash of itself, and | |
| 1245 | + * the probe reads that back — the only way to tell what someone actually | |
| 1246 | + * pasted into a config WordPress cannot open. `stale` names the settings | |
| 1247 | + * that moved since, where we can tell, because "re-paste the block" with | |
| 1248 | + * no reason attached is what makes people ignore it. | |
| 1249 | + * | |
| 1250 | + * @param array $rules Cache::rules_state() output. | |
| 1251 | + */ | |
| 1252 | + private function cli_report_rules_state( array $rules ): void { | |
| 1253 | + $state = (string) ( $rules['state'] ?? '' ); | |
| 1254 | + | |
| 1255 | + if ( 'current' === $state ) { | |
| 1256 | + \WP_CLI::log( 'Cache rules: current — the installed rules are the ones these settings generate.' ); | |
| 1257 | + return; | |
| 1258 | + } | |
| 1259 | + if ( 'stale' === $state ) { | |
| 1260 | + $changed = array_filter( array_map( 'strval', (array) ( $rules['changed'] ?? array() ) ) ); | |
| 1261 | + \WP_CLI::log( | |
| 1262 | + '' === implode( '', $changed ) | |
| 1263 | + ? 'Cache rules: stale — a different version of the rules is installed. Re-paste the block.' | |
| 1264 | + : sprintf( | |
| 1265 | + 'Cache rules: stale — a different version of the rules is installed (%s changed since). Re-paste the block.', | |
| 1266 | + implode( ', ', $changed ) | |
| 1267 | + ) | |
| 1268 | + ); | |
| 1269 | + return; | |
| 1270 | + } | |
| 1271 | + if ( 'absent' === $state ) { | |
| 1272 | + \WP_CLI::log( 'Cache rules: absent — no xSpeed rules are installed, or they predate the version marker.' ); | |
| 1273 | + return; | |
| 1274 | + } | |
| 1275 | + | |
| 1276 | + \WP_CLI::log( 'Cache rules: unknown — the probe could not read a rules marker back from this server.' ); | |
| 842 | 1277 | } |
| 843 | 1278 | |
| 844 | 1279 | /** `wp xspeed cache inventory [--limit=N]` — which pages are cached, and how old. */ |
| 845 | 1280 | private function cli_inventory( int $limit ): void { |
