remoteRF-server 1.1.0.dev34__py3-none-any.whl → 1.1.0.dev36__py3-none-any.whl

remoteRF_server/server/commands.py

@@ -153,8 +153,8 @@ def _table() -> list[Command]:
         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"),
         Command(("cluster remove",), "Leave or disband: cluster remove <name>", _federation("remove"), "Clusters"),
-        Command(("cluster groups",), "Groups you share: cluster groups <name> [add|remove <group>]", _federation("groups"), "Clusters"),
-        Command(("cluster codes",), "Student codes for a cluster: cluster codes <name> [count]", _federation("codes"), "Clusters"),
+        Command(("cluster groups",), "Choose which of your groups a cluster shares (interactive)", _federation("groups"), "Clusters"),
+        Command(("cluster codes",), "Codes for your users to join a cluster: cluster codes [count]", _federation("codes"), "Clusters"),
         Command(("cluster accept",), "", _federation("accept"), "Clusters", hidden=True),
         Command(("global cluster",), "", _federation("cluster"), "Global", hidden=True),
         # ---- gist ----

remoteRF_server/server/federation/cli.py

@@ -17,6 +17,7 @@
 
 from __future__ import annotations
 
+import re
 import sys
 from pathlib import Path
 
@@ -37,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
 
@@ -63,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 ""))
@@ -71,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)
@@ -106,7 +117,7 @@ def _ask_for(verb: str) -> str:
     what = {"create": "Name for the new cluster (short slug, e.g. ucla-lab)",
             "invite": "Which cluster to invite a lab into",
             "accept": "Which cluster's pending join to accept",
-            "groups": "Which cluster's shared groups to show",
+            "groups": "Which cluster to share groups with",
             "codes": "Which cluster to make student codes for",
             "remove": "Which cluster to leave (revokes the contract)"}[verb]
     if verb != "create" and names:
@@ -115,6 +126,40 @@ def _ask_for(verb: str) -> str:
     return _input(f"{what}{f' [{default}]' if default else ''}: ") or default
 
 
+def _share_groups(name: str) -> int:
+    """Pick, by number, which of this server's groups the cluster shares.
+    Toggling: a shared group chosen again is unshared."""
+    from ...common.utils.ansi_codes import Sty
+    from ..user_group_handler import user_group_handler
+    from . import cluster
+
+    all_groups = user_group_handler.get_all_user_groups(include_users=False) or []
+    if not all_groups:
+        _print("  No user groups yet: make one with `groups create`, then share it here.", Sty.WARNING)
+        return 1
+    shared = {g["group_id"] for g in cluster.groups(name)}
+    print(f"  Groups on this server (shared with {name} are marked):")
+    for index, group in enumerate(all_groups, 1):
+        mark = "*" if int(group["group_id"]) in shared else " "
+        devices = group.get("devices_whitelist") or []
+        print(f"   {mark} {index:>2}  {group['group_name']}  ({len(devices)} device{'s' if len(devices) != 1 else ''})")
+    answer = _input("Toggle by number, e.g. 2 or 1,3 (Enter to leave as is): ")
+    picks = [part for part in re.split(r"[\s,]+", answer) if part]
+    if not picks:
+        return 0
+    for pick in picks:
+        if not pick.isdigit() or not 1 <= int(pick) <= len(all_groups):
+            _print(f"  {pick} is not a number in the list.", Sty.WARNING)
+            continue
+        group = all_groups[int(pick) - 1]
+        if int(group["group_id"]) in shared:
+            _print(f"  {cluster.detach_group(name, str(group['group_id']))} is no longer shared with {name}.", Sty.GRAY)
+        else:
+            _print(f"  {cluster.attach_group(name, str(group['group_id']))} is now shared with {name}; "
+                   "everyone in the cluster gets it.", Sty.GRAY)
+    return 0
+
+
 def _input(prompt: str) -> str:
     # The console's own prompt session: a bare input() inside the running
     # server fights prompt_toolkit for the terminal and kills the process.
@@ -128,7 +173,7 @@ def _input(prompt: str) -> str:
 
 
 _USAGE = ("Usage: cluster list | cluster create|invite|remove <name> | cluster join <code> | "
-          "cluster groups <name> [add|remove <group>] | cluster codes <name> [count]")
+          "cluster groups [<name>] | cluster codes [<name>] [count]")
 
 
 def cmd_cluster(argv: list[str]) -> int:
@@ -140,6 +185,10 @@ def cmd_cluster(argv: list[str]) -> int:
     words = [a for a in argv[1:] if not a.startswith("--")]
     if verb == "list" and not words:
         return cmd_clusters()
+    if verb == "codes" and words and words[0].isdigit() and words[0] not in cluster.load():
+        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"):
         # Leaving the argument out asks for it (docs/deployment-groups.md §8).
         answer = _ask_for(verb)
@@ -167,10 +216,8 @@ def cmd_cluster(argv: list[str]) -> int:
         elif verb == "remove" and arg:
             _print(f"  {arg}: {cluster.remove(arg)}.", Sty.GRAY)
         elif verb == "groups" and len(words) == 1:
-            shared = cluster.groups(arg)
-            _print(f"  {arg} shares: " + (", ".join(g["group_name"] for g in shared) or "nothing yet"), Sty.GRAY)
-            _print(f"  Attach one with `cluster groups {arg} add <group>`; students of every lab in the "
-                   "cluster get it. Group names stay on this server.", Sty.GRAY)
+            cluster._find(cluster.load(), arg)
+            return _share_groups(arg)
         elif verb == "groups" and len(words) == 3 and words[1] in ("add", "remove"):
             if words[1] == "add":
                 _print(f"  {cluster.attach_group(arg, words[2])} is now shared with {arg}.", Sty.GRAY)

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,23 @@ 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 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)})
     return out
 
 
+def _sharing(name: str) -> dict:
+    """Counts only -- all a partner ever learns about what we share."""
+    shared = groups(name)
+    return {"groups": len(shared), "devices": len({d for g in shared for d in g["devices"]})}
+
+
 def _account_counts(name: str) -> dict:
     with _usergroups() as conn:
         rows = dict(conn.execute(
@@ -687,6 +701,32 @@ 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"]}
+
+
 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 +814,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 +837,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.dev34.dist-info → remoterf_server-1.1.0.dev36.dist-info}/METADATA

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

{remoterf_server-1.1.0.dev34.dist-info → remoterf_server-1.1.0.dev36.dist-info}/RECORD

@@ -52,7 +52,7 @@ 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=9ExGTi3nG7wqgSAyOEIFMDz0iBFLwC8QJdXrKNZNB5A,17277
+remoteRF_server/server/commands.py,sha256=xG_RAYm0nHDqN74b-QPHizw2OodfrYAvdYlVNNi7tGE,17279
 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
@@ -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=nFlUGmhpndw0RafjeRQjz7cYieKtKy7U60_n738g-s0,9021
-remoteRF_server/server/federation/cluster.py,sha256=yKGFRAI-RHB_xZivJkxaK_Fniz2XGRUfArJXM_DH2WQ,33207
+remoteRF_server/server/federation/cli.py,sha256=iZpS-31516atRauI6zXdCTw81hV7QNEdyDqC8ijXoEA,11175
+remoteRF_server/server/federation/cluster.py,sha256=m_SW942R7d0a8X16kMfKn3fdUbyJsAmonI67Wl8OIOs,35529
 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.dev34.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-remoterf_server-1.1.0.dev34.dist-info/METADATA,sha256=HF3Nrx8Y6Id4gZt4THauRMrCve0ZazMtLrMtVsYpyWU,42069
-remoterf_server-1.1.0.dev34.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-remoterf_server-1.1.0.dev34.dist-info/entry_points.txt,sha256=_bbKk65PfYi-n6zUjqOiOwcalf_Ws1TCGATIe1TukxE,136
-remoterf_server-1.1.0.dev34.dist-info/top_level.txt,sha256=NuYWe8dSx3qdbxshWBwOgx68EHmJ9I8Zvxam4ARsQ_I,30
-remoterf_server-1.1.0.dev34.dist-info/RECORD,,
+remoterf_server-1.1.0.dev36.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+remoterf_server-1.1.0.dev36.dist-info/METADATA,sha256=PA_v4CEjH9HfN0EABXND3J1B53HdPVIhfxZhxwQ_vvc,42069
+remoterf_server-1.1.0.dev36.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+remoterf_server-1.1.0.dev36.dist-info/entry_points.txt,sha256=_bbKk65PfYi-n6zUjqOiOwcalf_Ws1TCGATIe1TukxE,136
+remoterf_server-1.1.0.dev36.dist-info/top_level.txt,sha256=NuYWe8dSx3qdbxshWBwOgx68EHmJ9I8Zvxam4ARsQ_I,30
+remoterf_server-1.1.0.dev36.dist-info/RECORD,,