1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
|
import { Moderation, ModLogType, type BushClient, type BushGuild, type BushRole, type BushUser } from '#lib';
import { GuildMember, MessageEmbed, type Partialize, type Role } from 'discord.js';
import type { RawGuildMemberData } from 'discord.js/typings/rawDataTypes';
interface BushPunishmentOptions {
reason?: string | null;
moderator?: BushGuildMember;
evidence?: string;
}
interface BushTimedPunishmentOptions extends BushPunishmentOptions {
duration?: number;
}
interface AddRoleOptions extends BushTimedPunishmentOptions {
role: BushRole | Role;
addToModlog: boolean;
}
interface RemoveRoleOptions extends BushTimedPunishmentOptions {
role: BushRole | Role;
addToModlog: boolean;
}
type PunishmentResponse = 'success' | 'error creating modlog entry' | 'failed to dm';
type WarnResponse = PunishmentResponse;
type AddRoleResponse =
| PunishmentResponse
| 'user hierarchy'
| 'role managed'
| 'client hierarchy'
| 'error creating role entry'
| 'error adding role';
type RemoveRoleResponse =
| PunishmentResponse
| 'user hierarchy'
| 'role managed'
| 'client hierarchy'
| 'error removing role entry'
| 'error removing role';
type MuteResponse =
| PunishmentResponse
| 'missing permissions'
| 'no mute role'
| 'invalid mute role'
| 'mute role not manageable'
| 'error giving mute role'
| 'error creating mute entry';
type UnmuteResponse =
| PunishmentResponse
| 'missing permissions'
| 'no mute role'
| 'invalid mute role'
| 'mute role not manageable'
| 'error removing mute role'
| 'error removing mute entry';
type KickResponse = PunishmentResponse | 'missing permissions' | 'error kicking';
interface BushBanOptions extends BushTimedPunishmentOptions {
deleteDays?: number;
}
type BanResponse = PunishmentResponse | 'missing permissions' | 'error creating ban entry' | 'error banning';
export type PartialBushGuildMember = Partialize<
BushGuildMember,
'joinedAt' | 'joinedTimestamp',
'warn' | 'addRole' | 'removeRole' | 'mute' | 'unmute' | 'bushKick' | 'bushBan' | 'isOwner' | 'isSuperUser'
>;
export class BushGuildMember extends GuildMember {
public declare readonly client: BushClient;
public declare guild: BushGuild;
public declare user: BushUser;
public constructor(client: BushClient, data: RawGuildMemberData, guild: BushGuild) {
super(client, data, guild);
}
public async punishDM(punishment: string, reason?: string | null, duration?: number, sendFooter = true): Promise<boolean> {
const ending = await this.guild.getSetting('punishmentEnding');
const dmEmbed =
ending && ending.length && sendFooter
? new MessageEmbed().setDescription(ending).setColor(util.colors.newBlurple)
: undefined;
const dmSuccess = await this.send({
content: `You have been ${punishment} in **${this.guild.name}** ${
duration !== null && duration !== undefined ? (duration ? `for ${util.humanizeDuration(duration)} ` : 'permanently ') : ''
}for **${reason?.trim() ?? 'No reason provided'}**.`,
embeds: dmEmbed ? [dmEmbed] : undefined
}).catch(() => false);
return !!dmSuccess;
}
public async warn(options: BushPunishmentOptions): Promise<{ result: WarnResponse | null; caseNum: number | null }> {
let caseID: string | undefined = undefined;
let dmSuccessEvent: boolean | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
// add modlog entry
const result = await Moderation.createModLogEntry(
{
type: ModLogType.WARN,
user: this,
moderator: moderator.id,
reason: options.reason,
guild: this.guild,
evidence: options.evidence
},
true
);
caseID = result.log?.id;
if (!result || !result.log) return { result: 'error creating modlog entry', caseNum: null };
// dm user
const dmSuccess = await this.punishDM('warned', options.reason);
dmSuccessEvent = dmSuccess;
if (!dmSuccess) return { result: 'failed to dm', caseNum: result.caseNum };
return { result: 'success', caseNum: result.caseNum };
})();
if (!['error creating modlog entry'].includes(ret.result))
client.emit('bushWarn', this, moderator, this.guild, options.reason ?? undefined, caseID!, dmSuccessEvent!);
return ret as { result: WarnResponse | null; caseNum: number | null };
}
public async addRole(options: AddRoleOptions): Promise<AddRoleResponse> {
const ifShouldAddRole = this.#checkIfShouldAddRole(options.role, options.moderator);
if (ifShouldAddRole !== true) return ifShouldAddRole;
let caseID: string | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
if (options.addToModlog || options.duration) {
const { log: modlog } = await Moderation.createModLogEntry({
type: options.duration ? ModLogType.TEMP_PUNISHMENT_ROLE : ModLogType.PERM_PUNISHMENT_ROLE,
guild: this.guild,
moderator: moderator.id,
user: this,
reason: 'N/A',
pseudo: !options.addToModlog,
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
if (options.addToModlog || options.duration) {
const punishmentEntrySuccess = await Moderation.createPunishmentEntry({
type: 'role',
user: this,
guild: this.guild,
modlog: modlog.id,
duration: options.duration,
extraInfo: options.role.id
});
if (!punishmentEntrySuccess) return 'error creating role entry';
}
}
const removeRoleSuccess = await this.roles.add(options.role, `${moderator.tag}`);
if (!removeRoleSuccess) return 'error adding role';
return 'success';
})();
if (!['error adding role', 'error creating modlog entry', 'error creating role entry'].includes(ret) && options.addToModlog)
client.emit(
'bushPunishRole',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
options.duration ?? 0,
options.role as BushRole,
options.evidence
);
return ret;
}
public async removeRole(options: RemoveRoleOptions): Promise<RemoveRoleResponse> {
const ifShouldAddRole = this.#checkIfShouldAddRole(options.role, options.moderator);
if (ifShouldAddRole !== true) return ifShouldAddRole;
let caseID: string | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
if (options.addToModlog) {
const { log: modlog } = await Moderation.createModLogEntry({
type: ModLogType.REMOVE_PUNISHMENT_ROLE,
guild: this.guild,
moderator: moderator.id,
user: this,
reason: 'N/A',
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
const punishmentEntrySuccess = await Moderation.removePunishmentEntry({
type: 'role',
user: this,
guild: this.guild,
extraInfo: options.role.id
});
if (!punishmentEntrySuccess) return 'error removing role entry';
}
const removeRoleSuccess = await this.roles.remove(options.role, `${moderator.tag}`);
if (!removeRoleSuccess) return 'error removing role';
return 'success';
})();
if (!['error removing role', 'error creating modlog entry', 'error removing role entry'].includes(ret) && options.addToModlog)
client.emit(
'bushPunishRoleRemove',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
options.role as BushRole,
options.evidence
);
return ret;
}
#checkIfShouldAddRole(
role: BushRole | Role,
moderator?: BushGuildMember
): true | 'user hierarchy' | 'role managed' | 'client hierarchy' {
if (moderator && moderator.roles.highest.position <= role.position /* && this.guild.ownerId !== this.id */) {
client.console.debug(`${this.roles.highest.position} <= ${role.position}`);
return 'user hierarchy';
} else if (role.managed) {
return 'role managed';
} else if (this.guild.me!.roles.highest.position <= role.position) {
return 'client hierarchy';
}
return true;
}
public async mute(options: BushTimedPunishmentOptions): Promise<MuteResponse> {
// checks
if (!this.guild.me!.permissions.has('MANAGE_ROLES')) return 'missing permissions';
const muteRoleID = await this.guild.getSetting('muteRole');
if (!muteRoleID) return 'no mute role';
const muteRole = this.guild.roles.cache.get(muteRoleID);
if (!muteRole) return 'invalid mute role';
if (muteRole.position >= this.guild.me!.roles.highest.position || muteRole.managed) return 'mute role not manageable';
let caseID: string | undefined = undefined;
let dmSuccessEvent: boolean | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
// add role
const muteSuccess = await this.roles
.add(muteRole, `[Mute] ${moderator.tag} | ${options.reason ?? 'No reason provided.'}`)
.catch(async (e) => {
await client.console.warn('muteRoleAddError', e);
client.console.debug(e);
return false;
});
if (!muteSuccess) return 'error giving mute role';
// add modlog entry
const { log: modlog } = await Moderation.createModLogEntry({
type: options.duration ? ModLogType.TEMP_MUTE : ModLogType.PERM_MUTE,
user: this,
moderator: moderator.id,
reason: options.reason,
duration: options.duration,
guild: this.guild,
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
// add punishment entry so they can be unmuted later
const punishmentEntrySuccess = await Moderation.createPunishmentEntry({
type: 'mute',
user: this,
guild: this.guild,
duration: options.duration,
modlog: modlog.id
});
if (!punishmentEntrySuccess) return 'error creating mute entry';
// dm user
const dmSuccess = await this.punishDM('muted', options.reason, options.duration ?? 0);
dmSuccessEvent = dmSuccess;
if (!dmSuccess) return 'failed to dm';
return 'success';
})();
if (!['error giving mute role', 'error creating modlog entry', 'error creating mute entry'].includes(ret))
client.emit(
'bushMute',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
options.duration ?? 0,
dmSuccessEvent!,
options.evidence
);
return ret;
}
public async unmute(options: BushPunishmentOptions): Promise<UnmuteResponse> {
//checks
if (!this.guild.me!.permissions.has('MANAGE_ROLES')) return 'missing permissions';
const muteRoleID = await this.guild.getSetting('muteRole');
if (!muteRoleID) return 'no mute role';
const muteRole = this.guild.roles.cache.get(muteRoleID);
if (!muteRole) return 'invalid mute role';
if (muteRole.position >= this.guild.me!.roles.highest.position || muteRole.managed) return 'mute role not manageable';
let caseID: string | undefined = undefined;
let dmSuccessEvent: boolean | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
//remove role
const muteSuccess = await this.roles
.remove(muteRole, `[Unmute] ${moderator.tag} | ${options.reason ?? 'No reason provided.'}`)
.catch(async (e) => {
await client.console.warn('muteRoleAddError', e?.stack || e);
return false;
});
if (!muteSuccess) return 'error removing mute role';
//remove modlog entry
const { log: modlog } = await Moderation.createModLogEntry({
type: ModLogType.UNMUTE,
user: this,
moderator: moderator.id,
reason: options.reason,
guild: this.guild,
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
// remove mute entry
const removePunishmentEntrySuccess = await Moderation.removePunishmentEntry({
type: 'mute',
user: this,
guild: this.guild
});
if (!removePunishmentEntrySuccess) return 'error removing mute entry';
//dm user
const dmSuccess = await this.punishDM('unmuted', options.reason, undefined, false);
dmSuccessEvent = dmSuccess;
if (!dmSuccess) return 'failed to dm';
return 'success';
})();
if (!['error removing mute role', 'error creating modlog entry', 'error removing mute entry'].includes(ret))
client.emit(
'bushUnmute',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
dmSuccessEvent!,
options.evidence
);
return ret;
}
public async bushKick(options: BushPunishmentOptions): Promise<KickResponse> {
// checks
if (!this.guild.me?.permissions.has('KICK_MEMBERS') || !this.kickable) return 'missing permissions';
let caseID: string | undefined = undefined;
let dmSuccessEvent: boolean | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
// dm user
const dmSuccess = await this.punishDM('kicked', options.reason);
dmSuccessEvent = dmSuccess;
// kick
const kickSuccess = await this.kick(`${moderator?.tag} | ${options.reason ?? 'No reason provided.'}`).catch(() => false);
if (!kickSuccess) return 'error kicking';
// add modlog entry
const { log: modlog } = await Moderation.createModLogEntry({
type: ModLogType.KICK,
user: this,
moderator: moderator.id,
reason: options.reason,
guild: this.guild,
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
if (!dmSuccess) return 'failed to dm';
return 'success';
})();
if (!['error kicking', 'error creating modlog entry'].includes(ret))
client.emit(
'bushKick',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
dmSuccessEvent!,
options.evidence
);
return ret;
}
public async bushBan(options: BushBanOptions): Promise<BanResponse> {
// checks
if (!this.guild.me!.permissions.has('BAN_MEMBERS') || !this.bannable) return 'missing permissions';
let caseID: string | undefined = undefined;
let dmSuccessEvent: boolean | undefined = undefined;
const moderator = (await util.resolveNonCachedUser(options.moderator ?? this.guild.me))!;
const ret = await (async () => {
// dm user
const dmSuccess = await this.punishDM('banned', options.reason, options.duration ?? 0);
dmSuccessEvent = dmSuccess;
// ban
const banSuccess = await this.ban({
reason: `${moderator.tag} | ${options.reason ?? 'No reason provided.'}`,
days: options.deleteDays
}).catch(() => false);
if (!banSuccess) return 'error banning';
// add modlog entry
const { log: modlog } = await Moderation.createModLogEntry({
type: options.duration ? ModLogType.TEMP_BAN : ModLogType.PERM_BAN,
user: this,
moderator: moderator.id,
reason: options.reason,
duration: options.duration,
guild: this.guild,
evidence: options.evidence
});
if (!modlog) return 'error creating modlog entry';
caseID = modlog.id;
// add punishment entry so they can be unbanned later
const punishmentEntrySuccess = await Moderation.createPunishmentEntry({
type: 'ban',
user: this,
guild: this.guild,
duration: options.duration,
modlog: modlog.id
});
if (!punishmentEntrySuccess) return 'error creating ban entry';
if (!dmSuccess) return 'failed to dm';
return 'success';
})();
if (!['error banning', 'error creating modlog entry', 'error creating ban entry'].includes(ret))
client.emit(
'bushBan',
this,
moderator,
this.guild,
options.reason ?? undefined,
caseID!,
options.duration ?? 0,
dmSuccessEvent!,
options.evidence
);
return ret;
}
public get isOwner(): boolean {
return client.isOwner(this);
}
public get isSuperUser(): boolean {
return client.isSuperUser(this);
}
}
|