/**
* Modlog viewer
* Pokemon Showdown - http://pokemonshowdown.com/
*
* Actually reading, writing, and searching modlog is handled in server/modlog/.
*
* @license MIT
*/
import { Dashycode, Utils } from '../../lib';
import type { ModlogID, ModlogSearch, ModlogEntry } from '../modlog';
const MAX_QUERY_LENGTH = 2500;
const DEFAULT_RESULTS_LENGTH = 100;
const MORE_BUTTON_INCREMENTS = [200, 400, 800, 1600, 3200];
const LINES_SEPARATOR = 'lines=';
const MAX_RESULTS_LENGTH = MORE_BUTTON_INCREMENTS[MORE_BUTTON_INCREMENTS.length - 1];
const IPS_REGEX = /[([]?([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})[)\]]?/g;
const ALIASES: { [k: string]: string } = {
'helpticket': 'help-rooms',
'groupchat': 'groupchat-rooms',
'battle': 'battle-rooms',
};
/*********************************************************
* Modlog Functions
*********************************************************/
function getMoreButton(
roomid: ModlogID, searchCmd: string,
lines: number, maxLines: number, onlyPunishments: boolean, onlyNotes: boolean,
) {
let newLines = 0;
for (const 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 {
let cmd = `/modlog`;
if (onlyNotes) cmd = `/modnotes`;
if (onlyPunishments) cmd = `/punishlog`;
return Utils.html`
The last ${scope}${Chat.count(lines, "logged actions")} ${Utils.escapeHTML(searchString)} on ${roomName}.`;
} else {
preamble = `>view-modlog-${modlogid}\n|init|html\n|title|[Modlog]${title}\n` +
`|pagehtml|
The last ${Chat.count(lines, `${scope}lines`)} of the Moderator Log of ${roomName}.`;
}
preamble += `
[${dateString}]
[${timestamp}] \u2190 current server time`;
const moreButton = getMoreButton(roomid, searchCmd, lines, maxLines, onlyPunishments, onlyNotes);
return `${preamble}${resultString}${moreButton}
`;
}
async function getModlog(
connection: Connection, roomid: ModlogID = 'global', search: ModlogSearch,
searchCmd: string, maxLines = 20, onlyPunishments = false, timed = false, onlyNotes = false,
) {
const targetRoom = Rooms.search(roomid);
const user = connection.user;
roomid = getRoomID(roomid);
// 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 = !!(
(user.tempGroup !== ' ' || (targetRoom && targetRoom.settings.isPrivate !== true))
);
if (hideIps && search.ip.length) {
connection.popup(`You cannot search for IPs.`);
return;
}
if (Object.values(search).join('').length > MAX_QUERY_LENGTH) {
connection.popup(`Your search query is too long.`);
return;
}
if (search.note?.length) {
for (const [i, noteSearch] of search.note.entries()) {
if (/^["'].+["']$/.test(noteSearch.search)) {
search.note[i] = { ...noteSearch, search: noteSearch.search.substring(1, noteSearch.search.length - 1) };
search.note[i].isExact = true;
}
}
}
for (const [i, userSearch] of search.user.entries()) {
if (/^["'].+["']$/.test(userSearch.search)) {
userSearch.search = userSearch.search.substring(1, userSearch.search.length - 1);
userSearch.isExact = true;
}
userSearch.search = toID(userSearch.search);
search.user[i] = userSearch;
}
if (onlyNotes) search.action.push({ search: 'NOTE' });
const response = await Rooms.Modlog.search(roomid, search, maxLines, onlyPunishments);
if (!response) return connection.popup(`The moderator log is currently disabled.`);
connection.send(
prettifyResults(
response.results,
roomid,
search,
searchCmd,
addModlogLinks,
hideIps,
maxLines,
onlyPunishments,
onlyNotes,
)
);
if (timed) connection.popup(`The modlog query took ${response.duration} ms to complete.`);
}
const shouldSearchGlobal = ['staff', 'adminlog'];
export const commands: Chat.ChatCommands = {
ml: 'modlog',
punishlog: 'modlog',
pl: 'modlog',
timedmodlog: 'modlog',
mlid: 'modlog',
mlip: 'modlog',
plid: 'modlog',
plip: 'modlog',
modnotes: 'modlog',
modlog(target, room, user, connection, cmd) {
let roomid: ModlogID = (!room || shouldSearchGlobal.includes(room.roomid) ? 'global' : room.roomid);
const onlyPunishments = cmd.startsWith('pl') || cmd.startsWith('punishlog');
let lines;
const possibleParam = cmd.slice(2);
const targets = target.split(',').map(f => f.trim()).filter(Boolean);
const search: ModlogSearch = { note: [], user: [], ip: [], action: [], actionTaker: [] };
switch (possibleParam) {
case 'id':
targets.unshift(`user='${targets.shift()}'`);
break;
case 'ip':
targets.unshift(`ip=${targets.shift()}`);
break;
}
for (const [i, option] of targets.entries()) {
let [param, value] = option.split('=').map(part => part.trim());
if (!value) {
// If no specific parameter is specified, we should search all fields
value = param.trim();
if (i === 0 && value) {
// they might mean a roomid, as per the old format of /modlog
param = 'room';
// if the room exists, they probably mean a roomid. otherwise, assume they're misusing it.
// we except gdrivers+ from this because drivers can access deleted room modlogs
if (!Rooms.search(toID(value)) && !user.can('lock')) {
return this.parse(`/help modlog`);
}
} else {
this.errorReply(`You must specify a search type and search value.`);
return this.parse(`/help modlog`);
}
}
const isExclusion = param.endsWith('!');
param = toID(param);
switch (param) {
case 'note': case 'text':
if (!search.note) search.note = [];
search.note.push({ search: value, isExclusion });
break;
case 'user': case 'name': case 'username': case 'userid':
search.user.push({ search: value });
break;
case 'ip': case 'ipaddress': case 'ipaddr':
search.ip.push({ search: value, isExclusion });
break;
case 'action': case 'punishment':
search.action.push({ search: value.toUpperCase(), isExclusion });
break;
case 'actiontaker': case 'moderator': case 'staff': case 'mod':
search.actionTaker.push({ search: toID(value), isExclusion });
break;
case 'room': case 'roomid':
roomid = value.toLowerCase().replace(/[^a-z0-9-]+/g, '') as ModlogID;
break;
case 'lines': case 'maxlines':
lines = parseInt(value);
if (isNaN(lines) || lines < 1) return this.errorReply(`Invalid linecount: '${value}'.`);
break;
default:
this.errorReply(`Invalid modlog parameter: '${param}'.`);
return this.errorReply(`Please specify 'room', 'note', 'user', 'ip', 'action', 'staff', or 'lines'.`);
}
}
const targetRoom = Rooms.search(roomid);
// if a room alias was used, replace alias with actual id
if (targetRoom) roomid = targetRoom.roomid;
if (roomid.includes('-')) {
if (user.can('modlog')) {
// default to global modlog for staff convenience
roomid = 'global';
} else {
return this.errorReply(`Only global staff may view battle and groupchat modlogs.`);
}
}
if (!target && !lines) {
lines = 20;
}
if (!lines) lines = DEFAULT_RESULTS_LENGTH;
if (lines > MAX_RESULTS_LENGTH) lines = MAX_RESULTS_LENGTH;
void getModlog(
connection,
roomid,
search,
target.replace(/^\s?([^,=]*),\s?/, '').replace(/,?\s*(room|lines)\s*=[^,]*,?/g, ''),
lines,
onlyPunishments,
cmd === 'timedmodlog',
cmd === 'modnotes',
);
},
modloghelp() {
this.sendReplyBox(
`
/modlog [comma-separated list of parameters]
: searches the moderator log, defaulting to the current room unless specified otherwise.
` +
`You can replace the
=
in a parameter with a
!=
to exclude entries that match that parameter.
` +
`
Parameters
` +
`` +
`room=[room]
- searches a room's modlog ` +
`userid=[user]
- searches for a username (or fragment of one) ` +
`note=[text]
- searches the contents of notes/reasons ` +
`ip=[IP address]
- searches for an IP address (or fragment of one) ` +
`staff=[user]
- searches for actions taken by a particular staff member ` +
`action=[type]
- searches for a particular type of action ` +
`lines=[number]
- displays the given number of lines ` +
`
` +
`` +
`
Additional commands
` +
`` +
`/mlid [user]
- searches for actions taken against a specific user ` +
`/mlip [IP address]
- searches for actions taken against a specific IP address ` +
`/punishlog
, /pl
, /plid
, /plip
- like /modlog
, but only displays punishments ` +
`/modnotes
- searches only modnotes ` +
`
` +
``
);
},
mls: 'modlogstats',
modlogstats(target, room, user) {
this.checkCan('lock');
target = toID(target);
if (!target) return this.parse(`/help modlogstats`);
return this.parse(`/join view-modlogstats-${target}`);
},
modlogstatshelp: [`/modlogstats [userid] - Fetch all information on that [userid] from the modlog (IPs, alts, etc). Requires: @ ~`],
};
export const pages: Chat.PageTable = {
async modlogstats(query, user) {
this.checkCan('lock');
const target = toID(query.shift());
if (!target || target.length > 18) {
return this.errorReply(`Invalid userid - must be between 1 and 18 characters long.`);
}
this.title = `[Modlog Stats] ${target}`;
this.setHTML(`
Running modlog search...
`);
const entries = await Rooms.Modlog.search('global', {
user: [{
search: target,
isExact: true,
}], note: [], ip: [], action: [], actionTaker: [],
}, 1000);
if (!entries?.results.length) {
return this.errorReply(`No data found.`);
}
const punishmentTable = new Utils.Multiset
();
const punishmentsByIp = new Map>();
const actionsWithIp = new Set();
const alts = new Set();
const autoconfirmed = new Set();
const ips = new Set();
for (const entry of entries.results) {
if (entry.action !== 'NOTE') {
punishmentTable.add(entry.action);
if (entry.ip) {
let ipTable = punishmentsByIp.get(entry.ip);
if (!ipTable) {
ipTable = new Utils.Multiset();
punishmentsByIp.set(entry.ip, ipTable);
}
ipTable.add(entry.action);
actionsWithIp.add(entry.action);
}
}
if (entry.alts) {
for (const alt of entry.alts) alts.add(alt);
}
if (entry.autoconfirmedID) autoconfirmed.add(entry.autoconfirmedID);
if (entry.ip) ips.add(entry.ip);
}
let buf = `Modlog information for ${target}
`;
if (alts.size) {
buf += `
Listed alts: `;
buf += `
(These are userids sharing the same IP at the time of the punishment, they may not be direct alts)`;
buf += [...alts]
.map(id => `
${toID(id)}`)
.join(', ');
buf += `
`;
}
if (autoconfirmed.size) {
buf += `
Autoconfirmed alts:`;
buf += ` (these are autoconfirmed accounts linked to their name, and are very likely them)
`;
buf += [...autoconfirmed]
.map(id => `
${toID(id)}`)
.join(', ');
buf += `
`;
}
if (ips.size) {
buf += `
Known IPs:`;
const mapped = await Promise.all([...ips].map(async ip => {
const info = await IPTools.lookup(ip);
return `
${ip} [${info.hostType}]`;
}));
buf += mapped.join(', ');
buf += `
`;
}
if (punishmentTable.size) {
buf += `
Punishments:`;
buf += `
`;
buf += `Punishment type | Count |
`;
for (const [punishment, number] of punishmentTable) {
buf += `${punishment} | ${number} |
`;
}
buf += `
`;
}
if (punishmentsByIp.size) {
buf += `
Punishments by IP:`;
const keys = [...actionsWithIp];
buf += `
`;
buf += ` | ${keys.map(k => `${k} | `).join("")}
`;
for (const [ip, table] of punishmentsByIp) {
buf += `${ip} | `;
for (const key of keys) {
buf += `${table.get(key)} | `;
}
buf += `
`;
}
buf += `
`;
}
buf += `
`;
return buf;
},
};