3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-03-16 06:11:49 +00:00
zeppelin/src/plugins/Logs.ts

290 lines
8.2 KiB
TypeScript
Raw Normal View History

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";
import { LogType } from "../data/LogType";
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";
import DefaultLogMessages from "../data/DefaultLogMessages.json";
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";
interface ILogChannel {
include?: LogType[];
exclude?: LogType[];
}
interface ILogChannelMap {
[channelId: string]: ILogChannel;
}
const unknownUser = {
2018-07-29 18:46:49 +03:00
id: 0,
username: "Unknown",
discriminator: "0000"
2018-07-29 18:46:49 +03:00
};
export class LogsPlugin extends Plugin {
2018-07-29 18:46:49 +03:00
protected serverLogs: GuildLogs;
protected logListener;
getDefaultOptions() {
return {
config: {
channels: {},
format: {
timestamp: "HH:mm:ss",
...DefaultLogMessages
}
}
};
}
onLoad() {
2018-07-29 18:46:49 +03:00
this.serverLogs = new GuildLogs(this.guildId);
this.logListener = ({ type, data }) => this.log(type, data);
this.serverLogs.on("log", this.logListener);
}
onUnload() {
this.serverLogs.removeListener("log", this.logListener);
}
async log(type, data) {
const logChannels: ILogChannelMap = this.configValue("channels");
for (const [channelId, opts] of Object.entries(logChannels)) {
const channel = this.guild.channels.get(channelId);
if (!channel || !(channel instanceof TextChannel)) continue;
if (
(opts.include && opts.include.includes(type)) ||
(opts.exclude && !opts.exclude.includes(type))
) {
const message = this.getLogMessage(type, data);
if (message) await channel.createMessage(message);
}
}
}
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
});
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) {
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(
this.guild,
2018-07-29 18:46:49 +03:00
ErisConstants.AuditLogActions.MEMBER_BAN_ADD,
user.id
);
const mod = relevantAuditLogEntry ? relevantAuditLogEntry.user : unknownUser;
2018-07-29 18:46:49 +03:00
this.serverLogs.log(LogType.MEMBER_BAN, {
user: stripObjectToScalars(user),
mod: stripObjectToScalars(mod)
});
2018-07-29 18:46:49 +03:00
}
@d.event("guildBanRemove")
async onMemberUnban(_, user) {
const relevantAuditLogEntry = await findRelevantAuditLogEntry(
this.guild,
2018-07-29 18:46:49 +03:00
ErisConstants.AuditLogActions.MEMBER_BAN_REMOVE,
user.id
);
const mod = relevantAuditLogEntry ? relevantAuditLogEntry.user : unknownUser;
2018-07-29 18:46:49 +03:00
this.serverLogs.log(LogType.MEMBER_UNBAN, {
user: stripObjectToScalars(user),
mod: stripObjectToScalars(mod)
});
2018-07-29 18:46:49 +03:00
}
@d.event("guildMemberUpdate")
async onMemberUpdate(_, member: Member, oldMember: Member) {
2018-07-29 18:46:49 +03:00
if (!oldMember) return;
if (member.nick !== oldMember.nick) {
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)) {
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) {
this.serverLogs.log(LogType.MEMBER_ROLE_ADD, {
2018-07-29 18:46:49 +03:00
member,
role: this.guild.roles.get(addedRoles[0]),
mod: stripObjectToScalars(mod)
2018-07-29 18:46:49 +03:00
});
} else if (removedRoles.length) {
this.serverLogs.log(LogType.MEMBER_ROLE_REMOVE, {
2018-07-29 18:46:49 +03:00
member,
role: this.guild.roles.get(removedRoles[0]),
mod: stripObjectToScalars(mod)
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 };
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) {
this.serverLogs.log(LogType.CHANNEL_CREATE, {
2018-07-29 18:46:49 +03:00
channel: stripObjectToScalars(channel)
});
}
@d.event("channelDelete")
onChannelDelete(channel) {
this.serverLogs.log(LogType.CHANNEL_DELETE, {
2018-07-29 18:46:49 +03:00
channel: stripObjectToScalars(channel)
});
}
@d.event("guildRoleCreate")
onRoleCreate(_, role) {
this.serverLogs.log(LogType.ROLE_CREATE, {
2018-07-29 18:46:49 +03:00
role: stripObjectToScalars(role)
});
}
@d.event("guildRoleDelete")
onRoleDelete(_, role) {
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;
if (msg.type !== 0) return;
2018-07-29 18:46:49 +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),
before: oldMsg ? oldMsg.content || "" : "Unavailable due to restart",
after: msg.content || ""
2018-07-29 18:46:49 +03:00
});
}
@d.event("messageDelete")
onMessageDelete(msg: Message) {
if (msg.type !== 0) return;
if (msg.member) {
this.serverLogs.log(
LogType.MESSAGE_DELETE,
{
member: stripObjectToScalars(msg.member, ["user"]),
channel: stripObjectToScalars(msg.channel),
messageText: msg.cleanContent || ""
},
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[]) {
this.serverLogs.log(LogType.MESSAGE_DELETE_BULK, {
2018-07-29 18:46:49 +03:00
count: messages.length,
channel: messages[0] ? messages[0].channel : null
});
}
@d.event("voiceChannelJoin")
onVoiceChannelJoin(member: Member, channel: Channel) {
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) {
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")
onVoiceChannelSwitch(member: Member, newChannel: Channel, oldChannel: Channel) {
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)
});
}
}