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/piwik.config.php
  20  *     file:
  21  *
  22  *      return [
  23  *          'piwik' => [
  24  *              'baseurl' => '',
  25  *              'sideid' => '',
  26  *              'optout' => true,
  27  *              'async' => false,
  28  *              'shortendpoint' => false,
  29  *          ],
  30  *      ];
  31  *
  32  *     Change the siteid to the ID that the Piwik tracker for your Friendica
  33  *     installation has. Alter the baseurl to fit your needs, don't care
  34  *     about http/https but beware to put the trailing / at the end of your
  35  *     setting.
  36  */
  37
  38 use Friendica\App;
  39 use Friendica\Core\Hook;
  40 use Friendica\Core\Logger;
  41 use Friendica\Core\Renderer;
  42 use Friendica\DI;
  43 use Friendica\Core\Config\Util\ConfigFileManager;
  44
  45 function piwik_install() {
  46         Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
  47         Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
  48
  49         Logger::notice("installed piwik addon");
  50 }
  51
  52 function piwik_load_config(ConfigFileManager $loader)
  53 {
  54         DI::app()->getConfigCache()->load($loader->loadAddonConfig('piwik'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
  55 }
  56
  57 function piwik_analytics(string &$b)
  58 {
  59         /*
  60          *   styling of every HTML block added by this addon is done in the
  61          *   associated CSS file. We just have to tell Friendica to get it
  62          *   into the page header.
  63          */
  64         DI::page()->registerStylesheet('addon/piwik/piwik.css', 'all');
  65
  66         /*
  67          *   Get the configuration values.
  68          */
  69         $baseurl = DI::config()->get('piwik', 'baseurl');
  70         $siteid  = DI::config()->get('piwik', 'siteid');
  71         $optout  = DI::config()->get('piwik', 'optout');
  72         $async   = DI::config()->get('piwik', 'async');
  73         $shortendpoint = DI::config()->get('piwik', 'shortendpoint');
  74
  75         /*
  76          *   Add the Piwik tracking code for the site.
  77          *   If async is set to true use asynchronous tracking
  78          */
  79
  80         $scriptAsyncValue = $async ? 'true' : 'false';
  81         $scriptPhpEndpoint = $shortendpoint ? 'js/' : 'piwik.php';
  82         $scriptJsEndpoint = $shortendpoint ? 'js/' : 'piwik.js';
  83
  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+'$scriptPhpEndpoint']); _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=$scriptAsyncValue; g.src=u+'$scriptJsEndpoint'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Piwik Code -->\r\n";
  85
  86         if ($async) {
  87                 $b .= "<div id='piwik-code-block'> <!-- Piwik -->\r\n<noscript><p><img src=\"//$baseurl$scriptPhpEndpoint?idsite=$siteid\" style=\"border:0\" alt=\"\" /></p></noscript>\r\n <!-- End Piwik Tracking Tag --> </div>";
  88         }
  89
  90         /*
  91          *   If the optout variable is set to true then display the notice
  92          *   otherwise just include the above code into the page.
  93          */
  94         if ($optout) {
  95                 $b .= "<div id='piwik-optout-link'>";
  96                 $b .= DI::l10n()->t("This website is tracked using the <a href='http://www.matomo.org'>Matomo</a> analytics tool.");
  97                 $b .= " ";
  98                 $the_url =  "http://{$baseurl}index.php?module=CoreAdminHome&action=optOut";
  99                 $b .= DI::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);
 100                 $b .= "</div>";
 101         }
 102 }
 103 function piwik_addon_admin (string &$o)
 104 {
 105         $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
 106
 107         $o = Renderer::replaceMacros( $t, [
 108                 '$submit' => DI::l10n()->t('Save Settings'),
 109                 '$piwikbaseurl' => ['baseurl', DI::l10n()->t('Matomo (Piwik) Base URL'), DI::config()->get('piwik','baseurl' ), DI::l10n()->t('Absolute path to your Matomo (Piwik) installation. (without protocol (http/s), with trailing slash)')],
 110                 '$siteid' => ['siteid', DI::l10n()->t('Site ID'), DI::config()->get('piwik','siteid' ), ''],
 111                 '$optout' => ['optout', DI::l10n()->t('Show opt-out cookie link?'), DI::config()->get('piwik','optout' ), ''],
 112                 '$async' => ['async', DI::l10n()->t('Asynchronous tracking'), DI::config()->get('piwik','async' ), ''],
 113                 '$shortendpoint' => ['shortendpoint', DI::l10n()->t("Shortcut path to the script ('/js/' instead of '/piwik.js')"), DI::config()->get('piwik','shortendpoint' ), ''],
 114         ]);
 115 }
 116
 117 function piwik_addon_admin_post()
 118 {
 119         DI::config()->set('piwik', 'baseurl', trim($_POST['baseurl'] ?? ''));
 120         DI::config()->set('piwik', 'siteid', trim($_POST['siteid'] ?? ''));
 121         DI::config()->set('piwik', 'optout', trim($_POST['optout'] ?? ''));
 122         DI::config()->set('piwik', 'async', trim($_POST['async'] ?? ''));
 123         DI::config()->set('piwik', 'shortendpoint', trim($_POST['shortendpoint'] ?? ''));
 124 }