xref: /plugin/botmon/action.php (revision f4417fde3b994fe0c6f5285c818940fa0214754b) 
1<?php
2
3use dokuwiki\Extension\EventHandler;
4use dokuwiki\Extension\Event;
5
6/**
7 * Action Component for the Bot Monitoring Plugin
8 *
9 * @license	GPL 3 (http://www.gnu.org/licenses/gpl.html)
10 * @author	 Sascha Leib <sascha.leib(at)kolmio.com>
11 */
12
13class action_plugin_botmon extends DokuWiki_Action_Plugin {
14
15	/**
16	 * Registers a callback functions
17	 *
18	 * @param EventHandler $controller DokuWiki's event controller object
19	 * @return void
20	 */
21	public function register(EventHandler $controller) {
22		$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'insertHeader');
23	}
24
25	/**
26	 * Inserts tracking code to the page header
27	 *
28	 * @param Event $event event object by reference
29	 * @return void
30	 */
31	public function insertHeader(Event $event, $param) {
32
33		global $INFO;
34
35		// is there a user logged in?
36		$username = ( !empty($INFO['userinfo']) && !empty($INFO['userinfo']['name'])
37					?  $INFO['userinfo']['name'] : '');
38
39		// build the tracker code:
40		$code = NL . DOKU_TAB . "document._botmon = {'t0': Date.now()};" . NL;
41		if ($username) {
42			$code .= DOKU_TAB . 'document._botmon.user = "' . $username . '";'. NL;
43		}
44		$code .= DOKU_TAB . "addEventListener('load',function(){" . NL;
45
46		$code .= DOKU_TAB . DOKU_TAB . "const e=document.createElement('script');" . NL;
47		$code .= DOKU_TAB . DOKU_TAB . "e.async=true;e.defer=true;" . NL;
48		$code .= DOKU_TAB . DOKU_TAB . "e.src='".DOKU_BASE."lib/plugins/botmon/client.js';" . NL;
49		$code .= DOKU_TAB . DOKU_TAB . "document.getElementsByTagName('head')[0].appendChild(e);" . NL;
50		$code .= DOKU_TAB . "});" . NL;
51
52		$event->data['script'][] = [
53			'_data'   => $code
54        ];
55
56		/* Write out server-side info to a server log: */
57
58		// what is the session identifier?
59		$sessionId = $username;
60		$sessionType = 'usr';
61		if ($sessionId == '') {
62			$sessionId = $_COOKIE['DokuWiki'] ?? '';
63			$sessionType = 'dw';
64		}
65		if ($sessionId == '') {
66			$sessionId = $_SERVER['REMOTE_ADDR'] ?? '';
67			if ($sessionId == '127.0.0.1' || $sessionId == '::1') {
68				$sessionId = 'localhost';
69			}
70			$sessionType = 'ip';
71		}
72
73		$logArr = Array(
74			$_SERVER['REMOTE_ADDR'] ?? '', /* remote IP */
75			$INFO['id'] ?? '', /* page ID */
76			$sessionId, /* Session ID */
77			$sessionType,
78			$username,
79			$_SERVER['HTTP_USER_AGENT'] ?? '', /* User agent */
80			$_SERVER['HTTP_REFERER'] ?? '' /* HTTP Referrer */
81		);
82
83		//* create the log line */
84		$filename = __DIR__ .'/logs/' . gmdate('Y-m-d') . '.srv.txt'; /* use GMT date for filename */
85		$logline = gmdate('Y-m-d H:i:s'); /* use GMT time for log entries */
86		foreach ($logArr as $tab) {
87			$logline .= "\t" . $tab;
88		};
89
90		/* write the log line to the file */
91		$logfile = fopen($filename, 'a');
92		if (!$logfile) die();
93		if (fwrite($logfile, $logline . "\n") === false) {
94			fclose($logfile);
95			die();
96		}
97
98		/* Done */
99		fclose($logfile);
100
101	}
102}