piwik/piwik.php

   1 <?php
   2 /**
   3  * Name: Piwik Analytics
   4  * Description: Piwik Analytics Addon for Friendica
   5  * Version: 1.3
   6  * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
   7  * Author: Klaus Weidenbach
   8  */
   9
  10 /*   Piwik Analytics Addon for Friendica
  11  *
  12  *   Author: Tobias Diekershoff
  13  *           tobias.diekershoff@gmx.net
  14  *
  15  *   License: 3-clause BSD license
  16  *
  17  *   Configuration:
  18  *     Use the administration panel to configure the Piwik tracking addon, or
  19  *     in case you don't use this add the following lines to your .htconfig.php
  20  *     file:
  21  *
  22  *     $a->config['piwik']['baseurl'] = 'www.example.com/piwik/';
  23  *     $a->config['piwik']['siteid'] = '1';
  24  *     $a->config['piwik']['optout'] = true;  // set to false to disable
  25  *     $a->config['piwik']['async'] = false;  // set to true to enable
  26  *
  27  *     Change the siteid to the ID that the Piwik tracker for your Friendica
  28  *     installation has. Alter the baseurl to fit your needs, don't care
  29  *     about http/https but beware to put the trailing / at the end of your
  30  *     setting.
  31  */
  32 use Friendica\Core\Addon;
  33 use Friendica\Core\Config;
  34
  35 function piwik_install() {
  36         Addon::registerHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  37
  38         logger("installed piwik addon");
  39 }
  40
  41 function piwik_uninstall() {
  42         Addon::unregisterHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  43
  44         logger("uninstalled piwik addon");
  45 }
  46
  47 function piwik_analytics($a,&$b) {
  48
  49         /*
  50          *   styling of every HTML block added by this addon is done in the
  51          *   associated CSS file. We just have to tell Friendica to get it
  52          *   into the page header.
  53          */
  54         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />';
  55
  56         /*
  57          *   Get the configuration variables from the .htconfig file.
  58          */
  59         $baseurl = Config::get('piwik','baseurl');
  60         $siteid  = Config::get('piwik','siteid');
  61         $optout  = Config::get('piwik','optout');
  62         $async   = Config::get('piwik','async');
  63
  64         /*
  65          *   Add the Piwik tracking code for the site.
  66          *   If async is set to true use asynchronous tracking
  67          */
  68         if ($async) {
  69           $b .= "<!-- Piwik --> <script type=\"text/javascript\"> var _paq = _paq || []; _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u=((\"https:\" == document.location.protocol) ? \"https\" : \"http\") + \"://".$baseurl."\"; _paq.push(['setTrackerUrl', u+'piwik.php']); _paq.push(['setSiteId', ".$siteid."]); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Piwik Code -->\r\n";
  70           $b .= "<div id='piwik-code-block'> <!-- Piwik -->\r\n<noscript><p><img src=\"//".$baseurl."piwik.php?idsite=".$siteid."\" style=\"border:0\" alt=\"\" /></p></noscript>\r\n <!-- End Piwik Tracking Tag --> </div>";
  71         } else {
  72           $b .= "<!-- Piwik --> <script type=\"text/javascript\"> var _paq = _paq || []; _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u=((\"https:\" == document.location.protocol) ? \"https\" : \"http\") + \"://".$baseurl."\"; _paq.push(['setTrackerUrl', u+'piwik.php']); _paq.push(['setSiteId', ".$siteid."]); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=false; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Piwik Code -->\r\n";
  73         }
  74
  75         /*
  76          *   If the optout variable is set to true then display the notice
  77          *   otherwise just include the above code into the page.
  78          */
  79         if ($optout) {
  80                 $b .= "<div id='piwik-optout-link'>";
  81                 $b .= t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
  82                 $b .= " ";
  83                 $the_url =  "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
  84                 $b .= sprintf(t("If you do not want that your visits are logged in this way you <a href='%s'>can set a cookie to prevent Piwik from tracking further visits of the site</a> (opt-out)."), $the_url);
  85                 $b .= "</div>";
  86         }
  87 }
  88 function piwik_addon_admin (&$a, &$o) {
  89         $t = get_markup_template( "admin.tpl", "addon/piwik/" );
  90         $o = replace_macros( $t, [
  91                 '$submit' => t('Save Settings'),
  92                 '$piwikbaseurl' => ['baseurl', t('Piwik Base URL'), Config::get('piwik','baseurl' ), t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')],
  93                 '$siteid' => ['siteid', t('Site ID'), Config::get('piwik','siteid' ), ''],
  94                 '$optout' => ['optout', t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
  95                 '$async' => ['async', t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
  96         ]);
  97 }
  98 function piwik_addon_admin_post (&$a) {
  99         $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : '');
 100         $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
 101         $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
 102         $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
 103         Config::set('piwik', 'baseurl', $url);
 104         Config::set('piwik', 'siteid', $id);
 105         Config::set('piwik', 'optout', $optout);
 106         Config::set('piwik', 'async', $async);
 107         info( t('Settings updated.'). EOL);
 108 }