`;
}
buf += ``;
return this.linkify(buf);
}
async battle(tier: string, number: number, context: PageContext) {
if (number > Rooms.global.lastBattle) {
throw new Chat.ErrorMessage(`That battle cannot exist, as the number has not been used.`);
}
const roomid = `battle-${tier}-${number}` as RoomID;
context.send(`
Locating battle logs for the battle ${tier}-${number}...
`);
const log = await PM.query({
queryType: 'battlesearch', roomid: toID(tier), search: number,
});
if (!log) return context.send(this.error("Logs not found."));
const {connection} = context;
context.close();
connection.sendTo(
roomid, `|init|battle\n|title|[Battle Log] ${tier}-${number}\n${log.join('\n')}`
);
connection.sendTo(roomid, `|expire|This is a battle log.`);
}
renderLine(fullLine: string, opts?: string) {
if (!fullLine) return ``;
if (opts === 'txt') return Utils.html`
${fullLine}
`;
let timestamp = fullLine.slice(0, opts ? 8 : 5);
let line;
if (/^[0-9:]+$/.test(timestamp)) {
line = fullLine.charAt(9) === '|' ? fullLine.slice(10) : '|' + fullLine.slice(9);
} else {
timestamp = '';
line = '!NT|';
}
if (opts !== 'all' && (
line.startsWith(`userstats|`) ||
line.startsWith('J|') || line.startsWith('L|') || line.startsWith('N|')
)) return ``;
const cmd = line.slice(0, line.indexOf('|'));
if (opts?.includes('onlychat')) {
if (cmd !== 'c') return '';
if (opts.includes('txt')) return `
`)}`;
buf += ``;
}
return buf;
}
async fsSearchMonth(opts: ChatlogSearch) {
let {limit, room: roomid, date: month, search} = opts;
if (!limit || limit > MAX_RESULTS) limit = MAX_RESULTS;
const log = await LogReader.get(roomid);
if (!log) return {results: {}, total: 0};
const days = await log.listDays(month);
const results: {[k: string]: SearchMatch[]} = {};
let total = 0;
for (const day of days) {
const dayResults = await this.fsSearchDay(roomid, day, search, limit ? limit - total : null);
if (!dayResults.length) continue;
total += dayResults.length;
results[day] = dayResults;
if (total > limit) break;
}
return {results, total};
}
/** pass a null `year` to search all-time */
async fsSearchYear(roomid: RoomID, year: string | null, search: string, limit?: number | null) {
if (!limit || limit > MAX_RESULTS) limit = MAX_RESULTS;
const log = await LogReader.get(roomid);
if (!log) return {results: {}, total: 0};
let months = await log.listMonths();
months = months.reverse();
const results: {[k: string]: SearchMatch[]} = {};
let total = 0;
for (const month of months) {
if (year && !month.includes(year)) continue;
const monthSearch = await this.fsSearchMonth({room: roomid, date: month, search, limit});
const {results: monthResults, total: monthTotal} = monthSearch;
if (!monthTotal) continue;
total += monthTotal;
Object.assign(results, monthResults);
if (total > limit) break;
}
return {results, total};
}
async runYearSearch(roomid: RoomID, year: string | null, search: string, limit: number) {
const {results, total} = await this.fsSearchYear(roomid, year, search, limit);
if (!total) {
return LogViewer.error(`No matches found for ${search} on ${roomid}.`);
}
let buf = '';
if (year) {
buf += `
Searching year: ${year}: `;
} else {
buf += `
Searching all logs: `;
}
buf += this.renderDayResults(results, roomid);
if (total > limit) {
// cap is met
buf += ` Max results reached, capped at ${total > limit ? limit : MAX_RESULTS}`;
buf += `
`;
if (total < MAX_RESULTS) {
buf += ``;
buf += `
`;
}
}
this.results = 0;
return buf;
}
async runMonthSearch(roomid: RoomID, month: string, search: string, limit: number, year = false) {
const {results, total} = await this.fsSearchMonth({room: roomid, date: month, search, limit});
if (!total) {
return LogViewer.error(`No matches found for ${search} on ${roomid}.`);
}
let buf = (
`
Searching for "${search}" in ${roomid} (${month}):`
);
buf += this.renderDayResults(results, roomid);
if (total > limit) {
// cap is met & is not being used in a year read
buf += ` Max results reached, capped at ${limit}`;
buf += `
`;
if (total < MAX_RESULTS) {
buf += ``;
buf += `
`;
}
}
buf += `
`;
this.results = 0;
return buf;
}
async getSharedBattles(userids: string[]) {
const months = FS("logs/").readdirSync().filter(f => !isNaN(new Date(f).getTime()));
const results: string[] = [];
for (const month of months) {
const tiers = await FS(`logs/${month}`).readdir();
for (const tier of tiers) {
const days = await FS(`logs/${month}/${tier}/`).readdir();
for (const day of days) {
const battles = await FS(`logs/${month}/${tier}/${day}`).readdir();
for (const battle of battles) {
const content = JSON.parse(FS(`logs/${month}/${tier}/${day}/${battle}`).readSync());
const players = [content.p1, content.p2].map(toID);
if (players.every(p => userids.includes(p))) {
const battleName = battle.slice(0, -9);
results.push(battleName);
}
}
}
}
}
return results;
}
}
export class RipgrepLogSearcher extends Searcher {
async ripgrepSearchMonth(opts: ChatlogSearch) {
let {raw, search, room: roomid, date: month, args} = opts;
let results: string[];
let count = 0;
if (!raw) {
search = this.constructSearchRegex(search);
}
const resultSep = args?.includes('-m') ? '--' : '\n';
try {
const options = [
'-e', search,
`logs/chat/${roomid}/${month}`,
'-i',
];
if (args) {
options.push(...args);
}
const {stdout} = await exec(['rg', ...options], {
maxBuffer: MAX_MEMORY,
cwd: `${__dirname}/../../`,
});
results = stdout.split(resultSep);
} catch (e) {
if (e.code !== 1 && !e.message.includes('stdout maxBuffer') && !e.message.includes('No such file or directory')) {
throw e; // 2 means an error in ripgrep
}
if (e.stdout) {
results = e.stdout.split(resultSep);
} else {
results = [];
}
}
count += results.length;
return {results, count};
}
async searchLogs(
roomid: RoomID,
search: string,
limit?: number | null,
date?: string | null
) {
if (date) {
// if it's more than 7 chars, assume it's a month
if (date.length > 7) date = date.substr(0, 7);
// if it's less, assume they were trying a year
else if (date.length < 7) date = date.substr(0, 4);
}
const months = (date && toID(date) !== 'all' ? [date] : await new LogReaderRoom(roomid).listMonths()).reverse();
let count = 0;
let results: string[] = [];
if (!limit || limit > MAX_RESULTS) limit = MAX_RESULTS;
if (!date) date = 'all';
const originalSearch = search;
const userRegex = /user-(.[a-zA-Z0-9]*)/gi;
const user = userRegex.exec(search)?.[0]?.slice(5);
const userSearch = user ? `the user '${user}'` : null;
if (userSearch) {
const id = toID(user);
const rest = search.replace(userRegex, '')
.split('-')
.filter(Boolean)
.map(str => `.*${Utils.escapeRegex(str)}`)
.join('');
search = `\\|c\\|${this.constructUserRegex(id)}\\|${rest}`;
}
while (count < MAX_RESULTS) {
const month = months.shift();
if (!month) break;
const output = await this.ripgrepSearchMonth({
room: roomid, search, date: month,
limit, args: [`-m`, `${limit}`, '-C', '3', '--engine=auto'], raw: !!userSearch,
});
results = results.concat(output.results);
count += output.count;
}
if (count > MAX_RESULTS) {
const diff = count - MAX_RESULTS;
results = results.slice(0, -diff);
}
return this.renderSearchResults(results, roomid, search, limit, date, originalSearch);
}
renderSearchResults(
results: string[], roomid: RoomID, search: string, limit: number,
month?: string | null, originalSearch?: string | null
) {
results = results.filter(Boolean);
if (results.length < 1) return LogViewer.error('No results found.');
let exactMatches = 0;
let curDate = '';
if (limit > MAX_RESULTS) limit = MAX_RESULTS;
const useOriginal = originalSearch && originalSearch !== search;
const searchRegex = new RegExp(useOriginal ? search : this.constructSearchRegex(search), "i");
const sorted = results.sort((aLine, bLine) => {
const [aName] = aLine.split('.txt');
const [bName] = bLine.split('.txt');
const aDate = new Date(aName.split('/').pop()!);
const bDate = new Date(bName.split('/').pop()!);
return bDate.getTime() - aDate.getTime();
}).map(chunk => chunk.split('\n').map(rawLine => {
if (exactMatches > limit || !toID(rawLine)) return null; // return early so we don't keep sorting
const sep = rawLine.includes('.txt-') ? '.txt-' : '.txt:';
const [name, text] = rawLine.split(sep);
let line = LogViewer.renderLine(text, 'all');
if (!line || name.includes('today')) return null;
// gets rid of some edge cases / duplicates
let date = name.replace(`logs/chat/${roomid}${toID(month) === 'all' ? '' : `/${month}`}`, '').slice(9);
if (searchRegex.test(rawLine)) {
if (++exactMatches > limit) return null;
line = `
${line}
`;
}
if (curDate !== date) {
curDate = date;
date = `
[${date}]`;
} else {
date = '';
}
return `${date} ${line}`;
}).filter(Boolean).join(' ')).filter(Boolean);
let buf = `
Results on ${roomid} for ${originalSearch ? originalSearch : search}:`;
buf += limit ? ` ${exactMatches} (capped at ${limit})` : '';
buf += `
`;
buf += sorted.join('');
if (limit) {
buf += `
Capped at ${limit}. `;
buf += ``;
buf += `
`;
}
return buf;
}
async searchLinecounts(room: RoomID, month: string, user?: ID) {
// don't need to check if logs exist since ripgrepSearchMonth does that
// eslint-disable-next-line no-useless-escape
const regexString = user ? `\\|c\\|${this.constructUserRegex(user)}\\|` : `\\|c\\|`;
const args: string[] = user ? ['--count'] : [];
const {results: rawResults} = await this.ripgrepSearchMonth({
search: regexString, raw: true, date: month, room, args,
});
if (!rawResults.length) return LogViewer.error(`No results found.`);
const results: {[k: string]: {[userid: string]: number}} = {};
for (const fullLine of rawResults) {
const [data, line] = fullLine.split('.txt:');
const date = data.split('/').pop()!;
if (!results[date]) results[date] = {};
if (!toID(date)) continue;
if (user) {
if (!results[date][user]) results[date][user] = 0;
const parsed = parseInt(line);
results[date][user] += isNaN(parsed) ? 0 : parsed;
} else {
const parts = line?.split('|').map(toID);
if (!parts || parts[1] !== 'c') continue;
const id = parts[2];
if (!id) continue;
if (!results[date][id]) results[date][id] = 0;
results[date][id]++;
}
}
return this.renderLinecountResults(results, room, month, user);
}
async getSharedBattles(userids: string[]) {
const regexString = userids.map(id => `(?=.*?("p(1|2)":"${[...id].join('[^a-zA-Z0-9]*')}[^a-zA-Z0-9]*"))`).join('');
const results: string[] = [];
try {
const {stdout} = await exec(['rg', '-e', regexString, '-i', '-tjson', 'logs/', '-P']);
for (const line of stdout.split('\n')) {
const [name] = line.split(':');
const battleName = name.split('/').pop()!;
results.push(battleName.slice(0, -9));
}
} catch (e) {
if (e.code !== 1) throw e;
}
return results.filter(Boolean);
}
}
export const LogSearcher: Searcher = new (Config.chatlogreader === 'ripgrep' ? RipgrepLogSearcher : FSLogSearcher)();
export const PM = new QueryProcessManager(module, async data => {
try {
const {date, search, roomid, limit, queryType} = data;
switch (queryType) {
case 'linecount':
return LogSearcher.searchLinecounts(roomid, date, search);
case 'search':
return LogSearcher.searchLogs(roomid, search, limit, date);
case 'sharedsearch':
return LogSearcher.getSharedBattles(search);
case 'battlesearch':
return LogReader.findBattleLog(roomid, search);
default:
return LogViewer.error(`Config.chatlogreader is not configured.`);
}
} catch (e) {
if (e.name?.endsWith('ErrorMessage')) {
return LogViewer.error(e.message);
}
Monitor.crashlog(e, 'A chatlog search query', data);
return LogViewer.error(`Sorry! Your chatlog search crashed. We've been notified and will fix this.`);
}
}, CHATLOG_PM_TIMEOUT);
if (!PM.isParentProcess) {
// This is a child process!
global.Config = Config;
global.Monitor = {
crashlog(error: Error, source = 'A chatlog search process', details: AnyObject | null = null) {
const repr = JSON.stringify([error.name, error.message, source, details]);
process.send!(`THROW\n@!!@${repr}\n${error.stack}`);
},
};
global.Dex = Dex;
global.toID = Dex.toID;
global.Chat = Chat;
process.on('uncaughtException', err => {
if (Config.crashguard) {
Monitor.crashlog(err, 'A chatlog search child process');
}
});
// eslint-disable-next-line no-eval
Repl.start('chatlog', cmd => eval(cmd));
} else {
PM.spawn(MAX_PROCESSES);
}
const accessLog = FS(`logs/chatlog-access.txt`).createAppendStream();
export const pages: PageTable = {
async chatlog(args, user, connection) {
if (!user.named) return Rooms.RETRY_AFTER_LOGIN;
let [roomid, date, opts] = Utils.splitFirst(args.join('-'), '--', 2) as
[RoomID, string | undefined, string | undefined];
if (date) date = date.trim();
if (!roomid || roomid.startsWith('-')) {
this.title = '[Logs]';
return LogViewer.list(user, roomid?.slice(1));
}
// permission check
const room = Rooms.get(roomid);
if (!user.trusted) {
if (room) {
this.checkCan('declare', null, room);
} else {
return this.errorReply(`Access denied.`);
}
}
if (!user.can('rangeban')) {
// Some chatlogs can only be viewed by upper staff
if (roomid.startsWith('spl') && roomid !== 'splatoon') {
return this.errorReply("SPL team discussions are super secret.");
}
if (roomid.startsWith('wcop')) {
return this.errorReply("WCOP team discussions are super secret.");
}
if (UPPER_STAFF_ROOMS.includes(roomid)) {
return this.errorReply("Upper staff rooms are super secret.");
}
}
if (room) {
if (!user.can('lock') || room.settings.isPrivate === 'hidden' && !room.checkModjoin(user)) {
if (!room.persist) return this.errorReply(`Access denied.`);
this.checkCan('mute', null, room);
}
} else {
this.checkCan('lock');
}
void accessLog.writeLine(`${user.id}: <${roomid}> ${date}`);
this.title = '[Logs] ' + roomid;
/** null = no limit */
let limit: number | null = null;
let search;
if (opts?.startsWith('search-')) {
let [input, limitString] = opts.split('--limit-');
input = input.slice(7);
search = Dashycode.decode(input);
if (search.length < 3) return this.errorReply(`That's too short of a search query.`);
if (limitString) {
limit = parseInt(limitString) || null;
} else {
limit = 500;
}
opts = '';
}
const isAll = (toID(date) === 'all' || toID(date) === 'alltime');
const parsedDate = new Date(date as string);
const validDateStrings = ['all', 'alltime', 'today'];
// this is apparently the best way to tell if a date is invalid
if (date && isNaN(parsedDate.getTime()) && !validDateStrings.includes(toID(date))) {
return this.errorReply(`Invalid date.`);
}
if (date && search) {
return LogSearcher.runSearch(this, search, roomid, isAll ? null : date, limit);
} else if (date) {
if (date === 'today') {
return LogViewer.day(roomid, LogReader.today(), opts);
} else if (date.split('-').length === 3) {
return LogViewer.day(roomid, parsedDate.toISOString().slice(0, 10), opts);
} else {
return LogViewer.month(roomid, parsedDate.toISOString().slice(0, 7));
}
} else {
return LogViewer.room(roomid);
}
},
roomstats(args, user) {
const room = this.extractRoom();
if (room) {
this.checkCan('mute', null, room);
} else {
if (!user.can('bypassall')) {
return this.errorReply(`You cannot view logs for rooms that no longer exist.`);
}
}
const [, date, target] = Utils.splitFirst(args.join('-'), '--', 3).map(item => item.trim());
if (isNaN(new Date(date).getTime())) {
return this.errorReply(`Invalid date.`);
}
this.title = `[Log Stats] ${date}`;
return LogSearcher.runLinecountSearch(this, room ? room.roomid : args[2] as RoomID, date, toID(target));
},
battlelog(args, user) {
const [tierName, battleNum] = args;
const tier = toID(tierName);
const num = parseInt(battleNum);
if (isNaN(num)) return this.errorReply(`Invalid battle number.`);
void accessLog.writeLine(`${user.id}: battle-${tier}-${num}`);
return LogViewer.battle(tier, num, this);
},
async logsaccess(query) {
this.checkCan('rangeban');
const type = toID(query.shift());
if (type && !['chat', 'battle', 'all', 'battles'].includes(type)) {
return this.errorReply(`Invalid log type.`);
}
let title = '';
switch (type) {
case 'battle': case 'battles':
title = 'Battlelog access log';
break;
case 'chat':
title = 'Chatlog access log';
break;
default:
title = 'Logs access log';
break;
}
const userid = toID(query.shift());
let buf = `
${title}`;
if (userid) buf += ` for ${userid}`;
buf += `
`;
const accessStream = FS(`logs/chatlog-access.txt`).createReadStream();
for await (const line of accessStream.byLine()) {
const [id, rest] = Utils.splitFirst(line, ': ');
if (userid && id !== userid) continue;
if (type === 'battle' && !line.includes('battle-')) continue;
if (userid) {
buf += `
${rest}
`;
} else {
buf += `
${id}: ${rest}
`;
}
}
buf += ``;
return buf;
},
};
export const commands: ChatCommands = {
chatlog(target, room, user) {
const [tarRoom, ...opts] = target.split(',');
const targetRoom = tarRoom ? Rooms.search(tarRoom) : room;
const roomid = targetRoom ? targetRoom.roomid : target;
return this.parse(`/join view-chatlog-${roomid}--today${opts ? `--${opts.join('--')}` : ''}`);
},
chatloghelp() {
const strings = [
`/chatlog [optional room], [opts] - View chatlogs from the given room. `,
`If none is specified, shows logs from the room you're in. Requires: % @ * # &`,
`Supported options:`,
`txt - Do not render logs.`,
`txt-onlychat - Show only chat lines, untransformed.`,
`onlychat - Show only chat lines.`,
`all - Show all lines, including userstats and join/leave messages.`,
];
this.runBroadcast();
return this.sendReplyBox(strings.join(' '));
},
sl: 'searchlogs',
logsearch: 'searchlogs',
searchlog: 'searchlogs',
searchlogs(target, room) {
target = target.trim();
const args = target.split(',').map(item => item.trim());
if (!target) return this.parse('/help searchlogs');
let date = 'all';
const searches: string[] = [];
let limit = '500';
for (const arg of args) {
if (arg.startsWith('room:')) {
const id = arg.slice(5);
room = Rooms.search(id as RoomID) as Room | null;
if (!room) {
return this.errorReply(`Room "${id}" not found.`);
}
} else if (arg.startsWith('limit:')) {
limit = arg.slice(6);
} else if (arg.startsWith('date:')) {
date = arg.slice(5);
} else if (arg.startsWith('user:')) {
args.push(`user-${toID(arg.slice(5))}`);
} else {
searches.push(arg);
}
}
if (!room) {
return this.parse(`/help searchlogs`);
}
return this.parse(
`/join view-chatlog-${room.roomid}--${date}--search-` +
`${Dashycode.encode(searches.join('+'))}--limit-${limit}`
);
},
searchlogshelp() {
const buffer = `/searchlogs [arguments]: ` +
`searches logs in the current room using the [arguments].` +
`A room can be specified using the argument room: [roomid]. Defaults to the room it is used in. ` +
`A limit can be specified using the argument limit: [number less than or equal to 3000]. Defaults to 500. ` +
`A date can be specified in ISO (YYYY-MM-DD) format using the argument date: [month] (for example, date: 2020-05). Defaults to searching all logs. ` +
`If you provide a user argument in the form user:username, it will search for messages (that match the other arguments) only from that user` +
`All other arguments will be considered part of the search ` +
`(if more than one argument is specified, it searches for lines containing all terms). ` +
"Requires: % @ # &
";
return this.sendReplyBox(buffer);
},
topusers: 'linecount',
roomstats: 'linecount',
linecount(target, room, user) {
let [roomid, month, userid] = target.split(',').map(item => item.trim());
const tarRoom = roomid ? Rooms.search(roomid) : room;
if (!tarRoom) return this.errorReply(`You must specify a valid room.`);
if (!month) month = LogReader.getMonth();
return this.parse(`/join view-roomstats-${tarRoom.roomid}--${month}--${toID(userid)}`);
},
linecounthelp: [
`/topusers OR /linecount [room], [month], [userid] - View room stats in the given [room].`,
`If a user is provided, searches only for that user, else the top 100 users are shown.`,
`Requires: % @ # &`,
],
slb: 'sharedloggedbattles',
async sharedloggedbattles(target, room, user) {
this.checkCan('lock');
const targets = target.split(',').map(toID).filter(Boolean);
if (targets.length < 2 || targets.length > 2) {
return this.errorReply(`Specify two users.`);
}
const results = await LogSearcher.sharedBattles(targets);
if (room?.settings.staffRoom || this.pmTarget?.isStaff) {
this.runBroadcast();
}
return this.sendReplyBox(results);
},
sharedloggedbattleshelp: [
`/sharedloggedbattles OR /slb [user1, user2] - View shared battle logs between user1 and user2`,
],
battlelog(target, room, user) {
this.checkCan('lock');
target = target.trim();
if (!target) return this.errorReply(`Specify a battle.`);
if (target.startsWith('http://')) target = target.slice(7);
if (target.startsWith('https://')) target = target.slice(8);
if (target.startsWith(`${Config.routes.client}/`)) target = target.slice(Config.routes.client.length + 1);
if (target.startsWith(`${Config.routes.replays}/`)) target = `battle-${target.slice(Config.routes.replays.length + 1)}`;
if (target.startsWith('psim.us/')) target = target.slice(8);
return this.parse(`/join view-battlelog-${target}`);
},
logsaccess(target, room, user) {
this.checkCan('rangeban');
const [type, userid] = target.split(',').map(toID);
return this.parse(`/j view-logsaccess-${type || 'all'}${userid ? `-${userid}` : ''}`);
},
};