GroupModerBot v1.2.1

What's Changed

Logging:

• Improved configuration error messages: Errors related to invalid parameters now display the parameter value (e.g., value MaxLogFileSize is invalid ("1 024")).

General:

• Adding instructions for building the bot to README.md.
• A small addition to code and CMakeLists.txt.

GroupModerBot v1.2.0

What's Changed

Commands:

• The /admins command now displays Telegram IDs of administrators.
• The /remove_admin command now accepts the admin's Telegram ID.
• Commands are now processed completely asynchronously.
• Updated descriptions for several commands.
• Messages sent to private chats for commands that require replying to a user's message have been updated.

Configuration file:

• The DbPath parameter is now mandatory.
• If the path specified in DbPath or LogDirectory does not exist, it will be created automatically.
• Parameter keys must now be placed at the beginning of the line. There can now be spaces after = and after the value.
• Added the LogMode parameter with the following options: Console (logging to console only), File (logging to file only), or ConsoleAndFile (logging to console and file).
• Added the MaxLogFileSize parameter to define the size limit (in bytes) before a new log file is generated.
• Added the LogDirectory parameter to specify the folder where log files will be created.
• File paths in parameters must now be absolute.

Logging:

• Added the ability to enable and configure logging to a file using the LogMode, MaxLogFileSize, and LogDirectory parameters.

General:

• Added program shutdown handling. If the program is closed without the /disable_bot command, it will not close immediately, but will delay closing and attempt to exit gracefully.
• Admin data is now automatically updated in the database whenever an administrator executes a command.
• Improved performance and security.
• If LogMode is set to File or ConsoleAndFile, the program will not require a keystroke to close.

GroupModerBot v1.1.0

What's Changed

• The bot now supports Linux (GLIBC 2.35 or higher).
• Added the /disable_bot command, allowing you to turn off the bot completely from Telegram.
• All command names have been rewritten in snake_case (e.g., /add_admin instead of /addAdmin).
• Commands and their short descriptions are now natively integrated into the Telegram UI menu.
• Added the ProcessPendingUpdates feature. If ProcessPendingUpdates is enabled, the bot will ignore all commands and events sent to it while it was offline that are not directly related to the bot.
• Console logs now contain more details and include precise timestamps.
• Logs are now visually aligned for easier monitoring.
• The project has switched to a CMake build.
• SQL queries have been optimized for better security and faster execution.
• Improved overall code security by fixing several potential overflows and incorrect behaviors in multithreaded environments.
• Reduced code duplication.

GroupModerBot v1.0.0

GroupModerBot

📋 Description

GroupModerBot is a reliable Telegram moderation bot designed to help you maintain order in your groups. It provides administrators with a flexible warning system, allowing them to issue warnings, and automatically mute or ban repeat offenders based on configurable thresholds.

⛓️ Dependencies

• Windows x64
• Compiler with C++20 support
• SQLiteCpp
• tgbot-cpp
• Boost (Required by tgbot-cpp)

✨ Features

1. ⚖️ Warning System - Issue warnings to group members and set custom penalties. Includes an auto-mute feature where mute duration increases progressively using the Fibonacci sequence.
2. 🛡️ Fault Tolerance - The bot is completely crash-resistant. Exception handling ensures it stays online continuously unless the host runs out of memory or power.
3. 🔒 Persistent Storage - All data (admins, warnings, group settings) is stored securely in an SQLite database. No data is lost upon restart or disconnection.

🚀 Quick Start

Follow these steps to launch the bot:

1. Download the latest release

• Go to the Releases.
• Download the GroupModerBot_[Version]_[OperatingSystem].zip archive and extract it to an empty folder. The path to the folder with .exe must not contain non-Latin letters. Do not separate the .exe from the .dll files.

2. Get a bot token

• Create a new bot in @BotFather on Telegram.
• Send /token to get the bot token.

To function as a moderator, the bot needs specific permissions in BotFather:

• Send /setjoingroups -> Select your bot -> Enable (Allows adding the bot to groups).
• Send /setprivacy -> Select your bot -> Disable (Allows the bot to read all messages in the group, which is required for reply-based commands).

3. Database setup

• The bot requires an SQLite database to function. You have two options:

  • Automatic (Recommended): Simply skip this step. If the configuration file does not contain DbPath=, a file GroupModerBotDatabase.db containing the necessary structure will be automatically created in the folder with the .exe.
  • Manual: If you wish to use a custom location or filename, create a .db (you can use DB Browser or SQLiteStudio for this, for example). The path to .db must not contain non-Latin letters. And then create the necessary tables in this database:

BotAdmins

CREATE TABLE "BotAdmins" (
	"Id"	INTEGER NOT NULL UNIQUE,
	"FirstName"	TEXT NOT NULL,
	"LastName"	TEXT NOT NULL,
	"Username"	TEXT NOT NULL,
	"IsBot"	INTEGER NOT NULL,
	"IsPremium"	INTEGER NOT NULL,
	"IsBotOwner"	INTEGER NOT NULL,
	PRIMARY KEY("Id")
)

Groups

CREATE TABLE "Groups" (
	"Id"	INTEGER NOT NULL UNIQUE,
	"Title"	TEXT NOT NULL,
	"UniqueTitle"	TEXT NOT NULL UNIQUE,
	"Type"	INTEGER NOT NULL CHECK("Type" >= 0 AND "Type" <= 3),
	"IsBotAdmin"	INTEGER NOT NULL CHECK("IsBotAdmin" = 0 OR "IsBotAdmin" = 1),
	"IsBotActive"	INTEGER NOT NULL CHECK("IsBotActive" = 0 OR "IsBotActive" = 1),
	PRIMARY KEY("Id")
)

GroupsSettings

CREATE TABLE "GroupsSettings" (
	"Id"	INTEGER NOT NULL UNIQUE,
	"NumWarnToMute"	INTEGER NOT NULL CHECK("NumWarnToMute" >= 0),
	"NumWarnToBan"	INTEGER NOT NULL CHECK("NumWarnToBan" >= 0),
	FOREIGN KEY("Id") REFERENCES "Groups"("Id") ON DELETE CASCADE
)

UserWarnings

CREATE TABLE "UsersWarnings" (
	"Id"	INTEGER NOT NULL,
	"GroupId"	INTEGER NOT NULL,
	"QuantityWarn"	INTEGER NOT NULL CHECK("QuantityWarn" >= 0),
	PRIMARY KEY("Id","GroupId"),
	FOREIGN KEY("GroupId") REFERENCES "Groups"("Id") ON DELETE CASCADE
)

4. Configuration

• Open the DataForBot.txt file in the folder with the .exe.
• Fill in your BotToken and (optionally) your DbPath:

DbPath=C:\Users\UserName\Desktop\Database\DBForBot.db
BotToken=1234567890:AAFJmnuH50H05MqFwJZrrpI2FTRGTFCWK68

• IMPORTANT:
  • Line order does not matter, but ensure there are no spaces around the = sign.
  • Any other text or empty lines in the file will be ignored.
  • If you remove DbPath= , a .db file will be automatically created as described in step 3 (Automatic).

5. Run & Authenticate

• Run GroupModerBot.exe.
• If everything is configured correctly, you will see a successful initialization log in the console, ending with [BOT] [EVENT] bot: "NameBot" has been launched.
• Look for the confirmation code in the console output and copy it:
  [PROGRAM] [EVENT] confirmation code: 255127673...
• Open a private chat with your bot in Telegram and click Start.
• Claim ownership by sending the following command with your copied code:
  /addAdmin 255127673...

The bot will reply: you have become a bot owner. You are now the owner of the bot and have full access to its functionality!

⌨️ Usage

Bot Commands

Syntax guide:

• Parameters: < > = required, [ ] = optional.
• Location: 🔒 = private chat, 👥 = groups.
• Access: 👑 = owner, 🛡️ = admin, 👤 = guest.

Command & Parameters	Location	Access	Description
/start	🔒	👑🛡️👤	Show available commands
/groups	🔒	👑🛡️	List all groups containing the bot
/setGroupUniqueTitle <OldUniqueTitle> <NewUniqueTitle>	🔒	👑	Change the uniqueTitle for a group
/admins	🔒	👑🛡️	List all bot administrators
/addAdmin [AdminConfirmationCode]	🔒	👑👤	👑: Generate an AdminConfirmationCode. 👤: Become the owner (if none exists) or an admin by entering the confirmation code
/removeAdmin <AdminNumber>	🔒	👑	Remove an admin using their index number from /admins. Always use /admins first to get the correct number.
/setWarnMuteSettings <QuantityWarnToMute>	🔒	👑🛡️	Set the number of warnings after which a group member will be muted. Default: 3. Mute duration (days) = Fibonacci(UserWarns−QuantityWarnToMute). Example: If QuantityWarnToMute is 3 and the user receives the 7th warning, mute is Fibonacci(4) = 3 days
/setWarnBanSettings <QuantityWarnToBan>	🔒	👑🛡️	Set the number of warnings before banning a group member. Default: 5
/botActive	👥	👑	Activates the bot. The bot begins executing commands in the group
/botDeactive	👥	👑	Deactivate the bot. The bot stops executing commands in the group
/addWarn [QuantityWarns]	👥	👑🛡️	Add the specified number of warnings to a member. Default: 1. Must be used as a reply to a user's message
/removeWarn [QuantityWarns]	👥	👑🛡️	Remove the specified number of warnings to a member. Default: 1. Must be used as a reply to a user's message
/setWarn <QuantityWarns>	👥	👑🛡️	Set the specified number of warnings for a member. Must be used as a reply to a user's message
/viewWarn	👥	👑🛡️	Check the current number of warnings for a member. Must be used as a reply to a user's message

Parameters Reference:

• UniqueTitle: A unique string (1-32 characters). Allowed: A-z, 0-9, and underscore _.
• AdminConfirmationCode: A unique 32-character numeric verification string.
• AdminNumber: The specific index number retrieved from the /admins list.
• QuantityWarns: An integer. Warns: cannot be negative.

🕛 TODO

• Linux support
• Full multithreading
• Logging to a file
• Improving the informativeness of logging
• Improving the bot's functionality
• Improving the bot's usability

🤝 Contribution

• Found a bug or have a suggestion? Feel free to open an issues.

• If you want to support the project, please give it a star. ⭐