Merge pull request #80 from FivePixels/master

Optional confirmations, transcript sending, and a default topic.
This commit is contained in:
Isaac 2021-01-01 15:43:21 +00:00 committed by GitHub
commit 3e72dfda54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 195 additions and 148 deletions

View File

@ -78,53 +78,88 @@ module.exports = {
.setFooter(guild.name, guild.iconURL()) .setFooter(guild.name, guild.iconURL())
); );
let success;
let pre = fs.existsSync(paths.text) || fs.existsSync(paths.log)
? `You will be able to view an archived version later with \`${config.prefix}transcript ${ticket.id}\``
: '';
let confirm = await message.channel.send( if (config.commands.close.confirmation) {
new MessageEmbed() let success;
.setColor(config.colour) let pre = fs.existsSync(paths.text) || fs.existsSync(paths.log)
.setAuthor(message.author.username, message.author.displayAvatarURL()) ? `You will be able to view an archived version later with \`${config.prefix}transcript ${ticket.id}\``
.setTitle('❔ Are you sure?') : '';
.setDescription(`${pre}\n**React with ✅ to confirm.**`)
.setFooter(guild.name + ' | Expires in 15 seconds', guild.iconURL())
);
await confirm.react('✅'); let confirm = await message.channel.send(
const collector = confirm.createReactionCollector(
(r, u) => r.emoji.name === '✅' && u.id === message.author.id, {
time: 15000
});
collector.on('collect', async () => {
let users = [];
if (channel.id !== message.channel.id) {
channel.send(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('**Ticket closed**')
.setDescription(`Ticket closed by ${message.author}`)
.setFooter(guild.name, guild.iconURL())
);
}
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed() new MessageEmbed()
.setColor(config.colour) .setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL()) .setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle(`✅ **Ticket ${ticket.id} closed**`) .setTitle('❔ Are you sure?')
.setDescription('The channel will be automatically deleted in a few seconds, once the contents have been archived.') .setDescription(`${pre}\n**React with ✅ to confirm.**`)
.setFooter(guild.name, guild.iconURL()) .setFooter(guild.name + ' | Expires in 15 seconds', guild.iconURL())
); );
await confirm.react('✅');
const collector = confirm.createReactionCollector(
(r, u) => r.emoji.name === '✅' && u.id === message.author.id, {
time: 15000
});
collector.on('collect', async () => {
if (channel.id !== message.channel.id) {
channel.send(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('**Ticket closed**')
.setDescription(`Ticket closed by ${message.author}`)
.setFooter(guild.name, guild.iconURL())
);
}
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle(`✅ **Ticket ${ticket.id} closed**`)
.setDescription('The channel will be automatically deleted in a few seconds, once the contents have been archived.')
.setFooter(guild.name, guild.iconURL())
);
if (channel.id !== message.channel.id)
message.delete({
timeout: 5000
}).then(() => confirm.delete());
success = true;
close();
});
collector.on('end', () => {
if (!success) {
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.err_colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('❌ **Expired**')
.setDescription('You took too long to react; confirmation failed.')
.setFooter(guild.name, guild.iconURL()));
message.delete({
timeout: 10000
}).then(() => confirm.delete());
}
});
} else {
close();
}
async function close () {
let users = [];
if (config.transcripts.text.enabled || config.transcripts.web.enabled) { if (config.transcripts.text.enabled || config.transcripts.web.enabled) {
let u = await client.users.fetch(ticket.creator); let u = await client.users.fetch(ticket.creator);
if (u) { if (u) {
let dm; let dm;
try { try {
@ -133,7 +168,6 @@ module.exports = {
log.warn(`Could not create DM channel with ${u.tag}`); log.warn(`Could not create DM channel with ${u.tag}`);
} }
let res = {}; let res = {};
const embed = new MessageEmbed() const embed = new MessageEmbed()
.setColor(config.colour) .setColor(config.colour)
@ -162,7 +196,7 @@ module.exports = {
res.embed = embed; res.embed = embed;
try { try {
dm.send(res); if (config.commands.close.send_transcripts) dm.send(res);
if (config.transcripts.channel.length > 1) client.channels.cache.get(config.transcripts.channel).send(res); if (config.transcripts.channel.length > 1) client.channels.cache.get(config.transcripts.channel).send(res);
} catch (e) { } catch (e) {
message.channel.send('❌ Couldn\'t send DM or transcript log message'); message.channel.send('❌ Couldn\'t send DM or transcript log message');
@ -171,7 +205,6 @@ module.exports = {
} }
// update database // update database
success = true;
ticket.update({ ticket.update({
open: false open: false
}, { }, {
@ -180,13 +213,10 @@ module.exports = {
} }
}); });
// delete messages and channel // delete channel
setTimeout(() => { channel.delete({
channel.delete(); timeout: 5000
if (channel.id !== message.channel.id) });
message.delete()
.then(() => confirm.delete());
}, 5000);
log.info(`${message.author.tag} closed a ticket (#ticket-${ticket.id})`); log.info(`${message.author.tag} closed a ticket (#ticket-${ticket.id})`);
@ -205,26 +235,6 @@ module.exports = {
client.channels.cache.get(config.logs.discord.channel).send(embed); client.channels.cache.get(config.logs.discord.channel).send(embed);
} }
}); }
collector.on('end', () => {
if (!success) {
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.err_colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('❌ **Expired**')
.setDescription('You took too long to react; confirmation failed.')
.setFooter(guild.name, guild.iconURL()));
message.delete({
timeout: 10000
})
.then(() => confirm.delete());
}
});
} }
}; };

View File

@ -76,48 +76,80 @@ module.exports = {
.setFooter(guild.name, guild.iconURL()) .setFooter(guild.name, guild.iconURL())
); );
let success;
let confirm = await message.channel.send( if (config.commands.delete.confirmation) {
new MessageEmbed() let success;
.setColor(config.colour) let confirm = await message.channel.send(
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('❔ Are you sure?')
.setDescription(
`:warning: This action is **irreversible**, the ticket will be completely removed from the database.
You will **not** be able to view a transcript/archive of the channel later.
Use the \`close\` command instead if you don't want this behaviour.\n**React with ✅ to confirm.**`)
.setFooter(guild.name + ' | Expires in 15 seconds', guild.iconURL())
);
await confirm.react('✅');
const collector = confirm.createReactionCollector(
(r, u) => r.emoji.name === '✅' && u.id === message.author.id, {
time: 15000
});
collector.on('collect', async () => {
if (channel.id !== message.channel.id)
channel.send(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('**Ticket deleted**')
.setDescription(`Ticket deleted by ${message.author}`)
.setFooter(guild.name, guild.iconURL())
);
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed() new MessageEmbed()
.setColor(config.colour) .setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL()) .setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle(`✅ **Ticket ${ticket.id} deleted**`) .setTitle('❔ Are you sure?')
.setDescription('The channel will be automatically deleted in a few seconds.') .setDescription(
.setFooter(guild.name, guild.iconURL()) `:warning: This action is **irreversible**, the ticket will be completely removed from the database.
You will **not** be able to view a transcript/archive of the channel later.
Use the \`close\` command instead if you don't want this behaviour.\n**React with ✅ to confirm.**`)
.setFooter(guild.name + ' | Expires in 15 seconds', guild.iconURL())
); );
await confirm.react('✅');
const collector = confirm.createReactionCollector(
(r, u) => r.emoji.name === '✅' && u.id === message.author.id, {
time: 15000
});
collector.on('collect', async () => {
if (channel.id !== message.channel.id)
channel.send(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('**Ticket deleted**')
.setDescription(`Ticket deleted by ${message.author}`)
.setFooter(guild.name, guild.iconURL())
);
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle(`✅ **Ticket ${ticket.id} deleted**`)
.setDescription('The channel will be automatically deleted in a few seconds.')
.setFooter(guild.name, guild.iconURL())
);
if (channel.id !== message.channel.id)
message.delete({
timeout: 5000
}).then(() => confirm.delete());
success = true;
del();
});
collector.on('end', () => {
if (!success) {
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.err_colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('❌ **Expired**')
.setDescription('You took too long to react; confirmation failed.')
.setFooter(guild.name, guild.iconURL()));
message.delete({
timeout: 10000
}).then(() => confirm.delete());
}
});
} else {
del();
}
async function del () {
let txt = join(__dirname, `../../user/transcripts/text/${ticket.get('channel')}.txt`), let txt = join(__dirname, `../../user/transcripts/text/${ticket.get('channel')}.txt`),
raw = join(__dirname, `../../user/transcripts/raw/${ticket.get('channel')}.log`), raw = join(__dirname, `../../user/transcripts/raw/${ticket.get('channel')}.log`),
json = join(__dirname, `../../user/transcripts/raw/entities/${ticket.get('channel')}.json`); json = join(__dirname, `../../user/transcripts/raw/entities/${ticket.get('channel')}.json`);
@ -127,16 +159,13 @@ module.exports = {
if (fs.existsSync(json)) fs.unlinkSync(json); if (fs.existsSync(json)) fs.unlinkSync(json);
// update database // update database
success = true;
ticket.destroy(); // remove ticket from database ticket.destroy(); // remove ticket from database
// delete messages and channel // channel
setTimeout(() => { channel.delete({
channel.delete(); timeout: 5000
if (channel.id !== message.channel.id) });
message.delete()
.then(() => confirm.delete());
}, 5000);
log.info(`${message.author.tag} deleted a ticket (#ticket-${ticket.id})`); log.info(`${message.author.tag} deleted a ticket (#ticket-${ticket.id})`);
@ -152,26 +181,7 @@ module.exports = {
.setTimestamp() .setTimestamp()
); );
} }
}); }
collector.on('end', () => {
if (!success) {
confirm.reactions.removeAll();
confirm.edit(
new MessageEmbed()
.setColor(config.err_colour)
.setAuthor(message.author.username, message.author.displayAvatarURL())
.setTitle('❌ **Expired**')
.setDescription('You took too long to react; confirmation failed.')
.setFooter(guild.name, guild.iconURL()));
message.delete({
timeout: 10000
})
.then(() => confirm.delete());
}
});
} }
}; };

View File

@ -26,7 +26,7 @@ module.exports = {
let cmds = []; let cmds = [];
for (let command of commands) { for (let command of commands) {
if (command.hide) continue; if (command.hide || command.disabled) continue;
if (command.permission && !message.member.hasPermission(command.permission)) continue; if (command.permission && !message.member.hasPermission(command.permission)) continue;
let desc = command.description; let desc = command.description;

View File

@ -11,6 +11,7 @@ const log = new Logger();
const { MessageEmbed } = require('discord.js'); const { MessageEmbed } = require('discord.js');
const fs = require('fs'); const fs = require('fs');
const { join } = require('path'); const { join } = require('path');
const config = require(join(__dirname, '../../user/', require('../').config));
module.exports = { module.exports = {
name: 'new', name: 'new',
@ -19,10 +20,16 @@ module.exports = {
aliases: ['ticket', 'open'], aliases: ['ticket', 'open'],
example: 'new my server won\'t start', example: 'new my server won\'t start',
args: false, args: false,
disabled: !config.commands.new.enabled,
async execute(client, message, args, {config, Ticket}) { async execute(client, message, args, {config, Ticket}) {
if (!config.commands.new.enabled) return; // stop if the command is disabled
const guild = client.guilds.cache.get(config.guild); const guild = client.guilds.cache.get(config.guild);
const supportRole = guild.roles.cache.get(config.staff_role); const supportRole = guild.roles.cache.get(config.staff_role);
if (!supportRole) if (!supportRole)
return message.channel.send( return message.channel.send(
new MessageEmbed() new MessageEmbed()
@ -66,7 +73,7 @@ module.exports = {
let topic = args.join(' '); let topic = args.join(' ');
if (topic.length > 256) if (topic.length > 256) {
return message.channel.send( return message.channel.send(
new MessageEmbed() new MessageEmbed()
.setColor(config.err_colour) .setColor(config.err_colour)
@ -75,7 +82,10 @@ module.exports = {
.setDescription('Please limit your ticket topic to less than 256 characters. A short sentence will do.') .setDescription('Please limit your ticket topic to less than 256 characters. A short sentence will do.')
.setFooter(guild.name, guild.iconURL()) .setFooter(guild.name, guild.iconURL())
); );
else if (topic.length < 1) topic = 'No topic given'; }
else if (topic.length < 1) {
topic = config.tickets.default_topic.command;
}
let ticket = await Ticket.create({ let ticket = await Ticket.create({
channel: '', channel: '',
@ -192,5 +202,6 @@ module.exports = {
}).catch(log.error); }).catch(log.error);
}, },
}; };

View File

@ -89,7 +89,7 @@ module.exports = {
} }
} }
let topic = 'No topic given (created via panel)'; let topic = config.tickets.default_topic.command;
let ticket = await Ticket.create({ let ticket = await Ticket.create({
channel: '', channel: '',

View File

@ -47,7 +47,6 @@ module.exports = {
colour: '#009999', colour: '#009999',
err_colour: 'RED', err_colour: 'RED',
cooldown: 3, cooldown: 3,
guild: '', // ID of your guild (REQUIRED) guild: '', // ID of your guild (REQUIRED)
staff_role: '', // ID of your Support Team role (REQUIRED) staff_role: '', // ID of your Support Team role (REQUIRED)
@ -59,7 +58,24 @@ module.exports = {
A member of staff will assist you shortly. A member of staff will assist you shortly.
In the mean time, please describe your issue in as much detail as possible! :)`, In the mean time, please describe your issue in as much detail as possible! :)`,
pin: false, pin: false,
max: 3 max: 3,
default_topic: {
command: 'No topic given',
panel: 'Created via panel'
}
},
commands: {
close: {
confirmation: true,
send_transcripts: true
},
delete: {
confirmation: true
},
new: {
enabled: true
},
}, },
transcripts: { transcripts: {