@allansantos-dev/smart-tool 0.9.31 → 0.9.33

package/toast_notice.py

@@ -0,0 +1,99 @@
+"""Windows toast with buttons, no dependency: PowerShell 5.1 (always present) shows it through the WinRT toast API and
+each button is a protocol link that Windows hands to `notice_action.py`.
+
+An unpackaged app has no COM activator, so a button cannot call back into a running process. The protocol route needs
+only HKCU keys (no admin): one AppUserModelId key (name and icon of the toast) and one URL protocol whose command runs
+`pythonw notice_action.py "<uri>"` without a window. Actions are therefore small independent commands that read and
+write the config file, never state held by the tray.
+"""
+import base64
+import os
+import subprocess
+import sys
+import urllib.parse
+from xml.sax.saxutils import quoteattr, escape
+
+APP_ID = "SmartTool.Notifications"
+PROTOCOL = "smart-tool-action"
+ACTION_SCRIPT = os.path.join(os.path.dirname(os.path.abspath(__file__)), "notice_action.py")
+
+_SHOW_SCRIPT = r"""
+$ErrorActionPreference = 'Stop'
+[Windows.UI.Notifications.ToastNotificationManager, Windows.UI.Notifications, ContentType = WindowsRuntime] | Out-Null
+[Windows.Data.Xml.Dom.XmlDocument, Windows.Data.Xml.Dom.XmlDocument, ContentType = WindowsRuntime] | Out-Null
+$xml = New-Object Windows.Data.Xml.Dom.XmlDocument
+$xml.LoadXml($env:SMART_TOOL_TOAST_XML)
+$toast = New-Object Windows.UI.Notifications.ToastNotification $xml
+if ($env:SMART_TOOL_TOAST_TAG) { $toast.Tag = $env:SMART_TOOL_TOAST_TAG; $toast.Group = 'smart-tool' }
+[Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($env:SMART_TOOL_TOAST_APPID).Show($toast)
+"""
+
+
+def _pythonw():
+    candidate = os.path.join(os.path.dirname(sys.executable), "pythonw.exe")
+    return candidate if os.path.isfile(candidate) else sys.executable
+
+
+def action_command():
+    """The command the protocol runs; `%1` is the clicked link."""
+    return f'"{_pythonw()}" "{ACTION_SCRIPT}" "%1"'
+
+
+def register():
+    """Writes the HKCU keys (idempotent). Raises on any failure: a toast whose buttons do nothing is worse than none."""
+    import winreg
+    with winreg.CreateKey(winreg.HKEY_CURRENT_USER, rf"Software\Classes\AppUserModelId\{APP_ID}") as key:
+        winreg.SetValueEx(key, "DisplayName", 0, winreg.REG_SZ, "Smart Tool")
+    root = rf"Software\Classes\{PROTOCOL}"
+    with winreg.CreateKey(winreg.HKEY_CURRENT_USER, root) as key:
+        winreg.SetValueEx(key, None, 0, winreg.REG_SZ, "URL:Smart Tool action")
+        winreg.SetValueEx(key, "URL Protocol", 0, winreg.REG_SZ, "")
+    with winreg.CreateKey(winreg.HKEY_CURRENT_USER, root + r"\shell\open\command") as key:
+        winreg.SetValueEx(key, None, 0, winreg.REG_SZ, action_command())
+
+
+def unregister():
+    """Deletes the HKCU keys `register` wrote, deepest first; returns how many existed (missing keys are not an error)."""
+    import winreg
+    count = 0
+    for path in (rf"Software\Classes\{PROTOCOL}\shell\open\command", rf"Software\Classes\{PROTOCOL}\shell\open",
+                 rf"Software\Classes\{PROTOCOL}\shell", rf"Software\Classes\{PROTOCOL}",
+                 rf"Software\Classes\AppUserModelId\{APP_ID}"):
+        try:
+            winreg.DeleteKey(winreg.HKEY_CURRENT_USER, path)
+            count += 1
+        except FileNotFoundError:
+            pass
+    return count
+
+
+def action_uri(action, **params):
+    """The protocol link a button carries: `smart-tool-action:<action>?<params>`; returns the link as text."""
+    query = urllib.parse.urlencode(params)
+    return f"{PROTOCOL}:{action}" + (f"?{query}" if query else "")
+
+
+def toast_xml(title, lines, buttons):
+    """`buttons` is a list of (label, uri); each one launches its protocol link and closes the toast."""
+    text = "".join(f"<text>{escape(line)}</text>" for line in [title, *lines])
+    actions = "".join(
+        f'<action content={quoteattr(label)} arguments={quoteattr(uri)} activationType="protocol"/>'
+        for label, uri in buttons)
+    return (f'<toast><visual><binding template="ToastGeneric">{text}</binding></visual>'
+            f'<actions>{actions}</actions></toast>')
+
+
+def show(title, lines, buttons, tag=None):
+    """Shows the toast; raises RuntimeError with PowerShell's message when Windows refuses it."""
+    if sys.platform != "win32":
+        raise RuntimeError("Toast notifications are only available on Windows.")
+    register()
+    script = base64.b64encode(_SHOW_SCRIPT.encode("utf-16-le")).decode("ascii")
+    env = {**os.environ, "SMART_TOOL_TOAST_XML": toast_xml(title, lines, buttons),
+           "SMART_TOOL_TOAST_APPID": APP_ID, "SMART_TOOL_TOAST_TAG": tag or ""}
+    done = subprocess.run(
+        ["powershell.exe", "-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-EncodedCommand", script],
+        env=env, capture_output=True, text=True, encoding="utf-8", errors="replace", timeout=30,
+        creationflags=subprocess.CREATE_NO_WINDOW)
+    if done.returncode:
+        raise RuntimeError(f"Windows refused the notification: {(done.stderr or done.stdout).strip()[:500]}")

package/tray.py

@@ -22,11 +22,13 @@ sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
 import autostart
 import config
 import daemon_launcher
+import toast_notice
 import update_check
 import version
 
 POLL_INTERVAL_S = 45
 UPDATE_CHECK_INTERVAL_S = 24 * 3600
+NOTICE_INTERVAL_S = 600
 SETUP_URL = "http://127.0.0.1:8765/setup"
 
 _STATE_LOCK = threading.Lock()
@@ -111,6 +113,42 @@ def _poll_loop(icon):
         time.sleep(POLL_INTERVAL_S)
 
 
+def _show_notices(icon, notices):
+    """Shows a toast for each pending notice: the new-default-models offer and each model over the failure limit."""
+    offer = notices.get("upgrade")
+    if offer:
+        lines = [f"{role}: {change['current']} -> {change['new']}" for role, change in offer["changes"].items()]
+        nonce = offer["nonce"]
+        toast_notice.show("Smart Tool has new recommended models", lines, [
+            ("Apply now", toast_notice.action_uri("models-apply", n=nonce)),
+            ("Don't show again", toast_notice.action_uri("models-decline", n=nonce)),
+        ], tag="models-upgrade")
+    for row in notices.get("failing") or []:
+        last = row.get("last_error") or "see the failure log in the settings"
+        toast_notice.show(
+            f"{row['model']} is failing", [f"{row['errors']} of {row['calls']} calls failed in 24 h as {row['role']}.", last[:160]],
+            [("Switch model", toast_notice.action_uri("open-setup", section="models")),
+             ("Mute 7 days", toast_notice.action_uri("mute-model", model=row["model"]))], tag="model-failing:" + row["model"])
+
+
+def _notice_loop(icon):
+    """Asks the daemon every 10 minutes whether a toast is due. The daemon decides (once a day per notice) and marks it
+    announced, so a restart of the tray never repeats one."""
+    while True:
+        try:
+            daemon_url = (daemon_launcher.read_registry() or {}).get("url")
+            if daemon_url:
+                request = urllib.request.Request(daemon_url.rstrip("/") + "/setup/notices", data=b"{}", method="POST",
+                                                 headers={"Content-Type": "application/json"})
+                with urllib.request.urlopen(request, timeout=60) as response:
+                    _show_notices(icon, json.load(response))
+        except Exception as exc:
+            if str(exc) != _state.get("notice_error"):
+                _state["notice_error"] = str(exc)
+                icon.notify(f"Could not show a Smart Tool notice: {exc}", "Smart Tool")
+        time.sleep(NOTICE_INTERVAL_S)
+
+
 def _announce_start(icon):
     """Tells the user, once per start, that Smart Tool was just updated or that the last automatic update failed."""
     updated = update_check.note_running_version()
@@ -304,6 +342,7 @@ def main():
     )
     threading.Thread(target=_poll_loop, args=(icon,), daemon=True).start()
     threading.Thread(target=_update_loop, args=(icon,), daemon=True).start()
+    threading.Thread(target=_notice_loop, args=(icon,), daemon=True).start()
     try:
         icon.run()
     finally:

package/version.py

@@ -1,7 +1,7 @@
 """Single source of the Smart Tool version and of the User-Agent sent to public APIs."""
 import re
 
-VERSION = "0.9.31"
+VERSION = "0.9.33"
 _CONTACT_RE = re.compile(r"^(?:[^\s@()<>;]+@[^\s@()<>;]+\.[^\s@()<>;]+|https?://[^\s()<>;]+)$")