mAi: #2 - mdms-mover: strip blank pages from duplex scans

Two changes:

1. Migrate mover from m/otto (commit 9974937, otto#438) into this repo
   at infra/mdms-mover/. mover.sh, mdms-mover.service, mdms-mover.timer,
   README.md. Matches the live deployment on mDock byte-for-byte (modulo
   the strip step below).

2. Add blank-page stripping before the inbox → toprocess promotion. A
   page is dropped iff its embedded text is empty AND its rendered
   thumbnail is >= MDMS_BLANK_THRESHOLD near-white pixels (default 0.97
   per issue #2). Detects the empty backside of patch-T separator
   sheets in duplex scans (mDMS#2).

strip_blank_pages.py uses PyMuPDF as the only Python dep — single
self-contained wheel, no `poppler-utils` apt-install on mdock. Mirrors
the uv-inline-deps single-file pattern of infra/paperless/generate_separator.py.

Edge cases:
- 1-page input: strip skipped entirely.
- All pages would drop: script exits 2, mover keeps file in inbox and
  logs WARNING (no empty doc reaches Paperless).
- Strip script errors: mover falls back to plain mv, no scan blocked.
- MDMS_STRIP_BLANK=false: bypass strip entirely (emergency disable).

Deploy: rsync uv binary to mdock ~/.local/bin/uv (single static binary,
user-space, no apt), scp script + units, systemctl --user daemon-reload.
Verified live with synthetic 4-page (2 real + 1 blank + 1 real → 3
pages), 1-page (unchanged), all-blank (kept in inbox + warning) test
PDFs. Timer fires every ~70s as before.
This commit is contained in:
mAi
2026-05-16 17:57:26 +02:00
parent 862bc76a2b
commit 90142396d8
6 changed files with 419 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.m/

180
infra/mdms-mover/README.md Normal file
View File

@@ -0,0 +1,180 @@
# mdms-mover — age-gated inbox → toprocess promoter + blank-page stripper
Two jobs in one user-systemd timer:
1. **Stability gate** (otto#438): solves the chunk-write race between the
Canon MB5100 (SMB scans land in `/mnt/mdms/inbox/` in pieces) and
Paperless (polls `/mnt/mdms/toprocess/` every 60s and consumes
anything it sees). A file is only promoted when **both**:
- `mtime > 3 minutes` ago, and
- file size is unchanged since the previous run.
2. **Blank-page strip** (mDMS#2): duplex scans through patch-T separators
leave a blank backside (the unprinted reverse of the separator sheet)
at the front of every subsequent document. PDF files are passed
through `strip_blank_pages.py` before promotion. Pages with no
embedded text AND >97% near-white pixels are dropped.
## Layout on mDock
```
/home/m/mdms-mover/mover.sh # script, deployed copy
/home/m/mdms-mover/strip_blank_pages.py # blank-page detector
/home/m/.config/systemd/user/mdms-mover.service # oneshot service
/home/m/.config/systemd/user/mdms-mover.timer # OnUnitActiveSec=1min
/home/m/.local/state/mdms-mover/state.tsv # last-seen size per file
/home/m/.local/bin/uv # uv runner for the strip script
```
Runs as user `m` under user-systemd. mDock has `Linger=yes` for user
`m`, so the timer keeps firing across reboots and logout sessions.
## Why systemd, not cron
The original spec (otto#438) called for `/etc/cron.d/mdms-mover`. mDock
runs Ubuntu 24.04 server which ships with systemd-timers and no `cron`
package. Installing cron only to honour the spec wording would add a
package we don't otherwise need; a user-systemd timer is the canonical
Ubuntu 24.04 approach and gives better observability
(`systemctl --user status mdms-mover.timer`, `journalctl --user -u mdms-mover`).
User-mode (not system-mode) keeps the entire install in `m`'s home — no
sudo at deploy or maintenance time, no `/var/lib/...` directories to
chown, the service can read/write the NFS mount because `m` owns it.
## Configuration
```
| var | default | meaning |
|------------------------|-----------------------------------------------|----------------------------------------------------|
| MDMS_INBOX | /mnt/mdms/inbox | source — scanner SMB target |
| MDMS_TOPROCESS | /mnt/mdms/toprocess | destination — Paperless consume |
| MDMS_STATE | $HOME/.local/state/mdms-mover/state.tsv | per-file size memory |
| MDMS_MIN_AGE_MIN | 3 | minimum mtime age in minutes |
| MDMS_STRIP_BLANK | true | run blank-page strip on PDFs (set to "false" to disable) |
| MDMS_STRIP_SCRIPT | <mover dir>/strip_blank_pages.py | path override for the strip script |
| MDMS_BLANK_THRESHOLD | 0.97 | near-white pixel ratio to call a page blank (read by strip script) |
| MDMS_BLANK_NEAR_WHITE | 240 | grayscale cutoff (0-255) for "near white" pixels (read by strip script) |
| MDMS_BLANK_DPI | 50 | thumbnail render DPI (read by strip script) |
```
To override at runtime, drop into
`~/.config/systemd/user/mdms-mover.service.d/override.conf`:
```ini
[Service]
Environment=MDMS_MIN_AGE_MIN=5
Environment=MDMS_BLANK_THRESHOLD=0.99
```
then `systemctl --user daemon-reload && systemctl --user restart mdms-mover.timer`.
## Blank-page detection — what gets dropped
A page is dropped iff BOTH:
1. embedded text is empty / whitespace-only (image-only scans always
pass this — they have no embedded text), AND
2. the rendered thumbnail is ≥ `MDMS_BLANK_THRESHOLD` near-white pixels
(0.97 by default → >97% of pixels brighter than grayscale 240).
The threshold is conservative on purpose: a false-negative (keeping a
blank page we should have dropped) is recoverable via Paperless's UI; a
false-positive (dropping a real page) silently loses data. If real
pages get dropped in practice, **raise** `MDMS_BLANK_THRESHOLD` toward
0.99 — that makes the strip step pickier and keeps more pages.
Edge cases handled inside `strip_blank_pages.py`:
- **1-page input:** strip is skipped entirely (single-page docs never
have separator-backside artefacts).
- **All pages would drop:** the script exits with code `2` and writes no
output. The mover keeps the file in the inbox and logs
`WARNING: <name> appears all-blank, kept in inbox`. m can inspect via
`journalctl --user -u mdms-mover`.
- **strip_blank_pages.py errors out:** mover falls back to a plain `mv`
(unstripped) so a transient problem in the detector never blocks a
scan from reaching Paperless.
The script is a uv-inline-deps single file (PyMuPDF for both rendering
and text extraction — one wheel, no `poppler-utils` apt install on
mdock). Mirrors the pattern from `infra/paperless/generate_separator.py`.
## Deploy / sync
The live files on mDock must match this directory byte-for-byte (md5,
same convention as `infra/samba-canon/`).
```bash
ssh mdock 'mkdir -p ~/mdms-mover ~/.config/systemd/user ~/.local/state/mdms-mover ~/.local/bin'
# uv binary (single static binary, user-space — no apt, no sudo)
rsync -av ~/.local/bin/uv mdock:/home/m/.local/bin/uv
# mover + strip script
scp infra/mdms-mover/mover.sh mdock:/home/m/mdms-mover/mover.sh
scp infra/mdms-mover/strip_blank_pages.py mdock:/home/m/mdms-mover/strip_blank_pages.py
scp infra/mdms-mover/mdms-mover.service mdock:/home/m/.config/systemd/user/
scp infra/mdms-mover/mdms-mover.timer mdock:/home/m/.config/systemd/user/
ssh mdock 'chmod +x ~/mdms-mover/mover.sh ~/mdms-mover/strip_blank_pages.py && \
systemctl --user daemon-reload && \
systemctl --user enable --now mdms-mover.timer'
```
The first time the strip script runs, `uv` downloads python + PyMuPDF
into `~/.cache/uv/` (~30 MB). Subsequent runs reuse the cache.
## Verify
```bash
ssh mdock 'systemctl --user list-timers mdms-mover.timer'
ssh mdock 'journalctl --user -u mdms-mover -n 20 --no-pager'
ssh mdock 'cat ~/.local/state/mdms-mover/state.tsv'
ssh mdock 'journalctl -t mdms-mover -n 20 --no-pager'
```
## Emergency disable
Stop the timer entirely:
```bash
ssh mdock 'systemctl --user stop mdms-mover.timer && \
systemctl --user disable mdms-mover.timer'
```
Or just disable the strip step while keeping the stability gate:
```bash
mkdir -p ~/.config/systemd/user/mdms-mover.service.d
cat > ~/.config/systemd/user/mdms-mover.service.d/override.conf <<EOF
[Service]
Environment=MDMS_STRIP_BLANK=false
EOF
systemctl --user daemon-reload
```
Re-enable the timer with `systemctl --user enable --now mdms-mover.timer`.
If you need to drain the inbox manually while disabled, files older
than a few minutes are safe to `mv` into `toprocess/` by hand —
Paperless will pick them up on its next poll.
## Logs
Service logs land in the user journal under unit `mdms-mover`, and
moved-file events also go through `logger -t mdms-mover` so they appear
under that tag in the system journal too:
```bash
ssh mdock 'journalctl --user -u mdms-mover -f' # service execution
ssh mdock 'journalctl -t mdms-mover -f' # moved-file events
```
## Refs
- mDMS#2 — blank-page strip (this README)
- otto#438 — original scheduler / staging-folder design
- otto#429 — original Paperless pipeline setup
- otto#431 — samba-canon bridge container (upstream of this mover)
- `docs/strategy.md` — overall mDMS dataset layout
- `infra/paperless/generate_separator.py` — sibling uv-inline-deps script

View File

@@ -0,0 +1,11 @@
[Unit]
Description=mDMS mover — promote stable scanner files inbox → toprocess
After=network-online.target remote-fs.target
Wants=network-online.target remote-fs.target
[Service]
Type=oneshot
ExecStart=%h/mdms-mover/mover.sh
[Install]
WantedBy=default.target

View File

@@ -0,0 +1,12 @@
[Unit]
Description=Run mDMS mover every minute
Requires=mdms-mover.service
[Timer]
OnBootSec=2min
OnUnitActiveSec=1min
AccuracySec=10s
Unit=mdms-mover.service
[Install]
WantedBy=timers.target default.target

93
infra/mdms-mover/mover.sh Executable file
View File

@@ -0,0 +1,93 @@
#!/bin/bash
# mdms-mover: move stable files from /mnt/mdms/inbox → /mnt/mdms/toprocess.
#
# A file is "stable" when it satisfies BOTH conditions:
# 1. mtime older than MIN_AGE seconds (default 180s).
# 2. size unchanged since the previous run (recorded in STATE).
#
# This protects Paperless from ingesting half-written scans dropped by the
# Canon MB5100 via SMB. See otto#438, mDMS#2.
#
# When MDMS_STRIP_BLANK=true (default) and the file is a PDF, blank pages
# are stripped before promotion (mDMS#2). Empty backsides of patch-T
# separators from duplex scans land here. See strip_blank_pages.py for the
# detection heuristic.
set -euo pipefail
INBOX="${MDMS_INBOX:-/mnt/mdms/inbox}"
TOPROCESS="${MDMS_TOPROCESS:-/mnt/mdms/toprocess}"
STATE="${MDMS_STATE:-$HOME/.local/state/mdms-mover/state.tsv}"
MIN_AGE_MIN="${MDMS_MIN_AGE_MIN:-3}"
STRIP_BLANK="${MDMS_STRIP_BLANK:-true}"
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
STRIP_SCRIPT="${MDMS_STRIP_SCRIPT:-$SCRIPT_DIR/strip_blank_pages.py}"
mkdir -p "$TOPROCESS" "$(dirname "$STATE")"
touch "$STATE"
NEW_STATE=$(mktemp)
trap 'rm -f "$NEW_STATE"' EXIT
# Promote a single stable file from inbox into toprocess, blank-stripping
# PDFs when enabled. Returns silently; logs go through logger(1).
promote() {
local src="$1" name="$2" size="$3"
local ext="${name##*.}"
local dest="$TOPROCESS/$name"
if [[ "$STRIP_BLANK" != "true" || "${ext,,}" != "pdf" || ! -x "$STRIP_SCRIPT" ]]; then
if mv -n "$src" "$dest" 2>/dev/null; then
logger -t mdms-mover "moved $name ($size bytes)"
fi
return
fi
# Stage stripped output inside toprocess (same filesystem → atomic rename).
# Dotfile prefix so Paperless's consumer ignores the partial during write.
local tmpout="$TOPROCESS/.mdms-tmp.$$.$name"
local rc=0
"$STRIP_SCRIPT" "$src" "$tmpout" || rc=$?
case "$rc" in
0)
mv -f "$tmpout" "$dest" && rm -f "$src"
logger -t mdms-mover "moved $name ($size bytes, strip ok)"
;;
2)
rm -f "$tmpout"
logger -t mdms-mover "WARNING: $name appears all-blank, kept in inbox"
;;
*)
rm -f "$tmpout"
logger -t mdms-mover "strip failed for $name (rc=$rc), passing through unchanged"
if mv -n "$src" "$dest" 2>/dev/null; then
logger -t mdms-mover "moved $name ($size bytes, unstripped)"
fi
;;
esac
}
# Iterate top-level regular files older than MIN_AGE_MIN.
# Skip dotfiles (probe files, scanner temp markers like ._foo, our .mdms-tmp.*).
while IFS= read -r f; do
name=$(basename "$f")
case "$name" in
.*) continue ;;
esac
if ! size=$(stat -c %s "$f" 2>/dev/null); then
continue
fi
prev=$(awk -v n="$name" '$1==n {print $2; exit}' "$STATE")
printf '%s\t%s\n' "$name" "$size" >> "$NEW_STATE"
if [[ -n "$prev" && "$size" == "$prev" ]]; then
promote "$f" "$name" "$size"
fi
done < <(find "$INBOX" -maxdepth 1 -type f -mmin "+$MIN_AGE_MIN")
mv "$NEW_STATE" "$STATE"
trap - EXIT

View File

@@ -0,0 +1,122 @@
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.11"
# dependencies = [
# "pymupdf>=1.24",
# "Pillow>=10.0",
# ]
# ///
"""Strip blank pages from a PDF — used by mdms-mover before promoting to toprocess.
Usage:
strip_blank_pages.py <input.pdf> <output.pdf>
Exit codes:
0 output.pdf written (either stripped or copied unchanged)
2 all pages would be dropped — output NOT written, caller should keep
the original file in the inbox and log a warning
1 error (input unreadable, write failed, etc.)
A page counts as "blank" iff BOTH of:
* embedded text is empty / whitespace-only, AND
* rendered thumbnail is >= MDMS_BLANK_THRESHOLD near-white pixels.
False-negatives are preferred over false-positives — borderline pages stay.
Env:
MDMS_BLANK_THRESHOLD near-white pixel ratio (0.0-1.0, default 0.97)
MDMS_BLANK_NEAR_WHITE near-white cutoff in 0-255 grayscale (default 240)
MDMS_BLANK_DPI thumbnail render DPI (default 50)
PyMuPDF is used instead of pdf2image+pikepdf+pypdf so the whole pipeline is
one self-contained wheel — no poppler-utils apt-install on mdock, no
multiple text-extraction libraries to keep in sync.
"""
from __future__ import annotations
import io
import os
import shutil
import sys
from pathlib import Path
import fitz # PyMuPDF
from PIL import Image
def near_white_ratio(image: Image.Image, near_white: int) -> float:
gray = image.convert("L") if image.mode != "L" else image
hist = gray.histogram()
total = sum(hist)
if total == 0:
return 1.0
return sum(hist[near_white:]) / total
def page_is_blank(page: "fitz.Page", threshold: float, near_white: int, dpi: int) -> bool:
text = (page.get_text("text") or "").strip()
if text:
return False
pix = page.get_pixmap(dpi=dpi, colorspace=fitz.csGRAY)
image = Image.frombytes("L", (pix.width, pix.height), pix.samples)
return near_white_ratio(image, near_white) >= threshold
def main() -> int:
if len(sys.argv) != 3:
print(f"usage: {sys.argv[0]} <input.pdf> <output.pdf>", file=sys.stderr)
return 1
src = Path(sys.argv[1])
dst = Path(sys.argv[2])
threshold = float(os.environ.get("MDMS_BLANK_THRESHOLD", "0.97"))
near_white = int(os.environ.get("MDMS_BLANK_NEAR_WHITE", "240"))
dpi = int(os.environ.get("MDMS_BLANK_DPI", "50"))
try:
doc = fitz.open(src)
except Exception as exc:
print(f"failed to open {src}: {exc}", file=sys.stderr)
return 1
try:
page_count = doc.page_count
if page_count <= 1:
shutil.copyfile(src, dst)
return 0
keep: list[int] = []
for i in range(page_count):
if not page_is_blank(doc[i], threshold, near_white, dpi):
keep.append(i)
if not keep:
print(f"all pages blank in {src.name}", file=sys.stderr)
return 2
if len(keep) == page_count:
shutil.copyfile(src, dst)
return 0
out = fitz.open()
try:
for i in keep:
out.insert_pdf(doc, from_page=i, to_page=i)
out.save(dst)
finally:
out.close()
dropped = page_count - len(keep)
print(
f"{src.name}: dropped {dropped}/{page_count} blank page(s)",
file=sys.stderr,
)
return 0
finally:
doc.close()
if __name__ == "__main__":
sys.exit(main())