galactic-bot/structure/extensions/Guild.js

266 lines
8.9 KiB
JavaScript
Raw Normal View History

2020-08-17 22:24:57 +02:00
const { Structures, WebhookClient } = require('discord.js');
const { Collection } = require('../../util');
2020-04-08 18:08:46 +02:00
2020-07-28 22:40:15 +02:00
const safeCommands = ['command:settings', 'command:grant', 'command:revoke'];
2020-04-08 18:08:46 +02:00
const Guild = Structures.extend('Guild', (Guild) => {
class ExtendedGuild extends Guild {
constructor(...args) {
super(...args);
this._settings = null; //internal cache of current guild's settings; should ALWAYS stay the same as database.
this._permissions = null; //internal cache, should always match database.
2020-06-04 19:59:09 +02:00
2020-05-24 23:43:47 +02:00
this.callbacks = [];
2020-06-18 16:07:39 +02:00
this.webhooks = new Collection();
2020-04-08 18:08:46 +02:00
2020-11-12 19:12:46 +01:00
this.invites = null;
}
async checkInvite(code) {
// Is maintained by the utility hook
if (!this.invites && this.me.hasPermission('MANAGE_GUILD')) this.invites = await this.fetchInvites();
return this.invites?.has(code) || false;
2020-04-08 18:08:46 +02:00
}
2020-11-12 19:12:46 +01:00
2020-05-07 17:08:07 +02:00
//Fetch and cache settings
2020-04-19 10:27:13 +02:00
async settings() {
if(!this._settings) this._settings = this.client.storageManager.mongodb.guilds.findOne({ guildId: this.id });
if(this._settings instanceof Promise) this._settings = await this._settings || null;
2020-07-28 05:00:24 +02:00
if(!this._settings) this._settings = { guildId: this.id, ...this.defaultConfig };
// else this._settings = Object.assign({}, { ...this.defaultConfig, ...this._settings }); //eslint-disable-line prefer-object-spread
else this._settings = { ...this.defaultConfig, ...this._settings }; //eslint-disable-line prefer-object-spread
2020-04-19 10:27:13 +02:00
return this._settings;
}
2020-04-19 10:27:13 +02:00
2020-05-07 17:08:07 +02:00
//Fetch and cache perms
async permissions() {
if(!this._permissions) this._permissions = this.client.storageManager.mongodb.permissions.findOne({ guildId: this.id });
if(this._permissions instanceof Promise) this._permissions = await this._permissions || null;
if(!this._permissions) this._permissions = { guildId: this.id };
return this._permissions;
2020-04-19 10:27:13 +02:00
}
2020-04-19 12:12:10 +02:00
2020-06-04 19:59:09 +02:00
async caseId() {
if(!this._settings) await this.settings();
return this._caseId = this._settings.caseId; //eslint-disable-line no-return-assign
}
2020-08-17 22:24:57 +02:00
/**
* Update a webhook entry in the database
*
* @param {string} feature Which feature webhook to update, e.g. messagelog
* @param {Webhook} hook The webhook object, omitting this will nullify the hook data
* @memberof ExtendedGuild
*/
async updateWebhook(feature, hook) {
if (!feature) return false;
if (!hook) {
this.client.logger.debug(`Removing webhook in ${this.name} (${this.id})`);
const hook = this.webhooks.get(feature);
if (hook) await hook.delete('Removing old webhook').catch((err) => {
if(err.code !== 10015) this.client.logger.error(err.stack);
});
this.webhooks.delete(feature);
return this.client.storage.mongodb.webhooks.deleteOne({ feature, guild: this.id });
}
this.webhooks.set(feature, hook);
return this.client.storage.mongodb.webhooks.updateOne({ feature, guild: this.id }, { hookID: hook.id, token: hook.token });
}
/**
* Retrieves a cached webhook for a feature if it exists, gets it from the database if not cached
*
* @param {string} feature The name of the feature, ex. messageLogs
2020-08-17 22:24:57 +02:00
* @returns {Webhook}
* @memberof ExtendedGuild
*/
async getWebhook(feature) {
if (!feature) return false;
if (this.webhooks.has(feature)) return this.webhooks.get(feature);
const result = await this.client.storage.mongodb.webhooks.findOne({ feature, guild: this.id });
if (!result) return false;
2021-06-11 03:22:04 +02:00
if (!this.me.hasPermission('MANAGE_WEBHOOKS')) return false;
const hooks = await this.fetchWebhooks();
const hook = hooks.get(result.hookID);
if (!hook) return false;
// const hook = new WebhookClient(result.hookID, result.token, {
// disableMentions: 'everyone'
// });
2020-08-17 22:24:57 +02:00
this.webhooks.set(feature, hook);
return hook;
}
/* Settings Wrapper */
async _deleteSettings() { //Delete whole entry - remove
try {
await this.client.storageManager.mongodb.guilds.deleteOne({ guildId: this.id });
2020-07-28 05:00:24 +02:00
this._settings = { ...{}, ...this.defaultConfig }; //Create a new object so settings that change the _settings value won't replicate it towards the defaultConfig.
this._storageLog(`Database Delete (guild:${this.id}).`);
} catch(error) {
this._storageError(error);
}
return true;
}
2020-07-20 00:42:21 +02:00
async _resetSettings() {
if(!this._settings) await this.settings();
try {
await this.client.storageManager.mongodb.guilds.updateOne(
{ guildId: this.id },
{ caseId: this._settings.caseId, guildId: this.id },
false //No upsert
);
2020-07-20 00:42:21 +02:00
this._settings = {
2020-07-28 05:00:24 +02:00
...this.defaultConfig,
...{ caseId: this._settings.caseId }
2020-07-20 00:42:21 +02:00
};
this._storageLog(`Database Reset (guild:${this.id}).`);
} catch(error) {
this._storageError(error);
}
}
async _updateSettings(data) { //Update property (upsert true) - updateOne
if(!this._settings) await this.settings();
try {
await this.client.storageManager.mongodb.guilds.updateOne(
{ guildId: this.id },
data
);
this._settings = {
...this._settings,
...data
};
this._storageLog(`Database Update (guild:${this.id}).`);
} catch(error) {
this._storageError(error);
}
return true;
}
async _removeSettings(value) { //Remove property
if(!this._settings) await this.settings();
2020-07-28 05:00:24 +02:00
if(this.defaultConfig[value]) {
await this._updateSettings({ [value]: this.defaultConfig[value] });
return undefined;
}
try {
await this.client.storageManager.mongodb.guilds.removeProperty(
{ guildId: this.id },
[ value ]
);
this._storageLog(`Database Remove (guild:${this.id}).`);
delete this._settings[value];
} catch(error) {
this._storageError(error);
}
return true;
2020-07-28 22:40:15 +02:00
}
/* Language Formatting */
2020-05-24 23:43:47 +02:00
format(index, parameters = {}, code = false) {
2020-04-19 21:54:50 +02:00
2020-05-24 23:43:47 +02:00
let language = 'en_us';
if (this._settings.locale) language = this._settings.locale;
2020-04-19 12:12:10 +02:00
2020-05-24 23:43:47 +02:00
parameters.prefix = this.prefix;
2020-09-19 17:37:46 +02:00
return this.client.format(language, index, parameters, code);
2020-05-24 23:43:47 +02:00
2020-04-19 12:12:10 +02:00
}
/* Resolver Shortcuts */
async resolveMembers(members, strict) {
2020-04-11 10:06:39 +02:00
return this.client.resolver.resolveMembers(members, strict, this);
}
async resolveMember(member, strict) {
return this.client.resolver.resolveMembers(member, strict, this);
2020-04-11 10:06:39 +02:00
}
2020-11-09 19:17:13 +01:00
async resolveChannels(channels, strict, filter) {
2020-04-11 10:06:39 +02:00
2020-11-09 19:17:13 +01:00
return this.client.resolver.resolveChannels(channels, strict, this, filter);
2020-04-11 10:06:39 +02:00
}
2020-11-09 19:17:13 +01:00
async resolveChannel(channel, strict, filter) {
2020-11-09 19:17:13 +01:00
return this.client.resolver.resolveChannel(channel, strict, this, filter);
}
async resolveRoles(roles, strict) {
2020-04-11 10:06:39 +02:00
return this.client.resolver.resolveRoles(roles, strict, this);
2020-04-11 10:06:39 +02:00
}
async resolveRole(role, strict) {
2020-05-22 22:13:47 +02:00
return this.client.resolver.resolveRole(role, strict, this);
}
/* Logging */
_storageLog(log) {
2020-05-07 17:08:07 +02:00
this.client.logger.debug(log);
}
_storageError(error) {
2020-05-07 17:08:07 +02:00
this.client.logger.error(`Database Error (guild:${this.id}) : \n${error.stack || error}`);
}
_debugLog(log) {
this.client.logger.debug(`[${this.name}](${this.id}): ${log}`);
}
/* Lazy Developer Getters */
2020-07-28 05:00:24 +02:00
get defaultConfig() {
return JSON.parse(JSON.stringify(this.client.defaultConfig('GUILD')));
2020-07-28 05:00:24 +02:00
}
get prefix() {
2020-05-24 05:50:35 +02:00
return this._settings.prefix
|| this.client._options.bot.prefix;
}
get premium() { //GUILD SETTINGS MUST BE FETCHED
return this._settings.premium;
}
get debug() { //GUILD SETTINGS MUST BE FETCHED
return this._settings.debug;
}
2020-04-08 18:08:46 +02:00
}
return ExtendedGuild;
});
module.exports = Guild;