gB ^dZddlZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddlmZGd d eZGd d eZ dd lmZmZn#e$reZdZYnwxYwdZdZdZdZdZdZdZdZdZdZdZ e!gdZ"dddddd Z#d!d"d#d$d%d&d'd(d)d*d+d, Z$ej%fd-Z&ej%d.j'fdd1Z(ej)d2d3d4dd56Z*ej)d7d8d9d:d;<Z+d=Z,eej)d>e,?Z)e)d@dAd!dBdCDZ-e)dEdFdBdGd"HZ.e)dIdJdKdLMZ/e)dNdOdPdBd#QZ0e)dRdSdTdBd$QZ1e)dUdVdBdWQZ2dXZ3e)dYdZd[d\e3dB]Z4e)d^d&d_d`dabZ5dcZ6ee)e6dZ7e7dedfdgdBdhQZ8ej)didjdBdkdlmZ9ej)dndodBdpdlmZ:e0e1e-e/e.fZ;Gdqdrej<Z=e2e5e4e8gZ>e>?e;Gdsdte=Z@eduf ddxZAdyZBdzZCd{ZDd|ZEd}ZFeBeDeEeFd~ZGdeGfdZHdZIdZJej%defdZKddej%d.dddudf ddZLeMdkrFddlNZNe@dZOeOP\ZQZReLeQdZSeNjNeSdSdS)aU Collect client connection parameters from various sources. This module provides functions for collecting client parameters from various sources such as user relative defaults, environment variables, and even command line options. There are two primary data-structures that this module deals with: normalized parameters and denormalized parameters. Normalized parameters is a proper mapping object, dictionary, consisting of the parameters used to apply to a connection creation interface. The high-level interface, ``collect`` returns normalized parameters. Denormalized parameters is a sequence or iterable of key-value pairs. However, the key is always a tuple whose components make up the "key-path". This is used to support sub-dictionaries like settings:: >>> normal_params = { 'user' : 'jwp', 'host' : 'localhost', 'settings' : {'default_statistics_target' : 200, 'search_path' : 'home,public'} } Denormalized parameters are used to simplify the overriding of past parameters. For this to work with dictionaries in a general fashion, dictionary objects would need a "deep update" method. N)chain)partial)iri) pgpassfile)ErrorceZdZdZdZdS)ClientParameterErrorz-*000z.clientparametersN)__name__ __module__ __qualname__codesourceQ/granary/edev/quantum/lib/python3.11/site-packages/postgresql/clientparameters.pyr r +s rr ceZdZdZdS)ServiceDoesNotExistErrorz-*srvN)r r r rrrrrr.srr)getusergetpasscdS)Npostgresrrrrrr5s r localhosti8 PGSERVICE PGSERVICEFILE PGSYSCONFDIRzpg_service.confz.pg_service.confz.pgpassz .postgresql postgresqlz pgpass.conf) userhostdatabaseportpassword sslcrtfile sslkeyfilesslrootcrtfilesslrootkeyfilesslmodeserver_encodingconnect_timeouttimezone datestyleclient_encodinggeqooptions)TZ DATESTYLECLIENTENCODINGGEQOOPTIONSrr rr!r"r'sslkeyr)kerberos4_realmkerberos5_servicer) USERDATABASEHOSTPORTPASSWORDSSLMODESSLKEYCONNECT_TIMEOUTREALM KRBSRVNAMEPASSFILEc#Ktpd}tjd|zpd}tj|t }dtfVdt fVdtfVtj dkrb| d}|rJtj|t}tj|t}n%tj|t}d tj|d fd tj|d fd tj|dfdtj|dfd|ffD]+\}}tj|r|f|fV,dS)z= Produce the defaults based on the existing configuration. r~z /dev/null)rr)r!win32APPDATAr#zpostgresql.crtr$zpostgresql.keyr%zroot.crtsslrootcrlfilezroot.crlrN)rospath expanduserjoinpg_home_directory default_host default_portsysplatformgetpg_appdata_directorypg_appdata_passfilepg_home_passfileexists)environruserdirpgdataappdatarkvs rdefaultsr\~s  Z 7  cDj ) ) 8[ ',,w 1 2 2')),,LG KK " "' : GLL"6 7 76 V%899:w||G%566*f&6778f&6778RW\\&*556RW\\&*556 TQW^^A q===rPGmodifier!environment variable key modifierc#2Kd}d}|vr)|dkr dd|dzffVtD]!\}}|}|vr |f|fV"|vr d|fVfdtD}fd |D}tvrd tfVt vrd t fVd }|vrd |fVdSdS)a Create a clientparams dictionary from the given environment variables. PGUSER -> user PGDATABASE -> database PGHOST -> host PGHOSTADDR -> host (overrides PGHOST) PGPORT -> port PGPASSWORD -> password PGPASSFILE -> pgpassfile PGSSLMODE -> sslmode PGREQUIRESSL gets rewritten into "sslmode = 'require'". PGREALM -> kerberos4_realm PGKRBSVRNAME -> kerberos5_service PGSSLKEY -> sslkey PGTZ -> settings['timezone'] PGDATESTYLE -> settings['datestyle'] PGCLIENTENCODING -> settings['client_encoding'] PGGEQO -> settings['geqo'] The 'PG' prefix can be customized via the `modifier` argument. However, PGSYSCONFDIR will not respect any such change as it's not a client parameter itself. HOSTADDR REQUIRESSL1)r'requirez=1rDc38K|]\}}||fVdSNr).0rZr[r^s r zenvvars..sEq88A;;rc6g|]\}}|v d|f|fS)settingsr)rgrZr[rVs r zenvvars..s7   %)QALLJWQZ LLLrconfig-pg_sysconfdirconfig-pg_service_fileSERVICE pg_serviceN)stripdefault_envvar_mapitemsdefault_envvar_settings_mappg_sysconfdir_envvarpg_service_file_envvar) rVr^hostaddrreqsslrZr[envvar_settings_maprjservices `` renvvarsrzs: HZ  (<  g V_##  6D=1 1111  % % ' 'TQhqkk!'\\ $   GH%&&&&9??AA    -@    G## )=!>????g%% !7+A#BCCCC 8I   w ww'((((((rz-Dz --datadirz%location of the database storage areadatadir)helpdefaultdestz-1z--with-transactionin_xact store_truez&run operation with a transaction block)r~actionr|c`|dn|}|jj|jf|fdS)NTvaluesdb_client_parametersappendr~optionopt_strvalueparsers rappend_db_client_parametersrsBE#** K>5rcallback)rrz-Uz --usernamestrzuser name to connect as)r~typer|z-dz --databasezdatabase's name)rr|r~z-Wz --passwordprompt_passwordzprompt for password)r~r|z-hz--hostzdatabase server host)r|rr~z-pz--portzdatabase server portz--unixzpath to filesystem socketunixc|dd}t|dkrtd||jj|j|df|dfdS)z.split the string into a (key,value) pair tuple=rzinvalid setting argument, rN)splitlenOptionValueErrorrrrr~)rrrrkvs rappend_settingsrsx kk#qGGqLL%%ABBB#** KAArz-sz --settingrjz*run-time parameters to set upon connecting)r~r|rrz --ssl-modezASSL requirement for connectivity: require, prefer, allow, disable)rdpreferallowdisablechoice)r~r|choicesrcR|jj|j|fdSrfrrs rappend_db_client_x_parametersr+s(#**FK+?@@@@@r)rz-Iz--irizbdatabase locator string [pq://user:password@host:port/database?[driver_param]=value&setting=value]pq_iriz-lzBbind the library found in postgresql.sys.libpath to the connectionlibr)r|rr~rz-Lzappend the library pathlibpathc,eZdZdZeZfdZdZxZS)StandardParsera Option parser limited to the basic -U, -h, -p, -W, and -D options. This parser subclass is necessary for two reasons: 1. _add_help_option override to not conflict with -h 2. Initialize the db_client_parameters on the parser's values. See the DefaultParser for more fun. cHtj|i|}g|_|Srf)superget_default_valuesr)selfargskwr[ __class__s rrz!StandardParser.get_default_valuesUs+ egg $-"--!! (rc6|ddddS)Nz--helpr|zshow this help message and exit)rr|) add_option)rs r_add_help_optionzStandardParser._add_help_optionZs///(  +r) r r r __doc__standard_optparse_optionsstandard_option_listrr __classcell__)rs@rrrIsY2     rrceZdZdZeZdS) DefaultParserzU Parser that includes a variety of connectivity options. (IRI, sslmode, settings) N)r r r rdefault_optparse_optionsrrrrrrks"1rr parameters1a fully normalized set of client parameters(dict)c|dd}|dd}|dd}|durtjrM|p|dd}|dt j|d zd zz }|d |zd z|d <dStj}|tj r1|dt|ttj z }||d <dS| d |tj |||d <dSdSdS)a Given a parameters dictionary, resolve the 'password' key. If `prompt_password` is `True`. If sys.stdin is a TTY, use `getpass` to prompt the user. Otherwise, read a single line from sys.stdin. delete 'prompt_password' from the dictionary. Otherwise. If the 'password' key is `None`, attempt to resolve the password using the 'pgpassfile' key. Finally, remove the pgpassfile key as the password has been resolved for the given parameters. rFrN prompt_titleTr[)obscure_password]z Password for z: r")poprOstdinisattypg_iri serializereadlineendswithrHlineseprrQpg_pass lookup_pgpass)rrrprompt_for_passwordrpromptpws rresolve_passwordrrsa("~~&7??nn\400~t444Y   >JNN>2>>6 S6#J4HHH H3 NN6#GOf$.s& 3 3 3"'..   3 3 3rcontextz, hintz No service files could be found.zcannot find service named "{0}")details)rQrrHrIrJrrKpg_service_user_filenamerrU configparserRawConfigParserreadrrNoSectionErrorlowerpg_service_driver_parameterssumrformat) service_namer service_filesfhome sysconfdirsfcpsrZr[rs r x_pg_servicers ZZ!""Mq   C'))O , ,$rw||D*BCCDDDjj)) zz')<=="gll:r""!q ++R     #%%"''"+++  xx 11  $    8   fq!wwyy16kk chh1v&& ''''' \ Z a. X !  --- ?A  4)OOOO55 3 3] 3 3 344 tyy''77  .7 !$++L99    s E""E43E4c@tdt|z)Nzcannot resolve ldap URLs: )NotImplementedErrorr)ldap_urlrs r x_pg_ldaprs7#h--GHHHr)rjrrorc#NK|pi}|D]}|d}t|trx|dr!|d||tdd<U||}|r*t ||d|||D]}|V|VdS)zq Given an iterable of standardized settings, [((path0, path1, ..., pathN), value)] Process any callbacks. rzconfig-rN)r callbacks) isinstancer startswithrrQ extrapolate)iterrritemrZcbrs rrrs ,B T 1g!3ll9  !%aF1S^^__  q  B  ba& gggg  ::::#rc|\}}|ddkr |dvrd|d<d}n2|ddkrd|d<n |ddkr|}t||fS)z- Translate a parameter into standard form. r requiressl)rcTr'rdrr )rtuple)rrZr[s rnormalize_parameterr s| !QaDLQ+-- !A$!!dh !A$$diggii! q! rci}|D]E\}}|}|dt|dz D]}||i}|||d<F|S)zl Normally takes the output of `extrapolate` and makes a dictionary suitable for applying to a connector. Nr)r setdefault)rrdrZr[sdrs r normalizer-sk  Va " is1vvaxiLb b"22"QrU)) rc|t|}|r tj||SdSrf)rQrtrHrIrK)rVdefault_pg_sysconfdirdefault_pg_service_filenamers rresolve_pg_service_filer:s= kk.0EFF? j"= > >> rFrparsed_options(options parsed using the `DefaultParser` no_defaults;Don't build-out defaults like 'user' from getpass.getuser()rV/environment variables to use, `None` to disableenviron_prefix2prefix to use for collecting environment variablesrdefault 'PGSYSCONFDIR' to user#the pg-service file to actually user3additional title to use if a prompt request is made5base-client parameters to use(applied after defaults)c`g}|d|fg||d|fg||d|fg|s#|t||r/|tt||)|t ||jt |dd} | r|| ttt|} |t| || S) zf Build a normalized client parameters dictionary for use with a connection construction interface. zconfig-environNrlrm)rV)rVr^r)r) rr\rrrz__add__getattrrrrr) rrrVrrrrr d_parameterscopcpds rcollectr%Dsv '12333%12o. 3h111222@,T*-=-=>>??? g $~5t<<cUL122333|4444 r__main__z5print the clientparams dictionary for the environment) descriptioncustom_prompt_title)rr)r^r_)rr)rrrrrVrrrrrrrrrrr)TrrOrHroptparse itertoolsr functoolsrrrrrr exceptionsrr rrr ImportError raw_inputrMrNpg_service_envvarrurtrrrTrLrRrSsetrrsrqrVr\r rz make_optionoption_datadiroption_in_xactr option_useroption_databaseoption_password option_host option_port option_unixroption_settingsoption_sslmoder make_x_option option_iri option_liboption_libpathr OptionParserrrextendrrrrrrrdefault_x_callbacksrr rrr%r pprintr parse_argscocarrrrrHs8 ######53%%%%%%%%%    (%'-!$# #s$$$  & %        & #',z>jSWS_:):):):):)@&%dK/  &%d,@ 0 g   ' k$  ! +dL  +dLk$  k$  k(#  +dK4  \K 1 AAA 0MNNN ]4l  "X !$L    &%d!    k o X*4   9:::11111N111 )KA)K)K)K)KZ   222 ???BIII    $1D8        :2    @DOT?AzIM;?;?HJHJ+ <+ L+  =+ G + 9 + 9 + F+ F+ + + + Z z]G LLNN"b Wb1FGGGqsA A$#A$