Avatar manager (#8563)

This commit is contained in:
Guangcong Luo 2021-12-14 10:21:02 -08:00 committed by GitHub
parent 47fc69351b
commit 8642abcd12
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 924 additions and 463 deletions

View File

@ -1,5 +1,5 @@
# Avatars directory
# Custom avatars directory
You can specify custom avatars for users in `config/config.js` using the `customavatars` option. After doing so, place your custom avatar files in this directory.
You can give your users custom avatars. Your server *must* be registered, or this won't work.
Your server must be registered in order to use custom avatars.
Put avatar files (80x80 PNG files) here, and then use the `/addavatar` command to give users access to them.

View File

@ -410,21 +410,6 @@ exports.autolockdown = true;
*/
exports.noguestsecurity = false;
/**
* Custom avatars.
* This allows you to specify custom avatar images for users on your server.
* Place custom avatar files under the /config/avatars/ directory.
* Users must be specified as userids -- that is, you must make the name all
* lowercase and remove non-alphanumeric characters.
*
* Your server *must* be registered in order for your custom avatars to be
* displayed in the client.
* @type {{[userid: string]: string}}
*/
exports.customavatars = {
// 'userid': 'customavatar.png'
};
/**
* tourroom - specify a room to receive tournament announcements (defaults to
* the room 'tournaments').

View File

@ -0,0 +1,871 @@
/**
* Avatar commands
* Pokemon Showdown - http://pokemonshowdown.com/
*
* @license MIT
* @author Zarel <guangcongluo@gmail.com>
*/
import {FS, Net} from "../../lib";
const AVATARS_FILE = 'config/avatars.json';
/**
* Avatar IDs should be in one of these formats:
* - 'cynthia' - official avatars in https://play.pokemonshowdown.com/sprites/trainers/
* - '#splxraiders' - hosted custom avatars in https://play.pokemonshowdown.com/sprites/trainers-custom/
* - 'example.png' - side server custom avatars in config/avatars/ in your server
*/
type AvatarID = string;
const AVATAR_FORMATS_MESSAGE = Config.serverid === 'showdown' ?
"Custom avatars start with '#', like '#splxraiders'." :
"Custom avatars look like 'example.png'. Custom avatars should be put in `config/avatars/`. Your server must be registered for custom avatars to work.";
interface AvatarEntry {
timeReceived?: number;
timeUpdated?: number;
notNotified?: boolean;
/**
* First entry is the personal avatar.
* Will never only contain `null` - the entry should just be deleted if it does.
*/
allowed: [AvatarID | null, ...AvatarID[]];
/**
* undefined = personal avatar;
* null = no default (shouldn't occur in practice);
* (ignored during Christmas, where the any avatar is default if it ends in `xmas`.)
*/
default?: AvatarID | null;
}
const customAvatars: {[userid: string]: AvatarEntry} = Object.create(null);
try {
const configAvatars = JSON.parse(FS(AVATARS_FILE).readSync());
Object.assign(customAvatars, configAvatars);
} catch {
if (Config.customavatars) {
for (const userid in Config.customavatars) {
customAvatars[userid] = {allowed: [Config.customavatars[userid]]};
}
}
if (Config.allowedavatars) {
for (const avatar in Config.customavatars) {
for (const userid of Config.customavatars[avatar]) {
customAvatars[userid] ??= {allowed: [null]};
customAvatars[userid].allowed.push(avatar);
}
}
}
FS(AVATARS_FILE).writeSync(JSON.stringify(customAvatars));
}
if ((Config.customavatars && Object.keys(Config.customavatars).length) || Config.allowedavatars) {
Monitor.crashlog("Please remove 'customavatars' and 'allowedavatars' from Config (config/config.js). Your avatars have been migrated to the new '/addavatar' system.");
}
function saveCustomAvatars(instant?: boolean) {
FS(AVATARS_FILE).writeUpdate(() => JSON.stringify(customAvatars), {throttle: instant ? null : 60_000});
}
export const Avatars = new class {
avatars = customAvatars;
userCanUse(user: User, avatar: string): AvatarID | null {
let validatedAvatar = null;
for (const id of [user.id, ...user.previousIDs]) {
validatedAvatar = Avatars.canUse(id, avatar);
if (validatedAvatar) break;
}
return validatedAvatar;
}
canUse(userid: ID, avatar: string): AvatarID | null {
avatar = avatar.toLowerCase().replace(/[^a-z0-9-]+/g, '');
if (OFFICIAL_AVATARS.has(avatar)) return avatar;
const customs = customAvatars[userid]?.allowed;
if (!customs) return null;
if (customs.includes(avatar)) return avatar;
if (customs.includes('#' + avatar)) return '#' + avatar;
if (avatar.startsWith('#') && customs.includes(avatar.slice(1))) return avatar.slice(1);
return null;
}
save(instant?: boolean) {
saveCustomAvatars(instant);
}
src(avatar: AvatarID) {
if (avatar.includes('.')) return '';
const avatarUrl = avatar.startsWith('#') ? `trainers-custom/${avatar.slice(1)}.png` : `trainers/${avatar}.png`;
return `https://${Config.routes.client}/sprites/${avatarUrl}`;
}
exists(avatar: string) {
if (avatar.includes('.')) {
return FS(`config/avatars/${avatar}`).isFile();
}
if (!avatar.startsWith('#')) {
return OFFICIAL_AVATARS.has(avatar);
}
return Net(Avatars.src(avatar)).get().then(() => true).catch(() => false);
}
convert(avatar: string) {
if (avatar.startsWith('#') && avatar.includes('.')) return avatar.slice(1);
return avatar;
}
async validate(avatar: string, options?: {rejectOfficial?: boolean}) {
avatar = this.convert(avatar);
if (!/^#?[a-z0-9-]+$/.test(avatar) && !/^[a-z0-9.-]+$/.test(avatar)) {
throw new Chat.ErrorMessage(`Avatar "${avatar}" is not in a valid format. ${AVATAR_FORMATS_MESSAGE}`);
}
if (!await this.exists(avatar)) {
throw new Chat.ErrorMessage(`Avatar "${avatar}" doesn't exist. ${AVATAR_FORMATS_MESSAGE}`);
}
if (options?.rejectOfficial && /^[a-z0-9-]+$/.test(avatar)) {
throw new Chat.ErrorMessage(`Avatar "${avatar}" is an official avatar that all users already have access to.`);
}
return avatar;
}
img(avatar: AvatarID, noAlt?: boolean) {
const src = Avatars.src(avatar);
if (!src) return <strong><code>{avatar}</code></strong>;
return <img
src={src} alt={noAlt ? '' : avatar} width="80" height="80" class="pixelated" style={{verticalAlign: 'middle'}}
/>;
}
getDefault(userid: ID) {
const entry = customAvatars[userid];
if (!entry) return null;
const DECEMBER = 11; // famous JavaScript issue
if (new Date().getMonth() === DECEMBER && entry.allowed.some(avatar => avatar?.endsWith('xmas'))) {
return entry.allowed.find(avatar => avatar?.endsWith('xmas'));
}
return entry.default === undefined ? entry.allowed[0] : entry.default;
}
/** does not include validation */
setDefault(userid: ID, avatar: AvatarID | null) {
if (avatar === this.getDefault(userid)) return;
const entry = (customAvatars[userid] ??= {allowed: [null]});
if (avatar === entry.allowed[0]) {
delete entry.default;
} else {
entry.default = avatar;
}
saveCustomAvatars();
}
addAllowed(userid: ID, avatar: AvatarID | null) {
const entry = (customAvatars[userid] ??= {allowed: [null]});
if (entry.allowed.includes(avatar)) return false;
entry.allowed.push(avatar);
entry.notNotified = true;
this.tryNotify(Users.get(userid));
return true;
}
removeAllowed(userid: ID, avatar: AvatarID | null) {
const entry = customAvatars[userid];
if (!entry?.allowed.includes(avatar)) return false;
if (entry.allowed[0] === avatar) {
entry.allowed[0] = null;
} else {
entry.allowed = entry.allowed.filter(a => a !== avatar) as any;
}
if (!entry.allowed.some(Boolean)) delete customAvatars[userid];
return true;
}
addPersonal(userid: ID, avatar: AvatarID | null) {
const entry = (customAvatars[userid] ??= {allowed: [null]});
if (entry.allowed.includes(avatar)) return false;
entry.timeReceived ||= Date.now();
entry.timeUpdated = Date.now();
if (!entry.allowed[0]) {
entry.allowed[0] = avatar;
} else {
entry.allowed.unshift(avatar);
}
delete entry.default;
entry.notNotified = true;
this.tryNotify(Users.get(userid));
return true;
}
handleLogin(user: User) {
const avatar = this.getDefault(user.id);
if (avatar) user.avatar = avatar;
this.tryNotify(user);
}
tryNotify(user?: User | null) {
if (!user) return;
const entry = customAvatars[user.id];
if (entry?.notNotified) {
user.send(
`|pm|&|${user.getIdentity()}|/raw ` +
Chat.html`${<>
<p>
You have a new custom avatar!
</p>
<p>
{entry.allowed.map(avatar => avatar && [Avatars.img(avatar), ' '])}
</p>
Use <button class="button" name="send" value="/avatars"><code>/avatars</code></button> for usage instructions.
</>}`
);
delete entry.notNotified;
saveCustomAvatars();
}
}
};
function listUsers(users: string[]) {
return users.flatMap((userid, i) => [i ? ', ' : null, <username class="username">{userid}</username>]);
}
const OFFICIAL_AVATARS = new Set([
'aaron',
'acetrainercouple-gen3', 'acetrainercouple',
'acetrainerf-gen1', 'acetrainerf-gen1rb', 'acetrainerf-gen2', 'acetrainerf-gen3', 'acetrainerf-gen3rs', 'acetrainerf-gen4dp', 'acetrainerf-gen4', 'acetrainerf',
'acetrainer-gen1', 'acetrainer-gen1rb', 'acetrainer-gen2', 'acetrainer-gen3jp', 'acetrainer-gen3', 'acetrainer-gen3rs', 'acetrainer-gen4dp', 'acetrainer-gen4', 'acetrainer',
'acetrainersnowf',
'acetrainersnow',
'agatha-gen1', 'agatha-gen1rb', 'agatha-gen3',
'alder',
'anabel-gen3',
'archer',
'archie-gen3',
'argenta',
'ariana',
'aromalady-gen3', 'aromalady-gen3rs', 'aromalady',
'artist-gen4', 'artist',
'ash-alola', 'ash-hoenn', 'ash-kalos', 'ash-unova', 'ash-capbackward', 'ash-johto', 'ash-sinnoh', 'ash',
'backersf',
'backers',
'backpackerf',
'backpacker',
'baker',
'barry',
'battlegirl-gen3', 'battlegirl-gen4', 'battlegirl',
'beauty-gen1', 'beauty-gen1rb', 'beauty-gen2jp', 'beauty-gen2', 'beauty-gen3', 'beauty-gen3rs', 'beauty-gen4dp', 'beauty-gen5bw2', 'beauty',
'bellelba',
'bellepa',
'benga',
'bertha',
'bianca-pwt', 'bianca',
'biker-gen1', 'biker-gen1rb', 'biker-gen2', 'biker-gen3', 'biker-gen4', 'biker',
'bill-gen3',
'birch-gen3',
'birdkeeper-gen1', 'birdkeeper-gen1rb', 'birdkeeper-gen2', 'birdkeeper-gen3', 'birdkeeper-gen3rs', 'birdkeeper-gen4dp', 'birdkeeper',
'blackbelt-gen1', 'blackbelt-gen1rb', 'blackbelt-gen2', 'blackbelt-gen3', 'blackbelt-gen3rs', 'blackbelt-gen4dp', 'blackbelt-gen4', 'blackbelt',
'blaine-gen1', 'blaine-gen1rb', 'blaine-gen2', 'blaine-gen3', 'blaine',
'blue-gen1champion', 'blue-gen1', 'blue-gen1rbchampion', 'blue-gen1rb', 'blue-gen1rbtwo', 'blue-gen1two', 'blue-gen2', 'blue-gen3champion', 'blue-gen3', 'blue-gen3two', 'blue',
'boarder-gen2', 'boarder',
'brandon-gen3',
'brawly-gen3', 'brawly',
'brendan-gen3', 'brendan-gen3rs',
'brock-gen1', 'brock-gen1rb', 'brock-gen2', 'brock-gen3', 'brock',
'bruno-gen1', 'bruno-gen1rb', 'bruno-gen2', 'bruno-gen3', 'bruno',
'brycenman',
'brycen',
'buck',
'bugcatcher-gen1', 'bugcatcher-gen1rb', 'bugcatcher-gen2', 'bugcatcher-gen3', 'bugcatcher-gen3rs', 'bugcatcher-gen4dp', 'bugcatcher',
'bugmaniac-gen3',
'bugsy-gen2', 'bugsy',
'burgh',
'burglar-gen1', 'burglar-gen1rb', 'burglar-gen2', 'burglar-gen3', 'burglar',
'byron',
'caitlin',
'cameraman',
'camper-gen2', 'camper-gen3', 'camper-gen3rs', 'camper',
'candice',
'channeler-gen1', 'channeler-gen1rb', 'channeler-gen3',
'cheren-gen5bw2', 'cheren',
'cheryl',
'chili',
'chuck-gen2', 'chuck',
'cilan',
'clair-gen2', 'clair',
'clay',
'clemont',
'clerkf',
'clerk-boss', 'clerk',
'clown',
'collector-gen3', 'collector',
'colress',
'courtney-gen3',
'cowgirl',
'crasherwake',
'cress',
'crushgirl-gen3',
'crushkin-gen3',
'cueball-gen1', 'cueball-gen1rb', 'cueball-gen3',
'cyclistf-gen4', 'cyclistf',
'cyclist-gen4', 'cyclist',
'cynthia-gen4', 'cynthia',
'cyrus',
'dahlia',
'daisy-gen3',
'dancer',
'darach',
'dawn-gen4pt', 'dawn',
'depotagent',
'doctor',
'doubleteam',
'dragontamer-gen3', 'dragontamer',
'drake-gen3',
'drayden',
'elesa-gen5bw2', 'elesa',
'emmet',
'engineer-gen1', 'engineer-gen1rb', 'engineer-gen3',
'erika-gen1', 'erika-gen1rb', 'erika-gen2', 'erika-gen3', 'erika',
'ethan-gen2c', 'ethan-gen2', 'ethan-pokeathlon', 'ethan',
'eusine-gen2', 'eusine',
'expertf-gen3',
'expert-gen3',
'falkner-gen2',
'falkner',
'fantina',
'firebreather-gen2',
'firebreather',
'fisherman-gen1', 'fisherman-gen1rb', 'fisherman-gen2jp', 'fisherman-gen3', 'fisherman-gen3rs', 'fisherman-gen4', 'fisherman',
'flannery-gen3', 'flannery',
'flint',
'galacticgruntf',
'galacticgrunt',
'gambler-gen1', 'gambler-gen1rb', 'gambler',
'gamer-gen3',
'gardenia',
'gentleman-gen1', 'gentleman-gen1rb', 'gentleman-gen2', 'gentleman-gen3', 'gentleman-gen3rs', 'gentleman-gen4dp', 'gentleman-gen4', 'gentleman',
'ghetsis-gen5bw', 'ghetsis',
'giovanni-gen1', 'giovanni-gen1rb', 'giovanni-gen3', 'giovanni',
'glacia-gen3',
'greta-gen3',
'grimsley',
'guitarist-gen2', 'guitarist-gen3', 'guitarist-gen4', 'guitarist',
'harlequin',
'hexmaniac-gen3jp', 'hexmaniac-gen3',
'hiker-gen1', 'hiker-gen1rb', 'hiker-gen2', 'hiker-gen3', 'hiker-gen3rs', 'hiker-gen4', 'hiker',
'hilbert-wonderlauncher', 'hilbert',
'hilda-wonderlauncher', 'hilda',
'hooligans',
'hoopster',
'hugh',
'idol',
'infielder',
'ingo',
'interviewers-gen3',
'interviewers',
'iris-gen5bw2', 'iris',
'janine-gen2', 'janine',
'janitor',
'jasmine-gen2', 'jasmine',
'jessiejames-gen1',
'jogger',
'jrtrainerf-gen1', 'jrtrainerf-gen1rb',
'jrtrainer-gen1', 'jrtrainer-gen1rb',
'juan-gen3',
'juan',
'juggler-gen1', 'juggler-gen1rb', 'juggler-gen2', 'juggler-gen3', 'juggler',
'jupiter',
'karen-gen2', 'karen',
'kimonogirl-gen2', 'kimonogirl',
'kindler-gen3',
'koga-gen1', 'koga-gen2', 'koga-gen1rb', 'koga-gen3', 'koga',
'kris-gen2',
'lady-gen3', 'lady-gen3rs', 'lady-gen4', 'lady',
'lance-gen1', 'lance-gen1rb', 'lance-gen2', 'lance-gen3', 'lance',
'lass-gen1', 'lass-gen1rb', 'lass-gen2', 'lass-gen3', 'lass-gen3rs', 'lass-gen4dp', 'lass-gen4', 'lass',
'leaf-gen3',
'lenora',
'linebacker',
'li',
'liza',
'lorelei-gen1', 'lorelei-gen1rb', 'lorelei-gen3',
'ltsurge-gen1', 'ltsurge-gen1rb', 'ltsurge-gen2', 'ltsurge-gen3', 'ltsurge',
'lucas-gen4pt', 'lucas',
'lucian',
'lucy-gen3',
'lyra-pokeathlon', 'lyra',
'madame-gen4dp', 'madame-gen4', 'madame',
'maid-gen4', 'maid',
'marley',
'marlon',
'marshal',
'mars',
'matt-gen3',
'maxie-gen3',
'may-gen3', 'may-gen3rs',
'maylene',
'medium-gen2jp', 'medium',
'mira',
'misty-gen1', 'misty-gen2', 'misty-gen1rb', 'misty-gen3', 'misty',
'morty-gen2', 'morty',
'mrfuji-gen3',
'musician',
'nate-wonderlauncher', 'nate',
'ninjaboy-gen3', 'ninjaboy',
'noland-gen3',
'norman-gen3', 'norman',
'n',
'nurse',
'nurseryaide',
'oak-gen1', 'oak-gen1rb', 'oak-gen2', 'oak-gen3',
'officer-gen2',
'oldcouple-gen3',
'painter-gen3',
'palmer',
'parasollady-gen3', 'parasollady-gen4', 'parasollady',
'petrel',
'phoebe-gen3',
'picnicker-gen2', 'picnicker-gen3', 'picnicker-gen3rs', 'picnicker',
'pilot',
'plasmagruntf-gen5bw', 'plasmagruntf',
'plasmagrunt-gen5bw', 'plasmagrunt',
'pokefanf-gen2', 'pokefanf-gen3', 'pokefanf-gen4', 'pokefanf',
'pokefan-gen2', 'pokefan-gen3', 'pokefan-gen4', 'pokefan',
'pokekid',
'pokemaniac-gen1', 'pokemaniac-gen1rb', 'pokemaniac-gen2', 'pokemaniac-gen3', 'pokemaniac-gen3rs', 'pokemaniac',
'pokemonbreederf-gen3', 'pokemonbreederf-gen3frlg', 'pokemonbreederf-gen4', 'pokemonbreederf',
'pokemonbreeder-gen3', 'pokemonbreeder-gen4', 'pokemonbreeder',
'pokemonrangerf-gen3', 'pokemonrangerf-gen3rs', 'pokemonrangerf-gen4', 'pokemonrangerf',
'pokemonranger-gen3', 'pokemonranger-gen3rs', 'pokemonranger-gen4', 'pokemonranger',
'policeman-gen4', 'policeman',
'preschoolerf',
'preschooler',
'proton',
'pryce-gen2', 'pryce',
'psychicf-gen3', 'psychicf-gen3rs', 'psychicf-gen4', 'psychicfjp-gen3', 'psychicf',
'psychic-gen1', 'psychic-gen1rb', 'psychic-gen2', 'psychic-gen3', 'psychic-gen3rs', 'psychic-gen4', 'psychic',
'rancher',
'red-gen1main', 'red-gen1', 'red-gen1rb', 'red-gen1title', 'red-gen2', 'red-gen3', 'red',
'reporter',
'richboy-gen3', 'richboy-gen4', 'richboy',
'riley',
'roark',
'rocker-gen1', 'rocker-gen1rb', 'rocker-gen3',
'rocket-gen1', 'rocket-gen1rb',
'rocketgruntf-gen2', 'rocketgruntf',
'rocketgrunt-gen2', 'rocketgrunt',
'rocketexecutivef-gen2',
'rocketexecutive-gen2',
'rood',
'rosa-wonderlauncher', 'rosa',
'roughneck-gen4', 'roughneck',
'roxanne-gen3', 'roxanne',
'roxie',
'ruinmaniac-gen3', 'ruinmaniac-gen3rs', 'ruinmaniac',
'sabrina-gen1', 'sabrina-gen1rb', 'sabrina-gen2', 'sabrina-gen3', 'sabrina',
'sage-gen2', 'sage-gen2jp', 'sage',
'sailor-gen1', 'sailor-gen1rb', 'sailor-gen2', 'sailor-gen3jp', 'sailor-gen3', 'sailor-gen3rs', 'sailor',
'saturn',
'schoolboy-gen2',
'schoolkidf-gen3', 'schoolkidf-gen4', 'schoolkidf',
'schoolkid-gen3', 'schoolkid-gen4dp', 'schoolkid-gen4', 'schoolkid',
'scientistf',
'scientist-gen1', 'scientist-gen1rb', 'scientist-gen2', 'scientist-gen3', 'scientist-gen4dp', 'scientist-gen4', 'scientist',
'shadowtriad',
'shauntal',
'shelly-gen3',
'sidney-gen3',
'silver-gen2kanto', 'silver-gen2', 'silver',
'sisandbro-gen3', 'sisandbro-gen3rs', 'sisandbro',
'skierf-gen4dp', 'skierf',
'skier-gen2', 'skier',
'skyla',
'smasher',
'spenser-gen3',
'srandjr-gen3',
'steven-gen3', 'steven',
'striker',
'supernerd-gen1', 'supernerd-gen1rb', 'supernerd-gen2', 'supernerd-gen3', 'supernerd',
'swimmerf-gen2', 'swimmerf-gen3', 'swimmerf-gen3rs', 'swimmerf-gen4dp', 'swimmerf-gen4', 'swimmerfjp-gen2', 'swimmerf',
'swimmer-gen1', 'swimmer-gen1rb', 'swimmer-gen4dp', 'swimmer-gen4jp', 'swimmer-gen4', 'swimmerm-gen2', 'swimmerm-gen3', 'swimmerm-gen3rs', 'swimmer',
'tabitha-gen3',
'tamer-gen1', 'tamer-gen1rb', 'tamer-gen3',
'tateandliza-gen3',
'tate',
'teacher-gen2', 'teacher',
'teamaquabeta-gen3',
'teamaquagruntf-gen3',
'teamaquagruntm-gen3',
'teammagmagruntf-gen3',
'teammagmagruntm-gen3',
'teamrocketgruntf-gen3',
'teamrocketgruntm-gen3',
'teamrocket',
'thorton',
'triathletebikerf-gen3',
'triathletebikerm-gen3',
'triathleterunnerf-gen3',
'triathleterunnerm-gen3',
'triathleteswimmerf-gen3',
'triathleteswimmerm-gen3',
'tuberf-gen3', 'tuberf-gen3rs', 'tuberf',
'tuber-gen3', 'tuber',
'tucker-gen3',
'twins-gen2', 'twins-gen3', 'twins-gen3rs', 'twins-gen4dp', 'twins-gen4', 'twins',
'unknownf',
'unknown',
'veteranf',
'veteran-gen4', 'veteran',
'volkner',
'waiter-gen4dp', 'waiter-gen4', 'waiter',
'waitress-gen4', 'waitress',
'wallace-gen3', 'wallace-gen3rs', 'wallace',
'wally-gen3',
'wattson-gen3', 'wattson',
'whitney-gen2', 'whitney',
'will-gen2', 'will',
'winona-gen3', 'winona',
'worker-gen4',
'workerice',
'worker',
'yellow',
'youngcouple-gen3', 'youngcouple-gen3rs', 'youngcouple-gen4dp', 'youngcouple',
'youngster-gen1', 'youngster-gen1rb', 'youngster-gen2', 'youngster-gen3', 'youngster-gen3rs', 'youngster-gen4', 'youngster-gen4dp', 'youngster',
'zinzolin',
]);
const OFFICIAL_AVATARS_BELIOT419 = new Set([
'acerola', 'aetheremployee', 'aetheremployeef', 'aetherfoundation', 'aetherfoundationf', 'anabel',
'beauty-gen7', 'blue-gen7', 'burnet', 'colress-gen7', 'dexio', 'elio', 'faba', 'gladion-stance',
'gladion', 'grimsley-gen7', 'hapu', 'hau-stance', 'hau', 'hiker-gen7', 'ilima', 'kahili', 'kiawe',
'kukui-stand', 'kukui', 'lana', 'lass-gen7', 'lillie-z', 'lillie', 'lusamine-nihilego', 'lusamine',
'mallow', 'mina', 'molayne', 'nanu', 'officeworker', 'olivia', 'plumeria', 'pokemonbreeder-gen7',
'pokemonbreederf-gen7', 'preschoolers', 'red-gen7', 'risingstar', 'risingstarf', 'ryuki',
'samsonoak', 'selene', 'sightseer', 'sina', 'sophocles', 'teacher-gen7', 'theroyal', 'wally',
'wicke', 'youngathlete', 'youngathletef', 'youngster-gen7',
]);
const OFFICIAL_AVATARS_GNOMOWLADNY = new Set([
'az', 'brawly-gen6', 'bryony', 'drasna', 'evelyn', 'furisodegirl-black', 'furisodegirl-pink', 'guzma',
'hala', 'korrina', 'malva', 'nita', 'olympia', 'ramos', 'shelly', 'sidney', 'siebold', 'tierno',
'valerie', 'viola', 'wallace-gen6', 'wikstrom', 'winona-gen6', 'wulfric', 'xerosic', 'youngn', 'zinnia',
]);
for (const avatar of OFFICIAL_AVATARS_BELIOT419) OFFICIAL_AVATARS.add(avatar);
for (const avatar of OFFICIAL_AVATARS_GNOMOWLADNY) OFFICIAL_AVATARS.add(avatar);
export const commands: Chat.ChatCommands = {
avatar(target, room, user) {
if (!target) return this.parse(`${this.cmdToken}avatars`);
const [maybeAvatar, silent] = target.split(',');
const avatar = Avatars.userCanUse(user, maybeAvatar);
if (!avatar) {
if (silent) return false;
this.errorReply("Unrecognized avatar - make sure you're on the right account?");
return false;
}
user.avatar = avatar;
if (user.id in customAvatars && !avatar.endsWith('xmas')) {
Avatars.setDefault(user.id, avatar);
}
if (!silent) {
this.sendReply(
`${this.tr`Avatar changed to:`}\n` +
Chat.html`|raw|${Avatars.img(avatar)}`
);
if (OFFICIAL_AVATARS_BELIOT419.has(avatar)) {
this.sendReply(`|raw|(${this.tr`Artist: `}<a href="https://www.deviantart.com/beliot419">Beliot419</a>)`);
}
if (OFFICIAL_AVATARS_GNOMOWLADNY.has(avatar)) {
this.sendReply(`|raw|(${this.tr`Artist: `}Gnomowladny)`);
}
}
},
avatarhelp: [`/avatar [avatar name or number] - Change your trainer sprite.`],
avatars(target, room, user) {
this.runBroadcast();
if (target.startsWith('#')) return this.parse(`/avatarusers ${target}`);
const targetUser = this.broadcasting && !target ? null : this.getUserOrSelf(target);
const targetUserids = targetUser ? new Set([targetUser.id, ...targetUser.previousIDs]) :
target ? new Set([toID(target)]) : null;
if (targetUserids && targetUser !== user && !user.can('alts')) {
throw new Chat.ErrorMessage("You don't have permission to look at another user's avatars!");
}
const out = [];
if (targetUserids) {
const hasButton = !this.broadcasting && targetUser === user;
for (const id of targetUserids) {
const allowed = customAvatars[id]?.allowed;
if (allowed) {
out.push(
<p>Custom avatars from account <strong>{id}</strong>:</p>,
allowed.filter(Boolean).map(avatar => (
<p>
{hasButton ?
<button name="send" value={`/avatar ${avatar}`} class="button">{Avatars.img(avatar!)}</button> :
Avatars.img(avatar!)
} {}
<code>/avatar {avatar!.replace('#', '')}</code>
</p>
))
);
}
}
if (!out.length && target) {
out.push(<p>User <strong>{toID(target)}</strong> doesn't have any custom avatars.</p>);
}
}
if (!out.length) {
out.push(<p>Custom avatars require you to be a contributor/staff or win a tournament prize.</p>);
}
this.sendReplyBox(<>
{!target && [<p>
You can <button name="avatars" class="button">change your avatar</button> by clicking on it in the {}
<button name="openOptions" class="button" aria-label="Options"><i class="fa fa-cog"></i></button> menu in the upper {}
right.
</p>, <p>
Avatars from generations other than 3-5 are hidden. You can find them in this {}
<a href="https://play.pokemonshowdown.com/sprites/trainers/"><strong>full list of avatars</strong></a>. {}
You can use them by typing <code>/avatar <i>[avatar's name]</i></code> into any chat. For example, {}
<code>/avatar erika-gen2</code>.
</p>]}
{out}
</>);
},
avatarshelp: [
`/avatars - Explains how to change avatars.`,
`/avatars [username] - Shows custom avatars available to a user.`,
`!avatars - Show everyone that information. Requires: + % @ # &`,
],
addavatar() {
this.sendReply("Is this a personal avatar or a group avatar?");
return this.parse(`/help addavatar`);
},
addavatarhelp: [
`/personalavatar [username], [avatar] - Gives a user a default (personal) avatar.`,
`/groupavatar [username], [avatar] - Gives a user an allowed (group) avatar.`,
`/removeavatar [username], [avatar] - Removes access to an avatar from a user.`,
`/removeavatar [username] - Removes access to all custom avatars from a user.`,
AVATAR_FORMATS_MESSAGE,
],
personalavatar: 'defaultavatar',
async defaultavatar(target, room, user) {
this.checkCan('bypassall');
if (!target) return this.parse(`/help defaultavatar`);
const [inputUsername, inputAvatar] = this.splitOne(target);
if (!Users.isUsername(inputUsername)) {
throw new Chat.ErrorMessage(`"${inputUsername}" is not a valid username.`);
}
const userid = toID(inputUsername);
const avatar = await Avatars.validate(inputAvatar, {rejectOfficial: true});
if (!Avatars.addPersonal(userid, avatar)) {
throw new Chat.ErrorMessage(`User "${inputUsername}" can already use avatar "${avatar}".`);
}
this.globalModlog('PERSONAL AVATAR', userid, avatar);
this.sendReplyBox(<div>
{Avatars.img(avatar)}<br />
Added to <username class="username">{inputUsername}</username>
</div>);
},
defaultavatarhelp: 'addavatarhelp',
allowedavatar: 'allowavatar',
groupavatar: 'allowavatar',
async allowavatar(target, room, user) {
this.checkCan('bypassall');
if (!target) return this.parse(`/help defaultavatar`);
const [inputUsername, inputAvatar] = this.splitOne(target);
if (!Users.isUsername(inputUsername)) {
throw new Chat.ErrorMessage(`"${inputUsername}" is not a valid username.`);
}
const userid = toID(inputUsername);
const avatar = await Avatars.validate(inputAvatar, {rejectOfficial: true});
if (!Avatars.addAllowed(userid, avatar)) {
throw new Chat.ErrorMessage(`User "${inputUsername}" can already use avatar "${avatar}".`);
}
this.globalModlog('GROUP AVATAR', userid, avatar);
this.sendReplyBox(<div>
{Avatars.img(avatar)}<br />
Added to <username class="username">{inputUsername}</username>
</div>);
},
allowavatarhelp: 'addavatarhelp',
denyavatar: 'removeavatar',
disallowavatar: 'removeavatar',
removeavatars: 'removeavatar',
removeavatar(target, room, user) {
this.checkCan('bypassall');
if (!target) return this.parse(`/help defaultavatar`);
const [inputUsername, inputAvatar] = this.splitOne(target);
if (!Users.isUsername(inputUsername)) {
throw new Chat.ErrorMessage(`"${inputUsername}" is not a valid username.`);
}
const userid = toID(inputUsername);
const avatar = Avatars.convert(inputAvatar);
const allowed = customAvatars[userid]?.allowed.filter(Boolean);
if (!allowed) {
throw new Chat.ErrorMessage(`${inputUsername} doesn't have any custom avatars.`);
}
if (avatar) {
if (!Avatars.removeAllowed(userid, avatar)) {
throw new Chat.ErrorMessage(`${inputUsername} doesn't have access to avatar "${avatar}"`);
}
this.globalModlog('REMOVE AVATAR', userid, avatar);
this.sendReplyBox(<div>
{Avatars.img(avatar)}<br />
Removed from <username class="username">{inputUsername}</username>
</div>);
} else {
// delete all
delete customAvatars[userid];
Avatars.save();
this.globalModlog('REMOVE AVATARS', userid, allowed.join(','));
this.sendReplyBox(<div>
{allowed.map(curAvatar => [Avatars.img(curAvatar!), ' '])}<br />
Removed from <username class="username">{inputUsername}</username>
</div>);
}
},
removeavatarhelp: 'addavatarhelp',
async avatarusers(target, room, user) {
target = '#' + toID(target);
if (!Avatars.userCanUse(user, target) && !user.can('alts')) {
throw new Chat.ErrorMessage(`You don't have access to avatar "${target}"`);
}
this.runBroadcast();
const users = [];
for (const userid in customAvatars) {
if (customAvatars[userid].allowed.includes(target)) {
users.push(userid);
}
}
users.sort();
if (!users.length && !await Avatars.exists(target)) {
throw new Chat.ErrorMessage(`Unrecognized avatar "${target}"`);
}
this.sendReplyBox(<>
<p>{Avatars.img(target, true)}</p>
<p>
<code>{target}</code><br />
{users ? listUsers(users) : <p>No users currently allowed to use this avatar</p>}
</p>
</>);
},
async masspavatar(target, room, user) {
this.checkCan('bypassall');
const usernames = target.trim().split(/\s*\n|,\s*/)
.map(username => username.endsWith('.png') ? username.slice(0, -4) : username);
for (const username of usernames) {
if (!Users.isUsername(username)) {
throw new Chat.ErrorMessage(`Invalid username "${username}"`);
}
await Avatars.validate('#' + toID(username));
}
const userids = usernames.map(toID);
for (const userid of userids) {
const avatar = '#' + userid;
Avatars.addPersonal(userid, avatar);
this.globalModlog('PERSONAL AVATAR', userid, avatar);
}
this.sendReplyBox(<div>
{userids.map(userid => Avatars.img('#' + userid))}<br />
Added {userids.length} avatars
</div>);
},
async massxmasavatar(target, room, user) {
this.checkCan('bypassall');
const usernames = target.trim().split(/\s*\n|,\s*/)
.map(username => username.endsWith('.png') ? username.slice(0, -4) : username)
.map(username => username.endsWith('xmas') ? username.slice(0, -4) : username);
for (const username of usernames) {
if (!Users.isUsername(username)) {
throw new Chat.ErrorMessage(`Invalid username "${username}"`);
}
await Avatars.validate(`#${toID(username)}xmas`);
}
const userids = usernames.map(toID);
for (const userid of userids) {
const avatar = `#${userid}xmas`;
Avatars.addAllowed(userid, avatar);
this.globalModlog('GROUP AVATAR', userid, avatar);
}
this.sendReplyBox(<div>
{userids.map(userid => Avatars.img(`#${userid}xmas`))}<br />
Added {userids.length} avatars
</div>);
},
async massgavatar(target, room, user) {
this.checkCan('bypassall');
const args = target.trim().split(/\s*\n|,\s*/);
let curAvatar = '';
const toUpdate: Record<string, Set<ID>> = Object.create(null);
for (const arg of args) {
if (arg.startsWith('#')) {
curAvatar = await Avatars.validate(arg);
} else {
if (!curAvatar) return this.parse(`/help massgavatar`);
if (!/[A-Za-z0-9]/.test(arg.charAt(0)) || !/[A-Za-z]/.test(arg)) {
throw new Chat.ErrorMessage(`Invalid username "${arg}"`);
}
(toUpdate[curAvatar] ??= new Set()).add(toID(arg));
}
}
const out = [];
for (const avatar in toUpdate) {
const newUsers = toUpdate[avatar];
const oldUsers = new Set<ID>();
for (const userid in customAvatars) {
if (customAvatars[userid].allowed.includes(avatar)) {
oldUsers.add(userid as ID);
}
}
const added: ID[] = [];
for (const newUser of newUsers) {
if (!oldUsers.has(newUser)) {
Avatars.addAllowed(newUser, avatar);
added.push(newUser);
this.globalModlog('GROUP AVATAR', newUser, avatar);
}
}
const removed: ID[] = [];
for (const oldUser of oldUsers) {
if (!newUsers.has(oldUser)) {
Avatars.removeAllowed(oldUser, avatar);
removed.push(oldUser);
this.globalModlog('REMOVE AVATAR', oldUser, avatar);
}
}
out.push(<p>{Avatars.img(avatar, true)}</p>);
out.push(<div><code>{avatar}</code></div>);
if (added.length) out.push(<div>{oldUsers.size ? 'Added' : 'New'}: {listUsers(added)}</div>);
if (removed.length) out.push(<div>Removed: {listUsers(removed)}</div>);
if (!added.length && !removed.length) out.push(<div>No change</div>);
}
this.sendReplyBox(<>{out}</>);
Avatars.save(true);
},
};
Users.Avatars = Avatars;
Chat.multiLinePattern.register(
'/massgavatar', '/masspavatar', '/massxmasavatar',
);

View File

@ -18,330 +18,6 @@ import {Utils} from '../../lib';
import type {UserSettings} from '../users';
import type {GlobalPermission} from '../user-groups';
const avatarTable = new Set([
'aaron',
'acetrainercouple-gen3', 'acetrainercouple',
'acetrainerf-gen1', 'acetrainerf-gen1rb', 'acetrainerf-gen2', 'acetrainerf-gen3', 'acetrainerf-gen3rs', 'acetrainerf-gen4dp', 'acetrainerf-gen4', 'acetrainerf',
'acetrainer-gen1', 'acetrainer-gen1rb', 'acetrainer-gen2', 'acetrainer-gen3jp', 'acetrainer-gen3', 'acetrainer-gen3rs', 'acetrainer-gen4dp', 'acetrainer-gen4', 'acetrainer',
'acetrainersnowf',
'acetrainersnow',
'agatha-gen1', 'agatha-gen1rb', 'agatha-gen3',
'alder',
'anabel-gen3',
'archer',
'archie-gen3',
'argenta',
'ariana',
'aromalady-gen3', 'aromalady-gen3rs', 'aromalady',
'artist-gen4', 'artist',
'ash-alola', 'ash-hoenn', 'ash-kalos', 'ash-unova', 'ash-capbackward', 'ash-johto', 'ash-sinnoh', 'ash',
'backersf',
'backers',
'backpackerf',
'backpacker',
'baker',
'barry',
'battlegirl-gen3', 'battlegirl-gen4', 'battlegirl',
'beauty-gen1', 'beauty-gen1rb', 'beauty-gen2jp', 'beauty-gen2', 'beauty-gen3', 'beauty-gen3rs', 'beauty-gen4dp', 'beauty-gen5bw2', 'beauty',
'bellelba',
'bellepa',
'benga',
'bertha',
'bianca-pwt', 'bianca',
'biker-gen1', 'biker-gen1rb', 'biker-gen2', 'biker-gen3', 'biker-gen4', 'biker',
'bill-gen3',
'birch-gen3',
'birdkeeper-gen1', 'birdkeeper-gen1rb', 'birdkeeper-gen2', 'birdkeeper-gen3', 'birdkeeper-gen3rs', 'birdkeeper-gen4dp', 'birdkeeper',
'blackbelt-gen1', 'blackbelt-gen1rb', 'blackbelt-gen2', 'blackbelt-gen3', 'blackbelt-gen3rs', 'blackbelt-gen4dp', 'blackbelt-gen4', 'blackbelt',
'blaine-gen1', 'blaine-gen1rb', 'blaine-gen2', 'blaine-gen3', 'blaine',
'blue-gen1champion', 'blue-gen1', 'blue-gen1rbchampion', 'blue-gen1rb', 'blue-gen1rbtwo', 'blue-gen1two', 'blue-gen2', 'blue-gen3champion', 'blue-gen3', 'blue-gen3two', 'blue',
'boarder-gen2', 'boarder',
'brandon-gen3',
'brawly-gen3', 'brawly',
'brendan-gen3', 'brendan-gen3rs',
'brock-gen1', 'brock-gen1rb', 'brock-gen2', 'brock-gen3', 'brock',
'bruno-gen1', 'bruno-gen1rb', 'bruno-gen2', 'bruno-gen3', 'bruno',
'brycenman',
'brycen',
'buck',
'bugcatcher-gen1', 'bugcatcher-gen1rb', 'bugcatcher-gen2', 'bugcatcher-gen3', 'bugcatcher-gen3rs', 'bugcatcher-gen4dp', 'bugcatcher',
'bugmaniac-gen3',
'bugsy-gen2', 'bugsy',
'burgh',
'burglar-gen1', 'burglar-gen1rb', 'burglar-gen2', 'burglar-gen3', 'burglar',
'byron',
'caitlin',
'cameraman',
'camper-gen2', 'camper-gen3', 'camper-gen3rs', 'camper',
'candice',
'channeler-gen1', 'channeler-gen1rb', 'channeler-gen3',
'cheren-gen5bw2', 'cheren',
'cheryl',
'chili',
'chuck-gen2', 'chuck',
'cilan',
'clair-gen2', 'clair',
'clay',
'clemont',
'clerkf',
'clerk-boss', 'clerk',
'clown',
'collector-gen3', 'collector',
'colress',
'courtney-gen3',
'cowgirl',
'crasherwake',
'cress',
'crushgirl-gen3',
'crushkin-gen3',
'cueball-gen1', 'cueball-gen1rb', 'cueball-gen3',
'cyclistf-gen4', 'cyclistf',
'cyclist-gen4', 'cyclist',
'cynthia-gen4', 'cynthia',
'cyrus',
'dahlia',
'daisy-gen3',
'dancer',
'darach',
'dawn-gen4pt', 'dawn',
'depotagent',
'doctor',
'doubleteam',
'dragontamer-gen3', 'dragontamer',
'drake-gen3',
'drayden',
'elesa-gen5bw2', 'elesa',
'emmet',
'engineer-gen1', 'engineer-gen1rb', 'engineer-gen3',
'erika-gen1', 'erika-gen1rb', 'erika-gen2', 'erika-gen3', 'erika',
'ethan-gen2c', 'ethan-gen2', 'ethan-pokeathlon', 'ethan',
'eusine-gen2', 'eusine',
'expertf-gen3',
'expert-gen3',
'falkner-gen2',
'falkner',
'fantina',
'firebreather-gen2',
'firebreather',
'fisherman-gen1', 'fisherman-gen1rb', 'fisherman-gen2jp', 'fisherman-gen3', 'fisherman-gen3rs', 'fisherman-gen4', 'fisherman',
'flannery-gen3', 'flannery',
'flint',
'galacticgruntf',
'galacticgrunt',
'gambler-gen1', 'gambler-gen1rb', 'gambler',
'gamer-gen3',
'gardenia',
'gentleman-gen1', 'gentleman-gen1rb', 'gentleman-gen2', 'gentleman-gen3', 'gentleman-gen3rs', 'gentleman-gen4dp', 'gentleman-gen4', 'gentleman',
'ghetsis-gen5bw', 'ghetsis',
'giovanni-gen1', 'giovanni-gen1rb', 'giovanni-gen3', 'giovanni',
'glacia-gen3',
'greta-gen3',
'grimsley',
'guitarist-gen2', 'guitarist-gen3', 'guitarist-gen4', 'guitarist',
'harlequin',
'hexmaniac-gen3jp', 'hexmaniac-gen3',
'hiker-gen1', 'hiker-gen1rb', 'hiker-gen2', 'hiker-gen3', 'hiker-gen3rs', 'hiker-gen4', 'hiker',
'hilbert-wonderlauncher', 'hilbert',
'hilda-wonderlauncher', 'hilda',
'hooligans',
'hoopster',
'hugh',
'idol',
'infielder',
'ingo',
'interviewers-gen3',
'interviewers',
'iris-gen5bw2', 'iris',
'janine-gen2', 'janine',
'janitor',
'jasmine-gen2', 'jasmine',
'jessiejames-gen1',
'jogger',
'jrtrainerf-gen1', 'jrtrainerf-gen1rb',
'jrtrainer-gen1', 'jrtrainer-gen1rb',
'juan-gen3',
'juan',
'juggler-gen1', 'juggler-gen1rb', 'juggler-gen2', 'juggler-gen3', 'juggler',
'jupiter',
'karen-gen2', 'karen',
'kimonogirl-gen2', 'kimonogirl',
'kindler-gen3',
'koga-gen1', 'koga-gen2', 'koga-gen1rb', 'koga-gen3', 'koga',
'kris-gen2',
'lady-gen3', 'lady-gen3rs', 'lady-gen4', 'lady',
'lance-gen1', 'lance-gen1rb', 'lance-gen2', 'lance-gen3', 'lance',
'lass-gen1', 'lass-gen1rb', 'lass-gen2', 'lass-gen3', 'lass-gen3rs', 'lass-gen4dp', 'lass-gen4', 'lass',
'leaf-gen3',
'lenora',
'linebacker',
'li',
'liza',
'lorelei-gen1', 'lorelei-gen1rb', 'lorelei-gen3',
'ltsurge-gen1', 'ltsurge-gen1rb', 'ltsurge-gen2', 'ltsurge-gen3', 'ltsurge',
'lucas-gen4pt', 'lucas',
'lucian',
'lucy-gen3',
'lyra-pokeathlon', 'lyra',
'madame-gen4dp', 'madame-gen4', 'madame',
'maid-gen4', 'maid',
'marley',
'marlon',
'marshal',
'mars',
'matt-gen3',
'maxie-gen3',
'may-gen3', 'may-gen3rs',
'maylene',
'medium-gen2jp', 'medium',
'mira',
'misty-gen1', 'misty-gen2', 'misty-gen1rb', 'misty-gen3', 'misty',
'morty-gen2', 'morty',
'mrfuji-gen3',
'musician',
'nate-wonderlauncher', 'nate',
'ninjaboy-gen3', 'ninjaboy',
'noland-gen3',
'norman-gen3', 'norman',
'n',
'nurse',
'nurseryaide',
'oak-gen1', 'oak-gen1rb', 'oak-gen2', 'oak-gen3',
'officer-gen2',
'oldcouple-gen3',
'painter-gen3',
'palmer',
'parasollady-gen3', 'parasollady-gen4', 'parasollady',
'petrel',
'phoebe-gen3',
'picnicker-gen2', 'picnicker-gen3', 'picnicker-gen3rs', 'picnicker',
'pilot',
'plasmagruntf-gen5bw', 'plasmagruntf',
'plasmagrunt-gen5bw', 'plasmagrunt',
'pokefanf-gen2', 'pokefanf-gen3', 'pokefanf-gen4', 'pokefanf',
'pokefan-gen2', 'pokefan-gen3', 'pokefan-gen4', 'pokefan',
'pokekid',
'pokemaniac-gen1', 'pokemaniac-gen1rb', 'pokemaniac-gen2', 'pokemaniac-gen3', 'pokemaniac-gen3rs', 'pokemaniac',
'pokemonbreederf-gen3', 'pokemonbreederf-gen3frlg', 'pokemonbreederf-gen4', 'pokemonbreederf',
'pokemonbreeder-gen3', 'pokemonbreeder-gen4', 'pokemonbreeder',
'pokemonrangerf-gen3', 'pokemonrangerf-gen3rs', 'pokemonrangerf-gen4', 'pokemonrangerf',
'pokemonranger-gen3', 'pokemonranger-gen3rs', 'pokemonranger-gen4', 'pokemonranger',
'policeman-gen4', 'policeman',
'preschoolerf',
'preschooler',
'proton',
'pryce-gen2', 'pryce',
'psychicf-gen3', 'psychicf-gen3rs', 'psychicf-gen4', 'psychicfjp-gen3', 'psychicf',
'psychic-gen1', 'psychic-gen1rb', 'psychic-gen2', 'psychic-gen3', 'psychic-gen3rs', 'psychic-gen4', 'psychic',
'rancher',
'red-gen1main', 'red-gen1', 'red-gen1rb', 'red-gen1title', 'red-gen2', 'red-gen3', 'red',
'reporter',
'richboy-gen3', 'richboy-gen4', 'richboy',
'riley',
'roark',
'rocker-gen1', 'rocker-gen1rb', 'rocker-gen3',
'rocket-gen1', 'rocket-gen1rb',
'rocketgruntf-gen2', 'rocketgruntf',
'rocketgrunt-gen2', 'rocketgrunt',
'rocketexecutivef-gen2',
'rocketexecutive-gen2',
'rood',
'rosa-wonderlauncher', 'rosa',
'roughneck-gen4', 'roughneck',
'roxanne-gen3', 'roxanne',
'roxie',
'ruinmaniac-gen3', 'ruinmaniac-gen3rs', 'ruinmaniac',
'sabrina-gen1', 'sabrina-gen1rb', 'sabrina-gen2', 'sabrina-gen3', 'sabrina',
'sage-gen2', 'sage-gen2jp', 'sage',
'sailor-gen1', 'sailor-gen1rb', 'sailor-gen2', 'sailor-gen3jp', 'sailor-gen3', 'sailor-gen3rs', 'sailor',
'saturn',
'schoolboy-gen2',
'schoolkidf-gen3', 'schoolkidf-gen4', 'schoolkidf',
'schoolkid-gen3', 'schoolkid-gen4dp', 'schoolkid-gen4', 'schoolkid',
'scientistf',
'scientist-gen1', 'scientist-gen1rb', 'scientist-gen2', 'scientist-gen3', 'scientist-gen4dp', 'scientist-gen4', 'scientist',
'shadowtriad',
'shauntal',
'shelly-gen3',
'sidney-gen3',
'silver-gen2kanto', 'silver-gen2', 'silver',
'sisandbro-gen3', 'sisandbro-gen3rs', 'sisandbro',
'skierf-gen4dp', 'skierf',
'skier-gen2', 'skier',
'skyla',
'smasher',
'spenser-gen3',
'srandjr-gen3',
'steven-gen3', 'steven',
'striker',
'supernerd-gen1', 'supernerd-gen1rb', 'supernerd-gen2', 'supernerd-gen3', 'supernerd',
'swimmerf-gen2', 'swimmerf-gen3', 'swimmerf-gen3rs', 'swimmerf-gen4dp', 'swimmerf-gen4', 'swimmerfjp-gen2', 'swimmerf',
'swimmer-gen1', 'swimmer-gen1rb', 'swimmer-gen4dp', 'swimmer-gen4jp', 'swimmer-gen4', 'swimmerm-gen2', 'swimmerm-gen3', 'swimmerm-gen3rs', 'swimmer',
'tabitha-gen3',
'tamer-gen1', 'tamer-gen1rb', 'tamer-gen3',
'tateandliza-gen3',
'tate',
'teacher-gen2', 'teacher',
'teamaquabeta-gen3',
'teamaquagruntf-gen3',
'teamaquagruntm-gen3',
'teammagmagruntf-gen3',
'teammagmagruntm-gen3',
'teamrocketgruntf-gen3',
'teamrocketgruntm-gen3',
'teamrocket',
'thorton',
'triathletebikerf-gen3',
'triathletebikerm-gen3',
'triathleterunnerf-gen3',
'triathleterunnerm-gen3',
'triathleteswimmerf-gen3',
'triathleteswimmerm-gen3',
'tuberf-gen3', 'tuberf-gen3rs', 'tuberf',
'tuber-gen3', 'tuber',
'tucker-gen3',
'twins-gen2', 'twins-gen3', 'twins-gen3rs', 'twins-gen4dp', 'twins-gen4', 'twins',
'unknownf',
'unknown',
'veteranf',
'veteran-gen4', 'veteran',
'volkner',
'waiter-gen4dp', 'waiter-gen4', 'waiter',
'waitress-gen4', 'waitress',
'wallace-gen3', 'wallace-gen3rs', 'wallace',
'wally-gen3',
'wattson-gen3', 'wattson',
'whitney-gen2', 'whitney',
'will-gen2', 'will',
'winona-gen3', 'winona',
'worker-gen4',
'workerice',
'worker',
'yellow',
'youngcouple-gen3', 'youngcouple-gen3rs', 'youngcouple-gen4dp', 'youngcouple',
'youngster-gen1', 'youngster-gen1rb', 'youngster-gen2', 'youngster-gen3', 'youngster-gen3rs', 'youngster-gen4', 'youngster-gen4dp', 'youngster',
'zinzolin',
]);
const avatarTableBeliot419 = new Set([
'acerola', 'aetheremployee', 'aetheremployeef', 'aetherfoundation', 'aetherfoundationf', 'anabel',
'beauty-gen7', 'blue-gen7', 'burnet', 'colress-gen7', 'dexio', 'elio', 'faba', 'gladion-stance',
'gladion', 'grimsley-gen7', 'hapu', 'hau-stance', 'hau', 'hiker-gen7', 'ilima', 'kahili', 'kiawe',
'kukui-stand', 'kukui', 'lana', 'lass-gen7', 'lillie-z', 'lillie', 'lusamine-nihilego', 'lusamine',
'mallow', 'mina', 'molayne', 'nanu', 'officeworker', 'olivia', 'plumeria', 'pokemonbreeder-gen7',
'pokemonbreederf-gen7', 'preschoolers', 'red-gen7', 'risingstar', 'risingstarf', 'ryuki',
'samsonoak', 'selene', 'sightseer', 'sina', 'sophocles', 'teacher-gen7', 'theroyal', 'wally',
'wicke', 'youngathlete', 'youngathletef', 'youngster-gen7',
]);
const avatarTableGnomowladny = new Set([
'az', 'brawly-gen6', 'bryony', 'drasna', 'evelyn', 'furisodegirl-black', 'furisodegirl-pink', 'guzma',
'hala', 'korrina', 'malva', 'nita', 'olympia', 'ramos', 'shelly', 'sidney', 'siebold', 'tierno',
'valerie', 'viola', 'wallace-gen6', 'wikstrom', 'winona-gen6', 'wulfric', 'xerosic', 'youngn', 'zinnia',
]);
for (const avatar of avatarTableBeliot419) avatarTable.add(avatar);
for (const avatar of avatarTableGnomowladny) avatarTable.add(avatar);
export const crqHandlers: {[k: string]: Chat.CRQHandler} = {
userdetails(target, user, trustable) {
if (target.length > 18) {
@ -541,63 +217,6 @@ export const commands: Chat.ChatCommands = {
`If none is given, defaults to current generation random battle.`,
],
avatar(target, room, user) {
if (!target) return this.parse(`${this.cmdToken}avatars`);
const parts = target.split(',');
let avatar = parts[0].toLowerCase().replace(/[^a-z0-9-]+/g, '');
let avatarIsValid = true;
if (!avatarTable.has(avatar)) {
const avatarNum = parseInt(avatar);
if (!avatarNum || avatarNum > 294 || avatarNum < 1) {
avatarIsValid = false;
} else {
avatar = '' + avatarNum;
}
}
const avatarsAuto = Config.customavatars || {};
const avatarsManual = Config.allowedavatars || {};
function customAvatarIsValid(userid: ID) {
if (avatarsAuto[userid] === avatar) {
return true;
}
if (avatarsAuto[userid] === '#' + avatar) {
avatar = '#' + avatar;
return true;
}
if (Object.hasOwnProperty.call(avatarsManual, '#' + avatar)) {
avatar = '#' + avatar;
}
if (Object.hasOwnProperty.call(avatarsManual, avatar)) {
if (avatarsManual[avatar].includes(userid)) {
return true;
}
}
return false;
}
avatarIsValid = avatarIsValid || [user.id, ...user.previousIDs].some(customAvatarIsValid);
if (!avatarIsValid) {
if (parts[1]) return false;
if (avatar.startsWith('#')) {
this.errorReply(this.tr`Access denied for custom avatar - make sure you're on the right account?`);
} else {
this.errorReply(this.tr`Invalid avatar.`);
}
return false;
}
user.avatar = avatar;
const avatarUrl = avatar.startsWith('#') ? `trainers-custom/${avatar.slice(1)}.png` : `trainers/${avatar}.png`;
if (!parts[1]) {
this.sendReply(`${this.tr`Avatar changed to:`}\n|raw|<img src="//${Config.routes.client}/sprites/${avatarUrl}" alt="${avatar}" width="80" height="80" class="pixelated" />`);
if (avatarTableBeliot419.has(avatar)) {
this.sendReply(`|raw|(${this.tr`Artist: `}<a href="https://www.deviantart.com/beliot419">Beliot419</a>)`);
}
}
},
avatarhelp: [`/avatar [avatar name or number] - Change your trainer sprite.`],
signout: 'logout',
logout(target, room, user) {
user.resetName();
@ -1874,75 +1493,66 @@ export const commands: Chat.ChatCommands = {
return;
}
const cmds = target.split(' ');
const getHelp = (namespace: Chat.AnnotatedChatCommands, cmds: string[]): boolean => {
const [cmd, ...subCmds] = cmds;
let namespace = Chat.commands;
let currentBestHelp: {help: string[] | Chat.AnnotatedChatHandler, for: string[]} | null = null;
for (const [i, cmd] of cmds.entries()) {
let nextNamespace = namespace[cmd];
if (typeof nextNamespace === 'string') {
const help = namespace[`${nextNamespace}help`];
if (Array.isArray(help) || typeof help === 'function') {
currentBestHelp = {
help, for: cmds.slice(0, i + 1),
};
if (subCmds.length) {
// more specific help first
const subNamespace = namespace[cmd];
if (typeof subNamespace === 'object' && !Array.isArray(subNamespace)) {
if (getHelp(subNamespace, subCmds)) {
return true;
}
}
nextNamespace = namespace[nextNamespace];
}
if (typeof nextNamespace === 'string') {
throw new Error(`Recursive alias in "${target}"`);
let help = namespace[`${cmd}help`];
if (typeof help === 'string') {
help = namespace[help];
}
if (Array.isArray(nextNamespace)) {
const command = cmds.slice(0, i + 1).join(' ');
this.sendReply(this.tr`'/${command}' is a help command.`);
return this.parse(`/${target}`);
if (!help && namespace !== Chat.commands && namespace['help']) {
help = namespace['help'];
}
if (!nextNamespace) {
const curHandler = namespace[cmd] as Chat.AnnotatedChatHandler;
const requiredPerm = curHandler?.requiredPermission || 'lock';
if (curHandler?.isPrivate && !user.can(requiredPerm as GlobalPermission)) {
throw new Chat.ErrorMessage(this.tr`The command '/${target}' does not exist.`);
}
if (typeof help === 'function') {
// If the help command is a function, parse it instead
this.run(help);
return true;
}
if (Array.isArray(help)) {
this.sendReply(help.map(line => this.tr(line)).join('\n'));
return true;
}
if (!curHandler) {
for (const g in Config.groups) {
const groupid = Config.groups[g].id;
if (new RegExp(`(global)?(un|de)?${groupid}`).test(target)) {
if (new RegExp(`(global)?(un|de)?${groupid}`).test(cmd)) {
return this.parse(`/help promote`);
}
if (new RegExp(`room(un|de)?${groupid}`).test(target)) {
if (new RegExp(`room(un|de)?${groupid}`).test(cmd)) {
return this.parse(`/help roompromote`);
}
}
return this.errorReply(this.tr`The command '/${target}' does not exist.`);
throw new Chat.ErrorMessage(this.tr`The command '/${target}' does not exist.`);
}
const help = namespace[`${cmd}help`];
if (Array.isArray(help) || typeof help === 'function') {
currentBestHelp = {
help, for: cmds.slice(0, i + 1),
};
if (cmd.endsWith('help')) {
this.sendReply(this.tr`'/${target}' is a help command.`);
return true;
}
if (typeof nextNamespace === 'function') break;
namespace = nextNamespace;
}
return false;
};
if (!currentBestHelp) {
return this.errorReply(this.tr`Could not find help for '/${target}'. Try /help for general help.`);
}
const closestHelp = currentBestHelp.for.join(' ');
if (currentBestHelp.for.length < cmds.length) {
this.errorReply(this.tr`Could not find help for '/${target}' - displaying help for '/${closestHelp}' instead`);
}
const curHandler = Chat.parseCommand(`/${closestHelp}`)?.handler;
const requiredPerm = curHandler?.requiredPermission || 'lock';
if (curHandler?.isPrivate && !user.can(requiredPerm as GlobalPermission)) {
return this.errorReply(this.tr`The command '/${target}' does not exist.`);
}
if (typeof currentBestHelp.help === 'function') {
// If the help command is a function, parse it instead
this.run(currentBestHelp.help);
} else if (Array.isArray(currentBestHelp.help)) {
this.sendReply(currentBestHelp.help.map(line => this.tr(line)).join('\n'));
if (!getHelp(Chat.commands, target.split(' '))) {
throw new Chat.ErrorMessage(this.tr`Could not find help for '/${target}'. Try /help for general help.`);
}
},
helphelp: [

View File

@ -1669,15 +1669,6 @@ export const commands: Chat.ChatCommands = {
},
bugshelp: [`/bugs - Links to the various bug reporting services.`],
avatars(target, room, user) {
if (!this.runBroadcast()) return;
this.sendReplyBox(`You can <button name="avatars">change your avatar</button> by clicking on it in the <button name="openOptions"><i class="fa fa-cog"></i> Options</button> menu in the upper right. Custom avatars are only obtainable by staff.`);
},
avatarshelp: [
`/avatars - Explains how to change avatars.`,
`!avatars - Show everyone that information. Requires: + % @ # &`,
],
optionbutton: 'optionsbutton',
optionsbutton(target, room, user) {
if (!this.runBroadcast()) return;

View File

@ -179,6 +179,10 @@ function isUsernameKnown(name: string) {
return false;
}
function isUsername(name: string) {
return /[A-Za-z0-9]/.test(name.charAt(0)) && /[A-Za-z]/.test(name) && !name.includes(',');
}
function isTrusted(userid: ID) {
if (globalAuth.has(userid)) return userid;
for (const room of Rooms.global.chatRooms) {
@ -1061,9 +1065,7 @@ export class User extends Chat.MessageContext {
this.registered = true;
if (!isMerge) this.tempGroup = globalAuth.get(this.id);
if (Config.customavatars && Config.customavatars[this.id]) {
this.avatar = Config.customavatars[this.id];
}
Users.Avatars?.handleLogin(this);
const groupInfo = Config.groups[this.tempGroup];
this.isStaff = !!(groupInfo && (groupInfo.lock || groupInfo.root));
@ -1701,8 +1703,10 @@ export const Users = {
getExact: getExactUser,
findUsers,
Auth,
Avatars: null as typeof import('./chat-commands/avatars').Avatars | null,
globalAuth,
isUsernameKnown,
isUsername,
isTrusted,
SECTIONLEADER_SYMBOL,
PLAYER_SYMBOL,