mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-04-24 23:09:10 -05:00
4b8c6a4d6d
Some checks failed
Node.js CI / build (18.x) (push) Has been cancelled
This minimizes side effects of import/require across the codebase, and lets the caller be responsible of initializing child processeses, as well as other async logic, such as restoring saved battles.
342 lines
14 KiB
TypeScript
342 lines
14 KiB
TypeScript
import { FS, Utils } from '../../lib';
|
|
|
|
const DAY = 24 * 60 * 60 * 1000;
|
|
const SPOTLIGHT_FILE = 'config/chat-plugins/spotlights.json';
|
|
const NUMBER_REGEX = /^\s*[0-9]+\s*$/;
|
|
|
|
type StoredImage = [string, number, number];
|
|
|
|
interface Spotlight {
|
|
/** legacy - string = just url, arr is [url, width, height] */
|
|
image?: StoredImage | string;
|
|
description: string;
|
|
time: number;
|
|
}
|
|
|
|
export let spotlights: {
|
|
[roomid: string]: { [k: string]: Spotlight[] },
|
|
} = {};
|
|
|
|
try {
|
|
spotlights = JSON.parse(FS(SPOTLIGHT_FILE).readIfExistsSync() || "{}");
|
|
for (const roomid in spotlights) {
|
|
for (const k in spotlights[roomid]) {
|
|
for (const spotlight of spotlights[roomid][k]) {
|
|
if (!spotlight.time) {
|
|
spotlight.time = Date.now();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} catch (e: any) {
|
|
if (e.code !== 'MODULE_NOT_FOUND' && e.code !== 'ENOENT') throw e;
|
|
}
|
|
if (!spotlights || typeof spotlights !== 'object') spotlights = {};
|
|
|
|
function saveSpotlights() {
|
|
FS(SPOTLIGHT_FILE).writeUpdate(() => JSON.stringify(spotlights));
|
|
}
|
|
|
|
function nextDaily() {
|
|
for (const roomid in spotlights) {
|
|
for (const key in spotlights[roomid]) {
|
|
if (spotlights[roomid][key].length > 1) {
|
|
spotlights[roomid][key].shift();
|
|
}
|
|
}
|
|
}
|
|
|
|
saveSpotlights();
|
|
timeout = setTimeout(nextDaily, DAY);
|
|
}
|
|
|
|
const midnight = new Date();
|
|
midnight.setHours(24, 0, 0, 0);
|
|
let timeout = setTimeout(nextDaily, midnight.getTime() - Date.now());
|
|
|
|
export function renderSpotlight(roomid: RoomID, key: string, index = 0) {
|
|
let imgHTML = '', descHTML = '';
|
|
const { image, description } = spotlights[roomid][key][index];
|
|
|
|
if (image) {
|
|
if (Array.isArray(image)) {
|
|
imgHTML = `<td><img src="${image[0]}" width="${image[1]}" height="${image[2]}" style="vertical-align:middle;"></td>`;
|
|
} else {
|
|
// legacy
|
|
imgHTML = Chat.html`<td>Legacy image ${image}</td>`;
|
|
}
|
|
}
|
|
|
|
if (description) {
|
|
descHTML = `<td style="padding-right:10px;">${Chat.formatText(description, true)}</td>`;
|
|
}
|
|
|
|
return `<table style="text-align:center;margin:auto"><tr>${descHTML}${imgHTML}</tr></table>`;
|
|
}
|
|
|
|
export const destroy = () => clearTimeout(timeout);
|
|
|
|
export const pages: Chat.PageTable = {
|
|
spotlights(query, user, connection) {
|
|
this.title = 'Daily Spotlights';
|
|
const room = this.requireRoom();
|
|
query.shift(); // roomid
|
|
const sortType = toID(query.shift());
|
|
if (sortType && !['time', 'alphabet'].includes(sortType)) {
|
|
throw new Chat.ErrorMessage(`Invalid sorting type '${sortType}' - must be either 'time', 'alphabet', or not provided.`);
|
|
}
|
|
|
|
let buf = `<div class="pad ladder">`;
|
|
buf += `<div class="pad">`;
|
|
buf += `<button style="float:right;" class="button" name="send" value="/join view-spotlights-${room.roomid}${sortType ? '-' + sortType : ''}">`;
|
|
buf += `<i class="fa fa-refresh"></i> Refresh</button>`;
|
|
buf += `<h2>Daily Spotlights</h2>`;
|
|
// for posterity, all these switches are futureproofing for more sort types
|
|
if (sortType) {
|
|
let title = '';
|
|
switch (sortType) {
|
|
case 'time':
|
|
title = 'latest time updated';
|
|
break;
|
|
default:
|
|
title = 'alphabetical';
|
|
break;
|
|
}
|
|
buf += `(sorted by ${title})<br />`;
|
|
}
|
|
if (!spotlights[room.roomid]) {
|
|
buf += `<p>This room has no daily spotlights.</p></div>`;
|
|
return buf;
|
|
}
|
|
|
|
const sortedEntries = Utils.sortBy(Object.entries(spotlights[room.roomid]), ([key]) => {
|
|
switch (sortType) {
|
|
case 'time': {
|
|
// find most recently added/updated spotlight in that name, sort all by that
|
|
const sortedSpotlights = Utils.sortBy(spotlights[room.roomid][key].slice(), k => -k.time);
|
|
return -sortedSpotlights[0].time;
|
|
}
|
|
// sort alphabetically by name otherwise
|
|
default:
|
|
return key;
|
|
}
|
|
});
|
|
const canManage = user.can('announce', null, room);
|
|
for (const [key, queue] of sortedEntries) {
|
|
buf += `<table style="margin-bottom:30px;"><th colspan="2"><h3>${key}:</h3></th>`;
|
|
for (const i of queue.keys()) {
|
|
const html = renderSpotlight(room.roomid, key, i);
|
|
buf += `<tr><td>${i || 'Current'}</td><td>${html}</td>`;
|
|
if (canManage) {
|
|
const deleteCommand = `/msgroom ${room.roomid},/removedaily ${key}, ${i}`;
|
|
buf += `<td><button class="button" name="send" value="${deleteCommand}">Delete</button></td>`;
|
|
}
|
|
buf += `</tr>`;
|
|
if (!canManage) break;
|
|
}
|
|
buf += '</table>';
|
|
}
|
|
return buf;
|
|
},
|
|
};
|
|
|
|
export const commands: Chat.ChatCommands = {
|
|
removedaily(target, room, user) {
|
|
room = this.requireRoom();
|
|
if (!room.persist) throw new Chat.ErrorMessage("This command is unavailable in temporary rooms.");
|
|
let [key, rest] = target.split(',');
|
|
key = toID(key);
|
|
rest = toID(rest);
|
|
if (!key) return this.parse('/help daily');
|
|
if (!spotlights[room.roomid][key]) throw new Chat.ErrorMessage(`Cannot find a daily spotlight with name '${key}'`);
|
|
|
|
this.checkCan('announce', null, room);
|
|
if (!rest || rest === 'current' || rest === '0' || rest === 'all') {
|
|
spotlights[room.roomid][key].shift();
|
|
if (!spotlights[room.roomid][key].length || rest === 'all') {
|
|
delete spotlights[room.roomid][key];
|
|
this.modlog(`DAILY REMOVE`, key);
|
|
this.privateModAction(`${user.name} removed the daily spotlight named '${key}'.`);
|
|
} else {
|
|
this.modlog(`DAILY REMOVE`, `${key}[0]`);
|
|
this.privateModAction(`${user.name} removed the current entry from the queue of the daily spotlight named '${key}'.`);
|
|
}
|
|
saveSpotlights();
|
|
} else {
|
|
const queueNumber = parseInt(rest);
|
|
if (isNaN(queueNumber) || queueNumber < 1) throw new Chat.ErrorMessage("Invalid queue number");
|
|
if (queueNumber >= spotlights[room.roomid][key].length) {
|
|
throw new Chat.ErrorMessage(`Queue number must be between 1 and ${spotlights[room.roomid][key].length - 1}`);
|
|
}
|
|
spotlights[room.roomid][key].splice(queueNumber, 1);
|
|
saveSpotlights();
|
|
|
|
this.modlog(`DAILY REMOVE`, `${key}[${queueNumber}]`);
|
|
this.privateModAction(
|
|
`${user.name} removed the ${queueNumber}th entry from the queue of the daily spotlight named '${key}'.`
|
|
);
|
|
}
|
|
Chat.refreshPageFor(`spotlights-${room.roomid}`, room);
|
|
},
|
|
swapdailies: 'swapdaily',
|
|
swapdaily(target, room, user) {
|
|
room = this.requireRoom();
|
|
if (!room.persist) throw new Chat.ErrorMessage("This command is unavailable in temporary rooms.");
|
|
if (!spotlights[room.roomid]) throw new Chat.ErrorMessage("There are no dailies for this room.");
|
|
this.checkCan('announce', null, room);
|
|
|
|
const [key, indexStringA, indexStringB] = target.split(',').map(index => toID(index));
|
|
if (!indexStringB) return this.parse('/help daily');
|
|
if (!spotlights[room.roomid][key]) throw new Chat.ErrorMessage(`Cannot find a daily spotlight with name '${key}'`);
|
|
if (!(NUMBER_REGEX.test(indexStringA) && NUMBER_REGEX.test(indexStringB))) {
|
|
throw new Chat.ErrorMessage("Queue numbers must be numbers.");
|
|
}
|
|
const indexA = parseInt(indexStringA);
|
|
const indexB = parseInt(indexStringB);
|
|
const queueLength = spotlights[room.roomid][key].length;
|
|
if (indexA < 1 || indexB < 1 || indexA >= queueLength || indexB >= queueLength) {
|
|
throw new Chat.ErrorMessage(`Queue numbers must between 1 and the length of the queue (${queueLength}).`);
|
|
}
|
|
|
|
const dailyA = spotlights[room.roomid][key][indexA];
|
|
const dailyB = spotlights[room.roomid][key][indexB];
|
|
spotlights[room.roomid][key][indexA] = dailyB;
|
|
spotlights[room.roomid][key][indexB] = dailyA;
|
|
|
|
saveSpotlights();
|
|
|
|
this.modlog(`DAILY QUEUE SWAP`, key, `${indexA} with ${indexB}`);
|
|
this.privateModAction(`${user.name} swapped the queued dailies for '${key}' at queue numbers ${indexA} and ${indexB}.`);
|
|
Chat.refreshPageFor(`spotlights-${room.roomid}`, room);
|
|
},
|
|
queuedaily: 'setdaily',
|
|
queuedailyat: 'setdaily',
|
|
replacedaily: 'setdaily',
|
|
async setdaily(target, room, user, connection, cmd) {
|
|
room = this.requireRoom();
|
|
if (!room.persist) throw new Chat.ErrorMessage("This command is unavailable in temporary rooms.");
|
|
let key, indexString, rest;
|
|
if (cmd.endsWith('at') || cmd === 'replacedaily') {
|
|
[key, indexString, ...rest] = target.split(',');
|
|
} else {
|
|
[key, ...rest] = target.split(',');
|
|
}
|
|
key = toID(key);
|
|
if (!key) return this.parse('/help daily');
|
|
if (key.length > 20) throw new Chat.ErrorMessage("Spotlight names can be a maximum of 20 characters long.");
|
|
if (key === 'constructor') return false;
|
|
if (!spotlights[room.roomid]) spotlights[room.roomid] = {};
|
|
const queueLength = spotlights[room.roomid][key]?.length || 0;
|
|
|
|
if (indexString && !NUMBER_REGEX.test(indexString)) throw new Chat.ErrorMessage("The queue number must be a number.");
|
|
|
|
const index = (indexString ? parseInt(indexString) : queueLength);
|
|
if (indexString && (index < 1 || index > queueLength)) {
|
|
throw new Chat.ErrorMessage(`Queue numbers must be between 1 and the length of the queue (${queueLength}).`);
|
|
}
|
|
|
|
this.checkCan('announce', null, room);
|
|
if (!rest.length) return this.parse('/help daily');
|
|
let img: StoredImage | undefined;
|
|
if (rest[0].trim().startsWith('http://') || rest[0].trim().startsWith('https://')) {
|
|
const url = rest.shift()!.trim();
|
|
try {
|
|
const [width, height] = await Chat.fitImage(url);
|
|
img = [url, width, height];
|
|
} catch {
|
|
throw new Chat.ErrorMessage(`Invalid image url: ${url}`);
|
|
}
|
|
}
|
|
const desc = rest.join(',');
|
|
if (Chat.stripFormatting(desc).length > 500) {
|
|
throw new Chat.ErrorMessage("Descriptions can be at most 500 characters long.");
|
|
}
|
|
const obj = { image: img, description: desc, time: Date.now() };
|
|
if (!spotlights[room.roomid][key]) spotlights[room.roomid][key] = [];
|
|
if (cmd === 'setdaily') {
|
|
spotlights[room.roomid][key].shift();
|
|
spotlights[room.roomid][key].unshift(obj);
|
|
|
|
this.modlog('SETDAILY', key, `${img ? `${img}, ` : ''}${desc}`);
|
|
this.privateModAction(`${user.name} set the daily ${key}.`);
|
|
} else if (cmd === 'queuedailyat') {
|
|
spotlights[room.roomid][key].splice(index, 0, obj);
|
|
this.modlog('QUEUEDAILY', key, `queue number ${index}: ${img ? `${img}, ` : ''}${desc}`);
|
|
this.privateModAction(`${user.name} queued a daily ${key} at queue number ${index}.`);
|
|
} else {
|
|
spotlights[room.roomid][key][index] = obj;
|
|
if (indexString) {
|
|
this.modlog('REPLACEDAILY', key, `queue number ${index}: ${img ? `${img}, ` : ''}${desc}`);
|
|
this.privateModAction(`${user.name} replaced the daily ${key} at queue number ${index}.`);
|
|
} else {
|
|
this.modlog('QUEUEDAILY', key, `${img ? `${img}, ` : ''}${desc}`);
|
|
this.privateModAction(`${user.name} queued a daily ${key}.`);
|
|
}
|
|
}
|
|
saveSpotlights();
|
|
Chat.refreshPageFor(`spotlights-${room.roomid}`, room);
|
|
},
|
|
daily(target, room, user) {
|
|
room = this.requireRoom();
|
|
if (!room.persist) throw new Chat.ErrorMessage("This command is unavailable in temporary rooms.");
|
|
const key = toID(target);
|
|
if (!key) return this.parse('/help daily');
|
|
|
|
if (!spotlights[room.roomid]?.[key]) {
|
|
throw new Chat.ErrorMessage(`Cannot find a daily spotlight with name '${key}'`);
|
|
}
|
|
|
|
if (!this.runBroadcast()) return;
|
|
|
|
const { image, description } = spotlights[room.roomid][key][0];
|
|
const html = renderSpotlight(room.roomid, key);
|
|
|
|
this.sendReplyBox(html);
|
|
if (!this.broadcasting && user.can('ban', null, room, 'setdaily')) {
|
|
const code = Utils.escapeHTML(description).replace(/\n/g, '<br />');
|
|
this.sendReplyBox(`<details><summary>Source</summary><code style="white-space: pre-wrap; display: table; tab-size: 3">/setdaily ${key},${image ? `${typeof image === 'string' ? image : image[0]},` : ''}${code}</code></details>`);
|
|
}
|
|
room.update();
|
|
},
|
|
vsl: 'viewspotlights',
|
|
dailies: 'viewspotlights',
|
|
viewspotlights(target, room, user) {
|
|
room = this.requireRoom();
|
|
if (!room.persist) throw new Chat.ErrorMessage("This command is unavailable in temporary rooms.");
|
|
target = toID(target);
|
|
return this.parse(`/join view-spotlights-${room.roomid}${target ? `-${target}` : ''}`);
|
|
},
|
|
|
|
dailyhelp() {
|
|
this.sendReply(
|
|
`|html|<details class="readmore"><summary><code>/daily [name]</code>: shows the daily spotlight.<br />` +
|
|
`<code>!daily [name]</code>: shows the daily spotlight to everyone. Requires: + % @ # ~<br />` +
|
|
`<code>/setdaily [name], [image], [description]</code>: sets the daily spotlight. Image can be left out. Requires: % @ # ~</summary>` +
|
|
`<code>/queuedaily [name], [image], [description]</code>: queues a daily spotlight. At midnight, the spotlight with this name will automatically switch to the next queued spotlight. Image can be left out. Requires: % @ # ~<br />` +
|
|
`<code>/queuedailyat [name], [queue number], [image], [description]</code>: inserts a daily spotlight into the queue at the specified number (starting from 1). Requires: % @ # ~<br />` +
|
|
`<code>/replacedaily [name], [queue number], [image], [description]</code>: replaces the daily spotlight queued at the specified number. Requires: % @ # ~<br />` +
|
|
`<code>/removedaily [name][, queue number]</code>: If no queue number is provided, the current spotlight is deleted (and tomorrow's, if it exists, is moved up). If a number is provided, removes a specific future spotlight from the queue. Requires: % @ # ~<br />` +
|
|
`<code>/removedaily [name], all</code>: Deletes all current and queued spotlights with the given name. Requires: % @ # ~<br />` +
|
|
`<code>/swapdaily [name], [queue number], [queue number]</code>: swaps the two queued spotlights at the given queue numbers. Requires: % @ # ~<br />` +
|
|
`<code>/viewspotlights [sorter]</code>: shows all current spotlights in the room. For staff, also shows queued spotlights.` +
|
|
`[sorter] can either be unset, 'time', or 'alphabet'. These sort by either the time added, or alphabetical order.` +
|
|
`</details>`
|
|
);
|
|
},
|
|
};
|
|
|
|
export const handlers: Chat.Handlers = {
|
|
onRenameRoom(oldID, newID) {
|
|
if (spotlights[oldID]) {
|
|
if (!spotlights[newID]) spotlights[newID] = {};
|
|
Object.assign(spotlights[newID], spotlights[oldID]);
|
|
delete spotlights[oldID];
|
|
saveSpotlights();
|
|
}
|
|
},
|
|
};
|
|
|
|
export function start() {
|
|
Chat.multiLinePattern.register('/(queue|set|replace)daily(at | )');
|
|
}
|