Spaces:
Running
Running
File size: 44,687 Bytes
fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 efa9f90 fe8cd16 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 | from __future__ import annotations
import base64
import json
import mimetypes
import re
import time
from pathlib import Path
from typing import Any, Dict, Optional
from urllib.parse import urlparse
from fastapi import APIRouter, Depends, File, Form, Header, HTTPException, Query, Response, UploadFile
from app.config import get_settings
from app.core.logger import get_logger
from app.models.schemas import (
GCSACLRequest,
GCSBaseCredentialsRequest,
GCSBucketIAMRequest,
GCSBucketRequest,
GCSBucketRestoreRequest,
GCSBucketUpdateRequest,
GCSComposeRequest,
GCSDownloadResponse,
GCSGenericResponse,
GCSListResponse,
GCSObjectTransferRequest,
GCSObjectUpdateRequest,
GCSResumableUploadRequest,
GCSURLRequest,
GCSURLResponse,
GCSWatchRequest,
)
from app.services.gcs_service import GCSCredentials, GCSCredentialsError, GCSError, GCSService
router = APIRouter(prefix="/google/gcs", tags=["Google Cloud Storage"])
_logger = get_logger(__name__)
_settings = get_settings()
_MAX_UPLOAD_BYTES = _settings.max_upload_bytes
_gcs_service = GCSService()
def get_gcs_service() -> GCSService:
return _gcs_service
async def close_gcs_service() -> None:
await _gcs_service.close()
# ---------------------------------------------------------------------------
# Shared helpers
# ---------------------------------------------------------------------------
def _elapsed_ms(start: float) -> float:
return round((time.perf_counter() - start) * 1000, 2)
async def _resolve(
service: GCSService,
*,
payload: Optional[Any] = None,
url: Optional[str] = None,
file_bytes: Optional[bytes] = None,
file_name: Optional[str] = None,
) -> GCSCredentials:
try:
return await service.resolve_credentials(
payload=payload, url=url, file_bytes=file_bytes, file_name=file_name
)
except GCSCredentialsError as exc:
raise HTTPException(status_code=400, detail=exc.message)
def _creds_fields(body: Any) -> Dict[str, Any]:
"""Extract credential kwargs from a GCS request model."""
payload = body.credentials if isinstance(body.credentials, dict) else body.credentials_json
return {"payload": payload, "url": body.credentials_url}
def _error_response(cls, start: float, exc: GCSError):
return cls(success=False, time_ms=_elapsed_ms(start), error=exc.message)
async def _read_file_limited(f: UploadFile, *, what: str) -> bytes:
data = await f.read()
if len(data) > _MAX_UPLOAD_BYTES:
raise HTTPException(
status_code=413,
detail=f"{what} exceeds the {_MAX_UPLOAD_BYTES} byte upload limit",
)
return data
# ---------------------------------------------------------------------------
# Buckets — CRUD
# ---------------------------------------------------------------------------
@router.post("/buckets", response_model=GCSGenericResponse,
summary="Create a Cloud Storage bucket")
async def create_bucket(
body: GCSBucketRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
bucket_body: Dict[str, Any] = dict(body.bucket or {})
if body.location:
bucket_body["location"] = body.location
if body.storage_class:
bucket_body["storageClass"] = body.storage_class
try:
result = await service.create_bucket(creds, body.name, project=body.project_id, bucket_body=bucket_body)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}", response_model=GCSGenericResponse,
summary="Get bucket metadata")
async def get_bucket(
bucket: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials", description="Service account JSON (or JSON string)"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url", description="URL to a service account JSON file"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_bucket(creds, bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets", response_model=GCSListResponse,
summary="List buckets in a project")
async def list_buckets(
project_id: Optional[str] = Query(None, description="GCP project id (defaults to the service account project)"),
prefix: Optional[str] = Query(None, description="Filter buckets whose names start with this prefix"),
max_results: Optional[int] = Query(None, ge=1, le=1000, description="Maximum number of results to return"),
page_token: Optional[str] = Query(None, description="Pagination token from a previous response"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials", description="Service account JSON (or JSON string)"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url", description="URL to a service account JSON file"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.list_buckets(creds, project=project_id, prefix=prefix,
max_results=max_results, page_token=page_token)
data = result.get("data") or {}
items = data.get("items", [])
return GCSListResponse(
success=True, time_ms=_elapsed_ms(start), count=len(items),
next_page_token=data.get("nextPageToken"),
items=items, prefixes=[],
)
except GCSError as exc:
return _error_response(GCSListResponse, start, exc)
@router.patch("/buckets/{bucket}", response_model=GCSGenericResponse,
summary="Patch bucket metadata (partial update)")
async def patch_bucket(
bucket: str,
body: GCSBucketUpdateRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.patch_bucket(creds, bucket, body.bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}", response_model=GCSGenericResponse,
summary="Replace bucket metadata (full update)")
async def update_bucket(
bucket: str,
body: GCSBucketUpdateRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.update_bucket(creds, bucket, body.bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.delete("/buckets/{bucket}", response_model=GCSGenericResponse,
summary="Delete a bucket")
async def delete_bucket(
bucket: str,
body: Optional[Dict[str, Any]] = None,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(
service,
payload=(body or {}).get("credentials_json") or (body or {}).get("credentials"),
url=(body or {}).get("credentials_url"),
)
try:
await service.delete_bucket(creds, bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data={"deleted": bucket})
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Buckets — IAM & permissions
# ---------------------------------------------------------------------------
@router.post("/buckets/{bucket}/restore", response_model=GCSGenericResponse,
summary="Restore a soft-deleted bucket")
async def restore_bucket(
bucket: str,
body: GCSBucketRestoreRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.restore_bucket(creds, bucket, if_metageneration_match=body.if_metageneration_match)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/iam", response_model=GCSGenericResponse,
summary="Get bucket IAM policy")
async def get_bucket_iam(
bucket: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_bucket_iam(creds, bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}/iam", response_model=GCSGenericResponse,
summary="Set bucket IAM policy")
async def set_bucket_iam(
bucket: str,
body: GCSBucketIAMRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.set_bucket_iam(creds, bucket, body.policy)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/iam/testPermissions", response_model=GCSGenericResponse,
summary="Test permissions on a bucket")
async def test_bucket_permissions(
bucket: str,
permissions: str = Query(..., description="Comma-separated permissions to test, e.g. 'storage.buckets.get,storage.objects.list'"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
permission_list = [p.strip() for p in permissions.split(",") if p.strip()]
if not permission_list:
raise HTTPException(status_code=422, detail="At least one permission is required.")
try:
result = await service.test_bucket_permissions(creds, bucket, permission_list)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Buckets — default object ACLs
# ---------------------------------------------------------------------------
@router.get("/buckets/{bucket}/defaultAcl", response_model=GCSGenericResponse,
summary="List default object ACLs")
async def list_default_object_acl(
bucket: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.list_default_object_acl(creds, bucket)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/defaultAcl", response_model=GCSGenericResponse,
summary="Add a default object ACL entry")
async def insert_default_object_acl(
bucket: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.insert_default_object_acl(creds, bucket, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/defaultAcl/{entity}", response_model=GCSGenericResponse,
summary="Get a default object ACL entry")
async def get_default_object_acl(
bucket: str,
entity: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_default_object_acl(creds, bucket, entity)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.patch("/buckets/{bucket}/defaultAcl/{entity}", response_model=GCSGenericResponse,
summary="Patch a default object ACL entry")
async def patch_default_object_acl(
bucket: str,
entity: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.patch_default_object_acl(creds, bucket, entity, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}/defaultAcl/{entity}", response_model=GCSGenericResponse,
summary="Update a default object ACL entry")
async def update_default_object_acl(
bucket: str,
entity: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.update_default_object_acl(creds, bucket, entity, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.delete("/buckets/{bucket}/defaultAcl/{entity}", response_model=GCSGenericResponse,
summary="Delete a default object ACL entry")
async def delete_default_object_acl(
bucket: str,
entity: str,
body: Optional[Dict[str, Any]] = None,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(
service,
payload=(body or {}).get("credentials_json") or (body or {}).get("credentials"),
url=(body or {}).get("credentials_url"),
)
try:
await service.delete_default_object_acl(creds, bucket, entity)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data={"deleted": entity})
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Objects — list / upload / download
# ---------------------------------------------------------------------------
@router.get("/buckets/{bucket}/objects", response_model=GCSListResponse,
summary="List objects in a bucket")
async def list_objects(
bucket: str,
prefix: Optional[str] = Query(None, description="Filter objects whose names start with this prefix"),
delimiter: Optional[str] = Query(None, description="Fold object names at this delimiter (e.g. '/')"),
max_results: Optional[int] = Query(None, ge=1, le=1000, description="Maximum number of results"),
page_token: Optional[str] = Query(None, description="Pagination token from a previous response"),
versions: Optional[bool] = Query(None, description="Include object versions"),
match_glob: Optional[str] = Query(None, description="Glob pattern to filter object names"),
start_offset: Optional[str] = Query(None, description="Lexicographically first object to return"),
end_offset: Optional[str] = Query(None, description="Lexicographically last object to return"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.list_objects(
creds, bucket, prefix=prefix, delimiter=delimiter, max_results=max_results,
page_token=page_token, versions=versions, match_glob=match_glob,
start_offset=start_offset, end_offset=end_offset,
)
data = result.get("data") or {}
items = data.get("items", [])
return GCSListResponse(
success=True, time_ms=_elapsed_ms(start), count=len(items),
next_page_token=data.get("nextPageToken"),
items=items, prefixes=data.get("prefixes", []),
)
except GCSError as exc:
return _error_response(GCSListResponse, start, exc)
@router.post("/buckets/{bucket}/objects/upload", response_model=GCSGenericResponse,
summary="Upload an object from a file or a URL (up to the server upload limit)")
async def upload_object(
bucket: str,
name: Optional[str] = Form(None, min_length=1, max_length=1024, description="Destination object name (defaults to the uploaded file name)"),
file: Optional[UploadFile] = File(None, description="Object content to upload"),
file_url: Optional[str] = Form(None, description="Publicly reachable URL whose content becomes the object"),
content_type: Optional[str] = Form(None, description="Content-Type of the uploaded object (auto-detected when omitted)"),
metadata_json: str = Form(None, description="Optional JSON object of object metadata to set on upload"),
if_generation_match: Optional[int] = Form(None, description="Generation match condition"),
credentials_file: Optional[UploadFile] = File(None, description="Service account JSON file (alternative to inline credentials)"),
credentials_json: Optional[str] = Form(None, description="Service account JSON as a string"),
credentials_url: Optional[str] = Form(None, description="URL to a service account JSON file"),
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
if file is None and not file_url:
raise HTTPException(status_code=422, detail="Either 'file' or 'file_url' must be provided to upload an object.")
if file is not None and file_url:
raise HTTPException(status_code=422, detail="Provide either 'file' or 'file_url', not both.")
if name is None:
if file is not None and file.filename:
name = Path(file.filename).name
elif file_url:
parsed_url = urlparse(file_url)
name = Path(parsed_url.path).name or "download"
if not name or not name.strip():
raise HTTPException(status_code=422, detail="Object name must be non-empty and must not start with '/'.")
cleaned_name = name.strip()
if cleaned_name.startswith("/"):
raise HTTPException(status_code=422, detail="Object name must be non-empty and must not start with '/'.")
if content_type is None:
if file is not None and file.content_type:
content_type = file.content_type
else:
content_type = mimetypes.guess_type(cleaned_name)[0] or "application/octet-stream"
if not re.fullmatch(r"[\w./+-]{1,255}", content_type):
raise HTTPException(status_code=422, detail="content_type must be a valid media type.")
if credentials_file is not None:
cred_bytes = await _read_file_limited(credentials_file, what="credentials file")
creds = await _resolve(service, file_bytes=cred_bytes, file_name=credentials_file.filename)
else:
creds = await _resolve(service, payload=credentials_json, url=credentials_url)
if file_url:
try:
content, fetched_type = await service.fetch_url_content(file_url)
except GCSError as exc:
raise HTTPException(status_code=exc.status_code, detail=exc.message)
if len(content) > _MAX_UPLOAD_BYTES:
raise HTTPException(status_code=413, detail=f"Content from file_url exceeds the {_MAX_UPLOAD_BYTES} byte upload limit")
if fetched_type and (content_type == "application/octet-stream" or content_type == mimetypes.guess_type(cleaned_name)[0]):
content_type = fetched_type
else:
content = await _read_file_limited(file, what="file")
metadata: Dict[str, Any] = {}
if metadata_json:
try:
metadata = json.loads(metadata_json)
if not isinstance(metadata, dict):
raise ValueError("metadata_json must be a JSON object")
except (json.JSONDecodeError, ValueError) as exc:
raise HTTPException(status_code=400, detail=f"Invalid metadata_json: {exc}")
try:
result = await service.upload_object(
creds, bucket, cleaned_name, content,
content_type=content_type, metadata=metadata,
if_generation_match=if_generation_match,
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/upload/resumable", response_model=GCSGenericResponse,
summary="Start a resumable upload session and return its upload URI")
async def initiate_resumable_upload(
bucket: str,
body: GCSResumableUploadRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.initiate_resumable_upload(
creds, bucket, body.name,
content_type=body.content_type or "application/octet-stream",
object_metadata=body.object_metadata,
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data={"session_uri": result.get("session_uri")})
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/watch", response_model=GCSGenericResponse,
summary="Register an object-change notification channel for a bucket")
async def watch_all_objects(
bucket: str,
body: GCSWatchRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.watch_all_objects(creds, bucket, body.channel)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/objects/{object:path}/download", include_in_schema=False)
async def download_object_raw(
bucket: str,
object: str,
generation: Optional[int] = Query(None, description="Specific object generation to download"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
"""Download an object's raw bytes (returns the file directly)."""
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.download_object(creds, bucket, object, generation=generation)
except GCSError as exc:
raise HTTPException(status_code=exc.status_code, detail=exc.message)
content = result.get("data")
if not isinstance(content, bytes):
content = content or b""
content_type = result.get("content_type") or "application/octet-stream"
return Response(
content=content,
media_type=content_type,
headers={"Content-Disposition": f'attachment; filename="{object.split("/")[-1]}"'},
)
@router.get("/buckets/{bucket}/objects/{object:path}/download/base64", response_model=GCSDownloadResponse,
summary="Download an object as base64 (JSON response)")
async def download_object_base64(
bucket: str,
object: str,
generation: Optional[int] = Query(None, description="Specific object generation to download"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.download_object(creds, bucket, object, generation=generation)
except GCSError as exc:
return _error_response(GCSDownloadResponse, start, exc)
content = result.get("data")
content_bytes = content if isinstance(content, bytes) else (content or b"")
return GCSDownloadResponse(
success=True, time_ms=_elapsed_ms(start),
content_base64=base64.b64encode(content_bytes).decode("ascii"),
content_type=result.get("content_type"),
size_bytes=len(content_bytes),
)
@router.get("/buckets/{bucket}/objects/{object:path}/public-url", response_model=GCSURLResponse,
summary="Generate the public URL for an object")
async def public_url(
bucket: str,
object: str,
):
start = time.perf_counter()
url = GCSService.public_url(bucket, object)
return GCSURLResponse(success=True, time_ms=_elapsed_ms(start), url=url, method="GET")
# ---------------------------------------------------------------------------
# Objects — IAM
# ---------------------------------------------------------------------------
@router.get("/buckets/{bucket}/objects/{object:path}/iam", response_model=GCSGenericResponse,
summary="Get object IAM policy")
async def get_object_iam(
bucket: str,
object: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_object_iam(creds, bucket, object)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}/objects/{object:path}/iam", response_model=GCSGenericResponse,
summary="Set object IAM policy")
async def set_object_iam(
bucket: str,
object: str,
body: GCSBucketIAMRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.set_object_iam(creds, bucket, object, body.policy)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Objects — ACLs
# ---------------------------------------------------------------------------
@router.get("/buckets/{bucket}/objects/{object:path}/acl", response_model=GCSGenericResponse,
summary="List object ACLs")
async def list_object_acl(
bucket: str,
object: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.list_object_acl(creds, bucket, object)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/acl", response_model=GCSGenericResponse,
summary="Add an object ACL entry")
async def insert_object_acl(
bucket: str,
object: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.insert_object_acl(creds, bucket, object, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/objects/{object:path}/acl/{entity}", response_model=GCSGenericResponse,
summary="Get an object ACL entry")
async def get_object_acl(
bucket: str,
object: str,
entity: str,
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_object_acl(creds, bucket, object, entity)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.patch("/buckets/{bucket}/objects/{object:path}/acl/{entity}", response_model=GCSGenericResponse,
summary="Patch an object ACL entry")
async def patch_object_acl(
bucket: str,
object: str,
entity: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.patch_object_acl(creds, bucket, object, entity, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}/objects/{object:path}/acl/{entity}", response_model=GCSGenericResponse,
summary="Update an object ACL entry")
async def update_object_acl(
bucket: str,
object: str,
entity: str,
body: GCSACLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
acl = {"entity": body.entity, "role": body.role}
try:
result = await service.update_object_acl(creds, bucket, object, entity, acl)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.delete("/buckets/{bucket}/objects/{object:path}/acl/{entity}", response_model=GCSGenericResponse,
summary="Delete an object ACL entry")
async def delete_object_acl(
bucket: str,
object: str,
entity: str,
body: Optional[Dict[str, Any]] = None,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
payload = (body or {}).get("credentials_json") or (body or {}).get("credentials")
url = (body or {}).get("credentials_url")
creds = await _resolve(service, payload=payload, url=url)
try:
await service.delete_object_acl(creds, bucket, object, entity)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data={"deleted": entity})
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.get("/buckets/{bucket}/objects/{object:path}", response_model=GCSGenericResponse,
summary="Get object metadata")
async def get_object(
bucket: str,
object: str,
generation: Optional[int] = Query(None, description="Specific object generation"),
service: GCSService = Depends(get_gcs_service),
x_credentials: Optional[str] = Header(None, alias="X-Goog-Credentials"),
x_credentials_url: Optional[str] = Header(None, alias="X-Goog-Credentials-Url"),
):
start = time.perf_counter()
creds = await _resolve(service, payload=x_credentials, url=x_credentials_url)
try:
result = await service.get_object(creds, bucket, object, generation=generation)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.patch("/buckets/{bucket}/objects/{object:path}", response_model=GCSGenericResponse,
summary="Patch object metadata (partial update)")
async def patch_object(
bucket: str,
object: str,
body: GCSObjectUpdateRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.patch_object(creds, bucket, object, body.object,
if_generation_match=body.if_generation_match)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.put("/buckets/{bucket}/objects/{object:path}", response_model=GCSGenericResponse,
summary="Replace object metadata (full update)")
async def update_object(
bucket: str,
object: str,
body: GCSObjectUpdateRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.update_object(creds, bucket, object, body.object,
if_generation_match=body.if_generation_match)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.delete("/buckets/{bucket}/objects/{object:path}", response_model=GCSGenericResponse,
summary="Delete an object")
async def delete_object(
bucket: str,
object: str,
body: Optional[Dict[str, Any]] = None,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
payload = (body or {}).get("credentials_json") or (body or {}).get("credentials")
url = (body or {}).get("credentials_url")
creds = await _resolve(service, payload=payload, url=url)
generation = (body or {}).get("generation")
if_generation_match = (body or {}).get("if_generation_match")
try:
await service.delete_object(creds, bucket, object,
generation=generation, if_generation_match=if_generation_match)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data={"deleted": object})
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Objects — copy / move / rewrite / compose
# ---------------------------------------------------------------------------
@router.post("/buckets/{bucket}/objects/{object:path}/copy", response_model=GCSGenericResponse,
summary="Copy an object to a destination")
async def copy_object(
bucket: str,
object: str,
body: GCSObjectTransferRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.copy_object(
creds, bucket, object, body.destination_bucket, body.destination_name,
source_generation=body.source_generation, body=body.object,
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/move", response_model=GCSGenericResponse,
summary="Move an object to a destination")
async def move_object(
bucket: str,
object: str,
body: GCSObjectTransferRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.move_object(
creds, bucket, object, body.destination_bucket, body.destination_name,
source_generation=body.source_generation, if_generation_match=body.if_generation_match,
body=body.object,
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/rewrite", response_model=GCSGenericResponse,
summary="Rewrite (async copy) an object to a destination")
async def rewrite_object(
bucket: str,
object: str,
body: GCSObjectTransferRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.rewrite_object(
creds, bucket, object, body.destination_bucket, body.destination_name,
rewrite_token=body.rewrite_token,
max_bytes_rewritten_per_call=body.max_bytes_rewritten_per_call,
body=body.object,
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/hold", response_model=GCSGenericResponse,
summary="Set an event-based hold on an object")
async def set_object_hold(
bucket: str,
object: str,
body: GCSBaseCredentialsRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.set_object_hold(creds, bucket, object)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/releaseHold", response_model=GCSGenericResponse,
summary="Release an event-based hold on an object")
async def release_object_hold(
bucket: str,
object: str,
body: GCSBaseCredentialsRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.release_object_hold(creds, bucket, object)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/lockRetentionPolicy", response_model=GCSGenericResponse,
summary="Lock a retention policy on an object (permanent)")
async def lock_object_retention(
bucket: str,
object: str,
body: GCSBucketRestoreRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.lock_object_retention(
creds, bucket, object, if_metageneration_match=body.if_metageneration_match
)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/compose", response_model=GCSGenericResponse,
summary="Compose multiple source objects into this destination object")
async def compose_object(
bucket: str,
object: str,
body: GCSComposeRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
result = await service.compose_object(creds, bucket, object, body.source_objects, body=body.destination)
return GCSGenericResponse(success=True, time_ms=_elapsed_ms(start), data=result.get("data"))
except GCSError as exc:
return _error_response(GCSGenericResponse, start, exc)
# ---------------------------------------------------------------------------
# Public & signed URLs
# ---------------------------------------------------------------------------
@router.post("/buckets/{bucket}/objects/{object:path}/signed-url", response_model=GCSURLResponse,
summary="Generate a V4 signed download URL for an object")
async def signed_download_url(
bucket: str,
object: str,
body: GCSURLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
url, expires = await service.download_signed_url(
creds, bucket, object,
expires_in_seconds=body.expires_in_seconds,
response_content_type=body.response_content_type,
response_disposition=body.response_disposition,
)
return GCSURLResponse(
success=True, time_ms=_elapsed_ms(start), url=url,
method="GET", expires_in_seconds=expires,
)
except GCSError as exc:
return _error_response(GCSURLResponse, start, exc)
@router.post("/buckets/{bucket}/objects/{object:path}/signed-upload-url", response_model=GCSURLResponse,
summary="Generate a V4 signed upload URL for an object (PUT)")
async def signed_upload_url(
bucket: str,
object: str,
body: GCSURLRequest,
service: GCSService = Depends(get_gcs_service),
):
start = time.perf_counter()
creds = await _resolve(service, **_creds_fields(body))
try:
url, expires = await service.upload_signed_url(
creds, bucket, object,
expires_in_seconds=body.expires_in_seconds,
content_type=body.content_type,
)
return GCSURLResponse(
success=True, time_ms=_elapsed_ms(start), url=url,
method="PUT", expires_in_seconds=expires,
)
except GCSError as exc:
return _error_response(GCSURLResponse, start, exc)
|