|
| 1 | +from os import getcwd |
| 2 | +from pathlib import Path |
| 3 | + |
| 4 | +import boto3 |
| 5 | +from botocore.client import Config |
| 6 | +from botocore.exceptions import ClientError |
| 7 | +from ecoindex.config.settings import Settings |
| 8 | +from ecoindex.models import ScreenShot |
| 9 | + |
| 10 | +TEMPORARY_SCREENSHOT_ROOT = "/tmp/ecoindex-screenshots" |
| 11 | + |
| 12 | + |
| 13 | +def get_screenshot_storage_type() -> str: |
| 14 | + return Settings().SCREENSHOT_STORAGE_TYPE.lower() |
| 15 | + |
| 16 | + |
| 17 | +def is_s3_screenshot_storage() -> bool: |
| 18 | + return get_screenshot_storage_type() == "s3" |
| 19 | + |
| 20 | + |
| 21 | +def _get_root_path(path: str) -> Path: |
| 22 | + root_path = Path(path).expanduser() |
| 23 | + if root_path.is_absolute(): |
| 24 | + return root_path |
| 25 | + return Path(getcwd()) / root_path |
| 26 | + |
| 27 | + |
| 28 | +def _get_s3_client(): |
| 29 | + settings = Settings() |
| 30 | + if not settings.SCREENSHOT_S3_BUCKET: |
| 31 | + raise RuntimeError("SCREENSHOT_S3_BUCKET must be configured when using S3 storage.") |
| 32 | + |
| 33 | + if not settings.SCREENSHOT_S3_ENDPOINT_URL: |
| 34 | + raise RuntimeError( |
| 35 | + "SCREENSHOT_S3_ENDPOINT_URL must be configured when using S3 storage." |
| 36 | + ) |
| 37 | + |
| 38 | + if not settings.SCREENSHOT_S3_ACCESS_KEY_ID: |
| 39 | + raise RuntimeError( |
| 40 | + "SCREENSHOT_S3_ACCESS_KEY_ID must be configured when using S3 storage." |
| 41 | + ) |
| 42 | + |
| 43 | + if not settings.SCREENSHOT_S3_SECRET_ACCESS_KEY: |
| 44 | + raise RuntimeError( |
| 45 | + "SCREENSHOT_S3_SECRET_ACCESS_KEY must be configured when using S3 storage." |
| 46 | + ) |
| 47 | + |
| 48 | + return boto3.client( |
| 49 | + "s3", |
| 50 | + endpoint_url=settings.SCREENSHOT_S3_ENDPOINT_URL, |
| 51 | + region_name=settings.SCREENSHOT_S3_REGION, |
| 52 | + aws_access_key_id=settings.SCREENSHOT_S3_ACCESS_KEY_ID, |
| 53 | + aws_secret_access_key=settings.SCREENSHOT_S3_SECRET_ACCESS_KEY, |
| 54 | + config=Config( |
| 55 | + s3={ |
| 56 | + "addressing_style": ( |
| 57 | + "path" if settings.SCREENSHOT_S3_FORCE_PATH_STYLE else "auto" |
| 58 | + ) |
| 59 | + } |
| 60 | + ), |
| 61 | + ) |
| 62 | + |
| 63 | + |
| 64 | +def get_screenshot_local_folder(version: str) -> str: |
| 65 | + if is_s3_screenshot_storage(): |
| 66 | + return str(Path(TEMPORARY_SCREENSHOT_ROOT) / version) |
| 67 | + |
| 68 | + settings = Settings() |
| 69 | + return str(_get_root_path(settings.SCREENSHOT_FILESYSTEM_PATH) / version) |
| 70 | + |
| 71 | + |
| 72 | +def get_screenshot_local_path(version: str, screenshot_id: str) -> str: |
| 73 | + return str(Path(get_screenshot_local_folder(version)) / f"{screenshot_id}.webp") |
| 74 | + |
| 75 | + |
| 76 | +def get_screenshot_object_key(version: str, screenshot_id: str) -> str: |
| 77 | + settings = Settings() |
| 78 | + prefix = settings.SCREENSHOT_S3_PREFIX.strip("/") |
| 79 | + filename = f"{version}/{screenshot_id}.webp" |
| 80 | + return f"{prefix}/{filename}" if prefix else filename |
| 81 | + |
| 82 | + |
| 83 | +def persist_screenshot(screenshot: ScreenShot, version: str) -> None: |
| 84 | + if not is_s3_screenshot_storage(): |
| 85 | + return |
| 86 | + |
| 87 | + settings = Settings() |
| 88 | + screenshot_path = Path(screenshot.get_webp()) |
| 89 | + client = _get_s3_client() |
| 90 | + bucket = settings.SCREENSHOT_S3_BUCKET |
| 91 | + try: |
| 92 | + client.head_bucket(Bucket=bucket) |
| 93 | + except ClientError as exc: |
| 94 | + error_code = exc.response.get("Error", {}).get("Code") |
| 95 | + if error_code not in {"404", "NoSuchBucket", "NotFound"}: |
| 96 | + raise |
| 97 | + client.create_bucket(Bucket=bucket) |
| 98 | + |
| 99 | + client.upload_file( |
| 100 | + str(screenshot_path), |
| 101 | + bucket, |
| 102 | + get_screenshot_object_key(version=version, screenshot_id=screenshot.id), |
| 103 | + ExtraArgs={"ContentType": "image/webp"}, |
| 104 | + ) |
| 105 | + screenshot_path.unlink(missing_ok=True) |
| 106 | + |
| 107 | + |
| 108 | +def screenshot_exists(version: str, screenshot_id: str) -> bool: |
| 109 | + if not is_s3_screenshot_storage(): |
| 110 | + return Path(get_screenshot_local_path(version, screenshot_id)).is_file() |
| 111 | + |
| 112 | + settings = Settings() |
| 113 | + try: |
| 114 | + _get_s3_client().head_object( |
| 115 | + Bucket=settings.SCREENSHOT_S3_BUCKET, |
| 116 | + Key=get_screenshot_object_key(version=version, screenshot_id=screenshot_id), |
| 117 | + ) |
| 118 | + return True |
| 119 | + except ClientError as exc: |
| 120 | + error_code = exc.response.get("Error", {}).get("Code") |
| 121 | + if error_code in {"404", "NoSuchKey", "NotFound"}: |
| 122 | + return False |
| 123 | + raise |
| 124 | + |
| 125 | + |
| 126 | +def read_screenshot(version: str, screenshot_id: str) -> bytes: |
| 127 | + if not is_s3_screenshot_storage(): |
| 128 | + return Path(get_screenshot_local_path(version, screenshot_id)).read_bytes() |
| 129 | + |
| 130 | + settings = Settings() |
| 131 | + response = _get_s3_client().get_object( |
| 132 | + Bucket=settings.SCREENSHOT_S3_BUCKET, |
| 133 | + Key=get_screenshot_object_key(version=version, screenshot_id=screenshot_id), |
| 134 | + ) |
| 135 | + return response["Body"].read() |
0 commit comments