16f85903570172c398bd87b7593eab19de3fc8d3
[project/google_analytics.git] / googleanalytics.admin.inc
1 <?php
2 // $Id$
3
4 /**
5 * @file
6 * Administrative page callbacks for the googleanalytics module.
7 */
8
9 /**
10 * Implements hook_admin_settings() for module settings configuration.
11 */
12 function googleanalytics_admin_settings_form($form_state) {
13 $form['account'] = array(
14 '#type' => 'fieldset',
15 '#title' => t('General settings'),
16 );
17
18 $form['account']['googleanalytics_account'] = array(
19 '#title' => t('Web Property ID'),
20 '#type' => 'textfield',
21 '#default_value' => variable_get('googleanalytics_account', 'UA-'),
22 '#size' => 15,
23 '#maxlength' => 20,
24 '#required' => TRUE,
25 '#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' => 'http://code.google.com/apis/analytics/docs/concepts/gaConceptsAccounts.html#webProperty')),
26 );
27
28 // Visibility settings.
29 $form['tracking_title'] = array(
30 '#type' => 'item',
31 '#title' => t('Tracking scope'),
32 );
33 $form['tracking'] = array(
34 '#type' => 'vertical_tabs',
35 '#attached' => array(
36 'js' => array(drupal_get_path('module', 'googleanalytics') . '/googleanalytics.admin.js'),
37 ),
38 );
39
40 // Standard tracking configurations.
41 $form['tracking']['user_vis_settings'] = array(
42 '#type' => 'fieldset',
43 '#title' => t('Users'),
44 );
45 $t_permission = array('%permission' => t('opt-in or out of tracking'));
46 $form['tracking']['user_vis_settings']['googleanalytics_custom'] = array(
47 '#type' => 'radios',
48 '#title' => t('Allow users to customize tracking on their account page'),
49 '#options' => array(
50 t('No customization allowed'),
51 t('Tracking on by default, users with %permission permission can opt out', $t_permission),
52 t('Tracking off by default, users with %permission permission can opt in', $t_permission),
53 ),
54 '#default_value' => variable_get('googleanalytics_custom', 0),
55 );
56
57 // Render the role overview.
58 $form['tracking']['role_vis_settings'] = array(
59 '#type' => 'fieldset',
60 '#title' => t('Roles'),
61 );
62
63 $role_options = array_map('check_plain', user_roles());
64 $form['tracking']['role_vis_settings']['googleanalytics_roles'] = array(
65 '#type' => 'checkboxes',
66 '#title' => t('Add tracking for specific roles'),
67 '#default_value' => variable_get('googleanalytics_roles', array()),
68 '#options' => $role_options,
69 '#description' => t('If none are selected, all users will be tracked. If a user has any of the roles checked, that user will be tracked.'),
70 );
71
72 // Page specific visibility configurations.
73 $php_access = user_access('use PHP for tracking visibility');
74 $visibility = variable_get('googleanalytics_visibility', 0);
75 $pages = variable_get('googleanalytics_pages', '');
76
77 $form['tracking']['page_vis_settings'] = array(
78 '#type' => 'fieldset',
79 '#title' => t('Pages'),
80 '#collapsible' => TRUE,
81 '#collapsed' => TRUE,
82 );
83
84 if ($visibility == 2 && !$php_access) {
85 $form['tracking']['page_vis_settings'] = array();
86 $form['tracking']['page_vis_settings']['visibility'] = array('#type' => 'value', '#value' => 2);
87 $form['tracking']['page_vis_settings']['pages'] = array('#type' => 'value', '#value' => $pages);
88 }
89 else {
90 $options = array(
91 t('Every page except the listed pages'),
92 t('The listed pages only'),
93 );
94 $description = t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array('%blog' => 'blog', '%blog-wildcard' => 'blog/*', '%front' => '<front>'));
95
96 if (module_exists('php') && $php_access) {
97 $options[] = t('Pages on which this PHP code returns <code>TRUE</code> (experts only)');
98 $title = t('Pages or PHP code');
99 $description .= ' ' . t('If the PHP option is chosen, enter PHP code between %php. Note that executing incorrect PHP code can break your Drupal site.', array('%php' => '<?php ?>'));
100 }
101 else {
102 $title = t('Pages');
103 }
104 $form['tracking']['page_vis_settings']['googleanalytics_visibility'] = array(
105 '#type' => 'radios',
106 '#title' => t('Add tracking to specific pages'),
107 '#options' => $options,
108 '#default_value' => $visibility,
109 );
110 $form['tracking']['page_vis_settings']['googleanalytics_pages'] = array(
111 '#type' => 'textarea',
112 '#title' => $title,
113 '#title_display' => 'invisible',
114 '#default_value' => $pages,
115 '#description' => $description,
116 );
117 }
118
119 // Link specific configurations.
120 $form['tracking']['linktracking'] = array(
121 '#type' => 'fieldset',
122 '#title' => t('Links and downloads'),
123 );
124 $form['tracking']['linktracking']['googleanalytics_trackoutgoing'] = array(
125 '#type' => 'checkbox',
126 '#title' => t('Track clicks on outgoing links'),
127 '#default_value' => variable_get('googleanalytics_trackoutgoing', 1),
128 );
129 $form['tracking']['linktracking']['googleanalytics_trackmailto'] = array(
130 '#type' => 'checkbox',
131 '#title' => t('Track clicks on mailto links'),
132 '#default_value' => variable_get('googleanalytics_trackmailto', 1),
133 );
134 $form['tracking']['linktracking']['googleanalytics_trackfiles'] = array(
135 '#type' => 'checkbox',
136 '#title' => t('Track downloads (clicks on file links) for the following extensions'),
137 '#default_value' => variable_get('googleanalytics_trackfiles', 1),
138 );
139 $form['tracking']['linktracking']['googleanalytics_trackfiles_extensions'] = array(
140 '#title' => t('List of download file extensions'),
141 '#title_display' => 'invisible',
142 '#type' => 'textfield',
143 '#default_value' => variable_get('googleanalytics_trackfiles_extensions', GA_TRACKFILES_EXTENSIONS),
144 '#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' => GA_TRACKFILES_EXTENSIONS)),
145 '#maxlength' => 255,
146 );
147
148 // Google already have many translations, if not - they display a note to change the language.
149 global $language;
150 $form['tracking']['search_and_adsense'] = array(
151 '#type' => 'fieldset',
152 '#title' => t('Search and AdSense'),
153 );
154
155 $site_search_dependencies = '<div class="admin-dependencies">';
156 $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')))));
157 $site_search_dependencies .= '</div>';
158
159 $form['tracking']['search_and_adsense']['googleanalytics_site_search'] = array(
160 '#type' => 'checkbox',
161 '#title' => t('Track internal search'),
162 '#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">How do I set up Site Search for my profile</a>.', array('@url' => 'http://www.google.com/support/analytics/bin/answer.py?hl=' . $language->language . '&answer=75817')) . $site_search_dependencies,
163 '#default_value' => variable_get('googleanalytics_site_search', FALSE),
164 '#disabled' => (module_exists('search') ? FALSE : TRUE),
165 );
166
167 $form['tracking']['search_and_adsense']['googleanalytics_trackadsense'] = array(
168 '#type' => 'checkbox',
169 '#title' => t('Track AdSense ads'),
170 '#description' => t('If checked, your AdSense ads will be tracked in your Google Analytics account.'),
171 '#default_value' => variable_get('googleanalytics_trackadsense', FALSE),
172 );
173
174 // Backward compatibility only.
175 // TODO: If currently not in use, hide the UI and later remove the code.
176 $segmentation = variable_get('googleanalytics_segmentation', array());
177
178 if (!empty($segmentation) || variable_get('googleanalytics_segmentation_DEPRECATED', FALSE)) {
179 $profile_enabled = module_exists('profile');
180 $form['segmentation'] = array(
181 '#type' => 'fieldset',
182 '#title' => t('Additional user information'),
183 '#collapsible' => TRUE,
184 );
185
186 // Compile a list of fields to show.
187 $fields = variable_get('googleanalytics_segmentation_default_fields', array('roles' => t('User roles')));
188 if ($profile_enabled) {
189 $result = db_query('SELECT name, title FROM {profile_field} ORDER BY weight');
190 foreach ($result as $record) {
191 $fields[$record->name] = $record->title;
192 }
193 }
194
195 $form['segmentation']['googleanalytics_segmentation'] = array(
196 '#type' => 'select',
197 '#title' => t('Segment users based on these selected properties') . ' <span class="admin-disabled">***DEPRECATED***</span>',
198 '#description' => t("You can supplement Google Analytics' basic IP address tracking of visitors by segmenting users based on these selected properties.") . ' <span class="admin-disabled">' . t('For most situations, Google recommend that you use Custom Variables to segment your visitors.') . '</span>' . (!$profile_enabled ? ' ' . t('<a href="@module_list">Enable the profile module</a> to be able to use profile fields for more granular tracking.', array('@module_list' => url('admin/build/modules'))) : '') . ' ' . t('Section 8.1 of the <a href="@ga_tos">Google Analytics terms of use</a> requires you to make sure you will not associate (or permit any third party to associate) any data gathered from your websites (or such third parties\' websites) with any personally identifying information from any source as part of your use (or such third parties\' use) of the Google Analytics\' service.', array('@ga_tos' => 'http://www.google.com/analytics/en-GB/tos.html')) . ' ' . t('You can select multiple values.'),
199 '#default_value' => $segmentation,
200 '#options' => $fields,
201 '#size' => count($fields)>3 ? 10 : 3,
202 '#multiple' => TRUE,
203 );
204 }
205
206 $form['googleanalytics_custom_var'] = array(
207 '#collapsible' => TRUE,
208 '#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 64 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 values. Global and user tokens are always available; on node pages, node tokens are also available.', array('!custom_var_documentation' => 'http://code.google.com/intl/en/apis/analytics/docs/tracking/gaTrackingCustomVariables.html')),
209 '#theme' => 'googleanalytics_admin_custom_var_table',
210 '#title' => t('Custom variables'),
211 '#tree' => TRUE,
212 '#type' => 'fieldset',
213 );
214
215 $googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
216
217 // Google Analytics supports up to 5 custom variables.
218 for ($i = 1; $i < 6; $i++) {
219 $form['googleanalytics_custom_var']['slots'][$i]['slot'] = array(
220 '#default_value' => $i,
221 '#description' => t('Slot number'),
222 '#disabled' => TRUE,
223 '#size' => 1,
224 '#title' => t('Custom variable slot #@slot', array('@slot' => $i)),
225 '#title_display' => 'invisible',
226 '#type' => 'textfield',
227 );
228 $form['googleanalytics_custom_var']['slots'][$i]['name'] = array(
229 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['name']) ? $googleanalytics_custom_vars['slots'][$i]['name'] : '',
230 '#description' => t('The custom variable name.'),
231 '#size' => 20,
232 '#title' => t('Custom variable name #@slot', array('@slot' => $i)),
233 '#title_display' => 'invisible',
234 '#type' => 'textfield',
235 );
236 $form['googleanalytics_custom_var']['slots'][$i]['value'] = array(
237 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['value']) ? $googleanalytics_custom_vars['slots'][$i]['value'] : '',
238 '#description' => t('The custom variable value. You may use tokens in this field.'),
239 '#title' => t('Custom variable value #@slot', array('@slot' => $i)),
240 '#title_display' => 'invisible',
241 '#type' => 'textfield',
242 '#element_validate' => array('googleanalytics_token_element_validate'),
243 '#token_types' => array('node'),
244 );
245 if (module_exists('token')) {
246 $form['googleanalytics_custom_var']['slots'][$i]['value']['#element_validate'][] = 'token_element_validate';
247 }
248 $form['googleanalytics_custom_var']['slots'][$i]['scope'] = array(
249 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['scope']) ? $googleanalytics_custom_vars['slots'][$i]['scope'] : 3,
250 '#description' => t('The scope for the custom variable.'),
251 '#title' => t('Custom variable slot #@slot', array('@slot' => $i)),
252 '#title_display' => 'invisible',
253 '#type' => 'select',
254 '#options' => array(
255 1 => t('Visitor'),
256 2 => t('Session'),
257 3 => t('Page'),
258 ),
259 );
260 }
261
262 $form['googleanalytics_custom_var']['googleanalytics_custom_var_description'] = array(
263 '#type' => 'item',
264 '#description' => t('You can supplement Google Analytics\' basic IP address tracking of visitors by segmenting users based on custom variables. Section 8.1 of the <a href="@ga_tos">Google Analytics terms of use</a> requires you to make sure you will not associate (or permit any third party to associate) any data gathered from your websites (or such third parties\' websites) with any personally identifying information from any source as part of your use (or such third parties\' use) of the Google Analytics\' service.', array('@ga_tos' => 'http://www.google.com/analytics/en-GB/tos.html')),
265 );
266 $form['googleanalytics_custom_var']['googleanalytics_custom_var_token_tree'] = array(
267 '#theme' => 'token_tree',
268 '#token_types' => array('node'),
269 );
270
271
272 // Advanced feature configurations.
273 $form['advanced'] = array(
274 '#type' => 'fieldset',
275 '#title' => t('Advanced settings'),
276 '#collapsible' => TRUE,
277 '#collapsed' => TRUE,
278 );
279
280 $form['advanced']['googleanalytics_tracker_anonymizeip'] = array(
281 '#type' => 'checkbox',
282 '#title' => t('Anonymize visitors IP address'),
283 '#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.'),
284 '#default_value' => variable_get('googleanalytics_tracker_anonymizeip', 0),
285 );
286
287 $form['advanced']['googleanalytics_cache'] = array(
288 '#type' => 'checkbox',
289 '#title' => t('Locally cache tracking code file'),
290 '#description' => t("If checked, the tracking code file is retrieved from Google Analytics and cached locally. It is updated daily from Google's servers to ensure updates to tracking code are reflected in the local copy. Do not activate this until after Google Analytics has confirmed that site tracking is working!"),
291 '#default_value' => variable_get('googleanalytics_cache', 0),
292 );
293
294 // Allow for tracking of the originating node when viewing translation sets.
295 if (module_exists('translation')) {
296 $form['advanced']['googleanalytics_translation_set'] = array(
297 '#type' => 'checkbox',
298 '#title' => t('Track translation sets as one unit'),
299 '#description' => t('When a node is part of a translation set, record statistics for the originating node instead. This allows for a translation set to be treated as a single unit.'),
300 '#default_value' => variable_get('googleanalytics_translation_set', 0),
301 );
302 }
303
304 $form['advanced']['codesnippet'] = array(
305 '#type' => 'fieldset',
306 '#title' => t('Custom JavaScript code'),
307 '#collapsible' => TRUE,
308 '#collapsed' => TRUE,
309 '#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 &lt;script&gt; tags</strong>, and always end your code with a semicolon (;).', array('@snippets' => 'http://drupal.org/node/248699', '@ga_concepts_overview' => 'http://code.google.com/apis/analytics/docs/gaConceptsOverview.html', '@ga_js_api' => 'http://code.google.com/apis/analytics/docs/gaJSApi.html')),
310 );
311 $form['advanced']['codesnippet']['googleanalytics_codesnippet_before'] = array(
312 '#type' => 'textarea',
313 '#title' => t('Code snippet (before)'),
314 '#default_value' => variable_get('googleanalytics_codesnippet_before', ''),
315 '#rows' => 5,
316 '#description' => t("Code in this textarea will be added <strong>before</strong> _gaq.push(['_trackPageview'])."),
317 );
318 $form['advanced']['codesnippet']['googleanalytics_codesnippet_after'] = array(
319 '#type' => 'textarea',
320 '#title' => t('Code snippet (after)'),
321 '#default_value' => variable_get('googleanalytics_codesnippet_after', ''),
322 '#rows' => 5,
323 '#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."),
324 );
325
326 $form['advanced']['googleanalytics_js_scope'] = array(
327 '#type' => 'select',
328 '#title' => t('JavaScript scope'),
329 '#description' => t('Google recommends adding the external JavaScript files to the header for performance reasons.'),
330 '#options' => array(
331 'footer' => t('Footer'),
332 'header' => t('Header'),
333 ),
334 '#default_value' => variable_get('googleanalytics_js_scope', 'header'),
335 );
336
337 return system_settings_form($form);
338 }
339
340 /**
341 * Implements _form_validate().
342 */
343 function googleanalytics_admin_settings_form_validate($form, &$form_state) {
344 // Custom variables validation.
345 foreach ($form_state['values']['googleanalytics_custom_var']['slots'] as $custom_var) {
346 // Validate empty names/values.
347 if (empty($custom_var['name']) && !empty($custom_var['value'])) {
348 form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][name", 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'])));
349 }
350 elseif (!empty($custom_var['name']) && empty($custom_var['value'])) {
351 form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][value", 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'])));
352 }
353 }
354
355 // Trim some text values.
356 $form_state['values']['googleanalytics_account'] = trim($form_state['values']['googleanalytics_account']);
357 $form_state['values']['googleanalytics_pages'] = trim($form_state['values']['googleanalytics_pages']);
358 $form_state['values']['googleanalytics_codesnippet_before'] = trim($form_state['values']['googleanalytics_codesnippet_before']);
359 $form_state['values']['googleanalytics_codesnippet_after'] = trim($form_state['values']['googleanalytics_codesnippet_after']);
360
361 if (!preg_match('/^UA-\d{4,}-\d+$/', $form_state['values']['googleanalytics_account'])) {
362 form_set_error('googleanalytics_account', t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'));
363 }
364
365 // Clear obsolete local cache if cache has been disabled.
366 if (empty($form_state['values']['googleanalytics_cache']) && $form['advanced']['googleanalytics_cache']['#default_value']) {
367 googleanalytics_clear_js_cache();
368 }
369
370 // This is for the Newbie's who cannot read a text area description.
371 if (stristr($form_state['values']['googleanalytics_codesnippet_before'], 'google-analytics.com/ga.js')) {
372 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.'));
373 }
374 if (stristr($form_state['values']['googleanalytics_codesnippet_after'], 'google-analytics.com/ga.js')) {
375 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.'));
376 }
377 if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_before'])) {
378 form_set_error('googleanalytics_codesnippet_before', t('Do not include the &lt;script&gt; tags in the javascript code snippets.'));
379 }
380 if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_after'])) {
381 form_set_error('googleanalytics_codesnippet_after', t('Do not include the &lt;script&gt; tags in the javascript code snippets.'));
382 }
383 }
384
385 /**
386 * Layout for the custom variables table in the admin settings form.
387 */
388 function theme_googleanalytics_admin_custom_var_table($variables) {
389 $form = $variables['form'];
390
391 $header = array(
392 array('data' => t('Slot')),
393 array('data' => t('Name')),
394 array('data' => t('Value')),
395 array('data' => t('Scope')),
396 );
397
398 $rows = array();
399 foreach (element_children($form['slots']) as $key => $id) {
400 $rows[] = array(
401 'data' => array(
402 drupal_render($form['slots'][$id]['slot']),
403 drupal_render($form['slots'][$id]['name']),
404 drupal_render($form['slots'][$id]['value']),
405 drupal_render($form['slots'][$id]['scope']),
406 ),
407 );
408 }
409
410 $output = theme('table', array('header' => $header, 'rows' => $rows));
411 $output .= drupal_render($form['googleanalytics_custom_var_description']);
412 $output .= drupal_render($form['googleanalytics_custom_var_token_tree']);
413
414 return $output;
415 }
416
417 /**
418 * Validate a form element that should have tokens in it.
419 *
420 * For example:
421 * @code
422 * $form['my_node_text_element'] = array(
423 * '#type' => 'textfield',
424 * '#title' => t('Some text to token-ize that has a node context.'),
425 * '#default_value' => 'The title of this node is [node:title].',
426 * '#element_validate' => array('googleanalytics_token_element_validate'),
427 * );
428 * @endcode
429 */
430 function googleanalytics_token_element_validate(&$element, &$form_state) {
431 $value = isset($element['#value']) ? $element['#value'] : $element['#default_value'];
432
433 if (!drupal_strlen($value)) {
434 // Empty value needs no further validation since the element should depend
435 // on using the '#required' FAPI property.
436 return $element;
437 }
438
439 $tokens = token_scan($value);
440 $invalid_tokens = _googleanalytics_get_forbidden_tokens($tokens);
441 if ($invalid_tokens) {
442 form_error($element, t('The %element-title is using the following forbidden tokens with personal identifying information: @invalid-tokens.', array('%element-title' => $element['#title'], '@invalid-tokens' => implode(', ', $invalid_tokens))));
443 }
444
445 return $element;
446 }
447
448 function _googleanalytics_get_forbidden_tokens($value) {
449 $invalid_tokens = array();
450 $value_tokens = is_string($value) ? token_scan($value) : $value;
451
452 foreach ($value_tokens as $type => $tokens) {
453 if (array_filter($tokens, '_googleanalytics_contains_forbidden_token')) {
454 $invalid_tokens = array_merge($invalid_tokens, array_values($tokens));
455 }
456 }
457
458 array_unique($invalid_tokens);
459 return $invalid_tokens;
460 }
461
462 /**
463 * Validate if a string contains forbidden tokens not allowed by privacy rules.
464 *
465 * @param $token_string
466 * A string with one or more tokens to be validated.
467 * @return boolean
468 * TRUE if blacklisted token has been found, otherwise FALSE.
469 */
470 function _googleanalytics_contains_forbidden_token($token_string) {
471 // List of strings in tokens with personal identifying information not allowed
472 // for privacy reasons. See section 8.1 of the Google Analytics terms of use
473 // for more detailed information.
474 //
475 // This list can never ever be complete. For this reason it tries to use a
476 // regex and may kill a few other valid tokens, but it's the only way to
477 // protect users as much as possible from admins with illegal ideas.
478 //
479 // User tokens are not prefixed with colon to catch 'current-user' and 'user'.
480 //
481 // TODO: If someone have better ideas, share them, please!
482 $token_blacklist = array(
483 ':author]',
484 ':author:edit-url]',
485 ':author:url]',
486 ':author:path]',
487 ':fid]',
488 ':mail]',
489 ':name]',
490 ':uid]',
491 ':one-time-login-url]',
492 ':owner]',
493 ':owner:cancel-url]',
494 ':owner:edit-url]',
495 ':owner:url]',
496 ':owner:path]',
497 'user:cancel-url]',
498 'user:edit-url]',
499 'user:url]',
500 'user:path]',
501 );
502
503 return preg_match('/' . implode('|', array_map('preg_quote', $token_blacklist)) . '/i', $token_string);
504 }