o aqe\@sdZddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z ddlmZddlmZmZmZddlZddlmZddlmZGd d d ZdS) z5A Python module for interacting with Slack's RTM API.N)Future) SSLContext)current_thread main_thread)List)OptionalCallable DefaultDict) WebClientc@sdeZdZUdZeeZee d<ddddde j dddid de d e ed e ed e ed e e d e ede e de e de ede ejde efddZede fddZede defddZdejfddZddZd d!Zd"efd#d$Zd%d&Zd'd(Z d)e fd*d+Z!ed,d-Z"d.d/Z#d0d1Z$d2d3Z%d=d4d5Z&d6d7Z'd>d9d:Z(de)efd;d<Z*dS)? RTMClienta An RTMClient allows apps to communicate with the Slack Platform's RTM API. The event-driven architecture of this client allows you to simply link callbacks to their corresponding events. When an event occurs this client executes your callback while passing along any information it receives. Attributes: token (str): A string specifying an xoxp or xoxb token. run_async (bool): A boolean specifying if the client should be run in async mode. Default is False. auto_reconnect (bool): When true the client will automatically reconnect when (not manually) disconnected. Default is True. ssl (SSLContext): To use SSL support, pass an SSLContext object here. Default is None. proxy (str): To use proxy support, pass the string of the proxy server. e.g. "http://proxy.com" Authentication credentials can be passed in proxy URL. e.g. "http://user:pass@some.proxy.com" Default is None. timeout (int): The amount of seconds the session should wait before timing out. Default is 30. base_url (str): The base url for all HTTP requests. Note: This is only used in the WebClient. Default is "https://www.slack.com/api/". connect_method (str): An string specifying if the client will connect with `rtm.connect` or `rtm.start`. Default is `rtm.connect`. ping_interval (int): automatically send "ping" command every specified period of seconds. If set to 0, do not send automatically. Default is 30. loop (AbstractEventLoop): An event loop provided by asyncio. If None is specified we attempt to use the current loop with `get_event_loop`. Default is None. Methods: ping: Sends a ping message over the websocket to Slack. typing: Sends a typing indicator to the specified channel. on: Stores and links callbacks to websocket and Slack events. run_on: Decorator that stores and links callbacks to websocket and Slack events. start: Starts an RTM Session with Slack. stop: Closes the websocket connection and ensures it won't reconnect. Example: ```python import os from slack import RTMClient @RTMClient.run_on(event="message") def say_hello(**payload): data = payload['data'] web_client = payload['web_client'] if 'Hello' in data['text']: channel_id = data['channel'] thread_ts = data['ts'] user = data['user'] web_client.chat_postMessage( channel=channel_id, text=f"Hi <@{user}>!", thread_ts=thread_ts ) slack_token = os.environ["SLACK_API_TOKEN"] rtm_client = RTMClient(token=slack_token) rtm_client.start() ``` Note: The initial state returned when establishing an RTM connection will be available as the data in payload for the 'open' event. This data is not and will not be stored on the RTM Client. Any attributes or methods prefixed with _underscores are intended to be "private" internal use only. They may be changed or removed at anytime. _callbacksFTN) run_asyncauto_reconnectsslproxytimeoutbase_urlconnect_method ping_intervalloopheaderstokenrrrrrrrrrrc Cs||_||_||_||_||_||_||_||_| |_ | |_ | p%t |_ d|_d|_d|_tt|_d|_d|_d|_t|j|j|j|j|j|j|j |j|j d |_dS)NrF rrrrrrrsessionr)striprrrrrrrrrrasyncioget_event_loop _event_loop _web_client _websocket_sessionlogging getLogger__name___logger_last_message_id_connection_attempts_stoppedr ) selfrrrrrrrrrrrr*Q/var/www/html/humari/django-venv/lib/python3.10/site-packages/slack/rtm/client.py__init__gs:   zRTMClient.__init__eventcsfdd}|S)z5A decorator to store and link a callback to an event.cstj|d|S)N)r-callback)r on)r.r-r*r+ decoratorsz#RTMClient.run_on..decoratorr*)r-r1r*r0r+run_ons zRTMClient.run_onr.cCs`t|tr!|D]}||q|j|}tt|||j|<dS|||j||dS)aPStores and links the callback(s) to the event. Args: event (str): A string that specifies a Slack or websocket event. e.g. 'channel_joined' or 'open' callback (Callable): Any object or a list of objects that can be called. e.g. or [,] Raises: SlackClientError: The specified callback is not callable. SlackClientError: The callback must accept keyword arguments (**kwargs). N) isinstancelist_validate_callbackr setappend)clsr-r.cbprevious_callbacksr*r*r+r/s    z RTMClient.onreturncCsjtjdkr ttkr tjtjtjf}|D] }|j ||j qt j | |jd}|jr/|S|j|S)aStarts an RTM Session with Slack. Makes an authenticated call to Slack's RTM API to retrieve a websocket URL and then connects to the message server. As events stream-in we run any associated callbacks stored on the client. If 'auto_reconnect' is specified we retrieve a new url and reconnect any time the connection is lost unintentionally or an exception is thrown. Raises: SlackApiError: Unable to retrieve RTM URL from Slack. ntr)osnamerrsignalSIGHUPSIGTERMSIGINTradd_signal_handlerstopr ensure_future_connect_and_readrrun_until_complete)r)signalssfuturer*r*r+starts zRTMClient.startcCs|jdd|_|dS)alCloses the websocket connection and ensures it won't reconnect. If your application outputs the following errors, call #async_stop() instead and await for the completion on your application side. asyncio/base_events.py:641: RuntimeWarning: coroutine 'ClientWebSocketResponse.close' was never awaited self._ready.clear() %The Slack RTMClient is shutting down.TN)r%debugr(_close_websocketr)r*r*r+rEs  zRTMClient.stopcs4|jd|}|D]}|IdHq d|_dS)z?Closes the websocket connection and ensures it won't reconnect.rMNT)r%rNrOr()r)remaining_futuresrKr*r*r+ async_stops    zRTMClient.async_stoppayloadcCstj|||jdS)a0Sends a message to Slack over the WebSocket connection. Note: The RTM API only supports posting simple messages formatted using our default message formatting mode. It does not support attachments or other message formatting modes. For this reason we recommend users send messages via the Web API methods. e.g. web_client.chat_postMessage() If the message "id" is not specified in the payload, it'll be added. Args: payload (dict): The message to send over the wesocket. e.g. { "id": 1, "type": "typing", "channel": "C024BE91L" } Raises: SlackClientNotConnectedError: Websocket connection is closed. r=)rrF _send_jsonrr)rSr*r*r+send_over_websocketszRTMClient.send_over_websocketcsF|jdus |jdurtdd|vr||d<|j|IdHS)NzWebsocket connection is closed.id)r r client_errSlackClientNotConnectedError _next_msg_id send_jsonrUr*r*r+rTs zRTMClient._send_jsoncs&|dd}|j|dIdHdS)aSends a ping message over the websocket to Slack. Not all web browsers support the WebSocket ping spec, so the RTM protocol also supports ping/pong messages. Raises: SlackClientNotConnectedError: Websocket connection is closed. ping)rWtyperSNrZrTrUr*r*r+r\ s zRTMClient.pingchannelcs(|d|d}|j|dIdHdS)aDSends a typing indicator to the specified channel. This indicates that this app is currently writing a message to send to a channel. Args: channel (str): The channel id. e.g. 'C024BE91L' Raises: SlackClientNotConnectedError: Websocket connection is closed. typing)rWr]r`r^Nr_)r)r`rSr*r*r+ras zRTMClient.typingcCsjt|dr|jn|}t|sd|}t|t|j }t dd|Ds3d|}t|dS)aChecks if the specified callback is callable and accepts a kwargs param. Args: callback (obj): Any object or a list of objects that can be called. e.g. Raises: SlackClientError: The specified callback is not callable. SlackClientError: The callback must accept keyword arguments (**kwargs). r$z,The specified callback '{}' is not callable.css |] }|j|jkr|VqdSN)kind VAR_KEYWORD).0paramr*r*r+ 7sz/RTMClient._validate_callback..z;The callback '{}' must accept keyword arguments (**kwargs).N) hasattrr$callableformatrXSlackClientErrorinspect signature parametersvaluesany)r.cb_namemsgcallback_paramsr*r*r+r5%s    zRTMClient._validate_callbackcCs|jd7_|jS)zRetrieves the next message id. When sending messages to Slack every event should have a unique (for that connection) positive integer ID. Returns: An integer representing the message id. e.g. 98 )r&rPr*r*r+rZ?s zRTMClient._next_msg_idc s|jsz|jd7_tjtj|jdd4IdHy}||_|IdH\}}|j||j |j |j d4IdHG}|j d||_|jd|dIdH|IdH|jsu|jsu|j d  WdIdHWdIdHWdSWdIdHn 1IdHswYWdIdHn 1IdHswYWnKtjtjfy}z;|jd |dIdHt|d r|jd dnd}|jr|js|d kr||IdHWYd}~q|j d |d}~ww|jrdSdS)a;Retrieves the WS url and connects to Slack's RTM API. Makes an authenticated call to Slack's Web API to retrieve a websocket URL. Then connects to the message server and reads event messages as they come in. If 'auto_reconnect' is specified we retrieve a new url and reconnect any time the connection is lost unintentionally or an exception is thrown. Raises: SlackApiError: Unable to retrieve RTM URL from Slack. websockets.exceptions: Errors thrown by the 'websockets' library. rt)totalrN) heartbeatrrz)The Websocket connection has been opened.openr-dataz>Not reconnecting the Websocket because auto_reconnect is Falseerrorresponse invalid_authz=The Websocket encountered an error. Closing the connection...)r(r'aiohttp ClientSession ClientTimeoutrr!_retrieve_websocket_info ws_connectrrrr%rNr _dispatch_event_read_messagesrwarningrXrY SlackApiErrorrhr|get_wait_exponentially exceptionrO)r)rurlrz websocketr error_coder*r*r+rGKsp   *(  zRTMClient._connect_and_readc s|js|jdurz |jjddIdH}Wn;tjyP|jdur%YdS|jjs+Yq|jd|jj|j d|j dIdHd|_|j ddIdHYdSw|j t j jkrz|}|d d }|j ||d IdHWngty}z|r{|jn|}|jd |d |dWYd}~qd}~ww|j t j jkr|jd||j d|dIdHn(|j t j jt j jt j jfvr|jdd|_|j ddIdHn|jd||js|jdus dSdSdSdS)z6Process messages received on the WebSocket connection.NrtrvzWebsocket was closed (%s).r{rycloser0r]Unknown)rzzCaught a raised exception (z$) while dispatching a TEXT message ()z&Received an error on the websocket: %rzWebsocket was closed.z#Received unhandled message type: %r)r(r receiver TimeoutErrorclosedr%r close_coderrr]r~ WSMsgTypeTEXTjsonpop ExceptionrzinfoERRORr{CLOSECLOSINGCLOSEDrN)r)messagerSr-errrzr*r*r+rsZ        zRTMClient._read_messagesc s |jjtjkr|jd|||j|D]n}|jdt|j||z;|jr0|dvr0WdSt |rA|||j |dIdHn|j durPt d|jd||j |d}|d i|Wqty}z|j}|j}d |d |d |}|j|d}~wwdS) a/Dispatches the event and executes any associated callbacks. Note: To prevent the app from crashing due to callback errors. We catch all exceptions and send all data to the logger. Args: event (str): The type of event. e.g. 'bot_added' data (dict): The data Slack sent. e.g. { "type": "bot_added", "bot": { "id": "B024BE7LH", "app_id": "A4H1JB4AZ", "name": "hugbot" } } zReceived an event: '%s' - %sz$Running %s callbacks for event: '%s')rr{) rtm_client web_clientrzNTzThe callback "z" is NOT a coroutine. Running such with run_async=True is unsupported. Consider adding async/await to the method or going with run_async=False if your app is not really non-blocking.zWhen calling '#z ()' in the 'z)' module the following error was raised: r*)r%levelr"DEBUGrNr lenr(rliscoroutinefunctionrrrXSlackRequestErrorr$r __module__r{) r)r-rzr.rSrr?modulerrr*r*r+rsF     zRTMClient._dispatch_eventc s|jdurt|j|j|j|j|jd|j|j|j d |_|j d|j dv}|j r>|r5|jIdH}n|jIdH}n |rF|j}n|j}|d}|dur]d}tj||d||jfS) a;Retrieves the WebSocket info from Slack. Returns: A tuple of websocket information. e.g. ( "wss://...", { "self": {"id": "U01234ABC","name": "robotoverlord"}, "team": { "domain": "exampledomain", "id": "T123450FP", "name": "ExampleName" } } ) Raises: SlackApiError: Unable to retrieve RTM URL from Slack. NTrzRetrieving websocket info.)z rtm.start rtm_startrz&Unable to retrieve RTM URL from Slack.)rr|)rr rrrrrrr!rr%rNrrr rtm_connectrrXrrz)r) use_rtm_startresprrrr*r*r+rs6      z"RTMClient._retrieve_websocket_info,csR|jdidtd|jt|}|jd|tt |IdHdS)apWait exponentially longer for each connection attempt. Calculate the number of seconds to wait and then add a random number of milliseconds to avoid coincidental synchronized client retries. Wait up to the maximum amount of wait time specified via 'max_wait_time'. However, if Slack returned how long to wait use that. rz Retry-Afterz'Waiting %s seconds before reconnecting.N) r|rminr'randomr%rNrsleepfloat)r)r max_wait_time wait_timer*r*r+r1s zRTMClient._wait_exponentiallycCsbg}t|jdd}t|rtj||jd}||d|_tj|jdd|jd}|||S)z Closes the websocket connection.rNr=r0)getattrr rirrFrr7r)r)futures close_methodrKevent_fr*r*r+rOAs  zRTMClient._close_websocketrb)r)+r$r __qualname____doc__ collections defaultdictr4r r __annotations__r BASE_URLstrrboolrintrAbstractEventLoopdictr, staticmethodr2 classmethodrr/rrLrErRrVrTr\rar5rZrGrrrrrrOr*r*r*r+r sp N     -      A 89 4r )rrrrlr"r>rr@rrr threadingrrrarrrr r~ slack.errorserrorsrXslack.web.clientr r r*r*r*r+s"