From f584bf7ff127f20204a9062107188c1c1be61ff1 Mon Sep 17 00:00:00 2001 From: mqanneh Date: Sun, 24 Dec 2017 00:32:28 +0200 Subject: [PATCH] Issue #1994320 by mqanneh, ultimike, jlockhart, Jelle_S, weseze: User Interface submodule --- google_analytics_et.api.php | 127 +++++++++------- google_analytics_et.module | 159 ++++++++++++--------- google_analytics_et_ui/google_analytics_et_ui.info | 8 ++ .../google_analytics_et_ui.install | 103 +++++++++++++ .../google_analytics_et_ui.module | 27 ++++ .../google_analytics_et_ctools_export_ui.inc | 107 ++++++++++++++ js/google_analytics_et.js | 50 +++---- 7 files changed, 439 insertions(+), 142 deletions(-) create mode 100644 google_analytics_et_ui/google_analytics_et_ui.info create mode 100644 google_analytics_et_ui/google_analytics_et_ui.install create mode 100644 google_analytics_et_ui/google_analytics_et_ui.module create mode 100644 google_analytics_et_ui/plugins/export_ui/google_analytics_et_ctools_export_ui.inc diff --git a/google_analytics_et.api.php b/google_analytics_et.api.php index fcb6261..30c647b 100644 --- a/google_analytics_et.api.php +++ b/google_analytics_et.api.php @@ -1,7 +1,7 @@ TRUE); + * Available options: "trackOnce" + * Usage: options = array("trackOnce" => TRUE); * * @return array * A multidimentional array in the format: * array( - * array( + * 'machine_name' => (object) array( + * 'name' => String('machine_name, a unique machine readable name'), * 'event' => string('mousedown | mousemove | mouseover | etc'), * 'selector' => String('#main-menu li a, or other valid css selector'), * 'category' => String(!text, !href, !currentPage, or custom string), @@ -54,62 +56,85 @@ * 'label' => String(!text, !href, !currentPage, or custom string), * 'value' => Number(Weight of event), * 'noninteraction' => Bool(TRUE | FALSE), + * 'options' => Array('Associative array of options'), * ), * ); */ function hook_google_analytics_et_google_analytics_et_api() { - $selectors = array( - array( - 'event' => 'mousedown', - 'selector' => '#main-menu li a', - 'category' => 'main navigation', - 'action' => 'click', - 'label' => '!text', - 'value' => 0, - 'noninteraction' => TRUE, - 'options' => array(), - ), - array( - 'event' => 'mousedown', - 'selector' => 'a#logo', - 'category' => 'Home Link', - 'action' => 'click', - 'label' => 'Logo', - 'value' => 0, - 'noninteraction' => TRUE, - 'options' => array( - 'trackOnce' => TRUE - ), - ), - array( - 'event' => 'mousedown', - 'selector' => 'div#site-name a[rel="home"]', - 'category' => 'Home Link', - 'action' => 'click', - 'label' => 'Site Name', - 'value' => 0, - 'noninteraction' => TRUE, - 'options' => array(), - ), - array( - 'event' => 'mouseover', - 'selector' => 'div', - 'category' => 'test', - 'action' => 'click', - 'label' => '!test', - 'value' => 0, - 'noninteraction' => TRUE, - 'options' => array(), - ), + $selectors = array(); + + $selector = new stdClass(); + $selector->disabled = FALSE; /* Edit this to true to make a default ga_et_selector disabled initially */ + $selector->api_version = 1; + $selector->name = 'main_menu_mousedown'; + $selector->event = 'mousedown'; + $selector->selector = '#main-menu li a'; + $selector->category = 'main navigation'; + $selector->action = 'click'; + $selector->label = '!text'; + $selector->value = 0; + $selector->noninteraction = TRUE; + $selector->options = array( + 'trackOnce' => 0, + ); + $selectors['main_menu_mousedown'] = $selector; + + $selector = new stdClass(); + $selector->disabled = FALSE; /* Edit this to true to make a default ga_et_selector disabled initially */ + $selector->api_version = 1; + $selector->name = 'logo_mousedown'; + $selector->event = 'mousedown'; + $selector->selector = 'a#logo'; + $selector->category = 'Home Link'; + $selector->action = 'click'; + $selector->label = 'Logo'; + $selector->value = 0; + $selector->noninteraction = TRUE; + $selector->options = array( + 'trackOnce' => 1, + ); + $selectors['logo_mousedown'] = $selector; + + $selector = new stdClass(); + $selector->disabled = FALSE; /* Edit this to true to make a default ga_et_selector disabled initially */ + $selector->api_version = 1; + $selector->name = 'site_name_mousedown'; + $selector->event = 'mousedown'; + $selector->selector = 'div#site-name a[rel="home"]'; + $selector->category = 'Home Link'; + $selector->action = 'click'; + $selector->label = 'Site Name'; + $selector->value = 0; + $selector->noninteraction = TRUE; + $selector->options = array( + 'trackOnce' => 0, + ); + $selectors['site_name_mousedown'] = $selector; + + $selector = new stdClass(); + $selector->disabled = FALSE; /* Edit this to true to make a default ga_et_selector disabled initially */ + $selector->api_version = 1; + $selector->name = 'div_mouseover'; + $selector->event = 'mouseover'; + $selector->selector = 'div'; + $selector->category = 'test'; + $selector->action = 'click'; + $selector->label = '!test'; + $selector->value = 0; + $selector->noninteraction = TRUE; + $selector->options = array( + 'trackOnce' => 0, ); + $selectors['div_mouseover'] = $selector; return $selectors; } /** - * Define the settings used in the google analytics event tracker + * Define the settings used in the google analytics event tracker. * - * @return array settings array. + * @return array + * settings array. */ function hook_google_analytics_et_settings_info() { $settings = array(); diff --git a/google_analytics_et.module b/google_analytics_et.module index 973fd71..7e13234 100644 --- a/google_analytics_et.module +++ b/google_analytics_et.module @@ -15,7 +15,6 @@ function google_analytics_et_page_alter(&$page) { global $user; $id = variable_get('googleanalytics_account', ''); - $cache_on = variable_get('google_analytics_et_cache_on', FALSE); // Get page status code for visibility filtering. $status = drupal_get_http_header('Status'); @@ -26,41 +25,18 @@ function google_analytics_et_page_alter(&$page) { $settings = module_invoke_all('google_analytics_et_settings_info'); - // Get all selectors defined by google_analytics_et_api hook. - $selectors = &drupal_static(__FUNCTION__); - if(!isset($selectors)) { - if($cache = cache_get('google_analytics_et_selectors_cache')) { - $selectors = $cache->data; - } - else { - $selectors = module_invoke_all('google_analytics_et_api'); - - // If the override selectors toggle is TRUE then only load the selectors - // from the variable table. - $override_hooked_selectors = variable_get('google_analytics_et_selectors_override', FALSE); - if ($override_hooked_selectors) { - $selectors = variable_get('google_analytics_et_selectors', ''); - } - - // Sanitize event tracking input to limit the threat of xss. - $selectors = _google_analytics_et_sanitize_event_trackers($selectors); - - if($cache_on) { - cache_set('google_analytics_et_selectors_cache', $selectors, 'cache'); - } - } - } + $selectors = google_analytics_et_get_selectors(); - // Token replacements. @TODO this should be in an alter hook + // Token replacements. @TODO this should be in an alter hook. if (!empty($selectors)) { foreach ($selectors as $out_key => $selector) { if (!empty($selector) && $out_key != 'debug') { - foreach($selector as $key => $value) { + foreach ($selector as $key => $value) { switch ($key) { case 'label': case 'category': case 'action': - $selectors[$out_key][$key] = token_replace($value); + $selectors[$out_key]->{$key} = token_replace($value); break; } } @@ -69,7 +45,7 @@ function google_analytics_et_page_alter(&$page) { } $js = array( 'googleAnalyticsETSettings' => array( - 'selectors' => $selectors, + 'selectors' => array_values($selectors), 'settings' => $settings, ), ); @@ -82,42 +58,55 @@ function google_analytics_et_page_alter(&$page) { } /** - * Add a single selector to the list of selectors. + * Loads all defined selectors. */ -function google_analytics_et_add_event_tracker($selector_array) { - // Get whole list of event trackers. - $event_trackers = google_analytics_et_get_event_trackers(); - - // Append this event tracker to the end of the list. - $event_trackers[] = $selector_array; +function google_analytics_et_get_selectors($database_only = FALSE) { + ctools_include('export'); + $selectors = ctools_export_crud_load_all('ga_et_selectors'); + + // If the override selectors toggle is TRUE then only load the selectors + // from the variable table. + $database_only = $database_only || variable_get('google_analytics_et_selectors_override', FALSE); + foreach ($selectors as $key => $selector) { + if ($database_only && (!isset($selector->export_type) || !($selector->export_type & EXPORT_IN_DATABASE))) { + unset($selectors[$key]); + } + if (isset($selector->disabled) && $selector->disabled) { + unset($selectors[$key]); + } + } - // Save list of event trackers. - variable_set('google_analytics_et_selectors', $event_trackers); + // Sanitize event tracking input to limit the threat of xss. + $selectors = _google_analytics_et_sanitize_event_trackers($selectors); + return $selectors; +} - // Clear cache so the changes will be rendered. - cache_clear_all('google_analytics_et', 'cache', TRUE); +/** + * Add a single selector to the list of selectors. + */ +function google_analytics_et_add_event_tracker($selector_array) { + $new = ctools_export_crud_new('ga_et_selectors'); + foreach (array_keys($selector_array) as $prop) { + $new->{$prop} = $selector_array[$prop]; + } + if (!isset($new->name) || empty($new->name)) { + $new->name = preg_replace('/[^a-z0-9_]+/', '_', $new->selector); + } + ctools_export_crud_save('ga_et_selectors', $new); } /** * Remove a single selector from the list of events being tracked. */ -function google_analytics_et_remove_event_tracker($selector) { - // Get whole list of event trackers. - $event_trackers = google_analytics_et_get_event_trackers(); - $new_event_trackers = array(); - - // Go through all events and copy all that do not match into the new array. - if (is_array($event_trackers)) { - foreach ($event_trackers as $key => $value) { - if ($event_trackers[$key]['selector'] != $selector) { - $new_event_trackers[] = $event_trackers[$key]; - } +function google_analytics_et_remove_event_tracker($selector_string) { + ctools_include('export'); + $selectors = ctools_export_load_object('ga_et_selectors', 'conditions', array('selector')); + foreach ($selectors as $selector) { + if ($selector->selector != $selector_string) { + ctools_export_crud_delete('ga_et_selectors', $selector); } } - - // Save list of event trackers. - variable_set('google_analytics_et_selectors', $new_event_trackers); } /** @@ -143,7 +132,7 @@ function google_analytics_et_override_event_tracking($status = NULL) { } /** - * Validates the input of the override event input function + * Validates the input of the override event input function. */ function _google_analytics_et_override_event_tracking_validate($status) { if ($status == TRUE || $status == FALSE) { @@ -161,10 +150,13 @@ function _google_analytics_et_sanitize_event_trackers($selectors) { $sanitized_selectors = array(); if (is_array($selectors)) { foreach ($selectors as $key => $selector) { - if($key != 'debug') { - foreach ($selector as $s) { - if (!is_array($s)) { - $s = filter_xss($s); + if ($key != 'debug') { + foreach ($selector as $prop => $s) { + if ($prop == 'options') { + $selectors[$key]->{$prop} = array_map('filter_xss', $s); + } + else { + $selectors[$key]->{$prop} = filter_xss($s); } } } @@ -187,11 +179,8 @@ function google_analytics_et_get_event_trackering_override_status() { * Get the event trackers. */ function google_analytics_et_get_event_trackers() { - $et = array(); - - $et = variable_get('google_analytics_et_selectors', $et); - - return $et; + // Backwards compatibility. + return google_analytics_et_get_selectors(TRUE); } /** @@ -203,6 +192,44 @@ function google_analytics_et_get_event_trackers() { * @ingroup google_analytics_et_api_hooks */ function google_analytics_et_api() { - // Loads the user created selectors from the variable table. - return variable_get('google_analytics_et_selectors', array()); + // Backwards compatibility. + return google_analytics_et_get_selectors(TRUE); +} + +/** + * Implements hook_google_analytics_et_api_alter(). + */ +function google_analytics_et_google_analytics_et_api_alter(&$selectors) { + // Backwards compatibility: Invoke the hook again, ctools might have + // overridden some selectors because in previous versions, the selectors + // didn't need to be keyed by name. + // Unset numeric keys, they are useless. + foreach ($selectors as $key => $selector) { + if (is_numeric($key)) { + unset($selectors[$key]); + } + } + + $modules = module_implements('google_analytics_et_api'); + foreach ($modules as $module) { + $function = $module . '_google_analytics_et_api'; + if (function_exists($function)) { + foreach ((array) $function() as $name => $default_selector) { + $default_selector = (object) $default_selector; + // Record the module that provides this exportable. + $default_selector->export_module = $module; + if (is_numeric($name)) { + $default_selector->name = isset($default_selector->name) ? $default_selector->name : preg_replace('/[^a-z0-9_]+/', '_', $default_selector->selector); + } + elseif (!isset($default_selector->name) || empty($default_selector->name)) { + $default_selector->name = $name; + } + // Make sure we don't override data from the database (which overrides + // the defaults) with the defaults again. + if (!isset($selectors[$default_selector->name])) { + $selectors[$default_selector->name] = $default_selector; + } + } + } + } } diff --git a/google_analytics_et_ui/google_analytics_et_ui.info b/google_analytics_et_ui/google_analytics_et_ui.info new file mode 100644 index 0000000..dc1a624 --- /dev/null +++ b/google_analytics_et_ui/google_analytics_et_ui.info @@ -0,0 +1,8 @@ +name = Google Analytics Event Tracking UI +description = "User Interface for Google Analytics Event Tracking" +core = 7.x +package = Statistics +dependencies[] = googleanalytics +dependencies[] = google_analytics_et +dependencies[] = ctools +configure = admin/config/system/et diff --git a/google_analytics_et_ui/google_analytics_et_ui.install b/google_analytics_et_ui/google_analytics_et_ui.install new file mode 100644 index 0000000..ce1d2b7 --- /dev/null +++ b/google_analytics_et_ui/google_analytics_et_ui.install @@ -0,0 +1,103 @@ + 'Table storing Google Analytics ET selectors.', + 'export' => array( + 'key' => 'name', + 'key name' => 'Name', + 'admin_title' => 'selector', + 'primary key' => 'sid', + 'identifier' => 'ga_et_selector', + 'default hook' => 'google_analytics_et_api', + 'api' => array( + 'owner' => 'google_analytics_et_ui', + 'api' => 'google_analytics_et_api', + 'minimum_version' => 1, + 'current_version' => 1, + ), + ), + 'fields' => array( + 'sid' => array( + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => 'Primary ID field for the table. Not used for anything except internal lookups.', + // Do not export database-only keys. + 'no export' => TRUE, + ), + 'name' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => 'Unique ID for selectors. Used to identify them programmatically.', + 'not null' => TRUE, + ), + 'event' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => 'The jQuery event that triggers the event.', + 'not null' => TRUE, + ), + 'selector' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => 'A CSS Selector that the event is bound to.', + 'not null' => TRUE, + ), + 'category' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => "Typically the object that was interacted with (e.g. 'Video').", + 'not null' => TRUE, + ), + 'action' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => "The type of interaction (e.g. 'play').", + 'not null' => TRUE, + ), + 'label' => array( + 'type' => 'varchar', + 'length' => '255', + 'description' => "Useful for categorizing events (e.g. 'Fall Campaign').", + 'not null' => FALSE, + 'default' => NULL, + ), + 'value' => array( + 'type' => 'int', + 'size' => 'medium', + 'description' => "Useful for categorizing events (e.g. 'Fall Campaign').", + 'not null' => FALSE, + 'default' => NULL, + ), + 'noninteraction' => array( + 'type' => 'int', + 'size' => 'tiny', + 'description' => 'Should this event be counted towards the sites overall bounce rate.', + 'not null' => TRUE, + ), + 'options' => array( + 'type' => 'blob', + 'not null' => FALSE, + 'size' => 'big', + 'serialize' => TRUE, + 'description' => 'A serialized array of name value pairs. This holds extra options for the event. Currently the only extra option is trackOnce. Which makes that event only fire one time after the load of the site.', + ), + ), + 'primary key' => array('sid'), + 'unique keys' => array( + 'name' => array('name'), + ), + ); + + return $schema; +} diff --git a/google_analytics_et_ui/google_analytics_et_ui.module b/google_analytics_et_ui/google_analytics_et_ui.module new file mode 100644 index 0000000..a682b89 --- /dev/null +++ b/google_analytics_et_ui/google_analytics_et_ui.module @@ -0,0 +1,27 @@ + array( + 'title' => t('Administer Google Analytics Event Tracking'), + ), + ); +} + +/** + * Implements hook_ctools_plugin_directory(). + */ +function google_analytics_et_ui_ctools_plugin_directory($module, $type) { + // Load the export_ui plugin. + if ($type == 'export_ui') { + return 'plugins/export_ui'; + } +} diff --git a/google_analytics_et_ui/plugins/export_ui/google_analytics_et_ctools_export_ui.inc b/google_analytics_et_ui/plugins/export_ui/google_analytics_et_ctools_export_ui.inc new file mode 100644 index 0000000..b45d012 --- /dev/null +++ b/google_analytics_et_ui/plugins/export_ui/google_analytics_et_ctools_export_ui.inc @@ -0,0 +1,107 @@ + 'ga_et_selectors', + 'access' => 'administer google analytics et', + // Define the menu item. + 'menu' => array( + 'menu prefix' => 'admin/config/system', + 'menu item' => 'et', + 'menu title' => 'Google Analytics Event Tracking', + 'menu description' => 'Configure Google Analytics Event trackers.', + ), + // Define user interface texts. + 'title singular' => t('selector'), + 'title plural' => t('selectors'), + 'title singular proper' => t('Google Analytics event tracking selector'), + 'title plural proper' => t('Google Analytics event tracking selectors'), + // Define the names of the functions that provide the add/edit forms. + 'form' => array( + 'settings' => 'google_analytics_et_ui_admin_form', + // 'submit' and 'validate' are also valid callbacks. + ), +); + +/** + * Define the preset add/edit form. + */ +function google_analytics_et_ui_admin_form(&$form, &$form_state) { + $selector = $form_state['item']; + ctools_include('export'); + + $events = drupal_map_assoc(array( + 'mousedown', 'submit', 'blur', 'change', 'click', 'dblclick', 'focus', + 'focusin', 'focusout', 'hover', 'keydown', 'keypress', 'keyup', + 'mouseenter', 'mouseleave', 'mouseout', 'mouseover', 'mouseup', 'select', + )); + + $form['info']['selector']['#title'] = t('Selector'); + $form['info']['selector']['#description'] = t('The CSS selector the event is bound to.'); + $form['info']['selector']['#required'] = TRUE; + + $form['event'] = array( + '#title' => t('Event'), + '#description' => t('The jQuery event that triggers the event.'), + '#type' => 'select', + '#options' => $events, + '#default_value' => isset($selector->event) ? $selector->event : NULL, + '#required' => TRUE, + ); + + $form['category'] = array( + '#title' => t('Category'), + '#description' => t("Typically the object that was interacted with (e.g. 'Video')."), + '#type' => 'textfield', + '#default_value' => isset($selector->category) ? $selector->category : NULL, + '#required' => TRUE, + ); + + $form['action'] = array( + '#title' => t('Action'), + '#description' => t("The type of interaction (e.g. 'play')."), + '#type' => 'textfield', + '#default_value' => isset($selector->action) ? $selector->action : NULL, + '#required' => TRUE, + ); + + $form['label'] = array( + '#title' => t('Label'), + '#description' => t("Useful for categorizing events (e.g. 'Fall Campaign')."), + '#type' => 'textfield', + '#default_value' => isset($selector->label) ? $selector->label : NULL, + ); + + $form['value'] = array( + '#title' => t('Value'), + '#description' => t("Useful for categorizing events (e.g. 'Fall Campaign')."), + '#element_validate' => array('element_validate_integer'), + '#type' => 'textfield', + '#default_value' => isset($selector->value) ? $selector->value : NULL, + ); + + $form['noninteraction'] = array( + '#title' => t('Noninteraction'), + '#description' => t('Should this event be counted towards the sites overall bounce rate.'), + '#type' => 'checkbox', + '#default_value' => isset($selector->noninteraction) ? $selector->noninteraction : NULL, + ); + + $form['options'] = array( + '#type' => 'container', + '#tree' => TRUE, + ); + + $form['options']['trackOnce'] = array( + '#title' => t('Track only once'), + '#description' => t('Make this event only fire one time after the load of the site.'), + '#type' => 'checkbox', + '#default_value' => isset($selector->options['trackOnce']) ? $selector->options['trackOnce'] : FALSE, + ); + + return $form; +} diff --git a/js/google_analytics_et.js b/js/google_analytics_et.js index b308bcc..5c7be28 100644 --- a/js/google_analytics_et.js +++ b/js/google_analytics_et.js @@ -9,30 +9,30 @@ Drupal.behaviors.googleAnalyticsET = { var settings = Drupal.settings.googleAnalyticsETSettings; delete settings.selectors.debug; - var defaultOptions = { - label: '', - value: 0, - noninteraction: false, - options: [] - }; - var s = new Array(); + for(var i = 0; i < settings.selectors.length; i++) { - s[i] = settings.selectors[i].selector; + bindGAEvent(settings.selectors[i]); } - - jQuery.each(s, - function(i, val) { - jQuery(settings.selectors[i].selector).once('GoogleAnalyticsET').bind(settings.selectors[i].event, - function(event) { - settings.selectors[i] = jQuery.extend(defaultOptions, settings.selectors[i]); - trackEvent(jQuery(this), i, settings.selectors[i].options, settings.selectors[i].category, settings.selectors[i].action, settings.selectors[i].label, settings.selectors[i].value, settings.selectors[i].noninteraction) - } - ); - } - - ); } + } + +/** + * Bind the event to the DOM element based on the settings. + */ +function bindGAEvent(selectorSettings) { + var defaultOptions = { + label: '', + value: 0, + noninteraction: false, + options: [] + }; + jQuery(selectorSettings.selector).once('GoogleAnalyticsET' + '-' + selectorSettings.name, function () { + jQuery(this).bind(selectorSettings.event, function(event) { + selectorSettings = jQuery.extend(defaultOptions, selectorSettings); + trackEvent(jQuery(this), selectorSettings.name, selectorSettings.options, selectorSettings.category, selectorSettings.action, selectorSettings.label, selectorSettings.value, selectorSettings.noninteraction) + }); + }); } /** @@ -57,12 +57,12 @@ Drupal.behaviors.googleAnalyticsET = { * A boolean that when set to true, indicates that the event hit will not * be used in bounce-rate calculation. */ -function trackEvent($obj, id, options, category, action, opt_label, opt_value, opt_noninteraction) { +function trackEvent($obj, name, options, category, action, opt_label, opt_value, opt_noninteraction) { var href = $obj.attr('href') == undefined ? false : String($obj.attr('href')); if (typeof this.options == 'undefined') { this.options = {}; } - this.options[id] = options; + this.options[name] = options; category = category == '!text' ? String($obj.text()) : (category == '!href' ? href : (category == '!currentPage' ? String(window.location.href) : String(category))); action = action == '!text' ? String($obj.text()) : (action == '!href' ? href : (action == '!currentPage' ? String(window.location.href) : String(action))); @@ -75,9 +75,9 @@ function trackEvent($obj, id, options, category, action, opt_label, opt_value, o } // Only track once if the trackOnce option is set. - if (this.options[id].trackOnce == true) { - if (typeof this.options[id].times == 'undefined') { - this.options[id].times = 1; + if (this.options[name].trackOnce == true) { + if (typeof this.options[name].times == 'undefined') { + this.options[name].times = 1; } else { return; -- 2.7.4