2011-09-25 04:56:03 -04:00
< ? php
/**
2019-02-19 01:21:05 -05:00
* Name : Matomo / Piwik Analytics
* Description : Matomo / Piwik Analytics Addon for Friendica
2016-07-28 10:32:05 -04:00
* Version : 1.3
2013-06-14 13:40:10 -04:00
* Author : Tobias Diekershoff < https :// f . diekershoff . de / profile / tobias >
2012-02-19 04:17:38 -05:00
* Author : Klaus Weidenbach
2011-09-25 04:56:03 -04:00
*/
2018-01-20 08:57:41 -05:00
/* Piwik Analytics Addon for Friendica
2011-09-25 04:56:03 -04:00
*
* Author : Tobias Diekershoff
* tobias . diekershoff @ gmx . net
*
2012-02-19 04:17:38 -05:00
* License : 3 - clause BSD license
2011-09-25 04:56:03 -04:00
*
* Configuration :
2014-08-11 03:07:25 -04:00
* Use the administration panel to configure the Piwik tracking addon , or
2018-11-25 02:15:18 -05:00
* in case you don ' t use this add the following lines to your config / addon . config . php
2014-08-11 03:07:25 -04:00
* file :
2011-09-25 04:56:03 -04:00
*
2018-06-27 23:18:33 -04: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 04:56:03 -04:00
*
2012-01-31 06:08:46 -05:00
* Change the siteid to the ID that the Piwik tracker for your Friendica
2011-09-25 04:56:03 -04: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 16:22:03 -05:00
2017-11-06 18:55:24 -05:00
use Friendica\Core\Config ;
2018-12-26 02:28:16 -05:00
use Friendica\Core\Hook ;
2018-01-22 14:03:11 -05:00
use Friendica\Core\L10n ;
2018-10-29 19:40:18 -04:00
use Friendica\Core\Logger ;
2018-10-31 10:55:15 -04:00
use Friendica\Core\Renderer ;
2018-11-08 11:45:19 -05:00
use Friendica\Util\Strings ;
2017-11-06 18:55:24 -05:00
2011-09-25 04:56:03 -04:00
function piwik_install () {
2018-12-26 02:28:16 -05:00
Hook :: register ( 'load_config' , 'addon/piwik/piwik.php' , 'piwik_load_config' );
Hook :: register ( 'page_end' , 'addon/piwik/piwik.php' , 'piwik_analytics' );
2011-09-25 04:56:03 -04:00
2018-10-29 19:40:18 -04:00
Logger :: log ( " installed piwik addon " );
2011-09-25 04:56:03 -04:00
}
function piwik_uninstall () {
2018-12-26 02:28:16 -05:00
Hook :: unregister ( 'load_config' , 'addon/piwik/piwik.php' , 'piwik_load_config' );
Hook :: unregister ( 'page_end' , 'addon/piwik/piwik.php' , 'piwik_analytics' );
2011-09-25 04:56:03 -04:00
2018-10-29 19:40:18 -04:00
Logger :: log ( " uninstalled piwik addon " );
2011-09-25 04:56:03 -04:00
}
2019-02-10 14:10:59 -05:00
function piwik_load_config ( \Friendica\App $a , Config\Cache\ConfigCacheLoader $loader )
2018-06-27 23:18:33 -04:00
{
2019-02-10 14:10:59 -05:00
$a -> getConfigCache () -> load ( $loader -> loadAddonConfig ( 'piwik' ));
2018-06-27 23:18:33 -04:00
}
2011-09-25 04:56:03 -04:00
function piwik_analytics ( $a , & $b ) {
/*
2018-01-20 08:57:41 -05:00
* styling of every HTML block added by this addon is done in the
2012-01-31 06:08:46 -05:00
* associated CSS file . We just have to tell Friendica to get it
2011-09-25 04:56:03 -04:00
* into the page header .
*/
2018-10-09 14:13:22 -04:00
$a -> page [ 'htmlhead' ] .= '<link rel="stylesheet" type="text/css" href="' . $a -> getBaseURL () . '/addon/piwik/piwik.css' . '" media="all" />' ;
2011-09-25 04:56:03 -04:00
/*
2018-11-25 02:15:18 -05:00
* Get the configuration variables from the config / addon . config . php file .
2011-09-25 04:56:03 -04:00
*/
2018-06-27 23:18:33 -04:00
$baseurl = Config :: get ( 'piwik' , 'baseurl' );
$siteid = Config :: get ( 'piwik' , 'siteid' );
$optout = Config :: get ( 'piwik' , 'optout' );
$async = Config :: get ( 'piwik' , 'async' );
2011-09-25 04:56:03 -04:00
/*
2012-02-19 04:17:38 -05:00
* Add the Piwik tracking code for the site .
* If async is set to true use asynchronous tracking
2011-09-25 04:56:03 -04:00
*/
2012-02-19 04:17:38 -05:00
if ( $async ) {
2014-08-11 03:07:25 -04:00
$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 " ;
2012-08-14 12:22:31 -04:00
$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> " ;
2012-02-19 04:17:38 -05:00
} else {
2014-08-11 03:07:25 -04:00
$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 " ;
2012-02-19 04:17:38 -05:00
}
2011-09-25 04:56:03 -04:00
/*
* If the optout variable is set to true then display the notice
* otherwise just include the above code into the page .
*/
if ( $optout ) {
2012-02-19 04:17:38 -05:00
$b .= " <div id='piwik-optout-link'> " ;
2018-01-22 14:03:11 -05:00
$b .= L10n :: t ( " This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool. " );
2012-02-19 04:17:38 -05:00
$b .= " " ;
2012-08-14 12:33:24 -04:00
$the_url = " http:// " . $baseurl . " index.php?module=CoreAdminHome&action=optOut " ;
2018-01-23 22:59:20 -05:00
$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 Piwik from tracking further visits of the site</a> (opt-out). " , $the_url );
2012-02-19 04:17:38 -05:00
$b .= " </div> " ;
2011-09-25 04:56:03 -04:00
}
}
2018-01-20 08:57:41 -05:00
function piwik_addon_admin ( & $a , & $o ) {
2018-10-31 10:55:15 -04:00
$t = Renderer :: getMarkupTemplate ( " admin.tpl " , " addon/piwik/ " );
$o = Renderer :: replaceMacros ( $t , [
2018-01-22 14:03:11 -05:00
'$submit' => L10n :: t ( 'Save Settings' ),
'$piwikbaseurl' => [ 'baseurl' , L10n :: t ( 'Piwik Base URL' ), Config :: get ( 'piwik' , 'baseurl' ), L10n :: t ( 'Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)' )],
'$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 08:15:33 -05:00
]);
2011-09-25 04:56:03 -04:00
}
2018-01-20 08:57:41 -05:00
function piwik_addon_admin_post ( & $a ) {
2018-11-30 09:11:56 -05:00
$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' ]) : '' );
2017-11-06 18:55:24 -05:00
Config :: set ( 'piwik' , 'baseurl' , $url );
Config :: set ( 'piwik' , 'siteid' , $id );
Config :: set ( 'piwik' , 'optout' , $optout );
Config :: set ( 'piwik' , 'async' , $async );
2018-01-22 14:03:11 -05:00
info ( L10n :: t ( 'Settings updated.' ) . EOL );
2011-09-25 04:56:03 -04:00
}