| 1 |
<?php |
| 2 |
/** |
| 3 |
* Main plugin bootstrap. |
| 4 |
* |
| 5 |
* @package XSpeed |
| 6 |
*/ |
| 7 |
|
| 8 |
namespace XSpeed; |
| 9 |
|
| 10 |
defined( 'ABSPATH' ) || exit; |
| 11 |
|
| 12 |
class Plugin { |
| 13 |
|
| 14 |
/** |
| 15 |
* Data-schema version for one-time migrations, independent of the |
| 16 |
* plugin version header. Bump when adding a step to maybe_upgrade(). |
| 17 |
*/ |
| 18 |
public const DATA_VERSION = '1.1.6'; |
| 19 |
|
| 20 |
private static $instance = null; |
| 21 |
|
| 22 |
/** @var Usage_Tracker|null */ |
| 23 |
private $usage_tracker = null; |
| 24 |
|
| 25 |
public static function instance() { |
| 26 |
if ( null === self::$instance ) { |
| 27 |
self::$instance = new self(); |
| 28 |
} |
| 29 |
return self::$instance; |
| 30 |
} |
| 31 |
|
| 32 |
public function init() { |
| 33 |
// v1 services that are NOT yet wrapped as Modules (Admin, Rest_Api, |
| 34 |
// Cache, Onboarding) are instantiated directly. Minifier is now |
| 35 |
// instantiated by MinifyModule::boot(); Gzip is purely static. |
| 36 |
new Admin(); |
| 37 |
new Rest_Api(); |
| 38 |
new Cache(); |
| 39 |
new Rest_Cache(); |
| 40 |
new Onboarding(); |
| 41 |
|
| 42 |
// Optional deactivation feedback survey on the Plugins screen. Admin |
| 43 |
// context only (its hooks are admin_enqueue_scripts / admin_footer / |
| 44 |
// wp_ajax). Sends nothing unless the user clicks "Submit & Deactivate". |
| 45 |
if ( is_admin() ) { |
| 46 |
new Deactivation_Feedback(); |
| 47 |
} |
| 48 |
|
| 49 |
// Opt-in usage analytics. Instantiating + init() only registers the |
| 50 |
// cron callback; NOTHING is collected or sent until the admin opts in |
| 51 |
// from the setup wizard (Onboarding wires the consent toggle to |
| 52 |
// Usage_Tracker::opt_in()). See class-usage-tracker.php privacy contract. |
| 53 |
$this->start_plugin_tracking(); |
| 54 |
|
| 55 |
// Auto-heal the cache drop-in + WP_CACHE constant when state |
| 56 |
// drifts. Scoped to admin_init only: filesystem writes belong in |
| 57 |
// an authenticated admin context, never on anonymous front-end |
| 58 |
// requests. The user already opted in (cache_enabled=true) — |
| 59 |
// this is a consistency check, not a new install path. First |
| 60 |
// admin page load after a plugin upgrade restores the state; |
| 61 |
// front-end then serves from cache on the next request. |
| 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' ) ); |
| 66 |
|
| 67 |
// Secondary net: restore as soon as an update completes, for the |
| 68 |
// cases where activate() does not re-run (bulk updates, auto-updates, |
| 69 |
// some host updaters). Best-effort by nature — this callback is only |
| 70 |
// registered when we were loaded in the request performing the |
| 71 |
// update, which is not guaranteed while WE are the plugin being |
| 72 |
// replaced. The restore in activate() is the primary guarantee; |
| 73 |
// auto_heal() on admin_init remains the backstop. |
| 74 |
add_action( 'upgrader_process_complete', array( $this, 'maybe_restore_after_update' ), 10, 2 ); |
| 75 |
|
| 76 |
// Per-post cache rules (Phase 3.4) — registers postmeta with |
| 77 |
// REST + meta box on edit screens. |
| 78 |
Cache_Meta_Box::boot(); |
| 79 |
|
| 80 |
// Phase 0 architecture — managers + Free modules. v1 services |
| 81 |
// (Cache/Minifier/Gzip) are NOT yet Modules; they'll be refactored |
| 82 |
// in a follow-up PR with parity tests. |
| 83 |
Conflict_Registry::boot(); |
| 84 |
|
| 85 |
// Register Free modules via the same action xspeed-pro uses, so |
| 86 |
// the bootstrap path is symmetric across tiers. |
| 87 |
add_action( 'xspeed_register_modules', array( $this, 'register_free_modules' ) ); |
| 88 |
|
| 89 |
// Fire the registration action + boot the registry at a LATER |
| 90 |
// plugins_loaded priority so add-on plugins (xspeed-pro, in |
| 91 |
// alphabetical order so it runs at default priority 10 AFTER |
| 92 |
// us, but any add-on loaded at plugins_loaded(< 20)) have a |
| 93 |
// chance to register their `xspeed_register_modules` callback |
| 94 |
// before we fire the action. |
| 95 |
// |
| 96 |
// Bug history: previously this fired inline from init() at |
| 97 |
// priority 10. xspeed-pro's plugins_loaded(15) hook then added |
| 98 |
// its register_pro_modules callback AFTER the action had |
| 99 |
// already fired — Pro modules never appeared in the registry. |
| 100 |
// Caught by the ProStatus sentinel module's integration test. |
| 101 |
add_action( 'plugins_loaded', array( $this, 'fire_module_lifecycle' ), 20 ); |
| 102 |
|
| 103 |
// One-time data migrations keyed on the stored version. Runs in |
| 104 |
// admin only — nothing here needs to touch a front-end request. |
| 105 |
if ( is_admin() ) { |
| 106 |
add_action( 'plugins_loaded', array( $this, 'maybe_upgrade' ), 21 ); |
| 107 |
} |
| 108 |
} |
| 109 |
|
| 110 |
/** |
| 111 |
* Run version-gated data migrations exactly once per upgrade. |
| 112 |
* |
| 113 |
* Keyed on `xspeed_data_version` rather than the plugin version header |
| 114 |
* so a migration can be added without forcing a release bump. |
| 115 |
*/ |
| 116 |
public function maybe_upgrade(): void { |
| 117 |
$current = (string) get_option( 'xspeed_data_version', '0' ); |
| 118 |
if ( version_compare( $current, self::DATA_VERSION, '>=' ) ) { |
| 119 |
return; |
| 120 |
} |
| 121 |
|
| 122 |
// 1.1.2 — strip credential values recorded by earlier versions' |
| 123 |
// settings change annotations (they're served by the trend endpoints). |
| 124 |
Activity_Log::redact_legacy_secrets(); |
| 125 |
|
| 126 |
// 1.1.4 — earlier versions cached a failed loopback as "gzip is not |
| 127 |
// active" for an hour, which showed up as a bogus server-config |
| 128 |
// warning. Drop the stale answer so the fixed probe re-runs instead |
| 129 |
// of the wrong verdict living on past the update (issue #18). |
| 130 |
delete_transient( 'xspeed_gzip_active' ); |
| 131 |
|
| 132 |
// 1.1.6 — a `/?s=<term>` request used to write its results page into |
| 133 |
// the static tree under the *searched-from* path, which for the usual |
| 134 |
// query-form search is `/`. The web server then served that results |
| 135 |
// page as the homepage to every visitor. The write is fixed in |
| 136 |
// Cache::store_static(), but an entry poisoned before the update |
| 137 |
// outlives it: nothing purges on upgrade, and the static serve path |
| 138 |
// never revalidates. Clear the tree once. The flat cache is keyed |
| 139 |
// correctly and is deliberately left alone. (issue #191) |
| 140 |
Cache::purge_static_tree(); |
| 141 |
|
| 142 |
update_option( 'xspeed_data_version', self::DATA_VERSION, false ); |
| 143 |
} |
| 144 |
|
| 145 |
/** |
| 146 |
* Phase 2 of plugin init: fire the registration action (collecting |
| 147 |
* Free + Pro + any third-party modules hooked into |
| 148 |
* `xspeed_register_modules`) and boot the registry. |
| 149 |
* |
| 150 |
* Runs at plugins_loaded(20) so every add-on that hooks at any |
| 151 |
* priority < 20 has time to register first. |
| 152 |
*/ |
| 153 |
public function fire_module_lifecycle(): void { |
| 154 |
/** |
| 155 |
* Action: xspeed_register_modules |
| 156 |
* |
| 157 |
* Free modules register at priority 10; xspeed-pro at priority |
| 158 |
* 20; site code can hook in between to inject custom modules. |
| 159 |
* Fires exactly once per request. |
| 160 |
*/ |
| 161 |
do_action( 'xspeed_register_modules' ); |
| 162 |
|
| 163 |
Module_Registry::boot_all(); |
| 164 |
} |
| 165 |
|
| 166 |
/** |
| 167 |
* Register the Free Modules shipped in this plugin. Add new module |
| 168 |
* registrations here. Pro plugin hooks the same action separately. |
| 169 |
*/ |
| 170 |
public function register_free_modules(): void { |
| 171 |
Module_Registry::register( new \XSpeed\Modules\Cache\CacheModule() ); |
| 172 |
Module_Registry::register( new \XSpeed\Modules\Health\HealthModule() ); |
| 173 |
// Settings — owns no settings itself; it's the CLI/MCP surface over |
| 174 |
// Settings_Manager. Registering it is what makes `xspeed settings` |
| 175 |
// exist, which is what keeps the curated get_settings/update_settings |
| 176 |
// tools in the MCP catalog. (#149/#153) |
| 177 |
Module_Registry::register( new \XSpeed\Modules\Settings\SettingsModule() ); |
| 178 |
// External performance scores (PSI / GTmetrix) — Free, off by |
| 179 |
// default. Rendered inside the Health host page's PageSpeed tab, so |
| 180 |
// it has no sidebar row of its own. |
| 181 |
Module_Registry::register( new \XSpeed\Modules\Score\ScoreModule() ); |
| 182 |
Module_Registry::register( new \XSpeed\Modules\Preloader\PreloaderModule() ); |
| 183 |
Module_Registry::register( new \XSpeed\Modules\Heartbeat\HeartbeatModule() ); |
| 184 |
Module_Registry::register( new \XSpeed\Modules\Minify\MinifyModule() ); |
| 185 |
Module_Registry::register( new \XSpeed\Modules\Gzip\GzipModule() ); |
| 186 |
Module_Registry::register( new \XSpeed\Modules\Lazy\LazyModule() ); |
| 187 |
Module_Registry::register( new \XSpeed\Modules\Bloat\BloatModule() ); |
| 188 |
Module_Registry::register( new \XSpeed\Modules\Database\DatabaseModule() ); |
| 189 |
Module_Registry::register( new \XSpeed\Modules\Cdn\CdnModule() ); |
| 190 |
Module_Registry::register( new \XSpeed\Modules\Cloudflare\CloudflareModule() ); |
| 191 |
Module_Registry::register( new \XSpeed\Modules\ObjectCache\ObjectCacheModule() ); |
| 192 |
Module_Registry::register( new \XSpeed\Modules\BrowserCache\BrowserCacheModule() ); |
| 193 |
// Advanced Cache — a Free container row that gathers the Pro |
| 194 |
// cache-coverage features (404 / search / feed / REST / rules / |
| 195 |
// maintenance) into one sidebar sub-item (FBS-83633). |
| 196 |
Module_Registry::register( new \XSpeed\Modules\CacheCoverage\CacheCoverageModule() ); |
| 197 |
Module_Registry::register( new \XSpeed\Modules\Fonts\FontsModule() ); |
| 198 |
Module_Registry::register( new \XSpeed\Modules\ResourceHints\ResourceHintsModule() ); |
| 199 |
// AI Privacy (GDPR off-switch) ships in Free even though every AI |
| 200 |
// *feature* is Pro — privacy is a right, not a paid tier. FEATURES.md |
| 201 |
// §AI row 6 mandates it. Without this registration the module was dead |
| 202 |
// code: no REST/settings surface, the promised off-switch unreachable |
| 203 |
// (FBS-83633 Bug 1). It carries its own cli_commands() so it satisfies |
| 204 |
// the CLI/MCP coverage guard once registered. |
| 205 |
Module_Registry::register( new \XSpeed\Modules\AIPrivacy\AIPrivacyModule() ); |
| 206 |
// Migration moved Pro → Free: it's an acquisition/onboarding feature |
| 207 |
// (detect a competing caching plugin, import its settings, switch over), |
| 208 |
// so it must work without a Pro license. Agency-scale extras (profiles, |
| 209 |
// bulk multisite, host presets) remain Pro. |
| 210 |
Module_Registry::register( new \XSpeed\Modules\Migration\MigrationModule() ); |
| 211 |
// Help & Support moved Pro → Free: a ticket link + read-only system |
| 212 |
// snapshot is onboarding/diagnostics, not a paid value-add, so every |
| 213 |
// user gets it. The snapshot degrades gracefully without Pro (Pro |
| 214 |
// version/license fields fall back to defaults via defined()/get_option). |
| 215 |
Module_Registry::register( new \XSpeed\Modules\Support\SupportModule() ); |
| 216 |
// MCP remote control (AI assistants) — Free. The plugin serves the |
| 217 |
// MCP protocol at the site's own /xspeed/mcp URL; the only gate is |
| 218 |
// the per-site connection token an admin mints via Connect. No |
| 219 |
// license, no hosted infra. See IMPLEMENTATION.md §17. |
| 220 |
Module_Registry::register( new \XSpeed\Modules\Mcp\McpModule() ); |
| 221 |
} |
| 222 |
|
| 223 |
/** |
| 224 |
* Boot the opt-in usage tracker. Registers the cron sender only; the send |
| 225 |
* itself is consent-gated inside Usage_Tracker. The instance is held so the |
| 226 |
* onboarding REST handler can flip consent via usage_tracker()->opt_in(). |
| 227 |
*/ |
| 228 |
public function start_plugin_tracking(): void { |
| 229 |
$this->usage_tracker = Usage_Tracker::get_instance( |
| 230 |
XSPEED_FILE, |
| 231 |
array( |
| 232 |
'opt_in' => true, |
| 233 |
'item_id' => defined( 'XSPEED_INSIGHTS_ITEM_ID' ) ? XSPEED_INSIGHTS_ITEM_ID : false, |
| 234 |
) |
| 235 |
); |
| 236 |
$this->usage_tracker->init(); |
| 237 |
} |
| 238 |
|
| 239 |
/** |
| 240 |
* The shared Usage_Tracker singleton (or null if tracking wasn't booted, |
| 241 |
* e.g. on the activation hook before init() runs). |
| 242 |
*/ |
| 243 |
public function usage_tracker(): ?Usage_Tracker { |
| 244 |
return $this->usage_tracker; |
| 245 |
} |
| 246 |
|
| 247 |
public static function activate() { |
| 248 |
Settings::set_defaults(); |
| 249 |
|
| 250 |
// Score history table. Also called on admin_init (see init()) because |
| 251 |
// activation does not fire for a site added to a multisite network |
| 252 |
// later, nor after an update that ships a new schema version. |
| 253 |
Score_Store::maybe_install(); |
| 254 |
|
| 255 |
if ( ! file_exists( XSPEED_CACHE_DIR ) ) { |
| 256 |
wp_mkdir_p( XSPEED_CACHE_DIR ); |
| 257 |
} |
| 258 |
Cache::write_silence( XSPEED_CACHE_DIR ); |
| 259 |
|
| 260 |
// Caching is only ever ENABLED from the admin UI — see Cache::toggle() |
| 261 |
// and Rest_Api::toggle_cache(). A fresh install therefore gets no |
| 262 |
// drop-in and no wp-config.php edit here: cache_enabled is unset, so |
| 263 |
// the call below is a no-op. |
| 264 |
// |
| 265 |
// It is NOT a no-op during an upgrade. WordPress runs an update as |
| 266 |
// deactivate → wipe files → install → activate, which deletes |
| 267 |
// advanced-cache.php while cache_enabled stays true. Restoring it |
| 268 |
// here closes the window in which the site silently serves uncached |
| 269 |
// (auto_heal() alone only fires on the next wp-admin page load). |
| 270 |
Cache::restore_dropin_if_enabled(); |
| 271 |
|
| 272 |
// First-run wizard: flag a one-time redirect for the activating user. |
| 273 |
// Suppressed for bulk activations / already-completed sites in |
| 274 |
// Onboarding::maybe_redirect(). |
| 275 |
Onboarding::flag_redirect(); |
| 276 |
|
| 277 |
// Propagate activation to every registered Module. Activation |
| 278 |
// happens after plugins_loaded → modules are already registered. |
| 279 |
Module_Registry::activate_all(); |
| 280 |
} |
| 281 |
|
| 282 |
/** |
| 283 |
* Restore the cache drop-in right after THIS plugin is updated. |
| 284 |
* |
| 285 |
* Bound to upgrader_process_complete. Bulk updates, auto-updates and |
| 286 |
* host-level updaters finish without re-running activate(), so this is |
| 287 |
* the only hook that repairs the drop-in before the next wp-admin page |
| 288 |
* load. Narrow by design: bails unless the completed action was a |
| 289 |
* plugin update whose payload actually includes xspeed. |
| 290 |
* |
| 291 |
* @param \WP_Upgrader $upgrader Upgrader instance (unused). |
| 292 |
* @param array $hook_extra Contextual data about the update. |
| 293 |
* @return void |
| 294 |
*/ |
| 295 |
public function maybe_restore_after_update( $upgrader, $hook_extra ) { |
| 296 |
unset( $upgrader ); |
| 297 |
|
| 298 |
if ( ! is_array( $hook_extra ) ) { |
| 299 |
return; |
| 300 |
} |
| 301 |
if ( ! isset( $hook_extra['type'], $hook_extra['action'] ) ) { |
| 302 |
return; |
| 303 |
} |
| 304 |
if ( 'plugin' !== $hook_extra['type'] || 'update' !== $hook_extra['action'] ) { |
| 305 |
return; |
| 306 |
} |
| 307 |
|
| 308 |
// Single update uses 'plugin'; bulk uses 'plugins'. |
| 309 |
$updated = array(); |
| 310 |
if ( isset( $hook_extra['plugins'] ) && is_array( $hook_extra['plugins'] ) ) { |
| 311 |
$updated = $hook_extra['plugins']; |
| 312 |
} elseif ( isset( $hook_extra['plugin'] ) && is_string( $hook_extra['plugin'] ) ) { |
| 313 |
$updated = array( $hook_extra['plugin'] ); |
| 314 |
} |
| 315 |
|
| 316 |
$ours = plugin_basename( XSPEED_FILE ); |
| 317 |
if ( ! in_array( $ours, $updated, true ) ) { |
| 318 |
return; |
| 319 |
} |
| 320 |
|
| 321 |
Cache::restore_dropin_if_enabled(); |
| 322 |
} |
| 323 |
|
| 324 |
public static function deactivate() { |
| 325 |
// Drop-in + WP_CACHE constant are NOT touched here. WordPress |
| 326 |
// upgrades run as deactivate → wipe files → install → activate, |
| 327 |
// so removing those artifacts on every deactivate would silently |
| 328 |
// disable caching after each plugin update. uninstall.php |
| 329 |
// handles full teardown when the user actually removes the |
| 330 |
// plugin; auto_heal() restores state on the next admin_init if |
| 331 |
// the drop-in or WP_CACHE went missing for any other reason. |
| 332 |
Cache::purge_all(); |
| 333 |
Minifier::purge_minified(); |
| 334 |
Gzip::apply( false ); |
| 335 |
|
| 336 |
Module_Registry::deactivate_all(); |
| 337 |
} |
| 338 |
} |
| 339 |
|
