Update .renovaterc

Reviewed-on: #46

.renovaterc

@@ -2,5 +2,19 @@
     "$schema": "https://docs.renovatebot.com/renovate-schema.json",
     "extends": [
         "config:base"
+    ],
+    "baseBranches": [
+        "dev"
+    ],
+    "packageRules": [
+        {
+            "matchUpdateTypes": [
+                "minor",
+                "patch",
+                "pin",
+                "digest"
+            ],
+            "automerge": true
+        }
     ]
 }

classes/callbacks.py

@@ -9,7 +9,7 @@ class CallbackVerify:
 
     @classmethod
     def from_callback(cls, callback: CallbackQuery):
-        action, user_id = str(callback.data).split(";")
+        action, user_id = str(callback.data).split(":")
         if action.lower() != "verify":
             raise ValueError("Callback provided is not a verification callback")
         return cls(int(user_id))
@@ -22,7 +22,7 @@ class CallbackEmoji:
 
     @classmethod
     def from_callback(cls, callback: CallbackQuery):
-        action, user_id, emoji = str(callback.data).split(";")
+        action, user_id, emoji = str(callback.data).split(":")
         if action.lower() != "emoji":
             raise ValueError("Callback provided is not an emoji button callback")
         return cls(int(user_id), emoji)
@@ -34,7 +34,7 @@ class CallbackBan:
 
     @classmethod
     def from_callback(cls, callback: CallbackQuery):
-        action, user_id = str(callback.data).split(";")
+        action, user_id = str(callback.data).split(":")
         if action.lower() != "ban":
             raise ValueError("Callback provided is not a ban callback")
         return cls(int(user_id))
@@ -46,7 +46,7 @@ class CallbackLanguage:
 
     @classmethod
     def from_callback(cls, callback: CallbackQuery):
-        action, language = str(callback.data).split(";")
+        action, language = str(callback.data).split(":")
         if action.lower() != "language":
             raise ValueError("Callback provided is not a language callback")
         return cls(language)

classes/pyroclient.py

@@ -1,30 +1,37 @@
 from typing import Union
 
-from libbot.pyrogram.classes import PyroClient
+from libbot.pyrogram.classes import PyroClient as LibPyroClient
 from pyrogram.types import User
 
+from classes.pyrogroup import PyroGroup
 from classes.pyrouser import PyroUser
-from modules.database import col_users
 
 
-class PyroClient(PyroClient):
-    async def find_user(self, user: Union[int, User], group: int) -> PyroUser:
-        """Find User by it's ID or User object
+class PyroClient(LibPyroClient):
+    async def find_user(self, user: Union[int, User], *args, **kwargs) -> PyroUser:
+        """Find User by it's ID or User object.
 
         ### Args:
             * user (`Union[int, User]`): ID or User object to extract ID from
-            * group (`int`): ID of the group
 
         ### Returns:
             * `PyroUser`: PyroUser object
         """
-        db_record = await col_users.find_one(
-            {"id": user.id if isinstance(user, User) else user, "group": group}
+
+        return (
+            await PyroUser.find(user, *args, **kwargs)
+            if isinstance(user, int)
+            else await PyroUser.find(user.id, *args, **kwargs)
         )
 
-        if db_record is None:
-            raise KeyError(
-                f"User with ID {user.id if isinstance(user, User) else user} was not found in the database"
-            )
+    async def find_group(self, id: int, *args, **kwargs) -> PyroGroup:
+        """Find Group by it's ID.
 
-        return PyroUser(**db_record)
+        ### Args:
+            * id (`int`): Group ID
+
+        ### Returns:
+            * `PyroGroup`: PyroGroup object
+        """
+
+        return await PyroGroup.find(id, *args, **kwargs)

classes/pyrogroup.py

@@ -3,9 +3,10 @@ from dataclasses import dataclass
 from typing import Union
 
 from bson import ObjectId
+from libbot import sync
+from libbot.pyrogram.classes import PyroClient
 from pyrogram.types import User
 
-from classes.pyroclient import PyroClient
 from modules.database import col_groups
 
 logger = logging.getLogger(__name__)
@@ -15,35 +16,56 @@ logger = logging.getLogger(__name__)
 class PyroGroup:
     """Dataclass of DB entry of a group"""
 
-    __slots__ = ("_id", "id", "locale", "locale_auto")
+    __slots__ = (
+        "_id",
+        "id",
+        "locale",
+        "locale_auto",
+        "ban_failed",
+        "timeout_join",
+        "timeout_verify",
+    )
 
     _id: ObjectId
     id: int
     locale: Union[str, None]
     locale_auto: bool
+    ban_failed: bool
+    timeout_join: int
+    timeout_verify: int
 
     @classmethod
-    async def create_if_not_exists(
+    async def find(
         cls,
-        id: int,
-        locale: Union[str, None] = None,
-        locale_auto: bool = True,
+        id: Union[int, float],
+        locale: Union[str, None] = sync.config_get("locale", "defaults", "group"),
+        locale_auto: bool = sync.config_get("locale_auto", "defaults", "group"),
+        ban_failed: bool = sync.config_get("ban_failed", "defaults", "group"),
+        timeout_join: int = sync.config_get("timeout_join", "defaults", "group"),
+        timeout_verify: int = sync.config_get("timeout_verify", "defaults", "group"),
     ):
         db_entry = await col_groups.find_one(
             {
                 "id": id,
             }
         )
+
         if db_entry is None:
             inserted = await col_groups.insert_one(
-                {"id": id, "locale": locale, "locale_auto": locale_auto}
+                {
+                    "id": int(id),
+                    "locale": locale,
+                    "locale_auto": locale_auto,
+                    "ban_failed": ban_failed,
+                    "timeout_join": timeout_join,
+                    "timeout_verify": timeout_verify,
+                }
             )
-            db_entry = {
-                "_id": inserted.inserted_id,
-                "id": id,
-                "locale": locale,
-                "locale_auto": locale_auto,
-            }
+            db_entry = await col_groups.find_one({"_id": inserted.inserted_id})
+
+        if db_entry is None:
+            raise RuntimeError("Could not find inserted group entry.")
+
         return cls(**db_entry)
 
     async def set_locale(self, locale: Union[str, None]) -> None:
@@ -60,11 +82,43 @@ class PyroGroup:
             {"_id": self._id}, {"$set": {"locale_auto": enabled}}
         )
 
+    async def set_ban_failed(self, enabled: bool) -> None:
+        logger.debug(
+            "Banning users that failed the captcha in group %s has been set to %s",
+            self.id,
+            enabled,
+        )
+        await col_groups.update_one(
+            {"_id": self._id}, {"$set": {"ban_failed": enabled}}
+        )
+
+    async def set_timeout_join(self, timeout: int) -> None:
+        logger.debug(
+            "Join timeout in group %s has been set to %s",
+            self.id,
+            timeout,
+        )
+        await col_groups.update_one(
+            {"_id": self._id}, {"$set": {"timeout_join": timeout}}
+        )
+
+    async def set_timeout_verify(self, timeout: int) -> None:
+        logger.debug(
+            "Verification timeout in group %s has been set to %s",
+            self.id,
+            timeout,
+        )
+        await col_groups.update_one(
+            {"_id": self._id}, {"$set": {"timeout_verify": timeout}}
+        )
+
     # Group settings
     # User locale
     def select_locale(
-        self, app: PyroClient, user: Union[User, None] = None, ignore_auto: bool = False
+        self, app: PyroClient, user: User, ignore_auto: bool = False
     ) -> str:
+        if user is None:
+            return app.default_locale
         if not ignore_auto and self.locale_auto is True:
             if user.language_code is not None:
                 return user.language_code

classes/pyrouser.py

@@ -1,6 +1,6 @@
 import logging
 from dataclasses import dataclass
-from typing import List
+from typing import List, Union
 
 from bson import ObjectId
 
@@ -34,9 +34,9 @@ class PyroUser:
     mistakes: int
 
     @classmethod
-    async def create_if_not_exists(
+    async def find(
         cls,
-        id: int,
+        id: Union[int, float],
         group: int,
         failed: bool = False,
         emojis: List[str] = [],
@@ -45,10 +45,11 @@ class PyroUser:
         mistakes: int = 0,
     ):
         db_entry = await col_users.find_one({"id": id, "group": group})
+
         if db_entry is None:
             inserted = await col_users.insert_one(
                 {
-                    "id": id,
+                    "id": int(id),
                     "group": group,
                     "failed": failed,
                     "emojis": emojis,
@@ -57,16 +58,11 @@ class PyroUser:
                     "mistakes": mistakes,
                 }
             )
-            db_entry = {
-                "_id": inserted.inserted_id,
-                "id": id,
-                "group": group,
-                "failed": failed,
-                "emojis": emojis,
-                "selected": selected,
-                "score": 0,
-                "mistakes": mistakes,
-            }
+            db_entry = await col_users.find_one({"_id": inserted.inserted_id})
+
+        if db_entry is None:
+            raise RuntimeError("Could not find inserted user entry.")
+
         return cls(**db_entry)
 
     async def set_failed(self, failed: bool = True) -> None:
@@ -85,6 +81,10 @@ class PyroUser:
         logger.debug("%s's mistakes count has been set to %s", self.id, mistakes)
         await col_users.update_one({"_id": self._id}, {"$set": {"mistakes": mistakes}})
 
+    async def set_selected(self, emojis: List[str] = None) -> None:
+        logger.debug("%s's elected emojis have been set to %s", self.id, emojis)
+        await col_users.update_one({"_id": self._id}, {"$set": {"selected": emojis}})
+
     async def update_score(self, points: int = 1) -> None:
         logger.debug("%s point(s) have been added to %s score", points, self.id)
         await col_users.update_one(

config_example.json

@@ -19,9 +19,14 @@
         "port": 27017,
         "name": "captchabot"
     },
-    "timeouts": {
-        "join": 2,
-        "verify": 3
+    "defaults": {
+        "group": {
+            "locale": null,
+            "locale_auto": true,
+            "ban_failed": true,
+            "timeout_join": 180,
+            "timeout_verify": 300
+        }
     },
     "whitelist": {
         "enabled": false,
@@ -106,6 +111,20 @@
         "🙊"
     ],
     "commands": {
+        "help": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeDefault"
+                }
+            ]
+        },
+        "ban_failed": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeAllChatAdministrators"
+                }
+            ]
+        },
         "language": {
             "scopes": [
                 {
@@ -119,6 +138,20 @@
                     "name": "BotCommandScopeAllChatAdministrators"
                 }
             ]
+        },
+        "timeout_join": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeAllChatAdministrators"
+                }
+            ]
+        },
+        "timeout_verify": {
+            "scopes": [
+                {
+                    "name": "BotCommandScopeAllChatAdministrators"
+                }
+            ]
         }
     }
 }

locale/de.json

@@ -0,0 +1,54 @@
+{
+    "metadata": {
+        "flag": "🇩🇪",
+        "name": "Deutsch",
+        "selectable": true,
+        "codes": [
+            "de",
+            "de-AT",
+            "de-CH",
+            "de-DE",
+            "de-LI",
+            "de-LU"
+        ]
+    },
+    "commands": {
+        "help": "Nützliche Informationen anzeigen",
+        "ban_failed": "Umschaltverbot bei fehlender Verifizierung",
+        "language": "Sprache des Bots in dieser Gruppe einstellen",
+        "language_auto": "Automatische Sprachwahl umschalten",
+        "timeout_join": "Zeitlimit für die Anmeldung festlegen",
+        "timeout_verify": "Zeitlimit für die Überprüfung festlegen"
+    },
+    "messages": {
+        "help": "Hallo! Dieser Bot kann Ihnen helfen, sich gegen nervige Bots zu schützen, indem er Emoji-Captchas beim Beitritt erzwingt.\n\nFügen Sie diesen Bot zu Ihrer gewünschten Gruppe hinzu und geben Sie ihm die Berechtigungen **Nachrichten löschen** und **Benutzer sperren**.\n\nVerfügbare Kommandos:\n• /ban_failed - Bannen bei Zeitüberschreitung oder fehlgeschlagenem Captcha umschalten\n• /language - Sprache des Bots ändern\n• /language_auto - automatische Sprache pro Benutzer umschalten\n\nKommandos, die oben aufgelistet sind, müssen in der Gruppe von ihren Admins oder dem Besitzer ausgeführt werden.\n\nDieser Bot ist Open Source, also können Sie ihn selbst hosten oder nach Ihren Wünschen verändern: https://git.end-play.xyz/profitroll/EmojiCaptchaBot\n\nWenn Sie einen Fehler melden oder einen Vorschlag machen möchten – besuchen Sie die [Problemseite](https://git.end-play.xyz/profitroll/EmojiCaptchaBot/issues) des Bots auf git.\n\nEinen schönen Tag noch :)",
+        "ban_failed_disabled": "Bann bei Fehlschlag wurde **deaktiviert**. Wenn Benutzer die Überprüfung ignorieren oder sie nicht bestehen, bleiben sie in der Gruppe nur zum Lesen zugelassen.",
+        "ban_failed_enabled": "Bann bei Fehlschlag wurde **aktiviert**. Wenn Benutzer die Überprüfung ignorieren oder sie nicht bestehen, werden sie sofort aus der Gruppe geworfen und gesperrt.",
+        "locale_auto_disabled": "Die automatische Sprachauswahl auf individueller Basis wurde **deaktiviert**. Bitte beachten Sie, dass jetzt die Sprache der Gruppe verwendet wird. Sie können sie mit /language ändern. Wenn \"Standard\" als Sprache eingestellt ist, wird die Standardsprache des Bots ({default_locale}) verwendet.",
+        "locale_auto_enabled": "Die automatische Sprachauswahl auf individueller Basis wurde **aktiviert**. Bitte beachten Sie, dass die Standardsprache der Gruppe oder des Bots verwendet wird, wenn der Bot kein Sprachpaket für den Benutzer hat. Sie können die Sprache der Gruppe mit /language ändern. Wenn \"Standard\" als Sprache eingestellt ist, wird die Standardsprache des Bots ({default_locale}) verwendet.",
+        "locale_choice": "Okay. Bitte wählen Sie die Sprache mit der Tastatur unten aus.\n\nBitte beachten Sie, dass Sie auch die automatische Sprachauswahl für jeden Benutzer mit dem Befehl /language_auto",
+        "permission_denied": "Dies ist Ihnen nicht erlaubt.",
+        "timeout_invalid_number": "Timeout muss ein ganzzahliger Wert im zwischen 10 und 600 (Sekunden) sein.",
+        "timeout_join_invalid": "Falsche Verwendung! Richtiges Beispiel:\n`/timeout_join SEKUNDEN`",
+        "timeout_join_set": "Join-Timeout wurde eingestellt: {timeout} Sek.",
+        "timeout_verify_invalid": "Falsche Verwendung! Richtiges Beispiel:\n`/timeout_verify SEKUNDEN`",
+        "timeout_verify_set": "Zeitüberschreitung für die Verifizierung wurde eingestellt: {timeout} Sek.",
+        "verify": "Bitte benutzen Sie die unten stehenden Tasten, um das Captcha auszufüllen. Tippen Sie auf die Tasten mit den Emojis, die Sie auf diesem Bild sehen.",
+        "welcome_verify": "Willkommen, {mention}! Um hier chatten zu können, müssen wir verifizieren, dass Sie ein Mensch sind. Bitte klicke auf die untenstehende Taste, um die Verifizierung zu starten.",
+        "welcome": "Willkommen zum Chat, {mention}!"
+    },
+    "callbacks": {
+        "captcha_failed_force": "Sie haben den Benutzer {user_id} gezwungen, das Captcha nicht zu bestehen.",
+        "captcha_failed": "Sie haben das Captcha nicht bestanden.",
+        "captcha_mistake": "Falsche Antwort. Restliche Versuche: {remaining}.",
+        "captcha_passed": "Sie haben das Captcha bestanden. Willkommen!",
+        "locale_set": "Die Sprache in dieser Gruppe ist jetzt: {locale}",
+        "nothing": "Diese Aktion ist schon abgeschlossen.",
+        "wrong_user": "Diese Nachricht ist nicht für Sie gedacht."
+    },
+    "buttons": {
+        "ban": "Bannen (für Admins)",
+        "locale_default": "Standard",
+        "verify": "Sich verifizieren"
+    }
+}

locale/en.json

@@ -2,22 +2,35 @@
     "metadata": {
         "flag": "🇬🇧",
         "name": "English",
+        "selectable": true,
         "codes": [
             "en",
-            "en-US",
-            "en-GB"
+            "en-GB",
+            "en-US"
         ]
     },
     "commands": {
+        "help": "Show some helpful info",
+        "ban_failed": "Toggle ban on verification fail",
+        "language_auto": "Toggle automatic language selection",
         "language": "Set bot's language in this group",
-        "language_auto": "Toggle automatic language selection"
+        "timeout_join": "Set join timeout",
+        "timeout_verify": "Set verification timeout"
     },
     "messages": {
-        "locale_auto_disabled": "Automatic language selection on per-user basis has been **disabled**. Please note that group's language will now be used. You can change it using /language. If \"Default\" language is set – bot's default language ({default_locale}) will be used.",
-        "locale_auto_enabled": "Automatic language selection on per-user basis has been **enabled**. Please note that if bot does not have a language pack for user – group's or bot's default language will be used. You can change group's language using /language. If \"Default\" language is set – bot's default language ({default_locale}) will be used.",
-        "locale_choice": "Alright. Please choose the language using keyboard below.\n\nNote, that you can also enable automatic language selection on per-user basis using command /language_auto",
+        "help": "Hi! This bot can help you protect against annoying bots by enforcing emoji captcha on join.\n\nIn order to it, add this bot to your desired group and provide it with **Delete Messages** and **Ban Users** permissions.\n\nAvailable commands:\n• /ban_failed - toggle banning on timeout or captcha fail\n• /language - change bot's language\n• /language_auto - toggle automatic per-user language\n• /timeout_join - set timeout time on join (in seconds)\n• /timeout_verify - set timeout for verification (in seconds)\n\nCommands listed above must be executes in group by its admins or owner.\n\nThis bot is open source, so feel free to host it yourself or modify to your liking: https://git.end-play.xyz/profitroll/EmojiCaptchaBot\n\nIf you want to file an issue or make a suggestion – visit bot's [issues page](https://git.end-play.xyz/profitroll/EmojiCaptchaBot/issues) on bot's git.\n\nHave a nice day :)",
+        "ban_failed_disabled": "Ban on fail has been **disabled**. If users ignore verification or fail it, they will remain read-only in the group.",
+        "ban_failed_enabled": "Ban on fail has been **enabled**. If users ignore verification or fail it, they will be immediately kicked from the group and banned.",
+        "locale_auto_disabled": "Automatic language selection on a per-user basis has been **disabled**. Please note that the group's language will now be used. You can change it using /language. If \"Default\" language is set, bot's default language ({default_locale}) will be used.",
+        "locale_auto_enabled": "Automatic language selection on a per-user basis has been **enabled**. Please note that if bot does not have a language pack for user – group's or bot's default language will be used. You can change group's language using /language. If \"Default\" language is set, bot's default language ({default_locale}) will be used.",
+        "locale_choice": "Alright. Please choose the language using the keyboard below.\n\nNote, that you can also enable automatic language selection on a per-user basis using the command /language_auto",
         "permission_denied": "You are not allowed to do so.",
-        "verify": "Please, use the buttons below to complete the captcha. Tap on the buttons with emojis you see on this image.",
+        "timeout_invalid_number": "Timeout must be an integer value in the range 10 to 600 (seconds).",
+        "timeout_join_invalid": "Wrong usage! Correct example:\n`/timeout_join SECONDS`",
+        "timeout_join_set": "Join timeout has been set: {timeout} sec.",
+        "timeout_verify_invalid": "Wrong usage! Correct example:\n`/timeout_verify SECONDS`",
+        "timeout_verify_set": "Verification timeout has been set: {timeout} sec.",
+        "verify": "Please, use the buttons below to complete the captcha. Tap on the buttons with emojis you see in this image.",
         "welcome_verify": "Welcome, {mention}! In order to chat here, we need to verify you're a human. Please, press the button below to start the verification.",
         "welcome": "Welcome to the chat, {mention}!"
     },
@@ -27,7 +40,7 @@
         "captcha_mistake": "Invalid answer. Remaining attempts: {remaining}.",
         "captcha_passed": "You have passed the captcha. Welcome!",
         "locale_set": "Group's language is now: {locale}",
-        "nothing": "This actions has already been finished.",
+        "nothing": "This action has already been finished.",
         "wrong_user": "This message is not for you."
     },
     "buttons": {

locale/uk.json

@@ -2,20 +2,33 @@
     "metadata": {
         "flag": "🇺🇦",
         "name": "Українська",
+        "selectable": true,
         "codes": [
             "uk",
             "uk-UA"
         ]
     },
     "commands": {
+        "help": "Показати корисну інформацію",
+        "ban_failed": "Перемикнути бан при невдалій верифікації",
         "language": "Встановити мову бота в цій групі",
-        "language_auto": "Переключити автоматичний вибір мови"
+        "language_auto": "Перемикнути автоматичний вибір мови",
+        "timeout_join": "Встановити таймаут приєднання",
+        "timeout_verify": "Встановити таймаут перевірки"
     },
     "messages": {
+        "help": "Привіт! Цей бот допоможе вам захиститися від настирливих ботів, запровадивши емодзі-капчу при вході в групу.\n\nДля цього додайте цього бота в потрібну вам групу і надайте йому права **Видаляти повідомлення** та **Банити користувачів**.\n\nДоступні команди:\n• /ban_failed - увімкнути заборону після таймауту або невдалого введення капчі\n• /language - змінити мову бота\n• /language_auto - перемкнути автоматичну мову для кожного користувача\n\nКоманди, перераховані вище, повинні виконуватися в групі її адміністраторами або власником.\n\nЦей бот має відкритий вихідний код, тому ви можете хостити його самостійно або модифікувати під себе: https://git.end-play.xyz/profitroll/EmojiCaptchaBot\n\nЯкщо ви хочете повідомити про проблему або внести пропозицію – відвідайте [сторінку підтримки бота](https://git.end-play.xyz/profitroll/EmojiCaptchaBot/issues) на гіті бота.\n\nГарного дня :)",
+        "ban_failed_disabled": "Блокування при невдалій верифікації було **вимкнено**. Якщо користувачі проігнорують верифікацію або не пройдуть її, вони залишаться в групі тільки для читання.",
+        "ban_failed_enabled": "Блокування при невдачі було **увімкнено**. Якщо користувач проігнорує верифікацію або не пройде її, його буде негайно вигнано з групи та забанено.",
         "locale_auto_disabled": "Автоматичний вибір мови для кожного користувача було **вимкнено**. Зверніть увагу, що тепер буде використовуватися мова групи. Ви можете змінити її за допомогою /language. Якщо встановлено мову \"За замовчуванням\" – буде використовуватися мова бота за замовчуванням ({default_locale}).",
         "locale_auto_enabled": "Автоматичний вибір мови для кожного користувача був **увімкнений**. Зверніть увагу, що якщо бот не має мовного пакета для користувача – буде використовуватися мова групи або бота за замовчуванням. Ви можете змінити мову групи за допомогою /language. Якщо встановлено мову \"За замовчуванням\" – буде використовуватися мова бота за замовчуванням ({default_locale}).",
         "locale_choice": "Гаразд. Будь ласка, оберіть мову за допомогою клавіатури нижче.\n\nЗауважте, що ви також можете увімкнути автоматичний вибір мови для кожного користувача за допомогою команди /language_auto",
         "permission_denied": "Вам не дозволено робити це.",
+        "timeout_invalid_number": "Таймаут має бути цілим числом у діапазоні від 10 до 600 (секунд).",
+        "timeout_join_invalid": "Неправильне використання! Правильний приклад:\n`/timeout_join СЕКУНДИ`",
+        "timeout_join_set": "Встановлено тайм-аут приєднання: {timeout} сек.",
+        "timeout_verify_invalid": "Неправильне використання! Правильний приклад:\n`/timeout_verify СЕКУНДИ`",
+        "timeout_verify_set": "Встановлено таймаут перевірки: {timeout} сек.",
         "verify": "Будь ласка, використовуйте кнопки нижче, щоб заповнити капчу. Натисніть на кнопки зі смайликами, які ви бачите на цьому зображенні.",
         "welcome_verify": "Ласкаво просимо, {mention}! Для того, щоб спілкуватися в чаті, ми повинні переконатися, що ви людина. Будь ласка, натисніть кнопку нижче, щоб почати перевірку.",
         "welcome": "Ласкаво просимо до чату, {mention}!"

modules/database.py

@@ -1,11 +1,9 @@
 """Module that provides all database columns"""
 
 from async_pymongo import AsyncClient
-from ujson import loads
+from libbot import sync
 
-with open("config.json", "r", encoding="utf-8") as f:
-    db_config = loads(f.read())["database"]
-    f.close()
+db_config = sync.config_get("database")
 
 if db_config["user"] is not None and db_config["password"] is not None:
     con_string = "mongodb://{0}:{1}@{2}:{3}/{4}".format(
@@ -23,12 +21,6 @@ else:
 db_client = AsyncClient(con_string)
 db = db_client.get_database(name=db_config["name"])
 
-# collections = db.list_collection_names()
-
-# for collection in ["users", "groups", "schedule"]:
-#     if collection not in collections:
-#         db.create_collection(collection)
-
 col_users = db.get_collection("users")
 col_groups = db.get_collection("groups")
 col_schedule = db.get_collection("schedule")

modules/kicker.py

@@ -7,13 +7,16 @@ async def kick_unstarted(
     app: PyroClient, user_id: int, group_id: int, message_id: int
 ) -> None:
     user = await app.find_user(user_id, group_id)
+    group = await app.find_group(group_id)
 
     if user.score == 0 and user.failed == 0:
-        banned = await app.ban_chat_member(group_id, user_id)
+        if group.ban_failed:
+            banned = await app.ban_chat_member(group_id, user_id)
 
-        if isinstance(banned, Message):
-            await banned.delete()
+            if isinstance(banned, Message):
+                await banned.delete()
 
+        await user.set_failed(True)
         await app.delete_messages(group_id, message_id)
 
 
@@ -21,11 +24,14 @@ async def kick_unverified(
     app: PyroClient, user_id: int, group_id: int, message_id: int
 ) -> None:
     user = await app.find_user(user_id, group_id)
+    group = await app.find_group(group_id)
 
     if user.score < 6 or user.failed:
-        banned = await app.ban_chat_member(group_id, user_id)
+        if group.ban_failed:
+            banned = await app.ban_chat_member(group_id, user_id)
 
-        if isinstance(banned, Message):
-            await banned.delete()
+            if isinstance(banned, Message):
+                await banned.delete()
 
+        await user.set_failed(True)
         await app.delete_messages(group_id, message_id)

modules/utils.py

@@ -1,12 +1,16 @@
 from io import BytesIO
 from pathlib import Path
 from random import randint, sample
-from typing import List
+from typing import List, Union
 
 from huepaper import generate
 from PIL import Image
+from pyrogram.enums.chat_member_status import ChatMemberStatus
+from pyrogram.types import CallbackQuery, Message
 
 from classes.captcha import Captcha
+from classes.pyroclient import PyroClient
+from classes.pyrogroup import PyroGroup
 
 
 def get_captcha_image(emojis: List[str]) -> Captcha:
@@ -49,3 +53,40 @@ def get_captcha_image(emojis: List[str]) -> Captcha:
     base_img.save(output, format="jpeg")
 
     return Captcha(output, emojis_all, emojis_correct)
+
+
+async def is_permitted(
+    app: PyroClient,
+    group: PyroGroup,
+    message: Union[Message, None] = None,
+    callback: Union[CallbackQuery, None] = None,
+) -> bool:
+    """Check if User is an admin or a creator of a group. Alternatively, if the User is actually a group itself.
+
+    ### Args:
+        * app (`PyroClient`): Pyrogram Client
+        * group (`PyroGroup`): Group
+        * message (`Union[Message, None]`, *optional*): Message if the request originates from a command. Defaults to `None`.
+        * callback (`Union[CallbackQuery, None]`, *optional*): CallbackQuery if the request originates from a callback. Defaults to `None`.
+
+    ### Returns:
+        * `bool`: `True` if permitted and `False` if not. Also `False` if no message or callback provided.
+    """
+    if message is not None:
+        return (
+            message.sender_chat is not None and message.sender_chat.id == group.id
+        ) or (
+            message.from_user is not None
+            and (await app.get_chat_member(group.id, message.from_user.id)).status
+        ) in [
+            ChatMemberStatus.ADMINISTRATOR,
+            ChatMemberStatus.OWNER,
+        ]
+
+    if callback is not None:
+        return (await app.get_chat_member(group.id, callback.from_user.id)).status in [
+            ChatMemberStatus.ADMINISTRATOR,
+            ChatMemberStatus.OWNER,
+        ]
+
+    return False

plugins/callbacks/ban.py

@@ -1,25 +1,21 @@
 import logging
 
 from pyrogram import filters
-from pyrogram.enums.chat_member_status import ChatMemberStatus
 from pyrogram.types import CallbackQuery, Message
 
 from classes.callbacks import CallbackBan
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
+from modules.utils import is_permitted
 
 logger = logging.getLogger(__name__)
 
 
-@PyroClient.on_callback_query(filters.regex(r"ban;[\s\S]*"))
+@PyroClient.on_callback_query(filters.regex(r"ban:[\s\S]*"))  # type: ignore
 async def callback_ban(app: PyroClient, callback: CallbackQuery):
-    group = await PyroGroup.create_if_not_exists(callback.message.chat.id, None, True)
+    group = await app.find_group(callback.message.chat.id)
     locale = group.select_locale(app, callback.message.from_user)
 
-    if (await app.get_chat_member(group.id, callback.from_user.id)).status not in [
-        ChatMemberStatus.ADMINISTRATOR,
-        ChatMemberStatus.OWNER,
-    ]:
+    if not (await is_permitted(app, group, callback=callback)):
         await callback.answer(
             app._("wrong_user", "callbacks", locale=locale), show_alert=True
         )

plugins/callbacks/emoji_button.py

@@ -11,15 +11,14 @@ from pyrogram.types import (
 
 from classes.callbacks import CallbackEmoji
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
 
 logger = logging.getLogger(__name__)
 
 
-@PyroClient.on_callback_query(filters.regex(r"emoji;[\s\S]*"))
+@PyroClient.on_callback_query(filters.regex(r"emoji:[\s\S]*"))  # type: ignore
 async def callback_emoji_button(app: PyroClient, callback: CallbackQuery):
     parsed = CallbackEmoji.from_callback(callback)
-    group = await PyroGroup.create_if_not_exists(callback.message.chat.id, None, True)
+    group = await app.find_group(callback.message.chat.id)
     locale = group.select_locale(app, callback.message.from_user)
 
     if callback.from_user.id != parsed.user_id:
@@ -62,7 +61,7 @@ async def callback_emoji_button(app: PyroClient, callback: CallbackQuery):
             await app.restrict_chat_member(
                 chat_id=group.id,
                 user_id=callback.from_user.id,
-                permissions=ChatPermissions(can_send_messages=True),
+                permissions=callback.message.chat.permissions,
             )
             return
 
@@ -82,10 +81,11 @@ async def callback_emoji_button(app: PyroClient, callback: CallbackQuery):
                 app._("captcha_failed", "callbacks", locale=locale), show_alert=True
             )
 
-            banned = await app.ban_chat_member(group.id, callback.from_user.id)
+            if group.ban_failed:
+                banned = await app.ban_chat_member(group.id, callback.from_user.id)
 
-            if isinstance(banned, Message):
-                await banned.delete()
+                if isinstance(banned, Message):
+                    await banned.delete()
 
             await callback.message.delete()
             return

plugins/callbacks/nothing.py

@@ -2,12 +2,11 @@ from pyrogram import filters
 from pyrogram.types import CallbackQuery
 
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
 
 
-@PyroClient.on_callback_query(filters.regex(r"nothing"))
+@PyroClient.on_callback_query(filters.regex(r"nothing"))  # type: ignore
 async def callback_nothing(app: PyroClient, callback: CallbackQuery):
-    group = await PyroGroup.create_if_not_exists(callback.message.chat.id, None, True)
+    group = await app.find_group(callback.message.chat.id)
     locale = group.select_locale(app, callback.message.from_user)
 
     await callback.answer(app._("nothing", "callbacks", locale=locale))

plugins/callbacks/verify.py

@@ -9,7 +9,6 @@ from pyrogram.types import CallbackQuery
 
 from classes.callbacks import CallbackVerify
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
 from modules.database import col_schedule
 from modules.kicker import kick_unverified
 from modules.utils import get_captcha_image
@@ -17,10 +16,10 @@ from modules.utils import get_captcha_image
 logger = logging.getLogger(__name__)
 
 
-@PyroClient.on_callback_query(filters.regex(r"verify;[\s\S]*"))
+@PyroClient.on_callback_query(filters.regex(r"verify:[\s\S]*"))  # type: ignore
 async def callback_verify(app: PyroClient, callback: CallbackQuery):
     parsed = CallbackVerify.from_callback(callback)
-    group = await PyroGroup.create_if_not_exists(callback.message.chat.id, None, True)
+    group = await app.find_group(callback.message.chat.id)
     locale = group.select_locale(app, callback.message.from_user)
 
     if callback.from_user.id != parsed.user_id:
@@ -50,7 +49,7 @@ async def callback_verify(app: PyroClient, callback: CallbackQuery):
     await user.set_emojis(captcha.emojis_correct)
 
     buttons = [
-        InlineButton(emoji, f"emoji;{user.id};{emoji}") for emoji in captcha.emojis_all
+        InlineButton(emoji, f"emoji:{user.id}:{emoji}") for emoji in captcha.emojis_all
     ]
 
     keyboard = InlineKeyboard(3)
@@ -72,6 +71,5 @@ async def callback_verify(app: PyroClient, callback: CallbackQuery):
             kick_unverified,
             "date",
             [app, user.id, group.id, captcha_message.id],
-            run_date=datetime.now()
-            + timedelta(seconds=app.config["timeouts"]["verify"]),
+            run_date=datetime.now() + timedelta(seconds=group.timeout_verify),
         )

plugins/commands/ban_failed.py

@@ -0,0 +1,40 @@
+import logging
+
+from pyrogram import filters
+from pyrogram.types import Message
+
+from classes.pyroclient import PyroClient
+from modules.utils import is_permitted
+
+logger = logging.getLogger(__name__)
+
+
+@PyroClient.on_message(
+    ~filters.scheduled
+    & filters.group
+    & filters.command(["ban_failed"], prefixes=["/"])  # type: ignore
+)
+async def command_ban_failed(app: PyroClient, message: Message):
+    group = await app.find_group(message.chat.id)
+    locale = group.select_locale(app, message.from_user)
+
+    if not (await is_permitted(app, group, message=message)):
+        await message.reply_text(
+            app._("permission_denied", "messages", locale=locale), quote=True
+        )
+        return
+
+    if group.ban_failed:
+        await message.reply_text(
+            app._("ban_failed_disabled", "messages", locale=locale)
+        )
+    else:
+        await message.reply_text(app._("ban_failed_enabled", "messages", locale=locale))
+
+    logger.info(
+        "Ban on fail in group %s has been set to %s",
+        group.id,
+        not group.ban_failed,
+    )
+
+    await group.set_ban_failed(not group.ban_failed)

plugins/commands/help.py

@@ -0,0 +1,20 @@
+import logging
+
+from pyrogram import filters
+from pyrogram.types import Message
+
+from classes.pyroclient import PyroClient
+
+logger = logging.getLogger(__name__)
+
+
+@PyroClient.on_message(
+    ~filters.scheduled
+    & filters.private
+    & filters.command(["help", "start"], prefixes=["/"])  # type: ignore
+)
+async def command_help(app: PyroClient, message: Message):
+    await message.reply_text(
+        app._("help", "messages", locale=message.from_user.language_code),
+        disable_web_page_preview=True,
+    )

plugins/commands/language_auto.py

@@ -5,7 +5,7 @@ from pyrogram.enums.chat_member_status import ChatMemberStatus
 from pyrogram.types import Message
 
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
+from modules.utils import is_permitted
 
 logger = logging.getLogger(__name__)
 
@@ -15,14 +15,11 @@ logger = logging.getLogger(__name__)
     & filters.group
     & filters.command(["language_auto"], prefixes=["/"])  # type: ignore
 )
-async def command_language(app: PyroClient, message: Message):
-    group = await PyroGroup.create_if_not_exists(message.chat.id, None, True)
+async def command_language_auto(app: PyroClient, message: Message):
+    group = await app.find_group(message.chat.id)
     locale = group.select_locale(app, message.from_user)
 
-    if (await app.get_chat_member(group.id, message.from_user.id)).status not in [
-        ChatMemberStatus.ADMINISTRATOR,
-        ChatMemberStatus.OWNER,
-    ]:
+    if not (await is_permitted(app, group, message=message)):
         await message.reply_text(
             app._("permission_denied", "messages", locale=locale), quote=True
         )

plugins/commands/timeout_join.py

@@ -0,0 +1,51 @@
+import logging
+
+from pyrogram import filters
+from pyrogram.types import Message
+
+from classes.pyroclient import PyroClient
+from modules.utils import is_permitted
+
+logger = logging.getLogger(__name__)
+
+
+@PyroClient.on_message(
+    ~filters.scheduled
+    & filters.group
+    & filters.command(["timeout_join"], prefixes=["/"])  # type: ignore
+)
+async def command_timeout_join(app: PyroClient, message: Message):
+    group = await app.find_group(message.chat.id)
+    locale = group.select_locale(app, message.from_user)
+
+    if not (await is_permitted(app, group, message=message)):
+        await message.reply_text(
+            app._("permission_denied", "messages", locale=locale), quote=True
+        )
+        return
+
+    if len(message.command) < 2 or not message.command[1].isdigit():
+        await message.reply_text(
+            app._("timeout_join_invalid", "messages", locale=locale), quote=True
+        )
+        return
+
+    timeout = int(message.command[1])
+
+    if timeout < 10 or timeout > 600:
+        await message.reply_text(
+            app._("timeout_invalid_number", "messages", locale=locale), quote=True
+        )
+        return
+
+    await message.reply_text(
+        app._("timeout_join_set", "messages", locale=locale).format(timeout=timeout)
+    )
+
+    logger.info(
+        "Timeout on join in group %s has been set to %s",
+        group.id,
+        timeout,
+    )
+
+    await group.set_timeout_join(timeout)

plugins/commands/timeout_verify.py

@@ -0,0 +1,51 @@
+import logging
+
+from pyrogram import filters
+from pyrogram.types import Message
+
+from classes.pyroclient import PyroClient
+from modules.utils import is_permitted
+
+logger = logging.getLogger(__name__)
+
+
+@PyroClient.on_message(
+    ~filters.scheduled
+    & filters.group
+    & filters.command(["timeout_verify"], prefixes=["/"])  # type: ignore
+)
+async def command_timeout_verify(app: PyroClient, message: Message):
+    group = await app.find_group(message.chat.id)
+    locale = group.select_locale(app, message.from_user)
+
+    if not (await is_permitted(app, group, message=message)):
+        await message.reply_text(
+            app._("permission_denied", "messages", locale=locale), quote=True
+        )
+        return
+
+    if len(message.command) < 2 or not message.command[1].isdigit():
+        await message.reply_text(
+            app._("timeout_verify_invalid", "messages", locale=locale), quote=True
+        )
+        return
+
+    timeout = int(message.command[1])
+
+    if timeout < 10 or timeout > 600:
+        await message.reply_text(
+            app._("timeout_invalid_number", "messages", locale=locale), quote=True
+        )
+        return
+
+    await message.reply_text(
+        app._("timeout_verify_set", "messages", locale=locale).format(timeout=timeout)
+    )
+
+    logger.info(
+        "Verification timeout in group %s has been set to %s",
+        group.id,
+        timeout,
+    )
+
+    await group.set_timeout_verify(timeout)

plugins/handlers/bot_join.py

@@ -4,12 +4,11 @@ from pyrogram import filters
 from pyrogram.types import Message
 
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
 
 logger = logging.getLogger(__name__)
 
 
-@PyroClient.on_message(filters.new_chat_members & filters.group & filters.me)
+@PyroClient.on_message(filters.new_chat_members & filters.group & filters.me)  # type: ignore
 async def handler_bot_join(app: PyroClient, message: Message):
     logger.info("Bot has joined the group %s")
-    await PyroGroup.create_if_not_exists(message.chat.id, None, True)
+    await app.find_group(message.chat.id)

plugins/handlers/user_join.py

@@ -12,8 +12,6 @@ from pyrogram.types import (
 )
 
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
-from classes.pyrouser import PyroUser
 from modules.database import col_schedule
 from modules.kicker import kick_unstarted
 
@@ -21,10 +19,10 @@ logger = logging.getLogger(__name__)
 
 
 @PyroClient.on_message(
-    filters.new_chat_members & filters.group & ~filters.me & ~filters.bot
+    filters.new_chat_members & filters.group & ~filters.me & ~filters.bot  # type: ignore
 )
 async def handler_user_join(app: PyroClient, message: Message):
-    group = await PyroGroup.create_if_not_exists(message.chat.id, None, True)
+    group = await app.find_group(message.chat.id)
     locale = group.select_locale(app, message.from_user)
 
     if (
@@ -50,10 +48,11 @@ async def handler_user_join(app: PyroClient, message: Message):
                 "User %s has previously failed the captcha, kicking and banning him",
                 user.id,
             )
-            banned = await app.ban_chat_member(group.id, user.id)
+            if group.ban_failed:
+                banned = await app.ban_chat_member(group.id, user.id)
 
-            if isinstance(banned, Message):
-                await banned.delete()
+                if isinstance(banned, Message):
+                    await banned.delete()
 
             return
 
@@ -63,12 +62,15 @@ async def handler_user_join(app: PyroClient, message: Message):
         permissions=ChatPermissions(can_send_messages=False),
     )
 
-    user = await PyroUser.create_if_not_exists(message.from_user.id, group.id)
+    user = await app.find_user(message.from_user, group=group.id)
 
     if user.mistakes > 0 or user.score > 0:
         await user.set_score(0)
         await user.set_mistakes(0)
 
+    if len(user.selected) > 0:
+        await user.set_selected([])
+
     await asyncio.sleep(2)
     verification_request = await app.send_message(
         chat_id=group.id,
@@ -80,13 +82,13 @@ async def handler_user_join(app: PyroClient, message: Message):
                 [
                     InlineKeyboardButton(
                         app._("verify", "buttons", locale=locale),
-                        callback_data=f"verify;{user.id}",
+                        callback_data=f"verify:{user.id}",
                     )
                 ],
                 [
                     InlineKeyboardButton(
                         app._("ban", "buttons", locale=locale),
-                        callback_data=f"ban;{user.id}",
+                        callback_data=f"ban:{user.id}",
                     )
                 ],
             ],
@@ -98,8 +100,8 @@ async def handler_user_join(app: PyroClient, message: Message):
             kick_unstarted,
             "date",
             [app, user.id, verification_request.chat.id, verification_request.id],
-            run_date=datetime.now() + timedelta(seconds=app.config["timeouts"]["join"]),
+            run_date=datetime.now() + timedelta(seconds=group.timeout_join),
         )
         await col_schedule.insert_one(
-            {"user": user.id, "group": group.id, "job_id": job.id}
+            {"user": int(user.id), "group": int(group.id), "job_id": job.id}
         )

plugins/language.py

@@ -3,12 +3,11 @@ import logging
 from pykeyboard import InlineButton, InlineKeyboard
 from pyrogram import filters
 from pyrogram.client import Client
-from pyrogram.enums.chat_member_status import ChatMemberStatus
 from pyrogram.types import CallbackQuery, Message
 
 from classes.callbacks import CallbackLanguage
 from classes.pyroclient import PyroClient
-from classes.pyrogroup import PyroGroup
+from modules.utils import is_permitted
 
 logger = logging.getLogger(__name__)
 
@@ -17,29 +16,24 @@ logger = logging.getLogger(__name__)
     ~filters.scheduled & filters.group & filters.command(["language"], prefixes=["/"])  # type: ignore
 )
 async def command_language(app: PyroClient, message: Message):
-    group = await PyroGroup.create_if_not_exists(message.chat.id, None, True)
+    group = await app.find_group(message.chat.id)
     locale = group.select_locale(app, message.from_user)
 
-    if (await app.get_chat_member(group.id, message.from_user.id)).status not in [
-        ChatMemberStatus.ADMINISTRATOR,
-        ChatMemberStatus.OWNER,
-    ]:
+    if not (await is_permitted(app, group, message=message)):
         await message.reply_text(
             app._("permission_denied", "messages", locale=locale), quote=True
         )
         return
 
     keyboard = InlineKeyboard(row_width=2)
-    buttons = []
-
-    for language, data in app.in_every_locale("metadata").items():
-        buttons.append(
-            InlineButton(f"{data['flag']} {data['name']}", f"language;{language}")
-        )
-
+    buttons = [
+        InlineButton(f"{data['flag']} {data['name']}", f"language:{language}")
+        for language, data in app.in_every_locale("metadata").items()
+        if data["selectable"]
+    ]
     buttons.append(
         InlineButton(
-            f"🤖 {app._('locale_default', 'buttons', locale=locale)}", "language;default"
+            f"🤖 {app._('locale_default', 'buttons', locale=locale)}", "language:default"
         )
     )
 
@@ -51,15 +45,12 @@ async def command_language(app: PyroClient, message: Message):
     )
 
 
-@Client.on_callback_query(filters.regex(r"language;[\s\S]*"))  # type: ignore
+@Client.on_callback_query(filters.regex(r"language:[\s\S]*"))  # type: ignore
 async def callback_language(app: PyroClient, callback: CallbackQuery):
-    group = await PyroGroup.create_if_not_exists(callback.message.chat.id, None, True)
+    group = await app.find_group(callback.message.chat.id)
     locale = group.select_locale(app, callback.message.from_user)
 
-    if (await app.get_chat_member(group.id, callback.from_user.id)).status not in [
-        ChatMemberStatus.ADMINISTRATOR,
-        ChatMemberStatus.OWNER,
-    ]:
+    if not (await is_permitted(app, group, callback=callback)):
         await callback.answer(
             app._("wrong_user", "callbacks", locale=locale), show_alert=True
         )

requirements.txt

@@ -1,13 +1,8 @@
-aiofiles~=23.2.1
-apscheduler~=3.10.1
-async_pymongo==0.1.3
-black~=23.7.0
-Pillow~=10.0.0
-pykeyboard==0.1.5
-pyrogram==2.0.106
+Pillow~=10.3.0
+pykeyboard==0.1.7
 tgcrypto==1.2.5
-ujson==5.8.0
-uvloop==0.17.0
+uvloop==0.19.0
 --extra-index-url https://git.end-play.xyz/api/packages/profitroll/pypi/simple
-huepaper==0.0.4
-libbot[speed,pyrogram]==2.0.1
+async_pymongo==0.1.4
+huepaper==0.0.5
+libbot[speed,pyrogram]==3.0.0