EnlivenMinetest/webapp/server.js

'use strict';
// Howto: see README.md

//function getUserHome() {
	//return process.env[(process.platform == 'win32') ? 'USERPROFILE' : 'HOME'];
//}


const profilePath = require('os').homedir();
var skinDir = profilePath + "/minetest/games/ENLIVEN/mods/codercore/coderskins/textures";
var tz_offset = 240; //subtract this from server time to get local time; 4hrs is 240; 5hrs is 300
//TODO: handle tz_offset not divisible by 60
//var selected_date_s = null;
//selected_date_s = "2018-05-08";

var express = require('express'),
//var exphbs  = require("express-handlebars");
//	exphbs  = require('../../'); // "express-handlebars"
	cookieParser = require('cookie-parser'),
	bodyParser = require('body-parser'),
	//session = require('express-session'),
	fs = require('fs'),
	readlines = require('n-readlines');
const os = require('os');
var formidable = require('formidable')
var querystring = require("querystring");  // built-in
// var util = require('util')

var app = express();
//app.engine('handlebars', exphbs({defaultLayout: 'main'}));
//app.set('view engine', 'handlebars');
var players = [];
var player_indices = {};
var play_dates = [];
//see https://developer.mozilla.org/en-US/docs/Learn/Server-side/Express_Nodejs/Introduction
var prev_line = null;

//#region derived from mtsenliven.py
var msgprefix_flags = ["WARNING[Server]: ", "ACTION[Server]: "]
var msgprefix_lists = {}  // where flag is key
var mf_len = msgprefix_flags.length;
for (var mf_i=0; mf_i<mf_len; mf_i++) {
	msgprefix_lists[msgprefix_flags[mf_i]] = [];
}

var non_unique_wraps = [];
non_unique_wraps.push({
	"opener":"active block modifiers took ",
	"closer":"ms (longer than 200ms)"
});
var unique_flags = [
	"leaves game",
	"joins game"
];
//#endregion derived from mtsenliven.py

function process_logline(line, line_number) {
	//selected_date_s
	//TODO: use store_unique_log_data instead of this function
	var player_name = null;
	var verb = "";
	var time_s = "";
	var date_s = "";
	var player_ip = null;
	const time_start_i = 11;
	var uf_len = unique_flags.length;
	mf_len = msgprefix_flags.length;
	var verb_i = -1;
	var verb_number = -1;
	var msgprefix_i = -1;
	var msgprefix_number = -1;
	var msgprefix = null;
	var index_msg = "";
	for (var mf_i=0; mf_i<mf_len; mf_i++) {
		msgprefix_i = line.indexOf(msgprefix_flags[mf_i]);
		if (msgprefix_i > -1) {
			msgprefix_number = mf_i;
			msgprefix = msgprefix_flags[mf_i];
			break;
		}
	}
	var skip_date_enable = false;
	for (var uf_i=0; uf_i<uf_len; uf_i++) {
		verb_i = line.indexOf(unique_flags[uf_i]);
		if (verb_i > -1) {
			verb_number = uf_i;
			verb = unique_flags[uf_i];
			date_s = line.substring(0,10).trim();
			//if (selected_date_s==null || selected_date_s==date_s) {
				//console.log("(verbose message in process_logline) using '" + date_s + "' since selected '"+selected_date_s+"'");
				time_s = line.substring(time_start_i, time_start_i+8);
				//console.log("using time "+time_s);
				if (msgprefix!=null) {
					player_name = line.substring(msgprefix_i+msgprefix.length, verb_i).trim();
					var ip_flag = " [";
					var ip_i = player_name.indexOf(ip_flag);
					if (ip_i > -1) {
						player_ip = player_name.substring(ip_i+ip_flag.length, player_name.length-1);
						player_name = player_name.substring(0,ip_i);
					}
				}
				else {
					player_name = "&lt;missing msgprefix&rt;";
				}
			//}
			//else {
			//	skip_date_enable = true;
				//console.log("WARNING in process_logline: skipping '" + date_s + "' since not '"+selected_date_s+"'");
			//}
			break;
		}
	}
	var index = -1;  // player index
	if (player_name != null) {
		if (player_name.length > 0) {
			if (player_indices.hasOwnProperty(player_name)) {
				index = player_indices[player_name];
				index_msg = "cached ";
			}
			else {
				index = players.length;
				//players.push({});
				players[index] = {};
				players[index].display_name = player_name;
				player_indices[player_name] = index;
				//console.log("created new index "+index);
			}
		}
		else {
			console.log("WARNING in process_logline: zero-length player name");
		}
	}
	if (index<0 && (verb=="leaves game"||verb=="joins game")) {
		console.log("(ERROR in process_logline) " + index_msg +
		            "index was '"+index+"' but date was present '" +
		            date_s + "' for '"+line+"' (no player found, but" +
		            "verb is a player verb).");
	}
	var play_date_enable = false;
	if (verb == "leaves game") {
		if (index > -1) {
			var play_i = -1;
			if (!players[index].hasOwnProperty("plays")) {
				players[index].plays = {};
			}
			if (!players[index].plays.hasOwnProperty(date_s)) {
				//leave login time blank--player must have logged in before the available part of the log began
				players[index].plays[date_s] = [];
				players[index].plays[date_s].push({});
				play_i = 0;
			}
			else {
				if (players[index].plays[date_s].length==0) players[index].plays[date_s].push({});
				play_i = players[index].plays[date_s].length - 1;
				if (players[index].plays[date_s][play_i].hasOwnProperty("logout_time")) {
					//If last entry is incomplete, start a new one:
					players[index].plays[date_s].push({});
					play_i++;
				}
			}
			players[index].plays[date_s][play_i].logout_time = time_s;
			play_date_enable = true;
		}
	}
	else if (verb == "joins game") {
		if (index > -1) {
			if (player_ip!=null) {
				players[index].player_ip = player_ip;
				var play_i = -1;
				if (!players[index].hasOwnProperty("plays")) {
					players[index].plays = {};
				}
				if (!players[index].plays.hasOwnProperty(date_s)) {
					players[index].plays[date_s] = [];
					play_i = 0;
				}
				else play_i = players[index].plays[date_s].length;
				players[index].plays[date_s].push({});
				//console.log(verb+" on "+date_s+" (length "+players[index].plays[date_s].length+") play "+play_i+"+1 for player ["+index+"] "+player_name+"...");
				players[index].plays[date_s][play_i].login_time = time_s;
				play_date_enable = true;
			}
			// else redundant (server writes " joins game " again
			// and shows list of players instead of ip).
			//TODO: else analyze list of players to confirm in case player logged in all day
		}
	}
	if (play_date_enable) {
		if (date_s.length>0) {
			if (play_dates.indexOf(date_s) < 0) {
				play_dates.push(date_s);
			}
		}
	}
}

function store_unique_log_data(output, line_number, err_flag=false) {
	var ret = "";
	var output_strip = output.trim();
	var u_prefix = "active block modifiers took ";
	var u_suffix = "ms (longer than 200ms)";
	// (out_bytes is bytes)
	var show_enable = true;
	var found_flag = null;
	var f_i = null;
	var always_show_enable = false;
	var msg_msg = "previous message";
	var uf_len = unique_flags.length;
	for (var uf_i=0; uf_i<uf_len; uf_i++) {
		if (output.includes(unique_flags[uf_i])) {
			always_show_enable = true;
		}
	}
	if (!always_show_enable) {
		var mf_len = msgprefix_flags.length;
		for (var mf_i=0; mf_i<mf_len; mf_i++) {
			// such as '2018-02-06 21:08:06: WARNING[Server]: Deprecated call to get_look_yaw, use get_look_horizontal instead'
			// or 2018-02-06 21:08:05: ACTION[Server]: [playereffects] Wrote playereffects data into /home/owner/.minetest/worlds/FCAGameAWorld/playereffects.mt.
			f_i = output.find(msgprefix_flags[mf_i]);
			if (f_i >= 0) {
				found_flag = msgprefix_flags[mf_i];
				break;
			}
		}
		if (found_flag!=null) {
			var sub_msg = output.substring(f_i+flag.length).trim();
			var nuw_len = non_unique_wraps.length;
			for (var nuw_i=0; nuw_i<nuw_len; nuw_i++) {
			//for (wrap in non_unique_wraps) {
				var wrap = non_unique_wraps[nuw_i];
				if (sub_msg.includes(wrap["opener"]) && sub_msg.includes(wrap["closer"])) {
					sub_msg = wrap["opener"] + "..." + wrap["closer"];
					msg_msg = "similar messages";
					break;
				}
			}
			if (msgprefix_lists[found_flag].indexOf(sub_msg) > -1) {
				show_enable = false;
			}
			else {
				msgprefix_lists[found_flag].push(sub_msg);
			}
		}
	}
	if (show_enable) {
		ret = output_strip;
		if (found_flag != null) {
			ret += "\n  [ EnlivenMinetest ] " + msg_msg + " will be suppressed";
		}
	}
	return ret;
}

function read_log() {
	if (players==null) players = [];
	if (player_indices==null) player_indices = {};
	// os.homedir() + "/.minetest/debug_archived/2018/05/08.txt",
	// var log_paths = [os.homedir() + "/.minetest/debug.txt"];
	var log_paths = [os.homedir() + "/minetest/bin/debug.txt"];
	var lp_len = log_paths.length;
	for (var lp_i=0; lp_i<lp_len; lp_i++) {
		var this_log_path = log_paths[lp_i];
		console.log("EnlivenMinetest webapp reading '" + this_log_path + "'...");
		var line_number = 1;
		if (fs.existsSync(this_log_path)) {
			//uses n-readlines package: see https://stackoverflow.com/questions/34223065/read-lines-synchronously-from-file-in-node-js
			var liner = new readlines(this_log_path);
			var next = true;
			while (next) {
				next = liner.next();
				if (next!=false) {
					process_logline(next.toString('ascii'), line_number);
					line_number++;
				}
			}
		}
		else {
			console.log("WARNING: file not found: '" + this_log_path + "' (listing actual archived log folders is not yet implemented, so this is a hard-coded demo folder only on poikilos' server)");
		}
	}
}



app.get('/get-players', function (req, res) {
	res.setHeader('Content-Type', 'application/json');
	 res.send(JSON.stringify(players));
});

var last_announce_string = "none";

app.get('/last-announce', function (req, res) {
	res.setHeader('Content-Type', 'text/plain');
	res.send(last_announce_string);
});

app.get('/announce', function (req, res) {
	last_announce_string = JSON.stringify(req.body);
	console.log("announce got:"+last_announce_string);
	res.setHeader('Content-Type', 'text/plain');
	res.send();
});



app.get('/skin-form', function (req, res) {
	var ret = "";
	ret += '<html><body style="font-family:calibri,sans">'+"\n";
	ret += '<form action="/set-skin" method="post" enctype="multipart/form-data">'+"\n";
	ret += 'User Name (case-sensitive): <input type="text" name="userName" id="userName">'+"\n";
	ret += 'Select image to upload:'+"\n";
	ret += '<input type="file" name="userFile" id="userFile">'+"\n";
	ret += '<input type="submit" value="Upload Image" name="submit">'+"\n";
	ret += '</form>'+"\n";
	ret += '</body></html>';
	res.send(ret);
	//res.render('home');
});


//using express & formidable:
app.post('/set-skin', function (req, res){
    var form = new formidable.IncomingForm();
	// from coderskins/readme.txt:
	//To install  a specific skin  for a specific player,  name the PNG file
	//to be used as follows:
		  //player_NAME.png
	//where NAME is  the player's in-game nick.  Then copy the PNG file into
	//the mod's "textures" directory.
	//The PNG file should be  a standard  Minetest 64x32 or  Minecraft 64x64
	//"skin" file.
	//Or, if you prefer,  create a text file, in the mod's "textures" direc-
	//tory with a similar filename:
		  //player_NAME.skin
	//(OldCoder, 2019)
	var directPath = "";
	var indirectPath = "";
	var destNameNoExt = "";
	var msg = "Uploading...";
    form.parse(req, function(err, fields, files) {
        if (err) next(err);
		destNameNoExt = destNameNoExt = "player_" + fields.userName;
        directPath = skinDir + "/" + destNameNoExt + ".png";
        indirectPath = skinDir + "/" + destNameNoExt + ".skin";
        // TODO: make sure my_file and project_id values are present
        if (files.userFile != undefined) {
			var originalPath = files.userFile.path;
			console.log("trying to rename " + files.userFile.path
						+ " to " + directPath);
			fs.rename(files.userFile.path, directPath, function(err) {
				if (err) {
					msg = "Failed to rename " + originalPath
						  + " to " + directPath + "<br/>\n";
					console.log(msg);
					next(err);
				}
				else {
					fs.writeFile(indirectPath + ".png", destNameNoExt + ".skin", function(err, data) {
					  if (err) console.log(err);
					  console.log("Successfully wrote " + destNameNoExt
								  + " to "+indirectPath+".");
					});
				}
				res.end();
			});
		}
		else {
			console.log("userFile is undefined.");
		}
    });
    //form.on('fileBegin', function (name, file){
        ////file.path = __dirname + '/uploads/' + file.name;
        //// file.path = skinDir + "/" + file.name;
        //// manual_path = "player_" +
    //});
    form.on('file', function (name, file){
		msg = 'Uploaded ' + file.name + "<br/>\n";
        console.log(msg);
    });
    //res.sendFile(__dirname + '/index.html');
    res.redirect("/?msg=" + querystring.stringify(msg));
});


app.get('/', function (req, res) {
	var ret = "";
	ret += '<html><body style="font-family:calibri,sans">';
	// Whenever server starts the following is logged
	// (see also etc/example-input.txt):
	//
	//-------------
	//  Separator
	//-------------
	//
	var selected_date_s = null;
	if (req.query.date) selected_date_s = req.query.date
	if (req.query.msg != undefined) {
		ret += "<br/>\n";
		//ret += "<b>" + querystring.parse(req.query.msg) + "</b><br>\n";
		// line above causes:
		//TypeError: Cannot convert object to primitive value
		//at /home/owner/git/EnlivenMinetest/webapp/server.js:390:16
		//at Layer.handle [as handle_request] (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/layer.js:95:5)
		//at next (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/route.js:137:13)
		//at Route.dispatch (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/route.js:112:3)
		//at Layer.handle [as handle_request] (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/layer.js:95:5)
		//at /home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/index.js:281:22
		//at Function.process_params (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/index.js:335:12)
		//at next (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/index.js:275:10)
		//at expressInit (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/middleware/init.js:40:5)
		//at Layer.handle [as handle_request] (/home/owner/git/EnlivenMinetest/webapp/node_modules/express/lib/router/layer.js:95:5)

		ret += "<br/>\n";
	}
	ret += "assuming minetestserver ran as: " + os.homedir() + "<br/>\n";
	ret += "timezone (tz_offset/60*-1): " + (Math.floor(tz_offset/60)*-1) + '<span name="tzArea" id="tzArea"></span><br/>\n';
	ret += 'date: <span id="dateArea" name="dateArea">' + selected_date_s + '</span><br/>'+"\n";
	//ret += 'var play_dates = [];';
	var pdLength = 0;
	if (play_dates != null) pdLength = play_dates.length;
	for (var pd_i = 0; pd_i < pdLength; pd_i++) {
		//ret += 'play_dates.push("' + play_dates[pd_i] + '");';
		if (selected_date_s!=play_dates[pd_i]) {
			ret += '<a href="?date='+play_dates[pd_i]+'">'+play_dates[pd_i]+'</a> ';
		}
		else {
			ret += play_dates[pd_i]+' ';
		}
	}
	//if (selected_date_s==null) {
		//ret += '<a href="?date=2018-05-08">2018-05-08</a>';
	//}
	//see ~/.minetest/debug.txt
	//and logs archived by EnlivenMinetest:
	//~/.minetest/debug_archived/2018/05/08.txt
	ret += `
<div style="color:gray" id="statusArea"></div>
<canvas id="myCanvas" width="100" height="1540"> <!--style="border:1px solid #c3c3c3;">-->
Your browser does not support the canvas element.
</canvas>
<div style="color:gray" id="outputArea">loading...</div>
<script src="js/main.js"></script>`;
	ret += '</body></html>';
	res.send(ret);
	//res.render('home');
});



var server = app.listen(3000, function () {
	//console.log('express-handlebars example server listening on: 3000');
	var host = server.address().address;
	var port = server.address().port;
	console.log("server address:");
	console.log(JSON.stringify(server.address()));
	console.log("reading log...");
	read_log();
	console.log("EnlivenMinetest webapp is listening at http://%s:%s", host, port);
});