import json import logging import os import re from datetime import datetime from glob import glob import frontmatter from liquid import Template logging.basicConfig(format=logging.BASIC_FORMAT, level=logging.INFO) # Handle versions having at least 2 digits (ex. 1.2) and at most 4 digits (ex. 1.2.3.4), with an optional leading "v". # Major version must be >= 1. DEFAULT_VERSION_REGEX = r"^v?(?P[1-9]\d*)\.(?P\d+)(\.(?P\d+)(\.(?P\d+))?)?$" DEFAULT_VERSION_PATTERN = re.compile(DEFAULT_VERSION_REGEX) DEFAULT_VERSION_TEMPLATE = "{{major}}{% if minor %}.{{minor}}{% if patch %}.{{patch}}{% if tiny %}.{{tiny}}{% endif %}{% endif %}{% endif %}" PRODUCTS_PATH = os.environ.get("PRODUCTS_PATH", "website/products") VERSIONS_PATH = os.environ.get("VERSIONS_PATH", "releases") class AutoConfig: def __init__(self, method: str, config: dict) -> None: self.method = method self.url = config[method] self.version_template = Template(config.get("template", DEFAULT_VERSION_TEMPLATE)) regexes = config.get("regex", DEFAULT_VERSION_REGEX) regexes = regexes if isinstance(regexes, list) else [regexes] self.version_patterns = [re.compile(regex) for regex in regexes] def first_match(self, version: str) -> re.Match: for pattern in self.version_patterns: match = pattern.match(version) if match: return match def render(self, match: re.Match) -> str: return self.version_template.render(**match.groupdict()) class ProductFrontmatter: def __init__(self, name: str) -> None: self.name: str = name self.path: str = f"{PRODUCTS_PATH}/{name}.md" self.data = None if os.path.isfile(self.path): with open(self.path) as f: self.data = frontmatter.load(f) logging.info(f"loaded product data for {self.name} from {self.path}") else: logging.warning(f"no product data found for {self.name} at {self.path}") def get_auto_configs(self, method: str) -> list[AutoConfig]: configs = [] if "auto" in self.data: for config in self.data["auto"]: if method in config.keys(): configs.append(AutoConfig(method, config)) else: logging.error(f"mixed auto-update methods declared for {self.name}, this is not yet supported") return configs def get_release_date(self, release_cycle: str) -> datetime: for release in self.data["releases"]: if release["releaseCycle"] == release_cycle: return release["releaseDate"] class Product: def __init__(self, name: str) -> None: self.name: str = name self.versions_path: str = f"{VERSIONS_PATH}/{name}.json" self.versions = {} @staticmethod def from_file(name: str) -> "Product": product = Product(name) if not os.path.isfile(product.versions_path): with open(product.versions_path) as f: for version, date in json.load(f).items(): product.versions[version] = datetime.strptime(date, "%Y-%m-%d") logging.info(f"loaded versions data for {product.name} from {product.versions_path}") else: logging.warning(f"no versions data found for {product.name} at {product.versions_path}") return product def has_version(self, version: str) -> bool: return version in self.versions def get_version_date(self, version: str) -> datetime: return self.versions[version] if version in self.versions else None def declare_version(self, version: str, date: datetime) -> None: if version in self.versions: if self.versions[version] != date: logging.warning(f"overwriting version {version} ({self.versions[version]} -> {date}) for {self.name}") else: return # already declared logging.info(f"adding version {version} ({date}) to {self.name}") self.versions[version] = date def declare_versions(self, dates_by_version: dict[str, datetime]) -> None: for (version, date) in dates_by_version.items(): self.declare_version(version, date) def replace_version(self, version: str, date: datetime) -> None: if version not in self.versions: raise ValueError(f"version {version} cannot be replaced as it does not exist for {self.name}") logging.info(f"replacing version {version} ({self.versions[version]} -> {date}) in {self.name}") self.versions[version] = date def remove_version(self, version: str) -> None: if not self.has_version(version): logging.warning(f"version {version} cannot be removed as it does not exist for {self.name}") return logging.info(f"removing version {version} ({self.versions.pop(version)}) from {self.name}") def write(self) -> None: versions = {version: date.strftime("%Y-%m-%d") for version, date in self.versions.items()} with open(self.versions_path, "w") as f: f.write(json.dumps(dict( # sort by date then version (desc) sorted(versions.items(), key=lambda x: (x[1], x[0]), reverse=True) ), indent=2)) def __repr__(self) -> str: return f"<{self.name}>" def list_products(method: str, products_filter: str = None) -> list[str]: """Return a list of products that are using the same given update method. """ products = [] for product_file in glob(f"{PRODUCTS_PATH}/*.md"): product_name = os.path.splitext(os.path.basename(product_file))[0] if products_filter and product_name != products_filter: continue with open(product_file) as f: data = frontmatter.load(f) if "auto" in data: matching_configs = list(filter(lambda config: method in config.keys(), data["auto"])) if len(matching_configs) > 0: products.append(product_name) return products