@SrSSKrSSKrSSKrSSKrSSKrSSKJr SSKJr SSK J r Sr \R"\ 5r0r\R "5r"SS\5r"S S \5rS r\R,"S 5SS j5r\R,"S5SSj5r\R,"S5SSj5r\R,"S5SSj5r\R,"S5SSj5r"SS\5rg)aMulti-credential file store with lock support. This module implements a JSON credential store where multiple credentials can be stored in one file. That file supports locking both in a single process and across processes. The credential themselves are keyed off of: * client_id * user_agent * scope The format of the stored data is like so:: { 'file_version': 1, 'data': [ { 'key': { 'clientId': '', 'userAgent': '', 'scope': '' }, 'credential': { # JSON serialized Credentials. } } ] } N)client)util) locked_filezjbeda@google.com (Joe Beda)c\rSrSrSrSrg)ErrorBzBase error for this module.N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r 7lib/third_party/oauth2client/contrib/multistore_file.pyrrBs%rrc\rSrSrSrSrg)NewerCredentialStoreErrorFz7The credential store is a newer version than supported.r Nr r rrrrFsArrcF[[UR555$)aPConverts a dictionary to a tuple that can be used as an immutable key. The resulting key is always sorted so that logically equivalent dictionaries always produce an identical tuple for a key. Args: dictionary: the dictionary to use as the key. Returns: A tuple representing the dictionary in it's naturally sorted ordering. )tuplesorteditems) dictionarys r_dict_to_tuple_keyrJs  ((*+ ,,rcHX[R"U5S.n[XUS9$)aGet a Storage instance for a credential. Args: filename: The JSON file storing a set of credentials client_id: The client_id for the credential user_agent: The user agent for the credential scope: string or iterable of strings, Scope(s) being requested warn_on_readonly: if True, log a warning if the store is readonly Returns: An object derived from client.Storage for getting/setting the credential. )clientId userAgentscopewarn_on_readonly)rscopes_to_string!get_credential_storage_custom_key)filename client_id user_agentr r"keys rget_credential_storager)Ys/"!))%0 2C ,(8 ::rcSU0n[XUS9$)aGet a Storage instance for a credential using a single string as a key. Allows you to provide a string as a custom key that will be used for credential storage and retrieval. Args: filename: The JSON file storing a set of credentials key_string: A string to use as the key for storing this credential. warn_on_readonly: if True, log a warning if the store is readonly Returns: An object derived from client.Storage for getting/setting the credential. r(r!)r$)r% key_stringr"key_dicts r(get_credential_storage_custom_string_keyr.ps!$z"H ,-= ??rcL[XS9n[U5nURU5$)auGet a Storage instance for a credential using a dictionary as a key. Allows you to provide a dictionary as a custom key that will be used for credential storage and retrieval. Args: filename: The JSON file storing a set of credentials key_dict: A dictionary to use as the key for storing this credential. There is no ordering of the keys in the dictionary. Logically equivalent dictionaries will produce equivalent storage keys. warn_on_readonly: if True, log a warning if the store is readonly Returns: An object derived from client.Storage for getting/setting the credential. r!)_get_multistorer _get_storage)r%r-r" multistorer(s rr$r$s)&!MJ X &C  " "3 ''rc[XS9nUR5 UR5UR5 $!UR5 f=f)aGets all the registered credential keys in the given Multistore. Args: filename: The JSON file storing a set of credentials warn_on_readonly: if True, log a warning if the store is readonly Returns: A list of the credential keys present in the file. They are returned as dictionaries that can be passed into get_credential_storage_custom_key to get the actual credentials. r!)r0_lock_get_all_credential_keys_unlockr%r"r2s rget_all_credential_keysr9sD!MJ224 s ;A c[RRU5n[R 5 [ R U[XS95n[R5 U$![R5 f=f)zA helper method to initialize the multistore with proper locking. Args: filename: The JSON file storing a set of credentials warn_on_readonly: if True, log a warning if the store is readonly Returns: A multistore object r!) ospath expanduser_multistores_lockacquire _multistores setdefault _MultiStorereleaser8s rr0r0shww!!(+H$!,, k(NP  !!#  !!#s A((A>c\rSrSrSr\R "S5SSj5r"SS\R5r Sr Sr S r S rS rS rS rSrSrSrSrSrSrSrg)rBz-A file backed store for multiple credentials.r*c[R"USS5Ul[R"5UlSUlX lUR5 SUl g)z?Initialize the class. This will create the file if necessary. zr+rFN) r LockedFile_file threadingLock _thread_lock _read_only_warn_on_readonly_create_file_if_needed_data)selfr%r"s r__init___MultiStore.__init__sK !++HdC@ %NN,!1 ##% rc<\rSrSrSrSrSrSrSrSr Sr S r g ) _MultiStore._Storagez9A Storage object that can read/write a single credential.cXlX lg)N) _multistore_key)rQr2r(s rrR_MultiStore._Storage.__init__s ) Irc8URR5 g)zQAcquires any lock necessary to access this Storage. This lock is not reentrant. N)rXr5rQs r acquire_lock!_MultiStore._Storage.acquire_locks    " " $rc8URR5 g)zcRelease the Storage lock. Trying to release a lock that isn't held will result in a RuntimeError. N)rXr7r\s r release_lock!_MultiStore._Storage.release_locks    $ $ &rcURRUR5nU(aURU5 U$)zwRetrieve credential. The Storage lock must be held when this is called. Returns: oauth2client.client.Credentials )rX_get_credentialrY set_store)rQ credentials r locked_get_MultiStore._Storage.locked_gets5))99$))DJ$$T* rcPURRURU5 g)zWrite a credential. The Storage lock must be held when this is called. Args: credentials: Credentials, the credentials to store. N)rX_update_credentialrY)rQ credentialss r locked_put_MultiStore._Storage.locked_puts    / / ; GrcNURRUR5 g)zDelete a credential. The Storage lock must be held when this is called. Args: credentials: Credentials, the credentials to store. N)rX_delete_credentialrYr\s r locked_delete"_MultiStore._Storage.locked_deletes    / / :r)rYrXN) r r r rrrRr]r`rfrkrorr rr_StoragerUs$G  % '  H ;rrqcr[RRURR 55(d`[R "S5n[ URR 5S5R5 [R "U5 gg![R "U5 f=f)zCreate an empty file if necessary. This method will not initialize the file. Instead it implements a simple version of "touch" to ensure the file has been created. za+bN)r;r<existsrIr%umaskopenclose)rQ old_umasks rrO"_MultiStore._create_file_if_neededsw ww~~djj11344I $TZZ((*E288:# 5 #s 2BB6c`URR5 URR5 URR5(dFSUlUR(a.[RSURR!55 ["R$R'URR!55S:Xa-[R)S 5 0UlUR-5 gUR(a UR*cUR/5 gg![[ 4anUR [ R:Xa[RS5 SnAGNFUR [ R:Xa[RS5 SnAGNUR [ R:Xa[RS5 SnAGNUR [ R:Xa[RS5 SnAGNeSnAff=f) zLock the entire multistore.z:File system does not support locking the credentials file.zVFile system is out of resources for writing the credentials file (is your disk full?).z>Lock contention on multistore file, opening in read-only mode.zCannot access credentials file.NTzThe credentials file (%s) is not writable. Opening in read-only mode. Any refreshed credentials will only be valid for this run.rz"Initializing empty multistore file)rLr?rI open_and_lockIOErrorOSErrorerrnoENOSYSloggerwarnENOLCKEDEADLKEACCES is_lockedrMrNr%r;r<getsizedebugrP_write_refresh_data_cache)rQes rr5_MultiStore._lock&s !!#  JJ $ $ &zz##%%"DO%% 248::3F3F3HJ 77??4::..0 1Q 6 LL= >DJ KKMDJJ$6  $ $ & %77! ww%,,& 011ELL( EFFEMM) 122ELL( =>> s/D33H-3H(<3H(53H(.3H('H((H-clURR5 URR5 g)z#Release the lock on the multistore.N)rIunlock_and_closerLrCr\s rr7_MultiStore._unlockNs$ ##% !!#rcURR5(deURR5R S5 [ R "URR55$)zGet the raw content of the multistore file. The multistore must be locked when this is called. Returns: The contents of the multistore decoded as JSON. r)rLlockedrI file_handleseekjsonloadr\s r_locked_json_read_MultiStore._locked_json_readSsV  ''))))  %%a(yy//122rcjURR5(deUR(agURR 5R S5 [ R"XRR 5SSSS9 URR 5R5 g)zWrite a JSON serializable data structure to the multistore. The multistore must be locked when this is called. Args: data: The data to be serialized and written. NrTr*),z: ) sort_keysindent separators) rLrrMrIrrrdumptruncate)rQdatas r_locked_json_write_MultiStore._locked_json_write_s  '')))) ??   %%a( $ ..0 { D  ))+rc0UlUR5nSnUSnUS:a[ SR U55e/nUSnUH%nURU5upVX`RU'M' g![a [R S5 gf=f![a [R S5 Nf=f![[4a Nf=f! [RS S S 9 M=f) zRefresh the contents of the multistore. The multistore must be locked when this is called. Raises: NewerCredentialStoreError: Raised when a newer client has written the store. zECredential data store could not be loaded. Will ignore and overwrite.Nr file_versionz\Missing version for credential data store. It may be corrupt or an old version. Overwriting.r3zMCredential file has file_version of {0}. Only file_version of 1 is supported.rz#Error decoding credential, skippingT)exc_info) rPr Exceptionrrrformat TypeErrorKeyError_decode_credential_from_jsoninfo)rQraw_dataversionrj cred_entryr(res rr_MultiStore._refresh_data_cacheos  --/H  C~.G Q;+77=vgH H  "6*K&J +"&"C"CJ"O", 3&-  KK5 6   C KKB C C8$    + A%)+s@A5BB?!C5BBB<;B<?CCC.cUSn[U5nSn[RR[R "US55nX44$)zLoad a credential from our JSON serialization. Args: cred_entry: A dict entry from the data member of our format Returns: (key, cred) where the key is the key tuple and the cred is the OAuth2Credential object. r(Nre)rr Credentials new_from_jsonrdumps)rQrraw_keyr(res rr(_MultiStore._decode_credential_from_jsonsMU# ) ''55 JJz,/ 02   rcSS0n/nX!S'URR5HGup4[U5n[R"UR 55nUR XVS.5 MI URU5 g)z@Write the cached data back out. The multistore must be locked. rr3r)r(reN)rPrdictrloadsto_jsonappendr)rQr raw_credscred_keycredrraw_creds rr_MultiStore._writess #A& $ $ 0 0 2 X8nGzz$,,.1H   WE F!3 )rctURR5Vs/sHn[U5PM sn$s snf)zGets all the registered credential keys in the multistore. Returns: A list of dictionaries corresponding to all the keys currently registered )rPkeysrrQr(s rr6$_MultiStore._get_all_credential_keyss-&*ZZ__%67%6cS %6777s5c:URRUS5$)zGet a credential from the multistore. The multistore must be locked. Args: key: The key used to retrieve the credential Returns: The credential specified or None if not present N)rPgetrs rrc_MultiStore._get_credentialszz~~c4((rc@X RU'UR5 g)zUpdate a credential and write the multistore. This must be called when the multistore is locked. Args: key: The key used to retrieve the credential cred: The OAuth2Credential to update/set N)rPr)rQr(rs rri_MultiStore._update_credentials 3 rc`URU UR5 g![a Nf=f)zDelete a credential and write the multistore. This must be called when the multistore is locked. Args: key: The key used to retrieve the credential N)rPrrrs rrn_MultiStore._delete_credentials1  3    s --c$URX5$)zGet a Storage object to get/set a credential. This Storage is a 'view' into the multistore. Args: key: The key used to retrieve the credential Returns: A Storage object that can be used to get/set this cred )rqrs rr1_MultiStore._get_storages}}T''r)rPrIrMrLrNNT)r r r rrr positionalrRrStoragerqrOr5r7rrrrrr6rcrirnr1rr rrrBrBst7 __Q*5;6>>5;n $&'P$ 3, )+V!" *8 )   (rrBr)rr~rloggingr;rJ oauth2clientrroauth2client.contribr __author__ getLoggerr rr@rKr>rrrrrr)r.r$r9r0objectrBr rrrs@  , *   8 $ NN$&I&BB -,0::,>B??,7;((.((k(&k(r