a oe@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl m Z ddlmZmZddlmZddlmZddlmZmZmZmZdd lmZmZmZmZmZmZdd lm Z!dd lm"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(dd l)m*Z*dd l+m,Z,m-Z-m.Z.m/Z/ddl0m1Z1dZ2e3Z4dddZ5d6e7dedddZ8ej9dkrvddZ:ddZ"ddZ;dd Zd&d'Z?ej@d(d)ZAd*d+ZBd,d-ZCd.d/ZDd0d1ZEdud2d3ZFd4d5ZGd6d7ZHd8d9ZId:d;ZJdd?ZLd@dAZMdBdCZNeOdDZPdEdFZQdGdHZRdIdJZSdKdLZTdMdNZUdOdPZVej@dQdRZWdSdTZXdvdUdVZYdWdXZZdwdYdZZ[dxd\d]Z\d^d_Z]d`daZ^db_dcZ`e`ddZae`deZbdfdgZcdhdiZddjdkZedldmZfdndoZgdpdqZhdrdsZidS)yz requests.utils ~~~~~~~~~~~~~~ This module provides utility functions that are used within Requests that are also useful for external consumption. N) OrderedDict) make_headers parse_url)certs __version__)_HEADER_VALIDATORS_BYTE_HEADER_VALIDATORS_STRHEADER_VALIDATORSto_native_string)Mapping basestringbytes getproxiesgetproxies_environment integer_types)parse_http_list) proxy_bypassproxy_bypass_environmentquotestrunquoteurlparse urlunparsecookiejar_from_dict)FileModeWarning InvalidHeader InvalidURLUnrewindableBodyError)CaseInsensitiveDict)z.netrc_netrcPi)httphttpsz, z,\s*T)Zaccept_encodingzaccept-encodingwin32c Csz ddl}Wnty YdS0z6||jd}t||dd}||dd}WnttfypYdS0|rz|s~dS|d}|D]T}|dkrd|vrd S| dd }| d d }| d d}t ||t j rd SqdS)NrFz;Software\Microsoft\Windows\CurrentVersion\Internet SettingsZ ProxyEnableZ ProxyOverride;z.Tz\.*z.*?) winreg ImportErrorOpenKeyHKEY_CURRENT_USERint QueryValueExOSError ValueErrorsplitreplacerematchI)hostr+ZinternetSettingsZ proxyEnableZ proxyOverridetestr:/C:\Program Files\Certbot\pkgs\requests\utils.pyproxy_bypass_registryLs4      r<cCstrt|St|SdS)zReturn True, if the host should be bypassed. Checks proxy settings gathered from the environment, if specified, or the registry. N)rrr<)r8r:r:r;rpsrcCst|dr|}|S)z/Returns an internal sequence dictionary update.items)hasattrr=)dr:r:r;dict_to_sequence|s r@c Cs*d}d}t|drt|}ndt|dr.|j}nRt|drz |}Wntjtfy\Yn$0t|j}d|j vrt dt t|drz | }Wnty|dur|}YnX0t|dr|durz&|dd | }||pdWnty d}Yn0|durd}td||S) Nr__len__lenfilenoba%Requests has determined the content-length for this request using the binary size of the file: however, the file has been opened in text mode (i.e. without the 'b' flag in the mode). This may lead to an incorrect content-length. In Requests 3.0, support will be removed for files in text mode.tellseek)r>rBrCioUnsupportedOperationAttributeErrorosfstatst_sizemodewarningswarnrrEr1rFmax)oZ total_lengthZcurrent_positionrCr:r:r; super_lensB              rSFc CsFtjd}|dur|f}nddtD}zddlm}m}d}|D]B}ztj|}WntyrYWdS0tj |rF|}qqF|durWdSt |} d} t |t r| d} | j| d} z<||| } | r| drdnd } | | | d fWWSWn |tfy$|r Yn0Wnttfy@Yn0dS) z;Returns the Requests tuple auth for a given url from netrc.ZNETRCNcss|]}d|VqdS)z~/Nr:).0fr:r:r; z!get_netrc_auth..r)NetrcParseErrornetrc:asciirrG)rKenvironget NETRC_FILESrYrXpath expanduserKeyErrorexistsr isinstancerdecodenetlocr3Zauthenticatorsr1r,rJ)urlZ raise_errorsZ netrc_fileZnetrc_locationsrXrYZ netrc_pathrUlocZriZsplitstrr8r"Zlogin_ir:r:r;get_netrc_auths@       rhcCsBt|dd}|r>t|tr>|ddkr>|ddkr>tj|SdS)z0Tries to guess the filename of the given object.nameNr<>)getattrrcrrKr_basename)objrir:r:r;guess_filenames &rpcCstj|r|Stj|\}}|rVtj|sVtj|\}}|sFqVd||g}q t|sd|St|}||vr~|St }tj||dd}tj|st | }| | |Wdn1s0Y|S)zReplace nonexistent paths that look like they refer to a member of a zip archive with the location of an extracted copy of the target, or else just return the provided path unchanged. /rkN)rKr_rbr3joinzipfile is_zipfileZipFileZnamelisttempfileZ gettempdir atomic_openwriteread)r_archivememberprefixZzip_filetmpZextracted_pathZ file_handlerr:r:r;extract_zipped_pathss&      .r~ccs~tjtj|d\}}zBt|d}|VWdn1sB0Yt||Wntyxt|Yn0dS)z-Write a file to the disk in an atomic fashion)dirwbN) rvZmkstemprKr_dirnamefdopenr4 BaseExceptionremove)filenameZtmp_descriptorZtmp_nameZ tmp_handlerr:r:r;rw,s$  rwcCs.|dur dSt|ttttfr&tdt|S)aTake an object and test to see if it can be represented as a dictionary. Unless it can not be represented as such, return an OrderedDict, e.g., :: >>> from_key_val_list([('key', 'val')]) OrderedDict([('key', 'val')]) >>> from_key_val_list('string') Traceback (most recent call last): ... ValueError: cannot encode objects that are not 2-tuples >>> from_key_val_list({'key': 'val'}) OrderedDict([('key', 'val')]) :rtype: OrderedDict N+cannot encode objects that are not 2-tuples)rcrrboolr/r2rvaluer:r:r;from_key_val_list9s rcCs@|dur dSt|ttttfr&tdt|tr8|}t|S)aTake an object and test to see if it can be represented as a dictionary. If it can be, return a list of tuples, e.g., :: >>> to_key_val_list([('key', 'val')]) [('key', 'val')] >>> to_key_val_list({'key': 'val'}) [('key', 'val')] >>> to_key_val_list('string') Traceback (most recent call last): ... ValueError: cannot encode objects that are not 2-tuples :rtype: list Nr) rcrrrr/r2r r=listrr:r:r;to_key_val_listTs rcCsXg}t|D]F}|dd|ddkr4dkrHnnt|dd}||q |S)aParse lists as described by RFC 2068 Section 2. In particular, parse comma-separated lists where the elements of the list may include quoted-strings. A quoted-string could contain a comma. A non-quoted string could have quotes in the middle. Quotes are removed automatically after parsing. It basically works like :func:`parse_set_header` just that items may appear multiple times and case sensitivity is preserved. The return value is a standard :class:`list`: >>> parse_list_header('token, "quoted value"') ['token', 'quoted value'] To create a header from the :class:`list` again, use the :func:`dump_header` function. :param value: a string with a list header. :return: :class:`list` :rtype: list Nrrk")_parse_list_headerunquote_header_valueappend)rresultitemr:r:r;parse_list_headerrs  ( rcCsxi}t|D]f}d|vr"d||<q |dd\}}|dd|ddkrVdkrjnnt|dd}|||<q |S)a^Parse lists of key, value pairs as described by RFC 2068 Section 2 and convert them into a python dict: >>> d = parse_dict_header('foo="is a fish", bar="as well"') >>> type(d) is dict True >>> sorted(d.items()) [('bar', 'as well'), ('foo', 'is a fish')] If there is no value for a key it will be `None`: >>> parse_dict_header('key_without_value') {'key_without_value': None} To create a header from the :class:`dict` again, use the :func:`dump_header` function. :param value: a string with a dict header. :return: :class:`dict` :rtype: dict =Nrrkr)rr3r)rrrrir:r:r;parse_dict_headers ( rcCs\|rX|d|dkr dkrXnn4|dd}|rD|dddkrX|ddd dS|S) zUnquotes a header value. (Reversal of :func:`quote_header_value`). This does not use the real unquoting but what browsers are actually using for quoting. :param value: the header value to unquote. :rtype: str rrkrrNrGz\\\z\")r4)rZ is_filenamer:r:r;rs $ rcCsi}|D]}|j||j<q|S)zReturns a key/value dictionary from a CookieJar. :param cj: CookieJar object to extract cookies from. :rtype: dict )rri)cj cookie_dictcookier:r:r;dict_from_cookiejarsrcCs t||S)zReturns a CookieJar from a key/value dictionary. :param cj: CookieJar to insert cookies into. :param cookie_dict: Dict of key/values to insert into CookieJar. :rtype: CookieJar r)rrr:r:r;add_dict_to_cookiejarsrcCsTtdttjdtjd}tjdtjd}td}||||||S)zlReturns encodings from given content string. :param content: bytestring to extract encodings from. zIn requests 3.0, get_encodings_from_content will be removed. For more information, please see the discussion on issue #2266. (This warning should only appear once.)z!])flagsz+]z$^<\?xml.*?encoding=["\']*(.+?)["\'>])rOrPDeprecationWarningr5compiler7findall)contentZ charset_reZ pragma_reZxml_rer:r:r;get_encodings_from_contents  rc Cs|d}|d|dd}}i}d}|D]`}|}|r0|d}}|d} | dkr|d| |}|| dd|}|||<q0||fS) zReturns content type and parameters from given header :param header: string :return: tuple containing content type and dictionary of parameters r'rrNz"' Trrk)r3stripfindlower) headertokens content_typeparamsZ params_dictZitems_to_stripparamkeyrZindex_of_equalsr:r:r;_parse_content_type_headers   rcCsP|d}|sdSt|\}}d|vr4|ddSd|vr@dSd|vrLdSdS) z}Returns encodings from given HTTP Header Dict. :param headers: dictionary to extract encoding from. :rtype: str z content-typeNcharsetz'"textz ISO-8859-1zapplication/jsonutf-8)r]rr)headersrrr:r:r;get_encoding_from_headerss  rccsd|jdur|EdHdSt|jdd}|D]}||}|r.|Vq.|jddd}|r`|VdS)zStream decodes an iterator.Nr4errorsrWT)final)encodingcodecsgetincrementaldecoderrd)iteratorrdecoderchunkrvr:r:r;stream_decode_response_unicode3s   rccsHd}|dus|dkrt|}|t|krD||||V||7}qdS)z Iterate over slices of a string.rN)rB)stringZ slice_lengthposr:r:r; iter_slicesDs  rcCsztdtg}t|j}|rJzt|j|WStyH||Yn0zt|j|ddWSt yt|jYS0dS)zReturns the requested content back in unicode. :param r: Response object to get unicode content from. Tried: 1. charset from content-type 2. fall back and replace all unicode characters :rtype: str zIn requests 3.0, get_unicode_from_response will be removed. For more information, please see the discussion on issue #2266. (This warning should only appear once.)r4rN) rOrPrrrrr UnicodeErrorr TypeError)rZtried_encodingsrr:r:r;get_unicode_from_responseNs     rzBABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~c Cs|d}tdt|D]}||dd}t|dkr|rztt|d}Wn"tyttd|dYn0|tvr|||dd||<qd||||<qd||||<qd |S) zUn-escape any percent-escape sequences in a URI that are unreserved characters. This leaves all reserved, illegal and non-ASCII bytes encoded. :rtype: str %rrrGz"Invalid percent-escape sequence: ''N) r3rangerBisalnumchrr/r2rUNRESERVED_SETrr)uripartsihcr:r:r;unquote_unreserved{s  rcCs>d}d}ztt||dWSty8t||dYS0dS)zRe-quote the given URI. This function passes the given URI through an unquote/quote cycle to ensure that it is fully and consistently quoted. :rtype: str z!#$%&'()*+,/:;=?@[]~z!#$&'()*+,/:;=?@[]~)safeN)rrr)rZsafe_with_percentZsafe_without_percentr:r:r; requote_uris  rcCsltdt|d}|d\}}tdttt|d}tdt|d|@}||@||@kS)zThis function allows you to check if an IP belongs to a network subnet Example: returns True if ip = 192.168.1.1 and net = 192.168.1.0/24 returns False if ip = 192.168.1.1 and net = 192.168.100.0/24 :rtype: bool z=Lrrq)structunpacksocket inet_atonr3dotted_netmaskr/)ZipZnetZipaddrZnetaddrbitsZnetmaskZnetworkr:r:r;address_in_networks rcCs&ddd|>dA}ttd|S)zConverts mask from /xx format to xxx.xxx.xxx.xxx Example: if mask is 24 function returns 255.255.255.0 :rtype: str lr z>I)rZ inet_ntoarpack)maskrr:r:r;rsrcCs(zt|Wnty"YdS0dS)z :rtype: bool FT)rrr1)Z string_ipr:r:r;is_ipv4_addresss  rcCs|ddkr~zt|dd}Wnty8YdS0|dksJ|dkrNdSzt|ddWqtyzYdS0ndSdS)zV Very simple check of the cidr format in no_proxy variable. :rtype: bool rqrFrrT)countr/r3r2rrr1)Zstring_networkrr:r:r; is_valid_cidrs   rc cst|du}|r"tj|}|tj|<z*dVW|rp|durBtj|=qp|tj|<n"|rn|durdtj|=n |tj|<0dS)zSet the environment variable 'env_name' to 'value' Save previous value, yield, and then restore the previous value stored in the environment variable 'env_name'. If 'value' is None, do nothingN)rKr\r])Zenv_namerZ value_changed old_valuer:r:r; set_environs     rc Cs>dd}|}|dur|d}t|}|jdur2dS|rdd|dd d D}t|jr|D]0}t|rt|j|rdSq`|j|kr`dSq`nB|j}|jr|d |j7}|D] }|j|s||rdSqt d|>zt |j}Wnt t j fyd }Yn0Wdn1s&0Y|r:dSd S) zL Returns whether we should bypass proxies or not. :rtype: bool cSstj|ptj|SN)rKr\r]upper)rr:r:r; get_proxysz(should_bypass_proxies..get_proxyNno_proxyTcss|]}|r|VqdSrr:)rTr8r:r:r;rVrWz(should_bypass_proxies.. r,:F)rhostnamer4r3rrrportendswithrrrrZgaierror) rfrrZ no_proxy_argparsedZproxy_ipZhost_with_portr8Zbypassr:r:r;should_bypass_proxiess<      *rcCst||driStSdS)zA Return a dict of environment proxies. :rtype: dict rN)rr)rfrr:r:r;get_environ_proxies8s rcCst|pi}t|}|jdur.||j|dS|jd|j|jd|jdg}d}|D]}||vrV||}qpqV|S)zSelect a proxy for the url, if applicable. :param url: The url being for the request :param proxies: A dictionary of schemes or schemes and hosts to proxy URLs Nallz://zall://)rrr]scheme)rfproxiesZurlpartsZ proxy_keysproxyZ proxy_keyr:r:r; select_proxyDs rc Cst|dur |ni}|j}t|j}|d}|}|rpt||dspt||d}|||d}|rp||||S)aThis method takes proxy information from a request and configuration input to resolve a mapping of target proxies. This will consider settings such a NO_PROXY to strip proxy configurations. :param request: Request or PreparedRequest :param proxies: A dictionary of schemes or schemes and hosts to proxy URLs :param trust_env: Boolean declaring whether to trust environment configs :rtype: dict Nrrr)rfrrr]copyrr setdefault) ZrequestrZ trust_envrfrrZ new_proxiesZenviron_proxiesrr:r:r;resolve_proxies^s     rpython-requestscCs|dtS)zO Return a string representing the default user agent. :rtype: str rqr)rir:r:r;default_user_agentysrcCstttdddS)z9 :rtype: requests.structures.CaseInsensitiveDict z*/*z keep-alive)z User-AgentzAccept-EncodingZAcceptZ Connection)r!rDEFAULT_ACCEPT_ENCODINGr:r:r:r;default_headerssrc Csg}d}||}|s|Std|D]}z|dd\}}WntyZ|d}}Yn0d|di}|dD]D}z|d\}}WntyYqYn0|||||<qt||q&|S) zReturn a list of parsed link headers proxies. i.e. Link: ; rel=front; type="image/jpeg",; rel=back;type="image/jpeg" :rtype: list z '"z, * '"r)rr5r3r2r) rZlinksZ replace_charsvalrfrlinkrrr:r:r;parse_header_linkss&     rr[rGcCs|dd}|tjtjfvr dS|ddtjkr6dS|ddtjtjfvrRdS|t}|dkrhd S|dkr|dddtkrd S|d ddtkrd S|dkr|ddt krd S|d dt krdSdS)z :rtype: str Nzutf-32rz utf-8-sigrGzutf-16rrz utf-16-berz utf-16-lez utf-32-bez utf-32-le) r BOM_UTF32_LE BOM_UTF32_BEBOM_UTF8 BOM_UTF16_LE BOM_UTF16_BEr_null_null2_null3)dataZsampleZ nullcountr:r:r;guess_json_utfs*  r c Cslt|}|\}}}}}}} |j} | s.|| } }|r@d|| g} |durL|}|durXd}t|| |d|| fS)zGiven a URL that may or may not have a scheme, prepend the given scheme. Does not replace a present scheme with the one provided as an argument. :rtype: str @Nr)rrerrr) rfZ new_schemerrauthr8rr_queryfragmentrer:r:r;prepend_scheme_if_neededs rc Cs@t|}zt|jt|jf}Wnttfy:d}Yn0|S)z{Given a url with authentication components, extract them into a tuple of username,password. :rtype: (str,str) )rr)rrusernamepasswordrJr)rfrr r:r:r;get_auth_from_urls  rcCs$|\}}t||dt||ddS)zVerifies that header parts don't contain leading whitespace reserved characters, or return characters. :param header: tuple, in the format (name, value). rrN)_validate_header_part)rrirr:r:r;check_header_validitys rcCsxt|trt|}n2t|tr(t|}ntd|d|dt|||st|dkr\dnd}td|d|dS) Nz Header part (z) from z# must be of type str or bytes, not rrirzSInvalid leading whitespace, reserved character(s), or returncharacter(s) in header z: )rcrr rr rtyper6)rZ header_partZheader_validator_indexZ validatorZ header_kindr:r:r;rs$     rcCsFt|\}}}}}}|s"||}}|ddd}t|||||dfS)zW Given a url remove the fragment and the authentication part. :rtype: str r rrkr)rrsplitr)rfrrer_rrrr:r:r; urldefragauth&s  rcCsZt|jdd}|durNt|jtrNz||jWqVtyJtdYqV0ntddS)zfMove file pointer back to its recorded starting position so it can be read again on redirect. rFNz;An error occurred when rewinding request body for redirect.z+Unable to rewind request body for redirect.)rmbodyrcZ_body_positionrr1r )Zprepared_requestZ body_seekr:r:r; rewind_body7s   r)F)F)N)T)r)j__doc__r contextlibrHrKr5rrsysrvrOrs collectionsrZ urllib3.utilrrrrrZ_internal_utilsr r r r compatr rrrrrrrrrrrrrrZcookiesr exceptionsrrrr Z structuresr!r^whereZDEFAULT_CA_BUNDLE_PATHZ DEFAULT_PORTSrrr3rplatformr<r@rSrhrpr~contextmanagerrwrrrrrrrrrrrrr frozensetrrrrrrrrrrrrrrrencoderrr r rrrrrrr:r:r:r;s     $    $  B 9%  #   (   <   &