printbox 0.2.51__tar.gz

printbox-0.2.51/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PrintBox contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

printbox-0.2.51/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: printbox
+Version: 0.2.51
+Summary: Turn a minimal Linux box into a headless print server (CUPS / AirPrint / Mopria / WS-Discovery / WebUI / archive).
+License: MIT
+Project-URL: Homepage, https://github.com/PaulLiszt/printbox
+Project-URL: Repository, https://github.com/PaulLiszt/printbox
+Keywords: print,cups,airprint,mopria,print-server,iot
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: System :: Systems Administration
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# PrintBox
+
+把一台**已经装好精简 Linux（Debian / Ubuntu 等 systemd 发行版）**的主机，变成一台无头打印服务器。
+
+> 产品形态：这是一个 **pip 分发的 Python 应用**，不再包含整个操作系统。
+> 网络参数、主机名、系统账号等由底层 Linux 自行管理（与系统一致）；
+> PrintBox 只负责把打印服务栈跑起来并提供管理界面。
+
+## 功能
+
+- **一键启动**：`sudo printbox init` 后所有服务开机自启；`printbox start/stop/restart/status` 随时管理。
+- **全协议无线/有线打印**：CUPS + IPP Everywhere + AirPrint(iOS/macOS) + Mopria(Android/HarmonyOS) + WS-Discovery(Windows) + LPD。
+- **Web 管理界面**：状态 / 打印机 / 打印设置 / 系统 / 关于 / 归档 / 打印历史 / 设置 / 日志，局域网 `http://<主机名>.local` 直接访问。打印设置可改纸张/双面/色彩等可选项并设默认打印机；系统页展示硬件用量、网络/WiFi 与系统升级；关于页展示版本与更新日志。
+- **自动安装驱动**：探测到打印机后按厂商自动 `apt` 安装对应驱动包（HP / Brother / Samsung / Canon / Epson …）。
+- **打印文件归档**：每次打印的原始文件自动保存，按磁盘容量自动算配额，装满轮替删除最旧文件。
+- **打印历史**：可预览(PDF)、可一键再次打印。
+- **断电不丢参**：配置落盘 `/etc/printbox`，日志落盘 `/var/log/printbox`。
+
+## 安装
+
+**一行命令从 PyPI 安装：**
+
+```bash
+pip install printbox
+```
+
+安装后初始化（需 root，会自动装系统依赖、写服务、探测打印机）：
+
+```bash
+sudo printbox init
+```
+
+**或全自动一键（GitHub 安装脚本，自动建 venv + 安装 + 初始化）：**
+
+```bash
+curl -sSL https://raw.githubusercontent.com/PaulLiszt/printbox/main/install.sh | sudo bash
+```
+
+或在本仓库目录内离线安装：
+
+```bash
+sudo ./install.sh --local
+```
+
+安装脚本会：创建独立虚拟环境 `/opt/printbox/venv` → 安装 `printbox` →
+建立 `/usr/local/bin/printbox` → 运行 `printbox init`（装系统依赖、写服务、探测打印机）。
+
+> 可靠性：脚本**可重复运行**（重跑自动重建 venv 与服务）；逐包安装依赖，**个别在源中已更名的包会自动跳过**，不影响核心服务；**Web 管理界面始终会启动**（不依赖 CUPS 是否装好），打印功能待 CUPS 就绪后自动可用。
+
+## 使用
+
+```bash
+sudo printbox status     # 查看服务状态
+sudo printbox detect     # 重新探测/添加打印机（自动装驱动）
+sudo printbox restart    # 重启全部服务
+printbox version         # 显示版本
+```
+
+浏览器打开安装结束时显示的 **本机 IP**（如 `http://192.168.1.100`），或 `<主机名>.local`（如 `http://<box>.local`），
+即可在 Web 界面管理打印机、查看打印历史与归档。
+
+## 手动从 PyPI 安装（等价）
+
+```bash
+python3 -m venv /opt/printbox/venv
+/opt/printbox/venv/bin/pip install printbox
+ln -s /opt/printbox/venv/bin/printbox /usr/local/bin/printbox
+sudo printbox init
+```
+
+## 目录约定（FHS）
+
+| 用途 | 路径 |
+|---|---|
+| 配置 | `/etc/printbox/config.json` |
+| 状态/归档 | `/var/lib/printbox`（含 `archive/`） |
+| 日志 | `/var/log/printbox/*.log` |
+| 命令 | `/usr/local/bin/printbox` |
+
+## 许可证
+
+MIT

printbox-0.2.51/README.md

@@ -0,0 +1,82 @@
+# PrintBox
+
+把一台**已经装好精简 Linux（Debian / Ubuntu 等 systemd 发行版）**的主机，变成一台无头打印服务器。
+
+> 产品形态：这是一个 **pip 分发的 Python 应用**，不再包含整个操作系统。
+> 网络参数、主机名、系统账号等由底层 Linux 自行管理（与系统一致）；
+> PrintBox 只负责把打印服务栈跑起来并提供管理界面。
+
+## 功能
+
+- **一键启动**：`sudo printbox init` 后所有服务开机自启；`printbox start/stop/restart/status` 随时管理。
+- **全协议无线/有线打印**：CUPS + IPP Everywhere + AirPrint(iOS/macOS) + Mopria(Android/HarmonyOS) + WS-Discovery(Windows) + LPD。
+- **Web 管理界面**：状态 / 打印机 / 打印设置 / 系统 / 关于 / 归档 / 打印历史 / 设置 / 日志，局域网 `http://<主机名>.local` 直接访问。打印设置可改纸张/双面/色彩等可选项并设默认打印机；系统页展示硬件用量、网络/WiFi 与系统升级；关于页展示版本与更新日志。
+- **自动安装驱动**：探测到打印机后按厂商自动 `apt` 安装对应驱动包（HP / Brother / Samsung / Canon / Epson …）。
+- **打印文件归档**：每次打印的原始文件自动保存，按磁盘容量自动算配额，装满轮替删除最旧文件。
+- **打印历史**：可预览(PDF)、可一键再次打印。
+- **断电不丢参**：配置落盘 `/etc/printbox`，日志落盘 `/var/log/printbox`。
+
+## 安装
+
+**一行命令从 PyPI 安装：**
+
+```bash
+pip install printbox
+```
+
+安装后初始化（需 root，会自动装系统依赖、写服务、探测打印机）：
+
+```bash
+sudo printbox init
+```
+
+**或全自动一键（GitHub 安装脚本，自动建 venv + 安装 + 初始化）：**
+
+```bash
+curl -sSL https://raw.githubusercontent.com/PaulLiszt/printbox/main/install.sh | sudo bash
+```
+
+或在本仓库目录内离线安装：
+
+```bash
+sudo ./install.sh --local
+```
+
+安装脚本会：创建独立虚拟环境 `/opt/printbox/venv` → 安装 `printbox` →
+建立 `/usr/local/bin/printbox` → 运行 `printbox init`（装系统依赖、写服务、探测打印机）。
+
+> 可靠性：脚本**可重复运行**（重跑自动重建 venv 与服务）；逐包安装依赖，**个别在源中已更名的包会自动跳过**，不影响核心服务；**Web 管理界面始终会启动**（不依赖 CUPS 是否装好），打印功能待 CUPS 就绪后自动可用。
+
+## 使用
+
+```bash
+sudo printbox status     # 查看服务状态
+sudo printbox detect     # 重新探测/添加打印机（自动装驱动）
+sudo printbox restart    # 重启全部服务
+printbox version         # 显示版本
+```
+
+浏览器打开安装结束时显示的 **本机 IP**（如 `http://192.168.1.100`），或 `<主机名>.local`（如 `http://<box>.local`），
+即可在 Web 界面管理打印机、查看打印历史与归档。
+
+## 手动从 PyPI 安装（等价）
+
+```bash
+python3 -m venv /opt/printbox/venv
+/opt/printbox/venv/bin/pip install printbox
+ln -s /opt/printbox/venv/bin/printbox /usr/local/bin/printbox
+sudo printbox init
+```
+
+## 目录约定（FHS）
+
+| 用途 | 路径 |
+|---|---|
+| 配置 | `/etc/printbox/config.json` |
+| 状态/归档 | `/var/lib/printbox`（含 `archive/`） |
+| 日志 | `/var/log/printbox/*.log` |
+| 命令 | `/usr/local/bin/printbox` |
+
+## 许可证
+
+MIT

printbox-0.2.51/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "printbox"
+version = "0.2.51"
+description = "Turn a minimal Linux box into a headless print server (CUPS / AirPrint / Mopria / WS-Discovery / WebUI / archive)."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+keywords = ["print", "cups", "airprint", "mopria", "print-server", "iot"]
+classifiers = [
+    "Operating System :: POSIX :: Linux",
+    "Topic :: System :: Systems Administration",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+]
+dependencies = []   # 纯标准库实现，无 Python 第三方依赖
+
+[project.urls]
+Homepage = "https://github.com/PaulLiszt/printbox"
+Repository = "https://github.com/PaulLiszt/printbox"
+
+[project.scripts]
+printbox = "printbox.cli:main"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+packages = ["printbox"]
+
+[tool.setuptools.package-data]
+printbox = [
+    "web/templates/*.html",
+    "web/static/*.css",
+    "data/*.service",
+    "data/*.rules",
+    "data/*.json",
+]

printbox-0.2.51/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

printbox-0.2.51/src/printbox/__init__.py

@@ -0,0 +1,5 @@
+"""PrintBox —— 把一台精简 Linux 主机变成无头打印服务器。
+
+以 pip 包形式分发，安装后由 printbox init 在本机配置打印/网络栈与 systemd 服务。
+"""
+__version__ = "0.2.51"

printbox-0.2.51/src/printbox/__main__.py

@@ -0,0 +1,4 @@
+from printbox.cli import main
+
+if __name__ == "__main__":
+    main()

printbox-0.2.51/src/printbox/about.py

@@ -0,0 +1,48 @@
+"""PrintBox 关于/发布页内容。
+
+优先读取 /var/lib/printbox/about.json（可由管理员就地编辑，无需重装），
+回退到打包的 data/about.json。WebUI 的“关于”页渲染此内容；
+用户后续新增的版本功能、改进内容、发布页面链接都放在这个 JSON 里即可。
+"""
+import json
+import os
+
+from . import config as C
+from . import __version__
+
+
+def _pkg_path():
+    return os.path.join(os.path.dirname(os.path.abspath(__file__)), "data", "about.json")
+
+
+def load_about():
+    state_path = os.path.join(C.STATE_DIR, "about.json")
+    for p in (state_path, _pkg_path()):
+        if os.path.exists(p):
+            try:
+                with open(p, "r", encoding="utf-8") as f:
+                    data = json.load(f)
+                data.setdefault("version", __version__)
+                return data
+            except Exception:
+                continue
+    return {
+        "project": "PrintBox",
+        "tagline": "把一台精简 Linux 主机变成无头打印服务器",
+        "description": "",
+        "homepage": "",
+        "releases_url": "",
+        "features": [],
+        "changelog": [],
+        "version": __version__,
+    }
+
+
+def save_about(data):
+    """就地保存（管理员可在设备上改关于页内容）。"""
+    path = os.path.join(C.STATE_DIR, "about.json")
+    C.ensure_dirs()
+    tmp = path + ".tmp"
+    with open(tmp, "w", encoding="utf-8") as f:
+        json.dump(data, f, indent=2, ensure_ascii=False)
+    os.replace(tmp, path)

printbox-0.2.51/src/printbox/archive.py

@@ -0,0 +1,232 @@
+"""PrintBox 打印文件归档（自动配额 + 环型轮替）。
+
+- 每次打印的原始文件都保存下来，便于追溯。
+- 归档空间按磁盘容量自动计算（见 config.compute_archive_quota）。
+- 装满后自动删除最旧的文件（轮替），不会无限增长。
+
+依赖 CUPS 的 PreserveJobFiles（由 printers.enable_job_archive 开启）。
+"""
+import os
+import re
+import sys
+import time
+import json
+import shutil
+
+from . import config as C
+
+SPOOL = C.SPOOL
+POLL_INTERVAL = 15          # 秒
+EXT_MAP = {
+    "application/pdf": "pdf",
+    "application/postscript": "ps",
+    "application/vnd.cups-postscript": "ps",
+    "image/urf": "urf",
+    "image/pwg-raster": "pwg",
+    "text/plain": "txt",
+    "text/html": "html",
+    "application/octet-stream": "bin",
+}
+
+
+def ensure_preserve():
+    # PreserveJobFiles 保留原始文件；PreserveJobHistory 让已完成作业在 lpstat -W completed 中
+    # 保留更久，避免刚打印完、归档轮询还没跑到时作业就从历史里消失（表现为“历史只有旧记录”）。
+    # 0.2.48：改为直接写 cupsd.conf（幂等 no-op），不再调用 cupsctl 做 live reload——
+    # 对 PreserveJobFiles/PreserveJobHistory 的 live 重载会让 cupsd 立即崩溃重启、重跑作业。
+    from . import printers
+    try:
+        printers.enable_job_archive()
+    except Exception:
+        pass
+
+
+def list_completed_jobs():
+    """返回已完成作业列表 [{id, printer, user, name, format}]。"""
+    jobs = {}
+    rc, out, _ = C.run(["lpstat", "-W", "completed", "-o"])
+    for line in out.splitlines():
+        line = line.strip()
+        m = re.match(r"^(\S+?)-(\d+)\s+(\S+)\s+(\d+)\s+(.*)$", line)
+        if m:
+            prn, jid, user, _size, rest = m.groups()
+            jobs[int(jid)] = {
+                "id": int(jid), "printer": prn, "user": user,
+                "name": rest.strip(), "format": "",
+            }
+    rc, out2, _ = C.run(["lpstat", "-l", "-W", "completed", "-o"])
+    cur = None
+    for line in out2.splitlines():
+        if re.match(r"^\S+?-\d+\s", line):
+            mm = re.match(r"^(\S+?)-(\d+)", line)
+            cur = int(mm.group(2)) if mm else None
+        elif cur is not None and "document-format" in line:
+            parts = line.split(None, 1)
+            if len(parts) == 2:
+                jobs.get(cur, {})["format"] = parts[1].strip()
+    return list(jobs.values())
+
+
+def load_state(d):
+    sp = os.path.join(d, "state.json")
+    if os.path.exists(sp):
+        try:
+            with open(sp) as f:
+                return set(json.load(f).get("processed", []))
+        except Exception:
+            return set()
+    return set()
+
+
+def save_state(d, processed):
+    sp = os.path.join(d, "state.json")
+    tmp = sp + ".tmp"
+    with open(tmp, "w") as f:
+        json.dump({"processed": sorted(processed)}, f)
+    os.replace(tmp, sp)
+
+
+def sanitize(s, maxlen=40):
+    s = re.sub(r"[^\w\-_. ]", "_", s or "job").strip() or "job"
+    return s[:maxlen]
+
+
+def ext_for(format_str):
+    return EXT_MAP.get((format_str or "").lower(), "bin")
+
+
+def archive_one(job, d, processed):
+    jid = job["id"]
+    # CUPS spool 数据文件名是 5 位零填充（如 d00012），不能用裸 d{jid} 匹配；
+    # 用 ^d0*{jid} 兼容任意前导零（d12 / d0012 / d00012 都能命中）。
+    pat = re.compile(rf"^d0*{jid}(?:-\d+)?$")
+    matches = sorted(p for p in os.listdir(SPOOL) if pat.match(p))
+    ts = time.strftime("%Y%m%d-%H%M%S")
+    user = sanitize(job["user"], 20)
+    name = sanitize(job["name"])
+    ext = ext_for(job.get("format"))
+    base = f"{ts}_{jid}_{user}_{name}"
+    saved = []
+    if matches:
+        for i, fn in enumerate(matches):
+            src = os.path.join(SPOOL, fn)
+            suffix = f".{i+1}" if len(matches) > 1 else ""
+            dst = os.path.join(d, f"{base}{suffix}.{ext}")
+            try:
+                shutil.copy2(src, dst)
+                saved.append(dst)
+            except Exception as e:
+                C.log("archive", "WARN", f"复制作业 {jid} 文件失败: {e}")
+    # 即便 spool 文件已不在（CUPS 清理/未开启保留），也写一条历史元数据包，
+    # 保证“最近打印”稳定出现在历史里（仅无原文件可下载）。
+    meta = {
+        "job_id": jid,
+        "printer": job.get("printer"),
+        "user": job.get("user"),
+        "job_name": job.get("name"),
+        "format": job.get("format"),
+        "archived_at": ts,
+        "files": [os.path.basename(x) for x in saved],
+        "no_file": len(saved) == 0,
+    }
+    with open(os.path.join(d, base + ".meta.json"), "w") as f:
+        json.dump(meta, f, indent=2, ensure_ascii=False)
+    if saved:
+        C.log("archive", "INFO", f"已归档作业 {jid} ({job.get('name')}) -> {len(saved)} 个文件")
+    else:
+        C.log("archive", "DEBUG",
+              f"作业 {jid} 无 spool 原文件（已记历史元数据；可能 PreserveJobFiles 未生效）")
+    processed.add(jid)
+    return True
+
+
+def enforce_quota(d, max_bytes):
+    if max_bytes <= 0:
+        return
+    files = []
+    total = 0
+    for name in os.listdir(d):
+        if name.endswith(".meta.json") or name == "state.json":
+            continue
+        fp = os.path.join(d, name)
+        try:
+            stt = os.stat(fp)
+        except OSError:
+            continue
+        files.append((stt.st_mtime, fp))
+        total += stt.st_size
+    if total <= max_bytes:
+        return
+    files.sort()
+    C.log("archive", "INFO",
+          f"归档超出配额 ({total/1024/1024:.1f}/{max_bytes/1024/1024:.1f} MB)，开始轮替删除最旧文件")
+    for mtime, fp in files:
+        if total <= max_bytes:
+            break
+        try:
+            sz = os.path.getsize(fp)
+            os.remove(fp)
+            total -= sz
+            meta = fp[:-4] + ".meta.json" if not fp.endswith(".meta.json") else fp
+            if os.path.exists(meta):
+                os.remove(meta)
+            C.log("archive", "INFO", f"轮替删除: {os.path.basename(fp)}")
+        except OSError:
+            pass
+
+
+def run_once(dry=False):
+    cfg = C.load_config()
+    a = cfg.get("archive", {})
+    if not a.get("enabled", True):
+        return
+    d = a.get("dir", C.ARCHIVE_DIR)
+    os.makedirs(d, exist_ok=True)
+    ensure_preserve()
+    max_mb = int(a.get("max_size_mb", 0) or 0)
+    if max_mb <= 0:
+        try:
+            st = os.statvfs("/")
+            total = st.f_frsize * st.f_blocks
+            max_mb = C.compute_archive_quota(total)
+            a["max_size_mb"] = max_mb
+            C.save_config(cfg)
+        except Exception:
+            max_mb = 2048
+    max_bytes = max_mb * 1024 * 1024
+
+    processed = load_state(d)
+    jobs = list_completed_jobs()
+    new_count = 0
+    for job in jobs:
+        if job["id"] in processed:
+            continue
+        if archive_one(job, d, processed):
+            new_count += 1
+        else:
+            C.log("archive", "DEBUG",
+                  f"已完成作业 {job['id']} 未在 spool 找到原始数据文件"
+                  f"（可能 PreserveJobFiles 关闭、或文件已被 CUPS 清理）")
+    if new_count:
+        save_state(d, processed)
+    if not dry:
+        enforce_quota(d, max_bytes)
+
+
+def main():
+    C.ensure_dirs()
+    if "--once" in sys.argv:
+        run_once()
+        return 0
+    C.log("archive", "INFO", "打印归档守护进程启动")
+    while True:
+        try:
+            run_once()
+        except Exception as e:
+            C.log("archive", "ERROR", f"归档循环异常: {e}")
+        time.sleep(POLL_INTERVAL)
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())