"""Internal API views""" from django.apps import apps from django.views.decorators.http import require_http_methods from django.http import HttpResponse, JsonResponse from django.utils.safestring import mark_safe from registrar.templatetags.url_helpers import public_site_url from registrar.utility.errors import GenericError, GenericErrorCodes import requests from login_required import login_not_required from cachetools.func import ttl_cache from registrar.utility.s3_bucket import S3ClientError, S3ClientHelper DOMAIN_FILE_URL = "https://raw.githubusercontent.com/cisagov/dotgov-data/main/current-full.csv" DOMAIN_API_MESSAGES = { "required": "Enter the .gov domain you want. Don’t include “www” or “.gov.”" " For example, if you want www.city.gov, you would enter “city”" " (without the quotes).", "extra_dots": "Enter the .gov domain you want without any periods.", # message below is considered safe; no user input can be inserted into the message # body; public_site_url() function reads from local app settings and therefore safe "unavailable": mark_safe( # nosec "That domain isn’t available. " "" "Read more about choosing your .gov domain.".format(public_site_url("domains/choosing")) ), "invalid": "Enter a domain using only letters, numbers, or hyphens (though we don't recommend using hyphens).", "success": "That domain is available!", "error": GenericError.get_error_message(GenericErrorCodes.CANNOT_CONTACT_REGISTRY), } # this file doesn't change that often, nor is it that big, so cache the result # in memory for ten minutes @ttl_cache(ttl=600) def _domains(): """Return a list of the current .gov domains. Fetch a file from DOMAIN_FILE_URL, parse the CSV for the domain, lowercase everything and return the list. """ DraftDomain = apps.get_model("registrar.DraftDomain") # 5 second timeout file_contents = requests.get(DOMAIN_FILE_URL, timeout=5).text domains = set() # skip the first line for line in file_contents.splitlines()[1:]: # get the domain before the first comma domain = line.split(",", 1)[0] # sanity-check the string we got from the file here if DraftDomain.string_could_be_domain(domain): # lowercase everything when we put it in domains domains.add(domain.lower()) return domains def check_domain_available(domain): """Return true if the given domain is available. The given domain is lowercased to match against the domains list. If the given domain doesn't end with .gov, ".gov" is added when looking for a match. If check fails, throws a RegistryError. """ Domain = apps.get_model("registrar.Domain") if domain.endswith(".gov"): return Domain.available(domain) else: # domain search string doesn't end with .gov, add it on here return Domain.available(domain + ".gov") @require_http_methods(["GET"]) @login_not_required def available(request, domain=""): """Is a given domain available or not. Response is a JSON dictionary with the key "available" and value true or false. """ domain = request.GET.get("domain", "") DraftDomain = apps.get_model("registrar.DraftDomain") # validate that the given domain could be a domain name and fail early if # not. if not (DraftDomain.string_could_be_domain(domain) or DraftDomain.string_could_be_domain(domain + ".gov")): return JsonResponse({"available": False, "message": DOMAIN_API_MESSAGES["invalid"]}) # a domain is available if it is NOT in the list of current domains try: if check_domain_available(domain): return JsonResponse({"available": True, "message": DOMAIN_API_MESSAGES["success"]}) else: return JsonResponse({"available": False, "message": DOMAIN_API_MESSAGES["unavailable"]}) except Exception: return JsonResponse({"available": False, "message": DOMAIN_API_MESSAGES["error"]}) @require_http_methods(["GET"]) @login_not_required def get_current_full(request, file_name="current-full.csv"): """This will return the file content of current-full.csv which is the command output of generate_current_full_report.py. This command iterates through each Domain and returns a CSV representation.""" return serve_file(file_name) @require_http_methods(["GET"]) @login_not_required def get_current_federal(request, file_name="current-federal.csv"): """This will return the file content of current-federal.csv which is the command output of generate_current_federal_report.py. This command iterates through each Domain and returns a CSV representation.""" return serve_file(file_name) def serve_file(file_name): """Downloads a file based on a given filepath. Returns a 500 if not found.""" s3_client = S3ClientHelper() # Serve the CSV file. If not found, an exception will be thrown. # This will then be caught by flat, causing it to not read it - which is what we want. try: file = s3_client.get_file(file_name, decode_to_utf=True) except S3ClientError as err: # TODO - #1317: Notify operations when auto report generation fails raise err response = HttpResponse(file) return response