GoogleAnalyticsConnector.cs

using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using DotNetNuke.Services.Analytics.Config;
using DotNetNuke.Services.Connections;
using DotNetNuke.Services.Exceptions;
using DotNetNuke.Services.Localization;

namespace MikeSmeltzer.Connectors.ConnectorExample
{
    public class GoogleAnalyticsConnector : IConnector
    {
        #region Properties

        private const string DefaultDisplayName = "Google Analytics Connector Example";

        public string Name
        {
            get { return "Google Analytics Connector Example"; }
        }

        private string _displayName;

        public string DisplayName
        {
            get
            {
                return
                    string.IsNullOrEmpty(_displayName) ? DefaultDisplayName : _displayName;
            }

            set { _displayName = value; }
        }

        public string IconUrl
        {
            get { return "~/icons/sigma/GoogleAnalytics_32X32_Standard.png"; }
        }

        public string PluginFolder
        {
            get { return "~/DesktopModules/MikeSmeltzer/ConnectorExample/"; }
        }

        public bool IsEngageConnector
        {
            get
            {
                return false;
            }
        }

        public string Id { get; set; }

        public ConnectorCategories Type => ConnectorCategories.Analytics;

        public bool SupportsMultiple => false;

        #endregion

        #region Public Methods
        public IEnumerable<IConnector> GetConnectors(int portalId)
        {

            return new List<IConnector> { this };

        }

        public void DeleteConnector(int portalId)
        {
           
        }

        public bool HasConfig(int portalId)
        {
            IDictionary<string, string> config = GetConfig(portalId);

            return (config.ContainsKey("TrackingID") && !String.IsNullOrEmpty(config["TrackingID"].ToString()));

        }

        public IDictionary<string, string> GetConfig(int portalId)
        {

            var analyticsConfig = AnalyticsConfiguration.GetConfig("GoogleAnalytics");
            var trackingId = String.Empty;
            var urlParameter = String.Empty;
            var trackForAdmin = false;

            if (analyticsConfig != null)
            {

                foreach (AnalyticsSetting setting in analyticsConfig.Settings)
                {
                    switch (setting.SettingName.ToLower())
                    {
                        case "trackingid":
                            trackingId = setting.SettingValue;
                            break;
                        case "urlparameter":
                            urlParameter = setting.SettingValue;
                            break;
                        case "trackforadmin":
                            if (!bool.TryParse(setting.SettingValue, out trackForAdmin))
                            {
                                trackForAdmin = true;
                            }
                            break;
                    }
                }
            }

            var configItems = new Dictionary<string, string>
            {
                { "TrackingID", trackingId },
                { "UrlParameter", urlParameter},
                { "TrackAdministrators", trackForAdmin.ToString()}
            };

            return configItems;
        }

        public bool SaveConfig(int portalId, IDictionary<string, string> values, ref bool validated, out string customErrorMessage)
        {
            customErrorMessage = string.Empty;
            bool isValid;

            try
            {

                string trackingID = values["TrackingID"].ToString().Trim();
                string urlParameter = values["UrlParameter"].ToString().Trim();
                bool trackForAdmin = false;

                trackForAdmin = bool.TryParse(values["TrackAdministrators"].ToLowerInvariant(), out trackForAdmin);

                if (!String.IsNullOrEmpty(trackingID) && IsValidGoogleAnalyticsCode(trackingID))
                {

                    isValid = true;

                    var config = new AnalyticsConfiguration
                    {
                        Settings = new AnalyticsSettingCollection()
                    };

                    var setting = new AnalyticsSetting
                    {
                        SettingName = "TrackingId",
                        SettingValue = trackingID
                    };

                    config.Settings.Add(setting);

                    setting = new AnalyticsSetting
                    {
                        SettingName = "UrlParameter",
                        SettingValue = urlParameter
                    };

                    config.Settings.Add(setting);

                    setting = new AnalyticsSetting
                    {
                        SettingName = "TrackForAdmin",
                        SettingValue = trackForAdmin.ToString().ToLowerInvariant()
                    };

                    config.Settings.Add(setting);

                    AnalyticsConfiguration.SaveConfig("GoogleAnalytics", config);

                } else
                {

                    customErrorMessage = Localization.GetString("TrackingCodeFormat.ErrorMessage", Constants.LocalResourceFile);

                    isValid = false;
                }

                return isValid;
            }
            catch (Exception ex)
            {
                Exceptions.LogException(ex);
                return false;
            }
        }

        #endregion

        #region Private Methods

        private bool IsValidGoogleAnalyticsCode(string trackingCode)
        {

            bool isValid = false;

            isValid = Regex.IsMatch(trackingCode, "^ua-\\d{4,10}(-\\d{1,4})?$");

            return isValid;
        }

        #endregion
    }
}