xref: /plugin/botmon/action.php (revision cf9f7fe823093a2f336627bc7e05ea0296d98bca)
16980370bSSascha Leib<?php
26980370bSSascha Leib
36980370bSSascha Leibuse dokuwiki\Extension\EventHandler;
46980370bSSascha Leibuse dokuwiki\Extension\Event;
56980370bSSascha Leib
66980370bSSascha Leib/**
76980370bSSascha Leib * Action Component for the Monitor Plugin
86980370bSSascha Leib *
96980370bSSascha Leib * @license	GPL 3 (http://www.gnu.org/licenses/gpl.html)
106980370bSSascha Leib * @author	 Sascha Leib <sascha.leib(at)kolmio.com>
116980370bSSascha Leib */
126980370bSSascha Leib
136980370bSSascha Leibclass action_plugin_monitor extends DokuWiki_Action_Plugin {
146980370bSSascha Leib
156980370bSSascha Leib	/**
166980370bSSascha Leib	 * Registers a callback functions
176980370bSSascha Leib	 *
186980370bSSascha Leib	 * @param EventHandler $controller DokuWiki's event controller object
196980370bSSascha Leib	 * @return void
206980370bSSascha Leib	 */
216980370bSSascha Leib	public function register(EventHandler $controller) {
226980370bSSascha Leib		$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'insertHeader');
236980370bSSascha Leib	}
246980370bSSascha Leib
256980370bSSascha Leib	/**
266980370bSSascha Leib	 * Inserts tracking code to the page header
276980370bSSascha Leib	 *
286980370bSSascha Leib	 * @param Event $event event object by reference
296980370bSSascha Leib	 * @return void
306980370bSSascha Leib	 */
316980370bSSascha Leib	public function insertHeader(Event $event, $param) {
326980370bSSascha Leib
336980370bSSascha Leib		global $INFO;
346980370bSSascha Leib
356980370bSSascha Leib		// is there a user logged in?
366980370bSSascha Leib		$username = ( !empty($INFO['userinfo']) && !empty($INFO['userinfo']['name'])
376980370bSSascha Leib					?  $INFO['userinfo']['name'] : null);
386980370bSSascha Leib
396980370bSSascha Leib		// build the tracker code:
406980370bSSascha Leib		$code = NL . DOKU_TAB . "document._monitor = {'t0': Date.now()};" . NL;
416980370bSSascha Leib		if ($username) {
426980370bSSascha Leib			$code .= DOKU_TAB . 'document._monitor.user = "' . $username . '";'. NL;
436980370bSSascha Leib		}
446980370bSSascha Leib		$code .= DOKU_TAB . "addEventListener('load',function(){" . NL;
456980370bSSascha Leib
466980370bSSascha Leib		$code .= DOKU_TAB . DOKU_TAB . "const e=document.createElement('script');" . NL;
476980370bSSascha Leib		$code .= DOKU_TAB . DOKU_TAB . "e.async=true;e.defer=true;" . NL;
486980370bSSascha Leib		$code .= DOKU_TAB . DOKU_TAB . "e.src='".DOKU_BASE."lib/plugins/monitor/client.js';" . NL;
496980370bSSascha Leib		$code .= DOKU_TAB . DOKU_TAB . "document.getElementsByTagName('head')[0].appendChild(e);" . NL;
506980370bSSascha Leib		$code .= DOKU_TAB . "});" . NL;
516980370bSSascha Leib
526980370bSSascha Leib		$event->data['script'][] = [
536980370bSSascha Leib			'_data'   => $code
546980370bSSascha Leib        ];
55*cf9f7fe8SSascha Leib
56*cf9f7fe8SSascha Leib		/* Write out client info to a server log: */
57*cf9f7fe8SSascha Leib
58*cf9f7fe8SSascha Leib		$logArr = Array(
59*cf9f7fe8SSascha Leib			$_SERVER['REMOTE_ADDR'] ?? '–', /* remote IP */
60*cf9f7fe8SSascha Leib			$INFO['id'] ?? '–', /* user agent */
61*cf9f7fe8SSascha Leib			$_COOKIE['DokuWiki'] ?? '–', /* DokuWiki session ID */
62*cf9f7fe8SSascha Leib			$username,
63*cf9f7fe8SSascha Leib			$_SERVER['HTTP_USER_AGENT'] ?? '' /* User agent */
64*cf9f7fe8SSascha Leib		);
65*cf9f7fe8SSascha Leib
66*cf9f7fe8SSascha Leib		//* create the log line */
67*cf9f7fe8SSascha Leib		$filename = __DIR__ .'/logs/' . gmdate('Y-m-d') . '.srv'; /* use GMT date for filename */
68*cf9f7fe8SSascha Leib		$logline = gmdate('Y-m-d H:i:s'); /* use GMT time for log entries */
69*cf9f7fe8SSascha Leib		foreach ($logArr as $tab) {
70*cf9f7fe8SSascha Leib			$logline .= "\t" . $tab;
71*cf9f7fe8SSascha Leib		};
72*cf9f7fe8SSascha Leib
73*cf9f7fe8SSascha Leib		/* write the log line to the file */
74*cf9f7fe8SSascha Leib		$logfile = fopen($filename, 'a');
75*cf9f7fe8SSascha Leib		if (!$logfile) die();
76*cf9f7fe8SSascha Leib		if (fwrite($logfile, $logline . "\n") === false) {
77*cf9f7fe8SSascha Leib			fclose($logfile);
78*cf9f7fe8SSascha Leib			die();
796980370bSSascha Leib		}
80*cf9f7fe8SSascha Leib
81*cf9f7fe8SSascha Leib		/* Done */
82*cf9f7fe8SSascha Leib		fclose($logfile);
83*cf9f7fe8SSascha Leib
84*cf9f7fe8SSascha Leib	}
85*cf9f7fe8SSascha Leib
866980370bSSascha Leib}