Merge pull request #37 from acmucsd/aaron/fields

added challenge fields (formerly attachments)

Author: KNOXDEV

src/database/models/Challenge.ts

@@ -11,6 +11,7 @@ import {
 import { Category } from './Category';
 import { Flag, initFlag } from './Flag';
 import { ChallengeChannel, initChallengeChannel } from './ChallengeChannel';
+import { ChallengeField, initChallengeField } from './ChallengeField';
 
 export interface ChallengeAttributes {
   id: number;
@@ -65,6 +66,18 @@ export class Challenge extends Model<ChallengeAttributes, ChallengeCreationAttri
   // declare removeFlags: HasManyRemoveAssociationsMixin<Flag, number>;
   declare createFlag: HasManyCreateAssociationMixin<Flag>;
   declare readonly Flags?: Flag[];
+
+  declare getChallengeFields: HasManyGetAssociationsMixin<ChallengeField>;
+  // declare countChallengeFields: HasManyCountAssociationsMixin;
+  // declare hasChallengeField: HasManyHasAssociationMixin<ChallengeField, number>;
+  // declare hasChallengeFields: HasManyHasAssociationsMixin<ChallengeField, number>;
+  // declare setChallengeFields: HasManySetAssociationsMixin<ChallengeField, number>;
+  // declare addChallengeField: HasManyAddAssociationMixin<ChallengeField, number>;
+  // declare addChallengeFields: HasManyAddAssociationsMixin<ChallengeField, number>;
+  // declare removeChallengeField: HasManyRemoveAssociationMixin<ChallengeField, number>;
+  // declare removeChallengeFields: HasManyRemoveAssociationsMixin<ChallengeField, number>;
+  declare createChallengeField: HasManyCreateAssociationMixin<ChallengeField>;
+  declare readonly ChallengeFields?: ChallengeField[];
 }
 
 export function initChallenge(sequelize: Sequelize) {
@@ -113,4 +126,7 @@ export function initChallenge(sequelize: Sequelize) {
 
   initFlag(sequelize);
   Challenge.hasMany(Flag);
+
+  initChallengeField(sequelize);
+  Challenge.hasMany(ChallengeField);
 }

src/database/models/ChallengeField.ts

@@ -0,0 +1,57 @@
+import { BelongsToGetAssociationMixin, DataTypes, Model, Optional, Sequelize } from 'sequelize';
+import { Challenge } from './Challenge';
+
+interface ChallengeFieldAttributes {
+  id: number;
+  title: string;
+  content: string;
+}
+
+type ChallengeFieldCreationAttributes = Optional<ChallengeFieldAttributes, 'id'>;
+
+export class ChallengeField
+  extends Model<ChallengeFieldAttributes, ChallengeFieldCreationAttributes>
+  implements ChallengeFieldAttributes
+{
+  declare id: number;
+  declare title: string;
+  declare content: string;
+
+  // declare readonly createdAt: Date;
+  // declare readonly updatedAt: Date;
+
+  declare getChallenge: BelongsToGetAssociationMixin<Challenge>;
+  // declare setChallenge: BelongsToSetAssociationMixin<Challenge, number>;
+  // declare createChallenge: BelongsToCreateAssociationMixin<Challenge>;
+  // declare readonly challenge?: Challenge;
+}
+
+export function initChallengeField(sequelize: Sequelize) {
+  ChallengeField.init(
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+      },
+      title: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      content: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+    },
+    {
+      sequelize,
+    },
+  );
+
+  ChallengeField.belongsTo(Challenge, {
+    onDelete: 'CASCADE',
+    foreignKey: {
+      allowNull: false,
+    },
+  });
+}

src/discord/events/interaction/commands/challenge/challenge.ts

@@ -4,10 +4,11 @@ import set from './set';
 import { ChatInputCommandDefinition } from '../../interaction';
 import flag from './flag';
 import fromcsv from './fromcsv';
+import field from './field';
 
 export default {
   name: 'challenge',
   description: 'Challenge management and submission',
-  options: [add, del, set, flag, fromcsv],
+  options: [add, del, set, flag, fromcsv, field],
   default_permission: false,
 } as ChatInputCommandDefinition;

src/discord/events/interaction/commands/challenge/field/add.ts

@@ -0,0 +1,33 @@
+import { ApplicationCommandOptionTypes } from 'discord.js/typings/enums';
+import { ExecutableSubCommandData, PopulatedCommandInteraction } from '../../../interaction';
+import { getChallengeByChannelContext } from '../../../../../util/ResourceManager';
+
+export default {
+  name: 'add',
+  description: 'Add a new field to this challenge.',
+  type: ApplicationCommandOptionTypes.SUB_COMMAND,
+  options: [
+    {
+      name: 'title',
+      description: "The field's title",
+      type: ApplicationCommandOptionTypes.STRING,
+      required: true,
+    },
+    {
+      name: 'content',
+      description: "The field's content",
+      type: ApplicationCommandOptionTypes.STRING,
+      required: true,
+    },
+  ],
+  async execute(interaction: PopulatedCommandInteraction) {
+    const challenge = await getChallengeByChannelContext(interaction.channel);
+
+    await challenge.createChallengeField({
+      title: interaction.options.getString('title', true),
+      content: interaction.options.getString('content', true),
+    });
+
+    return `Field has been added to challenge **${challenge.name}**.`;
+  },
+} as ExecutableSubCommandData;

src/discord/events/interaction/commands/challenge/field/del.ts

@@ -0,0 +1,28 @@
+import { ApplicationCommandOptionTypes } from 'discord.js/typings/enums';
+import { ExecutableSubCommandData, PopulatedCommandInteraction } from '../../../interaction';
+import { getChallengeByChannelContext } from '../../../../../util/ResourceManager';
+
+export default {
+  name: 'del',
+  description: 'Deletes a field attached to this challenge.',
+  type: ApplicationCommandOptionTypes.SUB_COMMAND,
+  options: [
+    {
+      name: 'index',
+      description: 'Indicate which field you want to delete (counting starts at 1)',
+      type: ApplicationCommandOptionTypes.NUMBER,
+      required: true,
+    },
+  ],
+  async execute(interaction: PopulatedCommandInteraction) {
+    const challenge = await getChallengeByChannelContext(interaction.channel);
+
+    const fields = await challenge.getChallengeFields({ order: [['createdAt', 'ASC']] });
+    const index = interaction.options.getNumber('index', true) - 1;
+
+    if (!fields || !fields[index]) throw new Error('no field with that index');
+    await fields[index].destroy();
+
+    return `Field #${index + 1} has been removed from challenge **${challenge.name}**.`;
+  },
+} as ExecutableSubCommandData;

src/discord/events/interaction/commands/challenge/field/index.ts

@@ -0,0 +1,11 @@
+import { ApplicationCommandOptionTypes } from 'discord.js/typings/enums';
+import { ExecutableSubGroupData } from '../../../interaction';
+import add from './add';
+import del from './del';
+
+export default {
+  name: 'field',
+  description: 'Challenge field management',
+  type: ApplicationCommandOptionTypes.SUB_COMMAND_GROUP,
+  options: [add, del],
+} as ExecutableSubGroupData;

src/discord/hooks/index.ts

@@ -14,6 +14,7 @@ import { destroyChallengeChannel, refreshChallengeChannel } from './ChallengeCha
 import { Flag } from '../../database/models/Flag';
 import { destroyTeam, refreshTeam } from './TeamHooks';
 import { Team } from '../../database/models/Team';
+import { ChallengeField } from '../../database/models/ChallengeField';
 
 export async function initHooks(client: Client<true>) {
   Ctf.beforeCreate((ctf) =>
@@ -65,6 +66,10 @@ export async function initHooks(client: Client<true>) {
   Flag.afterCreate((flag) => flag.getChallenge().then((chal) => refreshChallenge(chal, client)));
   Flag.afterUpdate((flag) => flag.getChallenge().then((chal) => refreshChallenge(chal, client)));
   Flag.afterDestroy((flag) => flag.getChallenge().then((chal) => refreshChallenge(chal, client)));
+  // same for challenge fields
+  ChallengeField.afterCreate((field) => field.getChallenge().then((chal) => refreshChallenge(chal, client)));
+  ChallengeField.afterUpdate((field) => field.getChallenge().then((chal) => refreshChallenge(chal, client)));
+  ChallengeField.afterDestroy((field) => field.getChallenge().then((chal) => refreshChallenge(chal, client)));
 
   // TODO: after a flag gets captured, we queue up a periodic refresh
 

src/discord/messages/ChallengeMessage.ts

@@ -27,8 +27,10 @@ export async function setChallengeMessage(client: Client<true>, channel: TextCha
   challengeMessage.setFooter({ text: `By ${challenge.author}` });
   challengeMessage.setColor('#50c0bf');
 
-  // const attachments = await this.getAllAttachments();
-  // attachments.forEach((attachment) => challengeMessage.addField(attachment.row.name, attachment.row.url));
+  // add challenge fields
+  const fields = await challenge.getChallengeFields();
+  fields.forEach((field) => challengeMessage.addField(field.title, field.content));
+
   const guild = await client.guilds.fetch(category.Ctf.guildSnowflake);
 
   // complicated nested query to fetch the associated first blood user and team, if defined