#609892 by joetsuihk, hass, bec, jmesam: Added Multiple custom variables.
[project/google_analytics.git] / googleanalytics.admin.inc
CommitLineData
5bcdd55b 1<?php
2// $Id$
60b6111f 3
5bcdd55b 4/**
5 * @file
6 * Administrative page callbacks for the googleanalytics module.
7 */
8
9/**
10 * Implementation of hook_admin_settings() for configuring the module
11 */
84201561 12function googleanalytics_admin_settings_form($form_state) {
5bcdd55b 13 $form['account'] = array(
14 '#type' => 'fieldset',
60b6111f 15 '#title' => t('General settings'),
5bcdd55b 16 );
17
18 $form['account']['googleanalytics_account'] = array(
a8664f42 19 '#title' => t('Web Property ID'),
5bcdd55b 20 '#type' => 'textfield',
5bcdd55b 21 '#default_value' => variable_get('googleanalytics_account', 'UA-'),
22 '#size' => 15,
23 '#maxlength' => 20,
24 '#required' => TRUE,
a8664f42 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 ),
5bcdd55b 38 );
39
60b6111f 40 // Standard tracking configurations.
a8664f42 41 $form['tracking']['user_vis_settings'] = array(
60b6111f 42 '#type' => 'fieldset',
a8664f42 43 '#title' => t('Users'),
60b6111f 44 );
a8664f42 45 $t_permission = array('%permission' => t('opt-in or out of tracking'));
46 $form['tracking']['user_vis_settings']['googleanalytics_custom'] = array(
60b6111f 47 '#type' => 'radios',
a8664f42 48 '#title' => t('Allow users to customize tracking on their account page'),
60b6111f 49 '#options' => array(
a8664f42 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)
60b6111f 53 ),
60b6111f 54 '#default_value' => variable_get('googleanalytics_custom', 0),
55 );
5bcdd55b 56
60b6111f 57 // Render the role overview.
a8664f42 58 $form['tracking']['role_vis_settings'] = array(
5bcdd55b 59 '#type' => 'fieldset',
a8664f42 60 '#title' => t('Roles'),
5bcdd55b 61 );
62
a8664f42 63 $role_options = array_map('check_plain', user_roles());
64 $form['tracking']['role_vis_settings']['googleanalytics_roles'] = array(
60b6111f 65 '#type' => 'checkboxes',
66 '#title' => t('Add tracking for specific roles'),
67 '#default_value' => variable_get('googleanalytics_roles', array()),
68 '#options' => $role_options,
a8664f42 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.'),
60b6111f 70 );
5bcdd55b 71
60b6111f 72 // Page specific visibility configurations.
a8664f42 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(
5bcdd55b 78 '#type' => 'fieldset',
a8664f42 79 '#title' => t('Pages'),
5bcdd55b 80 '#collapsible' => TRUE,
60b6111f 81 '#collapsed' => TRUE,
5bcdd55b 82 );
83
a8664f42 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);
5bcdd55b 88 }
89 else {
a8664f42 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>'));
60b6111f 95
a8664f42 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');
60b6111f 103 }
a8664f42 104 $form['tracking']['page_vis_settings']['googleanalytics_visibility'] = array(
60b6111f 105 '#type' => 'radios',
106 '#title' => t('Add tracking to specific pages'),
107 '#options' => $options,
108 '#default_value' => $visibility,
5bcdd55b 109 );
a8664f42 110 $form['tracking']['page_vis_settings']['googleanalytics_pages'] = array(
60b6111f 111 '#type' => 'textarea',
a8664f42 112 '#title' => '<span class="element-invisible">' . $title . '</span>',
60b6111f 113 '#default_value' => $pages,
114 '#description' => $description,
97110728 115 '#wysiwyg' => FALSE,
60b6111f 116 );
117 }
118
a8664f42 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 '#type' => 'textfield',
141 '#default_value' => variable_get('googleanalytics_trackfiles_extensions', GA_TRACKFILES_EXTENSIONS),
142 '#description' => t('A file extension list separated by the | character that will be tracked when clicked. Regular expressions are supported. For example: !extensions', array('!extensions' => GA_TRACKFILES_EXTENSIONS)),
143 '#maxlength' => 255,
144 );
145
146 // Google already have many translations, if not - they display a note to change the language.
147 global $language;
148 $form['tracking']['search_and_adsense'] = array(
149 '#type' => 'fieldset',
150 '#title' => t('Search and AdSense'),
151 );
152
153 $site_search_dependencies = '<div class="admin-dependencies">';
154 $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')))));
155 $site_search_dependencies .= '</div>';
156
157 $form['tracking']['search_and_adsense']['googleanalytics_site_search'] = array(
158 '#type' => 'checkbox',
159 '#title' => t('Track internal search'),
160 '#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,
161 '#default_value' => variable_get('googleanalytics_site_search', FALSE),
162 '#disabled' => (module_exists('search') ? FALSE : TRUE),
163 );
164
165 $form['tracking']['search_and_adsense']['googleanalytics_trackadsense'] = array(
166 '#type' => 'checkbox',
167 '#title' => t('Track AdSense ads'),
168 '#default_value' => variable_get('googleanalytics_trackadsense', FALSE),
169 );
170
26110623 171 // Backward compatibility only.
172 // TODO: If currently not in use, hide the UI and later remove the code.
173 $segmentation = variable_get('googleanalytics_segmentation', array());
174
175 if (!empty($segmentation)) {
176 $profile_enabled = module_exists('profile');
177 $form['segmentation'] = array(
178 '#type' => 'fieldset',
179 '#title' => t('Additional user information'),
180 '#collapsible' => TRUE,
181 );
182
183 // Compile a list of fields to show.
184 $fields = variable_get('googleanalytics_segmentation_default_fields', array('roles' => t('User roles')));
185 if ($profile_enabled) {
186 $result = db_query('SELECT name, title FROM {profile_field} ORDER BY weight');
187 foreach ($result as $record) {
188 $fields[$record->name] = $record->title;
189 }
190 }
191
192 $form['segmentation']['googleanalytics_segmentation'] = array(
193 '#type' => 'select',
194 '#title' => t('Segment users based on these selected properties') . ' <span class="admin-disabled">***DEPRECATED***</span>',
195 '#description' => t("You can supplement Google Analytics' basic IP address tracking of visitors by segmenting users based on these selected properties.") . (!$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.'),
196 '#default_value' => variable_get('googleanalytics_segmentation', array()),
197 '#options' => $fields,
198 '#size' => count($fields)>3 ? 10 : 3,
199 '#multiple' => TRUE
200 );
201 }
202
203 $token_enabled = module_exists('token');
204
205 $form['googleanalytics_custom_var'] = array(
60b6111f 206 '#collapsible' => TRUE,
26110623 207 '#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')),
208 '#theme' => 'googleanalytics_admin_custom_var_table',
209 '#title' => t('Custom variables'),
210 '#tree' => TRUE,
211 '#type' => 'fieldset',
60b6111f 212 );
213
26110623 214 $googleanalytics_custom_vars = variable_get('googleanalytics_custom_var', array());
215
216 // Google Analytics supports up to 5 custom variables.
217 for ($i = 1; $i < 6; $i++) {
218 $form['googleanalytics_custom_var']['slots'][$i]['slot'] = array(
219 '#default_value' => $i,
220 '#description' => t('Slot number'),
221 '#disabled' => TRUE,
222 '#size' => 1,
223 '#type' => 'textfield',
224 );
225 $form['googleanalytics_custom_var']['slots'][$i]['name'] = array(
226 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['name']) ? $googleanalytics_custom_vars['slots'][$i]['name'] : '',
227 '#description' => t('The custom variable name.'),
228 '#size' => 20,
229 '#type' => 'textfield',
230 );
231 $form['googleanalytics_custom_var']['slots'][$i]['value'] = array(
232 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['value']) ? $googleanalytics_custom_vars['slots'][$i]['value'] : '',
233 '#description' => ($token_enabled ? t('The custom variable value. You may use tokens in this field.') : 'The custom variable value.'),
234 '#type' => 'textfield',
235 );
236 $form['googleanalytics_custom_var']['slots'][$i]['scope'] = array(
237 '#default_value' => !empty($googleanalytics_custom_vars['slots'][$i]['scope']) ? $googleanalytics_custom_vars['slots'][$i]['scope'] : 3,
238 '#description' => t('The scope for the custom variable.'),
239 '#type' => 'select',
240 '#options' => array(
241 1 => t('Visitor'),
242 2 => t('Session'),
243 3 => t('Page'),
244 ),
245 );
5bcdd55b 246 }
247
26110623 248 $form['googleanalytics_custom_var']['googleanalytics_custom_var_description'] = array(
249 '#type' => 'item',
250 '#description' => t("You can supplement Google Analytics' basic IP address tracking of visitors by segmenting users based on these selected properties.") . (!$token_enabled ? ' '. t('<a href="@module_list">Enable the token module</a> to be able to use tokens 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')),
251 );
252 $form['googleanalytics_custom_var']['googleanalytics_custom_var_token_tree'] = array(
253 '#access' => $token_enabled ? TRUE : FALSE,
254 '#theme' => 'token_tree',
255 '#token_types' => array('node'),
60b6111f 256 );
257
26110623 258
60b6111f 259 // Advanced feature configurations.
5bcdd55b 260 $form['advanced'] = array(
261 '#type' => 'fieldset',
60b6111f 262 '#title' => t('Advanced settings'),
5bcdd55b 263 '#collapsible' => TRUE,
264 '#collapsed' => TRUE,
60b6111f 265 );
266
b44fb664 267 $form['advanced']['googleanalytics_tracker_anonymizeip'] = array(
268 '#type' => 'checkbox',
269 '#title' => t('Anonymize visitors IP address'),
b44fb664 270 '#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.'),
0753fcd1 271 '#default_value' => variable_get('googleanalytics_tracker_anonymizeip', 0),
b44fb664 272 );
273
5bcdd55b 274 $form['advanced']['googleanalytics_cache'] = array(
275 '#type' => 'checkbox',
a8664f42 276 '#title' => t('Locally cache tracking code file'),
277 '#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!"),
5bcdd55b 278 '#default_value' => variable_get('googleanalytics_cache', 0),
279 );
97110728 280
281 // Allow for tracking of the originating node when viewing translation sets.
282 if (module_exists('translation')) {
283 $form['advanced']['googleanalytics_translation_set'] = array(
284 '#type' => 'checkbox',
285 '#title' => t('Track translation sets as one unit'),
286 '#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.'),
287 '#default_value' => variable_get('googleanalytics_translation_set', 0),
288 );
5bcdd55b 289 }
290
97110728 291 $form['advanced']['codesnippet'] = array(
292 '#type' => 'fieldset',
60b6111f 293 '#title' => t('Custom JavaScript code'),
97110728 294 '#collapsible' => TRUE,
295 '#collapsed' => TRUE,
a8664f42 296 '#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'))
97110728 297 );
298 $form['advanced']['codesnippet']['googleanalytics_codesnippet_before'] = array(
299 '#type' => 'textarea',
300 '#title' => t('Code snippet (before)'),
301 '#default_value' => variable_get('googleanalytics_codesnippet_before', ''),
302 '#rows' => 5,
303 '#wysiwyg' => FALSE,
dbfe5398 304 '#description' => t("Code in this textarea will be added <strong>before</strong> _gaq.push(['_trackPageview'])."),
97110728 305 );
306 $form['advanced']['codesnippet']['googleanalytics_codesnippet_after'] = array(
307 '#type' => 'textarea',
308 '#title' => t('Code snippet (after)'),
309 '#default_value' => variable_get('googleanalytics_codesnippet_after', ''),
60b6111f 310 '#rows' => 5,
97110728 311 '#wysiwyg' => FALSE,
dbfe5398 312 '#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."),
60b6111f 313 );
314
315 $form['advanced']['googleanalytics_js_scope'] = array(
316 '#type' => 'select',
317 '#title' => t('JavaScript scope'),
01f3950e 318 '#description' => t('Google recommends adding the external JavaScript files to the header for performance reasons.'),
60b6111f 319 '#options' => array(
320 'footer' => t('Footer'),
321 'header' => t('Header'),
322 ),
01f3950e 323 '#default_value' => variable_get('googleanalytics_js_scope', 'header'),
5bcdd55b 324 );
325
326 return system_settings_form($form);
327}
60b6111f 328
329function googleanalytics_admin_settings_form_validate($form, &$form_state) {
26110623 330 // Custom variables validation.
331 foreach ($form_state['values']['googleanalytics_custom_var']['slots'] as $custom_var) {
332 // Validate empty names/values.
333 if (empty($custom_var['name']) && !empty($custom_var['value'])) {
334 form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][name", t('Custom variable #@slot: <em>Name</em> is required, if <em>value</em> has been provided.', array('@slot' => $custom_var['slot'])));
335 }
336 elseif (!empty($custom_var['name']) && empty($custom_var['value'])) {
337 form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][value", t('Custom variable #@slot: <em>Value</em> is required, if <em>name</em> has been provided.', array('@slot' => $custom_var['slot'])));
338 }
339
340 // Block tokens with personally identifying information.
341 if (_googleanalytics_contains_forbidden_token($custom_var['value'])) {
342 form_set_error("googleanalytics_custom_var][slots][" . $custom_var['slot'] . "][value", t('Custom variable #@slot: Forbidden token has been found in custom variable named %name. Never use tokens with personally identifying information!', array('%name' => $custom_var['name'], '@slot' => $custom_var['slot'])));
343 }
344 }
345
38901433 346 // Trim some text values.
347 $form_state['values']['googleanalytics_account'] = trim($form_state['values']['googleanalytics_account']);
348 $form_state['values']['googleanalytics_pages'] = trim($form_state['values']['googleanalytics_pages']);
349 $form_state['values']['googleanalytics_codesnippet_before'] = trim($form_state['values']['googleanalytics_codesnippet_before']);
350 $form_state['values']['googleanalytics_codesnippet_after'] = trim($form_state['values']['googleanalytics_codesnippet_after']);
351
60b6111f 352 if (!preg_match('/^UA-\d{4,}-\d+$/', $form_state['values']['googleanalytics_account'])) {
a8664f42 353 form_set_error('googleanalytics_account', t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'));
60b6111f 354 }
355
8de0b902 356 // Clear obsolete local cache if cache has been disabled.
357 if (empty($form_state['values']['googleanalytics_cache']) && $form['advanced']['googleanalytics_cache']['#default_value']) {
35b6a781 358 googleanalytics_clear_js_cache();
359 }
360
60b6111f 361 // This is for the Newbie's who cannot read a text area description.
97110728 362 if (stristr($form_state['values']['googleanalytics_codesnippet_before'], 'google-analytics.com/ga.js')) {
363 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.'));
364 }
365 if (stristr($form_state['values']['googleanalytics_codesnippet_after'], 'google-analytics.com/ga.js')) {
366 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.'));
367 }
368 if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_before'])) {
369 form_set_error('googleanalytics_codesnippet_before', t('Do not include the &lt;script&gt; tags in the javascript code snippets.'));
370 }
371 if (preg_match('/(.*)<\/?script(.*)>(.*)/i', $form_state['values']['googleanalytics_codesnippet_after'])) {
372 form_set_error('googleanalytics_codesnippet_after', t('Do not include the &lt;script&gt; tags in the javascript code snippets.'));
60b6111f 373 }
60b6111f 374}
26110623 375
376/**
377 * Layout for the custom variables table in the admin settings form.
378 */
379function theme_googleanalytics_admin_custom_var_table($variables) {
380 $form = $variables['form'];
381
382 $header = array(
383 array('data' => t('Slot')),
384 array('data' => t('Name')),
385 array('data' => t('Value')),
386 array('data' => t('Scope')),
387 );
388
389 $rows = array();
390 foreach (element_children($form['slots']) as $key => $id) {
391 $rows[] = array(
392 'data' => array(
393 drupal_render($form['slots'][$id]['slot']),
394 drupal_render($form['slots'][$id]['name']),
395 drupal_render($form['slots'][$id]['value']),
396 drupal_render($form['slots'][$id]['scope']),
397 ),
398 );
399 }
400
401 $output = theme('table', array('header' => $header, 'rows' => $rows));
402 $output .= drupal_render($form['googleanalytics_custom_var_description']);
403
404 if (!empty($form['googleanalytics_custom_var_token_tree'])) {
405 $output .= drupal_render($form['googleanalytics_custom_var_token_tree']);
406 }
407
408 return $output;
409}
410
411/**
412 * Validate if a string contains forbidden tokens not allowed by privacy rules.
413 *
414 * @param $token_string
415 * A string with one or more tokens to be validated.
416 * @return boolean
417 * TRUE if blacklisted token has been found, otherwise FALSE.
418 */
419function _googleanalytics_contains_forbidden_token($token_string) {
420 // List of strings in tokens with personal identifying information not allowed
421 // for privacy reasons. See section 8.1 of the Google Analytics terms of use
422 // for more detailed information.
423 //
424 // This list can never ever be complete. For this reason it tries to use a
425 // regex and may kill a few other valid tokens, but it's the only way to
426 // protect users as much as possible from admins with illegal ideas.
427 //
428 // User tokens are not prefixed with colon to catch 'current-user' and 'user'.
429 //
430 // TODO: If someone have better ideas, share them, please!
431 $token_blacklist = array(
432 ':author]',
433 ':author:edit-url]',
434 ':author:url]',
435 ':author:path]',
436 ':mail]',
437 ':name]',
438 ':uid]',
439 'user:edit-url]',
440 'user:url]',
441 'user:path]',
442 );
443
444 return preg_match('/' . implode('|', array_map('preg_quote', $token_blacklist)) . '/i', $token_string);
445}