Documentation patch

For anyone who doesn't feel comfortable patching a file or reading a patched file. I've posted a new version of the read me followed by the current version at: http://privatepaste.com/41IfqYSi17

Also. You actually don't even need to patch the file to see what changes I'm doing. You can open the file in a text editor. Lines preceeded by a "+" are added and those with a "-" are deleted.

Shai

hass, great.

I'm attaching a new patch for the README.txt which just talks about the new tracking role functionality in general. This is in response to Greggles. Removed all the warning stuff I had previously written etc.

The new patch is also against the most recent dev version.

I'm also attaching a new file UPGRADE.txt as Greggles suggested which is where the warning info goes.

I had deleted that line about automatically not counting the admin stuff by accident. (Hass, what will happen if the site admin deletes the admin pages from the page settings set by default via the block visibility like settings?)

I like the idea of the drupal_set_message() in a googleanalytics_update_ID() but I'm not up to it right now.

Shai

@hass

1. Users must check their role settings after the upgrade!

Oops. I fixed that.

2. You are telling users to check "page specific settings". I haven't done any logic change here. I only added configurable paths that have been hardcoded in past ("admin*") and added some more paths as they seems to be bad in tracking and may create privacy issues. I don't know why we should track users editing their nodes and so on and this is why the filter have been extended to

admin*
user*
node/add*
node/*/*

3. It wasn't very wrong that you removed the admin path line... but i think we should change the line to document the new default settings from #2. This way users are able to restore this value them self after a change and don't need to ask us and we are able to tell them to RTFM.

I've changed the README.txt usage section to describe the new page tracking feature per your suggestion. See the new patch attached.

4. "If no boxes are checked, the code will be placed on all pages." is specific to the next 1.5, not 1.4. In 1.4 - nothing get's tracked if no role is checked...

I'm assuming that the new UPGRADE.txt and README.txt will be for 1.5 and I've gone through both files and made clear what changes are 1.4 and 1.5. Please review and let me know if I got it right. @Hass: Any chance you'd be up to creating a CHANGELOG.txt for this module. That might help alleviate some of the confusion.

I've removed the "See the following issue..."

The new README patch (ga_new_document3.patch) is against the new 5-18 dev version.

To do: per your suggestion at: http://drupal.org/node/248075#comment-845791 I think it would be great to improve my sample code snippet at: http://drupal.org/node/248075#comment-845538. It would be nice to have a code snippet ready to go that allowed for both opt-out role filtering as in 1.3 AND allowed for path specific settings. By choosing the custom php for visibility settings in 1.5 the admin loses the possibility of using the path visibility functionality.

We're gettin' there.

Shai
content2zero

Hmm,

The attachments I included in #10 got stripped when I used the preview button, arghh. I'm attaching them here.

@hass

1.5

Done. See attached patch.

@hass:

I tried it yesterday night, but something was wrong...

It is it throwing an error or is it not delivering the tracking code on the right pages? '

Remember that the roles included in the array are just sample role names, they need to be replaced with real role names from the specific Drupal install.

Shai

Post what you've done and I can try it, take a look as well.

Hass,

How about this way:

<?php
global $user;
// These are the roles that should not get the Google Analytics tracker code on pages they visit. Replace 'staff' etc. with your own roles you want to opt out.
$hide_roles = array('staff','webmaster','editor');

// Assume all roles will have Google Analytics code.
$show_ga = TRUE;

// Check the user to see if she is assigned a role which is in the hide_ga array. If so, set show_ga to FALSE.
foreach($user->roles as $role){
  if(in_array($role, $hide_roles)) {
    $show_ga = FALSE;
  }
}

// Tracking code visibility based on paths.

	$url = request_uri();
	if (strpos($url, 'admin')) {
	  $show_ga = FALSE;
	}
	
	if (strpos($url, 'user')) {
	  $show_ga = FALSE;
	}

	if (strpos($url, 'node') && strpos($url, 'edit')) {
	  $show_ga = FALSE;
	}

return $show_ga
?>

I tested it and it works for me.

Shai

This is a slight variation. It's better in that it reduces the chances that a url will be included in the don't show list simply because it has "admin", "node" or "user" in it's custom url by coincidence, not because it is one of those special pages. The downside to the following code is that it only works with clean urls turned on and you need to make slight modifications for clean urls off.

<?php
global $user;
// These are the roles that should not get the Google Analytics tracker code on pages they visit. Replace 'staff' etc. with your own roles you want to opt out.
$hide_roles = array('staff','webmaster','editor');

// Assume all roles and pages will have Google Analytics code.
$show_ga = TRUE;

// Check the user to see if she is assigned a role which is in the hide_ga array. If so, set show_ga to FALSE.
foreach($user->roles as $role){
  if(in_array($role, $hide_roles)) {
    $show_ga = FALSE;
  }
}

// Tracking code visibility based on paths.

	$url = request_uri();
	if (strpos($url, '/admin/')) {
	  $show_ga = FALSE;
	}
	
	if (strpos($url, '/user/')) {
	  $show_ga = FALSE;
	}

	if (strpos($url, '/node/') && strpos($url, '/edit')) {
	  $show_ga = FALSE;
	}

return $show_ga
?>

Shai
content2zero

@Hass, I looked at them and they look good. But I guess you want someone else to look at them. There is a missing word that I'd like to add to the UPGRADE.txt new file. I'll post that here soon.

Reminder: correct link to handbook http://drupal.org/node/261997

That's a reminder for yourself, yes?

I made some edits to the handbook page you created (only the explanation, didn't touch the code).

Shai