owl-map/matcher/utils.py

from flask import current_app, request
from itertools import islice
import os.path
import json
import math
import user_agents
import re
import pattern.en
from datetime import date

metres_per_mile = 1609.344
feet_per_metre = 3.28084
feet_per_mile = 5280


def chunk(it, size):
    it = iter(it)
    return iter(lambda: tuple(islice(it, size)), ())


def flatten(l):
    return [item for sublist in l for item in sublist]


def drop_start(s, start):
    assert s.startswith(start)
    return s[len(start) :]


def remove_start(s, start):
    return s[len(start) :] if s.startswith(start) else s


def normalize_url(url):
    for start in "http://", "https://", "www.":
        url = remove_start(url, start)
    return url.rstrip("/")


def contains_digit(s):
    return any(c.isdigit() for c in s)


def cache_dir():
    return current_app.config["CACHE_DIR"]


def cache_filename(filename):
    return os.path.join(cache_dir(), filename)


def load_from_cache(filename):
    return json.load(open(cache_filename(filename)))


def get_radius(default=1000):
    arg_radius = request.args.get("radius")
    return int(arg_radius) if arg_radius and arg_radius.isdigit() else default


def get_int_arg(name):
    if name in request.args and request.args[name].isdigit():
        return int(request.args[name])


def calc_chunk_size(area_in_sq_km, size=22):
    side = math.sqrt(area_in_sq_km)
    return max(1, math.ceil(side / size))


def file_missing_or_empty(filename):
    return os.path.exists(filename) or os.stat(filename).st_size == 0


def is_bot():
    """ Is the current request from a web robot? """
    ua = request.headers.get("User-Agent")
    return ua and user_agents.parse(ua).is_bot


def log_location():
    return current_app.config["LOG_DIR"]


def good_location():
    return os.path.join(log_location(), "complete")


def capfirst(value):
    """ Uppercase first letter of string, leave rest as is. """
    return value[0].upper() + value[1:] if value else value


def any_upper(value):
    return any(c.isupper() for c in value)


def find_log_file(place):
    start = f"{place.place_id}_"
    for f in os.scandir(good_location()):
        if f.name.startswith(start):
            return f.path


def get_free_space(config):
    s = os.statvfs(config["FREE_SPACE_PATH"])
    return s.f_bsize * s.f_bavail


def display_distance(units, dist):
    if units in ("miles_and_feet", "miles_and_yards"):
        total_feet = dist * feet_per_metre
        miles = total_feet / feet_per_mile

        if miles > 0.5:
            return f"{miles:,.2f} miles"
        else:
            return {
                "miles_and_feet": f"{total_feet:,.0f} feet",
                "miles_and_yards": f"{total_feet / 3:,.0f} yards",
            }[units]

    if units == "miles_and_metres":
        miles = dist / metres_per_mile
        return f"{miles:,.2f} miles" if miles > 0.5 else f"{dist:,.0f} metres"

    if units == "km_and_metres":
        units = "km" if dist > 500 else "metres"
    if units == "metres":
        return f"{dist:,.0f} m"
    if units == "km":
        return f"{dist / 1000:,.2f} km"


re_range = re.compile(r"\b(\d+) ?(?:to|-) ?(\d+)\b", re.I)
re_number_list = re.compile(r"\b([\d, ]+) (?:and|&) (\d+)\b", re.I)
re_number = re.compile(r"^(?:No\.?|Number)? ?(\d+)\b")


def is_in_range(address_range, address):
    m_number = re_number.match(address)
    if not m_number:
        return False

    m_range = re_range.search(address_range)
    if m_range:
        start, end = int(m_range.group(1)), int(m_range.group(2))
        if re_range.search(address):
            return False
        return start <= int(m_number.group(1)) <= end

    m_list = re_number_list.search(address_range)
    if m_list:
        numbers = {n.strip() for n in m_list.group(1).split(",")} | {m_list.group(2)}
        if re_number_list.search(address):
            return False
        return m_number.group(1) in numbers

    return False


def pluralize_label(label):
    text = label["value"]
    if label["language"] != "en":
        return text

    # pattern.en.pluralize has the plural of 'mine' as 'ours'
    if text == "mine":
        return "mines"

    return pattern.en.pluralize(text)


def format_wikibase_time(v):
    p = v["precision"]
    t = v["time"]

    assert p in (7, 9, 10, 11)

    # TODO: handle dates with century precision (7)
    # example: https://www.wikidata.org/wiki/Q108266998

    if p == 11:
        return date.fromisoformat(t[1:11]).strftime("%d %B %Y")
    if p == 10:
        return date.fromisoformat(t[1:8] + "-01").strftime("%B %Y")
    if p == 9:
        return t[1:5]
    if p == 7:
        return t[1:5]