| @@ -48,8 +48,126 @@ | ||
| 48 | 48 | const DEFAULT_GEMINI_MODEL = 'gemini-3.5-flash'; |
| 49 | 49 | const DEFAULT_OPENROUTER_MODEL = 'openai/gpt-4o-mini'; |
| 50 | 50 | |
| 51 | 51 | /** |
| 52 | + * Default request timeout for the OpenAI-compatible provider, in seconds. | |
| 53 | + * | |
| 54 | + * Deliberately higher than the 120s the hosted providers get: a local model | |
| 55 | + * on CPU routinely takes minutes for a content brief, and a timeout there | |
| 56 | + * is never retried (see OpenAI_Client::request_with_retry()). | |
| 57 | + * | |
| 58 | + * @since 2.8.0 | |
| 59 | + */ | |
| 60 | + const DEFAULT_OPENAI_COMPATIBLE_TIMEOUT = 120; | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * Canonical default author-archive templates. | |
| 64 | + * | |
| 65 | + * Same single-source-of-truth rule as the model constants above: the | |
| 66 | + * defaults array, the REST endpoint, the get-settings ability and | |
| 67 | + * Author_Archives_Manager all read these instead of repeating the literal, | |
| 68 | + * which had already drifted — the title default hardcoded an en dash while | |
| 69 | + * the feature resolves %separator% from Site Identity (#318). | |
| 70 | + * | |
| 71 | + * @since 1.29.1 | |
| 72 | + */ | |
| 73 | + /** | |
| 74 | + * AI providers this plugin supports. | |
| 75 | + * | |
| 76 | + * Single source of truth for the REST enum, the connection test's dispatch | |
| 77 | + * and sanitize_setting(), so the three cannot disagree about what is legal. | |
| 78 | + * | |
| 79 | + * @since 2.2.0 | |
| 80 | + * @var string[] | |
| 81 | + */ | |
| 82 | + public const SUPPORTED_AI_PROVIDERS = ['openai', 'claude', 'gemini', 'openrouter', 'openai_compatible']; | |
| 83 | + | |
| 84 | + /** | |
| 85 | + * The stored value meaning "the user has not chosen a provider yet". | |
| 86 | + * | |
| 87 | + * A fresh install ships with no provider selected: picking one is the | |
| 88 | + * user's call, and pre-selecting OpenAI made the settings screen open with | |
| 89 | + * a warning about a missing key for a provider nobody had asked for (#572). | |
| 90 | + * Every write path accepts this alongside SUPPORTED_AI_PROVIDERS. | |
| 91 | + * | |
| 92 | + * @since 2.1.3 | |
| 93 | + */ | |
| 94 | + public const AI_PROVIDER_NONE = ''; | |
| 95 | + | |
| 96 | + /** | |
| 97 | + * One-time marker for {@see Settings::retire_seeded_ai_provider()}. | |
| 98 | + */ | |
| 99 | + private const PROVIDER_MIGRATION_OPTION = 'thinkrank_ai_provider_migration'; | |
| 100 | + private const PROVIDER_MIGRATION_VERSION = '1'; | |
| 101 | + | |
| 102 | + /** | |
| 103 | + * Legal values for the `ai_provider` setting, including "not chosen". | |
| 104 | + * | |
| 105 | + * @since 2.1.3 | |
| 106 | + * @return string[] | |
| 107 | + */ | |
| 108 | + public static function selectable_ai_providers(): array { | |
| 109 | + return array_merge([self::AI_PROVIDER_NONE], self::SUPPORTED_AI_PROVIDERS); | |
| 110 | + } | |
| 111 | + | |
| 112 | + /** | |
| 113 | + * Is the selected AI provider configured well enough to run a request? | |
| 114 | + * | |
| 115 | + * One answer for the whole plugin. The admin menu notice, the metabox | |
| 116 | + * "Generate with AI" button and every generator used to ask their own | |
| 117 | + * version of this as an inline OR over the API key settings, which the | |
| 118 | + * OpenAI-compatible provider invalidates: a local Ollama or LM Studio | |
| 119 | + * server has no key and is configured by base URL + model id (#721). | |
| 120 | + * | |
| 121 | + * Provider-aware on purpose. A stored key for a provider the site did not | |
| 122 | + * select never made AI features work, so counting it only produced enabled | |
| 123 | + * buttons that fail on click. | |
| 124 | + * | |
| 125 | + * @since 2.8.0 | |
| 126 | + * | |
| 127 | + * @return bool | |
| 128 | + */ | |
| 129 | + public function has_ai_provider_configured(): bool { | |
| 130 | + $provider = (string) $this->get('ai_provider', self::AI_PROVIDER_NONE); | |
| 131 | + | |
| 132 | + if (self::AI_PROVIDER_NONE === $provider) { | |
| 133 | + return false; | |
| 134 | + } | |
| 135 | + | |
| 136 | + if ('openai_compatible' === $provider) { | |
| 137 | + return '' !== trim((string) $this->get('openai_compatible_base_url', '')) | |
| 138 | + && '' !== trim((string) $this->get('openai_compatible_model', '')); | |
| 139 | + } | |
| 140 | + | |
| 141 | + return !empty($this->get($provider . '_api_key')); | |
| 142 | + } | |
| 143 | + | |
| 144 | + const DEFAULT_AUTHOR_ARCHIVES_TITLE = '%author_name% %separator% %site_title% %page%'; | |
| 145 | + const DEFAULT_AUTHOR_ARCHIVES_META_DESC = 'Articles written by %author_name% on %site_title%'; | |
| 146 | + | |
| 147 | + /** | |
| 148 | + * String settings where a stored empty string is a real value, not "unset". | |
| 149 | + * | |
| 150 | + * get() normally treats '' the same as a missing option and returns the | |
| 151 | + * default, which is right for most keys — a blank API key or model name is | |
| 152 | + * never what the user meant. For these template fields it is the opposite: | |
| 153 | + * clearing the box means "render no template", and the consumers already | |
| 154 | + * branch on an empty value. Without the opt-out the save appeared to | |
| 155 | + * succeed and the default reappeared on the next request (#316). | |
| 156 | + * | |
| 157 | + * @since 1.29.1 | |
| 158 | + * @var string[] | |
| 159 | + */ | |
| 160 | + private const EMPTY_IS_A_VALUE = [ | |
| 161 | + 'author_archives_title', | |
| 162 | + 'author_archives_meta_desc', | |
| 163 | + // '' is the "no provider chosen" state, not "fall back to the default". | |
| 164 | + // Without this, deselecting a provider would be undone by any caller | |
| 165 | + // that passes its own fallback to get() (#572). | |
| 166 | + 'ai_provider', | |
| 167 | + ]; | |
| 168 | + | |
| 169 | + /** | |
| 52 | 170 | * Shared singleton instance |
| 53 | 171 | * |
| 54 | 172 | * @var Settings|null |
| 55 | 173 | */ |
| @@ -98,9 +216,9 @@ | ||
| 98 | 216 | * @var array |
| 99 | 217 | */ |
| 100 | 218 | private array $defaults = [ |
| 101 | 219 | // AI Settings |
| 102 | - 'ai_provider' => 'openai', | |
| 220 | + 'ai_provider' => self::AI_PROVIDER_NONE, | |
| 103 | 221 | 'openai_api_key' => '', |
| 104 | 222 | 'openai_model' => self::DEFAULT_OPENAI_MODEL, |
| 105 | 223 | 'claude_api_key' => '', |
| 106 | 224 | 'claude_model' => self::DEFAULT_CLAUDE_MODEL, // Recommended default (best speed/quality balance) |
| @@ -107,8 +225,18 @@ | ||
| 107 | 225 | 'gemini_api_key' => '', |
| 108 | 226 | 'gemini_model' => self::DEFAULT_GEMINI_MODEL, |
| 109 | 227 | 'openrouter_api_key' => '', |
| 110 | 228 | 'openrouter_model' => self::DEFAULT_OPENROUTER_MODEL, |
| 229 | + // OpenAI-compatible endpoint (Ollama, LM Studio, vLLM, Azure OpenAI, | |
| 230 | + // Groq, a company gateway…). No default URL or model: this provider | |
| 231 | + // does nothing until the administrator names a server (#721). | |
| 232 | + 'openai_compatible_base_url' => '', | |
| 233 | + 'openai_compatible_api_key' => '', | |
| 234 | + 'openai_compatible_model' => '', | |
| 235 | + 'openai_compatible_timeout' => self::DEFAULT_OPENAI_COMPATIBLE_TIMEOUT, | |
| 236 | + 'openai_compatible_supports_images' => false, | |
| 237 | + 'openai_compatible_json_mode' => false, | |
| 238 | + 'openai_compatible_price_per_million' => 0.0, | |
| 111 | 239 | 'max_tokens' => 1000, |
| 112 | 240 | 'temperature' => 0.7, |
| 113 | 241 | |
| 114 | 242 | // Google API Keys (encrypted) |
| @@ -130,11 +258,17 @@ | ||
| 130 | 258 | 'ga_analytics_data_stream_id' => '', |
| 131 | 259 | |
| 132 | 260 | // Performance Settings |
| 133 | 261 | 'cache_duration' => 3600, |
| 134 | - 'max_requests_per_minute' => 10, | |
| 262 | + 'max_requests_per_minute' => 0, | |
| 135 | 263 | 'enable_logging' => true, |
| 136 | 264 | |
| 265 | + // AI spend controls (#448). Both are neutral by default so an upgrade | |
| 266 | + // changes nothing: 0 means no daily ceiling, and AI is not paused. | |
| 267 | + // Enforced by ThinkRank\AI\Spend_Guard at the provider HTTP boundary. | |
| 268 | + 'ai_daily_request_limit' => 0, | |
| 269 | + 'ai_paused' => false, | |
| 270 | + | |
| 137 | 271 | // Integration Settings |
| 138 | 272 | 'api_timeout' => 30, |
| 139 | 273 | 'enable_rate_limiting' => true, |
| 140 | 274 | 'auto_test_connections' => true, |
| @@ -156,43 +290,14 @@ | ||
| 156 | 290 | 'seo_score_threshold' => 70, |
| 157 | 291 | 'enable_meta_generation' => true, |
| 158 | 292 | 'enable_schema_markup' => true, |
| 159 | 293 | |
| 160 | - // Auto AI Optimization (on-publish metadata fill; #248 P1) | |
| 161 | - 'auto_ai_meta_enabled' => false, | |
| 162 | - 'auto_ai_meta_post_types' => ['post'], | |
| 163 | - | |
| 164 | - // Brand Visibility v2. The brand profile drives question generation | |
| 165 | - // and mention detection; per-platform keys let this feature query | |
| 166 | - // several assistants without changing the site-wide AI provider. | |
| 167 | - 'bv_brand_name' => '', | |
| 168 | - 'bv_variants' => [], | |
| 169 | - 'bv_location' => '', | |
| 170 | - 'bv_category' => '', | |
| 171 | - 'bv_description' => '', | |
| 172 | - 'bv_competitors' => [], | |
| 173 | - 'bv_queries' => [], | |
| 174 | - 'bv_platforms' => ['chatgpt'], | |
| 175 | - 'bv_samples' => 1, | |
| 176 | - 'bv_key_chatgpt' => '', | |
| 177 | - 'bv_key_gemini' => '', | |
| 178 | - 'bv_key_claude' => '', | |
| 179 | - 'bv_key_perplexity' => '', | |
| 180 | - // Empty = use the platform's default model (see Brand_Visibility_Providers). | |
| 181 | - 'bv_model_chatgpt' => '', | |
| 182 | - 'bv_model_gemini' => '', | |
| 183 | - 'bv_model_claude' => '', | |
| 184 | - 'bv_model_perplexity' => '', | |
| 185 | - | |
| 186 | - // AI Brand Visibility (BYO-key checks; #248 P1) | |
| 187 | - 'brand_visibility_queries' => [], | |
| 188 | - | |
| 189 | 294 | // Author Archives Settings |
| 190 | 295 | 'author_archives_enabled' => true, |
| 191 | 296 | 'author_archives_index' => true, |
| 192 | 297 | 'author_archives_show_empty' => false, |
| 193 | - 'author_archives_title' => '%author_name% – %site_title% %page%', | |
| 194 | - 'author_archives_meta_desc' => 'Articles written by %author_name% on %site_title%', | |
| 298 | + 'author_archives_title' => self::DEFAULT_AUTHOR_ARCHIVES_TITLE, | |
| 299 | + 'author_archives_meta_desc' => self::DEFAULT_AUTHOR_ARCHIVES_META_DESC, | |
| 195 | 300 | |
| 196 | 301 | // UI Settings |
| 197 | 302 | 'show_welcome_message' => true, |
| 198 | 303 | 'dashboard_widgets' => ['seo_score', 'ai_usage', 'recent_briefs'], |
| @@ -203,8 +308,16 @@ | ||
| 203 | 308 | 'retry_attempts' => 3, |
| 204 | 309 | // Exposes the standalone Migration admin page for re-running SEO data |
| 205 | 310 | // imports after setup. Hidden by default; opt-in for advanced/support use. |
| 206 | 311 | 'enable_migration_tools' => false, |
| 312 | + // Exposes ThinkRank's own export / restore. Off by default, like the | |
| 313 | + // migration toggle above: both are occasional, admin-only tools, and a | |
| 314 | + // menu item nobody asked for is a menu item in the way. Your data is | |
| 315 | + // never locked in — the switch is one click away in | |
| 316 | + // Settings > Import / Export, and turning it on immediately restores | |
| 317 | + // the screen and the menu item. Off hides the export card and, unless | |
| 318 | + // migration tools are on, the Import / Export menu item with it. | |
| 319 | + 'enable_import_export' => false, | |
| 207 | 320 | |
| 208 | 321 | // Privacy Settings |
| 209 | 322 | 'data_retention_days' => 90, |
| 210 | 323 | 'anonymize_logs' => true, |
| @@ -213,16 +326,8 @@ | ||
| 213 | 326 | // Integration Settings |
| 214 | 327 | 'google_analytics_id' => '', |
| 215 | 328 | 'search_console_property' => '', |
| 216 | 329 | |
| 217 | - // GA4 Tracking Settings | |
| 218 | - 'ga4_measurement_id' => '', | |
| 219 | - 'ga4_auto_inject' => false, | |
| 220 | - 'ga4_anonymize_ip' => false, | |
| 221 | - 'ga4_exclude_admin' => false, | |
| 222 | - 'ga4_tracking_verified' => false, | |
| 223 | - 'ga4_last_verification' => '', | |
| 224 | - | |
| 225 | 330 | // SEO Analytics Settings |
| 226 | 331 | 'seo_analytics_enabled' => false, |
| 227 | 332 | 'seo_analytics_setup_completed' => false, |
| 228 | 333 | 'seo_analytics_google_analytics_property_id' => '', |
| @@ -252,8 +357,9 @@ | ||
| 252 | 357 | 'openai_api_key', |
| 253 | 358 | 'claude_api_key', |
| 254 | 359 | 'gemini_api_key', |
| 255 | 360 | 'openrouter_api_key', |
| 361 | + 'openai_compatible_api_key', | |
| 256 | 362 | // Google API Keys |
| 257 | 363 | 'google_analytics_api_key', |
| 258 | 364 | 'google_search_console_api_key', |
| 259 | 365 | 'google_pagespeed_api_key', |
| @@ -271,11 +377,145 @@ | ||
| 271 | 377 | * @return void |
| 272 | 378 | */ |
| 273 | 379 | public function init(): void { |
| 274 | 380 | add_action('admin_init', [$this, 'register_settings']); |
| 381 | + // Every value below is read from THIS site's options, and the cache is | |
| 382 | + // keyed by setting name alone. On multisite a switch_to_blog() leaves | |
| 383 | + // the previous site's values sitting in it, so anything that switches | |
| 384 | + // reads the wrong site's configuration (#516). Nothing in the plugin | |
| 385 | + // switched blogs before the OAuth discovery resolver did, which is why | |
| 386 | + // this had never bitten. | |
| 387 | + // | |
| 388 | + // Registered against the CLASS, not $this. init() runs on the object in | |
| 389 | + // the component container, while every consumer reads through | |
| 390 | + // Settings::instance() — and those are not always the same object: a | |
| 391 | + // caller that resolves the singleton while load_components() is still | |
| 392 | + // building the array gets a standalone instance, which is then memoized | |
| 393 | + // for the rest of the request. Hooking $this there registers the flush | |
| 394 | + // on an object nobody reads through, which is exactly the shape of bug | |
| 395 | + // a source-scanning test cannot see. | |
| 396 | + add_action('switch_blog', [self::class, 'flush_instance_cache']); | |
| 397 | + // Admin-only: a front-end pageview can never need this migration, and | |
| 398 | + // the marker is a non-autoloaded option, so hooking it unconditionally | |
| 399 | + // bought one dedicated query on every request for the life of the | |
| 400 | + // install (#588). | |
| 401 | + if (is_admin()) { | |
| 402 | + add_action('init', [self::class, 'retire_seeded_ai_provider']); | |
| 403 | + } | |
| 275 | 404 | } |
| 276 | 405 | |
| 277 | 406 | /** |
| 407 | + * Drop every memoized setting value. | |
| 408 | + * | |
| 409 | + * Called on `switch_blog` so a blog switch cannot serve the previous | |
| 410 | + * site's configuration, and available to any caller that switches | |
| 411 | + * explicitly. Cheap: the next read repopulates from the options cache. | |
| 412 | + * | |
| 413 | + * @since 2.9.0 | |
| 414 | + * @return void | |
| 415 | + */ | |
| 416 | + public function flush_cache(): void { | |
| 417 | + $this->cache = []; | |
| 418 | + } | |
| 419 | + | |
| 420 | + /** | |
| 421 | + * Drop the memo on the instance consumers actually read through. | |
| 422 | + * | |
| 423 | + * Resolved at fire time rather than registration time, so it always acts on | |
| 424 | + * whatever Settings::instance() currently returns. | |
| 425 | + * | |
| 426 | + * @since 2.9.0 | |
| 427 | + * @return void | |
| 428 | + */ | |
| 429 | + public static function flush_instance_cache(): void { | |
| 430 | + self::instance()->flush_cache(); | |
| 431 | + } | |
| 432 | + | |
| 433 | + /** | |
| 434 | + * Clear the OpenAI selection that older versions seeded on activation. | |
| 435 | + * | |
| 436 | + * Changing the default only helps installs created after the change. Every | |
| 437 | + * site activated before it still carries `ai_provider = 'openai'` written by | |
| 438 | + * Activator::set_default_options(), and still opens Settings warning about a | |
| 439 | + * missing key for a provider nobody picked — the whole complaint in #572. | |
| 440 | + * | |
| 441 | + * "OpenAI with no OpenAI key" is provably not a user's choice: the settings | |
| 442 | + * form refuses to save a provider without a key, so the only way to reach | |
| 443 | + * that state is the old activation seed. A site that genuinely chose OpenAI | |
| 444 | + * has a key and is left alone, as is any site on another provider. | |
| 445 | + * | |
| 446 | + * Version-gated so it runs once and never fights a user who later clears | |
| 447 | + * their key but keeps the provider selected. | |
| 448 | + * | |
| 449 | + * @since 2.1.3 | |
| 450 | + * | |
| 451 | + * @return void | |
| 452 | + */ | |
| 453 | + public static function retire_seeded_ai_provider(): void { | |
| 454 | + if (get_option(self::PROVIDER_MIGRATION_OPTION) === self::PROVIDER_MIGRATION_VERSION) { | |
| 455 | + self::promote_migration_marker_to_autoload(); | |
| 456 | + return; | |
| 457 | + } | |
| 458 | + | |
| 459 | + // Record first: a site that somehow fails the checks below must not | |
| 460 | + // re-test on every request for the rest of its life. Autoloaded on | |
| 461 | + // purpose — it is a short write-once flag that is read on every admin | |
| 462 | + // request, which is exactly what autoload is for; storing it | |
| 463 | + // non-autoloaded bought a dedicated query per request instead (#588). | |
| 464 | + update_option(self::PROVIDER_MIGRATION_OPTION, self::PROVIDER_MIGRATION_VERSION, true); | |
| 465 | + | |
| 466 | + if (get_option('thinkrank_ai_provider', null) !== 'openai') { | |
| 467 | + return; | |
| 468 | + } | |
| 469 | + | |
| 470 | + // Read the stored option directly rather than through Settings::get(). | |
| 471 | + // Only emptiness matters here, and get() adds two things this decision | |
| 472 | + // must not depend on: a per-instance cache that may already be primed, | |
| 473 | + // and decryption that can yield '' for a key that is genuinely present. | |
| 474 | + // The raw option is non-empty whenever a key exists, encrypted or not. | |
| 475 | + if ('' !== (string) get_option('thinkrank_openai_api_key', '')) { | |
| 476 | + // A real choice, backed by a key. Leave it. | |
| 477 | + return; | |
| 478 | + } | |
| 479 | + | |
| 480 | + // Write through the shared instance, not a throwaway one: set() refreshes | |
| 481 | + // only the cache of the object it is called on, so a private instance | |
| 482 | + // would leave the registered component serving the old value for the | |
| 483 | + // rest of this request — including to the admin page it localizes. | |
| 484 | + self::instance()->set('ai_provider', self::AI_PROVIDER_NONE); | |
| 485 | + } | |
| 486 | + | |
| 487 | + /** | |
| 488 | + * Move a legacy migration marker into the autoloaded set. | |
| 489 | + * | |
| 490 | + * Sites that ran the migration on 2.1.3 wrote the marker with | |
| 491 | + * `autoload = false`, and the version gate above returns before the write | |
| 492 | + * that would correct it — so those installs keep paying a dedicated query | |
| 493 | + * to read a one-byte flag on every admin request, which is the cost #588 | |
| 494 | + * was about. Promote it once. | |
| 495 | + * | |
| 496 | + * Free to test: alloptions is loaded from the object cache once per request | |
| 497 | + * regardless, and an autoloaded marker is in it, so the steady state after | |
| 498 | + * the promotion is a cache lookup and nothing else. wp_set_option_autoload() | |
| 499 | + * arrived in WP 6.4 and the plugin supports 6.0, hence the guard. | |
| 500 | + * | |
| 501 | + * @since 2.2.0 | |
| 502 | + * | |
| 503 | + * @return void | |
| 504 | + */ | |
| 505 | + private static function promote_migration_marker_to_autoload(): void { | |
| 506 | + if (!function_exists('wp_set_option_autoload') || !function_exists('wp_load_alloptions')) { | |
| 507 | + return; | |
| 508 | + } | |
| 509 | + | |
| 510 | + if (array_key_exists(self::PROVIDER_MIGRATION_OPTION, wp_load_alloptions())) { | |
| 511 | + return; | |
| 512 | + } | |
| 513 | + | |
| 514 | + wp_set_option_autoload(self::PROVIDER_MIGRATION_OPTION, true); | |
| 515 | + } | |
| 516 | + | |
| 517 | + /** | |
| 278 | 518 | * Register WordPress settings |
| 279 | 519 | * |
| 280 | 520 | * @return void |
| 281 | 521 | */ |
| @@ -286,16 +526,55 @@ | ||
| 286 | 526 | ]); |
| 287 | 527 | } |
| 288 | 528 | |
| 289 | 529 | /** |
| 530 | + * Warm the option cache for a batch of setting keys in one query. | |
| 531 | + * | |
| 532 | + * Every `thinkrank_*` option is autoload=off, so WordPress cannot serve | |
| 533 | + * them from `alloptions` and each get() below is its own round-trip. A | |
| 534 | + * caller that reads a known list of keys should prime it first: on a | |
| 535 | + * ~1ms managed-hosting round-trip, sixteen of those on an anonymous | |
| 536 | + * pageview is ~16ms spent on values the page may not use (#393). | |
| 537 | + * | |
| 538 | + * get() memoizes within the request, so only the first read of each key | |
| 539 | + * ever reaches the database — this is what collapses those first reads. | |
| 540 | + * Keys already memoized are left out of the batch. | |
| 541 | + * | |
| 542 | + * wp_prime_option_caches() is WP 6.4+; the plugin supports 6.0, so an | |
| 543 | + * older site simply keeps the previous behaviour. | |
| 544 | + * | |
| 545 | + * @since 2.1.0 | |
| 546 | + * | |
| 547 | + * @param string[] $keys Setting keys, without the `thinkrank_` prefix. | |
| 548 | + * @return void | |
| 549 | + */ | |
| 550 | + public function prime(array $keys): void { | |
| 551 | + if (!function_exists('wp_prime_option_caches')) { | |
| 552 | + return; | |
| 553 | + } | |
| 554 | + | |
| 555 | + $unread = []; | |
| 556 | + | |
| 557 | + foreach ($keys as $key) { | |
| 558 | + if (!isset($this->cache[$key])) { | |
| 559 | + $unread[] = 'thinkrank_' . $key; | |
| 560 | + } | |
| 561 | + } | |
| 562 | + | |
| 563 | + if (!empty($unread)) { | |
| 564 | + wp_prime_option_caches($unread); | |
| 565 | + } | |
| 566 | + } | |
| 567 | + | |
| 568 | + /** | |
| 290 | 569 | * Get setting value |
| 291 | 570 | * |
| 292 | 571 | * @param string $key Setting key |
| 293 | - * @param mixed $default Default value | |
| 572 | + * @param mixed $fallback Default value | |
| 294 | 573 | * @param int $user_id User ID (0 for global, >0 for user-specific) |
| 295 | 574 | * @return mixed Setting value |
| 296 | 575 | */ |
| 297 | - public function get(string $key, $default = null, int $user_id = 0) { | |
| 576 | + public function get(string $key, $fallback = null, int $user_id = 0) { | |
| 298 | 577 | // Check cache first |
| 299 | 578 | $cache_key = $user_id > 0 ? "user_{$user_id}_{$key}" : $key; |
| 300 | 579 | |
| 301 | 580 | if (isset($this->cache[$cache_key])) { |
| @@ -325,15 +604,25 @@ | ||
| 325 | 604 | // Empty string exists in DB, this likely means false was stored |
| 326 | 605 | $value = false; |
| 327 | 606 | } else { |
| 328 | 607 | // Option doesn't exist, use default |
| 329 | - $value = $default ?? $this->defaults[$key]; | |
| 608 | + $value = $fallback ?? $this->defaults[$key]; | |
| 330 | 609 | } |
| 331 | 610 | } |
| 332 | 611 | } else { |
| 333 | - // Non-boolean settings: use default if not found | |
| 334 | - if (null === $value || '' === $value) { | |
| 335 | - $value = $default ?? ($this->defaults[$key] ?? null); | |
| 612 | + // Non-boolean settings: use default if not found. | |
| 613 | + // | |
| 614 | + // get_option() above is called with a null default, so null means | |
| 615 | + // "no row" while '' means a value was deliberately stored. For most | |
| 616 | + // keys we collapse the two — an empty string is treated as unset so | |
| 617 | + // the documented default applies. Keys in EMPTY_IS_A_VALUE opt out: | |
| 618 | + // there, clearing the field is a real choice the consumer honours, | |
| 619 | + // and folding it back into the default made the save look like it | |
| 620 | + // silently failed (#316). | |
| 621 | + $empty_is_unset = !in_array($key, self::EMPTY_IS_A_VALUE, true); | |
| 622 | + | |
| 623 | + if (null === $value || ($empty_is_unset && '' === $value)) { | |
| 624 | + $value = $fallback ?? ($this->defaults[$key] ?? null); | |
| 336 | 625 | } |
| 337 | 626 | } |
| 338 | 627 | |
| 339 | 628 | // Cache the value |
| @@ -355,10 +644,14 @@ | ||
| 355 | 644 | if (!array_key_exists($key, $this->defaults)) { |
| 356 | 645 | return false; |
| 357 | 646 | } |
| 358 | 647 | |
| 648 | + // Apply the declared per-key sanitizer before anything is stored. This | |
| 649 | + // is the path essentially every caller takes, so skipping it left the | |
| 650 | + // whole sanitize_setting() switch unreachable — max_tokens, | |
| 651 | + // cache_duration and temperature persisted whatever string arrived. | |
| 652 | + $value = $this->sanitize_setting($key, $value); | |
| 359 | 653 | |
| 360 | - | |
| 361 | 654 | // Encrypt if needed |
| 362 | 655 | $encrypted_value = $this->maybe_encrypt($key, $value); |
| 363 | 656 | |
| 364 | 657 | // Save to WordPress options or user meta |
| @@ -384,10 +677,15 @@ | ||
| 384 | 677 | } |
| 385 | 678 | |
| 386 | 679 | // Verify value actually saved (update_option returns false when unchanged) |
| 387 | 680 | $saved_value = get_option($option_name, 'NOT_FOUND'); |
| 681 | + // The loose branch is load-bearing: get_option() returns the stored | |
| 682 | + // STRING ('1', '0', '30') while $encrypted_value may be the original | |
| 683 | + // bool/int. On an unchanged re-save update_option() returns false, so | |
| 684 | + // this comparison is the only thing that marks the save successful — | |
| 685 | + // strict-only here made every unchanged-boolean re-save report failure. | |
| 388 | 686 | $values_match = ($saved_value === $encrypted_value) || |
| 389 | - ($saved_value == $encrypted_value && $encrypted_value !== 'NOT_FOUND'); | |
| 687 | + ($saved_value == $encrypted_value && $encrypted_value !== 'NOT_FOUND'); // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual -- intentional type-tolerant verify, see above. | |
| 390 | 688 | |
| 391 | 689 | // Consider it successful if the value was saved correctly |
| 392 | 690 | $result = $result || $values_match; |
| 393 | 691 | } |
| @@ -434,8 +732,23 @@ | ||
| 434 | 732 | return $result; |
| 435 | 733 | } |
| 436 | 734 | |
| 437 | 735 | /** |
| 736 | + * Setting keys whose values are encrypted at rest. | |
| 737 | + * | |
| 738 | + * Exposed so callers that must never emit a credential — the data exporter | |
| 739 | + * in particular — can filter against the same list this class encrypts | |
| 740 | + * with, instead of keeping a copy that silently drifts when a key is added. | |
| 741 | + * | |
| 742 | + * @since 2.2.0 | |
| 743 | + * | |
| 744 | + * @return string[] Setting keys. | |
| 745 | + */ | |
| 746 | + public function get_encrypted_keys(): array { | |
| 747 | + return $this->encrypted_keys; | |
| 748 | + } | |
| 749 | + | |
| 750 | + /** | |
| 438 | 751 | * Get all settings (optimized with bulk caching) |
| 439 | 752 | * |
| 440 | 753 | * @param int $user_id User ID (0 for global) |
| 441 | 754 | * @return array All settings |
| @@ -502,8 +815,44 @@ | ||
| 502 | 815 | return $sanitized; |
| 503 | 816 | } |
| 504 | 817 | |
| 505 | 818 | /** |
| 819 | + * Sanitize a nested array, preserving its shape. | |
| 820 | + * | |
| 821 | + * Scalars keep their type (an int threshold stays an int); strings are | |
| 822 | + * text-sanitized; objects are dropped, since no setting stores one. | |
| 823 | + * | |
| 824 | + * @since 2.2.0 | |
| 825 | + * @param array $value Array to sanitize. | |
| 826 | + * @param int $depth Current recursion depth. | |
| 827 | + * @return array | |
| 828 | + */ | |
| 829 | + private function sanitize_array_recursive(array $value, int $depth = 0): array { | |
| 830 | + // Settings are configuration, not arbitrary payloads; a cap keeps a | |
| 831 | + // malformed deep structure from recursing without bound. | |
| 832 | + if ($depth > 10) { | |
| 833 | + return []; | |
| 834 | + } | |
| 835 | + | |
| 836 | + $sanitized = []; | |
| 837 | + foreach ($value as $item_key => $item) { | |
| 838 | + $key = is_string($item_key) ? sanitize_key($item_key) : $item_key; | |
| 839 | + | |
| 840 | + if (is_array($item)) { | |
| 841 | + $sanitized[$key] = $this->sanitize_array_recursive($item, $depth + 1); | |
| 842 | + } elseif (is_object($item)) { | |
| 843 | + continue; | |
| 844 | + } elseif (is_bool($item) || is_int($item) || is_float($item)) { | |
| 845 | + $sanitized[$key] = $item; | |
| 846 | + } else { | |
| 847 | + $sanitized[$key] = sanitize_text_field((string) $item); | |
| 848 | + } | |
| 849 | + } | |
| 850 | + | |
| 851 | + return $sanitized; | |
| 852 | + } | |
| 853 | + | |
| 854 | + /** | |
| 506 | 855 | * Sanitize individual setting |
| 507 | 856 | * |
| 508 | 857 | * @param string $key Setting key |
| 509 | 858 | * @param mixed $value Setting value |
| @@ -509,22 +858,77 @@ | ||
| 509 | 858 | * @param mixed $value Setting value |
| 510 | 859 | * @return mixed Sanitized value |
| 511 | 860 | */ |
| 512 | 861 | private function sanitize_setting(string $key, $value) { |
| 862 | + // Only keys that are declared array-typed may receive an array. For a | |
| 863 | + // scalar key an array/object value is malformed input, and the scalar | |
| 864 | + // sanitizers below would fatal on it, so fall back to the declared | |
| 865 | + // default instead of letting the bad value through. | |
| 866 | + if (is_array($value) || is_object($value)) { | |
| 867 | + if (!is_array($this->defaults[$key] ?? null)) { | |
| 868 | + return $this->defaults[$key] ?? ''; | |
| 869 | + } | |
| 870 | + $value = (array) $value; | |
| 871 | + } | |
| 872 | + | |
| 513 | 873 | switch ($key) { |
| 514 | 874 | case 'openai_api_key': |
| 515 | 875 | case 'claude_api_key': |
| 516 | 876 | case 'gemini_api_key': |
| 517 | 877 | case 'openrouter_api_key': |
| 878 | + case 'openai_compatible_api_key': | |
| 518 | 879 | return sanitize_text_field($value); |
| 519 | 880 | |
| 881 | + case 'openai_compatible_base_url': | |
| 882 | + // Validation (scheme, SSRF guard) belongs to the write path that | |
| 883 | + // can report a reason to the user; a value that never went | |
| 884 | + // through it must not become a URL we fetch, so an invalid one | |
| 885 | + // is stored as empty — which disables the provider — rather | |
| 886 | + // than silently kept. | |
| 887 | + $url = esc_url_raw(trim((string) $value)); | |
| 888 | + if ('' === $url) { | |
| 889 | + return ''; | |
| 890 | + } | |
| 891 | + $validated = \ThinkRank\AI\Endpoint_URL_Validator::validate($url); | |
| 892 | + | |
| 893 | + return is_wp_error($validated) ? '' : $validated; | |
| 894 | + | |
| 895 | + case 'openai_compatible_timeout': | |
| 896 | + // Below 10s nothing local ever finishes; above 600s PHP-FPM | |
| 897 | + // kills the request first. | |
| 898 | + return max(10, min(600, absint($value))); | |
| 899 | + | |
| 900 | + case 'openai_compatible_price_per_million': | |
| 901 | + return max(0.0, (float) $value); | |
| 902 | + | |
| 903 | + case 'openai_compatible_supports_images': | |
| 904 | + case 'openai_compatible_json_mode': | |
| 905 | + // Each toggle decides whether we send a field (a vision | |
| 906 | + // payload, response_format) a server may reject, so coerce the '0'/'false' a form | |
| 907 | + // post can send rather than storing a truthy string (the | |
| 908 | + // default: arm keeps strings as strings, and '0' is truthy to | |
| 909 | + // nobody but PHP's loose rules). | |
| 910 | + if (is_string($value)) { | |
| 911 | + return !in_array(strtolower(trim($value)), ['', '0', 'false', 'no', 'off'], true); | |
| 912 | + } | |
| 913 | + | |
| 914 | + return (bool) $value; | |
| 915 | + | |
| 520 | 916 | case 'ai_provider': |
| 521 | - return sanitize_key($value); | |
| 917 | + // sanitize_key() maps '' to '', which is AI_PROVIDER_NONE — the | |
| 918 | + // deliberate "no provider chosen" state, so it must survive here | |
| 919 | + // rather than being folded back into the default (#572). | |
| 920 | + $provider = sanitize_key($value); | |
| 522 | 921 | |
| 922 | + return in_array($provider, self::selectable_ai_providers(), true) | |
| 923 | + ? $provider | |
| 924 | + : $this->defaults['ai_provider']; | |
| 925 | + | |
| 523 | 926 | case 'openai_model': |
| 524 | 927 | case 'claude_model': |
| 525 | 928 | case 'gemini_model': |
| 526 | 929 | case 'openrouter_model': |
| 930 | + case 'openai_compatible_model': | |
| 527 | 931 | // Model ids may contain dots and slashes (e.g. "gpt-4.1" or |
| 528 | 932 | // "openai/gpt-4o-mini") and users can enter custom models, so |
| 529 | 933 | // sanitize_key() would corrupt them — use text-field sanitizing. |
| 530 | 934 | return sanitize_text_field($value); |
| @@ -531,8 +935,9 @@ | ||
| 531 | 935 | |
| 532 | 936 | case 'max_tokens': |
| 533 | 937 | case 'cache_duration': |
| 534 | 938 | case 'max_requests_per_minute': |
| 939 | + case 'ai_daily_request_limit': | |
| 535 | 940 | case 'seo_score_threshold': |
| 536 | 941 | case 'api_timeout': |
| 537 | 942 | case 'retry_attempts': |
| 538 | 943 | case 'data_retention_days': |
| @@ -538,14 +943,48 @@ | ||
| 538 | 943 | case 'data_retention_days': |
| 539 | 944 | case 'monitoring_frequency': |
| 540 | 945 | return absint($value); |
| 541 | 946 | |
| 947 | + case 'ai_paused': | |
| 948 | + // The kill switch arrives from REST as a real boolean, from a | |
| 949 | + // form post as "1"/"0", and from WP-CLI as "true"/"false". The | |
| 950 | + // default arm's sanitize_text_field() would turn "false" into a | |
| 951 | + // truthy string and silently pause a site that asked to resume. | |
| 952 | + return rest_sanitize_boolean($value); | |
| 953 | + | |
| 542 | 954 | case 'temperature': |
| 543 | 955 | return (float) $value; |
| 544 | 956 | |
| 545 | 957 | case 'dashboard_widgets': |
| 958 | + return is_array($value) ? array_map('sanitize_key', $value) : []; | |
| 959 | + | |
| 546 | 960 | case 'seo_analytics_alert_thresholds': |
| 547 | - return is_array($value) ? array_map('sanitize_key', $value) : []; | |
| 961 | + // A threshold_name => value map where the values are numbers | |
| 962 | + // (e.g. traffic_drop_percentage => 20) as well as strings, so | |
| 963 | + // sanitize each value by its own type rather than forcing every | |
| 964 | + // one through sanitize_key() — that turned ints into strings. | |
| 965 | + if (!is_array($value)) { | |
| 966 | + return []; | |
| 967 | + } | |
| 968 | + $thresholds = []; | |
| 969 | + foreach ($value as $threshold_key => $threshold_value) { | |
| 970 | + if (is_array($threshold_value)) { | |
| 971 | + continue; | |
| 972 | + } | |
| 973 | + if (is_bool($threshold_value)) { | |
| 974 | + // Keep booleans as booleans. is_numeric() is false for | |
| 975 | + // one, so it used to fall to the string arm and a true | |
| 976 | + // came back as "1" — invisible while this ran only on | |
| 977 | + // the register_setting() path, now that set() routes | |
| 978 | + // every write through here it is a type change on save. | |
| 979 | + $thresholds[sanitize_key($threshold_key)] = $threshold_value; | |
| 980 | + continue; | |
| 981 | + } | |
| 982 | + $thresholds[sanitize_key($threshold_key)] = is_numeric($threshold_value) | |
| 983 | + ? $threshold_value + 0 | |
| 984 | + : sanitize_text_field((string) $threshold_value); | |
| 985 | + } | |
| 986 | + return $thresholds; | |
| 548 | 987 | |
| 549 | 988 | case 'google_analytics_property_id': |
| 550 | 989 | case 'seo_analytics_google_analytics_property_id': |
| 551 | 990 | case 'seo_analytics_report_schedule': |
| @@ -552,9 +991,12 @@ | ||
| 552 | 991 | return sanitize_text_field($value); |
| 553 | 992 | |
| 554 | 993 | case 'robots_txt_content': |
| 555 | 994 | // Multi-line content — sanitize_text_field() collapses newlines |
| 556 | - // and would flatten the whole file onto a single line. | |
| 995 | + // and would flatten the whole file onto a single line. set() | |
| 996 | + // routes every write through here, so a caller that chose | |
| 997 | + // sanitize_textarea_field() itself is otherwise silently | |
| 998 | + // overridden by the default: arm below (#587). | |
| 557 | 999 | return sanitize_textarea_field($value); |
| 558 | 1000 | |
| 559 | 1001 | default: |
| 560 | 1002 | if (is_bool($value)) { |
| @@ -561,9 +1003,14 @@ | ||
| 561 | 1003 | return (bool) $value; |
| 562 | 1004 | } elseif (is_string($value)) { |
| 563 | 1005 | return sanitize_text_field($value); |
| 564 | 1006 | } elseif (is_array($value)) { |
| 565 | - return array_map('sanitize_text_field', $value); | |
| 1007 | + // Recurse rather than drop. Skipping nested members was | |
| 1008 | + // harmless while this ran only on the register_setting() | |
| 1009 | + // path, but set() now routes every write through here, and | |
| 1010 | + // structured settings (lists of maps) were being silently | |
| 1011 | + // emptied on save. | |
| 1012 | + return $this->sanitize_array_recursive($value); | |
| 566 | 1013 | } |
| 567 | 1014 | return $value; |
| 568 | 1015 | } |
| 569 | 1016 | } |
| @@ -585,24 +1032,12 @@ | ||
| 585 | 1032 | private function maybe_encrypt(string $key, $value) { |
| 586 | 1033 | if (!in_array($key, $this->encrypted_keys, true) || !is_string($value) || '' === $value) { |
| 587 | 1034 | return $value; |
| 588 | 1035 | } |
| 589 | - if (!function_exists('sodium_crypto_secretbox')) { | |
| 590 | - return $value; // sodium unavailable — store as-is | |
| 591 | - } | |
| 592 | 1036 | |
| 593 | - $enc_key = $this->encryption_key(); | |
| 594 | - if ('' === $enc_key) { | |
| 595 | - return $value; | |
| 596 | - } | |
| 597 | - | |
| 598 | - try { | |
| 599 | - $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); | |
| 600 | - $cipher = sodium_crypto_secretbox($value, $nonce, $enc_key); | |
| 601 | - return self::ENC_PREFIX . base64_encode($nonce . $cipher); | |
| 602 | - } catch (\Exception $e) { | |
| 603 | - return $value; | |
| 604 | - } | |
| 1037 | + // Same scheme, same key, same prefix — it just lives in Secret_At_Rest | |
| 1038 | + // now so the MCP pairing token can use it too (#396). | |
| 1039 | + return Secret_At_Rest::encrypt($value); | |
| 605 | 1040 | } |
| 606 | 1041 | |
| 607 | 1042 | /** |
| 608 | 1043 | * Decrypt a value previously encrypted by maybe_encrypt. Values without the |
| @@ -615,27 +1050,12 @@ | ||
| 615 | 1050 | private function maybe_decrypt(string $key, $value) { |
| 616 | 1051 | if (!is_string($value) || strncmp($value, self::ENC_PREFIX, strlen(self::ENC_PREFIX)) !== 0) { |
| 617 | 1052 | return $value; // legacy plaintext or non-string |
| 618 | 1053 | } |
| 619 | - if (!function_exists('sodium_crypto_secretbox_open')) { | |
| 620 | - return $value; | |
| 621 | - } | |
| 622 | 1054 | |
| 623 | - $enc_key = $this->encryption_key(); | |
| 624 | - if ('' === $enc_key) { | |
| 625 | - return $value; | |
| 626 | - } | |
| 1055 | + $plain = Secret_At_Rest::decrypt($value); | |
| 627 | 1056 | |
| 628 | - $decoded = base64_decode(substr($value, strlen(self::ENC_PREFIX)), true); | |
| 629 | - if (false === $decoded || strlen($decoded) <= SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) { | |
| 630 | - return $value; | |
| 631 | - } | |
| 632 | - | |
| 633 | - $nonce = substr($decoded, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); | |
| 634 | - $cipher = substr($decoded, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); | |
| 635 | - $plain = sodium_crypto_secretbox_open($cipher, $nonce, $enc_key); | |
| 636 | - | |
| 637 | - if (false === $plain) { | |
| 1057 | + if ('' === $plain) { | |
| 638 | 1058 | // We reach here only when sodium is available and a key was |
| 639 | 1059 | // derivable, so this is a genuine failure: the auth salt changed |
| 640 | 1060 | // (config rotated, or the site was migrated without wp-config) or |
| 641 | 1061 | // the row is corrupt. The value is unrecoverable either way. |
| @@ -647,20 +1067,6 @@ | ||
| 647 | 1067 | return ''; |
| 648 | 1068 | } |
| 649 | 1069 | |
| 650 | 1070 | return $plain; |
| 651 | - } | |
| 652 | - | |
| 653 | - /** | |
| 654 | - * Derive a 32-byte encryption key from the site's auth salt. | |
| 655 | - * | |
| 656 | - * @return string Raw 32-byte key, or '' if salts are unavailable. | |
| 657 | - */ | |
| 658 | - private function encryption_key(): string { | |
| 659 | - if (!function_exists('wp_salt')) { | |
| 660 | - return ''; | |
| 661 | - } | |
| 662 | - // 32 raw bytes from a site-specific secret — SHA-256 output length | |
| 663 | - // matches SODIUM_CRYPTO_SECRETBOX_KEYBYTES. | |
| 664 | - return hash('sha256', 'thinkrank-settings|' . wp_salt('auth'), true); | |
| 665 | 1071 | } |
| 666 | 1072 | } |
