PluginProbe
Search Atlas SEO – OTTO AI SEO Automation for WordPress / 2.6.5
Search Atlas SEO – OTTO AI SEO Automation for WordPress v2.6.5
2.7.0 2.6.26 2.6.25 2.6.24 2.6.23 2.6.22 2.6.21 2.6.20 2.6.19 2.6.18 2.6.17 2.6.16 2.6.15 2.6.14 2.6.13 2.6.12 2.6.11 2.6.10 2.6.9 2.6.8 2.6.7 2.6.6 2.6.5 2.6.4 2.6.3 All 139 releases
metasync / otto / Otto_pixel_class.php

Otto_pixel_class.php in Search Atlas SEO – OTTO AI SEO Automation for WordPress 2.6.5, at otto/Otto_pixel_class.php

576 lines 22.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
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 # Disable SG Cache for Brizy pages FIRST - before any other processing
201 # Using global function defined in otto_pixel.php
202 if (function_exists('metasync_otto_disable_sg_cache_for_brizy')) {
203 metasync_otto_disable_sg_cache_for_brizy();
204 }
205
206 # get the route
207 $route = $this->get_route();
208
209 # get the current page from globas
210 # this is to help us exclude the login page
211
212 $page_now = $GLOBALS['pagenow'] ?? false;
213
214 # check whether page now in excluded pages
215 if(in_array($page_now , $this->no_cache_pages)){
216
217 # stop otto
218 return;
219 }
220
221 /*
222 #uncomment to test on local hosts
223 if(!empty($_GET['otto_test'])){
224
225 # @dev
226 $route = 'https://staging-perm.wp65.qa.internal.searchatlas.com/';
227 }
228 */
229
230 # OPTION 1 IMPLEMENTATION: Check transient cache instead of notification data
231 # This makes the system self-healing - works even if notifications fail
232
233 # Get OTTO UUID from options
234 global $metasync_options;
235 $otto_uuid = $metasync_options['general']['otto_pixel_uuid'] ?? '';
236
237 if (empty($otto_uuid)) {
238 return;
239 }
240
241 $transient_cache = new Metasync_Otto_Transient_Cache($otto_uuid);
242
243 # Create tracking key for cache status
244 $cache_track_key = 'otto_' . md5($route);
245
246 # Check if URL has OTTO suggestions (checks transient, calls API if needed)
247 # Use get_suggestions directly to track cache status
248 $suggestions = $transient_cache->get_suggestions($route, $cache_track_key);
249
250 if (!$suggestions || !$transient_cache->has_payload($suggestions)) {
251 # No suggestions available for this URL
252 # Set header to indicate cache status
253 if (!headers_sent()) {
254 $cache_status = Metasync_Otto_Transient_Cache::get_cache_status($cache_track_key);
255 header('X-MetaSync-OTTO-Cache: ' . ($cache_status ?: 'NO_SUGGESTIONS'));
256 header('X-MetaSync-OTTO-Method: NONE');
257 }
258 return;
259 }
260
261 # comment out for fixing pagination issues
262 # $route = rtrim($route, '/');
263
264 # Analyze what OTTO is providing for SEO plugin blocking
265 $blocking_flags = $this->analyze_otto_blocking($suggestions);
266
267 # Get cache status for headers
268 $cache_status = Metasync_Otto_Transient_Cache::get_cache_status($cache_track_key);
269
270 # RENDER PRIORITY:
271 # 1. WP Rocket rocket_buffer filter — WP Rocket caches OTTO-modified HTML,
272 # so Kinsta also caches the correct version. No exit(), no cache bypass.
273 # 2. Output Buffer (fast) — for environments without WP Rocket.
274 # 3. HTTP Request (last resort) — exits early, bypasses all caching.
275 try {
276 # Safety check: ensure render strategy class exists
277 if (!class_exists('Metasync_Otto_Render_Strategy')) {
278 # Class not loaded - use HTTP method as fallback
279 $this->render_via_http($route, $suggestions, $cache_track_key, $cache_status);
280 return;
281 }
282
283 # WP ROCKET PATH: highest priority when WP Rocket is active.
284 # rocket_buffer fires inside WP Rocket's own cache pipeline, so the
285 # cache file WP Rocket writes (and that Kinsta stores) is already
286 # OTTO-modified. Eliminates the race where WP Rocket saved pre-OTTO HTML.
287 if (class_exists('WP_Rocket')) {
288 $wp_rocket_compat_mode = Metasync_Otto_Config::get_wp_rocket_compat_mode();
289 if ($wp_rocket_compat_mode !== 'http') {
290 # disable_otto exits in metasync_start_otto() before we get here, so
291 # only 'http' compat mode needs to skip the rocket_buffer path.
292 $this->render_via_rocket_buffer($suggestions, $blocking_flags, $cache_status);
293 return;
294 }
295 }
296
297 $render_method = Metasync_Otto_Render_Strategy::determine_method();
298
299 if ($render_method === Metasync_Otto_Render_Strategy::METHOD_BUFFER) {
300 # FAST PATH: Use output buffer approach
301 $result = $this->render_via_buffer($route, $suggestions, $blocking_flags, $cache_status);
302
303 if ($result === true) {
304 # Buffer is now active, WordPress will continue rendering
305 # OTTO modifications will be applied when buffer flushes
306 return;
307 }
308
309 # Buffer approach failed, fall back to HTTP method
310 $render_method = Metasync_Otto_Render_Strategy::METHOD_HTTP;
311 }
312
313 if ($render_method === Metasync_Otto_Render_Strategy::METHOD_HTTP) {
314 # FALLBACK PATH: Use traditional HTTP request approach
315 $this->render_via_http($route, $suggestions, $cache_track_key, $cache_status);
316 }
317 } catch (Exception $e) {
318 # Any exception in the render strategy - fall back to HTTP method
319 $this->render_via_http($route, $suggestions, $cache_track_key, $cache_status);
320 } catch (Error $e) {
321 # PHP 7+ Error (like TypeError) - fall back to HTTP method
322 $this->render_via_http($route, $suggestions, $cache_track_key, $cache_status);
323 }
324 }
325
326 /**
327 * Render page using WP Rocket's rocket_buffer filter (PREFERRED for WP Rocket sites)
328 *
329 * When WP Rocket is active, hooking into rocket_buffer ensures WP Rocket
330 * caches the OTTO-modified HTML. This means:
331 * - WP Rocket's cache file = OTTO-modified HTML ✓
332 * - Kinsta FastCGI cache = WP Rocket output = OTTO-modified HTML ✓
333 * - No exit() = proper cache lifecycle ✓
334 *
335 * The filter fires on every uncached PHP request. Once WP Rocket has cached
336 * the result, subsequent requests are served directly from cache with zero PHP.
337 *
338 * @param array $suggestions OTTO suggestions data
339 * @param array $blocking_flags SEO plugin blocking flags
340 * @param string $cache_status Cache status for X-MetaSync-* headers
341 */
342 private function render_via_rocket_buffer($suggestions, $blocking_flags, $cache_status) {
343 $o_html = $this->o_html;
344
345 # Hook into WP Rocket's HTML buffer at priority 1 so other rocket_buffer
346 # filters (minifiers, CDN rewriters, etc.) run on already-OTTO-modified HTML.
347 add_filter('rocket_buffer', function($html) use ($o_html, $suggestions, $blocking_flags) {
348 if (empty($html) || strlen($html) < 100) {
349 return $html;
350 }
351
352 # Only process full HTML documents — skip partials, JSON, error responses
353 if (stripos($html, '<html') === false && stripos($html, '<!DOCTYPE') === false) {
354 return $html;
355 }
356
357 # Pass blocking context to the HTML processor (suppresses Yoast/Rank Math tags
358 # that OTTO is replacing, preventing duplicates in the final HTML)
359 $data = $suggestions;
360 if (!empty($blocking_flags)) {
361 $data['_otto_blocking'] = $blocking_flags;
362 }
363
364 try {
365 $modified = $o_html->process_html_directly($html, $data);
366 # Sanity check: modified HTML must be at least 50% the size of original
367 if ($modified && strlen($modified) > strlen($html) * 0.5) {
368 return $modified;
369 }
370 } catch (Exception $e) {
371 // Fall through — return original HTML on any failure
372 } catch (Error $e) {
373 // Fall through — return original HTML on any failure
374 }
375
376 return $html;
377 }, 1);
378
379 # Block SEO plugins before wp_head fires so duplicate tags aren't output
380 $description_tags = $blocking_flags['block_description_tags'] ?? [];
381 $has_description_tags = !empty($description_tags);
382 if ($blocking_flags['block_title'] || $has_description_tags) {
383 if (function_exists('metasync_otto_block_seo_plugins')) {
384 metasync_otto_block_seo_plugins(
385 $blocking_flags['block_title'],
386 $has_description_tags,
387 $description_tags
388 );
389 }
390 }
391
392 # Send X-MetaSync-* diagnostic headers before WordPress outputs anything
393 if (!headers_sent()) {
394 Metasync_Otto_Render_Strategy::set_current_method(Metasync_Otto_Render_Strategy::METHOD_WP_ROCKET);
395 Metasync_Otto_Render_Strategy::send_headers($cache_status);
396 }
397
398 # Return — WordPress continues its normal render lifecycle.
399 # WP Rocket's buffer captures the full HTML, fires rocket_buffer,
400 # our callback modifies it, and WP Rocket caches the OTTO version.
401 }
402
403 /**
404 * Analyze OTTO suggestions to determine what to block from SEO plugins
405 *
406 * @param array $suggestions OTTO suggestions data
407 * @return array Blocking flags
408 */
409 private function analyze_otto_blocking($suggestions) {
410 $has_otto_title = false;
411 $otto_description_tags = []; // Track specific description tags Otto provides
412
413 if (!empty($suggestions['header_replacements']) && is_array($suggestions['header_replacements'])) {
414 foreach ($suggestions['header_replacements'] as $item) {
415 if (!empty($item['type'])) {
416 # Check if OTTO has title
417 if ($item['type'] == 'title' && !empty($item['recommended_value'])) {
418 $has_otto_title = true;
419 }
420 # Check if OTTO has description - track specific tag types
421 if ($item['type'] == 'meta') {
422 # Check for meta[name=description]
423 if (!empty($item['name']) && $item['name'] == 'description' && !empty($item['recommended_value'])) {
424 $otto_description_tags[] = 'meta[name=description]';
425 }
426 # Check for meta[property=og:description]
427 if (!empty($item['property']) && $item['property'] == 'og:description' && !empty($item['recommended_value'])) {
428 $otto_description_tags[] = 'meta[property=og:description]';
429 }
430 # Check for meta[name=twitter:description]
431 if (!empty($item['name']) && $item['name'] == 'twitter:description' && !empty($item['recommended_value'])) {
432 $otto_description_tags[] = 'meta[name=twitter:description]';
433 }
434 }
435 }
436 }
437 }
438
439 # Check header_html_insertion for description
440 # Must have a non-empty content value, otherwise Yoast would be blocked with nothing to replace it
441 if (!empty($suggestions['header_html_insertion'])) {
442 if (preg_match('/<meta[^>]*name=["\']description["\'][^>]*content=["\']([^"\']+)["\'][^>]*>/i', $suggestions['header_html_insertion'])) {
443 $otto_description_tags[] = 'meta[name=description]';
444 }
445 }
446
447 # Remove duplicates
448 $otto_description_tags = array_unique($otto_description_tags);
449
450 return [
451 'block_title' => $has_otto_title,
452 'block_description_tags' => $otto_description_tags, // Pass array of specific tags
453 ];
454 }
455
456 /**
457 * Render page using output buffer approach (FAST)
458 * Eliminates the internal HTTP request by capturing WordPress output directly
459 *
460 * @param string $route Current page route
461 * @param array $suggestions OTTO suggestions data
462 * @param array $blocking_flags SEO plugin blocking flags
463 * @param string $cache_status Cache status for headers
464 * @return bool True if buffer started successfully, false to fall back to HTTP
465 */
466 private function render_via_buffer($route, $suggestions, $blocking_flags, $cache_status) {
467 # Try to start output buffer
468 $buffer_started = Metasync_Otto_Render_Strategy::start_buffer(
469 $suggestions,
470 $route,
471 $this->o_html,
472 $blocking_flags
473 );
474
475 if (!$buffer_started) {
476 # Buffer failed to start
477 return false;
478 }
479
480 # Buffer is active - send headers now (before any output)
481 if (!headers_sent()) {
482 Metasync_Otto_Render_Strategy::send_headers($cache_status);
483 }
484
485 # Block SEO plugins if needed (for the buffered output)
486 $description_tags = $blocking_flags['block_description_tags'] ?? [];
487 $has_description_tags = !empty($description_tags);
488 if ($blocking_flags['block_title'] || $has_description_tags) {
489 if (function_exists('metasync_otto_block_seo_plugins')) {
490 metasync_otto_block_seo_plugins(
491 $blocking_flags['block_title'],
492 $has_description_tags,
493 $description_tags
494 );
495 }
496 }
497
498 # Return true - WordPress will continue rendering, buffer will capture and process
499 return true;
500 }
501
502 /**
503 * Render page using HTTP request approach (FALLBACK)
504 * Makes internal wp_remote_get request to fetch page HTML
505 *
506 * @param string $route Current page route
507 * @param array $suggestions OTTO suggestions data
508 * @param string $cache_track_key Cache tracking key
509 * @param string $cache_status Cache status for headers
510 */
511 private function render_via_http($route, $suggestions, $cache_track_key, $cache_status) {
512 # Set method indicator
513 Metasync_Otto_Render_Strategy::set_current_method(Metasync_Otto_Render_Strategy::METHOD_HTTP);
514
515 # check if we have the route html (pass suggestions to avoid duplicate API call)
516 $route_html = $this->get_route_html($route, $cache_track_key, $suggestions);
517
518 # check that route html is valid
519 if(empty($route_html)){
520 return false;
521 }
522
523 $route_html_string = is_string($route_html) ? $route_html : $route_html->__toString();
524
525 if (strpos($route_html_string, 'pix-sliding-headline-2') !== false || strpos($route_html_string, 'pix-intro-sliding-text') !== false) {
526 # Only apply fix within sliding text contexts to avoid breaking other layouts
527 $route_html_string = preg_replace('#(</span></span>)(<span\s+class=["\'][^"\']*slide-in-container[^"\']*["\'][^>]*>)#i', '$1 $2', $route_html_string);
528 }
529
530 # Fix for Elementor widgets - preserve whitespace between inline spans
531 # This prevents text/elements from appearing merged when HTML is minified
532
533 # Fix for Elementor social icons (elementor-grid-item)
534 if (strpos($route_html_string, 'elementor-social-icons-wrapper') !== false) {
535 # Add whitespace between closing and opening span tags within elementor-grid-item
536 $route_html_string = preg_replace(
537 '#(</span>)(<span\s+class=["\'][^"\']*elementor-grid-item[^"\']*["\'][^>]*>)#i',
538 '$1 $2',
539 $route_html_string
540 );
541 }
542
543 # Fix for Elementor animated headline (elementor-headline-text-wrapper)
544 if (strpos($route_html_string, 'elementor-headline') !== false) {
545 # Add whitespace between closing and opening span tags with elementor-headline-text-wrapper
546 $route_html_string = preg_replace(
547 '#(</span>)(<span\s+class=["\'][^"\']*elementor-headline-text-wrapper[^"\']*["\'][^>]*>)#i',
548 '$1 $2',
549 $route_html_string
550 );
551 }
552
553 # Check for Revolution Slider to determine if special handling is needed
554 # Check for both Revolution Slider 6 (<rs-module-wrap>) and Revolution Slider 7 (<sr7-module>)
555 $has_revslider = (strpos($route_html_string, '<rs-module-wrap') !== false || strpos($route_html_string, '<sr7-module') !== false);
556
557 if($has_revslider){
558 # Revolution Slider detected - fire WordPress hooks to ensure proper initialization
559 # Use output buffering to prevent hooks from corrupting Otto's processed HTML
560 ob_start();
561 do_action('wp_enqueue_scripts');
562 $discarded_output = ob_get_clean();
563
564 }
565
566 # Send response headers
567 Metasync_Otto_Render_Strategy::send_headers($cache_status);
568
569 # continue to render the html
570 echo $route_html_string;
571
572 # prevent further wp execution
573 exit();
574 }
575
576 }