komito-analytics.php

<?php
/**
 * Komito Analytics is an enhancement for the most popular web analytics software.
 *
 * Privacy is not a concern: Komito Analytics does not store any data.
 * Why? Because it's an extension for the most popular web analytics software, not a service.
 *
 * PHP version 7.2
 *
 * @package KomitoAnalytics
 * @version 1.2.3
 * @license http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
 * @author Valentin Podkamennyi <valentin@dtm.io>
 * @author Komito Analytics <support@komito.net>
 * @link https://wordpress.org/plugins/komito-analytics/
 * @link https://pear.php.net/manual/en/standards.php
 */

/**
 * Plugin Name: Komito Analytics
 * Plugin URI: https://komito.net
 * Description: Komito Analytics is an enhancement for the most popular web analytics software.
 * Version: 1.2.3
 * Author: Datamart
 * Author URI: https://profiles.wordpress.org/datamart
 * License: Apache License 2.0
 * License URI: https://www.apache.org/licenses/LICENSE-2.0
 * Tags: analytics, google-analytics, adobe-analytics, clicktale, event-tracking, yandex-metrica
 * Text Domain: komito-analytics
 * Domain Path: /languages
 */

if (!defined('ABSPATH')) exit; // Exit if accessed directly

define('KOMITO_TEXT_DOMAIN', 'komito-analytics');
define('KOMITO_PREFIX', 'komito_');
define('KOMITO_SCRIPT', 'https://komito.net/komito.js');
define('KOMITO_DEFAULT', 'defaults');

/**
 * Gets Komito Analytics options.
 * @link https://komito.net/integration/
 */
function komito_options() {
    return array(
        'trackTwitter' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track Twitter events if widget is presented on page.', 'komito-analytics')),

        'trackFacebook' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Track Facebook events if widget is presented on page.', 'komito-analytics')),

        'trackLinkedIn' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track LinkedIn events if plugin is presented on page.', 'komito-analytics')),

        'trackDownloads' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track files download links.', 'komito-analytics')),

        'trackOutbound' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track outbound links.', 'komito-analytics')),

        'trackForms' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track forms submissions.', 'komito-analytics')),

        'trackUsers' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track pageviews by users logged in to social networks.', 'komito-analytics')),

        'trackActions' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track "mailto", "tel", "sms" and "skype" actions.', 'komito-analytics')),

        'trackPrint' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track page print actions.', 'komito-analytics')),

        'trackMedia' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track HTML5 video, audio, Vimeo and YouTube players events.', 'komito-analytics')),

        'trackScroll' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track scroll depth.', 'komito-analytics')),

        'trackOrientation' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track orientation change on mobile devices.', 'komito-analytics')),

        'trackColorScheme' => array(
            'default' => 1, 'type' => 'integer',
            'description' => __('Track user preferred color scheme.', 'komito-analytics')),

        'trackAdblock' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Track pageviews with blocked ads. (e.g. AdBlock tracker)', 'komito-analytics')),

        'trackErrorPages' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Track error pages using HTTP status code. (404, 500, etc.)', 'komito-analytics')),

        'sendHeartbeat' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Send heartbeat event. The default heartbeat interval is 30 seconds.', 'komito-analytics')),

        'gtag' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Use "gtag" events for Google Analytics (GA4).', 'komito-analytics')),

        'debugMode' => array(
            'default' => 0, 'type' => 'integer',
            'description' => __('Print all requests to console.', 'komito-analytics'))
    );
}

/**
 * Adds Komito Analytics script.
 * @link https://developer.wordpress.org/reference/functions/wp_enqueue_script/
 * @link https://komito.net/integration/
 */
function komito_load_plugin() {
    if (!get_option(KOMITO_PREFIX . KOMITO_DEFAULT, 1)) {
        $options = komito_options();
        $output = array();

        foreach ($options as $option => $args) {
            $value = esc_attr(get_option(KOMITO_PREFIX . $option, $args['default']));
            array_push($output, $option . ':' . (empty($value) ? 0 : $value));
        }

        wp_register_script('komito-config', '', array(), false, array('in_footer' => true));
        wp_enqueue_script('komito-config');
        wp_add_inline_script('komito-config', 'var _komito=_komito||{' . join(',', $output) . '};');
    }
    wp_enqueue_script('komito', KOMITO_SCRIPT, array(), false, array('strategy' => 'async', 'in_footer' => true));
}

/**
 * Adds a top-level menu page.
 * @link https://developer.wordpress.org/reference/functions/add_menu_page/
 * @link https://developer.wordpress.org/resource/dashicons
 */
function komito_menu() {
    add_menu_page(
        __('Komito Analytics Settings', 'komito-analytics'), // Page title
        __('Komito Analytics', 'komito-analytics'), // Menu title
        'administrator', // Capability
        'komito-settings', // Menu slug, URL
        'komito_settings_page', // Function name
        //'dashicons-chart-area'); // Icon URL or a Dashicons string
        'data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeD0iMHB4IiB5PSIwcHgiIHdpZHRoPSIxMDI0cHgiIGhlaWdodD0iMTAyNHB4IiB2aWV3Qm94PSIwIDAgNDAgNDAiPjxwb2x5Z29uIGZpbGw9IiNkMjAiIHBvaW50cz0iMCwwIDAsMjAuMSAxOS44LDAiLz48cG9seWdvbiBmaWxsPSIjZjgwIiBwb2ludHM9IjAsMzIgMCw0NSAyMC45LDQ1IDguMywyNC42Ii8+PHBvbHlnb24gZmlsbD0iIzA3ZCIgcG9pbnRzPSIzMy42LDQ1IDQ1LDQ1IDQ1LDAgMzIuMywwIDE0LjYsMTgiLz48L3N2Zz4=');
}

/**
 * The function to be called to output the content for Komito settings page.
 * @link https://codex.wordpress.org/Function_Reference/settings_fields
 * @link https://codex.wordpress.org/Function_Reference/do_settings_sections
 * @link https://developer.wordpress.org/reference/functions/submit_button/
 * @link https://developer.wordpress.org/reference/functions/checked/
 */
function komito_settings_page() {
    $options = komito_options();
    ?>
    <div class="wrap">
      <h2><?php esc_html_e('Komito Analytics Settings', 'komito-analytics') ?></h2>
      <form method="post" action="options.php" name="komito-form">
        <?php settings_fields('komito-settings-group'); ?>
        <div>
          <label><input type="checkbox"
            name="<?php echo esc_attr(KOMITO_PREFIX . KOMITO_DEFAULT); ?>"
            value="1" <?php checked(get_option(KOMITO_PREFIX . KOMITO_DEFAULT), 1); ?>
            onclick="setDisabled_()">
            <?php esc_html_e('Use default Komito Analytics configuration settings.', 'komito-analytics') ?></label>
          <p>
            <?php
            /* translators: Variables contain start and end tags for the relevant link. */
            printf(__('For further information and instructions please see the <a href="%s" target="_blank">Komito Analytics integration page</a>.', 'komito-analytics'), 'https://komito.net/integration/');
            ?>
          </p>
        </div>
        <hr/>
        <div class="card">
          <?php foreach ($options as $option => $args) { ?>
              <p>
                <label><input type="checkbox"
                  value="1" <?php checked(get_option(KOMITO_PREFIX . $option), 1); ?>
                  name="<?php echo esc_attr(KOMITO_PREFIX . $option); ?>"><?php echo esc_html($args['description']); ?>
                </label>
              </p>
          <?php } ?>
        </div>
        <?php submit_button(); ?>
      </form>
    </div>
    <?php
}

function komito_settings_script() {
    ?>
    <script>
    function setDisabled_() {
      var form = document.forms['komito-form'];
      var elements = form.elements;
      var input = elements['<?php echo esc_js(KOMITO_PREFIX . KOMITO_DEFAULT); ?>'];
      var length = elements.length;
      var types = {'checkbox': '', 'text': ''};
      var element;
      for (; length;) {
        element = elements[--length];
        if (element.name != input.name && element.type in types) {
          element.disabled = input.checked;
        }
      }
    }
    setDisabled_();
    </script>
    <?php
}

/**
 * Registers Komito Analytics setting.
 * @link https://developer.wordpress.org/reference/functions/register_setting/
 */
function komito_settings() {
    $group = 'komito-settings-group';
    $options = komito_options();

    register_setting($group, KOMITO_PREFIX . KOMITO_DEFAULT, array('default' => 1));
    foreach ($options as $option => $args) {
        register_setting($group, KOMITO_PREFIX . $option, $args);
    }
}

/**
 * Loads a plugin's translated strings.
 * @link https://developer.wordpress.org/reference/functions/load_plugin_textdomain/
 * @link https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#loading-text-domain
 */
function komito_load_textdomain() {
    load_plugin_textdomain(KOMITO_TEXT_DOMAIN, FALSE, basename(dirname(__FILE__)) . '/languages/');
}

/**
 * Hooks a functions on to a specific actions.
 * @link https://developer.wordpress.org/reference/functions/add_action/
 */
add_action('wp_enqueue_scripts', 'komito_load_plugin');
add_action('admin_menu', 'komito_menu');
add_action('admin_init', 'komito_settings');
add_action('admin_print_scripts', 'komito_settings_script');
add_action('plugins_loaded', 'komito_load_textdomain');
?>