Merge pull request 'Bug fixes and small structural changes' (#7) from dev into master

Reviewed-on: profitroll/HoloCheckerBot#7

classes/errors/holo_user.py

@@ -0,0 +1,24 @@
+"""Exceptions that are meant to be used by HoloUser class
+and other modules that handle those exceptions"""
+
+class UserNotFoundError(Exception):
+    """HoloUser could not find user with such an ID in database"""
+    def __init__(self, user, user_id):
+        self.user = user
+        self.user_id = user_id
+        super().__init__(f"User of type {type(self.user)} with id {self.user_id} was not found")
+
+class UserInvalidError(Exception):
+    """Provided to HoloUser object is not supported"""    
+    def __init__(self, user):
+        self.user = user
+        super().__init__(f"Could not find HoloUser by using {type(self.user)} as an input type")
+
+class LabelTooLongError(Exception):
+    def __init__(self, label: str) -> None:
+        self.label = label
+        super().__init__(f"Could not set label to '{label}' because it is {len(label)} characters long (16 is maximum)")
+
+class LabelSettingError(Exception):
+    def __init__(self, exp: Exception, trace: str) -> None:
+        super().__init__(f"❌ **Could not set label**\n\nException: `{exp}`\n\n**Traceback:**\n```\n{trace}\n```")

classes/holo_user.py

@@ -6,75 +6,12 @@ from pyrogram.types import User, ChatMember, ChatPrivileges, Chat, Message, Phot
 from pyrogram.errors import bad_request_400
 from dateutil.relativedelta import relativedelta
 from classes.errors.geo import PlaceNotFoundError
+from classes.errors.holo_user import UserInvalidError, UserNotFoundError, LabelTooLongError, LabelSettingError
+from classes.templates import DefaultApplicationTemp, DefaultSponsorshipTemp
 from modules.database import col_tmp, col_users, col_applications, col_sponsorships, col_messages, col_spoilers
 from modules.logging import logWrite
 from modules.utils import configGet, find_location, locale, should_quote
 
-class DefaultApplicationTemp(dict):
-    def __init__(self, user: int, reapply: bool = False):
-        super().__init__({})
-        self.dict = {
-            "user": user,
-            "type": "application",
-            "complete": False,
-            "sent": False,
-            "state": "fill",
-            "reapply": reapply,
-            "stage": 1,
-            "application": {
-                "1": None,
-                "2": None,
-                "3": None,
-                "4": None,
-                "5": None,
-                "6": None,
-                "7": None,
-                "8": None,
-                "9": None,
-                "10": None
-            }
-        }
-
-class DefaultSponsorshipTemp(dict):
-    def __init__(self, user: int):
-        super().__init__({})
-        self.dict = {
-            "user": user,
-            "type": "sponsorship",
-            "complete": False,
-            "sent": False,
-            "state": "fill",
-            "stage": 1,
-            "sponsorship": {
-                "streamer": None,
-                "expires": datetime.fromtimestamp(0),
-                "proof": None,
-                "label": ""
-            }
-        }
-
-class UserNotFoundError(Exception):
-    """HoloUser could not find user with such an ID in database"""
-    def __init__(self, user, user_id):
-        self.user = user
-        self.user_id = user_id
-        super().__init__(f"User of type {type(self.user)} with id {self.user_id} was not found")
-
-class UserInvalidError(Exception):
-    """Provided to HoloUser object is not supported"""    
-    def __init__(self, user):
-        self.user = user
-        super().__init__(f"Could not find HoloUser by using {type(self.user)} as an input type")
-
-class LabelTooLongError(Exception):
-    def __init__(self, label: str) -> None:
-        self.label = label
-        super().__init__(f"Could not set label to '{label}' because it is {len(label)} characters long (16 is maximum)")
-
-class LabelSettingError(Exception):
-    def __init__(self, exp: Exception, trace: str) -> None:
-        super().__init__(f"❌ **Could not set label**\n\nException: `{exp}`\n\n**Traceback:**\n```\n{trace}\n```")
-
 class HoloUser():
     """This object represents a user of HoloChecker bot.
     It is primarily used to interact with a database in a more python-friendly way,
@@ -219,11 +156,11 @@ class HoloUser():
                 if photo is not None:
                     if isinstance(photo, Photo):
                         photo = photo.file_id
-                    new_message = await origin.reply_photo(photo, caption=caption, quote=True)
+                    new_message = await origin.reply_cached_media(photo, caption=caption, quote=True)
                 elif video is not None:
                     if isinstance(video, Video):
                         video = video.file_id
-                    new_message = await origin.reply_video(video, caption=caption, quote=True)
+                    new_message = await origin.reply_cached_media(video, caption=caption, quote=True)
                 elif file is not None:
                     if isinstance(file, Document):
                         file = file.file_id
@@ -231,7 +168,7 @@ class HoloUser():
                 elif animation is not None:
                     if isinstance(animation, Animation):
                         animation = animation.file_id
-                    new_message = await origin.reply_animation(animation, caption=caption, quote=True)
+                    new_message = await origin.reply_cached_media(animation, caption=caption, quote=True)
                 elif voice is not None:
                     if isinstance(voice, Voice):
                         voice = voice.file_id
@@ -244,11 +181,11 @@ class HoloUser():
                 if photo is not None:
                     if isinstance(photo, Photo):
                         photo = photo.file_id
-                    new_message = await app.send_photo(self.id, photo, caption=caption)
+                    new_message = await app.send_cached_media(self.id, photo, caption=caption)
                 elif video is not None:
                     if isinstance(video, Video):
                         video = video.file_id
-                    new_message = await app.send_video(self.id, video, caption=caption)
+                    new_message = await app.send_cached_media(self.id, video, caption=caption)
                 elif file is not None:
                     if isinstance(file, Document):
                         file = file.file_id
@@ -256,11 +193,11 @@ class HoloUser():
                 elif animation is not None:
                     if isinstance(animation, Animation):
                         animation = animation.file_id
-                    new_message = await app.send_animation(self.id, animation, caption=caption)
+                    new_message = await app.send_cached_media(self.id, animation, caption=caption)
                 elif voice is not None:
                     if isinstance(voice, Voice):
                         voice = voice.file_id
-                    new_message = await app.send_voice(self.id, voice, caption=caption)
+                    new_message = await app.send_cached_media(self.id, voice, caption=caption)
                 else:
                     new_message = await app.send_message(self.id, text)
 
@@ -531,8 +468,8 @@ class HoloUser():
                         return
                     progress["sponsorship"]["label"] = query
                     col_tmp.update_one({"user": {"$eq": self.id}, "type": {"$eq": "sponsorship"}}, {"$set": {"sponsorship": progress["sponsorship"], "complete": True}})
-                    await msg.reply_photo(
-                        photo=progress["sponsorship"]["proof"],
+                    await msg.reply_cached_media(
+                        progress["sponsorship"]["proof"],
                         caption=locale("sponsor_confirm", "message", locale=self.locale).format(
                             progress["sponsorship"]["streamer"],
                             progress["sponsorship"]["expires"].strftime("%d.%m.%Y"),

classes/templates.py

@@ -0,0 +1,46 @@
+"""Templates for temporary application/sponsorship records"""
+
+from datetime import datetime
+
+class DefaultApplicationTemp(dict):
+    def __init__(self, user: int, reapply: bool = False):
+        super().__init__({})
+        self.dict = {
+            "user": user,
+            "type": "application",
+            "complete": False,
+            "sent": False,
+            "state": "fill",
+            "reapply": reapply,
+            "stage": 1,
+            "application": {
+                "1": None,
+                "2": None,
+                "3": None,
+                "4": None,
+                "5": None,
+                "6": None,
+                "7": None,
+                "8": None,
+                "9": None,
+                "10": None
+            }
+        }
+
+class DefaultSponsorshipTemp(dict):
+    def __init__(self, user: int):
+        super().__init__({})
+        self.dict = {
+            "user": user,
+            "type": "sponsorship",
+            "complete": False,
+            "sent": False,
+            "state": "fill",
+            "stage": 1,
+            "sponsorship": {
+                "streamer": None,
+                "expires": datetime.fromtimestamp(0),
+                "proof": None,
+                "label": ""
+            }
+        }

locale/uk.json

@@ -108,10 +108,10 @@
         "spoiler_empty": "Спойлер категорії \"{0}\" без опису",
         "spoiler_described": "Спойлер категорії \"{0}\": {1}",
         "spoiler_description_enter": "Добре, введіть бажаний опис спойлера",
-        "spoiler_using_description": "Встановлено опис спойлера: {0}\n\nЗалишилось додати вміст самого спойлера. Бот приймає текстове повідомлення, фото, відео а також гіф зображення (1 шт.)",
+        "spoiler_using_description": "Встановлено опис спойлера: {0}\n\nЗалишилось додати вміст самого спойлера. Бот приймає текстове повідомлення, фото, відео, файл а також гіф зображення (1 шт.)",
         "spoiler_send_description": "Тепер треба надіслати коротенький опис спойлера, щоб люди розуміли що під ним варто очкувати. Надішли мінус (-) щоб пропустити цей крок.",
         "spoiler_ready": "Успіх! Спойлер створено. Користуйтесь кнопкою нижче щоб надіслати його.",
-        "spoiler_incorrect_content": "Бот не підтримує такий контент. Будь ласка, надішли текст, фото, відео або анімацію (гіф).",
+        "spoiler_incorrect_content": "Бот не підтримує такий контент. Будь ласка, надішли текст, фото, відео, файл або анімацію (гіф).",
         "spoiler_incorrect_category": "Вказана категорія не є дійсною. Будь ласка, користуйся клавіатурою бота (кнопка біля 📎) для вибору категорії.",
         "spoiler_in_progress": "❌ **Дія неможлива**\nПерш ніж починати нову дію, треба завершити створення спойлера або перервати його командою /cancel.",
         "yes": "Так",

modules/callbacks/sponsorship.py

@@ -3,7 +3,8 @@ from app import app
 from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton, ForceReply, CallbackQuery
 from pyrogram.client import Client
 from pyrogram import filters
-from classes.holo_user import HoloUser, LabelSettingError
+from classes.errors.holo_user import LabelSettingError
+from classes.holo_user import HoloUser
 from modules.utils import configGet, locale, logWrite, should_quote
 from modules.database import col_tmp, col_sponsorships
 

modules/commands/application.py

@@ -5,7 +5,8 @@ from pyrogram.enums.parse_mode import ParseMode
 from pyrogram.types import Message
 from pyrogram.errors import bad_request_400
 from pyrogram.client import Client
-from classes.holo_user import HoloUser, UserNotFoundError
+from classes.errors.holo_user import UserNotFoundError
+from classes.holo_user import HoloUser
 from modules.utils import logWrite, locale, should_quote
 from dateutil.relativedelta import relativedelta
 from modules.database import col_applications

modules/commands/identify.py

@@ -5,7 +5,8 @@ from pyrogram.types import Message
 from pyrogram.client import Client
 from pyrogram.errors import bad_request_400
 from pyrogram.enums.chat_action import ChatAction
-from classes.holo_user import HoloUser, UserNotFoundError, UserInvalidError
+from classes.errors.holo_user import UserNotFoundError, UserInvalidError
+from classes.holo_user import HoloUser
 from modules.utils import jsonLoad, should_quote, logWrite, locale, download_tmp, create_tmp, find_user
 from modules import custom_filters
 

modules/commands/label.py

@@ -3,7 +3,8 @@ from pyrogram import filters
 from pyrogram.types import Message
 from pyrogram.client import Client
 from modules.utils import configGet, locale, should_quote, find_user
-from classes.holo_user import HoloUser, LabelTooLongError, LabelSettingError
+from classes.errors.holo_user import LabelTooLongError, LabelSettingError
+from classes.holo_user import HoloUser
 from modules import custom_filters
 
 # Label command ================================================================================================================

modules/commands/message.py

@@ -2,7 +2,8 @@ from app import app
 from pyrogram import filters
 from pyrogram.types import Message
 from pyrogram.client import Client
-from classes.holo_user import HoloUser, UserInvalidError
+from classes.errors.holo_user import UserInvalidError
+from classes.holo_user import HoloUser
 from modules.utils import logWrite, locale, should_quote, find_user
 from modules import custom_filters
 
@@ -18,11 +19,11 @@ async def cmd_message(app: Client, msg: Message):
             destination = HoloUser(await find_user(app, query=msg.command[1]))
 
         if ((msg.text is not None) and (len(msg.text.split()) > 2)):
-            await destination.message(context=msg, text=" ".join(msg.text.split()[2:]), caption=msg.caption, photo=msg.photo, video=msg.video, file=msg.document, adm_context=True)
+            await destination.message(context=msg, text=" ".join(msg.text.split()[2:]), caption=msg.caption, photo=msg.photo, video=msg.video, file=msg.document, voice=msg.voice, animation=msg.animation, adm_context=True)
         elif ((msg.caption is not None) and (len(msg.caption.split()) > 2)):
-            await destination.message(context=msg, text=msg.text, caption=" ".join(msg.caption.split()[2:]), photo=msg.photo, video=msg.video, file=msg.document, adm_context=True)
+            await destination.message(context=msg, text=msg.text, caption=" ".join(msg.caption.split()[2:]), photo=msg.photo, video=msg.video, file=msg.document, voice=msg.voice, animation=msg.animation, adm_context=True)
         else:
-            await destination.message(context=msg, text=None, caption=None, photo=msg.photo, video=msg.video, file=msg.document, adm_context=True)
+            await destination.message(context=msg, text=None, caption=None, photo=msg.photo, video=msg.video, file=msg.document, voice=msg.voice, animation=msg.animation, adm_context=True)
     
     except IndexError:
         await msg.reply_text(locale("message_invalid_syntax", "message", locale=msg.from_user), quote=should_quote(msg))

modules/commands/spoiler.py

@@ -2,7 +2,8 @@ from app import app
 from pyrogram import filters
 from pyrogram.types import Message, ReplyKeyboardMarkup
 from pyrogram.client import Client
-from classes.holo_user import HoloUser, UserInvalidError, UserNotFoundError
+from classes.errors.holo_user import UserNotFoundError, UserInvalidError
+from classes.holo_user import HoloUser
 from modules.logging import logWrite
 from modules.utils import locale
 from modules.database import col_spoilers
@@ -30,6 +31,7 @@ async def cmd_spoiler(app: Client, msg: Message):
                     "photo": None,
                     "video": None,
                     "animation": None,
+                    "document": None,
                     "caption": None,
                     "text": None
                 }

modules/commands/start.py

@@ -33,11 +33,13 @@ async def cmd_start(app: Client, msg: Message):
         try:
             spoiler = col_spoilers.find_one( {"_id": ObjectId(msg.command[1])} )
             if spoiler["photo"] is not None:
-                await msg.reply_photo(spoiler["photo"], caption=spoiler["caption"])
+                await msg.reply_document(spoiler["photo"], caption=spoiler["caption"])
             if spoiler["video"] is not None:
-                await msg.reply_video(spoiler["video"], caption=spoiler["caption"])
+                await msg.reply_cached_media(spoiler["video"], caption=spoiler["caption"])
             if spoiler["animation"] is not None:
-                await msg.reply_animation(spoiler["animation"], caption=spoiler["caption"])
+                await msg.reply_cached_media(spoiler["animation"], caption=spoiler["caption"])
+            if spoiler["document"] is not None:
+                await msg.reply_document(spoiler["document"], caption=spoiler["caption"])
             if spoiler["text"] is not None:
                 await msg.reply_text(spoiler["text"])
         except InvalidId:

modules/handlers/confirmation.py

@@ -1,6 +1,4 @@
-from os import remove, sep
 from typing import Literal
-from uuid import uuid1
 from dateutil.relativedelta import relativedelta
 from datetime import datetime
 from app import app
@@ -119,7 +117,7 @@ async def confirm_yes(app: Client, msg: Message, kind: Literal["application", "s
                 else:
                     sponsorship_content.append(f"{locale(f'question_{question}', 'message', 'sponsor_titles')} {tmp_sponsorship['sponsorship'][question]}")
             
-            await app.send_photo(chat_id=configGet("admin", "groups"), photo=tmp_sponsorship["sponsorship"]["proof"], caption=(locale("sponsor_got", "message")).format(str(holo_user.id), msg.from_user.first_name, msg.from_user.username, "\n".join(sponsorship_content)), parse_mode=ParseMode.MARKDOWN, reply_markup=InlineKeyboardMarkup(
+            await app.send_cached_media(chat_id=configGet("admin", "groups"), photo=tmp_sponsorship["sponsorship"]["proof"], caption=(locale("sponsor_got", "message")).format(str(holo_user.id), msg.from_user.first_name, msg.from_user.username, "\n".join(sponsorship_content)), parse_mode=ParseMode.MARKDOWN, reply_markup=InlineKeyboardMarkup(
                     [
                         [
                             InlineKeyboardButton(text=str(locale("sponsor_yes", "button")), callback_data=f"sponsor_yes_{holo_user.id}")

modules/handlers/everything.py

@@ -43,6 +43,8 @@ async def any_stage(app: Client, msg: Message):
                 photo=msg.photo,
                 video=msg.video,
                 file=msg.document,
+                animation=msg.animation,
+                voice=msg.voice,
                 adm_origin=await isAnAdmin(context_message.from_user.id),
                 adm_context=await isAnAdmin(msg.from_user.id)
             )
@@ -121,7 +123,12 @@ async def any_stage(app: Client, msg: Message):
                 logWrite(f"Adding animation with id {msg.animation.file_id} to {msg.from_user.id}'s spoiler")
                 ready = True
 
-            if spoiler["photo"] is None and spoiler["video"] is None and spoiler["animation"] is None and spoiler["text"] is None:
+            if msg.document is not None:
+                col_spoilers.find_one_and_update( {"user": msg.from_user.id, "completed": False}, {"$set": {"document": msg.document.file_id, "caption": msg.caption, "completed": True}} )
+                logWrite(f"Adding document with id {msg.document.file_id} to {msg.from_user.id}'s spoiler")
+                ready = True
+
+            if spoiler["photo"] is None and spoiler["video"] is None and spoiler["animation"] is None and spoiler["document"] is None and spoiler["text"] is None:
                 if msg.text is not None:
                     col_spoilers.find_one_and_update( {"user": msg.from_user.id, "completed": False}, {"$set": {"text": msg.text, "completed": True}} )
                     logWrite(f"Adding text '{msg.text}' to {msg.from_user.id}'s spoiler")

modules/inline.py

@@ -9,7 +9,8 @@ from pyrogram.client import Client
 from pyrogram.enums.chat_type import ChatType
 from pyrogram.enums.chat_members_filter import ChatMembersFilter
 from dateutil.relativedelta import relativedelta
-from classes.holo_user import HoloUser, UserInvalidError, UserNotFoundError
+from classes.errors.holo_user import UserNotFoundError, UserInvalidError
+from classes.holo_user import HoloUser
 from modules.utils import configGet, locale
 from modules.database import col_applications, col_spoilers
 from bson.objectid import ObjectId

validation/spoilers.json

@@ -8,6 +8,7 @@
             "photo",
             "video",
             "animation",
+            "document",
             "caption",
             "text"
         ],
@@ -41,6 +42,10 @@
                 "bsonType": ["string", "null"],
                 "description": "Spoilered animation/GIF"
             },
+            "document": {
+                "bsonType": ["string", "null"],
+                "description": "Spoilered document/file"
+            },
             "caption": {
                 "bsonType": ["string", "null"],
                 "description": "Spoilered caption for media"