danielebarchiesi@2: <?php
danielebarchiesi@2: 
danielebarchiesi@2: /*
danielebarchiesi@2:  * @file
danielebarchiesi@2:  * Drupal Module: GoogleAnalytics
danielebarchiesi@2:  * Adds the required Javascript to the bottom of all your Drupal pages
danielebarchiesi@2:  * to allow tracking by the Google Analytics statistics package.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @author: Alexander Hass <http://drupal.org/user/85918>
danielebarchiesi@2:  */
danielebarchiesi@2: 
danielebarchiesi@2: 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');
danielebarchiesi@2: 
danielebarchiesi@2: // Remove tracking from all administrative pages, see http://drupal.org/node/34970.
danielebarchiesi@2: define('GOOGLEANALYTICS_PAGES', "admin\nadmin/*\nbatch\nnode/add*\nnode/*/*\nuser/*/*");
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_help().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_help($path, $arg) {
danielebarchiesi@2:   switch ($path) {
danielebarchiesi@2:     case 'admin/config/system/googleanalytics':
danielebarchiesi@2:       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/'));
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_theme().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_theme() {
danielebarchiesi@2:   return array(
danielebarchiesi@2:     'googleanalytics_admin_custom_var_table' => array(
danielebarchiesi@2:       'render element' => 'form',
danielebarchiesi@2:     ),
danielebarchiesi@2:   );
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_permission().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_permission() {
danielebarchiesi@2:   return array(
danielebarchiesi@2:     'administer google analytics' => array(
danielebarchiesi@2:       'title' => t('Administer Google Analytics'),
danielebarchiesi@2:       'description' => t('Perform maintenance tasks for Google Analytics.'),
danielebarchiesi@2:     ),
danielebarchiesi@2:     'opt-in or out of tracking' => array(
danielebarchiesi@2:       'title' => t('Opt-in or out of tracking'),
danielebarchiesi@2:       'description' => t('Allow users to decide if tracking code will be added to pages or not.'),
danielebarchiesi@2:     ),
danielebarchiesi@2:     'use PHP for tracking visibility' => array(
danielebarchiesi@2:       'title' => t('Use PHP for tracking visibility'),
danielebarchiesi@2:       'description' => t('Enter PHP code in the field for tracking visibility settings.'),
danielebarchiesi@2:       'restrict access' => TRUE,
danielebarchiesi@2:     ),
danielebarchiesi@2:   );
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_menu().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_menu() {
danielebarchiesi@2:   $items['admin/config/system/googleanalytics'] = array(
danielebarchiesi@2:     'title' => 'Google Analytics',
danielebarchiesi@2:     'description' => 'Configure tracking behavior to get insights into your website traffic and marketing effectiveness.',
danielebarchiesi@2:     'page callback' => 'drupal_get_form',
danielebarchiesi@2:     'page arguments' => array('googleanalytics_admin_settings_form'),
danielebarchiesi@2:     'access arguments' => array('administer google analytics'),
danielebarchiesi@2:     'type' => MENU_NORMAL_ITEM,
danielebarchiesi@2:     'file' => 'googleanalytics.admin.inc',
danielebarchiesi@2:   );
danielebarchiesi@2: 
danielebarchiesi@2:   return $items;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_page_alter() to insert JavaScript to the appropriate scope/region of the page.
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_page_alter(&$page) {
danielebarchiesi@2:   global $user;
danielebarchiesi@2: 
danielebarchiesi@2:   $id = variable_get('googleanalytics_account', '');
danielebarchiesi@2: 
danielebarchiesi@2:   // Get page status code for visibility filtering.
danielebarchiesi@2:   $status = drupal_get_http_header('Status');
danielebarchiesi@2:   $trackable_status_codes = array(
danielebarchiesi@2:     '403 Forbidden',
danielebarchiesi@2:     '404 Not Found',
danielebarchiesi@2:   );
danielebarchiesi@2: 
danielebarchiesi@2:   // 1. Check if the GA account number has a value.
danielebarchiesi@2:   // 2. Track page views based on visibility value.
danielebarchiesi@2:   // 3. Check if we should track the currently active user's role.
danielebarchiesi@2:   // 4. Ignore pages visibility filter for 404 or 403 status codes.
danielebarchiesi@2:   if (!empty($id) && (_googleanalytics_visibility_pages() || in_array($status, $trackable_status_codes)) && _googleanalytics_visibility_user($user)) {
danielebarchiesi@2: 
danielebarchiesi@2:     // We allow different scopes. Default to 'header' but allow user to override if they really need to.
danielebarchiesi@2:     $scope = variable_get('googleanalytics_js_scope', 'header');
danielebarchiesi@2: 
danielebarchiesi@2:     if (variable_get('googleanalytics_trackadsense', FALSE)) {
danielebarchiesi@2:       // Custom tracking. Prepend before all other JavaScript.
danielebarchiesi@2:       drupal_add_js('window.google_analytics_uacct = ' . drupal_json_encode($id) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1));
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Add link tracking.
danielebarchiesi@2:     $link_settings = array();
danielebarchiesi@2:     if ($track_outbound = variable_get('googleanalytics_trackoutbound', 1)) {
danielebarchiesi@2:       $link_settings['trackOutbound'] = $track_outbound;
danielebarchiesi@2:     }
danielebarchiesi@2:     if ($track_mailto = variable_get('googleanalytics_trackmailto', 1)) {
danielebarchiesi@2:       $link_settings['trackMailto'] = $track_mailto;
danielebarchiesi@2:     }
danielebarchiesi@2:     if (($track_download = variable_get('googleanalytics_trackfiles', 1)) && ($trackfiles_extensions = variable_get('googleanalytics_trackfiles_extensions', GOOGLEANALYTICS_TRACKFILES_EXTENSIONS))) {
danielebarchiesi@2:       $link_settings['trackDownload'] = $track_download;
danielebarchiesi@2:       $link_settings['trackDownloadExtensions'] = $trackfiles_extensions;
danielebarchiesi@2:     }
danielebarchiesi@2:     if ($track_domain_mode = variable_get('googleanalytics_domain_mode', 0)) {
danielebarchiesi@2:       $link_settings['trackDomainMode'] = $track_domain_mode;
danielebarchiesi@2:     }
danielebarchiesi@2:     if ($track_cross_domains = variable_get('googleanalytics_cross_domains', '')) {
danielebarchiesi@2:       $link_settings['trackCrossDomains'] = preg_split('/(\r\n?|\n)/', $track_cross_domains);
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     if (!empty($link_settings)) {
danielebarchiesi@2:       drupal_add_js(array('googleanalytics' => $link_settings), 'setting');
danielebarchiesi@2:       drupal_add_js(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.js');
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Add messages tracking.
danielebarchiesi@2:     $message_events = '';
danielebarchiesi@2:     if ($message_types = variable_get('googleanalytics_trackmessages', array())) {
danielebarchiesi@2:       $message_types = array_values(array_filter($message_types));
danielebarchiesi@2:       $status_heading = array(
danielebarchiesi@2:         'status' => t('Status message'),
danielebarchiesi@2:         'warning' => t('Warning message'),
danielebarchiesi@2:         'error' => t('Error message'),
danielebarchiesi@2:       );
danielebarchiesi@2: 
danielebarchiesi@2:       foreach (drupal_get_messages(NULL, FALSE) as $type => $messages) {
danielebarchiesi@2:         // Track only the selected message types.
danielebarchiesi@2:         if (in_array($type, $message_types)) {
danielebarchiesi@2:           foreach ($messages as $message) {
danielebarchiesi@2:             $message_events .= '_gaq.push(["_trackEvent", ' . drupal_json_encode(t('Messages')) . ', ' . drupal_json_encode($status_heading[$type]) . ', ' . drupal_json_encode(strip_tags($message)) . ']);';
danielebarchiesi@2:           }
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Site search tracking support.
danielebarchiesi@2:     $url_custom = '';
danielebarchiesi@2:     if (module_exists('search') && variable_get('googleanalytics_site_search', FALSE) && arg(0) == 'search' && $keys = googleanalytics_search_get_keys()) {
danielebarchiesi@2:       $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'))));
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // If this node is a translation of another node, pass the original
danielebarchiesi@2:     // node instead.
danielebarchiesi@2:     if (module_exists('translation') && variable_get('googleanalytics_translation_set', 0)) {
danielebarchiesi@2:       // Check we have a node object, it supports translation, and its
danielebarchiesi@2:       // translated node ID (tnid) doesn't match its own node ID.
danielebarchiesi@2:       $node = menu_get_object();
danielebarchiesi@2:       if ($node && translation_supported_type($node->type) && !empty($node->tnid) && ($node->tnid != $node->nid)) {
danielebarchiesi@2:         $source_node = node_load($node->tnid);
danielebarchiesi@2:         $languages = language_list();
danielebarchiesi@2:         $url_custom = drupal_json_encode(url('node/' . $source_node->nid, array('language' => $languages[$source_node->language])));
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Track access denied (403) and file not found (404) pages.
danielebarchiesi@2:     if ($status == '403 Forbidden') {
danielebarchiesi@2:       // See http://www.google.com/support/analytics/bin/answer.py?answer=86927
danielebarchiesi@2:       $url_custom = '"/403.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
danielebarchiesi@2:     }
danielebarchiesi@2:     elseif ($status == '404 Not Found') {
danielebarchiesi@2:       $url_custom = '"/404.html?page=" + document.location.pathname + document.location.search + "&from=" + document.referrer';
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Add any custom code snippets if specified.
danielebarchiesi@2:     $codesnippet_before = variable_get('googleanalytics_codesnippet_before', '');
danielebarchiesi@2:     $codesnippet_after = variable_get('googleanalytics_codesnippet_after', '');
danielebarchiesi@2: 
danielebarchiesi@2:     // Add custom variables.
danielebarchiesi@2:     $googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
danielebarchiesi@2:     $custom_var = '';
danielebarchiesi@2:     for ($i = 1; $i < 6; $i++) {
danielebarchiesi@2:       $custom_var_name = !empty($googleanalytics_custom_vars['slots'][$i]['name']) ? $googleanalytics_custom_vars['slots'][$i]['name'] : '';
danielebarchiesi@2:       if (!empty($custom_var_name)) {
danielebarchiesi@2:         $custom_var_value = !empty($googleanalytics_custom_vars['slots'][$i]['value']) ? $googleanalytics_custom_vars['slots'][$i]['value'] : '';
danielebarchiesi@2:         $custom_var_scope = !empty($googleanalytics_custom_vars['slots'][$i]['scope']) ? $googleanalytics_custom_vars['slots'][$i]['scope'] : 3;
danielebarchiesi@2: 
danielebarchiesi@2:         $types = array();
danielebarchiesi@2:         $node = menu_get_object();
danielebarchiesi@2:         if (is_object($node)) {
danielebarchiesi@2:           $types += array('node' => $node);
danielebarchiesi@2:         }
danielebarchiesi@2:         $custom_var_name = token_replace($custom_var_name, $types, array('clear' => TRUE));
danielebarchiesi@2:         $custom_var_value = token_replace($custom_var_value, $types, array('clear' => TRUE));
danielebarchiesi@2: 
danielebarchiesi@2:         // Suppress empty custom names and/or variables.
danielebarchiesi@2:         if (!drupal_strlen(trim($custom_var_name)) || !drupal_strlen(trim($custom_var_value))) {
danielebarchiesi@2:           continue;
danielebarchiesi@2:         }
danielebarchiesi@2: 
danielebarchiesi@2:         // The length of the string used for the 'name' and the length of the
danielebarchiesi@2:         // string used for the 'value' must not exceed 128 bytes after url encoding.
danielebarchiesi@2:         $name_length = drupal_strlen(rawurlencode($custom_var_name));
danielebarchiesi@2:         $tmp_value = rawurlencode($custom_var_value);
danielebarchiesi@2:         $value_length = drupal_strlen($tmp_value);
danielebarchiesi@2:         if ($name_length + $value_length > 128) {
danielebarchiesi@2:           // Trim value and remove fragments of url encoding.
danielebarchiesi@2:           $tmp_value = rtrim(substr($tmp_value, 0, 127 - $name_length), '%0..9A..F');
danielebarchiesi@2:           $custom_var_value = urldecode($tmp_value);
danielebarchiesi@2:         }
danielebarchiesi@2: 
danielebarchiesi@2:         $custom_var_name = drupal_json_encode($custom_var_name);
danielebarchiesi@2:         $custom_var_value = drupal_json_encode($custom_var_value);
danielebarchiesi@2:         $custom_var .= "_gaq.push(['_setCustomVar', $i, $custom_var_name, $custom_var_value, $custom_var_scope]);";
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Build tracker code.
danielebarchiesi@2:     $script = 'var _gaq = _gaq || [];';
danielebarchiesi@2:     $script .= '_gaq.push(["_setAccount", ' . drupal_json_encode($id) . ']);';
danielebarchiesi@2:     if (variable_get('googleanalytics_tracker_anonymizeip', 0)) {
danielebarchiesi@2:       // FIXME: The Google API is currently broken and "_gat._anonymizeIp" is only
danielebarchiesi@2:       // a workaround until "_anonymizeIp" has been implemented/fixed.
danielebarchiesi@2:       $script .= '_gaq.push(["_gat._anonymizeIp"]);';
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Domain tracking type.
danielebarchiesi@2:     global $cookie_domain;
danielebarchiesi@2:     $domain_mode = variable_get('googleanalytics_domain_mode', 0);
danielebarchiesi@2: 
danielebarchiesi@2:     // Per RFC 2109, cookie domains must contain at least one dot other than the
danielebarchiesi@2:     // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
danielebarchiesi@2:     if ($domain_mode == 1 && count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
danielebarchiesi@2:       $script .= '_gaq.push(["_setDomainName", ' . drupal_json_encode($cookie_domain) . ']);';
danielebarchiesi@2:     }
danielebarchiesi@2:     elseif ($domain_mode == 2) {
danielebarchiesi@2:       $script .= '_gaq.push(["_setDomainName", "none"]);';
danielebarchiesi@2:       $script .= '_gaq.push(["_setAllowLinker", true]);';
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     if (!empty($custom_var)) {
danielebarchiesi@2:       $script .= $custom_var;
danielebarchiesi@2:     }
danielebarchiesi@2:     if (!empty($codesnippet_before)) {
danielebarchiesi@2:       $script .= $codesnippet_before;
danielebarchiesi@2:     }
danielebarchiesi@2:     if (empty($url_custom)) {
danielebarchiesi@2:       $script .= '_gaq.push(["_trackPageview"]);';
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       $script .= '_gaq.push(["_trackPageview", ' . $url_custom . ']);';
danielebarchiesi@2:     }
danielebarchiesi@2:     if (!empty($message_events)) {
danielebarchiesi@2:       $script .= $message_events;
danielebarchiesi@2:     }
danielebarchiesi@2:     if (!empty($codesnippet_after)) {
danielebarchiesi@2:       $script .= $codesnippet_after;
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     $script .= '(function() {';
danielebarchiesi@2:     $script .= 'var ga = document.createElement("script");';
danielebarchiesi@2:     $script .= 'ga.type = "text/javascript";';
danielebarchiesi@2:     $script .= 'ga.async = true;';
danielebarchiesi@2: 
danielebarchiesi@2:     // Which version of the tracking library should be used?
danielebarchiesi@2:     if ($trackdoubleclick = variable_get('googleanalytics_trackdoubleclick', FALSE)) {
danielebarchiesi@2:       $library_tracker_url = 'stats.g.doubleclick.net/dc.js';
danielebarchiesi@2:       $library_cache_url = 'http://' . $library_tracker_url;
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       $library_tracker_url = '.google-analytics.com/ga.js';
danielebarchiesi@2:       $library_cache_url = 'http://www' . $library_tracker_url;
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Should a local cached copy of ga.js be used?
danielebarchiesi@2:     if (variable_get('googleanalytics_cache', 0) && $url = _googleanalytics_cache($library_cache_url)) {
danielebarchiesi@2:       // A dummy query-string is added to filenames, to gain control over
danielebarchiesi@2:       // browser-caching. The string changes on every update or full cache
danielebarchiesi@2:       // flush, forcing browsers to load a new copy of the files, as the
danielebarchiesi@2:       // URL changed.
danielebarchiesi@2:       $query_string = '?' . variable_get('css_js_query_string', '0');
danielebarchiesi@2: 
danielebarchiesi@2:       $script .= 'ga.src = "' . $url . $query_string . '";';
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       // Library paths do not follow the same naming convention.
danielebarchiesi@2:       if ($trackdoubleclick) {
danielebarchiesi@2:         $script .= 'ga.src = ("https:" == document.location.protocol ? "https://" : "http://") + "' . $library_tracker_url . '";';
danielebarchiesi@2:       }
danielebarchiesi@2:       else {
danielebarchiesi@2:         $script .= 'ga.src = ("https:" == document.location.protocol ? "https://ssl" : "http://www") + "' . $library_tracker_url . '";';
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:     $script .= 'var s = document.getElementsByTagName("script")[0];';
danielebarchiesi@2:     $script .= 's.parentNode.insertBefore(ga, s);';
danielebarchiesi@2:     $script .= '})();';
danielebarchiesi@2: 
danielebarchiesi@2:     drupal_add_js($script, array('scope' => $scope, 'type' => 'inline'));
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_field_extra_fields().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_field_extra_fields() {
danielebarchiesi@2:   $extra['user']['user']['form']['googleanalytics'] = array(
danielebarchiesi@2:     'label' => t('Google Analytics configuration'),
danielebarchiesi@2:     'description' => t('Google Analytics module form element.'),
danielebarchiesi@2:     'weight' => 3,
danielebarchiesi@2:   );
danielebarchiesi@2: 
danielebarchiesi@2:   return $extra;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@2:  *
danielebarchiesi@2:  * Allow users to decide if tracking code will be added to pages or not.
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_form_user_profile_form_alter(&$form, &$form_state) {
danielebarchiesi@2:   $account = $form['#user'];
danielebarchiesi@2:   $category = $form['#user_category'];
danielebarchiesi@2: 
danielebarchiesi@2:   if ($category == 'account' && user_access('opt-in or out of tracking') && ($custom = variable_get('googleanalytics_custom', 0)) != 0 && _googleanalytics_visibility_roles($account)) {
danielebarchiesi@2:     $form['googleanalytics'] = array(
danielebarchiesi@2:       '#type' => 'fieldset',
danielebarchiesi@2:       '#title' => t('Google Analytics configuration'),
danielebarchiesi@2:       '#weight' => 3,
danielebarchiesi@2:       '#collapsible' => TRUE,
danielebarchiesi@2:       '#tree' => TRUE
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     switch ($custom) {
danielebarchiesi@2:       case 1:
danielebarchiesi@2:         $description = t('Users are tracked by default, but you are able to opt out.');
danielebarchiesi@2:         break;
danielebarchiesi@2: 
danielebarchiesi@2:       case 2:
danielebarchiesi@2:         $description = t('Users are <em>not</em> tracked by default, but you are able to opt in.');
danielebarchiesi@2:         break;
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     // Disable tracking for visitors who have opted out from tracking via DNT (Do-Not-Track) header.
danielebarchiesi@2:     $disabled = FALSE;
danielebarchiesi@2:     if (variable_get('googleanalytics_privacy_donottrack', 1) && !empty($_SERVER['HTTP_DNT'])) {
danielebarchiesi@2:       $disabled = TRUE;
danielebarchiesi@2: 
danielebarchiesi@2:       // Override settings value.
danielebarchiesi@2:       $account->data['googleanalytics']['custom'] = FALSE;
danielebarchiesi@2: 
danielebarchiesi@2:       $description .= '<span class="admin-disabled">';
danielebarchiesi@2:       $description .= ' ' . t('You have opted out from tracking via browser privacy settings.');
danielebarchiesi@2:       $description .= '</span>';
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:     $form['googleanalytics']['custom'] = array(
danielebarchiesi@2:       '#type' => 'checkbox',
danielebarchiesi@2:       '#title' => t('Enable user tracking'),
danielebarchiesi@2:       '#description' => $description,
danielebarchiesi@2:       '#default_value' => isset($account->data['googleanalytics']['custom']) ? $account->data['googleanalytics']['custom'] : ($custom == 1),
danielebarchiesi@2:       '#disabled' => $disabled,
danielebarchiesi@2:     );
danielebarchiesi@2: 
danielebarchiesi@2:     return $form;
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_user_presave().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_user_presave(&$edit, $account, $category) {
danielebarchiesi@2:   if (isset($edit['googleanalytics']['custom'])) {
danielebarchiesi@2:     $edit['data']['googleanalytics']['custom'] = $edit['googleanalytics']['custom'];
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_cron().
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_cron() {
danielebarchiesi@2:   // Regenerate the tracking code file every day.
danielebarchiesi@2:   if (REQUEST_TIME - variable_get('googleanalytics_last_cache', 0) >= 86400 && variable_get('googleanalytics_cache', 0)) {
danielebarchiesi@2:     // Which version of the tracking library should be used?
danielebarchiesi@2:     if (variable_get('googleanalytics_trackdoubleclick', FALSE)) {
danielebarchiesi@2:       _googleanalytics_cache('http://stats.g.doubleclick.net/dc.js', TRUE);
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       _googleanalytics_cache('http://www.google-analytics.com/ga.js', TRUE);
danielebarchiesi@2:     }
danielebarchiesi@2:     variable_set('googleanalytics_last_cache', REQUEST_TIME);
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Implements hook_preprocess_search_results().
danielebarchiesi@2:  *
danielebarchiesi@2:  * Collects and adds the number of search results to the head.
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_preprocess_search_results(&$variables) {
danielebarchiesi@2:   // There is no search result $variable available that hold the number of items
danielebarchiesi@2:   // found. But the pager item mumber can tell the number of search results.
danielebarchiesi@2:   global $pager_total_items;
danielebarchiesi@2: 
danielebarchiesi@2:   drupal_add_js('window.googleanalytics_search_results = ' . intval($pager_total_items[0]) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1));
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Helper function for grabbing search keys. Function is missing in D7.
danielebarchiesi@2:  *
danielebarchiesi@2:  * http://api.drupal.org/api/function/search_get_keys/6
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_search_get_keys() {
danielebarchiesi@2:   static $return;
danielebarchiesi@2:   if (!isset($return)) {
danielebarchiesi@2:     // Extract keys as remainder of path
danielebarchiesi@2:     // Note: support old GET format of searches for existing links.
danielebarchiesi@2:     $path = explode('/', $_GET['q'], 3);
danielebarchiesi@2:     $keys = empty($_REQUEST['keys']) ? '' : $_REQUEST['keys'];
danielebarchiesi@2:     $return = count($path) == 3 ? $path[2] : $keys;
danielebarchiesi@2:   }
danielebarchiesi@2:   return $return;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Download/Synchronize/Cache tracking code file locally.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @param $location
danielebarchiesi@2:  *   The full URL to the external javascript file.
danielebarchiesi@2:  * @param $sync_cached_file
danielebarchiesi@2:  *   Synchronize tracking code and update if remote file have changed.
danielebarchiesi@2:  * @return mixed
danielebarchiesi@2:  *   The path to the local javascript file on success, boolean FALSE on failure.
danielebarchiesi@2:  */
danielebarchiesi@2: function _googleanalytics_cache($location, $sync_cached_file = FALSE) {
danielebarchiesi@2:   $path = 'public://googleanalytics';
danielebarchiesi@2:   $file_destination = $path . '/' . basename($location);
danielebarchiesi@2: 
danielebarchiesi@2:   if (!file_exists($file_destination) || $sync_cached_file) {
danielebarchiesi@2:     // Download the latest tracking code.
danielebarchiesi@2:     $result = drupal_http_request($location);
danielebarchiesi@2: 
danielebarchiesi@2:     if ($result->code == 200) {
danielebarchiesi@2:       if (file_exists($file_destination)) {
danielebarchiesi@2:         // Synchronize tracking code and and replace local file if outdated.
danielebarchiesi@2:         $data_hash_local = drupal_hash_base64(file_get_contents($file_destination));
danielebarchiesi@2:         $data_hash_remote = drupal_hash_base64($result->data);
danielebarchiesi@2:         // Check that the files directory is writable.
danielebarchiesi@2:         if ($data_hash_local != $data_hash_remote && file_prepare_directory($path)) {
danielebarchiesi@2:           // Save updated tracking code file to disk.
danielebarchiesi@2:           file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
danielebarchiesi@2:           watchdog('googleanalytics', 'Locally cached tracking code file has been updated.', array(), WATCHDOG_INFO);
danielebarchiesi@2: 
danielebarchiesi@2:           // Change query-strings on css/js files to enforce reload for all users.
danielebarchiesi@2:           _drupal_flush_css_js();
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:       else {
danielebarchiesi@2:         // Check that the files directory is writable.
danielebarchiesi@2:         if (file_prepare_directory($path, FILE_CREATE_DIRECTORY)) {
danielebarchiesi@2:           // There is no need to flush JS here as core refreshes JS caches
danielebarchiesi@2:           // automatically, if new files are added.
danielebarchiesi@2:           file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
danielebarchiesi@2:           watchdog('googleanalytics', 'Locally cached tracking code file has been saved.', array(), WATCHDOG_INFO);
danielebarchiesi@2: 
danielebarchiesi@2:           // Return the local JS file path.
danielebarchiesi@2:           return file_create_url($file_destination);
danielebarchiesi@2:         }
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:   }
danielebarchiesi@2:   else {
danielebarchiesi@2:     // Return the local JS file path.
danielebarchiesi@2:     return file_create_url($file_destination);
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Delete cached files and directory.
danielebarchiesi@2:  */
danielebarchiesi@2: function googleanalytics_clear_js_cache() {
danielebarchiesi@2:   $path = 'public://googleanalytics';
danielebarchiesi@2:   if (file_prepare_directory($path)) {
danielebarchiesi@2:     file_scan_directory($path, '/.*/', array('callback' => 'file_unmanaged_delete'));
danielebarchiesi@2:     drupal_rmdir($path);
danielebarchiesi@2: 
danielebarchiesi@2:     // Change query-strings on css/js files to enforce reload for all users.
danielebarchiesi@2:     _drupal_flush_css_js();
danielebarchiesi@2: 
danielebarchiesi@2:     watchdog('googleanalytics', 'Local cache has been purged.', array(), WATCHDOG_INFO);
danielebarchiesi@2:   }
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Tracking visibility check for an user object.
danielebarchiesi@2:  *
danielebarchiesi@2:  * @param $account
danielebarchiesi@2:  *   A user object containing an array of roles to check.
danielebarchiesi@2:  * @return boolean
danielebarchiesi@2:  *   A decision on if the current user is being tracked by Google Analytics.
danielebarchiesi@2:  */
danielebarchiesi@2: function _googleanalytics_visibility_user($account) {
danielebarchiesi@2: 
danielebarchiesi@2:   $enabled = FALSE;
danielebarchiesi@2: 
danielebarchiesi@2:   // Is current user a member of a role that should be tracked?
danielebarchiesi@2:   if (_googleanalytics_visibility_header($account) && _googleanalytics_visibility_roles($account)) {
danielebarchiesi@2: 
danielebarchiesi@2:     // Use the user's block visibility setting, if necessary.
danielebarchiesi@2:     if (($custom = variable_get('googleanalytics_custom', 0)) != 0) {
danielebarchiesi@2:       if ($account->uid && isset($account->data['googleanalytics']['custom'])) {
danielebarchiesi@2:         $enabled = $account->data['googleanalytics']['custom'];
danielebarchiesi@2:       }
danielebarchiesi@2:       else {
danielebarchiesi@2:         $enabled = ($custom == 1);
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       $enabled = TRUE;
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   return $enabled;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Based on visibility setting this function returns TRUE if GA code should
danielebarchiesi@2:  * be added for the current role and otherwise FALSE.
danielebarchiesi@2:  */
danielebarchiesi@2: function _googleanalytics_visibility_roles($account) {
danielebarchiesi@2: 
danielebarchiesi@2:   $visibility = variable_get('googleanalytics_visibility_roles', 0);
danielebarchiesi@2:   $enabled = $visibility;
danielebarchiesi@2:   $roles = variable_get('googleanalytics_roles', array());
danielebarchiesi@2: 
danielebarchiesi@2:   if (array_sum($roles) > 0) {
danielebarchiesi@2:     // One or more roles are selected.
danielebarchiesi@2:     foreach (array_keys($account->roles) as $rid) {
danielebarchiesi@2:       // Is the current user a member of one of these roles?
danielebarchiesi@2:       if (isset($roles[$rid]) && $rid == $roles[$rid]) {
danielebarchiesi@2:         // Current user is a member of a role that should be tracked/excluded from tracking.
danielebarchiesi@2:         $enabled = !$visibility;
danielebarchiesi@2:         break;
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:   }
danielebarchiesi@2:   else {
danielebarchiesi@2:     // No role is selected for tracking, therefore all roles should be tracked.
danielebarchiesi@2:     $enabled = TRUE;
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   return $enabled;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Based on visibility setting this function returns TRUE if GA code should
danielebarchiesi@2:  * be added to the current page and otherwise FALSE.
danielebarchiesi@2:  */
danielebarchiesi@2: function _googleanalytics_visibility_pages() {
danielebarchiesi@2:   static $page_match;
danielebarchiesi@2: 
danielebarchiesi@2:   // Cache visibility result if function is called more than once.
danielebarchiesi@2:   if (!isset($page_match)) {
danielebarchiesi@2: 
danielebarchiesi@2:     $visibility = variable_get('googleanalytics_visibility_pages', 0);
danielebarchiesi@2:     $setting_pages = variable_get('googleanalytics_pages', GOOGLEANALYTICS_PAGES);
danielebarchiesi@2: 
danielebarchiesi@2:     // Match path if necessary.
danielebarchiesi@2:     if (!empty($setting_pages)) {
danielebarchiesi@2:       // Convert path to lowercase. This allows comparison of the same path
danielebarchiesi@2:       // with different case. Ex: /Page, /page, /PAGE.
danielebarchiesi@2:       $pages = drupal_strtolower($setting_pages);
danielebarchiesi@2:       if ($visibility < 2) {
danielebarchiesi@2:         // Convert the Drupal path to lowercase
danielebarchiesi@2:         $path = drupal_strtolower(drupal_get_path_alias($_GET['q']));
danielebarchiesi@2:         // Compare the lowercase internal and lowercase path alias (if any).
danielebarchiesi@2:         $page_match = drupal_match_path($path, $pages);
danielebarchiesi@2:         if ($path != $_GET['q']) {
danielebarchiesi@2:           $page_match = $page_match || drupal_match_path($_GET['q'], $pages);
danielebarchiesi@2:         }
danielebarchiesi@2:         // When $visibility has a value of 0, the tracking code is displayed on
danielebarchiesi@2:         // all pages except those listed in $pages. When set to 1, it
danielebarchiesi@2:         // is displayed only on those pages listed in $pages.
danielebarchiesi@2:         $page_match = !($visibility xor $page_match);
danielebarchiesi@2:       }
danielebarchiesi@2:       elseif (module_exists('php')) {
danielebarchiesi@2:         $page_match = php_eval($setting_pages);
danielebarchiesi@2:       }
danielebarchiesi@2:       else {
danielebarchiesi@2:         $page_match = FALSE;
danielebarchiesi@2:       }
danielebarchiesi@2:     }
danielebarchiesi@2:     else {
danielebarchiesi@2:       $page_match = TRUE;
danielebarchiesi@2:     }
danielebarchiesi@2: 
danielebarchiesi@2:   }
danielebarchiesi@2:   return $page_match;
danielebarchiesi@2: }
danielebarchiesi@2: 
danielebarchiesi@2: /**
danielebarchiesi@2:  * Based on headers send by clients this function returns TRUE if GA code should
danielebarchiesi@2:  * be added to the current page and otherwise FALSE.
danielebarchiesi@2:  */
danielebarchiesi@2: function _googleanalytics_visibility_header($account) {
danielebarchiesi@2: 
danielebarchiesi@2:   if (($account->uid || variable_get('cache', 0) == 0) && variable_get('googleanalytics_privacy_donottrack', 1) && !empty($_SERVER['HTTP_DNT'])) {
danielebarchiesi@2:     // Disable tracking if caching is disabled or a visitors is logged in and
danielebarchiesi@2:     // have opted out from tracking via DNT (Do-Not-Track) header.
danielebarchiesi@2:     return FALSE;
danielebarchiesi@2:   }
danielebarchiesi@2: 
danielebarchiesi@2:   return TRUE;
danielebarchiesi@2: }