remoteRF-server 1.1.0.dev35__py3-none-any.whl → 1.1.0.dev37__py3-none-any.whl

remoteRF_server/server/commands.py

@@ -149,6 +149,7 @@ def _table() -> list[Command]:
         Command(("global leave",), "Stop participating", _global("leave"), "Global"),
         # ---- clusters (sharing devices with other labs) ----
         Command(("cluster list",), "Clusters shared with other labs", _federation("list"), "Clusters"),
+        Command(("cluster info",), "Every lab, shared group and device in a cluster", _federation("info"), "Clusters"),
         Command(("cluster create",), "Start a cluster: cluster create <name>", _federation("create"), "Clusters"),
         Command(("cluster invite",), "Invite code for a lab: cluster invite <name>", _federation("invite"), "Clusters"),
         Command(("cluster join",), "Join with a code: cluster join <code>", _federation("join"), "Clusters"),

remoteRF_server/server/device_manager.py

@@ -704,6 +704,20 @@ def get_registered_devices() -> Dict[int, Tuple[object, str, str]]:
             gid: (st.dev, st.salt, st.hsh) for gid, st in _devices.items()
         }
 
+def describe_devices(ids) -> list[dict]:
+    """Name, type and live state for the given ids (unknown ids are skipped)."""
+    _sync_host_devices()
+    out = []
+    with _state_lock:
+        for gid in ids:
+            st = _devices.get(int(gid))
+            if st is None:
+                continue
+            out.append({"id": int(gid), "name": (st.name or f"device-{gid}").strip(),
+                        "type": st.dtype or "", "online": _is_connected(st)})
+    return out
+
+
 def get_all_devices_str() -> Dict[int, str]:
     _sync_host_devices()
 

remoteRF_server/server/federation/cli.py

@@ -38,6 +38,10 @@ def _lab(party: dict) -> str:
     return f"{party['display_name']} ({short}…)" if party.get("display_name") else party["deployment_id"]
 
 
+def _n(count: int, noun: str) -> str:
+    return f"{count} {noun}{'' if count == 1 else 's'}"
+
+
 def _day(epoch) -> str:
     import datetime
 
@@ -64,6 +68,7 @@ def cmd_clusters() -> int:
     for index, item in enumerate(items):
         if index:
             rows.append("")
+        owner_row = None
         if item["role"] == "owner":
             invites = item["open_invites"]
             rows.append(f"{item['name']}  (yours)" + (f"  {invites} open invite{'s' if invites != 1 else ''}" if invites else ""))
@@ -72,20 +77,25 @@ def cmd_clusters() -> int:
             if not item["members"] and not invites:
                 rows.append(f"    nobody yet: `cluster invite {item['name']}`")
         else:
-            owner = {"display_name": item.get("peer_name"), "deployment_id": item["peer"]}
+            owner_row = owner = {"display_name": item.get("peer_name"), "deployment_id": item["peer"]}
             rows.append(f"{item['name']}  {item['state']}")
             labs = [(owner, "admin", "", None), (me, "member", "", None)] + [
                 (p, "member", p["state"] or "joining", None) for p in item.get("peers", [])]
         for lab, role, lab_state, since in labs:
-            you = "  (you)" if lab["deployment_id"] == me["deployment_id"] else ""
-            line = f"    {_lab(lab)}  {role}{you}"
+            you = lab["deployment_id"] == me["deployment_id"]
+            line = f"    {_lab(lab)}  {role}" + ("  (you)" if you else "")
             if lab_state and lab_state != "active":
                 line += f"  {lab_state}"
             if since:
                 line += f"  since {_day(since)}"
             rows.append(line)
-        if item["groups"]:
-            rows.append("    sharing: " + ", ".join(group["group_name"] for group in item["groups"]))
+            if you:
+                rows.append("        sharing: " + (", ".join(
+                    f"{g['group_name']} ({_n(len(g['devices']), 'device')})" for g in item["groups"]) or "nothing"))
+            else:
+                sharing = lab.get("sharing") if lab is not owner_row else item.get("peer_sharing")
+                if sharing:
+                    rows.append(f"        sharing {_n(sharing['groups'], 'group')}, {_n(sharing['devices'], 'device')}")
         rows.append(f"    {item['students']} of your users enrolled, {item['visitors']} visiting")
     print()
     print_panel("Clusters", rows, literal=True)
@@ -93,6 +103,58 @@ def cmd_clusters() -> int:
     return 0
 
 
+def cmd_cluster_info(name: str) -> int:
+    """Every lab in the cluster, each shared group with its limits, each device."""
+    from ...common.utils.panel import print_panel
+    from ..device_manager import describe_devices
+    from ..user_group_cli import _fmt_duration
+    from . import cluster
+
+    config = load_config()
+    state = load_state(Path(config["identity_dir"]))
+    item = {i["name"]: i for i in cluster.list_clusters()}.get(name)
+    if item is None:
+        raise cluster.ClusterError(f"no cluster named {name}")
+    me = {"display_name": config["display_name"], "deployment_id": state.deployment_id}
+    mine = {"groups": len(item["groups"]), "detail": [
+        {"name": g["group_name"], "max_reservation_time_sec": g["max_reservation_time_sec"],
+         "max_reservations": g["max_reservations"], "lifetime_sec": g["lifetime_sec"],
+         "devices": describe_devices(g["devices"])}
+        for g in item["groups"]]}
+    if item["role"] == "owner":
+        labs = [(me, "admin", mine)] + [(m, "member", m.get("sharing")) for m in item["members"]]
+    else:
+        owner = {"display_name": item.get("peer_name"), "deployment_id": item["peer"]}
+        labs = [(owner, "admin", item.get("peer_sharing")), (me, "member", mine)] + [
+            (p, "member", p.get("sharing")) for p in item.get("peers", [])]
+    rows = []
+    for index, (lab, role, sharing) in enumerate(labs):
+        if index:
+            rows.append("")
+        rows.append(f"{_lab(lab)}  {role}" + ("  (you)" if lab["deployment_id"] == me["deployment_id"] else ""))
+        if sharing is None:
+            rows.append("    (no details from this lab yet)")
+            continue
+        if not sharing.get("detail"):
+            rows.append("    shares nothing")
+        for group in sharing["detail"]:
+            limits = " · ".join([
+                _n(len(group["devices"]), "device"),
+                f"{_fmt_duration(group['max_reservation_time_sec'])} max per reservation",
+                f"{_n(group['max_reservations'], 'reservation')} at once",
+                "no expiry" if group["lifetime_sec"] <= 0 else f"expires after {_fmt_duration(group['lifetime_sec'])}",
+            ])
+            rows.append(f"    {group['name']}  —  {limits}")
+            width = max([len(d["name"]) for d in group["devices"]] + [4])
+            for device in group["devices"]:
+                rows.append(f"        {device['id']:>6}  {device['name']:<{width}}  {device['type'] or '?':<12}  "
+                            + ("online" if device["online"] else "offline"))
+    print()
+    print_panel(f"Cluster {name}", rows, literal=True)
+    print()
+    return 0
+
+
 def _ask_for(verb: str) -> str:
     """Prompt for the missing cluster name (or invite code), offering the obvious default."""
     from . import cluster
@@ -100,7 +162,7 @@ def _ask_for(verb: str) -> str:
     if verb == "join":
         return _input("Invite code from the other lab: ")
     names = [name for name, item in sorted(cluster.load().items()) if item.get("role") == "owner"]
-    if verb in ("remove", "groups", "codes"):
+    if verb in ("remove", "groups", "codes", "info"):
         names = sorted(cluster.load())
     if verb == "accept":
         names = [name for name, item in sorted(cluster.load().items()) if item.get("state") == "pending"]
@@ -108,6 +170,7 @@ def _ask_for(verb: str) -> str:
             "invite": "Which cluster to invite a lab into",
             "accept": "Which cluster's pending join to accept",
             "groups": "Which cluster to share groups with",
+            "info": "Which cluster to show",
             "codes": "Which cluster to make student codes for",
             "remove": "Which cluster to leave (revokes the contract)"}[verb]
     if verb != "create" and names:
@@ -163,7 +226,7 @@ def _input(prompt: str) -> str:
 
 
 _USAGE = ("Usage: cluster list | cluster create|invite|remove <name> | cluster join <code> | "
-          "cluster groups [<name>] | cluster codes [<name>] [count]")
+          "cluster info [<name>] | cluster groups [<name>] | cluster codes [<name>] [count]")
 
 
 def cmd_cluster(argv: list[str]) -> int:
@@ -179,7 +242,7 @@ def cmd_cluster(argv: list[str]) -> int:
         words = [_ask_for(verb), words[0]]  # `cluster codes 3`: the count came first
         if not words[0]:
             return 2
-    if not words and verb in ("create", "invite", "accept", "join", "remove", "groups", "codes"):
+    if not words and verb in ("create", "invite", "accept", "join", "remove", "groups", "codes", "info"):
         # Leaving the argument out asks for it (docs/deployment-groups.md §8).
         answer = _ask_for(verb)
         if not answer:
@@ -205,6 +268,8 @@ def cmd_cluster(argv: list[str]) -> int:
             _print(f"  Accepted. {arg} activates once both servers confirm (about a minute).", Sty.GRAY)
         elif verb == "remove" and arg:
             _print(f"  {arg}: {cluster.remove(arg)}.", Sty.GRAY)
+        elif verb == "info" and arg:
+            return cmd_cluster_info(arg)
         elif verb == "groups" and len(words) == 1:
             cluster._find(cluster.load(), arg)
             return _share_groups(arg)
@@ -233,7 +298,7 @@ def main(argv) -> int:
     # `cluster <verb> …` from the table; `global cluster …` is the old spelling.
     if argv and argv[0] in ("cluster", "clusters"):
         argv = argv[1:] or ["list"]
-    if argv and argv[0] in ("list", "create", "invite", "join", "accept", "remove", "groups", "codes"):
+    if argv and argv[0] in ("list", "create", "invite", "join", "accept", "remove", "groups", "codes", "info"):
         return cmd_cluster(argv)
     print(_USAGE, file=sys.stderr)
     return 2

remoteRF_server/server/federation/cluster.py

@@ -404,7 +404,8 @@ def list_clusters() -> list[dict]:
                     except ContractError:
                         pass
                 members.append({"deployment_id": peer, "display_name": member.get("display_name"),
-                                "state": state, "joined_at": member.get("joined_at")})
+                                "state": state, "joined_at": member.get("joined_at"),
+                                "sharing": member.get("sharing")})
             item.update(members=members, open_invites=len(cluster["invites"]))
         else:
             state = cluster.get("state")
@@ -414,9 +415,11 @@ def list_clusters() -> list[dict]:
                     state = store.show(cluster["contract_id"], 1)["state"]
                 except ContractError:
                     pass
-            peers = [{"deployment_id": peer, "display_name": party.get("display_name"), "state": party.get("state")}
+            peers = [{"deployment_id": peer, "display_name": party.get("display_name"), "state": party.get("state"),
+                      "sharing": party.get("sharing")}
                      for peer, party in sorted(cluster.get("peers", {}).items())]
-            item.update(peer=cluster["peer"], peer_name=cluster.get("peer_name"), state=state, peers=peers)
+            item.update(peer=cluster["peer"], peer_name=cluster.get("peer_name"), state=state, peers=peers,
+                        peer_sharing=cluster.get("sharing"))
         item.update(groups=groups(name), **_account_counts(name))
         out.append(item)
     return out
@@ -445,12 +448,34 @@ def groups(name: str) -> list[dict]:
     out = []
     with _usergroups() as conn:
         for group_id in cluster.get("groups", []):
-            row = conn.execute("SELECT group_name FROM UserGroups WHERE group_id=?", (group_id,)).fetchone()
+            row = conn.execute(
+                "SELECT group_name,devices_whitelist,max_reservation_time_sec,max_reservations,lifetime_sec "
+                "FROM UserGroups WHERE group_id=?", (group_id,)).fetchone()
             if row is not None:
-                out.append({"group_id": group_id, "group_name": row[0]})
+                try:
+                    devices = {int(d) for d in json.loads(row[1] or "[]")}
+                except (ValueError, TypeError):
+                    devices = set()
+                out.append({"group_id": group_id, "group_name": row[0], "devices": sorted(devices),
+                            "max_reservation_time_sec": int(row[2]), "max_reservations": int(row[3]),
+                            "lifetime_sec": int(row[4])})
     return out
 
 
+def _sharing(name: str) -> dict:
+    """What the other labs in the cluster get told about what we share:
+    counts, plus each shared group's limits and devices (`cluster info`)."""
+    from ..device_manager import describe_devices
+
+    shared = groups(name)
+    detail = [{
+        "name": g["group_name"], "max_reservation_time_sec": g["max_reservation_time_sec"],
+        "max_reservations": g["max_reservations"], "lifetime_sec": g["lifetime_sec"],
+        "devices": describe_devices(g["devices"]),
+    } for g in shared]
+    return {"groups": len(shared), "devices": len({d for g in shared for d in g["devices"]}), "detail": detail}
+
+
 def _account_counts(name: str) -> dict:
     with _usergroups() as conn:
         rows = dict(conn.execute(
@@ -687,6 +712,33 @@ def _publish_roster(name: str, cluster: dict) -> None:
     cluster["roster"] = active
 
 
+def _publish_status(name: str, cluster: dict) -> None:
+    """Any lab: post our counts for this cluster when they change."""
+    sharing = _sharing(name)
+    if sharing == cluster.get("status"):
+        return
+    key, _, me = g._signing_material()
+    owner = me if cluster["role"] == "owner" else cluster["peer"]
+    status = {"cluster_name": name, "owner": owner, "deployment_id": me, "issued_at": int(time.time()), **sharing}
+    signature = base64.b64encode(key.sign(canonical_json(status).encode())).decode("ascii")
+    g.call("POST", "/v2/broker/clusters/roster", {"protocol_version": "2", "status": status, "signature": signature})
+    cluster["status"] = sharing
+
+
+def _take_statuses(name: str, cluster: dict, statuses: list[dict]) -> None:
+    """Attach each partner's verified counts to its row."""
+    owner = g._signing_material()[2] if cluster["role"] == "owner" else cluster["peer"]
+    parties = dict(_parties(cluster))
+    for item in statuses:
+        status = item.get("status") or {}
+        peer = status.get("deployment_id")
+        if status.get("owner") != owner or status.get("cluster_name") != name or peer not in parties:
+            continue
+        if _roster_signed_by(peer, status, item.get("signature", "")):
+            parties[peer]["sharing"] = {"groups": status["groups"], "devices": status["devices"],
+                                        "detail": status.get("detail", [])}
+
+
 def _roster_signed_by(owner: str, roster: dict, signature: str) -> bool:
     from cryptography.exceptions import InvalidSignature
     from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PublicKey
@@ -774,7 +826,7 @@ def tick(notify=None, home=None) -> None:
         return
     directory = None
     broker_invites = None
-    rosters = None
+    board = None  # rosters and status notes, one GET for all clusters
     for name, cluster in clusters.items():
         if cluster["role"] == "owner":
             if cluster["invites"]:
@@ -797,9 +849,15 @@ def tick(notify=None, home=None) -> None:
             if directory is None:
                 directory = g.call("GET", "/v2/broker/contracts")["contracts"]
             _advance(cluster, cluster["peer"], directory, label=name, notify=notify, is_member=True)
-            if rosters is None:
-                rosters = g.call("GET", "/v2/broker/clusters/roster")["rosters"]
-            _mesh(name, cluster, rosters, directory, notify)
+        if board is None:
+            board = g.call("GET", "/v2/broker/clusters/roster")
+        if cluster["role"] != "owner":
+            _mesh(name, cluster, board["rosters"], directory, notify)
+        try:
+            _publish_status(name, cluster)
+        except g.GlobalError as exc:
+            notify(f"[cluster] {name}: could not publish what we share: {exc}")
+        _take_statuses(name, cluster, board.get("statuses", []))
         save(clusters)
     if home is not None:
         enroll_students(home, notify)

{remoterf_server-1.1.0.dev35.dist-info → remoterf_server-1.1.0.dev37.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoteRF-server
-Version: 1.1.0.dev35
+Version: 1.1.0.dev37
 Summary: RemoteRF server-side control package
 License: GPL-3.0-or-later
 Classifier: Programming Language :: Python :: 3

{remoterf_server-1.1.0.dev35.dist-info → remoterf_server-1.1.0.dev37.dist-info}/RECORD

@@ -52,10 +52,10 @@ remoteRF_server/host/host_tunnel_server.py,sha256=sz06xOtFbaDZSy1UQfw6faKhJmuOy5
 remoteRF_server/server/__init__.py,sha256=-1h_xQjiE66oiWRO-vnLGJ4smpgUNhFuV-ZreW9_tD4,667
 remoteRF_server/server/acc_perms.py,sha256=2loCvstVu8uvsb2uCv2Sk7iNQ5GyO_sBIkPQFzqOaRI,13334
 remoteRF_server/server/cert_provider.py,sha256=CRDrZL4DSf-eL6wzPJzwucrzPLOr2PvNRq5V--oZtr0,6272
-remoteRF_server/server/commands.py,sha256=xG_RAYm0nHDqN74b-QPHizw2OodfrYAvdYlVNNi7tGE,17279
+remoteRF_server/server/commands.py,sha256=6HcvEpznOblV57NMuOJTl2VY2js1wbuLV9mwxGDqMeg,17399
 remoteRF_server/server/console.py,sha256=J91LfwPVmBgielOxfE740NOYduekggyZkqi-47y_A4w,4472
 remoteRF_server/server/control.py,sha256=Uq1Fk0zIoHHX_EXfz3OuNle8urvO_UhAiB5Lk5cs2e4,5177
-remoteRF_server/server/device_manager.py,sha256=nRTvk_jeZFU3QnlM6qf3DIckU2V2e_gyDeD5gW14KQI,38802
+remoteRF_server/server/device_manager.py,sha256=PPuCwlPSmjfVpCqy_hCaOr9WvFgE8mqtLMhWOAgXNDA,39281
 remoteRF_server/server/direct_path.py,sha256=CQs0uPTANJq6Bn-TzsV0APmD3hYKH8xYvczXZZk1OXk,15229
 remoteRF_server/server/dynamic_v2.py,sha256=AMhQEFhNAvCNcF-PdfCCQQLmeoaR7s1Os8et1KFGn_8,70814
 remoteRF_server/server/global_onboarding.py,sha256=boLAKXCKvcsIY3TDiFwduMaHdDMB9Cr104MyWJYZ-BA,39891
@@ -70,8 +70,8 @@ remoteRF_server/server/deployment/__init__.py,sha256=YV86uafd8XiGD7sLaqNfO5xxmt5
 remoteRF_server/server/deployment/capabilities.py,sha256=20RxmGG03VoQQZnV3jGhc-3i9B5hOl5fCopnsErFjPk,872
 remoteRF_server/server/federation/__init__.py,sha256=auqdGiGnEGIKQiXX2jFVt8iWmfyZ-V3w4dUmtWDKAZE,735
 remoteRF_server/server/federation/admin.py,sha256=t3F17FIytekzclPICmaFJEA4-F5OuWcDx3rgmFga17A,9187
-remoteRF_server/server/federation/cli.py,sha256=m3fzURqmnZH1pO7wHyqg5EUoo4ZPiw7P3K_9q8SXQu8,10703
-remoteRF_server/server/federation/cluster.py,sha256=yKGFRAI-RHB_xZivJkxaK_Fniz2XGRUfArJXM_DH2WQ,33207
+remoteRF_server/server/federation/cli.py,sha256=rMA81mk656tP29cPntTIlLE95JTUeJ-RdNZSTU_eJuI,13995
+remoteRF_server/server/federation/cluster.py,sha256=bQpT7jq-2d87ae6AkmsKktozBsULSy3QrIbAVgBLMQg,36238
 remoteRF_server/server/federation/contracts.py,sha256=NYh7lb_9etJHFfzXwevjC4HfSBUypLxg5xGeBgydLF4,29305
 remoteRF_server/server/federation/destination.py,sha256=XawmGCiVbL_MfNNn8xwV9_bYxUDW1L7efCpL11K2JAc,35909
 remoteRF_server/server/federation/devices.py,sha256=n5MvnD0UZyl4sFpiekG9ProanWXTYizYq6YchCflLgY,18061
@@ -90,9 +90,9 @@ remoteRF_server/tools/gen_certs.py,sha256=Vbyu8JjRu__UYPVmyCRXt5SOw0Za1HV7g1md3G
 remoteRF_server/tools/gist_status.py,sha256=SFv2iQgQrIKT9gxKrU-_Dr7S0p0rE4wQM6J3OC6FcoM,4649
 remoteRF_server/tools/gist_status_testing.py,sha256=IYw7UkPjAUpKDTtIlnYGb5g6SJkwz4TRGUfJJ6f4LhQ,2690
 remoteRF_server/tools/introspect_uhd.py,sha256=vUpPb0rM9tsHPxWadS3EfMDE-gMd-TvNV0TjrZOQqBY,4531
-remoterf_server-1.1.0.dev35.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-remoterf_server-1.1.0.dev35.dist-info/METADATA,sha256=meRywJNeTPy2Yol5Gc-G6zGPXnvPdyIkH-JlIe9H93Y,42069
-remoterf_server-1.1.0.dev35.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-remoterf_server-1.1.0.dev35.dist-info/entry_points.txt,sha256=_bbKk65PfYi-n6zUjqOiOwcalf_Ws1TCGATIe1TukxE,136
-remoterf_server-1.1.0.dev35.dist-info/top_level.txt,sha256=NuYWe8dSx3qdbxshWBwOgx68EHmJ9I8Zvxam4ARsQ_I,30
-remoterf_server-1.1.0.dev35.dist-info/RECORD,,
+remoterf_server-1.1.0.dev37.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+remoterf_server-1.1.0.dev37.dist-info/METADATA,sha256=L_odnm8vq5_QVx26laNnT9KsfhijKBkDPfgubrd_hig,42069
+remoterf_server-1.1.0.dev37.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+remoterf_server-1.1.0.dev37.dist-info/entry_points.txt,sha256=_bbKk65PfYi-n6zUjqOiOwcalf_Ws1TCGATIe1TukxE,136
+remoterf_server-1.1.0.dev37.dist-info/top_level.txt,sha256=NuYWe8dSx3qdbxshWBwOgx68EHmJ9I8Zvxam4ARsQ_I,30
+remoterf_server-1.1.0.dev37.dist-info/RECORD,,