Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Google Analytics: TrackAdmin, AnonymizeIp, and TrackUserID Support #2785

Merged
merged 5 commits into from
May 15, 2019
Merged

Google Analytics: TrackAdmin, AnonymizeIp, and TrackUserID Support #2785

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5d6d00e
fix TrackAdmin setting always saving as true. add anonymizeIp and tra…
ohine May 14, 2019
ea8e78c
Allow anonymizeIp and trackingUserId to both be enabled.
ohine May 14, 2019
0091655
fixes issues discovered during code review.
ohine May 14, 2019
58c6fce
update syntax for SaveConfig
ohine May 14, 2019
42a509e
fixed ESLint warnings.
ohine May 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions DNN Platform/Connectors/GoogleAnalytics/App_LocalResources/SharedResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,10 @@
<data name="UrlParameter.Text" xml:space="preserve">
<value>Url Parameter:</value>
</data>
<data name="AnonymizeIp.Text" xml:space="preserve">
<value>Anonymize IP:</value>
</data>
<data name="TrackUserId.Text" xml:space="preserve">
<value>Track UserID:</value>
</data>
</root>
5 changes: 4 additions & 1 deletion DNN Platform/Connectors/GoogleAnalytics/GoogleAnalyticsConnector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ public IDictionary<string, string> GetConfig(int portalId)
{ "TrackingID", trackingId },
{ "UrlParameter", urlParameter},
{ "TrackAdministrators", trackForAdmin.ToString()},
{ "AnonymizeIp", trackForAdmin.ToString()},
{ "TrackUserId", trackForAdmin.ToString()},
ohine marked this conversation as resolved.
Show resolved Hide resolved
{ "isDeactivating", false.ToString()}
};

Expand Down Expand Up @@ -158,7 +160,8 @@ public bool SaveConfig(int portalId, IDictionary<string, string> values, ref boo

trackingID = values["TrackingID"] != null ? values["TrackingID"].ToString().Trim() : String.Empty;
urlParameter = values["UrlParameter"] != null ? values["UrlParameter"].ToString().Trim() : String.Empty;
trackForAdmin = bool.TryParse(values["TrackAdministrators"].ToLowerInvariant(), out trackForAdmin);

bool.TryParse(values["TrackAdministrators"].ToLowerInvariant(), out trackForAdmin);
ohine marked this conversation as resolved.
Show resolved Hide resolved

if (String.IsNullOrEmpty(trackingID))
{
Expand Down
5 changes: 3 additions & 2 deletions DNN Platform/Connectors/GoogleAnalytics/Scripts/connector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ define(["jquery", "knockout", "templatePath/scripts/config", "templatePath/scrip

// Convert boolean to string as the API requires a dictionary of string values
conn.configurations[2].value(conn.configurations[2].value().toString());

conn.configurations[3].value(conn.configurations[3].value().toString());
conn.configurations[4].value(conn.configurations[4].value().toString());
}

var onSaveComplete = function (conn, id) {
Expand Down Expand Up @@ -105,7 +106,7 @@ define(["jquery", "knockout", "templatePath/scripts/config", "templatePath/scrip

// Set the isDeactivating flag to true to override the default save behaviour
// Temporary workaround until delete functionality on connectors is improved
conn.configurations[3].value("true");
conn.configurations[5].value("true");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way to get away from mysterious numbers defining these values?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, It's something I'd also like to fix, but I didn't have time this morning to look into the configuration property in the connector engine. I'm looking at it now to see if we can remove those and replace them with the name of the setting.

wasDeactivated = true;
conn.save(conn, e, onSaveComplete.bind(this, conn, conn.id));
}
Expand Down
10 changes: 10 additions & 0 deletions DNN Platform/Connectors/GoogleAnalytics/connector.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@
<input id="chkTrackAdmins" type="checkbox" data-bind="checked: configurations[2].value, checkedValue: configurations[2].value" />
</div>

<div>
<label for="chkAnonymizeIp" data-bind="html: configurations[3].localizedName"></label>
<input id="chkAnonymizeIp" type="checkbox" data-bind="checked: configurations[3].value, checkedValue: configurations[3].value" />
</div>

<div>
<label for="chkTrackUserId" data-bind="html: configurations[4].localizedName"></label>
<input id="chkTrackUserId" type="checkbox" data-bind="checked: configurations[4]].value, checkedValue: configurations[4].value" />
ohine marked this conversation as resolved.
Show resolved Hide resolved
</div>

<div class="clear"></div>

</div>
47 changes: 47 additions & 0 deletions DNN Platform/Library/Services/Analytics/GoogleAnalyticsEngine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,52 @@ public override string RenderScript(string scriptTemplate)
scriptTemplate = scriptTemplate.Replace("[CUSTOM_SCRIPT]", RenderCustomScript(config));
return scriptTemplate;
}

public override string RenderCustomScript(AnalyticsConfiguration config)
{
try
{
bool anonymize = false;
bool trackingUserId = false;

foreach (AnalyticsSetting setting in config.Settings)
{
switch (setting.SettingName.ToLowerInvariant())
{
case "anonymizeip":
{
bool.TryParse(setting.SettingValue, out anonymize);
break;
}
case "trackinguser":
{
bool.TryParse(setting.SettingValue, out trackingUserId);
break;
}
}
}


var sb = new System.Text.StringBuilder();
if (anonymize)
{
sb.Append("ga('set', 'anonymizeIp', true);");
}

if (trackingUserId)
{
sb.AppendFormat("ga('set', 'userId', {0});", UserController.Instance.GetCurrentUserInfo().UserID);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this check if they're logged in? or do we want to track -1?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I grabbed that code from my old GA extension, and it was running for all users in that extension.

However, I can see pros/cons for either way. I'm good with -1 for guests or adding a check IsAuthenticated prior to setting the UserId var in GA. Whichever sounds best to the @dnnsoftware/approvers i'll make happen with another commit.

}

return sb.ToString();
}
catch (Exception ex)
{
Exceptions.Exceptions.LogException(ex);

return string.Empty;
}
}

}
}