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 * Add the following lines to your .htconfig.php file:
20 * $a->config['piwik']['baseurl'] = 'www.example.com/piwik/';
21 * $a->config['piwik']['siteid'] = '1';
22 * $a->config['piwik']['optout'] = true; // set to false to disable
23 * $a->config['piwik']['async'] = false; // set to true to enable
25 * Change the siteid to the ID that the Piwik tracker for your Friendica
26 * installation has. Alter the baseurl to fit your needs, don't care
27 * about http/https but beware to put the trailing / at the end of your
31 function piwik_install() {
32 register_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
34 logger("installed piwik plugin");
37 function piwik_uninstall() {
38 unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
40 logger("uninstalled piwik plugin");
43 function piwik_analytics($a,&$b) {
46 * styling of every HTML block added by this plugin is done in the
47 * associated CSS file. We just have to tell Friendica to get it
48 * into the page header.
50 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />';
53 * Get the configuration variables from the .htconfig file.
55 $baseurl = get_config('piwik','baseurl');
56 $siteid = get_config('piwik','siteid');
57 $optout = get_config('piwik','optout');
58 $async = get_config('piwik','async');
61 * Add the Piwik tracking code for the site.
62 * If async is set to true use asynchronous tracking
65 $a->page['htmlhead'] .= "<!-- Piwik --> <script type=\"text/javascript\">\r\nvar _paq = _paq || [];\r\n(function(){ var u=((\"https:\" == document.location.protocol) ? \"https://".$baseurl."\" : \"http://".$baseurl."\");\r\n_paq.push(['setSiteId', ".$siteid."]);\r\n_paq.push(['setTrackerUrl', u+'piwik.php']);\r\n_paq.push(['trackPageView']);\r\n_paq.push(['enableLinkTracking']);\r\nvar d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript';\r\ng.defer=true; g.async=true; g.src=u+'piwik.js';\r\ns.parentNode.insertBefore(g,s); })();\r\n </script>\r\n<!-- End Piwik Code -->\r\n";
66 $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>";
68 $b .= "<div id='piwik-code-block'> <!-- Piwik -->\r\n <script type=\"text/javascript\">\r\n var pkBaseURL = ((\"https:\" == document.location.protocol) ? \"https://".$baseurl."\" : \"http://".$baseurl."\");\r\n document.write(unescape(\"%3Cscript src='\" + pkBaseURL + \"piwik.js' type='text/javascript'%3E%3C/script%3E\"));\r\n </script>\r\n<script type=\"text/javascript\">\r\n try {\r\n var piwikTracker = Piwik.getTracker(pkBaseURL + \"piwik.php\", ".$siteid.");\r\n piwikTracker.trackPageView();\r\n piwikTracker.enableLinkTracking();\r\n }\r\n catch( err ) {}\r\n </script>\r\n<noscript><p><img src=\"//".$baseurl."piwik.php?idsite=".$siteid."\" style=\"border:0\" alt=\"\" /></p></noscript>\r\n <!-- End Piwik Tracking Tag --> </div>";
72 * If the optout variable is set to true then display the notice
73 * otherwise just include the above code into the page.
76 $b .= "<div id='piwik-optout-link'>";
77 $b .= t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
79 $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
80 $b .= sprintf(t("If you do not want that your visits are logged 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);
84 function piwik_plugin_admin (&$a, &$o) {
85 $t = get_markup_template( "admin.tpl", "addon/piwik/" );
86 $o = replace_macros( $t, array(
87 '$submit' => t('Submit'),
88 '$baseurl' => array('baseurl', t('Piwik Base URL'), get_config('piwik','baseurl' ), t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')),
89 '$siteid' => array('siteid', t('Site ID'), get_config('piwik','siteid' ), ''),
90 '$optout' => array('optout', t('Show opt-out cookie link?'), get_config('piwik','optout' ), ''),
91 '$async' => array('async', t('Asynchronous tracking'), get_config('piwik','async' ), ''),
94 function piwik_plugin_admin_post (&$a) {
95 $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : '');
96 $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
97 $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
98 $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
99 set_config('piwik', 'baseurl', $url);
100 set_config('piwik', 'siteid', $id);
101 set_config('piwik', 'optout', $optout);
102 set_config('piwik', 'async', $async);
103 info( t('Settings updated.'). EOL);