/instructor_disconnect

Author: tire95

documentation/commands/instructor/instructor_disconnect.md

@@ -0,0 +1,9 @@
+## /instructor_disconnect
+
+- :heavy_check_mark: Can be used in every channel.
+- :heavy_check_mark: Reply with an ephemeral message - is only visible to the user of the interaction.
+- :heavy_check_mark: Needs argument: user to disconnect from voice chat.
+- :heavy_check_mark: Admin and faculty can disconnect anyone from any voice chat.
+- :heavy_check_mark: Instructor can disconnect a user from course voice chat only if they are instructor in that specific course.
+- :x: All members can use this command.
+- :x: Can give the intructor role to a member who is not on the course.

documentation/usermanual-admin.md

@@ -134,6 +134,12 @@ Command | Explanation | Arguments
 [/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:
 
+#### Instructor specific commands ####
+
+Command | Explanation | Arguments
+--------|-------------|----------:
+[/instructor_disconnect](./commands/instructor/instructor_disconnect.md) | Disconnect another user from a voice chat, e.g., /instructor_disconnect @user1. | :heavy_check_mark:
+
 #### General commands ####
 
 Command | Explanation | Arguments

documentation/usermanual-faculty.md

@@ -38,10 +38,6 @@ To be able to use all the faculty commands, you need to authenticate yourself. U
 
 You can create new course with command `/create_course`. Give the command and after that give the _course code_, course´s _full name_ and course´s _nickname_. Nickname is optional and if not given then the coursecode will be also course´s nickname. **Note** that nickname is the value that is used as course´s name that users see on the Discord´s left column. So, we prefer that you give your course a short nickname because it is more readable on Discord for the users. **Note** also that nickname is a unique value.
 
-#### Multilingual course name
-
-If your course has multilingual course name, enter all the information in the _full name_ field.
-
 #### Open university course
 
 If your course is an open university course, use the abbreviation **MOOC** in the _full name_ field next to your course name.
@@ -130,6 +126,10 @@ Users with faculty rights can hide a text channel from regular users inside a co
 
 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.
 
+### Disconnecting users from voice chat
+
+You can disconnect another user from any voice chat with the command `/instructor_disconnect`. Simply type `/instructor_disconnect @user1` in any chat.
+
 #### Faculty specific commands ####
 
 Command | Explanation | Arguments
@@ -138,7 +138,7 @@ Command | Explanation | Arguments
 [/create_channel](./commands/faculty/create_channel.md) | Create new text channel inside a course, e.g., /create_channel feedback. | :heavy_check_mark:
 [/create_course](./commands/faculty/create_course.md) | Create a new course | :heavy_check_mark:
 [/create_poll](./commands/faculty/create_poll.md) | Create a new poll | :heavy_check_mark:
-[/delete_bridge](./commands/faculty/delete_bridge.md) | Delete the bridge from specified Course, e.g., /delete_bridge ohpe | :heavy_check_mark:
+[/delete_bridge](./commands/faculty/delete_bridge.md) | Delete the bridge from specified course, e.g., /delete_bridge ohpe | :heavy_check_mark:
 [/delete_channel](./commands/faculty/delete_channel.md) | Remove given text channel inside a course, e.g., /delete_channel feedback. | :heavy_check_mark:
 [/disable_bridge](./commands/faculty/disable_bridge.md) | Disable the bridge between Telegram and the (non-default) course channel it is used in. | :x:
 [/edit_course](./commands/faculty/edit_course.md) | Edit course information, options; coursecode, full name, nickname | :heavy_check_mark:
@@ -154,6 +154,12 @@ Command | Explanation | Arguments
 [/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:
 
+#### Instructor specific commands ####
+
+Command | Explanation | Arguments
+--------|-------------|----------:
+[/instructor_disconnect](./commands/instructor/instructor_disconnect.md) | Disconnect another user from a voice chat, e.g., /instructor_disconnect @user1. | :heavy_check_mark:
+
 #### General commands ####
 
 Command | Explanation | Arguments

documentation/usermanual-instructor.md

@@ -0,0 +1,57 @@
+# User manual for instructors
+
+### About Discord
+
+To learn more about Discord in general, head over to their [official website](https://discord.com/). You can also check the [Beginner's Guide to Discord](https://support.discord.com/hc/en-us/articles/360045138571-Beginner-s-Guide-to-Discord#h_d33e3809-909b-4720-899d-db26c17bafa9).
+
+The Department of Computer Science has a Discord server for course support. The server contains categories for courses where students can ask for help and offer peer support for other students. The server also has a bot that can help you with several things, including creating course categories, adding instructors for a course, editing course visibility, and more.
+
+We recommend that you use the Discord application (desktop app or mobile app). If you can't or don't want to download the application, you can use a browser-based version of Discord instead.
+
+### Create your Discord account
+
+Create yourself a Discord account. You can do this on [Discord Website](https://discord.com/). If you already have the account, you can login [here](https://discord.com/login).
+
+If you’re on a desktop or mobile device, you can directly open the Discord app on your device (You can learn more information on downloading the app [here](https://support.discord.com/hc/en-us/articles/360033931551)).
+
+Once you’re at the login page, type in either _your email address_ or _phone number_ that has been officially verified to your Discord account. 
+
+Note: You will need to verify your phone number to your Discord account before using phone number login! [Click here](https://support.discord.com/hc/en-us/articles/360033931551) to learn how to verify your phone number to your Discord account.
+
+### Joining to the Discord
+
+You can join to the Helsinki University Discord server in two different ways. Join directly to the server using this [link]( https://study.cs.helsinki.fi/discord). Join directly using the course´s own link (MOOC, Moodle, etc.).
+
+![commands](./images/courselink.png)
+
+### How to use the bot
+
+The Discord server has a bot that can help you with many things. Interaction with bot is achieved with Discord's slash commands.
+
+Commands can be used by typing `/<command_name>` into the message area at the bottom of the application. You can see all the available commands as a list that opens after typing `/`. **Note that you have to manually type the commands; the bot rarely understands copy-pasted commands!**
+
+### Disconnecting users from course voice chat
+
+You can disconnect another user from course voice chat with the command `/instructor_disconnect`. Note that you can disconnect a user only if you are an instructor on that course. E.g. if you are a course instructor in tito, `@user1` is currently in `tito_voice`, and `@user2` is in `wepa_voice`, you can disconnect `@user1` by typing `/instructor_disconnect @user1` in any chat, whereas using `/instructor_disconnect @user2` will do nothing as you are not an instructor in wepa.
+
+#### Instructor specific commands ####
+
+Command | Explanation | Arguments
+--------|-------------|----------:
+[/instructor_disconnect](./commands/instructor/instructor_disconnect.md) | Disconnect another user from a voice chat, e.g., /instructor_disconnect @user1. Only works for persons in voice chat of a course you are instructor in. | :heavy_check_mark:
+
+### General commands
+
+Command | Explanation | Arguments
+--------|-------------|----------:
+[/auth](./commands/general/auth.md) | For faculty members with student role to acquire the faculty role. | :x:
+[/courses](./commands/general/courses.md) | Get public course information | :x:
+[/help](./commands/general/help.md) | Get help how to use slash commands. | :o:
+[/instructors](./commands/general/instructors.md) | Get course intructors information. | :x:
+[/join](./commands/general/join.md) | Joins you into the course given, e.g., /join ohpe. | :heavy_check_mark:
+[/leave](./commands/general/leave.md) | Remove you from the course given, e.g., /leave ohpe. | :heavy_check_mark:
+[/workshops](./commands/general/workshops.md) | Get workshop info for the course. | :x:
+
+### Material
+
+[Source code for the Bot](https://github.com/Ohtuproju2021syksy/Discord-Bot-better)

src/discordBot/commands/instructor/instructor_disconnect.js

@@ -0,0 +1,67 @@
+const { SlashCommandBuilder } = require("@discordjs/builders");
+const { getChannelByDiscordId } = require("../../../db/services/channelService");
+const { findUserByDiscordId } = require("../../../db/services/userService");
+const { sendEphemeral, editEphemeral, editErrorEphemeral } = require("../../services/message");
+const { confirmChoice } = require("../../services/confirm");
+const { findCourseMember } = require("../../../db/services/courseMemberService");
+const { getUserWithUserId } = require("../../services/service");
+
+const execute = async (interaction, client, models) => {
+  await sendEphemeral(interaction, "Disconnecting user from voice channel...");
+
+  const channelModel = models.Channel;
+  const courseMemberModel = models.CourseMember;
+
+  const parameter = interaction.options.getString("user");
+  if (!parameter.match(/(?<=<@!).*?(?=>)/)) {
+    return await editErrorEphemeral(interaction, "Invalid parameters.");
+  }
+  const userToDisconnectID = parameter.match(/(?<=<@!).*?(?=>)/)[0];
+  const commandUser = await findUserByDiscordId(interaction.member.user.id, models.User);
+  const userToDc = await getUserWithUserId(client.guild, userToDisconnectID);
+  const userToDcVoiceChannel = await getChannelByDiscordId(userToDc.voice.channelId, channelModel);
+  console.log(userToDcVoiceChannel);
+
+
+  // inside a course voice channel
+  if (userToDcVoiceChannel?.courseId) {
+    const commandUserCourseMember = await findCourseMember(commandUser.id, userToDcVoiceChannel.courseId, courseMemberModel);
+    console.log(commandUserCourseMember);
+    if (!commandUser.admin && !commandUser.faculty && !commandUserCourseMember.instructor) {
+      return await editErrorEphemeral(interaction, "You don't have the permissions to do that.");
+    }
+    const confirm = await confirmChoice(interaction, `Confirm command: Disconnect user ${parameter} from voice channel`);
+
+    if (!confirm) {
+      return await editEphemeral(interaction, "Command declined");
+    }
+    userToDc.voice.setChannel(null);
+    return await editEphemeral(interaction, `Disconnected user ${parameter} from voice channel`);
+  }
+
+  // inside a non-course voice channel
+  if (!commandUser.admin && !commandUser.faculty) {
+    return await editErrorEphemeral(interaction, "You don't have the permissions to do that.");
+  }
+  const confirm = await confirmChoice(interaction, `Confirm command: Disconnect user ${parameter} from voice channel`);
+
+  if (!confirm) {
+    return await editEphemeral(interaction, "Command declined");
+  }
+  userToDc.voice.disconnect();
+  await editEphemeral(interaction, `Disconnected user ${parameter} from voice channel`);
+};
+
+module.exports = {
+  data: new SlashCommandBuilder()
+    .setName("instructor_disconnect")
+    .setDescription("Disconnect user from voice channel.")
+    .setDefaultPermission(true)
+    .addStringOption(option =>
+      option.setName("user")
+        .setDescription("User to disconnect.")
+        .setRequired(true)),
+  execute,
+  usage: "/instructor_disconnect",
+  description: "Disconnect user from voice channel.*",
+};

src/discordBot/index.js

@@ -11,6 +11,7 @@ const intents = [
   Intents.FLAGS.GUILD_INVITES,
   Intents.FLAGS.GUILD_MESSAGES,
   Intents.FLAGS.GUILD_MESSAGE_REACTIONS,
+  Intents.FLAGS.GUILD_VOICE_STATES,
 ];
 const client = new Client({ intents: intents });