@dZddlZddlZddlZddlZddlZddlmZddlmZddl m Z dZ eje ZiZej ZGddeZGd d eZd Zej,d  dd Zej,d ddZej,d ddZej,dddZej,dddZGddeZy)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)ceZdZdZy)ErrorzBase error for this module.N__name__ __module__ __qualname____doc__7lib/third_party/oauth2client/contrib/multistore_file.pyrrBs%rrceZdZdZy)NewerCredentialStoreErrorz7The credential store is a newer version than supported.Nrr rrrrFsArrcFtt|jS)alConverts 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  ((*+ ,,rcP||tj|d}t|||S)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_agentrrkeys rget_credential_storager%Ys3"!z))%0 2C ,#(8 ::rc&d|i}t|||S)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_stringrkey_dicts r(get_credential_storage_custom_string_keyr*ps#$z"H ,(-= ??rcTt||}t|}|j|S)aGet 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,&!z-A file backed store for multiple credentials.r&ctj|dd|_tj|_d|_||_|jd|_ y)zOInitialize 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!rs r__init__z_MultiStore.__init__sM !++HdC@ %NN,!1 ##% rc4eZdZdZdZdZdZdZdZdZ y) _MultiStore._Storagez9A Storage object that can read/write a single credential.c ||_||_y)N) _multistore_key)rLr.r$s rrMz_MultiStore._Storage.__init__s)D DIrc8|jjy)ziAcquires any lock necessary to access this Storage. This lock is not reentrant. N)rQr1rLs r acquire_lockz!_MultiStore._Storage.acquire_locks    " " $rc8|jjy)zRelease the Storage lock. Trying to release a lock that isn't held will result in a RuntimeError. N)rQr3rTs r release_lockz!_MultiStore._Storage.release_locks    $ $ &rcv|jj|j}|r|j||S)zRetrieve credential. The Storage lock must be held when this is called. Returns: oauth2client.client.Credentials )rQ_get_credentialrR set_store)rL credentials r locked_getz_MultiStore._Storage.locked_gets5))99$))DJ$$T* rcP|jj|j|y)zWrite a credential. The Storage lock must be held when this is called. Args: credentials: Credentials, the credentials to store. N)rQ_update_credentialrR)rL credentialss r locked_putz_MultiStore._Storage.locked_puts    / / ; GrcN|jj|jy)zDelete a credential. The Storage lock must be held when this is called. Args: credentials: Credentials, the credentials to store. N)rQ_delete_credentialrRrTs r locked_deletez"_MultiStore._Storage.locked_deletes    / / :rN) r r r r rMrUrWr\r`rcr rr_StoragerOs$G  % '  H ;rrdcbtjj|jj s^tj d} t |jj djtj |yy#tj |wxYw)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)r7r8existsrDr!umaskopenclose)rL old_umasks rrJz"_MultiStore._create_file_if_neededst ww~~djj1134I $TZZ((*E288:# 5 #s 2BB.c|jj |jj|jjsAd|_|jr.tjd|jj!t"j$j'|jj!dk(r-tj)d i|_|j-y|jr |j*|j/yy#tt f$r}|j t jk(rtjdn|j t jk(rtjdng|j t jk(rtjdn4|j t jk(rtjdnYd}~d}~wwxYw) 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)rGr;rD open_and_lockIOErrorOSErrorerrnoENOSYSloggerwarnENOLCKEDEADLKEACCES is_lockedrHrIr!r7r8getsizedebugrK_write_refresh_data_cache)rLes rr1z_MultiStore._lock&sp !!#  JJ $ $ &zz##%"DO%% 248::3F3F3HJ 77??4::..0 1Q 6 LL= >DJ KKMDJJ$6  $ $ & %77! ww%,,& 01ELL( EFEMM) 12ELL( => sD""H 1C HH cl|jj|jjy)z#Release the lock on the multistore.N)rDunlock_and_closerGr?rTs rr3z_MultiStore._unlockNs$ ##% !!#rc|jjsJ|jjj dt j |jjS)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)rGlockedrD file_handleseekjsonloadrTs r_locked_json_readz_MultiStore._locked_json_readSsS  '')))  %%a(yy//122rc\|jjsJ|jry|jj j dt j||jj ddd|jj jy)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) rGrrHrDrrrdumptruncate)rLdatas r_locked_json_writez_MultiStore._locked_json_write_s  ''))) ??   %%a( $ ..0 { D  ))+rci|_ |j}d} |d}|dkDrt dj |g} |d}|D]&} |j|\}}||j|<(y#t$rtj dYywxYw#t$rtj dYwxYw#ttf$rYwxYw#tjd d YxYw) 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.r/zMCredential file has file_version of {0}. Only file_version of 1 is supported.rz#Error decoding credential, skippingT)exc_info) rKr Exceptionrrrsrformat TypeErrorKeyError_decode_credential_from_jsoninfo)rLraw_dataversionr_ cred_entryr$r[s rr{z_MultiStore._refresh_data_cacheos"  --/H  C~.G Q;+77=vgH H  "6*K&J +"&"C"CJ"OZ", 3&-  KK5 6   C KKB C C8$    + A%)+s@A4BB<#C4BBB98B9<C CC,c|d}t|}d}tjjt j |d}||fS)aLoad 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$Nr[)rr Credentials new_from_jsonrdumps)rLrraw_keyr$r[s rrz(_MultiStore._decode_credential_from_jsonsOU# ) ''55 JJz,/ 02 Z  rcddi}g}||d<|jjD]G\}}t|}tj|j }|j ||dI|j|y)zPWrite the cached data back out. The multistore must be locked. rr/r)r$r[N)rKrdictrloadsto_jsonappendr)rLr raw_credscred_keycredrraw_creds rrzz_MultiStore._writesy #A& $ $ 0 0 2 Xt8nGzz$,,.1H   WHE F!3 )rcn|jjDcgc] }t|c}Scc}w)zGets all the registered credential keys in the multistore. Returns: A list of dictionaries corresponding to all the keys currently registered )rKkeysrrLr$s rr2z$_MultiStore._get_all_credential_keyss-&*ZZ__%67%6cS %6777s2c:|jj|dS)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)rKgetrs rrYz_MultiStore._get_credentialszz~~c4((rcB||j|<|jy)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)rKrz)rLr$rs rr^z_MultiStore._update_credentials 3 rc^ |j|=|jy#t$rYwxYw)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)rKrrzrs rrbz_MultiStore._delete_credentials1  3    s ,,c&|j||S)a Get 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 )rdrs rr-z_MultiStore._get_storages}}T3''rNT)r r r r r positionalrMrStoragerdrJr1r3rrr{rrzr2rYr^rbr-r rrr>r>sv7T__Q*5;6>>5;n $&'P$ 3, )+V!" *8 )   (rr>r)r rprloggingr7rE oauth2clientrroauth2client.contribr __author__ getLoggerr rrr<rFr:rrrrrr%r*r r5r,objectr>r rrrs#@  , *   8 $ "INN$&I&BB -,0::,>B??,7;((.((k(&k(r