U ڲgV!@sdZddlZddlZddlZddlZddlmZddlmZddl Z ddl m Z ddl m Z ddl m Z ddl m Z dd l mZdd l mZd Zd d ddddddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+d,g!Ze jZe jZe jZe jZe jZe jZe jZe jZe jZe jZe jZe jZe jZe jZe j Z e j!Z!e j"Z"e j#Z#e j$Z$e j%Z%e j&Z&e j'Z'd-d.Z(d=d0d&Z)d>d1d)Z*d?d2d*Z+d@d3d'Z,dAd4d(Z-dBd5d+Z.dCd6d,Z/Gd7ddZ0Gd8d d Z1Gd9ddZ2Gd:ddZ3Gd;d<d<Z4dS)Dz Firebase Cloud Messaging module.N)http)_auth) _http_client)_messaging_encoder)_messaging_utils) _gapic_utils)_utils) exceptionsZ _messaging AndroidConfigAndroidFCMOptionsAndroidNotification APNSConfigAPNSFCMOptions APNSPayloadApsApsAlert BatchResponse CriticalSound ErrorInfo FCMOptions LightSettingsMessageMulticastMessage NotificationQuotaExceededErrorSenderIdMismatchError SendResponseThirdPartyAuthErrorTopicManagementResponseUnregisteredError WebpushConfigWebpushFCMOptionsWebpushNotificationWebpushNotificationActionsendsend_allsend_multicast send_eachsend_each_for_multicastsubscribe_to_topicunsubscribe_from_topiccCst|ttSN)rZget_app_service_MESSAGING_ATTRIBUTE_MessagingService)appr/multicast_messager/r0 sz+send_each_for_multicast..) isinstancer ValueErrortokensr1r'rCr3r.r5r/rBr0r(s    cCstdtt|||S)aSends the given list of messages via Firebase Cloud Messaging as a single batch. If the ``dry_run`` mode is enabled, the message will not be actually delivered to the recipients. Instead FCM performs all the usual validations, and emulates the send operation. Args: messages: A list of ``messaging.Message`` instances. dry_run: A boolean indicating whether to run the operation in dry run mode (optional). app: An App instance (optional). Returns: BatchResponse: A ``messaging.BatchResponse`` instance. Raises: FirebaseError: If an error occurs while sending the message to the FCM service. ValueError: If the input arguments are invalid. send_all() is deprecated. Use send_each() instead. z2send_all() is deprecated. Use send_each() instead.)warningswarnDeprecationWarningr1r%r4r/r/r0r%s csBtdtttstdfddjD}t|||S)a'Sends the given mutlicast message to all tokens via Firebase Cloud Messaging (FCM). If the ``dry_run`` mode is enabled, the message will not be actually delivered to the recipients. Instead FCM performs all the usual validations, and emulates the send operation. Args: multicast_message: An instance of ``messaging.MulticastMessage``. dry_run: A boolean indicating whether to run the operation in dry run mode (optional). app: An App instance (optional). Returns: BatchResponse: A ``messaging.BatchResponse`` instance. Raises: FirebaseError: If an error occurs while sending the message to the FCM service. ValueError: If the input arguments are invalid. send_multicast() is deprecated. Use send_each_for_multicast() instead. zFsend_multicast() is deprecated. Use send_each_for_multicast() instead.r6c s.g|]&}tjjjjjj|dqSr7r?r@rBr/r0rDsz"send_multicast..) rIrJrKrErrFrGr1r%rHr/rBr0r&s   cCst|||dS)a4Subscribes a list of registration tokens to an FCM topic. Args: tokens: A non-empty list of device registration tokens. List may not have more than 1000 elements. topic: Name of the topic to subscribe to. May contain the ``/topics/`` prefix. app: An App instance (optional). Returns: TopicManagementResponse: A ``TopicManagementResponse`` instance. Raises: FirebaseError: If an error occurs while communicating with instance ID service. ValueError: If the input arguments are invalid. ziid/v1:batchAddr1make_topic_management_requestrGtopicr.r/r/r0r)s cCst|||dS)a<Unsubscribes a list of registration tokens from an FCM topic. Args: tokens: A non-empty list of device registration tokens. List may not have more than 1000 elements. topic: Name of the topic to unsubscribe from. May contain the ``/topics/`` prefix. app: An App instance (optional). Returns: TopicManagementResponse: A ``TopicManagementResponse`` instance. Raises: FirebaseError: If an error occurs while communicating with instance ID service. ValueError: If the input arguments are invalid. ziid/v1:batchRemoverLrNr/r/r0r*s c@s0eZdZdZddZeddZeddZdS) rzBAn error encountered when performing a topic management operation.cCs||_||_dSr+)_index_reason)selfindexreasonr/r/r0__init__szErrorInfo.__init__cCs|jS)zBIndex of the registration token to which this error is related to.)rPrRr/r/r0rSszErrorInfo.indexcCs|jS)z*String describing the nature of the error.)rQrVr/r/r0rTszErrorInfo.reasonN)__name__ __module__ __qualname____doc__rUpropertyrSrTr/r/r/r0rs  c@s<eZdZdZddZeddZeddZedd Zd S) rz8The response received from a topic management operation.cCst|trd|kr td|d|_d|_g|_t|dD]D\}}d|krt|jd7_|jt ||dq>|jd7_q>dS)Nresultsz*Unexpected topic management response: {0}.rerror) rEdictrFformat_success_count_failure_count_errors enumerateappendr)rRresprSresultr/r/r0rU$sz TopicManagementResponse.__init__cCs|jS)zCNumber of tokens that were successfully subscribed or unsubscribed.rarVr/r/r0 success_count1sz%TopicManagementResponse.success_countcCs|jS)zLNumber of tokens that could not be subscribed or unsubscribed due to errors.)rbrVr/r/r0 failure_count6sz%TopicManagementResponse.failure_countcCs|jS)z;A list of ``messaging.ErrorInfo`` objects (possibly empty).)rcrVr/r/r0errors;szTopicManagementResponse.errorsN) rWrXrYrZrUr[rirjrkr/r/r/r0r!s   c@s<eZdZdZddZeddZeddZedd Zd S) rz:The response received from a batch request to the FCM API.cCs||_tdd|D|_dS)NcSsg|]}|jr|qSr/)successrArfr/r/r0rDFsz*BatchResponse.__init__..) _responseslenra)rR responsesr/r/r0rUDszBatchResponse.__init__cCs|jS)z>A list of ``messaging.SendResponse`` objects (possibly empty).)rnrVr/r/r0rpHszBatchResponse.responsescCs|jSr+rhrVr/r/r0riMszBatchResponse.success_countcCst|j|jSr+)rorprirVr/r/r0rjQszBatchResponse.failure_countN) rWrXrYrZrUr[rprirjr/r/r/r0rAs  c@s<eZdZdZddZeddZeddZedd Zd S) rzHThe response received from an individual batched request to the FCM API.cCs"||_d|_|r|dd|_dS)Nname) _exception _message_idget)rRrf exceptionr/r/r0rUYszSendResponse.__init__cCs|jS)z9A message ID string that uniquely identifies the message.)rsrVr/r/r0 message_id_szSendResponse.message_idcCs|jdk o|j S)z3A boolean indicating if the request was successful.N)rsrrrVr/r/r0rldszSendResponse.successcCs|jS)zTA ``FirebaseError`` if an error occurs while sending the message to the FCM service.)rrrVr/r/r0ruiszSendResponse.exceptionN) rWrXrYrZrUr[rvrlrur/r/r/r0rVs  c@seZdZdZdZdZdZddiZe Z e e e e edZdd Zed d Zd&d dZd'ddZd(ddZddZddZddZddZddZddZedd Zed!d"Zed#d$Zd%S))r-zKService class that implements Firebase Cloud Messaging (FCM) functionality.z8https://fcm.googleapis.com/v1/projects/{0}/messages:sendz https://fcm.googleapis.com/batchzhttps://iid.googleapis.comZaccess_token_authtrue)ZAPNS_AUTH_ERRORZQUOTA_EXCEEDEDZSENDER_ID_MISMATCHZTHIRD_PARTY_AUTH_ERRORZ UNREGISTEREDcCsn|j}|stdtj||_ddtjd|_|j dt j }|j |_t j|j|d|_tj|_dS)NzProject ID is required to access Cloud Messaging service. Either set the projectId option, or use service account credentials. Alternatively, set the GOOGLE_CLOUD_PROJECT environment variable.2zfire-admin-python/{0})zX-GOOG-API-FORMAT-VERSIONzX-FIREBASE-CLIENTZ httpTimeout) credentialtimeout) project_idrFr-FCM_URLr`_fcm_urlfirebase_admin __version__ _fcm_headersoptionsrtrZDEFAULT_TIMEOUT_SECONDSryget_credential _credentialZJsonHttpClient_clientrZauthorized_http_build_transport)rRr.r{rzr/r/r0rUs  z_MessagingService.__init__cCst|tstd|j|S)Nz7Message must be an instance of messaging.Message class.)rErrF JSON_ENCODERdefault)clsr2r/r/r0encode_messages z _MessagingService.encode_messageFc Csf|||}z|jjd|j|j|d}Wn0tjjk rX}z||W5d}~XYn X|dSdS)z2Sends the given message to FCM via the FCM v1 API.posturlheadersjsonNrq) _message_datarbodyr}rrequestsr RequestException_handle_fcm_error)rRr2r3r8rfr]r/r/r0r$s  z_MessagingService.sendc st|tstdt|dkr&tdfdd}fdd|D}zJtjjt|d.}d d|||D}t|W5QRWSQRXWn6t k r}zt j d ||d W5d }~XYnXd S) z3Sends the given messages to FCM via the FCM v1 API.7messages must be a list of messaging.Message instances.1messages must not contain more than 500 elements.c sjzjjdjj|d}Wn<tjjk rX}ztd|dWYSd}~XYnXt|ddSdS)Nrr)rfru)ru) rrr}rrr rrr)r8rfrurVr/r0 send_datas (z._MessagingService.send_each..send_datacsg|]}|qSr/)r)rAr2r3rRr/r0rDsz/_MessagingService.send_each..) max_workerscSsg|]}|qSr/r/rmr/r/r0rDsz4Unknown error while making remote service calls: {0})r2causeN) rElistrFro concurrentZfuturesZThreadPoolExecutormapr Exceptionr Z UnknownErrorr`)rRr5r3rZ message_dataexecutorrpr]r/rr0r's    z_MessagingService.send_eachc st|tstdt|dkr&tdgfdd}tj|tjd}j }|D]<}t  ||}tj |jjd|jd}||qXz |Wn,tk r} z| W5d } ~ XYn XtSd S) z2Sends the given messages to FCM via the batch API.rrrcs*d}|r|}t||}|dSr+)_handle_batch_errorrre)_responser]ruZ send_responserprRr/r0batch_callbacks   z2_MessagingService.send_all..batch_callback)callbackZ batch_uriPOST)rZpostprocurimethodrrN)rErrFrorZBatchHttpRequestr- FCM_BATCH_URLrrrdumpsrZ HttpRequest _postprocr}raddexecuterrr) rRr5r3rbatch transportr2rreqr]r/rr0r%s6     z_MessagingService.send_allc Cst|tr|g}t|tr|s&tddd|D}|r@tdt|trN|sVtd|dsjd|}||d}d tj|}z|jj d ||tj d }Wn0t j j k r}z||W5d }~XYn Xt|Sd S) z;Invokes the IID service for topic management functionality.z7Tokens must be a string or a non-empty list of strings.cSsg|]}t|tr|s|qSr/)rEstr)rAtr/r/r0rDs zC_MessagingService.make_topic_management_request..z!Tokens must be non-empty strings.z!Topic must be a non-empty string.z/topics/z /topics/{0})toZregistration_tokensz{0}/{1}r)rrrN)rErrrF startswithr`r-IID_URLrr IID_HEADERSrr r_handle_iid_errorr) rRrGrOZ operationZ invalid_strr8rrfr]r/r/r0rMs2    z/_MessagingService.make_topic_management_requestcCsdt|i}|rd|d<|S)Nr2TZ validate_only)r-r)rRr2r3r8r/r/r0rsz_MessagingService._message_datacCst|S)z'Handle response from batch API request.)rloadsdecode)rRrrr/r/r0rsz_MessagingService._postproccCst|tjS)z)Handles errors received from the FCM API.)rZ#handle_platform_error_from_requestsr-_build_fcm_error_requestsrRr]r/r/r0rsz#_MessagingService._handle_fcm_errorcCs|jdkrt|i}z|j}t|tr2|}Wntk rHYnX|d}d}|rhd|}nd|jj |jj }t||S)z1Handles errors received from the Instance ID API.Nr]z(Error while calling the IID service: {0}z4Unexpected HTTP response with status: {0}; body: {1}) rrZhandle_requests_errorrrEr_rFrtr` status_codecontentr)rRr]r8Z parsed_bodycodemsgr/r/r0rs$       z#_MessagingService._handle_iid_errorcCst|tjS)zMHandles errors received from the googleapiclient while making batch requests.)rZ*handle_platform_error_from_googleapiclientr- _build_fcm_error_googleapiclientrr/r/r0r0sz%_MessagingService._handle_batch_errorcCs"||}|r||||jdSdSzfParses an error response from the FCM API and creates a FCM-specific exception if appropriate.)r http_responseN)_build_fcm_errorr)rr]r2 error_dictexc_typer/r/r0r5s z+_MessagingService._build_fcm_error_requestscCs ||}|r||||dSdSr)r)rr]r2rrrr/r/r0r<s z2_MessagingService._build_fcm_error_googleapiclientcCsF|sdSd}|dgD] }|ddkr|d}q:qtj|S)Ndetailsz@typez3type.googleapis.com/google.firebase.fcm.v1.FcmErrorZ errorCode)rtr-FCM_ERROR_TYPES)rrZfcm_codeZdetailr/r/r0rCs z"_MessagingService._build_fcm_errorN)F)F)F)rWrXrYrZr|rrrrZMessageEncoderrrrrrrrU classmethodrr$r'r%rMrrrrrrrrr/r/r/r0r-os<    &  r-)FN)FN)FN)FN)FN)N)N)5rZconcurrent.futuresrrrIrZgoogleapiclientrrr~rrrrrr r,__all__r r r r rrrrrrrrrrr r!r"r#rrrrr1r$r'r(r%r&r)r*rrrrr-r/r/r/r0s        &     #