U %FZh@s@dZddlZddlZddlZddlZddlZddlmZddlZddl Z ddl m Z ddl m Z ddl m Z ddl m Z dZd Zd Zd e jejjejjZd Zd Zd%ddZddZGdddZGdddZGdddZGdddZGddde jZ GdddZ!Gdd d Z"Gd!d"d"Z#Gd#d$d$e j$Z%dS)&asFirebase Realtime Database module. This module contains functions and classes that facilitate interacting with the Firebase Realtime Database. It supports basic data manipulation operations, as well as complex queries such as limit queries and range queries. However, it does not support realtime update notifications. This module uses the Firebase REST API underneath. N)parse) exceptions) _http_client) _sseclient)_utilsZ _databasez[].?#$)$key$value $priorityz%Firebase/HTTP/{0}/{1}.{2}/AdminPythonZFIREBASE_DATABASE_EMULATOR_HOST/cCs$t|tt}||}t||dS)aHReturns a database ``Reference`` representing the node at the specified path. If no path is specified, this function returns a ``Reference`` that represents the database root. By default, the returned References provide access to the Firebase Database specified at app initialization. To connect to a different database instance in the same Firebase project, specify the ``url`` parameter. Args: path: Path to a node in the Firebase realtime database (optional). app: An App instance (optional). url: Base URL of the Firebase Database instance (optional). When specified, takes precedence over the the ``databaseURL`` option set at app initialization. Returns: Reference: A newly initialized Reference. Raises: ValueError: If the specified path or app is invalid. clientpath)rZget_app_service _DB_ATTRIBUTE_DatabaseService get_client Reference)rappurlZservicer rX/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/firebase_admin/db.py reference0s rcsPttstdtfddtDrLsz_parse_path..z6Invalid path: "{0}". Path contains illegal characters.cSsg|] }|r|qSrr)rsegrrr Osz_parse_path..r ) isinstancestr ValueErrorformatany_INVALID_PATH_CHARACTERSsplitrrrr _parse_pathHs r&c@s<eZdZdZddZeddZeddZedd Zd S) Eventz>Represents a realtime update event received from the database.cCs||_t|j|_dSr) _sse_eventjsonloadsdata_dataselfZ sse_eventrrr__init__UszEvent.__init__cCs |jdS)zParsed JSON data of this event.r+r,r.rrrr+Ysz Event.datacCs |jdS)z9Path of the database reference that triggered this event.rr0r1rrrr^sz Event.pathcCs|jjS)zEvent type string (put, patch).)r( event_typer1rrrr2cszEvent.event_typeN) __name__ __module__ __qualname____doc__r/propertyr+rr2rrrrr'Rs  r'c@s(eZdZdZddZddZddZdS) ListenerRegistrationzERepresents the addition of an event listener to a database reference.cCs*||_||_tj|jd|_|jdS)a3Initializes a new listener with given parameters. This is an internal API. Use the ``db.Reference.listen()`` method to start a new listener. Args: callback: The callback function to fire in case of event. sse: A transport session to make requests with. )targetN) _callback_sse threadingThread _start_listen_threadstart)r.callbacksserrrr/ls zListenerRegistration.__init__cCs"|jD]}|r|t|qdSr)r;r:r'r-rrrr>{s z"ListenerRegistration._start_listencCs|j|jdS)zStops the event listener represented by this registration This closes the SSE HTTP connection, and joins the background thread. N)r;closer?joinr1rrrrCs zListenerRegistration.closeN)r3r4r5r6r/r>rCrrrrr8isr8c@seZdZdZddZeddZeddZedd Zd d Z d,d dZ ddZ ddZ ddZ d-ddZddZddZddZddZd d!Zd"d#Zd$d%Zd.d'd(Zd/d*d+Zd)S)0rz>Reference represents a node in the Firebase realtime database.cKsH|d|_d|kr"|d|_nt|d|_dd|j|_dS)zCreates a new Reference using the provided parameters. This method is for internal use only. Use db.reference() to obtain an instance of Reference. r segmentsrr N)get_client _segmentsr&rD_pathurl)r.kwargsrrrr/s  zReference.__init__cCs|jr|jdSdS)N)rHr1rrrkeys z Reference.keycCs|jSrrIr1rrrrszReference.pathcCs"|jrt|j|jdddSdS)NrK)r rE)rHrrGr1rrrparentszReference.parentcCsP|rt|tstd||dr4td||jd|}t|j|dS)aReturns a Reference to the specified child node. The path may point to an immediate child of the current Reference, or a deeply nested child. Child paths must not begin with '/'. Args: path: Path to the child node. Returns: Reference: A database Reference representing the specified child node. Raises: ValueError: If the child path is not a string, not well-formed or begins with '/'. z>Invalid path argument: "{0}". Path must be a non-empty string.r @Invalid path argument: "{0}". Child path must not start with "/"r )rr r!r" startswithrIrrG)r.r full_pathrrrchilds zReference.childFcCs^|r<|rtd|jjd|ddid\}}||dfS|rDdnd}|jjd||d S) aReturns the value, and optionally the ETag, at the current location of the database. Args: etag: A boolean indicating whether the Etag value should be returned or not (optional). shallow: A boolean indicating whether to execute a shallow read (optional). Shallow reads do not retrieve the child nodes of the current database location. Cannot be set to True if ``etag`` is also set to True. Returns: object: If etag is False returns the decoded JSON value of the current database location. If etag is True, returns a 2-tuple consisting of the decoded JSON value and the Etag associated with the current database location. Raises: ValueError: If both ``etag`` and ``shallow`` are set to True. FirebaseError: If an error occurs while communicating with the remote database server. z,etag and shallow cannot both be set to True.rFzX-Firebase-ETagtrueheadersETagz shallow=trueNparams)r!rGZheaders_and_body _add_suffixrFbody)r.etagZshallowrUr+rXrrrrFs  z Reference.getcCsPt|tstd|jjd|d|id}|jdkr:dSd||j dfS) aGets data in this location only if the specified ETag does not match. Args: etag: The ETag value to be checked against the ETag of the current location. Returns: tuple: A 3-tuple consisting of a boolean, a decoded JSON value and an ETag. If the ETag specified by the caller did not match, the boolen value will be True and the JSON and ETag values would reflect the corresponding values in the database. If the ETag matched, the boolean value will be False and the other elements of the tuple will be None. Raises: ValueError: If the ETag is not a string. FirebaseError: If an error occurs while communicating with the remote database server. zETag must be a string.rFz if-none-matchrTi0)FNNTrV) rr r!rGrequestrY status_coder)rUrF)r.r[resprrrget_if_changeds   zReference.get_if_changedcCs,|dkrtd|jjd||dddS)aSets the data at this location to the given value. The value must be JSON-serializable and not None. Args: value: JSON-serializable value to be set at this location. Raises: ValueError: If the provided value is None. TypeError: If the value is not JSON-serializable. FirebaseError: If an error occurs while communicating with the remote database server. NValue must not be None.put print=silentr)rX)r!rGr\rYr.valuerrrsets z Reference.setc Cst|tstd|dkr"tdz.|jjd||d|id}d||dfWStjk r}zD|j }|dk rd|jkr|jd}| }d ||fWY S|W5d}~XYnXdS) a<Conditonally sets the data at this location to the given value. Sets the data at this location to the given value only if ``expected_etag`` is same as the ETag value in the database. Args: expected_etag: Value of ETag we want to check. value: JSON-serializable value to be set at this location. Returns: tuple: A 3-tuple consisting of a boolean, a decoded JSON value and an ETag. The boolean indicates whether the set operation was successful or not. The decoded JSON and the ETag corresponds to the latest value in this database location. Raises: ValueError: If the value is None, or if expected_etag is not a string. FirebaseError: If an error occurs while communicating with the remote database server. zExpected ETag must be a string.NzValue must not be none.razif-match)r)rUTrVF) rr r!rGrUrYrFrZFailedPreconditionError http_responser))r.Z expected_etagrerUerrorrgr[Zsnapshotrrrset_if_unchanged s&  zReference.set_if_unchangedcCs:|dkrtd|jjd||d}|d}||S)asCreates a new child node. The optional value argument can be used to provide an initial value for the child node. If no value is provided, child node will have empty string as the default value. Args: value: JSON-serializable initial value for the child node (optional). Returns: Reference: A Reference representing the newly created child node. Raises: ValueError: If the value is None. TypeError: If the value is not JSON-serializable. FirebaseError: If an error occurs while communicating with the remote database server. Nr`post)r)name)r!rGrZrYrFrR)r.reoutputZpush_idrrrpush0s  zReference.pushcCsF|rt|tstdd|kr*td|jjd||dddS)ajUpdates the specified child keys of this Reference to the provided values. Args: value: A dictionary containing the child keys to update, and their new values. Raises: ValueError: If value is empty or not a dictionary. FirebaseError: If an error occurs while communicating with the remote database server. z.Value argument must be a non-empty dictionary.Nz&Dictionary must not contain None keys.patchrbrc)rdictr!keysrGr\rYrdrrrupdateGs  zReference.updatecCs|jd|dS)zDeletes this node from the database. Raises: FirebaseError: If an error occurs while communicating with the remote database server. deleteN)rGr\rYr1rrrrsWszReference.deletecCs ||S)aRegisters the ``callback`` function to receive realtime updates. The specified callback function will get invoked with ``db.Event`` objects for each realtime update received from the database. It will also get called whenever the SDK reconnects to the server due to network issues or credential expiration. In general, the OAuth2 credentials used to authorize connections to the server expire every hour. Therefore clients should expect the ``callback`` to fire at least once every hour, even if there are no updates in the database. This API is based on the event streaming support available in the Firebase REST API. Each call to ``listen()`` starts a new HTTP connection and a background thread. This is an experimental feature. It currently does not honor the auth overrides and timeout settings. Cannot be used in thread-constrained environments like Google App Engine. Args: callback: A function to be called when a data change is detected. Returns: ListenerRegistration: An object that can be used to stop the event listener. Raises: FirebaseError: If an error occurs while starting the initial HTTP connection. )_listen_with_session)r.rArrrlisten_szReference.listencCsdt|stdd}|jdd\}}|tkrX||}|||\}}}|rN|S|d7}q$tddS)aAtomically modifies the data at this location. Unlike a normal ``set()``, which just overwrites the data regardless of its previous state, ``transaction()`` is used to modify the existing value to a new value, ensuring there are no conflicts with other clients simultaneously writing to the same location. This is accomplished by passing an update function which is used to transform the current value of this reference into a new value. If another client writes to this location before the new value is successfully saved, the update function is called again with the new current value, and the write will be retried. In case of repeated failures, this method will retry the transaction up to 25 times before giving up and raising a TransactionAbortedError. The update function may also force an early abort by raising an exception instead of returning a value. Args: transaction_update: A function which will be passed the current data stored at this location. The function should return the new value it would like written. If an exception is raised, the transaction will be aborted, and the data at this location will not be modified. The exceptions raised by this function are propagated to the caller of the transaction method. Returns: object: New value of the current database Reference (only if the transaction commits). Raises: TransactionAbortedError: If the transaction aborts after exhausting all retry attempts. ValueError: If transaction_update is not a function. z&transaction_update must be a function.rT)r[z)Transaction aborted after failed retries.N)callabler!rF_TRANSACTION_MAX_RETRIESriTransactionAbortedError)r.Ztransaction_updatetriesr+r[Znew_datasuccessrrr transactionys zReference.transactioncCs*|tkrtd|t||j|dS)aReturns a Query that orders data by child values. Returned Query can be used to set additional parameters, and execute complex database queries (e.g. limit queries, range queries). Args: path: Path to a valid child of the current Reference. Returns: Query: A database Query instance. Raises: ValueError: If the child path is not a string, not well-formed or None. zIllegal child path: {0}order_byr pathurl)_RESERVED_FILTERSr!r"QueryrGrY)r.rrrrorder_by_childszReference.order_by_childcCstd|j|dS)aCreates a Query that orderes data by key. Returned Query can be used to set additional parameters, and execute complex database queries (e.g. limit queries, range queries). Returns: Query: A database Query instance. rr}rrGrYr1rrr order_by_keys zReference.order_by_keycCstd|j|dS)aCreates a Query that orderes data by value. Returned Query can be used to set additional parameters, and execute complex database queries (e.g. limit queries, range queries). Returns: Query: A database Query instance. rr}rr1rrrorder_by_values zReference.order_by_value.jsoncCs |j|SrrM)r.suffixrrrrYszReference._add_suffixNc Csx|jj|}|s|j}z$tj||fd|jji}t||WStj j k rr}zt |W5d}~XYnXdS)NrX) rGbase_urlrYcreate_listener_sessionrZ SSEClientrXr8requestsrRequestException_Clienthandle_rtdb_error)r.rAsessionrrBrhrrrrts  zReference._listen_with_session)FF)rj)r)N)r3r4r5r6r/r7rLrrNrRrFr_rfrirnrrrsrur|rrrrYrtrrrrrs.     & +  rc@sTeZdZdZddZddZddZdd Zd d Zd d Z e ddZ ddZ dS)raRepresents a complex query that can be executed on a Reference. Complex queries can consist of up to 2 components: a required ordering constraint, and an optional filtering constraint. At the server, data is first sorted according to the given ordering constraint (e.g. order by child). Then the filtering constraint (e.g. limit, range) is applied on the sorted data to produce the final result. Despite the ordering constraint, the final result is returned by the server as an unordered collection. Therefore the Query interface performs another round of sorting at the client-side before returning the results to the caller. This client-side sorted results are returned to the user as a Python OrderedDict. cKs|d}|rt|ts td|tkrR|dr@td|t|}d|}|d|_ |d|_ ||_ dt |i|_|rtd|dS) Nr~z)order_by field must be a non-empty stringr rOr rZorderByz!Unexpected keyword arguments: {0})poprr r!rrPr"r&rDrGrI _order_byr)dumps_params)r.rJr~rErrrr/s      zQuery.__init__cCs:t|tr|dkrtdd|jkr,td||jd<|S)aMCreates a query with limit, and anchors it to the start of the window. Args: limit: The maximum number of child nodes to return. Returns: Query: The updated Query instance. Raises: ValueError: If the value is not an integer, or set_limit_last() was called previously. r%Limit must be a non-negative integer. limitToLast&Cannot set both first and last limits. limitToFirstrintr!rr.limitrrrlimit_to_firsts   zQuery.limit_to_firstcCs:t|tr|dkrtdd|jkr,td||jd<|S)aLCreates a query with limit, and anchors it to the end of the window. Args: limit: The maximum number of child nodes to return. Returns: Query: The updated Query instance. Raises: ValueError: If the value is not an integer, or set_limit_first() was called previously. rrrrrrrrrr limit_to_last s   zQuery.limit_to_lastcCs$|dkrtdt||jd<|S)asSets the lower bound for a range query. The Query will only return child nodes with a value greater than or equal to the specified value. Args: start: JSON-serializable value to start at, inclusive. Returns: Query: The updated Query instance. Raises: ValueError: If the value is ``None``. NzStart value must not be None.ZstartAtr!r)rr)r.r@rrrstart_at szQuery.start_atcCs$|dkrtdt||jd<|S)alSets the upper bound for a range query. The Query will only return child nodes with a value less than or equal to the specified value. Args: end: JSON-serializable value to end at, inclusive. Returns: Query: The updated Query instance. Raises: ValueError: If the value is ``None``. NzEnd value must not be None.ZendAtr)r.endrrrend_at4sz Query.end_atcCs$|dkrtdt||jd<|S)aSSets an equals constraint on the Query. The Query will only return child nodes whose value is equal to the specified value. Args: value: JSON-serializable value to query for. Returns: Query: The updated Query instance. Raises: ValueError: If the value is ``None``. Nz Equal to value must not be None.ZequalTorrdrrrequal_toHszQuery.equal_tocCs6g}t|jD]}|d||j|qd|S)N{0}={1}&)sortedrappendr"rD)r.rXrLrrr _querystr[szQuery._querystrcCsB|jjd|j|jd}t|ttfr>|jdkr>t||j S|S)a7Executes this Query and returns the results. The results will be returned as a sorted list or an OrderedDict. Returns: object: Decoded JSON result of the Query. Raises: FirebaseError: If an error occurs while communicating with the remote database server. rFrWr ) rGrZrIrrrplistr_SorterrF)r.resultrrrrFbs z Query.getN) r3r4r5r6r/rrrrrr7rrFrrrrrs  rc@seZdZdZddZdS)ryzGA transaction was aborted aftr exceeding the maximum number of retries.cCstj||dSr)r AbortedErrorr/)r.messagerrrr/vsz TransactionAbortedError.__init__N)r3r4r5r6r/rrrrryssryc@s eZdZdZddZddZdS)rz'Helper class for sorting query results.cspt|tr(d|_fdd|D}n:t|trPd|_fddt|D}ntdt|t ||_ dS)NTcsg|]\}}t||qSr _SortEntryrkvr~rrrsz$_Sorter.__init__..Fcsg|]\}}t||qSrrrrrrrsz'Sorting not supported for "{0}" object.) rrp dict_inputitemsr enumerater!r"typer sort_entries)r.resultsr~entriesrrrr/}s  z_Sorter.__init__cCs,|jrtdd|jDSdd|jDS)NcSsg|]}|j|jfqSr)rLrererrrrsz_Sorter.get..cSsg|] }|jqSr)rerrrrrs)r collections OrderedDictrr1rrrrFsz _Sorter.getN)r3r4r5r6r/rFrrrrrzs rc@seZdZdZdZdZdZdZdZdZ dd Z e d d Z e d d Z e ddZe ddZeddZeddZddZddZddZddZddZd d!Zd"S)#rz;A wrapper that is capable of sorting items in a dictionary.rrvcCsL||_||_|dkr||_n|dkr,||_nt|||_t|j|_dS)N)rr r)_key_value_indexr_extract_child_get_index_type _index_type)r.rLrer~rrrr/sz_SortEntry.__init__cCs|jSr)rr1rrrrLsz_SortEntry.keycCs|jSr)rr1rrrindexsz_SortEntry.indexcCs|jSr)rr1rrr index_typesz_SortEntry.index_typecCs|jSr)rr1rrrresz_SortEntry.valuecCs`|dkr|jSt|tr"|s"|jSt|tr6|r6|jSt|ttfrJ|jSt|trZ|j S|j S)zAssigns an integer code to the type of the index. The index type determines how differently typed values are sorted. This ordering is based on https://firebase.google.com/docs/database/rest/retrieve-data#section-rest-ordered-data N) _type_nonerbool_type_bool_false_type_bool_truerfloat _type_numericr _type_string _type_object)clsrrrrrs z_SortEntry._get_index_typecCs8|d}|}|D] }t|tr,||}qdSq|S)Nr )r%rrprF)rrerrEcurrentsegmentrrrrs   z_SortEntry._extract_childcCsl|j|j}}||krP||j|jfkrB|j|jkrB|j|j}}n|j|j}}||kr\dS||krhdSdS)abCompares two _SortEntry instances. If the indices have the same numeric or string type, compare them directly. Ties are broken by comparing the keys. If the indices have the same type, but are neither numeric nor string, compare the keys. In all other cases compare based on the ordering provided by index types. rKrvr)rrrrrL)r.otherZself_keyZ other_keyrrr_comparesz_SortEntry._comparecCs||dkSNrrr.rrrr__lt__sz_SortEntry.__lt__cCs||dkSrrrrrr__le__sz_SortEntry.__le__cCs||dkSrrrrrr__gt__sz_SortEntry.__gt__cCs||dkSrrrrrr__ge__sz_SortEntry.__ge__cCs||dkSrrrrrr__eq__sz_SortEntry.__eq__N)r3r4r5r6rrrrrrr/r7rLrrre classmethodrrrrrrrrrrrrrs4       rc@sNeZdZdZdZddZdddZdd Zed d Z ed d Z ddZ dS)rz8Service that maintains a collection of database clients.Z_admin_cCs|j|_|jd}|r ||_nd|_t|}||jifkrPtj |dd|_ nd|_ |jdt j |_ i|_tjt}|rd|krtdt|||_nd|_dS)NZ databaseURL),:) separatorsZ httpTimeoutz//z6Invalid {0}: "{1}". It must follow format "host:port".) credential _credentialoptionsrF_db_urlr_get_auth_override_DEFAULT_AUTH_OVERRIDEr)r_auth_overriderZDEFAULT_TIMEOUT_SECONDS_timeout_clientsosenviron_EMULATOR_HOST_ENV_VARr!r"_emulator_host)r.rdb_url auth_overrideZ emulator_hostrrrr/s,   z_DatabaseService.__init__Nc Cs|dkr|j}|rt|ts*td|t|}|jsHtd|||}|rpt }|j }d|j i}n|j }d|j}i}|jr|j|d<|tj|ddf}||jkrt|||j|}||j|<|j|S) ztd||S)NZdatabaseAuthVariableOverridezZInvalid databaseAuthVariableOverride option: "{0}". Override value must be a dict or None.)rrFrrrpr!r")rrrrrrrYs z#_DatabaseService._get_auth_overridecCs"|jD] }|q i|_dSr)rvaluesrCrdrrrrCds z_DatabaseService.close)N) r3r4r5r6rr/rrrrrrCrrrrrs %  rcsNeZdZdZd fdd ZfddZddZed d Zed d Z Z S)rzHTTP client used to make REST calls. _Client maintains an HTTP session, and handles authenticating HTTP requests along with marshalling and unmarshalling of JSON data. Ncs0tj|||dtid||_|r&|ni|_dS)aCreates a new _Client from the given parameters. This exists primarily to enable testing. For regular use, obtain _Client instances by calling the from_app() class method. Args: credential: A Google credential that can be used to authenticate requests. base_url: A URL prefix to be added to all outgoing requests. This is typically the Firebase Realtime Database URL. timeout: HTTP request timeout in seconds. If set to None connections will never timeout, which is the default behavior of the underlying requests library. params: Dict of query parameters to add to all outgoing requests. z User-Agent)rrtimeoutrUN)superr/ _USER_AGENTrrX)r.rrrrX __class__rrr/qsz_Client.__init__c sdfddjD}|d}|r>|r:|d|}n|}||d<zttj||f|WStjjk r}zt |W5d}~XYnXdS)aMakes an HTTP call using the Python requests library. Extends the request() method of the parent JsonHttpClient class. Handles default params like auth overrides, and low-level exceptions. Args: method: HTTP method name as a string (e.g. get, post). url: URL path of the remote endpoint. This will be appended to the server's base URL. **kwargs: An additional set of keyword arguments to be passed into requests API (e.g. json, params). Returns: Response: An HTTP response object. Raises: FirebaseError: If an error occurs while making the HTTP call. rc3s |]}d|j|VqdS)rN)r"rX)rrLr1rrrsz"_Client.request..rXN) rDrXrFrrr\rrrr)r.methodrrJrZ extra_paramsrhrr1rr\s z_Client.requestcCs t|jSr)rZKeepAuthSessionrr1rrrrsz_Client.create_listener_sessioncCs.|jdkrt|S||j}tj||dS)zFConverts an error encountered while calling RTDB into a FirebaseError.N)r)responserZhandle_requests_error_extract_error_message)rrhrrrrrs   z_Client.handle_rtdb_errorcCsRd}z |}t|tr"|d}Wntk r8YnX|sNd|j}|S)aiExtracts an error message from an error response. If the server has sent a JSON response with an 'error' field, which is the typical behavior of the Realtime Database REST API, parses the response to retrieve the error message. If the server has sent a non-JSON response, returns the full response as the error message. Nrhz&Unexpected response from database: {0})r)rrprFr!r"contentdecode)rr rr+rrrr s  z_Client._extract_error_message)N) r3r4r5r6r/r\rrrr  __classcell__rrrrrjs  r)r NN)&r6rr)rsysr<urllibrrZfirebase_adminrrrrrr$rr" __version__ version_infomajorminorrrxrrr&r'r8rrrryrrrZJsonHttpClientrrrrrsH       "Sjq