Changes to be committed:

modified:   README.md
	new file:   action.php
	new file:   client.js
	new file:   plugin.info.txt
This commit is contained in:
Sascha Leib
2025-08-20 16:34:20 +03:00
parent 95d47eb6c8
commit 6980370b98
4 changed files with 141 additions and 1 deletions

View File

@@ -1,2 +1,4 @@
# dokuwiki-plugin-monitor
# DokuWiki Monitoring Plugin
Plugin for live-monitoring your DokuWiki instance
#TODO: Work in progress

56
action.php Normal file
View File

@@ -0,0 +1,56 @@
<?php
use dokuwiki\Extension\EventHandler;
use dokuwiki\Extension\Event;
/**
* Action Component for the Monitor Plugin
*
* @license GPL 3 (http://www.gnu.org/licenses/gpl.html)
* @author Sascha Leib <sascha.leib(at)kolmio.com>
*/
class action_plugin_monitor extends DokuWiki_Action_Plugin {
/**
* Registers a callback functions
*
* @param EventHandler $controller DokuWiki's event controller object
* @return void
*/
public function register(EventHandler $controller) {
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'insertHeader');
}
/**
* Inserts tracking code to the page header
*
* @param Event $event event object by reference
* @return void
*/
public function insertHeader(Event $event, $param) {
global $INFO;
// is there a user logged in?
$username = ( !empty($INFO['userinfo']) && !empty($INFO['userinfo']['name'])
? $INFO['userinfo']['name'] : null);
// build the tracker code:
$code = NL . DOKU_TAB . "document._monitor = {'t0': Date.now()};" . NL;
if ($username) {
$code .= DOKU_TAB . 'document._monitor.user = "' . $username . '";'. NL;
}
$code .= DOKU_TAB . "addEventListener('load',function(){" . NL;
$code .= DOKU_TAB . DOKU_TAB . "const e=document.createElement('script');" . NL;
$code .= DOKU_TAB . DOKU_TAB . "e.async=true;e.defer=true;" . NL;
$code .= DOKU_TAB . DOKU_TAB . "e.src='".DOKU_BASE."lib/plugins/monitor/client.js';" . NL;
$code .= DOKU_TAB . DOKU_TAB . "document.getElementsByTagName('head')[0].appendChild(e);" . NL;
$code .= DOKU_TAB . "});" . NL;
$event->data['script'][] = [
'_data' => $code
];
}
}

75
client.js Normal file
View File

@@ -0,0 +1,75 @@
monitor_client = {
init: function() {
/* send the page view request: */
this._onPageView(this._src.replace( this._scriptName, '/view.php'));
/* send the first heartbeat signal after x seconds: */
setTimeout(this._onHeartbeat.bind(this, this._src.replace( this._scriptName, '/tock.php')),this._heartbeat * 1000);
},
/* keep a reference to the script URL: */
_src: document.currentScript.src,
/* heartbeat signal every x seconds: */
_heartbeat: 30,
/* name of this script (with slash): */
_scriptName: '/client.js',
/* function to init page data on server: */
_onPageView: async function(url) {
try {
/* collect the data to send: */
const visit = {
'pg': JSINFO.id,
'u': document._monitor.user || null,
'lg': navigator.language,
'tz': new Date().getTimezoneOffset() /*,
'url': window.location.href,
'r': document.referrer,
'lt': ( document._monitor ? Date.now() - document._monitor.t0 : null),
'scr': screen.width+':'+screen.height,
'l': navigator.languages */
}
/* compile to a FormData object: */
const data = new FormData();
data.append( "visit", JSON.stringify( visit ) );
/* send the request */
const response = await fetch(url + '?t=' + Date.now(), {
method: 'POST',
body: data
});
if (!response.ok) {
throw new Error(response.status + ' ' + response.statusText + ' - ' + url);
}
} catch (err) {
console.error('Error: ', err);
}
},
/* function to call regularly to show the user is still on the page: */
_onHeartbeat: async function(url) {
console.info('monitor_client._onHeartbeat', url);
console.log(this);
try {
const response = await fetch(url + '?p=' + encodeURIComponent(JSINFO.id) + '&t=' + Date.now(), {
method: 'HEAD',
});
if (!response.ok) {
throw new Error(response.status + ' ' + response.statusText + ' - ' + url);
}
} catch (err) {
console.error(err);
} finally {
/* send the next heartbeat signal after x seconds: */
setTimeout(this._onHeartbeat.bind(this, this._src.replace( this._scriptName, '/tock.php')),this._heartbeat * 1000);
}
}
}
// init the script:
monitor_client.init();

7
plugin.info.txt Normal file
View File

@@ -0,0 +1,7 @@
base monitor
author Sascha Leib
email ad@hominem.com
date 2025-08-20
name Monitoring
desc Live monitoring traffic on your DokuWiki instance (under development)
url https://www.dokuwiki.org/plugin:nustats