hbkit 0.4.6__tar.gz → 0.4.8__tar.gz

{hbkit-0.4.6 → hbkit-0.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: hbkit
-Version: 0.4.6
+Version: 0.4.8
 Summary: Recover files from Synology Hyper Backup (.hbk) archives without Synology software
 Project-URL: Homepage, https://github.com/YordiLorenzo/hbkit
 Project-URL: Source, https://github.com/YordiLorenzo/hbkit
@@ -27,7 +27,9 @@ Provides-Extra: dev
 Requires-Dist: pytest>=7; extra == 'dev'
 Description-Content-Type: text/markdown
 
-# hbkit
+<p align="center">
+  <img src="https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/banner.png" alt="hbkit: your backup, without the NAS" width="100%">
+</p>
 
 [![PyPI](https://img.shields.io/pypi/v/hbkit)](https://pypi.org/project/hbkit/)
 [![CI](https://github.com/YordiLorenzo/hbkit/actions/workflows/ci.yml/badge.svg)](https://github.com/YordiLorenzo/hbkit/actions/workflows/ci.yml)
@@ -39,6 +41,8 @@ Point it at a backup on a local disk, an external drive, or a network mount, bro
 a tree, and pull out what you want. Works headless on Linux and macOS, including Apple Silicon, where Synology's
 own Hyper Backup Explorer is awkward or unavailable.
 
+Website: **[yordilorenzo.github.io/hbkit](https://yordilorenzo.github.io/hbkit/)**
+
 ```sh
 brew install YordiLorenzo/tap/hbkit     # macOS / Linux, pulls in liblz4 for you
 
@@ -77,22 +81,7 @@ case is a loud failure naming the file.
 
 ## The TUI
 
-```
-⭘                          Hyper Backup Recovery                          17:11:17
- ┌──────────────────────────────────────────────────────────────┐ │
- │  search filename…  (/)                                       │ │ Selection
- └──────────────────────────────────────────────────────────────┘ │ 197,607 files
- ▼ ◪ 📁 NAS Volume 1                       4.4T   499,745         │ 625.0G  in 1 item(s)
- ├─ ▶ ☐ 📁 Archive 2022                      24.2G       358      │
- ├─ ▶ ☐ 📁 Backups                           23.5G    63,693      │ Destination
- ├─ ▶ ☐ 📁 Video Projects                     1.9T    64,473      │ ┌──────────────────────────┐
- ├─ ▶ ☐ 📁 Media Library                      1.3T    66,629      │ │ ~/restore                │
- ├─ ▼ ☑ 📁 Photo Libraries                  625.0G   197,607      │ └──────────────────────────┘
- │  ├─ ▶ ☑ 📁 Photos Library - Laptop…        28.8G    76,844     │ ⚠ needs 625.0G, only 70.3G free
- │  ├─ ▶ ☑ 📁 Photos Library - Old Backup…    19.8G    15,505     │
-                                                                  │      Start recovery
- a All  n Clear  d Destination  r Recover  / Search  q Quit       │
-```
+![hbkit's terminal browser: a backup's shares as a folder tree with sizes and file counts, two photo folders ticked, and a panel with the selection, the destination's free space and a Start recovery button](https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/tui.png)
 
 `space` tick · `a` all · `n` clear · `/` search · `d` destination · `r` recover ·
 `ctrl+q` quit (plain `q` types into whichever field has focus, so quit is ctrl+q).

{hbkit-0.4.6 → hbkit-0.4.8}/README.md

@@ -1,4 +1,6 @@
-# hbkit
+<p align="center">
+  <img src="https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/banner.png" alt="hbkit: your backup, without the NAS" width="100%">
+</p>
 
 [![PyPI](https://img.shields.io/pypi/v/hbkit)](https://pypi.org/project/hbkit/)
 [![CI](https://github.com/YordiLorenzo/hbkit/actions/workflows/ci.yml/badge.svg)](https://github.com/YordiLorenzo/hbkit/actions/workflows/ci.yml)
@@ -10,6 +12,8 @@ Point it at a backup on a local disk, an external drive, or a network mount, bro
 a tree, and pull out what you want. Works headless on Linux and macOS, including Apple Silicon, where Synology's
 own Hyper Backup Explorer is awkward or unavailable.
 
+Website: **[yordilorenzo.github.io/hbkit](https://yordilorenzo.github.io/hbkit/)**
+
 ```sh
 brew install YordiLorenzo/tap/hbkit     # macOS / Linux, pulls in liblz4 for you
 
@@ -48,22 +52,7 @@ case is a loud failure naming the file.
 
 ## The TUI
 
-```
-⭘                          Hyper Backup Recovery                          17:11:17
- ┌──────────────────────────────────────────────────────────────┐ │
- │  search filename…  (/)                                       │ │ Selection
- └──────────────────────────────────────────────────────────────┘ │ 197,607 files
- ▼ ◪ 📁 NAS Volume 1                       4.4T   499,745         │ 625.0G  in 1 item(s)
- ├─ ▶ ☐ 📁 Archive 2022                      24.2G       358      │
- ├─ ▶ ☐ 📁 Backups                           23.5G    63,693      │ Destination
- ├─ ▶ ☐ 📁 Video Projects                     1.9T    64,473      │ ┌──────────────────────────┐
- ├─ ▶ ☐ 📁 Media Library                      1.3T    66,629      │ │ ~/restore                │
- ├─ ▼ ☑ 📁 Photo Libraries                  625.0G   197,607      │ └──────────────────────────┘
- │  ├─ ▶ ☑ 📁 Photos Library - Laptop…        28.8G    76,844     │ ⚠ needs 625.0G, only 70.3G free
- │  ├─ ▶ ☑ 📁 Photos Library - Old Backup…    19.8G    15,505     │
-                                                                  │      Start recovery
- a All  n Clear  d Destination  r Recover  / Search  q Quit       │
-```
+![hbkit's terminal browser: a backup's shares as a folder tree with sizes and file counts, two photo folders ticked, and a panel with the selection, the destination's free space and a Start recovery button](https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/tui.png)
 
 `space` tick · `a` all · `n` clear · `/` search · `d` destination · `r` recover ·
 `ctrl+q` quit (plain `q` types into whichever field has focus, so quit is ctrl+q).

hbkit-0.4.8/contrib/art/README.md

@@ -0,0 +1,22 @@
+# Art
+
+Every image in `docs/images/` and `site/` is built from the files here, so the screenshots
+can be redone whenever the TUI changes. Run from anywhere:
+
+```sh
+pip install -e . fonttools brotli        # hbkit itself renders the TUI screenshot
+brew install webp imagemagick            # plus Google Chrome, used headless
+contrib/art/render.sh
+```
+
+| source | builds |
+|---|---|
+| `site/images/icon.svg` | the icon, drawn by hand; everything else derives from it |
+| `logo.py` | `docs/images/logo.svg` and `logo-light.svg`: the icon and the wordmark, in Outfit SemiBold as outlines |
+| `render_tui.py`, `tui.html` | `docs/images/tui.png` and the site's `tui-*.webp`: hbkit's real browser screen over a made-up archive |
+| `banner.html` | `docs/images/banner.png`, the README header |
+| `social.html` | `site/social-preview.png`, the link preview card |
+| `icon.html` | `docs/images/icon-1024.png` |
+
+The demo archive in `render_tui.py` is invented: no real backup or personal data goes into
+any image. Outfit is under the SIL Open Font License (`site/fonts/OFL.txt`).

{hbkit-0.4.6 → hbkit-0.4.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hbkit"
-version = "0.4.6"
+version = "0.4.8"
 description = "Recover files from Synology Hyper Backup (.hbk) archives without Synology software"
 readme = "README.md"
 requires-python = ">=3.10"

{hbkit-0.4.6 → hbkit-0.4.8}/src/hbkit/__init__.py

@@ -1,6 +1,6 @@
 """hbkit - recover files from Synology Hyper Backup (.hbk) archives without Synology software."""
 
-__version__ = "0.4.6"
+__version__ = "0.4.8"
 
 from .archive import (Archive, NeedPassword, UnsupportedArchive,  # noqa: F401
                       find_archive_root, is_archive)

{hbkit-0.4.6 → hbkit-0.4.8}/src/hbkit/cli.py

@@ -92,6 +92,23 @@ def resolve_password(password):
     return password or os.environ.get("HBK_PASSWORD")
 
 
+def stdin_is_interactive():
+    """True when a password prompt can be answered: stdin is a real terminal/console."""
+    if not sys.stdin or not sys.stdin.isatty():
+        return False
+    if os.name != "nt":
+        return True
+    # `< NUL` is a character device, so isatty() is True; only a real console has a mode
+    import ctypes
+    import msvcrt
+    try:
+        h = msvcrt.get_osfhandle(sys.stdin.fileno())
+    except OSError:
+        return False
+    mode = ctypes.c_uint32()
+    return bool(ctypes.windll.kernel32.GetConsoleMode(ctypes.c_void_p(h), ctypes.byref(mode)))
+
+
 def open_archive(archive, password=None):
     """Open, prompting for a password only if the archive turns out to be encrypted."""
     try:
@@ -99,7 +116,7 @@ def open_archive(archive, password=None):
     except hbk.NeedPassword:
         pw = resolve_password(password)
         if not pw:
-            if not sys.stdin.isatty():
+            if not stdin_is_interactive():
                 sys.exit("archive is encrypted - pass --password or set HBK_PASSWORD")
             pw = getpass.getpass("archive password: ")
         try:

{hbkit-0.4.6 → hbkit-0.4.8}/src/hbkit/tui.py

@@ -526,14 +526,19 @@ class BrowserScreen(Screen):
                                    (f"{n}", "bold"), (" item(s)", "dim")))
         self.update_space()
 
+    def dest(self) -> str:
+        """The destination as typed, with ~ and relative paths resolved as a shell would."""
+        return os.path.abspath(os.path.expanduser(self.query_one("#dest", Input).value))
+
     def update_space(self):
-        probe = self.query_one("#dest", Input).value
-        while probe and not os.path.exists(probe):
-            probe = os.path.dirname(probe)
         w = self.query_one("#space-info", Static)
-        if not probe:
-            w.update(Text("invalid path", style="bold red"))
-            return
+        probe = self.dest()
+        while not os.path.exists(probe):
+            parent = os.path.dirname(probe)
+            if parent == probe:                    # a drive that isn't there
+                w.update(Text("invalid path", style="bold red"))
+                return
+            probe = parent
         free = shutil.disk_usage(probe).free
         _, need, _ = self.sel.totals()
         if need > free:
@@ -595,7 +600,7 @@ class BrowserScreen(Screen):
         if not self.sel.chosen:
             self.notify("select something first — space to tick", severity="warning")
             return
-        dest = os.path.abspath(os.path.expanduser(self.query_one("#dest", Input).value))
+        dest = self.dest()
         files = self.sel.files()
         if not files:
             self.notify("selection contains no extractable files", severity="error")

{hbkit-0.4.6 → hbkit-0.4.8}/tests/test_hbkit.py

@@ -303,6 +303,26 @@ def test_verify_rejects_options_it_does_not_take():
     assert "unknown option --version" in r.stderr
 
 
+def test_encrypted_archive_with_null_stdin_fails_instead_of_prompting(tmp_path):
+    """On Windows `< NUL` is a character device, so isatty() says True and getpass used
+    to wait on the console forever. Only enough of an archive to reach NeedPassword."""
+    import struct
+    header = struct.pack(">16I", hbk.MAGIC, 0, 0, 0, 56, *([0] * 11))
+    root = tmp_path / "enc.hbk"
+    for d in ("Config/virtual_file.index", "Pool/chunk_index",
+              "Config/file_chunk1.index", "Pool/0"):
+        (root / d).mkdir(parents=True)
+    (root / "Config/virtual_file.index/0.idx").write_bytes(header)
+    (root / "Pool/chunk_index/0.idx").write_bytes(header)
+    (root / "_Syno_TaskConfig").write_text('enable_data_encrypt="true"\n')
+    env = {k: v for k, v in os.environ.items() if k != "HBK_PASSWORD"}
+    r = subprocess.run([sys.executable, "-m", "hbkit.cli", str(root), "list"],
+                       stdin=subprocess.DEVNULL, capture_output=True, text=True,
+                       env=env, timeout=30, check=False)
+    assert r.returncode != 0, r.stderr
+    assert "pass --password or set HBK_PASSWORD" in r.stderr
+
+
 # ------------------------------------------------- shard maths (no archive needed)
 
 def _make_shards(tmp_path, sizes, shard_size, monkeypatch):
@@ -590,3 +610,40 @@ def test_lazycats_lists_shards_before_any_are_opened():
                           0: "/nonexistent/file_chunk0.index"})
     assert cats.known == [0, 4]
     assert len(cats) == 0, "listing shards must not open them"
+
+
+@pytest.mark.parametrize("typed", ["~/hbkit-test-not-there/restore", "restore/here"])
+def test_tui_free_space_follows_home_and_relative_destinations(tmp_path, monkeypatch, typed):
+    """Typing ~/restore showed "invalid path" under the destination, though the restore
+    itself expanded ~ fine. A relative path did the same."""
+    import asyncio
+    import sqlite3
+    from types import SimpleNamespace
+
+    from hbkit import tui
+
+    db = tmp_path / "index.db"
+    con = sqlite3.connect(db)
+    con.execute("CREATE TABLE node(id INTEGER PRIMARY KEY, parent INTEGER, name TEXT, "
+                "isdir INTEGER, size INTEGER, nfiles INTEGER, ovf INTEGER, mtime INTEGER, "
+                "share TEXT)")
+    con.execute("INSERT INTO node VALUES (1, NULL, 'share', 1, 10, 1, NULL, 0, 'share')")
+    con.commit()
+    con.close()
+    monkeypatch.chdir(tmp_path)
+
+    class App(tui.HBKApp):
+        def on_mount(self, event):
+            event.prevent_default()            # skip the archive picker
+            self.push_screen(tui.BrowserScreen(SimpleNamespace(root="demo"), tui.Index(str(db))))
+
+    async def space_line():
+        app = App(1)
+        async with app.run_test() as pilot:
+            await pilot.pause()
+            app.screen.query_one("#dest", tui.Input).value = typed
+            await pilot.pause()
+            return str(app.screen.query_one("#space-info", tui.Static).render())
+
+    line = asyncio.run(space_line())
+    assert "free" in line and "invalid" not in line, line