'string', 'sanitize_callback' => function ($v) { return $v === 'on' ? 'on' : 'off'; }, 'default' => 'off', ]); register_setting(Options::SUSPICIOUS_GROUP_KEY, Options::SUSPICIOUS_REDIRECT_URL, [ 'type' => 'string', 'sanitize_callback' => 'esc_url_raw', 'default' => '', ]); register_setting(Options::SUSPICIOUS_GROUP_KEY, Options::SUSPICIOUS_REQUESTS, [ 'type' => 'integer', 'sanitize_callback' => function ($v) { return max(1, (int) $v); }, 'default' => 5, ]); register_setting(Options::SUSPICIOUS_GROUP_KEY, Options::SUSPICIOUS_WINDOW, [ 'type' => 'integer', 'sanitize_callback' => function ($v) { return max(1, min(3600, (int) $v)); }, 'default' => 30, ]); register_setting(Options::ROBOTS_GROUP_KEY, Options::ROBOTS_ENABLE); register_setting(Options::ROBOTS_GROUP_KEY, Options::ROBOTS_ENFORCE); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_REDIRECT_URL, ['sanitize_callback' => ['FiftyoneService', 'sanitize_robots_redirect_url']]); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_CUSTOM_TOP, ['sanitize_callback' => ['FiftyoneService', 'sanitize_robots_textarea']]); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_CUSTOM_BOTTOM, ['sanitize_callback' => ['FiftyoneService', 'sanitize_robots_textarea']]); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_ALLOWED_CATEGORIES, ['sanitize_callback' => ['FiftyoneService', 'sanitize_categories']]); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_STANDARD_TDL_SELECTED, ['sanitize_callback' => ['FiftyoneService', 'sanitize_standard_tdl_selected']]); register_setting( Options::ROBOTS_GROUP_KEY, Options::ROBOTS_CUSTOM_TDL, ['sanitize_callback' => ['FiftyoneService', 'sanitize_tdl']]); register_setting(Options::GROUP_KEY, Options::PIPELINE_ENABLE); } static function sanitize_robots_textarea($value) { return sanitize_textarea_field($value); } static function sanitize_robots_redirect_url($value) { return esc_url_raw($value); } static function sanitize_standard_tdl_selected($value) { if (!is_array($value)) { return []; } $valid_ids = array_column(FiftyOneDegreesStandardTdls::load(), 'id'); return array_values(array_unique(array_intersect($value, $valid_ids))); } static function sanitize_categories($value) { if (!is_array($value)) { return []; } $available = FiftyOneDegreesCloudMetadata::fetch_crawler_usage_values(); $valid = array_keys($available); if (empty($valid)) { $valid = ['Index', 'Train', 'Input', 'Search', 'Monitor', 'Archiving', 'Preview', 'Security', 'Analytics', 'Feed', 'Discovery']; } return array_values(array_intersect($value, $valid)); } static function sanitize_tdl($value) { if (is_string($value)) { $lines = explode("\n", $value); } elseif (is_array($value)) { $lines = $value; } else { return []; } $clean = []; foreach ($lines as $url) { $url = esc_url_raw(trim($url)); if (!empty($url)) { $clean[] = $url; } } return array_values(array_unique($clean)); } /** * Register the JSON endpoint for the pipeline. This is where the * JavaScript will callback to instead of the 51Degrees domain. * * @return void */ function fiftyonedegrees_rest_api_init() { register_rest_route('fiftyonedegrees/v4', "json", array( 'methods' => 'POST', 'args' => array(), 'callback' => array('Pipeline','getJSON'), 'permission_callback' => '__return_true' )); } /** * Checks if the Resource Key has been changed, and stores the new one * if it has. When the new option has been updated, the pipeline will be * rebuilt. * * @return void */ function submit_rk_submit_action() { if (isset($_POST[Options::RESOURCE_KEY]) && isset($_POST["action"]) && $_POST[Options::RESOURCE_KEY] !== get_option(Options::RESOURCE_KEY)) { $resource_key = sanitize_text_field(wp_unslash( $_POST[Options::RESOURCE_KEY])); update_option(Options::RESOURCE_KEY, $resource_key); if (!isset($cachedPipeline['error'])) { if (get_option(Options::ENABLE_GA) && get_option(Options::RESOURCE_KEY_UPDATED)) { wp_redirect(get_admin_url() . 'options-general.php?page=51Degrees&tab=google-analytics'); exit(); } } else { wp_redirect(get_admin_url() . 'options-general.php?page=51Degrees&tab=setup' ); exit(); } } } /** * Add stylesheet for admin pages. * * @return void */ function fiftyonedegrees_admin_enqueue_scripts() { wp_enqueue_style( "fiftyonedegrees_admin_styles", plugin_dir_url(__FILE__) . "../assets/css/fod.css"); wp_enqueue_style( "fiftyonedegrees_admin_styles_icons", "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"); wp_enqueue_script( "fiftyonedegrees_jQuery", plugin_dir_url(__FILE__) . '../assets/js/51D.js', array('jquery') #dependencies ); } /** * After any option is updated, check if the option was something that * needs to be taken care of. For Resource Key, the flow data needs to * be removed from the session cache, and a new pipeline created. * * @return void */ function fiftyonedegrees_update_option($option, $old_value, $new_value) { if ($option === Options::RESOURCE_KEY) { // Remove the cached flowdata from the session. if (session_status() === PHP_SESSION_ACTIVE && isset($_SESSION["fiftyonedegrees_data"])) { unset($_SESSION["fiftyonedegrees_data"]); update_option( Options::SESSION_INVALIDATED, time()); } // Invalidate cloud metadata transient FiftyOneDegreesCloudMetadata::invalidate_all(); // Stale against the previous key — clear. delete_option(Options::ROBOTS_LAST_REFRESH); self::build_and_save_pipeline($new_value); if ($old_value !== $new_value) { update_option(Options::RESOURCE_KEY_UPDATED, true); delete_option(Options::GA_DIMENSIONS); } else { delete_option(Options::RESOURCE_KEY_UPDATED); } } if ($option === Options::GA_TRACKING_ID && $old_value !== $new_value) { update_option(Options::GA_ID_UPDATED, true); delete_option(Options::GA_DIMENSIONS); } if ($option === Options::GA_SEND_PAGE_VIEW_VAL && $old_value !== $new_value) { update_option(Options::GA_SEND_PAGE_VIEW_UPDATED, true); } if ($option === Options::ROBOTS_ENFORCE && $new_value === 'on' && get_option(Options::PIPELINE_ENABLE, 'on') !== 'on') { update_option(Options::PIPELINE_ENABLE, 'on'); set_transient( 'fiftyonedegrees_pipeline_auto_enabled', 'Robots Enforce', 30); } if ($option === Options::PIPELINE_ENABLE && $new_value === 'off' && get_option(Options::ROBOTS_ENFORCE, 'off') === 'on') { update_option(Options::ROBOTS_ENFORCE, 'off'); } } /** * Builds the pipeline when the resource key option is first created, * e.g. via WP-CLI where update_option hook does not fire. * * @param string $option the option name * @param mixed $value the option value * @return void */ function fiftyonedegrees_add_option($option, $value) { if ($option === Options::RESOURCE_KEY && $value) { self::build_and_save_pipeline($value); } } // On error: leave PIPELINE alone, record error string for setup.php. private static function build_and_save_pipeline($resource_key) { // Empty key: nothing to validate. Drop all cached state so the setup // tab renders clean (no stale red box from a previous failed save). if (empty($resource_key)) { delete_option(Options::PIPELINE); delete_option(Options::PIPELINE_VALIDATION_ERROR); return; } $pipeline = Pipeline::make_pipeline($resource_key); if ($pipeline && !isset($pipeline['error'])) { update_option(Options::PIPELINE, $pipeline); delete_option(Options::PIPELINE_VALIDATION_ERROR); return; } if (is_array($pipeline) && isset($pipeline['error']) && $pipeline['error'] !== '') { update_option(Options::PIPELINE_VALIDATION_ERROR, (string) $pipeline['error']); } } /** * Called on admin_init. When returning to the robots settings page after a * settings save (WordPress adds settings-updated=true to the URL), triggers * an immediate Cloud API call to refresh the cached robots.txt content. * * @return void */ function fiftyonedegrees_re_generate_robots() { if (!isset($_GET['settings-updated'])) { return; } $page = isset($_GET['page']) ? sanitize_text_field(wp_unslash($_GET['page'])) : ''; $tab = isset($_GET['tab']) ? sanitize_text_field(wp_unslash($_GET['tab'])) : ''; if ($page !== '51Degrees' || $tab !== 'robots') { return; } $success = FiftyOneDegreesRobotsTxt::fetch_from_cloud(); if ($success) { set_transient('fiftyonedegrees_robots_generate_success', true, 30); } } /** * Displays an admin notice when device detection was automatically enabled * because a dependent feature (e.g. Robots Enforce) requires it. * * @return void */ function fiftyonedegrees_pipeline_autoenable_notice() { $feature = get_transient('fiftyonedegrees_pipeline_auto_enabled'); if ($feature === false) { return; } delete_transient('fiftyonedegrees_pipeline_auto_enabled'); echo '

' . '51Degrees: Device detection was automatically ' . 'enabled because ' . esc_html($feature) . ' requires it.' . '

'; } function fiftyonedegrees_suspicious_toggle_failed_notice() { $message = get_transient('fiftyonedegrees_suspicious_toggle_failed'); if ($message === false) { return; } delete_transient('fiftyonedegrees_suspicious_toggle_failed'); echo '

' . '51Degrees: ' . esc_html($message) . '

'; } /** * Rebuilds the pipeline when the permalink structure changes. * Hooked to 'updated_option' (fires after the DB write) so that * rest_url() returns the URL for the new permalink structure. * * @return void */ function fiftyonedegrees_updated_option($option, $old_value, $new_value) { if ($option === 'permalink_structure') { $resource_key = get_option(Options::RESOURCE_KEY); if ($resource_key) { if (session_status() === PHP_SESSION_ACTIVE && isset($_SESSION["fiftyonedegrees_data"])) { unset($_SESSION["fiftyonedegrees_data"]); update_option(Options::SESSION_INVALIDATED, time()); } self::build_and_save_pipeline($resource_key); } } } /** * Synchronously rebuild the cached pipeline whenever * SUSPICIOUS_ENABLE is toggled. The cached pipeline's engine list is * the single source of truth for both engine selection and the * query.id.usage evidence decision; keep it in sync on every toggle. */ public function fiftyonedegrees_suspicious_enable_updated($option, $old_value, $value) { if ($option !== Options::SUSPICIOUS_ENABLE) { return; } // $rebuilding = false reset via finally because the revert's update_option re-fires this hook; WP dispatcher guarantees the re-entry path. static $rebuilding = false; if ($rebuilding) { return; } $rebuilding = true; try { update_option(Options::SESSION_INVALIDATED, time()); $resource_key = get_option(Options::RESOURCE_KEY); if (empty($resource_key)) { return; } delete_option(Options::PIPELINE_VALIDATION_ERROR); self::build_and_save_pipeline($resource_key); $had_error = (bool) get_option(Options::PIPELINE_VALIDATION_ERROR); if ($had_error) { update_option(Options::SUSPICIOUS_ENABLE, $old_value); delete_option(Options::PIPELINE_VALIDATION_ERROR); set_transient( 'fiftyonedegrees_suspicious_toggle_failed', 'Suspicious activity detection setting could not be applied — the ' . '51Degrees cloud was unreachable. Your previous setting was ' . 'preserved.', MINUTE_IN_SECONDS * 10 ); } } finally { $rebuilding = false; } } /** * Register the options page for the plugin. * * @return void */ function fiftyonedegrees_register_options_page() { add_options_page( '51Degrees', '51Degrees', 'manage_options', '51Degrees', array($this, 'fiftyonedegrees_admin_page')); } /** * Set the link to settings for this plugin. * * @param string[] $links array of links to add to. * @return string[] updated array of links. */ function fiftyonedegrees_add_plugin_page_settings_link($links) { $links[] = '' . __('Settings') . ''; return $links; } /** * Inlude the admin page for this plugin. * * @return void */ function fiftyonedegrees_admin_page() { include plugin_dir_path(__FILE__) . "../admin.php"; } /** * Add the 51Degrees JavaScript to the page. * * @return void */ function fiftyonedegrees_javascript() { wp_enqueue_script( "fiftyonedegrees", plugin_dir_url(__FILE__) . "../assets/js/fod.js"); wp_add_inline_script( "fiftyonedegrees", Pipeline::getJavaScript(), "before"); } /** * Block filter function to replace tokens in the format * '{Pipeline::get("engine","property")}'. * * @param string $block_content the existing blocb content to parse * @param object $block not used in this function * @return string the updated block content */ public function fiftyonedegrees_block_filter($block_content, $block) { $content = $block_content; $pattern = '/\{Pipeline::get\("[A-Za-z]+",[ ]*"[A-Za-z]+"\)\}/'; preg_match_all( $pattern, $block_content, $matches, PREG_PATTERN_ORDER); foreach ($matches as $pattern_matches) { foreach ($pattern_matches as $match) { $args = str_replace("{Pipeline::get(", "", $match); $args = str_replace(")}", "", $args); $args = str_replace("\"", "", $args); $args = str_replace(" ", "", $args); $args = explode(",", $args); try { $value = Pipeline::get($args[0], $args[1]); } catch (\Throwable $exception) { $value = null; } switch (gettype($value)) { case "string": break; case "boolean": if ($value) { $value = "true"; } else { $value = "false"; } break; case "array": $value = implode(",", $value); break; default: $value = json_encode($value); } $content = str_replace($match, $value, $content); } } return $content; } /** * Add a '51Degrees' category to the list of block categories * available in the editor. * * @param array $categories the existing list of categories * @return object the updated categories including the 51Degrees category */ function fiftyonedegrees_block_categories($categories) { $category_slugs = wp_list_pluck($categories, 'slug'); return in_array('51Degrees', $category_slugs, true) ? $categories : array_merge( $categories, array( array( 'slug' => '51Degrees', 'title' => __( '51Degrees', '51D' ), 'icon' => null, ), ) ); } /** * Setup everything needed for editing 51Degrees blocks. For example, * a list of properties is initialized to be used in a drop down list. * * @return void */ function fiftyonedegrees_setup_blocks() { wp_register_script( 'fiftyonedegrees-conditional-group-block', plugins_url('../conditional-group-block/build/index.js', __FILE__), [ 'wp-i18n', 'wp-element', 'wp-blocks', 'wp-components', 'wp-editor' ], '1.0.0' ); wp_register_style( 'fiftyonedegrees-conditional-group-block', plugins_url('../conditional-group-block/src/editor.css', __FILE__), [], '1.0.0' ); register_block_type( 'fiftyonedegrees/conditional-group-block', [ 'editor_script' => 'fiftyonedegrees-conditional-group-block', 'style' => 'fiftyonedegrees-conditional-group-block', ] ); // Add list of properties to select field in editor interface $propertySelect = [ [ "label" => "Property", "value" => "" ] ]; if (Pipeline::$data) { foreach (Pipeline::$data["properties"] as $dataKey => $engineProperties) { foreach ($engineProperties as $property) { $propertySelect[] = array( "label" => strtolower( $property["name"] . " (" . $dataKey . ")"), "value" => strtolower( $dataKey . "|" . $property["name"]) ); } } wp_localize_script( "fiftyonedegrees-conditional-group-block", 'fiftyoneProperties', $propertySelect); } } /** * Handles conditional blocks. * Compares the target property value set in the block with the actual * property value from the flow data for the requesting device using the * operator specified in the block. If the result is true then the block * is rendered, otherwise not. * * @param string $block_content content of the block to potentially be * displayed * @param object $block the block itself, containing the options used to * determine whether to display the content * @return string|null either the value of $block_content if the condition * is met, otherwise null */ function fiftyonedegrees_render_block($block_content, $block) { if ('fiftyonedegrees/conditional-group-block' === $block['blockName']) { if(isset($block["attrs"]["property"]) && !empty($block["attrs"]["property"]) && isset($block["attrs"]["operator"]) && !empty($block["attrs"]["operator"]) && isset($block["attrs"]["value"]) && !empty($block["attrs"]["value"])){ $property = $block["attrs"]["property"]; // Split property and engine by pipe $engineDataKey = explode("|", $property)[0]; $propertyName = explode("|", $property)[1]; // Get property value $value = Pipeline::get($engineDataKey, $propertyName); // JSON encode to string if not a string already if (!is_string($value)) { $value = json_encode($value); } $compareValue = $block["attrs"]["value"]; if (empty($compareValue)) { return null; } $operator = $block["attrs"]["operator"]; // Default to not show and then overwrite based on // operator rules $show = false; switch ($operator) { case "is": $show = $value === $compareValue; break; case "not": $show = $value !== $compareValue; break; case "contains": $show = strpos($value, $compareValue) !== false; break; } if (!$show) { return null; } } else { return null; } } return $block_content; } public function delete_pipeline_options() { delete_option(Options::RESOURCE_KEY); delete_option(Options::PIPELINE); delete_option(Options::PIPELINE_ENABLE); delete_option(Options::SESSION_INVALIDATED); delete_option(Options::PIPELINE_VALIDATION_ERROR); } } ?>