from urllib2 import urlopen
-def get_file_by_url(url):
- try:
- f = urlopen(url)
- return f.read().decode("UTF-8")
- except:
- print("Problem getting file: ", url)
-
-
-def write_data(f, data):
- if PY3:
- f.write(bytes(data, "UTF-8"))
- else:
- f.write(str(data).encode("UTF-8"))
-
-
-def list_dir_no_hidden(path):
- # This function doesn't list hidden files
- return glob(path_join_robust(path, "*"))
-
-
# Project Settings
BASEDIR_PATH = os.path.dirname(os.path.realpath(__file__))
"commonexclusions": ["hulu.com"],
"blacklistfile": path_join_robust(BASEDIR_PATH, "blacklist"),
"whitelistfile": path_join_robust(BASEDIR_PATH, "whitelist")}
+# End Project Settings
def main():
remove_old_hosts_file()
final_file = remove_dups_and_excl(merge_file)
- finalize_file(final_file)
+ write_opening_header(final_file)
+ final_file.close()
if settings["ziphosts"]:
zf = zipfile.ZipFile(path_join_robust(settings["outputsubfolder"],
# Prompt the User
def prompt_for_update():
- # Create hosts file if it doesn't exists
+ """
+ Prompt the user to update all hosts files.
+ """
+
+ # Create hosts file if it doesn't exist.
if not os.path.isfile(path_join_robust(BASEDIR_PATH, "hosts")):
try:
open(path_join_robust(BASEDIR_PATH, "hosts"), "w+").close()
def prompt_for_exclusions():
+ """
+ Prompt the user to exclude any custom domains from being blocked.
+ """
+
prompt = ("Do you want to exclude any domains?\n"
"For example, hulu.com video streaming must be able to access "
"its tracking and ad servers in order to play video.")
def prompt_for_flush_dns_cache():
+ """
+ Prompt the user to flush the DNS cache.
+ """
+
if settings["flushdnscache"]:
flush_dns_cache()
def prompt_for_move(final_file):
+ """
+ Prompt the user to move the newly created hosts file to its designated
+ location in the OS.
+
+ Parameters
+ ----------
+ final_file : file
+ The file object that contains the newly created hosts data.
+ """
+
if settings["replace"] and not settings["skipstatichosts"]:
move_file = True
elif settings["auto"] or settings["skipstatichosts"]:
if move_file:
move_hosts_file_into_place(final_file)
prompt_for_flush_dns_cache()
- else:
- return False
# End Prompt the User
# Exclusion logic
def display_exclusion_options():
+ """
+ Display the exclusion options to the user.
+
+ This function checks whether a user wants to exclude particular domains,
+ and if so, excludes them.
+ """
+
for exclusion_option in settings["commonexclusions"]:
prompt = "Do you want to exclude the domain " + exclusion_option + " ?"
def exclude_domain(domain):
+ """
+ Exclude a domain from being blocked.
+
+ Parameters
+ ----------
+ domain : str
+ The filename or regex pattern to exclude.
+ """
+
settings["exclusionregexs"].append(re.compile(
settings["exclusionpattern"] + domain))
def matches_exclusions(stripped_rule):
+ """
+ Check whether a rule matches an exclusion rule we already provided.
+
+ If this function returns True, that means this rule should be excluded
+ from the final hosts file.
+
+ Parameters
+ ----------
+ stripped_rule : str
+ The rule that we are checking.
+
+ Returns
+ -------
+ matches_exclusion : bool
+ Whether or not the rule string matches a provided exclusion.
+ """
+
stripped_domain = stripped_rule.split()[1]
for exclusionRegex in settings["exclusionregexs"]:
if exclusionRegex.search(stripped_domain):
# Update Logic
def update_all_sources():
- # Update all hosts files regardless of folder depth
+ """
+ Update all host files, regardless of folder depth.
+ """
+
all_sources = recursive_glob("*", settings["sourcedatafilename"])
for source in all_sources:
# File Logic
def create_initial_file():
+ """
+ Initialize the file in which we merge all host files for later pruning.
+ """
+
merge_file = tempfile.NamedTemporaryFile()
# spin the sources for the base file
def remove_dups_and_excl(merge_file):
+ """
+ Remove duplicates and remove hosts that we are excluding.
+
+ We check for duplicate hostnames as well as remove any hostnames that
+ have been explicitly excluded by the user.
+
+ Parameters
+ ----------
+ merge_file : file
+ The file object that contains the hostnames that we are pruning.
+ """
+
number_of_rules = settings["numberofrules"]
if os.path.isfile(settings["whitelistfile"]):
with open(settings["whitelistfile"], "r") as ins:
exclusions = settings["exclusions"]
for line in merge_file.readlines():
- write = "true"
+ write_line = True
# Explicit encoding
line = line.decode("UTF-8")
hostname, normalized_rule = normalize_rule(stripped_rule)
for exclude in exclusions:
if exclude in line:
- write = "false"
+ write_line = False
break
- if (normalized_rule and (hostname not in hostnames)
- and (write == "true")):
+ if normalized_rule and (hostname not in hostnames) and write_line:
write_data(final_file, normalized_rule)
hostnames.add(hostname)
number_of_rules += 1
def normalize_rule(rule):
+ """
+ Standardize and format the rule string provided.
+
+ Parameters
+ ----------
+ rule : str
+ The rule whose spelling and spacing we are standardizing.
+
+ Returns
+ -------
+ normalized_rule : str
+ The rule string with spelling and spacing reformatted.
+ """
+
result = re.search(r'^[ \t]*(\d+\.\d+\.\d+\.\d+)\s+([\w\.-]+)(.*)', rule)
if result:
hostname, suffix = result.group(2, 3)
return None, None
-def finalize_file(final_file):
- write_opening_header(final_file)
- final_file.close()
+def strip_rule(line):
+ """
+ Sanitize a rule string provided before writing it to the output hosts file.
+ Some sources put comments around their rules, for accuracy we need
+ to strip them the comments are preserved in the output hosts file.
+
+ Parameters
+ ----------
+ line : str
+ The rule provided for sanitation.
+
+ Returns
+ -------
+ sanitized_line : str
+ The sanitized rule.
+ """
-# Some sources put comments around their rules, for accuracy we need
-# to strip them the comments are preserved in the output hosts file
-def strip_rule(line):
split_line = line.split()
if len(split_line) < 2:
# just return blank
def write_opening_header(final_file):
+ """
+ Write the header information into the newly-created hosts file.
+
+ Parameters
+ ----------
+ final_file : file
+ The file object that points to the newly-created hosts file.
+ """
+
final_file.seek(0) # reset file pointer
file_contents = final_file.read() # save content
final_file.seek(0) # write at the top
def update_readme_data():
+ """
+ Update the host and website information provided in the README JSON data.
+ """
+
extensions_key = "base"
if settings["extensions"]:
extensions_key = "-".join(settings["extensions"])
print_failure("Unable to determine DNS management tool.")
-# Hotfix since merging with an already existing
-# hosts file leads to artifacts and duplicates
def remove_old_hosts_file():
+ """
+ Remove the old hosts file.
+
+ This is a hotfix because merging with an already existing hosts file leads
+ to artifacts and duplicates.
+ """
+
old_file_path = path_join_robust(BASEDIR_PATH, "hosts")
# create if already removed, so remove wont raise an error
open(old_file_path, "a").close()
# Helper Functions
+def get_file_by_url(url):
+ """
+ Get a file data located at a particular URL.
+
+ Parameters
+ ----------
+ url : str
+ The URL at which to access the data.
+
+ Returns
+ -------
+ url_data : str or None
+ The data retrieved at that URL from the file. Returns None if the
+ attempted retrieval is unsuccessful.
+ """
+
+ try:
+ f = urlopen(url)
+ return f.read().decode("UTF-8")
+ except:
+ print("Problem getting file: ", url)
+
+
+def write_data(f, data):
+ """
+ Write data to a file object. This is a cross-Python implementation.
+
+ Parameters
+ ----------
+ f : file
+ The file object at which to write the data.
+ data : str
+ The data to write to the file.
+ """
+
+ if PY3:
+ f.write(bytes(data, "UTF-8"))
+ else:
+ f.write(str(data).encode("UTF-8"))
+
+
+def list_dir_no_hidden(path):
+ """
+ List all files in a directory, except for hidden files.
+
+ Parameters
+ ----------
+ path : str
+ The path of the directory whose files we wish to list.
+ """
+
+ return glob(os.path.join(path, "*"))
+
+
def query_yes_no(question, default="yes"):
"""
Ask a yes/no question via raw_input() and get answer from the user.
def is_valid_domain_format(domain):
+ """
+ Check whether a provided domain is valid.
+
+ Parameters
+ ----------
+ domain : str
+ The domain against which to check.
+
+ Returns
+ -------
+ valid_domain : bool
+ Whether or not the domain provided is valid.
+ """
+
if domain == "":
print("You didn't enter a domain. Try again.")
return False
return True
-# A version-independent glob( ... "/**/" ... )
def recursive_glob(stem, file_pattern):
+ """
+ Recursively match files in a directory according to a pattern.
+
+ This function is a version-independent of Python 3.x's function:
+
+ glob( ... "/**/" ... )
+
+ Parameters
+ ----------
+ stem : str
+ The directory in which to recurse
+ file_pattern : str
+ The filename regex pattern to which to match.
+
+ Returns
+ -------
+ matches_list : list
+ A list of filenames in the directory that match the file pattern.
+ """
+
if sys.version_info >= (3, 5):
return glob(stem + "/**/" + file_pattern, recursive=True)
else:
def colorize(text, color):
+ """
+ Wrap a string so that it displays in a particular color.
+
+ This function adds a prefix and suffix to a text string so that it is
+ displayed as a particular color, either in command prompt or the terminal.
+
+ Parameters
+ ----------
+ text : str
+ The message to display.
+ color : str
+ The color string prefix to put before the text.
+
+ Returns
+ -------
+ wrapped_str : str
+ The wrapped string to display in color.
+ """
+
return color + text + Colors.ENDC
def print_success(text):
+ """
+ Print a success message.
+
+ Parameters
+ ----------
+ text : str
+ The message to display.
+ """
+
print(colorize(text, Colors.SUCCESS))
def print_failure(text):
+ """
+ Print a failure message.
+
+ Parameters
+ ----------
+ text : str
+ The message to display.
+ """
+
print(colorize(text, Colors.FAIL))
# End Helper Functions
git.99rst.org / stevenblack-hosts.git / commitdiff