piwik/piwik.php

   1 <?php
   2 /**
   3  * Name: Matomo / Piwik Analytics
   4  * Description: Matomo / 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.config.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
  34 use Friendica\Core\Config;
  35 use Friendica\Core\Hook;
  36 use Friendica\Core\L10n;
  37 use Friendica\Core\Logger;
  38 use Friendica\Core\Renderer;
  39 use Friendica\Util\Config\ConfigFileLoader;
  40 use Friendica\Util\Strings;
  41
  42 function piwik_install() {
  43         Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
  44         Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  45
  46         Logger::log("installed piwik addon");
  47 }
  48
  49 function piwik_uninstall() {
  50         Hook::unregister('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
  51         Hook::unregister('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  52
  53         Logger::log("uninstalled piwik addon");
  54 }
  55
  56 function piwik_load_config(\Friendica\App $a, ConfigFileLoader $loader)
  57 {
  58         $a->getConfigCache()->load($loader->loadAddonConfig('piwik'));
  59 }
  60
  61 function piwik_analytics($a,&$b) {
  62
  63         /*
  64          *   styling of every HTML block added by this addon is done in the
  65          *   associated CSS file. We just have to tell Friendica to get it
  66          *   into the page header.
  67          */
  68         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->getBaseURL() . '/addon/piwik/piwik.css' . '" media="all" />';
  69
  70         /*
  71          *   Get the configuration variables from the config/addon.config.php file.
  72          */
  73         $baseurl = Config::get('piwik', 'baseurl');
  74         $siteid  = Config::get('piwik', 'siteid');
  75         $optout  = Config::get('piwik', 'optout');
  76         $async   = Config::get('piwik', 'async');
  77
  78         /*
  79          *   Add the Piwik tracking code for the site.
  80          *   If async is set to true use asynchronous tracking
  81          */
  82         if ($async) {
  83           $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";
  84           $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>";
  85         } else {
  86           $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";
  87         }
  88
  89         /*
  90          *   If the optout variable is set to true then display the notice
  91          *   otherwise just include the above code into the page.
  92          */
  93         if ($optout) {
  94                 $b .= "<div id='piwik-optout-link'>";
  95                 $b .= L10n::t("This website is tracked using the <a href='http://www.matomo.org'>Matomo</a> analytics tool.");
  96                 $b .= " ";
  97                 $the_url =  "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
  98                 $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 Matomo / Piwik from tracking further visits of the site</a> (opt-out).", $the_url);
  99                 $b .= "</div>";
 100         }
 101 }
 102 function piwik_addon_admin (&$a, &$o) {
 103         $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
 104         $o = Renderer::replaceMacros( $t, [
 105                 '$submit' => L10n::t('Save Settings'),
 106                 '$piwikbaseurl' => ['baseurl', L10n::t('Matomo (Piwik) Base URL'), Config::get('piwik','baseurl' ), L10n::t('Absolute path to your Matomo (Piwik) installation. (without protocol (http/s), with trailing slash)')],
 107                 '$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
 108                 '$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
 109                 '$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
 110         ]);
 111 }
 112 function piwik_addon_admin_post (&$a) {
 113         $url = (!empty($_POST['baseurl']) ? Strings::escapeTags(trim($_POST['baseurl'])) : '');
 114         $id = (!empty($_POST['siteid']) ? trim($_POST['siteid']) : '');
 115         $optout = (!empty($_POST['optout']) ? trim($_POST['optout']) : '');
 116         $async = (!empty($_POST['async']) ? trim($_POST['async']) : '');
 117         Config::set('piwik', 'baseurl', $url);
 118         Config::set('piwik', 'siteid', $id);
 119         Config::set('piwik', 'optout', $optout);
 120         Config::set('piwik', 'async', $async);
 121         info(L10n::t('Settings updated.'). EOL);
 122 }