import { Arg, BushConstants, Global, type BushClient, type BushInspectOptions, type BushMessage, type BushNewsChannel, type BushSlashEditMessageType, type BushSlashMessage, type BushSlashSendMessageType, type BushTextChannel, type BushUser, type BushUserResolvable, type CodeBlockLang, type Pronoun, type PronounCode } from '#lib'; import { humanizeDuration } from '@notenoughupdates/humanize-duration'; import { exec } from 'child_process'; import deepLock from 'deep-lock'; import { ClientUtil, Util as AkairoUtil } from 'discord-akairo'; import { APIMessage } from 'discord-api-types'; import { Constants as DiscordConstants, GuildMember, Message, MessageEmbed, ThreadMember, User, Util as DiscordUtil, type ColorResolvable, type CommandInteraction, type InteractionReplyOptions, type PermissionResolvable, type Snowflake, type TextChannel, type UserResolvable } from 'discord.js'; import got from 'got'; import _ from 'lodash'; import { inspect, promisify } from 'util'; import CommandErrorListener from '../../../listeners/commands/commandError.js'; import { Format } from '../../common/Format.js'; export class BushClientUtil extends ClientUtil { /** * The client. */ public declare readonly client: BushClient; /** * The hastebin urls used to post to hastebin, attempts to post in order */ #hasteURLs: string[] = [ 'https://hst.sh', // 'https://hasteb.in', 'https://hastebin.com', 'https://mystb.in', 'https://haste.clicksminuteper.net', 'https://paste.pythondiscord.com', 'https://haste.unbelievaboat.com' // 'https://haste.tyman.tech' ]; /** * Creates this client util * @param client The client to initialize with */ public constructor(client: BushClient) { super(client); } /** * Maps an array of user ids to user objects. * @param ids The list of IDs to map * @returns The list of users mapped */ public async mapIDs(ids: Snowflake[]): Promise { return await Promise.all(ids.map((id) => client.users.fetch(id))); } /** * Capitalizes the first letter of the given text * @param text The text to capitalize * @returns The capitalized text */ public capitalize(text: string): string { return text.charAt(0).toUpperCase() + text.slice(1); } /** * Runs a shell command and gives the output * @param command The shell command to run * @returns The stdout and stderr of the shell command */ public async shell(command: string): Promise<{ stdout: string; stderr: string; }> { return await promisify(exec)(command); } /** * Posts text to hastebin * @param content The text to post * @returns The url of the posted text */ public async haste(content: string, substr = false): Promise { let isSubstr = false; if (content.length > 400_000 && !substr) { void this.handleError('haste', new Error(`content over 400,000 characters (${content.length.toLocaleString()})`)); return { error: 'content too long' }; } else if (content.length > 400_000) { content = content.substring(0, 400_000); isSubstr = true; } for (const url of this.#hasteURLs) { try { const res: HastebinRes = await got.post(`${url}/documents`, { body: content }).json(); return { url: `${url}/${res.key}`, error: isSubstr ? 'substr' : undefined }; } catch { void client.console.error('haste', `Unable to upload haste to ${url}`); } } return { error: 'unable to post' }; } /** * Resolves a user-provided string into a user object, if possible * @param text The text to try and resolve * @returns The user resolved or null */ public async resolveUserAsync(text: string): Promise { const idReg = /\d{17,19}/; const idMatch = text.match(idReg); if (idMatch) { try { return await client.users.fetch(text as Snowflake); } catch { // pass } } const mentionReg = /<@!?(?\d{17,19})>/; const mentionMatch = text.match(mentionReg); if (mentionMatch) { try { return await client.users.fetch(mentionMatch.groups!.id as Snowflake); } catch { // pass } } const user = client.users.cache.find((u) => u.username === text); if (user) return user; return null; } /** * Appends the correct ordinal to the given number * @param n The number to append an ordinal to * @returns The number with the ordinal */ public ordinal(n: number): string { const s = ['th', 'st', 'nd', 'rd'], v = n % 100; return n + (s[(v - 20) % 10] || s[v] || s[0]); } /** * Chunks an array to the specified size * @param arr The array to chunk * @param perChunk The amount of items per chunk * @returns The chunked array */ public chunk(arr: T[], perChunk: number): T[][] { return arr.reduce((all, one, i) => { const ch: number = Math.floor(i / perChunk); (all as any[])[ch] = [].concat(all[ch] || [], one as any); return all; }, []); } /** * Commonly Used Colors */ get colors() { return client.consts.colors; } /** * Commonly Used Emojis */ get emojis() { return client.consts.emojis; } /** * A simple utility to create and embed with the needed style for the bot. * @param color The color to set the embed to. * @param author The author to set the embed to. * @returns The generated embed. */ public createEmbed(color?: ColorResolvable, author?: User | GuildMember): MessageEmbed { if (author instanceof GuildMember) { author = author.user; // Convert to User if GuildMember } let embed = new MessageEmbed().setTimestamp(); if (author) embed = embed.setAuthor({ name: author.username, iconURL: author.displayAvatarURL({ dynamic: true }), url: `https://discord.com/users/${author.id}` }); if (color) embed = embed.setColor(color); return embed; } /** * Fetches a user's uuid from the mojang api. * @param username The username to get the uuid of. * @returns The the uuid of the user. */ public async mcUUID(username: string, dashed = false): Promise { const apiRes = (await got.get(`https://api.ashcon.app/mojang/v2/user/${username}`).json()) as UuidRes; return dashed ? apiRes.uuid : apiRes.uuid.replace(/-/g, ''); } /** * Surrounds text in a code block with the specified language and puts it in a hastebin if its too long. * * Embed Description Limit = 4096 characters * * Embed Field Limit = 1024 characters * @param code The content of the code block. * @param length The maximum length of the code block. * @param language The language of the code. * @param substr Whether or not to substring the code if it is too long. * @returns The generated code block */ public async codeblock(code: string, length: number, language: CodeBlockLang | '' = '', substr = false): Promise { let hasteOut = ''; code = this.discord.escapeCodeBlock(code); const prefix = `\`\`\`${language}\n`; const suffix = '\n```'; if (code.length + (prefix + suffix).length >= length) { const haste = await this.haste(code, substr); hasteOut = `Too large to display. ${ haste.url ? `Hastebin: ${haste.url}${haste.error ? ` - ${haste.error}` : ''}` : `${this.emojis.error} Hastebin: ${haste.error}` }`; } const FormattedHaste = hasteOut.length ? `\n${hasteOut}` : ''; const shortenedCode = hasteOut ? code.substring(0, length - (prefix + FormattedHaste + suffix).length) : code; const code3 = code.length ? prefix + shortenedCode + suffix + FormattedHaste : prefix + suffix; if (code3.length > length) { void client.console.warn(`codeblockError`, `Required Length: ${length}. Actual Length: ${code3.length}`, true); void client.console.warn(`codeblockError`, code3, true); throw new Error('code too long'); } return code3; } /** * Uses {@link inspect} with custom defaults. * @param object - The object you would like to inspect. * @param options - The options you would like to use to inspect the object. * @returns The inspected object. */ public inspect(object: any, options?: BushInspectOptions): string { const optionsWithDefaults = this.getDefaultInspectOptions(options); return inspect(object, optionsWithDefaults); } /** * Generate defaults for {@link inspect}. * @param options The options to create defaults with. * @returns The default options combined with the specified options. */ private getDefaultInspectOptions(options?: BushInspectOptions): BushInspectOptions { const { showHidden = false, depth = 2, colors = false, customInspect = true, showProxy = false, maxArrayLength = Infinity, maxStringLength = Infinity, breakLength = 80, compact = 3, sorted = false, getters = true } = options ?? {}; return { showHidden, depth, colors, customInspect, showProxy, maxArrayLength, maxStringLength, breakLength, compact, sorted, getters }; } /** * Maps the key of a credential with a readable version when redacting. * @param key The key of the credential. * @returns The readable version of the key or the original key if there isn't a mapping. */ #mapCredential(key: string): string { const mapping = { token: 'Main Token', devToken: 'Dev Token', betaToken: 'Beta Token', hypixelApiKey: 'Hypixel Api Key', wolframAlphaAppId: 'Wolfram|Alpha App ID', dbPassword: 'Database Password' }; return mapping[key as keyof typeof mapping] || key; } /** * Redacts credentials from a string. * @param text The text to redact credentials from. * @returns The redacted text. */ public redact(text: string) { for (const credentialName in { ...client.config.credentials, dbPassword: client.config.db.password }) { const credential = { ...client.config.credentials, dbPassword: client.config.db.password }[ credentialName as keyof typeof client.config.credentials ]; const replacement = this.#mapCredential(credentialName); const escapeRegex = /[.*+?^${}()|[\]\\]/g; text = text.replace(new RegExp(credential.toString().replace(escapeRegex, '\\$&'), 'g'), `[${replacement} Omitted]`); text = text.replace( new RegExp([...credential.toString()].reverse().join('').replace(escapeRegex, '\\$&'), 'g'), `[${replacement} Omitted]` ); } return text; } /** * Takes an any value, inspects it, redacts credentials, and puts it in a codeblock * (and uploads to hast if the content is too long). * @param input The object to be inspect, redacted, and put into a codeblock. * @param language The language to make the codeblock. * @param inspectOptions The options for {@link BushClientUtil.inspect}. * @param length The maximum length that the codeblock can be. * @returns The generated codeblock. */ public async inspectCleanRedactCodeblock( input: any, language?: CodeBlockLang | '', inspectOptions?: BushInspectOptions & { inspectStrings?: boolean }, length = 1024 ) { input = !inspectOptions?.inspectStrings && typeof input === 'string' ? input : this.inspect(input, inspectOptions ?? undefined); if (inspectOptions) inspectOptions.inspectStrings = undefined; input = this.discord.cleanCodeBlockContent(input); input = this.redact(input); return this.codeblock(input, length, language, true); } /** * Takes an any value, inspects it, redacts credentials, and uploads it to haste. * @param input The object to be inspect, redacted, and upload. * @param inspectOptions The options for {@link BushClientUtil.inspect}. * @returns The {@link HasteResults}. */ public async inspectCleanRedactHaste(input: any, inspectOptions?: BushInspectOptions): Promise { input = typeof input !== 'string' ? this.inspect(input, inspectOptions ?? undefined) : input; input = this.redact(input); return this.haste(input, true); } /** * Takes an any value, inspects it and redacts credentials. * @param input The object to be inspect and redacted. * @param inspectOptions The options for {@link BushClientUtil.inspect}. * @returns The redacted and inspected object. */ public inspectAndRedact(input: any, inspectOptions?: BushInspectOptions): string { input = typeof input !== 'string' ? this.inspect(input, inspectOptions ?? undefined) : input; return this.redact(input); } /** * Responds to a slash command interaction. * @param interaction The interaction to respond to. * @param responseOptions The options for the response. * @returns The message sent. */ public async slashRespond( interaction: CommandInteraction, responseOptions: BushSlashSendMessageType | BushSlashEditMessageType ): Promise { const newResponseOptions = typeof responseOptions === 'string' ? { content: responseOptions } : responseOptions; if (interaction.replied || interaction.deferred) { delete (newResponseOptions as InteractionReplyOptions).ephemeral; // Cannot change a preexisting message to be ephemeral return (await interaction.editReply(newResponseOptions)) as Message | APIMessage; } else { await interaction.reply(newResponseOptions); return await interaction.fetchReply().catch(() => undefined); } } /** * Gets a a configured channel as a TextChannel. * @channel The channel to retrieve. */ public async getConfigChannel(channel: keyof typeof client['config']['channels']): Promise { return (await client.channels.fetch(client.config.channels[channel])) as unknown as TextChannel; } /** * Takes an array and combines the elements using the supplied conjunction. * @param array The array to combine. * @param conjunction The conjunction to use. * @param ifEmpty What to return if the array is empty. * @returns The combined elements or `ifEmpty`. * * @example * const permissions = oxford(['ADMINISTRATOR', 'SEND_MESSAGES', 'MANAGE_MESSAGES'], 'and', 'none'); * console.log(permissions); // ADMINISTRATOR, SEND_MESSAGES and MANAGE_MESSAGES */ public oxford(array: string[], conjunction: string, ifEmpty?: string): string | undefined { const l = array.length; if (!l) return ifEmpty; if (l < 2) return array[0]; if (l < 3) return array.join(` ${conjunction} `); array = array.slice(); array[l - 1] = `${conjunction} ${array[l - 1]}`; return array.join(', '); } /** * Add or remove an element from an array stored in the Globals database. * @param action Either `add` or `remove` an element. * @param key The key of the element in the global cache to update. * @param value The value to add/remove from the array. */ public async insertOrRemoveFromGlobal( action: 'add' | 'remove', key: K, value: typeof client['cache']['global'][K][0] ): Promise { const row = (await Global.findByPk(client.config.environment)) ?? (await Global.create({ environment: client.config.environment })); const oldValue: any[] = row[key]; const newValue = this.addOrRemoveFromArray(action, oldValue, value); row[key] = newValue; client.cache.global[key] = newValue; return await row.save().catch((e) => this.handleError('insertOrRemoveFromGlobal', e)); } /** * Updates an element in the Globals database. * @param key The key in the global cache to update. * @param value The value to set the key to. */ public async setGlobal( key: K, value: typeof client['cache']['global'][K] ): Promise { const row = (await Global.findByPk(client.config.environment)) ?? (await Global.create({ environment: client.config.environment })); row[key] = value; client.cache.global[key] = value; return await row.save().catch((e) => this.handleError('setGlobal', e)); } /** * Add or remove an item from an array. All duplicates will be removed. * @param action Either `add` or `remove` an element. * @param array The array to add/remove an element from. * @param value The element to add/remove from the array. */ public addOrRemoveFromArray(action: 'add' | 'remove', array: T[], value: T): T[] { const set = new Set(array); action === 'add' ? set.add(value) : set.delete(value); return [...set]; } /** * Surrounds a string to the begging an end of each element in an array. * @param array The array you want to surround. * @param surroundChar1 The character placed in the beginning of the element. * @param surroundChar2 The character placed in the end of the element. Defaults to `surroundChar1`. */ public surroundArray(array: string[], surroundChar1: string, surroundChar2?: string): string[] { return array.map((a) => `${surroundChar1}${a}${surroundChar2 ?? surroundChar1}`); } /** * Gets the duration from a specified string. * @param content The string to look for a duration in. * @param remove Whether or not to remove the duration from the original string. * @returns The {@link ParsedDuration}. */ public parseDuration(content: string, remove = true): ParsedDuration { if (!content) return { duration: 0, contentWithoutTime: null }; // eslint-disable-next-line prefer-const let duration = null; // Try to reduce false positives by requiring a space before the duration, this makes sure it still matches if it is // in the beginning of the argument let contentWithoutTime = ` ${content}`; for (const unit in BushConstants.TimeUnits) { const regex = BushConstants.TimeUnits[unit as keyof typeof BushConstants.TimeUnits].match; const match = regex.exec(contentWithoutTime); const value = Number(match?.groups?.[unit]); if (!isNaN(value)) (duration as unknown as number) += value * BushConstants.TimeUnits[unit as keyof typeof BushConstants.TimeUnits].value; if (remove) contentWithoutTime = contentWithoutTime.replace(regex, ''); } // remove the space added earlier if (contentWithoutTime.startsWith(' ')) contentWithoutTime.replace(' ', ''); return { duration, contentWithoutTime }; } /** * Converts a duration in milliseconds to a human readable form. * @param duration The duration in milliseconds to convert. * @param largest The maximum number of units to display for the duration. * @returns A humanized string of the duration. */ public humanizeDuration(duration: number, largest?: number): string { if (largest) return humanizeDuration(duration, { language: 'en', maxDecimalPoints: 2, largest })!; else return humanizeDuration(duration, { language: 'en', maxDecimalPoints: 2 })!; } /** * Creates a formatted relative timestamp from a duration in milliseconds. * @param duration The duration in milliseconds. * @returns The formatted relative timestamp. */ public timestampDuration(duration: number): string { return ``; } /** * Creates a timestamp from a date. * @param date The date to create a timestamp from. * @param style The style of the timestamp. * @returns The formatted timestamp. * * @see * **Styles:** * - **t**: Short Time * - **T**: Long Time * - **d**: Short Date * - **D**: Long Date * - **f**: Short Date/Time * - **F**: Long Date/Time * - **R**: Relative Time */ public timestamp( date: D, style: 't' | 'T' | 'd' | 'D' | 'f' | 'F' | 'R' = 'f' ): D extends Date ? string : undefined { if (!date) return date as unknown as D extends Date ? string : undefined; return `` as unknown as D extends Date ? string : undefined; } /** * Creates a human readable representation between a date and the current time. * @param date The date to be compared with the current time. * @param largest The maximum number of units to display for the duration. * @returns A humanized string of the delta. */ public dateDelta(date: Date, largest?: number): string { return this.humanizeDuration(new Date().getTime() - date.getTime(), largest ?? 3); } /** * Convert a hex code to an rbg value. * @param hex The hex code to convert. * @returns The rbg value. */ public hexToRgb(hex: string): string { const arrBuff = new ArrayBuffer(4); const vw = new DataView(arrBuff); vw.setUint32(0, parseInt(hex, 16), false); const arrByte = new Uint8Array(arrBuff); return `${arrByte[1]}, ${arrByte[2]}, ${arrByte[3]}`; } /* eslint-disable @typescript-eslint/no-unused-vars */ public async lockdownChannel(options: { channel: BushTextChannel | BushNewsChannel; moderator: BushUserResolvable }) { // todo: implement lockdowns } /* eslint-enable @typescript-eslint/no-unused-vars */ /** * Capitalize the first letter of a string. * @param string The string to capitalize the first letter of. * @returns The string with the first letter capitalized. */ public capitalizeFirstLetter(string: string): string { return string.charAt(0)?.toUpperCase() + string.slice(1); } /** * Wait an amount in seconds. * @param s The number of seconds to wait * @returns A promise that resolves after the specified amount of seconds */ public async sleep(s: number) { return new Promise((resolve) => setTimeout(resolve, s * 1000)); } /** * Send a message in the error logging channel and console for an error. * @param context * @param error */ public async handleError(context: string, error: Error) { await client.console.error(_.camelCase(context), `An error occurred:\n${error?.stack ?? (error as any)}`, false); await client.console.channelError({ embeds: [await CommandErrorListener.generateErrorEmbed({ type: 'unhandledRejection', error: error, context })] }); } public async resolveNonCachedUser(user: UserResolvable | undefined | null): Promise { if (!user) return undefined; const id = user instanceof User || user instanceof GuildMember || user instanceof ThreadMember ? user.id : user instanceof Message ? user.author.id : typeof user === 'string' ? user : undefined; if (!id) return undefined; else return await client.users.fetch(id).catch(() => undefined); } public async getPronounsOf(user: User | Snowflake): Promise { const _user = await this.resolveNonCachedUser(user); if (!_user) throw new Error(`Cannot find user ${user}`); const apiRes = (await got .get(`https://pronoundb.org/api/v1/lookup?platform=discord&id=${_user.id}`) .json() .catch(() => undefined)) as { pronouns: PronounCode } | undefined; if (!apiRes) return undefined; if (!apiRes.pronouns) throw new Error('apiRes.pronouns is undefined'); return client.constants.pronounMapping[apiRes.pronouns!]!; } public getMethods(obj: Record): string { // modified from https://stackoverflow.com/questions/31054910/get-functions-methods-of-a-class // answer by Bruno Grieder let props: string[] = []; let obj_: Record = new Object(obj); do { const l = Object.getOwnPropertyNames(obj_) .concat(Object.getOwnPropertySymbols(obj_).map((s) => s.toString())) .sort() .filter( (p, i, arr) => typeof Object.getOwnPropertyDescriptor(obj_, p)?.['get'] !== 'function' && // ignore getters typeof Object.getOwnPropertyDescriptor(obj_, p)?.['set'] !== 'function' && // ignore setters typeof obj_[p] === 'function' && //only the methods p !== 'constructor' && //not the constructor (i == 0 || p !== arr[i - 1]) && //not overriding in this prototype props.indexOf(p) === -1 //not overridden in a child ); const reg = /\(([\s\S]*?)\)/; props = props.concat( l.map( (p) => `${obj_[p] && obj_[p][Symbol.toStringTag] === 'AsyncFunction' ? 'async ' : ''}function ${p}(${ reg.exec(obj_[p].toString())?.[1] ? reg .exec(obj_[p].toString())?.[1] .split(', ') .map((arg) => arg.split('=')[0].trim()) .join(', ') : '' });` ) ); } while ( (obj_ = Object.getPrototypeOf(obj_)) && //walk-up the prototype chain Object.getPrototypeOf(obj_) //not the the Object prototype methods (hasOwnProperty, etc...) ); return props.join('\n'); } public async uploadImageToImgur(image: string) { const clientId = this.client.config.credentials.imgurClientId; const resp = (await got .post('https://api.imgur.com/3/upload', { headers: { // Authorization: `Bearer ${token}`, Authorization: `Client-ID ${clientId}`, Accept: 'application/json' }, form: { image: image, type: 'base64' }, followRedirect: true }) .json()) as { data: { link: string } }; return resp.data.link; } public userGuildPermCheck(message: BushMessage | BushSlashMessage, permissions: PermissionResolvable) { const missing = message.member?.permissions.missing(permissions) ?? []; return missing.length ? missing : null; } public clientGuildPermCheck(message: BushMessage | BushSlashMessage, permissions: PermissionResolvable) { const missing = message.guild?.me?.permissions.missing(permissions) ?? []; return missing.length ? missing : null; } public clientSendAndPermCheck( message: BushMessage | BushSlashMessage, permissions: PermissionResolvable = [], checkChannel = false ) { const missing = []; const sendPerm = message.channel!.isThread() ? 'SEND_MESSAGES' : 'SEND_MESSAGES_IN_THREADS'; if (!message.guild!.me!.permissionsIn(message.channel!.id!).has(sendPerm)) missing.push(sendPerm); missing.push( ...(checkChannel ? message.guild!.me!.permissionsIn(message.channel!.id!).missing(permissions) : this.clientGuildPermCheck(message, permissions) ?? []) ); return missing.length ? missing : null; } public prefix(message: BushMessage | BushSlashMessage): string { return message.util.isSlash ? '/' : client.config.isDevelopment ? 'dev ' : message.util.parsed?.prefix ?? client.config.prefix; } public get deepFreeze() { return deepLock; } public static get deepFreeze() { return deepLock; } public get arg() { return Arg; } /** * Formats and escapes content for formatting */ public get format() { return Format; } /** * Discord.js's Util class */ public get discord() { return DiscordUtil; } /** * Discord.js's Util constants */ public get discordConstants() { return DiscordConstants; } /** * discord-akairo's Util class */ public get akairo() { return AkairoUtil; } } interface HastebinRes { key: string; } export interface UuidRes { uuid: string; username: string; username_history?: { username: string }[] | null; textures: { custom: boolean; slim: boolean; skin: { url: string; data: string; }; raw: { value: string; signature: string; }; }; created_at: string; } export interface HasteResults { url?: string; error?: 'content too long' | 'substr' | 'unable to post'; } export interface ParsedDuration { duration: number | null; contentWithoutTime: string | null; }