@commte/mdbrowse 0.2.1 → 0.3.1

package/README.ja.md

@@ -59,12 +59,22 @@ mdb
 
 プレビュー用のタブが開き、小さな背景プロセスが動きだす。以後どの Markdown を保存しても、どのプロジェクトのものでも、そのタブに出る。止めるときは `mdb --stop`、再開はまた `mdb`
 
+ログアウトや再起動で消える。macOS なら、勝手に戻ってくるようにもできる
+
+```sh
+mdb --install-agent
+```
+
+`~/Library/LaunchAgents` に LaunchAgent を1枚置くだけで、ログインした時点から追従が動いている。外すときは `mdb --uninstall-agent`。macOS のログイン項目には「開発元を識別できない項目」として出る。スクリプトに署名していないため
+
 ## 使い方
 
 ```sh
 mdb              # タブを開いて、以後ずっと追従させる
 mdb --stop       # 背景の追従を止める
 mdb --status     # いま何が出ているかを表示する
+mdb --install-agent    # ログイン時に自動で始めるようにする（macOS）
+mdb --uninstall-agent  # それを外す
 mdb file.md      # そのファイルを1回だけ変換する
 mdb -w file.md   # 1つのファイルだけを前面で監視する（Ctrl-C で終了）
 mdb --path       # 出力先の HTML のパスを表示する

package/README.md

@@ -59,12 +59,22 @@ mdb
 
 That opens the preview tab and starts a small background process. Save any Markdown file from here on and it shows up in that tab, whichever project it lives in. `mdb --stop` ends it; `mdb` starts it again.
 
+The process is gone after a logout or a reboot. On macOS you can have it come back on its own:
+
+```sh
+mdb --install-agent
+```
+
+That writes a LaunchAgent under `~/Library/LaunchAgents` and nothing else, so the sync is running from the moment you log in. `mdb --uninstall-agent` removes it. macOS lists it under Login Items as an unidentified developer — the script is not code-signed.
+
 ## Usage
 
 ```sh
 mdb              # open the tab and keep it in sync
 mdb --stop       # stop the background sync
 mdb --status     # show what is being previewed
+mdb --install-agent    # start the sync at every login (macOS)
+mdb --uninstall-agent  # remove it
 mdb file.md      # render one file, once
 mdb -w file.md   # follow one file in the foreground (Ctrl-C to stop)
 mdb --path       # print the output HTML path

package/assets/head.html

@@ -184,10 +184,17 @@
     var THEMES = ['light', 'dark'];
     var WIDTHS = [800, 680, 960, 1200];
     var printing = false;
-    addEventListener('beforeprint', function () { printing = true; });
-    addEventListener('afterprint', function () { printing = false; });
-    // 印刷がキャンセルされて afterprint が来ない場合に、止まったままにならないようにする
-    addEventListener('visibilitychange', function () { if (!document.hidden) printing = false; });
+    var printTimer = null;
+    addEventListener('beforeprint', function () {
+      printing = true;
+      // afterprint が来ないブラウザや、途中で閉じられた場合に止まったままにならないようにする
+      clearTimeout(printTimer);
+      printTimer = setTimeout(function () { printing = false; }, 60000);
+    });
+    addEventListener('afterprint', function () {
+      printing = false;
+      clearTimeout(printTimer);
+    });
 
     function save() { try { localStorage.setItem('mdbrowse', JSON.stringify(s)); } catch (e) {} }
     function fontSize() { return s.fontSize || parseInt(getComputedStyle(r).getPropertyValue('--font-size')) || 16; }
@@ -257,7 +264,8 @@
       }
       heads = heads.filter(function (h) { return lv(h) <= top + 1; });
     }
-    if (heads.length >= 3) {
+    try {
+    if (heads.length >= 3 && typeof IntersectionObserver === 'function') {
       var topLevel = Math.min.apply(null, heads.map(function (h) { return +h.tagName.slice(1); }));
       var toc = document.createElement('nav');
       toc.id = 'mdtoc';
@@ -294,6 +302,7 @@
       }, { rootMargin: '0px 0px -75% 0px' });
       heads.forEach(function (h) { io.observe(h); });
     }
+    } catch (e) { /* 目次が組めなくても、更新の監視は動かす */ }
 
     // スクロール位置はブラウザ標準の復元に任せる（手で保存するとカクつく）
     var lastScroll = 0;
@@ -318,6 +327,7 @@
     var stampUrl = location.pathname.replace(/\.html$/, '-stamp.js');
     var known = null;
     function checkStamp() {
+      if (printing) return;
       var el = document.createElement('script');
       el.src = stampUrl + '?t=' + Date.now();
       el.onload = function () {
@@ -335,11 +345,12 @@
     addEventListener('focus', function () { checkStamp(); });
     // バーを操作している間は再読み込みを止める。状態を持たずにその場で見る
     // （持つと、バーの上にポインタを置いたままウィンドウを離れたときに止まったままになる）
-    var hoverable = !matchMedia || matchMedia('(hover: hover)').matches;
+    var hoverable = typeof window.matchMedia !== 'function'
+      || window.matchMedia('(hover: hover)').matches;
     setInterval(function () {
       if (printing || (hoverable && bar.matches(':hover'))) return;
       if (Date.now() - lastScroll < 900) return;
       checkStamp();
-    }, 1000);
+    }, 250);
   });
 </script>

package/bin/mdbrowse

@@ -3,9 +3,14 @@
 # browser tab can stay open and just swap its contents.
 set -euo pipefail
 
-VERSION="0.2.1"
+VERSION="0.3.1"
 PROG="$(basename "$0")"
 OUT="${MDBROWSE_OUT:-/tmp/mdbrowse.html}"
+case "$OUT" in
+  *.html) ;;
+  *) echo "$(basename "$0"): MDBROWSE_OUT must end with .html (got: $OUT)" >&2; exit 2 ;;
+esac
+STAMP="${OUT%.html}-stamp.js"
 CONFIG_DIR="${XDG_CONFIG_HOME:-$HOME/.config}/mdbrowse"
 
 # スタイルシートの探索順
@@ -40,6 +45,8 @@ Usage:
   mdb <file.md>          render that file once
   mdb --stop             stop the background sync
   mdb --status           show what is being previewed
+  mdb --install-agent    start the sync automatically at every login (macOS)
+  mdb --uninstall-agent  remove it
   mdb -w <file|dir>      watch in the foreground instead (Ctrl-C to stop)
   mdb --eject            copy the bundled stylesheet into your config directory
   mdb --path             print the output HTML path
@@ -47,7 +54,12 @@ Usage:
 
 With no arguments, mdb opens the preview tab and starts a small background
 process. From then on, whatever Markdown file you save — in any project, from
-any editor — shows up in that tab. Nothing else to set up. `mdb --stop` ends it.
+any editor — shows up in that tab. Nothing else to set up. `mdb --stop` ends it,
+and it is gone after a logout or a reboot.
+
+`mdb --install-agent` makes it start on its own at every login, so you never
+have to think about starting or stopping it. It writes a LaunchAgent under
+~/Library/LaunchAgents and nothing else; `mdb --uninstall-agent` removes it.
 
 Finding the file you just saved uses Spotlight (mdfind). Files under hidden
 directories, node_modules and ~/Library are ignored. Without Spotlight, mdb
@@ -72,14 +84,28 @@ open_url() {
   fi
 }
 
+# まだ何も変換していないときの仮ページ。スタイルシートごと入れるので、
+# 更新の監視も目次もバーも、ふつうのページと同じように動く
+placeholder() {
+  printf '%s\n' '<!doctype html><meta charset="utf-8"><title>mdbrowse</title>'
+  [ -f "$HEAD" ] && cat "$HEAD"
+  printf '%s\n' '<p>No preview yet. Save a Markdown file.'
+}
+
 open_tab() {
-  [ -f "$OUT" ] || printf '<!doctype html><meta charset="utf-8"><p>No preview yet.' > "$OUT"
-  [ -f "${OUT%.html}-stamp.js" ] || printf 'window.__mdbrowseStamp="0";\n' > "${OUT%.html}-stamp.js"
+  [ -f "$OUT" ] || placeholder > "$OUT"
+  [ -f "$STAMP" ] || printf 'window.__mdbrowseStamp="0";\n' > "$STAMP"
   open_url
 }
 
-PIDFILE="${OUT%.html}-sync.pid"
-LOGFILE="${OUT%.html}-sync.log"
+# PID・ログ・ロックは自分だけが書ける場所に置く。共有の /tmp に固定名で置くと、
+# 先に symlink を作られたときに書き込み先を差し替えられる
+RUNTIME_DIR="${TMPDIR:-/tmp}/mdbrowse-$(id -u)"
+( umask 077; mkdir -p "$RUNTIME_DIR" ) 2>/dev/null || true
+LOGFILE="$RUNTIME_DIR/sync.log"
+LOCKDIR="$RUNTIME_DIR/sync.lock"
+PIDFILE="$LOCKDIR/pid"
+LEGACY_PIDFILE="${OUT%.html}-sync.pid"
 
 running_pid() {
   [ -f "$PIDFILE" ] || return 1
@@ -92,15 +118,27 @@ running_pid() {
 }
 
 stop_sync() {
-  local pid
+  local pid stopped=0 i=0
   if pid="$(running_pid)"; then
     kill "$pid" 2>/dev/null || true
-    rm -f "$PIDFILE"
-    echo "$PROG: stopped"
-  else
-    rm -f "$PIDFILE"
-    echo "$PROG: not running"
+    while [ $i -lt 30 ]; do
+      kill -0 "$pid" 2>/dev/null || break
+      i=$(( i + 1 ))
+      sleep 0.1
+    done
+    stopped=1
+  fi
+  # 0.2.x が置いた古い場所のものも拾う
+  if [ -f "$LEGACY_PIDFILE" ]; then
+    local old; old="$(cat "$LEGACY_PIDFILE" 2>/dev/null || true)"
+    if [ -n "$old" ] && kill -0 "$old" 2>/dev/null; then
+      kill "$old" 2>/dev/null || true
+      stopped=1
+    fi
+    rm -f "$LEGACY_PIDFILE"
   fi
+  rm -rf "$LOCKDIR"
+  if [ "$stopped" -eq 1 ]; then echo "$PROG: stopped"; else echo "$PROG: not running"; fi
 }
 
 start_sync() {
@@ -124,8 +162,74 @@ start_sync() {
   fi
 }
 
+AGENT_LABEL="com.commte.mdbrowse"
+AGENT_PLIST="$HOME/Library/LaunchAgents/$AGENT_LABEL.plist"
+
+agent_installed() { [ -f "$AGENT_PLIST" ]; }
+
+install_agent() {
+  if [ "$(uname -s)" != "Darwin" ]; then
+    echo "$PROG: --install-agent is macOS only" >&2
+    return 1
+  fi
+  local self; self="$(resolve_dir "$0")/$(basename "$(readlink "$0" 2>/dev/null || echo "$0")")"
+  [ -x "$self" ] || self="$0"
+
+  # launchd の PATH は最小限なので、pandoc と node の場所を書き込んでおく
+  local paths="/usr/bin:/bin:/usr/sbin:/sbin"
+  local d
+  for d in "$(command -v pandoc)" "$(command -v node)" "$(command -v mdfind)"; do
+    [ -n "$d" ] && paths="$(dirname "$d"):$paths"
+  done
+
+  mkdir -p "$HOME/Library/LaunchAgents"
+  {
+    printf '%s\n' '<?xml version="1.0" encoding="UTF-8"?>'
+    printf '%s\n' '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">'
+    printf '%s\n' '<plist version="1.0">'
+    printf '%s\n' '<dict>'
+    printf '  <key>Label</key><string>%s</string>\n' "$AGENT_LABEL"
+    printf '%s\n' '  <key>ProgramArguments</key>'
+    printf '%s\n' '  <array>'
+    printf '    <string>%s</string>\n' "$self"
+    printf '%s\n' '    <string>--sync-daemon</string>'
+    printf '    <string>%s</string>\n' "$HOME"
+    printf '%s\n' '  </array>'
+    printf '%s\n' '  <key>RunAtLoad</key><true/>'
+    printf '%s\n' '  <key>KeepAlive</key><false/>'
+    printf '  <key>StandardErrorPath</key><string>%s</string>\n' "$LOGFILE"
+    printf '%s\n' '  <key>EnvironmentVariables</key>'
+    printf '%s\n' '  <dict>'
+    printf '    <key>PATH</key><string>%s</string>\n' "$paths"
+    [ -n "${MDBROWSE_OUT:-}" ] && printf '    <key>MDBROWSE_OUT</key><string>%s</string>\n' "$MDBROWSE_OUT"
+    [ -n "${MDBROWSE_HEAD:-}" ] && printf '    <key>MDBROWSE_HEAD</key><string>%s</string>\n' "$MDBROWSE_HEAD"
+    printf '%s\n' '  </dict>'
+    printf '%s\n' '</dict>'
+    printf '%s\n' '</plist>'
+  } > "$AGENT_PLIST"
+
+  launchctl bootout "gui/$(id -u)/$AGENT_LABEL" 2>/dev/null || true
+  if ! launchctl bootstrap "gui/$(id -u)" "$AGENT_PLIST" 2>/dev/null; then
+    launchctl load -w "$AGENT_PLIST" 2>/dev/null || true
+  fi
+  echo "$PROG: starts at login now ($AGENT_PLIST)"
+}
+
+uninstall_agent() {
+  launchctl bootout "gui/$(id -u)/$AGENT_LABEL" 2>/dev/null \
+    || launchctl unload -w "$AGENT_PLIST" 2>/dev/null || true
+  if [ -f "$AGENT_PLIST" ]; then
+    rm -f "$AGENT_PLIST"
+    echo "$PROG: will not start at login any more"
+  else
+    echo "$PROG: not installed"
+  fi
+}
+
 case "${1:-}" in
   -h|--help) usage; exit 0 ;;
+  --install-agent) install_agent; exit $? ;;
+  --uninstall-agent) uninstall_agent; exit 0 ;;
   -v|--version) echo "mdbrowse $VERSION"; exit 0 ;;
   --path) echo "$OUT"; exit 0 ;;
   --stop) stop_sync; exit 0 ;;
@@ -135,6 +239,11 @@ case "${1:-}" in
     else
       echo "$PROG: not running"
     fi
+    if agent_installed; then
+      echo "starts at login: yes ($AGENT_PLIST)"
+    else
+      echo "starts at login: no (mdb --install-agent to change that)"
+    fi
     [ -f "$OUT" ] && echo "showing: $(grep -o '<title>[^<]*' "$OUT" 2>/dev/null | sed 's/<title>//')"
     exit 0 ;;
   --eject)
@@ -228,13 +337,18 @@ else
 fi
 
 render() {
-  # 途中経過をタブに見せないため、別名で組み立ててから置き換える
-  local tmp="$OUT.part"
+  # 途中経過をタブに見せないため、別名で組み立ててから置き換える。
+  # 名前は毎回変える。固定名だと、同時に走ったときに互いの中間結果を踏む
+  local tmp
+  tmp="$(mktemp "$OUT.part.XXXXXX")" || return 1
+
   # 出力先が .part なので、拡張子から形式を推測させず明示する
   local args=(--standalone --from gfm --to html5 "${hl[@]}" --variable "pagetitle=$(basename "$src")" --output "$tmp")
   [ -f "$HEAD" ] && args+=(--include-in-header "$HEAD")
 
-  pandoc "$src" "${args[@]}"
+  # 途中で失敗したら、そこで止めて古い表示を残す。
+  # 関数を `render || ...` の形で呼ぶと関数の中では set -e が効かないので、各段で判定する
+  pandoc "$src" "${args[@]}" || { rm -f "$tmp"; return 1; }
 
   # コードブロックを Shiki で色付けし直す。失敗しても変換自体は成立させる
   if [ "$use_shiki" -eq 1 ]; then
@@ -243,14 +357,15 @@ render() {
 
   # frontmatter の title を pandoc が拾うと本文の先頭に見出しが増えるので落とす。
   # ブラウザのタブ名には pagetitle を使っている
-  perl -0pi -e 's#<header id="title-block-header">.*?</header>\n?##s' "$tmp"
+  perl -0pi -e 's#<header id="title-block-header">.*?</header>\n?##s' "$tmp" \
+    || { rm -f "$tmp"; return 1; }
 
   # 出力先が /tmp なので、元ファイルからの相対パス（画像・ローカルリンク）が
   # そのままでは解決できない。ソースのあるディレクトリ基準の file:// に書き換える。
   # 書き換えるのはタグの属性だけ。本文中の src="..." のようなインラインコードは触らない。
   # スキーム付き（http(s) data: mailto: など）／絶対パス／ページ内アンカーはそのまま残す
   local src_dir
-  src_dir="$(cd "$(dirname "$src")" && pwd)" || return 1
+  src_dir="$(cd "$(dirname "$src")" && pwd)" || { rm -f "$tmp"; return 1; }
   MDBROWSE_SRC_DIR="$src_dir" perl -0pi -e '
   BEGIN {
     $base = $ENV{MDBROWSE_SRC_DIR};
@@ -262,21 +377,26 @@ render() {
     $base =~ s/"/%22/g;
     $base =~ s/ /%20/g;
   }
-  s{(<(?:img|a|source|video|audio|embed|object|track)\b)([^>]*?)(/?>)}{
+  # 属性値の中の > でタグを切らないよう、引用符の中はまとめて食う
+  s{(<(?:img|a|source|video|audio|embed|object|track)\b)((?:[^>"\x27]|"[^"]*"|\x27[^\x27]*\x27)*)(>)}{
     my ($tag, $attrs, $close) = ($1, $2, $3);
     $attrs =~ s{((?:src|href|poster|data)=")(?![a-zA-Z][a-zA-Z0-9+.\-]*:|//|/|\#|")([^"]*)"}
                {$1 . "file://" . $base . "/" . $2 . "\""}ge;
+    $attrs =~ s{((?:src|href|poster|data)=\x27)(?![a-zA-Z][a-zA-Z0-9+.\-]*:|//|/|\#|\x27)([^\x27]*)\x27}
+               {$1 . "file://" . $base . "/" . $2 . "\x27"}ge;
     $tag . $attrs . $close;
   }gse;
-' "$tmp"
+' "$tmp" || { rm -f "$tmp"; return 1; }
 
-  mv -f "$tmp" "$OUT"
+  mv -f "$tmp" "$OUT" || { rm -f "$tmp"; return 1; }
 
   # 更新の目印。ブラウザはこれを見て、中身が変わったときだけ読み直す。
   # 本体の差し替えが済んでから書く
-  local stamp="${OUT%.html}-stamp.js"
-  printf 'window.__mdbrowseStamp="%s";\n' "$(date +%s)-$RANDOM" > "$stamp.part"
-  mv -f "$stamp.part" "$stamp"
+  local stamp_tmp
+  stamp_tmp="$(mktemp "$STAMP.part.XXXXXX")" || return 1
+  printf 'window.__mdbrowseStamp="%s";\n' "$(date +%s)-$RANDOM" > "$stamp_tmp" \
+    || { rm -f "$stamp_tmp"; return 1; }
+  mv -f "$stamp_tmp" "$STAMP" || { rm -f "$stamp_tmp"; return 1; }
 }
 
 # ファイルの更新時刻とサイズ。同じ秒内の2回目の保存も拾えるようにサイズも見る
@@ -311,10 +431,23 @@ newest_global() {
 
 # 背景で動く本体。保存された Markdown を追いかけて変換し続ける
 if [ "$daemon" -eq 1 ]; then
-  # 先に別のものが動いていたら黙って降りる（同時に叩かれた場合の取り合いを避ける）
-  if running_pid >/dev/null; then exit 0; fi
+  # 確認と取得を1操作にする。mkdir は原子的なので、同時に叩かれても1つしか通らない
+  if ! mkdir "$LOCKDIR" 2>/dev/null; then
+    # 取れなかった側は、持ち主が名乗るのを少し待つ。
+    # すぐ「持ち主なし」と判断すると、書き込み前の相手からロックを奪ってしまう
+    i=0
+    while [ $i -lt 30 ]; do
+      running_pid >/dev/null && exit 0
+      i=$(( i + 1 ))
+      sleep 0.1
+    done
+    # 3秒待っても名乗らないなら、置き去りのロックとして回収する
+    rm -rf "$LOCKDIR"
+    mkdir "$LOCKDIR" 2>/dev/null || exit 0
+  fi
   echo $$ > "$PIDFILE"
-  trap 'rm -f "$PIDFILE"' EXIT
+  # 自分が持っているときだけ外す。あとから起きたものの分を消さないため
+  trap 'if [ "$(cat "$PIDFILE" 2>/dev/null)" = "$$" ]; then rm -rf "$LOCKDIR"; fi' EXIT
   use_spotlight=0
   command -v mdfind >/dev/null 2>&1 && use_spotlight=1
   if [ "$use_spotlight" -eq 0 ]; then root="$sync_cwd"; fi
@@ -326,16 +459,18 @@ if [ "$daemon" -eq 1 ]; then
   # 変換の失敗は画面に出ないので、ログに残す
   log() { printf '%s %s\n' "$(date '+%Y-%m-%d %H:%M:%S')" "$1" >> "$LOGFILE"; }
 
-  # Spotlight を使えない場合は木を歩く。大きな木では間隔を伸ばす
-  scan_gap=2
+  # 表示中のファイルは 0.25 秒ごとに見る。1周 = 0.25 秒
+  TICK=0.25
+  # Spotlight への問い合わせは 2 秒ごと（8周に1回）
+  scan_gap=8
   if [ "$use_spotlight" -eq 0 ]; then
     t0="$(perl -MTime::HiRes=time -e 'printf "%d", time*1000')"
     newest_md "$root" >/dev/null
     t1="$(perl -MTime::HiRes=time -e 'printf "%d", time*1000')"
-    scan_gap=$(( ( (t1 - t0) * 5 + 999) / 1000 ))
-    [ "$scan_gap" -lt 2 ] && scan_gap=2
-    [ "$scan_gap" -gt 10 ] && scan_gap=10
-    log "watching $root every ${scan_gap}s (no Spotlight)"
+    scan_gap=$(( ( (t1 - t0) * 5 + 249) / 250 ))
+    [ "$scan_gap" -lt 8 ] && scan_gap=8
+    [ "$scan_gap" -gt 40 ] && scan_gap=40
+    log "watching $root every $(( scan_gap / 4 ))s (no Spotlight)"
   fi
 
   src="$(pick)"
@@ -343,7 +478,7 @@ if [ "$daemon" -eq 1 ]; then
   last="$src $(fingerprint "$src") $(fingerprint "$HEAD")"
   # 開いているファイルの保存は毎秒見る。別ファイルへの切り替えの検出は2秒ごと
   tick=0
-  while sleep 1; do
+  while sleep "$TICK"; do
     tick=$(( tick + 1 ))
     if [ $(( tick % scan_gap )) -eq 0 ]; then
       cand="$(pick)"
@@ -375,7 +510,7 @@ render
 if [ "$watch" -eq 1 ]; then
   # ディレクトリを見る場合、木が大きいと走査が重い。1回の走査時間から
   # 待ち時間を決めて、CPU を食い潰さないようにする
-  interval=1
+  interval=0.25
   if [ -n "$root" ]; then
     t0="$(perl -MTime::HiRes=time -e 'printf "%d", time*1000')"
     newest_md "$root" >/dev/null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commte/mdbrowse",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Preview the Markdown file you are editing in a real browser, with your own CSS, from any editor that can run a shell command. No server, no port.",
   "bin": {
     "mdbrowse": "bin/mdbrowse",