# Copyright (C) 2012 Anaconda, Inc # SPDX-License-Identifier: BSD-3-Clause """Common URL utilities.""" from __future__ import annotations import codecs import re import socket import struct from collections import namedtuple from functools import cache from getpass import getpass from os.path import abspath, expanduser from typing import TYPE_CHECKING, NamedTuple from urllib.parse import ( # noqa: F401 quote, quote_plus, unquote, unquote_plus, ) from urllib.parse import urlparse as _urlparse from urllib.parse import urlunparse as _urlunparse # noqa: F401 from ..deprecations import deprecated from .compat import on_win from .path import split_filename, strip_pkg_extension if TYPE_CHECKING: from collections.abc import Iterable from re import Pattern from typing import Any, Self from urllib.parse import ParseResult @deprecated("25.9", "26.3", addendum="Use int(..., 16) instead.") def hex_octal_to_int(ho: str) -> int: ho = ord(ho.upper()) o0 = ord("0") o9 = ord("9") oA = ord("A") oF = ord("F") res = ( ho - o0 if ho >= o0 and ho <= o9 else (ho - oA + 10) if ho >= oA and ho <= oF else None ) return res @cache def percent_decode(path: str) -> str: # This is not fast so avoid when we can. if "%" not in path: return path ranges: list[tuple[int, int]] = [] for m in re.finditer(r"(%[0-9A-F]{2})", path, flags=re.IGNORECASE): ranges.append((m.start(), m.end())) if not len(ranges): return path # Sorry! Correctness is more important than speed at the moment. # Should use a map + lambda eventually. result = b"" skips = 0 for i, c in enumerate(path): if skips > 0: skips -= 1 continue c = c.encode("ascii") emit = c if c == b"%": for r in ranges: if i == r[0]: emit = struct.pack("B", int(path[i + 1 : i + 3], 16)) skips = 2 break if emit: result += emit return codecs.utf_8_decode(result)[0] file_scheme = "file://" # Keeping this around for now, need to combine with the same function in conda/common/path.py """ def url_to_path(url): assert url.startswith(file_scheme), "{} is not a file-scheme URL".format(url) decoded = percent_decode(url[len(file_scheme):]) if decoded.startswith('/') and decoded[2] == ':': # A Windows path. decoded.replace('/', '\\') return decoded """ @cache def path_to_url(path: str) -> str: if not path: raise ValueError(f"Not allowed: {path!r}") if path.startswith(file_scheme): try: path.decode("ascii") except UnicodeDecodeError: raise ValueError( f"Non-ascii not allowed for things claiming to be URLs: {path!r}" ) return path path = abspath(expanduser(path)).replace("\\", "/") # We do not use urljoin here because we want to take our own # *very* explicit control of how paths get encoded into URLs. # We should not follow any RFCs on how to encode and decode # them, we just need to make sure we can represent them in a # way that will not cause problems for whatever amount of # urllib processing we *do* need to do on them (which should # be none anyway, but I doubt that is the case). I have gone # for ASCII and % encoding of everything not alphanumeric or # not in `!'()*-._/:`. This should be pretty save. # # To avoid risking breaking the internet, this code only runs # for `file://` URLs. # percent_encode_chars = "!'()*-._/\\:" percent_encode = lambda s: "".join( [f"%{ord(c):02X}", c][c < "{" and c.isalnum() or c in percent_encode_chars] for c in s ) if any(ord(char) >= 128 for char in path): path = percent_encode( path.decode("unicode-escape") if hasattr(path, "decode") else bytes(path, "utf-8").decode("unicode-escape") ) # https://blogs.msdn.microsoft.com/ie/2006/12/06/file-uris-in-windows/ if len(path) > 1 and path[1] == ":": path = file_scheme + "/" + path else: path = file_scheme + path return path url_attrs = ( "scheme", "path", "query", "fragment", "username", "password", "hostname", "port", ) class Url(namedtuple("Url", url_attrs)): """ Object used to represent a Url. The string representation of this object is a url string. This object was inspired by the urllib3 implementation as it gives you a way to construct URLs from various parts. The motivation behind this object was making something that is interoperable with built the `urllib.parse.urlparse` function and has more features than the built-in `ParseResult` object. """ def __new__( cls, scheme: str | None = None, path: str | None = None, query: str | None = None, fragment: str | None = None, username: str | None = None, password: str | None = None, hostname: str | None = None, port: str | None = None, ): if path and not path.startswith("/"): path = "/" + path if scheme: scheme = scheme.lower() if hostname: hostname = hostname.lower() return super().__new__( cls, scheme, path, query, fragment, username, password, hostname, port ) @property def auth(self) -> str | None: if self.username and self.password: return f"{self.username}:{self.password}" elif self.username: return self.username @property def netloc(self) -> str | None: if self.port: return f"{self.hostname}:{self.port}" return self.hostname def __str__(self) -> str: scheme, path, query, fragment, username, password, hostname, port = self url = "" if scheme: url += f"{scheme}://" if password and username: url += f"{username}:{password}@" if hostname: url += hostname if port: url += f":{port}" if path: url += path if query: url += f"?{query}" if fragment: url += f"#{fragment}" return url def as_dict(self) -> dict[str, str | None]: """Provide a public interface for namedtuple's _asdict""" return self._asdict() def replace(self, **kwargs) -> Self: """Provide a public interface for namedtuple's _replace""" return self._replace(**kwargs) @classmethod def from_parse_result(cls, parse_result: ParseResult) -> Self: values = {fld: getattr(parse_result, fld, "") for fld in url_attrs} return cls(**values) @cache def urlparse(url: str) -> Url: if on_win and url.startswith("file:"): url.replace("\\", "/") # Allows us to pass in strings like 'example.com:8080/path/1'. if not has_scheme(url): url = "//" + url return Url.from_parse_result(_urlparse(url)) def url_to_s3_info(url: str) -> tuple[str, str]: """Convert an s3 url to a tuple of bucket and key. Examples: >>> url_to_s3_info("s3://bucket-name.bucket/here/is/the/key") ('bucket-name.bucket', '/here/is/the/key') """ parsed_url = urlparse(url) if parsed_url.scheme != "s3": raise ValueError(f"You can only use s3: urls (not {url!r})") bucket, key = parsed_url.hostname, parsed_url.path return bucket, key def is_url(url: Any) -> bool: """ Examples: >>> is_url(None) False >>> is_url("s3://some/bucket") True """ if not url: return False try: return urlparse(url).scheme != "" except ValueError: return False def is_ipv4_address(string_ip: str) -> bool: """ Examples: >>> [is_ipv4_address(ip) for ip in ('8.8.8.8', '192.168.10.10', '255.255.255.255')] [True, True, True] >>> [is_ipv4_address(ip) for ip in ('8.8.8', '192.168.10.10.20', '256.255.255.255', '::1')] [False, False, False, False] """ try: socket.inet_aton(string_ip) except OSError: return False return string_ip.count(".") == 3 def is_ipv6_address(string_ip: str) -> bool: """ Examples: >> [is_ipv6_address(ip) for ip in ('::1', '2001:db8:85a3::370:7334', '1234:'*7+'1234')] [True, True, True] >> [is_ipv6_address(ip) for ip in ('192.168.10.10', '1234:'*8+'1234')] [False, False] """ try: socket.inet_pton(socket.AF_INET6, string_ip) except OSError: return False return True def is_ip_address(string_ip: str) -> bool: """ Examples: >> is_ip_address('192.168.10.10') True >> is_ip_address('::1') True >> is_ip_address('www.google.com') False """ return is_ipv4_address(string_ip) or is_ipv6_address(string_ip) def join(*args: str): start = "/" if not args[0] or args[0].startswith("/") else "" return start + "/".join(y for y in (x.strip("/") for x in args if x) if y) join_url = join def has_scheme(value: str) -> bool: return re.match(r"[a-z][a-z0-9]{0,11}://", value) def strip_scheme(url: str) -> str: """ Examples: >>> strip_scheme("https://www.conda.io") 'www.conda.io' >>> strip_scheme("s3://some.bucket/plus/a/path.ext") 'some.bucket/plus/a/path.ext' """ return url.split("://", 1)[-1] def mask_anaconda_token(url: str) -> str: _, token = split_anaconda_token(url) return url.replace(token, "", 1) if token else url def split_anaconda_token(url: str): """ Examples: >>> split_anaconda_token("https://1.2.3.4/t/tk-123-456/path") (u'https://1.2.3.4/path', u'tk-123-456') >>> split_anaconda_token("https://1.2.3.4/t//path") (u'https://1.2.3.4/path', u'') >>> split_anaconda_token("https://some.domain/api/t/tk-123-456/path") (u'https://some.domain/api/path', u'tk-123-456') >>> split_anaconda_token("https://1.2.3.4/conda/t/tk-123-456/path") (u'https://1.2.3.4/conda/path', u'tk-123-456') >>> split_anaconda_token("https://1.2.3.4/path") (u'https://1.2.3.4/path', None) >>> split_anaconda_token("https://10.2.3.4:8080/conda/t/tk-123-45") (u'https://10.2.3.4:8080/conda', u'tk-123-45') """ _token_match = re.search(r"/t/([a-zA-Z0-9-]*)", url) token = _token_match.groups()[0] if _token_match else None cleaned_url = url.replace("/t/" + token, "", 1) if token is not None else url return cleaned_url.rstrip("/"), token def split_platform(known_subdirs: Iterable[str], url: str) -> tuple[str, str]: """ Examples: >>> from conda.base.constants import KNOWN_SUBDIRS >>> split_platform(KNOWN_SUBDIRS, "https://1.2.3.4/t/tk-123/linux-ppc64le/path") (u'https://1.2.3.4/t/tk-123/path', u'linux-ppc64le') """ _platform_match = _split_platform_re(known_subdirs).search(url) platform = _platform_match.groups()[0] if _platform_match else None cleaned_url = url.replace("/" + platform, "", 1) if platform is not None else url return cleaned_url.rstrip("/"), platform @cache def _split_platform_re(known_subdirs: Iterable[str]) -> Pattern[str]: _platform_match_regex = r"/({})(?:/|$)".format( r"|".join(rf"{d}" for d in known_subdirs) ) return re.compile(_platform_match_regex, re.IGNORECASE) def has_platform(url: str, known_subdirs: Iterable[str]) -> bool | None: url_no_package_name, _ = split_filename(url) if not url_no_package_name: return None maybe_a_platform = url_no_package_name.rsplit("/", 1)[-1] return maybe_a_platform in known_subdirs and maybe_a_platform or None def split_scheme_auth_token( url: str, ) -> tuple[str | None, str | None, str | None, str | None]: """ Examples: >>> split_scheme_auth_token("https://u:p@conda.io/t/x1029384756/more/path") ('conda.io/more/path', 'https', 'u:p', 'x1029384756') >>> split_scheme_auth_token(None) (None, None, None, None) """ if not url: return None, None, None, None cleaned_url, token = split_anaconda_token(url) url_parts = urlparse(cleaned_url) remainder_url = Url( hostname=url_parts.hostname, port=url_parts.port, path=url_parts.path, query=url_parts.query, ) return str(remainder_url), url_parts.scheme, url_parts.auth, token class _SplitUrlParts(NamedTuple): scheme: str | None auth: str | None token: str | None platform: str | None package_filename: str | None hostname: str | None port: str | None path: str | None query: str | None def split_conda_url_easy_parts( known_subdirs: Iterable[str], url: str ) -> _SplitUrlParts: # scheme, auth, token, platform, package_filename, host, port, path, query cleaned_url, token = split_anaconda_token(url) cleaned_url, platform = split_platform(known_subdirs, cleaned_url) _, ext = strip_pkg_extension(cleaned_url) cleaned_url, package_filename = ( cleaned_url.rsplit("/", 1) if ext and "/" in cleaned_url else (cleaned_url, None) ) # TODO: split out namespace using regex url_parts = urlparse(cleaned_url) return _SplitUrlParts( url_parts.scheme, url_parts.auth, token, platform, package_filename, url_parts.hostname, url_parts.port, url_parts.path, url_parts.query, ) @cache def get_proxy_username_and_pass(scheme: str) -> tuple[str, str]: username = input(f"\n{scheme} proxy username: ") passwd = getpass("Password: ") return username, passwd def add_username_and_password(url: str, username: str, password: str) -> str: """ Inserts `username` and `password` into provided `url` >>> add_username_and_password('https://anaconda.org', 'TestUser', 'Password') 'https://TestUser:Password@anaconda.org' """ url = urlparse(url) url_with_auth = url.replace(username=username, password=quote(password, safe="")) return str(url_with_auth) def maybe_add_auth(url: str, auth: str, force: bool = False) -> str: """Add auth if the url doesn't currently have it. By default, does not replace auth if it already exists. Setting ``force`` to ``True`` overrides this behavior. Examples: >>> maybe_add_auth("https://www.conda.io", "user:passwd") 'https://user:passwd@www.conda.io' >>> maybe_add_auth("https://www.conda.io", "") 'https://www.conda.io' """ if not auth: return url url_parts = urlparse(url) if url_parts.username and url_parts.password and not force: return url auth_parts = auth.split(":") if len(auth_parts) > 1: url_parts = url_parts.replace(username=auth_parts[0], password=auth_parts[1]) return str(url_parts) def maybe_unquote(url: str) -> str: return unquote_plus(remove_auth(url)) if url else url def remove_auth(url: str) -> str: """Remove embedded authentication from URL. .. code-block:: pycon >>> remove_auth("https://user:password@anaconda.com") 'https://anaconda.com' """ url = urlparse(url) url_no_auth = url.replace(username="", password="") return str(url_no_auth)