Upgrade custom variables from D6 to D7.
[project/google_analytics.git] / googleanalytics.install
index 7d6c1c9..b6e8a0e 100644 (file)
@@ -6,6 +6,9 @@
  * Installation file for Google Analytics module.
  */
 
+/**
+ * Implements hook_install().
+ */
 function googleanalytics_install() {
   variable_set('googleanalytics_visibility', 0);
 
@@ -18,10 +21,23 @@ function googleanalytics_install() {
     'node/*/*',
   );
   variable_set('googleanalytics_pages', implode("\n", $pages));
+
+  // 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_custom_vars');
   variable_del('googleanalytics_codesnippet_before');
   variable_del('googleanalytics_codesnippet_after');
   variable_del('googleanalytics_segmentation');
@@ -38,37 +54,57 @@ function googleanalytics_uninstall() {
   variable_del('googleanalytics_roles');
   variable_del('googleanalytics_visibility');
   variable_del('googleanalytics_pages');
+  variable_del('googleanalytics_tracker_anonymizeip');
   variable_del('googleanalytics_translation_set');
+
+  // Remove backup variables if exits. Remove this code in D8.
+  variable_del('googleanalytics_codesnippet_before_backup_6300');
+  variable_del('googleanalytics_codesnippet_after_backup_6300');
 }
 
 /**
+ * Implements hook_disable().
+ *
  * Remove cache directory if module is disabled (or uninstalled).
  */
 function googleanalytics_disable() {
-  $path = 'public://googleanalytics';
-  if (file_exists($path)) {
-    file_unmanaged_delete($path . '/ga.js');
-    rmdir($path);
+  googleanalytics_clear_js_cache();
+}
+
+/**
+ * Implements hook_requirements().
+ */
+function googleanalytics_requirements($phase) {
+  $requirements = array();
+  $t = get_t();
+
+  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(
+        '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_ERROR,
+        'value' => $t('Not configured'),
+      );
+    }
   }
+
+  return $requirements;
 }
 
 /**
  * Upgrade old extension variable to new and use old name as enabled/disabled flag.
  */
 function googleanalytics_update_6000() {
-  $ret = array();
-
   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'));
   $trackfiles = 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') ? TRUE : FALSE;
   variable_set('googleanalytics_trackfiles', $trackfiles);
-  $ret[] = array('success' => TRUE, 'query' => 'Updated download tracking settings.');
 
-  return $ret;
+  return t('Updated download tracking file extensions.');
 }
 
 function googleanalytics_update_6001() {
-  $ret = array();
-
   variable_set('googleanalytics_visibility', 0);
 
   // Remove tracking from all administrative pages, see http://drupal.org/node/34970.
@@ -79,9 +115,8 @@ function googleanalytics_update_6001() {
     'node/*/*',
   );
   variable_set('googleanalytics_pages', implode("\n", $pages));
-  $ret[] = array('success' => TRUE, 'query' => 'Added page tracking to every page except the listed pages: '. implode(', ', $pages));
 
-  return $ret;
+  return t('Added page tracking to every page except the listed pages: @pages.', array('@pages' => implode(', ', $pages)));
 }
 
 /**
@@ -89,18 +124,17 @@ function googleanalytics_update_6001() {
  * of "User 1" and remove outdated tracking variables.
  */
 function googleanalytics_update_6002() {
-  $ret = array();
-
   // 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) {
-    if (variable_get('googleanalytics_track_'. $rid, FALSE)) {
+    if (variable_get('googleanalytics_track_' . $rid, FALSE)) {
       // Role ID is activated for user tracking.
       $roles[$rid] = $rid;
-      $ret[] = array('success' => TRUE, 'query' => 'Enabled page tracking for role: ' . $name);
+      $messages[] = t('Enabled page tracking for role: @name.', array('@name' => $name));
     }
     else {
-      $ret[] = array('success' => TRUE, 'query' => 'Disabled page tracking for role: ' . $name);
+      $messages[] = t('Disabled page tracking for role: @name.', array('@name' => $name));
     }
   }
   variable_set('googleanalytics_roles', $roles);
@@ -110,33 +144,32 @@ function googleanalytics_update_6002() {
     variable_set('googleanalytics_custom', 1);
 
     // Load user 1 object, set appropiate value and save new user settings back.
-    $account = user_load(array('uid' => 1));
+    $account = user_load(1);
     $account = user_save($account, array('googleanalytics' => array('custom' => 0)), 'account');
-    $ret[] = array('success' => TRUE, 'query' => 'Disabled user specific page tracking for website administrator.');
+    $messages[] = t('Disabled user specific page tracking for site administrator.');
   }
 
   // Delete outdated tracking settings.
-  $ret[] = update_sql("DELETE FROM {variable} WHERE name LIKE 'googleanalytics_track_%'");
+  db_delete('variable')
+    ->condition('name', db_like('googleanalytics_track_') . '%', 'LIKE')
+    ->execute();
 
-  return $ret;
+  return implode(', ', $messages);
 }
 
 /**
  * #262468: Clear menu cache to solve stale menu data in 5.x-1.5 and 6.x-1.1
  */
 function googleanalytics_update_6003() {
-  $ret = array();
   menu_rebuild();
-  return $ret;
+  return t('Menu has been rebuild.');
 }
 
 /**
  * Change visibility setting for path "user/*".
  */
 function googleanalytics_update_6004() {
-  $ret = array();
-
-  // Orginal pages setting.
+  // Original pages setting.
   $pages = array(
     'admin*',
     'user*',
@@ -154,22 +187,18 @@ function googleanalytics_update_6004() {
       'node/*/*',
     );
     variable_set('googleanalytics_pages', implode("\n", $pages));
-    $ret[] = array('success' => TRUE, 'query' => 'Path visibility filter setting changed from "user*" to "user/*/*".');
+    return t('Path visibility filter setting changed from "user*" to "user/*/*".');
   }
   else {
-    $ret[] = array('success' => TRUE, 'query' => 'Custom path visibility filter setting found. Update skipped!');
+    return t('Custom path visibility filter setting found. Update skipped!');
   }
-
-  return $ret;
 }
 
 /**
  * Change visibility setting for path "admin*".
  */
 function googleanalytics_update_6005() {
-  $ret = array();
-
-  // Orginal pages setting.
+  // Original pages setting.
   $pages = array(
     'admin*',
     'user/*/*',
@@ -188,26 +217,21 @@ function googleanalytics_update_6005() {
       'node/*/*',
     );
     variable_set('googleanalytics_pages', implode("\n", $pages));
-    $ret[] = array('success' => TRUE, 'query' => 'Path visibility filter setting changed from "admin*" to "admin" and "admin/*".');
+    return t('Path visibility filter setting changed from "admin*" to "admin" and "admin/*".');
   }
   else {
-    $ret[] = array('success' => TRUE, 'query' => 'Custom path visibility filter setting found. Update skipped!');
+    return t('Custom path visibility filter setting found. Update skipped!');
   }
-
-  return $ret;
 }
 
 /**
  * Upgrade custom javascript settings.
  */
 function googleanalytics_update_6006() {
-  $ret = array();
-
   variable_set('googleanalytics_codesnippet_before', variable_get('googleanalytics_codesnippet', ''));
   variable_del('googleanalytics_codesnippet');
-  $ret[] = array('success' => TRUE, 'query' => 'Upgraded custom javascript codesnippet setting.');
 
-  return $ret;
+  return t('Upgraded custom javascript codesnippet setting.');
 }
 
 /**
@@ -217,44 +241,129 @@ function googleanalytics_update_6006() {
  * terms of use section 8.1 (http://www.google.com/analytics/en-GB/tos.html).
  */
 function googleanalytics_update_6007() {
-  $ret = array();
-
   $profile_fields = variable_get('googleanalytics_segmentation', array());
   unset($profile_fields['uid']);
   unset($profile_fields['name']);
   variable_set('googleanalytics_segmentation', $profile_fields);
-  $ret[] = array('success' => TRUE, 'query' => 'Removed "User identifier" and "User name" from segmentation fields.');
 
-  return $ret;
+  return t('Removed "User identifier" and "User name" from segmentation fields.');
 }
 
 /**
  * Remove outdated legacy support variables and files.
  */
 function googleanalytics_update_6200() {
-  $ret = array();
-
   $path = 'public://googleanalytics';
   if (file_exists($path)) {
-    file_unmanaged_delete($path .'/urchin.js');
+    file_unmanaged_delete($path . '/urchin.js');
   }
   variable_del('googleanalytics_legacy_version');
 
-  $ret[] = array('success' => TRUE, 'query' => 'Removed legacy support.');
-
-  return $ret;
+  return t('Removed outdated legacy tracker stuff.');
 }
 
 /**
  * Update list of default file extensions.
  */
 function googleanalytics_update_6201() {
-  $ret = array();
-
   if (variable_get('googleanalytics_trackfiles_extensions', '') == '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') {
     variable_set('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');
   }
-  $ret[] = array('success' => TRUE, 'query' => 'The default extensions for download tracking have been updated.');
 
-  return $ret;
+  return t('The default extensions for download tracking have been updated.');
+}
+
+/**
+ * Try to update Google Analytics custom code snippet to async version.
+ */
+function googleanalytics_update_6300() {
+  // TODO: Backup synchronous code snippets. Remove variables in D8.
+  variable_set('googleanalytics_codesnippet_before_backup_6300', variable_get('googleanalytics_codesnippet_before', ''));
+  variable_set('googleanalytics_codesnippet_after_backup_6300', variable_get('googleanalytics_codesnippet_after', ''));
+
+  // Upgrade of BEFORE code snippet.
+  $code_before = variable_get('googleanalytics_codesnippet_before', '');
+  if (!empty($code_before)) {
+    // No value, e.g. _setLocalRemoteServerMode()
+    $code_before = preg_replace('/(.*)pageTracker\.(\w+)\(\);(.*)/i', '$1_gaq.push(["$2"]);$3', $code_before);
+    // One value, e.g. _setCookiePath()
+    $code_before = preg_replace('/(.*)pageTracker\.(\w+)\(("|\'?)(\w+)("|\'?)\);(.*)/i', '$1_gaq.push(["$2", $3$4$5]);$6', $code_before);
+    // Multiple values e.g. _trackEvent()
+    $code_before = preg_replace('/(.*)pageTracker\.(\w+)\((.*)\);(.*)/i', '$1_gaq.push(["$2", $3]);$4', $code_before);
+
+    variable_set('googleanalytics_codesnippet_before', $code_before);
+
+    drupal_set_message(Database::getConnection()->prefixTables("<strong>Attempted</strong> to upgrade Google Analytics custom 'before' code snippet. Backup of previous code snippet has been saved in database table '{variable}' as 'googleanalytics_codesnippet_before_backup_6300'. Please consult Google's <a href='http://code.google.com/intl/de-DE/apis/analytics/docs/tracking/asyncUsageGuide.html'>Asynchronous Tracking Usage Guide</a> if the upgrade was successfully."), 'warning');
+    return 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.
+  $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');
+    return t('Skipped custom "after" code snippet.');
+  }
+}
+
+/**
+ * Run D6 -> D7 upgrades.
+ */
+function googleanalytics_update_7000() {
+  // Update JavaScript scope to 'header'.
+  variable_set('googleanalytics_js_scope', 'header');
+  $messages[] = t('Google tracking code has been moved to header.');
+
+  // Upgrade D6 token placeholder to D7. update_6301 is not required.
+  $googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
+  if (!empty($googleanalytics_custom_vars['slots'][1]) && $googleanalytics_custom_vars['slots'][1]['name'] == 'User roles' && $googleanalytics_custom_vars['slots'][1]['value'] = '[roles]') {
+    $googleanalytics_custom_vars['slots'][1]['value'] = '[current-user:roles]';
+    variable_set('googleanalytics_custom_var', $googleanalytics_custom_vars);
+    $messages[] = t("The token placeholder [roles] used in the custom variable 'User roles' has been replaced with [current-user:roles].");
+  }
+
+  return implode(' ', $messages);
+}
+
+/**
+ * Automatically enable anonymizing of IP addresses for Germany.
+ */
+function googleanalytics_update_7001() {
+  // By German law it's always best to enable the anonymizing of IP addresses.
+  $countries = array(
+    'DE',
+  );
+  if (in_array(variable_get('site_default_country', ''), $countries)) {
+    variable_set('googleanalytics_tracker_anonymizeip', 1);
+    return t('The default country in your regional settings is Germany. Anonymizing of IP addresses has been enabled for privacy reasons.');
+  }
+  else {
+    return t('The default country in your regional settings is <em>not</em> Germany. The anonymizing of IP addresses setting has not been changed. Make sure your site settings comply with the local privacy rules.');
+  }
+}
+
+/**
+ * Upgrade "User roles" tracking to custom variables.
+ */
+function googleanalytics_update_7002() {
+
+  // Read previous segmentation settings.
+  $segmentation = variable_get('googleanalytics_segmentation', array());
+
+  // If this is an upgrade from D6 the slot 1 may not empty.
+  if (empty($googleanalytics_custom_vars['slots'][1]) && in_array('roles', $segmentation)) {
+    // Upgrade previous segmentation settings to new custom variables settings.
+    $googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
+
+    $googleanalytics_custom_vars['slots'][1]['slot'] = 1;
+    $googleanalytics_custom_vars['slots'][1]['name'] = 'User roles';
+    $googleanalytics_custom_vars['slots'][1]['value'] = '[current-user:roles]';
+    $googleanalytics_custom_vars['slots'][1]['scope'] = 1; // Sets the scope to visitor-level.
+
+    variable_set('googleanalytics_custom_var', $googleanalytics_custom_vars);
+    return t('The deprecated profile segmentation setting for "User roles" has been upgraded to custom variables. You need to upgrade other profile fields manually or you may loose tracking data in future!');
+  }
+  else {
+    return t('You need to upgrade the deprecated profile segmentation settings to custom variables manually or you may loose tracking data in future!');
+  }
 }