Visibility update

examples/hilton/simplepopulate.py

@@ -2,6 +2,7 @@
 Populates the simple example server with a bunch of ACT maps.
 """
 
+import argparse
 from pathlib import Path
 
 from hippoclient import Client
@@ -25,6 +26,21 @@
 identical to v1.0.
 """
 
+
+parser = argparse.ArgumentParser(
+    description="Populate ACT maps to the server with visbility."
+)
+parser.add_argument(
+    "--visibility",
+    type=str,
+    choices=["public", "private", "collaboration"],
+    default="collaboration",
+    help="Set visibility for the products.",
+)
+args = parser.parse_args()
+
+USER_VISIBILITY = args.visibility
+
 catalogs = {
     "DR5_cluster-catalog_v1.1.fits": CatalogMetadata(
         file_type="fits",
@@ -130,6 +146,7 @@
             metadata=catalogs[catalog],
             sources=[Path(catalog)],
             source_descriptions=["Catalog file"],
+            visibility=USER_VISIBILITY,
         )
 
         add_to_collection(
@@ -145,6 +162,7 @@
         metadata=mask,
         sources=[Path("DR5_cluster-search-area-mask_v1.0.fits")],
         source_descriptions=["Mask file"],
+        visibility=USER_VISIBILITY,
     )
 
     add_to_collection(

hippoclient/cli.py

@@ -58,6 +58,20 @@ def product_read(id: str):
         CONSOLE.print("Parents: " + ", ".join(product_extracted_version.child_of))
 
 
+@product_app.command("set-visibility")
+def product_set_visibility(id: str, visibility: str):
+    """
+    Set the visibility level of a product.
+
+    Example:
+    $ hippo product set-visibility <product-id> <visibility>
+    """
+
+    global CLIENT
+    sc.product.set_visibility(client=CLIENT, id=id, visibility=visibility)
+    CONSOLE.print(f"Visibility set to {visibility} for product {id}.")
+
+
 @product_app.command("delete")
 def product_delete(id: str):
     """
@@ -148,6 +162,21 @@ def collection_cache(id: str):
     CONSOLE.print(f"Cached collection {id} including {len(response)} files")
 
 
+@collection_app.command("set-visibility")
+def collection_set_visibility(id: str, visibility: str):
+    """
+    Set the visibility level of a collection.
+
+    Example:
+    $ hippo collection set-visibility <collection-id> <visibility>
+    """
+    global CLIENT
+    sc.collections.set_collection_visibility(
+        client=CLIENT, collection_id=id, visibility=visibility
+    )
+    CONSOLE.print(f"Visibility set to {visibility} for collection {id}.")
+
+
 @collection_app.command("uncache")
 def collection_uncache(id: str):
     """

hippoclient/collections.py

@@ -4,7 +4,9 @@
 
 from pathlib import Path
 
+from hippoclient.product import set_visibility as set_product_visibility
 from hipposerve.api.models.relationships import ReadCollectionResponse
+from hipposerve.database import Visibility
 
 from .core import Client, MultiCache, console
 from .product import cache as cache_product
@@ -272,3 +274,60 @@ def uncache(client: Client, cache: MultiCache, id: str) -> None:
 
     for product in collection.products:
         uncache_product(client, cache, product.id)
+
+
+def set_collection_visibility(
+    client: Client, collection_id: str, visibility: str
+) -> None:
+    """
+    Update the visibility of all products in a collection.
+
+    Arguments
+    ---------
+    client: Client
+        The client to use for interacting with the hippo API.
+    collection_id : str
+        The ID of the collection whose products' visibility is being updated.
+    visibility : str
+        The new visibility level ('public', 'collaboration', or 'private').
+
+    Raises
+    ------
+    ValueError
+        If an invalid visibility level is provided.
+    httpx.HTTPStatusError
+        If a request to the API fails.
+    """
+
+    # Validate visibility
+    try:
+        visibility_enum = Visibility(visibility)
+    except ValueError:
+        raise ValueError(
+            "Invalid visibility level. Choose from 'public', 'collaboration', or 'private'."
+        )
+
+    # Fetch the collection details
+    collection = read(client, collection_id)
+
+    # Update visibility for each product in the collection
+    console.print(
+        f"Updating visibility to '{visibility}' for all products in collection '{collection.name}'...",
+        style="blue",
+    )
+    for product in collection.products:
+        try:
+            set_product_visibility(client, product.id, visibility_enum.value)
+            console.print(
+                f"Successfully updated visibility for product {product.id}.",
+                style="green",
+            )
+        except Exception as e:
+            console.print(
+                f"Failed to update product {product.id}: {str(e)}", style="red"
+            )
+
+    console.print(
+        f"Successfully updated visibility for all products in collection '{collection.name}'.",
+        style="bold green",
+    )

hippoclient/product.py

@@ -9,7 +9,7 @@
 from hippometa import ALL_METADATA_TYPE
 from hippometa.simple import SimpleMetadata
 from hipposerve.api.models.product import ReadProductResponse
-from hipposerve.database import ProductMetadata
+from hipposerve.database import ProductMetadata, Visibility
 from hipposerve.service.product import PostUploadFile
 
 from .core import Client, MultiCache, console
@@ -22,6 +22,7 @@ def create(
     metadata: ALL_METADATA_TYPE,
     sources: list[Path],
     source_descriptions: list[str | None],
+    visibility: str = "collaboration",
 ) -> str:
     """
     Create a product in hippo.
@@ -57,6 +58,12 @@ def create(
         If a request to the API fails
     """
 
+    # Validate visibility
+    if visibility not in ["public", "collaboration", "private"]:
+        raise ValueError(
+            "Invalid visibility level. Choose from 'public', 'collaboration', or 'private'."
+        )
+
     # Check and validate the sources.
     assert len(sources) == len(source_descriptions)
 
@@ -88,6 +95,7 @@ def create(
             "description": description,
             "metadata": metadata.model_dump(),
             "sources": source_metadata,
+            "visibility": visibility,
         },
     )
 
@@ -352,3 +360,40 @@ def uncache(client: Client, cache: MultiCache, id: str) -> None:
                 console.print(f"Removed file {source.name} ({source.uuid}) from cache")
 
     return
+
+
+def set_visibility(client: Client, id: str, visibility: str) -> None:
+    """
+    Update the visibility of a product.
+
+    Arguments
+    ---------
+    client: Client
+        The client to use for interacting with the hippo API.
+    collection_id : str
+        The ID of the product whose visibility is being updated.
+    visibility : str
+        The new visibility level ('public', 'collaboration', or 'private').
+
+    Raises
+    ------
+    ValueError
+        If an invalid visibility level is provided.
+    """
+    # Validate the provided visibility level
+    try:
+        visibility_enum = Visibility(visibility)  # Convert string to Visibility enum
+    except ValueError:
+        raise ValueError(
+            "Invalid visibility level. Choose from 'public', 'collaboration', or 'private'."
+        )
+
+    response = client.get(f"/product/{id}/set-visibility/{visibility}")
+
+    response.raise_for_status()
+
+    if client.verbose:
+        console.print(
+            f"Successfully updated product {id} to {visibility_enum.value} visibility.",
+            style="bold green",
+        )

hipposerve/api/models/product.py

@@ -15,6 +15,7 @@ class CreateProductRequest(BaseModel):
     description: str
     metadata: ALL_METADATA_TYPE
     sources: list[PreUploadFile]
+    visibility: str
 
 
 class CreateProductResponse(BaseModel):
@@ -43,6 +44,7 @@ class UpdateProductRequest(BaseModel):
     replace_sources: list[PreUploadFile] = []
     drop_sources: list[str] = []
     level: VersionRevision = VersionRevision.MINOR
+    visibility: str = "collaboration"
 
 
 class UpdateProductResponse(BaseModel):