X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=piwik%2Fpiwik.php;h=9c0708c595942393fe03d62a6705e75969590bbf;hb=86e24c747e8f8534ee8e5805f6e5e73c400b88b6;hp=890309d4fd5c78f599d025215bc8675726c3fc5c;hpb=d7bd2246c18f5880fc3c083bf3d698fe4f29fcb6;p=friendica-addons.git diff --git a/piwik/piwik.php b/piwik/piwik.php old mode 100755 new mode 100644 index 890309d4..9c0708c5 --- a/piwik/piwik.php +++ b/piwik/piwik.php @@ -1,95 +1,113 @@ + * Name: Matomo / Piwik Analytics + * Description: Matomo / Piwik Analytics Addon for Friendica + * Version: 1.3 + * Author: Tobias Diekershoff + * Author: Klaus Weidenbach */ - -/* Piwik Analytics Plugin for Friendika +/* Piwik Analytics Addon for Friendica * * Author: Tobias Diekershoff * tobias.diekershoff@gmx.net * -* License: 3-clause BSD license + * License: 3-clause BSD license * * Configuration: - * Add the following two 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 + * [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 Friendika + * 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\App; +use Friendica\Core\Hook; +use Friendica\Core\Logger; +use Friendica\Core\Renderer; +use Friendica\DI; +use Friendica\Core\Config\Util\ConfigFileLoader; + 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::notice("installed piwik addon"); } -function piwik_uninstall() { - unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics'); - - logger("uninstalled piwik plugin"); +function piwik_load_config(App $a, ConfigFileLoader $loader) +{ + $a->getConfigCache()->load($loader->loadAddonConfig('piwik')); } -function piwik_analytics($a,&$b) { - +function piwik_analytics(App $a, array &$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 + * 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'] .= '' . "\r\n"; + DI::page()['htmlhead'] .= ''; /* - * 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'); + $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 code for the site. + * Add the Piwik tracking code for the site. + * If async is set to true use asynchronous tracking */ - $b .= "
\r\n \r\n\r\n\r\n
"; + if ($async) { + $b .= " \r\n"; + $b .= "
\r\n\r\n
"; + } else { + $b .= " \r\n"; + } + /* * If the optout variable is set to true then display the notice * otherwise just include the above code into the page. */ if ($optout) { - $b .= ""; + $b .= ""; } - } -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_addon_admin (App $a, string &$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']) : ''); - set_config('piwik', 'baseurl', $url); - set_config('piwik', 'siteid', $id); - set_config('piwik', 'optout', $optout); - info( t('Settings updated.'). EOL); + +function piwik_addon_admin_post(App $a) +{ + DI::config()->set('piwik', 'baseurl', trim($_POST['baseurl'] ?? '')); + DI::config()->set('piwik', 'siteid', trim($_POST['siteid'] ?? '')); + DI::config()->set('piwik', 'optout', trim($_POST['optout'] ?? '')); + DI::config()->set('piwik', 'async', trim($_POST['async'] ?? '')); }