yaab_analytics_default_tracking_code(), 'yaab_server_url' => yaab_analytics_default_server_url(), ); foreach ($defaults as $option => $value) { if ($value !== '' && get_option($option, false) === false) { add_option($option, $value); } } } register_activation_hook(__FILE__, 'yaab_analytics_store_package_defaults'); add_action('init', 'yaab_analytics_store_package_defaults'); function yaab_analytics_sanitize_tracking_code($value) { $value = is_string($value) ? sanitize_text_field($value) : ''; // An empty field turns tracking off. if ($value === '') { return ''; } if (preg_match('/\A[A-Za-z0-9_-]{20,128}\z/', $value)) { return $value; } add_settings_error('yaab_tracking_code', 'invalid_tracking_code', __('The Yaab tracking code is invalid.', 'yaab-analytics')); return get_option('yaab_tracking_code', yaab_analytics_default_tracking_code()); } function yaab_analytics_sanitize_server_url($value) { $value = is_string($value) ? trim($value) : ''; if ($value === '') { return ''; } $url = esc_url_raw($value, array('https')); $parts = $url ? wp_parse_url($url) : false; $host = is_array($parts) && isset($parts['host']) ? strtolower($parts['host']) : ''; $is_yaab_host = $host === 'yaab.fr' || ($host !== '' && substr($host, -8) === '.yaab.fr'); if ($is_yaab_host && ($parts['scheme'] ?? '') === 'https') { return untrailingslashit($url); } add_settings_error('yaab_server_url', 'invalid_server_url', __('The collector must use an official Yaab HTTPS address.', 'yaab-analytics')); return get_option('yaab_server_url', yaab_analytics_default_server_url()); } /** * Register the plugin settings. */ function yaab_analytics_register_settings() { register_setting('yaab_analytics_options_group', 'yaab_tracking_code', array( 'type' => 'string', 'sanitize_callback' => 'yaab_analytics_sanitize_tracking_code', 'default' => yaab_analytics_default_tracking_code() )); register_setting('yaab_analytics_options_group', 'yaab_server_url', array( 'type' => 'string', 'sanitize_callback' => 'yaab_analytics_sanitize_server_url', 'default' => yaab_analytics_default_server_url() )); } add_action('admin_init', 'yaab_analytics_register_settings'); /** * Pages of the Yaab dashboard reachable from WordPress. They open on yaab.fr, in * the site the user last selected there. */ function yaab_analytics_dashboard_links() { return array( 'studio' => array(__('Tracking plan', 'yaab-analytics'), '/dashboard/studio', __('Yaab scans your page, you choose what to track. No code.', 'yaab-analytics')), 'dashboard' => array(__('Statistics', 'yaab-analytics'), '/dashboard', __('Visitors, pages, traffic sources.', 'yaab-analytics')), 'clicks' => array(__('Clicks', 'yaab-analytics'), '/dashboard/clics', __('Buttons and links your visitors click.', 'yaab-analytics')), 'heatmap' => array(__('Heatmap', 'yaab-analytics'), '/dashboard/heatmap', __('Where visitors click and scroll.', 'yaab-analytics')), 'funnels' => array(__('Funnels', 'yaab-analytics'), '/dashboard/funnels', __('Where visitors leave before converting.', 'yaab-analytics')), ); } function yaab_analytics_app_url($path = '') { return esc_url(YAAB_ANALYTICS_APP_URL . $path); } function yaab_analytics_is_active() { return get_option('yaab_tracking_code', yaab_analytics_default_tracking_code()) !== '' && get_option('yaab_server_url', yaab_analytics_default_server_url()) !== ''; } /** * "Yaab" menu in the WordPress administration: connection page, plus direct * shortcuts to the Yaab dashboard that open in a new tab. */ function yaab_analytics_add_admin_menu() { add_menu_page( __('Yaab Analytics', 'yaab-analytics'), __('Yaab', 'yaab-analytics'), 'manage_options', 'yaab-analytics', 'yaab_analytics_options_page', 'dashicons-chart-area', 58 ); add_submenu_page( 'yaab-analytics', __('Yaab Analytics', 'yaab-analytics'), __('Connection', 'yaab-analytics'), 'manage_options', 'yaab-analytics', 'yaab_analytics_options_page' ); // External links: added straight to the menu array, WordPress has no API for them. global $submenu; foreach (yaab_analytics_dashboard_links() as $link) { $submenu['yaab-analytics'][] = array( $link[0] . ' ', 'manage_options', YAAB_ANALYTICS_APP_URL . $link[1], ); } } add_action('admin_menu', 'yaab_analytics_add_admin_menu'); /** * External menu entries open in a new tab. */ function yaab_analytics_admin_footer() { ?> %s', esc_url(admin_url('admin.php?page=yaab-analytics')), esc_html__('Settings', 'yaab-analytics')), sprintf('%s', yaab_analytics_app_url('/dashboard'), esc_html__('Open Yaab', 'yaab-analytics')) ); return $links; } add_filter('plugin_action_links_' . plugin_basename(__FILE__), 'yaab_analytics_add_settings_link'); /** * "Yaab" shortcut in the top admin bar. */ function yaab_analytics_admin_bar($bar) { if (!current_user_can('manage_options')) { return; } $bar->add_node(array( 'id' => 'yaab-analytics', 'title' => ' ' . esc_html__('Yaab', 'yaab-analytics'), 'href' => YAAB_ANALYTICS_APP_URL . '/dashboard', 'meta' => array('target' => '_blank', 'rel' => 'noopener noreferrer', 'title' => __('Open my Yaab dashboard', 'yaab-analytics')), )); } add_action('admin_bar_menu', 'yaab_analytics_admin_bar', 90); /** * Connection page. */ function yaab_analytics_options_page() { if (!current_user_can('manage_options')) { return; } $active = yaab_analytics_is_active(); ?>

↗ ↗

↗

' . esc_html__('terms of service', 'yaab-analytics') . '', '' . esc_html__('privacy policy', 'yaab-analytics') . '' ); ?>

Privacy). */ function yaab_analytics_privacy_policy_content() { if (!function_exists('wp_add_privacy_policy_content')) { return; } wp_add_privacy_policy_content( 'Yaab Analytics', wp_kses_post( '

' . __('This site measures its audience with Yaab (https://yaab.fr). When you visit a page, your browser sends the page viewed, the traffic source, the clicks on tracked elements, your device type, browser, language, approximate location and pseudonymous visitor and session identifiers to a Yaab server. These identifiers are stored in your browser (localStorage).', 'yaab-analytics') . '

' ) ); } add_action('admin_init', 'yaab_analytics_privacy_policy_content'); /** * Load the Yaab tracking script on the front end, once the code and collector are set. */ function yaab_analytics_enqueue_script() { if (is_customize_preview()) { return; } $tracking_code = get_option('yaab_tracking_code', yaab_analytics_default_tracking_code()); $server_url = get_option('yaab_server_url', yaab_analytics_default_server_url()); if (empty($tracking_code) || empty($server_url)) { return; } wp_enqueue_script('yaab-analytics', 'https://yaab.fr/v1/track.min.js', array(), YAAB_ANALYTICS_VERSION, false); } add_action('wp_enqueue_scripts', 'yaab_analytics_enqueue_script'); /** * The script reads its tracking code and collector from its own tag attributes. */ function yaab_analytics_script_attributes($tag, $handle) { if ($handle !== 'yaab-analytics') { return $tag; } $attributes = sprintf( 'defer id="hoosh-main" data-id="%s" data-server-url="%s" src=', esc_attr(get_option('yaab_tracking_code', yaab_analytics_default_tracking_code())), esc_url(get_option('yaab_server_url', yaab_analytics_default_server_url())) ); // WordPress sets its own id: the script expects its own. $tag = preg_replace('/\sid=(["\'])yaab-analytics-js\1/', '', $tag); // A literal replacement: a "$" in the address must not be read as a back-reference. $position = strpos($tag, ' src='); if ($position === false) { return $tag; } return substr_replace($tag, ' ' . $attributes, $position, strlen(' src=')); } add_filter('script_loader_tag', 'yaab_analytics_script_attributes', 10, 2);