cmem-cmemc 25.3.0__py3-none-any.whl → 25.5.0__py3-none-any.whl

cmem_cmemc/command_group.py

@@ -24,48 +24,49 @@ class CmemcGroup(HelpColorsGroup, DYMGroup):
         kwargs.setdefault(
             "help_options_custom_colors",
             {
+                "acl": self.color_for_command_groups,
+                "admin": self.color_for_command_groups,
                 "bootstrap": self.color_for_writing_commands,
-                "showcase": self.color_for_writing_commands,
-                "delete": self.color_for_writing_commands,
-                "password": self.color_for_writing_commands,
-                "secret": self.color_for_writing_commands,
-                "upload": self.color_for_writing_commands,
-                "import": self.color_for_writing_commands,
+                "cache": self.color_for_command_groups,
+                "cancel": self.color_for_writing_commands,
+                "client": self.color_for_command_groups,
+                "config": self.color_for_command_groups,
                 "create": self.color_for_writing_commands,
-                "enable": self.color_for_writing_commands,
+                "dataset": self.color_for_command_groups,
+                "delete": self.color_for_writing_commands,
                 "disable": self.color_for_writing_commands,
+                "enable": self.color_for_writing_commands,
+                "eval": self.color_for_writing_commands,
                 "execute": self.color_for_writing_commands,
-                "replay": self.color_for_writing_commands,
-                "io": self.color_for_writing_commands,
+                "graph": self.color_for_command_groups,
+                "import": self.color_for_writing_commands,
+                "imports": self.color_for_command_groups,
+                "insights": self.color_for_command_groups,
                 "install": self.color_for_writing_commands,
-                "uninstall": self.color_for_writing_commands,
-                "reload": self.color_for_writing_commands,
-                "update": self.color_for_writing_commands,
-                "eval": self.color_for_writing_commands,
-                "cancel": self.color_for_writing_commands,
-                "admin": self.color_for_command_groups,
-                "user": self.color_for_command_groups,
-                "store": self.color_for_command_groups,
+                "io": self.color_for_writing_commands,
                 "metrics": self.color_for_command_groups,
-                "config": self.color_for_command_groups,
-                "dataset": self.color_for_command_groups,
-                "graph": self.color_for_command_groups,
+                "migrate": self.color_for_writing_commands,
+                "migrations": self.color_for_command_groups,
+                "password": self.color_for_writing_commands,
                 "project": self.color_for_command_groups,
+                "python": self.color_for_command_groups,
                 "query": self.color_for_command_groups,
+                "reload": self.color_for_writing_commands,
+                "replay": self.color_for_writing_commands,
+                "resource": self.color_for_command_groups,
                 "scheduler": self.color_for_command_groups,
+                "secret": self.color_for_writing_commands,
+                "showcase": self.color_for_writing_commands,
+                "store": self.color_for_command_groups,
+                "uninstall": self.color_for_writing_commands,
+                "update": self.color_for_writing_commands,
+                "upload": self.color_for_writing_commands,
+                "user": self.color_for_command_groups,
+                "validation": self.color_for_command_groups,
+                "variable": self.color_for_command_groups,
                 "vocabulary": self.color_for_command_groups,
                 "workflow": self.color_for_command_groups,
                 "workspace": self.color_for_command_groups,
-                "python": self.color_for_command_groups,
-                "cache": self.color_for_command_groups,
-                "resource": self.color_for_command_groups,
-                "acl": self.color_for_command_groups,
-                "client": self.color_for_command_groups,
-                "variable": self.color_for_command_groups,
-                "validation": self.color_for_command_groups,
-                "migrate": self.color_for_writing_commands,
-                "migrations": self.color_for_command_groups,
-                "imports": self.color_for_command_groups,
             },
         )
         super().__init__(*args, **kwargs)

cmem_cmemc/commands/acl.py

@@ -35,7 +35,26 @@ HELP_TEXTS = {
     "read_graph": "Grants read access to a graph.",
     "write_graph": "Grants write access to a graph (includes read access).",
     "action": "Grants usage permissions to an action / functionality.",
+    "read_graph_pattern": (
+        "Grants management of conditions granting read access on graphs matching the defined "
+        "pattern. A pattern consists of a constant string and a wildcard ('*') at the end of "
+        "the pattern or the wildcard alone."
+    ),
+    "write_graph_pattern": (
+        "Grants management of conditions granting write access on graphs matching the defined "
+        "pattern. A pattern consists of a constant string and a wildcard ('*') at the end of "
+        "the pattern or the wildcard alone."
+    ),
+    "action_pattern": (
+        "Grants management of conditions granting action allowance for actions matching the "
+        "defined pattern. A pattern consists of a constant string and a wildcard ('*') at the "
+        "end of the pattern or the wildcard alone."
+    ),
     "query": "Dynamic access condition query (file or the query catalog IRI).",
+    "replace": (
+        "Replace (overwrite) existing access condition, if present. "
+        "Can be used only in combination with '--id'."
+    ),
 }
 
 WARNING_UNKNOWN_USER = "Unknown User or no access to get user info."
@@ -194,6 +213,27 @@ def inspect_command(app: ApplicationContext, access_condition_id: str, raw: bool
     shell_complete=completion.acl_actions,
     help=HELP_TEXTS["action"],
 )
+@click.option(
+    "--read-graph-pattern",
+    "read_graph_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["read_graph_pattern"],
+)
+@click.option(
+    "--write-graph-pattern",
+    "write_graph_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["write_graph_pattern"],
+)
+@click.option(
+    "--action-pattern",
+    "action_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["action_pattern"],
+)
 @click.option(
     "--query",
     "query",
@@ -219,6 +259,7 @@ def inspect_command(app: ApplicationContext, access_condition_id: str, raw: bool
     type=click.STRING,
     help=HELP_TEXTS["description"],
 )
+@click.option("--replace", is_flag=True, help=HELP_TEXTS["replace"])
 @click.pass_obj
 # pylint: disable-msg=too-many-arguments
 def create_command(  # noqa: PLR0913
@@ -231,7 +272,11 @@ def create_command(  # noqa: PLR0913
     read_graphs: tuple[str],
     write_graphs: tuple[str],
     actions: tuple[str],
+    read_graph_patterns: tuple[str],
+    write_graph_patterns: tuple[str],
+    action_patterns: tuple[str],
     query: str,
+    replace: bool,
 ) -> None:
     """Create an access condition.
 
@@ -254,17 +299,29 @@ def create_command(  # noqa: PLR0913
 
     Example: cmemc admin acl create --group local-users --write-graph https://example.org/
     """
-    if not read_graphs and not write_graphs and not actions and not query:
+    if replace and not id_:
+        raise click.UsageError("To replace an access condition, you must specify an ID.")
+
+    if (
+        not read_graphs
+        and not write_graphs
+        and not actions
+        and not read_graph_patterns
+        and not write_graph_patterns
+        and not action_patterns
+        and not query
+    ):
         raise click.UsageError(
             "Missing access / usage grant. Use at least one of the following options: "
-            "--read-graph, --write-graph, --action or --query."
+            "--read-graph, --write-graph, --action, --read-graph-pattern, "
+            "--write-graph-pattern, --action-pattern or --query."
         )
     query_str = None
     if query:
         query_str = get_query_text(query, {"user", "group", "readGraph", "writeGraph"})
 
     if not user and not groups and not query:
-        app.echo_warning("Access conditions without a user or group assignment affect ALL users.")
+        app.echo_warning("Access conditions without a user or group assignment affects ALL users.")
 
     if not name:
         name = generate_acl_name(user=user, groups=groups, query=query)
@@ -272,11 +329,11 @@ def create_command(  # noqa: PLR0913
     if not description:
         description = "This access condition was created with cmemc."
 
-    app.echo_info(
-        f"Creating access condition '{name}' ... ",
-        nl=False,
-    )
-
+    if replace and NS_ACL + id_ in [_["iri"] for _ in fetch_all_acls()]:
+        app.echo_info(f"Replacing access condition '{id_}' ... ", nl=False)
+        delete_access_condition(iri=NS_ACL + id_)
+    else:
+        app.echo_info(f"Creating access condition '{name}' ... ", nl=False)
     create_access_condition(
         name=name,
         static_id=id_,
@@ -286,6 +343,9 @@ def create_command(  # noqa: PLR0913
         read_graphs=list(read_graphs),
         write_graphs=list(write_graphs),
         actions=[convert_qname_to_iri(qname=_, default_ns=NS_ACTION) for _ in actions],
+        read_graph_patterns=list(read_graph_patterns),
+        write_graph_patterns=list(write_graph_patterns),
+        action_patterns=list(action_patterns),
         query=query_str,
     )
     app.echo_success("done")
@@ -351,6 +411,27 @@ def create_command(  # noqa: PLR0913
     shell_complete=completion.acl_actions,
     help=HELP_TEXTS["action"],
 )
+@click.option(
+    "--read-graph-pattern",
+    "read_graph_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["read_graph_pattern"],
+)
+@click.option(
+    "--write-graph-pattern",
+    "write_graph_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["write_graph_pattern"],
+)
+@click.option(
+    "--action-pattern",
+    "action_patterns",
+    type=click.STRING,
+    multiple=True,
+    help=HELP_TEXTS["action_pattern"],
+)
 @click.option(
     "--query",
     "query",
@@ -370,6 +451,9 @@ def update_command(  # noqa: PLR0913
     read_graphs: tuple[str],
     write_graphs: tuple[str],
     actions: tuple[str],
+    read_graph_patterns: tuple[str],
+    write_graph_patterns: tuple[str],
+    action_patterns: tuple[str],
     query: str,
 ) -> None:
     """Update an access condition.
@@ -396,6 +480,9 @@ def update_command(  # noqa: PLR0913
         read_graphs=read_graphs,
         write_graphs=write_graphs,
         actions=[convert_qname_to_iri(qname=_, default_ns=NS_ACTION) for _ in actions],
+        read_graph_patterns=read_graph_patterns,
+        write_graph_patterns=write_graph_patterns,
+        action_patterns=action_patterns,
         query=query_str,
     )
     app.echo_success("done")

cmem_cmemc/commands/admin.py

@@ -4,6 +4,7 @@ from datetime import datetime, timezone
 
 import click
 import jwt
+import timeago
 from click import ClickException
 from cmem.cmempy.api import get_access_token, get_token
 from cmem.cmempy.config import get_cmem_base_uri
@@ -185,8 +186,14 @@ def status_command(  # noqa: C901, PLR0912
     help="Decode the access token and outputs the raw JSON. Note that the "
     "access token is only decoded and esp. not validated.",
 )
+@click.option(
+    "--ttl",
+    is_flag=True,
+    help="Output information about the lifetime of the access token. "
+    "In combination with --raw, it outputs the TTL in seconds.",
+)
 @click.pass_obj
-def token_command(app: ApplicationContext, raw: bool, decode: bool) -> None:
+def token_command(app: ApplicationContext, raw: bool, decode: bool, ttl: bool) -> None:
     """Fetch and output an access token.
 
     This command can be used to check for correct authentication as well as
@@ -202,9 +209,30 @@ def token_command(app: ApplicationContext, raw: bool, decode: bool) -> None:
     # - get_access_token returns the token string which is maybe from conf
     # - get_token fetches a new token incl. envelope from keycloak
 
+    token = get_access_token()
+    decoded_token = jwt.decode(token, options={"verify_signature": False})
+    if ttl:
+        app.echo_debug(token)
+        iat_ts = decoded_token["iat"]
+        exp_ts = decoded_token["exp"]
+        ttl_in_seconds = exp_ts - iat_ts
+        if raw:
+            app.echo_info_json(ttl_in_seconds)
+            return
+        exp_time = datetime.fromtimestamp(exp_ts, tz=timezone.utc)
+        now_time = datetime.now(tz=timezone.utc)
+        ttl_delta = timeago.format(exp_time, now_time)
+        if ttl_delta.startswith("in"):
+            app.echo_info(
+                f"The provided access token will expire {ttl_delta} "
+                f"(TTL is {ttl_in_seconds} seconds)."
+            )
+        else:
+            app.echo_info(
+                f"The provided access token expired {ttl_delta} (TTL was {ttl_in_seconds} seconds)."
+            )
+        return
     if decode:
-        token = get_access_token()
-        decoded_token = jwt.decode(token, options={"verify_signature": False})
         if raw:
             app.echo_info_json(decoded_token)
             return
@@ -214,7 +242,6 @@ def token_command(app: ApplicationContext, raw: bool, decode: bool) -> None:
     if raw:
         app.echo_info_json(get_token())
         return
-    token = get_access_token()
     app.echo_info(token)
 
 

cmem_cmemc/commands/graph.py

@@ -27,6 +27,7 @@ from cmem_cmemc import completion
 from cmem_cmemc.command import CmemcCommand
 from cmem_cmemc.command_group import CmemcGroup
 from cmem_cmemc.commands.graph_imports import graph_imports_list, imports_group
+from cmem_cmemc.commands.graph_insights import insights_group
 from cmem_cmemc.commands.validation import validation_group
 from cmem_cmemc.constants import UNKNOWN_GRAPH_ERROR
 from cmem_cmemc.context import ApplicationContext
@@ -567,10 +568,11 @@ def _get_graph_supported_formats() -> dict[str, str]:
 
 def _get_buffer_and_content_type(
     triple_file: str, app: ApplicationContext
-) -> tuple[io.BytesIO, str]:
-    """Get the io.BytesIO buffer and the content type of triple_file"""
+) -> tuple[io.BytesIO, str, None | str]:
+    """Get the io.BytesIO buffer, the content type and the content encoding of a triple_file"""
     smart_file = SmartPath(triple_file)
     content_type, encoding = mimetypes.guess_type(triple_file)
+    content_encoding = "gzip" if smart_file.name.endswith(".gz") else None
     if content_type is None:
         content_type = "text/turtle"
         for supported_type, supported_suffix in _get_graph_supported_formats().items():
@@ -596,7 +598,7 @@ def _get_buffer_and_content_type(
     with ClickSmartPath.open(triple_file, transport_params=transport_params) as file_obj:
         buffer.write(file_obj.read())
     buffer.seek(0)
-    return buffer, content_type
+    return buffer, content_type, content_encoding
 
 
 def _create_graph_imports(ctx: Context, graphs: list[RdfGraphData]) -> None:
@@ -748,9 +750,13 @@ def import_command(  # noqa: PLR0913
             continue
         # prevents re-replacing of graphs in a single run
         _replace = False if graph_iri in processed_graphs else replace
-        _buffer, content_type = _get_buffer_and_content_type(triple_file, app)
+        _buffer, content_type, content_encoding = _get_buffer_and_content_type(triple_file, app)
         response = graph_api.post_streamed(
-            graph_iri, _buffer, replace=_replace, content_type=content_type
+            graph_iri,
+            _buffer,
+            replace=_replace,
+            content_type=content_type,
+            content_encoding=content_encoding,
         )
         request_headers = response.request.headers
         request_headers.pop("Authorization")
@@ -886,3 +892,4 @@ graph.add_command(import_command)
 graph.add_command(open_command)
 graph.add_command(validation_group)
 graph.add_command(imports_group)
+graph.add_command(insights_group)

cmem_cmemc/commands/graph_imports.py

@@ -12,7 +12,6 @@ from treelib import Tree
 from cmem_cmemc import completion
 from cmem_cmemc.command import CmemcCommand
 from cmem_cmemc.command_group import CmemcGroup
-from cmem_cmemc.completion import escape_colon
 from cmem_cmemc.constants import UNKNOWN_GRAPH_ERROR
 from cmem_cmemc.context import ApplicationContext
 from cmem_cmemc.object_list import DirectValuePropertyFilter, ObjectList
@@ -299,7 +298,7 @@ def _validate_graphs(from_graph: str | None, to_graph: str | None) -> None:
 def _from_graph_uris(ctx: Context, param: Argument, incomplete: str) -> list[CompletionItem]:
     """Provide auto completion items for delete command from-graph argument"""
     imports = get_imports_list(ctx)
-    from_graphs = {escape_colon(_["from_graph"]) for _ in imports}
+    from_graphs = {_["from_graph"] for _ in imports}
     return [
         _
         for _ in completion.graph_uris(ctx=ctx, param=param, incomplete=incomplete)
@@ -311,15 +310,13 @@ def _to_graph_uris(ctx: Context, param: Argument, incomplete: str) -> list[Compl
     """Provide auto completion items for create/delete command to-graph argument"""
     from_graph = ctx.params["from_graph"]
     imports = graph_imports_list.apply_filters(ctx=ctx, filter_=[("from-graph", from_graph)])
-    to_graphs = {escape_colon(_["to_graph"]) for _ in imports}
+    to_graphs = {_["to_graph"] for _ in imports}
     command = ctx.command.name
     return [
         _
         for _ in completion.graph_uris(ctx=ctx, param=param, incomplete=incomplete)
         if (command == "delete" and _.value in to_graphs)
-        or (
-            command == "create" and _.value not in to_graphs and _.value != escape_colon(from_graph)
-        )
+        or (command == "create" and _.value not in to_graphs and _.value != from_graph)
     ]