Merge branch 'master' of gitorious.org:statusnet/mainline into testing

[quix0rs-gnu-social.git] / plugins / PiwikAnalyticsPlugin.php

diff --git a/plugins/PiwikAnalyticsPlugin.php b/plugins/PiwikAnalyticsPlugin.php
index d2c52354ed0c688ca001f3c64732c6d1bd9422de..b353d725526920c22df02be716a374050159e7d4 100644 (file)
--- a/plugins/PiwikAnalyticsPlugin.php
+++ b/plugins/PiwikAnalyticsPlugin.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * Plugin to use Piwik Analytics
  *
@@ -20,15 +20,15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Plugin
- * @package   Laconica
- * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
  * @author    Tobias Diekershoff <tobias.diekershoff@gmx.net>
- * @copyright 2008 Control Yourself, Inc.
+ * @copyright 2008 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://laconi.ca/
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET')) {
     exit(1);
 }
 
@@ -38,30 +38,24 @@ if (!defined('LACONICA')) {
  * This plugin will spoot out the correct JavaScript spell to invoke
  * Piwik Analytics on a page.
  *
- * To use this plugin please add the following three lines to your config.php
+ * To use this plugin add the following to your config.php
  *
- *     require_once('plugins/PiwikAnalyticsPlugin.php');
- *     $pa = new PiwikAnalyticsPlugin("example.com/piwik/","id");
+ *  addPlugin('PiwikAnalytics', array('piwikroot' => 'example.com/piwik/',
+ *                                    'piwikId' => 'id'));
  *
- * exchange example.com/piwik/ with the url to your piwik installation and
- * make sure you don't forget the final /
- * exchange id with the ID your laconica installation has in your Piwik analytics
+ * Replace 'example.com/piwik/' with the URL to your Piwik installation and
+ * make sure you don't forget the final /.
+ * Replace 'id' with the ID your statusnet installation has in your Piwik
+ * analytics setup - for example '8'.
  *
- * @category Plugin
- * @package  Laconica
- * @author   Tobias Diekershoff <tobias.diekershoff@gmx.net>
- * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link     http://laconi.ca/
- *
- * @see      Event
  */
 
 class PiwikAnalyticsPlugin extends Plugin
 {
     /** the base of your Piwik installation */
-    var $piwikroot = null;
-    /** the Piwik Id of your laconica installation */
-    var $piwikId   = null;
+    public $piwikroot = null;
+    /** the Piwik Id of your statusnet installation */
+    public $piwikId   = null;
 
     /**
      * constructor
@@ -73,7 +67,7 @@ class PiwikAnalyticsPlugin extends Plugin
     function __construct($root=null, $id=null)
     {
         $this->piwikroot = $root;
-        $this->piwikid   = $id;
+        $this->piwikId   = $id;
         parent::__construct();
     }
 
@@ -87,18 +81,32 @@ class PiwikAnalyticsPlugin extends Plugin
 
     function onEndShowScripts($action)
     {
-        $js1 = 'var pkBaseURL = (("https:" == document.location.protocol) ? "https://'.
-                $this->piwikroot.'" : "http://'.$this->piwikroot.
-                '"); document.write(unescape("%3Cscript src=\'" + pkBaseURL + "piwik.js\''.
-                ' type=\'text/javascript\'%3E%3C/script%3E"));';
-        $js2 = 'piwik_action_name = ""; piwik_idsite = '.$this->piwikid.
-               '; piwik_url = pkBaseURL + "piwik.php"; piwik_log(piwik_action_name, piwik_idsite, piwik_url);';
-        $action->elementStart('script', array('type' => 'text/javascript'));
-        $action->raw($js1);
-        $action->elementEnd('script');
-        $action->elementStart('script', array('type' => 'text/javascript'));
-        $action->raw($js2);
-        $action->elementEnd('script');
+        $piwikCode1 = <<<ENDOFPIWIK
+var pkBaseURL = (("https:" == document.location.protocol) ? "https://{$this->piwikroot}" : "http://{$this->piwikroot}");
+document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+ENDOFPIWIK;
+        $piwikCode2 = <<<ENDOFPIWIK
+try {
+    var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", {$this->piwikId});
+    piwikTracker.trackPageView();
+    piwikTracker.enableLinkTracking();
+} catch( err ) {}
+ENDOFPIWIK;
+
+        $action->inlineScript($piwikCode1);
+        $action->inlineScript($piwikCode2);
+        return true;
+    }
+
+    function onPluginVersion(&$versions)
+    {
+        $versions[] = array('name' => 'PiwikAnalytics',
+                            'version' => STATUSNET_VERSION,
+                            'author' => 'Tobias Diekershoff, Evan Prodromou',
+                            'homepage' => 'http://status.net/wiki/Plugin:Piwik',
+                            'rawdescription' =>
+                            _m('Use <a href="http://piwik.org/">Piwik</a> Open Source Web analytics software.'));
         return true;
     }
-}
\ No newline at end of file
+
+}