|
| 1 | +import os |
| 2 | +from string import digits |
| 3 | + |
| 4 | +from django.conf import settings |
| 5 | +from django.core.exceptions import ImproperlyConfigured |
| 6 | + |
| 7 | +from lippukala.adapter.base import LippukalaAdapter |
| 8 | + |
| 9 | + |
| 10 | +def get_setting(name, default=None): |
| 11 | + return getattr(settings, f"LIPPUKALA_{name}", default) |
| 12 | + |
| 13 | + |
| 14 | +def get_integer_setting(name, default=0): |
| 15 | + try: |
| 16 | + value = get_setting(name, default) |
| 17 | + return int(value) |
| 18 | + except ValueError: # pragma: no cover |
| 19 | + raise ImproperlyConfigured(f"LIPPUKALA_{name} must be an integer (got {value!r})") |
| 20 | + |
| 21 | + |
| 22 | +class LippukalaSettings: |
| 23 | + def __init__(self) -> None: |
| 24 | + self.prefixes = get_setting("PREFIXES", {}) |
| 25 | + self.literate_keyspaces = get_setting("LITERATE_KEYSPACES", {}) |
| 26 | + self.code_min_n_digits = get_integer_setting("CODE_MIN_N_DIGITS", 10) |
| 27 | + self.code_max_n_digits = get_integer_setting("CODE_MAX_N_DIGITS", 10) |
| 28 | + self.code_allow_leading_zeroes = bool(get_setting("CODE_ALLOW_LEADING_ZEROES", True)) |
| 29 | + self.print_logo_path = get_setting("PRINT_LOGO_PATH") |
| 30 | + self.print_logo_size_cm = get_setting("PRINT_LOGO_SIZE_CM") |
| 31 | + |
| 32 | + if self.prefixes: |
| 33 | + self.prefix_choices = [(p, f"{p} [{t}]") for (p, t) in sorted(self.prefixes.items())] |
| 34 | + self.prefix_may_be_blank = False |
| 35 | + else: |
| 36 | + self.prefix_choices = [("", "---")] |
| 37 | + self.prefix_may_be_blank = True |
| 38 | + |
| 39 | + def validate(self) -> None: # pragma: no cover |
| 40 | + self._validate_code() |
| 41 | + self._validate_prefixes() |
| 42 | + self._validate_print() |
| 43 | + |
| 44 | + def _validate_code(self) -> None: |
| 45 | + if self.code_min_n_digits <= 5 or self.code_max_n_digits < self.code_min_n_digits: |
| 46 | + raise ImproperlyConfigured( |
| 47 | + f"The range ({self.code_min_n_digits} .. {self.code_max_n_digits}) for " |
| 48 | + f"Lippukala code digits is invalid" |
| 49 | + ) |
| 50 | + |
| 51 | + def _validate_prefixes(self): |
| 52 | + key_lengths = [len(k) for k in self.prefixes] |
| 53 | + if key_lengths and not all(k == key_lengths[0] for k in key_lengths): |
| 54 | + raise ImproperlyConfigured("All LIPPUKALA_PREFIXES keys must be the same length!") |
| 55 | + for prefix in self.prefixes: |
| 56 | + if not all(c in digits for c in prefix): |
| 57 | + raise ImproperlyConfigured( |
| 58 | + f"The prefix {prefix!r} has invalid characters. Only digits are allowed." |
| 59 | + ) |
| 60 | + for prefix, literate_keyspace in list(self.literate_keyspaces.items()): |
| 61 | + if isinstance(literate_keyspace, str): |
| 62 | + raise ImproperlyConfigured( |
| 63 | + f"A string ({literate_keyspace!r}) was passed as the " |
| 64 | + f"literate keyspace for prefix {prefix!r}" |
| 65 | + ) |
| 66 | + too_short_keys = any(len(key) <= 1 for key in literate_keyspace) |
| 67 | + maybe_duplicate = len(set(literate_keyspace)) != len(literate_keyspace) |
| 68 | + if too_short_keys or maybe_duplicate: |
| 69 | + raise ImproperlyConfigured( |
| 70 | + f"The literate keyspace for prefix {prefix!r} has invalid or duplicate entries." |
| 71 | + ) |
| 72 | + |
| 73 | + def _validate_print(self): |
| 74 | + if not self.print_logo_path: |
| 75 | + return |
| 76 | + if not os.path.isfile(self.print_logo_path): |
| 77 | + raise ImproperlyConfigured( |
| 78 | + f"PRINT_LOGO_PATH was defined, but does not exist ({self.print_logo_path!r})" |
| 79 | + ) |
| 80 | + if not all(float(s) > 0 for s in self.print_logo_size_cm): |
| 81 | + raise ImproperlyConfigured(f"PRINT_LOGO_SIZE_CM values not valid: {self.print_logo_size_cm!r}") |
| 82 | + |
| 83 | + |
| 84 | +class DefaultLippukalaAdapter(LippukalaAdapter): |
| 85 | + _settings: LippukalaSettings | None = None |
| 86 | + |
| 87 | + @classmethod |
| 88 | + def get_settings(cls) -> LippukalaSettings: |
| 89 | + if not cls._settings: |
| 90 | + cls._settings = LippukalaSettings() |
| 91 | + cls._settings.validate() |
| 92 | + return cls._settings |
| 93 | + |
| 94 | + def get_prefixes(self) -> dict[str, str]: |
| 95 | + return self.get_settings().prefixes |
| 96 | + |
| 97 | + def get_literate_keyspace(self, prefix: str | None) -> list[str] | None: |
| 98 | + literate_keyspaces = self.get_settings().literate_keyspaces |
| 99 | + return literate_keyspaces.get(prefix) |
| 100 | + |
| 101 | + def get_code_digit_range(self, prefix: str) -> range: |
| 102 | + s = self.get_settings() |
| 103 | + return range(s.code_min_n_digits, s.code_max_n_digits + 1) |
| 104 | + |
| 105 | + def get_code_allow_leading_zeroes(self, prefix: str) -> bool: |
| 106 | + return self.get_settings().code_allow_leading_zeroes |
| 107 | + |
| 108 | + def get_print_logo_path(self, prefix: str) -> str | None: |
| 109 | + return self.get_settings().print_logo_path |
| 110 | + |
| 111 | + def get_print_logo_size_cm(self, prefix: str) -> tuple[float, float]: |
| 112 | + return self.get_settings().print_logo_size_cm |
0 commit comments