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 config/addon.ini.php
  20  *     file:
  21  *
  22  *     [piwik]
  23  *     baseurl = example.com/piwik/
  24  *     sideid = 1
  25  *     optout = true ;set to false to disable
  26  *     async = false ;set to true to enable
  27  *
  28  *     Change the siteid to the ID that the Piwik tracker for your Friendica
  29  *     installation has. Alter the baseurl to fit your needs, don't care
  30  *     about http/https but beware to put the trailing / at the end of your
  31  *     setting.
  32  */
  33 use Friendica\Core\Addon;
  34 use Friendica\Core\Config;
  35 use Friendica\Core\L10n;
  36 use Friendica\Core\Logger;
  37 use Friendica\Core\Renderer;
  38 use Friendica\Util\Strings;
  39
  40 function piwik_install() {
  41         Addon::registerHook('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
  42         Addon::registerHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  43
  44         Logger::log("installed piwik addon");
  45 }
  46
  47 function piwik_uninstall() {
  48         Addon::unregisterHook('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
  49         Addon::unregisterHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  50
  51         Logger::log("uninstalled piwik addon");
  52 }
  53
  54 function piwik_load_config(\Friendica\App $a)
  55 {
  56         $a->loadConfigFile(__DIR__. '/config/piwik.ini.php');
  57 }
  58
  59 function piwik_analytics($a,&$b) {
  60
  61         /*
  62          *   styling of every HTML block added by this addon is done in the
  63          *   associated CSS file. We just have to tell Friendica to get it
  64          *   into the page header.
  65          */
  66         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->getBaseURL() . '/addon/piwik/piwik.css' . '" media="all" />';
  67
  68         /*
  69          *   Get the configuration variables from the config/addon.ini.php file.
  70          */
  71         $baseurl = Config::get('piwik', 'baseurl');
  72         $siteid  = Config::get('piwik', 'siteid');
  73         $optout  = Config::get('piwik', 'optout');
  74         $async   = Config::get('piwik', 'async');
  75
  76         /*
  77          *   Add the Piwik tracking code for the site.
  78          *   If async is set to true use asynchronous tracking
  79          */
  80         if ($async) {
  81           $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";
  82           $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>";
  83         } else {
  84           $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";
  85         }
  86
  87         /*
  88          *   If the optout variable is set to true then display the notice
  89          *   otherwise just include the above code into the page.
  90          */
  91         if ($optout) {
  92                 $b .= "<div id='piwik-optout-link'>";
  93                 $b .= L10n::t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
  94                 $b .= " ";
  95                 $the_url =  "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
  96                 $b .= L10n::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);
  97                 $b .= "</div>";
  98         }
  99 }
 100 function piwik_addon_admin (&$a, &$o) {
 101         $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
 102         $o = Renderer::replaceMacros( $t, [
 103                 '$submit' => L10n::t('Save Settings'),
 104                 '$piwikbaseurl' => ['baseurl', L10n::t('Piwik Base URL'), Config::get('piwik','baseurl' ), L10n::t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')],
 105                 '$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
 106                 '$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
 107                 '$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
 108         ]);
 109 }
 110 function piwik_addon_admin_post (&$a) {
 111         $url = ((x($_POST, 'baseurl')) ? Strings::removeTags(trim($_POST['baseurl'])) : '');
 112         $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
 113         $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
 114         $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
 115         Config::set('piwik', 'baseurl', $url);
 116         Config::set('piwik', 'siteid', $id);
 117         Config::set('piwik', 'optout', $optout);
 118         Config::set('piwik', 'async', $async);
 119         info(L10n::t('Settings updated.'). EOL);
 120 }