1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903 |
- """Provide a simple Bot object, mirroring Telegram API methods.
- camelCase methods mirror API directly, while snake_case ones act as middlewares
- 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):
- return "Bar!"
- @webhook_bot.command('/bar')
- async def bar_command(bot, update, user_record):
- return "Foo!"
- exit_state = Bot.run()
- sys.exit(exit_state)
- ```
- """
- # Standard library modules
- import asyncio
- from collections import OrderedDict
- import io
- import inspect
- import logging
- import os
- import re
- # Third party modules
- from aiohttp import web
- # Project modules
- from davtelepot.api import TelegramBot, TelegramError
- from davtelepot.database import ObjectWithDatabase
- from davtelepot.utilities import (
- escape_html_chars, extract, get_secure_key, make_inline_query_answer,
- make_lines_of_buttons, remove_html_tags
- )
- # Do not log aiohttp `INFO` and `DEBUG` levels
- logging.getLogger('aiohttp').setLevel(logging.WARNING)
- class Bot(TelegramBot, ObjectWithDatabase):
- """Simple Bot object, providing methods corresponding to Telegram bot API.
- Multiple Bot() instances may be run together, along with a aiohttp web app.
- """
- bots = []
- _path = '.'
- runner = None
- local_host = 'localhost'
- port = 3000
- final_state = 0
- _maintenance_message = ("I am currently under maintenance!\n"
- "Please retry later...")
- _authorization_denied_message = None
- _unknown_command_message = None
- TELEGRAM_MESSAGES_MAX_LEN = 4096
- _default_inline_query_answer = [
- dict(
- type='article',
- id=0,
- title="I cannot answer this query, sorry",
- input_message_content=dict(
- message_text="I'm sorry "
- "but I could not find an answer for your query."
- )
- )
- ]
- def __init__(
- self, token, hostname='', certificate=None, max_connections=40,
- allowed_updates=[], database_url='bot.db'
- ):
- """Init a bot instance.
- token : str
- Telegram bot API token.
- hostname : str
- Domain (or public IP address) for webhooks.
- certificate : str
- Path to domain certificate.
- max_connections : int (1 - 100)
- Maximum number of HTTPS connections allowed.
- allowed_updates : List(str)
- Allowed update types (empty list to allow all).
- """
- # Append `self` to class list of instances
- self.__class__.bots.append(self)
- # Call superclasses constructors with proper arguments
- TelegramBot.__init__(self, token)
- ObjectWithDatabase.__init__(self, database_url=database_url)
- self._path = None
- self.preliminary_tasks = []
- self.final_tasks = []
- self._offset = 0
- self._hostname = hostname
- self._certificate = certificate
- self._max_connections = max_connections
- self._allowed_updates = allowed_updates
- self._session_token = get_secure_key(length=10)
- self._name = None
- self._telegram_id = None
- # The following routing table associates each type of Telegram `update`
- # with a Bot method to be invoked on it.
- self.routing_table = {
- 'message': self.message_router,
- 'edited_message': self.edited_message_handler,
- 'channel_post': self.channel_post_handler,
- 'edited_channel_post': self.edited_channel_post_handler,
- '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,
- 'poll': self.poll_handler,
- }
- # Different message update types need different handlers
- self.message_handlers = {
- 'text': self.text_message_handler,
- 'audio': self.audio_message_handler,
- 'document': self.document_message_handler,
- 'animation': self.animation_message_handler,
- 'game': self.game_message_handler,
- 'photo': self.photo_message_handler,
- 'sticker': self.sticker_message_handler,
- 'video': self.video_message_handler,
- 'voice': self.voice_message_handler,
- 'video_note': self.video_note_message_handler,
- 'contact': self.contact_message_handler,
- 'location': self.location_message_handler,
- 'venue': self.venue_message_handler,
- 'poll': self.poll_message_handler,
- 'new_chat_members': self.new_chat_members_message_handler,
- 'left_chat_member': self.left_chat_member_message_handler,
- 'new_chat_title': self.new_chat_title_message_handler,
- 'new_chat_photo': self.new_chat_photo_message_handler,
- 'delete_chat_photo': self.delete_chat_photo_message_handler,
- 'group_chat_created': self.group_chat_created_message_handler,
- 'supergroup_chat_created': (
- self.supergroup_chat_created_message_handler
- ),
- 'channel_chat_created': self.channel_chat_created_message_handler,
- 'migrate_to_chat_id': self.migrate_to_chat_id_message_handler,
- 'migrate_from_chat_id': self.migrate_from_chat_id_message_handler,
- 'pinned_message': self.pinned_message_message_handler,
- 'invoice': self.invoice_message_handler,
- 'successful_payment': self.successful_payment_message_handler,
- 'connected_website': self.connected_website_message_handler,
- 'passport_data': self.passport_data_message_handler
- }
- # Special text message handlers: individual, commands, aliases, parsers
- self.individual_text_message_handlers = dict()
- self.commands = OrderedDict()
- self.command_aliases = OrderedDict()
- self._unknown_command_message = None
- self.text_message_parsers = OrderedDict()
- # Callback query-related properties
- self.callback_handlers = OrderedDict()
- self._callback_data_separator = None
- # Inline query-related properties
- self.inline_query_handlers = OrderedDict()
- self._default_inline_query_answer = None
- self.chosen_inline_result_handlers = dict()
- # Maintenance properties
- self._under_maintenance = False
- self._allowed_during_maintenance = []
- self._maintenance_message = None
- # Default chat_id getter: same chat as update
- self.get_chat_id = lambda update: (
- update['message']['chat']['id']
- if 'message' in update and 'chat' in update['message']
- else update['chat']['id']
- if 'chat' in update
- else None
- )
- # Message to be returned if user is not allowed to call method
- self._authorization_denied_message = None
- # Default authorization function (always return True)
- self.authorization_function = (
- lambda update, user_record=None, authorization_level='user': True
- )
- self.default_reply_keyboard_elements = []
- self._default_keyboard = dict()
- return
- @property
- def path(self):
- """Path where files should be looked for.
- If no instance path is set, return class path.
- """
- return self._path or self.__class__._path
- @classmethod
- def set_class_path(csl, path):
- """Set class path attribute."""
- csl._path = path
- def set_path(self, path):
- """Set instance path attribute."""
- self._path = path
- @property
- def hostname(self):
- """Hostname for the webhook URL.
- It must be a public domain or IP address. Port may be specified.
- A custom webhook url, including bot token and a random token, will be
- generated for Telegram to post new updates.
- """
- return self._hostname
- @property
- def webhook_url(self):
- """URL where Telegram servers should post new updates.
- It must be a public domain name or IP address. Port may be specified.
- """
- if not self.hostname:
- return ''
- return (
- f"{self.hostname}/webhook/{self.token}_{self.session_token}/"
- )
- @property
- def webhook_local_address(self):
- """Local address where Telegram updates are routed by revers proxy."""
- return (
- f"/webhook/{self.token}_{self.session_token}/"
- )
- @property
- def certificate(self):
- """Public certificate for `webhook_url`.
- May be self-signed
- """
- return self._certificate
- @property
- def max_connections(self):
- """Maximum number of simultaneous HTTPS connections allowed.
- Telegram will open as many connections as possible to boost bot’s
- throughput, lower values limit the load on bot‘s server.
- """
- return self._max_connections
- @property
- def allowed_updates(self):
- """List of update types to be retrieved.
- Empty list to allow all updates.
- """
- return self._allowed_updates
- @property
- def name(self):
- """Bot name."""
- return self._name
- @property
- def telegram_id(self):
- """Telegram id of this bot."""
- return self._telegram_id
- @property
- def session_token(self):
- """Return a token generated with the current instantiation."""
- return self._session_token
- @property
- def offset(self):
- """Return last update id.
- Useful to ignore repeated updates and restore original update order.
- """
- return self._offset
- @property
- def under_maintenance(self):
- """Return True if bot is under maintenance.
- While under maintenance, bot will reply `self.maintenance_message` to
- any update, except those which `self.is_allowed_during_maintenance`
- returns True for.
- """
- return self._under_maintenance
- @property
- def allowed_during_maintenance(self):
- """Return the list of criteria to allow an update during maintenance.
- If any of this criteria returns True on an update, that update will be
- handled even during maintenance.
- """
- return self._allowed_during_maintenance
- @property
- def maintenance_message(self):
- """Message to be returned if bot is under maintenance.
- If instance message is not set, class message is returned.
- """
- if self._maintenance_message:
- return self._maintenance_message
- if self.__class__.maintenance_message:
- return self.__class__._maintenance_message
- return ("I am currently under maintenance!\n"
- "Please retry later...")
- @property
- def authorization_denied_message(self):
- """Return this text if user is unauthorized to make a request.
- If instance message is not set, class message is returned.
- """
- if self._authorization_denied_message:
- return self._authorization_denied_message
- return self.__class__._authorization_denied_message
- @property
- def default_keyboard(self):
- """Get the default keyboard.
- It is sent when reply_markup is left blank and chat is private.
- """
- return self._default_keyboard
- @property
- def unknown_command_message(self):
- """Message to be returned if user sends an unknown command.
- If instance message is not set, class message is returned.
- """
- if self._unknown_command_message:
- return self._unknown_command_message
- return self.__class__._unknown_command_message
- @property
- def callback_data_separator(self):
- """Separator between callback data elements.
- Example of callback_data: 'my_button_prefix:///1|4|test'
- Prefix: `my_button_prefix:///`
- Separator: `|` <--- this is returned
- Data: `['1', '4', 'test']`
- """
- return self._callback_data_separator
- def set_callback_data_separator(self, separator):
- """Set a callback_data separator.
- See property `callback_data_separator` for details.
- """
- assert type(separator) is str, "Separator must be a string!"
- self._callback_data_separator = separator
- @property
- def default_inline_query_answer(self):
- """Answer to be returned if inline query returned None.
- If instance default answer is not set, class one is returned.
- """
- if self._default_inline_query_answer:
- return self._default_inline_query_answer
- return self.__class__._default_inline_query_answer
- @classmethod
- def set_class_default_inline_query_answer(cls,
- default_inline_query_answer):
- """Set class default inline query answer.
- It will be returned if an inline query returned no answer.
- """
- cls._default_inline_query_answer = make_inline_query_answer(
- default_inline_query_answer
- )
- def set_default_inline_query_answer(self, default_inline_query_answer):
- """Set a custom default_inline_query_answer.
- It will be returned when no answer is found for an inline query.
- If instance answer is None, default class answer is used.
- """
- self._default_inline_query_answer = make_inline_query_answer(
- default_inline_query_answer
- )
- async def message_router(self, update, user_record):
- """Route Telegram `message` update to appropriate message handler."""
- for key, value in update.items():
- if key in self.message_handlers:
- return await self.message_handlers[key](update, user_record)
- logging.error(
- f"The following message update was received: {update}\n"
- "However, this message type is unknown."
- )
- async def edited_message_handler(self, update, user_record):
- """Handle Telegram `edited_message` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this edited_message handler does nothing yet."
- )
- return
- async def channel_post_handler(self, update, user_record):
- """Handle Telegram `channel_post` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this channel_post handler does nothing yet."
- )
- return
- async def edited_channel_post_handler(self, update, user_record):
- """Handle Telegram `edited_channel_post` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this edited_channel_post handler does nothing yet."
- )
- return
- async def inline_query_handler(self, update, user_record):
- """Handle Telegram `inline_query` update.
- Answer it with results or log errors.
- """
- query = update['query']
- results, switch_pm_text, switch_pm_parameter = None, None, None
- for condition, handler in self.inline_query_handlers.items():
- if condition(query):
- _handler = handler['handler']
- results = await _handler(bot=self, update=update,
- user_record=user_record)
- break
- if not results:
- results = self.default_inline_query_answer
- if type(results) is dict and 'answer' in results:
- if 'switch_pm_text' in results:
- switch_pm_text = results['switch_pm_text']
- if 'switch_pm_parameter' in results:
- switch_pm_parameter = results['switch_pm_parameter']
- results = results['answer']
- try:
- await self.answer_inline_query(
- update=update,
- results=results,
- cache_time=10,
- is_personal=True,
- switch_pm_text=switch_pm_text,
- switch_pm_parameter=switch_pm_parameter
- )
- except Exception as e:
- logging.info("Error answering inline query\n{}".format(e))
- return
- async def chosen_inline_result_handler(self, update, user_record):
- """Handle Telegram `chosen_inline_result` update."""
- user_id = update['from']['id']
- if user_id in self.chosen_inline_result_handlers:
- result_id = update['result_id']
- handlers = self.chosen_inline_result_handlers[user_id]
- if result_id in handlers:
- func = handlers[result_id]
- if asyncio.iscoroutinefunction(func):
- await func(update)
- else:
- func(update)
- return
- def set_inline_result_handler(self, user_id, result_id, func):
- """Associate a func to a result_id.
- When an inline result is chosen having that id, function will
- be passed the update as argument.
- """
- if type(user_id) is dict:
- user_id = user_id['from']['id']
- assert type(user_id) is int, "user_id must be int!"
- # Query result ids are parsed as str by telegram
- result_id = str(result_id)
- assert callable(func), "func must be a callable"
- if user_id not in self.chosen_inline_result_handlers:
- self.chosen_inline_result_handlers[user_id] = {}
- self.chosen_inline_result_handlers[user_id][result_id] = func
- return
- async def callback_query_handler(self, update, user_record):
- """Handle Telegram `callback_query` update.
- A callback query is sent when users press inline keyboard buttons.
- Bad clients may send malformed or deceiving callback queries:
- never put secrets in buttons and always check request validity!
- Get an `answer` from the callback handler associated to the query
- prefix and use it to edit the source message (or send new ones
- if text is longer than single message limit).
- Anyway, the query is answered, otherwise the client would hang and
- the bot would look like idle.
- """
- assert 'data' in update, "Malformed callback query lacking data field."
- answer = dict()
- data = update['data']
- for start_text, handler in self.callback_handlers.items():
- if data.startswith(start_text):
- _function = handler['handler']
- answer = await _function(
- bot=self,
- update=update,
- user_record=user_record
- )
- break
- if type(answer) is str:
- answer = dict(text=answer)
- assert type(answer) is dict, "Invalid callback query answer."
- if 'edit' in answer:
- message_identifier = self.get_message_identifier(update)
- edit = answer['edit']
- method = (
- self.edit_message_text if 'text' in edit
- else self.editMessageCaption if 'caption' in edit
- else self.editMessageReplyMarkup if 'reply_markup' in edit
- else (lambda *args, **kwargs: None)
- )
- try:
- await method(**message_identifier, **edit)
- except TelegramError as e:
- logging.info("Message was not modified:\n{}".format(e))
- try:
- return await self.answerCallbackQuery(
- callback_query_id=update['id'],
- **{
- key: (val[:180] if key == 'text' else val)
- for key, val in answer.items()
- if key in ('text', 'show_alert', 'cache_time')
- }
- )
- except TelegramError as e:
- logging.error(e)
- return
- async def shipping_query_handler(self, update, user_record):
- """Handle Telegram `shipping_query` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this shipping_query handler does nothing yet."
- )
- return
- async def pre_checkout_query_handler(self, update, user_record):
- """Handle Telegram `pre_checkout_query` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this pre_checkout_query handler does nothing yet."
- )
- return
- async def poll_handler(self, update, user_record):
- """Handle Telegram `poll` update."""
- logging.info(
- f"The following update was received: {update}\n"
- "However, this poll handler does nothing yet."
- )
- return
- async def text_message_handler(self, update, user_record):
- """Handle `text` message update."""
- replier, reply = None, None
- text = update['text'].lower()
- user_id = update['from']['id'] if 'from' in update else None
- if user_id in self.individual_text_message_handlers:
- replier = self.individual_text_message_handlers[user_id]
- del self.individual_text_message_handlers[user_id]
- elif text.startswith('/'): # Handle commands
- # A command must always start with the ‘/’ symbol and may not be
- # longer than 32 characters.
- # Commands can use latin letters, numbers and underscores.
- command = re.search(
- r"([A-z_1-9]){1,32}", # Command pattern (without leading `/`)
- text
- ).group(0) # Get the first group of characters matching pattern
- if command in self.commands:
- replier = self.commands[command]['handler']
- elif 'chat' in update and update['chat']['id'] > 0:
- reply = self.unknown_command_message
- else: # Handle command aliases and text parsers
- # Aliases are case insensitive: text and alias are both .lower()
- for alias, function in self.command_aliases.items():
- if text.startswith(alias.lower()):
- replier = function
- break
- # Text message update parsers
- for check_function, parser in self.text_message_parsers.items():
- if (
- parser['argument'] == 'text'
- and check_function(text)
- ) or (
- parser['argument'] == 'update'
- and check_function(update)
- ):
- replier = parser['handler']
- break
- if replier:
- reply = await replier(
- bot=self,
- update=update,
- user_record=user_record
- )
- if reply:
- if type(reply) is str:
- reply = dict(text=reply)
- try:
- if 'text' in reply:
- return await self.send_message(update=update, **reply)
- if 'photo' in reply:
- return await self.send_photo(update=update, **reply)
- except Exception as e:
- logging.error(
- f"Failed to handle text message:\n{e}",
- exc_info=True
- )
- return
- async def audio_message_handler(self, update, user_record):
- """Handle `audio` message update."""
- logging.info(
- "A audio message update was received, "
- "but this handler does nothing yet."
- )
- async def document_message_handler(self, update, user_record):
- """Handle `document` message update."""
- logging.info(
- "A document message update was received, "
- "but this handler does nothing yet."
- )
- async def animation_message_handler(self, update, user_record):
- """Handle `animation` message update."""
- logging.info(
- "A animation message update was received, "
- "but this handler does nothing yet."
- )
- async def game_message_handler(self, update, user_record):
- """Handle `game` message update."""
- logging.info(
- "A game message update was received, "
- "but this handler does nothing yet."
- )
- async def photo_message_handler(self, update, user_record):
- """Handle `photo` message update."""
- logging.info(
- "A photo message update was received, "
- "but this handler does nothing yet."
- )
- async def sticker_message_handler(self, update, user_record):
- """Handle `sticker` message update."""
- logging.info(
- "A sticker message update was received, "
- "but this handler does nothing yet."
- )
- async def video_message_handler(self, update, user_record):
- """Handle `video` message update."""
- logging.info(
- "A video message update was received, "
- "but this handler does nothing yet."
- )
- async def voice_message_handler(self, update, user_record):
- """Handle `voice` message update."""
- logging.info(
- "A voice message update was received, "
- "but this handler does nothing yet."
- )
- async def video_note_message_handler(self, update, user_record):
- """Handle `video_note` message update."""
- logging.info(
- "A video_note message update was received, "
- "but this handler does nothing yet."
- )
- async def contact_message_handler(self, update, user_record):
- """Handle `contact` message update."""
- logging.info(
- "A contact message update was received, "
- "but this handler does nothing yet."
- )
- async def location_message_handler(self, update, user_record):
- """Handle `location` message update."""
- logging.info(
- "A location message update was received, "
- "but this handler does nothing yet."
- )
- async def venue_message_handler(self, update, user_record):
- """Handle `venue` message update."""
- logging.info(
- "A venue message update was received, "
- "but this handler does nothing yet."
- )
- async def poll_message_handler(self, update, user_record):
- """Handle `poll` message update."""
- logging.info(
- "A poll message update was received, "
- "but this handler does nothing yet."
- )
- async def new_chat_members_message_handler(self, update, user_record):
- """Handle `new_chat_members` message update."""
- logging.info(
- "A new_chat_members message update was received, "
- "but this handler does nothing yet."
- )
- async def left_chat_member_message_handler(self, update, user_record):
- """Handle `left_chat_member` message update."""
- logging.info(
- "A left_chat_member message update was received, "
- "but this handler does nothing yet."
- )
- async def new_chat_title_message_handler(self, update, user_record):
- """Handle `new_chat_title` message update."""
- logging.info(
- "A new_chat_title message update was received, "
- "but this handler does nothing yet."
- )
- async def new_chat_photo_message_handler(self, update, user_record):
- """Handle `new_chat_photo` message update."""
- logging.info(
- "A new_chat_photo message update was received, "
- "but this handler does nothing yet."
- )
- async def delete_chat_photo_message_handler(self, update, user_record):
- """Handle `delete_chat_photo` message update."""
- logging.info(
- "A delete_chat_photo message update was received, "
- "but this handler does nothing yet."
- )
- async def group_chat_created_message_handler(self, update, user_record):
- """Handle `group_chat_created` message update."""
- logging.info(
- "A group_chat_created message update was received, "
- "but this handler does nothing yet."
- )
- async def supergroup_chat_created_message_handler(self, update,
- user_record):
- """Handle `supergroup_chat_created` message update."""
- logging.info(
- "A supergroup_chat_created message update was received, "
- "but this handler does nothing yet."
- )
- async def channel_chat_created_message_handler(self, update, user_record):
- """Handle `channel_chat_created` message update."""
- logging.info(
- "A channel_chat_created message update was received, "
- "but this handler does nothing yet."
- )
- async def migrate_to_chat_id_message_handler(self, update, user_record):
- """Handle `migrate_to_chat_id` message update."""
- logging.info(
- "A migrate_to_chat_id message update was received, "
- "but this handler does nothing yet."
- )
- async def migrate_from_chat_id_message_handler(self, update, user_record):
- """Handle `migrate_from_chat_id` message update."""
- logging.info(
- "A migrate_from_chat_id message update was received, "
- "but this handler does nothing yet."
- )
- async def pinned_message_message_handler(self, update, user_record):
- """Handle `pinned_message` message update."""
- logging.info(
- "A pinned_message message update was received, "
- "but this handler does nothing yet."
- )
- async def invoice_message_handler(self, update, user_record):
- """Handle `invoice` message update."""
- logging.info(
- "A invoice message update was received, "
- "but this handler does nothing yet."
- )
- async def successful_payment_message_handler(self, update, user_record):
- """Handle `successful_payment` message update."""
- logging.info(
- "A successful_payment message update was received, "
- "but this handler does nothing yet."
- )
- async def connected_website_message_handler(self, update, user_record):
- """Handle `connected_website` message update."""
- logging.info(
- "A connected_website message update was received, "
- "but this handler does nothing yet."
- )
- async def passport_data_message_handler(self, update, user_record):
- """Handle `passport_data` message update."""
- logging.info(
- "A passport_data message update was received, "
- "but this handler does nothing yet."
- )
- @staticmethod
- def split_message_text(text, limit=None, parse_mode='HTML'):
- r"""Split text if it hits telegram limits for text messages.
- Split at `\n` if possible.
- Add a `[...]` at the end and beginning of split messages,
- with proper code markdown.
- """
- if parse_mode == 'HTML':
- text = escape_html_chars(text)
- tags = (
- ('`', '`')
- if parse_mode == 'Markdown'
- else ('<code>', '</code>')
- if parse_mode.lower() == 'html'
- else ('', '')
- )
- if limit is None:
- limit = Bot.TELEGRAM_MESSAGES_MAX_LEN - 100
- # Example text: "lines\nin\nreversed\order"
- text = text.split("\n")[::-1] # ['order', 'reversed', 'in', 'lines']
- text_part_number = 0
- while len(text) > 0:
- temp = []
- text_part_number += 1
- while (
- len(text) > 0
- and len(
- "\n".join(temp + [text[-1]])
- ) < limit
- ):
- # Append lines of `text` in order (`.pop` returns the last
- # line in text) until the addition of the next line would hit
- # the `limit`.
- temp.append(text.pop())
- # If graceful split failed (last line was longer than limit)
- if len(temp) == 0:
- # Force split last line
- temp.append(text[-1][:limit])
- text[-1] = text[-1][limit:]
- text_chunk = "\n".join(temp) # Re-join this group of lines
- prefix, suffix = '', ''
- is_last = len(text) == 0
- if text_part_number > 1:
- prefix = f"{tags[0]}[...]{tags[1]}\n"
- if not is_last:
- suffix = f"\n{tags[0]}[...]{tags[1]}"
- yield (prefix + text_chunk + suffix), is_last
- return
- async def send_message(self, chat_id=None, text=None,
- parse_mode='HTML',
- disable_web_page_preview=None,
- disable_notification=None,
- reply_to_message_id=None,
- reply_markup=None,
- update=dict(),
- reply_to_update=False,
- send_default_keyboard=True):
- """Send text via message(s).
- This method wraps lower-level `TelegramBot.sendMessage` method.
- Pass an `update` to extract `chat_id` and `message_id` from it.
- Set `reply_to_update` = True to reply to `update['message_id']`.
- Set `send_default_keyboard` = False to avoid sending default keyboard
- as reply_markup (only those messages can be edited, which were
- sent with no reply markup or with an inline keyboard).
- """
- if 'message' in update:
- update = update['message']
- if chat_id is None and 'chat' in update:
- chat_id = self.get_chat_id(update)
- if reply_to_update and 'message_id' in update:
- reply_to_message_id = update['message_id']
- if (
- send_default_keyboard
- and reply_markup is None
- and type(chat_id) is int
- and chat_id > 0
- and text != self.authorization_denied_message
- ):
- reply_markup = self.default_keyboard
- if not text:
- return
- parse_mode = str(parse_mode)
- text_chunks = self.split_message_text(
- text=text,
- limit=self.__class__.TELEGRAM_MESSAGES_MAX_LEN - 100,
- parse_mode=parse_mode
- )
- 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,
- parse_mode=parse_mode,
- disable_web_page_preview=disable_web_page_preview,
- disable_notification=disable_notification,
- reply_to_message_id=reply_to_message_id,
- reply_markup=_reply_markup
- )
- return sent_message_update
- async def edit_message_text(self, text,
- chat_id=None, message_id=None,
- inline_message_id=None,
- parse_mode='HTML',
- disable_web_page_preview=None,
- reply_markup=None,
- update=None):
- """Edit message text, sending new messages if necessary.
- This method wraps lower-level `TelegramBot.editMessageText` method.
- Pass an `update` to extract a message identifier from it.
- """
- if update is not None:
- message_identifier = self.get_message_identifier(update)
- if 'chat_id' in message_identifier:
- chat_id = message_identifier['chat_id']
- message_id = message_identifier['message_id']
- if 'inline_message_id' in message_identifier:
- inline_message_id = message_identifier['inline_message_id']
- for i, text_chunk in enumerate(
- self.split_message_text(
- text=text,
- limit=self.__class__.TELEGRAM_MESSAGES_MAX_LEN - 200,
- parse_mode=parse_mode
- )
- ):
- if i == 0:
- edited_message = await self.editMessageText(
- text=text_chunk,
- chat_id=chat_id,
- message_id=message_id,
- inline_message_id=inline_message_id,
- parse_mode=parse_mode,
- disable_web_page_preview=disable_web_page_preview,
- reply_markup=reply_markup
- )
- if chat_id is None:
- # Cannot send messages without a chat_id
- # Inline keyboards attached to inline query results may be
- # in chats the bot cannot reach.
- break
- else:
- await self.send_message(
- text=text,
- chat_id=chat_id,
- parse_mode=parse_mode,
- disable_web_page_preview=disable_web_page_preview,
- reply_markup=reply_markup,
- update=update,
- reply_to_update=True,
- send_default_keyboard=False
- )
- return edited_message
- async def send_photo(self, chat_id=None, photo=None,
- caption=None,
- parse_mode=None,
- disable_notification=None,
- reply_to_message_id=None,
- reply_markup=None,
- update=dict(),
- reply_to_update=False,
- send_default_keyboard=True,
- use_stored_file_id=True):
- """Send photos.
- This method wraps lower-level `TelegramBot.sendPhoto` method.
- Pass an `update` to extract `chat_id` and `message_id` from it.
- Set `reply_to_update` = True to reply to `update['message_id']`.
- Set `send_default_keyboard` = False to avoid sending default keyboard
- as reply_markup (only those messages can be edited, which were
- sent with no reply markup or with an inline keyboard).
- If photo was already sent by this bot and `use_stored_file_id` is set
- to True, use file_id (it is faster and recommended).
- """
- already_sent = False
- if 'message' in update:
- update = update['message']
- if chat_id is None and 'chat' in update:
- chat_id = self.get_chat_id(update)
- if reply_to_update and 'message_id' in update:
- reply_to_message_id = update['message_id']
- if (
- send_default_keyboard
- and reply_markup is None
- and type(chat_id) is int
- and chat_id > 0
- and caption != self.authorization_denied_message
- ):
- reply_markup = self.default_keyboard
- if type(photo) is str:
- photo_path = photo
- with self.db as db:
- already_sent = db['sent_pictures'].find_one(
- path=photo_path,
- errors=False
- )
- if already_sent and use_stored_file_id:
- photo = already_sent['file_id']
- already_sent = True
- else:
- already_sent = False
- if not any(
- [
- photo.startswith(url_starter)
- for url_starter in ('http', 'www',)
- ]
- ): # If `photo` is not a url but a local file path
- try:
- with io.BytesIO() as buffered_picture:
- with open(
- os.path.join(self.path, photo_path),
- 'rb' # Read bytes
- ) as photo_file:
- buffered_picture.write(photo_file.read())
- photo = buffered_picture.getvalue()
- except FileNotFoundError:
- photo = None
- else:
- use_stored_file_id = False
- if photo is None:
- logging.error("Photo is None, `send_photo` returning...")
- return
- sent_update = None
- try:
- sent_update = await self.sendPhoto(
- chat_id=chat_id,
- photo=photo,
- caption=caption,
- parse_mode=parse_mode,
- disable_notification=disable_notification,
- reply_to_message_id=reply_to_message_id,
- reply_markup=reply_markup
- )
- if isinstance(sent_update, Exception):
- raise Exception("sendPhoto API call failed!")
- except Exception as e:
- logging.error(f"Error sending photo\n{e}")
- if already_sent:
- with self.db as db:
- db['sent_pictures'].update(
- dict(
- path=photo_path,
- errors=True
- ),
- ['path']
- )
- if (
- type(sent_update) is dict
- and 'photo' in sent_update
- and len(sent_update['photo']) > 0
- and 'file_id' in sent_update['photo'][0]
- and (not already_sent)
- and use_stored_file_id
- ):
- with self.db as db:
- db['sent_pictures'].insert(
- dict(
- path=photo_path,
- file_id=sent_update['photo'][0]['file_id'],
- errors=False
- )
- )
- return sent_update
- async def answer_inline_query(self,
- inline_query_id=None,
- results=[],
- cache_time=None,
- is_personal=None,
- next_offset=None,
- switch_pm_text=None,
- switch_pm_parameter=None,
- update=None):
- """Answer inline queries.
- This method wraps lower-level `answerInlineQuery` method.
- If `results` is a string, cast it to proper type (list of dicts having
- certain keys). See utilities.make_inline_query_answer for details.
- """
- if (
- inline_query_id is None
- and isinstance(update, dict)
- and 'id' in update
- ):
- inline_query_id = update['id']
- results = make_inline_query_answer(results)
- return await self.answerInlineQuery(
- inline_query_id=inline_query_id,
- results=results,
- cache_time=cache_time,
- is_personal=is_personal,
- next_offset=next_offset,
- switch_pm_text=switch_pm_text,
- switch_pm_parameter=switch_pm_parameter,
- )
- @classmethod
- def set_class_maintenance_message(cls, maintenance_message):
- """Set class maintenance message.
- It will be returned if bot is under maintenance, unless and instance
- `_maintenance_message` is set.
- """
- cls._maintenance_message = maintenance_message
- def set_maintenance_message(self, maintenance_message):
- """Set instance maintenance message.
- It will be returned if bot is under maintenance.
- If instance message is None, default class message is used.
- """
- self._maintenance_message = maintenance_message
- def change_maintenance_status(self, maintenance_message=None, status=None):
- """Put the bot under maintenance or end it.
- While in maintenance, bot will reply to users with maintenance_message
- with a few exceptions.
- If status is not set, it is by default the opposite of the current one.
- Optionally, `maintenance_message` may be set.
- """
- if status is None:
- status = not self.under_maintenance
- assert type(status) is bool, "status must be a boolean value!"
- self._under_maintenance = status
- if maintenance_message:
- self.set_maintenance_message(maintenance_message)
- return self._under_maintenance # Return new status
- def is_allowed_during_maintenance(self, update):
- """Return True if update is allowed during maintenance.
- An update is allowed if any of the criteria in
- `self.allowed_during_maintenance` returns True called on it.
- """
- for criterion in self.allowed_during_maintenance:
- if criterion(update):
- return True
- return False
- def allow_during_maintenance(self, criterion):
- """Add a criterion to allow certain updates during maintenance.
- `criterion` must be a function taking a Telegram `update` dictionary
- and returning a boolean.
- ```# Example of criterion
- def allow_text_messages(update):
- if 'message' in update and 'text' in update['message']:
- return True
- return False
- ```
- """
- self._allowed_during_maintenance.append(criterion)
- async def handle_update_during_maintenance(self, update):
- """Handle an update while bot is under maintenance.
- Handle all types of updates.
- """
- if (
- 'message' in update
- and 'chat' in update['message']
- and update['message']['chat']['id'] > 0
- ):
- return await self.send_message(
- text=self.maintenance_message,
- update=update['message'],
- reply_to_update=True
- )
- elif 'callback_query' in update:
- await self.answerCallbackQuery(
- callback_query_id=update['id'],
- text=remove_html_tags(self.maintenance_message[:45])
- )
- elif 'inline_query' in update:
- await self.answer_inline_query(
- update['inline_query']['id'],
- self.maintenance_message,
- cache_time=30,
- is_personal=False,
- )
- return
- @classmethod
- def set_class_authorization_denied_message(csl, message):
- """Set class authorization denied message.
- It will be returned if user is unauthorized to make a request.
- """
- csl._authorization_denied_message = message
- def set_authorization_denied_message(self, message):
- """Set instance authorization denied message.
- If instance message is None, default class message is used.
- """
- self._authorization_denied_message = message
- def set_authorization_function(self, authorization_function):
- """Set a custom authorization_function.
- It should evaluate True if user is authorized to perform a specific
- action and False otherwise.
- It should take update and role and return a Boolean.
- Default authorization_function always evaluates True.
- """
- self.authorization_function = authorization_function
- @classmethod
- def set_class_unknown_command_message(cls, unknown_command_message):
- """Set class unknown command message.
- It will be returned if user sends an unknown command in private chat.
- """
- cls._unknown_command_message = unknown_command_message
- def set_unknown_command_message(self, unknown_command_message):
- """Set instance unknown command message.
- It will be returned if user sends an unknown command in private chat.
- If instance message is None, default class message is used.
- """
- self._unknown_command_message = unknown_command_message
- def command(self, command, aliases=None, show_in_keyboard=False,
- description="", authorization_level='admin'):
- """Associate a bot command with a custom handler function.
- Decorate command handlers like this:
- ```
- @bot.command('/mycommand', ['Button'], True, "My command", 'user')
- async def command_handler(bot, update, user_record):
- return "Result"
- ```
- When a message text starts with `/command[@bot_name]`, or with an
- alias, it gets passed to the decorated function.
- `command` is the command name (with or without /).
- `aliases` is a list of aliases; each will call the command handler
- function; the first alias will appear as button in
- default_keyboard.
- `show_in_keyboard`, if True, makes first alias appear in
- default_keyboard.
- `description` can be used to help users understand what `/command`
- does.
- `authorization_level` is the lowest authorization level needed to run
- the command.
- """
- if not isinstance(command, str):
- raise TypeError(f'Command `{command}` is not a string')
- if aliases:
- if not isinstance(aliases, list):
- raise TypeError(f'Aliases is not a list: `{aliases}`')
- if not all(
- [
- isinstance(alias, str)
- for alias in aliases
- ]
- ):
- raise TypeError(
- f'Aliases {aliases} is not a list of strings string'
- )
- command = command.strip('/ ').lower()
- def command_decorator(command_handler):
- async def decorated_command_handler(bot, update, user_record):
- logging.info(
- f"Command `{command}@{bot.name}` called by "
- "`{from_}`".format(
- from_=(
- update['from']
- if 'from' in update
- else update['chat']
- )
- )
- )
- if bot.authorization_function(
- update=update,
- user_record=user_record,
- authorization_level=authorization_level
- ):
- # Pass supported arguments from locals() to command_handler
- return await command_handler(
- **{
- name: argument
- for name, argument in locals().items()
- if name in inspect.signature(
- command_handler
- ).parameters
- }
- )
- return self.unauthorized_message
- self.commands[command] = dict(
- handler=decorated_command_handler,
- description=description,
- authorization_level=authorization_level
- )
- if aliases:
- for alias in aliases:
- self.command_aliases[alias] = decorated_command_handler
- if show_in_keyboard:
- self.default_reply_keyboard_elements.append(aliases[0])
- return command_decorator
- def parser(self, condition, description='', authorization_level='admin',
- argument='text'):
- """Define a text message parser.
- Decorate command handlers like this:
- ```
- def custom_criteria(update):
- return 'from' in update
- @bot.parser(custom_criteria, authorization_level='user')
- async def text_parser(bot, update, user_record):
- return "Result"
- ```
- If condition evaluates True when run on a message text
- (not starting with '/'), such decorated function gets
- called on update.
- Conditions of parsers are evaluated in order; when one is True,
- others will be skipped.
- `description` provides information about the parser.
- `authorization_level` is the lowest authorization level needed to call
- the parser.
- """
- if not callable(condition):
- raise TypeError(
- f'Condition {condition.__name__} is not a callable'
- )
- def parser_decorator(parser):
- async def decorated_parser(bot, update, user_record):
- logging.info(
- f"Text message update matching condition "
- f"`{condition.__name__}@{bot.name}` from "
- "`{user}`".format(
- user=(
- update['from']
- if 'from' in update
- else update['chat']
- )
- )
- )
- if bot.authorization_function(
- update=update,
- user_record=user_record,
- authorization_level=authorization_level
- ):
- # Pass supported arguments from locals() to parser
- return await parser(
- **{
- name: argument
- for name, argument in locals().items()
- if name in inspect.signature(parser).parameters
- }
- )
- return bot.unauthorized_message
- self.text_message_parsers[condition] = dict(
- handler=decorated_parser,
- description=description,
- authorization_level=authorization_level,
- argument=argument
- )
- return parser_decorator
- def set_command(self, command, handler, aliases=None,
- show_in_keyboard=False, description="",
- authorization_level='admin'):
- """Associate a `command` with a `handler`.
- When a message text starts with `/command[@bot_name]`, or with an
- alias, it gets passed to the decorated function.
- `command` is the command name (with or without /)
- `handler` is the function to be called on update objects.
- `aliases` is a list of aliases; each will call the command handler
- function; the first alias will appear as button in
- default_keyboard.
- `show_in_keyboard`, if True, makes first alias appear in
- default_keyboard.
- `description` is a description and can be used to help users understand
- what `/command` does.
- `authorization_level` is the lowest authorization level needed to run
- the command.
- """
- if not callable(handler):
- raise TypeError(f'Handler `{handler}` is not callable.')
- return self.command(
- command=command, aliases=aliases,
- show_in_keyboard=show_in_keyboard, description=description,
- authorization_level=authorization_level
- )(handler)
- def button(self, prefix, separator=None, description='',
- authorization_level='admin'):
- """Associate a bot button `prefix` with a handler.
- When a callback data text starts with `prefix`, the associated handler
- is called upon the update.
- Decorate button handlers like this:
- ```
- @bot.button('a_prefix:///', description="A button",
- authorization_level='user')
- async def button_handler(bot, update, user_record, data):
- return "Result"
- ```
- `separator` will be used to parse callback data received when a button
- starting with `prefix` will be pressed.
- `description` contains information about the button.
- `authorization_level` is the lowest authorization level needed to
- be allowed to push the button.
- """
- if not isinstance(prefix, str):
- raise TypeError(
- f'Inline button callback_data {prefix} is not a string'
- )
- def button_decorator(handler):
- async def decorated_button_handler(bot, update, user_record):
- logging.info(
- f"Button `{update['data']}`@{bot.name} pressed by "
- f"`{update['from']}`"
- )
- if bot.authorization_function(
- update=update,
- user_record=user_record,
- authorization_level=authorization_level
- ):
- # Remove `prefix` from `data`
- data = extract(update['data'], prefix)
- # If a specific separator or default separator is set,
- # use it to split `data` string in a list.
- # Cast numeric `data` elements to `int`.
- _separator = separator or self.callback_data_separator
- if _separator:
- data = [
- int(element) if element.isnumeric()
- else element
- for element in data.split(_separator)
- ]
- # Pass supported arguments from locals() to handler
- return await handler(
- **{
- name: argument
- for name, argument in locals().items()
- if name in inspect.signature(handler).parameters
- }
- )
- return bot.unauthorized_message
- self.callback_handlers[prefix] = dict(
- handler=decorated_button_handler,
- description=description,
- authorization_level=authorization_level
- )
- return button_decorator
- def query(self, condition, description='', authorization_level='admin'):
- """Define an inline query.
- Decorator: `@bot.query(example)`
- When an inline query matches the `condition` function,
- decorated function is called and passed the query update object
- as argument.
- `description` is a description
- `authorization_level` is the lowest authorization level needed to run
- the command
- """
- if not callable(condition):
- raise TypeError(
- 'Condition {c} is not a callable'.format(
- c=condition.__name__
- )
- )
- def query_decorator(handler):
- async def decorated_query_handler(bot, update, user_record):
- logging.info(
- f"Inline query matching condition "
- f"`{condition.__name__}@{bot.name}` from "
- f"`{update['from']}`"
- )
- if self.authorization_function(
- update=update,
- user_record=user_record,
- authorization_level=authorization_level
- ):
- # Pass supported arguments from locals() to handler
- return await handler(
- **{
- name: argument
- for name, argument in locals().items()
- if name in inspect.signature(handler).parameters
- }
- )
- return self.unauthorized_message
- self.inline_query_handlers[condition] = dict(
- handler=decorated_query_handler,
- description=description,
- authorization_level=authorization_level
- )
- return query_decorator
- def set_chat_id_getter(self, getter):
- """Set chat_id getter.
- It must be a function that takes an update and returns the proper
- chat_id.
- """
- assert callable(getter), "Chat id getter must be a function!"
- self.get_chat_id = getter
- @staticmethod
- def get_user_identifier(user_id=None, update=None):
- """Get telegram id of user given an update.
- Result itself may be passed as either parameter (for backward
- compatibility).
- """
- identifier = user_id or update
- assert identifier is not None, (
- "Provide a user_id or update object to get a user identifier."
- )
- if (
- isinstance(identifier, dict)
- and 'message' in identifier
- and 'from' not in identifier
- ):
- identifier = identifier['message']
- if isinstance(identifier, dict) and 'from' in identifier:
- identifier = identifier['from']['id']
- assert type(identifier) is int, (
- "Unable to find a user identifier."
- )
- return identifier
- @staticmethod
- def get_message_identifier(update=dict()):
- """Get a message identifier dictionary to edit `update`.
- Pass the result as keyword arguments to `edit...` API methods.
- """
- if 'message' in update:
- update = update['message']
- if 'chat' in update and 'message_id' in update:
- return dict(
- chat_id=update['chat']['id'],
- message_id=update['message_id']
- )
- elif 'inline_message_id' in update:
- return dict(
- inline_message_id=update['inline_message_id']
- )
- def set_individual_text_message_handler(self, handler,
- update=None, user_id=None):
- """Set a custom text message handler for the user.
- Any text message update from the user will be handled by this custom
- handler instead of default handlers for commands, aliases and text.
- Custom handlers last one single use, but they can call this method and
- set themselves as next custom text message handler.
- """
- identifier = self.get_user_identifier(
- user_id=user_id,
- update=update
- )
- assert callable(handler), (f"Handler `{handler.name}` is not "
- "callable. Custom text message handler "
- "could not be set.")
- self.individual_text_message_handlers[identifier] = handler
- return
- def remove_individual_text_message_handler(self,
- update=None, user_id=None):
- """Remove a custom text message handler for the user.
- Any text message update from the user will be handled by default
- handlers for commands, aliases and text.
- """
- identifier = self.get_user_identifier(
- user_id=user_id,
- update=update
- )
- if identifier in self.individual_text_message_handlers:
- del self.individual_text_message_handlers[identifier]
- return
- def set_default_keyboard(self, keyboard='set_default'):
- """Set a default keyboard for the bot.
- If a keyboard is not passed as argument, a default one is generated,
- based on aliases of commands.
- """
- if keyboard == 'set_default':
- buttons = [
- dict(
- text=x
- )
- for x in self.default_reply_keyboard_elements
- ]
- if len(buttons) == 0:
- self._default_keyboard = None
- else:
- self._default_keyboard = dict(
- keyboard=make_lines_of_buttons(
- buttons,
- (2 if len(buttons) < 4 else 3) # Row length
- ),
- resize_keyboard=True
- )
- else:
- self._default_keyboard = keyboard
- return
- async def webhook_feeder(self, request):
- """Handle incoming HTTP `request`s.
- Get data, feed webhook and return and OK message.
- """
- update = await request.json()
- asyncio.ensure_future(
- self.route_update(update)
- )
- return web.Response(
- body='OK'.encode('utf-8')
- )
- async def get_me(self):
- """Get bot information.
- Restart bots if bot can't be got.
- """
- try:
- me = await self.getMe()
- if isinstance(me, Exception):
- raise me
- elif me is None:
- raise Exception('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}"
- )
- await asyncio.sleep(5*60)
- self.__class__.stop(
- 65,
- f"Information aformation about this bot could "
- f"not be retrieved. Restarting..."
- )
- def setup(self):
- """Make bot ask for updates and handle responses."""
- self.set_default_keyboard()
- if not self.webhook_url:
- asyncio.ensure_future(self.get_updates())
- else:
- asyncio.ensure_future(self.set_webhook())
- self.__class__.app.router.add_route(
- 'POST', self.webhook_local_address, self.webhook_feeder
- )
- async def close_sessions(self):
- """Close open sessions."""
- for session_name, session in self.sessions.items():
- if not session.closed:
- await session.close()
- async def set_webhook(self, url=None, certificate=None,
- max_connections=None, allowed_updates=None):
- """Set a webhook if token is valid."""
- # Return if token is invalid
- await self.get_me()
- if self.name is None:
- return
- webhook_was_set = await self.setWebhook(
- url=url, certificate=certificate, max_connections=max_connections,
- allowed_updates=allowed_updates
- ) # `setWebhook` API method returns `True` on success
- webhook_information = await self.getWebhookInfo()
- webhook_information['url'] = webhook_information['url'].replace(
- self.token, "<BOT_TOKEN>"
- ).replace(
- self.session_token, "<SESSION_TOKEN>"
- )
- if webhook_was_set:
- logging.info(
- f"Webhook was set correctly.\n"
- f"Webhook information: {webhook_information}"
- )
- else:
- logging.error(
- f"Failed to set webhook!\n"
- f"Webhook information: {webhook_information}"
- )
- async def get_updates(self, timeout=30, limit=100, allowed_updates=None,
- error_cooldown=10):
- """Get updates using long polling.
- timeout : int
- Timeout set for Telegram servers. Make sure that connection timeout
- is greater than `timeout`.
- limit : int (1 - 100)
- Max number of updates to be retrieved.
- allowed_updates : List(str)
- List of update types to be retrieved.
- Empty list to allow all updates.
- None to fallback to class default.
- """
- # Return if token is invalid
- await self.get_me()
- if self.name is None:
- return
- # Set custom list of allowed updates or fallback to class default list
- if allowed_updates is None:
- allowed_updates = self.allowed_updates
- await self.deleteWebhook() # Remove eventually active webhook
- update = None # Do not update offset if no update is received
- while True:
- updates = await self.getUpdates(
- offset=self._offset,
- timeout=timeout,
- limit=limit,
- allowed_updates=allowed_updates
- )
- if updates is None:
- continue
- elif isinstance(updates, TelegramError):
- logging.error(
- f"Waiting {error_cooldown} seconds before trying again..."
- )
- await asyncio.sleep(error_cooldown)
- continue
- for update in updates:
- asyncio.ensure_future(self.route_update(update))
- if update is not None:
- self._offset = update['update_id'] + 1
- def set_router(self, event, handler):
- """Set `handler` as router for `event`."""
- self.routing_table[event] = handler
- async def route_update(self, update):
- """Pass `update` to proper method.
- Update objects have two keys:
- - `update_id` (which is used as offset while retrieving new updates)
- - One and only one of the following
- `message`
- `edited_message`
- `channel_post`
- `edited_channel_post`
- `inline_query`
- `chosen_inline_result`
- `callback_query`
- `shipping_query`
- `pre_checkout_query`
- `poll`
- """
- if (
- self.under_maintenance
- and not self.is_allowed_during_maintenance(update)
- ):
- return await self.handle_update_during_maintenance(update)
- for key, value in update.items():
- if key in self.routing_table:
- with self.db as db:
- user_record = db['users'].find_one(
- telegram_id=self.get_user_identifier(
- update=value
- )
- )
- return await self.routing_table[key](value, user_record)
- logging.error(f"Unknown type of update.\n{update}")
- def additional_task(self, when='BEFORE', *args, **kwargs):
- """Add a task before at app start or cleanup.
- Decorate an async function to have it awaited `BEFORE` or `AFTER` main
- loop.
- """
- when = when[0].lower()
- def additional_task_decorator(task):
- if when == 'b':
- self.preliminary_tasks.append(task(*args, **kwargs))
- elif when == 'a':
- self.final_tasks.append(task(*args, **kwargs))
- return additional_task_decorator
- @classmethod
- async def start_app(cls):
- """Start running `aiohttp.web.Application`.
- It will route webhook-received updates and other custom paths.
- """
- assert cls.local_host is not None, "Invalid local host"
- assert cls.port is not None, "Invalid port"
- cls.runner = web.AppRunner(cls.app)
- await cls.runner.setup()
- cls.server = web.TCPSite(cls.runner, cls.local_host, cls.port)
- await cls.server.start()
- logging.info(f"App running at http://{cls.local_host}:{cls.port}")
- @classmethod
- async def stop_app(cls):
- """Close bot sessions and cleanup."""
- for bot in cls.bots:
- await asyncio.gather(
- *bot.final_tasks
- )
- await bot.close_sessions()
- await cls.runner.cleanup()
- @classmethod
- def stop(cls, message, final_state=0):
- """Log a final `message`, stop loop and set exiting `code`.
- All bots and the web app will be terminated gracefully.
- The final state may be retrieved to get information about what stopped
- the bots.
- """
- logging.info(message)
- cls.final_state = final_state
- cls.loop.stop()
- return
- @classmethod
- def run(cls, local_host=None, port=None):
- """Run aiohttp web app and all Bot instances.
- 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.
- """
- if local_host is not None:
- cls.local_host = local_host
- if port is not None:
- cls.port = port
- try:
- cls.loop.run_until_complete(
- asyncio.gather(
- *[
- preliminary_task
- for bot in cls.bots
- for preliminary_task in bot.preliminary_tasks
- ]
- )
- )
- except Exception as e:
- logging.error(f"{e}", exc_info=True)
- for bot in cls.bots:
- bot.setup()
- asyncio.ensure_future(cls.start_app())
- try:
- cls.loop.run_forever()
- except KeyboardInterrupt:
- logging.info("Stopped by KeyboardInterrupt")
- except Exception as e:
- logging.error(f"{e}", exc_info=True)
- finally:
- cls.loop.run_until_complete(cls.stop_app())
- return cls.final_state
|