plugins/PiwikAnalyticsPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to use Piwik 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  * @author    Tobias Diekershoff <tobias.diekershoff@gmx.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Plugin to use Piwik Analytics (based on the Google Analytics plugin by Evan)
  37  *
  38  * This plugin will spoot out the correct JavaScript spell to invoke
  39  * Piwik Analytics on a page.
  40  *
  41  * To use this plugin add the following to your config.php
  42  *
  43  *  addPlugin('PiwikAnalytics', array('piwikroot' => 'example.com/piwik/',
  44  *                                    'piwikId' => 'id'));
  45  *
  46  * Replace 'example.com/piwik/' with the URL to your Piwik installation and
  47  * make sure you don't forget the final /.
  48  * Replace 'id' with the ID your statusnet installation has in your Piwik
  49  * analytics setup - for example '8'.
  50  *
  51  */
  52
  53 class PiwikAnalyticsPlugin extends Plugin
  54 {
  55     /** the base of your Piwik installation */
  56     public $piwikroot = null;
  57     /** the Piwik Id of your statusnet installation */
  58     public $piwikId   = null;
  59
  60     /**
  61      * constructor
  62      *
  63      * @param string $root Piwik root URL
  64      * @param string $id   Piwik ID of this app
  65      */
  66
  67     function __construct($root=null, $id=null)
  68     {
  69         $this->piwikroot = $root;
  70         $this->piwikId   = $id;
  71         parent::__construct();
  72     }
  73
  74     /**
  75      * Called when all scripts have been shown
  76      *
  77      * @param Action $action Current action
  78      *
  79      * @return boolean ignored
  80      */
  81
  82     function onEndShowScripts($action)
  83     {
  84         $piwikCode1 = <<<ENDOFPIWIK
  85 var pkBaseURL = (("https:" == document.location.protocol) ? "https://{$this->piwikroot}" : "http://{$this->piwikroot}");
  86 document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
  87 ENDOFPIWIK;
  88         $piwikCode2 = <<<ENDOFPIWIK
  89 try {
  90     var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", {$this->piwikId});
  91     piwikTracker.trackPageView();
  92     piwikTracker.enableLinkTracking();
  93 } catch( err ) {}
  94 ENDOFPIWIK;
  95
  96         $action->inlineScript($piwikCode1);
  97         $action->inlineScript($piwikCode2);
  98         return true;
  99     }
 100
 101     function onPluginVersion(&$versions)
 102     {
 103         $versions[] = array('name' => 'PiwikAnalytics',
 104                             'version' => STATUSNET_VERSION,
 105                             'author' => 'Tobias Diekershoff, Evan Prodromou',
 106                             'homepage' => 'http://status.net/wiki/Plugin:Piwik',
 107                             'rawdescription' =>
 108                             _m('Use <a href="http://piwik.org/">Piwik</a> Open Source Web analytics software.'));
 109         return true;
 110     }
 111
 112 }