beta: Scheduled Verse

Author: Nusab19

ChangeLogs.md

@@ -3,6 +3,9 @@
 **Latests are on top**
 
 
+## 13) 19th April, 2024
+- `/schedule` command added. Now, you can schedule a verse to be sent at a specific time of every day.
+
 
 ## 12) 5th April, 2024
 - Integrate custom local database logic to make database operations faster and more efficient.

TODO.md

@@ -2,11 +2,5 @@
 
 
 - Code Refactoring
-  - [ ] make a variable named `handlers` in every module which will contain the handlers for the module
-  - [ ] Use decorators. eg. `@usableBy("admin")`, `@usableBy("group_admin")`
   - [ ] Implement active users in the database
 
-• Scheduled Ayah Sending for channel
-
-- Admins will be able to set a time when they want to receive a random ayah from the Quran
-- Admins will be able to set the time zone

bot/bot.py

@@ -7,10 +7,10 @@
 from datetime import datetime, timezone
 
 from .handlers.database import db
+from .handlers.sendScheduled import jobSendScheduled
 from .handlers import exportedHandlers, handleErrors, middleware
 
 
-
 # Load Environment Variables
 load_dotenv()
 LOCAL = os.environ.get("LOCAL")
@@ -30,6 +30,9 @@ def runBot(token):
         .connect_timeout(333)
         .build()
     )
+
+    app.job_queue.run_repeating(jobSendScheduled, 60, name="scheduledMessages")
+
     app.add_handler(
         TypeHandler(Update, middleware), group=-19
     )  # called in every update, then passed to other handlers
@@ -40,7 +43,7 @@ def runBot(token):
 
     # Send a message to the admin when the bot starts
     loop = asyncio.get_event_loop()
-    
+
     msg = f"<b>Bot started at {datetime.now(timezone.utc).strftime('%d %B %Y, %H:%M:%S %A UTC')} 🚀</b>"
     loop.run_until_complete(app.bot.sendMessage(5596148289, msg))
 
@@ -52,13 +55,12 @@ def startBot():
         print("Please put your bot token in `.env` file")
         print()
         return
-    
+
     if LOCAL:
         print("-" * 27)
         print("Running on local test Bot")
         print("-" * 27)
 
-
     runBot(TOKEN)
 
 

bot/handlers/__init__.py

@@ -1,6 +1,6 @@
 from ..quran import QuranClass
 
-# Variables has to be declared before importing handlers
+# Import after the class definition to avoid circular import
 Quran = QuranClass()
 
 from .helpers import generateSurahButtons
@@ -32,5 +32,5 @@ class Constants:
     *commandHandlers,
     *messageHandlers,
     *inlineQueryHandlers,
-    *callbackQueryHandlers
-]
+    *callbackQueryHandlers,
+]

bot/handlers/callbackQuery/handleButtonPress.py

@@ -198,7 +198,7 @@ async def handleButtonPress(u: Update, c):
 
     elif method == "close":
         return await message.delete()
-    
+
     elif method == "schedule":
         return await handleSchedule(u, c)
 

bot/handlers/command/adminCommand.py

@@ -198,9 +198,7 @@ async def evaluateCode(u: Update, c):
 
 
 exportedHandlers = [
-    CommandHandler(
-        "admin", adminCommand, filters.User(db.getAllAdmins())
-    ),  # TODO: use decorators instead
+    CommandHandler("admin", adminCommand, filters.User(db.getAllAdmins())),
     CommandHandler("forward", forwardMessage, filters.User(db.getAllAdmins())),
     CommandHandler("getUser", getUser, filters.User(db.getAllAdmins())),
     CommandHandler("eval", evaluateCode, filters.User(db.getAllAdmins())),

bot/handlers/command/commands.py

@@ -64,7 +64,8 @@ async def aboutCommand(u: Update, c):
 async def useCommand(u: Update, c):
     """Sends a message to the user on how to use the bot"""
     message = u.effective_message
-    url = "https://telegra.ph/Al-Quran-05-29"
+    url = "https://telegra.ph/Al-Quran-05-29"  # old
+    url = "https://telegra.ph/Usage-of-Quran-Bot-04-19"
     reply = replies.howToUse.format(telegraphURL=url)
 
     buttons = InlineKeyboardMarkup(

bot/handlers/command/scheduleVerseSend.py

@@ -1,16 +1,19 @@
+import time
 import regex
 
-from ..database import db
 from .. import Quran
+from ..database import db
 from ..helpers.decorators import onlyGroupAdmin
 
-from telegram import Update, Bot, InlineKeyboardButton, InlineKeyboardMarkup
+from datetime import datetime, tzinfo
 from telegram.ext import MessageHandler, filters, ContextTypes
+from telegram import Update, Bot, InlineKeyboardButton, InlineKeyboardMarkup
 
 
-def _addScheduleToTemp(chatID: int, time: dict, chatType: str, langs: list = None):
+def _addScheduleToTemp(chatID: int, time: str, chatType: str, langs: list = None):
     """Add a schedule to the temp database."""
     langs = [i for i in langs if i] or ["english_1"]
+    langs = langs[:3]
     collection = db.db.schedules
     return collection.update_one(
         {"_id": chatID},
@@ -44,9 +47,6 @@ def _addScheduleToTemp(chatID: int, time: dict, chatType: str, langs: list = Non
     regex.IGNORECASE,
 )  # Match for: 11:49 pm - eng ara tur {'hour': '11', 'minute': '49', 'ampm': 'pm', 'langs': 'eng ara tur'}
 
-# TODO: run repeating every minute to check if the time has come
-# Enable, Disable, Delete schedule
-
 
 # /schedule 11:49 pm - eng ara
 @onlyGroupAdmin
@@ -68,12 +68,29 @@ async def scheduleCommand(u: Update, c: ContextTypes.DEFAULT_TYPE):
 
     langs = [Quran.detectLanguage(i) for i in langs]
     languages = [str(Quran.getTitleLanguageFromLang(i)) for i in langs]
+    currentTime = datetime.utcnow()
+    hours, minutes = result.split(":")
+    remaining = (
+        datetime(
+            year=currentTime.year,
+            month=currentTime.month,
+            day=currentTime.day,
+            hour=int(hours),
+            minute=int(minutes),
+            second=0,
+        )
+        - currentTime
+    )
+    remaining = remaining.total_seconds()
+
+    remaining = time.strftime("%H:%M:%S", time.gmtime(remaining))
 
     msg = f"""
 <b>Schedule Enabled</b>
 A random verse will be sent at the following time:
 
-<b>Time:</b> {result["hour"]:02d}:{result["minute"]:02d} UTC (24-hour format)
+<b>Time:</b> {result} UTC (24-hour format)
+<b>Remaining:</b> {remaining}
 
 <b>Language:</b> {", ".join(languages) or "English"}
 
@@ -114,18 +131,35 @@ async def showSchedule(u: Update, c: ContextTypes.DEFAULT_TYPE):
             "No schedule found. See /help for more information."
         )
 
-    time = data.get("time")
+    runTime = data.get("time")
     langs = data.get("langs")
     chatType = data.get("chatType")
     enabled = data.get("enabled")
 
     languages = [str(Quran.getTitleLanguageFromLang(i)) for i in langs]
+    hours, minutes = runTime.split(":")
+
+    currentTime = datetime.utcnow()
+    remaining = (
+        datetime(
+            year=currentTime.year,
+            month=currentTime.month,
+            day=currentTime.day,
+            hour=int(hours),
+            minute=int(minutes),
+            second=0,
+        )
+        - currentTime
+    )
+    remaining = remaining.total_seconds()
+    remaining = time.strftime("%H:%M:%S", time.gmtime(remaining))
 
     msg = f"""
 <b>Schedule Information</b>
 A random verse will be sent at the following time:
 
-<b>Time:</b> {time["hour"]:02d}:{time["minute"]:02d} UTC (24-hour format)
+<b>Time:</b> {hours}:{minutes} UTC (24-hour format)
+<b>Remaining:</b> {remaining}
 
 <b>Languages:</b> <code>{", ".join(languages) or "English"}</code>
 <b>Status:</b> <i>{"Enabled" if enabled else "Disabled"}</i>
@@ -190,7 +224,7 @@ async def _validateTime(message, text: str):
         else:
             if hour >= 12:
                 hour -= 12
-
+    return f"{hour:02d}:{minute:02d}"  # 24-hour format
     return {"hour": hour, "minute": minute}
 
 

bot/handlers/database.py

@@ -94,7 +94,7 @@ class Database:
     def __init__(self) -> None:
         uri = os.environ.get("MONGODB_URI")
         self.client = MongoClient(uri, server_api=ServerApi("1"))
-        self.db = self.client.quranbot_test  # TODO: change it to quranbot
+        self.db = self.client.quranbot
 
         self.defaultSettings = {
             "font": 1,  # 1 -> Uthmani, 2 -> Simple
@@ -267,9 +267,9 @@ def updateCounter(self):
     #     self.db.drop_collection(self.db.chats)
 
 
-
 db = Database()
 
+
 async def main():
     db = Database()
     users = db.getAllUsers()
@@ -278,24 +278,6 @@ async def main():
     print("Total Chats:", len(chats))
     print(db.getAllAdmins())
 
-    # test
-    db = db.db
-    if not db.schedules.find_one({"_id": 919919191}):
-        db.schedules.insert_one(
-            {
-                "_id": 919919191,
-                "time": "12:12", "say": "meow"
-            }
-        )
-
-    print(db.schedules.find_one({"_id": 919919191}))
-
-    db.schedules.update_one(
-        {"_id": 919919191},
-        {"$set": {"time": "12:34", "say": "hello"}},
-    )
-    print(db.schedules.find_one({"_id": 919919191}))
-
 
 if __name__ == "__main__":
     asyncio.run(main())

bot/handlers/errorHandler.py

@@ -56,7 +56,7 @@ async def handleErrors(u: Update, c: CallbackContext):
     admins = db.getAllAdmins()
     data = {
         "error_message": str(c.error),
-        "error": tbString.replace("\\n", '\n'),
+        "error": tbString.replace("\\n", "\n"),
         "update": u.to_dict(),
         "sendingError": messageSendingError,
     }

bot/handlers/helpers/__init__.py

@@ -3,4 +3,4 @@
 from .generateSurahButtons import generateSurahButtons
 from .getAyahReply import getAyahReply, getAyahReplyFromPreference
 
-from .getValidReply import getValidReply
+from .getValidReply import getValidReply

bot/handlers/inlineQuery/__init__.py

@@ -1,3 +1,3 @@
 from .handleInlineQuery import exportedHandlers
 
-handlers = [*exportedHandlers]
+handlers = [*exportedHandlers]

bot/handlers/message/__init__.py

@@ -1,3 +1,3 @@
 from .handleMessage import exportedHandlers
 
-handlers = [*exportedHandlers]
+handlers = [*exportedHandlers]

bot/handlers/middleware.py

@@ -38,4 +38,3 @@ async def middleware(u: Update, c):
 
     if isGroup and not chat:  # for groups
         chat = db.addChat(chatID)
-

bot/handlers/replies.py

@@ -35,8 +35,9 @@
 /settings - Change your settings
 /surah - The list of all the Surahs
 /get x:y - Get the ayah x from Surah y
-/<lang> x:y - Get the ayah x from Surah y in the language <lang>
-
+/lang x:y - Get the ayah <code>x</code> from Surah <code>y</code> in the language &lt;lang&gt;
+/schedule 11:30 - Get a random ayah at 11:30 everyday
+<i>See the Telegraph for more in depth usage of schedule</i>
 
 /langs, /languages, /translations - Get the list of all the available translations
 /rand, /random - Get a random ayah