friendica-addons/piwik/piwik.php

124 lines
5.7 KiB
PHP
Raw Normal View History

2011-09-25 10:56:03 +02:00
<?php
/**
2019-02-19 07:21:05 +01:00
* Name: Matomo / Piwik Analytics
* Description: Matomo / Piwik Analytics Addon for Friendica
* Version: 1.3
2013-06-14 19:40:10 +02:00
* Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
* Author: Klaus Weidenbach
2011-09-25 10:56:03 +02:00
*/
/* Piwik Analytics Addon for Friendica
2011-09-25 10:56:03 +02:00
*
* Author: Tobias Diekershoff
* tobias.diekershoff@gmx.net
*
* License: 3-clause BSD license
2011-09-25 10:56:03 +02:00
*
* Configuration:
* Use the administration panel to configure the Piwik tracking addon, or
2018-11-25 08:15:18 +01:00
* in case you don't use this add the following lines to your config/addon.config.php
* file:
2011-09-25 10:56:03 +02:00
*
* [piwik]
* baseurl = example.com/piwik/
* sideid = 1
* optout = true ;set to false to disable
* async = false ;set to true to enable
2011-09-25 10:56:03 +02:00
*
2012-01-31 12:08:46 +01:00
* Change the siteid to the ID that the Piwik tracker for your Friendica
2011-09-25 10:56:03 +02: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 22:22:03 +01:00
use Friendica\Core\Config;
use Friendica\Core\Hook;
2018-01-22 20:03:11 +01:00
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\DI;
use Friendica\Util\ConfigFileLoader;
use Friendica\Util\Strings;
2011-09-25 10:56:03 +02: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 10:56:03 +02:00
Logger::log("installed piwik addon");
2011-09-25 10:56:03 +02:00
}
function piwik_uninstall() {
Hook::unregister('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
Hook::unregister('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
2011-09-25 10:56:03 +02:00
Logger::log("uninstalled piwik addon");
2011-09-25 10:56:03 +02:00
}
function piwik_load_config(\Friendica\App $a, ConfigFileLoader $loader)
{
2019-02-10 20:10:59 +01:00
$a->getConfigCache()->load($loader->loadAddonConfig('piwik'));
}
2011-09-25 10:56:03 +02:00
function piwik_analytics($a,&$b) {
/*
* styling of every HTML block added by this addon is done in the
2012-01-31 12:08:46 +01:00
* associated CSS file. We just have to tell Friendica to get it
2011-09-25 10:56:03 +02: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 10:56:03 +02:00
/*
2018-11-25 08:15:18 +01:00
* Get the configuration variables from the config/addon.config.php file.
2011-09-25 10:56:03 +02:00
*/
$baseurl = Config::get('piwik', 'baseurl');
$siteid = Config::get('piwik', 'siteid');
$optout = Config::get('piwik', 'optout');
$async = Config::get('piwik', 'async');
2011-09-25 10:56:03 +02:00
/*
* Add the Piwik tracking code for the site.
* If async is set to true use asynchronous tracking
2011-09-25 10:56:03 +02: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 10:56:03 +02: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 .= 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 .= 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 10:56:03 +02:00
}
}
function piwik_addon_admin (&$a, &$o) {
$t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
$o = Renderer::replaceMacros( $t, [
2018-01-22 20:03:11 +01:00
'$submit' => L10n::t('Save Settings'),
'$piwikbaseurl' => ['baseurl', L10n::t('Matomo (Piwik) Base URL'), Config::get('piwik','baseurl' ), L10n::t('Absolute path to your Matomo (Piwik) installation. (without protocol (http/s), with trailing slash)')],
2018-01-22 20:03:11 +01:00
'$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
'$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
'$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
2018-01-15 14:15:33 +01:00
]);
2011-09-25 10:56:03 +02:00
}
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']) : '');
Config::set('piwik', 'baseurl', $url);
Config::set('piwik', 'siteid', $id);
Config::set('piwik', 'optout', $optout);
Config::set('piwik', 'async', $async);
2018-01-22 20:03:11 +01:00
info(L10n::t('Settings updated.'). EOL);
2011-09-25 10:56:03 +02:00
}