plugins/GoogleAnalytics/GoogleAnalyticsPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to use Google Analytics
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Plugin to use Google Analytics
  36  *
  37  * This plugin will spoot out the correct JavaScript spell to invoke Google Analytics on a page.
  38  *
  39  * Note that Google Analytics is not compatible with the Franklin Street Statement; consider using
  40  * Piwik (http://www.piwik.org/) instead!
  41  *
  42  * @category Plugin
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  *
  48  * @see      Event
  49  */
  50 class GoogleAnalyticsPlugin extends Plugin
  51 {
  52     var $code;
  53     var $domain;
  54
  55     const VERSION = '0.2';
  56
  57     function __construct($code=null)
  58     {
  59         if (!empty($code)) {
  60             global $config;
  61             $config['googleanalytics']['code'] = $code;
  62         }
  63
  64         parent::__construct();
  65     }
  66
  67     function onEndShowScripts(Action $action)
  68     {
  69         $code = common_config('googleanalytics', 'code');
  70         if (empty($code)) {
  71             $code = $this->code;
  72         }
  73         $domain = common_config('googleanalytics', 'domain');
  74         if (empty($domain)) {
  75             $domain = $this->domain;
  76         }
  77
  78         $js = <<<ENDOFSCRIPT0
  79
  80 var _gaq = _gaq || [];
  81 _gaq.push(['_setAccount', '{$code}']);
  82 _gaq.push(['_trackPageview']);
  83
  84 ENDOFSCRIPT0;
  85
  86 if (!empty($domain)) {
  87         $js .= <<<ENDOFSCRIPT1
  88
  89 _gaq.push(['_setDomainName', '{$domain}']);
  90 _gaq.push(['_setAllowHash', false]);
  91
  92 ENDOFSCRIPT1;
  93 }
  94
  95         $js .= <<<ENDOFSCRIPT2
  96
  97 (function() {
  98    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  99    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 100    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 101 })();
 102
 103 ENDOFSCRIPT2;
 104
 105        $action->inlineScript($js);
 106     }
 107
 108     function onPluginVersion(array &$versions)
 109     {
 110         $versions[] = array('name' => 'GoogleAnalytics',
 111                             'version' => self::VERSION,
 112                             'author' => 'Evan Prodromou',
 113                             'homepage' => 'http://status.net/wiki/Plugin:GoogleAnalytics',
 114                             'rawdescription' =>
 115                             // TRANS: Plugin description.
 116                             _m('Use <a href="http://www.google.com/analytics/">Google Analytics</a>'.
 117                                ' to track web access.'));
 118         return true;
 119     }
 120 }