Project

General

Profile

Paste
Download (24.6 KB) Statistics
| Branch: | Revision:

root / drupal7 / sites / all / modules / piwik / piwik.module @ 2f8c40f0

1
<?php
2

    
3
/**
4
 * @file
5
 * Drupal Module: Piwik
6
 *
7
 * Adds the required Javascript to all your Drupal pages to allow tracking by
8
 * the Piwik statistics package.
9
 *
10
 * @author: Alexander Hass <http://drupal.org/user/85918>
11
 */
12

    
13
/**
14
 * Define the default file extension list that should be tracked as download.
15
 */
16
define('PIWIK_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');
17

    
18
/**
19
 * Define default path exclusion list to remove tracking from admin pages,
20
 * see http://drupal.org/node/34970 for more information.
21
 */
22
define('PIWIK_PAGES', "admin\nadmin/*\nbatch\nnode/add*\nnode/*/*\nuser/*/*");
23

    
24
/**
25
 * Implements hook_help().
26
 */
27
function piwik_help($path, $arg) {
28
  switch ($path) {
29
    case 'admin/config/system/piwik':
30
      return t('<a href="@pk_url">Piwik - Web analytics</a> is an open source (GPL license) web analytics software. It gives interesting reports on your website visitors, your popular pages, the search engines keywords they used, the language they speak... and so much more. Piwik aims to be an open source alternative to Google Analytics.', array('@pk_url' => 'http://www.piwik.org/'));
31
  }
32
}
33

    
34
/**
35
 * Implements hook_theme().
36
 */
37
function piwik_theme() {
38
  return array(
39
    'piwik_admin_custom_var_table' => array(
40
      'render element' => 'form',
41
    ),
42
  );
43
}
44

    
45
/**
46
 * Implements hook_permission().
47
 */
48
function piwik_permission() {
49
  return array(
50
    'administer piwik' => array(
51
      'title' => t('Administer Piwik'),
52
      'description' => t('Perform maintenance tasks for Piwik.'),
53
    ),
54
    'opt-in or out of tracking' => array(
55
      'title' => t('Opt-in or out of tracking'),
56
      'description' => t('Allow users to decide if tracking code will be added to pages or not.'),
57
    ),
58
    'use PHP for tracking visibility' => array(
59
      'title' => t('Use PHP for tracking visibility'),
60
      'description' => t('Enter PHP code in the field for tracking visibility settings.'),
61
      'restrict access' => TRUE,
62
    ),
63
  );
64
}
65

    
66
/**
67
 * Implements hook_menu().
68
 */
69
function piwik_menu() {
70
  $items['admin/config/system/piwik'] = array(
71
    'title' => 'Piwik',
72
    'description' => 'Configure the settings used to generate your Piwik tracking code.',
73
    'page callback' => 'drupal_get_form',
74
    'page arguments' => array('piwik_admin_settings_form'),
75
    'access arguments' => array('administer piwik'),
76
    'type' => MENU_NORMAL_ITEM,
77
    'file' => 'piwik.admin.inc',
78
  );
79

    
80
  return $items;
81
}
82

    
83
/**
84
 * Implements hook_page_alter() to insert JavaScript to the appropriate scope/region of the page.
85
 */
86
function piwik_page_alter(&$page) {
87
  global $user;
88

    
89
  $id = variable_get('piwik_site_id', '');
90

    
91
  // Get page status code for visibility filtering.
92
  $status = drupal_get_http_header('Status');
93
  $trackable_status_codes = array(
94
    '403 Forbidden',
95
    '404 Not Found',
96
  );
97

    
98
  // 1. Check if the piwik account number has a value.
99
  // 2. Track page views based on visibility value.
100
  // 3. Check if we should track the currently active user's role.
101
  if (preg_match('/^\d{1,}$/', $id) && (_piwik_visibility_pages() || in_array($status, $trackable_status_codes)) && _piwik_visibility_user($user)) {
102

    
103
    $url_http = variable_get('piwik_url_http', '');
104
    $url_https = variable_get('piwik_url_https', '');
105
    $scope = variable_get('piwik_js_scope', 'header');
106

    
107
    $set_custom_url = '';
108
    $set_document_title = '';
109
    $set_custom_data = array();
110

    
111
    // Add link tracking.
112
    $link_settings = array();
113
    $link_settings['trackMailto'] = variable_get('piwik_trackmailto', 1);
114

    
115
    drupal_add_js(array('piwik' => $link_settings), 'setting');
116
    drupal_add_js(drupal_get_path('module', 'piwik') . '/piwik.js');
117

    
118
    // Piwik can show a tree view of page titles that represents the site structure
119
    // if setDocumentTitle() provides the page titles as a "/" delimited list.
120
    // This may makes it easier to browse through the statistics of page titles
121
    // on larger sites.
122
    if (variable_get('piwik_page_title_hierarchy', FALSE) == TRUE) {
123
      $titles = _piwik_get_hierarchy_titles();
124

    
125
      if (variable_get('piwik_page_title_hierarchy_exclude_home', TRUE)) {
126
        // Remove the "Home" item from the titles to flatten the tree view.
127
        array_shift($titles);
128
      }
129

    
130
      // Remove all empty titles.
131
      $titles = array_filter($titles);
132

    
133
      if (!empty($titles)) {
134
        // Encode title, at least to keep "/" intact.
135
        $titles = array_map('urlencode', $titles);
136

    
137
        $set_document_title = drupal_json_encode(implode('/', $titles));
138
      }
139
    }
140

    
141
    // Add messages tracking.
142
    $message_events = '';
143
    if ($message_types = variable_get('piwik_trackmessages', array())) {
144
      $message_types = array_values(array_filter($message_types));
145
      $status_heading = array(
146
        'status' => t('Status message'),
147
        'warning' => t('Warning message'),
148
        'error' => t('Error message'),
149
      );
150

    
151
      foreach (drupal_get_messages(NULL, FALSE) as $type => $messages) {
152
        // Track only the selected message types.
153
        if (in_array($type, $message_types)) {
154
          foreach ($messages as $message) {
155
            $message_events .= '_paq.push(["trackEvent", ' . drupal_json_encode(t('Messages')) . ', ' . drupal_json_encode($status_heading[$type]) . ', ' . drupal_json_encode(strip_tags($message)) . ']);';
156
          }
157
        }
158
      }
159
    }
160

    
161
    // If this node is a translation of another node, pass the original
162
    // node instead.
163
    if (module_exists('translation') && variable_get('piwik_translation_set', 0)) {
164
      // Check we have a node object, it supports translation, and its
165
      // translated node ID (tnid) doesn't match its own node ID.
166
      $node = menu_get_object();
167
      if ($node && translation_supported_type($node->type) && !empty($node->tnid) && ($node->tnid != $node->nid)) {
168
        $source_node = node_load($node->tnid);
169
        $languages = language_list();
170
        $set_custom_url = drupal_json_encode(url('node/' . $source_node->nid, array('language' => $languages[$source_node->language], 'absolute' => TRUE)));
171
      }
172
    }
173

    
174
    // Track access denied (403) and file not found (404) pages.
175
    if ($status == '403 Forbidden') {
176
      $set_document_title = '"403/URL = " + encodeURIComponent(document.location.pathname+document.location.search) + "/From = " + encodeURIComponent(document.referrer)';
177
    }
178
    elseif ($status == '404 Not Found') {
179
      $set_document_title = '"404/URL = " + encodeURIComponent(document.location.pathname+document.location.search) + "/From = " + encodeURIComponent(document.referrer)';
180
    }
181

    
182
    // Add custom variables.
183
    $piwik_custom_vars = variable_get('piwik_custom_var', array());
184
    $custom_variable = '';
185
    for ($i = 1; $i < 6; $i++) {
186
      $custom_var_name = !empty($piwik_custom_vars['slots'][$i]['name']) ? $piwik_custom_vars['slots'][$i]['name'] : '';
187
      if (!empty($custom_var_name)) {
188
        $custom_var_value = !empty($piwik_custom_vars['slots'][$i]['value']) ? $piwik_custom_vars['slots'][$i]['value'] : '';
189
        $custom_var_scope = !empty($piwik_custom_vars['slots'][$i]['scope']) ? $piwik_custom_vars['slots'][$i]['scope'] : 'visit';
190

    
191
        $types = array();
192
        $node = menu_get_object();
193
        if (is_object($node)) {
194
          $types += array('node' => $node);
195
        }
196
        $custom_var_name = token_replace($custom_var_name, $types, array('clear' => TRUE));
197
        $custom_var_value = token_replace($custom_var_value, $types, array('clear' => TRUE));
198

    
199
        // Suppress empty custom names and/or variables.
200
        if (!drupal_strlen(trim($custom_var_name)) || !drupal_strlen(trim($custom_var_value))) {
201
          continue;
202
        }
203

    
204
        // Custom variables names and values are limited to 200 characters in
205
        // length. It is recommended to store values that are as small as
206
        // possible to ensure that the Piwik Tracking request URL doesn't go
207
        // over the URL limit for the webserver or browser.
208
        $custom_var_name = rtrim(substr($custom_var_name, 0, 200));
209
        $custom_var_value = rtrim(substr($custom_var_value, 0, 200));
210

    
211
        $custom_var_name = drupal_json_encode($custom_var_name);
212
        $custom_var_value = drupal_json_encode($custom_var_value);
213
        $custom_var_scope = drupal_json_encode($custom_var_scope);
214
        $custom_variable .= "_paq.push(['setCustomVariable', $i, $custom_var_name, $custom_var_value, $custom_var_scope]);";
215
      }
216
    }
217

    
218
    // Add any custom code snippets if specified.
219
    $codesnippet_before = variable_get('piwik_codesnippet_before', '');
220
    $codesnippet_after = variable_get('piwik_codesnippet_after', '');
221

    
222
    // Build tracker code. See http://piwik.org/docs/javascript-tracking/#toc-asynchronous-tracking
223
    $script = 'var _paq = _paq || [];';
224
    $script .= '(function(){';
225
    $script .= 'var u=(("https:" == document.location.protocol) ? "' . check_url($url_https) . '" : "' . check_url($url_http) . '");';
226
    $script .= '_paq.push(["setSiteId", ' . drupal_json_encode(variable_get('piwik_site_id', '')) . ']);';
227
    $script .= '_paq.push(["setTrackerUrl", u+"piwik.php"]);';
228

    
229
    // Track logged in users across all devices.
230
    if (variable_get('piwik_trackuserid', 0) && user_is_logged_in()) {
231
      // The USER_ID value should be a unique, persistent, and non-personally
232
      // identifiable string identifier that represents a user or signed-in
233
      // account across devices.
234
      $script .= '_paq.push(["setUserId", ' . drupal_json_encode(drupal_base64_encode(drupal_get_hash_salt() . $user->uid)) . ']);';
235
    }
236

    
237
    // Set custom data.
238
    if (!empty($set_custom_data)) {
239
      foreach ($set_custom_data as $custom_data) {
240
        $script .= '_paq.push(["setCustomData", ' . $custom_data . ']);';
241
      }
242
    }
243
    // Set custom url.
244
    if (!empty($set_custom_url)) {
245
      $script .= '_paq.push(["setCustomUrl", ' . $set_custom_url . ']);';
246
    }
247
    // Set custom document title.
248
    if (!empty($set_document_title)) {
249
      $script .= '_paq.push(["setDocumentTitle", ' . $set_document_title . ']);';
250
    }
251

    
252
    // Custom file download extensions.
253
    if ((variable_get('piwik_track', 1)) && !(variable_get('piwik_trackfiles_extensions', PIWIK_TRACKFILES_EXTENSIONS) == PIWIK_TRACKFILES_EXTENSIONS)) {
254
      $script .= '_paq.push(["setDownloadExtensions", ' . drupal_json_encode(variable_get('piwik_trackfiles_extensions', PIWIK_TRACKFILES_EXTENSIONS)) . ']);';
255
    }
256

    
257
    // Disable tracking for visitors who have opted out from tracking via DNT (Do-Not-Track) header.
258
    if (variable_get('piwik_privacy_donottrack', 1)) {
259
      $script .= '_paq.push(["setDoNotTrack", 1]);';
260
    }
261

    
262
    // Domain tracking type.
263
    global $cookie_domain;
264
    $domain_mode = variable_get('piwik_domain_mode', 0);
265

    
266
    // Per RFC 2109, cookie domains must contain at least one dot other than the
267
    // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
268
    if ($domain_mode == 1 && count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
269
      $script .= '_paq.push(["setCookieDomain", ' . drupal_json_encode($cookie_domain) . ']);';
270
    }
271

    
272
    // Ordering $custom_variable before $codesnippet_before allows users to add
273
    // custom code snippets that may use deleteCustomVariable() and/or getCustomVariable().
274
    if (!empty($custom_variable)) {
275
      $script .= $custom_variable;
276
    }
277
    if (!empty($codesnippet_before)) {
278
      $script .= $codesnippet_before;
279
    }
280

    
281
    // Site search tracking support.
282
    // NOTE: It's recommended not to call trackPageView() on the Site Search Result page.
283
    if (module_exists('search') && variable_get('piwik_site_search', FALSE) && arg(0) == 'search' && $keys = piwik_search_get_keys()) {
284
      // Parameters:
285
      // 1. Search keyword searched for. Example: "Banana"
286
      // 2. Search category selected in your search engine. If you do not need
287
      //    this, set to false. Example: "Organic Food"
288
      // 3. Number of results on the Search results page. Zero indicates a
289
      //    'No Result Search Keyword'. Set to false if you don't know.
290
      //
291
      // hook_preprocess_search_results() is not executed if search result is
292
      // empty. Make sure the counter is set to 0 if there are no results.
293
      $script .= '_paq.push(["trackSiteSearch", ' . drupal_json_encode($keys) . ', false, (window.piwik_search_results) ? window.piwik_search_results : 0]);';
294
    }
295
    else {
296
      $script .= '_paq.push(["trackPageView"]);';
297
    }
298

    
299
    // Add link tracking.
300
    if (variable_get('piwik_track', 1)) {
301
      // Disable tracking of links with ".no-tracking" and ".colorbox" classes.
302
      $ignore_classes = array(
303
        'no-tracking',
304
        'colorbox',
305
      );
306
      // Disable the download & outlink tracking for specific CSS classes.
307
      // Custom code snippets with 'setIgnoreClasses' will override the value.
308
      // http://developer.piwik.org/api-reference/tracking-javascript#disable-the-download-amp-outlink-tracking-for-specific-css-classes
309
      $script .= '_paq.push(["setIgnoreClasses", ' . drupal_json_encode($ignore_classes) . ']);';
310

    
311
      // Enable download & outlink link tracking.
312
      $script .= '_paq.push(["enableLinkTracking"]);';
313
    }
314

    
315
    if (!empty($message_events)) {
316
      $script .= $message_events;
317
    }
318
    if (!empty($codesnippet_after)) {
319
      $script .= $codesnippet_after;
320
    }
321

    
322
    $script .= 'var d=document,';
323
    $script .= 'g=d.createElement("script"),';
324
    $script .= 's=d.getElementsByTagName("script")[0];';
325
    $script .= 'g.type="text/javascript";';
326
    $script .= 'g.defer=true;';
327
    $script .= 'g.async=true;';
328

    
329
    // Should a local cached copy of the tracking code be used?
330
    if (variable_get('piwik_cache', 0) && $url = _piwik_cache($url_http . 'piwik.js')) {
331
      // A dummy query-string is added to filenames, to gain control over
332
      // browser-caching. The string changes on every update or full cache
333
      // flush, forcing browsers to load a new copy of the files, as the
334
      // URL changed.
335
      $query_string = '?' . variable_get('css_js_query_string', '0');
336

    
337
      $script .= 'g.src="' . $url . $query_string . '";';
338
    }
339
    else {
340
      $script .= 'g.src=u+"piwik.js";';
341
    }
342

    
343
    $script .= 's.parentNode.insertBefore(g,s);';
344
    $script .= '})();';
345

    
346
    // Add tracker code to scope.
347
    drupal_add_js($script, array('scope' => $scope, 'type' => 'inline'));
348
  }
349
}
350

    
351
/**
352
 * Implements hook_field_extra_fields().
353
 */
354
function piwik_field_extra_fields() {
355
  $extra['user']['user']['form']['piwik'] = array(
356
    'label' => t('Piwik configuration'),
357
    'description' => t('Piwik module form element.'),
358
    'weight' => 3,
359
  );
360

    
361
  return $extra;
362
}
363

    
364
/**
365
 * Implement hook_form_FORM_ID_alter().
366
 *
367
 * Allow users to decide if tracking code will be added to pages or not.
368
 */
369
function piwik_form_user_profile_form_alter(&$form, &$form_state) {
370
  $account = $form['#user'];
371
  $category = $form['#user_category'];
372

    
373
  if ($category == 'account' && user_access('opt-in or out of tracking') && ($custom = variable_get('piwik_custom', 0)) != 0 && _piwik_visibility_roles($account)) {
374
    $form['piwik'] = array(
375
      '#type' => 'fieldset',
376
      '#title' => t('Piwik configuration'),
377
      '#weight' => 3,
378
      '#collapsible' => TRUE,
379
      '#tree' => TRUE
380
    );
381

    
382
    switch ($custom) {
383
      case 1:
384
        $description = t('Users are tracked by default, but you are able to opt out.');
385
        break;
386

    
387
      case 2:
388
        $description = t('Users are <em>not</em> tracked by default, but you are able to opt in.');
389
        break;
390
    }
391

    
392
    $form['piwik']['custom'] = array(
393
      '#type' => 'checkbox',
394
      '#title' => t('Enable user tracking'),
395
      '#description' => $description,
396
      '#default_value' => isset($account->data['piwik']['custom']) ? $account->data['piwik']['custom'] : ($custom == 1),
397
    );
398

    
399
    return $form;
400
  }
401
}
402

    
403
/**
404
 * Implements hook_user_presave().
405
 */
406
function piwik_user_presave(&$edit, $account, $category) {
407
  if (isset($edit['piwik']['custom'])) {
408
    $edit['data']['piwik']['custom'] = $edit['piwik']['custom'];
409
  }
410
}
411

    
412
/**
413
 * Implements hook_cron().
414
 */
415
function piwik_cron() {
416
  // Regenerate the piwik.js every day.
417
  if (REQUEST_TIME - variable_get('piwik_last_cache', 0) >= 86400 && variable_get('piwik_cache', 0)) {
418
    _piwik_cache(variable_get('piwik_url_http', '') . 'piwik.js', TRUE);
419
    variable_set('piwik_last_cache', REQUEST_TIME);
420
  }
421
}
422

    
423
/**
424
 * Implements hook_preprocess_search_results().
425
 *
426
 * Collects and adds the number of search results to the head.
427
 */
428
function piwik_preprocess_search_results(&$variables) {
429
  // There is no search result $variable available that hold the number of items
430
  // found. But the pager item mumber can tell the number of search results.
431
  global $pager_total_items;
432

    
433
  drupal_add_js('window.piwik_search_results = ' . intval($pager_total_items[0]) . ';', array('type' => 'inline', 'group' => JS_LIBRARY-1));
434
}
435

    
436
/**
437
 * Download/Synchronize/Cache tracking code file locally.
438
 *
439
 * @param $location
440
 *   The full URL to the external javascript file.
441
 * @param $sync_cached_file
442
 *   Synchronize tracking code and update if remote file have changed.
443
 * @return mixed
444
 *   The path to the local javascript file on success, boolean FALSE on failure.
445
 */
446
function _piwik_cache($location, $sync_cached_file = FALSE) {
447
  $path = 'public://piwik';
448
  $file_destination = $path . '/' . basename($location);
449

    
450
  if (!file_exists($file_destination) || $sync_cached_file) {
451
    // Download the latest tracking code.
452
    $result = drupal_http_request($location);
453

    
454
    if ($result->code == 200) {
455
      if (file_exists($file_destination)) {
456
        // Synchronize tracking code and and replace local file if outdated.
457
        $data_hash_local = drupal_hash_base64(file_get_contents($file_destination));
458
        $data_hash_remote = drupal_hash_base64($result->data);
459
        // Check that the files directory is writable.
460
        if ($data_hash_local != $data_hash_remote && file_prepare_directory($path)) {
461
          // Save updated tracking code file to disk.
462
          file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
463
          watchdog('piwik', 'Locally cached tracking code file has been updated.', array(), WATCHDOG_INFO);
464

    
465
          // Change query-strings on css/js files to enforce reload for all users.
466
          _drupal_flush_css_js();
467
        }
468
      }
469
      else {
470
        // Check that the files directory is writable.
471
        if (file_prepare_directory($path, FILE_CREATE_DIRECTORY)) {
472
          // There is no need to flush JS here as core refreshes JS caches
473
          // automatically, if new files are added.
474
          file_unmanaged_save_data($result->data, $file_destination, FILE_EXISTS_REPLACE);
475
          watchdog('piwik', 'Locally cached tracking code file has been saved.', array(), WATCHDOG_INFO);
476

    
477
          // Return the local JS file path.
478
          return file_create_url($file_destination);
479
        }
480
      }
481
    }
482
  }
483
  else {
484
    // Return the local JS file path.
485
    return file_create_url($file_destination);
486
  }
487
}
488

    
489
/**
490
 * Delete cached files and directory.
491
 */
492
function piwik_clear_js_cache() {
493
  $path = 'public://piwik';
494
  if (file_prepare_directory($path)) {
495
    file_scan_directory($path, '/.*/', array('callback' => 'file_unmanaged_delete'));
496
    drupal_rmdir($path);
497

    
498
    // Change query-strings on css/js files to enforce reload for all users.
499
    _drupal_flush_css_js();
500

    
501
    watchdog('piwik', 'Local cache has been purged.', array(), WATCHDOG_INFO);
502
  }
503
}
504

    
505
/**
506
 * Helper function for grabbing search keys. Function is missing in D7.
507
 *
508
 * http://api.drupal.org/api/function/search_get_keys/6
509
 */
510
function piwik_search_get_keys() {
511
  static $return;
512
  if (!isset($return)) {
513
    // Extract keys as remainder of path
514
    // Note: support old GET format of searches for existing links.
515
    $path = explode('/', $_GET['q'], 3);
516
    $keys = empty($_REQUEST['keys']) ? '' : $_REQUEST['keys'];
517
    $return = count($path) == 3 ? $path[2] : $keys;
518
  }
519
  return $return;
520
}
521

    
522
/**
523
 * Tracking visibility check for an user object.
524
 *
525
 * @param $account
526
 *   A user object containing an array of roles to check.
527
 * @return boolean
528
 *   A decision on if the current user is being tracked by Piwik.
529
 */
530
function _piwik_visibility_user($account) {
531

    
532
  $enabled = FALSE;
533

    
534
  // Is current user a member of a role that should be tracked?
535
  if (_piwik_visibility_roles($account)) {
536

    
537
    // Use the user's block visibility setting, if necessary.
538
    if (($custom = variable_get('piwik_custom', 0)) != 0) {
539
      if ($account->uid && isset($account->data['piwik']['custom'])) {
540
        $enabled = $account->data['piwik']['custom'];
541
      }
542
      else {
543
        $enabled = ($custom == 1);
544
      }
545
    }
546
    else {
547
      $enabled = TRUE;
548
    }
549

    
550
  }
551

    
552
  return $enabled;
553
}
554

    
555
/**
556
 * Based on visibility setting this function returns TRUE if GA code should
557
 * be added for the current role and otherwise FALSE.
558
 */
559
function _piwik_visibility_roles($account) {
560

    
561
  $visibility = variable_get('piwik_visibility_roles', 0);
562
  $enabled = $visibility;
563
  $roles = variable_get('piwik_roles', array());
564

    
565
  if (array_sum($roles) > 0) {
566
    // One or more roles are selected.
567
    foreach (array_keys($account->roles) as $rid) {
568
      // Is the current user a member of one of these roles?
569
      if (isset($roles[$rid]) && $rid == $roles[$rid]) {
570
        // Current user is a member of a role that should be tracked/excluded from tracking.
571
        $enabled = !$visibility;
572
        break;
573
      }
574
    }
575
  }
576
  else {
577
    // No role is selected for tracking, therefore all roles should be tracked.
578
    $enabled = TRUE;
579
  }
580

    
581
  return $enabled;
582
}
583

    
584
/**
585
 * Based on visibility setting this function returns TRUE if GA code should
586
 * be added to the current page and otherwise FALSE.
587
 */
588
function _piwik_visibility_pages() {
589
  static $page_match;
590

    
591
  // Cache visibility setting in hook_init for hook_footer.
592
  if (!isset($page_match)) {
593

    
594
    $visibility = variable_get('piwik_visibility_pages', 0);
595
    $setting_pages = variable_get('piwik_pages', PIWIK_PAGES);
596

    
597
    // Match path if necessary.
598
    if (!empty($setting_pages)) {
599
      // Convert path to lowercase. This allows comparison of the same path
600
      // with different case. Ex: /Page, /page, /PAGE.
601
      $pages = drupal_strtolower($setting_pages);
602
      if ($visibility < 2) {
603
        // Convert the Drupal path to lowercase
604
        $path = drupal_strtolower(drupal_get_path_alias($_GET['q']));
605
        // Compare the lowercase internal and lowercase path alias (if any).
606
        $page_match = drupal_match_path($path, $pages);
607
        if ($path != $_GET['q']) {
608
          $page_match = $page_match || drupal_match_path($_GET['q'], $pages);
609
        }
610
        // When $visibility has a value of 0, the tracking code is displayed on
611
        // all pages except those listed in $pages. When set to 1, it
612
        // is displayed only on those pages listed in $pages.
613
        $page_match = !($visibility xor $page_match);
614
      }
615
      elseif (module_exists('php')) {
616
        $page_match = php_eval($setting_pages);
617
      }
618
      else {
619
        $page_match = FALSE;
620
      }
621
    }
622
    else {
623
      $page_match = TRUE;
624
    }
625

    
626
  }
627
  return $page_match;
628
}
629

    
630
/**
631
 * Get the page titles trail for the current page.
632
 *
633
 * Based on menu_get_active_breadcrumb().
634
 *
635
 * @return array
636
 *   All page titles, including current page.
637
 */
638
function _piwik_get_hierarchy_titles() {
639
  $titles = array();
640

    
641
  // No breadcrumb for the front page.
642
  if (drupal_is_front_page()) {
643
    return $titles;
644
  }
645

    
646
  $item = menu_get_item();
647
  if (!empty($item['access'])) {
648
    $active_trail = menu_get_active_trail();
649

    
650
    // Allow modules to alter the breadcrumb, if possible, as that is much
651
    // faster than rebuilding an entirely new active trail.
652
    drupal_alter('menu_breadcrumb', $active_trail, $item);
653

    
654
    // Remove the tab root (parent) if the current path links to its parent.
655
    // Normally, the tab root link is included in the breadcrumb, as soon as we
656
    // are on a local task or any other child link. However, if we are on a
657
    // default local task (e.g., node/%/view), then we do not want the tab root
658
    // link (e.g., node/%) to appear, as it would be identical to the current
659
    // page. Since this behavior also needs to work recursively (i.e., on
660
    // default local tasks of default local tasks), and since the last non-task
661
    // link in the trail is used as page title (see menu_get_active_title()),
662
    // this condition cannot be cleanly integrated into menu_get_active_trail().
663
    // menu_get_active_trail() already skips all links that link to their parent
664
    // (commonly MENU_DEFAULT_LOCAL_TASK). In order to also hide the parent link
665
    // itself, we always remove the last link in the trail, if the current
666
    // router item links to its parent.
667
    if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
668
      array_pop($active_trail);
669
    }
670

    
671
    foreach ($active_trail as $parent) {
672
      $titles[] = $parent['title'];
673
    }
674
  }
675

    
676
  return $titles;
677
}