modules/google_analytics/googleanalytics.install

<?php
// $Id: googleanalytics.install,v 1.12 2009/08/22 11:57:24 hass Exp $

/**
 * @file
 * Installation file for Google Analytics module.
 */

function googleanalytics_install() {
  variable_set('googleanalytics_visibility', 0);

  // Remove tracking from all administrative pages, see http://drupal.org/node/34970.
  $pages = array(
    'admin',
    'admin/*',
    'user/*/*',
    'node/add*',
    'node/*/*',
  );
  variable_set('googleanalytics_pages', implode("\n", $pages));
}

function googleanalytics_uninstall() {
  variable_del('googleanalytics_account');
  variable_del('googleanalytics_codesnippet_before');
  variable_del('googleanalytics_codesnippet_after');
  variable_del('googleanalytics_segmentation');
  variable_del('googleanalytics_trackoutgoing');
  variable_del('googleanalytics_trackmailto');
  variable_del('googleanalytics_trackfiles');
  variable_del('googleanalytics_trackfiles_extensions');
  variable_del('googleanalytics_cache');
  variable_del('googleanalytics_last_cache');
  variable_del('googleanalytics_site_search');
  variable_del('googleanalytics_trackadsense');
  variable_del('googleanalytics_js_scope');
  variable_del('googleanalytics_custom');
  variable_del('googleanalytics_roles');
  variable_del('googleanalytics_visibility');
  variable_del('googleanalytics_pages');
  variable_del('googleanalytics_translation_set');
}

/**
 * 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);
  }
}

/**
 * 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;
}

function googleanalytics_update_6001() {
  $ret = array();

  variable_set('googleanalytics_visibility', 0);

  // Remove tracking from all administrative pages, see http://drupal.org/node/34970.
  $pages = array(
    'admin*',
    'user*',
    'node/add*',
    '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;
}

/**
 * Upgrade role settings and per user tracking settings
 * 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();
  foreach (user_roles() as $rid => $name) {
    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);
    }
    else {
      $ret[] = array('success' => TRUE, 'query' => 'Disabled page tracking for role: ' . $name);
    }
  }
  variable_set('googleanalytics_roles', $roles);

  // Upgrade disabled tracking of "user 1" to new logic.
  if (!$track_user1 = variable_get('googleanalytics_track__user1', 1)) {
    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_save($account, array('googleanalytics' => array('custom' => 0)), 'account');
    $ret[] = array('success' => TRUE, 'query' => 'Disabled user specific page tracking for website administrator.');
  }

  // Delete outdated tracking settings.
  $ret[] = update_sql("DELETE FROM {variable} WHERE name LIKE 'googleanalytics_track_%'");

  return $ret;
}

/**
 * #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;
}

/**
 * Change visibility setting for path "user/*".
 */
function googleanalytics_update_6004() {
  $ret = array();

  // Orginal pages setting.
  $pages = array(
    'admin*',
    'user*',
    'node/add*',
    'node/*/*',
  );

  $diff = array_diff($pages, preg_split('/(\r\n?|\n)/', variable_get('googleanalytics_pages', implode("\n", $pages))));
  if (empty($diff)) {
    // No diff to original settings found. Update with new settings.
    $pages = array(
      'admin*',
      'user/*/*',
      'node/add*',
      'node/*/*',
    );
    variable_set('googleanalytics_pages', implode("\n", $pages));
    $ret[] = array('success' => TRUE, 'query' => 'Path visibility filter setting changed from "user*" to "user/*/*".');
  }
  else {
    $ret[] = array('success' => TRUE, 'query' => '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.
  $pages = array(
    'admin*',
    'user/*/*',
    'node/add*',
    'node/*/*',
  );

  $diff = array_diff($pages, preg_split('/(\r\n?|\n)/', variable_get('googleanalytics_pages', implode("\n", $pages))));
  if (empty($diff)) {
    // No diff to original settings found. Update with new settings.
    $pages = array(
      'admin',
      'admin/*',
      'user/*/*',
      'node/add*',
      'node/*/*',
    );
    variable_set('googleanalytics_pages', implode("\n", $pages));
    $ret[] = array('success' => TRUE, 'query' => '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 $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;
}

/**
 * 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).
 */
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;
}

/**
 * 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');
  }
  variable_del('googleanalytics_legacy_version');

  $ret[] = array('success' => TRUE, 'query' => 'Removed legacy support.');

  return $ret;
}

/**
 * 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;
}
1	<?php
2	// $Id: googleanalytics.install,v 1.12 2009/08/22 11:57:24 hass Exp $
3
4	/**
5	* @file
6	* Installation file for Google Analytics module.
7	*/
8
9	function googleanalytics_install() {
10	variable_set('googleanalytics_visibility', 0);
11
12	// Remove tracking from all administrative pages, see http://drupal.org/node/34970.
13	$pages = array(
14	'admin',
15	'admin/*',
16	'user//',
17	'node/add*',
18	'node//',
19	);
20	variable_set('googleanalytics_pages', implode("\n", $pages));
21	}
22
23	function googleanalytics_uninstall() {
24	variable_del('googleanalytics_account');
25	variable_del('googleanalytics_codesnippet_before');
26	variable_del('googleanalytics_codesnippet_after');
27	variable_del('googleanalytics_segmentation');
28	variable_del('googleanalytics_trackoutgoing');
29	variable_del('googleanalytics_trackmailto');
30	variable_del('googleanalytics_trackfiles');
31	variable_del('googleanalytics_trackfiles_extensions');
32	variable_del('googleanalytics_cache');
33	variable_del('googleanalytics_last_cache');
34	variable_del('googleanalytics_site_search');
35	variable_del('googleanalytics_trackadsense');
36	variable_del('googleanalytics_js_scope');
37	variable_del('googleanalytics_custom');
38	variable_del('googleanalytics_roles');
39	variable_del('googleanalytics_visibility');
40	variable_del('googleanalytics_pages');
41	variable_del('googleanalytics_translation_set');
42	}
43
44	/**
45	* Remove cache directory if module is disabled (or uninstalled).
46	*/
47	function googleanalytics_disable() {
48	$path = 'public://googleanalytics';
49	if (file_exists($path)) {
50	file_unmanaged_delete($path . '/ga.js');
51	rmdir($path);
52	}
53	}
54
55	/**
56	* Upgrade old extension variable to new and use old name as enabled/disabled flag.
57	*/
58	function googleanalytics_update_6000() {
59	$ret = array();
60
61	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'));
62	$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;
63	variable_set('googleanalytics_trackfiles', $trackfiles);
64	$ret[] = array('success' => TRUE, 'query' => 'Updated download tracking settings.');
65
66	return $ret;
67	}
68
69	function googleanalytics_update_6001() {
70	$ret = array();
71
72	variable_set('googleanalytics_visibility', 0);
73
74	// Remove tracking from all administrative pages, see http://drupal.org/node/34970.
75	$pages = array(
76	'admin*',
77	'user*',
78	'node/add*',
79	'node//',
80	);
81	variable_set('googleanalytics_pages', implode("\n", $pages));
82	$ret[] = array('success' => TRUE, 'query' => 'Added page tracking to every page except the listed pages: '. implode(', ', $pages));
83
84	return $ret;
85	}
86
87	/**
88	* Upgrade role settings and per user tracking settings
89	* of "User 1" and remove outdated tracking variables.
90	*/
91	function googleanalytics_update_6002() {
92	$ret = array();
93
94	// Upgrade enabled/disabled roles to new logic (correct for upgrades from 5.x-1.4 and 6.x-1.0).
95	$roles = array();
96	foreach (user_roles() as $rid => $name) {
97	if (variable_get('googleanalytics_track_'. $rid, FALSE)) {
98	// Role ID is activated for user tracking.
99	$roles[$rid] = $rid;
100	$ret[] = array('success' => TRUE, 'query' => 'Enabled page tracking for role: ' . $name);
101	}
102	else {
103	$ret[] = array('success' => TRUE, 'query' => 'Disabled page tracking for role: ' . $name);
104	}
105	}
106	variable_set('googleanalytics_roles', $roles);
107
108	// Upgrade disabled tracking of "user 1" to new logic.
109	if (!$track_user1 = variable_get('googleanalytics_track__user1', 1)) {
110	variable_set('googleanalytics_custom', 1);
111
112	// Load user 1 object, set appropiate value and save new user settings back.
113	$account = user_load(array('uid' => 1));
114	$account = user_save($account, array('googleanalytics' => array('custom' => 0)), 'account');
115	$ret[] = array('success' => TRUE, 'query' => 'Disabled user specific page tracking for website administrator.');
116	}
117
118	// Delete outdated tracking settings.
119	$ret[] = update_sql("DELETE FROM {variable} WHERE name LIKE 'googleanalytics_track_%'");
120
121	return $ret;
122	}
123
124	/**
125	* #262468: Clear menu cache to solve stale menu data in 5.x-1.5 and 6.x-1.1
126	*/
127	function googleanalytics_update_6003() {
128	$ret = array();
129	menu_rebuild();
130	return $ret;
131	}
132
133	/**
134	* Change visibility setting for path "user/*".
135	*/
136	function googleanalytics_update_6004() {
137	$ret = array();
138
139	// Orginal pages setting.
140	$pages = array(
141	'admin*',
142	'user*',
143	'node/add*',
144	'node//',
145	);
146
147	$diff = array_diff($pages, preg_split('/(\r\n?\|\n)/', variable_get('googleanalytics_pages', implode("\n", $pages))));
148	if (empty($diff)) {
149	// No diff to original settings found. Update with new settings.
150	$pages = array(
151	'admin*',
152	'user//',
153	'node/add*',
154	'node//',
155	);
156	variable_set('googleanalytics_pages', implode("\n", $pages));
157	$ret[] = array('success' => TRUE, 'query' => 'Path visibility filter setting changed from "user" to "user//*".');
158	}
159	else {
160	$ret[] = array('success' => TRUE, 'query' => 'Custom path visibility filter setting found. Update skipped!');
161	}
162
163	return $ret;
164	}
165
166	/**
167	* Change visibility setting for path "admin*".
168	*/
169	function googleanalytics_update_6005() {
170	$ret = array();
171
172	// Orginal pages setting.
173	$pages = array(
174	'admin*',
175	'user//',
176	'node/add*',
177	'node//',
178	);
179
180	$diff = array_diff($pages, preg_split('/(\r\n?\|\n)/', variable_get('googleanalytics_pages', implode("\n", $pages))));
181	if (empty($diff)) {
182	// No diff to original settings found. Update with new settings.
183	$pages = array(
184	'admin',
185	'admin/*',
186	'user//',
187	'node/add*',
188	'node//',
189	);
190	variable_set('googleanalytics_pages', implode("\n", $pages));
191	$ret[] = array('success' => TRUE, 'query' => 'Path visibility filter setting changed from "admin" to "admin" and "admin/".');
192	}
193	else {
194	$ret[] = array('success' => TRUE, 'query' => 'Custom path visibility filter setting found. Update skipped!');
195	}
196
197	return $ret;
198	}
199
200	/**
201	* Upgrade custom javascript settings.
202	*/
203	function googleanalytics_update_6006() {
204	$ret = array();
205
206	variable_set('googleanalytics_codesnippet_before', variable_get('googleanalytics_codesnippet', ''));
207	variable_del('googleanalytics_codesnippet');
208	$ret[] = array('success' => TRUE, 'query' => 'Upgraded custom javascript codesnippet setting.');
209
210	return $ret;
211	}
212
213	/**
214	* Remove "User identifier" and "User name" from segmentation fields.
215	*
216	* This is a data protection and privacy law change. For more information see Google Analytics
217	* terms of use section 8.1 (http://www.google.com/analytics/en-GB/tos.html).
218	*/
219	function googleanalytics_update_6007() {
220	$ret = array();
221
222	$profile_fields = variable_get('googleanalytics_segmentation', array());
223	unset($profile_fields['uid']);
224	unset($profile_fields['name']);
225	variable_set('googleanalytics_segmentation', $profile_fields);
226	$ret[] = array('success' => TRUE, 'query' => 'Removed "User identifier" and "User name" from segmentation fields.');
227
228	return $ret;
229	}
230
231	/**
232	* Remove outdated legacy support variables and files.
233	*/
234	function googleanalytics_update_6200() {
235	$ret = array();
236
237	$path = 'public://googleanalytics';
238	if (file_exists($path)) {
239	file_unmanaged_delete($path .'/urchin.js');
240	}
241	variable_del('googleanalytics_legacy_version');
242
243	$ret[] = array('success' => TRUE, 'query' => 'Removed legacy support.');
244
245	return $ret;
246	}
247
248	/**
249	* Update list of default file extensions.
250	*/
251	function googleanalytics_update_6201() {
252	$ret = array();
253
254	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') {
255	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');
256	}
257	$ret[] = array('success' => TRUE, 'query' => 'The default extensions for download tracking have been updated.');
258
259	return $ret;
260	}