/** * Modlog viewer * Pokemon Showdown - http://pokemonshowdown.com/ * * Actually reading, writing, and searching modlog is handled in modlog.ts. * * @license MIT */ import {Dashycode, Utils} from '../../lib'; import {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 ) { 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 { return Utils.html`
`; } } function getRoomID(id: string) { if (id in ALIASES) return ALIASES[id] as ModlogID; return id as ModlogID; } function prettifyResults( resultArray: ModlogEntry[], roomid: ModlogID, search: ModlogSearch, searchCmd: string, addModlogLinks: boolean, hideIps: boolean, maxLines: number, onlyPunishments: boolean ) { if (resultArray === null) { return "|popup|The modlog query crashed."; } let roomName; switch (roomid) { case 'all': roomName = "all rooms"; break; case 'public': roomName = "all public rooms"; break; default: roomName = `room ${roomid}`; } const scope = onlyPunishments ? 'punishment-related ' : ''; let searchString = ``; if (search.anyField) searchString += `containing ${search.anyField} `; if (search.note) searchString += `with a note including any of: ${search.note.searches.join(', ')} `; if (search.user) searchString += `taken against ${search.user.search} `; if (search.ip) searchString += `taken against a user on the IP ${search.ip} `; if (search.action) searchString += `of the type ${search.action} `; if (search.actionTaker) searchString += `taken by ${search.actionTaker} `; if (!resultArray.length) { return `|popup|No ${scope}moderator actions ${searchString}found on ${roomName}.`; } const title = `[${roomid}] ${searchCmd}`; const lines = resultArray.length; let curDate = ''; const resultString = resultArray.map(result => { const date = new Date(result.time || Date.now()); const entryRoom = result.visualRoomID || result.roomID || 'global'; let [dateString, timestamp] = Chat.toTimestamp(date, {human: true}).split(' '); let line = `[${timestamp}] (${entryRoom}) ${result.action}`; if (result.userid) { line += `: [${result.userid}]`; if (result.autoconfirmedID) line += ` ac: [${result.autoconfirmedID}]`; if (result.alts.length) line += ` alts: [${result.alts.join('], [')}]`; if (!hideIps && result.ip) line += ` [${result.ip}]`; } if (result.loggedBy) line += `: by ${result.loggedBy}`; if (result.note) line += `: ${result.note}`; if (dateString !== curDate) { curDate = dateString; dateString = `

[${dateString}]
`; } else { dateString = ``; } const thisRoomID = entryRoom?.split(' ')[0]; if (addModlogLinks) { const url = Config.modloglink(date, thisRoomID); if (url) timestamp = `${timestamp}`; } line = Utils.escapeHTML(line.slice(line.indexOf(')') + ` `.length)); line = line.replace( IPS_REGEX, hideIps ? '' : `[$1]` ); return `${dateString}[${timestamp}] (${thisRoomID})${line}`; }).join(`
`); const [dateString, timestamp] = Chat.toTimestamp(new Date(), {human: true}).split(' '); let preamble; const modlogid = roomid + (searchString ? '-' + Dashycode.encode(searchString) : ''); if (searchString) { preamble = `>view-modlog-${modlogid}\n|init|html\n|title|[Modlog]${title}\n` + `|pagehtml|

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); return `${preamble}${resultString}${moreButton}

`; } async function getModlog( connection: Connection, roomid: ModlogID = 'global', search: ModlogSearch = {}, searchCmd: string, maxLines = 20, onlyPunishments = false, timed = 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 = !!( Config.modloglink && (user.tempGroup !== ' ' || (targetRoom && targetRoom.settings.isPrivate !== true)) ); if (hideIps && search.ip) { 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?.searches) { for (const [i, noteSearch] of search.note.searches.entries()) { if (/^["'].+["']$/.test(noteSearch)) { search.note.searches[i] = noteSearch.substring(1, noteSearch.length - 1); search.note.isExact = true; } } } if (search.user) { if (/^["'].+["']$/.test(search.user.search)) { search.user.search = search.user.search.substring(1, search.user.search.length - 1); search.user.isExact = true; } search.user.search = toID(search.user.search); } const response = await Rooms.Modlog.search(roomid, search, maxLines, onlyPunishments); connection.send( prettifyResults( response.results, roomid, search, searchCmd, addModlogLinks, hideIps, maxLines, onlyPunishments ) ); if (timed) connection.popup(`The modlog query took ${response.duration} ms to complete.`); } const shouldSearchGlobal = ['staff', 'adminlog']; export const commands: ChatCommands = { ml: 'modlog', punishlog: 'modlog', pl: 'modlog', timedmodlog: 'modlog', mlid: 'modlog', mlip: 'modlog', plid: 'modlog', plip: '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(','); const search: ModlogSearch = {}; 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 && targets.length > 1) { // they might mean a roomid, as per the old format of /modlog param = 'room'; } else { param = 'any'; } } param = toID(param); switch (param) { case 'any': search.anyField = value; break; case 'note': case 'text': if (!search.note?.searches) search.note = {searches: []}; search.note.searches.push(value); break; case 'user': case 'name': case 'username': case 'userid': search.user = {search: value}; break; case 'ip': case 'ipaddress': case 'ipaddr': search.ip = value; break; case 'action': case 'punishment': search.action = value.toUpperCase(); break; case 'actiontaker': case 'moderator': case 'staff': case 'mod': search.actionTaker = toID(value); 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', 'any', 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' ); }, modloghelp() { this.sendReplyBox( `/modlog [comma-separated list of parameters]: searches the moderator log, defaulting to the current room unless specified otherwise.
` + `If an unnamed parameter is specified, /modlog will search all fields at once.
` + `
Parameters:` + `` + `
` ); }, };