plugins/PiwikAnalyticsPlugin.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Tobias Diekershoff <tobias.diekershoff@gmx.net>
  26  * @copyright 2008 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  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 please add the following three lines to your config.php
  42  *
  43  *     require_once('plugins/PiwikAnalyticsPlugin.php');
  44  *     $pa = new PiwikAnalyticsPlugin("example.com/piwik/","id");
  45  *
  46  * exchange example.com/piwik/ with the url to your piwik installation and
  47  * make sure you don't forget the final /
  48  * exchange id with the ID your laconica installation has in your Piwik analytics
  49  *
  50  * @category Plugin
  51  * @package  Laconica
  52  * @author   Tobias Diekershoff <tobias.diekershoff@gmx.net>
  53  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  54  * @link     http://laconi.ca/
  55  *
  56  * @see      Event
  57  */
  58
  59 class PiwikAnalyticsPlugin extends Plugin
  60 {
  61     /** the base of your Piwik installation */
  62     var $piwikroot = null;
  63     /** the Piwik Id of your laconica installation */
  64     var $piwikId   = null;
  65
  66     /**
  67      * constructor
  68      *
  69      * @param string $root Piwik root URL
  70      * @param string $id   Piwik ID of this app
  71      */
  72
  73     function __construct($root=null, $id=null)
  74     {
  75         $this->piwikroot = $root;
  76         $this->piwikid   = $id;
  77         parent::__construct();
  78     }
  79
  80     /**
  81      * Called when all scripts have been shown
  82      *
  83      * @param Action $action Current action
  84      *
  85      * @return boolean ignored
  86      */
  87
  88     function onEndShowScripts($action)
  89     {
  90         $js1 = 'var pkBaseURL = (("https:" == document.location.protocol) ? "https://'.
  91                 $this->piwikroot.'" : "http://'.$this->piwikroot.
  92                 '"); document.write(unescape("%3Cscript src=\'" + pkBaseURL + "piwik.js\''.
  93                 ' type=\'text/javascript\'%3E%3C/script%3E"));';
  94         $js2 = 'piwik_action_name = ""; piwik_idsite = '.$this->piwikid.
  95                '; piwik_url = pkBaseURL + "piwik.php"; piwik_log(piwik_action_name, piwik_idsite, piwik_url);';
  96         $action->elementStart('script', array('type' => 'text/javascript'));
  97         $action->raw($js1);
  98         $action->elementEnd('script');
  99         $action->elementStart('script', array('type' => 'text/javascript'));
 100         $action->raw($js2);
 101         $action->elementEnd('script');
 102         return true;
 103     }
 104 }