TrackingCodeCustomizer.php

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\Plugins\TrackingCodeCustomizer;

/**
         * HOOK DOCUMENTATION
         * Present in >=v2.9.0 /piwik/core/Tracker/TrackerCodeGenerator.php
         * https://github.com/piwik/piwik/blob/master/core/Tracker/TrackerCodeGenerator.php
         * Triggered when generating JavaScript tracking code server side. Plugins can use
         * this event to customise the JavaScript tracking code that is displayed to the
         * user.
         *
         * @param array &$codeImpl An array containing snippets of code that the event handler
         *                         can modify. Will contain the following elements:
         *
         *                         - **idSite**: The ID of the site being tracked.
         *                         - **piwikUrl**: The tracker URL to use.
         *                         - **options**: A string of JavaScript code that customises
         *                                        the JavaScript tracker.
         *                         - **optionsBeforeTrackerUrl**: A string of Javascript code that customises
         *                                        the JavaScript tracker inside of anonymous function before
         *                                        adding setTrackerUrl into paq.
         *                         - **protocol**: Piwik url protocol.
         *
         *                         The **httpsPiwikUrl** element can be set if the HTTPS
         *                         domain is different from the normal domain.
         * @param array $parameters The parameters supplied to `TrackerCodeGenerator::generate()`.
         
*/

class TrackingCodeCustomizer extends \Piwik\Plugin
{
    private static $hooks = array(
            'Piwik.getJavascriptCode' => 'applyTrackingCodeCustomizations',
            'Controller.CoreAdminHome.setPluginSettings.end' => 'rewriteJavascriptFiles',
            'API.SitesManager.getJavascriptTag.end' => 'rewriteJavascriptTag',
            'Controller.SitesManager.siteWithoutData.end' => 'rewriteJavascriptTag',
            'CoreUpdater.update.end' => 'afterUpdate'
        );
    
    //2.15 includes a new function for registering hooks. 2.15 wi
    public function registerEvents()
    {
        return self::$hooks;
    }
    
    //Pre 2.15 hook registration. Will be removed in Piwik 3. Kept for backwards compatibility with 2.12.
    //Pre ver3 will still call this in addition to registerEvents.
    //From reviewing the Piwik source this shouldn't be an issue as the hooks are not additive and this call will just overwrite the registerEvents call.
    public function getListHooksRegistered()
    {
        return self::$hooks;
    }
    
    /*
    * @param array &$sysparams 
    *        @key int idSite
    *        @key string piwikUrl
    *        @key string options
    *        @key string optionsBeforeTrackerUrl
    *        @key string protocol
    * @param array $parameters
    *        @key bool mergeSubdomains
    *        @key bool groupPageTitlesByDomain
    *        @key bool mergeAliasUrls
    *        @key bool visitorCustomVariables
    *        @key bool pageCustomVariables
    *        @key bool customCampaignNameQueryParam
    *        @key bool customCampaignKeywordParam
    *        @key bool doNotTrack
    **/
    public function applyTrackingCodeCustomizations(&$sysparams,$parameters){
        
        $originalSysparams = $sysparams;
        $storedSettings = $this->getSettings();
        
        if(array_key_exists("options", $storedSettings)) {
            $storedSettings["options"] .= $sysparams["options"];
        }

        if(array_key_exists("optionsBeforeTrackerUrl", $storedSettings)) {
            $storedSettings["optionsBeforeTrackerUrl"] .= $sysparams["optionsBeforeTrackerUrl"];
        }

        $sysparams = array_merge($sysparams, $storedSettings);
        
        foreach($sysparams as $key => $value){
            $sysparams[$key] =  $this->replaceTokens($value,$originalSysparams,$sysparams);
        }
    
    }

    /**
     * @param $subject
     * @param $originalSysparams
     * @param $sysparams
     * @return mixed
     */
    private function replaceTokens($subject,$originalSysparams,$sysparams){
        $output = str_replace(array_map(function($item){return '{$original_'.$item.'}';},array_keys($originalSysparams)),array_values($originalSysparams),$subject);
        $output = str_replace(array_map(function($item){return '{$'.$item.'}';},array_keys($sysparams)),array_values($sysparams),$output);
        return $output;
    }

    /**
     * @return array
     */
    protected function getSettings() {
        $settings = API::getInstance();
        $storedSettings = $settings->getSettings();
        return $storedSettings;
    }

    /**
     * @return string
     */
    protected function getTrackingCodeFile() {
        return $trackingCodeFile = PIWIK_INCLUDE_PATH . "/piwik.js";
    }

    /**
     *
     */
    public function afterUpdate() {

        // cleanup old original file
        $oldOriginalCodeFile = $this->getTrackingCodeFile() . ".original";
        if(file_exists($oldOriginalCodeFile)) {
            unlink($oldOriginalCodeFile);
        }

        $this->rewriteJavascriptFiles();
    }

    /**
     *
     */
    public function rewriteJavascriptFiles() {
        $trackingCodeFile = $this->getTrackingCodeFile();

        if(is_writeable($trackingCodeFile)) {
            $trackingCodeFileOriginal = $trackingCodeFile . ".original";

            if (!file_exists($trackingCodeFileOriginal)) {
                copy($trackingCodeFile, $trackingCodeFileOriginal);
            }

            $trackingCode = file_get_contents($trackingCodeFileOriginal);

            $settings = $this->getSettings();

            if (array_key_exists("paqVariable", $settings)) {
                $trackingCode = str_replace("_paq", $settings["paqVariable"], $trackingCode);
            }

            if (array_key_exists("piwikJs", $settings)) {
                $trackingCode = str_replace("piwik.js", $settings["piwikJs"], $trackingCode);
            }

            if (array_key_exists("piwikPhp", $settings)) {
                $trackingCode = str_replace("piwik.php", $settings["piwikPhp"], $trackingCode);
            }

            file_put_contents($trackingCodeFile, $trackingCode);
        }
    }

    /**
     * @param $result
     * @param $parameters
     */
    public function rewriteJavascriptTag(&$result, $parameters) {

        $settings = $this->getSettings();

        if(array_key_exists("paqVariable", $settings)) {
            $result = str_replace("_paq", $settings["paqVariable"], $result);
        }

        if(array_key_exists("piwikJs", $settings)) {
            $result = str_replace("piwik.js", $settings["piwikJs"], $result);
        }

        if(array_key_exists("piwikPhp", $settings)) {
            $result = str_replace("piwik.php", $settings["piwikPhp"], $result);
        }

        if(array_key_exists("removePiwikBranding", $settings)) {
            $result = preg_replace('/&lt;\!\-\- .* \-\-&gt;/', '', $result);
        }
    }
}