-SrSSKrSSKrSSKrSSKrSSKrSSKrSSKJr SSK J r SSK J r Sr \R"\5r0r\R""5rSrSrS r"S S \5rS r"S S\ R25rg)a Multiprocess file credential storage. This module provides file-based storage that supports multiple credentials and cross-thread and process access. This module supersedes the functionality previously found in `multistore_file`. This module provides :class:`MultiprocessFileStorage` which: * Is tied to a single credential via a user-specified key. This key can be used to distinguish between multiple users, client ids, and/or scopes. * Can be safely accessed and refreshed across threads and processes. Process & thread safety guarantees the following behavior: * If one thread or process refreshes a credential, subsequent refreshes from other processes will re-fetch the credentials from the file instead of performing an http request. * If two processes or threads attempt to refresh concurrently, only one will be able to acquire the lock and refresh, with the deadlock caveat below. * The interprocess lock will not deadlock, instead, the if a process can not acquire the interprocess lock within ``INTERPROCESS_LOCK_DEADLINE`` it will allow refreshing the credential but will not write the updated credential to disk, This logic happens during every lock cycle - if the credentials are refreshed again it will retry locking and writing as normal. Usage ===== Before using the storage, you need to decide how you want to key the credentials. A few common strategies include: * If you're storing credentials for multiple users in a single file, use a unique identifier for each user as the key. * If you're storing credentials for multiple client IDs in a single file, use the client ID as the key. * If you're storing multiple credentials for one user, use the scopes as the key. * If you have a complicated setup, use a compound key. For example, you can use a combination of the client ID and scopes as the key. Create an instance of :class:`MultiprocessFileStorage` for each credential you want to store, for example:: filename = 'credentials' key = '{}-{}'.format(client_id, user_id) storage = MultiprocessFileStorage(filename, key) To store the credentials:: storage.put(credentials) If you're going to continue to use the credentials after storing them, be sure to call :func:`set_store`:: credentials.set_store(storage) To retrieve the credentials:: storage.get(credentials) N) iteritems)_helpers)clientc[RRU5(ag[US5R 5 [ R SRU55 g)zuCreates the an empty file if it does not already exist. Returns: True if the file was created, False otherwise. Fza+bzCredential file {0} createdT)ospathexistsopencloseloggerinfoformatfilenames Alib/third_party/oauth2client/contrib/multiprocess_file_storage.py_create_file_if_neededrdsJ  ww~~h Xu##% 188BCcURS5 [R"U5nUR S5S:wa[R S5 0$0n[UR S055H?up4[R"U5n[RRU5nXbU'MA U$![a [R S5 0s$f=f! [R SRU55 M=f)aLoad credentials from the given file handle. The file is expected to be in this format: { "file_version": 2, "credentials": { "key": "base64 encoded json representation of credentials." } } This function will warn and return empty credentials instead of raising exceptions. Args: credentials_file: An open file handle. Returns: A dictionary mapping user-defined keys to an instance of :class:`oauth2client.client.Credentials`. rz@Credentials file could not be loaded, will ignore and overwrite. file_versionz=Credentials file is not version 2, will ignore and overwrite. credentialsz)Invalid credential {0} in file, ignoring.)seekjsonload Exceptionr warninggetrbase64 b64decoder Credentials new_from_jsonr)credentials_filedatarkeyencoded_credentialcredential_json credentials r_load_credentials_filer)ss,a yy)* xx1$   K#,TXXmR-H#I I$../ABO++99/JJ)  $J /    & I NN;BB3G Is'B789C7!CC&DcNS0S.n[U5HZup4UR5n[R"[R "[R "U555nXbSU'M\ URS5 [R"X 5 UR5 g)aWrites credentials to a file. Refer to :func:`_load_credentials_file` for the format. Args: credentials_file: An open file handle, must be read/write. credentials: A dictionary mapping user-defined keys to an instance of :class:`oauth2client.client.Credentials`. r)rrrrN) rto_jsonr _from_bytesr b64encode _to_bytesrrdumptruncate)r#rr$r%r(r'r&s r_write_credentials_filer1sb 1D$[1$,,.%11&2B2B    /312#5]C 2 !IId%rcN\rSrSrSrSrSrSrSrSr Sr S r S r S r S rg )_MultiprocessStorageBackendaThread-local backend for multiprocess storage. Each process has only one instance of this backend per file. All threads share a single instance of this backend. This ensures that all threads use the same thread lock and process lock when accessing the file. cSUlXl[R"SR U55Ul[ R"5UlSUl 0Ul g)Nz{0}.lockF) _file _filename fastenersInterProcessLockr _process_lock threadingLock _thread_lock _read_only _credentials)selfrs r__init__$_MultiprocessStorageBackend.__init__sM !&77   h ')%NN,rcUR(dg[UR5nURRU5 [R S5 g)z)(Re-)loads the credentials from the file.NzRead credential file)r6r)r?updater debug)r@loaded_credentialss r_load_credentials-_MultiprocessStorageBackend._load_credentialss=zz 3DJJ?   !34 +,rcUR(a[RS5 g[URUR 5 [RSR UR55 g)Nz+In read-only mode, not writing credentials.zWrote credential file {0}.)r>r rEr1r6r?rr7r@s r_write_credentials._MultiprocessStorageBackend._write_credentialssI ?? LLF G  D,=,=> 188HIrcURR5 URR[S9nU(a8[ UR 5 [ UR S5UlSUlOm[RS5 [RRUR 5(a[ UR S5UlOSUlSUlUR5 g)N)timeoutzr+FzFailed to obtain interprocess lock for credentials. If a credential is being refreshed, other processes may not see the updated access token and refresh as well.rT)r=acquirer:INTERPROCESS_LOCK_DEADLINErr7r r6r>r warnrr r rG)r@lockeds r acquire_lock(_MultiprocessStorageBackend.acquire_locks !!###++4N+O  "4>> 2dnnd3DJ#DO KKH Iww~~dnn--!$..#6 ! "DO  rcURb!URR5 SUlUR(dURR 5 UR R 5 gN)r6r r>r:releaser=rJs r release_lock(_MultiprocessStorageBackend.release_locksN :: ! JJ   DJ    & & ( !!#rcTUcgUR(agUR(agg)NTF)invalidaccess_token_expiredr@rs r_refresh_predicate._MultiprocessStorageBackend._refresh_predicates&      - -rcURRUS5nURU5(a,UR5 URRUS5nU$rW)r?rr_rGr@r%rs r locked_get&_MultiprocessStorageBackend.locked_get sW''++C6   " "; / /  " " $++//T:Krc`UR5 X RU'UR5 grW)rGr?rKrbs r locked_put&_MultiprocessStorageBackend.locked_puts(  !,# !rc|UR5 URRUS5 UR5 grW)rGr?poprK)r@r%s r locked_delete)_MultiprocessStorageBackend.locked_deletes0   c4( !r)r?r6r7r:r>r=N)__name__ __module__ __qualname____firstlineno____doc__rArGrKrTrYr_rcrfrj__static_attributes__rrr3r3s5-J!,$ " "rr3c[RRU5n[ U[;a[ U5[U'[UsSSS5 $!,(df  g=f)aCA helper method to get or create a backend with thread locking. This ensures that only one backend is used per-file per-process, so that thread and process locks are appropriately shared. Args: filename: The full path to the credential storage file. Returns: An instance of :class:`_MultiprocessStorageBackend`. N)rr abspath_backends_lock _backendsr3rs r _get_backendrw$sBwwx(H  9 $"=h"GIh " s %A A#c<\rSrSrSrSrSrSrSrSr Sr S r g ) MultiprocessFileStoragei8a+Multiprocess file credential storage. Args: filename: The path to the file where credentials will be stored. key: An arbitrary string used to uniquely identify this set of credentials. For example, you may use the user's ID as the key or a combination of the client ID and user ID. c0X l[U5UlgrW)_keyrw_backend)r@rr%s rrA MultiprocessFileStorage.__init__As $X. rc8URR5 grW)r|rTrJs rrT$MultiprocessFileStorage.acquire_lockE ""$rc8URR5 grW)r|rYrJs rrY$MultiprocessFileStorage.release_lockHrrcxURRUR5nUbURU5 U$)zRetrieves the current credentials from the store. Returns: An instance of :class:`oauth2client.client.Credentials` or `None`. )r|rcr{ set_store)r@r(s rrc"MultiprocessFileStorage.locked_getKs6 ]]--dii8  !   &rcNURRURU5$)zWrites the given credentials to the store. Args: credentials: an instance of :class:`oauth2client.client.Credentials`. )r|rfr{r^s rrf"MultiprocessFileStorage.locked_putXs}}'' ;??rcLURRUR5$)z/Deletes the current credentials from the store.)r|rjr{rJs rrj%MultiprocessFileStorage.locked_deleteas}}**49955r)r|r{N) rlrmrnrorprArTrYrcrfrjrqrrrrryry8s&/%% @6rry)rprrloggingrr;r8sixr oauth2clientrrrQ getLoggerrlr rvr<rurr)r1objectr3rwStorageryrrrrrs=~  !    8 $  ! 0f .d"&d"N#(+6fnn+6r