plugins/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
  51 class GoogleAnalyticsPlugin extends Plugin
  52 {
  53     var $code = null;
  54
  55     function __construct($code=null)
  56     {
  57         $this->code = $code;
  58         parent::__construct();
  59     }
  60
  61     function onEndShowScripts($action)
  62     {
  63         $js1 = 'var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");'.
  64           'document.write(unescape("%3Cscript src=\'" + gaJsHost + "google-analytics.com/ga.js\' type=\'text/javascript\'%3E%3C/script%3E"));';
  65         $js2 = sprintf('try{'.
  66                        'var pageTracker = _gat._getTracker("%s");'.
  67                        'pageTracker._trackPageview();'.
  68                        '} catch(err) {}',
  69                        $this->code);
  70         $action->inlineScript($js1);
  71         $action->inlineScript($js2);
  72     }
  73
  74     function onPluginVersion(&$versions)
  75     {
  76         $versions[] = array('name' => 'GoogleAnalytics',
  77                             'version' => STATUSNET_VERSION,
  78                             'author' => 'Evan Prodromou',
  79                             'homepage' => 'http://status.net/wiki/Plugin:GoogleAnalytics',
  80                             'rawdescription' =>
  81                             _m('Use <a href="http://www.google.com/analytics/">Google Analytics</a>'.
  82                                ' to track Web access.'));
  83         return true;
  84     }
  85 }