mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-05-17 10:07:04 +02:00
116 lines
4.1 KiB
Python
116 lines
4.1 KiB
Python
"""Internal API views"""
|
||
import os
|
||
from django.apps import apps
|
||
from django.views.decorators.http import require_http_methods
|
||
from django.http import FileResponse, HttpResponse, JsonResponse
|
||
import requests
|
||
|
||
from login_required import login_not_required
|
||
|
||
from cachetools.func import ttl_cache
|
||
|
||
|
||
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.",
|
||
"unavailable": "That domain isn’t available. Try entering another one."
|
||
" Contact us if you need help coming up with a domain.",
|
||
"invalid": "Enter a domain using only letters, numbers, or hyphens (though we don't recommend using hyphens).",
|
||
"success": "That domain is available!",
|
||
"error": "Error finding domain availability.",
|
||
}
|
||
|
||
|
||
# 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.
|
||
"""
|
||
Domain = apps.get_model("registrar.Domain")
|
||
try:
|
||
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")
|
||
except Exception:
|
||
return False
|
||
|
||
|
||
@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.
|
||
"""
|
||
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):
|
||
# Open the CSV file
|
||
file_path = "migrationdata/current-full.csv"
|
||
return serve_file(file_path)
|
||
|
||
|
||
@require_http_methods(["GET"])
|
||
@login_not_required
|
||
def get_current_federal(request):
|
||
# Open the CSV file
|
||
file_path = "migrationdata/current-federal.csv"
|
||
return serve_file(file_path)
|
||
|
||
def serve_file(file_path):
|
||
"""Downloads a file based on a given filepath. Returns a 404 if not found."""
|
||
if os.path.exists(file_path):
|
||
# Serve the CSV file
|
||
response = FileResponse(open(file_path, "rb"))
|
||
return response
|
||
else:
|
||
return HttpResponse("File not found", status=404)
|