Compare commits

..
64 Commits
Author SHA1 Message Date
Davte 654ac2d0fb Include last commit message in version report 2026-03-29 19:18:27 +02:00
Davte 6cf63716ff Compliance with bot API 9.0
Also, the repository is not hosted on GiTea
2025-04-15 21:27:19 +02:00
Davte 9c61b564b1 Working on compliance with bot API 9.0 2025-04-13 00:00:51 +02:00
Davte 4a79535321 Compliance with bot API 8.02
Also, closed sessions are now removed from Bot.sessions
2025-02-01 16:46:33 +01:00
Davte 425902d2ac Compliance with bot API 7.10 2024-09-06 16:01:50 +02:00
Davte 6759e5c704 Administrators may be set after administration module initialization
Do not check for administrators until bot has got information about itself. Prevent duplicate calls to bot.get_me() async method
2024-09-01 18:27:28 +02:00
Davte db240ce199 Compliance with bot API 7.9
Implemented a system to get administration privileges if running the bot in absence of administrators (the token is provided through the command line).
2024-08-17 21:12:00 +02:00
Davte 02386d69da Get package version from metadata when package has no __version__ attribute 2024-08-04 18:49:41 +02:00
Davte cc4cbbacbd Compliance with bot API 7.8 2024-08-04 18:29:21 +02:00
Davte fd4374f328 Compliance with bot API 7.7 2024-07-07 14:36:58 +02:00
Davte 6b489363de Compliance with bot API 7.2
- Included python version in `/version` command
- Added the parameter `business_connection_id` to the methods sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendGame, and sendMediaGroup, sendChatAction.
- Moved the parameter `format` to Sticker instead of StickerSet (and related methods)
2024-04-13 11:15:42 +02:00
Davte a343e095e8 Compliance with bot API 7.1
- Added the class ReplyParameters and replaced parameters reply_to_message_id and allow_sending_without_reply in the methods copyMessage, sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendInvoice, sendGame, and sendMediaGroup with the field reply_parameters of type ReplyParameters.
- Added the class LinkPreviewOptions and replaced the parameter disable_web_page_preview with link_preview_options in the methods sendMessage and editMessageText.
2024-03-10 20:22:05 +01:00
Davte a3b28bc1d6 Allow to overwrite file when using bot.download_file method 2024-03-05 18:50:03 +01:00
Davte 3969794075 download_file behaves differently if a local bot API server is used. Wrong default API url was being used 2024-02-17 15:44:04 +01:00
Davte 748ba624a4 Support Local Bot API Server (with custom api_url). 2024-02-17 14:47:09 +01:00
Davte 41507067be download_file method updated to handle exceptions and return information about downloaded file 2024-02-14 19:30:35 +01:00
Davte ec747bef1d Specify encoding in send_part_of_text_file function 2023-12-17 10:22:12 +01:00
Davte 199fe29cf1 Compliance with bot API 6.8 and 6.9
Added the method `unpinAllGeneralForumTopicMessages` (6.8).

Added the new administrator privileges `can_post_stories`, `can_edit_stories` and `can_delete_stories` to the class `ChatAdministratorRights` and to the method `promoteChatMember` (6.9).
2023-11-12 11:56:16 +01:00
Davte 41f38d0b23 Method to add table columns if missing 2023-08-23 18:23:17 +02:00
Davte cf492f0c8b Allow non-null standard output and/or error pipe to be passed to aio_subprocess_shell function 2023-08-23 17:17:26 +02:00
Davte eab81b065d When answering inline queries, prevent invalid InlineQueryResultsButton instantiation 2023-08-07 20:19:09 +02:00
Davte 51a77c695b Better variable regex: accept only one decimal separator in float numbers 2023-07-25 18:58:31 +02:00
Davte febe5cee3f Config command implemented, allowing administrators to add variables to configuration files 2023-07-25 16:41:22 +02:00
Davte fb04211e81 Whitespace and type mismatch 2023-04-29 20:56:32 +02:00
Davte 3bd1a9b679 Compliance with Telegram Bot API 6.6 and new command line interface to run bot or send a single message 2023-04-29 20:38:33 +02:00
Davte 0c3ed2070d Compliance with Telegram Bot API 6.5 2023-02-03 21:38:20 +01:00
Davte 5c30dafd4c Compliance with Telegram Bot API 6.4 2023-01-06 10:29:44 +01:00
davte 27f9d62cf9 Make the regex dot match any character at all, including a newline, when cleaning HTML strings (so multiline tag bodies are allowed, as they are in Telegram HTML markdown). 2022-12-26 14:05:33 +01:00
Davte fafa639328 HTML parse_mode check upgraded.
All supported tags permitted, malformed tags replaced with escaped characters
2022-12-12 22:43:44 +01:00
Davte 55b47ed1f7 Method to add a table and its columns to and ObjectWithDatabase 2022-12-10 18:46:20 +01:00
Davte 881d249256 Compliance with Telegram Bot API 6.3 2022-12-08 16:18:22 +01:00
Davte fc486c60ce When admin A requests profile picture of user B, send B's picture and not A's. 2022-12-06 22:18:51 +01:00
Davte e813d37c8f Browse users via /auth command 2022-12-05 22:10:30 +01:00
Davte 21f91fb07c Syntax-breaking typo 2022-10-12 14:12:39 +02:00
Davte 50c2f92e8e asyncio get_event_loop method is being deprecated; use new_event_loop / get_running_loop and asyncio.run instead
Major version change because it may not be backward-compatible
2022-10-12 14:08:46 +02:00
Davte d77c416ea6 send_document method should not require a chat_id since it can be passed an update object 2020-12-20 20:30:59 +01:00
Davte e487764aad send_photo method should not require a chat_id since it can be passed an update object 2020-12-11 08:22:16 +01:00
Davte 4bf00f0cc5 Avoid relative import statements 2020-11-19 15:18:44 +01:00
Davte ed7e335d4e Items in __all__ must be str, not module 2020-11-19 14:37:25 +01:00
Davte d6a4a1d69a Document can be None if document_path is provided 2020-11-19 12:32:58 +01:00
Davte 668822fc21 Do not log chardet INFO and DEBUG levels 2020-11-16 23:05:18 +01:00
Davte 135442dcd6 Compliance with Telegram Bot API 5.0 and improved type hinting for API methods. 2020-11-16 22:56:12 +01:00
Davte eb11160a02 Version number 2020-11-15 21:35:38 +01:00
Davte fda4cac348 Import statements refactored 2020-11-15 21:34:18 +01:00
Davte 773fe1fdb1 web should not be imported from aiohttp; use aiohttp.web instead 2020-11-15 20:55:43 +01:00
Davte ddf25f8dd1 Store user profile pictures in bot database and show them in authorization panel 2020-10-07 16:32:51 +02:00
Davte 17b26ec23e MySQL compatibility: specify VARCHAR length
`db.types.string` becomes now `db.types.string(n)`
`db.types.text` is the wrong type to use (text blobs)
2020-10-07 16:32:50 +02:00
Davte 68974c4c40 Pass all information to command handler when using /start 2020-09-26 19:28:18 +02:00
Davte 92e39e7ed7 Make general_handler handle photo updates 2020-09-05 10:36:00 +02:00
Davte 48b7e1e4a2 Updated examples 2020-08-23 14:21:45 +02:00
Davte b797f3fffe Remove argument parameter from parser decorator 2020-08-23 14:08:06 +02:00
Davte 3e19ba4c81 In text message handler, make available both lowered and original text and inspect condition parameters 2020-08-23 14:03:52 +02:00
Davte e29bb08b7b Accept language directly 2020-08-20 15:51:00 +02:00
Davte 7233f9e478 General handler implemented and applied to contact updates 2020-08-17 23:51:50 +02:00
Davte e481623a75 Document handlers implemented 2020-08-16 15:18:02 +02:00
Davte 88835955ef Update default help messages with given ones, instead of replacing them 2020-07-17 09:48:39 +02:00
Davte 8c37d00602 In default keyboard, show only buttons for commands the user is authorized to call 2020-07-16 10:06:32 +02:00
Davte ada375b766 Prevent decoding None objects 2020-07-15 13:15:48 +02:00
Davte ed05d843bc Async function to run shell commands 2020-07-15 13:11:45 +02:00
Davte bc51ed109a Split outgoing documents bigger than 50 MB and send chunks 2020-06-22 22:56:21 +02:00
Davte 76204ccd69 Script to merge split files 2020-06-22 22:56:16 +02:00
Davte 293a831958 Typos 2020-06-20 15:43:22 +02:00
Davte fafc3de090 Send error message if database could not be sent - new version 2020-06-20 15:35:24 +02:00
Davte 5fe875e49c Send error message if database could not be sent 2020-06-20 15:32:37 +02:00
8 changed files with 1730 additions and 266 deletions
+1
View File
@@ -41,6 +41,7 @@ __pycache__/
# Distribution / packaging
.Python
env/
.venv/
build/
develop-eggs/
dist/
+1 -1
View File
@@ -11,7 +11,7 @@ __author__ = "Davide Testa"
__email__ = "davide@davte.it"
__credits__ = ["Marco Origlia", "Nick Lee @Nickoala"]
__license__ = "GNU General Public License v3.0"
__version__ = "2.9.8"
__version__ = "2.10.11"
__maintainer__ = "Davide Testa"
__contact__ = "t.me/davte"
+153 -74
View File
@@ -13,10 +13,12 @@ import asyncio
import datetime
import json
import logging
import platform
import re
import types
from collections import OrderedDict
from importlib.metadata import version as get_package_version_from_metadata
from typing import Union, List, Tuple
# Third party modules
@@ -27,8 +29,8 @@ from davtelepot.messages import default_admin_messages, default_talk_messages
from davtelepot.bot import Bot
from davtelepot.utilities import (
async_wrapper, CachedPage, Confirmator, extract, get_cleaned_text,
get_user, clean_html_string, line_drawing_unordered_list, make_button,
make_inline_keyboard, remove_html_tags, send_part_of_text_file,
get_secure_key, get_user, clean_html_string, line_drawing_unordered_list,
make_button, make_inline_keyboard, remove_html_tags, send_part_of_text_file,
send_csv_file, make_lines_of_buttons, join_path
)
@@ -43,6 +45,13 @@ variable_regex = re.compile(r"(?P<name>[a-zA-Z]\w*)\s*=\s*"
r"\"[^\"]*\")")
def get_package_version(package: types.ModuleType):
"""Get version of given package."""
if hasattr(package, '__version__'):
return package.__version__
return get_package_version_from_metadata(package.__name__)
async def _forward_to(update,
bot: Bot,
sender,
@@ -223,7 +232,7 @@ def get_talk_panel(bot: Bot,
return text, reply_markup
async def _talk_command(bot: Bot,
async def talk_command(bot: Bot,
update,
user_record):
text = get_cleaned_text(
@@ -343,7 +352,7 @@ async def end_session(bot: Bot,
return
async def _talk_button(bot: Bot,
async def talk_button(bot: Bot,
update,
user_record,
data):
@@ -353,7 +362,7 @@ async def _talk_button(bot: Bot,
if command == 'search':
bot.set_individual_text_message_handler(
await async_wrapper(
_talk_command,
talk_command,
),
update
)
@@ -426,7 +435,7 @@ async def _talk_button(bot: Bot,
return result
async def _restart_command(bot: Bot,
async def restart_command(bot: Bot,
update,
user_record):
with bot.db as db:
@@ -453,7 +462,7 @@ async def _restart_command(bot: Bot,
return
async def _stop_command(bot: Bot,
async def stop_command(bot: Bot,
update,
user_record):
text = bot.get_message(
@@ -495,7 +504,7 @@ async def stop_bots(bot: Bot):
return
async def _stop_button(bot: Bot,
async def stop_button(bot: Bot,
update,
user_record,
data: List[Union[int, str]]):
@@ -535,7 +544,7 @@ async def _stop_button(bot: Bot,
return result
async def _send_bot_database(bot: Bot, user_record: OrderedDict, language: str):
async def send_bot_database(bot: Bot, user_record: OrderedDict, language: str):
if not all(
[
bot.db_url.endswith('.db'),
@@ -562,7 +571,7 @@ async def _send_bot_database(bot: Bot, user_record: OrderedDict, language: str):
)
async def _query_command(bot, update, user_record):
async def query_command(bot, update, user_record):
query = get_cleaned_text(
update,
bot,
@@ -640,7 +649,7 @@ async def _query_command(bot, update, user_record):
)
async def _query_button(bot, update, user_record, data):
async def query_button(bot, update, user_record, data):
result, text, reply_markup = '', '', None
command = data[0] if len(data) else 'default'
error_message = bot.get_message(
@@ -677,7 +686,7 @@ async def _query_button(bot, update, user_record, data):
return result
async def _log_command(bot, update, user_record):
async def log_command(bot, update, user_record):
if bot.log_file_path is None:
return bot.get_message(
'admin', 'log_command', 'no_log',
@@ -730,7 +739,7 @@ async def _log_command(bot, update, user_record):
return
async def _errors_command(bot, update, user_record):
async def errors_command(bot, update, user_record):
# Always send errors log file in private chat
chat_id = update['from']['id']
if bot.errors_file_path is None:
@@ -774,7 +783,7 @@ async def _errors_command(bot, update, user_record):
return
async def _maintenance_command(bot, update, user_record):
async def maintenance_command(bot, update, user_record):
maintenance_message = get_cleaned_text(update, bot, ['maintenance'])
if maintenance_message.startswith('{'):
maintenance_message = json.loads(maintenance_message)
@@ -827,7 +836,8 @@ def get_maintenance_exception_criterion(bot, allowed_command):
async def get_last_commit():
"""Get last commit hash and davtelepot version."""
"""Get last commit hash and message."""
last_commit_message = None
try:
_subprocess = await asyncio.create_subprocess_exec(
'git', 'rev-parse', 'HEAD',
@@ -835,12 +845,22 @@ async def get_last_commit():
stderr=asyncio.subprocess.STDOUT
)
stdout, _ = await _subprocess.communicate()
last_commit = stdout.decode().strip()
last_commit_hash = stdout.decode().strip()
except Exception as e:
last_commit = f"{e}"
if last_commit.startswith("fatal: not a git repository"):
last_commit = "-"
return last_commit
last_commit_hash = f"{e}"
try:
_subprocess = await asyncio.create_subprocess_exec(
'git', 'log', '--pretty=%B', "-n", "1", last_commit_hash,
stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.STDOUT
)
stdout, _ = await _subprocess.communicate()
last_commit_message = stdout.decode().strip()
except Exception:
pass
if last_commit_hash.startswith("fatal: not a git repository"):
last_commit_hash = "-"
return last_commit_hash, last_commit_message
async def get_new_versions(bot: Bot,
@@ -864,7 +884,12 @@ async def get_new_versions(bot: Bot,
"skipping...")
continue
new_version = web_page['info']['version']
current_version = package.__version__
try:
current_version = get_package_version(package)
except TypeError:
current_version = "NA"
logging.error("Could not get current version of "
"package %s", package.__name__)
notification_record = bot.db['updates_notifications'].find_one(
package=package.__name__,
order_by=['-id'],
@@ -883,17 +908,21 @@ async def get_new_versions(bot: Bot,
return news
async def _version_command(bot: Bot, update: dict,
async def version_command(bot: Bot, update: dict,
user_record: OrderedDict, language: str):
last_commit = await get_last_commit()
last_commit_hash, last_commit_message = await get_last_commit()
text = bot.get_message(
'admin', 'version_command', 'header',
last_commit=last_commit,
last_commit=last_commit_hash,
update=update, user_record=user_record
) + '\n\n'
)
if last_commit_message:
text += "\n<i>" + last_commit_message + "</i>"
text += "\n\n"
text += f'<b>Python: </b> <code>{platform.python_version()}</code>\n'
text += '\n'.join(
f"<b>{package.__name__}</b>: "
f"<code>{package.__version__}</code>"
f"<code>{get_package_version(package)}</code>"
for package in bot.packages
)
temporary_message = await bot.send_message(
@@ -932,15 +961,15 @@ async def notify_new_version(bot: Bot):
Notify admins when last commit and/or davtelepot version change.
"""
last_commit = await get_last_commit()
last_commit_hash, last_commit_message = await get_last_commit()
old_record = bot.db['version_history'].find_one(
order_by=['-id']
)
current_versions = {
f"{package.__name__}_version": package.__version__
f"{package.__name__}_version": get_package_version(package)
for package in bot.packages
}
current_versions['last_commit'] = last_commit
current_versions['last_commit'] = last_commit_hash
if old_record is None:
old_record = dict(
updated_at=datetime.datetime.min,
@@ -963,13 +992,16 @@ async def notify_new_version(bot: Bot):
'admin', 'new_version', 'title',
user_record=admin
) + '\n\n'
if last_commit != old_record['last_commit']:
if last_commit_hash != old_record['last_commit']:
text += bot.get_message(
'admin', 'new_version', 'last_commit',
old_record=old_record,
new_record=current_versions,
user_record=admin
) + '\n\n'
)
if last_commit_message:
text += f"\n<i>{last_commit_message}</i>"
text += "\n\n"
text += '\n'.join(
f"<b>{name[:-len('_version')]}</b>: "
f"<code>{old_record[name]}</code> —> "
@@ -1032,7 +1064,7 @@ async def get_package_updates(bot: Bot,
await asyncio.sleep(monitoring_interval)
async def _send_start_messages(bot: Bot):
async def send_start_messages(bot: Bot):
"""Send restart messages at restart."""
for restart_message in bot.db['restart_messages'].find(sent=None):
asyncio.ensure_future(
@@ -1060,7 +1092,7 @@ async def _send_start_messages(bot: Bot):
return
async def _load_talking_sessions(bot: Bot):
async def load_talking_sessions(bot: Bot):
sessions = []
for session in bot.db.query(
"""SELECT *
@@ -1139,7 +1171,7 @@ def get_custom_commands(bot: Bot, language: str = None) -> List[dict]:
)
async def _father_command(bot, language):
async def father_command(bot, language):
modes = [
{
key: (
@@ -1443,12 +1475,12 @@ async def edit_bot_father_settings_via_message(bot: Bot,
return result, text, reply_markup
async def _father_button(bot: Bot, user_record: OrderedDict,
async def father_button(bot: Bot, user_record: OrderedDict,
language: str, data: list):
"""Handle BotFather button.
Operational modes
- main: back to main page (see _father_command)
- main: back to main page (see `father_command`)
- get: show commands stored by @BotFather
- set: edit commands stored by @BotFather
"""
@@ -1542,7 +1574,7 @@ async def _father_button(bot: Bot, user_record: OrderedDict,
elif command == 'main':
return dict(
text='',
edit=(await _father_command(bot=bot, language=language))
edit=(await father_command(bot=bot, language=language))
)
elif command == 'set':
stored_commands = await bot.getMyCommands()
@@ -1810,7 +1842,7 @@ async def _father_button(bot: Bot, user_record: OrderedDict,
return result
async def _config_command(bot: Bot, update: dict,
async def config_command(bot: Bot, update: dict,
user_record: dict, language: str):
text = get_cleaned_text(
update,
@@ -1844,6 +1876,52 @@ async def _config_command(bot: Bot, update: dict,
language=language)
async def become_administrator(bot: Bot, update: dict,
user_record: dict, language: str):
"""When the bot has no administrator, become one providing a token.
The token will be printed to the stdout on the machine running the bot.
"""
if len(bot.administrators) > 0:
return
def _get_message(*args):
return bot.get_message('admin', 'become_admin', *args,
update=update, user_record=user_record,
language=language)
token = get_cleaned_text(update=update, bot=bot,
replace=['become_administrator',
'00become_administrator'],
strip='/ @_')
if token != bot.administration_token:
return _get_message('wrong_token')
with bot.db as db:
db['users'].update({**user_record, 'privileges': 1},
['id'])
return _get_message('success')
async def create_promotion_command(bot: Bot):
"""If bot has no administrators, users can elevate themselves.
To do so, they need to provide a token, that will be printed to the stdout
of the machine running the bot.
"""
await bot.get_me()
if len(bot.administrators) > 0:
return
bot.administration_token = get_secure_key(length=10)
print(f"To become administrator click "
f"https://t.me/{bot.name}?start="
f"00become_administrator_{bot.administration_token}")
@bot.command(command='become_administrator',
authorization_level='everybody',
aliases=['00become_administrator'])
async def _become_administrator(bot, update, user_record, language):
return await become_administrator(bot=bot, update=update,
user_record=user_record,
language=language)
def init(telegram_bot: Bot,
talk_messages: dict = None,
admin_messages: dict = None,
@@ -1907,16 +1985,16 @@ def init(telegram_bot: Bot,
# Tasks to complete before starting bot
@telegram_bot.additional_task(when='BEFORE')
async def load_talking_sessions():
return await _load_talking_sessions(bot=telegram_bot)
async def _load_talking_sessions():
return await load_talking_sessions(bot=telegram_bot)
@telegram_bot.additional_task(when='BEFORE', bot=telegram_bot)
async def notify_version(bot):
return await notify_new_version(bot=bot)
@telegram_bot.additional_task('BEFORE')
async def send_restart_messages():
return await _send_start_messages(bot=telegram_bot)
async def _send_start_messages():
return await send_start_messages(bot=telegram_bot)
# Administration commands
@telegram_bot.command(command='/db',
@@ -1925,8 +2003,8 @@ def init(telegram_bot: Bot,
description=admin_messages[
'db_command']['description'],
authorization_level='admin')
async def send_bot_database(bot, user_record, language):
return await _send_bot_database(bot=bot,
async def _send_bot_database(bot, user_record, language):
return await send_bot_database(bot=bot,
user_record=user_record,
language=language)
@@ -1936,8 +2014,8 @@ def init(telegram_bot: Bot,
description=admin_messages[
'errors_command']['description'],
authorization_level='admin')
async def errors_command(bot, update, user_record):
return await _errors_command(bot, update, user_record)
async def _errors_command(bot, update, user_record):
return await errors_command(bot, update, user_record)
@telegram_bot.command(command='/father',
aliases=[],
@@ -1948,14 +2026,14 @@ def init(telegram_bot: Bot,
if key in ('description', )
},
authorization_level='admin')
async def father_command(bot, language):
return await _father_command(bot=bot, language=language)
async def _father_command(bot, language):
return await father_command(bot=bot, language=language)
@telegram_bot.button(prefix='father:///',
separator='|',
authorization_level='admin')
async def query_button(bot, user_record, language, data):
return await _father_button(bot=bot,
async def _father_button(bot, user_record, language, data):
return await father_button(bot=bot,
user_record=user_record,
language=language,
data=data)
@@ -1966,16 +2044,16 @@ def init(telegram_bot: Bot,
description=admin_messages[
'log_command']['description'],
authorization_level='admin')
async def log_command(bot, update, user_record):
return await _log_command(bot, update, user_record)
async def _log_command(bot, update, user_record):
return await log_command(bot, update, user_record)
@telegram_bot.command(command='/maintenance', aliases=[],
show_in_keyboard=False,
description=admin_messages[
'maintenance_command']['description'],
authorization_level='admin')
async def maintenance_command(bot, update, user_record):
return await _maintenance_command(bot, update, user_record)
async def _maintenance_command(bot, update, user_record):
return await maintenance_command(bot, update, user_record)
@telegram_bot.command(command='/query',
aliases=[],
@@ -1983,16 +2061,16 @@ def init(telegram_bot: Bot,
description=admin_messages[
'query_command']['description'],
authorization_level='admin')
async def query_command(bot, update, user_record):
return await _query_command(bot, update, user_record)
async def _query_command(bot, update, user_record):
return await query_command(bot, update, user_record)
@telegram_bot.button(prefix='db_query:///',
separator='|',
description=admin_messages[
'query_command']['description'],
authorization_level='admin')
async def query_button(bot, update, user_record, data):
return await _query_button(bot, update, user_record, data)
async def _query_button(bot, update, user_record, data):
return await query_button(bot, update, user_record, data)
@telegram_bot.command(command='/restart',
aliases=[],
@@ -2000,8 +2078,8 @@ def init(telegram_bot: Bot,
description=admin_messages[
'restart_command']['description'],
authorization_level='admin')
async def restart_command(bot, update, user_record):
return await _restart_command(bot, update, user_record)
async def _restart_command(bot, update, user_record):
return await restart_command(bot, update, user_record)
@telegram_bot.command(command='/select',
aliases=[],
@@ -2009,8 +2087,8 @@ def init(telegram_bot: Bot,
description=admin_messages[
'select_command']['description'],
authorization_level='admin')
async def select_command(bot, update, user_record):
return await _query_command(bot, update, user_record)
async def _select_command(bot, update, user_record):
return await query_command(bot, update, user_record)
@telegram_bot.command(command='/stop',
aliases=[],
@@ -2018,16 +2096,16 @@ def init(telegram_bot: Bot,
description=admin_messages[
'stop_command']['description'],
authorization_level='admin')
async def stop_command(bot, update, user_record):
return await _stop_command(bot, update, user_record)
async def _stop_command(bot, update, user_record):
return await stop_command(bot, update, user_record)
@telegram_bot.button(prefix='stop:///',
separator='|',
description=admin_messages[
'stop_command']['description'],
authorization_level='admin')
async def stop_button(bot, update, user_record, data):
return await _stop_button(bot, update, user_record, data)
async def _stop_button(bot, update, user_record, data):
return await stop_button(bot, update, user_record, data)
@telegram_bot.command(command='/talk',
aliases=[],
@@ -2035,14 +2113,14 @@ def init(telegram_bot: Bot,
description=admin_messages[
'talk_command']['description'],
authorization_level='admin')
async def talk_command(bot, update, user_record):
return await _talk_command(bot, update, user_record)
async def _talk_command(bot, update, user_record):
return await talk_command(bot, update, user_record)
@telegram_bot.button(prefix='talk:///',
separator='|',
authorization_level='admin')
async def talk_button(bot, update, user_record, data):
return await _talk_button(bot, update, user_record, data)
async def _talk_button(bot, update, user_record, data):
return await talk_button(bot, update, user_record, data)
@telegram_bot.command(command='/version',
aliases=[],
@@ -2053,8 +2131,8 @@ def init(telegram_bot: Bot,
},
show_in_keyboard=False,
authorization_level='admin')
async def version_command(bot, update, user_record, language):
return await _version_command(bot=bot,
async def _version_command(bot, update, user_record, language):
return await version_command(bot=bot,
update=update,
user_record=user_record,
language=language)
@@ -2068,8 +2146,9 @@ def init(telegram_bot: Bot,
},
show_in_keyboard=False,
authorization_level='admin')
async def config_command(bot, update, user_record, language):
return await _config_command(bot=bot,
async def _config_command(bot, update, user_record, language):
return await config_command(bot=bot,
update=update,
user_record=user_record,
language=language)
asyncio.ensure_future(create_promotion_command(bot=telegram_bot))
+1354 -85
View File
File diff suppressed because it is too large Load Diff
+5 -3
View File
@@ -25,6 +25,7 @@ class TelegramApiMethod(object):
'Boolean': "bool",
'Integer': "int",
'Integer or String': "Union[int, str]",
'Array of Integer': "List[str]",
'String': "str",
}
"""Telegram bot API method."""
@@ -55,14 +56,15 @@ class TelegramApiMethod(object):
for n, paragraph in enumerate(self.description.replace('.', '.\n').split('\n')):
additional_indentation = 0
if n == 0 and paragraph.startswith(redundant_string):
paragraph = paragraph[len(redundant_string)].upper() + paragraph[len(redundant_string)+1:]
paragraph = (paragraph[len(redundant_string)].upper()
+ paragraph[len(redundant_string)+1:])
for word in paragraph.split(' '):
if len(current_line) + len(word) > 80 - indentation - additional_indentation:
additional_indentation = max(additional_indentation, 4)
result += f"{current_line.strip()}\n{' ' * additional_indentation}"
current_line = ""
current_line += f"{word} "
if len(current_line):
if len(current_line) > 0:
result += f"{current_line.strip()}\n"
current_line = ""
if n == 0:
@@ -203,7 +205,7 @@ async def print_api_methods(filename=None,
)
)
if output_file:
with open(output_file, 'w') as file:
with open(output_file, 'w', encoding="utf-8") as file:
if new_methods:
file.write(
"from typing import List, Union\n"
+174 -71
View File
@@ -2,34 +2,6 @@
camelCase methods mirror API directly, while snake_case ones act as middleware
someway.
Usage
```
import sys
from davtelepot.bot import Bot
from data.passwords import my_token, my_other_token
long_polling_bot = Bot(token=my_token, database_url='my_db')
webhook_bot = Bot(token=my_other_token, hostname='example.com',
certificate='path/to/certificate.pem',
database_url='my_other_db')
@long_polling_bot.command('/foo')
async def foo_command(bot, update, user_record, language):
return "Bar!"
@webhook_bot.command('/bar')
async def bar_command(bot, update, user_record, language):
return "Foo!"
exit_state = Bot.run(
local_host='127.0.0.5',
port=8552
)
sys.exit(exit_state)
```
"""
# Standard library modules
@@ -49,7 +21,9 @@ from typing import Callable, List, Union, Dict
import aiohttp.web
# Project modules
from davtelepot.api import TelegramBot, TelegramError
from davtelepot.api import (
LinkPreviewOptions, ReplyParameters, TelegramBot, TelegramError
)
from davtelepot.database import ObjectWithDatabase
from davtelepot.languages import MultiLanguageObject
from davtelepot.messages import davtelepot_messages
@@ -104,10 +78,10 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
_errors_file_path = None
_documents_max_dimension = 50 * 1000 * 1000 # 50 MB
def __init__(
self, token, hostname='', certificate=None, max_connections=40,
allowed_updates=None, database_url='bot.db'
):
def __init__(self,
token, hostname='', certificate=None,
max_connections=40, allowed_updates=None,
database_url='bot.db', api_url: str = None):
"""Init a bot instance.
token : str
@@ -125,7 +99,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
# Append `self` to class list of instances
self.__class__.bots.append(self)
# Call superclasses constructors with proper arguments
TelegramBot.__init__(self, token)
TelegramBot.__init__(self, token, api_url=api_url)
ObjectWithDatabase.__init__(self, database_url=database_url)
MultiLanguageObject.__init__(self)
self.messages['davtelepot'] = davtelepot_messages
@@ -148,12 +122,47 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
'edited_message': self.edited_message_handler,
'channel_post': self.channel_post_handler,
'edited_channel_post': self.edited_channel_post_handler,
'business_connection': self.get_update_handler(
update_type='business_connection'
),
'business_message': self.get_update_handler(
update_type='business_message'
),
'edited_business_message': self.get_update_handler(
update_type='edited_business_message'
),
'deleted_business_messages': self.get_update_handler(
update_type='deleted_business_messages'
),
'message_reaction': self.get_update_handler(
update_type='message_reaction'
),
'message_reaction_count': self.get_update_handler(
update_type='message_reaction_count'
),
'inline_query': self.inline_query_handler,
'chosen_inline_result': self.chosen_inline_result_handler,
'callback_query': self.callback_query_handler,
'shipping_query': self.shipping_query_handler,
'pre_checkout_query': self.pre_checkout_query_handler,
'purchased_paid_media': self.get_update_handler(
update_type='purchased_paid_media'
),
'poll': self.poll_handler,
'poll_answer': self.get_update_handler(
update_type='poll_answer'
),
'my_chat_member': self.get_update_handler(
update_type='my_chat_member'
),
'chat_member': self.get_update_handler( update_type='chat_member' ),
'chat_join_request': self.get_update_handler(
update_type='chat_join_request'
),
'chat_boost': self.get_update_handler( update_type='chat_boost' ),
'removed_chat_boost': self.get_update_handler(
update_type='removed_chat_boost'
),
}
# Different message update types need different handlers
self.message_handlers = {
@@ -247,6 +256,8 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
self.Role = None
self.packages = [sys.modules['davtelepot']]
self._documents_max_dimension = None
self._getting_me = False
self._got_me = False
# Add `users` table with its fields if missing
if 'users' not in self.db.tables:
table = self.db.create_table(
@@ -706,6 +717,18 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
)
return
def get_update_handler(self, update_type: str):
"""Get update handler for `update_type`."""
bot = self
async def handler(update, user_record, language=None):
"""Handle update message of type `update_type`"""
logging.info(
"The following update was received: %s\n"
"However, this `%s` handler does nothing yet.",
update, update_type
)
return handler
async def edited_channel_post_handler(self, update, user_record, language=None):
"""Handle Telegram `edited_channel_post` update."""
logging.info(
@@ -1319,19 +1342,21 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
async def send_message(self, chat_id: Union[int, str] = None,
text: str = None,
message_thread_id: int = None,
entities: List[dict] = None,
parse_mode: str = 'HTML',
message_thread_id: int = None,
link_preview_options: LinkPreviewOptions = None,
disable_notification: bool = None,
protect_content: bool = None,
disable_web_page_preview: bool = None,
disable_notification: bool = None,
reply_to_message_id: int = None,
allow_sending_without_reply: bool = None,
reply_markup=None,
update: dict = None,
reply_to_update: bool = False,
send_default_keyboard: bool = True,
user_record: OrderedDict = None):
user_record: OrderedDict = None,
reply_parameters: ReplyParameters = None,
reply_markup=None):
"""Send text via message(s).
This method wraps lower-level `TelegramBot.sendMessage` method.
@@ -1352,6 +1377,10 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
user_record = self.db['users'].find_one(telegram_id=chat_id)
if reply_to_update and 'message_id' in update:
reply_to_message_id = update['message_id']
if disable_web_page_preview:
if link_preview_options is None:
link_preview_options = LinkPreviewOptions()
link_preview_options['is_disabled'] = True
if (
send_default_keyboard
and reply_markup is None
@@ -1395,19 +1424,27 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
limit=self.__class__.TELEGRAM_MESSAGES_MAX_LEN - 100,
parse_mode=parse_mode
)
if reply_to_message_id:
if reply_parameters is None:
reply_parameters = ReplyParameters(message_id=reply_to_message_id)
reply_parameters['message_id'] = reply_to_message_id
if allow_sending_without_reply:
reply_parameters['allow_sending_without_reply'] = allow_sending_without_reply
if reply_to_update and 'chat' in update and 'id' in update['chat']:
if update['chat']['id'] != chat_id:
reply_parameters['chat_id'] = update['chat']['id']
for text_chunk, is_last in text_chunks:
_reply_markup = (reply_markup if is_last else None)
sent_message_update = await self.sendMessage(
chat_id=chat_id,
text=text_chunk,
message_thread_id=message_thread_id,
parse_mode=parse_mode,
entities=entities,
message_thread_id=message_thread_id,
protect_content=protect_content,
disable_web_page_preview=disable_web_page_preview,
link_preview_options=link_preview_options,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
reply_parameters=reply_parameters,
reply_markup=_reply_markup
)
return sent_message_update
@@ -1431,6 +1468,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
parse_mode: str = 'HTML',
entities: List[dict] = None,
disable_web_page_preview: bool = None,
link_preview_options: LinkPreviewOptions = None,
allow_sending_without_reply: bool = None,
reply_markup=None,
update: dict = None):
@@ -1463,6 +1501,10 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
)
):
if i == 0:
if disable_web_page_preview:
if link_preview_options is None:
link_preview_options = LinkPreviewOptions()
link_preview_options['is_disabled'] = True
edited_message = await self.editMessageText(
text=text_chunk,
chat_id=chat_id,
@@ -1470,7 +1512,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
inline_message_id=inline_message_id,
parse_mode=parse_mode,
entities=entities,
disable_web_page_preview=disable_web_page_preview,
link_preview_options=link_preview_options,
reply_markup=(reply_markup if is_last else None)
)
if chat_id is None:
@@ -1576,6 +1618,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
reply_markup=None,
update: dict = None,
reply_to_update: bool = False,
reply_parameters: ReplyParameters = None,
send_default_keyboard: bool = True,
use_stored_file_id: bool = True):
"""Send photos.
@@ -1599,6 +1642,15 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
chat_id = self.get_chat_id(update)
if reply_to_update and 'message_id' in update:
reply_to_message_id = update['message_id']
if reply_to_message_id:
if reply_parameters is None:
reply_parameters = ReplyParameters(message_id=reply_to_message_id)
reply_parameters['message_id'] = reply_to_message_id
if allow_sending_without_reply:
reply_parameters['allow_sending_without_reply'] = allow_sending_without_reply
if reply_to_update and 'chat' in update and 'id' in update['chat']:
if update['chat']['id'] != chat_id:
reply_parameters['chat_id'] = update['chat']['id']
if (
send_default_keyboard
and reply_markup is None
@@ -1652,8 +1704,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
parse_mode=parse_mode,
caption_entities=caption_entities,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
reply_parameters=reply_parameters,
reply_markup=reply_markup
)
if isinstance(sent_update, Exception):
@@ -1701,6 +1752,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
reply_markup=None,
update: dict = None,
reply_to_update: bool = False,
reply_parameters: ReplyParameters = None,
send_default_keyboard: bool = True,
use_stored_file_id: bool = True):
"""Send audio files.
@@ -1724,6 +1776,15 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
chat_id = self.get_chat_id(update)
if reply_to_update and 'message_id' in update:
reply_to_message_id = update['message_id']
if reply_to_message_id:
if reply_parameters is None:
reply_parameters = ReplyParameters(message_id=reply_to_message_id)
reply_parameters['message_id'] = reply_to_message_id
if allow_sending_without_reply:
reply_parameters['allow_sending_without_reply'] = allow_sending_without_reply
if reply_to_update and 'chat' in update and 'id' in update['chat']:
if update['chat']['id'] != chat_id:
reply_parameters['chat_id'] = update['chat']['id']
if (
send_default_keyboard
and reply_markup is None
@@ -1781,8 +1842,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
title=title,
thumbnail=thumbnail,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
reply_parameters=reply_parameters,
reply_markup=reply_markup
)
if isinstance(sent_update, Exception):
@@ -1826,6 +1886,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
reply_markup=None,
update: dict = None,
reply_to_update: bool = False,
reply_parameters: ReplyParameters = None,
send_default_keyboard: bool = True,
use_stored_file_id: bool = True):
"""Send voice messages.
@@ -1849,6 +1910,15 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
chat_id = self.get_chat_id(update)
if reply_to_update and 'message_id' in update:
reply_to_message_id = update['message_id']
if reply_to_message_id:
if reply_parameters is None:
reply_parameters = ReplyParameters(message_id=reply_to_message_id)
reply_parameters['message_id'] = reply_to_message_id
if allow_sending_without_reply:
reply_parameters['allow_sending_without_reply'] = allow_sending_without_reply
if reply_to_update and 'chat' in update and 'id' in update['chat']:
if update['chat']['id'] != chat_id:
reply_parameters['chat_id'] = update['chat']['id']
if (
send_default_keyboard
and reply_markup is None
@@ -1903,8 +1973,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
caption_entities=caption_entities,
duration=duration,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
reply_parameters=reply_parameters,
reply_markup=reply_markup
)
if isinstance(sent_update, Exception):
@@ -1951,6 +2020,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
document_name: str = None,
update: dict = None,
reply_to_update: bool = False,
reply_parameters: ReplyParameters = None,
send_default_keyboard: bool = True,
use_stored_file_id: bool = False):
"""Send a document.
@@ -1983,6 +2053,15 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
return
if reply_to_update and 'message_id' in update:
reply_to_message_id = update['message_id']
if reply_to_message_id:
if reply_parameters is None:
reply_parameters = ReplyParameters(message_id=reply_to_message_id)
reply_parameters['message_id'] = reply_to_message_id
if allow_sending_without_reply:
reply_parameters['allow_sending_without_reply'] = allow_sending_without_reply
if reply_to_update and 'chat' in update and 'id' in update['chat']:
if update['chat']['id'] != chat_id:
reply_parameters['chat_id'] = update['chat']['id']
if chat_id > 0:
user_record = self.db['users'].find_one(telegram_id=chat_id)
language = self.get_language(update=update, user_record=user_record)
@@ -2061,7 +2140,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
caption=caption,
parse_mode=parse_mode,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
reply_parameters=reply_parameters,
reply_markup=reply_markup,
update=update,
reply_to_update=reply_to_update,
@@ -2092,8 +2171,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
caption_entities=caption_entities,
disable_content_type_detection=disable_content_type_detection,
disable_notification=disable_notification,
reply_to_message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
reply_parameters=reply_parameters,
reply_markup=reply_markup
)
if isinstance(sent_update, Exception):
@@ -2127,7 +2205,8 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
return sent_update
async def download_file(self, file_id,
file_name=None, path=None):
file_name=None, path=None,
prevent_overwriting: bool = False):
"""Given a telegram `file_id`, download the related file.
Telegram may not preserve the original file name and MIME type: the
@@ -2137,26 +2216,35 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
file = await self.getFile(file_id=file_id)
if file is None or isinstance(file, Exception):
logging.error(f"{file}")
return
return file
if self.api_url == 'https://api.telegram.org':
file_bytes = await async_get(
url=(
f"https://api.telegram.org/file/"
f"{self.api_url}/file/"
f"bot{self.token}/"
f"{file['file_path']}"
),
mode='raw'
)
path = path or self.path
while file_name is None:
if file_name is None:
file_name = get_secure_key(length=10)
if os.path.exists(f"{path}/{file_name}"):
file_name = None
file_complete_path = os.path.join(path, file_name)
if prevent_overwriting:
while os.path.exists(file_complete_path):
file_complete_path = file_complete_path + '1'
try:
with open(f"{path}/{file_name}", 'wb') as local_file:
with open(file_complete_path, 'wb') as local_file:
local_file.write(file_bytes)
except Exception as e:
logging.error(f"File download failed due to {e}")
return
return e
else:
file_complete_path = file['file_path']
return dict(file_id=file_id,
file_name=file_name,
path=path,
file_complete_path=file_complete_path)
def translate_inline_query_answer_result(self, record,
update=None, user_record=None):
@@ -2765,9 +2853,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
"""
if not callable(condition):
raise TypeError(
'Condition {c} is not a callable'.format(
c=condition.__name__
)
f'Condition {condition.__name__} is not a callable'
)
def query_decorator(handler):
@@ -3108,26 +3194,41 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
Restart bots if bot can't be got.
"""
for _ in range(60):
if not self._getting_me:
break
await asyncio.sleep(0.5)
else:
raise TimeoutError("Getting bot information was in progress but "
"did not make it in 30 seconds...")
if self._got_me:
return
self._getting_me = True
try:
me = await self.getMe()
if isinstance(me, Exception):
raise me
elif me is None:
raise Exception('getMe returned None')
if me is None:
raise TypeError('getMe returned None')
self._name = me["username"]
self._telegram_id = me['id']
except Exception as e:
logging.error(
f"API getMe method failed, information about this bot could "
f"not be retrieved. Restarting in 5 minutes...\n\n"
f"Error information:\n{e}"
"API getMe method failed, information about this bot could "
"not be retrieved. Restarting in 5 minutes...\n\n"
"Error information:\n%s", e
)
self._getting_me = False
await asyncio.sleep(5*60)
if self._got_me:
return
self.__class__.stop(
message="Information about this bot could not be retrieved.\n"
"Restarting...",
final_state=65
)
self._getting_me = False
self._got_me = True
def setup(self):
"""Make bot ask for updates and handle responses."""
@@ -3142,9 +3243,11 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
async def close_sessions(self):
"""Close open sessions."""
for session_name, session in self.sessions.items():
for session_name in list(self.sessions.keys()):
session = self.sessions[session_name]
if not session.closed:
await session.close()
del self.sessions[session_name]
async def send_one_message(self, *args, **kwargs):
sent_message = await self.send_message(*args, **kwargs)
@@ -3495,7 +3598,7 @@ class Bot(TelegramBot, ObjectWithDatabase, MultiLanguageObject):
Each bot will receive updates via long polling or webhook according to
its initialization parameters.
A single aiohttp.web.Application instance will be run (cls.app) on
local_host:port and it may serve custom-defined routes as well.
local_host:port, and it may serve custom-defined routes as well.
"""
if local_host is not None:
cls.local_host = local_host
+10
View File
@@ -22,6 +22,16 @@ davtelepot_messages = {
}
default_admin_messages = {
'become_admin': {
'success': {
'en': "🎉 You are now administrator! 👑",
'it': "🎉 Ora hai diritti di amministrazione! 👑",
},
'wrong_token': {
'en': "❌ Wrong token 🚷",
'it': "❌ Password errata 🚷",
},
},
'cancel': {
'button': {
'en': "↩️ Cancel",
+1 -1
View File
@@ -51,7 +51,7 @@ setuptools.setup(
license=find_information("license", "davtelepot", "__init__.py"),
long_description=long_description,
long_description_content_type="text/markdown",
url="https://gogs.davte.it/davte/davtelepot",
url="https://gitea.davte.it/davte/davtelepot",
packages=setuptools.find_packages(),
platforms=['any'],
install_requires=[