pokemon-showdown/server/chat-plugins/modlog.js
2019-03-02 11:12:24 -06:00

627 lines
23 KiB
JavaScript

/**
* Modlog
* Pokemon Showdown - http://pokemonshowdown.com/
*
* Interface for viewing and searching modlog. These run in a
* subprocess.
*
* Also handles searching battle logs.
*
* Actually writing to modlog is handled in chat.js, rooms.js, and
* roomlogs.js
*
* @license MIT
*/
'use strict';
const FS = require('../../.lib-dist/fs').FS;
const path = require('path');
const Dashycode = require('../../.lib-dist/dashycode');
const util = require('util');
const execFile = util.promisify(require('child_process').execFile);
const MAX_PROCESSES = 1;
const MAX_QUERY_LENGTH = 2500;
const DEFAULT_RESULTS_LENGTH = 100;
const MORE_BUTTON_INCREMENTS = [200, 400, 800, 1600, 3200];
// If a modlog query takes longer than this, it will be logged.
const LONG_QUERY_DURATION = 2000;
const LINES_SEPARATOR = 'lines=';
const MAX_RESULTS_LENGTH = MORE_BUTTON_INCREMENTS[MORE_BUTTON_INCREMENTS.length - 1];
const LOG_PATH = 'logs/modlog/';
class SortedLimitedLengthList {
constructor(maxSize) {
this.maxSize = maxSize;
this.list = [];
}
getListClone() {
return this.list.slice();
}
insert(element) {
let insertedAt = -1;
for (let i = this.list.length - 1; i >= 0; i--) {
if (element.localeCompare(this.list[i]) < 0) {
insertedAt = i + 1;
if (i === this.list.length - 1) {
this.list.push(element);
break;
}
this.list.splice(i + 1, 0, element);
break;
}
}
if (insertedAt < 0) this.list.splice(0, 0, element);
if (this.list.length > this.maxSize) {
this.list.pop();
}
}
}
/*********************************************************
* Modlog Functions
*********************************************************/
function checkRipgrepAvailability() {
if (Config.ripgrepmodlog === undefined) {
Config.ripgrepmodlog = (async () => {
try {
await execFile('rg', ['--version'], {cwd: path.normalize(`${__dirname}/../`)});
await execFile('tac', ['--version'], {cwd: path.normalize(`${__dirname}/../`)});
return true;
} catch (error) {
return false;
}
})();
}
return Config.ripgrepmodlog;
}
function getMoreButton(roomid, search, useExactSearch, lines, maxLines) {
let newLines = 0;
for (let increase of MORE_BUTTON_INCREMENTS) {
if (increase > lines) {
newLines = increase;
break;
}
}
if (!newLines || lines < maxLines) {
return ''; // don't show a button if no more pre-set increments are valid or if the amount of results is already below the max
} else {
if (useExactSearch) search = Chat.escapeHTML(`"${search}"`);
return `<br /><div style="text-align:center"><button class="button" name="send" value="/modlog ${roomid}, ${search} ${LINES_SEPARATOR}${newLines}" title="View more results">Older results<br />&#x25bc;</button></div>`;
}
}
async function runModlog(roomidList, searchString, exactSearch, maxLines) {
const useRipgrep = await checkRipgrepAvailability();
let fileNameList = [];
let checkAllRooms = false;
for (const roomid of roomidList) {
if (roomid === 'all') {
checkAllRooms = true;
const fileList = await FS(LOG_PATH).readdir();
for (const file of fileList) {
if (file !== 'README.md' && file !== 'modlog_global.txt') fileNameList.push(file);
}
} else {
fileNameList.push(`modlog_${roomid}.txt`);
}
}
fileNameList = fileNameList.map(filename => `${LOG_PATH}${filename}`);
// Ensure regexString can never be greater than or equal to the value of
// RegExpMacroAssembler::kMaxRegister in v8 (currently 1 << 16 - 1) given a
// searchString with max length MAX_QUERY_LENGTH. Otherwise, the modlog
// child process will crash when attempting to execute any RegExp
// constructed with it (i.e. when not configured to use ripgrep).
let regexString;
if (!searchString) {
regexString = '.';
} else if (exactSearch) {
regexString = searchString.replace(/[\\.+*?()|[\]{}^$]/g, '\\$&');
} else {
searchString = toId(searchString);
regexString = `[^a-zA-Z0-9]${searchString.split('').join('[^a-zA-Z0-9]*')}([^a-zA-Z0-9]|\\z)`;
}
let results = new SortedLimitedLengthList(maxLines);
if (useRipgrep) {
// the entire directory is searched by default, no need to list every file manually
if (checkAllRooms) fileNameList = [LOG_PATH];
await runRipgrepModlog(fileNameList, regexString, results, maxLines);
} else {
const searchStringRegex = searchString ? new RegExp(regexString, 'i') : null;
for (const fileName of fileNameList) {
await checkRoomModlog(fileName, searchStringRegex, results);
}
}
const resultData = results.getListClone();
return resultData;
}
async function checkRoomModlog(path, regex, results) {
const fileStream = await FS(path).createReadStream();
let line;
while ((line = await fileStream.readLine()) !== null) {
if (!regex || regex.test(line)) {
results.insert(line);
}
}
fileStream.destroy();
return results;
}
async function runRipgrepModlog(paths, regexString, results, lines) {
let output;
try {
const options = [
'-i',
'-m', '' + lines,
'--pre', 'tac',
'-e', regexString,
'--no-filename',
'--no-line-number',
...paths,
'-g', '!modlog_global.txt', '-g', '!README.md',
];
output = await execFile('rg', options, {cwd: path.normalize(`${__dirname}/../../`)});
} catch (error) {
return results;
}
for (const fileName of output.stdout.split('\n').reverse()) {
if (fileName) results.insert(fileName);
}
return results;
}
function prettifyResults(resultArray, roomid, searchString, exactSearch, addModlogLinks, hideIps, maxLines) {
if (resultArray === null) {
return "|popup|The modlog query has crashed.";
}
let roomName;
switch (roomid) {
case 'all':
roomName = "all rooms";
break;
case 'public':
roomName = "all public rooms";
break;
default:
roomName = `room ${roomid}`;
}
if (!resultArray.length) {
return `|popup|No moderator actions containing ${searchString} found on ${roomName}.` +
(exactSearch ? "" : " Add quotes to the search parameter to search for a phrase, rather than a user.");
}
const title = `[${roomid}]` + (searchString ? ` ${searchString}` : ``);
let lines = resultArray.length;
let curDate = '';
resultArray.unshift('');
const resultString = resultArray.map(line => {
let time;
let bracketIndex;
if (line) {
if (hideIps) line = line.replace(/[([][0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[)\]]/g, '');
bracketIndex = line.indexOf(']');
if (bracketIndex < 0) return Chat.escapeHTML(line);
time = new Date(line.slice(1, bracketIndex));
} else {
time = new Date();
}
let [date, timestamp] = Chat.toTimestamp(time, {human: true}).split(' ');
if (date !== curDate) {
curDate = date;
date = `</p><p>[${date}]<br />`;
} else {
date = ``;
}
if (!line) {
return `${date}<small>[${timestamp}] \u2190 current server time</small>`;
}
let parenIndex = line.indexOf(')');
let thisRoomID = line.slice(bracketIndex + 3, parenIndex);
if (addModlogLinks) {
let url = Config.modloglink(time, thisRoomID);
if (url) timestamp = `<a href="${url}">${timestamp}</a>`;
}
return `${date}<small>[${timestamp}] (${thisRoomID})</small>${Chat.escapeHTML(line.slice(parenIndex + 1))}`;
}).join(`<br />`);
let preamble;
const modlogid = roomid + (searchString ? '-' + Dashycode.encode(searchString) : '');
if (searchString) {
const searchStringDescription = (exactSearch ? `containing the string "${searchString}"` : `matching the username "${searchString}"`);
preamble = `>view-modlog-${modlogid}\n|init|html\n|title|[Modlog]${title}\n` +
`|pagehtml|<div class="pad"><p>The last ${Chat.count(lines, "logged actions")} ${searchStringDescription} on ${roomName}.` +
(exactSearch ? "" : " Add quotes to the search parameter to search for a phrase, rather than a user.");
} else {
preamble = `>view-modlog-${modlogid}\n|init|html\n|title|[Modlog]${title}\n` +
`|pagehtml|<div class="pad"><p>The last ${Chat.count(lines, "lines")} of the Moderator Log of ${roomName}.`;
}
let moreButton = getMoreButton(roomid, searchString, exactSearch, lines, maxLines);
return `${preamble}${resultString}${moreButton}</div>`;
}
async function getModlog(connection, roomid = 'global', searchString = '', maxLines = 20, timed = false) {
const startTime = Date.now();
const targetRoom = Rooms.search(roomid);
const user = connection.user;
// permission checking
if (roomid === 'all' || roomid === 'public') {
if (!user.can('modlog')) {
return connection.popup("Access denied");
}
} else {
if (!user.can('modlog', null, targetRoom) && !user.can('modlog')) {
return connection.popup("Access denied");
}
}
const hideIps = !user.can('lock');
const addModlogLinks = Config.modloglink && (user.group !== ' ' || (targetRoom && targetRoom.isPrivate !== true));
if (searchString.length > MAX_QUERY_LENGTH) {
connection.popup(`Your search query must be shorter than ${MAX_QUERY_LENGTH} characters.`);
return;
}
let exactSearch = false;
if (searchString.match(/^["'].+["']$/)) {
exactSearch = true;
searchString = searchString.substring(1, searchString.length - 1);
}
let roomidList;
// handle this here so the child process doesn't have to load rooms data
if (roomid === 'public') {
const isPublicRoom = (room => !(room.isPrivate || room.battle || room.isPersonal || room.id === 'global'));
roomidList = Array.from(Rooms.rooms.values()).filter(isPublicRoom).map(room => room.id);
} else {
roomidList = [roomid];
}
const query = {cmd: 'modlog', roomidList, searchString, exactSearch, maxLines};
const response = await PM.query(query);
connection.send(prettifyResults(response, roomid, searchString, exactSearch, addModlogLinks, hideIps, maxLines));
const duration = Date.now() - startTime;
if (timed) connection.popup(`The modlog query took ${duration} ms to complete.`);
if (duration > LONG_QUERY_DURATION) console.log(`Long modlog query took ${duration} ms to complete:`, query);
}
/*********************************************************
* Battle Search Functions
*********************************************************/
async function runBattleSearch(userid, turnLimit, month, tierid, date) {
const useRipgrep = await checkRipgrepAvailability();
let path = `logs/${month}/${tierid}/${date}`;
let results = {
totalBattles: 0,
totalWins: 0,
totalLosses: 0,
totalTies: 0,
};
let files = [];
try {
files = await FS(path).readdir();
} catch (err) {
if (err.code === 'ENOENT') {
results.notFound = true;
return results;
}
throw err;
}
if (useRipgrep) {
// Matches non-word (including _ which counts as a word) characters between letters/numbers
// in a user's name so the userid can case-insensitively be matched to the name.
const regexString = `("p1":"${userid.split('').join('[^a-zA-Z0-9]*')}[^a-zA-Z0-9]*"|"p2":"${userid.split('').join('[^a-zA-Z0-9]*')}[^a-zA-Z0-9]*")`;
let output;
try {
output = await execFile('rg', ['-i', regexString, '--no-filename', '--no-line-number', '-tjson', path]);
} catch (error) {
return results;
}
for (const file of output.stdout.split('\n').reverse()) {
if (!file) continue;
let data = JSON.parse(file);
if (data.turns > turnLimit) continue;
results.totalBattles++;
if (toId(data.winner) === userid) {
results.totalWins++;
} else if (data.winner) {
results.totalLosses++;
} else {
results.totalTies++;
}
const foe = toId(data.p1) === userid ? toId(data.p2) : toId(data.p1);
if (!results[foe]) results[foe] = 0;
results[foe]++;
}
return results;
}
for (const file of files) {
const json = await FS(`${path}/${file}`).readIfExists();
const data = JSON.parse(json);
if (toId(data.p1) !== userid && toId(data.p2) !== userid) continue;
if (data.turns > turnLimit) continue;
results.totalBattles++;
if (toId(data.winner) === userid) {
results.totalWins++;
} else if (data.winner) {
results.totalLosses++;
} else {
results.totalTies++;
}
const foe = toId(data.p1) === userid ? toId(data.p2) : toId(data.p1);
if (!results[foe]) results[foe] = 0;
results[foe]++;
}
return results;
}
function buildResults(data, userid, turnLimit, month, tierid, date) {
let buf = `>view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}-${date}-confirm\n|init|html\n|title|[Battle Search][${userid}][${tierid}][${date}]\n`;
buf += `|pagehtml|<div class="pad ladder"><p>${tierid} battles on ${date} where ${userid} was a player and the battle lasted less than ${turnLimit} turn${Chat.plural(turnLimit)}:</p>`;
buf += `<table style="margin-left: auto; margin-right: auto"><tbody><tr><th colspan="2"><h2 style="margin: 5px auto">${userid}'s ${tierid} Battles</h1></th></tr><tr><th>Category</th><th>Number</th></tr>`;
buf += `<tr><td>Total Battles</td><td>${data.totalBattles}</td></tr><tr><td>Total Wins</td><td>${data.totalWins}</td></tr><tr><td>Total Losses</td><td>${data.totalLosses}</td></tr><tr><td>Total Ties</td><td>${data.totalTies}</td></tr>`;
buf += `<tr><th>Opponent</th><th>Times Battled</th></tr>`;
for (let foe in data) {
if (['totalBattles', 'totalWins', 'totalLosses', 'totalTies'].includes(foe)) continue;
buf += `<tr><td>${foe}</td><td>${data[foe]}</td></tr>`;
}
buf += `</tbody></table></div>`;
return buf;
}
async function getBattleSearch(connection, userid, turnLimit = 1, month, tierid, date) {
const user = connection.user;
if (!user.can('forcewin')) return connection.popup(`/battlesearch - Access Denied`);
const response = await PM.query({cmd: 'battlesearch', userid, turnLimit, month, tierid, date});
connection.send(buildResults(response, userid, turnLimit, month, tierid, date));
}
exports.pages = {
modlog(args, user, connection) {
if (!user.named) return Rooms.RETRY_AFTER_LOGIN;
const roomid = args[0];
const target = Dashycode.decode(args.slice(1).join('-'));
getModlog(connection, roomid, target);
},
async battlesearch(args, user, connection) {
if (!user.named) return Rooms.RETRY_AFTER_LOGIN;
if (!this.can('forcewin')) return;
let userid = toId(args.shift());
let turnLimit = parseInt(args.shift());
if (!userid || !turnLimit || turnLimit < 1) return user.popup(`Some arguments are missing or invalid for battlesearch. Use /battlesearch to start over.`);
this.title = `[Battle Search][${userid}]`;
let buf = `<div class="pad ladder"><h2>Battle Search</h2><p>Userid: ${userid}</p><p>Maximum Turns: ${turnLimit}</p>`;
const months = (await FS('logs/').readdir()).filter(f => f.length === 7 && f.includes('-')).sort((aKey, bKey) => {
const a = aKey.split('-').map(parseInt);
const b = bKey.split('-').map(parseInt);
if (a[0] !== b[0]) return b[0] - a[0];
return b[1] - a[1];
});
let month = args.shift();
if (!month) {
buf += `<p>Please select a month:</p><ul style="list-style: none; display: block; padding: 0">`;
for (const i of months) {
buf += `<li style="display: inline; list-style: none"><a href="/view-battlesearch-${userid}-${turnLimit}-${i}" target="replace"><button class="button">${i}</button></li>`;
}
return buf + `</ul></div>`;
} else {
month = month += `-${args.shift()}`;
if (!months.includes(month)) return buf + `Invalid month selected. <a href="/view-battlesearch-${userid}-${turnLimit}" target="replace"><button class="button">Back to month selection</button></a></div>`;
buf += `<p><a href="/view-battlesearch-${userid}-${turnLimit}" target="replace"><button class="button">Back</button></a> <button class="button disabled">${month}</button></p>`;
}
let tierid = toId(args.shift());
const tiers = (await FS(`logs/${month}/`).readdir()).sort((a, b) => {
// First sort by gen with the latest being first
let aGen = 6;
let bGen = 6;
if (a.substring(0, 3) === 'gen') aGen = parseInt(a.substring(3, 4));
if (b.substring(0, 3) === 'gen') bGen = parseInt(b.substring(3, 4));
if (aGen !== bGen) return bGen - aGen;
// Sort alphabetically
let aTier = a.substring(4);
let bTier = b.substring(4);
if (aTier < bTier) return -1;
if (aTier > bTier) return 1;
return 0;
}).map(tier => {
// Use the official tier name
let format = Dex.getFormat(tier);
if (format && format.exists) tier = format.name;
// Otherwise format as best as possible
if (tier.substring(0, 3) === 'gen') {
return `[Gen ${tier.substring(3, 4)}] ${tier.substring(4)}`;
}
return tier;
});
if (!tierid) {
buf += `<p>Please select the tier to search:</p><ul style="list-style: none; display: block; padding: 0">`;
for (const tier of tiers) {
buf += `<li style="display: inline; list-style: none"><a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${toId(tier)}" target="replace"><button class="button">${tier}</button></a></li>`;
}
return buf + `</ul></div>`;
} else {
let tierids = tiers.map(toId);
if (!tierids.includes(tierid)) return buf + `Invalid tier selected. <a href="/view-battlesearch-${userid}-${turnLimit}-${month}" target="replace"><button class="button">Back to tier selection</button></a></div>`;
this.title += `[${tierid}]`;
buf += `<p><a href="/view-battlesearch-${userid}-${turnLimit}-${month}" target="replace"><button class="button">Back</button></a> <button class="button disabled">${tierid}</button></p>`;
}
let date = args.shift();
const days = (await FS(`logs/${month}/${tierid}/`).readdir()).sort((a, b) => {
a = a.split('-').map(parseInt);
b = b.split('-').map(parseInt);
if (a[0] !== b[0]) return b[0] - a[0];
if (a[1] !== b[1]) return b[1] - a[1];
return b[2] - a[2];
});
if (!date) {
buf += `<p>Please select the date to search:</p><ul style="list-style: none; display: block; padding: 0">`;
for (const day of days) {
buf += `<li style="display: inline; list-style: none"><a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}-${day}" target="replace"><button class="button">${day}</button></a></li>`;
}
return buf + `</ul></div>`;
} else {
date = date += `-${args.shift()}-${args.shift()}`;
if (!days.includes(date)) return buf + `Invalid date selected. <a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}" target="replace"><button class="button">Back to date selection</button></a></div>`;
this.title += `[${date}]`;
buf += `<p><a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}" target="replace"><button class="button">Back</button></a> <button class="button disabled">${date}</button></p>`;
}
if (args[0] !== 'confirm') {
buf += `<p>Are you sure you want to run a battle search for for ${tierid} battles on ${date} where ${userid} was a player and the battle lasted less than ${turnLimit} turn${Chat.plural(turnLimit)}?</p>`;
buf += `<p><a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}-${date}-confirm" target="replace"><button class="button notifying">Yes, run the battle search</button></a> <a href="/view-battlesearch-${userid}-${turnLimit}-${month}-${tierid}" target="replace"><button class="button">No, go back</button></a></p>`;
return buf + `</div>`;
}
// Run search
getBattleSearch(connection, userid, turnLimit, month, tierid, date);
return `<div class="pad ladder"><h2>Battle Search</h2><p>Searching for ${tierid} battles on ${date} where ${userid} was a player and the battle lasted less than ${turnLimit} turn${Chat.plural(turnLimit)}.</p><p>Loading... (this will take a while)</p></div>`;
},
};
exports.commands = {
'!modlog': true,
ml: 'modlog',
timedmodlog: 'modlog',
modlog(target, room, user, connection, cmd) {
if (!room) room = Rooms('global');
let roomid = (room.id === 'staff' ? 'global' : room.id);
if (target.includes(',')) {
let targets = target.split(',');
target = targets[1].trim();
roomid = toId(targets[0]) || room.id;
}
let targetRoom = Rooms.search(roomid);
// if a room alias was used, replace alias with actual id
if (targetRoom) roomid = targetRoom.id;
if (roomid.includes('-')) return this.errorReply(`Battles and groupchats (and other rooms with - in their ID) don't have individual modlogs.`);
let lines;
if (target.includes(LINES_SEPARATOR)) { // undocumented line specification
const reqIndex = target.indexOf(LINES_SEPARATOR);
const requestedLines = parseInt(target.substr(reqIndex + LINES_SEPARATOR.length, target.length));
if (isNaN(requestedLines) || requestedLines < 1) {
this.errorReply(`${LINES_SEPARATOR}${requestedLines} is not a valid line count.`);
return;
}
lines = requestedLines;
target = target.substr(0, reqIndex).trim(); // strip search out
}
if (!target && !lines) {
lines = 20;
}
if (!lines) lines = DEFAULT_RESULTS_LENGTH;
if (lines > MAX_RESULTS_LENGTH) lines = MAX_RESULTS_LENGTH;
getModlog(connection, roomid, target, lines, cmd === 'timedmodlog');
},
modloghelp: [
`/modlog OR /ml [roomid], [search] - Searches the moderator log - defaults to the current room unless specified otherwise.`,
`If you set [roomid] as [all], it searches for [search] on all rooms' moderator logs.`,
`If you set [roomid] as [public], it searches for [search] in all public rooms' moderator logs, excluding battles. Requires: % @ # & ~`,
],
battlesearch(target, room, user, connection) {
if (!target.trim()) return this.parse('/help battlesearch');
if (!this.can('forcewin')) return;
let [userid, turnLimit] = target.split(',').map(toId);
if (!userid) return this.parse('/help battlesearch');
if (!turnLimit) {
turnLimit = 1;
} else {
turnLimit = parseInt(turnLimit);
if (isNaN(turnLimit) || turnLimit < 1) return this.errorReply(`The turn limit should be a number that is greater than 0.`);
}
// Selection on month, tier, and date will be handled in the HTML room
return this.parse(`/join view-battlesearch-${userid}-${turnLimit}`);
},
battlesearchhelp: ['/battlesearch [user], (turn limit) - Searches a users rated battle history and returns information on battles that ended in less than (turn limit or 1) turns. Requires &, ~'],
};
/*********************************************************
* Process manager
*********************************************************/
const QueryProcessManager = require('../../.lib-dist/process-manager').QueryProcessManager;
const PM = new QueryProcessManager(module, async data => {
switch (data.cmd) {
case 'modlog':
const {roomidList, searchString, exactSearch, maxLines} = data;
try {
return await runModlog(roomidList, searchString, exactSearch, maxLines);
} catch (err) {
Monitor.crashlog(err, 'A modlog query', {
roomidList,
searchString,
exactSearch,
maxLines,
});
}
break;
case 'battlesearch':
const {userid, turnLimit, month, tierid, date} = data;
try {
return await runBattleSearch(userid, turnLimit, month, tierid, date);
} catch (err) {
Monitor.crashlog(err, 'A battle search query', {
userid,
turnLimit,
month,
tierid,
date,
});
}
break;
}
return null;
});
if (!PM.isParentProcess) {
// This is a child process!
global.Config = require('../../config/config');
// @ts-ignore ???
global.Monitor = {
/**
* @param {Error} error
* @param {string} source
* @param {{}?} details
*/
crashlog(error, source = 'A modlog process', details = null) {
const repr = JSON.stringify([error.name, error.message, source, details]);
// @ts-ignore
process.send(`THROW\n@!!@${repr}\n${error.stack}`);
},
};
process.on('uncaughtException', err => {
if (Config.crashguard) {
Monitor.crashlog(err, 'A modlog child process');
}
});
global.Dex = require('../../.sim-dist/dex');
global.toId = Dex.getId;
require('../../.lib-dist/repl').Repl.start('modlog', cmd => eval(cmd));
} else {
PM.spawn(MAX_PROCESSES);
}
exports.PM = PM;