2018-07-12 03:02:47 +03:00
|
|
|
import { decorators as d, Plugin } from "knub";
|
2018-07-29 18:46:49 +03:00
|
|
|
import { GuildLogs } from "../data/GuildLogs";
|
2018-07-09 02:48:36 +03:00
|
|
|
import { LogType } from "../data/LogType";
|
2018-07-30 01:44:03 +03:00
|
|
|
import { Channel, Constants as ErisConstants, Member, Message, TextChannel, User } from "eris";
|
2018-07-29 18:46:49 +03:00
|
|
|
import { findRelevantAuditLogEntry, formatTemplateString, stripObjectToScalars } from "../utils";
|
2018-07-12 03:02:13 +03:00
|
|
|
import DefaultLogMessages from "../data/DefaultLogMessages.json";
|
2018-07-12 02:58:34 +03:00
|
|
|
import moment from "moment-timezone";
|
2018-07-12 03:02:47 +03:00
|
|
|
import humanizeDuration from "humanize-duration";
|
2018-07-29 18:46:49 +03:00
|
|
|
import isEqual from "lodash.isequal";
|
|
|
|
import diff from "lodash.difference";
|
2018-07-09 02:48:36 +03:00
|
|
|
|
|
|
|
interface ILogChannel {
|
2018-07-31 20:23:33 +03:00
|
|
|
include?: string[];
|
|
|
|
exclude?: string[];
|
2018-07-09 02:48:36 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
interface ILogChannelMap {
|
|
|
|
[channelId: string]: ILogChannel;
|
|
|
|
}
|
|
|
|
|
2018-07-29 23:30:24 +03:00
|
|
|
const unknownUser = {
|
2018-07-29 18:46:49 +03:00
|
|
|
id: 0,
|
2018-07-29 23:30:24 +03:00
|
|
|
username: "Unknown",
|
|
|
|
discriminator: "0000"
|
2018-07-29 18:46:49 +03:00
|
|
|
};
|
|
|
|
|
2018-07-09 02:48:36 +03:00
|
|
|
export class LogsPlugin extends Plugin {
|
2018-07-29 18:46:49 +03:00
|
|
|
protected serverLogs: GuildLogs;
|
2018-07-09 02:48:36 +03:00
|
|
|
protected logListener;
|
|
|
|
|
|
|
|
getDefaultOptions() {
|
|
|
|
return {
|
|
|
|
config: {
|
|
|
|
channels: {},
|
|
|
|
format: {
|
|
|
|
timestamp: "HH:mm:ss",
|
2018-07-12 03:02:13 +03:00
|
|
|
...DefaultLogMessages
|
2018-07-09 02:48:36 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
onLoad() {
|
2018-07-29 18:46:49 +03:00
|
|
|
this.serverLogs = new GuildLogs(this.guildId);
|
2018-07-09 02:48:36 +03:00
|
|
|
|
|
|
|
this.logListener = ({ type, data }) => this.log(type, data);
|
|
|
|
this.serverLogs.on("log", this.logListener);
|
|
|
|
}
|
|
|
|
|
|
|
|
onUnload() {
|
|
|
|
this.serverLogs.removeListener("log", this.logListener);
|
|
|
|
}
|
|
|
|
|
2018-07-29 23:30:24 +03:00
|
|
|
async log(type, data) {
|
2018-07-09 02:48:36 +03:00
|
|
|
const logChannels: ILogChannelMap = this.configValue("channels");
|
2018-07-31 20:23:33 +03:00
|
|
|
const typeStr = LogType[type];
|
|
|
|
|
2018-07-09 02:48:36 +03:00
|
|
|
for (const [channelId, opts] of Object.entries(logChannels)) {
|
|
|
|
const channel = this.guild.channels.get(channelId);
|
|
|
|
if (!channel || !(channel instanceof TextChannel)) continue;
|
|
|
|
|
|
|
|
if (
|
2018-07-31 20:23:33 +03:00
|
|
|
(opts.include && opts.include.includes(typeStr)) ||
|
|
|
|
(opts.exclude && !opts.exclude.includes(typeStr))
|
2018-07-09 02:48:36 +03:00
|
|
|
) {
|
|
|
|
const message = this.getLogMessage(type, data);
|
2018-07-29 23:30:24 +03:00
|
|
|
if (message) await channel.createMessage(message);
|
2018-07-09 02:48:36 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
getLogMessage(type, data): string {
|
|
|
|
const format = this.configValue(`format.${LogType[type]}`, "");
|
|
|
|
if (format === "") return;
|
|
|
|
|
|
|
|
const formatted = formatTemplateString(format, data);
|
|
|
|
|
|
|
|
const timestampFormat = this.configValue("format.timestamp");
|
|
|
|
if (timestampFormat) {
|
|
|
|
const timestamp = moment().format(timestampFormat);
|
|
|
|
return `\`[${timestamp}]\` ${formatted}`;
|
|
|
|
} else {
|
|
|
|
return formatted;
|
|
|
|
}
|
|
|
|
}
|
2018-07-12 03:02:47 +03:00
|
|
|
|
|
|
|
@d.event("guildMemberAdd")
|
|
|
|
onMemberJoin(_, member) {
|
|
|
|
const newThreshold = moment().valueOf() - 1000 * 60 * 60;
|
|
|
|
const accountAge = humanizeDuration(moment().valueOf() - member.createdAt, {
|
|
|
|
largest: 2,
|
|
|
|
round: true
|
|
|
|
});
|
|
|
|
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.MEMBER_JOIN, {
|
2018-07-12 03:02:47 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"]),
|
|
|
|
new: member.createdAt >= newThreshold ? " :new:" : "",
|
|
|
|
account_age: accountAge
|
|
|
|
});
|
|
|
|
}
|
2018-07-29 18:46:49 +03:00
|
|
|
|
|
|
|
@d.event("guildMemberRemove")
|
|
|
|
onMemberLeave(_, member) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.MEMBER_LEAVE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"])
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("guildBanAdd")
|
|
|
|
async onMemberBan(_, user) {
|
|
|
|
const relevantAuditLogEntry = await findRelevantAuditLogEntry(
|
2018-07-29 23:30:24 +03:00
|
|
|
this.guild,
|
2018-07-29 18:46:49 +03:00
|
|
|
ErisConstants.AuditLogActions.MEMBER_BAN_ADD,
|
|
|
|
user.id
|
|
|
|
);
|
2018-07-29 23:30:24 +03:00
|
|
|
const mod = relevantAuditLogEntry ? relevantAuditLogEntry.user : unknownUser;
|
2018-07-29 18:46:49 +03:00
|
|
|
|
2018-07-31 04:02:45 +03:00
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MEMBER_BAN,
|
|
|
|
{
|
|
|
|
user: stripObjectToScalars(user),
|
|
|
|
mod: stripObjectToScalars(mod)
|
|
|
|
},
|
|
|
|
user.id
|
|
|
|
);
|
2018-07-29 18:46:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("guildBanRemove")
|
|
|
|
async onMemberUnban(_, user) {
|
|
|
|
const relevantAuditLogEntry = await findRelevantAuditLogEntry(
|
2018-07-29 23:30:24 +03:00
|
|
|
this.guild,
|
2018-07-29 18:46:49 +03:00
|
|
|
ErisConstants.AuditLogActions.MEMBER_BAN_REMOVE,
|
|
|
|
user.id
|
|
|
|
);
|
2018-07-29 23:30:24 +03:00
|
|
|
const mod = relevantAuditLogEntry ? relevantAuditLogEntry.user : unknownUser;
|
2018-07-29 18:46:49 +03:00
|
|
|
|
2018-07-31 04:02:45 +03:00
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MEMBER_UNBAN,
|
|
|
|
{
|
|
|
|
mod: stripObjectToScalars(mod),
|
|
|
|
userId: user.id
|
|
|
|
},
|
|
|
|
user.id
|
|
|
|
);
|
2018-07-29 18:46:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("guildMemberUpdate")
|
2018-07-29 23:30:24 +03:00
|
|
|
async onMemberUpdate(_, member: Member, oldMember: Member) {
|
2018-07-29 18:46:49 +03:00
|
|
|
if (!oldMember) return;
|
|
|
|
|
|
|
|
if (member.nick !== oldMember.nick) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.MEMBER_NICK_CHANGE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member,
|
2018-07-30 23:35:44 +03:00
|
|
|
oldNick: oldMember.nick || "<none>",
|
2018-07-29 18:46:49 +03:00
|
|
|
newNick: member.nick
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!isEqual(oldMember.roles, member.roles)) {
|
2018-07-29 23:30:24 +03:00
|
|
|
const addedRoles = diff(member.roles, oldMember.roles);
|
|
|
|
const removedRoles = diff(oldMember.roles, member.roles);
|
|
|
|
|
|
|
|
const relevantAuditLogEntry = await findRelevantAuditLogEntry(
|
|
|
|
this.guild,
|
|
|
|
ErisConstants.AuditLogActions.MEMBER_ROLE_UPDATE,
|
|
|
|
member.id
|
|
|
|
);
|
|
|
|
const mod = relevantAuditLogEntry ? relevantAuditLogEntry.user : unknownUser;
|
2018-07-29 18:46:49 +03:00
|
|
|
|
|
|
|
if (addedRoles.length) {
|
2018-07-31 02:42:45 +03:00
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MEMBER_ROLE_ADD,
|
|
|
|
{
|
|
|
|
member,
|
|
|
|
role: this.guild.roles.get(addedRoles[0]),
|
|
|
|
mod: stripObjectToScalars(mod)
|
|
|
|
},
|
|
|
|
member.id
|
|
|
|
);
|
2018-07-29 18:46:49 +03:00
|
|
|
} else if (removedRoles.length) {
|
2018-07-31 02:42:45 +03:00
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MEMBER_ROLE_REMOVE,
|
|
|
|
{
|
|
|
|
member,
|
|
|
|
role: this.guild.roles.get(removedRoles[0]),
|
|
|
|
mod: stripObjectToScalars(mod)
|
|
|
|
},
|
|
|
|
member.id
|
|
|
|
);
|
2018-07-29 18:46:49 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("userUpdate")
|
|
|
|
onUserUpdate(user: User, oldUser: User) {
|
|
|
|
if (!oldUser) return;
|
|
|
|
|
|
|
|
if (user.username !== oldUser.username || user.discriminator !== oldUser.discriminator) {
|
|
|
|
const member = this.guild.members.get(user.id) || { id: user.id, user };
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.MEMBER_USERNAME_CHANGE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"]),
|
|
|
|
oldName: `${oldUser.username}#${oldUser.discriminator}`,
|
|
|
|
newName: `${user.username}#${user.discriminator}`
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("channelCreate")
|
|
|
|
onChannelCreate(channel) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.CHANNEL_CREATE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
channel: stripObjectToScalars(channel)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("channelDelete")
|
|
|
|
onChannelDelete(channel) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.CHANNEL_DELETE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
channel: stripObjectToScalars(channel)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("guildRoleCreate")
|
2018-07-29 23:30:24 +03:00
|
|
|
onRoleCreate(_, role) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.ROLE_CREATE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
role: stripObjectToScalars(role)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("guildRoleDelete")
|
2018-07-29 23:30:24 +03:00
|
|
|
onRoleDelete(_, role) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.ROLE_DELETE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
role: stripObjectToScalars(role)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("messageUpdate")
|
|
|
|
onMessageUpdate(msg: Message, oldMsg: Message) {
|
|
|
|
if (oldMsg && msg.content === oldMsg.content) return;
|
2018-07-30 01:44:03 +03:00
|
|
|
if (msg.type !== 0) return;
|
2018-07-29 18:46:49 +03:00
|
|
|
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.MESSAGE_EDIT, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(msg.member, ["user"]),
|
|
|
|
channel: stripObjectToScalars(msg.channel),
|
2018-08-01 09:36:46 +03:00
|
|
|
before: oldMsg ? (oldMsg.cleanContent || oldMsg.content || "") : "Unavailable due to restart",
|
|
|
|
after: msg.cleanContent || msg.content || ""
|
2018-07-29 18:46:49 +03:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("messageDelete")
|
|
|
|
onMessageDelete(msg: Message) {
|
2018-07-31 02:42:45 +03:00
|
|
|
if (msg.type != null && msg.type !== 0) return;
|
2018-07-30 01:44:03 +03:00
|
|
|
|
|
|
|
if (msg.member) {
|
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MESSAGE_DELETE,
|
|
|
|
{
|
|
|
|
member: stripObjectToScalars(msg.member, ["user"]),
|
|
|
|
channel: stripObjectToScalars(msg.channel),
|
2018-08-01 09:36:46 +03:00
|
|
|
messageText: msg.cleanContent || msg.content || ""
|
2018-07-30 01:44:03 +03:00
|
|
|
},
|
|
|
|
msg.id
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MESSAGE_DELETE_BARE,
|
|
|
|
{
|
|
|
|
messageId: msg.id,
|
|
|
|
channel: stripObjectToScalars(msg.channel)
|
|
|
|
},
|
|
|
|
msg.id
|
|
|
|
);
|
|
|
|
}
|
2018-07-29 18:46:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("messageDeleteBulk")
|
|
|
|
onMessageDeleteBulk(messages: Message[]) {
|
2018-07-31 02:42:45 +03:00
|
|
|
this.serverLogs.log(
|
|
|
|
LogType.MESSAGE_DELETE_BULK,
|
|
|
|
{
|
|
|
|
count: messages.length,
|
|
|
|
channel: messages[0] ? messages[0].channel : null
|
|
|
|
},
|
|
|
|
messages[0] && messages[0].id
|
|
|
|
);
|
2018-07-29 18:46:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("voiceChannelJoin")
|
|
|
|
onVoiceChannelJoin(member: Member, channel: Channel) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.VOICE_CHANNEL_JOIN, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"]),
|
|
|
|
channel: stripObjectToScalars(channel)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("voiceChannelLeave")
|
|
|
|
onVoiceChannelLeave(member: Member, channel: Channel) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.VOICE_CHANNEL_LEAVE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"]),
|
|
|
|
channel: stripObjectToScalars(channel)
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
@d.event("voiceChannelSwitch")
|
2018-07-29 23:30:24 +03:00
|
|
|
onVoiceChannelSwitch(member: Member, newChannel: Channel, oldChannel: Channel) {
|
2018-07-30 01:44:03 +03:00
|
|
|
this.serverLogs.log(LogType.VOICE_CHANNEL_MOVE, {
|
2018-07-29 18:46:49 +03:00
|
|
|
member: stripObjectToScalars(member, ["user"]),
|
|
|
|
oldChannel: stripObjectToScalars(oldChannel),
|
|
|
|
newChannel: stripObjectToScalars(newChannel)
|
|
|
|
});
|
|
|
|
}
|
2018-07-09 02:48:36 +03:00
|
|
|
}
|