diff options
Diffstat (limited to 'addon/piwik')
-rw-r--r-- | addon/piwik/README | 43 | ||||
-rw-r--r-- | addon/piwik/admin.tpl | 4 | ||||
-rw-r--r-- | addon/piwik/piwik.css | 8 | ||||
-rw-r--r-- | addon/piwik/piwik.php | 95 |
4 files changed, 0 insertions, 150 deletions
diff --git a/addon/piwik/README b/addon/piwik/README deleted file mode 100644 index 20b78b51e..000000000 --- a/addon/piwik/README +++ /dev/null @@ -1,43 +0,0 @@ -____ Piwik Plugin ____ -by Tobias Diekershoff - tobias.diekershoff(at)gmx.net - -This addon allows you to embed the code necessary for the FLOSS webanalytics -tool piwik into the Friendika pages. - -Online version of this Document: http://ur1.ca/35m2x - -___ Requirements ___ - -To use this plugin you need a "piwik":http://piwik.org installation. - -___ Where to find ___ - -In the Friendika git repository @/addon/piwik/piwik.php@ and a CSS file for -styling the opt-out notice. - -___ Configuration ___ - -Open the .htconfig.php file and add "piwik" to the list of activated addons. - $a->config['system']['addon'] = "piwik, ..." -You have to add 3 more configuration variables for the addon: - -$a->config['piwik']['baseurl'] = 'example.com/piwik/'; -$a->config['piwik']['sideid'] = '1'; -$a->config['piwik']['optout'] = true; - -The *baseurl* points to your piwik installation. Use the absolute path, -remember trailing slashes but ignore the protocol (http/s) part of the URL. -Change the *sideid* parameter to whatever ID you want to use for tracking your -Friendika installation. The *optout* parameter (true|false) defines whether or -not a short notice about the utilization of piwik will be displayed on every -page of your Friendika site (at the bottom of the page with some spacing to the -other content). Part of the note is a link that allows the visitor to set an -_opt-out_ cookie which will prevent visits from that user be tracked by piwik. - -Currently the optional notice states the following: - - This website is tracked using the Piwik analytics tool. If you do not want - that your visits are logged this way you can set a cookie to prevent Piwik - from tracking further visits of the site (opt-out). - diff --git a/addon/piwik/admin.tpl b/addon/piwik/admin.tpl deleted file mode 100644 index 0edd06210..000000000 --- a/addon/piwik/admin.tpl +++ /dev/null @@ -1,4 +0,0 @@ -{{ inc field_input.tpl with $field=$baseurl }}{{ endinc }} -{{ inc field_input.tpl with $field=$siteid }}{{ endinc }} -{{ inc field_checkbox.tpl with $field=$optout }}{{ endinc }} -<div class="submit"><input type="submit" name="page_site" value="$submit" /></div> diff --git a/addon/piwik/piwik.css b/addon/piwik/piwik.css deleted file mode 100644 index bb43b67ea..000000000 --- a/addon/piwik/piwik.css +++ /dev/null @@ -1,8 +0,0 @@ -#piwik-optout-link { - padding: 100px 50px; - text-align: justify; - font-size: 0.85em; -} -#piwik-code-block { - display: none; -} diff --git a/addon/piwik/piwik.php b/addon/piwik/piwik.php deleted file mode 100644 index 890309d4f..000000000 --- a/addon/piwik/piwik.php +++ /dev/null @@ -1,95 +0,0 @@ -<?php -/** - * Name: Piwik Analytics - * Description: Piwik Analytics Plugin for Friendika - * Version: 1.0 - * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias> - */ - - -/* Piwik Analytics Plugin for Friendika - * - * Author: Tobias Diekershoff - * tobias.diekershoff@gmx.net - * -* License: 3-clause BSD license - * - * Configuration: - * Add the following two lines to your .htconfig.php file: - * - * $a->config['piwik']['baseurl'] = 'www.example.com/piwik/'; - * $a->config['piwik']['siteid'] = '1'; - * $a->config['piwik']['optout'] = true; // set to false to disable - * - * Change the siteid to the ID that the Piwik tracker for your Friendika - * installation has. Alter the baseurl to fit your needs, don't care - * about http/https but beware to put the trailing / at the end of your - * setting. - * - * Documentation see http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Piwik_Plugin - */ - -function piwik_install() { - register_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics'); - - logger("installed piwik plugin"); -} - -function piwik_uninstall() { - unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics'); - - logger("uninstalled piwik plugin"); -} - -function piwik_analytics($a,&$b) { - - /* - * styling of every HTML block added by this plugin is done in the - * associated CSS file. We just have to tell Friendika to get it - * into the page header. - */ - $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />' . "\r\n"; - - /* - * Get the configuration variables from the .htconfig file. - */ - $baseurl = get_config('piwik','baseurl'); - $siteid = get_config('piwik','siteid'); - $optout = get_config('piwik','optout'); - - /* - * Add the Piwik code for the site. - */ - $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=\"http://".$baseurl."/piwik.php?idsite=".$siteid."\" style=\"border:0\" alt=\"\" /></p></noscript>\r\n <!-- End Piwik Tracking Tag --> </div>"; - /* - * If the optout variable is set to true then display the notice - * otherwise just include the above code into the page. - */ - if ($optout) { - $b .= "<div id='piwik-optout-link'>"; - $b .= t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool."); - $b .= " "; - $the_url = "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut"; - $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); - $b .= "</div>"; - } - -} -function piwik_plugin_admin (&$a, &$o) { - $t = file_get_contents( dirname(__file__)."/admin.tpl"); - $o = replace_macros( $t, array( - '$submit' => t('Submit'), - '$baseurl' => array('baseurl', t('Piwik Base URL'), get_config('piwik','baseurl' ), ''), - '$siteid' => array('siteid', t('Site ID'), get_config('piwik','siteid' ), ''), - '$optout' => array('optout', t('Show opt-out cookie link?'), get_config('piwik','optout' ), ''), - )); -} -function piwik_plugin_admin_post (&$a) { - $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : ''); - $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : ''); - $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : ''); - set_config('piwik', 'baseurl', $url); - set_config('piwik', 'siteid', $id); - set_config('piwik', 'optout', $optout); - info( t('Settings updated.'). EOL); -} |