Migrate free channel command

[borgrel]

Replace existing functionality

This command is not completed, it still needs a lot of work, this PR is just to replace the current provided features of the old free channel system. Some of the expected improvements will be mentioned in this PR.

Configuration

Simply add the channel id's where you want the output and a list of the channels to monitor to the config file. since the json is expected in an array format multiple guilds can easily be added or removed without needing to comb through a list of numbers to find the channels related to one specific guild. Internally the channels are not separated.

There is only allowed to be one status channel per guild, I see no reason why a guild will want to display the status message in multiple places. If a second entry is added to the settings array which points to the same guild no errors will occur and only one channel will end up mapped for that guild.

The bot will throw Illegal state exceptions if the channel id's added to the config do not point to TextChannels.

Status message

The bot will display the status in the designated configured channel.

• If no message currently exists, it will generate one (and it will thereafter modify the existing one)
• If the status message is not the last message in the channel, it will delete the old message and display a new one. (This allows moderators to post updates and announcements etc in the channel and the bot will adjust around them)
• It will search the most recent 10 messages to find an existing status message.

The status message is currently identified by bot is the author and message includes embeds.

The final added check embed has correct title is not currently working. I believe this is because there is no getTitleRaw() method and the only solution I have thought of to date is to store the title constant as 2 strings which is not ideal.

If another command places messages with embeds in the same channel this command will currently modify and or delete them!

Busy Channel

When a user posts a message in a currently free channel, they get an automated reply. All strings displayed directly to a user are stored in the enum UserStrings so that they are easily modifiable and easily comparable to ensure consistent tone and jargon and language.

This feature needs expansion ...... when a user types in a free channel they will receive a prompt with buttons.
Are you asking a question?

• Yes -> mark channel as busy.
• Oops, wrong channel -> delete message.
• No, just adding additional information to previous question -> If this author is the OP, delete the previous free marker and allow him to continue the previous topic, otherwise move the free channel message below this post.

Free Channel

When the channel is marked as free a message is displayed, for everybody to see. This message is easily modifiable in the UserStrings class.

If a person tries to call the free command in a channel not currently being monitored they receive an ephemeral message stating such.

This feature needs expansion, when a helper tries to mark the channel as free the OP will receive a message with buttons asking if he is satisfied / finished before channel is marked as free. (This will require a timeout on the message as well as not triggering if the OP uses the /free command.

Inactivity

There is currently no scheduled process to check channels on a regular schedule and automatically mark them as available.

Since this is a feature expansion and not a replacement it is not included in this PR. However the bot uses this exact functionality on initialisation to generate the starting status of the channels, so once the bot receives Routine support (#235) it will be a simple method call to add that functionality.

Checklist

• adjust User messages (in UserStrings) (optional)
• update config.json
• run /reload command
• check that a status message appears in the designated channel
• check that the status message mentions all channels it must monitor
• check that typing in a monitored channel that is free changes to busy
  (checking one channel should be enough)
• check that using /free in a busy channel changes it to free
  (checking one channel should be enough)

[java-coding-prodigy]

This will work similar to the current free channel system right?

[borgrel]

This will work similar to the current free channel system right?

no, this will not work by typing in ?tag free the free is triggered via a slash command so only /free works
and it will have a lot of improvements over the current system

[CLAassistant]

All committers have signed the CLA.

[borgrel]

ready to merge

spotless is failing because of gradle deprecation

[Zabuzard]

spotless is failing because of gradle deprecation

What? Whats wrong with gradle? Or is your branch behind? Then please rebase.

[borgrel]

spotless is failing because of gradle deprecation

What? Whats wrong with gradle? Or is your branch behind? Then please rebase.

the same thing that fails on all builds atm until gradle 8 is officially released?

i did rebase.

[Zabuzard]

spotless is failing because of gradle deprecation

What? Whats wrong with gradle? Or is your branch behind? Then please rebase.

the same thing that fails on all builds atm until gradle 8 is officially released?

i did rebase.

Wait what, our current setup fails for all PRs? Why was it merged then, it has to be reverted. Or am I getting something wrong?

We wont merge stuff that fails Spotless.

[Zabuzard]

@borgrel Spotless fails because your code is wrongly formatted. See here:

[Zabuzard]

Can you add a release checklist to the PR? I.e. what do we have to do when we merge this? I guess adjust the config, anything else?

[borgrel]

Can you add a release checklist to the PR? I.e. what do we have to do when we merge this? I guess adjust the config, anything else?

done

stale, no response since 7 days.

[Zabuzard]

7 days without further activity + 1 approving review. Hence, merging.