nystudio107\instantanalytics\services\IA

Complexity

Total Complexity

72

Size/Duplication

Total Lines	497
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getGlobals()	0	10	2
A	pageViewAnalytics()	0	17	2
A	getGclid()	0	11	3
A	eventAnalytics()	0	19	2
A	pageViewTrackingUrl()	0	16	1
D	documentPathFromUrl()	0	36	10
D	getAnalyticsObj()	0	73	13
A	eventTrackingUrl()	0	17	1
D	shouldSendAnalytics()	0	133	31
A	analytics()	0	9	1
A	gaGenUUID()	0	20	1
B	gaParseCookie()	0	18	5

<?php
/**
 * Instant Analytics plugin for Craft CMS 3.x
 *
 * Instant Analytics brings full Google Analytics support to your Twig templates
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2017 nystudio107
 */

namespace nystudio107\instantanalytics\services;

use nystudio107\instantanalytics\InstantAnalytics;
use nystudio107\instantanalytics\helpers\IAnalytics;
use nystudio107\instantanalytics\models\Settings;

use Jaybizzle\CrawlerDetect\CrawlerDetect;

use Craft;
use craft\base\Component;
use craft\elements\User as UserElement;
use craft\helpers\UrlHelper;

use yii\base\Exception;

/**
 * IA Service
 *
 * All of your plugin’s business logic should go in services, including saving
 * data, retrieving data, etc. They provide APIs that your controllers,
 * template variables, and other plugins can interact with.
 *
 * https://craftcms.com/docs/plugins/services
 *
 * @author    nystudio107
 * @package   InstantAnalytics
 * @since     1.0.0
 */
class IA extends Component
{
    // Public Methods
    // =========================================================================

    protected $cachedAnalytics = null;

    /**
     * Get the global variables for our Twig context
     *
     * @param $title
     *
     * @return IAnalytics
     */
    public function getGlobals($title)
    {
        if ($this->cachedAnalytics) {
            $analytics = $this->cachedAnalytics;
        } else {
            $analytics = $this->pageViewAnalytics("", $title);
            $this->cachedAnalytics = $analytics;
        }

        return $analytics;
    }

    /**
     * Get a PageView analytics object
     *
     * @param string $url
     * @param string $title
     *
     * @return null|IAnalytics
     */
    public function pageViewAnalytics($url = "", $title = "")
    {
        $result = null;
        $analytics = $this->analytics();
        if ($analytics) {
            $url = $this->documentPathFromUrl($url);
            // Prepare the Analytics object, and send the pageview
            $analytics->setDocumentPath($url)
                ->setDocumentTitle($title);
            $result = $analytics;
            Craft::info(
                "Created sendPageView for `" . $url . "` - `" . $title . "`",
                __METHOD__
            );
        }

        return $result;
    }

    /**
     * Get an Event analytics object
     *
     * @param string $eventCategory
     * @param string $eventAction
     * @param string $eventLabel
     * @param int    $eventValue
     *
     * @return null|IAnalytics
     */
    public function eventAnalytics($eventCategory = "", $eventAction = "", $eventLabel = "", $eventValue = 0)
    {
        $result = null;
        $analytics = $this->analytics();
        if ($analytics) {
            $url = $this->documentPathFromUrl();
            $analytics->setDocumentPath($url)
                ->setEventCategory($eventCategory)
                ->setEventAction($eventAction)
                ->setEventLabel($eventLabel)
                ->setEventValue(intval($eventValue));
            $result = $analytics;
            Craft::info(
                "Created sendEvent for `" . $eventCategory . "` - `" . $eventAction . "` - `" . $eventLabel . "` - `" . $eventValue . "`",
                __METHOD__
            );
        }

        return $result;
    }

    /**
     * getAnalyticsObject() return an analytics object
     *
     * @return IAnalytics object
     */
    public function analytics()
    {
        $analytics = $this->getAnalyticsObj();
        Craft::info(
            "Created generic analytics object",
            __METHOD__
        );

        return $analytics;
    }

    /**
     * Get a PageView tracking URL
     *
     * @param $url
     * @param $title
     *
     * @return string
     * @throws \yii\base\Exception
     */
    public function pageViewTrackingUrl($url, $title)
    {
        $urlParams = [
            'url'   => $url,
            'title' => $title,
        ];
        $path = parse_url($url, PHP_URL_PATH);
        $pathFragments = explode('/', rtrim($path, '/'));
        $fileName = end($pathFragments);
        $trackingUrl = UrlHelper::siteUrl('instantanalytics/pageViewTrack/' . $fileName, $urlParams);
        Craft::info(
            "Created pageViewTrackingUrl for " . $trackingUrl,
            __METHOD__
        );

        return $trackingUrl;
    }

    /**
     * Get an Event tracking URL
     *
     * @param        $url
     * @param string $eventCategory
     * @param string $eventAction
     * @param string $eventLabel
     * @param int    $eventValue
     *
     * @return string
     * @throws \yii\base\Exception
     */
    public function eventTrackingUrl($url, $eventCategory = "", $eventAction = "", $eventLabel = "", $eventValue = 0)
    {
        $urlParams = [
            'url'           => $url,
            'eventCategory' => $eventCategory,
            'eventAction'   => $eventAction,
            'eventLabel'    => $eventLabel,
            'eventValue'    => $eventValue,
        ];
        $fileName = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_BASENAME);
        $trackingUrl = UrlHelper::siteUrl('instantanalytics/eventTrack/' . $fileName, $urlParams);
        Craft::info(
            "Created eventTrackingUrl for " . $trackingUrl,
            __METHOD__
        );

        return $trackingUrl;
    }

    /**
     * _shouldSendAnalytics determines whether we should be sending Google
     * Analytics data
     *
     * @return bool
     */
    public function shouldSendAnalytics()
    {
        $result = true;

        /** @var Settings $settings */
        $settings = InstantAnalytics::$plugin->getSettings();
        $request = Craft::$app->getRequest();
        $requestIp = $request->getUserIP();

        if (!$settings->sendAnalyticsData) {
            if ($settings->logExcludedAnalytics) {
                Craft::info(
                    "Analytics excluded for: " . $requestIp . " due to: `sendAnalyticsData`",
                    __METHOD__
                );
            }

            return false;
        }

        if (!$settings->sendAnalyticsInDevMode && Craft::$app->getConfig()->getGeneral()->devMode) {
            if ($settings->logExcludedAnalytics) {
                Craft::info(
                    "Analytics excluded for: " . $requestIp . " due to: `sendAnalyticsInDevMode`",
                    __METHOD__
                );
            }

            return false;
        }

        if ($request->getIsConsoleRequest()) {
            if ($settings->logExcludedAnalytics) {
                Craft::info(
                    "Analytics excluded for: " . $requestIp . " due to: `craft()->isConsole()`",
                    __METHOD__
                );
            }

            return false;
        }

        if ($request->getIsCpRequest()) {
            if ($settings->logExcludedAnalytics) {
                Craft::info(
                    "Analytics excluded for: " . $requestIp . " due to: `craft()->request->isCpRequest()`",
                    __METHOD__
                );
            }

            return false;
        }

        if ($request->getIsLivePreview()) {
            if ($settings->logExcludedAnalytics) {
                Craft::info(
                    "Analytics excluded for: " . $requestIp . " due to: `craft()->request->isLivePreview()`",
                    __METHOD__
                );
            }

            return false;
        }

        // Check the $_SERVER[] super-global exclusions
        if (isset($settings->serverExcludes) && is_array($settings->serverExcludes)) {
            foreach ($settings->serverExcludes as $match => $matchArray) {
                if (isset($_SERVER[$match])) {
                    foreach ($matchArray as $matchItem) {
                        if (preg_match($matchItem, $_SERVER[$match])) {
                            if ($settings->logExcludedAnalytics) {
                                Craft::info(
                                    "Analytics excluded for: " . $requestIp . " due to: `serverExcludes`",
                                    __METHOD__
                                );
                            }

                            return false;
                        }
                    }
                }
            }
        }

        // Filter out bot/spam requests via UserAgent
        if ($settings->filterBotUserAgents) {
            $crawlerDetect = new CrawlerDetect;
            // Check the user agent of the current 'visitor'
            if ($crawlerDetect->isCrawler()) {
                if ($settings->logExcludedAnalytics) {
                    Craft::info(
                        "Analytics excluded for: " . $requestIp . " due to: `filterBotUserAgents`",
                        __METHOD__
                    );
                }

                return false;
            }
        }

        // Filter by user group
        $userService = Craft::$app->getUser();
        /** @var UserElement $user */
        $user = $userService->getIdentity();
        if ($user) {
            if ($settings->adminExclude && $user->admin) {
                if ($settings->logExcludedAnalytics) {
                    Craft::info(
                        "Analytics excluded for: " . $requestIp . " due to: `adminExclude`",
                        __METHOD__
                    );
                }

                return false;
            }

            if (isset($settings->groupExcludes) && is_array($settings->groupExcludes)) {
                foreach ($settings->groupExcludes as $matchItem) {
                    if ($user->isInGroup($matchItem)) {
                        if ($settings->logExcludedAnalytics) {
                            Craft::info(
                                "Analytics excluded for: " . $requestIp . " due to: `groupExcludes`",
                                __METHOD__
                            );
                        }

                        return false;
                    }
                }
            }
        }

        return $result;
    }

    /**
     * Return a sanitized documentPath from a URL
     *
     * @param $url
     *
     * @return bool|string
     */
    protected function documentPathFromUrl($url = '')
    {
        if ($url == "") {
            $url = Craft::$app->getRequest()->getFullPath();
        }

        // We want to send just a path to GA for page views
        if (UrlHelper::isAbsoluteUrl($url)) {
            $urlParts = parse_url($url);
            if (isset($urlParts['path'])) {
                $url = $urlParts['path'];
            } else {
                $url = "/";
            }
            if (isset($urlParts['query'])) {
                $url = $url."?".$urlParts['query'];
            }
        }

        // We don't want to send protocol-relative URLs either
        if (UrlHelper::isProtocolRelativeUrl($url)) {
            $url = substr($url, 1);
        }

        // Strip the query string if that's the global config setting
        $settings = InstantAnalytics::$plugin->getSettings();
        if (isset($settings) && isset($settings->stripQueryString) && $settings->stripQueryString) {
            $url = UrlHelper::stripQueryString($url);
        }

        // We always want the path to be / rather than empty
        if ($url == "") {
            $url = "/";
        }

        return $url;
    }

    /**
     * Get the Google Analytics object, primed with the default values
     *
     * @return IAnalytics object
     */
    private function getAnalyticsObj()
    {
        $analytics = null;
        $settings = InstantAnalytics::$plugin->getSettings();
        $request = Craft::$app->getRequest();
        if (isset($settings) && !empty($settings->googleAnalyticsTracking)) {
            $analytics = new IAnalytics();
            if ($analytics) {
                $hostName = $request->getServerName();
                if (empty($hostName)) {
                    try {
                        $hostName = parse_url(UrlHelper::siteUrl(), PHP_URL_HOST);
                    } catch (Exception $e) {
                        Craft::error(
                            $e->getMessage(),
                            __METHOD__
                        );
                    }
                }
                $userAgent = $request->getUserAgent();
                if (empty($userAgent)) {
                    $userAgent = "User-Agent:Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.13) Gecko/20080311 Firefox/2.0.0.13\r\n";
                }
                $referrer = $request->getReferrer();
                if (empty($referrer)) {
                    $referrer = "";
                }
                $analytics->setProtocolVersion('1')
                    ->setTrackingId($settings->googleAnalyticsTracking)
                    ->setIpOverride($request->getUserIP())
                    ->setUserAgentOverride($userAgent)
                    ->setDocumentHostName($hostName)
                    ->setDocumentReferrer($referrer)
                    ->setAsyncRequest(false)
                    ->setClientId($this->gaParseCookie());

                // Set the gclid
                $gclid = $this->getGclid();
                if ($gclid) {
                    $analytics->setGoogleAdwordsId($gclid);
                }

                // Handle UTM parameters
                $utm_source = $request->getParam('utm_source');
                if (!empty($utm_source)) {
                    $analytics->setCampaignSource($utm_source);
                }
                $utm_medium = $request->getParam('utm_medium');
                if (!empty($utm_medium)) {
                    $analytics->setCampaignMedium($utm_medium);
                }
                $utm_campaign = $request->getParam('utm_campaign');
                if (!empty($utm_campaign)) {
                    $analytics->setCampaignName($utm_campaign);
                }
                $utm_content = $request->getParam('utm_content');
                if (!empty($utm_content)) {
                    $analytics->setCampaignContent($utm_content);
                }

                // If SEOmatic is installed, set the affiliation as well
                // TODO: handle Seomatic
                /*
                $seomatic = craft()->plugins->getPlugin('Seomatic');
                if ($seomatic && $seomatic->isInstalled && $seomatic->isEnabled) {
                    $seomaticSettings = craft()->seomatic->getSettings(craft()->language);
                    $analytics->setAffiliation($seomaticSettings['siteSeoName']);
                }
                */
            }
        }

        return $analytics;
    } /* -- _getAnalyticsObj */

    /**
     * _getGclid get the `gclid` and sets the 'gclid' cookie
     */
    /**
     * _getGclid get the `gclid` and sets the 'gclid' cookie
     *
     * @return string
     */
    private function getGclid()
    {
        $gclid = "";
        if (isset($_GET['gclid'])) {
            $gclid = $_GET['gclid'];
            if (!empty($gclid)) {
                setcookie("gclid", $gclid, time() + (10 * 365 * 24 * 60 * 60), "/");
            }
        }

        return $gclid;
    }

    /**
     * gaParseCookie handles the parsing of the _ga cookie or setting it to a
     * unique identifier
     *
     * @return string the cid
     */
    private function gaParseCookie()
    {
        $cid = '';
        if (isset($_COOKIE['_ga'])) {
            $parts = preg_split('[\.]', $_COOKIE["_ga"], 4);
            if ($parts !== false) {
                $cid = implode('.', array_slice($parts, 2));
            }
        } else {
            if (isset($_COOKIE['_ia']) && $_COOKIE['_ia'] != '') {
                $cid = $_COOKIE['_ia'];
            } else {
                $cid = $this->gaGenUUID();
            }
        }
        setcookie('_ia', $cid, time() + 60 * 60 * 24 * 730, "/"); // Two years

        return $cid;
    }

    /**
     * gaGenUUID Generate UUID v4 function - needed to generate a CID when one
     * isn't available
     *
     * @return string The generated UUID
     */
    private function gaGenUUID()
    {
        return sprintf(
            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
            // 32 bits for "time_low"
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff),
            // 16 bits for "time_mid"
            mt_rand(0, 0xffff),
            // 16 bits for "time_hi_and_version",
            // four most significant bits holds version number 4
            mt_rand(0, 0x0fff) | 0x4000,
            // 16 bits, 8 bits for "clk_seq_hi_res",
            // 8 bits for "clk_seq_low",
            // two most significant bits holds zero and one for variant DCE1.1
            mt_rand(0, 0x3fff) | 0x8000,
            // 48 bits for "node"
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff)
        );
    }
}