3 * Name: Piwik Analytics
4 * Description: Piwik Analytics Plugin for Friendica
6 * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
7 * Author: Klaus Weidenbach
10 /* Piwik Analytics Plugin 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 .htconfig.php
22 * $a->config['piwik']['baseurl'] = 'www.example.com/piwik/';
23 * $a->config['piwik']['siteid'] = '1';
24 * $a->config['piwik']['optout'] = true; // set to false to disable
25 * $a->config['piwik']['async'] = false; // set to true to enable
27 * Change the siteid to the ID that the Piwik tracker for your Friendica
28 * installation has. Alter the baseurl to fit your needs, don't care
29 * about http/https but beware to put the trailing / at the end of your
33 function piwik_install() {
34 register_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
36 logger("installed piwik plugin");
39 function piwik_uninstall() {
40 unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
42 logger("uninstalled piwik plugin");
45 function piwik_analytics($a,&$b) {
48 * styling of every HTML block added by this plugin is done in the
49 * associated CSS file. We just have to tell Friendica to get it
50 * into the page header.
52 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />';
55 * Get the configuration variables from the .htconfig file.
57 $baseurl = get_config('piwik','baseurl');
58 $siteid = get_config('piwik','siteid');
59 $optout = get_config('piwik','optout');
60 $async = get_config('piwik','async');
63 * Add the Piwik tracking code for the site.
64 * If async is set to true use asynchronous tracking
67 $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";
68 $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>";
70 $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";
74 * If the optout variable is set to true then display the notice
75 * otherwise just include the above code into the page.
78 $b .= "<div id='piwik-optout-link'>";
79 $b .= t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
81 $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
82 $b .= sprintf(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);
86 function piwik_plugin_admin (&$a, &$o) {
87 $t = get_markup_template( "admin.tpl", "addon/piwik/" );
88 $o = replace_macros( $t, array(
89 '$submit' => t('Save Settings'),
90 '$piwikbaseurl' => array('baseurl', t('Piwik Base URL'), get_config('piwik','baseurl' ), t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')),
91 '$siteid' => array('siteid', t('Site ID'), get_config('piwik','siteid' ), ''),
92 '$optout' => array('optout', t('Show opt-out cookie link?'), get_config('piwik','optout' ), ''),
93 '$async' => array('async', t('Asynchronous tracking'), get_config('piwik','async' ), ''),
96 function piwik_plugin_admin_post (&$a) {
97 $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : '');
98 $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
99 $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
100 $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
101 set_config('piwik', 'baseurl', $url);
102 set_config('piwik', 'siteid', $id);
103 set_config('piwik', 'optout', $optout);
104 set_config('piwik', 'async', $async);
105 info( t('Settings updated.'). EOL);