friendica-addons/piwik/piwik.php

117 lines
5.3 KiB
PHP
Raw Normal View History

2011-09-25 08:56:03 +00:00
<?php
/**
2019-02-19 06:21:05 +00:00
* Name: Matomo / Piwik Analytics
* Description: Matomo / Piwik Analytics Addon for Friendica
* Version: 1.3
2013-06-14 17:40:10 +00:00
* Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
* Author: Klaus Weidenbach
2011-09-25 08:56:03 +00:00
*/
/* Piwik Analytics Addon for Friendica
2011-09-25 08:56:03 +00:00
*
* Author: Tobias Diekershoff
* tobias.diekershoff@gmx.net
*
* License: 3-clause BSD license
2011-09-25 08:56:03 +00:00
*
* 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 config/piwik.config.php
* file:
2011-09-25 08:56:03 +00:00
*
* return [
* 'piwik' => [
* 'baseurl' => '',
* 'sideid' => '',
* 'optout' => true,
* 'async' => false,
* ],
* ];
2011-09-25 08:56:03 +00:00
*
2012-01-31 11:08:46 +00:00
* Change the siteid to the ID that the Piwik tracker for your Friendica
2011-09-25 08:56:03 +00:00
* 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.
*/
2019-02-03 21:22:03 +00:00
use Friendica\App;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\DI;
2021-10-26 19:44:28 +00:00
use Friendica\Core\Config\Util\ConfigFileLoader;
2011-09-25 08:56:03 +00:00
function piwik_install() {
Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
2011-09-25 08:56:03 +00:00
Logger::notice("installed piwik addon");
2011-09-25 08:56:03 +00:00
}
function piwik_load_config(App $a, ConfigFileLoader $loader)
{
$a->getConfigCache()->load($loader->loadAddonConfig('piwik'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
}
Hook::register has changed API `Hook::register` now takes a string as the second parameter, not an array. Without this change Friendica fails to start, with errors such as: ``` 2022-11-07T11:40:20Z index [ERROR]: Uncaught Exception TypeError: "Argument 2 passed to piwik_analytics() must be of the type array, string given, called in /var/www/html/src/Core/Hook.php on line 223" at /var/www/html/addon/piwik/piwik.php line 53 {"exception":"TypeError: Argument 2 passed to piwik_analytics() must be of the type array, string given, called in /var/www/html/src/Core/Hook.php on line 223 and defined in /var/www/html/addon/piwik/piwik.php:53\nStack trace:\n#0 /var/www/html/src/Core/Hook.php(223): piwik_analytics(Object(Friendica\\App), '<h1><img width=...')\n#1 /var/www/html/src/Core/Hook.php(198): Friendica\\Core\\Hook::callSingle(Object(Friendica\\App), 'page_end', Array, '<h1><img width=...')\n#2 /var/www/html/src/App/Page.php(493): Friendica\\Core\\Hook::callAll('page_end', '<h1><img width=...')\n#3 /var/www/html/src/App.php(722): Friendica\\App\\Page->run(Object(Friendica\\App), Object(Friendica\\App\\BaseURL), Object(Friendica\\App\\Arguments), Object(Friendica\\App\\Mode), Object(GuzzleHttp\\Psr7\\Response), Object(Friendica\\Core\\L10n), Object(Friendica\\Util\\Profiler), Object(Friendica\\Core\\Config\\Type\\JitConfig), Object(Friendica\\Core\\PConfig\\Type\\JitPConfig))\n#4 /var/www/html/index.php(44): Friendica\\App->runFrontend(Object(Friendica\\App\\Router), Object(Friendica\\Core\\PConfig\\Type\\JitPConfig), Object(Friendica\\Security\\Authentication), Object(Friendica\\App\\Page), Object(Friendica\\Util\\HTTPInputData), 1667821218.5153)\n#5 {main}"} - {"file":null,"line":null,"function":null,"uid":"73d499","process_id":52} ```
2022-11-07 11:42:31 +00:00
function piwik_analytics(App $a, string &$b)
{
2011-09-25 08:56:03 +00:00
/*
* styling of every HTML block added by this addon is done in the
2012-01-31 11:08:46 +00:00
* associated CSS file. We just have to tell Friendica to get it
2011-09-25 08:56:03 +00:00
* into the page header.
*/
DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/piwik/piwik.css' . '" media="all" />';
2011-09-25 08:56:03 +00:00
/*
* Get the configuration values.
2011-09-25 08:56:03 +00:00
*/
$baseurl = DI::config()->get('piwik', 'baseurl');
$siteid = DI::config()->get('piwik', 'siteid');
$optout = DI::config()->get('piwik', 'optout');
$async = DI::config()->get('piwik', 'async');
2011-09-25 08:56:03 +00:00
/*
* Add the Piwik tracking code for the site.
* If async is set to true use asynchronous tracking
2011-09-25 08:56:03 +00:00
*/
if ($async) {
$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 .= "<!-- 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";
}
2011-09-25 08:56:03 +00:00
/*
* 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 .= 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 .= 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>";
2011-09-25 08:56:03 +00:00
}
}
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' ), ''],
2018-01-15 13:15:33 +00:00
]);
2011-09-25 08:56:03 +00:00
}
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'] ?? ''));
2011-09-25 08:56:03 +00:00
}