The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all our adapter.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
RequestAdapterBase
Bases: HTTPAdapter
Extends the built-in HTTP adapater and acts as a base for all our own
adapter.
Source code in PyFunceble/query/requests/adapter/base.py
| class RequestAdapterBase(requests.adapters.HTTPAdapter):
"""
Extends the built-in HTTP adapater and acts as a base for all our own
adapter.
"""
resolving_cache: dict = {}
resolving_use_cache: bool = False
timeout: float = 5.0
proxy_pattern: dict = {}
def __init__(self, *args, **kwargs):
if "timeout" in kwargs:
self.timeout = float(kwargs["timeout"])
del kwargs["timeout"]
if "max_retries" in kwargs:
kwargs["max_retries"] = requests.adapters.Retry(
total=kwargs["max_retries"], respect_retry_after_header=False
)
if "dns_query_tool" in kwargs:
self.dns_query_tool = kwargs["dns_query_tool"]
del kwargs["dns_query_tool"]
else:
self.dns_query_tool = DNSQueryTool()
if "proxy_pattern" in kwargs:
self.proxy_pattern = kwargs["proxy_pattern"]
del kwargs["proxy_pattern"]
else:
self.proxy_pattern = {}
super().__init__(*args, **kwargs)
@staticmethod
def fake_response() -> requests.models.Response:
"""
Provides the fake response that is provided when we couldn't resolve the
given domain.
"""
raise PyFunceble.factory.Requester.exceptions.ConnectionError(
"Could not resolve."
)
@staticmethod
def extract_extension(subject: str) -> Optional[str]:
"""
Provides the extension of the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject does not have a `.` (point).
:param str subject:
The subject to get extract the extension from.
:raise TypeError:
When the given :code:`subject` is not a :py:class:`str`.
:raise ValueError:
When the given :code:`subject` is an empty :py:class:`str`.
"""
if not subject or "." not in subject:
return None
if subject.endswith("."):
# Absolute needs a little correction.
last_point = subject[:-1].rfind(".")
else:
last_point = subject.rindex(".")
extension = subject[last_point + 1 :]
if extension.endswith("."):
return extension[:-1]
return extension
def fetch_proxy_from_pattern(self, subject: str) -> dict:
"""
Provides the proxy settings to use for the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject has no extension/TLD.
:param str subject:
The subject to work with.
:raise TypeError:
When the given :code:`subject` is not a :py:class:`str`.
:raise ValueError:
When the given :code:`subject` is an empty :py:class:`str`.
"""
def correct_input(pattern_input: dict) -> dict:
result = {}
if "http" in pattern_input and pattern_input["http"]:
result["http"] = pattern_input["http"]
if "https" in pattern_input and pattern_input["https"]:
result["https"] = pattern_input["https"]
if "http" in result and "https" not in result:
result["https"] = result["http"]
if "https" in result and "http" not in result:
result["http"] = result["https"]
return result
extension = self.extract_extension(subject)
proxies = {}
if extension and "rules" in self.proxy_pattern:
for rule in self.proxy_pattern["rules"]:
local_proxy = {}
if "http" in rule and rule["http"]:
local_proxy["http"] = rule["http"]
if "https" in rule and rule["https"]:
local_proxy["https"] = rule["https"]
if not local_proxy:
continue
if "tld" in rule and extension in rule["tld"]:
proxies = correct_input(local_proxy)
break
if not proxies and "global" in self.proxy_pattern:
proxies = correct_input(self.proxy_pattern["global"])
return proxies
def resolve_with_cache(self, hostname: str) -> Optional[str]:
"""
Try to resolve using an internal cache.
"""
if hostname not in self.resolving_cache:
self.resolving_cache[hostname] = self.resolve_without_cache(hostname)
return self.resolving_cache[hostname]
def resolve_without_cache(self, hostname: str) -> Optional[str]:
"""
Resolves the IP of the given hostname.
:param hostname:
The hostname to get resolve.
"""
def get_last_cname(subject: str, recursion_depth: int = 60) -> Optional[str]:
"""
Given a subject, this function tries to query the CNAME until there
is none.
:param subject:
The first subject.
"""
last_cname_result = []
last_cname_new_subject = subject
depth = 0
while depth < recursion_depth:
local_last_cname_result = (
self.dns_query_tool.set_query_record_type("CNAME")
.set_subject(last_cname_new_subject)
.query()
)
depth += 1
if any(x in last_cname_result for x in local_last_cname_result):
break
last_cname_result.extend(local_last_cname_result)
if local_last_cname_result:
last_cname_new_subject = local_last_cname_result[0]
else:
break
try:
return last_cname_result[-1]
except IndexError:
return None
result = set()
if not IPSyntaxChecker(hostname).is_valid():
last_cname = get_last_cname(hostname)
if last_cname:
result.update(
self.dns_query_tool.set_query_record_type("A")
.set_subject(last_cname)
.query()
)
else:
result.update(
self.dns_query_tool.set_query_record_type("A")
.set_subject(hostname)
.query()
)
else:
result.add(hostname)
if result:
return result.pop()
return None
def resolve(self, hostname: str) -> Optional[str]:
"""
Resolves with the prefered method.
"""
if hostname:
if self.resolving_use_cache:
return self.resolve_with_cache(hostname)
return self.resolve_without_cache(hostname)
return None
|
Provides the extension of the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject does not have a .
(point).
Parameters:
Name |
Type |
Description |
Default |
subject
|
str
|
The subject to get extract the extension from.
|
required
|
Raises:
Type |
Description |
TypeError
|
When the given :code:subject is not a class:str .
|
ValueError
|
When the given :code:subject is an empty class:str .
|
Source code in PyFunceble/query/requests/adapter/base.py
| @staticmethod
def extract_extension(subject: str) -> Optional[str]:
"""
Provides the extension of the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject does not have a `.` (point).
:param str subject:
The subject to get extract the extension from.
:raise TypeError:
When the given :code:`subject` is not a :py:class:`str`.
:raise ValueError:
When the given :code:`subject` is an empty :py:class:`str`.
"""
if not subject or "." not in subject:
return None
if subject.endswith("."):
# Absolute needs a little correction.
last_point = subject[:-1].rfind(".")
else:
last_point = subject.rindex(".")
extension = subject[last_point + 1 :]
if extension.endswith("."):
return extension[:-1]
return extension
|
fake_response()
staticmethod
Provides the fake response that is provided when we couldn't resolve the
given domain.
Source code in PyFunceble/query/requests/adapter/base.py
| @staticmethod
def fake_response() -> requests.models.Response:
"""
Provides the fake response that is provided when we couldn't resolve the
given domain.
"""
raise PyFunceble.factory.Requester.exceptions.ConnectionError(
"Could not resolve."
)
|
fetch_proxy_from_pattern(subject)
Provides the proxy settings to use for the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject has no extension/TLD.
Parameters:
Name |
Type |
Description |
Default |
subject
|
str
|
The subject to work with.
|
required
|
Raises:
Type |
Description |
TypeError
|
When the given :code:subject is not a class:str .
|
ValueError
|
When the given :code:subject is an empty class:str .
|
Source code in PyFunceble/query/requests/adapter/base.py
| def fetch_proxy_from_pattern(self, subject: str) -> dict:
"""
Provides the proxy settings to use for the given subject.
.. versionchanged:: 4.1.1.dev
Handle the case that the given subject has no extension/TLD.
:param str subject:
The subject to work with.
:raise TypeError:
When the given :code:`subject` is not a :py:class:`str`.
:raise ValueError:
When the given :code:`subject` is an empty :py:class:`str`.
"""
def correct_input(pattern_input: dict) -> dict:
result = {}
if "http" in pattern_input and pattern_input["http"]:
result["http"] = pattern_input["http"]
if "https" in pattern_input and pattern_input["https"]:
result["https"] = pattern_input["https"]
if "http" in result and "https" not in result:
result["https"] = result["http"]
if "https" in result and "http" not in result:
result["http"] = result["https"]
return result
extension = self.extract_extension(subject)
proxies = {}
if extension and "rules" in self.proxy_pattern:
for rule in self.proxy_pattern["rules"]:
local_proxy = {}
if "http" in rule and rule["http"]:
local_proxy["http"] = rule["http"]
if "https" in rule and rule["https"]:
local_proxy["https"] = rule["https"]
if not local_proxy:
continue
if "tld" in rule and extension in rule["tld"]:
proxies = correct_input(local_proxy)
break
if not proxies and "global" in self.proxy_pattern:
proxies = correct_input(self.proxy_pattern["global"])
return proxies
|
resolve(hostname)
Resolves with the prefered method.
Source code in PyFunceble/query/requests/adapter/base.py
| def resolve(self, hostname: str) -> Optional[str]:
"""
Resolves with the prefered method.
"""
if hostname:
if self.resolving_use_cache:
return self.resolve_with_cache(hostname)
return self.resolve_without_cache(hostname)
return None
|
resolve_with_cache(hostname)
Try to resolve using an internal cache.
Source code in PyFunceble/query/requests/adapter/base.py
| def resolve_with_cache(self, hostname: str) -> Optional[str]:
"""
Try to resolve using an internal cache.
"""
if hostname not in self.resolving_cache:
self.resolving_cache[hostname] = self.resolve_without_cache(hostname)
return self.resolving_cache[hostname]
|
resolve_without_cache(hostname)
Resolves the IP of the given hostname.
Parameters:
Name |
Type |
Description |
Default |
hostname
|
str
|
The hostname to get resolve.
|
required
|
Source code in PyFunceble/query/requests/adapter/base.py
| def resolve_without_cache(self, hostname: str) -> Optional[str]:
"""
Resolves the IP of the given hostname.
:param hostname:
The hostname to get resolve.
"""
def get_last_cname(subject: str, recursion_depth: int = 60) -> Optional[str]:
"""
Given a subject, this function tries to query the CNAME until there
is none.
:param subject:
The first subject.
"""
last_cname_result = []
last_cname_new_subject = subject
depth = 0
while depth < recursion_depth:
local_last_cname_result = (
self.dns_query_tool.set_query_record_type("CNAME")
.set_subject(last_cname_new_subject)
.query()
)
depth += 1
if any(x in last_cname_result for x in local_last_cname_result):
break
last_cname_result.extend(local_last_cname_result)
if local_last_cname_result:
last_cname_new_subject = local_last_cname_result[0]
else:
break
try:
return last_cname_result[-1]
except IndexError:
return None
result = set()
if not IPSyntaxChecker(hostname).is_valid():
last_cname = get_last_cname(hostname)
if last_cname:
result.update(
self.dns_query_tool.set_query_record_type("A")
.set_subject(last_cname)
.query()
)
else:
result.update(
self.dns_query_tool.set_query_record_type("A")
.set_subject(hostname)
.query()
)
else:
result.add(hostname)
if result:
return result.pop()
return None
|