<?php
/**
- * Name: Piwik Analytics
- * Description: Piwik Analytics Addon for Friendica
+ * 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
*
* Configuration:
* Use the administration panel to configure the Piwik tracking addon, or
- * in case you don't use this add the following lines to your .htconfig.php
+ * 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.
*/
-use Friendica\Core\Addon;
-use Friendica\Core\Config;
+
+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() {
- Addon::registerHook('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 addon");
+ Logger::log("installed piwik addon");
}
function piwik_uninstall() {
- Addon::unregisterHook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+ Hook::unregister('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
+ Hook::unregister('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+
+ Logger::log("uninstalled piwik addon");
+}
- logger("uninstalled piwik addon");
+function piwik_load_config(\Friendica\App $a, ConfigFileLoader $loader)
+{
+ $a->getConfigCache()->load($loader->loadAddonConfig('piwik'));
}
function piwik_analytics($a,&$b) {
* 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 = Config::get('piwik','baseurl');
- $siteid = Config::get('piwik','siteid');
- $optout = Config::get('piwik','optout');
- $async = Config::get('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 ($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 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);
+ $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_addon_admin (&$a, &$o) {
- $t = get_markup_template( "admin.tpl", "addon/piwik/" );
- $o = replace_macros( $t, [
- '$submit' => t('Save Settings'),
- '$piwikbaseurl' => ['baseurl', t('Piwik Base URL'), Config::get('piwik','baseurl' ), t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')],
- '$siteid' => ['siteid', t('Site ID'), Config::get('piwik','siteid' ), ''],
- '$optout' => ['optout', t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
- '$async' => ['async', t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
+ $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_addon_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']) : '');
- Config::set('piwik', 'baseurl', $url);
- Config::set('piwik', 'siteid', $id);
- Config::set('piwik', 'optout', $optout);
- Config::set('piwik', 'async', $async);
- info( t('Settings updated.'). EOL);
+ $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);
+ info(DI::l10n()->t('Settings updated.'). EOL);
}