all contrib module security updates done
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
|
||||
Module: Google Analytics
|
||||
Author: Alexander Hass <http://drupal.org/user/85918>
|
||||
Author: Alexander Hass <https://drupal.org/user/85918>
|
||||
|
||||
|
||||
Description
|
||||
@@ -12,12 +12,20 @@ Requirements
|
||||
|
||||
* Google Analytics user account
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
* Copy the 'googleanalytics' module directory in to your Drupal
|
||||
Copy the 'googleanalytics' module directory in to your Drupal
|
||||
sites/all/modules directory as usual.
|
||||
|
||||
Upgrading from 6.x-3.x and 7.x-1.x
|
||||
==================================
|
||||
If you upgrade from 6.x-3.x and 7.x-1.x (ga.js) to 7.x-2.x (analytics.js) you
|
||||
should verify if you used custom variables. Write down your settings or make a
|
||||
screenshot. You need to re-configure the settings to use custom dimensions or
|
||||
metrics. There is no automatic upgrade path for custom variables feature. All
|
||||
other module settings are upgraded automatically.
|
||||
|
||||
See https://support.google.com/analytics/answer/2795983?hl=en for more details.
|
||||
|
||||
Usage
|
||||
=====
|
||||
@@ -27,12 +35,8 @@ All pages will now have the required JavaScript added to the
|
||||
HTML footer can confirm this by viewing the page source from
|
||||
your browser.
|
||||
|
||||
New approach to page tracking in 5.x-1.5 and 6.x-1.1
|
||||
====================================================
|
||||
With 5.x-1.5 and 6.x-1.1 there are new settings on the settings page at
|
||||
admin/config/system/googleanalytics. The "Page specific tracking" area now
|
||||
comes with an interface that copies Drupal's block visibility settings.
|
||||
|
||||
Page specific tracking
|
||||
======================
|
||||
The default is set to "Add to every page except the listed pages". By
|
||||
default the following pages are listed for exclusion:
|
||||
|
||||
@@ -44,33 +48,57 @@ node/*/*
|
||||
user/*/*
|
||||
|
||||
These defaults are changeable by the website administrator or any other
|
||||
user with 'administer google analytics' permission.
|
||||
user with 'Administer Google Analytics' permission.
|
||||
|
||||
Like the blocks visibility settings in Drupal core, there is now a
|
||||
choice for "Add if the following PHP code returns TRUE." Sample PHP snippets
|
||||
that can be used in this textarea can be found on the handbook page
|
||||
"Overview-approach to block visibility" at http://drupal.org/node/64135.
|
||||
Like the blocks visibility settings in Drupal core, there is a choice for
|
||||
"Add if the following PHP code returns TRUE." Sample PHP snippets that can be
|
||||
used in this textarea can be found on the handbook page "Overview-approach to
|
||||
block visibility" at https://drupal.org/node/64135.
|
||||
|
||||
Custom variables
|
||||
=================
|
||||
One example for custom variables tracking is the "User roles" tracking. Enter
|
||||
the below configuration data into the custom variables settings form under
|
||||
admin/config/system/googleanalytics.
|
||||
Custom dimensions and metrics
|
||||
=============================
|
||||
One example for custom dimensions tracking is the "User roles" tracking.
|
||||
|
||||
Slot: 1
|
||||
Name: User roles
|
||||
Value: [current-user:role-names]
|
||||
Scope: Visitor
|
||||
1. In the Google Analytics (https://marketingplatform.google.com/about/analytics/)
|
||||
Management Interface you need to setup Dimension #1 with name
|
||||
e.g. "User roles". This step is required. Do not miss it, please.
|
||||
|
||||
More details about Custom variables can be found in the Google API documentation at
|
||||
http://code.google.com/intl/en/apis/analytics/docs/tracking/gaTrackingCustomVariables.html
|
||||
2. Enter the below configuration data into the Drupal custom dimensions settings
|
||||
form under admin/config/system/googleanalytics. You can also choose another
|
||||
index, but keep it always in sync with the index used in step #1.
|
||||
|
||||
Index: 1
|
||||
Value: [current-user:role-names]
|
||||
|
||||
More details about custom dimensions and metrics can be found in the Google API
|
||||
documentation at https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets
|
||||
|
||||
Advanced Settings
|
||||
=================
|
||||
You can include additional JavaScript snippets in the custom javascript
|
||||
code textarea. These can be found on the official Google Analytics pages
|
||||
and a few examples at http://drupal.org/node/248699. Support is not
|
||||
and a few examples at https://drupal.org/node/248699. Support is not
|
||||
provided for any customisations you include.
|
||||
|
||||
To speed up page loading you may also cache the Analytics ga.js
|
||||
To speed up page loading you may also cache the Google Analytics "analytics.js"
|
||||
file locally.
|
||||
|
||||
Manual JS debugging
|
||||
===================
|
||||
For manual debugging of the JS code you are able to create a test node. This
|
||||
is the example HTML code for this test node. You need to enable debugging mode
|
||||
in your Drupal configuration of Google Analytics settings to see verbose
|
||||
messages in your browsers JS console.
|
||||
|
||||
Title: Google Analytics test page
|
||||
|
||||
Body:
|
||||
<ul>
|
||||
<li><a href="mailto:foo@example.com">Mailto</a></li>
|
||||
<li><a href="/files/test.txt">Download file</a></li>
|
||||
<li><a class="colorbox" href="#">Open colorbox</a></li>
|
||||
<li><a href="https://example.com/">External link</a></li>
|
||||
<li><a href="/go/test">Go link</a></li>
|
||||
</ul>
|
||||
|
||||
Text format: Full HTML
|
||||
|
||||
@@ -18,10 +18,17 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#title' => t('Web Property ID'),
|
||||
'#type' => 'textfield',
|
||||
'#default_value' => variable_get('googleanalytics_account', 'UA-'),
|
||||
'#size' => 15,
|
||||
'#size' => 20,
|
||||
'#maxlength' => 20,
|
||||
'#required' => TRUE,
|
||||
'#description' => t('This ID is unique to each site you want to track separately, and is in the form of UA-xxxxxxx-yy. To get a Web Property ID, <a href="@analytics">register your site with Google Analytics</a>, or if you already have registered your site, go to your Google Analytics Settings page to see the ID next to every site profile. <a href="@webpropertyid">Find more information in the documentation</a>.', array('@analytics' => 'http://www.google.com/analytics/', '@webpropertyid' => url('https://developers.google.com/analytics/resources/concepts/gaConceptsAccounts', array('fragment' => 'webProperty')))),
|
||||
'#description' => t('This ID is unique to each site you want to track separately, and is in the form of UA-xxxxxxx-yy. To get a Web Property ID, <a href="@analytics">register your site with Google Analytics</a>, or if you already have registered your site, go to your Google Analytics Settings page to see the ID next to every site profile. <a href="@webpropertyid">Find more information in the documentation</a>.', array('@analytics' => 'https://marketingplatform.google.com/about/analytics/', '@webpropertyid' => url('https://developers.google.com/analytics/resources/concepts/gaConceptsAccounts', array('fragment' => 'webProperty')))),
|
||||
);
|
||||
|
||||
$form['account']['googleanalytics_premium'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Premium account'),
|
||||
'#description' => t('If you are a Google Analytics Premium customer, you can use up to 200 instead of 20 custom dimensions and metrics.'),
|
||||
'#default_value' => variable_get('googleanalytics_premium', FALSE),
|
||||
);
|
||||
|
||||
// Visibility settings.
|
||||
@@ -80,7 +87,15 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#title' => t('List of top-level domains'),
|
||||
'#type' => 'textarea',
|
||||
'#default_value' => variable_get('googleanalytics_cross_domains', ''),
|
||||
'#description' => t('If you selected "Multiple top-level domains" above, enter all related top-level domains. Add one domain per line. By default, the data in your reports only includes the path and name of the page, and not the domain name. For more information see section <em>Show separate domain names</em> in <a href="@url">Tracking Multiple Domains</a>.', array('@url' => url('http://support.google.com/analytics/bin/answer.py', array('query' => array('answer' => '1034342'))))),
|
||||
'#description' => t('If you selected "Multiple top-level domains" above, enter all related top-level domains. Add one domain per line. By default, the data in your reports only includes the path and name of the page, and not the domain name. For more information see section <em>Show separate domain names</em> in <a href="@url">Tracking Multiple Domains</a>.', array('@url' => 'https://support.google.com/analytics/answer/1034342')),
|
||||
'#states' => array(
|
||||
'enabled' => array(
|
||||
':input[name="googleanalytics_domain_mode"]' => array('value' => '2'),
|
||||
),
|
||||
'required' => array(
|
||||
':input[name="googleanalytics_domain_mode"]' => array('value' => '2'),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
// Page specific visibility configurations.
|
||||
@@ -97,8 +112,8 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
|
||||
if ($visibility == 2 && !$php_access) {
|
||||
$form['tracking']['page_vis_settings'] = array();
|
||||
$form['tracking']['page_vis_settings']['visibility'] = array('#type' => 'value', '#value' => 2);
|
||||
$form['tracking']['page_vis_settings']['pages'] = array('#type' => 'value', '#value' => $pages);
|
||||
$form['tracking']['page_vis_settings']['googleanalytics_visibility_pages'] = array('#type' => 'value', '#value' => 2);
|
||||
$form['tracking']['page_vis_settings']['googleanalytics_pages'] = array('#type' => 'value', '#value' => $pages);
|
||||
}
|
||||
else {
|
||||
$options = array(
|
||||
@@ -161,7 +176,7 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#type' => 'fieldset',
|
||||
'#title' => t('Users'),
|
||||
);
|
||||
$t_permission = array('%permission' => t('opt-in or out of tracking'));
|
||||
$t_permission = array('%permission' => t('Opt-in or out of tracking'));
|
||||
$form['tracking']['user_vis_settings']['googleanalytics_custom'] = array(
|
||||
'#type' => 'radios',
|
||||
'#title' => t('Allow users to customize tracking on their account page'),
|
||||
@@ -172,6 +187,12 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
),
|
||||
'#default_value' => variable_get('googleanalytics_custom', 0),
|
||||
);
|
||||
$form['tracking']['user_vis_settings']['googleanalytics_trackuserid'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track User ID'),
|
||||
'#default_value' => variable_get('googleanalytics_trackuserid', 0),
|
||||
'#description' => t('User ID enables the analysis of groups of sessions, across devices, using a unique, persistent, and non-personally identifiable ID string representing a user. <a href="@url">Learn more about the benefits of using User ID</a>.', array('@url' => 'https://support.google.com/analytics/answer/3123663')),
|
||||
);
|
||||
|
||||
// Link specific configurations.
|
||||
$form['tracking']['linktracking'] = array(
|
||||
@@ -199,7 +220,40 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#type' => 'textfield',
|
||||
'#default_value' => variable_get('googleanalytics_trackfiles_extensions', GOOGLEANALYTICS_TRACKFILES_EXTENSIONS),
|
||||
'#description' => t('A file extension list separated by the | character that will be tracked as download when clicked. Regular expressions are supported. For example: !extensions', array('!extensions' => GOOGLEANALYTICS_TRACKFILES_EXTENSIONS)),
|
||||
'#maxlength' => 255,
|
||||
'#maxlength' => 500,
|
||||
'#states' => array(
|
||||
'enabled' => array(
|
||||
':input[name="googleanalytics_trackfiles"]' => array('checked' => TRUE),
|
||||
),
|
||||
// Note: Form required marker is not visible as title is invisible.
|
||||
'required' => array(
|
||||
':input[name="googleanalytics_trackfiles"]' => array('checked' => TRUE),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$colorbox_dependencies = '<div class="admin-requirements">';
|
||||
$colorbox_dependencies .= t('Requires: !module-list', array('!module-list' => (module_exists('colorbox') ? t('@module (<span class="admin-enabled">enabled</span>)', array('@module' => 'Colorbox')) : t('@module (<span class="admin-disabled">disabled</span>)', array('@module' => 'Colorbox')))));
|
||||
$colorbox_dependencies .= '</div>';
|
||||
|
||||
$form['tracking']['linktracking']['googleanalytics_trackcolorbox'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track content in colorbox modal dialogs'),
|
||||
'#default_value' => variable_get('googleanalytics_trackcolorbox', 1),
|
||||
'#description' => t('Enable to track the content shown in colorbox modal windows.') . $colorbox_dependencies,
|
||||
'#disabled' => (module_exists('colorbox') ? FALSE : TRUE),
|
||||
);
|
||||
$form['tracking']['linktracking']['googleanalytics_tracklinkid'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track enhanced link attribution'),
|
||||
'#default_value' => variable_get('googleanalytics_tracklinkid', 0),
|
||||
'#description' => t('Enhanced Link Attribution improves the accuracy of your In-Page Analytics report by automatically differentiating between multiple links to the same URL on a single page by using link element IDs. <a href="@url">Enable enhanced link attribution</a> in the Admin UI of your Google Analytics account.', array('@url' => 'https://support.google.com/analytics/answer/2558867')),
|
||||
);
|
||||
$form['tracking']['linktracking']['googleanalytics_trackurlfragments'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track changing URL fragments as pageviews'),
|
||||
'#default_value' => variable_get('googleanalytics_trackurlfragments', 0),
|
||||
'#description' => t('By default, the URL reported to Google Analytics will not include the "fragment identifier" (i.e. the portion of the URL beginning with a hash sign), and hash changes by themselves will not cause new pageviews to be reported. Checking this box will cause hash changes to be reported as pageviews (in modern browsers) and all pageview URLs to include the fragment where applicable.'),
|
||||
);
|
||||
|
||||
// Message specific configurations.
|
||||
@@ -211,7 +265,7 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#type' => 'checkboxes',
|
||||
'#title' => t('Track messages of type'),
|
||||
'#default_value' => variable_get('googleanalytics_trackmessages', array()),
|
||||
'#description' => t('This will track the selected message types shown to users. Tracking of form validation errors may help you identifying usability issues in your site. Keep in mind that Google allows a maximum of 500 events per session only and every message is tracked as one individual event. If the limit has been exceeded no further events are tracked, but normal page tracking is not effected. Messages from excluded pages cannot tracked.'),
|
||||
'#description' => t('This will track the selected message types shown to users. Tracking of form validation errors may help you identifying usability issues in your site. For each visit (user session), a maximum of approximately 500 combined GATC requests (both events and page views) can be tracked. Every message is tracked as one individual event. Note that - as the number of events in a session approaches the limit - additional events might not be tracked. Messages from excluded pages cannot be tracked.'),
|
||||
'#options' => array(
|
||||
'status' => t('Status message'),
|
||||
'warning' => t('Warning message'),
|
||||
@@ -219,21 +273,19 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
),
|
||||
);
|
||||
|
||||
// Google already have many translations, if not - they display a note to change the language.
|
||||
global $language;
|
||||
$form['tracking']['search_and_advertising'] = array(
|
||||
'#type' => 'fieldset',
|
||||
'#title' => t('Search and Advertising'),
|
||||
);
|
||||
|
||||
$site_search_dependencies = '<div class="admin-dependencies">';
|
||||
$site_search_dependencies .= t('Depends on: !dependencies', array('!dependencies' => (module_exists('search') ? t('@module (<span class="admin-enabled">enabled</span>)', array('@module' => 'Search')) : t('@module (<span class="admin-disabled">disabled</span>)', array('@module' => 'Search')))));
|
||||
$site_search_dependencies = '<div class="admin-requirements">';
|
||||
$site_search_dependencies .= t('Requires: !module-list', array('!module-list' => (module_exists('search') ? t('@module (<span class="admin-enabled">enabled</span>)', array('@module' => 'Search')) : t('@module (<span class="admin-disabled">disabled</span>)', array('@module' => 'Search')))));
|
||||
$site_search_dependencies .= '</div>';
|
||||
|
||||
$form['tracking']['search_and_advertising']['googleanalytics_site_search'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track internal search'),
|
||||
'#description' => t('If checked, internal search keywords are tracked. You must configure your Google account to use the internal query parameter <strong>search</strong>. For more information see <a href="@url">Setting Up Site Search for a Profile</a>.', array('@url' => url('http://support.google.com/analytics/bin/answer.py', array('query' => array('answer' => '1012264'))))) . $site_search_dependencies,
|
||||
'#description' => t('If checked, internal search keywords are tracked. You must configure your Google account to use the internal query parameter <strong>search</strong>. For more information see <a href="@url">Setting Up Site Search for a Profile</a>.', array('@url' => 'https://support.google.com/analytics/answer/1012264')) . $site_search_dependencies,
|
||||
'#default_value' => variable_get('googleanalytics_site_search', FALSE),
|
||||
'#disabled' => (module_exists('search') ? FALSE : TRUE),
|
||||
);
|
||||
@@ -245,8 +297,8 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
);
|
||||
$form['tracking']['search_and_advertising']['googleanalytics_trackdoubleclick'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Track DoubleClick data'),
|
||||
'#description' => t('If checked, the alternative Google <a href="@doubleclick">DoubleClick data tracking</a> is used to enable AdWords remarketing features. If you choose this option you will need to <a href="@privacy">update your privacy policy</a>.', array('@doubleclick' => url('http://support.google.com/analytics/bin/answer.py', array('query' => array('answer' => '2444872'))), '@privacy' => url('http://support.google.com/analytics/bin/answer.py', array('query' => array('answer' => '2636405'))))),
|
||||
'#title' => t('Track display features'),
|
||||
'#description' => t('The display features plugin can be used to enable Display Advertising Features in Google Analytics, such as Remarketing, Demographics and Interest Reporting, and more. <a href="@displayfeatures">Learn more about Display Advertising Features in Google Analytics</a>. If you choose this option you will need to <a href="@privacy">update your privacy policy</a>.', array('@displayfeatures' => 'https://support.google.com/analytics/answer/3450482', '@privacy' => 'https://support.google.com/analytics/answer/2700409')),
|
||||
'#default_value' => variable_get('googleanalytics_trackdoubleclick', FALSE),
|
||||
);
|
||||
|
||||
@@ -259,88 +311,119 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Anonymize visitors IP address'),
|
||||
'#description' => t('Tell Google Analytics to anonymize the information sent by the tracker objects by removing the last octet of the IP address prior to its storage. Note that this will slightly reduce the accuracy of geographic reporting. In some countries it is not allowed to collect personally identifying information for privacy reasons and this setting may help you to comply with the local laws.'),
|
||||
'#default_value' => variable_get('googleanalytics_tracker_anonymizeip', 0),
|
||||
'#default_value' => variable_get('googleanalytics_tracker_anonymizeip', 1),
|
||||
);
|
||||
$form['tracking']['privacy']['googleanalytics_privacy_donottrack'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Universal web tracking opt-out'),
|
||||
'#description' => t('If enabled and your server receives the <a href="@donottrack">Do-Not-Track</a> header from the client browser, the Google Analytics module will not embed any tracking code into your site. Compliance with Do Not Track could be purely voluntary, enforced by industry self-regulation, or mandated by state or federal law. Please accept your visitors privacy. If they have opt-out from tracking and advertising, you should accept their personal decision. This feature is currently limited to logged in users and disabled page caching.', array('@donottrack' => 'http://donottrack.us/')),
|
||||
'#description' => t('If enabled and your server receives the <a href="@donottrack">Do-Not-Track</a> header from the client browser, the Google Analytics module will not embed any tracking code into your site. Compliance with Do Not Track could be purely voluntary, enforced by industry self-regulation, or mandated by state or federal law. Please accept your visitors privacy. If they have opt-out from tracking and advertising, you should accept their personal decision. This feature is currently limited to logged in users and disabled page caching.', array('@donottrack' => 'https://www.eff.org/issues/do-not-track')),
|
||||
'#default_value' => variable_get('googleanalytics_privacy_donottrack', 1),
|
||||
);
|
||||
|
||||
// Custom variables.
|
||||
$form['googleanalytics_custom_var'] = array(
|
||||
// Custom Dimensions.
|
||||
$form['googleanalytics_custom_dimension'] = array(
|
||||
'#collapsed' => TRUE,
|
||||
'#collapsible' => TRUE,
|
||||
'#description' => t('You can add Google Analytics <a href="@custom_var_documentation">Custom Variables</a> here. These will be added to every page that Google Analytics tracking code appears on. Google Analytics will only accept custom variables if the <em>name</em> and <em>value</em> combined are less than 128 bytes after URL encoding. Keep the names as short as possible and expect long values to get trimmed. You may use tokens in custom variable names and values. Global and user tokens are always available; on node pages, node tokens are also available.', array('@custom_var_documentation' => 'https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables')),
|
||||
'#description' => t('You can set values for Google Analytics <a href="@custom_var_documentation">Custom Dimensions</a> here. You must have already configured your custom dimensions in the <a href="@setup_documentation">Google Analytics Management Interface</a>. You may use tokens. Global and user tokens are always available; on node pages, node tokens are also available. A dimension <em>value</em> is allowed to have a maximum length of 150 bytes. Expect longer values to get trimmed.', array('@custom_var_documentation' => 'https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets', '@setup_documentation' => 'https://support.google.com/analytics/answer/2709829')),
|
||||
'#theme' => 'googleanalytics_admin_custom_var_table',
|
||||
'#title' => t('Custom variables'),
|
||||
'#title' => t('Custom dimensions'),
|
||||
'#tree' => TRUE,
|
||||
'#type' => 'fieldset',
|
||||
);
|
||||
|
||||
$googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
|
||||
$googleanalytics_custom_dimension = variable_get('googleanalytics_custom_dimension', array());
|
||||
|
||||
// Google Analytics supports up to 5 custom variables.
|
||||
for ($i = 1; $i < 6; $i++) {
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['slot'] = array(
|
||||
// Standard Google Analytics accounts support up to 20 custom dimensions,
|
||||
// premium accounts support up to 200 custom dimensions.
|
||||
$limit = (variable_get('googleanalytics_premium', FALSE)) ? 200 : 20;
|
||||
for ($i = 1; $i <= $limit; $i++) {
|
||||
$form['googleanalytics_custom_dimension']['indexes'][$i]['index'] = array(
|
||||
'#default_value' => $i,
|
||||
'#description' => t('Slot number'),
|
||||
'#description' => t('Index number'),
|
||||
'#disabled' => TRUE,
|
||||
'#size' => 1,
|
||||
'#title' => t('Custom variable slot #@slot', array('@slot' => $i)),
|
||||
'#title' => t('Custom dimension index #@index', array('@index' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'textfield',
|
||||
);
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['name'] = array(
|
||||
'#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['name']) ? $googleanalytics_custom_vars['slots'][$i]['name'] : '',
|
||||
'#description' => t('The custom variable name.'),
|
||||
$form['googleanalytics_custom_dimension']['indexes'][$i]['value'] = array(
|
||||
'#default_value' => isset($googleanalytics_custom_dimension[$i]['value']) ? $googleanalytics_custom_dimension[$i]['value'] : '',
|
||||
'#description' => t('The custom dimension value.'),
|
||||
'#maxlength' => 255,
|
||||
'#size' => 20,
|
||||
'#title' => t('Custom variable name #@slot', array('@slot' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'textfield',
|
||||
'#element_validate' => array('googleanalytics_token_element_validate'),
|
||||
'#token_types' => array('node'),
|
||||
);
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['value'] = array(
|
||||
'#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['value']) ? $googleanalytics_custom_vars['slots'][$i]['value'] : '',
|
||||
'#description' => t('The custom variable value.'),
|
||||
'#maxlength' => 255,
|
||||
'#title' => t('Custom variable value #@slot', array('@slot' => $i)),
|
||||
'#title' => t('Custom dimension value #@index', array('@index' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'textfield',
|
||||
'#element_validate' => array('googleanalytics_token_element_validate'),
|
||||
'#token_types' => array('node'),
|
||||
);
|
||||
if (module_exists('token')) {
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['name']['#element_validate'][] = 'token_element_validate';
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['value']['#element_validate'][] = 'token_element_validate';
|
||||
$form['googleanalytics_custom_dimension']['indexes'][$i]['value']['#element_validate'][] = 'token_element_validate';
|
||||
}
|
||||
$form['googleanalytics_custom_var']['slots'][$i]['scope'] = array(
|
||||
'#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['scope']) ? $googleanalytics_custom_vars['slots'][$i]['scope'] : 3,
|
||||
'#description' => t('The scope for the custom variable.'),
|
||||
'#title' => t('Custom variable slot #@slot', array('@slot' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'select',
|
||||
'#options' => array(
|
||||
1 => t('Visitor'),
|
||||
2 => t('Session'),
|
||||
3 => t('Page'),
|
||||
),
|
||||
}
|
||||
|
||||
$form['googleanalytics_custom_dimension']['googleanalytics_description'] = array(
|
||||
'#type' => 'item',
|
||||
'#description' => t('You can supplement Google Analytics\' basic IP address tracking of visitors by segmenting users based on custom dimensions. Section 7 of the <a href="@ga_tos">Google Analytics terms of service</a> requires that You will not (and will not allow any third party to) use the Service to track, collect or upload any data that personally identifies an individual (such as a name, userid, email address or billing information), or other data which can be reasonably linked to such information by Google. You will have and abide by an appropriate Privacy Policy and will comply with all applicable laws and regulations relating to the collection of information from Visitors. You must post a Privacy Policy and that Privacy Policy must provide notice of Your use of cookies that are used to collect traffic data, and You must not circumvent any privacy features (e.g., an opt-out) that are part of the Service.', array('@ga_tos' => 'https://www.google.com/analytics/terms/gb.html')),
|
||||
);
|
||||
if (module_exists('token')) {
|
||||
$form['googleanalytics_custom_dimension']['googleanalytics_token_tree'] = array(
|
||||
'#theme' => 'token_tree',
|
||||
'#token_types' => array('node'),
|
||||
'#dialog' => TRUE,
|
||||
);
|
||||
}
|
||||
|
||||
$form['googleanalytics_custom_var']['googleanalytics_custom_var_description'] = array(
|
||||
'#type' => 'item',
|
||||
'#description' => t('You can supplement Google Analytics\' basic IP address tracking of visitors by segmenting users based on custom variables. Section 7 of the <a href="@ga_tos">Google Analytics terms of service</a> requires that You will not (and will not allow any third party to) use the Service to track, collect or upload any data that personally identifies an individual (such as a name, email address or billing information), or other data which can be reasonably linked to such information by Google. You will have and abide by an appropriate Privacy Policy and will comply with all applicable laws and regulations relating to the collection of information from Visitors. You must post a Privacy Policy and that Privacy Policy must provide notice of Your use of cookies that are used to collect traffic data, and You must not circumvent any privacy features (e.g., an opt-out) that are part of the Service.', array('@ga_tos' => 'http://www.google.com/analytics/terms/gb.html')),
|
||||
);
|
||||
$form['googleanalytics_custom_var']['googleanalytics_custom_var_token_tree'] = array(
|
||||
'#theme' => 'token_tree',
|
||||
'#token_types' => array('node'),
|
||||
'#dialog' => TRUE,
|
||||
// Custom Metrics.
|
||||
$form['googleanalytics_custom_metric'] = array(
|
||||
'#collapsed' => TRUE,
|
||||
'#collapsible' => TRUE,
|
||||
'#description' => t('You can add Google Analytics <a href="@custom_var_documentation">Custom Metrics</a> here. You must have already configured your custom metrics in the <a href="@setup_documentation">Google Analytics Management Interface</a>. You may use tokens. Global and user tokens are always available; on node pages, node tokens are also available.', array('@custom_var_documentation' => 'https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets', '@setup_documentation' => 'https://support.google.com/analytics/answer/2709829')),
|
||||
'#theme' => 'googleanalytics_admin_custom_var_table',
|
||||
'#title' => t('Custom metrics'),
|
||||
'#tree' => TRUE,
|
||||
'#type' => 'fieldset',
|
||||
);
|
||||
|
||||
$googleanalytics_custom_metric = variable_get('googleanalytics_custom_metric', array());
|
||||
|
||||
// Standard Google Analytics accounts support up to 20 custom metrics,
|
||||
// premium accounts support up to 200 custom metrics.
|
||||
for ($i = 1; $i <= $limit; $i++) {
|
||||
$form['googleanalytics_custom_metric']['indexes'][$i]['index'] = array(
|
||||
'#default_value' => $i,
|
||||
'#description' => t('Index number'),
|
||||
'#disabled' => TRUE,
|
||||
'#size' => 1,
|
||||
'#title' => t('Custom metric index #@index', array('@index' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'textfield',
|
||||
);
|
||||
$form['googleanalytics_custom_metric']['indexes'][$i]['value'] = array(
|
||||
'#default_value' => isset($googleanalytics_custom_metric[$i]['value']) ? $googleanalytics_custom_metric[$i]['value'] : '',
|
||||
'#description' => t('The custom metric value.'),
|
||||
'#maxlength' => 255,
|
||||
'#title' => t('Custom metric value #@index', array('@index' => $i)),
|
||||
'#title_display' => 'invisible',
|
||||
'#type' => 'textfield',
|
||||
'#element_validate' => array('googleanalytics_token_element_validate'),
|
||||
'#token_types' => array('node'),
|
||||
);
|
||||
if (module_exists('token')) {
|
||||
$form['googleanalytics_custom_metric']['indexes'][$i]['value']['#element_validate'][] = 'token_element_validate';
|
||||
}
|
||||
}
|
||||
|
||||
$form['googleanalytics_custom_metric']['googleanalytics_description'] = array(
|
||||
'#type' => 'item',
|
||||
'#description' => t('You can supplement Google Analytics\' basic IP address tracking of visitors by segmenting users based on custom metrics. Section 7 of the <a href="@ga_tos">Google Analytics terms of service</a> requires that You will not (and will not allow any third party to) use the Service to track, collect or upload any data that personally identifies an individual (such as a name, userid, email address or billing information), or other data which can be reasonably linked to such information by Google. You will have and abide by an appropriate Privacy Policy and will comply with all applicable laws and regulations relating to the collection of information from Visitors. You must post a Privacy Policy and that Privacy Policy must provide notice of Your use of cookies that are used to collect traffic data, and You must not circumvent any privacy features (e.g., an opt-out) that are part of the Service.', array('@ga_tos' => 'https://www.google.com/analytics/terms/gb.html')),
|
||||
);
|
||||
if (module_exists('token')) {
|
||||
$form['googleanalytics_custom_metric']['googleanalytics_token_tree'] = array(
|
||||
'#theme' => 'token_tree',
|
||||
'#token_types' => array('node'),
|
||||
'#dialog' => TRUE,
|
||||
);
|
||||
}
|
||||
|
||||
// Advanced feature configurations.
|
||||
$form['advanced'] = array(
|
||||
@@ -367,38 +450,45 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
);
|
||||
}
|
||||
|
||||
$user_access_add_js_snippets = !user_access('add JS snippets for google analytics');
|
||||
$user_access_add_js_snippets_permission_warning = $user_access_add_js_snippets ? ' <em>' . t('This field has been disabled because you do not have sufficient permissions to edit it.') . '</em>' : '';
|
||||
$form['advanced']['codesnippet'] = array(
|
||||
'#type' => 'fieldset',
|
||||
'#title' => t('Custom JavaScript code'),
|
||||
'#collapsible' => TRUE,
|
||||
'#collapsed' => TRUE,
|
||||
'#description' => t('You can add custom Google Analytics <a href="@snippets">code snippets</a> here. These will be added every time tracking is in effect. Before you add your custom code, you should read the <a href="@ga_concepts_overview">Google Analytics Tracking Code - Functional Overview</a> and the <a href="@ga_js_api">Google Analytics Tracking API</a> documentation. <strong>Do not include the <script> tags</strong>, and always end your code with a semicolon (;).', array('@snippets' => 'http://drupal.org/node/248699', '@ga_concepts_overview' => 'https://developers.google.com/analytics/resources/concepts/gaConceptsTrackingOverview', '@ga_js_api' => 'https://developers.google.com/analytics/devguides/collection/gajs/methods/')),
|
||||
'#description' => t('You can add custom Google Analytics <a href="@snippets">code snippets</a> here. These will be added every time tracking is in effect. Before you add your custom code, you should read the <a href="@ga_concepts_overview">Google Analytics Tracking Code - Functional Overview</a> and the <a href="@ga_js_api">Google Analytics Tracking API</a> documentation. <strong>Do not include the <script> tags</strong>, and always end your code with a semicolon (;).', array('@snippets' => 'https://drupal.org/node/248699', '@ga_concepts_overview' => 'https://developers.google.com/analytics/resources/concepts/gaConceptsTrackingOverview', '@ga_js_api' => 'https://developers.google.com/analytics/devguides/collection/analyticsjs/method-reference')),
|
||||
);
|
||||
$form['advanced']['codesnippet']['googleanalytics_codesnippet_create'] = array(
|
||||
'#type' => 'textarea',
|
||||
'#title' => t('Create only fields'),
|
||||
'#default_value' => _googleanalytics_get_name_value_string(variable_get('googleanalytics_codesnippet_create', array())),
|
||||
'#rows' => 5,
|
||||
'#description' => t('Enter one value per line, in the format name|value. Settings in this textarea will be added to <code>ga("create", "UA-XXXX-Y", {"name":"value"});</code>. For more information, read <a href="@url">create only fields</a> documentation in the Analytics.js field reference.', array('@url' => 'https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#create')),
|
||||
'#element_validate' => array('googleanalytics_validate_create_field_values'),
|
||||
);
|
||||
$form['advanced']['codesnippet']['googleanalytics_codesnippet_before'] = array(
|
||||
'#type' => 'textarea',
|
||||
'#title' => t('Code snippet (before)'),
|
||||
'#default_value' => variable_get('googleanalytics_codesnippet_before', ''),
|
||||
'#disabled' => $user_access_add_js_snippets,
|
||||
'#rows' => 5,
|
||||
'#description' => t("Code in this textarea will be added <strong>before</strong> _gaq.push(['_trackPageview'])."),
|
||||
'#description' => t('Code in this textarea will be added <strong>before</strong> <code>ga("send", "pageview");</code>.') . $user_access_add_js_snippets_permission_warning,
|
||||
);
|
||||
$form['advanced']['codesnippet']['googleanalytics_codesnippet_after'] = array(
|
||||
'#type' => 'textarea',
|
||||
'#title' => t('Code snippet (after)'),
|
||||
'#default_value' => variable_get('googleanalytics_codesnippet_after', ''),
|
||||
'#disabled' => $user_access_add_js_snippets,
|
||||
'#rows' => 5,
|
||||
'#description' => t("Code in this textarea will be added <strong>after</strong> _gaq.push(['_trackPageview']). This is useful if you'd like to track a site in two accounts."),
|
||||
'#description' => t('Code in this textarea will be added <strong>after</strong> <code>ga("send", "pageview");</code>. This is useful if you\'d like to track a site in two accounts.') . $user_access_add_js_snippets_permission_warning,
|
||||
);
|
||||
|
||||
$form['advanced']['googleanalytics_js_scope'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('JavaScript scope'),
|
||||
'#description' => t('Google recommends adding the external JavaScript files to the header for performance reasons. If <em>Multiple top-level domains</em> has been selected, this setting will be forced to header.'),
|
||||
'#options' => array(
|
||||
'footer' => t('Footer'),
|
||||
'header' => t('Header'),
|
||||
),
|
||||
'#default_value' => variable_get('googleanalytics_js_scope', 'header'),
|
||||
'#disabled' => (variable_get('googleanalytics_domain_mode', 0) == 2) ? TRUE : FALSE,
|
||||
$form['advanced']['googleanalytics_debug'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Enable debugging'),
|
||||
'#description' => t('If checked, the Google Universal Analytics debugging script will be loaded. You should not enable your production site to use this version of the JavaScript. The analytics_debug.js script is larger than the analytics.js tracking code and it is not typically cached. Using it in your production site will slow down your site for all of your users. Again, this is only for your own testing purposes. Debug messages are printed to the <code>window.console</code> object.'),
|
||||
'#default_value' => variable_get('googleanalytics_debug', 0),
|
||||
);
|
||||
|
||||
return system_settings_form($form);
|
||||
@@ -408,31 +498,37 @@ function googleanalytics_admin_settings_form($form_state) {
|
||||
* Implements _form_validate().
|
||||
*/
|
||||
function googleanalytics_admin_settings_form_validate($form, &$form_state) {
|
||||
// Custom variables validation.
|
||||
foreach ($form_state['values']['googleanalytics_custom_var']['slots'] as $custom_var) {
|
||||
$form_state['values']['googleanalytics_custom_var']['slots'][$custom_var['slot']]['name'] = trim($custom_var['name']);
|
||||
$form_state['values']['googleanalytics_custom_var']['slots'][$custom_var['slot']]['value'] = trim($custom_var['value']);
|
||||
|
||||
// Validate empty names/values.
|
||||
if (empty($custom_var['name']) && !empty($custom_var['value'])) {
|
||||
form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][name", t('The custom variable @slot-number requires a <em>Name</em> if a <em>Value</em> has been provided.', array('@slot-number' => $custom_var['slot'])));
|
||||
}
|
||||
elseif (!empty($custom_var['name']) && empty($custom_var['value'])) {
|
||||
form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][value", t('The custom variable @slot-number requires a <em>Value</em> if a <em>Name</em> has been provided.', array('@slot-number' => $custom_var['slot'])));
|
||||
// Trim custom dimensions and metrics.
|
||||
foreach ($form_state['values']['googleanalytics_custom_dimension']['indexes'] as $dimension) {
|
||||
$form_state['values']['googleanalytics_custom_dimension']['indexes'][$dimension['index']]['value'] = trim($dimension['value']);
|
||||
// Remove empty values from the array.
|
||||
if (!drupal_strlen($form_state['values']['googleanalytics_custom_dimension']['indexes'][$dimension['index']]['value'])) {
|
||||
unset($form_state['values']['googleanalytics_custom_dimension']['indexes'][$dimension['index']]);
|
||||
}
|
||||
}
|
||||
$form_state['values']['googleanalytics_custom_dimension'] = $form_state['values']['googleanalytics_custom_dimension']['indexes'];
|
||||
|
||||
foreach ($form_state['values']['googleanalytics_custom_metric']['indexes'] as $metric) {
|
||||
$form_state['values']['googleanalytics_custom_metric']['indexes'][$metric['index']]['value'] = trim($metric['value']);
|
||||
// Remove empty values from the array.
|
||||
if (!drupal_strlen($form_state['values']['googleanalytics_custom_metric']['indexes'][$metric['index']]['value'])) {
|
||||
unset($form_state['values']['googleanalytics_custom_metric']['indexes'][$metric['index']]);
|
||||
}
|
||||
}
|
||||
$form_state['values']['googleanalytics_custom_metric'] = $form_state['values']['googleanalytics_custom_metric']['indexes'];
|
||||
|
||||
// Trim some text values.
|
||||
$form_state['values']['googleanalytics_account'] = trim($form_state['values']['googleanalytics_account']);
|
||||
$form_state['values']['googleanalytics_pages'] = trim($form_state['values']['googleanalytics_pages']);
|
||||
$form_state['values']['googleanalytics_cross_domains'] = trim($form_state['values']['googleanalytics_cross_domains']);
|
||||
$form_state['values']['googleanalytics_codesnippet_create'] = _googleanalytics_extract_create_field_values($form_state['values']['googleanalytics_codesnippet_create']);
|
||||
$form_state['values']['googleanalytics_codesnippet_before'] = trim($form_state['values']['googleanalytics_codesnippet_before']);
|
||||
$form_state['values']['googleanalytics_codesnippet_after'] = trim($form_state['values']['googleanalytics_codesnippet_after']);
|
||||
|
||||
// Replace all type of dashes (n-dash, m-dash, minus) with the normal dashes.
|
||||
$form_state['values']['googleanalytics_account'] = str_replace(array('–', '—', '−'), '-', $form_state['values']['googleanalytics_account']);
|
||||
|
||||
if (!preg_match('/^UA-\d{4,}-\d+$/', $form_state['values']['googleanalytics_account'])) {
|
||||
if (!preg_match('/^UA-\d+-\d+$/', $form_state['values']['googleanalytics_account'])) {
|
||||
form_set_error('googleanalytics_account', t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'));
|
||||
}
|
||||
|
||||
@@ -440,16 +536,25 @@ function googleanalytics_admin_settings_form_validate($form, &$form_state) {
|
||||
if ($form_state['values']['googleanalytics_domain_mode'] == 2 && empty($form_state['values']['googleanalytics_cross_domains'])) {
|
||||
form_set_error('googleanalytics_cross_domains', t('A list of top-level domains is required if <em>Multiple top-level domains</em> has been selected.'));
|
||||
}
|
||||
// Clear the domain list if cross domains are disabled.
|
||||
if ($form_state['values']['googleanalytics_domain_mode'] != 2) {
|
||||
$form_state['values']['googleanalytics_cross_domains'] = '';
|
||||
}
|
||||
|
||||
// Disallow empty list of download file extensions.
|
||||
if ($form_state['values']['googleanalytics_trackfiles'] && empty($form_state['values']['googleanalytics_trackfiles_extensions'])) {
|
||||
form_set_error('googleanalytics_trackfiles_extensions', t('List of download file extensions cannot empty.'));
|
||||
}
|
||||
// Clear obsolete local cache if cache has been disabled.
|
||||
if (empty($form_state['values']['googleanalytics_cache']) && $form['advanced']['googleanalytics_cache']['#default_value']) {
|
||||
googleanalytics_clear_js_cache();
|
||||
}
|
||||
|
||||
// This is for the Newbie's who cannot read a text area description.
|
||||
if (stristr($form_state['values']['googleanalytics_codesnippet_before'], 'google-analytics.com/ga.js')) {
|
||||
if (stristr($form_state['values']['googleanalytics_codesnippet_before'], 'google-analytics.com/analytics.js')) {
|
||||
form_set_error('googleanalytics_codesnippet_before', t('Do not add the tracker code provided by Google into the javascript code snippets! This module already builds the tracker code based on your Google Analytics account number and settings.'));
|
||||
}
|
||||
if (stristr($form_state['values']['googleanalytics_codesnippet_after'], 'google-analytics.com/ga.js')) {
|
||||
if (stristr($form_state['values']['googleanalytics_codesnippet_after'], 'google-analytics.com/analytics.js')) {
|
||||
form_set_error('googleanalytics_codesnippet_after', t('Do not add the tracker code provided by Google into the javascript code snippets! This module already builds the tracker code based on your Google Analytics account number and settings.'));
|
||||
}
|
||||
if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_before'])) {
|
||||
@@ -458,41 +563,40 @@ function googleanalytics_admin_settings_form_validate($form, &$form_state) {
|
||||
if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_after'])) {
|
||||
form_set_error('googleanalytics_codesnippet_after', t('Do not include the <script> tags in the javascript code snippets.'));
|
||||
}
|
||||
|
||||
// Header section must be forced for multiple top-level domains.
|
||||
if ($form_state['values']['googleanalytics_domain_mode'] == 2) {
|
||||
$form_state['values']['googleanalytics_js_scope'] = 'header';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Layout for the custom variables table in the admin settings form.
|
||||
*
|
||||
* @param array $variables
|
||||
* An array contains the form elements.
|
||||
*
|
||||
* @return string
|
||||
* The rendered output.
|
||||
*/
|
||||
function theme_googleanalytics_admin_custom_var_table($variables) {
|
||||
$form = $variables['form'];
|
||||
|
||||
$header = array(
|
||||
array('data' => t('Slot')),
|
||||
array('data' => t('Name')),
|
||||
array('data' => t('Index')),
|
||||
array('data' => t('Value')),
|
||||
array('data' => t('Scope')),
|
||||
);
|
||||
|
||||
$rows = array();
|
||||
foreach (element_children($form['slots']) as $key => $id) {
|
||||
foreach (element_children($form['indexes']) as $id) {
|
||||
$rows[] = array(
|
||||
'data' => array(
|
||||
drupal_render($form['slots'][$id]['slot']),
|
||||
drupal_render($form['slots'][$id]['name']),
|
||||
drupal_render($form['slots'][$id]['value']),
|
||||
drupal_render($form['slots'][$id]['scope']),
|
||||
drupal_render($form['indexes'][$id]['index']),
|
||||
drupal_render($form['indexes'][$id]['value']),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
$output = theme('table', array('header' => $header, 'rows' => $rows));
|
||||
$output .= drupal_render($form['googleanalytics_custom_var_description']);
|
||||
$output .= drupal_render($form['googleanalytics_custom_var_token_tree']);
|
||||
$output .= drupal_render($form['googleanalytics_description']);
|
||||
if (isset($form['googleanalytics_token_tree'])) {
|
||||
$output .= drupal_render($form['googleanalytics_token_tree']);
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
@@ -528,11 +632,18 @@ function googleanalytics_token_element_validate(&$element, &$form_state) {
|
||||
return $element;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $value
|
||||
* An array of token values.
|
||||
*
|
||||
* @return array
|
||||
* A unique array of invalid tokens.
|
||||
*/
|
||||
function _googleanalytics_get_forbidden_tokens($value) {
|
||||
$invalid_tokens = array();
|
||||
$value_tokens = is_string($value) ? token_scan($value) : $value;
|
||||
|
||||
foreach ($value_tokens as $type => $tokens) {
|
||||
foreach ($value_tokens as $tokens) {
|
||||
if (array_filter($tokens, '_googleanalytics_contains_forbidden_token')) {
|
||||
$invalid_tokens = array_merge($invalid_tokens, array_values($tokens));
|
||||
}
|
||||
@@ -545,8 +656,9 @@ function _googleanalytics_get_forbidden_tokens($value) {
|
||||
/**
|
||||
* Validate if a string contains forbidden tokens not allowed by privacy rules.
|
||||
*
|
||||
* @param $token_string
|
||||
* @param string $token_string
|
||||
* A string with one or more tokens to be validated.
|
||||
*
|
||||
* @return boolean
|
||||
* TRUE if blacklisted token has been found, otherwise FALSE.
|
||||
*/
|
||||
@@ -599,3 +711,203 @@ function _googleanalytics_contains_forbidden_token($token_string) {
|
||||
|
||||
return preg_match('/' . implode('|', array_map('preg_quote', $token_blacklist)) . '/i', $token_string);
|
||||
}
|
||||
|
||||
/**
|
||||
* #element_validate callback for create only fields.
|
||||
*
|
||||
* @param $element
|
||||
* An associative array containing the properties and children of the
|
||||
* generic form element.
|
||||
* @param $form_state
|
||||
* The $form_state array for the form this element belongs to.
|
||||
*
|
||||
* @see form_process_pattern()
|
||||
*/
|
||||
function googleanalytics_validate_create_field_values(&$element, &$form_state) {
|
||||
$values = _googleanalytics_extract_create_field_values($element['#value']);
|
||||
|
||||
if (!is_array($values)) {
|
||||
form_error($element, t('The %element-title field contains invalid input.', array('%element-title' => $element['#title'])));
|
||||
}
|
||||
else {
|
||||
// Check that name and value are valid for the field type.
|
||||
foreach ($values as $name => $value) {
|
||||
if ($error = _googleanalytics_validate_create_field_name($name)) {
|
||||
form_error($element, $error);
|
||||
break;
|
||||
}
|
||||
if ($error = _googleanalytics_validate_create_field_value($value)) {
|
||||
form_error($element, $error);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return $element;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts the values array from the element.
|
||||
*
|
||||
* @param string $string
|
||||
* The raw string to extract values from.
|
||||
*
|
||||
* @return array|null
|
||||
* The array of extracted key/value pairs, or NULL if the string is invalid.
|
||||
*
|
||||
* @see \Drupal\options\Plugin\Field\FieldType\ListTextItem::allowedValuesString()
|
||||
*/
|
||||
function _googleanalytics_extract_create_field_values($string) {
|
||||
$values = array();
|
||||
|
||||
$list = explode("\n", $string);
|
||||
$list = array_map('trim', $list);
|
||||
$list = array_filter($list, 'strlen');
|
||||
|
||||
foreach ($list as $text) {
|
||||
// Check for an explicit key.
|
||||
$matches = array();
|
||||
if (preg_match('/(.*)\|(.*)/', $text, $matches)) {
|
||||
// Trim key and value to avoid unwanted spaces issues.
|
||||
$name = trim($matches[1]);
|
||||
$value = trim($matches[2]);
|
||||
}
|
||||
else {
|
||||
return;
|
||||
}
|
||||
|
||||
$values[$name] = $value;
|
||||
}
|
||||
|
||||
return _googleanalytics_convert_form_value_data_types($values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a field name is valid.
|
||||
*
|
||||
* @param string $name
|
||||
* The option value entered by the user.
|
||||
*
|
||||
* @return string
|
||||
* The error message if the specified value is invalid, NULL otherwise.
|
||||
*/
|
||||
function _googleanalytics_validate_create_field_name($name) {
|
||||
// List of supported field names:
|
||||
// https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#create
|
||||
$create_only_fields = array(
|
||||
'allowAnchor',
|
||||
'alwaysSendReferrer',
|
||||
'clientId',
|
||||
'cookieName',
|
||||
'cookieDomain',
|
||||
'cookieExpires',
|
||||
'legacyCookieDomain',
|
||||
'legacyHistoryImport',
|
||||
'sampleRate',
|
||||
'siteSpeedSampleRate',
|
||||
'storage',
|
||||
'useAmpClientId',
|
||||
);
|
||||
|
||||
if ($name == 'name') {
|
||||
return t('Create only field name %name is a disallowed field name. Changing the <em>Tracker Name</em> is currently not supported.', array('%name' => $name));
|
||||
}
|
||||
if ($name == 'allowLinker') {
|
||||
return t('Create only field name %name is a disallowed field name. Please select <em>Multiple top-level domains</em> under <em>What are you tracking</em> to enable cross domain tracking.', array('%name' => $name));
|
||||
}
|
||||
if ($name == 'userId') {
|
||||
return t('Create only field name %name is a disallowed field name. Please enable <em>Track User ID</em> under <em>Tracking scope > Users</em>.', array('%name' => $name));
|
||||
}
|
||||
if (!in_array($name, $create_only_fields)) {
|
||||
return t('Create only field name %name is an unknown field name. Field names are case sensitive. Please see <a href="@url">create only fields</a> documentation for supported field names.', array('%name' => $name, '@url' => 'https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#create'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a field value is valid.
|
||||
*
|
||||
* @param string $value
|
||||
* The option value entered by the user.
|
||||
*
|
||||
* @return string
|
||||
* The error message if the specified value is invalid, NULL otherwise.
|
||||
*/
|
||||
function _googleanalytics_validate_create_field_value($value) {
|
||||
if (!is_bool($value) && !drupal_strlen($value)) {
|
||||
return t('A create only field requires a value.');
|
||||
}
|
||||
if (drupal_strlen($value) > 255) {
|
||||
return t('The value of a create only field must be a string at most 255 characters long.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a string representation of an array.
|
||||
*
|
||||
* This string format is suitable for edition in a textarea.
|
||||
*
|
||||
* @param array $values
|
||||
* An array of values, where array keys are values and array values are
|
||||
* labels.
|
||||
*
|
||||
* @return string
|
||||
* The string representation of the $values array:
|
||||
* - Values are separated by a carriage return.
|
||||
* - Each value is in the format "name|value" or "value".
|
||||
*/
|
||||
function _googleanalytics_get_name_value_string($values) {
|
||||
$lines = array();
|
||||
foreach ($values as $name => $value) {
|
||||
// Convert data types.
|
||||
// @todo: #2251377: Json utility class serializes boolean values to incorrect data type
|
||||
if (is_bool($value)) {
|
||||
$value = ($value) ? 'true' : 'false';
|
||||
}
|
||||
|
||||
$lines[] = "$name|$value";
|
||||
}
|
||||
return implode("\n", $lines);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare form data types for Json conversion.
|
||||
*
|
||||
* @param array $values
|
||||
* Array of name/value pairs.
|
||||
*
|
||||
* @return array
|
||||
* Array of name/value pairs with casted data types.
|
||||
*/
|
||||
function _googleanalytics_convert_form_value_data_types($values) {
|
||||
|
||||
foreach ($values as $name => $value) {
|
||||
// Convert data types.
|
||||
// @todo: #2251377: Json utility class serializes boolean values to incorrect data type
|
||||
$match = drupal_strtolower($value);
|
||||
if ($match == 'true') {
|
||||
$value = TRUE;
|
||||
}
|
||||
elseif ($match == 'false') {
|
||||
$value = FALSE;
|
||||
}
|
||||
|
||||
// Convert other known fields.
|
||||
// @todo: #2251343: Json utility class serializes numeric values to incorrect data type
|
||||
switch ($name) {
|
||||
case 'sampleRate':
|
||||
// Float
|
||||
settype($value, 'float');
|
||||
break;
|
||||
|
||||
case 'siteSpeedSampleRate':
|
||||
case 'cookieExpires':
|
||||
// Integer
|
||||
settype($value, 'integer');
|
||||
break;
|
||||
}
|
||||
|
||||
$values[$name] = $value;
|
||||
}
|
||||
|
||||
return $values;
|
||||
}
|
||||
|
||||
@@ -65,6 +65,15 @@ Drupal.behaviors.trackingSettingsSummary = {
|
||||
if ($('input#edit-googleanalytics-trackfiles', context).is(':checked')) {
|
||||
vals.push(Drupal.t('Downloads'));
|
||||
}
|
||||
if ($('input#edit-googleanalytics-trackcolorbox', context).is(':checked')) {
|
||||
vals.push(Drupal.t('Colorbox'));
|
||||
}
|
||||
if ($('input#edit-googleanalytics-tracklinkid', context).is(':checked')) {
|
||||
vals.push(Drupal.t('Link attribution'));
|
||||
}
|
||||
if ($('input#edit-googleanalytics-trackurlfragments', context).is(':checked')) {
|
||||
vals.push(Drupal.t('URL fragments'));
|
||||
}
|
||||
if (!vals.length) {
|
||||
return Drupal.t('Not tracked');
|
||||
}
|
||||
@@ -91,7 +100,7 @@ Drupal.behaviors.trackingSettingsSummary = {
|
||||
vals.push(Drupal.t('AdSense ads'));
|
||||
}
|
||||
if ($('input#edit-googleanalytics-trackdoubleclick', context).is(':checked')) {
|
||||
vals.push(Drupal.t('DoubleClick data'));
|
||||
vals.push(Drupal.t('Display features'));
|
||||
}
|
||||
if (!vals.length) {
|
||||
return Drupal.t('Not tracked');
|
||||
|
||||
@@ -0,0 +1,213 @@
|
||||
(function ($) {
|
||||
|
||||
Drupal.googleanalytics = {};
|
||||
|
||||
$(document).ready(function() {
|
||||
|
||||
// Attach mousedown, keyup, touchstart events to document only and catch
|
||||
// clicks on all elements.
|
||||
$(document.body).bind("mousedown keyup touchstart", function(event) {
|
||||
console.group("Running Google Analytics for Drupal.");
|
||||
console.info("Event '%s' has been detected.", event.type);
|
||||
|
||||
// Catch the closest surrounding link of a clicked element.
|
||||
$(event.target).closest("a,area").each(function() {
|
||||
console.info("Closest element '%o' has been found. URL '%s' extracted.", this, this.href);
|
||||
|
||||
// Is the clicked URL internal?
|
||||
if (Drupal.googleanalytics.isInternal(this.href)) {
|
||||
// Skip 'click' tracking, if custom tracking events are bound.
|
||||
if ($(this).is('.colorbox') && (Drupal.settings.googleanalytics.trackColorbox)) {
|
||||
// Do nothing here. The custom event will handle all tracking.
|
||||
console.info("Click on .colorbox item has been detected.");
|
||||
}
|
||||
// Is download tracking activated and the file extension configured for download tracking?
|
||||
else if (Drupal.settings.googleanalytics.trackDownload && Drupal.googleanalytics.isDownload(this.href)) {
|
||||
// Download link clicked.
|
||||
console.info("Download url '%s' has been found. Tracked download as extension '%s'.", Drupal.googleanalytics.getPageUrl(this.href), Drupal.googleanalytics.getDownloadExtension(this.href).toUpperCase());
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Downloads",
|
||||
"eventAction": Drupal.googleanalytics.getDownloadExtension(this.href).toUpperCase(),
|
||||
"eventLabel": Drupal.googleanalytics.getPageUrl(this.href),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else if (Drupal.googleanalytics.isInternalSpecial(this.href)) {
|
||||
// Keep the internal URL for Google Analytics website overlay intact.
|
||||
console.info("Click on internal special link '%s' has been tracked.", Drupal.googleanalytics.getPageUrl(this.href));
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": Drupal.googleanalytics.getPageUrl(this.href),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else {
|
||||
// e.g. anchor in same page or other internal page link
|
||||
console.info("Click on internal link '%s' detected, but not tracked by click.", this.href);
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (Drupal.settings.googleanalytics.trackMailto && $(this).is("a[href^='mailto:'],area[href^='mailto:']")) {
|
||||
// Mailto link clicked.
|
||||
console.info("Click on e-mail '%s' has been tracked.", this.href.substring(7));
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Mails",
|
||||
"eventAction": "Click",
|
||||
"eventLabel": this.href.substring(7),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else if (Drupal.settings.googleanalytics.trackOutbound && this.href.match(/^\w+:\/\//i)) {
|
||||
if (Drupal.settings.googleanalytics.trackDomainMode !== 2 || (Drupal.settings.googleanalytics.trackDomainMode === 2 && !Drupal.googleanalytics.isCrossDomain(this.hostname, Drupal.settings.googleanalytics.trackCrossDomains))) {
|
||||
// External link clicked / No top-level cross domain clicked.
|
||||
console.info("Outbound link '%s' has been tracked.", this.href);
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Outbound links",
|
||||
"eventAction": "Click",
|
||||
"eventLabel": this.href,
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else {
|
||||
console.info("Internal link '%s' clicked, not tracked.", this.href);
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
console.groupEnd();
|
||||
});
|
||||
|
||||
// Track hash changes as unique pageviews, if this option has been enabled.
|
||||
if (Drupal.settings.googleanalytics.trackUrlFragments) {
|
||||
window.onhashchange = function() {
|
||||
console.info("Track URL '%s' as pageview. Hash '%s' has changed.", location.pathname + location.search + location.hash, location.hash);
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": location.pathname + location.search + location.hash
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
// Colorbox: This event triggers when the transition has completed and the
|
||||
// newly loaded content has been revealed.
|
||||
if (Drupal.settings.googleanalytics.trackColorbox) {
|
||||
$(document).bind("cbox_complete", function () {
|
||||
var href = $.colorbox.element().attr("href");
|
||||
if (href) {
|
||||
console.info("Colorbox transition to url '%s' has been tracked.", Drupal.googleanalytics.getPageUrl(href));
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": Drupal.googleanalytics.getPageUrl(href)
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
/**
|
||||
* Check whether the hostname is part of the cross domains or not.
|
||||
*
|
||||
* @param string hostname
|
||||
* The hostname of the clicked URL.
|
||||
* @param array crossDomains
|
||||
* All cross domain hostnames as JS array.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isCrossDomain = function (hostname, crossDomains) {
|
||||
/**
|
||||
* jQuery < 1.6.3 bug: $.inArray crushes IE6 and Chrome if second argument is
|
||||
* `null` or `undefined`, https://bugs.jquery.com/ticket/10076,
|
||||
* https://github.com/jquery/jquery/commit/a839af034db2bd934e4d4fa6758a3fed8de74174
|
||||
*
|
||||
* @todo: Remove/Refactor in D8
|
||||
*/
|
||||
if (!crossDomains) {
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
return $.inArray(hostname, crossDomains) > -1 ? true : false;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is a download URL or not.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isDownload = function (url) {
|
||||
var isDownload = new RegExp("\\.(" + Drupal.settings.googleanalytics.trackDownloadExtensions + ")([\?#].*)?$", "i");
|
||||
return isDownload.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is an absolute internal URL or not.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isInternal = function (url) {
|
||||
var isInternal = new RegExp("^(https?):\/\/" + window.location.host, "i");
|
||||
return isInternal.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is a special URL or not.
|
||||
*
|
||||
* URL types:
|
||||
* - gotwo.module /go/* links.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isInternalSpecial = function (url) {
|
||||
var isInternalSpecial = new RegExp("(\/go\/.*)$", "i");
|
||||
return isInternalSpecial.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Extract the relative internal URL from an absolute internal URL.
|
||||
*
|
||||
* Examples:
|
||||
* - https://mydomain.com/node/1 -> /node/1
|
||||
* - https://example.com/foo/bar -> https://example.com/foo/bar
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return string
|
||||
* Internal website URL
|
||||
*/
|
||||
Drupal.googleanalytics.getPageUrl = function (url) {
|
||||
var extractInternalUrl = new RegExp("^(https?):\/\/" + window.location.host, "i");
|
||||
return url.replace(extractInternalUrl, '');
|
||||
};
|
||||
|
||||
/**
|
||||
* Extract the download file extension from the URL.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return string
|
||||
* The file extension of the passed url. e.g. "zip", "txt"
|
||||
*/
|
||||
Drupal.googleanalytics.getDownloadExtension = function (url) {
|
||||
var extractDownloadextension = new RegExp("\\.(" + Drupal.settings.googleanalytics.trackDownloadExtensions + ")([\?#].*)?$", "i");
|
||||
var extension = extractDownloadextension.exec(url);
|
||||
return (extension === null) ? '' : extension[1];
|
||||
};
|
||||
|
||||
})(jQuery);
|
||||
@@ -4,10 +4,9 @@ core = 7.x
|
||||
package = Statistics
|
||||
configure = admin/config/system/googleanalytics
|
||||
files[] = googleanalytics.test
|
||||
|
||||
; Information added by drupal.org packaging script on 2012-11-01
|
||||
version = "7.x-1.3"
|
||||
test_dependencies[] = token
|
||||
; Information added by Drupal.org packaging script on 2019-01-31
|
||||
version = "7.x-2.6"
|
||||
core = "7.x"
|
||||
project = "google_analytics"
|
||||
datestamp = "1351810914"
|
||||
|
||||
datestamp = "1548968597"
|
||||
|
||||
@@ -5,52 +5,46 @@
|
||||
* Installation file for Google Analytics module.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Implements hook_install().
|
||||
*/
|
||||
function googleanalytics_install() {
|
||||
// By German laws it's always best to enable the anonymizing of IP addresses.
|
||||
// NOTE: If this is also an important default setting in other countries, please let us know!
|
||||
$countries = array(
|
||||
'DE',
|
||||
);
|
||||
if (in_array(variable_get('site_default_country', ''), $countries)) {
|
||||
variable_set('googleanalytics_tracker_anonymizeip', 1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_uninstall().
|
||||
*/
|
||||
function googleanalytics_uninstall() {
|
||||
variable_del('googleanalytics_account');
|
||||
variable_del('googleanalytics_premium');
|
||||
variable_del('googleanalytics_cache');
|
||||
variable_del('googleanalytics_codesnippet_create');
|
||||
variable_del('googleanalytics_codesnippet_before');
|
||||
variable_del('googleanalytics_codesnippet_after');
|
||||
variable_del('googleanalytics_cross_domains');
|
||||
variable_del('googleanalytics_custom');
|
||||
variable_del('googleanalytics_custom_var');
|
||||
variable_del('googleanalytics_custom_dimension');
|
||||
variable_del('googleanalytics_custom_metric');
|
||||
variable_del('googleanalytics_debug');
|
||||
variable_del('googleanalytics_domain_mode');
|
||||
variable_del('googleanalytics_js_scope');
|
||||
variable_del('googleanalytics_last_cache');
|
||||
variable_del('googleanalytics_pages');
|
||||
variable_del('googleanalytics_roles');
|
||||
variable_del('googleanalytics_site_search');
|
||||
variable_del('googleanalytics_trackadsense');
|
||||
variable_del('googleanalytics_trackcolorbox');
|
||||
variable_del('googleanalytics_trackdoubleclick');
|
||||
variable_del('googleanalytics_tracker_anonymizeip');
|
||||
variable_del('googleanalytics_trackfiles');
|
||||
variable_del('googleanalytics_trackfiles_extensions');
|
||||
variable_del('googleanalytics_tracklinkid');
|
||||
variable_del('googleanalytics_trackurlfragments');
|
||||
variable_del('googleanalytics_trackuserid');
|
||||
variable_del('googleanalytics_trackmailto');
|
||||
variable_del('googleanalytics_trackmessages');
|
||||
variable_del('googleanalytics_trackoutbound');
|
||||
variable_del('googleanalytics_translation_set');
|
||||
variable_del('googleanalytics_visibility_pages');
|
||||
variable_del('googleanalytics_visibility_roles');
|
||||
variable_del('googleanalytics_privacy_donottrack');
|
||||
|
||||
// Remove backup variables if exist. Remove this code in D8.
|
||||
variable_del('googleanalytics_codesnippet_after_backup_6300');
|
||||
variable_del('googleanalytics_codesnippet_before_backup_6300');
|
||||
variable_del('googleanalytics_segmentation');
|
||||
// Remove backup variables if they exist. Remove this code in D8.
|
||||
variable_del('googleanalytics_codesnippet_after_backup_7200');
|
||||
variable_del('googleanalytics_codesnippet_before_backup_7200');
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -71,21 +65,32 @@ function googleanalytics_requirements($phase) {
|
||||
|
||||
if ($phase == 'runtime') {
|
||||
// Raise warning if Google user account has not been set yet.
|
||||
if (!preg_match('/^UA-\d{4,}-\d+$/', variable_get('googleanalytics_account', 'UA-'))) {
|
||||
$requirements['googleanalytics'] = array(
|
||||
if (!preg_match('/^UA-\d+-\d+$/', variable_get('googleanalytics_account', 'UA-'))) {
|
||||
$requirements['googleanalytics_account'] = array(
|
||||
'title' => $t('Google Analytics module'),
|
||||
'description' => $t('Google Analytics module has not been configured yet. Please configure its settings from the <a href="@url">Google Analytics settings page</a>.', array('@url' => url('admin/config/system/googleanalytics'))),
|
||||
'severity' => REQUIREMENT_WARNING,
|
||||
'value' => $t('Not configured'),
|
||||
);
|
||||
}
|
||||
|
||||
// Raise warning if debugging is enabled.
|
||||
if (variable_get('googleanalytics_debug', 0)) {
|
||||
$requirements['google_analytics_debugging'] = array(
|
||||
'title' => $t('Google Analytics module'),
|
||||
'description' => $t('Google Analytics module has debugging enabled. Please disable debugging setting in production sites from the <a href="@url">Google Analytics settings page</a>.', array('@url' => url('admin/config/system/googleanalytics'))),
|
||||
'severity' => REQUIREMENT_WARNING,
|
||||
'value' => $t('Debugging enabled'),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $requirements;
|
||||
}
|
||||
|
||||
/**
|
||||
* Upgrade old extension variable to new and use old name as enabled/disabled flag.
|
||||
* Upgrade old extension variable to new and use old name as enabled/disabled
|
||||
* flag.
|
||||
*/
|
||||
function googleanalytics_update_6000() {
|
||||
variable_set('googleanalytics_trackfiles_extensions', variable_get('googleanalytics_trackfiles', '7z|aac|avi|csv|doc|exe|flv|gif|gz|jpe?g|js|mp(3|4|e?g)|mov|pdf|phps|png|ppt|rar|sit|tar|torrent|txt|wma|wmv|xls|xml|zip'));
|
||||
@@ -98,7 +103,8 @@ function googleanalytics_update_6000() {
|
||||
function googleanalytics_update_6001() {
|
||||
variable_set('googleanalytics_visibility', 0);
|
||||
|
||||
// Remove tracking from all administrative pages, see http://drupal.org/node/34970.
|
||||
// Remove tracking from all administrative pages, see:
|
||||
// https://drupal.org/node/34970.
|
||||
$pages = array(
|
||||
'admin*',
|
||||
'user*',
|
||||
@@ -111,11 +117,12 @@ function googleanalytics_update_6001() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Upgrade role settings and per user tracking settings
|
||||
* of "User 1" and remove outdated tracking variables.
|
||||
* Upgrade role settings and per user tracking settings of "User 1" and remove
|
||||
* outdated tracking variables.
|
||||
*/
|
||||
function googleanalytics_update_6002() {
|
||||
// Upgrade enabled/disabled roles to new logic (correct for upgrades from 5.x-1.4 and 6.x-1.0).
|
||||
// Upgrade enabled/disabled roles to new logic (correct for upgrades from
|
||||
// 5.x-1.4 and 6.x-1.0).
|
||||
$roles = array();
|
||||
$messages = array();
|
||||
foreach (user_roles() as $rid => $name) {
|
||||
@@ -134,7 +141,7 @@ function googleanalytics_update_6002() {
|
||||
if (!$track_user1 = variable_get('googleanalytics_track__user1', 1)) {
|
||||
variable_set('googleanalytics_custom', 1);
|
||||
|
||||
// Load user 1 object, set appropriate value and save new user settings back.
|
||||
// Load user 1 object, set appropriate value and save new user settings.
|
||||
$account = user_load(1);
|
||||
$account = user_save($account, array('data' => array('googleanalytics' => array('custom' => 0))), 'account');
|
||||
$messages[] = t('Disabled user specific page tracking for site administrator.');
|
||||
@@ -149,11 +156,11 @@ function googleanalytics_update_6002() {
|
||||
}
|
||||
|
||||
/**
|
||||
* #262468: Clear menu cache to solve stale menu data in 5.x-1.5 and 6.x-1.1
|
||||
* #262468: Clear menu cache to solve stale menu data in 5.x-1.5 and 6.x-1.1.
|
||||
*/
|
||||
function googleanalytics_update_6003() {
|
||||
menu_rebuild();
|
||||
return t('Menu has been rebuild.');
|
||||
return t('Menu has been rebuilt.');
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -228,8 +235,9 @@ function googleanalytics_update_6006() {
|
||||
/**
|
||||
* Remove "User identifier" and "User name" from segmentation fields.
|
||||
*
|
||||
* This is a data protection and privacy law change. For more information see Google Analytics
|
||||
* terms of use section 8.1 (http://www.google.com/analytics/en-GB/tos.html).
|
||||
* This is a data protection and privacy law change. For more information see
|
||||
* Google Analytics terms of use section 8.1:
|
||||
* https://www.google.com/analytics/en-GB/tos.html
|
||||
*/
|
||||
function googleanalytics_update_6007() {
|
||||
$profile_fields = variable_get('googleanalytics_segmentation', array());
|
||||
@@ -290,15 +298,15 @@ function googleanalytics_update_6300() {
|
||||
$messages[] = t('Upgraded custom "before" code snippet.');
|
||||
}
|
||||
|
||||
// Upgrade of AFTER code snippet.
|
||||
// We cannot update this code snippet automatically. Show message that the upgrade has been skipped.
|
||||
// Upgrade of AFTER code snippet. We cannot update this code snippet
|
||||
// automatically. Show message that the upgrade has been skipped.
|
||||
$code_after = variable_get('googleanalytics_codesnippet_after', '');
|
||||
if (!empty($code_after)) {
|
||||
drupal_set_message(Database::getConnection()->prefixTables("Automatic upgrade of Google Analytics custom 'after' code snippet has been skipped. Backup of previous code snippet has been saved in database table '{variable}' as 'googleanalytics_codesnippet_after_backup_6300'. You need to manually upgrade the custom 'after' code snippet."), 'error');
|
||||
$messages[] = t('Skipped custom "after" code snippet.');
|
||||
}
|
||||
|
||||
return empty($messages) ? t('No custom code snipped found. Nothing to do.') : implode(' ', $messages);
|
||||
return empty($messages) ? t('No custom code snippet found. Nothing to do.') : implode(' ', $messages);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -353,18 +361,20 @@ function googleanalytics_update_7002() {
|
||||
$googleanalytics_custom_vars['slots'][1]['slot'] = 1;
|
||||
$googleanalytics_custom_vars['slots'][1]['name'] = 'User roles';
|
||||
$googleanalytics_custom_vars['slots'][1]['value'] = '[current-user:role-names]';
|
||||
$googleanalytics_custom_vars['slots'][1]['scope'] = 1; // Sets the scope to visitor-level.
|
||||
// Sets the scope to visitor-level.
|
||||
$googleanalytics_custom_vars['slots'][1]['scope'] = 1;
|
||||
|
||||
variable_set('googleanalytics_custom_var', $googleanalytics_custom_vars);
|
||||
return t('The deprecated profile segmentation setting for "User roles" has been added to custom variables. You need to deselect all selected profile fields in <a href="@admin">Google Analytics settings</a> and upgrade other profile fields manually or you may loose tracking data in future! See Google Analytics <a href="@customvar">Custom Variables</a> for more information.', array('@customvar' => 'https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables', '@admin' => url('admin/config/system/googleanalytics')));
|
||||
return t('The deprecated profile segmentation setting for "User roles" has been added to custom variables. You need to deselect all selected profile fields in <a href="@admin">Google Analytics settings</a> and upgrade other profile fields manually or you may lose tracking data in future! See Google Analytics <a href="@customvar">Custom Variables</a> for more information.', array('@customvar' => 'https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables', '@admin' => url('admin/config/system/googleanalytics')));
|
||||
}
|
||||
else {
|
||||
return t('You need to deselect all selected profile fields in <a href="@admin">Google Analytics settings</a> and upgrade other profile fields manually or you may loose tracking data in future! See Google Analytics <a href="@customvar">Custom Variables</a> for more information.', array('@customvar' => 'https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables', '@admin' => url('admin/config/system/googleanalytics')));
|
||||
return t('You need to deselect all selected profile fields in <a href="@admin">Google Analytics settings</a> and upgrade other profile fields manually or you may lose tracking data in future! See Google Analytics <a href="@customvar">Custom Variables</a> for more information.', array('@customvar' => 'https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingCustomVariables', '@admin' => url('admin/config/system/googleanalytics')));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Rename googleanalytics_trackoutgoing variable to googleanalytics_trackoutbound.
|
||||
* Rename googleanalytics_trackoutgoing variable to
|
||||
* googleanalytics_trackoutbound.
|
||||
*/
|
||||
function googleanalytics_update_7003() {
|
||||
variable_set('googleanalytics_trackoutbound', variable_get('googleanalytics_trackoutgoing', 1));
|
||||
@@ -374,7 +384,8 @@ function googleanalytics_update_7003() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Rename googleanalytics_visibility variable to googleanalytics_visibility_pages for consistency.
|
||||
* Rename googleanalytics_visibility variable to
|
||||
* googleanalytics_visibility_pages for consistency.
|
||||
*/
|
||||
function googleanalytics_update_7004() {
|
||||
variable_set('googleanalytics_visibility_pages', variable_get('googleanalytics_visibility', 1));
|
||||
@@ -398,7 +409,7 @@ function googleanalytics_update_7005() {
|
||||
|
||||
$diff = array_diff($pages, preg_split('/(\r\n?|\n)/', variable_get('googleanalytics_pages', implode("\n", $pages))));
|
||||
if (empty($diff)) {
|
||||
// No diff to previous settings found. Update with new settings.
|
||||
// No difference to previous settings found. Update with new settings.
|
||||
$pages = array(
|
||||
'admin',
|
||||
'admin/*',
|
||||
@@ -425,10 +436,113 @@ function googleanalytics_update_7006() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete obsolete googleanalytics_trackpageloadtime variable.
|
||||
*/
|
||||
* Delete obsolete googleanalytics_trackpageloadtime variable.
|
||||
*/
|
||||
function googleanalytics_update_7007() {
|
||||
variable_del('googleanalytics_trackpageloadtime');
|
||||
|
||||
return t('Deleted obsolete googleanalytics_trackpageloadtime variable.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete custom ga.js code snippets to prevent malfunctions in new Universal
|
||||
* Analytics tracker. A backup of your snippets will be created.
|
||||
*/
|
||||
function googleanalytics_update_7200() {
|
||||
$messages = array();
|
||||
|
||||
// ga.js code will cause the tracker to break. Remove custom code snippets.
|
||||
$googleanalytics_codesnippet_before = variable_get('googleanalytics_codesnippet_before', '');
|
||||
if (!empty($googleanalytics_codesnippet_before) && stristr($googleanalytics_codesnippet_before, '_gaq.push(')) {
|
||||
variable_set('googleanalytics_codesnippet_before_backup_7200', $googleanalytics_codesnippet_before);
|
||||
variable_del('googleanalytics_codesnippet_before');
|
||||
drupal_set_message(Database::getConnection()->prefixTables("A backup of your previous Google Analytics code snippet (ga.js) has been saved in database table '{variable}' as 'googleanalytics_codesnippet_before_backup_7200'. You need to manually upgrade the custom 'before' code snippet to analytics.js API."), 'warning');
|
||||
$messages[] = t('Manual upgrade of custom "before" code snippet from ja.js to analytics.js API is required.');
|
||||
}
|
||||
|
||||
$googleanalytics_codesnippet_after = variable_get('googleanalytics_codesnippet_after', '');
|
||||
if (!empty($googleanalytics_codesnippet_after) && stristr($googleanalytics_codesnippet_after, '_gaq.push(')) {
|
||||
variable_set('googleanalytics_codesnippet_after_backup_7200', $googleanalytics_codesnippet_after);
|
||||
variable_del('googleanalytics_codesnippet_after');
|
||||
drupal_set_message(Database::getConnection()->prefixTables("A backup of your previous Google Analytics code snippet (ga.js) has been saved in database table '{variable}' as 'googleanalytics_codesnippet_after_backup_7200'. You need to manually upgrade the custom 'after' code snippet to analytics.js API."), 'warning');
|
||||
$messages[] = t('Manual upgrade of custom "after" code snippet from ja.js to analytics.js API is required.');
|
||||
}
|
||||
|
||||
return empty($messages) ? t('No custom code snippet found. Nothing to do.') : implode(' ', $messages);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete obsolete custom variables. Custom variables are now custom dimensions
|
||||
* and metrics.
|
||||
*/
|
||||
function googleanalytics_update_7201() {
|
||||
variable_del('googleanalytics_custom_var');
|
||||
|
||||
return t('Deleted obsolete custom variables. Custom variables are now custom dimensions and metrics and you need to manually configure them!');
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete obsolete JavaScript scope variable.
|
||||
*/
|
||||
function googleanalytics_update_7202() {
|
||||
// Remove obsolete scope variable.
|
||||
variable_del('googleanalytics_js_scope');
|
||||
|
||||
return t('Removed obsolete JavaScript scope variable.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Flatten the metrics and dimensions arrays.
|
||||
*/
|
||||
function googleanalytics_update_7203() {
|
||||
$googleanalytics_custom_dimension = variable_get('googleanalytics_custom_dimension', array());
|
||||
if (isset($googleanalytics_custom_dimension['indexes'])) {
|
||||
foreach ($googleanalytics_custom_dimension['indexes'] as $dimension) {
|
||||
$googleanalytics_custom_dimension['indexes'][$dimension['index']]['value'] = trim($dimension['value']);
|
||||
// Remove empty values from the array.
|
||||
if (!drupal_strlen($googleanalytics_custom_dimension['indexes'][$dimension['index']]['value'])) {
|
||||
unset($googleanalytics_custom_dimension['indexes'][$dimension['index']]);
|
||||
}
|
||||
}
|
||||
variable_set('googleanalytics_custom_dimension', $googleanalytics_custom_dimension['indexes']);
|
||||
}
|
||||
$googleanalytics_custom_metric = variable_get('googleanalytics_custom_metric', array());
|
||||
if (isset($googleanalytics_custom_metric['indexes'])) {
|
||||
foreach ($googleanalytics_custom_metric['indexes'] as $dimension) {
|
||||
$googleanalytics_custom_metric['indexes'][$dimension['index']]['value'] = trim($dimension['value']);
|
||||
// Remove empty values from the array.
|
||||
if (!drupal_strlen($googleanalytics_custom_metric['indexes'][$dimension['index']]['value'])) {
|
||||
unset($googleanalytics_custom_metric['indexes'][$dimension['index']]);
|
||||
}
|
||||
}
|
||||
variable_set('googleanalytics_custom_metric', $googleanalytics_custom_metric['indexes']);
|
||||
}
|
||||
|
||||
return t('Saved custom dimensions and metrics.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove obsolete backup variables.
|
||||
*/
|
||||
function googleanalytics_update_7204() {
|
||||
variable_del('googleanalytics_segmentation');
|
||||
variable_del('googleanalytics_codesnippet_after_backup_6300');
|
||||
variable_del('googleanalytics_codesnippet_before_backup_6300');
|
||||
variable_del('googleanalytics_codesnippet_after_backup_6400');
|
||||
variable_del('googleanalytics_codesnippet_before_backup_6400');
|
||||
|
||||
return t('Removed obsolete backup variables.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Update list of default file extensions.
|
||||
*/
|
||||
function googleanalytics_update_7205() {
|
||||
if (variable_get('googleanalytics_trackfiles_extensions', '') == '7z|aac|arc|arj|asf|asx|avi|bin|csv|doc|exe|flv|gif|gz|gzip|hqx|jar|jpe?g|js|mp(2|3|4|e?g)|mov(ie)?|msi|msp|pdf|phps|png|ppt|qtm?|ra(m|r)?|sea|sit|tar|tgz|torrent|txt|wav|wma|wmv|wpd|xls|xml|z|zip') {
|
||||
variable_set('googleanalytics_trackfiles_extensions', '7z|aac|arc|arj|asf|asx|avi|bin|csv|doc(x|m)?|dot(x|m)?|exe|flv|gif|gz|gzip|hqx|jar|jpe?g|js|mp(2|3|4|e?g)|mov(ie)?|msi|msp|pdf|phps|png|ppt(x|m)?|pot(x|m)?|pps(x|m)?|ppam|sld(x|m)?|thmx|qtm?|ra(m|r)?|sea|sit|tar|tgz|torrent|txt|wav|wma|wmv|wpd|xls(x|m|b)?|xlt(x|m)|xlam|xml|z|zip');
|
||||
return t('The default extensions for download tracking have been updated.');
|
||||
}
|
||||
else {
|
||||
return t('Custom extensions for download tracking setting found. Update skipped!');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,66 +1,93 @@
|
||||
(function ($) {
|
||||
|
||||
Drupal.googleanalytics = {};
|
||||
|
||||
$(document).ready(function() {
|
||||
|
||||
// Expression to check for absolute internal links.
|
||||
var isInternal = new RegExp("^(https?):\/\/" + window.location.host, "i");
|
||||
// Attach mousedown, keyup, touchstart events to document only and catch
|
||||
// clicks on all elements.
|
||||
$(document.body).bind("mousedown keyup touchstart", function(event) {
|
||||
|
||||
// Attach onclick event to document only and catch clicks on all elements.
|
||||
$(document.body).click(function(event) {
|
||||
// Catch the closest surrounding link of a clicked element.
|
||||
$(event.target).closest("a,area").each(function() {
|
||||
|
||||
var ga = Drupal.settings.googleanalytics;
|
||||
// Expression to check for special links like gotwo.module /go/* links.
|
||||
var isInternalSpecial = new RegExp("(\/go\/.*)$", "i");
|
||||
// Expression to check for download links.
|
||||
var isDownload = new RegExp("\\.(" + ga.trackDownloadExtensions + ")$", "i");
|
||||
|
||||
// Is the clicked URL internal?
|
||||
if (isInternal.test(this.href)) {
|
||||
if (Drupal.googleanalytics.isInternal(this.href)) {
|
||||
// Skip 'click' tracking, if custom tracking events are bound.
|
||||
if ($(this).is('.colorbox')) {
|
||||
if ($(this).is('.colorbox') && (Drupal.settings.googleanalytics.trackColorbox)) {
|
||||
// Do nothing here. The custom event will handle all tracking.
|
||||
//console.info("Click on .colorbox item has been detected.");
|
||||
}
|
||||
// Is download tracking activated and the file extension configured for download tracking?
|
||||
else if (ga.trackDownload && isDownload.test(this.href)) {
|
||||
else if (Drupal.settings.googleanalytics.trackDownload && Drupal.googleanalytics.isDownload(this.href)) {
|
||||
// Download link clicked.
|
||||
var extension = isDownload.exec(this.href);
|
||||
_gaq.push(["_trackEvent", "Downloads", extension[1].toUpperCase(), this.href.replace(isInternal, '')]);
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Downloads",
|
||||
"eventAction": Drupal.googleanalytics.getDownloadExtension(this.href).toUpperCase(),
|
||||
"eventLabel": Drupal.googleanalytics.getPageUrl(this.href),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else if (isInternalSpecial.test(this.href)) {
|
||||
else if (Drupal.googleanalytics.isInternalSpecial(this.href)) {
|
||||
// Keep the internal URL for Google Analytics website overlay intact.
|
||||
_gaq.push(["_trackPageview", this.href.replace(isInternal, '')]);
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": Drupal.googleanalytics.getPageUrl(this.href),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (ga.trackMailto && $(this).is("a[href^='mailto:'],area[href^='mailto:']")) {
|
||||
if (Drupal.settings.googleanalytics.trackMailto && $(this).is("a[href^='mailto:'],area[href^='mailto:']")) {
|
||||
// Mailto link clicked.
|
||||
_gaq.push(["_trackEvent", "Mails", "Click", this.href.substring(7)]);
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Mails",
|
||||
"eventAction": "Click",
|
||||
"eventLabel": this.href.substring(7),
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
else if (ga.trackOutbound && this.href.match(/^\w+:\/\//i)) {
|
||||
if (ga.trackDomainMode == 2 && isCrossDomain($(this).attr('hostname'), ga.trackCrossDomains)) {
|
||||
// Top-level cross domain clicked. document.location is handled by _link internally.
|
||||
event.preventDefault();
|
||||
_gaq.push(["_link", this.href]);
|
||||
}
|
||||
else {
|
||||
// External link clicked.
|
||||
_gaq.push(["_trackEvent", "Outbound links", "Click", this.href]);
|
||||
else if (Drupal.settings.googleanalytics.trackOutbound && this.href.match(/^\w+:\/\//i)) {
|
||||
if (Drupal.settings.googleanalytics.trackDomainMode !== 2 || (Drupal.settings.googleanalytics.trackDomainMode === 2 && !Drupal.googleanalytics.isCrossDomain(this.hostname, Drupal.settings.googleanalytics.trackCrossDomains))) {
|
||||
// External link clicked / No top-level cross domain clicked.
|
||||
ga("send", {
|
||||
"hitType": "event",
|
||||
"eventCategory": "Outbound links",
|
||||
"eventAction": "Click",
|
||||
"eventLabel": this.href,
|
||||
"transport": "beacon"
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Track hash changes as unique pageviews, if this option has been enabled.
|
||||
if (Drupal.settings.googleanalytics.trackUrlFragments) {
|
||||
window.onhashchange = function() {
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": location.pathname + location.search + location.hash
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
// Colorbox: This event triggers when the transition has completed and the
|
||||
// newly loaded content has been revealed.
|
||||
$(document).bind("cbox_complete", function() {
|
||||
var href = $.colorbox.element().attr("href");
|
||||
if (href) {
|
||||
_gaq.push(["_trackPageview", href.replace(isInternal, '')]);
|
||||
}
|
||||
});
|
||||
if (Drupal.settings.googleanalytics.trackColorbox) {
|
||||
$(document).bind("cbox_complete", function () {
|
||||
var href = $.colorbox.element().attr("href");
|
||||
if (href) {
|
||||
ga("send", {
|
||||
"hitType": "pageview",
|
||||
"page": Drupal.googleanalytics.getPageUrl(href)
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
@@ -74,10 +101,10 @@ $(document).ready(function() {
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
function isCrossDomain(hostname, crossDomains) {
|
||||
Drupal.googleanalytics.isCrossDomain = function (hostname, crossDomains) {
|
||||
/**
|
||||
* jQuery < 1.6.3 bug: $.inArray crushes IE6 and Chrome if second argument is
|
||||
* `null` or `undefined`, http://bugs.jquery.com/ticket/10076,
|
||||
* `null` or `undefined`, https://bugs.jquery.com/ticket/10076,
|
||||
* https://github.com/jquery/jquery/commit/a839af034db2bd934e4d4fa6758a3fed8de74174
|
||||
*
|
||||
* @todo: Remove/Refactor in D8
|
||||
@@ -88,6 +115,81 @@ function isCrossDomain(hostname, crossDomains) {
|
||||
else {
|
||||
return $.inArray(hostname, crossDomains) > -1 ? true : false;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is a download URL or not.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isDownload = function (url) {
|
||||
var isDownload = new RegExp("\\.(" + Drupal.settings.googleanalytics.trackDownloadExtensions + ")([\?#].*)?$", "i");
|
||||
return isDownload.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is an absolute internal URL or not.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isInternal = function (url) {
|
||||
var isInternal = new RegExp("^(https?):\/\/" + window.location.host, "i");
|
||||
return isInternal.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Check whether this is a special URL or not.
|
||||
*
|
||||
* URL types:
|
||||
* - gotwo.module /go/* links.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
Drupal.googleanalytics.isInternalSpecial = function (url) {
|
||||
var isInternalSpecial = new RegExp("(\/go\/.*)$", "i");
|
||||
return isInternalSpecial.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* Extract the relative internal URL from an absolute internal URL.
|
||||
*
|
||||
* Examples:
|
||||
* - https://mydomain.com/node/1 -> /node/1
|
||||
* - https://example.com/foo/bar -> https://example.com/foo/bar
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return string
|
||||
* Internal website URL
|
||||
*/
|
||||
Drupal.googleanalytics.getPageUrl = function (url) {
|
||||
var extractInternalUrl = new RegExp("^(https?):\/\/" + window.location.host, "i");
|
||||
return url.replace(extractInternalUrl, '');
|
||||
};
|
||||
|
||||
/**
|
||||
* Extract the download file extension from the URL.
|
||||
*
|
||||
* @param string url
|
||||
* The web url to check.
|
||||
*
|
||||
* @return string
|
||||
* The file extension of the passed url. e.g. "zip", "txt"
|
||||
*/
|
||||
Drupal.googleanalytics.getDownloadExtension = function (url) {
|
||||
var extractDownloadextension = new RegExp("\\.(" + Drupal.settings.googleanalytics.trackDownloadExtensions + ")([\?#].*)?$", "i");
|
||||
var extension = extractDownloadextension.exec(url);
|
||||
return (extension === null) ? '' : extension[1];
|
||||
};
|
||||
|
||||
})(jQuery);
|
||||
|
||||
@@ -1,26 +1,42 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
/**
|
||||
* @file
|
||||
* Drupal Module: GoogleAnalytics
|
||||
* Adds the required Javascript to the bottom of all your Drupal pages
|
||||
* to allow tracking by the Google Analytics statistics package.
|
||||
* Drupal Module: Google Analytics
|
||||
*
|
||||
* @author: Alexander Hass <http://drupal.org/user/85918>
|
||||
* Adds the required Javascript to all your Drupal pages to allow tracking by
|
||||
* the Google Analytics statistics package.
|
||||
*
|
||||
* @author: Alexander Hass <https://drupal.org/user/85918>
|
||||
*/
|
||||
|
||||
define('GOOGLEANALYTICS_TRACKFILES_EXTENSIONS', '7z|aac|arc|arj|asf|asx|avi|bin|csv|doc|exe|flv|gif|gz|gzip|hqx|jar|jpe?g|js|mp(2|3|4|e?g)|mov(ie)?|msi|msp|pdf|phps|png|ppt|qtm?|ra(m|r)?|sea|sit|tar|tgz|torrent|txt|wav|wma|wmv|wpd|xls|xml|z|zip');
|
||||
/**
|
||||
* Define the default file extension list that should be tracked as download.
|
||||
*/
|
||||
define('GOOGLEANALYTICS_TRACKFILES_EXTENSIONS', '7z|aac|arc|arj|asf|asx|avi|bin|csv|doc(x|m)?|dot(x|m)?|exe|flv|gif|gz|gzip|hqx|jar|jpe?g|js|mp(2|3|4|e?g)|mov(ie)?|msi|msp|pdf|phps|png|ppt(x|m)?|pot(x|m)?|pps(x|m)?|ppam|sld(x|m)?|thmx|qtm?|ra(m|r)?|sea|sit|tar|tgz|torrent|txt|wav|wma|wmv|wpd|xls(x|m|b)?|xlt(x|m)|xlam|xml|z|zip');
|
||||
|
||||
// Remove tracking from all administrative pages, see http://drupal.org/node/34970.
|
||||
/**
|
||||
* Define default path exclusion list to remove tracking from admin pages,
|
||||
* see https://drupal.org/node/34970 for more information.
|
||||
*/
|
||||
define('GOOGLEANALYTICS_PAGES', "admin\nadmin/*\nbatch\nnode/add*\nnode/*/*\nuser/*/*");
|
||||
|
||||
/**
|
||||
* Advertise the supported google analytics api details.
|
||||
*/
|
||||
function googleanalytics_api() {
|
||||
return array(
|
||||
'api' => 'analytics.js',
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_help().
|
||||
*/
|
||||
function googleanalytics_help($path, $arg) {
|
||||
switch ($path) {
|
||||
case 'admin/config/system/googleanalytics':
|
||||
return t('<a href="@ga_url">Google Analytics</a> is a free (registration required) website traffic and marketing effectiveness service.', array('@ga_url' => 'http://www.google.com/analytics/'));
|
||||
return t('<a href="@ga_url">Google Analytics</a> is a free (registration required) website traffic and marketing effectiveness service.', array('@ga_url' => 'https://marketingplatform.google.com/about/analytics/'));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -53,6 +69,11 @@ function googleanalytics_permission() {
|
||||
'description' => t('Enter PHP code in the field for tracking visibility settings.'),
|
||||
'restrict access' => TRUE,
|
||||
),
|
||||
'add JS snippets for google analytics' => array(
|
||||
'title' => t('Add JavaScript snippets'),
|
||||
'description' => 'Enter JavaScript code snippets for advanced Google Analytics functionality.',
|
||||
'restrict access' => TRUE,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -77,7 +98,7 @@ function googleanalytics_menu() {
|
||||
* Implements hook_page_alter() to insert JavaScript to the appropriate scope/region of the page.
|
||||
*/
|
||||
function googleanalytics_page_alter(&$page) {
|
||||
global $user;
|
||||
global $base_path, $user;
|
||||
|
||||
$id = variable_get('googleanalytics_account', '');
|
||||
|
||||
@@ -88,19 +109,14 @@ function googleanalytics_page_alter(&$page) {
|
||||
'404 Not Found',
|
||||
);
|
||||
|
||||
// 1. Check if the GA account number has a value.
|
||||
// 1. Check if the GA account number has a valid value.
|
||||
// 2. Track page views based on visibility value.
|
||||
// 3. Check if we should track the currently active user's role.
|
||||
// 4. Ignore pages visibility filter for 404 or 403 status codes.
|
||||
if (!empty($id) && (_googleanalytics_visibility_pages() || in_array($status, $trackable_status_codes)) && _googleanalytics_visibility_user($user)) {
|
||||
if (preg_match('/^UA-\d+-\d+$/', $id) && (_googleanalytics_visibility_pages() || in_array($status, $trackable_status_codes)) && _googleanalytics_visibility_user($user)) {
|
||||
|
||||
// We allow different scopes. Default to 'header' but allow user to override if they really need to.
|
||||
$scope = variable_get('googleanalytics_js_scope', 'header');
|
||||
|
||||
if (variable_get('googleanalytics_trackadsense', FALSE)) {
|
||||
// Custom tracking. Prepend before all other JavaScript.
|
||||
drupal_add_js('window.google_analytics_uacct = ' . drupal_json_encode($id) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1));
|
||||
}
|
||||
$debug = variable_get('googleanalytics_debug', 0);
|
||||
$url_custom = '';
|
||||
|
||||
// Add link tracking.
|
||||
$link_settings = array();
|
||||
@@ -114,16 +130,32 @@ function googleanalytics_page_alter(&$page) {
|
||||
$link_settings['trackDownload'] = $track_download;
|
||||
$link_settings['trackDownloadExtensions'] = $trackfiles_extensions;
|
||||
}
|
||||
if (module_exists('colorbox') && ($track_colorbox = variable_get('googleanalytics_trackcolorbox', 1))) {
|
||||
$link_settings['trackColorbox'] = $track_colorbox;
|
||||
}
|
||||
if ($track_domain_mode = variable_get('googleanalytics_domain_mode', 0)) {
|
||||
$link_settings['trackDomainMode'] = $track_domain_mode;
|
||||
$link_settings['trackDomainMode'] = (int) $track_domain_mode;
|
||||
}
|
||||
if ($track_cross_domains = variable_get('googleanalytics_cross_domains', '')) {
|
||||
$link_settings['trackCrossDomains'] = preg_split('/(\r\n?|\n)/', $track_cross_domains);
|
||||
}
|
||||
if ($track_url_fragments = variable_get('googleanalytics_trackurlfragments', 0)) {
|
||||
$link_settings['trackUrlFragments'] = $track_url_fragments;
|
||||
$url_custom = 'location.pathname + location.search + location.hash';
|
||||
}
|
||||
|
||||
if (!empty($link_settings)) {
|
||||
drupal_add_js(array('googleanalytics' => $link_settings), 'setting');
|
||||
drupal_add_js(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.js');
|
||||
|
||||
// Add debugging code.
|
||||
if ($debug) {
|
||||
drupal_add_js(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.debug.js');
|
||||
// Add the JS test in development to the page.
|
||||
//drupal_add_js(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.test.js');
|
||||
}
|
||||
else {
|
||||
drupal_add_js(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.js');
|
||||
}
|
||||
}
|
||||
|
||||
// Add messages tracking.
|
||||
@@ -140,15 +172,17 @@ function googleanalytics_page_alter(&$page) {
|
||||
// Track only the selected message types.
|
||||
if (in_array($type, $message_types)) {
|
||||
foreach ($messages as $message) {
|
||||
$message_events .= '_gaq.push(["_trackEvent", ' . drupal_json_encode(t('Messages')) . ', ' . drupal_json_encode($status_heading[$type]) . ', ' . drupal_json_encode(strip_tags($message)) . ']);';
|
||||
// @todo: Track as exceptions?
|
||||
$message_events .= 'ga("send", "event", ' . drupal_json_encode(t('Messages')) . ', ' . drupal_json_encode($status_heading[$type]) . ', ' . drupal_json_encode(strip_tags($message)) . ');';
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Site search tracking support.
|
||||
$url_custom = '';
|
||||
if (module_exists('search') && variable_get('googleanalytics_site_search', FALSE) && arg(0) == 'search' && $keys = googleanalytics_search_get_keys()) {
|
||||
// hook_preprocess_search_results() is not executed if search result is
|
||||
// empty. Make sure the counter is set to 0 if there are no results.
|
||||
$url_custom = '(window.googleanalytics_search_results) ? ' . drupal_json_encode(url('search/' . arg(1), array('query' => array('search' => $keys)))) . ' : ' . drupal_json_encode(url('search/' . arg(1), array('query' => array('search' => 'no-results:' . $keys, 'cat' => 'no-results'))));
|
||||
}
|
||||
|
||||
@@ -167,77 +201,149 @@ function googleanalytics_page_alter(&$page) {
|
||||
|
||||
// Track access denied (403) and file not found (404) pages.
|
||||
if ($status == '403 Forbidden') {
|
||||
// See http://www.google.com/support/analytics/bin/answer.py?answer=86927
|
||||
$url_custom = '"/403.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
|
||||
// See https://www.google.com/support/analytics/bin/answer.py?answer=86927
|
||||
$url_custom = '"' . $base_path . '403.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
|
||||
}
|
||||
elseif ($status == '404 Not Found') {
|
||||
$url_custom = '"/404.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
|
||||
$url_custom = '"' . $base_path . '404.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
|
||||
}
|
||||
|
||||
// Add any custom code snippets if specified.
|
||||
$codesnippet_before = variable_get('googleanalytics_codesnippet_before', '');
|
||||
$codesnippet_after = variable_get('googleanalytics_codesnippet_after', '');
|
||||
// #2693595: User has entered an invalid login and clicked on forgot
|
||||
// password link. This link contains the username or email address and may
|
||||
// get send to Google if we do not override it. Override only if 'name'
|
||||
// query param exists. Last custom url condition, this need to win.
|
||||
//
|
||||
// URLs to protect are:
|
||||
// - user/password?name=username
|
||||
// - user/password?name=foo@example.com
|
||||
if (arg(0) == 'user' && arg(1) == 'password' && array_key_exists('name', drupal_get_query_parameters())) {
|
||||
$url_custom = '"' . $base_path . 'user/password"';
|
||||
}
|
||||
|
||||
// Add custom variables.
|
||||
$googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
|
||||
// Add custom dimensions and metrics.
|
||||
$custom_var = '';
|
||||
for ($i = 1; $i < 6; $i++) {
|
||||
$custom_var_name = !empty($googleanalytics_custom_vars['slots'][$i]['name']) ? $googleanalytics_custom_vars['slots'][$i]['name'] : '';
|
||||
if (!empty($custom_var_name)) {
|
||||
$custom_var_value = !empty($googleanalytics_custom_vars['slots'][$i]['value']) ? $googleanalytics_custom_vars['slots'][$i]['value'] : '';
|
||||
$custom_var_scope = !empty($googleanalytics_custom_vars['slots'][$i]['scope']) ? $googleanalytics_custom_vars['slots'][$i]['scope'] : 3;
|
||||
foreach (array('dimension', 'metric') as $googleanalytics_custom_type) {
|
||||
$googleanalytics_custom_vars = variable_get('googleanalytics_custom_' . $googleanalytics_custom_type, array());
|
||||
// Are there dimensions or metrics configured?
|
||||
if (!empty($googleanalytics_custom_vars)) {
|
||||
// Add all the configured variables to the content.
|
||||
foreach ($googleanalytics_custom_vars as $googleanalytics_custom_var) {
|
||||
// Replace tokens in values.
|
||||
$types = array();
|
||||
$node = menu_get_object();
|
||||
if (is_object($node)) {
|
||||
$types += array('node' => $node);
|
||||
}
|
||||
$googleanalytics_custom_var['value'] = token_replace($googleanalytics_custom_var['value'], $types, array('clear' => TRUE));
|
||||
|
||||
$types = array();
|
||||
$node = menu_get_object();
|
||||
if (is_object($node)) {
|
||||
$types += array('node' => $node);
|
||||
// Suppress empty values.
|
||||
if (!drupal_strlen(trim($googleanalytics_custom_var['value']))) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Per documentation the max length of a dimension is 150 bytes.
|
||||
// A metric has no length limitation. It's not documented if this
|
||||
// limit means 150 bytes after url encoding or before.
|
||||
// See https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#customs
|
||||
if ($googleanalytics_custom_type == 'dimension' && drupal_strlen($googleanalytics_custom_var['value']) > 150) {
|
||||
$googleanalytics_custom_var['value'] = substr($googleanalytics_custom_var['value'], 0, 150);
|
||||
}
|
||||
|
||||
// Cast metric values for json_encode to data type numeric.
|
||||
if ($googleanalytics_custom_type == 'metric') {
|
||||
settype($googleanalytics_custom_var['value'], 'float');
|
||||
};
|
||||
|
||||
// Add variables to tracker.
|
||||
$custom_var .= 'ga("set", ' . drupal_json_encode($googleanalytics_custom_type . $googleanalytics_custom_var['index']) . ', ' . drupal_json_encode($googleanalytics_custom_var['value']) . ');';
|
||||
}
|
||||
$custom_var_name = token_replace($custom_var_name, $types, array('clear' => TRUE));
|
||||
$custom_var_value = token_replace($custom_var_value, $types, array('clear' => TRUE));
|
||||
|
||||
// Suppress empty custom names and/or variables.
|
||||
if (!drupal_strlen(trim($custom_var_name)) || !drupal_strlen(trim($custom_var_value))) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// The length of the string used for the 'name' and the length of the
|
||||
// string used for the 'value' must not exceed 128 bytes after url encoding.
|
||||
$name_length = drupal_strlen(rawurlencode($custom_var_name));
|
||||
$tmp_value = rawurlencode($custom_var_value);
|
||||
$value_length = drupal_strlen($tmp_value);
|
||||
if ($name_length + $value_length > 128) {
|
||||
// Trim value and remove fragments of url encoding.
|
||||
$tmp_value = rtrim(substr($tmp_value, 0, 127 - $name_length), '%0..9A..F');
|
||||
$custom_var_value = urldecode($tmp_value);
|
||||
}
|
||||
|
||||
$custom_var_name = drupal_json_encode($custom_var_name);
|
||||
$custom_var_value = drupal_json_encode($custom_var_value);
|
||||
$custom_var .= "_gaq.push(['_setCustomVar', $i, $custom_var_name, $custom_var_value, $custom_var_scope]);";
|
||||
}
|
||||
}
|
||||
|
||||
// Build tracker code.
|
||||
$script = 'var _gaq = _gaq || [];';
|
||||
$script .= '_gaq.push(["_setAccount", ' . drupal_json_encode($id) . ']);';
|
||||
if (variable_get('googleanalytics_tracker_anonymizeip', 0)) {
|
||||
// FIXME: The Google API is currently broken and "_gat._anonymizeIp" is only
|
||||
// a workaround until "_anonymizeIp" has been implemented/fixed.
|
||||
$script .= '_gaq.push(["_gat._anonymizeIp"]);';
|
||||
$script = '(function(i,s,o,g,r,a,m){';
|
||||
$script .= 'i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){';
|
||||
$script .= '(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),';
|
||||
$script .= 'm=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)';
|
||||
$script .= '})(window,document,"script",';
|
||||
|
||||
// Which version of the tracking library should be used?
|
||||
$library_tracker_url = 'https://www.google-analytics.com/' . ($debug ? 'analytics_debug.js' : 'analytics.js');
|
||||
|
||||
// Should a local cached copy of analytics.js be used?
|
||||
if (variable_get('googleanalytics_cache', 0) && $url = _googleanalytics_cache($library_tracker_url)) {
|
||||
// A dummy query-string is added to filenames, to gain control over
|
||||
// browser-caching. The string changes on every update or full cache
|
||||
// flush, forcing browsers to load a new copy of the files, as the
|
||||
// URL changed.
|
||||
$query_string = '?' . variable_get('css_js_query_string', '0');
|
||||
|
||||
$script .= '"' . $url . $query_string . '"';
|
||||
}
|
||||
else {
|
||||
$script .= '"' . $library_tracker_url . '"';
|
||||
}
|
||||
$script .= ',"ga");';
|
||||
|
||||
// Add any custom code snippets if specified.
|
||||
$codesnippet_create = variable_get('googleanalytics_codesnippet_create', array());
|
||||
$codesnippet_before = variable_get('googleanalytics_codesnippet_before', '');
|
||||
$codesnippet_after = variable_get('googleanalytics_codesnippet_after', '');
|
||||
|
||||
// Build the create only fields list.
|
||||
$create_only_fields = array('cookieDomain' => 'auto');
|
||||
$create_only_fields = array_merge($create_only_fields, $codesnippet_create);
|
||||
|
||||
// Domain tracking type.
|
||||
global $cookie_domain;
|
||||
$domain_mode = variable_get('googleanalytics_domain_mode', 0);
|
||||
$googleanalytics_adsense_script = '';
|
||||
|
||||
// Per RFC 2109, cookie domains must contain at least one dot other than the
|
||||
// first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
|
||||
if ($domain_mode == 1 && count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
|
||||
$script .= '_gaq.push(["_setDomainName", ' . drupal_json_encode($cookie_domain) . ']);';
|
||||
$create_only_fields = array_merge($create_only_fields, array('cookieDomain' => $cookie_domain));
|
||||
$googleanalytics_adsense_script .= 'window.google_analytics_domain_name = ' . drupal_json_encode($cookie_domain) . ';';
|
||||
}
|
||||
elseif ($domain_mode == 2) {
|
||||
$script .= '_gaq.push(["_setDomainName", "none"]);';
|
||||
$script .= '_gaq.push(["_setAllowLinker", true]);';
|
||||
// Cross Domain tracking. 'autoLinker' need to be enabled in 'create'.
|
||||
$create_only_fields = array_merge($create_only_fields, array('allowLinker' => TRUE));
|
||||
$googleanalytics_adsense_script .= 'window.google_analytics_domain_name = "none";';
|
||||
}
|
||||
|
||||
// Track logged in users across all devices.
|
||||
if (variable_get('googleanalytics_trackuserid', 0) && user_is_logged_in()) {
|
||||
$create_only_fields['userId'] = google_analytics_user_id_hash($user->uid);
|
||||
}
|
||||
|
||||
// Create a tracker.
|
||||
$script .= 'ga("create", ' . drupal_json_encode($id) . ', ' . drupal_json_encode($create_only_fields) .');';
|
||||
|
||||
// Prepare Adsense tracking.
|
||||
$googleanalytics_adsense_script .= 'window.google_analytics_uacct = ' . drupal_json_encode($id) . ';';
|
||||
|
||||
// Add enhanced link attribution after 'create', but before 'pageview' send.
|
||||
// @see https://support.google.com/analytics/answer/2558867
|
||||
if (variable_get('googleanalytics_tracklinkid', 0)) {
|
||||
$script .= 'ga("require", "linkid", "linkid.js");';
|
||||
}
|
||||
|
||||
// Add display features after 'create', but before 'pageview' send.
|
||||
// @see https://support.google.com/analytics/answer/2444872
|
||||
if (variable_get('googleanalytics_trackdoubleclick', 0)) {
|
||||
$script .= 'ga("require", "displayfeatures");';
|
||||
}
|
||||
|
||||
// Domain tracking type.
|
||||
if ($domain_mode == 2) {
|
||||
// Cross Domain tracking
|
||||
// https://developers.google.com/analytics/devguides/collection/upgrade/reference/gajs-analyticsjs#cross-domain
|
||||
$script .= 'ga("require", "linker");';
|
||||
$script .= 'ga("linker:autoLink", ' . drupal_json_encode($link_settings['trackCrossDomains']) . ');';
|
||||
}
|
||||
|
||||
if (variable_get('googleanalytics_tracker_anonymizeip', 1)) {
|
||||
$script .= 'ga("set", "anonymizeIp", true);';
|
||||
}
|
||||
|
||||
if (!empty($custom_var)) {
|
||||
@@ -246,12 +352,11 @@ function googleanalytics_page_alter(&$page) {
|
||||
if (!empty($codesnippet_before)) {
|
||||
$script .= $codesnippet_before;
|
||||
}
|
||||
if (empty($url_custom)) {
|
||||
$script .= '_gaq.push(["_trackPageview"]);';
|
||||
}
|
||||
else {
|
||||
$script .= '_gaq.push(["_trackPageview", ' . $url_custom . ']);';
|
||||
if (!empty($url_custom)) {
|
||||
$script .= 'ga("set", "page", ' . $url_custom . ');';
|
||||
}
|
||||
$script .= 'ga("send", "pageview");';
|
||||
|
||||
if (!empty($message_events)) {
|
||||
$script .= $message_events;
|
||||
}
|
||||
@@ -259,48 +364,34 @@ function googleanalytics_page_alter(&$page) {
|
||||
$script .= $codesnippet_after;
|
||||
}
|
||||
|
||||
$script .= '(function() {';
|
||||
$script .= 'var ga = document.createElement("script");';
|
||||
$script .= 'ga.type = "text/javascript";';
|
||||
$script .= 'ga.async = true;';
|
||||
|
||||
// Which version of the tracking library should be used?
|
||||
if ($trackdoubleclick = variable_get('googleanalytics_trackdoubleclick', FALSE)) {
|
||||
$library_tracker_url = 'stats.g.doubleclick.net/dc.js';
|
||||
$library_cache_url = 'http://' . $library_tracker_url;
|
||||
}
|
||||
else {
|
||||
$library_tracker_url = '.google-analytics.com/ga.js';
|
||||
$library_cache_url = 'http://www' . $library_tracker_url;
|
||||
if (variable_get('googleanalytics_trackadsense', FALSE)) {
|
||||
// Custom tracking. Prepend before all other JavaScript.
|
||||
// @TODO: https://support.google.com/adsense/answer/98142
|
||||
// sounds like it could be appended to $script.
|
||||
drupal_add_js($googleanalytics_adsense_script, array('type' => 'inline', 'group' => JS_LIBRARY-1, 'requires_jquery' => FALSE));
|
||||
}
|
||||
|
||||
// Should a local cached copy of ga.js be used?
|
||||
if (variable_get('googleanalytics_cache', 0) && $url = _googleanalytics_cache($library_cache_url)) {
|
||||
// A dummy query-string is added to filenames, to gain control over
|
||||
// browser-caching. The string changes on every update or full cache
|
||||
// flush, forcing browsers to load a new copy of the files, as the
|
||||
// URL changed.
|
||||
$query_string = '?' . variable_get('css_js_query_string', '0');
|
||||
|
||||
$script .= 'ga.src = "' . $url . $query_string . '";';
|
||||
}
|
||||
else {
|
||||
// Library paths do not follow the same naming convention.
|
||||
if ($trackdoubleclick) {
|
||||
$script .= 'ga.src = ("https:" == document.location.protocol ? "https://" : "http://") + "' . $library_tracker_url . '";';
|
||||
}
|
||||
else {
|
||||
$script .= 'ga.src = ("https:" == document.location.protocol ? "https://ssl" : "http://www") + "' . $library_tracker_url . '";';
|
||||
}
|
||||
}
|
||||
$script .= 'var s = document.getElementsByTagName("script")[0];';
|
||||
$script .= 's.parentNode.insertBefore(ga, s);';
|
||||
$script .= '})();';
|
||||
|
||||
drupal_add_js($script, array('scope' => $scope, 'type' => 'inline'));
|
||||
drupal_add_js($script, array('scope' => 'header', 'type' => 'inline', 'requires_jquery' => FALSE));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate user id hash to implement USER_ID.
|
||||
*
|
||||
* The USER_ID value should be a unique, persistent, and non-personally
|
||||
* identifiable string identifier that represents a user or signed-in
|
||||
* account across devices.
|
||||
*
|
||||
* @param int $uid
|
||||
* User id.
|
||||
*
|
||||
* @return string
|
||||
* User id hash.
|
||||
*/
|
||||
function google_analytics_user_id_hash($uid) {
|
||||
return drupal_hmac_base64($uid, drupal_get_private_key() . drupal_get_hash_salt());
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_field_extra_fields().
|
||||
*/
|
||||
@@ -382,13 +473,7 @@ function googleanalytics_user_presave(&$edit, $account, $category) {
|
||||
function googleanalytics_cron() {
|
||||
// Regenerate the tracking code file every day.
|
||||
if (REQUEST_TIME - variable_get('googleanalytics_last_cache', 0) >= 86400 && variable_get('googleanalytics_cache', 0)) {
|
||||
// Which version of the tracking library should be used?
|
||||
if (variable_get('googleanalytics_trackdoubleclick', FALSE)) {
|
||||
_googleanalytics_cache('http://stats.g.doubleclick.net/dc.js', TRUE);
|
||||
}
|
||||
else {
|
||||
_googleanalytics_cache('http://www.google-analytics.com/ga.js', TRUE);
|
||||
}
|
||||
_googleanalytics_cache('https://www.google-analytics.com/analytics.js', TRUE);
|
||||
variable_set('googleanalytics_last_cache', REQUEST_TIME);
|
||||
}
|
||||
}
|
||||
@@ -399,17 +484,19 @@ function googleanalytics_cron() {
|
||||
* Collects and adds the number of search results to the head.
|
||||
*/
|
||||
function googleanalytics_preprocess_search_results(&$variables) {
|
||||
// There is no search result $variable available that hold the number of items
|
||||
// found. But the pager item mumber can tell the number of search results.
|
||||
global $pager_total_items;
|
||||
if (variable_get('googleanalytics_site_search', FALSE)) {
|
||||
// There is no search result $variable available that hold the number of items
|
||||
// found. But the pager item mumber can tell the number of search results.
|
||||
global $pager_total_items;
|
||||
|
||||
drupal_add_js('window.googleanalytics_search_results = ' . intval($pager_total_items[0]) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1));
|
||||
drupal_add_js('window.googleanalytics_search_results = ' . intval($pager_total_items[0]) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1, 'requires_jquery' => FALSE));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function for grabbing search keys. Function is missing in D7.
|
||||
*
|
||||
* http://api.drupal.org/api/function/search_get_keys/6
|
||||
* https://api.drupal.org/api/function/search_get_keys/6
|
||||
*/
|
||||
function googleanalytics_search_get_keys() {
|
||||
static $return;
|
||||
@@ -428,16 +515,16 @@ function googleanalytics_search_get_keys() {
|
||||
*
|
||||
* @param $location
|
||||
* The full URL to the external javascript file.
|
||||
* @param $sync_cached_file
|
||||
* Synchronize tracking code and update if remote file have changed.
|
||||
* @param $synchronize
|
||||
* Synchronize to local cache if remote file has changed.
|
||||
* @return mixed
|
||||
* The path to the local javascript file on success, boolean FALSE on failure.
|
||||
*/
|
||||
function _googleanalytics_cache($location, $sync_cached_file = FALSE) {
|
||||
function _googleanalytics_cache($location, $synchronize = FALSE) {
|
||||
$path = 'public://googleanalytics';
|
||||
$file_destination = $path . '/' . basename($location);
|
||||
|
||||
if (!file_exists($file_destination) || $sync_cached_file) {
|
||||
if (!file_exists($file_destination) || $synchronize) {
|
||||
// Download the latest tracking code.
|
||||
$result = drupal_http_request($location);
|
||||
|
||||
@@ -450,6 +537,10 @@ function _googleanalytics_cache($location, $sync_cached_file = FALSE) {
|
||||
if ($data_hash_local != $data_hash_remote && file_prepare_directory($path)) {
|
||||
// Save updated tracking code file to disk.
|
||||
file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
|
||||
// Based on Drupal Core drupal_build_css_cache().
|
||||
if (variable_get('css_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
|
||||
file_unmanaged_save_data(gzencode($result->data, 9, FORCE_GZIP), $file_destination . '.gz', FILE_EXISTS_REPLACE);
|
||||
}
|
||||
watchdog('googleanalytics', 'Locally cached tracking code file has been updated.', array(), WATCHDOG_INFO);
|
||||
|
||||
// Change query-strings on css/js files to enforce reload for all users.
|
||||
@@ -462,6 +553,10 @@ function _googleanalytics_cache($location, $sync_cached_file = FALSE) {
|
||||
// There is no need to flush JS here as core refreshes JS caches
|
||||
// automatically, if new files are added.
|
||||
file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
|
||||
// Based on Drupal Core drupal_build_css_cache().
|
||||
if (variable_get('css_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
|
||||
file_unmanaged_save_data(gzencode($result->data, 9, FORCE_GZIP), $file_destination . '.gz', FILE_EXISTS_REPLACE);
|
||||
}
|
||||
watchdog('googleanalytics', 'Locally cached tracking code file has been saved.', array(), WATCHDOG_INFO);
|
||||
|
||||
// Return the local JS file path.
|
||||
|
||||
@@ -6,10 +6,17 @@
|
||||
*/
|
||||
class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
|
||||
/**
|
||||
* User without permissions to edit snippets.
|
||||
*
|
||||
* @var \StdClass
|
||||
*/
|
||||
protected $noSnippetUser;
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => t('Google Analytics basic tests'),
|
||||
'description' => t('Test basic functionality of Google Analytics module.'),
|
||||
'name' => 'Google Analytics basic tests',
|
||||
'description' => 'Test basic functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
@@ -20,31 +27,70 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
$permissions = array(
|
||||
'access administration pages',
|
||||
'administer google analytics',
|
||||
'administer modules',
|
||||
'administer site configuration',
|
||||
);
|
||||
|
||||
// User to set up google_analytics.
|
||||
$this->noSnippetUser = $this->drupalCreateUser($permissions);
|
||||
$permissions[] = 'add JS snippets for google analytics';
|
||||
$this->admin_user = $this->drupalCreateUser($permissions);
|
||||
$this->drupalLogin($this->admin_user);
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsConfiguration() {
|
||||
// Check if Configure link is available on 'Modules' page.
|
||||
// Requires 'administer modules' permission.
|
||||
$this->drupalGet('admin/modules');
|
||||
$this->assertRaw('admin/config/system/googleanalytics', '[testGoogleAnalyticsConfiguration]: Configure link from Modules page to Google Analytics Settings page exists.');
|
||||
|
||||
// Check if Configure link is available on 'Status Reports' page. NOTE: Link is only shown without UA code configured.
|
||||
// Requires 'administer site configuration' permission.
|
||||
$this->drupalGet('admin/reports/status');
|
||||
$this->assertRaw('admin/config/system/googleanalytics', '[testGoogleAnalyticsConfiguration]: Configure link from Status Reports page to Google Analytics Settings page exists.');
|
||||
|
||||
// Check for setting page's presence.
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
$this->assertRaw(t('Web Property ID'), '[testGoogleAnalyticsConfiguration]: Settings page displayed.');
|
||||
|
||||
// Check for account code validation.
|
||||
$edit['googleanalytics_account'] = $this->randomName(2);
|
||||
$this->drupalPost('admin/config/system/googleanalytics', $edit, 'Save configuration');
|
||||
$this->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
|
||||
$this->assertRaw(t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'), '[testGoogleAnalyticsConfiguration]: Invalid Web Property ID number validated.');
|
||||
|
||||
// User should have access to code snippets.
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_create');
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_before');
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_after');
|
||||
$this->assertNoFieldByXPath("//textarea[@name='googleanalytics_codesnippet_create' and @disabled='disabled']", NULL, '"Create only fields" is enabled.');
|
||||
$this->assertNoFieldByXPath("//textarea[@name='googleanalytics_codesnippet_before' and @disabled='disabled']", NULL, '"Code snippet (before)" is enabled.');
|
||||
$this->assertNoFieldByXPath("//textarea[@name='googleanalytics_codesnippet_after' and @disabled='disabled']", NULL, '"Code snippet (after)" is enabled.');
|
||||
|
||||
// Login as user without JS permissions.
|
||||
$this->drupalLogin($this->noSnippetUser);
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
|
||||
// User should *not* have access to snippets, but create fields.
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_create');
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_before');
|
||||
$this->assertFieldByName('googleanalytics_codesnippet_after');
|
||||
$this->assertNoFieldByXPath("//textarea[@name='googleanalytics_codesnippet_create' and @disabled='disabled']", NULL, '"Create only fields" is enabled.');
|
||||
$this->assertFieldByXPath("//textarea[@name='googleanalytics_codesnippet_before' and @disabled='disabled']", NULL, '"Code snippet (before)" is disabled.');
|
||||
$this->assertFieldByXPath("//textarea[@name='googleanalytics_codesnippet_after' and @disabled='disabled']", NULL, '"Code snippet (after)" is disabled.');
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsPageVisibility() {
|
||||
// Verify that no tracking code is embedded into the webpage; if there is
|
||||
// only the module installed, but UA code not configured. See #2246991.
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed without UA code configured.');
|
||||
|
||||
$ua_code = 'UA-123456-1';
|
||||
variable_set('googleanalytics_account', $ua_code);
|
||||
|
||||
// Show tracking on "every page except the listed pages".
|
||||
variable_set('googleanalytics_visibility_pages', 0);
|
||||
// Disable tracking one "admin*" pages only.
|
||||
// Disable tracking on "admin*" pages only.
|
||||
variable_set('googleanalytics_pages', "admin\nadmin/*");
|
||||
// Enable tracking only for authenticated users only.
|
||||
variable_set('googleanalytics_roles', array(DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID));
|
||||
@@ -58,7 +104,7 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
$this->assertNoRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed on admin page.');
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
// Checking for tracking code URI here, as $ua_code is displayed in the form.
|
||||
$this->assertNoRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed on admin subpage.');
|
||||
$this->assertNoRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed on admin subpage.');
|
||||
|
||||
// Test whether tracking code display is properly flipped.
|
||||
variable_set('googleanalytics_visibility_pages', 1);
|
||||
@@ -66,7 +112,7 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
$this->assertRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed on admin page.');
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
// Checking for tracking code URI here, as $ua_code is displayed in the form.
|
||||
$this->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed on admin subpage.');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed on admin subpage.');
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is NOT displayed on front page.');
|
||||
|
||||
@@ -80,31 +126,33 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
// Enable tracking code for all user roles.
|
||||
variable_set('googleanalytics_roles', array());
|
||||
|
||||
$base_path = base_path();
|
||||
|
||||
// Test whether 403 forbidden tracking code is shown if user has no access.
|
||||
$this->drupalGet('admin');
|
||||
$this->assertRaw('/403.html', '[testGoogleAnalyticsPageVisibility]: 403 Forbidden tracking code shown if user has no access.');
|
||||
$this->assertRaw($base_path . '403.html', '[testGoogleAnalyticsPageVisibility]: 403 Forbidden tracking code shown if user has no access.');
|
||||
|
||||
// Test whether 404 not found tracking code is shown on non-existent pages.
|
||||
$this->drupalGet($this->randomName(64));
|
||||
$this->assertRaw('/404.html', '[testGoogleAnalyticsPageVisibility]: 404 Not Found tracking code shown on non-existent page.');
|
||||
$this->assertRaw($base_path . '404.html', '[testGoogleAnalyticsPageVisibility]: 404 Not Found tracking code shown on non-existent page.');
|
||||
|
||||
// DNT Tests:
|
||||
// Enable caching of pages for anonymous users.
|
||||
// Enable system internal page cache for anonymous users.
|
||||
variable_set('cache', 1);
|
||||
// Test whether DNT headers will fail to disable embedding of tracking code.
|
||||
$this->drupalGet('', array(), array('DNT: 1'));
|
||||
$this->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT header send from client, but page caching is enabled and tracker cannot removed.');
|
||||
// DNT works only with caching of pages for anonymous users disabled.
|
||||
$this->assertRaw('ga("send", "pageview");', '[testGoogleAnalyticsDNTVisibility]: DNT header send from client, but page caching is enabled and tracker cannot removed.');
|
||||
// DNT works only with system internal page cache for anonymous users disabled.
|
||||
variable_set('cache', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: Tracking is enabled without DNT header.');
|
||||
$this->assertRaw('ga("send", "pageview");', '[testGoogleAnalyticsDNTVisibility]: Tracking is enabled without DNT header.');
|
||||
// Test whether DNT header is able to remove the tracking code.
|
||||
$this->drupalGet('', array(), array('DNT: 1'));
|
||||
$this->assertNoRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT header received from client. Tracking has been disabled by browser.');
|
||||
$this->assertNoRaw('ga("send", "pageview");', '[testGoogleAnalyticsDNTVisibility]: DNT header received from client. Tracking has been disabled by browser.');
|
||||
// Disable DNT feature and see if tracker is still embedded.
|
||||
variable_set('googleanalytics_privacy_donottrack', 0);
|
||||
$this->drupalGet('', array(), array('DNT: 1'));
|
||||
$this->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT feature is disabled, DNT header from browser has been ignored.');
|
||||
$this->assertRaw('ga("send", "pageview");', '[testGoogleAnalyticsDNTVisibility]: DNT feature is disabled, DNT header from browser has been ignored.');
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsTrackingCode() {
|
||||
@@ -118,40 +166,75 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
|
||||
/* Sample JS code as added to page:
|
||||
<script type="text/javascript" src="/sites/all/modules/google_analytics/googleanalytics.js?w"></script>
|
||||
<script type="text/javascript">
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', 'UA-123456-7']);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||
})();
|
||||
<script>
|
||||
(function(q,u,i,c,k){window['GoogleAnalyticsObject']=q;
|
||||
window[q]=window[q]||function(){(window[q].q=window[q].q||[]).push(arguments)},
|
||||
window[q].l=1*new Date();c=i.createElement(u),k=i.getElementsByTagName(u)[0];
|
||||
c.async=true;c.src='https://www.google-analytics.com/analytics.js';
|
||||
k.parentNode.insertBefore(c,k)})('ga','script',document);
|
||||
ga('create', 'UA-123456-7');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<!-- End Google Analytics -->
|
||||
*/
|
||||
|
||||
// Test whether tracking code uses latest JS.
|
||||
variable_set('googleanalytics_cache', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsTrackingCode]: Latest tracking code used.');
|
||||
|
||||
// Test whether the alternate doubleclick library is used
|
||||
variable_set('googleanalytics_trackdoubleclick', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('stats.g.doubleclick.net/dc.js', '[testGoogleAnalyticsTrackingCode]: Doubleclick tracking code used.');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsTrackingCode]: Latest tracking code used.');
|
||||
|
||||
// Test whether anonymize visitors IP address feature has been enabled.
|
||||
variable_set('googleanalytics_tracker_anonymizeip', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('_gaq.push(["_gat._anonymizeIp"]);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address not found on frontpage.');
|
||||
$this->assertNoRaw('ga("set", "anonymizeIp", true);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address not found on frontpage.');
|
||||
// Enable anonymizing of IP addresses.
|
||||
variable_set('googleanalytics_tracker_anonymizeip', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('_gaq.push(["_gat._anonymizeIp"]);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address found on frontpage.');
|
||||
$this->assertRaw('ga("set", "anonymizeIp", true);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address found on frontpage.');
|
||||
|
||||
// Test if track Enhanced Link Attribution is enabled.
|
||||
variable_set('googleanalytics_tracklinkid', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('ga("require", "linkid", "linkid.js");', '[testGoogleAnalyticsTrackingCode]: Tracking code for Enhanced Link Attribution is enabled.');
|
||||
|
||||
// Test if track Enhanced Link Attribution is disabled.
|
||||
variable_set('googleanalytics_tracklinkid', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('ga("require", "linkid", "linkid.js");', '[testGoogleAnalyticsTrackingCode]: Tracking code for Enhanced Link Attribution is not enabled.');
|
||||
|
||||
// Test if tracking of User ID is enabled.
|
||||
variable_set('googleanalytics_trackuserid', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw(', {"cookieDomain":"auto","userId":"', '[testGoogleAnalyticsTrackingCode]: Tracking code for User ID is enabled.');
|
||||
|
||||
// Test if tracking of User ID is disabled.
|
||||
variable_set('googleanalytics_trackuserid', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw(', {"cookieDomain":"auto","userId":"', '[testGoogleAnalyticsTrackingCode]: Tracking code for User ID is disabled.');
|
||||
|
||||
// Test if tracking of url fragments is enabled.
|
||||
variable_set('googleanalytics_trackurlfragments', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('ga("set", "page", location.pathname + location.search + location.hash);', '[testGoogleAnalyticsTrackingCode]: Tracking code for url fragments is enabled.');
|
||||
|
||||
// Test if tracking of url fragments is disabled.
|
||||
variable_set('googleanalytics_trackurlfragments', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('ga("set", "page", location.pathname + location.search + location.hash);', '[testGoogleAnalyticsTrackingCode]: Tracking code for url fragments is not enabled.');
|
||||
|
||||
// Test if track display features is enabled.
|
||||
variable_set('googleanalytics_trackdoubleclick', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('ga("require", "displayfeatures");', '[testGoogleAnalyticsTrackingCode]: Tracking code for display features is enabled.');
|
||||
|
||||
// Test if track display features is disabled.
|
||||
variable_set('googleanalytics_trackdoubleclick', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('ga("require", "displayfeatures");', '[testGoogleAnalyticsTrackingCode]: Tracking code for display features is not enabled.');
|
||||
|
||||
// Test whether single domain tracking is active.
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('_gaq.push(["_setDomainName"', '[testGoogleAnalyticsTrackingCode]: Single domain tracking is active.');
|
||||
$this->assertRaw('{"cookieDomain":"auto"}', '[testGoogleAnalyticsTrackingCode]: Single domain tracking is active.');
|
||||
|
||||
// Enable "One domain with multiple subdomains".
|
||||
variable_set('googleanalytics_domain_mode', 1);
|
||||
@@ -161,36 +244,63 @@ class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
|
||||
// TODO: Workaround to run tests successfully. This feature cannot tested reliable.
|
||||
global $cookie_domain;
|
||||
if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
|
||||
$this->assertRaw('_gaq.push(["_setDomainName",', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains is active on real host.');
|
||||
$this->assertRaw('{"cookieDomain":"' . $cookie_domain . '"}', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains is active on real host.');
|
||||
}
|
||||
else {
|
||||
// Special cases, Localhost and IP addresses don't show '_setDomainName'.
|
||||
$this->assertNoRaw('_gaq.push(["_setDomainName",', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains may be active on localhost (test result is not reliable).');
|
||||
$this->assertNoRaw('{"cookieDomain":"' . $cookie_domain . '"}', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains may be active on localhost (test result is not reliable).');
|
||||
}
|
||||
|
||||
// Enable "Multiple top-level domains" tracking.
|
||||
variable_set('googleanalytics_domain_mode', 2);
|
||||
variable_set('googleanalytics_cross_domains', "www.example.com\nwww.example.net");
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('_gaq.push(["_setDomainName", "none"]);', '[testGoogleAnalyticsTrackingCode]: _setDomainName: "none" found. Cross domain tracking is active.');
|
||||
$this->assertRaw('_gaq.push(["_setAllowLinker", true]);', '[testGoogleAnalyticsTrackingCode]: _setAllowLinker: true found. Cross domain tracking is active.');
|
||||
$this->assertRaw('ga("create", "' . $ua_code . '", {"cookieDomain":"auto","allowLinker":true', '[testGoogleAnalyticsTrackingCode]: "allowLinker" has been found. Cross domain tracking is active.');
|
||||
$this->assertRaw('ga("require", "linker");', '[testGoogleAnalyticsTrackingCode]: Require linker has been found. Cross domain tracking is active.');
|
||||
$this->assertRaw('ga("linker:autoLink", ["www.example.com","www.example.net"]);', '[testGoogleAnalyticsTrackingCode]: "linker:autoLink" has been found. Cross domain tracking is active.');
|
||||
$this->assertRaw('"trackDomainMode":2,', '[testGoogleAnalyticsTrackingCode]: Domain mode value is of type integer.');
|
||||
$this->assertRaw('"trackCrossDomains":["www.example.com","www.example.net"]', '[testGoogleAnalyticsTrackingCode]: Cross domain tracking with www.example.com and www.example.net is active.');
|
||||
variable_set('googleanalytics_domain_mode', 0);
|
||||
|
||||
// Test whether the BEFORE and AFTER code is added to the tracker.
|
||||
variable_set('googleanalytics_codesnippet_before', '_setDetectFlash(false);');
|
||||
variable_set('googleanalytics_codesnippet_after', '_gaq.push(["t2._setAccount", "UA-123456-3"]);_gaq.push(["t2._trackPageview"]);');
|
||||
// Test whether debugging script has been enabled.
|
||||
variable_set('googleanalytics_debug', 1);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('_setDetectFlash(false);', '[testGoogleAnalyticsTrackingCode]: Before codesnippet has been found with "Flash" detection disabled.');
|
||||
$this->assertRaw('t2._setAccount', '[testGoogleAnalyticsTrackingCode]: After codesnippet with "t2" tracker has been found.');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics_debug.js', '[testGoogleAnalyticsTrackingCode]: Google debugging script has been enabled.');
|
||||
|
||||
// Check if text and link is shown on 'Status Reports' page.
|
||||
// Requires 'administer site configuration' permission.
|
||||
$this->drupalGet('admin/reports/status');
|
||||
$this->assertRaw(t('Google Analytics module has debugging enabled. Please disable debugging setting in production sites from the <a href="@url">Google Analytics settings page</a>.', array('@url' => url('admin/config/system/googleanalytics'))), '[testGoogleAnalyticsConfiguration]: Debugging enabled is shown on Status Reports page.');
|
||||
|
||||
// Test whether debugging script has been disabled.
|
||||
variable_set('googleanalytics_debug', 0);
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsTrackingCode]: Google debugging script has been disabled.');
|
||||
|
||||
// Test whether the CREATE and BEFORE and AFTER code is added to the tracker.
|
||||
$codesnippet_create = array(
|
||||
'cookieDomain' => 'foo.example.com',
|
||||
'cookieName' => 'myNewName',
|
||||
'cookieExpires' => 20000,
|
||||
'allowAnchor' => TRUE,
|
||||
'sampleRate' => 4.3,
|
||||
);
|
||||
variable_set('googleanalytics_codesnippet_create', $codesnippet_create);
|
||||
variable_set('googleanalytics_codesnippet_before', 'ga("set", "forceSSL", true);');
|
||||
variable_set('googleanalytics_codesnippet_after', 'ga("create", "UA-123456-3", {"name": "newTracker"});ga("newTracker.send", "pageview");');
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('ga("create", "' . $ua_code . '", {"cookieDomain":"foo.example.com","cookieName":"myNewName","cookieExpires":20000,"allowAnchor":true,"sampleRate":4.3});', '[testGoogleAnalyticsTrackingCode]: Create only fields have been found.');
|
||||
$this->assertRaw('ga("set", "forceSSL", true);', '[testGoogleAnalyticsTrackingCode]: Before codesnippet will force http pages to also send all beacons using https.');
|
||||
$this->assertRaw('ga("create", "UA-123456-3", {"name": "newTracker"});', '[testGoogleAnalyticsTrackingCode]: After codesnippet with "newTracker" tracker has been found.');
|
||||
}
|
||||
}
|
||||
|
||||
class GoogleAnalyticsCustomVariablesTest extends DrupalWebTestCase {
|
||||
class GoogleAnalyticsCustomDimensionsAndMetricsTest extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => t('Google Analytics Custom Variables tests'),
|
||||
'description' => t('Test custom variables functionality of Google Analytics module.'),
|
||||
'name' => 'Google Analytics custom dimensions and metrics tests',
|
||||
'description' => 'Test custom dimensions and metrics functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
'dependencies' => array('token'),
|
||||
);
|
||||
@@ -206,110 +316,217 @@ class GoogleAnalyticsCustomVariablesTest extends DrupalWebTestCase {
|
||||
|
||||
// User to set up google_analytics.
|
||||
$this->admin_user = $this->drupalCreateUser($permissions);
|
||||
$this->drupalLogin($this->admin_user);
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsCustomVariables() {
|
||||
function testGoogleAnalyticsCustomDimensions() {
|
||||
$ua_code = 'UA-123456-3';
|
||||
variable_set('googleanalytics_account', $ua_code);
|
||||
|
||||
// Basic test if the feature works.
|
||||
$custom_vars = array(
|
||||
'slots' => array(
|
||||
1 => array(
|
||||
'slot' => 1,
|
||||
'name' => 'Foo 1',
|
||||
'value' => 'Bar 1',
|
||||
'scope' => 3,
|
||||
),
|
||||
2 => array(
|
||||
'slot' => 2,
|
||||
'name' => 'Foo 2',
|
||||
'value' => 'Bar 2',
|
||||
'scope' => 2,
|
||||
),
|
||||
3 => array(
|
||||
'slot' => 3,
|
||||
'name' => 'Foo 3',
|
||||
'value' => 'Bar 3',
|
||||
'scope' => 3,
|
||||
),
|
||||
4 => array(
|
||||
'slot' => 4,
|
||||
'name' => 'Foo 4',
|
||||
'value' => 'Bar 4',
|
||||
'scope' => 2,
|
||||
),
|
||||
5 => array(
|
||||
'slot' => 5,
|
||||
'name' => 'Foo 5',
|
||||
'value' => 'Bar 5',
|
||||
'scope' => 1,
|
||||
),
|
||||
)
|
||||
$googleanalytics_custom_dimension = array(
|
||||
1 => array(
|
||||
'index' => 1,
|
||||
'value' => 'Bar 1',
|
||||
),
|
||||
2 => array(
|
||||
'index' => 2,
|
||||
'value' => 'Bar 2',
|
||||
),
|
||||
3 => array(
|
||||
'index' => 3,
|
||||
'value' => 'Bar 3',
|
||||
),
|
||||
4 => array(
|
||||
'index' => 4,
|
||||
'value' => 'Bar 4',
|
||||
),
|
||||
5 => array(
|
||||
'index' => 5,
|
||||
'value' => 'Bar 5',
|
||||
),
|
||||
);
|
||||
variable_set('googleanalytics_custom_var', $custom_vars);
|
||||
variable_set('googleanalytics_custom_dimension', $googleanalytics_custom_dimension);
|
||||
$this->drupalGet('');
|
||||
|
||||
foreach ($custom_vars['slots'] as $slot) {
|
||||
$this->assertRaw("_gaq.push(['_setCustomVar', " . $slot['slot'] . ", \"" . $slot['name'] . "\", \"" . $slot['value'] . "\", " . $slot['scope'] . "]);", '[testGoogleAnalyticsCustomVariables]: _setCustomVar ' . $slot['slot'] . ' is shown.');
|
||||
foreach ($googleanalytics_custom_dimension as $dimension) {
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('dimension' . $dimension['index']) . ', ' . drupal_json_encode($dimension['value']) . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Dimension #' . $dimension['index'] . ' is shown.');
|
||||
}
|
||||
|
||||
// Test whether tokens are replaced in custom variable names.
|
||||
// Test whether tokens are replaced in custom dimension values.
|
||||
$site_slogan = $this->randomName(16);
|
||||
variable_set('site_slogan', $site_slogan);
|
||||
|
||||
$custom_vars = array(
|
||||
'slots' => array(
|
||||
1 => array(
|
||||
'slot' => 1,
|
||||
'name' => 'Name: [site:slogan]',
|
||||
'value' => 'Value: [site:slogan]',
|
||||
'scope' => 3,
|
||||
),
|
||||
2 => array(
|
||||
'slot' => 2,
|
||||
'name' => '',
|
||||
'value' => $this->randomName(16),
|
||||
'scope' => 1,
|
||||
),
|
||||
3 => array(
|
||||
'slot' => 3,
|
||||
'name' => $this->randomName(16),
|
||||
'value' => '',
|
||||
'scope' => 2,
|
||||
),
|
||||
4 => array(
|
||||
'slot' => 4,
|
||||
'name' => '',
|
||||
'value' => '',
|
||||
'scope' => 3,
|
||||
),
|
||||
5 => array(
|
||||
'slot' => 5,
|
||||
'name' => '',
|
||||
'value' => '',
|
||||
'scope' => 3,
|
||||
),
|
||||
)
|
||||
$googleanalytics_custom_dimension = array(
|
||||
1 => array(
|
||||
'index' => 1,
|
||||
'value' => 'Value: [site:slogan]',
|
||||
),
|
||||
2 => array(
|
||||
'index' => 2,
|
||||
'value' => $this->randomName(16),
|
||||
),
|
||||
3 => array(
|
||||
'index' => 3,
|
||||
'value' => '',
|
||||
),
|
||||
// #2300701: Custom dimensions and custom metrics not outputed on zero value.
|
||||
4 => array(
|
||||
'index' => 4,
|
||||
'value' => '0',
|
||||
),
|
||||
);
|
||||
variable_set('googleanalytics_custom_var', $custom_vars);
|
||||
$this->verbose('<pre>' . print_r($custom_vars, TRUE) . '</pre>');
|
||||
variable_set('googleanalytics_custom_dimension', $googleanalytics_custom_dimension);
|
||||
$this->verbose('<pre>' . print_r($googleanalytics_custom_dimension, TRUE) . '</pre>');
|
||||
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw("_gaq.push(['_setCustomVar', 1, \"Name: $site_slogan\", \"Value: $site_slogan\", 3]", '[testGoogleAnalyticsCustomVariables]: Tokens have been replaced in custom variable.');
|
||||
$this->assertNoRaw("_gaq.push(['_setCustomVar', 2,", '[testGoogleAnalyticsCustomVariables]: Value with empty name is not shown.');
|
||||
$this->assertNoRaw("_gaq.push(['_setCustomVar', 3,", '[testGoogleAnalyticsCustomVariables]: Name with empty value is not shown.');
|
||||
$this->assertNoRaw("_gaq.push(['_setCustomVar', 4,", '[testGoogleAnalyticsCustomVariables]: Empty name and value is not shown.');
|
||||
$this->assertNoRaw("_gaq.push(['_setCustomVar', 5,", '[testGoogleAnalyticsCustomVariables]: Empty name and value is not shown.');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('dimension1') . ', ' . drupal_json_encode("Value: $site_slogan") . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Tokens have been replaced in dimension value.');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('dimension2') . ', ' . drupal_json_encode($googleanalytics_custom_dimension['2']['value']) . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Random value is shown.');
|
||||
$this->assertNoRaw('ga("set", ' . drupal_json_encode('dimension3') . ', ' . drupal_json_encode('') . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Empty value is not shown.');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('dimension4') . ', ' . drupal_json_encode('0') . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Value 0 is shown.');
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsCustomMetrics() {
|
||||
$ua_code = 'UA-123456-3';
|
||||
variable_set('googleanalytics_account', $ua_code);
|
||||
|
||||
// Basic test if the feature works.
|
||||
$googleanalytics_custom_metric = array(
|
||||
1 => array(
|
||||
'index' => 1,
|
||||
'value' => '6',
|
||||
),
|
||||
2 => array(
|
||||
'index' => 2,
|
||||
'value' => '8000',
|
||||
),
|
||||
3 => array(
|
||||
'index' => 3,
|
||||
'value' => '7.8654',
|
||||
),
|
||||
4 => array(
|
||||
'index' => 4,
|
||||
'value' => '1123.4',
|
||||
),
|
||||
5 => array(
|
||||
'index' => 5,
|
||||
'value' => '5,67',
|
||||
),
|
||||
);
|
||||
|
||||
variable_set('googleanalytics_custom_metric', $googleanalytics_custom_metric);
|
||||
$this->drupalGet('');
|
||||
|
||||
foreach ($googleanalytics_custom_metric as $metric) {
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('metric' . $metric['index']) . ', ' . drupal_json_encode((float) $metric['value']) . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Metric #' . $metric['index'] . ' is shown.');
|
||||
}
|
||||
|
||||
// Test whether tokens are replaced in custom metric values.
|
||||
$googleanalytics_custom_metric = array(
|
||||
1 => array(
|
||||
'index' => 1,
|
||||
'value' => '[current-user:roles:count]',
|
||||
),
|
||||
2 => array(
|
||||
'index' => 2,
|
||||
'value' => mt_rand(),
|
||||
),
|
||||
3 => array(
|
||||
'index' => 3,
|
||||
'value' => '',
|
||||
),
|
||||
// #2300701: Custom dimensions and custom metrics not outputed on zero value.
|
||||
4 => array(
|
||||
'index' => 4,
|
||||
'value' => '0',
|
||||
),
|
||||
);
|
||||
variable_set('googleanalytics_custom_metric', $googleanalytics_custom_metric);
|
||||
$this->verbose('<pre>' . print_r($googleanalytics_custom_metric, TRUE) . '</pre>');
|
||||
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('metric1') . ', ', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Tokens have been replaced in metric value.');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('metric2') . ', ' . drupal_json_encode($googleanalytics_custom_metric['2']['value']) . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Random value is shown.');
|
||||
$this->assertNoRaw('ga("set", ' . drupal_json_encode('metric3') . ', ' . drupal_json_encode('') . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Empty value is not shown.');
|
||||
$this->assertRaw('ga("set", ' . drupal_json_encode('metric4') . ', ' . drupal_json_encode(0) . ');', '[testGoogleAnalyticsCustomDimensionsAndMetrics]: Value 0 is shown.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests if Custom Dimensions token form validation works.
|
||||
*/
|
||||
public function testGoogleAnalyticsCustomDimensionsTokenFormValidation() {
|
||||
$ua_code = 'UA-123456-1';
|
||||
|
||||
// Check form validation.
|
||||
$edit['googleanalytics_account'] = $ua_code;
|
||||
$edit['googleanalytics_custom_dimension[indexes][1][value]'] = '[current-user:name]';
|
||||
$edit['googleanalytics_custom_dimension[indexes][2][value]'] = '[current-user:edit-url]';
|
||||
$edit['googleanalytics_custom_dimension[indexes][3][value]'] = '[user:name]';
|
||||
$edit['googleanalytics_custom_dimension[indexes][4][value]'] = '[term:name]';
|
||||
$edit['googleanalytics_custom_dimension[indexes][5][value]'] = '[term:tid]';
|
||||
|
||||
$this->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
|
||||
|
||||
$this->assertRaw(t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => t('Custom dimension value #@index', array('@index' => 1)), '@invalid-tokens' => implode(', ', array('[current-user:name]')))));
|
||||
$this->assertRaw(t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => t('Custom dimension value #@index', array('@index' => 2)), '@invalid-tokens' => implode(', ', array('[current-user:edit-url]')))));
|
||||
$this->assertRaw(t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => t('Custom dimension value #@index', array('@index' => 3)), '@invalid-tokens' => implode(', ', array('[user:name]')))));
|
||||
// BUG #2037595
|
||||
//$this->assertNoRaw(t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => t('Custom dimension value #@index', array('@index' => 4)), '@invalid-tokens' => implode(', ', array('[term:name]')))));
|
||||
//$this->assertNoRaw(t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => t('Custom dimension value #@index', array('@index' => 5)), '@invalid-tokens' => implode(', ', array('[term:tid]')))));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Test custom url functionality of Google Analytics module.
|
||||
*/
|
||||
class GoogleAnalyticsCustomUrls extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => 'Google Analytics custom url tests',
|
||||
'description' => 'Test custom url functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
|
||||
function setUp() {
|
||||
parent::setUp('googleanalytics');
|
||||
|
||||
$permissions = array(
|
||||
'access administration pages',
|
||||
'administer google analytics',
|
||||
);
|
||||
|
||||
// User to set up google_analytics.
|
||||
$this->admin_user = $this->drupalCreateUser($permissions);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests if user password page urls are overridden.
|
||||
*/
|
||||
public function testGoogleAnalyticsUserPasswordPage() {
|
||||
$base_path = base_path();
|
||||
$ua_code = 'UA-123456-4';
|
||||
variable_set('googleanalytics_account', $ua_code);
|
||||
|
||||
$this->drupalGet('user/password', array('query' => array('name' => 'foo')));
|
||||
$this->assertRaw('ga("set", "page", "' . $base_path . 'user/password"');
|
||||
|
||||
$this->drupalGet('user/password', array('query' => array('name' => 'foo@example.com')));
|
||||
$this->assertRaw('ga("set", "page", "' . $base_path . 'user/password"');
|
||||
|
||||
$this->drupalGet('user/password');
|
||||
$this->assertNoRaw('ga("set", "page",', '[testGoogleAnalyticsCustomUrls]: Custom url not set.');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
class GoogleAnalyticsStatusMessagesTest extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => t('Google Analytics status messages tests'),
|
||||
'description' => t('Test status messages functionality of Google Analytics module.'),
|
||||
'name' => 'Google Analytics status messages tests',
|
||||
'description' => 'Test status messages functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
@@ -333,20 +550,20 @@ class GoogleAnalyticsStatusMessagesTest extends DrupalWebTestCase {
|
||||
// Enable logging of errors only.
|
||||
variable_set('googleanalytics_trackmessages', array('error' => 'error'));
|
||||
|
||||
$this->drupalPost('user/login', array(), 'Log in');
|
||||
$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Username field is required."]);', '[testGoogleAnalyticsStatusMessages]: _trackEvent "Username field is required." is shown.');
|
||||
$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Password field is required."]);', '[testGoogleAnalyticsStatusMessages]: _trackEvent "Password field is required." is shown.');
|
||||
$this->drupalPost('user/login', array(), t('Log in'));
|
||||
$this->assertRaw('ga("send", "event", "Messages", "Error message", "Username field is required.");', '[testGoogleAnalyticsStatusMessages]: Event message "Username field is required." is shown.');
|
||||
$this->assertRaw('ga("send", "event", "Messages", "Error message", "Password field is required.");', '[testGoogleAnalyticsStatusMessages]: Event message "Password field is required." is shown.');
|
||||
|
||||
// @todo: investigate why drupal_set_message() fails.
|
||||
//drupal_set_message('Example status message.', 'status');
|
||||
//drupal_set_message('Example warning message.', 'warning');
|
||||
//drupal_set_message('Example error message.', 'error');
|
||||
//drupal_set_message('Example error <em>message</em> with html tags and <a href="http://example.com/">link</a>.', 'error');
|
||||
//drupal_set_message('Example error <em>message</em> with html tags and <a href="https://example.com/">link</a>.', 'error');
|
||||
//$this->drupalGet('');
|
||||
//$this->assertNoRaw('_gaq.push(["_trackEvent", "Messages", "Status message", "Example status message."]);', '[testGoogleAnalyticsStatusMessages]: Example status message is not enabled for tracking.');
|
||||
//$this->assertNoRaw('_gaq.push(["_trackEvent", "Messages", "Warning message", "Example warning message."]);', '[testGoogleAnalyticsStatusMessages]: Example warning message is not enabled for tracking.');
|
||||
//$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Example error message."]);', '[testGoogleAnalyticsStatusMessages]: Example error message is shown.');
|
||||
//$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Example error message with html tags and link."]);', '[testGoogleAnalyticsStatusMessages]: HTML has been stripped successful from Example error message with html tags and link.');
|
||||
//$this->assertNoRaw('ga("send", "event", "Messages", "Status message", "Example status message.");', '[testGoogleAnalyticsStatusMessages]: Example status message is not enabled for tracking.');
|
||||
//$this->assertNoRaw('ga("send", "event", "Messages", "Warning message", "Example warning message.");', '[testGoogleAnalyticsStatusMessages]: Example warning message is not enabled for tracking.');
|
||||
//$this->assertRaw('ga("send", "event", "Messages", "Error message", "Example error message.");', '[testGoogleAnalyticsStatusMessages]: Example error message is shown.');
|
||||
//$this->assertRaw('ga("send", "event", "Messages", "Error message", "Example error message with html tags and link.");', '[testGoogleAnalyticsStatusMessages]: HTML has been stripped successful from Example error message with html tags and link.');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -354,8 +571,8 @@ class GoogleAnalyticsRolesTest extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => t('Google Analytics role tests'),
|
||||
'description' => t('Test roles functionality of Google Analytics module.'),
|
||||
'name' => 'Google Analytics role tests',
|
||||
'description' => 'Test roles functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
@@ -438,5 +655,165 @@ class GoogleAnalyticsRolesTest extends DrupalWebTestCase {
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is displayed on frontpage for included anonymous users.');
|
||||
}
|
||||
}
|
||||
|
||||
class GoogleAnalyticsSearchTest extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => 'Google Analytics search tests',
|
||||
'description' => 'Test search functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
|
||||
function setUp() {
|
||||
parent::setUp('googleanalytics', 'search', 'node');
|
||||
|
||||
$permissions = array(
|
||||
'access administration pages',
|
||||
'administer google analytics',
|
||||
'search content',
|
||||
'create page content',
|
||||
'edit own page content',
|
||||
);
|
||||
|
||||
// User to set up google_analytics.
|
||||
$this->admin_user = $this->drupalCreateUser($permissions);
|
||||
$this->drupalLogin($this->admin_user);
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsSearchTracking() {
|
||||
$ua_code = 'UA-123456-1';
|
||||
variable_set('googleanalytics_account', $ua_code);
|
||||
|
||||
// Check tracking code visibility.
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw($ua_code, '[testGoogleAnalyticsSearch]: Tracking code is displayed for authenticated users.');
|
||||
|
||||
$this->drupalGet('search/node');
|
||||
$this->assertNoRaw('ga("set", "page",', '[testGoogleAnalyticsSearch]: Custom url not set.');
|
||||
|
||||
// Enable site search support.
|
||||
variable_set('googleanalytics_site_search', 1);
|
||||
|
||||
// Search for random string.
|
||||
$search = array();
|
||||
$search['keys'] = $this->randomName(8);
|
||||
|
||||
// Create a node to search for.
|
||||
$langcode = LANGUAGE_NONE;
|
||||
$edit = array();
|
||||
$edit['title'] = 'This is a test title';
|
||||
$edit["body[$langcode][0][value]"] = 'This test content contains ' . $search['keys'] . ' string.';
|
||||
|
||||
// Fire a search, it's expected to get 0 results.
|
||||
$this->drupalPost('search/node', $search, t('Search'));
|
||||
$this->assertRaw('ga("set", "page", (window.googleanalytics_search_results) ?', '[testGoogleAnalyticsSearch]: Search results tracker is displayed.');
|
||||
$this->assertRaw('window.googleanalytics_search_results = 0;', '[testGoogleAnalyticsSearch]: Search yielded no results.');
|
||||
|
||||
// Save the node.
|
||||
$this->drupalPost('node/add/page', $edit, t('Save'));
|
||||
$this->assertText(t('@type @title has been created.', array('@type' => 'Basic page', '@title' => $edit['title'])), 'Node was created.');
|
||||
|
||||
// Index the node or it cannot found.
|
||||
$this->cronRun();
|
||||
|
||||
$this->drupalPost('search/node', $search, t('Search'));
|
||||
$this->assertRaw('ga("set", "page", (window.googleanalytics_search_results) ?', '[testGoogleAnalyticsSearch]: Search results tracker is displayed.');
|
||||
$this->assertRaw('window.googleanalytics_search_results = 1;', '[testGoogleAnalyticsSearch]: One search result found.');
|
||||
|
||||
$this->drupalPost('node/add/page', $edit, t('Save'));
|
||||
$this->assertText(t('@type @title has been created.', array('@type' => 'Basic page', '@title' => $edit['title'])), 'Node was created.');
|
||||
|
||||
// Index the node or it cannot found.
|
||||
$this->cronRun();
|
||||
|
||||
$this->drupalPost('search/node', $search, t('Search'));
|
||||
$this->assertRaw('ga("set", "page", (window.googleanalytics_search_results) ?', '[testGoogleAnalyticsSearch]: Search results tracker is displayed.');
|
||||
$this->assertRaw('window.googleanalytics_search_results = 2;', '[testGoogleAnalyticsSearch]: Two search results found.');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
class GoogleAnalyticsPhpFilterTest extends DrupalWebTestCase {
|
||||
|
||||
public static function getInfo() {
|
||||
return array(
|
||||
'name' => 'Google Analytics php filter tests',
|
||||
'description' => 'Test php filter functionality of Google Analytics module.',
|
||||
'group' => 'Google Analytics',
|
||||
);
|
||||
}
|
||||
|
||||
function setUp() {
|
||||
parent::setUp('googleanalytics', 'php');
|
||||
|
||||
// Administrator with all permissions.
|
||||
$permissions_admin_user = array(
|
||||
'access administration pages',
|
||||
'administer google analytics',
|
||||
'use PHP for tracking visibility',
|
||||
);
|
||||
$this->admin_user = $this->drupalCreateUser($permissions_admin_user);
|
||||
|
||||
// Administrator who cannot configure tracking visibility with PHP.
|
||||
$permissions_delegated_admin_user = array(
|
||||
'access administration pages',
|
||||
'administer google analytics',
|
||||
);
|
||||
$this->delegated_admin_user = $this->drupalCreateUser($permissions_delegated_admin_user);
|
||||
}
|
||||
|
||||
function testGoogleAnalyticsPhpFilter() {
|
||||
$ua_code = 'UA-123456-1';
|
||||
$this->drupalLogin($this->admin_user);
|
||||
|
||||
$edit = array();
|
||||
$edit['googleanalytics_account'] = $ua_code;
|
||||
$edit['googleanalytics_visibility_pages'] = 2;
|
||||
$edit['googleanalytics_pages'] = '<?php return 0; ?>';
|
||||
$this->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
|
||||
|
||||
// Compare saved setting with posted setting.
|
||||
$googleanalytics_pages = variable_get('googleanalytics_pages', $this->randomName(8));
|
||||
$this->assertEqual('<?php return 0; ?>', $googleanalytics_pages, '[testGoogleAnalyticsPhpFilter]: PHP code snippet is intact.');
|
||||
|
||||
// Check tracking code visibility.
|
||||
variable_set('googleanalytics_pages', '<?php return TRUE; ?>');
|
||||
$this->drupalGet('');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPhpFilter]: Tracking is displayed on frontpage page.');
|
||||
$this->drupalGet('admin');
|
||||
$this->assertRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPhpFilter]: Tracking is displayed on admin page.');
|
||||
|
||||
variable_set('googleanalytics_pages', '<?php return FALSE; ?>');
|
||||
$this->drupalGet('');
|
||||
$this->assertNoRaw('https://www.google-analytics.com/analytics.js', '[testGoogleAnalyticsPhpFilter]: Tracking is not displayed on frontpage page.');
|
||||
|
||||
// Test administration form.
|
||||
variable_set('googleanalytics_pages', '<?php return TRUE; ?>');
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
$this->assertRaw(t('Pages on which this PHP code returns <code>TRUE</code> (experts only)'), '[testGoogleAnalyticsPhpFilter]: Permission to administer PHP for tracking visibility.');
|
||||
$this->assertRaw(check_plain('<?php return TRUE; ?>'), '[testGoogleAnalyticsPhpFilter]: PHP code snippted is displayed.');
|
||||
|
||||
// Login the delegated user and check if fields are visible.
|
||||
$this->drupalLogin($this->delegated_admin_user);
|
||||
$this->drupalGet('admin/config/system/googleanalytics');
|
||||
$this->assertNoRaw(t('Pages on which this PHP code returns <code>TRUE</code> (experts only)'), '[testGoogleAnalyticsPhpFilter]: No permission to administer PHP for tracking visibility.');
|
||||
$this->assertNoRaw(check_plain('<?php return TRUE; ?>'), '[testGoogleAnalyticsPhpFilter]: No permission to view PHP code snippted.');
|
||||
|
||||
// Set a different value and verify that this is still the same after the post.
|
||||
variable_set('googleanalytics_pages', '<?php return 0; ?>');
|
||||
|
||||
$edit = array();
|
||||
$edit['googleanalytics_account'] = $ua_code;
|
||||
$this->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
|
||||
|
||||
// Compare saved setting with posted setting.
|
||||
$googleanalytics_visibility_pages = variable_get('googleanalytics_visibility_pages', 0);
|
||||
$googleanalytics_pages = variable_get('googleanalytics_pages', $this->randomName(8));
|
||||
$this->assertEqual(2, $googleanalytics_visibility_pages, '[testGoogleAnalyticsPhpFilter]: Pages on which this PHP code returns TRUE is selected.');
|
||||
$this->assertEqual('<?php return 0; ?>', $googleanalytics_pages, '[testGoogleAnalyticsPhpFilter]: PHP code snippet is intact.');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
(function ($) {
|
||||
|
||||
/**
|
||||
* This file is for developers only.
|
||||
*
|
||||
* This tests are made for the javascript functions used in GA module.
|
||||
* These tests verify if the return values are properly working.
|
||||
*
|
||||
* Hopefully this can be added somewhere else once Drupal core has JavaScript
|
||||
* unit testing integrated.
|
||||
*/
|
||||
|
||||
"use strict";
|
||||
|
||||
Drupal.googleanalytics.test = {};
|
||||
|
||||
Drupal.googleanalytics.test.assertSame = function (value1, value2, message) {
|
||||
if (value1 === value2) {
|
||||
console.info(message);
|
||||
}
|
||||
else {
|
||||
console.error(message);
|
||||
}
|
||||
};
|
||||
|
||||
Drupal.googleanalytics.test.assertNotSame = function (value1, value2, message) {
|
||||
if (value1 !== value2) {
|
||||
console.info(message);
|
||||
}
|
||||
else {
|
||||
console.error(message);
|
||||
}
|
||||
};
|
||||
|
||||
Drupal.googleanalytics.test.assertTrue = function (value1, message) {
|
||||
if (value1 === true) {
|
||||
console.info(message);
|
||||
}
|
||||
else {
|
||||
console.error(message);
|
||||
}
|
||||
};
|
||||
|
||||
Drupal.googleanalytics.test.assertFalse = function (value1, message) {
|
||||
if (value1 === false) {
|
||||
console.info(message);
|
||||
}
|
||||
else {
|
||||
console.error(message);
|
||||
}
|
||||
};
|
||||
|
||||
// Run after the documented is ready or Drupal.settings is undefined.
|
||||
$(document).ready(function() {
|
||||
|
||||
/**
|
||||
* Run javascript tests against the GA module.
|
||||
*/
|
||||
|
||||
// JavaScript debugging
|
||||
var base_url = window.location.protocol + '//' + window.location.host;
|
||||
var base_path = window.location.pathname;
|
||||
console.dir(Drupal);
|
||||
|
||||
console.group("Test 'isDownload':");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'node/8'), "Verify that '/node/8' url is not detected as file download.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'files/foo1.zip'), "Verify that '/files/foo1.zip' url is detected as a file download.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'files/foo1.zip#foo'), "Verify that '/files/foo1.zip#foo' url is detected as a file download.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'files/foo1.zip?foo=bar'), "Verify that '/files/foo1.zip?foo=bar' url is detected as a file download.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'files/foo1.zip?foo=bar#foo'), "Verify that '/files/foo1.zip?foo=bar#foo' url is detected as a file download.");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isDownload(base_url + Drupal.settings.basePath + 'files/foo2.ddd'), "Verify that '/files/foo2.ddd' url is not detected as file download.");
|
||||
console.groupEnd();
|
||||
|
||||
console.group("Test 'isInternal':");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternal(base_url + Drupal.settings.basePath + 'node/1'), "Link '" + base_url + Drupal.settings.basePath + "node/2' has been detected as internal link.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternal(base_url + Drupal.settings.basePath + 'node/1#foo'), "Link '" + base_url + Drupal.settings.basePath + "node/1#foo' has been detected as internal link.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternal(base_url + Drupal.settings.basePath + 'node/1?foo=bar'), "Link '" + base_url + Drupal.settings.basePath + "node/1?foo=bar' has been detected as internal link.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternal(base_url + Drupal.settings.basePath + 'node/1?foo=bar#foo'), "Link '" + base_url + Drupal.settings.basePath + "node/1?foo=bar#foo' has been detected as internal link.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternal(base_url + Drupal.settings.basePath + 'go/foo'), "Link '" + base_url + Drupal.settings.basePath + "go/foo' has been detected as internal link.");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isInternal('https://example.com/node/3'), "Link 'https://example.com/node/3' has been detected as external link.");
|
||||
console.groupEnd();
|
||||
|
||||
console.group("Test 'isInternalSpecial':");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isInternalSpecial(base_url + Drupal.settings.basePath + 'go/foo'), "Link '" + base_url + Drupal.settings.basePath + "go/foo' has been detected as special internal link.");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isInternalSpecial(base_url + Drupal.settings.basePath + 'node/1'), "Link '" + base_url + Drupal.settings.basePath + "node/1' has been detected as special internal link.");
|
||||
console.groupEnd();
|
||||
|
||||
console.group("Test 'getPageUrl':");
|
||||
Drupal.google_analytics.test.assertSame(base_path, Drupal.google_analytics.getPageUrl(window.location.href), "Absolute internal URL '" + base_path + "' has been extracted from full qualified url '" + window.location.href + "'.");
|
||||
Drupal.google_analytics.test.assertSame(base_path, Drupal.google_analytics.getPageUrl(base_path), "Absolute internal URL '" + base_path + "' has been extracted from absolute url '" + base_path + "'.");
|
||||
//Drupal.googleanalytics.test.assertSame(base_path, Drupal.googleanalytics.getPageUrl(base_url + Drupal.settings.basePath + 'node/1'), "Absolute internal URL '" + Drupal.settings.basePath + "node/1' has been extracted from full qualified url '" + base_url + base_path + "'.");
|
||||
//Drupal.googleanalytics.test.assertSame(base_path, Drupal.googleanalytics.getPageUrl(Drupal.settings.basePath + 'node/1'), "Absolute internal URL '" + Drupal.settings.basePath + "node/1' has been extracted from absolute url '" + base_path + "'.");
|
||||
Drupal.googleanalytics.test.assertSame('https://example.com/node/2', Drupal.googleanalytics.getPageUrl('https://example.com/node/2'), "Full qualified external url 'https://example.com/node/2' has been extracted.");
|
||||
Drupal.googleanalytics.test.assertSame('//example.com/node/2', Drupal.googleanalytics.getPageUrl('//example.com/node/2'), "Full qualified external url '//example.com/node/2' has been extracted.");
|
||||
console.groupEnd();
|
||||
|
||||
console.group("Test 'getDownloadExtension':");
|
||||
Drupal.googleanalytics.test.assertSame('zip', Drupal.googleanalytics.getDownloadExtension(base_url + Drupal.settings.basePath + '/files/foo1.zip'), "Download extension 'zip' has been found in '" + base_url + Drupal.settings.basePath + "files/foo1.zip'.");
|
||||
Drupal.googleanalytics.test.assertSame('zip', Drupal.googleanalytics.getDownloadExtension(base_url + Drupal.settings.basePath + '/files/foo1.zip#foo'), "Download extension 'zip' has been found in '" + base_url + Drupal.settings.basePath + "files/foo1.zip#foo'.");
|
||||
Drupal.googleanalytics.test.assertSame('zip', Drupal.googleanalytics.getDownloadExtension(base_url + Drupal.settings.basePath + '/files/foo1.zip?foo=bar'), "Download extension 'zip' has been found in '" + base_url + Drupal.settings.basePath + "files/foo1.zip?foo=bar'.");
|
||||
Drupal.googleanalytics.test.assertSame('zip', Drupal.googleanalytics.getDownloadExtension(base_url + Drupal.settings.basePath + '/files/foo1.zip?foo=bar#foo'), "Download extension 'zip' has been found in '" + base_url + Drupal.settings.basePath + "files/foo1.zip?foo=bar'.");
|
||||
Drupal.googleanalytics.test.assertSame('', Drupal.googleanalytics.getDownloadExtension(base_url + Drupal.settings.basePath + '/files/foo2.dddd'), "No download extension found in '" + base_url + Drupal.settings.basePath + "files/foo2.dddd'.");
|
||||
console.groupEnd();
|
||||
|
||||
// List of top-level domains: example.com, example.net
|
||||
console.group("Test 'isCrossDomain' (requires cross domain configuration with 'example.com' and 'example.net'):");
|
||||
if (Drupal.settings.googleanalytics.trackCrossDomains) {
|
||||
console.dir(Drupal.settings.googleanalytics.trackCrossDomains);
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isCrossDomain('example.com', Drupal.settings.googleanalytics.trackCrossDomains), "URL 'example.com' has been found in cross domain list.");
|
||||
Drupal.googleanalytics.test.assertTrue(Drupal.googleanalytics.isCrossDomain('example.net', Drupal.settings.googleanalytics.trackCrossDomains), "URL 'example.net' has been found in cross domain list.");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isCrossDomain('www.example.com', Drupal.settings.googleanalytics.trackCrossDomains), "URL 'www.example.com' not found in cross domain list.");
|
||||
Drupal.googleanalytics.test.assertFalse(Drupal.googleanalytics.isCrossDomain('www.example.net', Drupal.settings.googleanalytics.trackCrossDomains), "URL 'www.example.net' not found in cross domain list.");
|
||||
}
|
||||
else {
|
||||
console.warn('Cross domain tracking is not enabled. Tests skipped.');
|
||||
}
|
||||
console.groupEnd();
|
||||
|
||||
});
|
||||
|
||||
})(jQuery);
|
||||
@@ -13,10 +13,11 @@ function googleanalytics_variable_info($options) {
|
||||
'type' => 'string',
|
||||
'title' => t('Web Property ID', array(), $options),
|
||||
'default' => 'UA-',
|
||||
'description' => t('This ID is unique to each site you want to track separately, and is in the form of UA-xxxxxxx-yy. To get a Web Property ID, <a href="@analytics">register your site with Google Analytics</a>, or if you already have registered your site, go to your Google Analytics Settings page to see the ID next to every site profile. <a href="@webpropertyid">Find more information in the documentation</a>.', array('@analytics' => 'http://www.google.com/analytics/', '@webpropertyid' => url('https://developers.google.com/analytics/resources/concepts/gaConceptsAccounts', array('fragment' => 'webProperty'))), $options),
|
||||
'description' => t('This ID is unique to each site you want to track separately, and is in the form of UA-xxxxxxx-yy. To get a Web Property ID, <a href="@analytics">register your site with Google Analytics</a>, or if you already have registered your site, go to your Google Analytics Settings page to see the ID next to every site profile. <a href="@webpropertyid">Find more information in the documentation</a>.', array('@analytics' => 'https://marketingplatform.google.com/about/analytics/', '@webpropertyid' => url('https://developers.google.com/analytics/resources/concepts/gaConceptsAccounts', array('fragment' => 'webProperty'))), $options),
|
||||
'required' => TRUE,
|
||||
'group' => 'googleanalytics',
|
||||
'localize' => TRUE,
|
||||
'multidomain' => TRUE,
|
||||
'validate callback' => 'googleanalytics_validate_googleanalytics_account',
|
||||
);
|
||||
|
||||
@@ -39,12 +40,16 @@ function googleanalytics_variable_group_info() {
|
||||
|
||||
/**
|
||||
* Validate Web Property ID variable.
|
||||
*
|
||||
* @param array $variable
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function googleanalytics_validate_googleanalytics_account($variable) {
|
||||
// Replace all type of dashes (n-dash, m-dash, minus) with the normal dashes.
|
||||
$variable['value'] = str_replace(array('–', '—', '−'), '-', $variable['value']);
|
||||
|
||||
if (!preg_match('/^UA-\d{4,}-\d+$/', $variable['value'])) {
|
||||
if (!preg_match('/^UA-\d+-\d+$/', $variable['value'])) {
|
||||
return t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.');
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user