o g@sldZddlZddlZddlZddlZddlmZmZmZm Z m Z ddl m Z ddl Z ddlZddlZddlmZmZmZddlZejejdeeZdZdZed ZGd d d e ZGd d d e ZGdddZGdddZGdddZ GdddZ!GdddZ"d!dedeee#e#ffddZ$  d"dedeee#e#fdee#fddZ%Gdd d Z&dS)#zxFirebase Remote Config Module. This module has required APIs for the clients to use Firebase Remote Config with python. N)DictOptionalLiteralUnionAny)Enum)App _http_client_utils)level _remoteconfig )defaultremotestaticc@s eZdZdZdZdZdZdZdS)PercentConditionOperatorzFEnum representing the available operators for percent conditions. LESS_OR_EQUAL GREATER_THANBETWEENUNKNOWNN)__name__ __module__ __qualname____doc__rrrrrrV/var/www/html/api-tag/env/lib/python3.10/site-packages/firebase_admin/remote_config.pyr's rc@sTeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdS)CustomSignalOperatorzLEnum representing the available operators for custom signal conditions. STRING_CONTAINSSTRING_DOES_NOT_CONTAINSTRING_EXACTLY_MATCHESSTRING_CONTAINS_REGEXNUMERIC_LESS_THANNUMERIC_LESS_EQUAL NUMERIC_EQUALNUMERIC_NOT_EQUALNUMERIC_GREATER_THANNUMERIC_GREATER_EQUALSEMANTIC_VERSION_LESS_THANSEMANTIC_VERSION_LESS_EQUALSEMANTIC_VERSION_EQUALSEMANTIC_VERSION_NOT_EQUALSEMANTIC_VERSION_GREATER_THANSEMANTIC_VERSION_GREATER_EQUALrN)rrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,rrrrrr/s&rc@sTeZdZdZddZeddZeddZedd Zed d Z ed d Z dS)_ServerTemplateDataz>Parses, validates and encapsulates template data and metadata.cCsd|vr|ddur|d|_ntdi|_d|vr+|ddur'|d|_ntdg|_d|_d|vr:|d|_d|_d|vrMt|dtrM|d|_t||_ dS) zInitializes a new ServerTemplateData instance. Args: template_data: The data to be parsed for getting the parameters and conditions. Raises: ValueError: If the template data is not valid. parametersNz2Remote Config parameters must be a non-null object conditionsz2Remote Config conditions must be a non-null objectversionetag) _parameters ValueError _conditions_version_etag isinstancestrjsondumps_template_data_json)self template_datarrr__init__Fs"      z_ServerTemplateData.__init__cC|jSN)r3r=rrrr.iz_ServerTemplateData.parameterscCr@rA)r7rBrrrr2mrCz_ServerTemplateData.etagcCr@rA)r6rBrrrr1qrCz_ServerTemplateData.versioncCr@rA)r5rBrrrr/urCz_ServerTemplateData.conditionscCr@rA)r<rBrrrtemplate_data_jsonyrCz&_ServerTemplateData.template_data_jsonN) rrrrr?propertyr.r2r1r/rDrrrrr-Ds#    r-c@sveZdZdZddedeeeeffddZddZ dd eeee ee ffd d fd d Z defddZ ddZdS)ServerTemplatezZRepresents a Server Template with implementations for loading and evaluating the template.Nappdefault_configcCsRt|tt|_d|_i|_t|_ |dur%|D] }t |||j|<qdSdS)aInitializes a ServerTemplate instance. Args: app: App instance to be used. This is optional and the default app instance will be used if not present. default_config: The default config to be used in the evaluated config. N) r get_app_service_REMOTE_CONFIG_ATTRIBUTE_RemoteConfigService _rc_service_cache_stringified_default_config threadingRLock_lockr9)r=rGrHkeyrrrr?s zServerTemplate.__init__csD|jIdH}|j ||_WddS1swYdS)z0Fetches the server template and caches the data.N)rLget_server_templaterQrM)r=rc_server_templaterrrloads "zServerTemplate.loadcontextreturn ServerConfigcCs|jstd|p i}i}|j|jj}|jj}Wdn1s#wY|jdur>|jD] \}}td|||<q2t|||||_ t |j dS)a"Evaluates the cached server template to produce a ServerConfig. Args: context: A dictionary of values to use for evaluating conditions. Returns: A ServerConfig object. Raises: ValueError: If the input arguments are invalid. zmNo Remote Config Server template in cache. Call load() before calling evaluate().Nr) config_values) rMr4rQr/r.rNitems_Value_ConditionEvaluator _evaluatorrXevaluate)r=rVrYtemplate_conditionstemplate_parametersrRvaluerrrr^s    zServerTemplate.evaluaterDcCsDt|}t|}|j ||_WddS1swYdS)zUpdates the cache to store the given template is of type ServerTemplateData. Args: template_data_json: A json string representing ServerTemplateData to be cached. N)r:loadsr-rQrM)r=rDtemplate_data_mapr>rrrsets "zServerTemplate.setcCsB|jstd|j |jj}Wd|S1swY|S)zRProvides the server template in a JSON format to be used for initialization later.zkNo Remote Config Server template in cache. Call load() before calling toJSON().N)rMr4rQrD)r= template_jsonrrrto_jsons  zServerTemplate.to_jsonNNrA)rrrrrrrr9r?rUrintr^rdrfrrrrrF~s ( rFc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rXz.Represents a Remote Config Server Side Config.cCs ||_dSrA)_config_values)r=rYrrrr?s zServerConfig.__init__cC||S)Returns the value as a boolean.) _get_value as_booleanr=rRrrr get_booleanzServerConfig.get_booleancCrj)Returns the value as a string.)rl as_stringrnrrr get_stringrpzServerConfig.get_stringcCrj)z Returns the value as an integer.)rlas_intrnrrrget_intrpzServerConfig.get_intcCrj)zReturns the value as a float.)rlas_floatrnrrr get_floatrpzServerConfig.get_floatcCrjz Returns the source of the value.)rl get_sourcernrrrget_value_sourcerpzServerConfig.get_value_sourcecCs|j|tdS)Nr)rigetr[rnrrrrlszServerConfig._get_valueN) rrrrr?rorsrurwrzrlrrrrrXs rXc@s:eZdZdZddZddZddZedefd d Z d S) rKzhInternal class that facilitates sending requests to the Firebase Remote Config backend API. cCsNd}|j|_|j}ddtji}|jdt j }t j ||||d|_ dS)zInitialize a JsonHttpClient with necessary inputs. Args: app: App instance to be used for fetching app specific details required for initializing the http client. z+https://firebaseremoteconfig.googleapis.comzX-FIREBASE-CLIENTzfire-admin-python/{0} httpTimeout) credentialbase_urlheaderstimeoutN) project_id _project_idr}get_credentialformatfirebase_admin __version__optionsr{r DEFAULT_TIMEOUT_SECONDSJsonHttpClient_client)r=rGremote_config_base_urlapp_credential rc_headersrrrrr?s   z_RemoteConfigService.__init__c snzt}|d|jjd|IdH\}}Wntjjy+}z| |d}~ww| d|d<t |S)zRequests for a server template and converts the response to an instance of ServerTemplateData for storing the template parameters and conditions.Nr{r2) asyncioget_event_looprun_in_executorrheaders_and_body_get_urlrequests exceptionsRequestException_handle_remote_config_errorr{r-)r=looprr>errorrrrrSs z(_RemoteConfigService.get_server_templatecCs d|jS)zJReturns project prefix for url, in the format of /v1/projects/${projectId}z>/v1/projects/{0}/namespaces/firebase-server/serverRemoteConfig)rrrBrrrrsz_RemoteConfigService._get_urlrcCs t|S)z5Handles errors received from the Cloud Functions API.)r #handle_platform_error_from_requests)clsrrrrrs z0_RemoteConfigService._handle_remote_config_errorN) rrrrr?rSr classmethodrrrrrrrKsrKc@seZdZdZddZddZdeeeffddZ d!d e defd d Z d!d e defd dZ d!d e defddZ defddZdede fddZdefddZdefddZdefddZdefddZdefddZd S)"r\z_Internal class that facilitates sending requests to the Firebase Remote Config backend API.cCs||_||_||_||_dSrA)_contextr5r3ri)r=r/r.rVrYrrrr?!s z_ConditionEvaluator.__init__c Cs||j|j}|jrx|jD]g\}}|di}|di}d}|r9|D]\}}||vr8|r8||}nq(|rG|drGtd|q|rW|d} td| |j |<q|s`t d|q|drltd|qtd|d|j |<q|j S) z]Internal function that evaluates the cached server template to produce a ServerConfigconditionalValues defaultValueNuseInAppDefaultz'Using in-app default value for key '%s'rarz#No default value found for key '%s') evaluate_conditionsr5rr3rZr{loggerinfor[riwarning) r=evaluated_conditionsrR parameterconditional_values default_valueparameter_value_wrappercondition_namecondition_evaluationparameter_valuerrrr^'s6        z_ConditionEvaluator.evaluaterWcCs.i}|D]}||d|||d<q|S)a%Evaluates a list of conditions and returns a dictionary of results. Args: conditions: A list of NamedCondition objects. context: An EvaluationContext object. Returns: A dictionary that maps condition names to boolean evaluation results. conditionname)evaluate_conditionr{)r=r/rVrrrrrrMs   z'_ConditionEvaluator.evaluate_conditionsr nesting_levelcCs|tkr tddS|ddur||d||dS|ddur1||d||dS|ddur:dS|d durCdS|d durS||d |S|d durc||d |Std dS) aRecursively evaluates a condition. Args: condition: The condition to evaluate. context: An EvaluationContext object. nesting_level: The current recursion depth. Returns: The boolean result of the condition evaluation. z+Maximum condition recursion depth exceeded.F orConditionN andConditiontrueTfalsepercent customSignalz#Unknown condition type encountered.)MAX_CONDITION_RECURSION_DEPTHrrr{evaluate_or_conditionevaluate_and_conditionevaluate_percent_condition evaluate_custom_signal_condition)r=rrVrrrrr^s*    z&_ConditionEvaluator.evaluate_conditioncCs8|dpg}|D]}||||d}|rdSq dS)a&Evaluates an OR condition. Args: or_condition: The OR condition to evaluate. context: An EvaluationContext object. nesting_level: The current recursion depth. Returns: True if any of the subconditions are true, False otherwise. r/rTFr{r)r= or_conditionrVrsub_conditions sub_conditionresultrrrr~ z)_ConditionEvaluator.evaluate_or_conditioncCs8|dpg}|D]}||||d}|sdSq dS)a(Evaluates an AND condition. Args: and_condition: The AND condition to evaluate. context: An EvaluationContext object. nesting_level: The current recursion depth. Returns: True if all of the subconditions are met; False otherwise. r/rFTr)r= and_conditionrVrrrrrrrrrz*_ConditionEvaluator.evaluate_and_conditioncCs|ds tddS|d}|d}|d}|d}|s)tddS|r:|d p1d }|d p8d }nd }d }|rC|} nd } |rL|d nd } | |d} || } | d} |tjjkrj| | kS|tjjkrt| | kS|tjjkr|| ko|kSStd|dS)zEvaluates a percent condition. Args: percent_condition: The percent condition to evaluate. context: An EvaluationContext object. Returns: True if the condition is met, False otherwise. randomization_idzEMissing randomization_id in context for evaluating percent condition.FseedpercentOperator microPercentmicroPercentRangez/Missing percent operator for percent condition.microPercentUpperBoundrmicroPercentLowerBound.r0izUnknown percent operator: %s) r{rrhash_seeded_randomization_idrrrarr)r=percent_conditionrVrpercent_operator micro_percentmicro_percent_rangenorm_percent_upper_boundnorm_percent_lower_boundnorm_micro_percent seed_prefixstring_to_hashhash64instance_micro_percentilerrrrs<           z._ConditionEvaluator.evaluate_percent_conditionseeded_randomization_idcCs.t}||d|}tt|dS)zHashes a seeded randomization ID. Args: seeded_randomization_id: The seeded randomization ID to hash. Returns: The hashed value. zutf-8)hashlibsha256updateencode hexdigestabsrh)r=r hash_objectrrrrrs z0_ConditionEvaluator.hash_seeded_randomization_idcCs|dpi}|dp i}|dpi}t|||gs#tddS|s'dS||p-i}|s8td|dS|tjjkrG|||ddS|tj jkrW|||d d S|tj jkrf|||d dS|tj jkrt|||t j S|tjjkr|||d |d dS|tjjkr|||d |d dS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr|||d |ddS|tjjkr+|||d |ddS|tjjkr>|||d |ddS|tjjkrQ|||d |ddStd|dS)aEvaluates a custom signal condition. Args: custom_signal_condition: The custom signal condition to evaluate. context: An EvaluationContext object. Returns: True if the condition is met, False otherwise. customSignalOperatorcustomSignalKeytargetCustomSignalValueszDMissing operator, key, or target values for custom signal condition.Fz,Custom signal value not found in context: %scS||vSrArtargetactualrrrzF_ConditionEvaluator.evaluate_custom_signal_condition..cSrrArrrrrrrcSs||kSrA)striprrrrrsrcS|dkSNrrrrrrrrcS|dkSrrrrrrrrcS|dkSrrrrrrrrcS|dkSrrrrrrr"rcS|dkSrrrrrrr'rcS|dkSrrrrrrr,rcSrrrrrrrr3rcSrrrrrrrr8rcSrrrrrrrr=rcSrrrrrrrrBrcSrrrrrrrrGrcSrrrrrrrrLrz"Unknown custom signal operator: %s)r{allrrdebugrrra_compare_stringsrrr researchr!_compare_numbersr"r#r$r%r&r'_compare_semantic_versionsr(r)r*r+r,)r=custom_signal_conditionrVcustom_signal_operatorcustom_signal_keytarget_custom_signal_valuesactual_custom_signal_valuerrrrs                z4_ConditionEvaluator.evaluate_custom_signal_conditioncCs"|D] }||t|rdSqdS)ajCompares the actual string value of a signal against a list of target values. Args: target_values: A list of target string values. actual_value: The actual value to compare, which can be a string or number. predicate_fn: A function that takes two string arguments (target and actual) and returns a boolean indicating whether the target matches the actual value. Returns: bool: True if the predicate function returns True for any target value in the list, False otherwise. TF)r9)r= target_values actual_value predicate_fnrrrrrPs z$_ConditionEvaluator._compare_stringscCsXzt|}t|}||krdn||krdnd}||WSty+td|YdSw)Nrrz>Invalid numeric value for comparison for custom signal key %s.F)floatr4rr)r=r target_valuerrrrrrrrrds  z$_ConditionEvaluator._compare_numberscCs||t|t||S)aCompares the actual semantic version value of a signal against a target value. Calls the predicate function with -1, 0, 1 if actual is less than, equal to, or greater than target. Args: custom_signal_key: The custom signal for which the evaluation is being performed. target_values: A list of target string values. actual_value: The actual value to compare, which can be a string or number. predicate_fn: A function that takes an integer (-1, 0, or 1) and returns a boolean. Returns: bool: True if the predicate function returns True for the result of the comparison, False otherwise. )_compare_versionsr9)r=rrrrrrrros z._ConditionEvaluator._compare_semantic_versionsc Cszfdd|dD}dd|dD}tt|t|}|dg|t||dg|t|t||D]&\}} t|dk| dkfrKt|| krV|dWS|| kra|dWSq;|dWStyvtd|Yd Sw) aCompares two semantic version strings. Args: custom_signal_key: The custom singal for which the evaluation is being performed. sem_version_1: The first semantic version string. sem_version_2: The second semantic version string. predicate_fn: A function that takes an integer and returns a boolean. Returns: bool: The result of the predicate function. cSg|]}t|qSrrh.0partrrr z9_ConditionEvaluator._compare_versions..rcSrrrrrrrr r rrrzHInvalid semantic version format for comparison for custom signal key %s.F) splitmaxlenextendzipanyr4rr) r=r sem_version_1 sem_version_2rv1_partsv2_parts max_lengthpart1part2rrrrs,   z%_ConditionEvaluator._compare_versionsN)r)rrrrr?r^rr9boolrrhrrrrrrrrrrrrrrr\sL& "   - o  r\rGrHcs t||d}|IdH|S)aInitializes a new ServerTemplate instance and fetches the server template. Args: app: App instance to be used. This is optional and the default app instance will be used if not present. default_config: The default config to be used in the evaluated config. Returns: ServerTemplate: An object having the cached server template to be used for evaluation. rGrHN)init_server_templaterU)rGrHtemplaterrrrSs rSrDcCs"t||d}|dur|||S)aInitializes a new ServerTemplate instance. Args: app: App instance to be used. This is optional and the default app instance will be used if not present. default_config: The default config to be used in the evaluated config. template_data_json: An optional template data JSON to be set on initialization. Returns: ServerTemplate: A new ServerTemplate instance initialized with an optional template and config. rN)rFrd)rGrHrDrrrrrs  rc@seZdZdZdZdZdZdZgdZefde de fd d Z d e fd d Z d e fddZd efddZd efddZd e fddZdS)r[z3Represents a value fetched from Remote Config. Fr0rg)1rtyesyonsourceracCs||_||_dS)aInitializes a Value instance. Args: source: The source of the value (e.g., 'default', 'remote', 'static'). "static" indicates the value was defined by a static constant. "default" indicates the value was defined by default config. "remote" indicates the value was defined by config produced by evaluating a template. value: The string value. N)r#ra)r=r#rarrrr?s z_Value.__init__rWcCs|jdkr|jSt|jS)rqr)r#DEFAULT_VALUE_FOR_STRINGr9rarBrrrrrs  z_Value.as_stringcCs$|jdkr|jSt|j|jvS)rkr)r#DEFAULT_VALUE_FOR_BOOLEANr9ralowerBOOLEAN_TRUTHY_VALUESrBrrrrms z_Value.as_booleancC6|jdkr|jSzt|jWSty|jYSwzReturns the value as a number.r)r#DEFAULT_VALUE_FOR_INTEGERrhrar4rBrrrrt    z _Value.as_intcCr(r))r#DEFAULT_VALUE_FOR_FLOAT_NUMBERrrar4rBrrrrvr+z_Value.as_floatcCr@rx)r#rBrrrryrCz_Value.get_sourceN)rrrrr%r$r*r,r' ValueSourcer9r?rrrrmrrtrvryrrrrr[s   r[rg)NNN)'rrr:loggingrOtypingrrrrrenumrrrrrrr r basicConfigINFO getLoggerrrrJrr-rrr-rFrXrKr\r9rSrr[rrrrsD  :T/