"""
The tool to check the availability or syntax of domains, IPv4, IPv6 or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the mining engine.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/special-thanks.html
Contributors:
https://pyfunceble.github.io/contributors.html
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://pyfunceble.readthedocs.io///en/master/
Project homepage:
https://pyfunceble.github.io/
License:
::
MIT License
Copyright (c) 2017, 2018, 2019, 2020 Nissar Chababy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
import socket
from hashlib import sha256
import urllib3.exceptions as urllib3_exceptions
import PyFunceble
[docs]class Mining: # pylint: disable=too-many-instance-attributes
"""
Manages the minig subsystem.
"""
database = {}
is_subject_present_cache = {}
database_file = None
authorized = False
filename = None
headers = {}
def __init__(self, filename, parent_process=False): # pragma: no cover
# We get the authorization to operate.
self.authorized = self.authorization()
self.database_file = ""
# We save the file we are working with.
self.filename = filename
# Se create the current file namespace.
self.database[self.filename] = {}
# We share the state.
self.parent = parent_process
self.table_name = self.get_table_name()
PyFunceble.LOGGER.debug(f"Authorization: {self.authorized}")
PyFunceble.LOGGER.debug(f"Table Name: {self.table_name}")
user_agent = PyFunceble.engine.UserAgent().get()
if user_agent:
# The user-agent is given.
# We append the user agent to the header we are going to parse with
# the request.
self.headers = {"User-Agent": user_agent}
if self.authorized:
# We are authorized to operate.
if PyFunceble.CONFIGURATION.db_type == "json":
# We get the file we are going to save our data.
self.database_file = (
PyFunceble.CONFIG_DIRECTORY
+ PyFunceble.OUTPUTS.default_files.mining
)
PyFunceble.LOGGER.debug(f"DB (File): {self.database_file}")
self.load()
def __getitem__(self, index):
if self.authorized:
if PyFunceble.CONFIGURATION.db_type == "json":
if index in self.database[self.filename]:
return self.database[self.filename][index]
if PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
query = (
"SELECT * "
"FROM {0} "
"WHERE file_path = %(file)s "
"AND subject = %(subject)s "
).format(self.table_name)
with PyFunceble.engine.MySQL() as connection, connection.cursor() as cursor:
cursor.execute(query, {"file": self.filename, "subject": index})
fetched = cursor.fetchall()
if fetched:
return [x["mined"] for x in fetched]
return None
def __setitem__(self, index, value): # pylint: disable=too-many-branches
if self.authorized:
if PyFunceble.CONFIGURATION.db_type == "json":
actual_value = self[index]
if actual_value:
if isinstance(actual_value, dict):
if isinstance(value, dict): # pragma: no cover
self.database[self.filename][index].update(value)
else: # pragma: no cover
self.database[self.filename][index] = value
elif isinstance(actual_value, list):
if isinstance(value, list):
self.database[self.filename][index].extend(value)
else: # pragma: no cover
self.database[self.filename][index].append(value)
else: # pragma: no cover
self.database[self.filename][index] = value
else:
if self.filename not in self.database: # pragma: no cover
self.database[self.filename] = {}
self.database[self.filename][index] = value
PyFunceble.LOGGER.info(
f"Inserted {repr(value)} into the subset of {repr(index)}"
)
elif PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
query = (
"INSERT INTO {0} "
"(file_path, subject, mined, digest) "
"VALUES (%(file)s, %(subject)s, %(mined)s, %(digest)s)"
).format(self.table_name)
with PyFunceble.engine.MySQL() as connection, connection.cursor() as cursor:
for val in value:
digest = sha256(
bytes(self.filename + index + val, "utf-8")
).hexdigest()
playload = {
"file": self.filename,
"subject": index,
"mined": val,
"digest": digest,
}
try:
cursor.execute(query, playload)
PyFunceble.LOGGER.info(
f"Inserted into the database: \n {playload}"
)
except PyFunceble.engine.MySQL.errors:
pass
def __delitem__(self, index): # pragma: no cover
if self.authorized:
if PyFunceble.CONFIGURATION.db_type == "json":
actual_value = self[index]
if actual_value:
del self.database[self.filename][index]
PyFunceble.LOGGER.info(
"Cleaned the data related to "
f"{repr(index)} and {repr(self.filename)} "
f"from the database."
)
elif PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
query = (
"DELETE FROM {0} "
"WHERE file_path = %(file)s "
"AND subject = %(subject)s "
).format(self.table_name)
with PyFunceble.engine.MySQL() as connection, connection.cursor() as cursor:
cursor.execute(query, {"file": self.filename, "subject": index})
PyFunceble.LOGGER.info(
"Cleaned the data related to "
f"{repr(index)} and {repr(self.filename)} "
f"from the {repr(self.table_name)} table."
)
[docs] @classmethod
def authorization(cls):
"""
Provides the operation authorization.
"""
return PyFunceble.CONFIGURATION.mining
[docs] @classmethod
def get_history(cls, url): # pragma: no cover
"""
Gets the history of the given url.
:param str url: An URL to call.
:return: The list of links.
:rtype: list
"""
try:
return PyFunceble.REQUESTS.get(
url,
headers=cls.headers,
timeout=PyFunceble.CONFIGURATION.timeout,
verify=PyFunceble.CONFIGURATION.verify_ssl_certificate,
allow_redirects=True,
).history
except (
PyFunceble.REQUESTS.exceptions.ConnectionError,
PyFunceble.REQUESTS.exceptions.Timeout,
PyFunceble.REQUESTS.exceptions.InvalidURL,
socket.timeout,
urllib3_exceptions.InvalidHeader,
UnicodeDecodeError, # The probability that this happend in production is minimal.
):
PyFunceble.LOGGER.exception()
return []
[docs] @classmethod
def get_table_name(cls):
"""
Returns the name of the table to use.
"""
if PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
return PyFunceble.engine.MySQL.tables["mining"]
return "mining"
[docs] def list_of_mined(self):
"""
Provides the list of mined domains so that they can
be tested.
:return:
The list of mined domains.
The returned format is the following:
::
[
(index_to_delete_after_test, mined),
(index_to_delete_after_test, mined),
(index_to_delete_after_test, mined)
]
:rtype: list
"""
PyFunceble.LOGGER.info(
"Getting the list of previously mined data. (DATASET WONT BE LOGGED)"
)
# We initiate a variable which will return the result.
result = []
if self.authorized:
# We are authorized to operate.
if PyFunceble.CONFIGURATION.db_type == "json":
for subject in self.database[self.filename].keys():
# We loop through the available list of status
# from the database.
for element in self[subject]:
# We then loop through the data associatied to
# the currently read status.
result.append((subject, element))
elif PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
query = "SELECT * FROM {0} WHERE file_path = %(file)s".format(
self.table_name
)
with PyFunceble.engine.MySQL() as connection, connection.cursor() as cursor:
cursor.execute(query, {"file": self.filename})
# We return the result.
return result
[docs] def load(self):
"""
Loads the content of the database file.
"""
if self.authorized and PyFunceble.CONFIGURATION.db_type == "json":
# We are authorized to operate.
if PyFunceble.helpers.File(self.database_file).exists():
# The database file exists.
# We update the database with the content of the file.
self.database.update(
PyFunceble.helpers.Dict().from_json_file(self.database_file)
)
PyFunceble.LOGGER.info(
"Database content loaded in memory. (DATASET WONT BE LOGGED)"
)
[docs] def save(self):
"""
Saves the content of the database into the database file.
"""
if (
self.authorized
and self.parent
and PyFunceble.CONFIGURATION.db_type == "json"
):
# We are authorized to operate.
# We save the database into the file.
PyFunceble.helpers.Dict(self.database).to_json_file(self.database_file)
PyFunceble.LOGGER.info(f"Saved database into {repr(self.database_file)}.")
# pylint: disable=too-many-branches
[docs] def mine(self, subject, subject_type): # pragma: no cover
"""
Searches for domain or URL related to the original URL or domain.
If some are found, we add them into the database.
:param str subject: The subject we are working with.
:param str subject_typ:
The type of the subject.
Can me one of the following:
- :code:`url`
- :code:`domain`
"""
if self.authorized and not self[subject]:
# We are authorized to operate.
PyFunceble.LOGGER.info("Starting mining logic..")
if subject_type == "domain":
to_get = "http://{0}:80".format(subject)
elif subject_type == "url":
to_get = subject
else:
raise ValueError("Unknown subject type {0}".format(repr(subject_type)))
history = self.get_history(to_get)
PyFunceble.LOGGER.debug(f"(Not processed) Mined:\n{history}")
for element in history:
# We loop through the list of requests history.
# We get the url from the currently read
# request.
url = element.url
# We create a variable which will save the
# local result.
local_result = None
if subject_type == "domain":
# We are working with domains.
# We validate and get the base of the URL we
# are working with.
local_result = PyFunceble.Check(url).is_url(return_base=True)
elif subject_type == "url":
# We are working with URLs.
# We validate and get the full URL.
local_result = PyFunceble.Check(url).is_url(
return_base=False, return_formatted=True
)
if local_result:
# The subject type is domain.
PyFunceble.LOGGER.debug(
f"{local_result} was successfully validated. "
"Removing possible Ports."
)
if subject_type == "domain":
# We are working with domain.
if local_result.endswith(":80"):
# The 80 port is present.
# We remove it.
local_result = local_result[: local_result.find(":80")]
elif local_result.endswith(":443"):
# The 443 port is present.
# We remove it.
local_result = local_result[: local_result.find(":443")]
if local_result != subject:
# The local result is differnt from the
# subject we are working with.
PyFunceble.LOGGER.debug(
f"Saving {repr(local_result)} into the subset of {repr(subject)}."
)
# We save into the database.
self[subject] = [local_result]
# We save the database.
self.save()
[docs] def remove(self, subject, history_member):
"""
Removes the given subject from the database assigned to the
currently tested file.
:param str subject: The subject we are working with.
:param str history_member: The history member to delete.
"""
if self.authorized:
while True:
actual_value = self[subject]
if isinstance(actual_value, list) and history_member in actual_value:
if PyFunceble.CONFIGURATION.db_type == "json":
try:
actual_value.remove(history_member)
PyFunceble.LOGGER.info(
f"Removed {repr(history_member)} (mined) "
f"From the subset of {repr(subject)}."
)
except ValueError: # pragma: no cover
pass
elif PyFunceble.CONFIGURATION.db_type in ["mariadb", "mysql"]:
# We construct the query string.
query = (
"DELETE FROM {0} "
"WHERE file_path = %(file)s "
"AND subject = %(subject)s "
"AND mined = %(mined)s"
).format(self.table_name)
with PyFunceble.engine.MySQL() as connection, connection.cursor() as cursor:
cursor.execute(
query,
{
"file": self.filename,
"subject": subject,
"mined": history_member,
},
)
PyFunceble.LOGGER.info(
"Cleaned the data related to "
f"{repr(subject)}, {repr(history_member)} (mined) and "
f"{repr(self.filename)} and from "
f"the {repr(self.table_name)} table."
)
else: # pragma: no cover
break
if not self[subject]: # pragma: no cover
del self[subject]
self.save()