xref: /plugin/botmon/action.php (revision b2e3bd8b82508cfa5ade59522b8bbcce2cb8568d)
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 = $_COOKIE['DokuWiki']  ?? '';
60		$sessionType = 'dw';
61		if ($sessionId == '') {
62			$sessionId = $_SERVER['REMOTE_ADDR'] ?? '';
63			if ($sessionId == '127.0.0.1' || $sessionId == '::1') {
64				$sessionId = 'localhost';
65			}
66			$sessionType = 'ip';
67		}
68
69		// clean the page ID
70		$pageId = preg_replace('/[\x00-\x1F]/', "\u{FFFD}", $INFO['id'] ?? '');
71
72		$logArr = Array(
73			$_SERVER['REMOTE_ADDR'] ?? '', /* remote IP */
74			$pageId, /* page ID */
75			$sessionId, /* Session ID */
76			$sessionType, /* session ID type */
77			$username,
78			$_SERVER['HTTP_USER_AGENT'] ?? '', /* User agent */
79			$_SERVER['HTTP_REFERER'] ?? '' /* HTTP Referrer */
80		);
81
82		//* create the log line */
83		$filename = __DIR__ .'/logs/' . gmdate('Y-m-d') . '.srv.txt'; /* use GMT date for filename */
84		$logline = gmdate('Y-m-d H:i:s'); /* use GMT time for log entries */
85		foreach ($logArr as $tab) {
86			$logline .= "\t" . $tab;
87		};
88
89		/* write the log line to the file */
90		$logfile = fopen($filename, 'a');
91		if (!$logfile) die();
92		if (fwrite($logfile, $logline . "\n") === false) {
93			fclose($logfile);
94			die();
95		}
96
97		/* Done */
98		fclose($logfile);
99
100	}
101}