| @@ -14,9 +14,9 @@ | ||
| 14 | 14 | /** |
| 15 | 15 | * Data-schema version for one-time migrations, independent of the |
| 16 | 16 | * plugin version header. Bump when adding a step to maybe_upgrade(). |
| 17 | 17 | */ |
| 18 | - public const DATA_VERSION = '1.1.2'; | |
| 18 | + public const DATA_VERSION = '1.1.6'; | |
| 19 | 19 | |
| 20 | 20 | private static $instance = null; |
| 21 | 21 | |
| 22 | 22 | /** @var Usage_Tracker|null */ |
| @@ -59,8 +59,11 @@ | ||
| 59 | 59 | // this is a consistency check, not a new install path. First |
| 60 | 60 | // admin page load after a plugin upgrade restores the state; |
| 61 | 61 | // front-end then serves from cache on the next request. |
| 62 | 62 | add_action( 'admin_init', array( Cache::class, 'auto_heal' ) ); |
| 63 | + // Cheap: returns immediately unless the stored schema version is | |
| 64 | + // behind. Covers updates and multisite, where activate() never runs. | |
| 65 | + add_action( 'admin_init', array( Score_Store::class, 'maybe_install' ) ); | |
| 63 | 66 | |
| 64 | 67 | // Secondary net: restore as soon as an update completes, for the |
| 65 | 68 | // cases where activate() does not re-run (bulk updates, auto-updates, |
| 66 | 69 | // some host updaters). Best-effort by nature — this callback is only |
| @@ -73,13 +76,34 @@ | ||
| 73 | 76 | // Per-post cache rules (Phase 3.4) — registers postmeta with |
| 74 | 77 | // REST + meta box on edit screens. |
| 75 | 78 | Cache_Meta_Box::boot(); |
| 76 | 79 | |
| 80 | + // Single-URL purge entry points — row actions, the edit-screen | |
| 81 | + // button and the admin-post handler the admin-bar item also uses. | |
| 82 | + Purge_Ui::boot(); | |
| 83 | + | |
| 77 | 84 | // Phase 0 architecture — managers + Free modules. v1 services |
| 78 | 85 | // (Cache/Minifier/Gzip) are NOT yet Modules; they'll be refactored |
| 79 | 86 | // in a follow-up PR with parity tests. |
| 80 | 87 | Conflict_Registry::boot(); |
| 81 | 88 | |
| 89 | + // Read-only page-cache ownership evidence, behind the same | |
| 90 | + // activation/deactivation invalidation as the conflict matrix. | |
| 91 | + Page_Cache_Detector::boot(); | |
| 92 | + | |
| 93 | + // Integrations that clear OTHER plugins' caches of rendered output | |
| 94 | + // (Elementor's element cache + generated CSS). Registers a listener | |
| 95 | + // only; nothing runs until Cache::purge_render_caches() asks. | |
| 96 | + Render_Caches::boot(); | |
| 97 | + // Server_Caches needs no boot(): Cache::dispatch_purge_event() calls it | |
| 98 | + // directly so a throwing third-party listener cannot skip it. | |
| 99 | + | |
| 100 | + // Forward a full purge to a full-page cache owned by the WEB SERVER | |
| 101 | + // (nginx FastCGI, via the host's Nginx Helper install). Registers a | |
| 102 | + // listener on xspeed_after_purge_all only; it stands down unless | |
| 103 | + // that cache is actually configured. | |
| 104 | + Host_Page_Caches::boot(); | |
| 105 | + | |
| 82 | 106 | // Register Free modules via the same action xspeed-pro uses, so |
| 83 | 107 | // the bootstrap path is symmetric across tiers. |
| 84 | 108 | add_action( 'xspeed_register_modules', array( $this, 'register_free_modules' ) ); |
| 85 | 109 | |
| @@ -119,8 +143,24 @@ | ||
| 119 | 143 | // 1.1.2 — strip credential values recorded by earlier versions' |
| 120 | 144 | // settings change annotations (they're served by the trend endpoints). |
| 121 | 145 | Activity_Log::redact_legacy_secrets(); |
| 122 | 146 | |
| 147 | + // 1.1.4 — earlier versions cached a failed loopback as "gzip is not | |
| 148 | + // active" for an hour, which showed up as a bogus server-config | |
| 149 | + // warning. Drop the stale answer so the fixed probe re-runs instead | |
| 150 | + // of the wrong verdict living on past the update (issue #18). | |
| 151 | + delete_transient( 'xspeed_gzip_active' ); | |
| 152 | + | |
| 153 | + // 1.1.6 — a `/?s=<term>` request used to write its results page into | |
| 154 | + // the static tree under the *searched-from* path, which for the usual | |
| 155 | + // query-form search is `/`. The web server then served that results | |
| 156 | + // page as the homepage to every visitor. The write is fixed in | |
| 157 | + // Cache::store_static(), but an entry poisoned before the update | |
| 158 | + // outlives it: nothing purges on upgrade, and the static serve path | |
| 159 | + // never revalidates. Clear the tree once. The flat cache is keyed | |
| 160 | + // correctly and is deliberately left alone. (issue #191) | |
| 161 | + Cache::purge_static_tree(); | |
| 162 | + | |
| 123 | 163 | update_option( 'xspeed_data_version', self::DATA_VERSION, false ); |
| 124 | 164 | } |
| 125 | 165 | |
| 126 | 166 | /** |
| @@ -131,8 +171,63 @@ | ||
| 131 | 171 | * Runs at plugins_loaded(20) so every add-on that hooks at any |
| 132 | 172 | * priority < 20 has time to register first. |
| 133 | 173 | */ |
| 134 | 174 | public function fire_module_lifecycle(): void { |
| 175 | + $this->ensure_modules_registered(); | |
| 176 | + | |
| 177 | + Module_Registry::boot_all(); | |
| 178 | + } | |
| 179 | + | |
| 180 | + /** | |
| 181 | + * Fire `xspeed_register_modules` if this request has not yet, hooking | |
| 182 | + * Free's own registration first when init() never got the chance. | |
| 183 | + * | |
| 184 | + * The activation request is the case that matters. activate_plugin() | |
| 185 | + * includes the plugin file long after `plugins_loaded` has fired, so the | |
| 186 | + * `plugins_loaded` callback init() would have added never runs, and | |
| 187 | + * neither does the add_action() inside it that puts register_free_modules | |
| 188 | + * on the action. Firing the action from activate() then registered | |
| 189 | + * nothing: Settings::conflict_safe_profile() composed from an empty | |
| 190 | + * registry, and a site with WP Super Cache came up with lazy-load, | |
| 191 | + * resource hints, font swapping and preloading switched on — only the | |
| 192 | + * four settings the registry-independent fallback names were held down | |
| 193 | + * (PR #295 review). Module_Registry::activate_all() has been a no-op on | |
| 194 | + * the same request for the same reason. | |
| 195 | + * | |
| 196 | + * On the activation request that means Free only: an add-on cannot have | |
| 197 | + * hooked yet, because xspeed-pro bails when Free's classes are absent and | |
| 198 | + * only hooks the action (at priority 20, from plugins_loaded(15)) once | |
| 199 | + * Free is active. On an ordinary request fire_module_lifecycle() reaches | |
| 200 | + * this at plugins_loaded(20) with every add-on already hooked. Do not | |
| 201 | + * call this from anything that can run in between: the action fires | |
| 202 | + * once, and an add-on that has not hooked yet stays unregistered for the | |
| 203 | + * whole request. | |
| 204 | + * did_action() keeps the action to one firing per request, so an | |
| 205 | + * activation that ran first does not make plugins_loaded(20) register | |
| 206 | + * every module a second time. | |
| 207 | + */ | |
| 208 | + public function ensure_modules_registered(): void { | |
| 209 | + if ( did_action( 'xspeed_register_modules' ) ) { | |
| 210 | + return; | |
| 211 | + } | |
| 212 | + | |
| 213 | + /* | |
| 214 | + * register_free_modules() does an unconditional `new` on every module | |
| 215 | + * class. On an ordinary request xspeed.php's integrity check refuses | |
| 216 | + * to boot before that can fatal and explains itself in an admin | |
| 217 | + * notice; the activation hook is registered outside that check, so | |
| 218 | + * an install missing a module file (truncated zip, a security | |
| 219 | + * plugin's quarantine, a half-applied update) would fatal here with | |
| 220 | + * no notice and no active plugin. Same answer as boot: do nothing. | |
| 221 | + */ | |
| 222 | + if ( function_exists( 'xspeed_missing_core_classes' ) && ! empty( xspeed_missing_core_classes() ) ) { | |
| 223 | + return; | |
| 224 | + } | |
| 225 | + | |
| 226 | + if ( ! has_action( 'xspeed_register_modules', array( $this, 'register_free_modules' ) ) ) { | |
| 227 | + add_action( 'xspeed_register_modules', array( $this, 'register_free_modules' ) ); | |
| 228 | + } | |
| 229 | + | |
| 135 | 230 | /** |
| 136 | 231 | * Action: xspeed_register_modules |
| 137 | 232 | * |
| 138 | 233 | * Free modules register at priority 10; xspeed-pro at priority |
| @@ -139,10 +234,8 @@ | ||
| 139 | 234 | * 20; site code can hook in between to inject custom modules. |
| 140 | 235 | * Fires exactly once per request. |
| 141 | 236 | */ |
| 142 | 237 | do_action( 'xspeed_register_modules' ); |
| 143 | - | |
| 144 | - Module_Registry::boot_all(); | |
| 145 | 238 | } |
| 146 | 239 | |
| 147 | 240 | /** |
| 148 | 241 | * Register the Free Modules shipped in this plugin. Add new module |
| @@ -150,8 +243,13 @@ | ||
| 150 | 243 | */ |
| 151 | 244 | public function register_free_modules(): void { |
| 152 | 245 | Module_Registry::register( new \XSpeed\Modules\Cache\CacheModule() ); |
| 153 | 246 | Module_Registry::register( new \XSpeed\Modules\Health\HealthModule() ); |
| 247 | + // Settings — owns no settings itself; it's the CLI/MCP surface over | |
| 248 | + // Settings_Manager. Registering it is what makes `xspeed settings` | |
| 249 | + // exist, which is what keeps the curated get_settings/update_settings | |
| 250 | + // tools in the MCP catalog. (#149/#153) | |
| 251 | + Module_Registry::register( new \XSpeed\Modules\Settings\SettingsModule() ); | |
| 154 | 252 | // External performance scores (PSI / GTmetrix) — Free, off by |
| 155 | 253 | // default. Rendered inside the Health host page's PageSpeed tab, so |
| 156 | 254 | // it has no sidebar row of its own. |
| 157 | 255 | Module_Registry::register( new \XSpeed\Modules\Score\ScoreModule() ); |
| @@ -188,8 +286,12 @@ | ||
| 188 | 286 | // snapshot is onboarding/diagnostics, not a paid value-add, so every |
| 189 | 287 | // user gets it. The snapshot degrades gracefully without Pro (Pro |
| 190 | 288 | // version/license fields fall back to defaults via defined()/get_option). |
| 191 | 289 | Module_Registry::register( new \XSpeed\Modules\Support\SupportModule() ); |
| 290 | + // The dashboard control for usage-analytics consent. Consent used to | |
| 291 | + // be collectable only in the wizard and withdrawable nowhere, while | |
| 292 | + // the wizard and readme both promised a dashboard switch. (#437) | |
| 293 | + Module_Registry::register( new \XSpeed\Modules\Privacy\PrivacyModule() ); | |
| 192 | 294 | // MCP remote control (AI assistants) — Free. The plugin serves the |
| 193 | 295 | // MCP protocol at the site's own /xspeed/mcp URL; the only gate is |
| 194 | 296 | // the per-site connection token an admin mints via Connect. No |
| 195 | 297 | // license, no hosted infra. See IMPLEMENTATION.md §17. |
| @@ -220,19 +322,80 @@ | ||
| 220 | 322 | return $this->usage_tracker; |
| 221 | 323 | } |
| 222 | 324 | |
| 223 | 325 | public static function activate() { |
| 224 | - Settings::set_defaults(); | |
| 326 | + // Nothing below can see a module the registry does not hold — the | |
| 327 | + // conflict-safe profile Settings::set_defaults() may pick is composed | |
| 328 | + // from it, and activate_all() walks it. See ensure_modules_registered() | |
| 329 | + // for why the registry is empty on this request without this call. | |
| 330 | + self::instance()->ensure_modules_registered(); | |
| 225 | 331 | |
| 332 | + $profile = Settings::set_defaults(); | |
| 333 | + | |
| 334 | + // Score history table. Also called on admin_init (see init()) because | |
| 335 | + // activation does not fire for a site added to a multisite network | |
| 336 | + // later, nor after an update that ships a new schema version. | |
| 337 | + Score_Store::maybe_install(); | |
| 338 | + | |
| 226 | 339 | if ( ! file_exists( XSPEED_CACHE_DIR ) ) { |
| 227 | 340 | wp_mkdir_p( XSPEED_CACHE_DIR ); |
| 228 | 341 | } |
| 229 | 342 | Cache::write_silence( XSPEED_CACHE_DIR ); |
| 230 | 343 | |
| 231 | - // Caching is only ever ENABLED from the admin UI — see Cache::toggle() | |
| 232 | - // and Rest_Api::toggle_cache(). A fresh install therefore gets no | |
| 233 | - // drop-in and no wp-config.php edit here: cache_enabled is unset, so | |
| 234 | - // the call below is a no-op. | |
| 344 | + /* | |
| 345 | + * One exception to "caching is only ever enabled from the admin UI": | |
| 346 | + * a fresh install another plugin performed on the user's behalf. | |
| 347 | + * | |
| 348 | + * That plugin asked the user for site performance and installed us to | |
| 349 | + * provide it; making them go and find a second switch afterwards is | |
| 350 | + * a step nobody wants. It is also what the copy-vendored Setup::finish() | |
| 351 | + * did, so hosts migrating off it keep the behaviour they have. | |
| 352 | + * | |
| 353 | + * PROFILE_HOST_PAGE_CACHE is the whole condition, and it means three | |
| 354 | + * things at once: the install was genuinely fresh, nothing else owns | |
| 355 | + * the page cache, and another plugin claimed the install. Every other | |
| 356 | + * fresh install — including a user's own on a clear site — waits for | |
| 357 | + * the wizard. Every OTHER feature is off in this profile; the cache is | |
| 358 | + * the one thing a host may assume, because it is what it installed us | |
| 359 | + * for. And toggle() runs its own ownership transaction, so a | |
| 360 | + * competitor appearing between the two checks loses the race rather | |
| 361 | + * than being overwritten. | |
| 362 | + */ | |
| 363 | + if ( Settings::PROFILE_HOST_PAGE_CACHE === $profile ) { | |
| 364 | + $state = Cache::toggle( true ); | |
| 365 | + if ( ! empty( $state['blocked'] ) ) { | |
| 366 | + /* | |
| 367 | + * Refused after all — a competitor that appeared between the | |
| 368 | + * profile decision and the write, or a drop-in we could not | |
| 369 | + * install. The settings are identical either way (everything | |
| 370 | + * off), so the honest record is the one that does not claim a | |
| 371 | + * cache: conflict-safe is what the site actually got. | |
| 372 | + */ | |
| 373 | + $profile = Settings::PROFILE_CONFLICT_SAFE; | |
| 374 | + update_option( 'xspeed_install_profile', $profile, false ); | |
| 375 | + } | |
| 376 | + } | |
| 377 | + | |
| 378 | + /* | |
| 379 | + * Read the claim BEFORE spending it. consume_installed_by() records | |
| 380 | + * the installer only for a FRESH install — on a re-activation over | |
| 381 | + * settings that are already there it deletes the arming option and | |
| 382 | + * keeps nothing — so asking again afterwards answered "the user did | |
| 383 | + * it" about an install a host had just claimed, and the wizard opened | |
| 384 | + * over the host's own flow. The claim decides who to tell and whether | |
| 385 | + * to open the wizard; whether it is worth RECORDING is a separate | |
| 386 | + * question, and only the recording depends on the install being fresh. | |
| 387 | + */ | |
| 388 | + $installed_by = Settings::installed_by(); | |
| 389 | + | |
| 390 | + // Spend the arming option now the profile is settled. It changes what | |
| 391 | + // activation does, so it may not survive into the next one. | |
| 392 | + Settings::consume_installed_by( $profile ); | |
| 393 | + | |
| 394 | + // Caching is otherwise only ENABLED from the admin UI — see | |
| 395 | + // Cache::toggle() and Rest_Api::toggle_cache(). A fresh install | |
| 396 | + // therefore gets no drop-in and no wp-config.php edit here: | |
| 397 | + // cache_enabled is unset, so the call below is a no-op. | |
| 235 | 398 | // |
| 236 | 399 | // It is NOT a no-op during an upgrade. WordPress runs an update as |
| 237 | 400 | // deactivate → wipe files → install → activate, which deletes |
| 238 | 401 | // advanced-cache.php while cache_enabled stays true. Restoring it |
| @@ -239,16 +402,41 @@ | ||
| 239 | 402 | // here closes the window in which the site silently serves uncached |
| 240 | 403 | // (auto_heal() alone only fires on the next wp-admin page load). |
| 241 | 404 | Cache::restore_dropin_if_enabled(); |
| 242 | 405 | |
| 243 | - // First-run wizard: flag a one-time redirect for the activating user. | |
| 244 | - // Suppressed for bulk activations / already-completed sites in | |
| 245 | - // Onboarding::maybe_redirect(). | |
| 246 | - Onboarding::flag_redirect(); | |
| 406 | + /* | |
| 407 | + * First-run wizard: flag a one-time redirect for the activating user. | |
| 408 | + * Suppressed for bulk activations / already-completed sites in | |
| 409 | + * Onboarding::maybe_redirect() — and here for an install another plugin | |
| 410 | + * performed, which has an onboarding flow of its own. The install runs | |
| 411 | + * over AJAX, so our redirect would fire on that admin's NEXT page load | |
| 412 | + * and pull them out of the middle of the host's wizard; finishing ours | |
| 413 | + * would then overwrite the deliberately all-off profile they never | |
| 414 | + * asked to change. | |
| 415 | + */ | |
| 416 | + if ( '' === $installed_by ) { | |
| 417 | + Onboarding::flag_redirect(); | |
| 418 | + } | |
| 247 | 419 | |
| 248 | - // Propagate activation to every registered Module. Activation | |
| 249 | - // happens after plugins_loaded → modules are already registered. | |
| 420 | + // Propagate activation to every registered Module — registered by | |
| 421 | + // ensure_modules_registered() at the top, not by plugins_loaded, | |
| 422 | + // which fired before this file was even included. | |
| 250 | 423 | Module_Registry::activate_all(); |
| 424 | + | |
| 425 | + /** | |
| 426 | + * Fires at the end of activation, once the settings profile is decided. | |
| 427 | + * | |
| 428 | + * The other half of the host-plugin contract: a plugin that installed | |
| 429 | + * xSpeed for the user writes `xspeed_installed_by` before activating | |
| 430 | + * and listens here to find out how it came up. It carries no return | |
| 431 | + * value and nothing branches on it — a host that ignores it changes | |
| 432 | + * nothing about the install. | |
| 433 | + * | |
| 434 | + * @param string $installed_by Host slug, or '' when the user did it. | |
| 435 | + * @param string $profile Settings::PROFILE_* — which profile a fresh | |
| 436 | + * install came up with, '' if not fresh. | |
| 437 | + */ | |
| 438 | + do_action( 'xspeed_activated', $installed_by, $profile ); | |
| 251 | 439 | } |
| 252 | 440 | |
| 253 | 441 | /** |
| 254 | 442 | * Restore the cache drop-in right after THIS plugin is updated. |
