| 1 |
<?php |
| 2 |
// If this file is called directly, abort. |
| 3 |
if (!defined('ABSPATH')) { |
| 4 |
exit; |
| 5 |
} |
| 6 |
|
| 7 |
/** |
| 8 |
* This class handles the Otto Pixel Functions |
| 9 |
*/ |
| 10 |
Class Metasync_otto_pixel{ |
| 11 |
|
| 12 |
#otto html class |
| 13 |
public $o_html; |
| 14 |
|
| 15 |
# crawl data option |
| 16 |
public $option_name = 'metasync_otto_crawldata'; |
| 17 |
|
| 18 |
# no cache wp pages |
| 19 |
public $no_cache_pages = ['wp-login.php']; |
| 20 |
|
| 21 |
# OTTO UUID |
| 22 |
private $otto_uuid; |
| 23 |
|
| 24 |
# |
| 25 |
function __construct($otto_uuid){ |
| 26 |
|
| 27 |
# store the UUID |
| 28 |
$this->otto_uuid = $otto_uuid; |
| 29 |
|
| 30 |
# load the html class |
| 31 |
$this->o_html = new Metasync_otto_html($otto_uuid); |
| 32 |
|
| 33 |
} |
| 34 |
|
| 35 |
# method to handle cache refresh |
| 36 |
# NOTE: Cache system removed - always process in real-time |
| 37 |
function refresh_cache($route){ |
| 38 |
# No-op: Cache system has been removed |
| 39 |
# All pages are processed in real-time from OTTO API |
| 40 |
return true; |
| 41 |
} |
| 42 |
|
| 43 |
|
| 44 |
# method to save crawl data into |
| 45 |
function save_crawl_data($data){ |
| 46 |
|
| 47 |
# get the option name |
| 48 |
$option_name = $this->option_name; |
| 49 |
|
| 50 |
# handle data |
| 51 |
$saved = get_option($option_name); |
| 52 |
|
| 53 |
# log saved |
| 54 |
|
| 55 |
# if saved false save |
| 56 |
if(empty($saved['urls'])){ |
| 57 |
|
| 58 |
# save the option |
| 59 |
update_option($option_name, $data); |
| 60 |
|
| 61 |
return; |
| 62 |
} |
| 63 |
|
| 64 |
# get new unique list of urls |
| 65 |
$new_list = array_unique(array_merge($data['urls'], $saved['urls'])); |
| 66 |
|
| 67 |
# set data |
| 68 |
$data['urls'] = $new_list; |
| 69 |
|
| 70 |
# log saved |
| 71 |
|
| 72 |
# save the option |
| 73 |
update_option($option_name, $data); |
| 74 |
} |
| 75 |
|
| 76 |
/** |
| 77 |
* Check if a URL has been crawled by Otto |
| 78 |
* - Validates domain against saved domain |
| 79 |
* - Ignores query strings |
| 80 |
* - Does exact path matching as Otto stores paths exactly as they appear |
| 81 |
* @param string $url - Full URL to check |
| 82 |
* @return bool - True if URL was crawled, false otherwise |
| 83 |
*/ |
| 84 |
function is_url_crawled($url) { |
| 85 |
# Ensure valid input |
| 86 |
if (empty($url) || !is_string($url)) { |
| 87 |
return false; |
| 88 |
} |
| 89 |
|
| 90 |
# Get saved crawl data |
| 91 |
$saved = get_option($this->option_name); |
| 92 |
|
| 93 |
if ( |
| 94 |
empty($saved) || |
| 95 |
!is_array($saved) || |
| 96 |
empty($saved['domain']) || |
| 97 |
empty($saved['urls']) || |
| 98 |
!is_array($saved['urls']) |
| 99 |
) { |
| 100 |
return false; |
| 101 |
} |
| 102 |
|
| 103 |
# Parse saved domain + incoming URL |
| 104 |
$saved_domain = parse_url($saved['domain'], PHP_URL_HOST); |
| 105 |
$incoming_domain = parse_url($url, PHP_URL_HOST); |
| 106 |
|
| 107 |
# Domain mismatch - not crawled |
| 108 |
if (empty($saved_domain) || empty($incoming_domain) || strcasecmp($saved_domain, $incoming_domain) !== 0) { |
| 109 |
return false; |
| 110 |
} |
| 111 |
|
| 112 |
# Parse incoming path (ignore query string) |
| 113 |
$parsed_url = parse_url($url); |
| 114 |
$url_path = $parsed_url['path'] ?? '/'; |
| 115 |
|
| 116 |
# Ensure path starts with / but don't modify trailing slashes |
| 117 |
# Otto stores paths exactly as they appear in URLs |
| 118 |
if (substr($url_path, 0, 1) !== '/') { |
| 119 |
$url_path = '/' . $url_path; |
| 120 |
} |
| 121 |
|
| 122 |
# Compare against crawled URLs - exact match |
| 123 |
foreach ($saved['urls'] as $crawled_url) { |
| 124 |
if (!is_string($crawled_url)) { |
| 125 |
continue; |
| 126 |
} |
| 127 |
|
| 128 |
# Direct comparison - Otto stores paths exactly as they are |
| 129 |
if (strcasecmp($crawled_url, $url_path) === 0) { |
| 130 |
return true; |
| 131 |
} |
| 132 |
} |
| 133 |
|
| 134 |
return false; |
| 135 |
} |
| 136 |
|
| 137 |
# get the current route |
| 138 |
function get_route(){ |
| 139 |
|
| 140 |
# check if we're in an HTTP context |
| 141 |
if(empty($_SERVER['HTTP_HOST']) || empty($_SERVER['REQUEST_URI'])){ |
| 142 |
# not in HTTP context (CLI, cron, etc.), return false |
| 143 |
return false; |
| 144 |
} |
| 145 |
|
| 146 |
# get req scheme |
| 147 |
$scheme = ( is_ssl() ? 'https' : 'http' ); |
| 148 |
|
| 149 |
# get req host |
| 150 |
$host = $_SERVER['HTTP_HOST']; |
| 151 |
|
| 152 |
# get the uri — strip query string before building the route. |
| 153 |
# OTTO suggestions are canonical-URL-based; query parameters (Kinsta cache-bypass |
| 154 |
# tokens, UTM params, tracking params, etc.) never produce different OTTO content. |
| 155 |
# Stripping them ensures that: |
| 156 |
# - The transient populated via a Kinsta BYPASS request (always has ?params) is |
| 157 |
# shared with the clean-URL MISS request (no params). |
| 158 |
# - The OTTO API is called with the canonical URL, not a noisy variant. |
| 159 |
$request_uri = strtok($_SERVER['REQUEST_URI'], '?') ?: $_SERVER['REQUEST_URI']; |
| 160 |
|
| 161 |
# return the formatted url |
| 162 |
return $scheme . '://' . $host . $request_uri; |
| 163 |
} |
| 164 |
|
| 165 |
# get the html for a route |
| 166 |
# OPTION 1 IMPLEMENTATION: Use transient cache for suggestions |
| 167 |
function get_route_html($route, $cache_track_key = null, $suggestions = null){ |
| 168 |
# If suggestions already provided (from render_route_html), use them directly |
| 169 |
if ($suggestions !== null && is_array($suggestions)) { |
| 170 |
# Process route with provided suggestions data |
| 171 |
return $this->o_html->process_route_with_data($route, $suggestions, ''); |
| 172 |
} |
| 173 |
|
| 174 |
# Get OTTO UUID from options |
| 175 |
global $metasync_options; |
| 176 |
$otto_uuid = $metasync_options['general']['otto_pixel_uuid'] ?? ''; |
| 177 |
|
| 178 |
if (empty($otto_uuid)) { |
| 179 |
return false; |
| 180 |
} |
| 181 |
|
| 182 |
# Get suggestions from transient cache (with API fallback) |
| 183 |
$transient_cache = new Metasync_Otto_Transient_Cache($otto_uuid); |
| 184 |
$track_key = $cache_track_key ?: md5($route); |
| 185 |
$suggestions = $transient_cache->get_suggestions($route, $track_key); |
| 186 |
|
| 187 |
if (!$suggestions || !$transient_cache->has_payload($suggestions)) { |
| 188 |
# No suggestions available |
| 189 |
return false; |
| 190 |
} |
| 191 |
|
| 192 |
# Process route with cached suggestions data |
| 193 |
return $this->o_html->process_route_with_data($route, $suggestions, ''); |
| 194 |
} |
| 195 |
|
| 196 |
|
| 197 |
# render route html |
| 198 |
function render_route_html(){ |
| 199 |
|
| 200 |
# Clear per-request statics before any path runs. Harmless under PHP-FPM |
| 201 |
# (the process ends with the request) but required under persistent-worker |
| 202 |
# SAPIs, where a latched flag would silently disable cache capping and |
| 203 |
# failure reporting for every later request in that worker. |
| 204 |
# |
| 205 |
# method_exists() is redundant to static analysis — this MR adds the method, |
| 206 |
# so PHPStan proves the call always true. It is kept for the upgrade window: |
| 207 |
# during a plugin update an opcache can still hold the previous |
| 208 |
# Metasync_Otto_Render_Strategy, where class_exists() passes but the method |
| 209 |
# is absent, and an unguarded static call would fatal the page. |
| 210 |
# @phpstan-ignore-next-line function.alreadyNarrowedType |
| 211 |
if (class_exists('Metasync_Otto_Render_Strategy') && method_exists('Metasync_Otto_Render_Strategy', 'reset_request_state')) { |
| 212 |
Metasync_Otto_Render_Strategy::reset_request_state(); |
| 213 |
} |
| 214 |
|
| 215 |
# Disable SG Cache for Brizy pages FIRST - before any other processing |
| 216 |
# Using global function defined in otto_pixel.php |
| 217 |
if (function_exists('metasync_otto_disable_sg_cache_for_brizy')) { |
| 218 |
metasync_otto_disable_sg_cache_for_brizy(); |
| 219 |
} |
| 220 |
|
| 221 |
# get the route |
| 222 |
$route = $this->get_route(); |
| 223 |
|
| 224 |
# get the current page from globas |
| 225 |
# this is to help us exclude the login page |
| 226 |
|
| 227 |
$page_now = $GLOBALS['pagenow'] ?? false; |
| 228 |
|
| 229 |
# check whether page now in excluded pages |
| 230 |
if(in_array($page_now , $this->no_cache_pages)){ |
| 231 |
|
| 232 |
# stop otto |
| 233 |
return; |
| 234 |
} |
| 235 |
|
| 236 |
/* |
| 237 |
#uncomment to test on local hosts |
| 238 |
if(!empty($_GET['otto_test'])){ |
| 239 |
|
| 240 |
# @dev |
| 241 |
$route = 'https://staging-perm.wp65.qa.internal.searchatlas.com/'; |
| 242 |
} |
| 243 |
*/ |
| 244 |
|
| 245 |
# OPTION 1 IMPLEMENTATION: Check transient cache instead of notification data |
| 246 |
# This makes the system self-healing - works even if notifications fail |
| 247 |
|
| 248 |
# Get OTTO UUID from options |
| 249 |
global $metasync_options; |
| 250 |
$otto_uuid = $metasync_options['general']['otto_pixel_uuid'] ?? ''; |
| 251 |
|
| 252 |
if (empty($otto_uuid)) { |
| 253 |
return; |
| 254 |
} |
| 255 |
|
| 256 |
$transient_cache = new Metasync_Otto_Transient_Cache($otto_uuid); |
| 257 |
|
| 258 |
# Create tracking key for cache status |
| 259 |
$cache_track_key = 'otto_' . md5($route); |
| 260 |
|
| 261 |
# Check if URL has OTTO suggestions (checks transient, calls API if needed) |
| 262 |
# Use get_suggestions directly to track cache status |
| 263 |
$suggestions = $transient_cache->get_suggestions($route, $cache_track_key); |
| 264 |
|
| 265 |
if (!$suggestions || !$transient_cache->has_payload($suggestions)) { |
| 266 |
# No suggestions available for this URL. |
| 267 |
$cache_status = Metasync_Otto_Transient_Cache::get_cache_status($cache_track_key); |
| 268 |
|
| 269 |
# Two very different situations reach this point, and they must be |
| 270 |
# treated differently. |
| 271 |
# |
| 272 |
# A transient failure means the suggestions exist upstream but could |
| 273 |
# not be retrieved on this request — the API errored or timed out, the |
| 274 |
# per-minute budget was spent, or another worker held the lock. The |
| 275 |
# next request will probably succeed. Serving the un-optimized page |
| 276 |
# with normal cache headers lets a caching layer store it and hand it |
| 277 |
# to everyone until its TTL expires, so cap how long it may be kept. |
| 278 |
# |
| 279 |
# Everything else here is a legitimate answer: OTTO simply has nothing |
| 280 |
# for this URL (NO_SUGGESTIONS, including the 404 case). Most URLs on |
| 281 |
# most sites are in that state permanently, so capping those would |
| 282 |
# strip caching from the bulk of the site and move that load onto the |
| 283 |
# origin. Those stay fully cacheable. |
| 284 |
$transient_failures = ['RATE_LIMITED', 'LOCKED', 'API_ERROR']; |
| 285 |
|
| 286 |
if (in_array($cache_status, $transient_failures, true) |
| 287 |
&& function_exists('metasync_otto_limit_response_cache')) { |
| 288 |
metasync_otto_limit_response_cache($cache_status); |
| 289 |
} |
| 290 |
|
| 291 |
# Set diagnostic headers only while Debug Mode is enabled. |
| 292 |
if (!headers_sent() && Metasync_Otto_Render_Strategy::diagnostics_enabled()) { |
| 293 |
header('X-MetaSync-OTTO-Cache: ' . Metasync_Otto_Render_Strategy::display_cache_status($cache_status ?: 'NO_SUGGESTIONS')); |
| 294 |
header('X-MetaSync-OTTO-Method: NONE'); |
| 295 |
} |
| 296 |
return; |
| 297 |
} |
| 298 |
|
| 299 |
# comment out for fixing pagination issues |
| 300 |
# $route = rtrim($route, '/'); |
| 301 |
|
| 302 |
# Now that OTTO has confirmed suggestions to apply to this URL, |
| 303 |
# disable SiteGround SG Optimizer page caching for THIS request only. |
| 304 |
# Doing it here (instead of unconditionally on the `wp` hook) ensures |
| 305 |
# pages without OTTO suggestions keep being served from SG's page cache. |
| 306 |
if (function_exists('metasync_otto_disable_sg_page_cache')) { |
| 307 |
metasync_otto_disable_sg_page_cache(); |
| 308 |
} |
| 309 |
|
| 310 |
# Analyze what OTTO is providing for SEO plugin blocking |
| 311 |
$blocking_flags = $this->analyze_otto_blocking($suggestions); |
| 312 |
|
| 313 |
# Get cache status for headers |
| 314 |
$cache_status = Metasync_Otto_Transient_Cache::get_cache_status($cache_track_key); |
| 315 |
|
| 316 |
# RENDER PRIORITY: |
| 317 |
# 1. WP Rocket rocket_buffer filter — WP Rocket caches OTTO-modified HTML, |
| 318 |
# so Kinsta also caches the correct version. No exit(), no cache bypass. |
| 319 |
# 2. Output Buffer (fast) — for environments without WP Rocket. |
| 320 |
# 3. HTTP Request (last resort) — exits early, bypasses all caching. |
| 321 |
try { |
| 322 |
# Safety check: ensure render strategy class exists |
| 323 |
if (!class_exists('Metasync_Otto_Render_Strategy')) { |
| 324 |
# Class not loaded - use HTTP method as fallback |
| 325 |
$this->render_via_http($route, $suggestions, $cache_track_key, $cache_status); |
| 326 |
return; |
| 327 |
} |
| 328 |
|
| 329 |
# WP ROCKET PATH: highest priority when WP Rocket is active. |
| 330 |
# rocket_buffer fires inside WP Rocket's own cache pipeline, so the |
| 331 |
# cache file WP Rocket writes (and that Kinsta stores) is already |
| 332 |
# OTTO-modified. Eliminates the race where WP Rocket saved pre-OTTO HTML. |
| 333 |
if (class_exists('WP_Rocket')) { |
| 334 |
$wp_rocket_compat_mode = Metasync_Otto_Config::get_wp_rocket_compat_mode(); |
| 335 |
if ($wp_rocket_compat_mode !== 'http') { |
| 336 |
# disable_otto exits in metasync_start_otto() before we get here, so |
| 337 |
# only 'http' compat mode needs to skip the rocket_buffer path. |
| 338 |
$this->render_via_rocket_buffer($suggestions, $blocking_flags, $cache_status); |
| 339 |
return; |
| 340 |
} |
| 341 |
} |
| 342 |
|
| 343 |
$render_method = Metasync_Otto_Render_Strategy::determine_method(); |
| 344 |
|
| 345 |
if ($render_method === Metasync_Otto_Render_Strategy::METHOD_BUFFER) { |
| 346 |
# FAST PATH: Use output buffer approach |
| 347 |
$result = $this->render_via_buffer($route, $suggestions, $blocking_flags, $cache_status); |
| 348 |
|
| 349 |
if ($result === true) { |
| 350 |
# Buffer is now active, WordPress will continue rendering |
| 351 |
# OTTO modifications will be applied when buffer flushes |
| 352 |
return; |
| 353 |
} |
| 354 |
|
| 355 |
# Buffer approach failed, fall back to HTTP method |
| 356 |
$render_method = Metasync_Otto_Render_Strategy::METHOD_HTTP; |
| 357 |
} |
| 358 |
|
| 359 |
if ($render_method === Metasync_Otto_Render_Strategy::METHOD_HTTP) { |
| 360 |
# FALLBACK PATH: Use traditional HTTP request approach |
| 361 |
$this->render_via_http($route, $suggestions, $cache_track_key, $cache_status); |
| 362 |
} |
| 363 |
} catch (Exception $e) { |
| 364 |
# Any exception in the render strategy - fall back to HTTP method |
| 365 |
$this->render_via_http($route, $suggestions, $cache_track_key, $cache_status); |
| 366 |
} catch (Error $e) { |
| 367 |
# PHP 7+ Error (like TypeError) - fall back to HTTP method |
| 368 |
$this->render_via_http($route, $suggestions, $cache_track_key, $cache_status); |
| 369 |
} |
| 370 |
} |
| 371 |
|
| 372 |
/** |
| 373 |
* Stop WP Rocket writing the current response to its disk cache. |
| 374 |
* |
| 375 |
* DONOTCACHEPAGE is not sufficient from inside the rocket_buffer filter: WP |
| 376 |
* Rocket reads that constant when it decides whether to buffer the request, |
| 377 |
* which has already happened by the time the filter runs. It evaluates |
| 378 |
* do_rocket_generate_caching_files immediately before writing the file, so |
| 379 |
* that is the only lever still effective at this point. |
| 380 |
* |
| 381 |
* This matters more than the response headers do. A page served from WP |
| 382 |
* Rocket's disk cache is delivered by rewrite rules without invoking PHP, so |
| 383 |
* once a bad file is on disk no header can override it — only deleting the |
| 384 |
* file or waiting out Rocket's own expiry will clear it. |
| 385 |
* |
| 386 |
* PHP_INT_MAX priority so a site's own filters cannot re-enable the write. |
| 387 |
*/ |
| 388 |
private static function block_rocket_cache_write() { |
| 389 |
if (!defined('DONOTCACHEPAGE')) { |
| 390 |
define('DONOTCACHEPAGE', true); |
| 391 |
} |
| 392 |
|
| 393 |
add_filter('do_rocket_generate_caching_files', '__return_false', PHP_INT_MAX); |
| 394 |
} |
| 395 |
|
| 396 |
/** |
| 397 |
* Render page using WP Rocket's rocket_buffer filter (PREFERRED for WP Rocket sites) |
| 398 |
* |
| 399 |
* When WP Rocket is active, hooking into rocket_buffer ensures WP Rocket |
| 400 |
* caches the OTTO-modified HTML. This means: |
| 401 |
* - WP Rocket's cache file = OTTO-modified HTML ✓ |
| 402 |
* - Kinsta FastCGI cache = WP Rocket output = OTTO-modified HTML ✓ |
| 403 |
* - No exit() = proper cache lifecycle ✓ |
| 404 |
* |
| 405 |
* The filter fires on every uncached PHP request. Once WP Rocket has cached |
| 406 |
* the result, subsequent requests are served directly from cache with zero PHP. |
| 407 |
* |
| 408 |
* @param array $suggestions OTTO suggestions data |
| 409 |
* @param array $blocking_flags SEO plugin blocking flags |
| 410 |
* @param string $cache_status Cache status for X-MetaSync-* headers |
| 411 |
*/ |
| 412 |
private function render_via_rocket_buffer($suggestions, $blocking_flags, $cache_status) { |
| 413 |
$o_html = $this->o_html; |
| 414 |
|
| 415 |
# Hook into WP Rocket's HTML buffer at priority 1 so other rocket_buffer |
| 416 |
# filters (minifiers, CDN rewriters, etc.) run on already-OTTO-modified HTML. |
| 417 |
add_filter('rocket_buffer', function($html) use ($o_html, $suggestions, $blocking_flags) { |
| 418 |
if (empty($html) || strlen($html) < 100) { |
| 419 |
// Tell WP Rocket not to cache this empty/broken response. The |
| 420 |
// constant alone is too late here (see block_rocket_cache_write), |
| 421 |
// so the write-time filter is applied as well. |
| 422 |
self::block_rocket_cache_write(); |
| 423 |
return $html; |
| 424 |
} |
| 425 |
|
| 426 |
# Only process full HTML documents — skip partials, JSON, error responses |
| 427 |
if (stripos($html, '<html') === false && stripos($html, '<!DOCTYPE') === false) { |
| 428 |
return $html; |
| 429 |
} |
| 430 |
|
| 431 |
# Pass blocking context to the HTML processor (suppresses Yoast/Rank Math tags |
| 432 |
# that OTTO is replacing, preventing duplicates in the final HTML) |
| 433 |
$data = $suggestions; |
| 434 |
if (!empty($blocking_flags)) { |
| 435 |
$data['_otto_blocking'] = $blocking_flags; |
| 436 |
} |
| 437 |
|
| 438 |
# From here on we hold usable suggestions, so any exit that returns |
| 439 |
# $html unmodified is a genuine failure: WP Rocket would write the |
| 440 |
# un-optimized markup to its cache file, and whatever sits in front of |
| 441 |
# it would then serve that copy. This is worse than the plain buffer |
| 442 |
# path, because the bad page is persisted on disk as well as at the |
| 443 |
# edge — and this route exists specifically to make the cached copy the |
| 444 |
# optimized one. |
| 445 |
# |
| 446 |
# Note that DONOTCACHEPAGE alone does NOT prevent that write. WP Rocket |
| 447 |
# evaluates the constant when it decides whether to buffer the page, |
| 448 |
# which has already happened by the time this filter runs. The |
| 449 |
# do_rocket_generate_caching_files filter is evaluated immediately |
| 450 |
# before the file is written, so it is the only lever still available |
| 451 |
# from here. A disk-cached page is served by rewrite rules without |
| 452 |
# invoking PHP, so no response header can undo it afterwards. |
| 453 |
try { |
| 454 |
$modified = $o_html->process_html_directly($html, $data); |
| 455 |
# Sanity check: modified HTML must be at least 50% the size of original |
| 456 |
if ($modified && strlen($modified) > strlen($html) * 0.5) { |
| 457 |
return $modified; |
| 458 |
} |
| 459 |
|
| 460 |
# An unprocessable document (oversized / over the memory budget) is |
| 461 |
# a permanent property of the page, not a failure to retry. Leave it |
| 462 |
# fully cacheable — capping it would make the most expensive page on |
| 463 |
# the site uncacheable forever for no gain. |
| 464 |
if (class_exists('Metasync_Otto_Render_Strategy') |
| 465 |
&& Metasync_Otto_Render_Strategy::document_was_unprocessable()) { |
| 466 |
return $html; |
| 467 |
} |
| 468 |
|
| 469 |
# Either the rewrite returned nothing usable, or the result was so |
| 470 |
# much smaller than the input that it is assumed to be mangled. |
| 471 |
self::block_rocket_cache_write(); |
| 472 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 473 |
metasync_otto_limit_response_cache('RENDER_DISCARDED_ROCKET'); |
| 474 |
} |
| 475 |
if (function_exists('metasync_otto_report_render_failure')) { |
| 476 |
metasync_otto_report_render_failure( |
| 477 |
'RENDER_DISCARDED_ROCKET', |
| 478 |
'OTTO rewrite produced no usable output on the WP Rocket path', |
| 479 |
[ |
| 480 |
'original_bytes' => strlen($html), |
| 481 |
'result_bytes' => is_string($modified) ? strlen($modified) : 0, |
| 482 |
'render_method' => 'wp_rocket', |
| 483 |
], |
| 484 |
'warning' |
| 485 |
); |
| 486 |
} |
| 487 |
} catch (Exception $e) { |
| 488 |
// Fall through — return original HTML on any failure |
| 489 |
self::block_rocket_cache_write(); |
| 490 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 491 |
metasync_otto_limit_response_cache('RENDER_EXCEPTION_ROCKET'); |
| 492 |
} |
| 493 |
if (function_exists('metasync_otto_report_render_failure')) { |
| 494 |
metasync_otto_report_render_failure( |
| 495 |
'RENDER_EXCEPTION_ROCKET', |
| 496 |
'OTTO rewrite threw on the WP Rocket path: ' . $e->getMessage(), |
| 497 |
['render_method' => 'wp_rocket', 'exception' => get_class($e)], |
| 498 |
'error' |
| 499 |
); |
| 500 |
} |
| 501 |
} catch (Error $e) { |
| 502 |
// Fall through — return original HTML on any failure |
| 503 |
self::block_rocket_cache_write(); |
| 504 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 505 |
metasync_otto_limit_response_cache('RENDER_EXCEPTION_ROCKET'); |
| 506 |
} |
| 507 |
if (function_exists('metasync_otto_report_render_failure')) { |
| 508 |
metasync_otto_report_render_failure( |
| 509 |
'RENDER_EXCEPTION_ROCKET', |
| 510 |
'OTTO rewrite errored on the WP Rocket path: ' . $e->getMessage(), |
| 511 |
['render_method' => 'wp_rocket', 'error' => get_class($e)], |
| 512 |
'error' |
| 513 |
); |
| 514 |
} |
| 515 |
} |
| 516 |
|
| 517 |
return $html; |
| 518 |
}, 1); |
| 519 |
|
| 520 |
# Block SEO plugins before wp_head fires so duplicate tags aren't output |
| 521 |
$description_tags = $blocking_flags['block_description_tags'] ?? []; |
| 522 |
$has_description_tags = !empty($description_tags); |
| 523 |
if ($blocking_flags['block_title'] || $has_description_tags) { |
| 524 |
if (function_exists('metasync_otto_block_seo_plugins')) { |
| 525 |
metasync_otto_block_seo_plugins( |
| 526 |
$blocking_flags['block_title'], |
| 527 |
$has_description_tags, |
| 528 |
$description_tags |
| 529 |
); |
| 530 |
} |
| 531 |
} |
| 532 |
|
| 533 |
# Send X-MetaSync-* diagnostic headers before WordPress outputs anything |
| 534 |
if (!headers_sent()) { |
| 535 |
Metasync_Otto_Render_Strategy::set_current_method(Metasync_Otto_Render_Strategy::METHOD_WP_ROCKET); |
| 536 |
Metasync_Otto_Render_Strategy::send_headers($cache_status); |
| 537 |
} |
| 538 |
|
| 539 |
# Return — WordPress continues its normal render lifecycle. |
| 540 |
# WP Rocket's buffer captures the full HTML, fires rocket_buffer, |
| 541 |
# our callback modifies it, and WP Rocket caches the OTTO version. |
| 542 |
} |
| 543 |
|
| 544 |
/** |
| 545 |
* Analyze OTTO suggestions to determine what to block from SEO plugins |
| 546 |
* |
| 547 |
* @param array $suggestions OTTO suggestions data |
| 548 |
* @return array Blocking flags |
| 549 |
*/ |
| 550 |
private function analyze_otto_blocking($suggestions) { |
| 551 |
$has_otto_title = false; |
| 552 |
$otto_description_tags = []; // Track specific description tags Otto provides |
| 553 |
|
| 554 |
if (!empty($suggestions['header_replacements']) && is_array($suggestions['header_replacements'])) { |
| 555 |
foreach ($suggestions['header_replacements'] as $item) { |
| 556 |
if (!empty($item['type'])) { |
| 557 |
# Check if OTTO has title |
| 558 |
if ($item['type'] == 'title' && !empty($item['recommended_value'])) { |
| 559 |
$has_otto_title = true; |
| 560 |
} |
| 561 |
# Check if OTTO has description - track specific tag types |
| 562 |
if ($item['type'] == 'meta') { |
| 563 |
# Check for meta[name=description] |
| 564 |
if (!empty($item['name']) && $item['name'] == 'description' && !empty($item['recommended_value'])) { |
| 565 |
$otto_description_tags[] = 'meta[name=description]'; |
| 566 |
} |
| 567 |
# Check for meta[property=og:description] |
| 568 |
if (!empty($item['property']) && $item['property'] == 'og:description' && !empty($item['recommended_value'])) { |
| 569 |
$otto_description_tags[] = 'meta[property=og:description]'; |
| 570 |
} |
| 571 |
# Check for meta[name=twitter:description] |
| 572 |
if (!empty($item['name']) && $item['name'] == 'twitter:description' && !empty($item['recommended_value'])) { |
| 573 |
$otto_description_tags[] = 'meta[name=twitter:description]'; |
| 574 |
} |
| 575 |
} |
| 576 |
} |
| 577 |
} |
| 578 |
} |
| 579 |
|
| 580 |
# Check header_html_insertion for description |
| 581 |
# Must have a non-empty content value, otherwise Yoast would be blocked with nothing to replace it |
| 582 |
if (!empty($suggestions['header_html_insertion'])) { |
| 583 |
if (preg_match('/<meta[^>]*name=["\']description["\'][^>]*content=["\']([^"\']+)["\'][^>]*>/i', $suggestions['header_html_insertion'])) { |
| 584 |
$otto_description_tags[] = 'meta[name=description]'; |
| 585 |
} |
| 586 |
} |
| 587 |
|
| 588 |
# Remove duplicates |
| 589 |
$otto_description_tags = array_unique($otto_description_tags); |
| 590 |
|
| 591 |
return [ |
| 592 |
'block_title' => $has_otto_title, |
| 593 |
'block_description_tags' => $otto_description_tags, // Pass array of specific tags |
| 594 |
]; |
| 595 |
} |
| 596 |
|
| 597 |
/** |
| 598 |
* Render page using output buffer approach (FAST) |
| 599 |
* Eliminates the internal HTTP request by capturing WordPress output directly |
| 600 |
* |
| 601 |
* @param string $route Current page route |
| 602 |
* @param array $suggestions OTTO suggestions data |
| 603 |
* @param array $blocking_flags SEO plugin blocking flags |
| 604 |
* @param string $cache_status Cache status for headers |
| 605 |
* @return bool True if buffer started successfully, false to fall back to HTTP |
| 606 |
*/ |
| 607 |
private function render_via_buffer($route, $suggestions, $blocking_flags, $cache_status) { |
| 608 |
# Try to start output buffer |
| 609 |
$buffer_started = Metasync_Otto_Render_Strategy::start_buffer( |
| 610 |
$suggestions, |
| 611 |
$route, |
| 612 |
$this->o_html, |
| 613 |
$blocking_flags |
| 614 |
); |
| 615 |
|
| 616 |
if (!$buffer_started) { |
| 617 |
# Buffer failed to start |
| 618 |
return false; |
| 619 |
} |
| 620 |
|
| 621 |
# Buffer is active - send headers now (before any output) |
| 622 |
if (!headers_sent()) { |
| 623 |
Metasync_Otto_Render_Strategy::send_headers($cache_status); |
| 624 |
} |
| 625 |
|
| 626 |
# Block SEO plugins if needed (for the buffered output) |
| 627 |
$description_tags = $blocking_flags['block_description_tags'] ?? []; |
| 628 |
$has_description_tags = !empty($description_tags); |
| 629 |
if ($blocking_flags['block_title'] || $has_description_tags) { |
| 630 |
if (function_exists('metasync_otto_block_seo_plugins')) { |
| 631 |
metasync_otto_block_seo_plugins( |
| 632 |
$blocking_flags['block_title'], |
| 633 |
$has_description_tags, |
| 634 |
$description_tags |
| 635 |
); |
| 636 |
} |
| 637 |
} |
| 638 |
|
| 639 |
# Return true - WordPress will continue rendering, buffer will capture and process |
| 640 |
return true; |
| 641 |
} |
| 642 |
|
| 643 |
/** |
| 644 |
* Render page using HTTP request approach (FALLBACK) |
| 645 |
* Makes internal wp_remote_get request to fetch page HTML |
| 646 |
* |
| 647 |
* @param string $route Current page route |
| 648 |
* @param array $suggestions OTTO suggestions data |
| 649 |
* @param string $cache_track_key Cache tracking key |
| 650 |
* @param string $cache_status Cache status for headers |
| 651 |
*/ |
| 652 |
private function render_via_http($route, $suggestions, $cache_track_key, $cache_status) { |
| 653 |
# Set method indicator |
| 654 |
Metasync_Otto_Render_Strategy::set_current_method(Metasync_Otto_Render_Strategy::METHOD_HTTP); |
| 655 |
|
| 656 |
# On Divi sites, skip OTTO for the first HTTP render per page |
| 657 |
# per 24h. OTTO's internal wp_remote_get creates corrupted CSS cache |
| 658 |
# files in et-cache/{post_id}/ (wrong server context). By returning |
| 659 |
# false once, WordPress renders the page normally — building correct |
| 660 |
# Divi CSS caches. Subsequent OTTO renders within 24h use those caches. |
| 661 |
# The transient stores the activation timestamp so it auto-invalidates |
| 662 |
# when the plugin is deactivated/reactivated. |
| 663 |
if (defined('ET_CORE_VERSION')) { |
| 664 |
$cache_key = 'otto_divi_css_fix_' . md5($route); |
| 665 |
$activated = get_option('metasync_activated_at', ''); |
| 666 |
$cached = get_transient($cache_key); |
| 667 |
if ($cached === false || $cached !== $activated) { |
| 668 |
set_transient($cache_key, $activated, DAY_IN_SECONDS); |
| 669 |
# Deliberate one-off skip, and the next request renders correctly — |
| 670 |
# so cap how long this un-optimized copy may be cached rather than |
| 671 |
# letting a caching layer pin it for its full TTL. |
| 672 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 673 |
metasync_otto_limit_response_cache('DIVI_FIRST_RENDER_SKIP'); |
| 674 |
} |
| 675 |
return false; |
| 676 |
} |
| 677 |
} |
| 678 |
|
| 679 |
# check if we have the route html (pass suggestions to avoid duplicate API call) |
| 680 |
$route_html = $this->get_route_html($route, $cache_track_key, $suggestions); |
| 681 |
|
| 682 |
# check that route html is valid |
| 683 |
if(empty($route_html)){ |
| 684 |
return false; |
| 685 |
} |
| 686 |
|
| 687 |
$route_html_string = is_string($route_html) ? $route_html : $route_html->__toString(); |
| 688 |
|
| 689 |
# Detect incomplete Divi rendering in OTTO's HTTP render output. |
| 690 |
# OTTO's internal wp_remote_get runs in a different server context than the |
| 691 |
# normal page load. This can cause Divi to produce incomplete output: |
| 692 |
# |
| 693 |
# 1. Cold CSS cache: Divi outputs inline <style> blocks instead of external |
| 694 |
# <link> tags (TB CSS files not yet generated) |
| 695 |
# 2. Missing Google Fonts: Divi's font enqueue depends on request context |
| 696 |
# (cookies, headers) that differ in the internal fetch |
| 697 |
# |
| 698 |
# If OTTO serves this incomplete HTML via exit(), SG Optimizer caches it — |
| 699 |
# breaking CSS for all visitors until manual cache purge. |
| 700 |
# |
| 701 |
# Fix: skip OTTO for this request (return false), letting WordPress render |
| 702 |
# normally. This builds Divi's caches so the next OTTO request works correctly. |
| 703 |
# |
| 704 |
# Both checks below are self-resolving — the next render finds warm caches — |
| 705 |
# so the un-optimized copy served now gets a capped cache lifetime rather |
| 706 |
# than being pinned for a caching layer's full TTL. |
| 707 |
# |
| 708 |
# The remaining fail-open exits on this path are deliberately NOT capped. |
| 709 |
# They mean the site could not fetch its own page (blocked loopback request, |
| 710 |
# HTTP Basic Auth, a firewall rejecting the internal user-agent) or that the |
| 711 |
# document cannot be processed at all. Those are whole-site, permanent |
| 712 |
# conditions: OTTO cannot work on any page, so capping cache lifetime would |
| 713 |
# rescue nothing while moving the entire site's traffic to the origin. |
| 714 |
if (defined('ET_CORE_VERSION')) { |
| 715 |
# Check 1: Cold TB CSS cache (inline styles instead of external link) |
| 716 |
if (preg_match('/<style\s[^>]*id=["\']et-core-unified-tb-[^"\']*-cached-inline-styles["\']/', $route_html_string)) { |
| 717 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 718 |
metasync_otto_limit_response_cache('DIVI_COLD_CSS_CACHE'); |
| 719 |
} |
| 720 |
return false; |
| 721 |
} |
| 722 |
# Check 2: Missing Google Fonts CSS (Divi enqueues this on every page) |
| 723 |
# Normal render has: <link ... id='et-builder-googlefonts-cached-css' ...> |
| 724 |
# or <link ... id='et-builder-googlefonts-css' ...> |
| 725 |
# If neither is present, the internal fetch didn't load fonts properly. |
| 726 |
if (strpos($route_html_string, 'et-builder-googlefonts') === false |
| 727 |
&& strpos($route_html_string, 'fonts.googleapis.com') === false |
| 728 |
) { |
| 729 |
if (function_exists('metasync_otto_limit_response_cache')) { |
| 730 |
metasync_otto_limit_response_cache('DIVI_MISSING_FONTS'); |
| 731 |
} |
| 732 |
return false; |
| 733 |
} |
| 734 |
} |
| 735 |
|
| 736 |
if (strpos($route_html_string, 'pix-sliding-headline-2') !== false || strpos($route_html_string, 'pix-intro-sliding-text') !== false) { |
| 737 |
# Only apply fix within sliding text contexts to avoid breaking other layouts |
| 738 |
$route_html_string = preg_replace('#(</span></span>)(<span\s+class=["\'][^"\']*slide-in-container[^"\']*["\'][^>]*>)#i', '$1 $2', $route_html_string); |
| 739 |
} |
| 740 |
|
| 741 |
# Fix for Elementor widgets - preserve whitespace between inline spans |
| 742 |
# This prevents text/elements from appearing merged when HTML is minified |
| 743 |
|
| 744 |
# Fix for Elementor social icons (elementor-grid-item) |
| 745 |
if (strpos($route_html_string, 'elementor-social-icons-wrapper') !== false) { |
| 746 |
# Add whitespace between closing and opening span tags within elementor-grid-item |
| 747 |
$route_html_string = preg_replace( |
| 748 |
'#(</span>)(<span\s+class=["\'][^"\']*elementor-grid-item[^"\']*["\'][^>]*>)#i', |
| 749 |
'$1 $2', |
| 750 |
$route_html_string |
| 751 |
); |
| 752 |
} |
| 753 |
|
| 754 |
# Fix for Elementor animated headline (elementor-headline-text-wrapper) |
| 755 |
if (strpos($route_html_string, 'elementor-headline') !== false) { |
| 756 |
# Add whitespace between closing and opening span tags with elementor-headline-text-wrapper |
| 757 |
$route_html_string = preg_replace( |
| 758 |
'#(</span>)(<span\s+class=["\'][^"\']*elementor-headline-text-wrapper[^"\']*["\'][^>]*>)#i', |
| 759 |
'$1 $2', |
| 760 |
$route_html_string |
| 761 |
); |
| 762 |
} |
| 763 |
|
| 764 |
# Check for Revolution Slider to determine if special handling is needed |
| 765 |
# Check for both Revolution Slider 6 (<rs-module-wrap>) and Revolution Slider 7 (<sr7-module>) |
| 766 |
$has_revslider = (strpos($route_html_string, '<rs-module-wrap') !== false || strpos($route_html_string, '<sr7-module') !== false); |
| 767 |
|
| 768 |
if($has_revslider){ |
| 769 |
# Revolution Slider detected - fire WordPress hooks to ensure proper initialization |
| 770 |
# Use output buffering to prevent hooks from corrupting Otto's processed HTML |
| 771 |
ob_start(); |
| 772 |
do_action('wp_enqueue_scripts'); |
| 773 |
$discarded_output = ob_get_clean(); |
| 774 |
|
| 775 |
} |
| 776 |
|
| 777 |
# If Divi's module-design CSS is missing from OTTO output, |
| 778 |
# fetch it directly and inject it. This handles the case where the |
| 779 |
# internal wp_remote_get response was truncated by SG Optimizer's parser. |
| 780 |
if (strpos($route_html_string, 'et-builder-module-design') === false |
| 781 |
&& function_exists('et_theme_builder_decorate_page_resource_slug') |
| 782 |
&& function_exists('et_core_page_resource_get') |
| 783 |
) { |
| 784 |
# Try to get Divi's inline CSS from its page resource manager |
| 785 |
$post_id = get_the_ID(); |
| 786 |
if ($post_id) { |
| 787 |
$resource_slug = et_theme_builder_decorate_page_resource_slug($post_id, 'module-design'); |
| 788 |
$manager = et_core_page_resource_get('builder', $resource_slug, $post_id, 40); |
| 789 |
if ($manager && method_exists($manager, 'get_data')) { |
| 790 |
$css_data = $manager->get_data('inline'); |
| 791 |
if (!empty($css_data)) { |
| 792 |
$style_tag = '<style id="et-builder-' . esc_attr($resource_slug) . '-cached-inline-styles">' |
| 793 |
. wp_strip_all_tags($css_data) . '</style>'; |
| 794 |
$route_html_string = str_replace('</body>', $style_tag . "\n" . '</body>', $route_html_string); |
| 795 |
} |
| 796 |
} |
| 797 |
} |
| 798 |
} |
| 799 |
|
| 800 |
# Send response headers |
| 801 |
Metasync_Otto_Render_Strategy::send_headers($cache_status); |
| 802 |
|
| 803 |
# continue to render the html |
| 804 |
echo $route_html_string; |
| 805 |
|
| 806 |
# prevent further wp execution |
| 807 |
exit(); |
| 808 |
} |
| 809 |
|
| 810 |
} |
| 811 |
|
