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.ini.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
33 use Friendica\Core\Addon;
34 use Friendica\Core\Config;
35 use Friendica\Core\L10n;
37 function piwik_install() {
38 Addon::registerHook('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
39 Addon::registerHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
41 logger("installed piwik addon");
44 function piwik_uninstall() {
45 Addon::unregisterHook('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
46 Addon::unregisterHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
48 logger("uninstalled piwik addon");
51 function piwik_load_config(\Friendica\App $a)
53 $a->loadConfigFile(__DIR__. '/config/piwik.ini.php');
56 function piwik_analytics($a,&$b) {
59 * styling of every HTML block added by this addon is done in the
60 * associated CSS file. We just have to tell Friendica to get it
61 * into the page header.
63 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />';
66 * Get the configuration variables from the config/addon.ini.php file.
68 $baseurl = Config::get('piwik', 'baseurl');
69 $siteid = Config::get('piwik', 'siteid');
70 $optout = Config::get('piwik', 'optout');
71 $async = Config::get('piwik', 'async');
74 * Add the Piwik tracking code for the site.
75 * If async is set to true use asynchronous tracking
78 $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";
79 $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>";
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=false; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Piwik Code -->\r\n";
85 * If the optout variable is set to true then display the notice
86 * otherwise just include the above code into the page.
89 $b .= "<div id='piwik-optout-link'>";
90 $b .= L10n::t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
92 $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
93 $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 function piwik_addon_admin (&$a, &$o) {
98 $t = get_markup_template( "admin.tpl", "addon/piwik/" );
99 $o = replace_macros( $t, [
100 '$submit' => L10n::t('Save Settings'),
101 '$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)')],
102 '$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
103 '$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
104 '$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
107 function piwik_addon_admin_post (&$a) {
108 $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : '');
109 $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
110 $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
111 $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
112 Config::set('piwik', 'baseurl', $url);
113 Config::set('piwik', 'siteid', $id);
114 Config::set('piwik', 'optout', $optout);
115 Config::set('piwik', 'async', $async);
116 info(L10n::t('Settings updated.'). EOL);