<?php
/**
- * Name: Piwik Analytics
- * Description: Piwik Analytics Plugin for Friendica
- * Version: 1.1
- * Author: Tobias Diekershoff <http://diekershoff.homeunix.net/friendika/profile/tobias>
+ * Name: Matomo / Piwik Analytics
+ * Description: Matomo / Piwik Analytics Addon for Friendica
+ * Version: 1.3
+ * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
* Author: Klaus Weidenbach
*/
-/* Piwik Analytics Plugin for Friendica
+/* Piwik Analytics Addon for Friendica
*
* Author: Tobias Diekershoff
* tobias.diekershoff@gmx.net
* License: 3-clause BSD license
*
* Configuration:
- * Add the following lines to your .htconfig.php file:
+ * Use the administration panel to configure the Piwik tracking addon, or
+ * in case you don't use this add the following lines to your config/addon.config.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
- * $a->config['piwik']['async'] = false; // set to true to enable
+ * [piwik]
+ * baseurl = example.com/piwik/
+ * sideid = 1
+ * optout = true ;set to false to disable
+ * async = false ;set to true to enable
*
* Change the siteid to the ID that the Piwik tracker for your Friendica
* 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
*/
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\DI;
+use Friendica\Util\ConfigFileLoader;
+use Friendica\Util\Strings;
+
function piwik_install() {
- register_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+ Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
+ Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
- logger("installed piwik plugin");
+ Logger::log("installed piwik addon");
}
-function piwik_uninstall() {
- unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
-
- logger("uninstalled piwik plugin");
+function piwik_load_config(\Friendica\App $a, ConfigFileLoader $loader)
+{
+ $a->getConfigCache()->load($loader->loadAddonConfig('piwik'));
}
function piwik_analytics($a,&$b) {
/*
- * styling of every HTML block added by this plugin is done in the
+ * styling of every HTML block added by this addon is done in the
* associated CSS file. We just have to tell Friendica 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" />';
+ DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/piwik/piwik.css' . '" media="all" />';
/*
- * Get the configuration variables from the .htconfig file.
+ * Get the configuration variables from the config/addon.config.php file.
*/
- $baseurl = get_config('piwik','baseurl');
- $siteid = get_config('piwik','siteid');
- $optout = get_config('piwik','optout');
- $async = get_config('piwik','async');
+ $baseurl = DI::config()->get('piwik', 'baseurl');
+ $siteid = DI::config()->get('piwik', 'siteid');
+ $optout = DI::config()->get('piwik', 'optout');
+ $async = DI::config()->get('piwik', 'async');
/*
* Add the Piwik tracking code for the site.
* If async is set to true use asynchronous tracking
*/
if ($async) {
- $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";
+ $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";
$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>";
} else {
- $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>";
+ $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";
}
/*
*/
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 .= DI::l10n()->t("This website is tracked using the <a href='http://www.matomo.org'>Matomo</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 .= DI::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 Matomo / 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");
- $t = get_markup_template( "admin.tpl", "addon/piwik/" );
-
- $includes = array(
- '$field_input' => 'field_input.tpl',
- '$field_checkbox' => 'field_select.tpl',
- );
- $includes = set_template_includes($a->theme['template_engine'], $includes);
-
- $o = replace_macros( $t, $includes + array(
- '$submit' => t('Submit'),
- '$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)')),
- '$siteid' => array('siteid', t('Site ID'), get_config('piwik','siteid' ), ''),
- '$optout' => array('optout', t('Show opt-out cookie link?'), get_config('piwik','optout' ), ''),
- '$async' => array('async', t('Asynchronous tracking'), get_config('piwik','async' ), ''),
- ));
+function piwik_addon_admin (&$a, &$o) {
+ $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
+ $o = Renderer::replaceMacros( $t, [
+ '$submit' => DI::l10n()->t('Save Settings'),
+ '$piwikbaseurl' => ['baseurl', DI::l10n()->t('Matomo (Piwik) Base URL'), DI::config()->get('piwik','baseurl' ), DI::l10n()->t('Absolute path to your Matomo (Piwik) installation. (without protocol (http/s), with trailing slash)')],
+ '$siteid' => ['siteid', DI::l10n()->t('Site ID'), DI::config()->get('piwik','siteid' ), ''],
+ '$optout' => ['optout', DI::l10n()->t('Show opt-out cookie link?'), DI::config()->get('piwik','optout' ), ''],
+ '$async' => ['async', DI::l10n()->t('Asynchronous tracking'), DI::config()->get('piwik','async' ), ''],
+ ]);
}
-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']) : '');
- $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
- set_config('piwik', 'baseurl', $url);
- set_config('piwik', 'siteid', $id);
- set_config('piwik', 'optout', $optout);
- set_config('piwik', 'async', $async);
- info( t('Settings updated.'). EOL);
+function piwik_addon_admin_post (&$a) {
+ $url = (!empty($_POST['baseurl']) ? Strings::escapeTags(trim($_POST['baseurl'])) : '');
+ $id = (!empty($_POST['siteid']) ? trim($_POST['siteid']) : '');
+ $optout = (!empty($_POST['optout']) ? trim($_POST['optout']) : '');
+ $async = (!empty($_POST['async']) ? trim($_POST['async']) : '');
+ DI::config()->set('piwik', 'baseurl', $url);
+ DI::config()->set('piwik', 'siteid', $id);
+ DI::config()->set('piwik', 'optout', $optout);
+ DI::config()->set('piwik', 'async', $async);
}