՟fHdZddlZddlmZddlmZmZmZmZmZm Z m Z m Z ddl m Z  ddlmZdZddlZdd lmZmZmZmZmZdd lmZdd lmZdd lmZerdd lm Z GddeZ!GddZ"GddZ#y#e$rdZYUwxYw)z1This module contains the CallbackDataCache class.N)datetime) TYPE_CHECKINGAnyDictMutableMappingOptionalTupleUnioncast)uuid4)LRUCacheTF) CallbackQueryInlineKeyboardButtonInlineKeyboardMarkupMessageUser)to_float_timestamp) TelegramError)CDCData)ExtBotcZeZdZdZdZddeeddffd Zdee eeeffdZ xZ S) InvalidCallbackDataa2 Raised when the received callback data has been tampered with or deleted from cache. Examples: :any:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Arbitrary callback_data ` .. versionadded:: 13.6 Args: callback_data (:obj:`int`, optional): The button data of which the callback data could not be found. Attributes: callback_data (:obj:`int`): Optional. The button data of which the callback data could not be found.  callback_dataNrreturnc2t|d||_y)Nz\The object belonging to this callback_data was deleted or the callback_data was manipulated.)super__init__r)selfr __class__s Z/var/www/cvtools/html/venv/lib/python3.12/site-packages/telegram/ext/_callbackdatacache.pyrzInvalidCallbackData.__init__Bs   -:c4|j|jffS)zDefines how to serialize the exception for pickle. See :py:meth:`object.__reduce__` for more info. Returns: :obj:`tuple` )r rrs r! __reduce__zInvalidCallbackData.__reduce__Is~~ 2 2444r"N) __name__ __module__ __qualname____doc__ __slots__rstrrr typer% __classcell__)r s@r!rr,sE&#I:hsm:t:5E$hsm(<"<=5r"rc jeZdZdZ d dedeedeeeeffdZ d dZ de eeeeefffd Z y) _KeyboardData) access_time button_data keyboard_uuidNr3r1r2cb||_|xsi|_|xstj|_yr&)r3r2timer1)rr3r1r2s r!rz_KeyboardData.__init__Vs, +&,"&5$))+r"rc6tj|_y)z.Updates the access time with the current time.N)r5r1r$s r!update_access_timez _KeyboardData.update_access_time`s99;r"cH|j|j|jfS)zsGives a tuple representation consisting of the keyboard uuid, the access time and the button data. r3r1r2r$s r!to_tuplez_KeyboardData.to_tupleds#!!4#3#3T5E5EEEr")NNrN) r'r(r)r+r,rfloatrobjectrr7r r:r"r!r0r0Ssj?I (,37 66e_6d3;/0 6'F%UDf,= =>Fr"r0ceZdZdZdZ d!dddedeefdZded dfd Z e d efd Z e d efd Z d e d e fdZededed efdZded eeeefedefffdZeded eeeffdZded dfdZded eefdZded dfdZded dfdZded dfdZd"deee e!fd dfdZ"d#dZ# d"de$deee e!fd dfd Z%y)$CallbackDataCacheaA custom cache for storing the callback data of a :class:`telegram.ext.ExtBot`. Internally, it keeps two mappings with fixed maximum size: * One for mapping the data received in callback queries to the cached objects * One for mapping the IDs of received callback queries to the cached objects The second mapping allows to manually drop data that has been cached for keyboards of messages sent via inline mode. If necessary, will drop the least recently used items. Important: If you want to use this class, you must install PTB with the optional requirement ``callback-data``, i.e. .. code-block:: bash pip install "python-telegram-bot[callback-data]" Examples: :any:`Arbitrary Callback Data Bot ` .. seealso:: :wiki:`Architecture Overview `, :wiki:`Arbitrary callback_data ` .. versionadded:: 13.6 .. versionchanged:: 20.0 To use this class, PTB must be installed via ``pip install "python-telegram-bot[callback-data]"``. Args: bot (:class:`telegram.ext.ExtBot`): The bot this cache is for. maxsize (:obj:`int`, optional): Maximum number of items in each of the internal mappings. Defaults to ``1024``. persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): Data to initialize the cache with, as returned by :meth:`telegram.ext.BasePersistence.get_callback_data`. Attributes: bot (:class:`telegram.ext.ExtBot`): The bot this cache is for. )_callback_queries_keyboard_data_maxsizebotNrDz ExtBot[Any]maxsizepersistent_datacts td||_||_t ||_t ||_|r|j|yy)NziTo use `CallbackDataCache`, PTB must be installed via `pip install "python-telegram-bot[callback-data]"`.)rE)CACHE_TOOLS_AVAILABLE RuntimeErrorrDrCr rBrAload_persistence_data)rrDrErFs r!rzCallbackDataCache.__init__sZ %9  !$$ BJSZB[;CG;T   & & 7 r"rc|\}}|jD]\}}||j|<|D]!\}}}t||||j|<#y)aLoads data into the cache. Warning: This method is not intended to be called by users directly. .. versionadded:: 20.0 Args: persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): Data to load, as returned by :meth:`telegram.ext.BasePersistence.get_callback_data`. r9N)itemsrAr0rB) rrF keyboard_datacallback_querieskeyvalueuuidr1datas r!rJz'CallbackDataCache.load_persistence_datasm+:' '*002 0JC*/D " "3 ' 0'4  #D+t(5" )D   % r"c|jS)z:obj:`int`: The maximum size of the cache. .. versionchanged:: 20.0 This property is now read-only. )rCr$s r!rEzCallbackDataCache.maxsizes}}r"c|jjDcgc]}|jc}t|jj fScc}w)zTuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]]: The data that needs to be persisted to allow caching callback data across bot reboots. )rBvaluesr:dictrArL)rrRs r!persistence_dataz"CallbackDataCache.persistence_datasN-1,?,?,F,F,HID I4  " " ( ( *L   IsA reply_markupcrtj}t|}|jDcgc]O}|Dcgc]A}|jr1t |j |j|j|n|Cc}Q}}}|js|S||j|<t|Scc}wcc}}w)aRegisters the reply markup to the cache. If any of the buttons have :attr:`~telegram.InlineKeyboardButton.callback_data`, stores that data and builds a new keyboard with the correspondingly replaced buttons. Otherwise, does nothing and returns the original reply markup. Args: reply_markup (:class:`telegram.InlineKeyboardMarkup`): The keyboard. Returns: :class:`telegram.InlineKeyboardMarkup`: The keyboard to be passed to Telegram. r) r hexr0inline_keyboardrrtext_CallbackDataCache__put_buttonr2rBr)rrXr3rMcolumnbtnbuttonss r!process_keyboardz"CallbackDataCache.process_keyboards %m4 "'66 " (( )&*&7&78I8I=&Y     "(( -:M*#G,,+  s B3AB. >B3.B3rrMchtj}||j|<|j|S)zStores the data for a single button in :attr:`keyboard_data`. Returns the string that should be passed instead of the callback_data, which is ``keyboard_uuid + button_uuids``. )r rZr2r3)rrMrQs r! __put_buttonzCallbackDataCache.__put_buttons5 w{{*7 !!$'--.tf55r"c|j|\}} |j|}|j|}|j||fS#t$rdt |fcYSwxYwr&) extract_uuidsrBr2r7KeyErrorr)rrkeyboardbuttonrMr2s r!#__get_keyboard_uuid_and_button_dataz5CallbackDataCache.__get_keyboard_uuid_and_button_datas{ --m<& <!//9M'33F;K  , , .$$ <,];; ; rs r!rezCallbackDataCache.extract_uuidssSb!=#555r"messagec&|j|y)aHReplaces the data in the inline keyboard attached to the message with the cached objects, if necessary. If the data could not be found, :class:`telegram.ext.InvalidCallbackData` will be inserted. Note: Checks :attr:`telegram.Message.via_bot` and :attr:`telegram.Message.from_user` to check if the reply markup (if any) was actually sent by this cache's bot. If it was not, the message will be returned unchanged. Note that this will fail for channel posts, as :attr:`telegram.Message.from_user` is :obj:`None` for those! In the corresponding reply markups the callback data will be replaced by :class:`telegram.ext.InvalidCallbackData`. Warning: * Does *not* consider :attr:`telegram.Message.reply_to_message` and :attr:`telegram.Message.pinned_message`. Pass them to this method separately. * *In place*, i.e. the passed :class:`telegram.Message` will be changed! Args: message (:class:`telegram.Message`): The message. N)#_CallbackDataCache__process_message)rrls r!process_messagez!CallbackDataCache.process_message,s. w'r"c|jsy|jr |j}n|jr |j}nd}|||jjk7ryd}|jjD]k}|D]d}|j st t|j }|j|\}}|j||rRt|trc|}fm|S)zAs documented in process_message, but returns the uuid of the attached keyboard, if any, which is relevant for process_callback_query. **IN PLACE** N) rXvia_bot from_userrDr[rr r,5_CallbackDataCache__get_keyboard_uuid_and_button_dataupdate_callback_data isinstancer) rrlsenderr3rowrhr2 keyboard_idrs r!__process_messagez#CallbackDataCache.__process_messageEs ## ??%,__F   &&FF  &DHHLL"8 ''77 4C 4''"&sF,@,@"AK151Y1Y#2.K// >)MK^1_(3  4 4r"callback_queryc$d}|jrm|j}|j|\}}|j5||_ddd|s+t|ts||j |j <d}t|jtro|j|j|jj|jjfD]$}t|ts|j|&yy#1swYxYw)aMReplaces the data in the callback query and the attached messages keyboard with the cached objects, if necessary. If the data could not be found, :class:`telegram.ext.InvalidCallbackData` will be inserted. If :attr:`telegram.CallbackQuery.data` or :attr:`telegram.CallbackQuery.message` is present, this also saves the callback queries ID in order to be able to resolve it to the stored data. Note: Also considers inserts data into the buttons of :attr:`telegram.Message.reply_to_message` and :attr:`telegram.Message.pinned_message` if necessary. Warning: *In place*, i.e. the passed :class:`telegram.CallbackQuery` will be changed! Args: callback_query (:class:`telegram.CallbackQuery`): The callback query. FNT) rRrs _unfrozenrurrAidrlrrnpinned_messagereply_to_message)rrzmappedrRr3r2 maybe_messages r!process_callback_queryz(CallbackDataCache.process_callback_queryks(   !&&D*.)Q)QRV)W &M;))+ 2&1# 2*[:M"N#9#9 :&&55&&77" : mW5**=9  : 7 2 2s DDc |jj|j}|j|y#t$r}t d|d}~wwxYw)aDeletes the data for the specified callback query. Note: Will *not* raise exceptions in case the callback data is not found in the cache. *Will* raise :exc:`KeyError` in case the callback query can not be found in the cache. Args: callback_query (:class:`telegram.CallbackQuery`): The callback query. Raises: KeyError: If the callback query can not be found in the cache z%CallbackQuery was not found in cache.N)rApopr}!_CallbackDataCache__drop_keyboardrf)rrzr3excs r! drop_datazCallbackDataCache.drop_datasR M 2266~7H7HIM   / MBC L Ms69 A AAr3ctjt5|jj |dddy#1swYyxYwr&) contextlibsuppressrfrBr)rr3s r!__drop_keyboardz!CallbackDataCache.__drop_keyboards9   * 3    # #M 2 3 3 3s ?A time_cutoffc>|j|j|y)aClears the stored callback data. Args: time_cutoff (:obj:`float` | :obj:`datetime.datetime`, optional): Pass a UNIX timestamp or a :obj:`datetime.datetime` to clear only entries which are older. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. )rN)_CallbackDataCache__clearrB)rrs r!clear_callback_dataz%CallbackDataCache.clear_callback_datas T((k Br"c:|j|jy)z%Clears the stored callback query IDs.N)rrAr$s r!clear_callback_queriesz(CallbackDataCache.clear_callback_queriess T++,r"mappingcv|s|jyt|trDt||jj r |jj j nd}n|}|jDcgc]\}}|j|ks|}}}|D]}|j|ycc}}w)N)tzinfo) clearrurrrDdefaultsrrLr1r)rrreffective_cutoffrOrRto_drops r!__clearzCallbackDataCache.__clears MMO  k8 ,1@Q@QDHH$5$5$<$r"r!r@r@ks+ZKI -1 8 88"'* 8(W,  '    '--A'-FZ'-R6F6=6S66 %  % uS&[!5/B)B#CC D % 6S 6U38_ 6 6(w(4(2$$Xc]$L,:],:t,:\M M$M(3S3T3 CxeXo8N/O C[_ C- X\%4r"r!rs&8 YYY"#  ]]7(-#$5-$5NFF0ii]"!"sA<<BB