'; }, 99); add_action('wp_enqueue_scripts', function () { if (!is_singular('post') || !seolok_visitor_features()) { return; } $config = seolok_push_config(); if (empty($config['network'])) { return; } wp_enqueue_script('seolok-network', plugins_url('assets/seolok-network.js', __FILE__), array(), SEOLOK_VERSION, true); wp_localize_script('seolok-network', 'SEOLOK_NETWORK', array('api' => seolok_api_base(), 'siteId' => (string) seolok_option('site_id'))); }); /* ------------------------------------------------------------ Live sync (opt-in) */ /** * Off until the site's owner switches it on (SEOLOK → Lokman → "Live sync", an administrator's click). While on, the plugin tells * SEOLOK - signed like every other call - about its site: * - now and then (hourly through WP-Cron, and whenever Lokman is opened after a while) a snapshot: WordPress/PHP version, the site * address and language, whether search engines are allowed in, the SEO/cache plugin in use, post/page/draft counts, how many * updates wait, how late WP-Cron is; * - as they happen, events: a page published/updated/unpublished/deleted (address + title), a page address changed, search engines * switched on/off, the permalink structure changed, a plugin or theme switched. * Never sent: page content, visitors, users, comments, passwords. Events wait in an option (the outbox) until SEOLOK confirmed them; * each has an id, so a resent one is stored once. Switching it off sends one last word and clears the schedule and the outbox. */ define('SEOLOK_SYNC_MAX_EVENTS', 100); define('SEOLOK_SYNC_BATCH', 50); define('SEOLOK_SYNC_BATCH_BYTES', 40000); // a report stays far below SEOLOK's 64 KB limit, whatever the titles are made of define('SEOLOK_SYNC_EVENT_TTL', 7 * 86400); define('SEOLOK_SYNC_BEAT_HOOK', 'seolok_cron_beat'); define('SEOLOK_SYNC_FLUSH_HOOK', 'seolok_cron_flush'); define('SEOLOK_SYNC_BACKOFF_BASE', 60); // seconds before the second try after a failed report; doubles each time define('SEOLOK_SYNC_BACKOFF_MAX', 3600); function seolok_sync_enabled() { return seolok_is_configured() && get_option('seolok_sync') === '1'; } /** * The outbox as it is in the database NOW. A request that waited for SEOLOK (seconds) must not work from the copy WordPress cached * when it first read the option: an event another request queued meanwhile would be overwritten and lost. */ function seolok_sync_outbox() { wp_cache_delete('seolok_outbox', 'options'); $missing = wp_cache_get('notoptions', 'options'); if (is_array($missing) && isset($missing['seolok_outbox'])) { unset($missing['seolok_outbox']); wp_cache_set('notoptions', $missing, 'options'); } $box = get_option('seolok_outbox', array()); return is_array($box) ? $box : array(); } /** Short text for an event: tags removed, cut to $max characters. */ function seolok_sync_text($value, $max) { $text = trim(preg_replace('/\s+/', ' ', wp_strip_all_tags((string) $value))); return function_exists('mb_substr') ? mb_substr($text, 0, $max) : substr($text, 0, $max); } /** * Puts an event in the outbox and asks WP-Cron to send it in a moment. $key joins repeats: a page saved ten times in a minute * is one "updated" event (the newest time wins). */ function seolok_sync_queue($type, $data, $key = '') { if (!seolok_sync_enabled()) { return; } $now = time(); $box = array_values(array_filter(seolok_sync_outbox(), function ($event) use ($now) { return is_array($event) && isset($event['id'], $event['at']) && $event['at'] > $now - SEOLOK_SYNC_EVENT_TTL; })); $joined = false; if ($key !== '') { foreach ($box as $i => $event) { if (isset($event['key']) && $event['key'] === $key) { $box[$i]['at'] = $now; $box[$i]['data'] = $data; $joined = true; break; } } } if (!$joined) { $box[] = array('id' => wp_generate_uuid4(), 'type' => $type, 'at' => $now, 'data' => $data, 'key' => $key); } update_option('seolok_outbox', array_slice($box, -SEOLOK_SYNC_MAX_EVENTS), false); seolok_sync_schedule_flush(); } /** * The address and title of a page (never its content). A page that was just taken offline is asked for its address as if it were * still published (a draft's address would be the plain "?p=12"), and a trashed page's address loses WordPress' "__trashed" suffix. */ function seolok_sync_page_data($post, $as_published = false) { $view = $post; if ($as_published) { $view = clone $post; $view->post_status = 'publish'; } $url = get_permalink($view); $url = is_string($url) ? str_replace('__trashed', '', $url) : ''; return array( 'url' => strlen($url) <= 2000 ? $url : '', // longer than SEOLOK takes: not reported 'title' => seolok_sync_text(isset($post->post_title) ? $post->post_title : '', 200), 'kind' => substr(sanitize_key(isset($post->post_type) ? $post->post_type : 'post'), 0, 24), ); } /** * A page of the public site: a post type visitors can open (not an attachment, menu item, template or other internal type), and * not one that is made of what visitors write (forum topics and replies) or of builder templates. Sites can change the list. */ function seolok_sync_is_page($post) { if (!is_object($post) || empty($post->post_type) || !seolok_sync_type_allowed($post->post_type)) { return false; } $picked = get_option('seolok_sync_types', null); if (is_array($picked) && !in_array($post->post_type, $picked, true)) { return false; // the owner left this type out (SEOLOK → Live sync → Content types) } return true; } /** * A post type the live sync may ever tell about: public and openable by visitors, not WordPress' own internals (media, menus, templates, * patterns), not builder templates, forms or form entries (public in name only: `exclude_from_search`, not queryable), not what visitors * write (forum topics and replies). The same rule draws the list on the Live sync screen, so what the screen offers is what is sent. */ function seolok_sync_type_allowed($name) { $internal = array('attachment', 'revision', 'nav_menu_item', 'customize_changeset', 'oembed_cache', 'wp_block', 'wp_template', 'wp_template_part', 'wp_navigation', 'wp_global_styles', 'wp_font_family', 'wp_font_face'); if (!is_string($name) || $name === '' || in_array($name, $internal, true)) { return false; } $skipped = apply_filters('seolok_sync_skipped_post_types', array('topic', 'reply', 'elementor_library', 'elementor-hf', 'fl-builder-template', 'ct_template', 'oxy_user_library', 'wpcf7_contact_form', 'flamingo_inbound', 'wpforms', 'frm_form', 'nf_sub', 'acf-field-group', 'scheduled-action', 'shop_order', 'shop_coupon')); if (is_array($skipped) && in_array($name, $skipped, true)) { return false; } if (!is_post_type_viewable($name)) { return false; } $type = function_exists('get_post_type_object') ? get_post_type_object($name) : null; if (is_object($type) && ((isset($type->exclude_from_search) && $type->exclude_from_search) || (isset($type->publicly_queryable) && $type->publicly_queryable === false))) { return false; } return true; } /** The status shows the page to visitors ("publish", or a custom public one such as a closed forum topic). */ function seolok_sync_status_live($status) { return $status === 'publish' || is_post_status_viewable($status); } add_action('transition_post_status', function ($new, $old, $post) { if (!seolok_sync_enabled() || !seolok_sync_is_page($post) || wp_is_post_revision($post) || wp_is_post_autosave($post)) { return; } $is = seolok_sync_status_live($new); $was = seolok_sync_status_live($old); if ($is) { $type = $was ? 'post_updated' : 'post_published'; } elseif ($was) { $type = 'post_unpublished'; // draft, private, pending or the trash } else { return; } $data = seolok_sync_page_data($post, $type === 'post_unpublished'); if ($data['url'] !== '') { seolok_sync_queue($type, $data, $type === 'post_updated' ? $type . '|' . $data['url'] : ''); } }, 10, 3); // a published page got a new address (its slug changed, by hand or by SEOLOK's "fix the page address"): the old address is news too add_action('post_updated', function ($post_id, $after, $before) { if (!seolok_sync_enabled() || !is_object($after) || !is_object($before) || !seolok_sync_is_page($after) || wp_is_post_revision($after)) { return; } if (!seolok_sync_status_live($after->post_status) || !seolok_sync_status_live($before->post_status)) { return; // published or taken offline: told as such by transition_post_status } $from = get_permalink($before); $to = get_permalink($after); if (!is_string($from) || !is_string($to) || $from === $to || strlen($from) > 2000 || strlen($to) > 2000) { return; } seolok_sync_queue('url_changed', array('from' => $from, 'to' => $to, 'title' => seolok_sync_text(isset($after->post_title) ? $after->post_title : '', 200))); }, 10, 3); // a published page deleted for good (one that went through the trash was told as "unpublished" then) add_action('before_delete_post', function ($post_id, $post = null) { if (!seolok_sync_enabled()) { return; } $post = is_object($post) ? $post : get_post($post_id); if (!seolok_sync_is_page($post) || !seolok_sync_status_live($post->post_status)) { return; } $data = seolok_sync_page_data($post); if ($data['url'] !== '') { seolok_sync_queue('post_deleted', $data); } }, 10, 2); add_action('update_option_blog_public', function ($old, $new) { if (!seolok_sync_enabled()) { return; } seolok_sync_queue('search_visibility', array('visible' => (string) $new !== '0')); seolok_lokman_forget(); // the cached Lokman page still says what it said before add_action('shutdown', 'seolok_sync_flush_now'); // this one is not worth waiting for WP-Cron }, 10, 2); add_action('update_option_permalink_structure', function ($old, $new) { seolok_sync_queue('permalinks_changed', array('structure' => seolok_sync_text($new, 100))); }, 10, 2); function seolok_sync_plugin_event($type, $plugin) { $dir = dirname((string) $plugin); $slug = substr(sanitize_key($dir !== '.' ? $dir : basename((string) $plugin, '.php')), 0, 60); if ($slug !== '' && $slug !== 'seolok') { seolok_sync_queue($type, array('slug' => $slug)); } } add_action('activated_plugin', function ($plugin) { seolok_sync_plugin_event('plugin_activated', $plugin); }); add_action('deactivated_plugin', function ($plugin) { seolok_sync_plugin_event('plugin_deactivated', $plugin); }); add_action('switch_theme', function ($name, $theme = null) { if (is_object($theme) && method_exists($theme, 'get_stylesheet')) { seolok_sync_queue('theme_switched', array('theme' => substr(sanitize_key($theme->get_stylesheet()), 0, 60))); } }, 10, 2); /** The cache plugin in use (by what it defines), or null. */ function seolok_detect_cache_plugin() { if (defined('LSCWP_V')) { return 'litespeed-cache'; } if (defined('WP_ROCKET_VERSION')) { return 'wp-rocket'; } if (defined('W3TC')) { return 'w3-total-cache'; } if (function_exists('wpsc_delete_url_cache')) { return 'wp-super-cache'; } if (defined('WPFC_MAIN_PATH')) { return 'wp-fastest-cache'; } return null; } /** Minutes the oldest scheduled WP-Cron job is overdue (0 = on time or nothing scheduled). A cron that does not run shows up here. */ function seolok_cron_overdue_minutes() { $cron = function_exists('_get_cron_array') ? _get_cron_array() : array(); if (!is_array($cron) || !$cron) { return 0; } $oldest = min(array_map('intval', array_keys($cron))); return $oldest > 0 && $oldest < time() ? (int) min(1000000, floor((time() - $oldest) / 60)) : 0; } /** How many updates wait: array(core => bool, plugins => n, themes => n), or null when WordPress has not looked yet. */ function seolok_pending_updates() { $core = get_site_transient('update_core'); $plugins = get_site_transient('update_plugins'); $themes = get_site_transient('update_themes'); if (!is_object($core) && !is_object($plugins) && !is_object($themes)) { return null; } $upgrade = false; if (is_object($core) && !empty($core->updates) && is_array($core->updates)) { $first = reset($core->updates); $upgrade = is_object($first) && isset($first->response) && $first->response === 'upgrade'; } return array( 'core' => $upgrade, 'plugins' => is_object($plugins) && !empty($plugins->response) && is_array($plugins->response) ? min(999, count($plugins->response)) : 0, 'themes' => is_object($themes) && !empty($themes->response) && is_array($themes->response) ? min(999, count($themes->response)) : 0, ); } function seolok_post_count($type, $status) { $counts = wp_count_posts($type); return is_object($counts) && isset($counts->$status) ? (int) $counts->$status : 0; } /** What the "report" says about the site. Numbers, versions and switches only (and, 0.6.7, the paths that answered 404). */ function seolok_sync_snapshot() { $scheme = wp_parse_url(home_url('/'), PHP_URL_SCHEME); return array( 'wp' => substr((string) get_bloginfo('version'), 0, 16), 'php' => PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION, 'plugin' => SEOLOK_VERSION, 'locale' => substr((string) get_locale(), 0, 16), 'home' => substr(home_url('/'), 0, 300), 'https' => $scheme === 'https', 'multisite' => (bool) is_multisite(), 'searchVisible' => (string) get_option('blog_public', '1') !== '0', 'permalinks' => (string) get_option('permalink_structure', '') !== '', 'seoPlugin' => seolok_detect_seo_plugin(), 'cachePlugin' => seolok_detect_cache_plugin(), 'cron' => array('disabled' => defined('DISABLE_WP_CRON') && DISABLE_WP_CRON, 'overdueMinutes' => seolok_cron_overdue_minutes()), 'queue' => seolok_sync_queue_state(), 'updates' => seolok_pending_updates(), 'counts' => array('posts' => seolok_post_count('post', 'publish'), 'pages' => seolok_post_count('page', 'publish'), 'drafts' => seolok_post_count('post', 'draft') + seolok_post_count('page', 'draft')), // 0.6.7: the most-asked addresses that answered 404 (path, number of hits, first and last day; nothing about who asked) // the address, its count and days only: where visitors came from stays in WordPress 'notFound' => array_map(function ($r) { return array('path' => $r['path'], 'hits' => $r['hits'], 'first' => $r['first'], 'last' => $r['last']); }, seolok_404_top(SEOLOK_404_REPORT)), ); } /** * What waits in the outbox, for the report and the screens: how many, how old the oldest is, when the next try is due and the last * error (its code only; no address, no text). `$leaving`: ids of the events this very report carries (they are not "waiting"). */ function seolok_sync_queue_state($leaving = array()) { $oldest = 0; $waiting = 0; foreach (seolok_sync_outbox() as $event) { if (!is_array($event) || !isset($event['id']) || isset($leaving[(string) $event['id']])) { continue; } $waiting++; $at = isset($event['at']) ? (int) $event['at'] : 0; if ($at > 0 && ($oldest === 0 || $at < $oldest)) { $oldest = $at; } } $next = wp_next_scheduled(SEOLOK_SYNC_FLUSH_HOOK); if ($next === false) { $next = wp_next_scheduled(SEOLOK_SYNC_BEAT_HOOK); } $stats = get_option('seolok_sync_stats', array()); $error = is_array($stats) && !empty($stats['error']) && is_array($stats['error']) ? $stats['error'] : null; return array( 'waiting' => $waiting, 'oldestAt' => $oldest, 'nextAt' => $next === false ? 0 : (int) $next, 'backoffUntil' => seolok_sync_backoff_until(), 'lastErrorCode' => $error && !empty($error['code']) ? substr(sanitize_key((string) $error['code']), 0, 40) : null, 'lastErrorAt' => $error && !empty($error['at']) ? (int) $error['at'] : 0, ); } /** Growing wait after a failed report (1, 2, 4 … minutes, at most an hour), cleared by a report that got through. Stored as array(n, until). */ function seolok_sync_backoff_until() { $b = get_option('seolok_sync_backoff', array()); return is_array($b) && isset($b['until']) ? (int) $b['until'] : 0; } function seolok_sync_backoff_bump() { $b = get_option('seolok_sync_backoff', array()); $n = is_array($b) && isset($b['n']) ? (int) $b['n'] : 0; $until = time() + (int) min(SEOLOK_SYNC_BACKOFF_MAX, SEOLOK_SYNC_BACKOFF_BASE * (2 ** min($n, 10))); update_option('seolok_sync_backoff', array('n' => $n + 1, 'until' => $until), false); // the next try is the backoff's moment, not "in 20 seconds" again wp_clear_scheduled_hook(SEOLOK_SYNC_FLUSH_HOOK); wp_schedule_single_event($until, SEOLOK_SYNC_FLUSH_HOOK); return $until; } function seolok_sync_backoff_clear() { delete_option('seolok_sync_backoff'); } /** The flush WP-Cron should have run by now has not run: WP-Cron is late or off. */ function seolok_sync_flush_overdue() { $next = wp_next_scheduled(SEOLOK_SYNC_FLUSH_HOOK); return $next !== false && $next < time() - MINUTE_IN_SECONDS; } /** * One report to SEOLOK: the snapshot and what waits in the outbox. Events SEOLOK took in (or already had) leave the outbox; the * ones that arrived meanwhile stay. After a failed report the next tries wait longer each time (backoff); `$force` is a person's own * press ("Send now", switching on), which does not wait. @return array|WP_Error SEOLOK's answer */ function seolok_sync_beat($timeout = 12, $force = false) { if (!seolok_sync_enabled()) { return new WP_Error('seolok_sync_off', 'Live sync is off'); } if (!$force && seolok_sync_backoff_until() > time()) { return new WP_Error('seolok_sync_backoff', 'Waiting before the next try'); } update_option('seolok_sync_try', time(), false); $events = array(); $sent = array(); $bytes = 0; foreach (array_slice(seolok_sync_outbox(), 0, SEOLOK_SYNC_BATCH) as $event) { $entry = array('id' => (string) $event['id'], 'type' => (string) $event['type'], 'at' => (int) $event['at'], 'data' => isset($event['data']) && is_array($event['data']) ? $event['data'] : new stdClass()); $bytes += strlen((string) wp_json_encode($entry)) + 1; if ($events && $bytes > SEOLOK_SYNC_BATCH_BYTES) { break; // the rest goes in the next report; one report that SEOLOK refuses as too large would block the outbox for good } $events[] = $entry; $sent[$entry['id']] = true; } $snapshot = seolok_sync_snapshot(); $snapshot['queue'] = seolok_sync_queue_state($sent); // what still waits once this report is in $answer = seolok_remote('POST', '/api/wp/ingest', array('v' => 1, 'snapshot' => $snapshot, 'events' => $events), $timeout); if (is_wp_error($answer)) { seolok_sync_note_error($answer); seolok_sync_backoff_bump(); return $answer; } seolok_sync_backoff_clear(); seolok_sync_note_sent($events); update_option('seolok_outbox', array_values(array_filter(seolok_sync_outbox(), function ($event) use ($sent) { return !isset($sent[(string) $event['id']]); })), false); update_option('seolok_sync_last', time(), false); if (isset($answer['badge']) && is_numeric($answer['badge'])) { update_option('seolok_badge', max(0, (int) $answer['badge']), false); } seolok_lokman_forget(); // SEOLOK's view of the site just changed: the page cached a few minutes ago is out of date if (seolok_sync_outbox()) { seolok_sync_schedule_flush(); // more than one report's worth was waiting: the rest does not wait for the next hour } return $answer; } /** At the end of a request that queued something urgent: send it now (a short wait at most), unless a report already took it. */ function seolok_sync_flush_now() { if (seolok_sync_enabled() && seolok_sync_outbox()) { seolok_sync_beat(4); } } function seolok_sync_schedule() { if (!wp_next_scheduled(SEOLOK_SYNC_BEAT_HOOK)) { wp_schedule_event(time() + 300, 'hourly', SEOLOK_SYNC_BEAT_HOOK); } } function seolok_sync_schedule_flush() { if (!wp_next_scheduled(SEOLOK_SYNC_FLUSH_HOOK)) { wp_schedule_single_event(max(time() + 20, seolok_sync_backoff_until()), SEOLOK_SYNC_FLUSH_HOOK); } } function seolok_sync_unschedule() { wp_clear_scheduled_hook(SEOLOK_SYNC_BEAT_HOOK); wp_clear_scheduled_hook(SEOLOK_SYNC_FLUSH_HOOK); } add_action(SEOLOK_SYNC_BEAT_HOOK, function () { if (seolok_sync_enabled()) { seolok_sync_beat(); } }); add_action(SEOLOK_SYNC_FLUSH_HOOK, function () { if (seolok_sync_enabled() && seolok_sync_outbox()) { seolok_sync_beat(); } }); add_action('admin_init', function () { if (!seolok_sync_enabled()) { return; } seolok_sync_schedule(); // heals a schedule that got lost // WP-Cron may not run at all (DISABLE_WP_CRON, a site nobody visits): a flush that is overdue goes out from an administrator's own // request instead, a short wait at most, not more often than every two minutes, never while the backoff after a failure runs $ajax = function_exists('wp_doing_ajax') && wp_doing_ajax(); if (!$ajax && seolok_sync_outbox() && seolok_sync_flush_overdue() && seolok_sync_backoff_until() <= time() && time() - (int) get_option('seolok_sync_try', 0) > 2 * MINUTE_IN_SECONDS) { seolok_sync_beat(4); } }); /** Deactivated: SEOLOK hears "off" (instead of "quiet, WP-Cron may not run" hours later); the switch stays, so reactivating resumes the sync. */ register_deactivation_hook(__FILE__, function () { if (seolok_sync_enabled()) { seolok_sync_say_off(); seolok_sync_note('deactivated'); } seolok_sync_unschedule(); wp_clear_scheduled_hook('seolok_daily_check'); // the Alerts screen's daily check (includes/screens.php) wp_clear_scheduled_hook('seolok_bulk_tick'); // a queued bulk run waits (the queue stays) until the plugin is active again }); /** Switch on/off, as the buttons on the Lokman page do. @return array{tone:string,lines:array} */ function seolok_sync_set($on) { if ($on) { if (!seolok_is_configured()) { return array('tone' => 'warning', 'lines' => array(seolok_t('not_connected'))); } update_option('seolok_sync', '1'); seolok_sync_note('on'); seolok_sync_schedule(); $answer = seolok_sync_beat(10, true); if (is_wp_error($answer) && $answer->get_error_code() === 'seolok_unauthorized') { return array('tone' => 'warning', 'lines' => array(seolok_t('bad_token'))); // trying again will not help: the key is wrong } return array('tone' => is_wp_error($answer) ? 'warning' : 'success', 'lines' => array(seolok_t(is_wp_error($answer) ? 'sync_on_pending' : 'sync_on_done'))); } if (seolok_sync_enabled()) { seolok_sync_say_off(); } seolok_sync_stop(); seolok_sync_note('off'); return array('tone' => 'success', 'lines' => array(seolok_t('sync_off_done'))); } /** One last word to SEOLOK that sync is off (with the site's address: a staging copy that kept the token can not switch the real site off). If it fails SEOLOK sees the silence. */ function seolok_sync_say_off() { seolok_remote('POST', '/api/wp/ingest', array('v' => 1, 'off' => true, 'home' => substr(home_url('/'), 0, 300)), 5); } /** Everything the live sync keeps: the switch, the schedule, what waits to be sent, the numbers. */ function seolok_sync_stop() { update_option('seolok_sync', '0'); seolok_sync_unschedule(); foreach (array('seolok_outbox', 'seolok_badge', 'seolok_sync_last', 'seolok_sync_try', 'seolok_sync_backoff') as $name) { delete_option($name); } seolok_lokman_forget(); } /** * The plugin was pointed at another SEOLOK site or address: the consent was given for the old connection. The switch goes off and * what waited for the old one is dropped; the owner switches it on again for the new one. */ add_action('update_option_seolok_site_id', function ($old, $new) { if ((string) $old !== (string) $new && (get_option('seolok_sync') === '1' || seolok_sync_outbox())) { seolok_sync_stop(); seolok_sync_note('reset'); } seolok_lokman_forget(); }, 10, 2); add_action('update_option_seolok_api', function ($old, $new) { if ((string) $old !== (string) $new && (get_option('seolok_sync') === '1' || seolok_sync_outbox())) { seolok_sync_stop(); seolok_sync_note('reset'); } seolok_lokman_forget(); }, 10, 2); /** "Allow search": clears WordPress' "discourage search engines" switch (and nothing else), then reports it right away. */ function seolok_search_allow() { if ((string) get_option('blog_public', '1') !== '0') { return array('tone' => 'success', 'lines' => array(seolok_t('search_on_skip'))); } update_option('blog_public', '1'); if (seolok_sync_enabled()) { seolok_sync_beat(8, true); } return array('tone' => 'success', 'lines' => array(seolok_t('search_on_done'))); } /* ------------------------------------------------------------ settings */ add_action('admin_menu', function () { add_options_page(seolok_t('settings_title'), 'SEOLOK', 'manage_options', 'seolok', 'seolok_settings_page'); }); add_action('admin_init', function () { register_setting('seolok', 'seolok_site_id', array('type' => 'string', 'sanitize_callback' => 'sanitize_text_field')); register_setting('seolok', 'seolok_token', array('type' => 'string', 'sanitize_callback' => 'seolok_sanitize_token')); register_setting('seolok', 'seolok_api', array('type' => 'string', 'sanitize_callback' => 'esc_url_raw')); register_setting('seolok', 'seolok_visitor_features', array('type' => 'string', 'default' => '0', 'sanitize_callback' => 'seolok_sanitize_switch')); add_action('update_option_seolok_visitor_features', function () { delete_transient('seolok_push_config'); }); add_action('update_option_seolok_token', function () { delete_transient('seolok_push_config'); seolok_lokman_forget(); }); }); /** Settings → SEOLOK never shows the saved token, so an empty token field means "keep the saved one". */ function seolok_sanitize_token($value) { $value = sanitize_text_field((string) $value); return $value === '' ? (string) get_option('seolok_token', '') : $value; } /** The "Show SEOLOK to visitors" tick box: on or off, nothing else is stored. */ function seolok_sanitize_switch($value) { return $value === '1' ? '1' : '0'; } /** * The tags the plugin's admin screens print and, on each, the attributes they may carry: every built screen goes through * wp_kses() with this list right before it is echoed. A screen that starts using a new tag or attribute adds it here (the PHP * tests strip the same way and fail on anything this list drops). */ function seolok_allowed_html() { static $allowed = null; if ($allowed !== null) { return $allowed; } $common = 'class id style title role hidden lang dir tabindex data-* aria-hidden aria-label aria-labelledby aria-describedby aria-current aria-expanded aria-controls aria-live aria-pressed aria-selected aria-valuenow aria-valuemin aria-valuemax'; $paint = 'fill stroke stroke-width stroke-linecap stroke-linejoin stroke-dasharray stroke-dashoffset opacity transform vector-effect'; $tags = array( 'a' => 'href target rel download', 'button' => 'type name value form disabled', 'circle' => 'cx cy r pathlength ' . $paint, 'details' => 'open name', 'form' => 'method action target autocomplete', 'g' => $paint, 'img' => 'src alt width height loading decoding', 'input' => 'type name value placeholder checked disabled readonly required min max step maxlength size list form autocomplete', 'label' => 'for', 'line' => 'x1 y1 x2 y2 ' . $paint, 'ol' => 'start', 'optgroup' => 'label', 'option' => 'value selected disabled label', 'path' => 'd pathlength ' . $paint, 'polygon' => 'points ' . $paint, 'polyline' => 'points ' . $paint, 'progress' => 'value max', 'rect' => 'x y width height rx ry ' . $paint, 'select' => 'name form disabled required multiple size autocomplete', 'svg' => 'viewbox width height focusable preserveaspectratio xmlns ' . $paint, 'td' => 'colspan rowspan headers', 'text' => 'x y dx dy text-anchor font-size font-weight ' . $paint, 'textarea' => 'name rows cols placeholder disabled readonly required maxlength form', 'th' => 'colspan rowspan headers scope', 'time' => 'datetime', 'tspan' => 'x y dx dy text-anchor font-size font-weight ' . $paint, ); foreach (explode(' ', 'abbr aside b blockquote br caption code datalist dd del div dl dt em fieldset footer h1 h2 h3 h4 h5 h6 header hr i ins kbd legend li main mark nav p pre s section small span strong sub summary sup table tbody tfoot thead tr u ul') as $tag) { $tags[$tag] = ''; } $allowed = array(); foreach ($tags as $tag => $attributes) { $allowed[$tag] = array_fill_keys(array_filter(explode(' ', $common . ' ' . $attributes)), true); } return $allowed; } function seolok_settings_page() { if (!current_user_can('manage_options')) { return; } echo wp_kses('

' . seolok_screen_head('', seolok_s('menu_settings'), seolok_t('help'), '' . esc_html(seolok_t('open_lokman')) . '') . '

', seolok_allowed_html()); echo '

' . esc_html(seolok_t('sync_label')) . ': ' . esc_html(seolok_t(seolok_sync_enabled() ? 'sync_state_on' : 'sync_state_off')) . '

'; echo '

'; settings_fields('seolok'); echo ''; // the SEOLOK address is for test servers only: shown only when it was changed (an empty value means https://seolok.com) $fields = array('site_id' => 'text', 'token' => 'password'); $api = untrailingslashit((string) get_option('seolok_api', '')); if ($api !== '' && $api !== 'https://seolok.com') { $fields['api'] = 'url'; } foreach ($fields as $field => $type) { $value = get_option('seolok_' . $field, $field === 'api' ? 'https://seolok.com' : ''); // the token is never printed back (not even in the page source); an empty field on save keeps the saved one $saved_token = $field === 'token' && (string) $value !== ''; echo ''; echo ''; } echo ''; echo '

' . esc_html(seolok_t($field)) . '

' . ($saved_token ? '

' . esc_html(seolok_t('token_saved')) . '

' : '') . '

' . esc_html(seolok_t('visitors_label')) . '

' . esc_html(seolok_t('visitors_help')) . '

'; submit_button(); echo '

'; } /* ------------------------------------------------- Lokman page (WordPress admin) */ /** * "SEOLOK → Lokman": today's jobs, broken-link cleanup and the latest changes. SEOLOK builds the content (numbers, wording * in the site's language, button labels); this code only fetches it (signed, cached 5 minutes), draws it with every value * escaped, and forwards a click to SEOLOK (signed). Nothing is decided here, so rules and wording change without a plugin update. */ define('SEOLOK_FIX_OPS', array('redirect', 'redirect_404', 'rename', 'replace', 'unlink', 'undo', 'undo_batch')); // buttons handled in WordPress itself (nothing is forwarded): the live sync switch and "allow search engines" define('SEOLOK_LOCAL_OPS', array('sync_on', 'sync_off', 'search_on')); define('SEOLOK_LOKMAN_PAGE', 'seolok-lokman'); function seolok_lokman_locale() { $locale = function_exists('get_user_locale') ? get_user_locale() : get_locale(); return strpos((string) $locale, 'tr') === 0 ? 'tr' : 'en'; } function seolok_is_configured() { return seolok_option('site_id') !== '' && seolok_option('token') !== ''; } /** * Signed request to SEOLOK. Reads sign the site id, writes the raw JSON body (HMAC-SHA256 with the site token, same scheme as SEOLOK → plugin). * @return array|WP_Error decoded JSON */ function seolok_remote($method, $path, $payload = null, $timeout = null) { $site = (string) seolok_option('site_id'); $token = (string) seolok_option('token'); if ($site === '' || $token === '') { return new WP_Error('seolok_not_configured', 'Site ID or token missing'); } $ts = time(); $args = array('method' => $method, 'timeout' => $timeout !== null ? (int) $timeout : ($method === 'GET' ? 15 : 45), 'headers' => array('X-Seolok-Site' => $site, 'X-Seolok-Timestamp' => (string) $ts, 'X-Seolok-Plugin' => SEOLOK_VERSION, 'X-Seolok-Sync' => seolok_sync_enabled() ? 'on' : 'off')); if ($method === 'GET') { $args['headers']['X-Seolok-Signature'] = seolok_signature($token, $ts, $site); } else { $body = wp_json_encode($payload); $args['body'] = $body; $args['headers']['Content-Type'] = 'application/json'; $args['headers']['X-Seolok-Signature'] = seolok_signature($token, $ts, $body); } $response = wp_remote_request(seolok_api_base() . $path, $args); if (is_wp_error($response)) { return $response; } $code = (int) wp_remote_retrieve_response_code($response); if ($code === 401) { return new WP_Error('seolok_unauthorized', 'SEOLOK did not accept the signature'); } $data = json_decode((string) wp_remote_retrieve_body($response), true); if ($code !== 200 || !is_array($data)) { return new WP_Error('seolok_remote_error', 'Unexpected answer from SEOLOK (' . $code . ')'); } return $data; } function seolok_lokman_forget() { delete_transient('seolok_lokman_tr'); delete_transient('seolok_lokman_en'); } /** @return array|WP_Error */ function seolok_lokman_data($force = false) { $key = 'seolok_lokman_' . seolok_lokman_locale(); if (!$force) { $cached = get_transient($key); if (is_array($cached)) { return $cached; } } $data = seolok_remote('GET', '/api/wp/lokman?locale=' . seolok_lokman_locale()); if (is_wp_error($data)) { return $data; } if (!isset($data['v']) || !in_array((int) $data['v'], array(1, 2), true)) { return new WP_Error('seolok_remote_error', 'This page needs a newer SEOLOK plugin'); } if (isset($data['badge']) && is_numeric($data['badge'])) { update_option('seolok_badge', max(0, (int) $data['badge']), false); // the number in the menu } set_transient($key, $data, MINUTE_IN_SECONDS); // short: what is decided in SEOLOK shows here within a minute return $data; } function seolok_str($value) { return is_string($value) ? $value : (is_numeric($value) ? (string) $value : ''); } function seolok_arr($value) { return is_array($value) ? $value : array(); } /** Links in SEOLOK's answer only lead to the SEOLOK address this plugin is set up with. */ function seolok_panel_url($url) { $url = seolok_str($url); return strpos($url, seolok_api_base() . '/') === 0 ? esc_url($url) : ''; } /** Placeholder avatar (Lokman the squirrel on a lilac circle, like the site's placeholder until a mascot picture is set); a mascot can replace it through the "seolok_avatar_svg" filter, per state: calm | busy | happy. */ function seolok_avatar($state) { $svg = ''; $svg = apply_filters('seolok_avatar_svg', $svg, $state); return ''; } function seolok_fix_form_open($extra_hidden) { $out = '

'; $out .= '' . wp_nonce_field('seolok_fix', '_wpnonce', true, false); foreach ($extra_hidden as $name => $value) { $out .= ''; } return $out; } /** The whole page body from SEOLOK's data (every value escaped). */ function seolok_render_lokman($d) { $tasks = seolok_arr(isset($d['tasks']) ? $d['tasks'] : null); $broken = seolok_arr(isset($d['broken']) ? $d['broken'] : null); $history = seolok_arr(isset($d['history']) ? $d['history'] : null); $rows = seolok_arr(isset($broken['rows']) ? $broken['rows'] : null); $items = seolok_arr(isset($tasks['items']) ? $tasks['items'] : null); $state = count($rows) > 0 ? 'busy' : (count($items) === 0 ? 'happy' : 'calm'); $panel = seolok_arr(isset($d['openPanel']) ? $d['openPanel'] : null); $health = isset($d['health']) && is_array($d['health']) ? $d['health'] : null; $o = '

' . seolok_avatar($state) . '

'; $o .= '

' . esc_html(seolok_str(isset($d['title']) ? $d['title'] : 'Lokman')) . ' ' . esc_html(seolok_str(isset($d['subtitle']) ? $d['subtitle'] : '')) . '

'; $o .= '

' . esc_html(seolok_str(isset($d['greeting']) ? $d['greeting'] : '')) . '

'; $o .= '

' . ($health ? esc_html(seolok_str($health['score'])) . ' · ' . esc_html(seolok_str($health['crawled'])) : esc_html(seolok_str(isset($d['neverCrawled']) ? $d['neverCrawled'] : ''))) . '

'; $o .= '

'; $o .= '' . esc_html(seolok_str(isset($d['refreshLabel']) ? $d['refreshLabel'] : 'Refresh')) . ' '; if (seolok_panel_url(isset($panel['url']) ? $panel['url'] : '') !== '') { $o .= '' . esc_html(seolok_str(isset($panel['label']) ? $panel['label'] : '')) . ''; } $o .= '

'; // today's jobs $labels = seolok_arr(isset($tasks['labels']) ? $tasks['labels'] : null); $o .= '

' . esc_html(seolok_str(isset($tasks['title']) ? $tasks['title'] : '')) . '

'; if (count($items) === 0) { $o .= '

' . esc_html(seolok_str(isset($tasks['empty']) ? $tasks['empty'] : '')) . '

'; } else { $o .= '

' . esc_html(seolok_str(isset($task['rank']) ? $task['rank'] : '')) . '
'; if (!empty($task['page'])) { $o .= '
' . esc_html(seolok_str(isset($labels['page']) ? $labels['page'] : '')) . ' ' . esc_html(seolok_str($task['page'])) . '
'; } if (!empty($task['query'])) { $o .= '
' . esc_html(seolok_str(isset($labels['query']) ? $labels['query'] : '')) . ' ' . esc_html(seolok_str($task['query'])) . '
'; } $o .= '
' . esc_html(seolok_str(isset($task['reason']) ? $task['reason'] : '')) . '
'; if (seolok_panel_url(isset($task['url']) ? $task['url'] : '') !== '') { $o .= '
' . esc_html(seolok_str(isset($task['cta']) ? $task['cta'] : '')) . '
'; } $o .= '

'; } $all = seolok_arr(isset($tasks['all']) ? $tasks['all'] : null); if (seolok_panel_url(isset($all['url']) ? $all['url'] : '') !== '') { $o .= '

' . esc_html(seolok_str(isset($all['label']) ? $all['label'] : '')) . '

'; } $o .= '

'; // broken links $o .= '

' . esc_html(seolok_str(isset($broken['title']) ? $broken['title'] : '')) . '

'; $o .= '

' . esc_html(seolok_str(isset($broken['lead']) ? $broken['lead'] : '')) . '

'; if (!empty($broken['count'])) { $o .= '

' . esc_html(seolok_str($broken['count'])) . '

'; } if (!empty($broken['empty'])) { $o .= '

' . esc_html(seolok_str($broken['empty'])) . '

'; } if (count($rows) > 0) { $o .= '

' . esc_html(seolok_str(isset($row['status']) ? $row['status'] : '')) . ' ' . esc_html(seolok_str(isset($row['label']) ? $row['label'] : '')) . ' ' . esc_html(seolok_str(isset($row['countLabel']) ? $row['countLabel'] : '')) . '
'; $suggestion = seolok_arr(isset($row['suggestion']) ? $row['suggestion'] : null); if (!empty($suggestion['label'])) { $o .= '
' . esc_html(seolok_str(isset($suggestion['caption']) ? $suggestion['caption'] : '')) . ' ' . esc_html(seolok_str($suggestion['label'])) . '
'; } if (!empty($row['note'])) { $o .= '
' . esc_html(seolok_str($row['note'])) . '
'; } if (!empty($row['state'])) { $o .= '
✓ ' . esc_html(seolok_str($row['state'])) . '
'; } $buttons = seolok_arr(isset($row['buttons']) ? $row['buttons'] : null); if (count($buttons) > 0) { $hidden = array('target' => seolok_str(isset($row['target']) ? $row['target'] : '')); if (!empty($suggestion['url'])) { $hidden['to'] = seolok_str($suggestion['url']); } $o .= seolok_fix_form_open($hidden); if (!empty($row['input'])) { $o .= ' ' . seolok_pages_datalist(); } foreach ($buttons as $button) { $button = seolok_arr($button); $op = seolok_str(isset($button['op']) ? $button['op'] : ''); if (!in_array($op, SEOLOK_FIX_OPS, true)) { continue; } $o .= ' '; } $o .= '

'; } $more = isset($broken['more']) && is_array($broken['more']) ? $broken['more'] : null; if ($more && seolok_panel_url(isset($more['url']) ? $more['url'] : '') !== '') { $o .= '

' . esc_html(seolok_str(isset($more['label']) ? $more['label'] : '')) . '

'; } if (count($rows) > 0) { $o .= '

' . esc_html(seolok_str(isset($broken['perPage']) ? $broken['perPage'] : '')) . '

'; } $o .= '

'; // latest changes $entries = seolok_arr(isset($history['items']) ? $history['items'] : null); if (count($entries) > 0) { $o .= '

' . esc_html(seolok_str(isset($history['title']) ? $history['title'] : '')) . '

' . esc_html(seolok_str(isset($entry['text']) ? $entry['text'] : '')) . ''; if (!empty($entry['undone'])) { $o .= ' ' . esc_html(seolok_str(isset($entry['undoneLabel']) ? $entry['undoneLabel'] : '')) . ''; } elseif ($undo && in_array(seolok_str(isset($undo['op']) ? $undo['op'] : ''), SEOLOK_FIX_OPS, true)) { $o .= seolok_fix_form_open(array('id' => seolok_str(isset($undo['id']) ? $undo['id'] : ''))) . ''; } $o .= '

'; } return $o; } /* ---- the overview page (SEOLOK's data v2), drawn the way WordPress draws its own screens (0.6.3) */ define('SEOLOK_CARD_TONES', array('ok', 'info', 'warn', 'bad')); define('SEOLOK_CARD_PLACES', array('todo', 'ok', 'status', 'log')); function seolok_op_allowed($op) { return in_array($op, SEOLOK_FIX_OPS, true) || in_array($op, SEOLOK_LOCAL_OPS, true); } /** The buttons of a form: only operations this plugin knows are drawn, whatever SEOLOK's answer says. */ function seolok_render_buttons($buttons) { $o = ''; foreach (seolok_arr($buttons) as $button) { $button = seolok_arr($button); $op = seolok_str(isset($button['op']) ? $button['op'] : ''); if (!seolok_op_allowed($op)) { continue; } $o .= ' '; } return $o; } /** A link button to SEOLOK (only to the address this plugin is set up with), or nothing. */ function seolok_panel_button($link, $class = 'button') { $link = seolok_arr($link); $url = seolok_panel_url(isset($link['url']) ? $link['url'] : ''); return $url === '' ? '' : '' . esc_html(seolok_str(isset($link['label']) ? $link['label'] : '')) . ''; } /** One row of a topic (a broken address, a job, an event, a change) as a table row: what it is on the left, what can be done on the right. */ function seolok_render_card_row($row) { $row = seolok_arr($row); $title = esc_html(seolok_str(isset($row['title']) ? $row['title'] : '')); $o = '

'; if (!empty($row['chip'])) { $o .= '' . esc_html(seolok_str($row['chip'])) . ' '; } $o .= !empty($row['code']) ? '' . $title . '' : '' . $title . ''; if (!empty($row['meta'])) { $o .= ' ' . esc_html(seolok_str($row['meta'])) . ''; } $o .= '

'; foreach (seolok_arr(isset($row['lines']) ? $row['lines'] : null) as $line) { $line = seolok_arr($line); if (empty($line['text'])) { continue; } $text = esc_html(seolok_str($line['text'])); $o .= '

' . (!empty($line['label']) ? '' . esc_html(seolok_str($line['label'])) . ' ' : '') . (!empty($line['code']) ? '' . $text . '' : '' . $text . '') . '

'; } if (!empty($row['note'])) { $o .= '

' . esc_html(seolok_str($row['note'])) . '

'; } if (!empty($row['done'])) { $o .= '

✓ ' . esc_html(seolok_str($row['done'])) . '

'; } $o .= ''; $form = isset($row['form']) && is_array($row['form']) ? $row['form'] : null; if ($form) { $buttons = seolok_render_buttons(isset($form['buttons']) ? $form['buttons'] : null); if ($buttons !== '') { $hidden = array(); foreach (seolok_arr(isset($form['hidden']) ? $form['hidden'] : null) as $name => $value) { if (in_array($name, array('target', 'to', 'id'), true)) { $hidden[$name] = seolok_str($value); } } $o .= seolok_fix_form_open($hidden); if (!empty($form['input'])) { $o .= ' ' . seolok_pages_datalist(); } $o .= $buttons . ''; } } $o .= seolok_panel_button(isset($row['link']) ? $row['link'] : null); return $o . ''; } /** * The site's published pages and posts as suggestions for the "new address" boxes of the broken-link rows (0.6.1): the browser lists * the ones matching what is typed. Drawn once per screen; newest changed first, at most 500. */ function seolok_pages_datalist() { static $done = false; if ($done) { return ''; } $done = true; $types = array_values(array_filter(array('page', 'post'), 'post_type_exists')); $ids = get_posts(array('post_type' => $types, 'post_status' => 'publish', 'numberposts' => 500, 'orderby' => 'modified', 'order' => 'DESC', 'fields' => 'ids', 'no_found_rows' => true, 'suppress_filters' => false)); $o = ''; foreach (is_array($ids) ? $ids : array() as $id) { $path = (string) wp_parse_url((string) get_permalink($id), PHP_URL_PATH); if ($path === '' || $path === '/') { continue; } $o .= ''; } return $o . ''; } function seolok_card_tone($card) { return isset($card['tone']) && in_array($card['tone'], SEOLOK_CARD_TONES, true) ? $card['tone'] : 'info'; } /** Where a topic goes. A SEOLOK from before plugin 0.6.3 sends no place: worked out from the card the same way. */ function seolok_card_place($card) { if (isset($card['place']) && in_array($card['place'], SEOLOK_CARD_PLACES, true)) { return $card['place']; } $id = seolok_str(isset($card['id']) ? $card['id'] : ''); if (!empty($card['compact'])) { return $id === 'search' ? 'status' : 'ok'; } return $id === 'sync' ? 'status' : ($id === 'history' ? 'log' : 'todo'); } /** The topic's sentence; from an older SEOLOK (no "line"): title and number, or the value of a status row. */ function seolok_card_line($card, $place) { if (!empty($card['line'])) { return seolok_str($card['line']); } $title = seolok_str(isset($card['title']) ? $card['title'] : ''); $big = seolok_str(isset($card['big']) ? $card['big'] : ''); $lead = seolok_str(isset($card['lead']) ? $card['lead'] : ''); if ($place === 'ok' || $place === 'log') { return $lead !== '' ? $lead : $title; } if ($place === 'status') { return $big !== '' ? $big : $lead; } return $big !== '' ? $title . ': ' . $big : ($lead !== '' ? $lead : $title); } function seolok_card_sub($card, $place) { if (isset($card['line'])) { return seolok_str(isset($card['sub']) ? $card['sub'] : ''); } return $place !== 'log' && !empty($card['big']) ? seolok_str(isset($card['lead']) ? $card['lead'] : '') : ''; } /** WordPress' own icon font (dashicons) for a tone; the colour comes from the "seolok-tone--…" class. */ function seolok_tone_icon($tone) { $icon = $tone === 'ok' ? 'dashicons-yes-alt' : ($tone === 'info' ? 'dashicons-info-outline' : 'dashicons-warning'); return ''; } /** The rows of a topic as a table, with the topic's link and small print under it. */ function seolok_card_body($card) { $rows = seolok_arr(isset($card['rows']) ? $card['rows'] : null); $o = ''; if (count($rows) > 0) { $o .= ''; foreach ($rows as $row) { $o .= seolok_render_card_row($row); } $o .= '

'; } $link = seolok_panel_button(isset($card['link']) ? $card['link'] : null, 'seolok-more'); if ($link !== '') { $o .= '

' . $link . '

'; } if (!empty($card['foot'])) { $o .= '

' . esc_html(seolok_str($card['foot'])) . '

'; } return $o; } /** The topic's own buttons (a form) and, when it has no rows to open, its link as a button. */ function seolok_card_actions($card, $with_link) { $o = ''; $buttons = seolok_render_buttons(isset($card['buttons']) ? $card['buttons'] : null); if ($buttons !== '') { $o .= seolok_fix_form_open(array()) . $buttons . ''; } if ($with_link) { $o .= seolok_panel_button(isset($card['link']) ? $card['link'] : null); } return $o; } /** * One line of the to-do list: icon, the sentence with its number, and one button. With rows, the button opens them under the line * (no script: a details element); otherwise the topic's own buttons or its link stand on the line. */ function seolok_render_todo($card) { $tone = seolok_card_tone($card); $rows = seolok_arr(isset($card['rows']) ? $card['rows'] : null); $sub = seolok_card_sub($card, 'todo'); $text = '' . esc_html(seolok_card_line($card, 'todo')) . '' . ($sub !== '' ? '' . esc_html($sub) . '' : '') . ''; $id = preg_replace('/[^a-z0-9_-]/', '', strtolower(seolok_str(isset($card['id']) ? $card['id'] : ''))); $o = '

'; if (count($rows) > 0) { $label = !empty($card['action']) ? seolok_str($card['action']) : (!empty($card['detailsLabel']) ? seolok_str($card['detailsLabel']) : '…'); // today's jobs are what Lokman's sentence talks about: shown open, not behind a button $o .= '

' . seolok_tone_icon($tone) . $text . '' . esc_html($label) . '

'; $actions = seolok_card_actions($card, false); $o .= '

' . ($actions !== '' ? '

' . $actions . '

' : '') . seolok_card_body($card) . '

'; } else { $actions = seolok_card_actions($card, true); $o .= '

' . seolok_tone_icon($tone) . $text . ($actions !== '' ? '' . $actions . '' : '') . '

'; if (!empty($card['foot'])) { $o .= '

' . esc_html(seolok_str($card['foot'])) . '

'; } } return $o . '

'; } /** A row of the status table (live sync, search engines) or the change log: name, value with small print, details folded, buttons. */ function seolok_render_status_row($card, $place) { $tone = seolok_card_tone($card); $rows = seolok_arr(isset($card['rows']) ? $card['rows'] : null); $sub = seolok_card_sub($card, $place); $o = '' . esc_html(seolok_str(isset($card['title']) ? $card['title'] : '')) . ''; $o .= ($place === 'log' ? '' : seolok_tone_icon($tone)) . '' . esc_html(seolok_card_line($card, $place)) . ''; if ($sub !== '') { $o .= '

' . esc_html($sub) . '

'; } if (count($rows) > 0) { $label = !empty($card['action']) ? seolok_str($card['action']) : (!empty($card['detailsLabel']) ? seolok_str($card['detailsLabel']) : '…'); $o .= '

' . esc_html($label) . '

' . seolok_card_body($card) . '

'; } return $o . '' . seolok_card_actions($card, count($rows) === 0) . ''; } /** * The overview (0.6.8): a heading with Lokman's sentence, the board (four numbers, to-do list beside the site summary, activity, * shortcuts, opportunities) when SEOLOK sends one, and the status table (live sync, search engines, recent changes) at the bottom. * The to-do list keeps every button of the topics (fix, 301, undo…). Every value escaped where it is added. */ function seolok_render_lokman_cards($d) { $cards = seolok_arr(isset($d['cards']) ? $d['cards'] : null); $todo = ''; $oks = ''; $status = ''; $log = ''; $busy = false; foreach ($cards as $card) { $card = seolok_arr($card); $place = seolok_card_place($card); $tone = seolok_card_tone($card); if ($place === 'todo') { $busy = $busy || $tone === 'warn' || $tone === 'bad'; $todo .= seolok_render_todo($card); } elseif ($place === 'ok') { $oks .= '

' . seolok_tone_icon($tone === 'ok' ? 'ok' : 'info') . esc_html(seolok_card_line($card, 'ok')) . '

'; } elseif ($place === 'status') { $status .= seolok_render_status_row($card, 'status'); } else { $log .= seolok_render_status_row($card, 'log'); } } $list = ($todo !== '' ? '

' . $todo . '' : '

' . seolok_tone_icon('ok') . esc_html(seolok_t('todo_empty')) . '

') . ($oks !== '' ? '

' . $oks . '' : ''); $o = '

' . esc_html(seolok_s('menu_overview')) . '

' . esc_html(seolok_s('ov_lead')) . '

'; $o .= '

' . seolok_avatar($busy ? 'busy' : 'happy') . '

' . esc_html(seolok_str(isset($d['title']) ? $d['title'] : 'Lokman')) . ' ' . esc_html(seolok_str(isset($d['subtitle']) ? $d['subtitle'] : '')) . '
' . esc_html(seolok_str(isset($d['greeting']) ? $d['greeting'] : '')) . '

' . seolok_dash_jobs_button($cards) . seolok_dash_ask($d) . '

'; if (isset($d['dash']) && is_array($d['dash'])) { $o .= seolok_render_dash($d, $list); } else { $o .= '

' . seolok_ui_icon('check') . '

' . esc_html(seolok_t('todo_title')) . '

' . $list . '

'; } if ($status !== '' || $log !== '') { $o .= '

' . seolok_ui_icon('gear') . '

' . esc_html(seolok_t('status_title')) . '

' . $status . $log . '

'; } return $o; } /** A whole number in the admin's language (1.234 / 1,234). */ function seolok_num($n) { return number_format((float) $n, 0, seolok_is_tr() ? ',' : '.', seolok_is_tr() ? '.' : ','); } /** A tiny line chart of a series (no axes, no labels: the number next to it carries the meaning). `$lower_better` flips it (positions). */ function seolok_sparkline($series, $tone = 'ok', $lower_better = false) { $points = array(); $values = array(); foreach (seolok_arr($series) as $i => $v) { if (is_numeric($v)) { $values[(int) $i] = (float) $v; } } if (count($values) < 2) { return ''; } $min = min($values); $max = max($values); $span = $max - $min > 0 ? $max - $min : 1; $n = max(array_keys($values)); foreach ($values as $i => $v) { $y = ($v - $min) / $span; $y = $lower_better ? $y : 1 - $y; $points[] = round($i / max(1, $n) * 96 + 2, 1) . ',' . round($y * 24 + 3, 1); } return ''; } /** "▲ 18 %" / "▼ 3,2": how a number moved against the window before; `$good` says whether that move is good news. */ function seolok_delta($text, $good) { return '' . ($good ? '▲' : '▼') . ' ' . esc_html($text) . ''; } /** The score as a ring (stroke length = score). */ function seolok_ring($score) { $score = max(0, min(100, (int) $score)); $len = round($score / 100 * 276.5, 1); $tone = $score >= 80 ? 'ok' : ($score >= 60 ? 'warn' : 'bad'); return '

' . esc_html((string) $score) . '/ 100

'; } /** A headline number card of the board; the whole card is a link (to SEOLOK, or to a place on this page). */ function seolok_dash_kpi($icon, $tone, $label, $value, $suffix, $sub, $href, $external) { $attrs = $external ? ' target="_blank" rel="noopener noreferrer"' : ''; return '' . seolok_ui_icon($icon) . '' . esc_html($label) . '' . esc_html($value) . ($suffix !== '' ? '' . esc_html($suffix) . '' : '') . '' . seolok_ui_icon('chev') . '' . $sub . ''; } /** The biggest issues of SEOLOK's last scan as to-do rows ("Pages without a title · 4 pages"), each opening the plugin's Site analysis screen. */ function seolok_dash_issue_rows($dash) { $rows = seolok_arr(isset($dash['issuesTop']) ? $dash['issuesTop'] : null); if (!$rows) { return ''; } $url = esc_url(admin_url('admin.php?page=' . seolok_insight_slug('audit'))); $o = '

' . esc_html(seolok_s('ov_from_scan')) . '

' . esc_html(seolok_str(isset($r['title']) ? $r['title'] : '')) . '' . seolok_pill($tone, sprintf(seolok_s('n_pages'), isset($r['count']) ? (int) $r['count'] : 0)) . seolok_ui_icon('chev') . '

'; } /** Lokman's sentence counts today's jobs: this button goes to them (the line of the "today" to-do topic). */ function seolok_dash_jobs_button($cards) { foreach ($cards as $card) { $card = seolok_arr($card); if (isset($card['id']) && $card['id'] === 'today' && seolok_card_place($card) === 'todo' && count(seolok_arr(isset($card['rows']) ? $card['rows'] : null)) > 0) { return '' . seolok_ui_icon('list') . esc_html(sprintf(seolok_s('ov_go_jobs'), count(seolok_arr($card['rows'])))) . ''; } } return ''; } /** "Ask a question": SEOLOK's support page of this site, where the team answers (when SEOLOK sent the link). */ function seolok_dash_ask($d) { $dash = isset($d['dash']) ? seolok_arr($d['dash']) : array(); $links = seolok_arr(isset($dash['links']) ? $dash['links'] : null); $url = seolok_panel_url(isset($links['support']) ? $links['support'] : ''); return $url === '' ? '' : '' . seolok_ui_icon('help') . esc_html(seolok_s('ov_ask')) . ''; } /** The board on top of the overview (plugin 0.6.8): four numbers, the to-do list beside the site summary, then activity, shortcuts and opportunities. */ function seolok_render_dash($d, $todo_html) { $dash = seolok_arr($d['dash']); $links = seolok_arr(isset($dash['links']) ? $dash['links'] : null); $link = function ($key) use ($links) { return seolok_panel_url(isset($links[$key]) ? $links[$key] : ''); }; $issues = seolok_arr(isset($dash['issues']) ? $dash['issues'] : null); $crit = isset($issues['critical']) ? (int) $issues['critical'] : 0; $warn = isset($issues['warning']) ? (int) $issues['warning'] : 0; $score = isset($dash['score']) && is_numeric($dash['score']) ? (int) $dash['score'] : null; $broken = isset($dash['brokenOpen']) ? (int) $dash['brokenOpen'] : 0; $tasks = isset($dash['tasks']) ? (int) $dash['tasks'] : 0; $search = isset($dash['search']) && is_array($dash['search']) ? $dash['search'] : null; $crawled = seolok_str(isset($dash['crawledAt']) ? $dash['crawledAt'] : ''); $o = '

'; $o .= seolok_dash_kpi('chain', $broken > 0 ? 'bad' : 'ok', seolok_s('ov_broken'), seolok_num($broken), '', esc_html($broken > 0 ? seolok_s('ov_broken_sub') : seolok_s('ov_broken_none')), $broken > 0 ? '#seolok-todo' : $link('links'), $broken === 0); $o .= seolok_dash_kpi('chart', $score === null ? 'muted' : ($score >= 80 ? 'ok' : ($score >= 60 ? 'warn' : 'bad')), seolok_s('ov_score'), $score === null ? '—' : (string) $score, $score === null ? '' : ' / 100', esc_html($score === null ? seolok_s('ov_score_never') : sprintf(seolok_s('ov_score_sub'), $crawled)), $link('audit'), true); $o .= seolok_dash_kpi('list', 'info', seolok_s('ov_tasks'), seolok_num($tasks), '', esc_html($tasks > 0 ? seolok_s('ov_tasks_sub') : seolok_s('ov_tasks_none')), $tasks > 0 ? '#seolok-todo' : $link('opportunities'), $tasks === 0); $o .= seolok_dash_kpi('warn', $crit > 0 ? 'bad' : ($warn > 0 ? 'warn' : 'ok'), seolok_s('ov_issues'), seolok_num($crit + $warn), '', '' . esc_html(sprintf(seolok_s('ov_critical'), $crit)) . ', ' . esc_html(sprintf(seolok_s('ov_warning'), $warn)) . '', $link('audit'), true); $o .= '

'; // to-do list | site summary $o .= '

' . seolok_ui_icon('check') . '

' . esc_html(seolok_s('ov_todo')) . '

' . esc_html(seolok_s('ov_todo_lead')) . '

' . ($link('opportunities') !== '' ? '' . esc_html(seolok_s('ov_all')) . ' →' : '') . '

' . $todo_html . seolok_dash_issue_rows($dash) . '

'; $o .= '

' . seolok_ui_icon('chart') . '

' . esc_html(seolok_s('ov_summary')) . '

' . esc_html(seolok_s('ov_summary_lead')) . '

' . ($link('audit') !== '' ? '' . esc_html(seolok_s('ov_detail')) . ' →' : '') . '

'; $o .= '

' . ($score === null ? '

' . esc_html(seolok_s('ov_score_never')) . '

' : seolok_ring($score) . '

' . esc_html(seolok_s('ov_score')) . '

') . '

' . seolok_ui_icon('file') . '' . esc_html(seolok_s('ov_pages')) . '' . esc_html($pages > 0 ? seolok_num($pages) : '—') . '
' . seolok_ui_icon('eye') . '' . esc_html(seolok_s('ov_clicks')) . '' . esc_html(seolok_num($clicks)) . ' ' . $delta . '' . seolok_sparkline(isset($search['clicksSeries']) ? $search['clicksSeries'] : array(), 'ok') . '
' . seolok_ui_icon('chart') . '' . esc_html(seolok_s('ov_position')) . '' . esc_html($pos === null ? '—' : number_format($pos, 1, seolok_is_tr() ? ',' : '.', '')) . ' ' . $pdelta . '' . seolok_sparkline(isset($search['positionSeries']) ? $search['positionSeries'] : array(), 'info', true) . '
' . seolok_ui_icon('search') . '' . esc_html(seolok_s('ov_impressions')) . '' . esc_html(seolok_num((int) $search['impressions'])) . '
' . seolok_ui_icon('eye') . '' . esc_html(seolok_s('ov_clicks')) . '' . esc_html(seolok_s('ov_no_gsc')) . '
' . seolok_ui_icon('chain') . '' . esc_html(seolok_s('in_ref_domains')) . '' . esc_html($ref === null ? '—' : seolok_num($ref)) . '' . seolok_ui_icon('chev') . '

' . ($search ? '

' . esc_html(seolok_s('ov_window')) . '

' : '') . '

'; // activity | shortcuts | opportunities $o .= '

' . seolok_ui_icon('clock') . '

' . esc_html(seolok_s('ov_activity')) . '

' . esc_html(seolok_s('ov_activity_lead')) . '

'; $activity = seolok_arr(isset($dash['activity']) ? $dash['activity'] : null); if (!$activity) { $o .= '

' . esc_html(seolok_s('ov_activity_none')) . '

'; } else { $o .= '

' . esc_html(seolok_str(isset($a['text']) ? $a['text'] : '')) . ($sub !== '' ? '' . esc_html($sub) . '' : '') . '' . esc_html(seolok_str(isset($a['when']) ? $a['when'] : '')) . '

'; } $o .= '

'; $quick = array( array('search', seolok_s('ov_q_alerts'), esc_url(admin_url('admin.php?page=' . SEOLOK_ALERTS_PAGE)), false), array('chain', seolok_s('ov_q_links'), $link('links'), true), array('chart', seolok_s('ov_q_competitors'), $link('competitors'), true), array('search', seolok_s('ov_q_rank'), $link('rankFinder'), true), array('file', seolok_s('ov_q_report'), $link('reports'), true), ); $o .= '

' . seolok_ui_icon('bolt') . '

' . esc_html(seolok_s('ov_quick')) . '

' . esc_html(seolok_s('ov_quick_lead')) . '

' . seolok_ui_icon($q[0]) . '' . esc_html($q[1]) . '' . seolok_ui_icon('chev') . '

'; $opps = seolok_arr(isset($dash['opportunities']) ? $dash['opportunities'] : null); $o .= '

' . seolok_ui_icon('star') . '

' . esc_html(seolok_s('ov_opps')) . '

' . esc_html(seolok_s('ov_opps_lead')) . '

' . ($link('opportunities') !== '' && $opps ? '' . esc_html(seolok_s('ov_all')) . ' →' : '') . '

'; if (!$opps) { $o .= '

' . esc_html(seolok_s('ov_opps_none')) . '

'; } else { $o .= '

' . esc_html((string) ($i + 1)) . '' . esc_html(seolok_str(isset($p['query']) ? $p['query'] : '')) . '' . esc_html(implode(' · ', $facts)) . '' . ($link('opportunities') !== '' ? '' . esc_html(seolok_s('ov_look')) . '' : '') . '

'; } $o .= '

'; return $o; } function seolok_flash_key() { return 'seolok_flash_' . (int) get_current_user_id(); } /** The result of the last click (kept for a short while across the redirect), drawn as a WordPress notice. */ function seolok_render_flash($flash) { if (!is_array($flash) || empty($flash['lines']) || !is_array($flash['lines'])) { return ''; } $class = isset($flash['tone']) && $flash['tone'] === 'success' ? 'notice notice-success' : 'notice notice-warning'; $o = '

'; foreach ($flash['lines'] as $line) { $o .= '

' . esc_html(seolok_str($line)) . '

'; } return $o . '

'; } function seolok_render_problem($error) { $code = is_wp_error($error) ? $error->get_error_code() : ''; $message = $code === 'seolok_not_configured' ? seolok_t('not_connected') : ($code === 'seolok_unauthorized' ? seolok_t('bad_token') : seolok_t('load_failed')); $o = '

' . esc_html($message) . '

'; $o .= '' . esc_html(seolok_t('go_settings')) . ' '; if ($code !== 'seolok_not_configured') { $o .= '' . esc_html(seolok_t('retry')) . ''; } return $o . '

'; } /** * Under the Lokman page: which SEOLOK site this WordPress is connected to. SEOLOK opens a site only in the account that owns it, so a * link that says "not found" there usually means the plugin is connected to a site of another account; this makes that visible. */ function seolok_site_note() { $id = (string) seolok_option('site_id'); if ($id === '') { return ''; } // only the end of the ID: enough to compare with the one SEOLOK shows, without putting the whole key on every screen $tail = strlen($id) > 8 ? '…' . substr($id, -6) : $id; return '

' . esc_html(seolok_t('site_note')) . ' ' . esc_html($tail) . ' · ' . esc_html(seolok_t('link_settings')) . '
' . esc_html(seolok_t('site_note_hint')) . '

'; } function seolok_lokman_page() { if (!current_user_can('manage_options')) { return; } echo '

'; $flash = get_transient(seolok_flash_key()); if ($flash !== false) { delete_transient(seolok_flash_key()); echo wp_kses(seolok_render_flash($flash), seolok_allowed_html()); } if (get_transient('seolok_look_again_' . (int) get_current_user_id())) { delete_transient('seolok_look_again_' . (int) get_current_user_id()); echo ''; } // live sync on and the last report is old: report now, so the page shows today's state ("last word 2 minutes ago") // (the attempt is noted first: SEOLOK slow or unreachable must not make every page view wait again) if (seolok_sync_enabled() && time() - max((int) get_option('seolok_sync_last', 0), (int) get_option('seolok_sync_try', 0)) > 30 * MINUTE_IN_SECONDS) { update_option('seolok_sync_try', time(), false); seolok_sync_beat(8); seolok_lokman_forget(); } $data = seolok_is_configured() ? seolok_lokman_data(isset($_GET['seolok_refresh'])) /* phpcs:ignore WordPress.Security.NonceVerification.Recommended -- a read-only "fetch again" flag */ : new WP_Error('seolok_not_configured', 'Not configured'); // top bar: the mark with its line, "Refresh" and "Open in SEOLOK" $refresh_url = add_query_arg(array('page' => SEOLOK_LOKMAN_PAGE, 'seolok_refresh' => '1'), admin_url('admin.php')); $panel = !is_wp_error($data) && isset($data['openPanel']) ? seolok_arr($data['openPanel']) : array(); $panel_url = seolok_panel_url(isset($panel['url']) ? $panel['url'] : ''); echo wp_kses('

' . seolok_brand() . '' . esc_html(seolok_s('ov_tagline')) . '

' . seolok_ui_icon('refresh') . esc_html(seolok_s('ov_refresh')) . '' . ($panel_url !== '' ? '' . seolok_ui_icon('link') . esc_html(seolok_str(isset($panel['label']) ? $panel['label'] : '')) . '' : '') . '

', seolok_allowed_html()); if (is_wp_error($data)) { echo wp_kses(seolok_render_problem($data), seolok_allowed_html()); } else { echo wp_kses((int) $data['v'] === 2 ? seolok_render_lokman_cards($data) : seolok_render_lokman($data), seolok_allowed_html()); } echo wp_kses(seolok_site_note(), seolok_allowed_html()); echo '

'; } /** The small number next to SEOLOK in the menu (WordPress' own bubble): addresses waiting for the owner. Comes from SEOLOK's last answer; nothing is fetched to draw the menu. */ function seolok_menu_badge() { $count = (int) get_option('seolok_badge', 0); return $count > 0 ? ' ' . esc_html($count > 99 ? '99+' : (string) $count) . '' : ''; } /** "Settings" and "Lokman" next to "Deactivate" in the plugin list, so the plugin is easy to find and open. */ add_filter('plugin_action_links_' . plugin_basename(__FILE__), function ($links) { $mine = array( '' . esc_html(seolok_t('link_settings')) . '', '' . esc_html(seolok_t('link_lokman')) . '', ); return array_merge($mine, is_array($links) ? $links : array()); }); /** Validates a form post and forwards it to SEOLOK. @return array{tone:string,lines:array} the notice to show */ function seolok_process_fix($post) { $op = isset($post['op']) ? sanitize_key(wp_unslash($post['op'])) : ''; if (!seolok_op_allowed($op)) { return array('tone' => 'warning', 'lines' => array(seolok_t('action_failed'))); } // the buttons that change something in WordPress itself are answered here, nothing is forwarded if (in_array($op, SEOLOK_LOCAL_OPS, true)) { $result = $op === 'sync_on' ? seolok_sync_set(true) : ($op === 'sync_off' ? seolok_sync_set(false) : seolok_search_allow()); seolok_lokman_forget(); return $result; } // URLs are passed through untouched (sanitize_text_field would strip %-encoded letters); SEOLOK checks them against its own crawl $clean = function ($key, $max) use ($post) { return isset($post[$key]) && is_string($post[$key]) ? substr(preg_replace('/[\x00-\x1F\x7F]/', '', wp_unslash($post[$key])), 0, $max) : ''; }; $result = seolok_remote('POST', '/api/wp/lokman/fix', array( 'op' => $op, 'locale' => seolok_lokman_locale(), 'target' => $clean('target', 2000), 'to' => $clean('to', 2000), 'id' => preg_replace('/[^0-9a-zA-Z-]/', '', $clean('id', 64)), )); seolok_lokman_forget(); if (is_wp_error($result) || !isset($result['lines']) || !is_array($result['lines'])) { return array('tone' => 'warning', 'lines' => array(is_wp_error($result) && $result->get_error_code() === 'seolok_unauthorized' ? seolok_t('bad_token') : seolok_t('action_failed'))); } return array('tone' => isset($result['tone']) && $result['tone'] === 'success' ? 'success' : 'warning', 'lines' => array_map('seolok_str', array_slice($result['lines'], 0, 12))); } function seolok_handle_fix() { if (!current_user_can('manage_options')) { wp_die(esc_html(seolok_t('forbidden')), '', array('response' => 403)); } check_admin_referer('seolok_fix'); $result = seolok_process_fix($_POST); // phpcs:ignore WordPress.Security.NonceVerification -- checked above set_transient(seolok_flash_key(), $result, 120); // a multi-page fix runs in SEOLOK's background now (0.6.1): the page looks again once, a few seconds later, to show the result $op = isset($_POST['op']) ? sanitize_key(wp_unslash($_POST['op'])) : ''; // phpcs:ignore WordPress.Security.NonceVerification -- checked above if (in_array($op, array('replace', 'unlink', 'undo_batch'), true) && isset($result['tone']) && $result['tone'] === 'success') { set_transient('seolok_look_again_' . (int) get_current_user_id(), 1, 60); } delete_option('seolok_badge'); // the number in the menu comes back with the next fresh page wp_safe_redirect(add_query_arg(array('page' => SEOLOK_LOKMAN_PAGE), admin_url('admin.php'))); exit; } add_action('admin_post_seolok_fix', 'seolok_handle_fix'); // the SEOLOK menu (Overview, SEO titles, Alerts, Live sync, Settings) and its screens require_once __DIR__ . '/includes/screens.php'; require_once __DIR__ . '/includes/insights.php'; require_once __DIR__ . '/includes/home.php';