Upgrade custom variables from D6 to D7.
[project/google_analytics.git] / googleanalytics.install
index 3221754..b6e8a0e 100644 (file)
@@ -6,6 +6,9 @@
  * Installation file for Google Analytics module.
  */
 
+/**
+ * Implements hook_install().
+ */
 function googleanalytics_install() {
   variable_set('googleanalytics_visibility', 0);
 
@@ -29,8 +32,12 @@ function googleanalytics_install() {
   }
 }
 
+/**
+ * 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');
@@ -56,6 +63,8 @@ function googleanalytics_uninstall() {
 }
 
 /**
+ * Implements hook_disable().
+ *
  * Remove cache directory if module is disabled (or uninstalled).
  */
 function googleanalytics_disable() {
@@ -63,7 +72,7 @@ function googleanalytics_disable() {
 }
 
 /**
- * Implementation of hook_requirements().
+ * Implements hook_requirements().
  */
 function googleanalytics_requirements($phase) {
   $requirements = array();
@@ -119,7 +128,7 @@ function googleanalytics_update_6002() {
   $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;
       $messages[] = t('Enabled page tracking for role: @name.', array('@name' => $name));
@@ -135,14 +144,14 @@ 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');
     $messages[] = t('Disabled user specific page tracking for site administrator.');
   }
 
   // Delete outdated tracking settings.
   db_delete('variable')
-    ->condition('name', db_like('googleanalytics_track_') .'%', 'LIKE')
+    ->condition('name', db_like('googleanalytics_track_') . '%', 'LIKE')
     ->execute();
 
   return implode(', ', $messages);
@@ -246,7 +255,7 @@ function googleanalytics_update_6007() {
 function googleanalytics_update_6200() {
   $path = 'public://googleanalytics';
   if (file_exists($path)) {
-    file_unmanaged_delete($path .'/urchin.js');
+    file_unmanaged_delete($path . '/urchin.js');
   }
   variable_del('googleanalytics_legacy_version');
 
@@ -298,12 +307,22 @@ function googleanalytics_update_6300() {
 }
 
 /**
- * Update JavaScript scope to 'header'.
+ * 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 t('Google tracking code has been moved to header.');
+  return implode(' ', $messages);
 }
 
 /**
@@ -322,3 +341,29 @@ function googleanalytics_update_7001() {
     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!');
+  }
+}