From aeb8d8274b681c9e1a56bc079525b6c9517a8b83 Mon Sep 17 00:00:00 2001 From: Llewellyn van der Merwe Date: Sun, 2 Feb 2020 19:32:10 +0200 Subject: [PATCH] Making the getBible bot public. --- .env.template | 13 ++ .gitignore | 97 ++++++++++++ LICENSE | 341 +++++++++++++++++++++++++++++++++++++++++++ README.md | 147 +++++++++++++++++++ bot.py | 35 +++++ config.py | 20 +++ modules/commands.py | 91 ++++++++++++ modules/get_bible.py | 166 +++++++++++++++++++++ modules/utils.py | 28 ++++ requirements.txt | 4 + 10 files changed, 942 insertions(+) create mode 100644 .env.template create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 bot.py create mode 100644 config.py create mode 100644 modules/commands.py create mode 100644 modules/get_bible.py create mode 100644 modules/utils.py create mode 100644 requirements.txt diff --git a/.env.template b/.env.template new file mode 100644 index 0000000..6362cf1 --- /dev/null +++ b/.env.template @@ -0,0 +1,13 @@ +TELEGRAM_API_TOKEN="xxxxxxxxxxxxxxxget@BotFatherxxxxxxxxxxxxxxxxxx" +TRANSLATION="kjv" +DEFAULT_VERSE="1 John 3:16" +GETBIBLE_URL="https://getBible.net/" +WELCOME_MESSAGE="Welcome to the official getBible.net telegram bot.\n/help for more info." +HELP_MESSAGE="*Available commands:*\n + _You can use a reference to get verses like:_ +- `/bible 1 John 3:16` +- `/bible John 3:16-19;1 John 3:10-17` +- `/bible Gen 1:1-5 codex` +- `/bible Ps 1:1-5 aov`\n +- /search: Search the Scriptures (soon..) +- /help: To get this help message again" \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..852b887 --- /dev/null +++ b/.gitignore @@ -0,0 +1,97 @@ +.idea/ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9b58a9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,341 @@ +GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..b434ff4 --- /dev/null +++ b/README.md @@ -0,0 +1,147 @@ +# getBible Bot Deployment and Operation Guide + +This is the detailed setup and operation instructions for the getBible Bot, a Telegram bot designed to deliver Bible verses and manage user interactions effectively. +This bot utilizes Python for its operation, interacting with users through Telegram's bot interface. + +## How to use this Bot on Telegram + +> These options give you access to this bot, without the need of running your own instance. +- In your browser: https://t.me/getBibleRobot +- In Telegram search for: `getBibleRobot` + +## Purpose of the Bible Bot + +The Bible Bot is designed to engage users by providing them with instant access to Bible verses and related content through Telegram. + +It supports various commands allowing users to retrieve biblical Scriptures, and more, directly within the Telegram platform. + +## Prerequisites + +- A Linux system with `systemd` for service management. +- Python 3.6 or newer, with `python3-venv` for creating virtual environments. +- `git` for cloning the repository. +- A Telegram account to create and manage the bot. + +## Setup Instructions + +### Step 1: Cloning the Repository + +Clone the repository to your preferred location: + +```bash +git clone https://git.vdm.dev/getBible/robot /home//getBibleRobot +``` + +Navigate to the bot directory: + +```bash +cd /home//getBibleRobot +``` + +### Step 2: Creating a Virtual Environment + +Within the bot directory, create and activate a Python virtual environment: + +```bash +python3 -m venv venv +source venv/bin/activate +``` + +### Step 3: Installing Dependencies + +Install required Python packages specified in [requirements.txt](https://git.vdm.dev/getBible/robot/src/branch/master/requirements.txt) + +```bash +pip install -r requirements.txt +``` + +### Step 4: Configuring the .env File + +Copy the provided `.env.template` to a new file named `.env` and populate it with your specific values: + +```bash +cp .env.template .env +nano .env +``` + +The `.env` file will require the following configurations: + +- `TELEGRAM_TOKEN`: Your Telegram bot's API token. +- `TRANSLATION`: (Optional) default: `kjv` +- `DEFAULT_VERSE`: (Optional) default: `1 John 3:16` +- `GETBIBLE_URL`: (Optional) default: `https://getBible.net/` see [Joomla Component](https://getbible.net/joomla) to host your own getBible. +- `WELCOME_MESSAGE`: (Optional) default: `Welcome to the official getBible.net telegram bot.\n\n/help for more info.` +- `HELP_MESSAGE`: (Optional) default: see [config.py](https://git.vdm.dev/getBible/robot/src/branch/master/config.py) + +#### Obtaining a Telegram Bot Token + +1. Message `@BotFather` on Telegram to create a new bot. +2. Follow the instructions and copy the provided API token. +3. Paste this token into your `.env` file for the `TELEGRAM_TOKEN` value. + +For more detailed instructions, refer to [Telegram's official bot documentation](https://core.telegram.org/bots#creating-a-new-bot). + +### Step 5: Running the Bot + +Ensure your virtual environment is activated and start the bot with: + +```bash +python bot.py +``` + +This command initiates the bot based on the script's logic and Telegram's bot API interaction. + +### Step 6: Setting Up Systemd Service + +To run the bot as a systemd service, create a unit file: + +```bash +sudo systemctl edit --force --full getBibleRobot.service +``` + +Add the following configuration, adjusting paths as necessary: + +```ini +[Unit] +Description=getBible Bot Service +After=network.target + +[Service] +User= +Group= +WorkingDirectory=/home//getBibleRobot +ExecStart=/home//getBibleRobot/venv/bin/python /home//getBibleRobot/bot.py + +[Install] +WantedBy=multi-user.target +``` + +Enable and start the service: + +```bash +sudo systemctl enable getBibleRobot.service +sudo systemctl start getBibleRobot.service +``` + +## Bot Commands + +The bot supports various commands for user interaction see [HELP_MESSAGE](https://git.vdm.dev/getBible/robot/src/branch/master/config.py). + +``` +Available commands: + + You can use a reference to get verses like: +- /bible 1 John 3:16 +- /bible John 3:16-19;1 John 3:10-17 +- /bible Gen 1:1-5 codex +- /bible Ps 1:1-5 aov + +- /search: Search the Scriptures (soon..) +- /help: To get this help message again +``` + +Ensure these [commands are registered](https://core.telegram.org/bots/tutorial#executing-commands) with `@BotFather` to make them visible to your bot's users. + +## Licensing Notice + +This project is licensed under the GNU GPL v2.0. See the LICENSE file for more details. diff --git a/bot.py b/bot.py new file mode 100644 index 0000000..37b9dbc --- /dev/null +++ b/bot.py @@ -0,0 +1,35 @@ +# import the Telegram API token from config.py +from config import TELEGRAM_API_TOKEN + +import logging + +# import the required Telegram modules +from telegram.ext import ( + ApplicationBuilder, + filters, + CommandHandler, + MessageHandler +) + +# import the required module +from modules.commands import * + +logging.basicConfig(level=logging.WARN) + +if __name__ == '__main__': + # we start the bot application + application = ApplicationBuilder().token(TELEGRAM_API_TOKEN).build() + # entry command for all private chats + application.add_handler(CommandHandler('start', start)) + # all handlers to get the Bible text [/get, /getBible, /Bible] + application.add_handler(CommandHandler('get', get)) + application.add_handler(CommandHandler('getbible', get)) + application.add_handler(CommandHandler('bible', get)) + # the search handle + application.add_handler(CommandHandler('search', search)) + # the help handle + application.add_handler(CommandHandler('help', bot_help)) + # add a message handler to handle unknown commands or messages + application.add_handler(MessageHandler(filters.ALL, unknown)) + # start polling for now (will add webhook later) + application.run_polling() diff --git a/config.py b/config.py new file mode 100644 index 0000000..a58fb98 --- /dev/null +++ b/config.py @@ -0,0 +1,20 @@ +import os + +from dotenv import load_dotenv + +load_dotenv() + +TELEGRAM_API_TOKEN = os.environ.get("TELEGRAM_API_TOKEN") +TRANSLATION = os.environ.get("TRANSLATION", 'kjv') +DEFAULT_VERSE = os.environ.get("DEFAULT_VERSE", '1 John 3:16') +GETBIBLE_URL = os.environ.get("GETBIBLE_URL", 'https://getBible.net/') +WELCOME_MESSAGE = os.environ.get("WELCOME_MESSAGE", "Welcome to the official getBible.net telegram bot.\n" + "/help for more info.") +HELP_MESSAGE = os.environ.get("HELP_MESSAGE", "*Available commands:*\n\n" + " _You can use a reference to get verses like:_\n" + "- `/bible 1 John 3:16`\n" + "- `/bible John 3:16-19;1 John 3:10-17`\n" + "- `/bible Gen 1:1-5 codex`\n" + "- `/bible Ps 1:1-5 aov`\n\n" + "- /search: Search the Scriptures (soon..)\n" + "- /help: To get this help message again") diff --git a/modules/commands.py b/modules/commands.py new file mode 100644 index 0000000..c01d2c7 --- /dev/null +++ b/modules/commands.py @@ -0,0 +1,91 @@ +# import the Telegram API token from config.py +from config import ( + HELP_MESSAGE, + WELCOME_MESSAGE +) +# import the required Telegram modules +from telegram import Update +from telegram.constants import ParseMode, MessageLimit +from telegram.ext import ( + ContextTypes, +) +import logging + +# import the required module +from modules.get_bible import bible +from modules.utils import send_typing_action + + +# handle unknown command +async def unknown(update: Update, context: ContextTypes.DEFAULT_TYPE): + return None + + +# entry command +async def start(update: Update, context: ContextTypes.DEFAULT_TYPE): + await context.bot.send_message( + chat_id=update.effective_chat.id, + text=WELCOME_MESSAGE + ) + + await context.bot.delete_message( + chat_id=update.effective_chat.id, + message_id=update.message.message_id + ) + + +# send a typing indicator in the chat +@send_typing_action +# handle the getting of the Bible text +async def get(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: + """Return the referenced scripture, shortened if it's too long.""" + scripture = bible(update.message.text) + + # Check if scripture length exceeds the maximum allowed message length + if len(scripture) > MessageLimit.MAX_TEXT_LENGTH: + notice = "...\n\n..._response was shortened due to Telegram message length limitation_" + # Shorten scripture to fit within limits with space for notice + text_to_send = scripture[:MessageLimit.MAX_TEXT_LENGTH - len(notice)] + notice + else: + text_to_send = scripture + + await context.bot.send_message( + chat_id=update.effective_chat.id, + text=text_to_send, + parse_mode=ParseMode.MARKDOWN, + disable_web_page_preview=True + ) + + await context.bot.delete_message( + chat_id=update.effective_chat.id, + message_id=update.message.message_id + ) + + +# send a typing indicator in the chat +@send_typing_action +# handle search command +async def search(update: Update, context: ContextTypes.DEFAULT_TYPE): + logging.info(f"Searching for: {update.message.text}") + await context.bot.send_message( + chat_id=update.effective_chat.id, + text=("The search function for Telegram is not yet finished.\n\n" + "You can search the Scriptures at https://getBible.net/search") + ) + await context.bot.delete_message( + chat_id=update.effective_chat.id, + message_id=update.message.id + ) + + +# help command +async def bot_help(update: Update, context: ContextTypes.DEFAULT_TYPE): + await context.bot.send_message( + chat_id=update.effective_chat.id, + parse_mode=ParseMode.MARKDOWN, + text=HELP_MESSAGE + ) + await context.bot.delete_message( + chat_id=update.effective_chat.id, + message_id=update.message.id + ) diff --git a/modules/get_bible.py b/modules/get_bible.py new file mode 100644 index 0000000..e9bb0eb --- /dev/null +++ b/modules/get_bible.py @@ -0,0 +1,166 @@ +# import the Telegram API token from config.py +from config import ( + TRANSLATION, + DEFAULT_VERSE, + GETBIBLE_URL +) + +# import the GetBible librarian +from getbible import GetBible + +import re +import logging + +# start getBible +_getBible = GetBible() + + +def _get_translation(input_string): + """ + Extracts the translation from the input string. + + :param input_string: The string from which to extract the translation. + :return: 'kjv' if the last word contains numbers, indicating it's not a translation, + otherwise returns the possible translation. + """ + try: + # Extract the last word which might be the translation or a part of the reference + possible_translation = input_string.split()[-1] + except IndexError: + logging.info(f"No translation found, used default: {TRANSLATION}") + return TRANSLATION + + # Check if the possible translation is valid + if _getBible.valid_translation(possible_translation): + return possible_translation + else: + logging.info(f"No valid translation found, used default: {TRANSLATION}") + return TRANSLATION + + +def _get_references(input_string, translation): + """ + Extracts and validates references from the input string, excluding the translation at the end if it's not 'kjv'. + If the input string is empty, returns a default verse. + + :param input_string: The string containing references. + :param translation: The translation to be excluded if present. + :return: The validated references string, or raises ValueError if any reference is invalid. + """ + # Check if input_string is empty or consists only of whitespace + if not input_string.strip(): + logging.info(f"No reference found, used default: {DEFAULT_VERSE}") + return DEFAULT_VERSE + + # Remove translation from the end if it's not 'kjv' + references_string = re.sub(f' {translation}$', '', input_string) if translation != "kjv" else input_string + + # Split references_string by ';' and validate each reference + references = references_string.split(';') + for reference in references: + if not _getBible.valid_reference(reference.strip(), translation): + raise ValueError("Invalid reference found:", reference) + + return references_string + + +def _get_verse_reference(verses): + """ + Generates a reference string for the verses. + + :param verses: A list of verse dictionaries. + :return: A string representing the verse reference range. + """ + verse_numbers = sorted([verse['verse'] for verse in verses]) + ranges = [] + range_start = None + range_end = None + + for verse in verse_numbers: + if range_start is None: + range_start = verse + elif verse == range_end + 1: + range_end = verse + else: + if range_end: + ranges.append(f"{range_start}-{range_end}") + else: + ranges.append(str(range_start)) + range_start = verse + range_end = None + if range_end is None: + range_end = verse + + # Handling the case for the last verse or a single-verse range + if range_start is not None: + if range_start != range_end: + ranges.append(f"{range_start}-{range_end}") + else: + ranges.append(str(range_start)) + + return ','.join(ranges) + + +def _format_verses(result): + """ + Formats the result from GetBible.select into nicely formatted paragraphs, + including the translation name and verse reference range in the header. + + :param result: The dictionary result from GetBible.select + :return: A string with the verses formatted as paragraphs. + """ + formatted_paragraphs = [] + for key, value in result.items(): + book_name = value.get('book_name', '') + chapter = value.get('chapter', '') + abbreviation = value.get('abbreviation', '') + verses = value.get('verses', []) + + # Generate verse reference range + verse_ref = _get_verse_reference(verses) + header = (f"[{book_name} {chapter}:{verse_ref}]({GETBIBLE_URL}{abbreviation}" + f"/{book_name}/{chapter}/{verse_ref}) ({abbreviation})") + formatted_paragraphs.append(header) + + for verse in verses: + verse_text = verse.get('text', '').strip() + verse_number = verse.get('verse', '') + verse_line = f"{verse_number}. {verse_text}" + formatted_paragraphs.append(verse_line) + + formatted_paragraphs.append("") + + return "\n".join(formatted_paragraphs) + + +def _remove_prefix_case_insensitive(input_string, prefixes): + # Join the prefixes into a regex pattern, making it case-insensitive + # The ^ character ensures the match is at the start of the string + regex_pattern = r'^(?:' + '|'.join(re.escape(prefix) for prefix in prefixes) + ')' + # Use re.sub() to replace the matched prefix with '', case-insensitively + cleaned_string = re.sub(regex_pattern, '', input_string, flags=re.IGNORECASE).strip() + + return cleaned_string + + +def _clean_string(input_string): + # Define the prefixes you want to remove + prefixes = ['/getBible', 'getBible', '/bible', 'Bible', '/get', 'Get'] + # Remove whitespace from both ends + cleaned_string = _remove_prefix_case_insensitive(input_string, prefixes) + + return cleaned_string + + +def bible(text): + try: + text = _clean_string(text) + translation = _get_translation(text) + references = _get_references(text, translation) + result = _getBible.select(references, translation) + scripture = _format_verses(result) + except Exception as e: + logging.error(str(e)) + scripture = str(e) + + return scripture diff --git a/modules/utils.py b/modules/utils.py new file mode 100644 index 0000000..61cbe65 --- /dev/null +++ b/modules/utils.py @@ -0,0 +1,28 @@ +# import the required modules +import asyncio +import json +from functools import wraps + +# import the required Telegram modules +from telegram.constants import ChatAction + + +# define the send_action decorator +def send_action(action, delay=1): + def decorator(func): + @wraps(func) + async def command_func(update, context, *args, **kwargs): + await context.bot.send_chat_action( + chat_id=update.effective_message.chat_id, action=action + ) + await asyncio.sleep(delay) # wait for the specified delay time + return await func(update, context, *args, **kwargs) + + return command_func + + return decorator + + +send_typing_action = send_action( + ChatAction.TYPING, delay=1 +) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8ec3fcd --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +python-telegram-bot[all]~=21.0 +python-dotenv~=1.0.1 +telegram~=0.0.1 +getbible~=1.1.2 \ No newline at end of file