Code re-written from scratch

Author: MasterGroosha

.gitignore

@@ -1,5 +1,2 @@
 /venv/
-/.idea/
-/__pycache__/
-
-/.env
+.idea/

Dockerfile

@@ -1,17 +1,15 @@
-# Using separate image as to reduce final image size
-FROM python:3.8-slim-buster as compile-image
-WORKDIR /app
+# Separate build image
+FROM python:3.9-slim-buster as compile-image
 RUN python -m venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
 COPY requirements.txt .
 RUN pip install --no-cache-dir --upgrade pip \
  && pip install --no-cache-dir -r requirements.txt
 
-# "production" image
-FROM python:3.8-slim-buster
+# Final image
+FROM python:3.9-slim-buster
 COPY --from=compile-image /opt/venv /opt/venv
-WORKDIR /app
 ENV PATH="/opt/venv/bin:$PATH"
-COPY handlers /app/handlers
-COPY *.py /app/
-CMD ["python", "bot.py"]
+WORKDIR /app
+COPY bot /app/bot
+CMD ["python", "-m", "bot"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Groosha
+Copyright (c) 2019-2021 Groosha
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,25 +1,24 @@
 # Report bot for Telegram
 
-This repository contains sources of a small yet rather powerful bot for Telegram, which handles reports from users and passes them to admins. Uses [aiogram](https://github.com/aiogram/aiogram) framework.  
-The main goal was to build a bot with no external database needed. Thus, it may lack some features, but hey, it's open source!
+This repository contains source code of a small yet rather powerful bot for Telegram, which handles reports from users and passes them to admins. 
+Uses [aiogram](https://github.com/aiogram/aiogram) framework.  
+The main goal is to build a bot with no external database needed. Thus, it may lack some features, but hey, it's open source!
 
-#### Screenshots
-User reports a message:  
-![User reports a message in regular chat](screenshots/users_view.jpg)
+#### Screenshot
 
-Admins take action:  
-![Admins get report in a special chat](screenshots/admin_view.jpg)
+![Left - main group. Right - group for admins only](screenshots/cover.png)
 
 #### Features
-* Handles `/report` command to gather reports from users;  
-* Handles `/ro` command to set user "Read-only" and `/textonly` to allow text messages only;
+* `/report` command to gather reports from users;  
+* `/ro` command to set user "read-only" and `/nomedia` to allow text messages only;
 * Removes "user joined" messages;  
-* Reacts to short "greetings" messages like "Hey everyone", kindly asking user to proceed to their question or problem directly;  
-* Provides a simple interface for admins to choose one of actions on reported message.
+* If text message starts with `@admin`, admins are notified;  
+* A simple interface for admins to choose one of actions on reported message;  
+* English and Russian languages are built-in.
 
 #### Requirements
-* Python 3.7 and above;  
-* Linux is mentioned in the following installation guide, but bot should also work on Windows: no platform-specific code is used;  
+* Python 3.9 and above;  
+* Tested on Linux, should work on Windows, no platform-specific code is used;  
 * Systemd (you can use it to enable autostart and autorestart) or Docker.
 
 #### Installation  
@@ -32,7 +31,7 @@ and **make bot an admin**. You also need to give it "Delete messages" permission
 4. Now choose installation method: **systemd** or **Docker**
 
 ##### systemd
-1. Create a venv (virtual environment): `python3.7 -m venv venv` (or any other Python 3.7+ version);  
+1. Create a venv (virtual environment): `python3.9 -m venv venv` (or any other Python 3.7+ version);  
 2. `source venv/bin/python && pip install -r requirements.txt`;  
 3. `chmod +x bot.py`;  
 4. Copy `env_dist` to `.env` (with dot). **Warning**: files starting with dot are usually hidden in Linux, 

bot.py

@@ -0,0 +1,77 @@
+import asyncio
+import logging
+
+from aiogram import Bot, Dispatcher
+from aiogram.types import BotCommand
+
+from bot.config_reader import load_config
+from bot.middlewares.config import ConfigMiddleware
+from bot.handlers.main_group_admin import register_main_group_admin
+from bot.handlers.main_group_user import register_main_group_user
+from bot.handlers.main_group_events import register_group_events
+from bot.handlers.callbacks_reports import register_callbacks_reports
+
+logger = logging.getLogger(__name__)
+
+
+async def set_bot_commands(bot: Bot):
+    commands = [
+        BotCommand(command="report", description="Report message to group admins"),
+    ]
+    await bot.set_my_commands(commands)
+
+
+def get_handled_updates_list(dp: Dispatcher) -> list:
+    """
+    Here we collect only the needed updates for bot based on already registered handlers types.
+    This way Telegram doesn't send unwanted updates and bot doesn't have to proceed them.
+
+    :param dp: Dispatcher
+    :return: a list of registered handlers types
+    """
+    available_updates = (
+        "callback_query_handlers", "channel_post_handlers", "chat_member_handlers",
+        "chosen_inline_result_handlers", "edited_channel_post_handlers", "edited_message_handlers",
+        "inline_query_handlers", "message_handlers", "my_chat_member_handlers", "poll_answer_handlers",
+        "poll_handlers", "pre_checkout_query_handlers", "shipping_query_handlers"
+    )
+    return [item.replace("_handlers", "") for item in available_updates
+            if len(dp.__getattribute__(item).handlers) > 0]
+
+
+async def main():
+    logging.basicConfig(
+        level=logging.INFO,
+        format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
+    )
+
+    # Reading config from env vars
+    config = load_config()
+
+    bot = Bot(token=config.token)
+    dp = Dispatcher(bot)
+
+    # Register handlers
+    register_main_group_admin(dp, main_group_id=config.group.main)
+    register_main_group_user(dp, main_group_id=config.group.main)
+    register_group_events(dp, main_group_id=config.group.main)
+    register_callbacks_reports(dp)
+
+    # Register middlewares
+    dp.middleware.setup(ConfigMiddleware(config))
+
+    # Register /-commands in UI
+    await set_bot_commands(bot)
+
+    logger.info("Starting bot")
+
+    # Start polling
+    # await dp.skip_updates()  # skip pending updates (optional)
+    try:
+        await dp.start_polling(allowed_updates=get_handled_updates_list(dp))
+    finally:
+        await bot.close()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

bot/__init__.py

@@ -0,0 +1,3 @@
+from aiogram.utils.callback_data import CallbackData
+
+report_msg_cb = CallbackData("delmsg", "option", "user_id", "message_ids")

bot/__main__.py

@@ -0,0 +1,26 @@
+from dataclasses import dataclass
+from os import getenv
+
+
+@dataclass
+class Group:
+    main: int
+    reports: int
+
+
+@dataclass
+class Config:
+    token: str
+    lang: str
+    group: Group
+
+
+def load_config():
+    return Config(
+        token=getenv("BOT_TOKEN"),
+        lang=getenv("BOT_LANGUAGE"),
+        group=Group(
+            main=int(getenv("GROUP_MAIN")),
+            reports=int(getenv("GROUP_REPORTS"))
+        )
+    )