Files
cloudflare-ddns-docker/cloudflare_ddns/utils.py
2021-01-30 18:18:40 +01:00

78 lines
2.3 KiB
Python

import re
import requests
from cloudflare_ddns.constants import BASE_ENDPOINT, IP_API_URL_IPV4, IP_API_URL_IPV6
from requests import HTTPError, Request, Response, codes
from requests.auth import AuthBase
DURATION_REGEX = re.compile(
r"((?P<days>\d+?) ?(days|day|D|d) ?)?"
r"((?P<hours>\d+?) ?(hours|hour|H|h) ?)?"
r"((?P<minutes>\d+?) ?(minutes|minute|min|M|m) ?)?"
r"((?P<seconds>\d+?) ?(seconds|second|sec|S|s))?"
)
UNIT_TO_SECONDS = {
"days": 86400,
"hours": 3600,
"minutes": 60,
"seconds": 1
}
def parse_duration(duration: str) -> int:
"""
Parameter type for durations.
The converter supports the following symbols for each unit of time:
- days: `d`, `D`, `day`, `days`
- hours: `H`, `h`, `hour`, `hours`
- minutes: `M`, `m`, `minute`, `minutes`, `min`
- seconds: `S`, `s`, `second`, `seconds`, `sec`
The units need to be provided in descending order of magnitude.
"""
match = DURATION_REGEX.fullmatch(duration)
if not match:
raise ValueError(f"{duration} isn't a valid duration.")
duration = 0
for unit, time_value in match.groupdict().items():
if time_value:
duration += int(time_value) * UNIT_TO_SECONDS[unit]
return duration
class BearerAuth(AuthBase):
"""Bearer based authentication."""
def __init__(self, token: str) -> None:
self.token = token
def __call__(self, r: Request) -> Request:
"""Attach the Authorization header to the request."""
r.headers["Authorization"] = f"Bearer {self.token}"
return r
def get_ip(ipv6: bool, session: requests.Session) -> str:
"""Return the host public IP as detected by ipify.org."""
r = check_status(session.get(IP_API_URL_IPV4 if not ipv6 else IP_API_URL_IPV6))
return r.text
class CloudflareHTTPError(HTTPError):
"""HTTPError coming from a Cloudflare endpoint."""
def check_status(r: Response) -> Response:
"""Check the status code of a response and return it."""
if not r.status_code == codes.ok:
if r.url.startswith(BASE_ENDPOINT) and not r.json()["success"]:
errors = "\n".join(f"{err['code']}: {err['message']}" for err in r.json()["errors"])
raise CloudflareHTTPError(f"{r.status_code} {r.reason} while querying {r.url}: {errors}")
else:
r.raise_for_status()
return r