Added support for Google's Universal Analytics

- Resolves VUFIND-993
- Includes upgrade warning
- Includes unit tests

config/vufind/config.ini

@@ -1054,9 +1054,13 @@ treeSearchLimit = 100
 ; field size in the tags database table.
 max_tag_length = 64
 
-; Uncomment this section and provide your API key to enable Google Analytics
+; Uncomment this section and provide your API key to enable Google Analytics. Be
+; sure to set the "universal" setting to true once your account is upgraded to
+; Universal Analytics; see:
+; https://developers.google.com/analytics/devguides/collection/upgrade/guide
 ;[GoogleAnalytics]
 ;apiKey = "mykey"
+;universal = false
 
 ; Uncomment portions of this section to activate tabs in the search box for switching
 ; between search modules. Keys are search backend names, values are labels for use in

module/VuFind/src/VuFind/Config/Upgrade.php

@@ -512,6 +512,16 @@ class Upgrade
                 . 'longer supported due to changes in Google APIs.'
             );
         }
+        if (isset($newConfig['GoogleAnalytics']['apiKey'])) {
+            if (!isset($newConfig['GoogleAnalytics']['universal'])
+                || !$newConfig['GoogleAnalytics']['universal']
+            ) {
+                $this->addWarning(
+                    'The [GoogleAnalytics] universal setting is off. See config.ini '
+                    . 'for important information on how to upgrade your Analytics.'
+                );
+            }
+        }
 
         // Disable unused, obsolete setting:
         unset($newConfig['Index']['local']);

module/VuFind/src/VuFind/View/Helper/Root/Factory.php

@@ -197,7 +197,9 @@ class Factory
         $config = $sm->getServiceLocator()->get('VuFind\Config')->get('config');
         $key = isset($config->GoogleAnalytics->apiKey)
             ? $config->GoogleAnalytics->apiKey : false;
-        return new GoogleAnalytics($key);
+        $universal = isset($config->GoogleAnalytics->universal)
+            ? $config->GoogleAnalytics->universal : false;
+        return new GoogleAnalytics($key, $universal);
     }
 
     /**

module/VuFind/src/VuFind/View/Helper/Root/GoogleAnalytics.php

@@ -45,14 +45,23 @@ class GoogleAnalytics extends \Zend\View\Helper\AbstractHelper
      */
     protected $key;
 
+    /**
+     * Are we using Universal Analytics?
+     *
+     * @var bool
+     */
+    protected $universal;
+
     /**
      * Constructor
      *
-     * @param string|bool $key API key (false if disabled)
+     * @param string|bool $key       API key (false if disabled)
+     * @param bool        $universal Are we using Universal Analytics?
      */
-    public function __construct($key)
+    public function __construct($key, $universal = false)
     {
         $this->key = $key;
+        $this->universal = $universal;
     }
 
     /**
@@ -65,18 +74,31 @@ class GoogleAnalytics extends \Zend\View\Helper\AbstractHelper
         if (!$this->key) {
             return '';
         }
-        $code = 'var key = "' . $this->key . '";' . "\n"
-            . "var _gaq = _gaq || [];\n"
-            . "_gaq.push(['_setAccount', key]);\n"
-            . "_gaq.push(['_trackPageview']);\n"
-            . "(function() {\n"
-            . "var ga = document.createElement('script'); "
-            . "ga.type = 'text/javascript'; ga.async = true;\n"
-            . "ga.src = ('https:' == document.location.protocol ? "
-            . "'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n"
-            . "var s = document.getElementsByTagName('script')[0]; "
-            . "s.parentNode.insertBefore(ga, s);\n"
-            . "})();";
+        if (!$this->universal) {
+            $code = 'var key = "' . $this->key . '";' . "\n"
+                . "var _gaq = _gaq || [];\n"
+                . "_gaq.push(['_setAccount', key]);\n"
+                . "_gaq.push(['_trackPageview']);\n"
+                . "(function() {\n"
+                . "var ga = document.createElement('script'); "
+                . "ga.type = 'text/javascript'; ga.async = true;\n"
+                . "ga.src = ('https:' == document.location.protocol ? "
+                . "'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n"
+                . "var s = document.getElementsByTagName('script')[0]; "
+                . "s.parentNode.insertBefore(ga, s);\n"
+                . "})();";
+        } else {
+            $code = '(function(i,s,o,g,r,a,m){'
+                . "i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){"
+                . '(i[r].q=i[r].q||[]).push(arguments)},'
+                . 'i[r].l=1*new Date();a=s.createElement(o),'
+                . 'm=s.getElementsByTagName(o)[0];a.async=1;a.src=g;'
+                . 'm.parentNode.insertBefore(a,m)'
+                . "})(window,document,'script',"
+                . "'//www.google-analytics.com/analytics.js','ga');"
+                . "ga('create', '{$this->key}', 'auto');"
+                . "ga('send', 'pageview');";
+        }
         $inlineScript = $this->getView()->plugin('inlinescript');
         return $inlineScript(\Zend\View\Helper\HeadScript::SCRIPT, $code, 'SET');
     }

module/VuFind/tests/fixtures/configs/googlewarnings/config.ini

+[GoogleAnalytics]
+apiKey = 'fake'
+
+[GoogleSearch]
+fake = fake
\ No newline at end of file

module/VuFind/tests/unit-tests/src/VuFindTest/Config/UpgradeTest.php

@@ -211,6 +211,32 @@ class UpgradeTest extends \VuFindTest\Unit\TestCase
         );
     }
 
+    /**
+     * Test Google-related warnings.
+     *
+     * @return void
+     */
+    public function testGoogleWarnings()
+    {
+        $upgrader = $this->getUpgrader('googlewarnings');
+        $upgrader->run();
+        $warnings = $upgrader->getWarnings();
+        $this->assertTrue(
+            in_array(
+                'The [GoogleSearch] section of config.ini is no '
+                . 'longer supported due to changes in Google APIs.',
+                $warnings
+            )
+        );
+        $this->assertTrue(
+            in_array(
+                'The [GoogleAnalytics] universal setting is off. See config.ini '
+                . 'for important information on how to upgrade your Analytics.',
+                $warnings
+            )
+        );
+    }
+
     /**
      * Test "meaningful line" detection in SolrMarc properties files.
      *

module/VuFind/tests/unit-tests/src/VuFindTest/View/Helper/Root/GoogleAnalyticsTest.php

+<?php
+/**
+ * GoogleAnalytics view helper Test Class
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2010.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * @category VuFind2
+ * @package  Tests
+ * @author   Demian Katz <demian.katz@villanova.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     http://vufind.org/wiki/vufind2:unit_tests Wiki
+ */
+namespace VuFindTest\View\Helper\Root;
+use VuFind\View\Helper\Root\GoogleAnalytics;
+
+/**
+ * GoogleAnalytics view helper Test Class
+ *
+ * @category VuFind2
+ * @package  Tests
+ * @author   Demian Katz <demian.katz@villanova.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     http://vufind.org/wiki/vufind2:unit_tests Wiki
+ */
+class GoogleAnalyticsTest extends \VuFindTest\Unit\ViewHelperTestCase
+{
+    /**
+     * Test the helper (old mode)
+     *
+     * @return void
+     */
+    public function testOldSetup()
+    {
+        $helper = new GoogleAnalytics('myfakekey', false);
+        $helper->setView($this->getPhpRenderer());
+        $output = $helper()->__toString();
+        $this->assertTrue(false !== strstr($output, 'ga.js'));
+        $this->assertFalse(strstr($output, 'analytics.js'));
+        $this->assertTrue(false !== strstr($output, 'myfakekey'));
+    }
+
+    /**
+     * Test the helper (Universal Analytics mode)
+     *
+     * @return void
+     */
+    public function testNewSetup()
+    {
+        $helper = new GoogleAnalytics('myfakekey', true);
+        $helper->setView($this->getPhpRenderer());
+        $output = $helper()->__toString();
+        $this->assertTrue(false !== strstr($output, 'analytics.js'));
+        $this->assertFalse(strstr($output, 'ga.js'));
+        $this->assertTrue(false !== strstr($output, 'myfakekey'));
+    }
+}
\ No newline at end of file