Commands for hiding and unhiding text channels

Author: tire95

documentation/commands.md

@@ -30,10 +30,12 @@ Command | Description | Example
 `/edit_course` | Edit course information, e.g. course code, fullname, or nickname. Must be used inside a course. | `/edit_course nickname ohpe`
 `/edit_topic` | Edit channel topic, replacing an already existing topic. | `/edit_topic perusteet`
 `/enable_bridge` | Enable bridge in a Discord text channel. Must be used inside a course and in a non-default text channel. | `/enable_bridge`
+`/hide_channel` | Make the channel hidden from regular users. Also disables the bridge in the channel. Must be used inside a course and in a non-default text channel. | `/hide_channel`
 `/hide_course` | Make the given course private, disabling joining with `/join` | `/hide_course ohpe`
 `/lock_chat` | Lock the given course, disabling messaging by regular users | `/lock_chat ohpe`
 `/rename_channel` | Rename a Discord text channel. Must be used inside a course and in a non-default text channel. | `/rename_channel questions`
 `/status` | Get full status of course. Must be used inside a course. | `/status`
+`/unhide_channel` | Make the channel visible to regular users. Also enables the bridge in the channel. Must be used inside a course and in a non-default text channel. | `/unhide_channel`
 `/unhide_course` | Make the given course public, enabling joining with `/join`. | `/unhide_course ohpe`
 `/unlock_chat` | Unlock the given course, enabling messaging by regular users. | `/unlock_chat ohpe`
 

documentation/commands/faculty/hide_channel.md

@@ -0,0 +1,9 @@
+## /hide_channel
+
+- :heavy_check_mark: Must be used in a non-default text channel.
+- :heavy_check_mark: Reply with an ephemeral message - is only visible to the user of the interaction.
+- :heavy_check_mark: Response includes the interaction status.
+
+- :x: All members can use this command.
+- :x: Needs arguments.
+- :x: Can be used in every channel.

documentation/commands/faculty/unhide_channel.md

@@ -0,0 +1,9 @@
+## /unhide_channel
+
+- :heavy_check_mark: Must be used in a non-default text channel.
+- :heavy_check_mark: Reply with an ephemeral message - is only visible to the user of the interaction.
+- :heavy_check_mark: Response includes the interaction status.
+
+- :x: All members can use this command.
+- :x: Needs arguments.
+- :x: Can be used in every channel.

documentation/usermanual-admin.md

@@ -124,11 +124,13 @@ Command | Explanation | Arguments
 [/edit_course](./commands/faculty/edit_course.md) | Edit course information, options; coursecode, full name, nickname | :heavy_check_mark:
 [/edit_topic](./commands/faculty/edit_topic.md) | Edit topic, must be used in a course channel, e.g., /edit_topic A new topic. | :heavy_check_mark:
 [/enable_bridge](./commands/faculty/enable_bridge.md) | Enable the bridge between Telegram and the (non-default) course channel it is used in. | :x:
+[/hide_channel](./commands/faculty/hide_channel.md)| Make the channel hidden from regular users, e.g., /hide_channel. Also disables the bridge in the channel. | :x:
 [/hide_course](./commands/faculty/hide_course.md)| Make given course private, e.g., /hide_course weba. | :heavy_check_mark:
 [/lock_chat](./commands/faculty/lock_chat.md) | Lock the chat (meaning only instructors and faculty can post messages) of a given course | :heavy_check_mark:
 [/remove_instructors](./commands/faculty/remove_instructors.md) | Remove instructor role from (multiple) users, e.g., /remove_instructors @user1 @user2. | :heavy_check_mark:
 [/rename_channel](./commands/faculty/rename_channel.md) | Rename the non-default course text channel the command is used in, e.g., /rename_channel feedback. | :heavy_check_mark:
 [/status](./commands/faculty/status.md) | Used in course channel returns general info about the course | :heavy_check_mark:
+[/unhide_channel](./commands/faculty/unhide_channel.md)| Make the channel visible to regular users, e.g., /unhide_channel. Also enables the bridge in the channel. | :x:
 [/unhide_course](./commands/faculty/unhide_course.md) | Make given course public, e.g., /unhide_course weba. | :heavy_check_mark:
 [/unlock_chat](./commands/faculty/unlock_chat.md) | Unlock the chat of a given course | :heavy_check_mark:
 

documentation/usermanual-faculty.md

@@ -120,10 +120,16 @@ The `/create_poll` command allows you to create a poll that is placed in the sam
 
 ## Disabling the bridge on a text channel
 
-Users with faculty rights can disable the bridge between a certain course channel and Telegram. This can be used e.g. on off-topic course channels where there's a lot of discussion that could flood the Telegram chat with messages not directly related to the course. Note that the bridge can be disabled only on non-default channels, that is channels which were created individually with `/create_channel` after the course was created. You can check in which channels the bridge is disabled with the command `/status`. 
+Users with faculty rights can disable the bridge between a certain course channel and Telegram. This can be used e.g. on off-topic course channels where there's a lot of discussion that could flood the Telegram chat with messages not directly related to the course. Note that the bridge can be disabled only on non-default channels, that is channels which were created individually with `/create_channel` after the course was created. To disable the bridge on a channel, write the command `/disable_bridge` on that channel. You can check in which channels the bridge is disabled with the command `/status`. 
 
 To enable the bridge on a channel, write the command `/enable_bridge` on that channel.
 
+## Hiding a text channel from regular users
+
+Users with faculty rights can hide a text channel from regular users inside a course. This can be used to e.g. make a private chat for course instructors. Note that the bridge can be disabled only on non-default channels, that is channels which were created individually with `/create_channel` after the course was created. To hide a text channel, write the command `/hide_channel` on that channel. Note that the command also disables the bridge on that channel, so that instructor specific conversations won't accidentally leak to Telegram.
+
+To reveal the channel to regular users, write the command `/unhide_channel` on that channel. Note that the command also enables the bridge on that channel.
+
 #### Faculty specific commands ####
 
 Command | Explanation | Arguments
@@ -138,11 +144,13 @@ Command | Explanation | Arguments
 [/edit_course](./commands/faculty/edit_course.md) | Edit course information, options; coursecode, full name, nickname | :heavy_check_mark:
 [/edit_topic](./commands/faculty/edit_topic.md) | Edit topic, must be used in a course channel, e.g., /edit_topic A new topic. | :heavy_check_mark:
 [/enable_bridge](./commands/faculty/enable_bridge.md) | Enable the bridge between Telegram and the (non-default) course channel it is used in. | :x:
+[/hide_channel](./commands/faculty/hide_channel.md)| Make the channel hidden from regular users, e.g., /hide_channel. Also disables the bridge in the channel. | :x:
 [/hide_course](./commands/faculty/hide_course.md)| Make given course private, e.g., /hide_course weba. | :heavy_check_mark:
 [/lock_chat](./commands/faculty/lock_chat.md) | Lock the chat (meaning only instructors and faculty can post messages) of a given course | :heavy_check_mark:
 [/remove_instructors](./commands/faculty/remove_instructors.md) | Remove instructor role from (multiple) users, e.g., /remove_instructors @user1 @user2. | :heavy_check_mark:
 [/rename_channel](./commands/faculty/rename_channel.md) | Rename the non-default course text channel the command is used in, e.g., /rename_channel feedback. | :heavy_check_mark:
 [/status](./commands/faculty/status.md) | Used in course channel returns general info about the course | :heavy_check_mark:
+[/unhide_channel](./commands/faculty/unhide_channel.md)| Make the channel visible to regular users, e.g., /unhide_channel. Also enables the bridge in the channel. | :x:
 [/unhide_course](./commands/faculty/unhide_course.md) | Make given course public, e.g., /unhide_course weba. | :heavy_check_mark:
 [/unlock_chat](./commands/faculty/unlock_chat.md) | Unlock the chat of a given course | :heavy_check_mark:
 

src/db/hookInit.js

@@ -83,6 +83,23 @@ const initChannelHooks = (guild, models) => {
       const channelObject = guild.channels.cache.find(c => c.name === channel.name);
       await channelObject.setTopic(channel.topic);
     }
+
+    if (channel._changed.has("hidden")) {
+      const course = await findCourseFromDbById(channel.courseId, courseModel);
+      const student = await findOrCreateRoleWithName(course.name, guild);
+      const channelObject = guild.channels.cache
+        .find(c => c.name === channel.dataValues.name);
+      if (channel.hidden) {
+        await channelObject.permissionOverwrites.create(student, {
+          VIEW_CHANNEL: false,
+        });
+      }
+      else {
+        await channelObject.permissionOverwrites.create(student, {
+          VIEW_CHANNEL: true,
+        });
+      }
+    }
   });
 };
 

src/db/migrations/addChannelHidden-migration.js

@@ -0,0 +1,14 @@
+"use strict";
+const { BOOLEAN } = require("sequelize");
+
+module.exports = {
+  up: async (queryInterface) => {
+    await queryInterface.addColumn("channel", "hidden", {
+      type: BOOLEAN,
+      defaultValue: false,
+    });
+  },
+  down: async (queryInterface) => {
+    await queryInterface.removeColumn("channel", "hidden");
+  },
+};

src/db/models/Channel.js

@@ -35,6 +35,11 @@ module.exports = (sequelize, DataTypes) => {
       allowNull: true,
       unique: true,
     },
+    hidden: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+      unique: false,
+    },
   }, {
     timestamps: false,
     freezeTableName: true,

src/db/services/channelService.js

@@ -107,6 +107,16 @@ const saveChannelIdWithName = async (id, channelName, Channel) => {
     { where: { name: channelName } });
 };
 
+const editChannelHiddenStatus = async (discordId, hiddenStatus, Channel) => {
+  const channel = await findChannelFromDbByDiscordId(discordId, Channel);
+
+  if (channel) {
+    channel.hidden = hiddenStatus;
+    channel.bridged = !hiddenStatus;
+    await channel.save();
+  }
+};
+
 module.exports = {
   findChannelFromDbByName,
   findChannelFromDbByDiscordId,
@@ -121,4 +131,5 @@ module.exports = {
   getAllChannels,
   editChannelName,
   saveChannelTopicToDb,
+  editChannelHiddenStatus,
 };

src/discordBot/commands/faculty/hide_channel.js

@@ -0,0 +1,45 @@
+const { SlashCommandBuilder } = require("@discordjs/builders");
+const { getChannelByDiscordId, editChannelHiddenStatus } = require("../../../db/services/channelService");
+const { sendEphemeral, editEphemeral, editErrorEphemeral } = require("../../services/message");
+const { facultyRole } = require("../../../../config.json");
+const { confirmChoice } = require("../../services/confirm");
+
+const execute = async (interaction, client, models) => {
+  await sendEphemeral(interaction, "Hiding text channel...");
+
+  const channelModel = models.Channel;
+
+  const channel = await getChannelByDiscordId(interaction.channelId, channelModel);
+
+  if (!channel || !channel.courseId) {
+    return await editErrorEphemeral(interaction, "Course not found, can not hide the channel.");
+  }
+
+  const confirm = await confirmChoice(interaction, "Confirm command: Hide channel");
+
+  if (!confirm) {
+    return await editEphemeral(interaction, "Command declined");
+  }
+
+  if (channel.defaultChannel) {
+    return await editErrorEphemeral(interaction, "Command can't be performed on default course channels!");
+  }
+
+  if (channel.hidden) {
+    return await editErrorEphemeral(interaction, "The channel is already hidden.");
+  }
+
+  await editChannelHiddenStatus(channel.discordId, true, channelModel);
+  await editEphemeral(interaction, `Hid channel ${channel.name}`);
+};
+
+module.exports = {
+  data: new SlashCommandBuilder()
+    .setName("hide_channel")
+    .setDescription("Hide text channel the command was used in from regular users.")
+    .setDefaultPermission(false),
+  execute,
+  usage: "/hide_channel",
+  description: "Hide text channel the command was used in from regular users.*",
+  roles: ["admin", facultyRole],
+};