3 * Name: Piwik Analytics
4 * Description: 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\L10n;
37 use Friendica\Core\Logger;
38 use Friendica\Core\Renderer;
39 use Friendica\Util\Strings;
41 function piwik_install() {
42 Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
43 Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
45 Logger::log("installed piwik addon");
48 function piwik_uninstall() {
49 Hook::unregister('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
50 Hook::unregister('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
52 Logger::log("uninstalled piwik addon");
55 function piwik_load_config(\Friendica\App $a, Config\ConfigCacheLoader $loader)
57 $a->getConfig()->loadConfigArray($loader->loadConfigFile('piwik', true));
60 function piwik_analytics($a,&$b) {
63 * styling of every HTML block added by this addon is done in the
64 * associated CSS file. We just have to tell Friendica to get it
65 * into the page header.
67 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->getBaseURL() . '/addon/piwik/piwik.css' . '" media="all" />';
70 * Get the configuration variables from the config/addon.config.php file.
72 $baseurl = Config::get('piwik', 'baseurl');
73 $siteid = Config::get('piwik', 'siteid');
74 $optout = Config::get('piwik', 'optout');
75 $async = Config::get('piwik', 'async');
78 * Add the Piwik tracking code for the site.
79 * If async is set to true use asynchronous tracking
82 $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";
83 $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 $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";
89 * If the optout variable is set to true then display the notice
90 * otherwise just include the above code into the page.
93 $b .= "<div id='piwik-optout-link'>";
94 $b .= L10n::t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
96 $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
97 $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);
101 function piwik_addon_admin (&$a, &$o) {
102 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
103 $o = Renderer::replaceMacros( $t, [
104 '$submit' => L10n::t('Save Settings'),
105 '$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)')],
106 '$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
107 '$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
108 '$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
111 function piwik_addon_admin_post (&$a) {
112 $url = (!empty($_POST['baseurl']) ? Strings::escapeTags(trim($_POST['baseurl'])) : '');
113 $id = (!empty($_POST['siteid']) ? trim($_POST['siteid']) : '');
114 $optout = (!empty($_POST['optout']) ? trim($_POST['optout']) : '');
115 $async = (!empty($_POST['async']) ? trim($_POST['async']) : '');
116 Config::set('piwik', 'baseurl', $url);
117 Config::set('piwik', 'siteid', $id);
118 Config::set('piwik', 'optout', $optout);
119 Config::set('piwik', 'async', $async);
120 info(L10n::t('Settings updated.'). EOL);