o hAO@shddlZddlZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z GdddeZdS)N) HTTPAdapter)Retry)AuthenticationErrorInvalidDataErrorFCMErrorFCMServerErrorFCMNotRegisteredErrorc@seZdZdZdZdZdZdZdZdZ dZ d'd d Z d d Z ddZ ddZd d d d d d d d dd d ddd d d d d d d d d d dd ifddZddZd(ddZddZgfddZddZdd Zd!d"Zd#d$Zd%d&Zd S))BaseAPIa Base class for the pyfcm API wrapper for FCM Attributes: api_key (str): Firebase API key proxy_dict (dict): use proxy (keys: `http`, `https`) env (str): for example "app_engine" json_encoder adapter: requests.adapters.HTTPAdapter() zapplication/jsonz#https://fcm.googleapis.com/fcm/sendz$https://iid.googleapis.com/iid/info/inormalhighNcCs.|r||_ntddrtdd|_ntdd|_t|_tdddgtj t dgBd}|j d|p9t |d |j d |pEt |d |jj ||j |jt |jd |rut|trud |vskd |vru||_|jj|g|_|d krz ddlm}|Wn tyYnw||_dS)NZ FCM_API_KEYz;Please provide the api_key in the google-services.json fileriiPOST)backoff_factorstatus_forcelistallowed_methodszhttp://) max_retrieszhttps://httphttpsZ app_enginer) appengine) _FCM_API_KEYosgetenvrZFCM_REQ_PROXIESrequestsSessionrequests_sessionrDEFAULT_ALLOWED_METHODS frozensetmountrheadersupdaterequest_headersINFO_END_POINT INFO_RETRIES isinstancedictproxiessend_request_responsesZrequests_toolbelt.adaptersrZ monkeypatchModuleNotFoundError json_encoder)selfZapi_keyZ proxy_dictenvr)adapterretriesrr.U/var/www/html/magazine_api/magazine_env/lib/python3.10/site-packages/pyfcm/baseapi.py__init__-s4       zBaseAPI.__init__cCs|jd|jdS)z Generates request headers including Content-Type and Authorization Returns: dict: request headers zkey=)z Content-Type Authorization) CONTENT_TYPErr*r.r.r/r!LszBaseAPI.request_headersccsRz|Wn tyt}Ynw|dt||jD] }||||jVqdS)a Splits registration ids in several lists of max 1000 registration ids per list Args: registration_ids (list): FCM device registration ID Yields: generator: list including lists with registration ids rN) NameErrorrangelenFCM_MAX_RECIPIENTS)r*registration_idsxrangeir.r.r/registration_id_chunksXs  zBaseAPI.registration_id_chunkscCstj|dd|jdddS)z Standardized json.dumps function with separators and sorted keys set Args: data (dict or list): data to be dumped Returns: string: json ),:TF) separators sort_keyscls ensure_asciiutf8)jsondumpsr)encode)r*datar.r.r/ json_dumpsks zBaseAPI.json_dumpsFcKs<t}|rt|dkr||d<n|d|d<|r||d<n|r%d||d<| r-|j|d<n|j|d<| r8| |d<|r>||d <| d urPt| trL| |d <ntd | rV| |d <| r\| |d<|rlt|trh||d<ntdi|d<|rx||dd<|r||dd<n|r||dd<|rt|tr||dd<ntd|r||dd<n|r||dd<|rt|tr||dd<ntd|r||dd<|rt|tr||d<|r||dd<t|tr|dkr||dd<|r||dd<|r||dd <|r||dd!<|r | ||r|d ||r|d=| |S)"a Parses parameters of FCMNotification's methods to FCM nested json Args: registration_ids (list, optional): FCM device registration IDs topic_name (str, optional): Name of the topic to deliver messages to message_body (str, optional): Message string to display in the notification tray message_title (str, optional): Message title to display in the notification tray message_icon (str, optional): Icon that apperas next to the notification sound (str, optional): The sound file name to play. Specify "Default" for device default sound. condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs click_action (str, optional): Action associated with a user click on the notification badge (str, optional): Badge of notification color (str, optional): Color of the icon tag (str, optional): Group notification by tag body_loc_key (str, optional): Indicates the key to the body string for localization body_loc_args (list, optional): Indicates the string value to replace format specifiers in body string for localization title_loc_key (str, optional): Indicates the key to the title string for localization title_loc_args (list, optional): Indicates the string value to replace format specifiers in title string for localization content_available (bool, optional): Inactive client app is awoken remove_notification (bool, optional): Only send a data message android_channel_id (str, optional): Starting in Android 8.0 (API level 26), all notifications must be assigned to a channel. For each channel, you can set the visual and auditory behavior that is applied to all notifications in that channel. Then, users can change these settings and decide which notification channels from your app should be intrusive or visible at all. extra_notification_kwargs (dict, optional): More notification keyword arguments **extra_kwargs (dict, optional): More keyword arguments Returns: string: json Raises: InvalidDataError: parameters do have the wrong type or format rr8rto conditionz /topics/%sprioritydelay_while_idle collapse_keyN time_to_livez'Provided time_to_live is not an integerrestricted_package_namedry_runrFz,Provided data_message is in the wrong formatZ notificationiconbody body_loc_key body_loc_argsz body_loc_args should be an arraytitle title_loc_keytitle_loc_argsz!title_loc_args should be an arrayandroid_channel_idcontent_available click_actionbadgecolortagsound) r%r6FCM_LOW_PRIORITYFCM_HIGH_PRIORITYr$intrlistboolr rG)r*r8 topic_name message_bodyZ message_titleZ message_iconr]rIrLrKrMrNZ low_priorityrOZ data_messagerYrZr[r\rRrSrUrVrXZremove_notificationrWZextra_notification_kwargs extra_kwargsZ fcm_payloadr.r.r/ parse_payload}sN                        zBaseAPI.parse_payloadcCsX|jj|j||d}d|jvr*t|jddkr*t|jd}t||||S|S)N)rFtimeoutz Retry-Afterr)rpost FCM_END_POINTrr`timesleep do_request)r*payloadrgresponseZ sleep_timer.r.r/rl/s   zBaseAPI.do_requestcCs,g|_|D]}|||}|j|qdS)N)r'rlappend)r*payloadsrgrmrnr.r.r/ send_request7s  zBaseAPI.send_requestcCs|jj|j|ddidS)z Makes a request for registration info and returns the response object Args: registration_id: id to be checked Returns: response of registration info request detailstrue)params)rgetr")r*registration_idr.r.r/registration_info_request=s z!BaseAPI.registration_info_requestcCs0g}|D]}||}|jdkr||q|S)z Checks registration ids and excludes inactive ids Args: registration_ids (list, optional): list of ids to be cleaned Returns: list: cleaned registration ids )rw status_codero)r*r8Zvalid_registration_idsrvrrr.r.r/clean_registration_idsLs    zBaseAPI.clean_registration_idscCs ||}|jdkr|SdS)a Returns details related to a registration id if it exists otherwise return None Args: registration_id: id to be checked Returns: dict: info about registration id None: if id doesn't exist rxN)rwryrC)r*rvrnr.r.r/get_registration_id_info]s z BaseAPI.get_registration_id_infocCTd}d||d}|jj||d}|jdkrdS|jdkr'|}t|dt) a Subscribes a list of registration ids to a topic Args: registration_ids (list): ids to be subscribed topic_name (str): name of topic Returns: True: if operation succeeded Raises: InvalidDataError: data sent to server was incorrectly formatted FCMError: an error occured on the server z*https://iid.googleapis.com/iid/v1:batchAdd/topics/rHZregistration_tokensrCrxTerrorrrhryrCrrr*r8rcurlrmrnrr.r.r/#subscribe_registration_ids_to_topicm   z+BaseAPI.subscribe_registration_ids_to_topiccCr|) a Unsubscribes a list of registration ids from a topic Args: registration_ids (list): ids to be unsubscribed topic_name (str): name of topic Returns: True: if operation succeeded Raises: InvalidDataError: data sent to server was incorrectly formatted FCMError: an error occured on the server z-https://iid.googleapis.com/iid/v1:batchRemover}r~rrxTrrrrr.r.r/'unsubscribe_registration_ids_from_topicrz/BaseAPI.unsubscribe_registration_ids_from_topicc Cs@gdddgdd}|jD]}|jdkr~d|jvr%t|jddkr%td|}|dd}|dd}|d d}|d d}|d g}|d d} | rQd }|rZ|d||d|7<|d |7<|d |7<|d || |d<q |jdkrt d|jdkrt |j |jdkrt dtd|S)a Parses the json response sent back by the server and tries to get out the important return variables Returns: dict: multicast_ids (list), success (int), failure (int), canonical_ids (int), results (list) and optional topic_message_id (str but None by default) Raises: FCMServerError: FCM is temporary not available AuthenticationError: error authenticating the sender account InvalidDataError: data passed to FCM was incorrecly structured rN) multicast_idssuccessfailure canonical_idsresultstopic_message_idrxzcontent-lengthz2FCM server connection error, the response is empty multicast_idrrrr message_idrrriz4There was an error authenticating the sender accountrizToken not registeredz%FCM server is temporarily unavailable) r'ryrr`rrCruroextendrrtextr ) r*Z response_dictrnZparsed_responserrrrrrr.r.r/parse_responsessF            zBaseAPI.parse_responsescsJddl}ddlm}fdd|D}||j||d}|S)Nrr) fetch_taskscsg|] }jdi|qS)r.)rf).0rtr3r.r/ sz.BaseAPI.send_async_request..)Z end_pointrrprg)asyncioZ async_fcmrZnew_event_loopZrun_until_completerir!)r*Z params_listrgrrrp responsesr.r3r/send_async_requests   zBaseAPI.send_async_request)NNNNN)NN)__name__ __module__ __qualname____doc__r2rir"r7r^r_r#r0r!r;rGrfrlrqrwrzr{rrrrr.r.r.r/r sd    3   7r )rCrrjrZrequests.adaptersrurllib3rerrorsrrrrr objectr r.r.r.r/s