bouquin 0.1.3__tar.gz → 0.1.5__tar.gz

{bouquin-0.1.3 → bouquin-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bouquin
-Version: 0.1.3
+Version: 0.1.5
 Summary: Bouquin is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.
 Home-page: https://git.mig5.net/mig5/bouquin
 License: GPL-3.0-or-later
@@ -46,6 +46,7 @@ There is deliberately no network connectivity or syncing intended.
  * Search
  * Automatic periodic saving (or explicitly save)
  * Transparent integrity checking of the database when it opens
+ * Automatic locking of the app after a period of inactivity (default 15 min)
  * Rekey the database (change the password)
  * Export the database to json, txt, html or csv
 

{bouquin-0.1.3 → bouquin-0.1.5}/README.md

@@ -26,6 +26,7 @@ There is deliberately no network connectivity or syncing intended.
  * Search
  * Automatic periodic saving (or explicitly save)
  * Transparent integrity checking of the database when it opens
+ * Automatic locking of the app after a period of inactivity (default 15 min)
  * Rekey the database (change the password)
  * Export the database to json, txt, html or csv
 

bouquin-0.1.5/bouquin/db.py

@@ -0,0 +1,451 @@
+from __future__ import annotations
+
+import csv
+import html
+import json
+import os
+
+from dataclasses import dataclass
+from pathlib import Path
+from sqlcipher3 import dbapi2 as sqlite
+from typing import List, Sequence, Tuple
+
+Entry = Tuple[str, str]
+
+
+@dataclass
+class DBConfig:
+    path: Path
+    key: str
+    idle_minutes: int = 15  # 0 = never lock
+
+
+class DBManager:
+    def __init__(self, cfg: DBConfig):
+        self.cfg = cfg
+        self.conn: sqlite.Connection | None = None
+
+    def connect(self) -> bool:
+        """
+        Open, decrypt and install schema on the database.
+        """
+        # Ensure parent dir exists
+        self.cfg.path.parent.mkdir(parents=True, exist_ok=True)
+        self.conn = sqlite.connect(str(self.cfg.path))
+        self.conn.row_factory = sqlite.Row
+        cur = self.conn.cursor()
+        cur.execute(f"PRAGMA key = '{self.cfg.key}';")
+        cur.execute("PRAGMA foreign_keys = ON;")
+        cur.execute("PRAGMA journal_mode = WAL;").fetchone()
+        try:
+            self._integrity_ok()
+        except Exception:
+            self.conn.close()
+            self.conn = None
+            return False
+        self._ensure_schema()
+        return True
+
+    def _integrity_ok(self) -> bool:
+        """
+        Runs the cipher_integrity_check PRAGMA on the database.
+        """
+        cur = self.conn.cursor()
+        cur.execute("PRAGMA cipher_integrity_check;")
+        rows = cur.fetchall()
+
+        # OK: nothing returned
+        if not rows:
+            return
+
+        # Not OK: rows of problems returned
+        details = "; ".join(str(r[0]) for r in rows if r and r[0] is not None)
+        raise sqlite.IntegrityError(
+            "SQLCipher integrity check failed"
+            + (f": {details}" if details else f" ({len(rows)} issue(s) reported)")
+        )
+
+    def _ensure_schema(self) -> None:
+        """
+        Install the expected schema on the database.
+        We also handle upgrades here.
+        """
+        cur = self.conn.cursor()
+        # Always keep FKs on
+        cur.execute("PRAGMA foreign_keys = ON;")
+
+        # Create new versioned schema if missing (< 0.1.5)
+        cur.executescript(
+            """
+            CREATE TABLE IF NOT EXISTS pages (
+                date TEXT PRIMARY KEY,                 -- yyyy-MM-dd
+                current_version_id INTEGER,
+                FOREIGN KEY(current_version_id) REFERENCES versions(id) ON DELETE SET NULL
+            );
+
+            CREATE TABLE IF NOT EXISTS versions (
+                id INTEGER PRIMARY KEY,
+                date TEXT NOT NULL,                    -- FK to pages.date
+                version_no INTEGER NOT NULL,           -- 1,2,3… per date
+                created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ','now')),
+                note   TEXT,
+                content TEXT NOT NULL,
+                FOREIGN KEY(date) REFERENCES pages(date) ON DELETE CASCADE
+            );
+
+            CREATE UNIQUE INDEX IF NOT EXISTS ux_versions_date_ver ON versions(date, version_no);
+            CREATE INDEX IF NOT EXISTS ix_versions_date_created ON versions(date, created_at);
+            """
+        )
+
+        # If < 0.1.5 'entries' table exists and nothing has been migrated yet, try to migrate.
+        pre_0_1_5 = cur.execute(
+            "SELECT 1 FROM sqlite_master WHERE type='table' AND name='entries';"
+        ).fetchone()
+        pages_empty = cur.execute("SELECT 1 FROM pages LIMIT 1;").fetchone() is None
+
+        if pre_0_1_5 and pages_empty:
+            # Seed pages and versions (all as version 1)
+            cur.execute("INSERT OR IGNORE INTO pages(date) SELECT date FROM entries;")
+            cur.execute(
+                "INSERT INTO versions(date, version_no, content) "
+                "SELECT date, 1, content FROM entries;"
+            )
+            # Point head to v1 for each page
+            cur.execute(
+                """
+                UPDATE pages
+                SET current_version_id = (
+                    SELECT v.id FROM versions v
+                    WHERE v.date = pages.date AND v.version_no = 1
+                );
+                """
+            )
+            cur.execute("DROP TABLE IF EXISTS entries;")
+        self.conn.commit()
+
+    def rekey(self, new_key: str) -> None:
+        """
+        Change the SQLCipher passphrase in-place, then reopen the connection
+        with the new key to verify.
+        """
+        if self.conn is None:
+            raise RuntimeError("Database is not connected")
+        cur = self.conn.cursor()
+        # Change the encryption key of the currently open database
+        cur.execute(f"PRAGMA rekey = '{new_key}';")
+        self.conn.commit()
+
+        # Close and reopen with the new key to verify and restore PRAGMAs
+        self.conn.close()
+        self.conn = None
+        self.cfg.key = new_key
+        if not self.connect():
+            raise sqlite.Error("Re-open failed after rekey")
+
+    def get_entry(self, date_iso: str) -> str:
+        """
+        Get a single entry by its date.
+        """
+        cur = self.conn.cursor()
+        row = cur.execute(
+            """
+            SELECT v.content
+            FROM pages p
+            JOIN versions v ON v.id = p.current_version_id
+            WHERE p.date = ?;
+            """,
+            (date_iso,),
+        ).fetchone()
+        return row[0] if row else ""
+
+    def upsert_entry(self, date_iso: str, content: str) -> None:
+        """
+        Insert or update an entry.
+        """
+        # Make a new version and set it as current
+        self.save_new_version(date_iso, content, note=None, set_current=True)
+
+    def search_entries(self, text: str) -> list[str]:
+        """
+        Search for entries by term. This only works against the latest
+        version of the page.
+        """
+        cur = self.conn.cursor()
+        pattern = f"%{text}%"
+        rows = cur.execute(
+            """
+            SELECT p.date, v.content
+            FROM pages AS p
+            JOIN versions AS v
+              ON v.id = p.current_version_id
+            WHERE TRIM(v.content) <> ''
+              AND v.content LIKE LOWER(?) ESCAPE '\\'
+            ORDER BY p.date DESC;
+            """,
+            (pattern,),
+        ).fetchall()
+        return [(r[0], r[1]) for r in rows]
+
+    def dates_with_content(self) -> list[str]:
+        """
+        Find all entries and return the dates of them.
+        This is used to mark the calendar days in bold if they contain entries.
+        """
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            """
+            SELECT p.date
+            FROM pages p
+            JOIN versions v ON v.id = p.current_version_id
+            WHERE TRIM(v.content) <> ''
+            ORDER BY p.date;
+            """
+        ).fetchall()
+        return [r[0] for r in rows]
+
+    # ------------------------- Versioning logic here ------------------------#
+    def save_new_version(
+        self,
+        date_iso: str,
+        content: str,
+        note: str | None = None,
+        set_current: bool = True,
+    ) -> tuple[int, int]:
+        """
+        Append a new version for this date. Returns (version_id, version_no).
+        If set_current=True, flips the page head to this new version.
+        """
+        if self.conn is None:
+            raise RuntimeError("Database is not connected")
+        with self.conn:  # transaction
+            cur = self.conn.cursor()
+            # Ensure page row exists
+            cur.execute("INSERT OR IGNORE INTO pages(date) VALUES (?);", (date_iso,))
+            # Next version number
+            row = cur.execute(
+                "SELECT COALESCE(MAX(version_no), 0) AS maxv FROM versions WHERE date=?;",
+                (date_iso,),
+            ).fetchone()
+            next_ver = int(row["maxv"]) + 1
+            # Insert the version
+            cur.execute(
+                "INSERT INTO versions(date, version_no, content, note) "
+                "VALUES (?,?,?,?);",
+                (date_iso, next_ver, content, note),
+            )
+            ver_id = cur.lastrowid
+            if set_current:
+                cur.execute(
+                    "UPDATE pages SET current_version_id=? WHERE date=?;",
+                    (ver_id, date_iso),
+                )
+            return ver_id, next_ver
+
+    def list_versions(self, date_iso: str) -> list[dict]:
+        """
+        Returns history for a given date (newest first), including which one is current.
+        Each item: {id, version_no, created_at, note, is_current}
+        """
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            """
+            SELECT v.id, v.version_no, v.created_at, v.note,
+                   CASE WHEN v.id = p.current_version_id THEN 1 ELSE 0 END AS is_current
+            FROM versions v
+            LEFT JOIN pages p ON p.date = v.date
+            WHERE v.date = ?
+            ORDER BY v.version_no DESC;
+            """,
+            (date_iso,),
+        ).fetchall()
+        return [dict(r) for r in rows]
+
+    def get_version(
+        self,
+        *,
+        date_iso: str | None = None,
+        version_no: int | None = None,
+        version_id: int | None = None,
+    ) -> dict | None:
+        """
+        Fetch a specific version by (date, version_no) OR by version_id.
+        Returns a dict with keys: id, date, version_no, created_at, note, content.
+        """
+        cur = self.conn.cursor()
+        if version_id is not None:
+            row = cur.execute(
+                "SELECT id, date, version_no, created_at, note, content "
+                "FROM versions WHERE id=?;",
+                (version_id,),
+            ).fetchone()
+        else:
+            if date_iso is None or version_no is None:
+                raise ValueError(
+                    "Provide either version_id OR (date_iso and version_no)"
+                )
+            row = cur.execute(
+                "SELECT id, date, version_no, created_at, note, content "
+                "FROM versions WHERE date=? AND version_no=?;",
+                (date_iso, version_no),
+            ).fetchone()
+        return dict(row) if row else None
+
+    def revert_to_version(
+        self,
+        date_iso: str,
+        *,
+        version_no: int | None = None,
+        version_id: int | None = None,
+    ) -> None:
+        """
+        Point the page head (pages.current_version_id) to an existing version.
+        Fast revert: no content is rewritten.
+        """
+        if self.conn is None:
+            raise RuntimeError("Database is not connected")
+        cur = self.conn.cursor()
+
+        if version_id is None:
+            if version_no is None:
+                raise ValueError("Provide version_no or version_id")
+            row = cur.execute(
+                "SELECT id FROM versions WHERE date=? AND version_no=?;",
+                (date_iso, version_no),
+            ).fetchone()
+            if row is None:
+                raise ValueError("Version not found for this date")
+            version_id = int(row["id"])
+        else:
+            # Ensure that version_id belongs to the given date
+            row = cur.execute(
+                "SELECT date FROM versions WHERE id=?;", (version_id,)
+            ).fetchone()
+            if row is None or row["date"] != date_iso:
+                raise ValueError("version_id does not belong to the given date")
+
+        with self.conn:
+            cur.execute(
+                "UPDATE pages SET current_version_id=? WHERE date=?;",
+                (version_id, date_iso),
+            )
+
+    # ------------------------- Export logic here ------------------------#
+    def get_all_entries(self) -> List[Entry]:
+        """
+        Get all entries. Used for exports.
+        """
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            """
+            SELECT p.date, v.content
+            FROM pages p
+            JOIN versions v ON v.id = p.current_version_id
+            ORDER BY p.date;
+            """
+        ).fetchall()
+        return [(r[0], r[1]) for r in rows]
+
+    def export_json(
+        self, entries: Sequence[Entry], file_path: str, pretty: bool = True
+    ) -> None:
+        """
+        Export to json.
+        """
+        data = [{"date": d, "content": c} for d, c in entries]
+        with open(file_path, "w", encoding="utf-8") as f:
+            if pretty:
+                json.dump(data, f, ensure_ascii=False, indent=2)
+            else:
+                json.dump(data, f, ensure_ascii=False, separators=(",", ":"))
+
+    def export_csv(self, entries: Sequence[Entry], file_path: str) -> None:
+        # utf-8-sig adds a BOM so Excel opens as UTF-8 by default.
+        with open(file_path, "w", encoding="utf-8-sig", newline="") as f:
+            writer = csv.writer(f)
+            writer.writerow(["date", "content"])  # header
+            writer.writerows(entries)
+
+    def export_txt(
+        self,
+        entries: Sequence[Entry],
+        file_path: str,
+        separator: str = "\n\n— — — — —\n\n",
+        strip_html: bool = True,
+    ) -> None:
+        import re, html as _html
+
+        # Precompiled patterns
+        STYLE_SCRIPT_RE = re.compile(r"(?is)<(script|style)[^>]*>.*?</\1>")
+        COMMENT_RE = re.compile(r"<!--.*?-->", re.S)
+        BR_RE = re.compile(r"(?i)<br\\s*/?>")
+        BLOCK_END_RE = re.compile(r"(?i)</(p|div|section|article|li|h[1-6])\\s*>")
+        TAG_RE = re.compile(r"<[^>]+>")
+        WS_ENDS_RE = re.compile(r"[ \\t]+\\n")
+        MULTINEWLINE_RE = re.compile(r"\\n{3,}")
+
+        def _strip(s: str) -> str:
+            # 1) Remove <style> and <script> blocks *including their contents*
+            s = STYLE_SCRIPT_RE.sub("", s)
+            # 2) Remove HTML comments
+            s = COMMENT_RE.sub("", s)
+            # 3) Turn some block-ish boundaries into newlines before removing tags
+            s = BR_RE.sub("\n", s)
+            s = BLOCK_END_RE.sub("\n", s)
+            # 4) Drop remaining tags
+            s = TAG_RE.sub("", s)
+            # 5) Unescape entities (&nbsp; etc.)
+            s = _html.unescape(s)
+            # 6) Tidy whitespace
+            s = WS_ENDS_RE.sub("\n", s)
+            s = MULTINEWLINE_RE.sub("\n\n", s)
+            return s.strip()
+
+        with open(file_path, "w", encoding="utf-8") as f:
+            for i, (d, c) in enumerate(entries):
+                body = _strip(c) if strip_html else c
+                f.write(f"{d}\n{body}\n")
+                if i < len(entries) - 1:
+                    f.write(separator)
+
+    def export_html(
+        self, entries: Sequence[Entry], file_path: str, title: str = "Entries export"
+    ) -> None:
+        parts = [
+            "<!doctype html>",
+            '<html lang="en">',
+            '<meta charset="utf-8">',
+            f"<title>{html.escape(title)}</title>",
+            "<style>body{font:16px/1.5 system-ui,Segoe UI,Roboto,Helvetica,Arial,sans-serif;padding:24px;max-width:900px;margin:auto;}",
+            "article{padding:16px 0;border-bottom:1px solid #ddd;} time{font-weight:600;color:#333;} section{margin-top:8px;}</style>",
+            "<body>",
+            f"<h1>{html.escape(title)}</h1>",
+        ]
+        for d, c in entries:
+            parts.append(
+                f"<article><header><time>{html.escape(d)}</time></header><section>{c}</section></article>"
+            )
+        parts.append("</body></html>")
+
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write("\n".join(parts))
+
+    def export_by_extension(self, file_path: str) -> None:
+        entries = self.get_all_entries()
+        ext = os.path.splitext(file_path)[1].lower()
+
+        if ext == ".json":
+            self.export_json(entries, file_path)
+        elif ext == ".csv":
+            self.export_csv(entries, file_path)
+        elif ext == ".txt":
+            self.export_txt(entries, file_path)
+        elif ext in {".html", ".htm"}:
+            self.export_html(entries, file_path)
+        else:
+            raise ValueError(f"Unsupported extension: {ext}")
+
+    def close(self) -> None:
+        if self.conn is not None:
+            self.conn.close()
+            self.conn = None

bouquin-0.1.5/bouquin/history_dialog.py

@@ -0,0 +1,179 @@
+from __future__ import annotations
+
+import difflib, re, html as _html
+from PySide6.QtCore import Qt, Slot
+from PySide6.QtWidgets import (
+    QDialog,
+    QVBoxLayout,
+    QHBoxLayout,
+    QListWidget,
+    QListWidgetItem,
+    QPushButton,
+    QMessageBox,
+    QTextBrowser,
+    QTabWidget,
+)
+
+
+def _html_to_text(s: str) -> str:
+    """Lightweight HTML→text for diff (keeps paragraphs/line breaks)."""
+    STYLE_SCRIPT_RE = re.compile(r"(?is)<(script|style)[^>]*>.*?</\1>")
+    COMMENT_RE = re.compile(r"<!--.*?-->", re.S)
+    BR_RE = re.compile(r"(?i)<br\s*/?>")
+    BLOCK_END_RE = re.compile(r"(?i)</(p|div|section|article|li|h[1-6])\s*>")
+    TAG_RE = re.compile(r"<[^>]+>")
+    MULTINL_RE = re.compile(r"\n{3,}")
+
+    s = STYLE_SCRIPT_RE.sub("", s)
+    s = COMMENT_RE.sub("", s)
+    s = BR_RE.sub("\n", s)
+    s = BLOCK_END_RE.sub("\n", s)
+    s = TAG_RE.sub("", s)
+    s = _html.unescape(s)
+    s = MULTINL_RE.sub("\n\n", s)
+    return s.strip()
+
+
+def _colored_unified_diff_html(old_html: str, new_html: str) -> str:
+    """Return HTML with colored unified diff (+ green, - red, context gray)."""
+    a = _html_to_text(old_html).splitlines()
+    b = _html_to_text(new_html).splitlines()
+    ud = difflib.unified_diff(a, b, fromfile="current", tofile="selected", lineterm="")
+    lines = []
+    for line in ud:
+        if line.startswith("+") and not line.startswith("+++"):
+            lines.append(
+                f"<span style='color:#116329'>+ {_html.escape(line[1:])}</span>"
+            )
+        elif line.startswith("-") and not line.startswith("---"):
+            lines.append(
+                f"<span style='color:#b31d28'>- {_html.escape(line[1:])}</span>"
+            )
+        elif line.startswith("@@"):
+            lines.append(f"<span style='color:#6f42c1'>{_html.escape(line)}</span>")
+        else:
+            lines.append(f"<span style='color:#586069'>{_html.escape(line)}</span>")
+    css = "pre { font-family: Consolas,Menlo,Monaco,monospace; font-size: 13px; }"
+    return f"<style>{css}</style><pre>{'<br>'.join(lines)}</pre>"
+
+
+class HistoryDialog(QDialog):
+    """Show versions for a date, preview, diff, and allow revert."""
+
+    def __init__(self, db, date_iso: str, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle(f"History — {date_iso}")
+        self._db = db
+        self._date = date_iso
+        self._versions = []  # list[dict] from DB
+        self._current_id = None  # id of current
+
+        root = QVBoxLayout(self)
+
+        # Top: list of versions
+        top = QHBoxLayout()
+        self.list = QListWidget()
+        self.list.setMinimumSize(500, 650)
+        self.list.currentItemChanged.connect(self._on_select)
+        top.addWidget(self.list, 1)
+
+        # Right: tabs (Preview / Diff vs current)
+        self.tabs = QTabWidget()
+        self.preview = QTextBrowser()
+        self.preview.setOpenExternalLinks(True)
+        self.diff = QTextBrowser()
+        self.diff.setOpenExternalLinks(False)
+        self.tabs.addTab(self.preview, "Preview")
+        self.tabs.addTab(self.diff, "Diff vs current")
+        self.tabs.setMinimumSize(500, 650)
+        top.addWidget(self.tabs, 2)
+
+        root.addLayout(top)
+
+        # Buttons
+        row = QHBoxLayout()
+        row.addStretch(1)
+        self.btn_revert = QPushButton("Revert to Selected")
+        self.btn_revert.clicked.connect(self._revert)
+        self.btn_close = QPushButton("Close")
+        self.btn_close.clicked.connect(self.reject)
+        row.addWidget(self.btn_revert)
+        row.addWidget(self.btn_close)
+        root.addLayout(row)
+
+        self._load_versions()
+
+    # --- Data/UX helpers ---
+    def _load_versions(self):
+        self._versions = self._db.list_versions(
+            self._date
+        )  # [{id,version_no,created_at,note,is_current}]
+        self._current_id = next(
+            (v["id"] for v in self._versions if v["is_current"]), None
+        )
+        self.list.clear()
+        for v in self._versions:
+            label = f"v{v['version_no']} — {v['created_at']}"
+            if v.get("note"):
+                label += f"  ·  {v['note']}"
+            if v["is_current"]:
+                label += "  **(current)**"
+            it = QListWidgetItem(label)
+            it.setData(Qt.UserRole, v["id"])
+            self.list.addItem(it)
+        # select the first non-current if available, else current
+        idx = 0
+        for i, v in enumerate(self._versions):
+            if not v["is_current"]:
+                idx = i
+                break
+        if self.list.count():
+            self.list.setCurrentRow(idx)
+
+    @Slot()
+    def _on_select(self):
+        item = self.list.currentItem()
+        if not item:
+            self.preview.clear()
+            self.diff.clear()
+            self.btn_revert.setEnabled(False)
+            return
+        sel_id = item.data(Qt.UserRole)
+        # Preview selected as HTML
+        sel = self._db.get_version(version_id=sel_id)
+        self.preview.setHtml(sel["content"])
+        # Diff vs current (textual diff)
+        cur = self._db.get_version(version_id=self._current_id)
+        self.diff.setHtml(_colored_unified_diff_html(cur["content"], sel["content"]))
+        # Enable revert only if selecting a non-current
+        self.btn_revert.setEnabled(sel_id != self._current_id)
+
+    @Slot()
+    def _revert(self):
+        item = self.list.currentItem()
+        if not item:
+            return
+        sel_id = item.data(Qt.UserRole)
+        if sel_id == self._current_id:
+            return
+        sel = self._db.get_version(version_id=sel_id)
+        vno = sel["version_no"]
+        # Confirm
+        if (
+            QMessageBox.question(
+                self,
+                "Revert",
+                f"Revert {self._date} to version v{vno}?\n\nYou can always change your mind later.",
+                QMessageBox.Yes | QMessageBox.No,
+            )
+            != QMessageBox.Yes
+        ):
+            return
+        # Flip head pointer
+        try:
+            self._db.revert_to_version(self._date, version_id=sel_id)
+        except Exception as e:
+            QMessageBox.critical(self, "Revert failed", str(e))
+            return
+        QMessageBox.information(self, "Reverted", f"{self._date} is now at v{vno}.")
+        self.accept()  # let the caller refresh the editor