3 * Name: Matomo / Piwik Analytics
4 * Description: Matomo / Piwik Analytics Addon for Friendica
6 * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
7 * Author: Klaus Weidenbach
10 /* Piwik Analytics Addon for Friendica
12 * Author: Tobias Diekershoff
13 * tobias.diekershoff@gmx.net
15 * License: 3-clause BSD license
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
23 * baseurl = example.com/piwik/
25 * optout = true ;set to false to disable
26 * async = false ;set to true to enable
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
34 use Friendica\Core\Config;
35 use Friendica\Core\Hook;
36 use Friendica\Core\Logger;
37 use Friendica\Core\Renderer;
39 use Friendica\Util\ConfigFileLoader;
40 use Friendica\Util\Strings;
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');
46 Logger::log("installed piwik addon");
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');
53 Logger::log("uninstalled piwik addon");
56 function piwik_load_config(\Friendica\App $a, ConfigFileLoader $loader)
58 $a->getConfigCache()->load($loader->loadAddonConfig('piwik'));
61 function piwik_analytics($a,&$b) {
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.
68 DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/piwik/piwik.css' . '" media="all" />';
71 * Get the configuration variables from the config/addon.config.php file.
73 $baseurl = DI::config()->get('piwik', 'baseurl');
74 $siteid = DI::config()->get('piwik', 'siteid');
75 $optout = DI::config()->get('piwik', 'optout');
76 $async = DI::config()->get('piwik', 'async');
79 * Add the Piwik tracking code for the site.
80 * If async is set to true use asynchronous tracking
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>";
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";
90 * If the optout variable is set to true then display the notice
91 * otherwise just include the above code into the page.
94 $b .= "<div id='piwik-optout-link'>";
95 $b .= DI::l10n()->t("This website is tracked using the <a href='http://www.matomo.org'>Matomo</a> analytics tool.");
97 $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
98 $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);
102 function piwik_addon_admin (&$a, &$o) {
103 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
104 $o = Renderer::replaceMacros( $t, [
105 '$submit' => DI::l10n()->t('Save Settings'),
106 '$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)')],
107 '$siteid' => ['siteid', DI::l10n()->t('Site ID'), DI::config()->get('piwik','siteid' ), ''],
108 '$optout' => ['optout', DI::l10n()->t('Show opt-out cookie link?'), DI::config()->get('piwik','optout' ), ''],
109 '$async' => ['async', DI::l10n()->t('Asynchronous tracking'), DI::config()->get('piwik','async' ), ''],
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 DI::config()->set('piwik', 'baseurl', $url);
118 DI::config()->set('piwik', 'siteid', $id);
119 DI::config()->set('piwik', 'optout', $optout);
120 DI::config()->set('piwik', 'async', $async);
121 info(DI::l10n()->t('Settings updated.'). EOL);