gea-program 0.65.0__tar.gz → 0.66.0__tar.gz

{gea_program-0.65.0/gea_program.egg-info → gea_program-0.66.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.65.0
+Version: 0.66.0
 Summary: GEA-Program: downhole gauge monitoring - canonical measurement records, quality rules, drift evaluation with a re-fit change log, well-test validation, alarm management, model cards, store-and-forward, monthly SLA measurement, FAT/SAT protocols and a dashboard, generated from live objects in the client's reporting outline.
 Author: Daniel T. Murphy
 License: MPL-2.0
@@ -1426,11 +1426,12 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.65.0.exe` (for 0.65.0): the
+Every release also carries `GEA-Program-Setup-0.66.0.exe` (for 0.66.0): the
 same Windows kit installed like any Windows program, for the signed-in user
 alone and with no administrator rights (`%LOCALAPPDATA%\Programs\GEA-Program`).
 It asks for the site workspace (an existing one such as `C:\site` is used as
-it is), runs the kit's `install.cmd` with no network, and adds Start-menu and
+it is, its name included; a new one is made with the site name it asks for,
+which heads every report), runs the kit's `install.cmd` with no network, and adds Start-menu and
 desktop shortcuts, an Add/Remove Programs entry and, when chosen, a start at
 sign-in. The shortcut **GEA-Program** starts the control panel when it is not
 running and opens it in Microsoft Edge's app window (its own window and
@@ -1442,7 +1443,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.65.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /TASKS="desktopicon"
+GEA-Program-Setup-0.66.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
 ```
 
 The setup is built by Inno Setup 6 from `tools/installer.iss` in the same

{gea_program-0.65.0 → gea_program-0.66.0}/README.md

@@ -1387,11 +1387,12 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.65.0.exe` (for 0.65.0): the
+Every release also carries `GEA-Program-Setup-0.66.0.exe` (for 0.66.0): the
 same Windows kit installed like any Windows program, for the signed-in user
 alone and with no administrator rights (`%LOCALAPPDATA%\Programs\GEA-Program`).
 It asks for the site workspace (an existing one such as `C:\site` is used as
-it is), runs the kit's `install.cmd` with no network, and adds Start-menu and
+it is, its name included; a new one is made with the site name it asks for,
+which heads every report), runs the kit's `install.cmd` with no network, and adds Start-menu and
 desktop shortcuts, an Add/Remove Programs entry and, when chosen, a start at
 sign-in. The shortcut **GEA-Program** starts the control panel when it is not
 running and opens it in Microsoft Edge's app window (its own window and
@@ -1403,7 +1404,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.65.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /TASKS="desktopicon"
+GEA-Program-Setup-0.66.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
 ```
 
 The setup is built by Inno Setup 6 from `tools/installer.iss` in the same

{gea_program-0.65.0 → gea_program-0.66.0}/gea/__init__.py

@@ -123,7 +123,7 @@ from .profile_catalog import (
     read_pangaea_txt,
 )
 
-__version__ = "0.65.0"
+__version__ = "0.66.0"
 __all__ = [
     "aging_rate", "rate_psi_yr", "accuracy_psi",
     "Sensor", "SimulatorConfig", "DownholeEngine",

{gea_program-0.65.0 → gea_program-0.66.0}/gea/__main__.py

@@ -823,6 +823,7 @@ def main(argv=None) -> int:
     p_la.add_argument("--selftest", action="store_true", help="say what a launch would do here (the kit, the workspace, the window, the command), start nothing")
     p_la.add_argument("--json", action="store_true")
     p_la.add_argument("--set-workspace", type=str, default=None, help="record the site workspace for this installation (the installer runs it; never a folder inside the program's own)")
+    p_la.add_argument("--site-name", type=str, default=None, help="with --set-workspace: make the workspace with this name when there is none there yet (an existing one is left as it is; empty names it after its folder)")
     p_ty = sub.add_parser("tray", help="the program's icon in the Windows notification area: running or stopped, and a menu to open, start or stop the control panel")
     p_ty.add_argument("--workspace", type=str, default=None, help="the workspace folder (as gea launch finds it)")
     p_ty.add_argument("--port", type=int, default=8765)

{gea_program-0.65.0 → gea_program-0.66.0}/gea/acceptance_tests.py

@@ -14549,6 +14549,136 @@ def section_dh_windows_installer(tmp: str) -> None:
        + (f" [failed: {', '.join(failed6)}]" if failed6 else ""))
 
 
+def section_di_site_name(tmp: str) -> None:
+    """Section DI - the site's name: asked for by the installer and given to a workspace it makes, an existing workspace
+    left with its own; never written into the kit's scripts; changed on the Administration page and in the first-run
+    guide, heading every report from then on, audited; the workflow's own install checks it."""
+    import argparse as _ap
+    import contextlib as _cl
+    import http.cookiejar
+    import importlib.util
+    import io as _io
+    import urllib.error
+    import urllib.request
+    from . import launcher as L
+    from .doctor import kit_dir as _doctor_kit
+    from .service import Service, Users
+    from .workspace import Workspace
+    pkg = Path(__file__).parent
+    d = Path(tmp, "site_name"); d.mkdir()
+    checkout = (pkg.parent / "pyproject.toml").exists() and (pkg.parent / "tools" / "installer.iss").exists()
+
+    # -- DI1 the installer's workspace, made with its name ---------------------------------------------------------------------------
+    kit = d / "Programs" / "GEA-Program"; (kit / "python").mkdir(parents=True)
+    (kit / "start-dashboard.cmd").write_text("@echo off\n", encoding="utf-8")
+    new_ws, old_ws, plain_ws = str(d / "new site"), str(d / "old site"), str(d / "Pad 7")
+    Workspace.create(old_ws, "Pad 3", actor="tester")
+    old_bytes = Path(old_ws, "workspace.json").read_bytes()
+    saved = L.kit_dir
+    outs = {}
+    try:
+        L.kit_dir = lambda executable=None: kit
+        for key, ws_, nm in (("new", new_ws, "Jörg's Pad 3 – east"), ("old", old_ws, "Something else"), ("plain", plain_ws, ""), ("quote", str(d / "q site"), 'Pad "3"'),
+                             ("record_only", str(d / "rec site"), None)):
+            buf = _io.StringIO()
+            with _cl.redirect_stdout(buf):
+                rc = L.main(_ap.Namespace(set_workspace=ws_, site_name=nm, selftest=False, workspace=None, port=8765, background=False, no_tray=False))
+            outs[key] = (rc, buf.getvalue())
+    finally:
+        L.kit_dir = saved
+    name_of = lambda p: json.loads(Path(p, "workspace.json").read_text(encoding="utf-8"))["name"] if Path(p, "workspace.json").exists() else None
+    c1 = {
+        "made_named": outs["new"][0] == 0 and name_of(new_ws) == "Jörg's Pad 3 – east" and "made, named Jörg's Pad 3 – east" in outs["new"][1]
+                      and Workspace(new_ws).audit_log()[-1]["actor"] == "installer",
+        "existing_kept": outs["old"][0] == 0 and Path(old_ws, "workspace.json").read_bytes() == old_bytes and "exists and is used as it is" in outs["old"][1],
+        "empty_is_folder": outs["plain"][0] == 0 and name_of(plain_ws) == "Pad 7",
+        "quote_not_taken": outs["quote"][0] == 2 and name_of(str(d / "q site")) is None and "quotation marks" in outs["quote"][1],
+        "record_only": outs["record_only"][0] == 0 and name_of(str(d / "rec site")) is None,
+        "limits": L.check_site_name("x" * 81) is not None and L.check_site_name("x" * 80) is None and L.check_site_name("a\tb") is not None,
+    }
+    failed1 = [k for k, v in c1.items() if not v]
+    ok(not failed1,
+       "DI1 the installer's site name: a workspace the setup makes is made with the name asked for (any letters; no quotation marks, tabs or "
+       "line breaks; 80 characters at most), or the folder's name when none is given; an existing workspace is used exactly as it is, its "
+       "own name kept, byte for byte" + (f" [failed: {', '.join(failed1)}]" if failed1 else ""))
+
+    # -- DI2 no site's name in the kit; the setup asks only when it makes the workspace ------------------------------------------------
+    if checkout:
+        spec = importlib.util.spec_from_file_location("di_installer", str(pkg.parent / "tools" / "build_installer.py"))
+        bi = importlib.util.module_from_spec(spec); spec.loader.exec_module(bi)
+        start_cmd, start_sh = bi.WIN_SCRIPTS["start-dashboard.cmd"], bi.LINUX_SCRIPTS["start-dashboard.sh"]
+        iss = (pkg.parent / "tools" / "installer.iss").read_text(encoding="utf-8")
+        wf = (pkg.parent / ".github" / "workflows" / "build-installer.yml").read_text(encoding="utf-8")
+        code = iss[iss.index("[Code]"):]
+        nb = code.split("function NextButtonClick", 1)[1].split("\nend;", 1)[0]
+        c2 = {
+            "page": "CreateInputQueryPage(WsPage.ID" in code and "{param:SITENAME|}" in code and "Result := WorkspaceExists();" in code.split("function ShouldSkipPage", 1)[1]
+                    and "SiteNameProblem(SiteName())" in nb and code.count("SiteNameProblem(SiteName())") == 2,
+            "made_by_program": "--site-name \"' + SiteName() + '\"'" in code and "Pos('\"', S) > 0" in code,
+            "workflow": '/SITENAME="CI Pad"' in wf and "expected 'CI Pad'" in wf and "the upgrade changed the existing workspace" in wf,
+        }
+        where2 = "the checkout's templates and installer"
+    else:
+        kd = _doctor_kit(); where2 = f"the installed kit at {kd}"
+        start_cmd = open(os.path.join(kd, "start-dashboard.cmd"), encoding="utf-8").read() if kd and os.path.isfile(os.path.join(kd, "start-dashboard.cmd")) else ""
+        start_sh = open(os.path.join(kd, "start-dashboard.sh"), encoding="utf-8").read() if kd and os.path.isfile(os.path.join(kd, "start-dashboard.sh")) else ""
+        c2 = {}
+    init_lines = [ln for ln in (start_cmd + "\n" + start_sh).splitlines() if "--action init" in ln]
+    c2["kit_unnamed"] = all("--name" not in ln for ln in init_lines) and "Pad 3" not in start_cmd + start_sh and (bool(init_lines) or not (start_cmd or start_sh))
+    failed2 = [k for k, v in c2.items() if not v]
+    ok(not failed2,
+       f"DI2 ({where2}) the kit's launchers make a missing workspace named after its folder - no site's name is written into them (before "
+       "v0.66 every kit named a new workspace Pad 3); the setup asks for the name only when it makes the workspace, skips the question for "
+       "one that exists, passes it to the program to make it, and its build makes one named and upgrades it unchanged"
+       + (f" [failed: {', '.join(failed2)}]" if failed2 else ""))
+
+    # -- DI3 renamed in the control panel ----------------------------------------------------------------------------------------------
+    wsp = str(d / "panel"); Workspace.create(wsp, "site", actor="tester")
+    users = Users(str(Path(wsp, "users.json")))
+    users.add("adm", "admin-pass-123", "admin"); users.add("op", "op-pass-123", "operator")
+    svc = Service(wsp, port=0, scheduler=False).start()
+    base_url = svc.url.rstrip("/")
+
+    def opener(name, pw_):
+        o = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()))
+        rq = urllib.request.Request(base_url + "/api/login", method="POST", data=json.dumps({"name": name, "password": pw_}).encode())
+        rq.add_header("Content-Type", "application/json"); rq.add_header("X-GEA-Action", "1"); o.open(rq, timeout=30)
+        return o
+
+    def call(o, method, path, body=None):
+        rq = urllib.request.Request(base_url + path, method=method, data=(json.dumps(body).encode() if body is not None else None))
+        rq.add_header("Content-Type", "application/json"); rq.add_header("X-GEA-Action", "1")
+        try:
+            with o.open(rq, timeout=60) as rr_:
+                return rr_.status, json.loads(rr_.read())
+        except urllib.error.HTTPError as e:
+            return e.code, json.loads(e.read())
+    try:
+        adm, op = opener("adm", "admin-pass-123"), opener("op", "op-pass-123")
+        s_op, _ = call(op, "POST", "/api/site", {"site": {"name": "Pad 9"}})
+        s_empty, e_empty = call(adm, "POST", "/api/site", {"site": {"name": "  "}})
+        s_q, e_q = call(adm, "POST", "/api/site", {"site": {"name": 'Pad "9"'}})
+        s_ok, r_ok = call(adm, "POST", "/api/site", {"site": {"name": "Pad 9 – north", "units": "si"}})
+        s_only, r_only = call(adm, "POST", "/api/site", {"site": {"name": "Pad 9 – north"}})
+        _, sess = call(op, "GET", "/api/session")
+    finally:
+        svc.stop()
+    renames = [e for e in Workspace(wsp).audit_log() if e.get("action") == "workspace.rename"]
+    page_src = (pkg / "web" / "app.html").read_text(encoding="utf-8")
+    c3 = {
+        "admin_only": s_op == 403,
+        "checked": s_empty == 400 and "not empty" in e_empty.get("error", "") and s_q == 400 and "quotation" in e_q.get("error", ""),
+        "renamed": s_ok == 200 and r_ok.get("site", {}).get("units") == "si" and sess.get("workspace") == "Pad 9 – north" and Workspace(wsp).manifest["name"] == "Pad 9 – north",
+        "audited_once": len(renames) == 1 and renames[0]["actor"] == "adm" and renames[0]["detail"] == {"from": "site", "to": "Pad 9 – north"} and s_only == 200,
+        "page": all(x in page_src for x in ('id="stSiteName"', 'id="wSiteName"', "{name: nm}", "The site's name heads every report")),
+    }
+    failed3 = [k for k, v in c3.items() if not v]
+    ok(not failed3,
+       "DI3 the site's name changed in the control panel (Administration's site settings, and the first-run guide's first step), by an "
+       "administrator only: an empty name or one with quotation marks answered, the new name heading the page and every report from then on, "
+       "one audit line per change" + (f" [failed: {', '.join(failed3)}]" if failed3 else ""))
+
+
 def main() -> int:
     print("GEA-Program - ACCEPTANCE SUITE (the product gate)")
     # a handle a job subprocess still holds at the end must not turn a finished gate into a traceback on Windows:
@@ -14664,6 +14794,7 @@ def main() -> int:
         section_df_trusted_timestamp(tmp)
         section_dg_casing_program(tmp)
         section_dh_windows_installer(tmp)
+        section_di_site_name(tmp)
     if _FAILS:
         print(f"[ACCEPTANCE] {len(_FAILS)} FAILURES ({_PASS} passed):")
         for f in _FAILS:

{gea_program-0.65.0 → gea_program-0.66.0}/gea/help/IT_SECURITY.md

@@ -24,9 +24,11 @@ system service (a per-user scheduled task only if the site runs
 and desktop, an optional shortcut in the user's Startup folder, and the
 user's own Add/Remove Programs entry (`HKCU`, the only registry key it
 writes, removed by its uninstaller). Silent install for a software
-deployment: `/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site"`.
-The setup never writes into the site workspace and will not take one inside the
-program's own folder; the uninstaller stops the control panel, removes the
+deployment: `/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site"`
+(`/SITENAME="Pad 3"` names a workspace the setup makes).
+The setup never writes into an existing site workspace (a new one it makes,
+with the site name asked for) and will not take one inside the program's own
+folder; the uninstaller stops the control panel, removes the
 program and leaves the workspace. The program's window is Microsoft Edge's
 app window (`msedge --app=` on the local address); its notification-area
 icon (standard library `ctypes`, `Shell_NotifyIconW`) reads only whether the

{gea_program-0.65.0 → gea_program-0.66.0}/gea/help/install.md

@@ -2,7 +2,7 @@
 
 > GEA-Program-Setup: the program installed for you like any Windows program - a window of its own, an icon in the notification area, Start-menu and desktop shortcuts, an Add/Remove Programs entry, upgrades in place - with no administrator rights and the site's data left where it is.
 
-**The command**: download the setup from the release on GitHub (`GEA-Program-Setup-0.65.0.exe` for this version) and run it. It installs for you alone, under `%LOCALAPPDATA%\Programs\GEA-Program`, and asks for one thing: the site workspace - the folder that holds the wells, reports, records, accounts and keys (an existing one such as `C:\site` is used as it is; otherwise `%LOCALAPPDATA%\GEA-Program\site`, made at the first start). Then the Start menu's **GEA-Program** (and the desktop shortcut) starts the control panel when it is not running and opens it in a window of its own. A newer setup installs over the older one: it stops the control panel, replaces the program, keeps the workspace and the choices made before. For a site's software deployment: `GEA-Program-Setup-0.65.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /TASKS="desktopicon"`. From a terminal: `gea launch` does what the shortcut does, `gea launch --selftest` says what it would do, `gea tray --selftest` checks the icon.
+**The command**: download the setup from the release on GitHub (`GEA-Program-Setup-0.66.0.exe` for this version) and run it. It installs for you alone, under `%LOCALAPPDATA%\Programs\GEA-Program`, and asks for the site workspace - the folder that holds the wells, reports, records, accounts and keys. An existing one such as `C:\site` is used exactly as it is, its name included; for a new one (by default `%LOCALAPPDATA%\GEA-Program\site`) it also asks the site's name, which heads every report, and makes the workspace with it (left empty, the workspace is named after its folder; an administrator renames the site in Administration's site settings). Then the Start menu's **GEA-Program** (and the desktop shortcut) starts the control panel when it is not running and opens it in a window of its own. A newer setup installs over the older one: it stops the control panel, replaces the program, keeps the workspace and the choices made before. For a site's software deployment: `GEA-Program-Setup-0.66.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"` (`/SITENAME` names a workspace the setup makes; one that exists keeps its own name). From a terminal: `gea launch` does what the shortcut does, `gea launch --selftest` says what it would do, `gea tray --selftest` checks the icon.
 
 **The window**: Microsoft Edge's app window (`msedge --app=`: the control panel with no tabs and no address bar, its own button on the taskbar, signed in as the browser is), else Google Chrome's, else a tab in the default browser. The control panel itself runs in the window titled "GEA - Operations Control Panel", minimised on the taskbar: the window that starts it again when the panel asks for a restart and says why it stopped when it stops. Closing that window stops the panel.
 
@@ -10,11 +10,11 @@
 
 **Starting at sign-in**: the setup's "Start the control panel when I sign in to Windows" puts a GEA-Program shortcut in the Startup folder: the control panel starts in the background with its icon, and no window opens until you open one. The install kit's `register-service.cmd` (a scheduled task) does the same for a kit that was not installed by the setup.
 
-**What it writes**: the program under `%LOCALAPPDATA%\Programs\GEA-Program` (the install kit, and the package installed into the kit's own Python by its `install.cmd`, from its own wheels, with no network); `site-workspace.txt` there, the workspace you chose; the shortcuts; the Add/Remove Programs entry under the current user. Setup and uninstall never write into the workspace, never move it and never delete it, and will not take a workspace inside the program's own folder (which an upgrade replaces and the uninstaller removes). Uninstalling stops the control panel and its icon, then removes the program and what `install.cmd` added to it.
+**What it writes**: the program under `%LOCALAPPDATA%\Programs\GEA-Program` (the install kit, and the package installed into the kit's own Python by its `install.cmd`, from its own wheels, with no network); `site-workspace.txt` there, the workspace you chose; the shortcuts; the Add/Remove Programs entry under the current user. Setup and uninstall never write into an existing workspace (a new one the setup makes, with its name, and leaves at that), never move it and never delete it, and will not take a workspace inside the program's own folder (which an upgrade replaces and the uninstaller removes). Uninstalling stops the control panel and its icon, then removes the program and what `install.cmd` added to it.
 
 **The number to check**: Add/Remove Programs lists GEA-Program with the version you installed; `gea doctor --workspace C:\site` ends with `nothing blocks serving`; the Start menu's **Verify GEA-Program** runs the acceptance gate from the installation and ends with `[ACCEPTANCE] OK - N checks passed`. The release's build installs, upgrades and uninstalls the setup silently before it is published, with the control panel running, and checks the workspace untouched afterwards.
 
-**Signed**: when the publisher's code-signing certificate is configured for the build, the setup is signed with it (Authenticode, timestamped) and Windows names the publisher; until then it ships unsigned and Windows SmartScreen says "unknown publisher" (More info, then Run anyway). The build's provenance holds either way: `gh attestation verify GEA-Program-Setup-0.65.0.exe -R Daniel8Murphy0007/GEA-Program`. The uninstaller the setup leaves behind is Inno Setup's own and is not signed separately.
+**Signed**: when the publisher's code-signing certificate is configured for the build, the setup is signed with it (Authenticode, timestamped) and Windows names the publisher; until then it ships unsigned and Windows SmartScreen says "unknown publisher" (More info, then Run anyway). The build's provenance holds either way: `gh attestation verify GEA-Program-Setup-0.66.0.exe -R Daniel8Murphy0007/GEA-Program`. The uninstaller the setup leaves behind is Inno Setup's own and is not signed separately.
 
 **What this page will not call a measurement**: the icon's running or stopped is whether the control panel's port answers on this computer, read every three seconds - not whether every patch, job or report behind it is healthy (Home and the Verification page say that).
 

{gea_program-0.65.0 → gea_program-0.66.0}/gea/help/site.md

@@ -2,7 +2,7 @@
 
 > The workspace folder, the four roles and what each cannot do, the audit log.
 
-**The command**: `gea workspace --path C:\site --action init --name "Pad 3"`; `gea serve --workspace C:\site` (loopback by default; it opens the control panel in your browser once it is listening, `--no-browser` for a scheduled start, and the window it runs in prints what happens on the page - sign-ins, jobs, stops - as it happens; `--behind-proxy` with a TLS proxy in front, see `deploy/README.md`); `gea users --workspace C:\site --action add --name ... --role admin` (the password from `GEA_PASSWORD`, never the command line). `gea workspace --path C:\site --action rename --name "Pad 3"` sets the site's name as every report prints it.
+**The command**: `gea workspace --path C:\site --action init --name "Pad 3"`; `gea serve --workspace C:\site` (loopback by default; it opens the control panel in your browser once it is listening, `--no-browser` for a scheduled start, and the window it runs in prints what happens on the page - sign-ins, jobs, stops - as it happens; `--behind-proxy` with a TLS proxy in front, see `deploy/README.md`); `gea users --workspace C:\site --action add --name ... --role admin` (the password from `GEA_PASSWORD`, never the command line). `gea workspace --path C:\site --action rename --name "Pad 3"` sets the site's name as every report prints it - as does Site name in Administration's site settings (and the first-run guide's first step), for an administrator; reports already written keep the name they were written with.
 
 **What it writes**: `workspace.json`, `wells/<id>/{source,records}`, `config/` (every configuration versioned, diffed, reversible), `monitor/`, `reports/`, `jobs/<id>/{job.json,log.txt}`, `records/audit.jsonl` (append-only, every action with the actor and the SHA-256 of its inputs), `users.json` (salted PBKDF2-SHA256, never a password).
 

{gea_program-0.65.0 → gea_program-0.66.0}/gea/launcher.py

@@ -134,6 +134,33 @@ def set_workspace(kit: Optional[Path], path: str) -> str:
     return path
 
 
+SITE_NAME_MAX = 80
+
+
+def check_site_name(name: Optional[str]) -> Optional[str]:
+    """Why a site name cannot be used, or None. Empty is allowed: the workspace is then named after its folder."""
+    name = (name or '').strip()
+    if len(name) > SITE_NAME_MAX:
+        return f'a site name of {len(name)} characters; {SITE_NAME_MAX} at most (it heads every report)'
+    if any(c in name for c in '"\r\n\t'):
+        return 'a site name holds no quotation marks, line breaks or tabs'
+    return None
+
+
+def create_workspace(path: str, site_name: Optional[str], actor: str = 'installer') -> Optional[str]:
+    """Make the workspace with its name when there is none at `path` yet; an existing workspace is left exactly as it
+    is (its name is changed on the Administration page). Returns the name it was made with, or None when it existed."""
+    if os.path.isfile(os.path.join(path, 'workspace.json')):
+        return None
+    why = check_site_name(site_name)
+    if why:
+        raise LaunchError(why)
+    from .workspace import Workspace
+    name = (site_name or '').strip() or os.path.basename(os.path.normpath(path))
+    Workspace.create(path, name, actor=actor)
+    return name
+
+
 def port_open(port: int, host: str = '127.0.0.1', timeout: float = 0.4) -> bool:
     try:
         with socket.create_connection((host, int(port)), timeout=timeout):
@@ -407,7 +434,15 @@ def main(a) -> int:
         except LaunchError as e:
             say('GEA-Program', f'The site workspace was not recorded: {e}', error=True)
             return 2
-        say('GEA-Program', f'site workspace: {path}  (recorded in {Path(kit_dir()) / WORKSPACE_FILE})')
+        made = None
+        if getattr(a, 'site_name', None) is not None:
+            try:
+                made = create_workspace(path, a.site_name)
+            except (LaunchError, OSError) as e:
+                say('GEA-Program', f'The site workspace was recorded but not made: {e}', error=True)
+                return 2
+        say('GEA-Program', f'site workspace: {path}  (recorded in {Path(kit_dir()) / WORKSPACE_FILE})'
+                           + (f'; made, named {made}' if made else ('; it exists and is used as it is' if getattr(a, 'site_name', None) is not None else '')))
         return 0
     if getattr(a, 'selftest', False):
         p = plan(a.workspace, a.port)

{gea_program-0.65.0 → gea_program-0.66.0}/gea/service.py

@@ -1260,9 +1260,25 @@ class App:
         return {'jobs': out}
 
     def set_site(self, user: dict, site: dict) -> dict:
-        """Site-wide display defaults in the manifest: units, time zone, display name, contact line. Admin only."""
+        """Site-wide display defaults in the manifest: units, time zone, display name, contact line - and `name`, the
+        site's name that heads every report (the workspace's own name, audited as workspace.rename). Admin only."""
+        site = dict(site or {})
+        if 'name' in site:
+            from .launcher import check_site_name
+            nm = site.pop('name')
+            if not isinstance(nm, str) or not nm.strip():
+                raise ApiError(400, 'the site name must be text, and not empty: it heads every report')
+            why = check_site_name(nm)
+            if why:
+                raise ApiError(400, why)
+            try:
+                self.ws.rename(nm.strip(), actor=user['name'])
+            except WorkspaceError as e:
+                raise ApiError(400, str(e))
+            if not site:
+                return dict(self.ws.manifest.get('site') or {})
         cur = dict(self.ws.manifest.get('site') or {})
-        for k, v in (site or {}).items():
+        for k, v in site.items():
             if k not in ('units', 'time_zone', 'display_name', 'contact', 'wizard_done'):
                 raise ApiError(400, f'unknown site setting: {k}')
             if k == 'units' and v not in ('field', 'si'):

{gea_program-0.65.0 → gea_program-0.66.0}/gea/web/app.html

@@ -1804,7 +1804,7 @@ VIEWS.admin = async () => {
   const nt = await get('/api/notifications');
   let SS = {sessions: []}; try { SS = await get('/api/sessions'); } catch (e) {}
   h += `<div class="card"><h3>Live sessions (${SS.sessions.length})</h3><p class="small muted">Who is signed in, from where, since when. Revoking signs that session out at its next request. ${esc(SS.note || '')}</p><table><thead><tr><th>User</th><th>Role</th><th>From</th><th>Signed in</th><th>Last seen</th><th>Expires</th><th></th></tr></thead><tbody>${SS.sessions.map(x => `<tr><td>${esc(x.name)}${x.via === 'company' ? ' <span class="small muted">(company)</span>' : ''}</td><td>${esc(x.role)}</td><td class="mono small">${esc(x.client)}</td><td class="small">${tz(x.created_utc)}</td><td class="small">${tz(x.last_seen_utc)}</td><td class="small">${tz(x.expires_utc)}</td><td><button class="secondary" data-rs="${esc(x.sid)}" type="button">Revoke</button> <button class="secondary danger" data-ru="${esc(x.name)}" type="button">All of ${esc(x.name)}</button></td></tr>`).join('') || '<tr><td colspan="7" class="muted">none</td></tr>'}</tbody></table></div>`;
-  h += `<div class="card"><h3>Site settings</h3><p class="small muted">Defaults for everyone who has not chosen their own: display units and time zone, the name on the home page, a contact line for the sign-in screen.</p><div class="row"><label>Display name<input id="stName" value="${esc(SITE.display_name || '')}" placeholder="${esc(workspaceName)}"></label><label>Units<select id="stUnits"><option value="field" ${(SITE.units || 'field') === 'field' ? 'selected' : ''}>field (psi, °F, ft)</option><option value="si" ${SITE.units === 'si' ? 'selected' : ''}>SI (kPa, °C, m)</option></select></label><label>Time zone<input id="stTz" value="${esc(SITE.time_zone || 'UTC')}" placeholder="UTC or America/Chicago" list="tzList"></label><label>Contact<input id="stContact" value="${esc(SITE.contact || '')}" placeholder="who to call"></label><button id="stSave" type="button">Save</button></div><datalist id="tzList">${['UTC', 'America/Chicago', 'America/Denver', 'America/New_York', 'America/Los_Angeles', 'America/Anchorage', 'Europe/London', 'Europe/Oslo', 'Asia/Dubai', 'Asia/Kuala_Lumpur', 'Australia/Perth'].map(z => `<option value="${z}">`).join('')}</datalist></div>`;
+  h += `<div class="card"><h3>Site settings</h3><p class="small muted">The site's name heads every report written from now on and the top of this page (reports already written keep theirs; a rename is in the audit log). Then defaults for everyone who has not chosen their own: display units and time zone, the name on the home page, a contact line for the sign-in screen.</p><div class="row"><label>Site name (on every report)<input id="stSiteName" maxlength="80" required value="${esc(workspaceName)}"></label><label>Display name<input id="stName" value="${esc(SITE.display_name || '')}" placeholder="${esc(workspaceName)}"></label><label>Units<select id="stUnits"><option value="field" ${(SITE.units || 'field') === 'field' ? 'selected' : ''}>field (psi, °F, ft)</option><option value="si" ${SITE.units === 'si' ? 'selected' : ''}>SI (kPa, °C, m)</option></select></label><label>Time zone<input id="stTz" value="${esc(SITE.time_zone || 'UTC')}" placeholder="UTC or America/Chicago" list="tzList"></label><label>Contact<input id="stContact" value="${esc(SITE.contact || '')}" placeholder="who to call"></label><button id="stSave" type="button">Save</button></div><datalist id="tzList">${['UTC', 'America/Chicago', 'America/Denver', 'America/New_York', 'America/Los_Angeles', 'America/Anchorage', 'Europe/London', 'Europe/Oslo', 'Asia/Dubai', 'Asia/Kuala_Lumpur', 'Australia/Perth'].map(z => `<option value="${z}">`).join('')}</datalist></div>`;
   h += `<div class="card"><h3>Notifications</h3><p class="small muted">Rules route events (alarm activations by priority, failed jobs, patches down, items waiting for approval) to channels: a webhook URL or an SMTP mailbox. Secrets stay out of the configuration - an SMTP password is read from the environment variable the channel names. The configuration is versioned as <span class="mono">notifications</span>.</p>`;
   h += nt.configured ? `<table><thead><tr><th>Channel</th><th>Kind</th><th>Target</th><th></th></tr></thead><tbody>${nt.channels.map(c => `<tr><td>${esc(c.name)}</td><td>${esc(c.kind)}</td><td class="mono small">${esc(c.target)}${c.secret ? ' <span class="muted">(with credentials)</span>' : ''}</td><td><button class="secondary" data-nt="${esc(c.name)}" type="button">Send a test</button></td></tr>`).join('')}</tbody></table><p class="small">${nt.rules.length} rule(s): ${nt.rules.map(r => `${esc(r.event)}${r.priority ? ' ' + esc(r.priority.join('/')) : ''} → ${esc((r.channels || []).join(', '))}`).join(' · ')} · quiet window ${nt.quiet_s} s</p>` : `<p class="small">Not configured. <button class="secondary" id="ntExample" type="button">Load the example</button> into the editor, change the URL or mailbox, validate and commit.</p>`;
   h += `<details><summary>Edit the configuration</summary><label>JSON<textarea id="ntCfg" spellcheck="false"></textarea></label><div class="row"><label>Note<input id="ntNote"></label><button class="secondary" id="ntLoad" type="button">Load current</button><button id="ntSave" type="button">Validate and commit</button></div></details>`;
@@ -1831,7 +1831,7 @@ VIEWS.admin = async () => {
   const o = await get('/api/overview'); const wsPath = o.workspace.path;
   document.querySelectorAll('[data-rs]').forEach(b => b.onclick = async () => { try { const r = await post('/api/sessions/revoke', {sid: b.dataset.rs}); toast(`${r.revoked} session(s) revoked`, 'ok'); route(); } catch (e) { toast(e.message, 'err'); } });
   document.querySelectorAll('[data-ru]').forEach(b => b.onclick = async () => { if (!confirm(`Sign ${b.dataset.ru} out of every session?`)) return; try { const r = await post('/api/sessions/revoke', {name: b.dataset.ru}); toast(`${r.revoked} session(s) revoked`, 'ok'); if (b.dataset.ru === me.name) { me = null; boot(); } else route(); } catch (e) { toast(e.message, 'err'); } });
-  $('#stSave').onclick = async () => { try { const r = await post('/api/site', {site: {display_name: $('#stName').value, units: $('#stUnits').value, time_zone: $('#stTz').value, contact: $('#stContact').value}}); SITE = r.site; toast('Site settings saved', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
+  $('#stSave').onclick = async () => { const nm = $('#stSiteName').value.trim(); if (!nm) return toast('The site needs a name: it heads every report', 'err'); try { const r = await post('/api/site', {site: {...(nm !== workspaceName ? {name: nm} : {}), display_name: $('#stName').value, units: $('#stUnits').value, time_zone: $('#stTz').value, contact: $('#stContact').value}}); SITE = r.site; workspaceName = nm; $('#siteName').textContent = nm; toast('Site settings saved', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
   const ntEx = $('#ntExample'); if (ntEx) ntEx.onclick = () => { $('#ntCfg').value = JSON.stringify({channels: [{name: 'ops-hook', kind: 'webhook', url: 'https://hooks.example.com/gea', headers: {}}, {name: 'mail', kind: 'smtp', host: 'smtp.example.com', port: 587, starttls: true, from: 'gea@example.com', to: ['operations@example.com'], user: 'gea', password_env: 'GEA_SMTP_PASSWORD'}], rules: [{event: 'alarm.activated', priority: ['P1'], channels: ['ops-hook', 'mail']}, {event: 'job.failed', channels: ['ops-hook']}, {event: 'patch.down', channels: ['ops-hook', 'mail']}, {event: 'approval.pending', channels: ['mail']}], quiet_s: 300}, null, 1); $('details').open = true; };
   $('#ntLoad').onclick = async () => { try { const c = await get('/api/config/notifications'); $('#ntCfg').value = JSON.stringify(c.current, null, 1); } catch (e) { toast('no committed notifications yet: ' + e.message, 'err'); } };
   $('#ntSave').onclick = async () => { let c; try { c = JSON.parse($('#ntCfg').value); } catch (e) { return toast('not valid JSON: ' + e.message, 'err'); } try { const r = await post('/api/config/commit', {name: 'notifications', content: c, note: $('#ntNote').value}); toast(r.unchanged ? 'Unchanged' : `Committed notifications v${r.version}`, 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
@@ -1876,12 +1876,12 @@ VIEWS.welcome = async () => {
   const step = o.workspace.n_wells === 0 ? (SITE.units ? 2 : 1) : (users.length < 2 ? 3 : 4);
   const steps = ['Site', 'First well', 'People', 'First refresh'].map((t, i) => `<span class="${i + 1 === step ? 'on' : ''}">${i + 1}. ${t}</span>`).join('');
   let h = `<h2>Setting up ${esc(workspaceName)}</h2>${help('welcome')}<div class="steps">${steps}</div>`;
-  h += `<div class="card wizard"><h3>1. The site</h3><p class="small muted">How numbers and times are shown to everyone here, and the name on the home page.</p><div class="row"><label>Display name<input id="wName" value="${esc(SITE.display_name || workspaceName)}"></label><label>Units<select id="wUnits"><option value="field" ${(SITE.units || 'field') === 'field' ? 'selected' : ''}>field (psi, °F, ft)</option><option value="si" ${SITE.units === 'si' ? 'selected' : ''}>SI (kPa, °C, m)</option></select></label><label>Time zone<input id="wTz" value="${esc(SITE.time_zone || 'UTC')}" placeholder="UTC or America/Chicago"></label><button id="wSite" type="button">Save</button></div></div>`;
+  h += `<div class="card wizard"><h3>1. The site</h3><p class="small muted">The site's name heads every report; how numbers and times are shown to everyone here, and the name on the home page.</p><div class="row"><label>Site name (on every report)<input id="wSiteName" maxlength="80" value="${esc(workspaceName)}"></label><label>Display name<input id="wName" value="${esc(SITE.display_name || workspaceName)}"></label><label>Units<select id="wUnits"><option value="field" ${(SITE.units || 'field') === 'field' ? 'selected' : ''}>field (psi, °F, ft)</option><option value="si" ${SITE.units === 'si' ? 'selected' : ''}>SI (kPa, °C, m)</option></select></label><label>Time zone<input id="wTz" value="${esc(SITE.time_zone || 'UTC')}" placeholder="UTC or America/Chicago"></label><button id="wSite" type="button">Save</button></div></div>`;
   h += `<div class="card wizard"><h3>2. The first well</h3><p class="small muted">Upload a historian CSV, LAS, SEG-Y or operator table - or import a file from a folder you allow the dashboard to read.</p><div class="row"><label>Well name<input id="wWell" placeholder="A-12"></label><label>File<input id="wFile" type="file"></label><label>Gauge station MD (ft)<input id="wMd" type="number" placeholder="10000"></label><button id="wAdd" type="button">Add the well</button></div><p class="small">Or: <a href="#/files">browse the import roots</a>${fr.import.length ? '' : ' (none yet - add one below)'}.</p>${fr.import.length ? '' : `<div class="row"><label>Import root name<input id="wRootName" placeholder="historian"></label><label>Folder on this machine<input id="wRootPath" placeholder="C:\\data\\historian"></label><button class="secondary" id="wRoot" type="button">Allow this folder</button></div>`}</div>`;
   h += `<div class="card wizard"><h3>3. People</h3><p class="small muted">${users.length} account(s). Operators run and acknowledge; approvers decide on well tests and re-fits; viewers only look.</p><div class="row"><label>Name<input id="wUser"></label><label>Password (8+)<input id="wPw" type="password"></label><label>Role<select id="wRole">${['operator', 'approver', 'viewer'].map(r => `<option>${r}</option>`).join('')}</select></label><button id="wUserAdd" type="button">Add</button></div></div>`;
   h += `<div class="card wizard"><h3>4. The first refresh</h3><p class="small muted">Runs every calculation on every well and builds the reports. Takes a minute per well.</p><div class="row"><button id="wRefresh" type="button" ${o.workspace.n_wells ? '' : 'disabled'}>Refresh every report</button><button class="secondary" id="wDone" type="button">Finish the guide</button></div></div>`;
   $('#main').innerHTML = h;
-  $('#wSite').onclick = async () => { try { const r = await post('/api/site', {site: {display_name: $('#wName').value, units: $('#wUnits').value, time_zone: $('#wTz').value}}); SITE = r.site; toast('Saved', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
+  $('#wSite').onclick = async () => { try { const nm = $('#wSiteName').value.trim(); const r = await post('/api/site', {site: {...(nm && nm !== workspaceName ? {name: nm} : {}), display_name: ($('#wName').value === workspaceName && nm) ? nm : $('#wName').value, units: $('#wUnits').value, time_zone: $('#wTz').value}}); SITE = r.site; if (nm) { workspaceName = nm; $('#siteName').textContent = nm; } toast('Saved', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
   $('#wAdd').onclick = async () => { const f = $('#wFile').files[0]; if (!f) return toast('Choose a file', 'err'); try { const b64 = await readFile(f); await post('/api/wells/file', {display: $('#wWell').value || f.name, filename: f.name, content_b64: b64, station_md: $('#wMd').value ? +$('#wMd').value : null}); toast('Well added', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
   const wr = $('#wRoot'); if (wr) wr.onclick = async () => { try { await post('/api/files/roots/add', {which: 'import', name: $('#wRootName').value, path: $('#wRootPath').value}); toast('Folder allowed', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };
   $('#wUserAdd').onclick = async () => { try { await post('/api/users/add', {name: $('#wUser').value, password: $('#wPw').value, role: $('#wRole').value}); toast('User added', 'ok'); route(); } catch (e) { toast(e.message, 'err'); } };

{gea_program-0.65.0 → gea_program-0.66.0/gea_program.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.65.0
+Version: 0.66.0
 Summary: GEA-Program: downhole gauge monitoring - canonical measurement records, quality rules, drift evaluation with a re-fit change log, well-test validation, alarm management, model cards, store-and-forward, monthly SLA measurement, FAT/SAT protocols and a dashboard, generated from live objects in the client's reporting outline.
 Author: Daniel T. Murphy
 License: MPL-2.0
@@ -1426,11 +1426,12 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.65.0.exe` (for 0.65.0): the
+Every release also carries `GEA-Program-Setup-0.66.0.exe` (for 0.66.0): the
 same Windows kit installed like any Windows program, for the signed-in user
 alone and with no administrator rights (`%LOCALAPPDATA%\Programs\GEA-Program`).
 It asks for the site workspace (an existing one such as `C:\site` is used as
-it is), runs the kit's `install.cmd` with no network, and adds Start-menu and
+it is, its name included; a new one is made with the site name it asks for,
+which heads every report), runs the kit's `install.cmd` with no network, and adds Start-menu and
 desktop shortcuts, an Add/Remove Programs entry and, when chosen, a start at
 sign-in. The shortcut **GEA-Program** starts the control panel when it is not
 running and opens it in Microsoft Edge's app window (its own window and
@@ -1442,7 +1443,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.65.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /TASKS="desktopicon"
+GEA-Program-Setup-0.66.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
 ```
 
 The setup is built by Inno Setup 6 from `tools/installer.iss` in the same

{gea_program-0.65.0 → gea_program-0.66.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gea-program"
-version = "0.65.0"
+version = "0.66.0"
 description = "GEA-Program: downhole gauge monitoring - canonical measurement records, quality rules, drift evaluation with a re-fit change log, well-test validation, alarm management, model cards, store-and-forward, monthly SLA measurement, FAT/SAT protocols and a dashboard, generated from live objects in the client's reporting outline."
 readme = "README.md"
 requires-python = ">=3.10"