Merge pull request #207 from Ohtuproju2021syksy/v13

V13 to main

Author: hupijekku

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/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

@@ -124,14 +124,22 @@ 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:
 
+#### 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.
@@ -120,10 +116,20 @@ 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.
+
+### 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
@@ -132,20 +138,28 @@ 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:
 [/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:
 
+#### 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/db/hookInit.js

@@ -83,6 +83,25 @@ 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,
+          SEND_MESSAGES: false,
+        });
+      }
+      else {
+        await channelObject.permissionOverwrites.create(student, {
+          VIEW_CHANNEL: true,
+          SEND_MESSAGES: true,
+        });
+      }
+    }
   });
 };
 
@@ -195,9 +214,9 @@ const initUserHooks = (guild, models) => {
 
 const initCourseMemberHooks = (guild, models) => {
   models.CourseMember.addHook("afterCreate", async (courseMember) => {
-    const user = await findUserByDbId(courseMember.userId, models.User);
-    const course = await findCourseFromDbById(courseMember.courseId, models.Course);
-    const member = guild.members.cache.get(user.discordId);
+    const user = await findUserByDbId(courseMember.dataValues.userId, models.User);
+    const course = await findCourseFromDbById(courseMember.dataValues.courseId, models.Course);
+    const member = guild.members.cache.get(user.dataValues.discordId);
     const courseRole = guild.roles.cache.find(r => r.name === course.name);
     await member.roles.add(courseRole);
     await updateGuide(guild, models);

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,