--- a/src/eric7/EricNetwork/EricTldExtractor.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/EricNetwork/EricTldExtractor.py Wed Jul 13 14:55:47 2022 +0200
@@ -24,6 +24,7 @@
"""
Class implementing the host parts helper.
"""
+
def __init__(self):
"""
Constructor
@@ -38,43 +39,44 @@
class EricTldExtractor(QObject):
"""
Class implementing the TLD Extractor.
-
+
Note: The module function instance() should be used to get a reference
to a global object to avoid overhead.
"""
+
def __init__(self, withPrivate=False, parent=None):
"""
Constructor
-
+
@param withPrivate flag indicating to load private TLDs as well
@type bool
@param parent reference to the parent object
@type QObject
"""
super().__init__(parent)
-
+
self.__withPrivate = withPrivate
self.__dataFileName = ""
self.__dataSearchPaths = []
-
+
self.__tldDict = collections.defaultdict(list)
# dict with list of str as values
-
+
self.setDataSearchPaths()
-
+
def isDataLoaded(self):
"""
Public method to check, if the TLD data ia already loaded.
-
+
@return flag indicating data is loaded
@rtype bool
"""
return bool(self.__tldDict)
-
+
def tld(self, host):
"""
Public method to get the top level domain for a host.
-
+
@param host host name to get TLD for
@type str
@return TLD for host
@@ -82,118 +84,118 @@
"""
if not host or host.startswith("."):
return ""
-
+
cleanHost = self.__normalizedHost(host)
-
- tldPart = cleanHost[cleanHost.rfind(".") + 1:]
+
+ tldPart = cleanHost[cleanHost.rfind(".") + 1 :]
cleanHost = bytes(QUrl.toAce(cleanHost)).decode("utf-8")
-
+
self.__loadData()
-
+
if tldPart not in self.__tldDict:
return tldPart
-
+
tldRules = self.__tldDict[tldPart][:]
-
+
if tldPart not in tldRules:
tldRules.append(tldPart)
-
+
maxLabelCount = 0
isWildcardTLD = False
-
+
for rule in tldRules:
labelCount = rule.count(".") + 1
-
+
if rule.startswith("!"):
rule = rule[1:]
-
+
rule = bytes(QUrl.toAce(rule)).decode("utf-8")
-
+
# matches with exception TLD
if cleanHost.endswith(rule):
- tldPart = rule[rule.find(".") + 1:]
+ tldPart = rule[rule.find(".") + 1 :]
break
-
+
if rule.startswith("*"):
rule = rule[1:]
-
+
if rule.startswith("."):
rule = rule[1:]
-
+
isWildcardTLD = True
else:
isWildcardTLD = False
-
+
rule = bytes(QUrl.toAce(rule)).decode("utf-8")
testRule = "." + rule
testUrl = "." + cleanHost
-
+
if labelCount > maxLabelCount and testUrl.endswith(testRule):
tldPart = rule
maxLabelCount = labelCount
-
+
if isWildcardTLD:
temp = cleanHost
- temp = temp[:temp.rfind(tldPart)]
-
+ temp = temp[: temp.rfind(tldPart)]
+
if temp.endswith("."):
temp = temp[:-1]
-
- temp = temp[temp.rfind(".") + 1:]
-
+
+ temp = temp[temp.rfind(".") + 1 :]
+
if temp:
tldPart = temp + "." + rule
else:
tldPart = rule
-
+
temp = self.__normalizedHost(host)
- tldPart = ".".join(
- temp.split(".")[temp.count(".") - tldPart.count("."):])
-
+ tldPart = ".".join(temp.split(".")[temp.count(".") - tldPart.count(".") :])
+
return tldPart
-
+
def domain(self, host):
"""
Public method to get the domain for a host.
-
+
@param host host name to get the domain for
@type str
@return domain for host
@rtype str
"""
tldPart = self.tld(host)
-
+
return self.__domainHelper(host, tldPart)
-
+
def registrableDomain(self, host):
"""
Public method to get the registrable domain for a host.
-
+
@param host host name to get the registrable domain for
@type str
@return registrable domain for host
@rtype str
"""
tldPart = self.tld(host)
-
+
return self.__registrableDomainHelper(
- self.__domainHelper(host, tldPart), tldPart)
-
+ self.__domainHelper(host, tldPart), tldPart
+ )
+
def subdomain(self, host):
"""
Public method to get the subdomain for a host.
-
+
@param host host name to get the subdomain for
@type str
@return subdomain for host
@rtype str
"""
return self.__subdomainHelper(host, self.registrableDomain(host))
-
+
def splitParts(self, host):
"""
Public method to split a host address into its parts.
-
+
@param host host address to be split
@type str
@return splitted host address
@@ -204,25 +206,25 @@
hostParts.tld = self.tld(host)
hostParts.domain = self.__domainHelper(host, hostParts.tld)
hostParts.registrableDomain = self.__registrableDomainHelper(
- hostParts.domain, hostParts.tld)
- hostParts.subdomain = self.__subdomainHelper(
- host, hostParts.registrableDomain)
-
+ hostParts.domain, hostParts.tld
+ )
+ hostParts.subdomain = self.__subdomainHelper(host, hostParts.registrableDomain)
+
return hostParts
-
+
def dataSearchPaths(self):
"""
Public method to get the search paths for the TLD data file.
-
+
@return search paths for the TLD data file
@rtype list of str
"""
return self.__dataSearchPaths[:]
-
+
def setDataSearchPaths(self, searchPaths=None):
"""
Public method to set the search paths for the TLD data file.
-
+
@param searchPaths search paths for the TLD data file or None,
if the default search paths shall be set
@type list of str
@@ -232,44 +234,45 @@
self.__dataSearchPaths.extend(self.__defaultDataSearchPaths())
else:
self.__dataSearchPaths = self.__defaultDataSearchPaths()[:]
-
+
# remove duplicates
paths = []
for p in self.__dataSearchPaths:
if p not in paths:
paths.append(p)
self.__dataSearchPaths = paths
-
+
def __defaultDataSearchPaths(self):
"""
Private method to get the default search paths for the TLD data file.
-
+
@return default search paths for the TLD data file
@rtype list of str
"""
return [os.path.join(os.path.dirname(__file__), "data")]
-
+
def getTldDownloadUrl(self):
"""
Public method to get the TLD data file download URL.
-
+
@return download URL
@rtype QUrl
"""
return QUrl(
"http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/"
- "effective_tld_names.dat?raw=1")
-
+ "effective_tld_names.dat?raw=1"
+ )
+
def __loadData(self):
"""
Private method to load the TLD data.
"""
if self.isDataLoaded():
return
-
+
dataFileName = ""
parsedDataFileExist = False
-
+
for searchPath in self.__dataSearchPaths:
dataFileName = os.path.abspath(
os.path.join(searchPath, "effective_tld_names.dat")
@@ -277,7 +280,7 @@
if os.path.exists(dataFileName):
parsedDataFileExist = True
break
-
+
if not parsedDataFileExist:
tldDataFileDownloadLink = (
"http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/"
@@ -286,27 +289,30 @@
EricMessageBox.information(
None,
self.tr("TLD Data File not found"),
- self.tr("""<p>The file 'effective_tld_names.dat' was not"""
- """ found!<br/>You can download it from """
- """'<a href="{0}"><b>here</b></a>' to one of the"""
- """ following paths:</p><ul>{1}</ul>""").format(
+ self.tr(
+ """<p>The file 'effective_tld_names.dat' was not"""
+ """ found!<br/>You can download it from """
+ """'<a href="{0}"><b>here</b></a>' to one of the"""
+ """ following paths:</p><ul>{1}</ul>"""
+ ).format(
tldDataFileDownloadLink,
- "".join(["<li>{0}</li>".format(p)
- for p in self.__dataSearchPaths]))
+ "".join(["<li>{0}</li>".format(p) for p in self.__dataSearchPaths]),
+ ),
)
return
-
+
self.__dataFileName = dataFileName
- if not self.__parseData(dataFileName,
- loadPrivateDomains=self.__withPrivate):
+ if not self.__parseData(dataFileName, loadPrivateDomains=self.__withPrivate):
qWarning(
- "EricTldExtractor: There are some parse errors for file: {0}"
- .format(dataFileName))
-
+ "EricTldExtractor: There are some parse errors for file: {0}".format(
+ dataFileName
+ )
+ )
+
def __parseData(self, dataFile, loadPrivateDomains=False):
"""
Private method to parse TLD data.
-
+
@param dataFile name of the file containing the TLD data
@type str
@param loadPrivateDomains flag indicating to load private domains
@@ -316,50 +322,50 @@
"""
# start with a fresh dictionary
self.__tldDict = collections.defaultdict(list)
-
+
seekToEndOfPrivateDomains = False
-
+
try:
with open(dataFile, "r", encoding="utf-8") as f:
for line in f.readlines():
if not line:
continue
-
+
if line.startswith("."):
line = line[1:]
-
+
if line.startswith("//"):
if "===END PRIVATE DOMAINS===" in line:
seekToEndOfPrivateDomains = False
-
+
if (
- not loadPrivateDomains and
- "===BEGIN PRIVATE DOMAINS===" in line
+ not loadPrivateDomains
+ and "===BEGIN PRIVATE DOMAINS===" in line
):
seekToEndOfPrivateDomains = True
-
+
continue
-
+
if seekToEndOfPrivateDomains:
continue
-
+
# only data up to the first whitespace is used
line = line.split(None, 1)[0]
-
+
if "." not in line:
self.__tldDict[line].append(line)
else:
- key = line[line.rfind(".") + 1:]
+ key = line[line.rfind(".") + 1 :]
self.__tldDict[key].append(line)
-
+
return self.isDataLoaded()
except OSError:
return False
-
+
def __domainHelper(self, host, tldPart):
"""
Private method to get the domain name without TLD.
-
+
@param host host address
@type str
@param tldPart TLD part of the host address
@@ -369,19 +375,19 @@
"""
if not host or not tldPart:
return ""
-
+
temp = self.__normalizedHost(host)
- temp = temp[:temp.rfind(tldPart)]
-
+ temp = temp[: temp.rfind(tldPart)]
+
if temp.endswith("."):
temp = temp[:-1]
-
- return temp[temp.rfind(".") + 1:]
-
+
+ return temp[temp.rfind(".") + 1 :]
+
def __registrableDomainHelper(self, domainPart, tldPart):
"""
Private method to get the registrable domain (i.e. domain plus TLD).
-
+
@param domainPart domain part of a host address
@type str
@param tldPart TLD part of a host address
@@ -393,12 +399,12 @@
return ""
else:
return "{0}.{1}".format(domainPart, tldPart)
-
+
def __subdomainHelper(self, host, registrablePart):
"""
Private method to get the subdomain of a host address (i.e. domain part
without the registrable domain name).
-
+
@param host host address
@type str
@param registrablePart registrable domain part of the host address
@@ -408,20 +414,20 @@
"""
if not host or not registrablePart:
return ""
-
+
subdomain = self.__normalizedHost(host)
-
- subdomain = subdomain[:subdomain.rfind(registrablePart)]
-
+
+ subdomain = subdomain[: subdomain.rfind(registrablePart)]
+
if subdomain.endswith("."):
subdomain = subdomain[:-1]
-
+
return subdomain
-
+
def __normalizedHost(self, host):
"""
Private method to get the normalized host for a host address.
-
+
@param host host address to be normalized
@type str
@return normalized host address
@@ -437,15 +443,15 @@
"""
Global function to get a reference to the TLD extractor and create it, if
it hasn't been yet.
-
+
@param withPrivate flag indicating to load private TLDs as well
@type bool
@return reference to the zoom manager object
@rtype EricTldExtractor
"""
global _TLDExtractor
-
+
if _TLDExtractor is None:
_TLDExtractor = EricTldExtractor(withPrivate=withPrivate)
-
+
return _TLDExtractor
