@phi-code-admin/camofox-browser 1.0.0 → 1.0.2

package/plugins/vnc/vnc-launcher.js

@@ -1,64 +1,64 @@
-/**
- * VNC launcher -- owns all process spawning and env reads.
- * Isolated from route handlers to keep subprocess management separate.
- */
-
-import { spawn } from './spawn.js';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-/**
- * Resolve VNC configuration from pluginConfig + env var fallbacks.
- * All process.env reads live here -- callers get a plain config object.
- */
-export function resolveVncConfig(pluginConfig = {}) {
-  const enabled = process.env.ENABLE_VNC === '1' || pluginConfig.enabled === true;
-
-  const rawResolution = process.env.VNC_RESOLUTION || pluginConfig.resolution || '1920x1080';
-  const resolution = rawResolution.includes('x', rawResolution.indexOf('x') + 1)
-    ? rawResolution
-    : `${rawResolution}x24`;
-
-  const vncPassword = process.env.VNC_PASSWORD || pluginConfig.password || '';
-  const viewOnly = process.env.VIEW_ONLY === '1' || pluginConfig.viewOnly === true;
-  const vncPort = process.env.VNC_PORT || pluginConfig.vncPort || '5900';
-  const novncPort = process.env.NOVNC_PORT || pluginConfig.novncPort || '6080';
-
-  return { enabled, resolution, vncPassword, viewOnly, vncPort, novncPort };
-}
-
-/**
- * Start the vnc-watcher.sh child process.
- * Returns the spawned ChildProcess.
- */
-export function startWatcher({ resolution, vncPassword, viewOnly, vncPort, novncPort, log, events }) {
-  const watcherPath = path.join(__dirname, 'vnc-watcher.sh');
-  const watcher = spawn('sh', [watcherPath], {
-    env: {
-      ...process.env,
-      VNC_PASSWORD: vncPassword,
-      VNC_RESOLUTION: resolution,
-      VIEW_ONLY: viewOnly ? '1' : '0',
-      VNC_PORT: String(vncPort),
-      NOVNC_PORT: String(novncPort),
-    },
-    stdio: ['ignore', 'inherit', 'inherit'],
-    detached: false,
-  });
-
-  watcher.on('error', (err) => {
-    log('error', 'vnc watcher failed to start', { error: err.message });
-  });
-
-  watcher.on('exit', (code, signal) => {
-    log('warn', 'vnc watcher exited', { code, signal });
-    events.emit('vnc:watcher:stopped', { code, signal });
-  });
-
-  log('info', 'vnc watcher started', { pid: watcher.pid });
-  events.emit('vnc:watcher:started', { pid: watcher.pid });
-
-  return watcher;
-}
+/**
+ * VNC launcher -- owns all process spawning and env reads.
+ * Isolated from route handlers to keep subprocess management separate.
+ */
+
+import { spawn } from './spawn.js';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * Resolve VNC configuration from pluginConfig + env var fallbacks.
+ * All process.env reads live here -- callers get a plain config object.
+ */
+export function resolveVncConfig(pluginConfig = {}) {
+  const enabled = process.env.ENABLE_VNC === '1' || pluginConfig.enabled === true;
+
+  const rawResolution = process.env.VNC_RESOLUTION || pluginConfig.resolution || '1920x1080';
+  const resolution = rawResolution.includes('x', rawResolution.indexOf('x') + 1)
+    ? rawResolution
+    : `${rawResolution}x24`;
+
+  const vncPassword = process.env.VNC_PASSWORD || pluginConfig.password || '';
+  const viewOnly = process.env.VIEW_ONLY === '1' || pluginConfig.viewOnly === true;
+  const vncPort = process.env.VNC_PORT || pluginConfig.vncPort || '5900';
+  const novncPort = process.env.NOVNC_PORT || pluginConfig.novncPort || '6080';
+
+  return { enabled, resolution, vncPassword, viewOnly, vncPort, novncPort };
+}
+
+/**
+ * Start the vnc-watcher.sh child process.
+ * Returns the spawned ChildProcess.
+ */
+export function startWatcher({ resolution, vncPassword, viewOnly, vncPort, novncPort, log, events }) {
+  const watcherPath = path.join(__dirname, 'vnc-watcher.sh');
+  const watcher = spawn('sh', [watcherPath], {
+    env: {
+      ...process.env,
+      VNC_PASSWORD: vncPassword,
+      VNC_RESOLUTION: resolution,
+      VIEW_ONLY: viewOnly ? '1' : '0',
+      VNC_PORT: String(vncPort),
+      NOVNC_PORT: String(novncPort),
+    },
+    stdio: ['ignore', 'inherit', 'inherit'],
+    detached: false,
+  });
+
+  watcher.on('error', (err) => {
+    log('error', 'vnc watcher failed to start', { error: err.message });
+  });
+
+  watcher.on('exit', (code, signal) => {
+    log('warn', 'vnc watcher exited', { code, signal });
+    events.emit('vnc:watcher:stopped', { code, signal });
+  });
+
+  log('info', 'vnc watcher started', { pid: watcher.pid });
+  events.emit('vnc:watcher:started', { pid: watcher.pid });
+
+  return watcher;
+}

package/plugins/vnc/vnc-watcher.sh

@@ -1,82 +1,82 @@
-#!/bin/sh
-# VNC watcher: detects Camoufox's dynamically-assigned Xvfb display and attaches
-# x11vnc + noVNC to it. Handles browser restarts (re-attaches on display change).
-#
-# Called by the VNC plugin via child_process.spawn. Not meant to run standalone.
-#
-# Env vars (set by the plugin):
-#   VNC_PASSWORD    If set, x11vnc requires this password
-#   VIEW_ONLY       "1" for view-only mode
-#   VNC_PORT        VNC port (default: 5900)
-#   NOVNC_PORT      noVNC websocket port (default: 6080)
-
-set -e
-
-VNC_PORT="${VNC_PORT:-5900}"
-NOVNC_PORT="${NOVNC_PORT:-6080}"
-VNC_RESOLUTION="${VNC_RESOLUTION:-1920x1080x24}"
-
-log() { printf '[vnc-watcher] %s\n' "$*" >&2; }
-
-CURRENT_DISPLAY=""
-X11VNC_PID=""
-
-# Prepare password file if requested
-PASSFILE=""
-if [ -n "${VNC_PASSWORD:-}" ]; then
-  mkdir -p /tmp/.vnc
-  x11vnc -storepasswd "$VNC_PASSWORD" /tmp/.vnc/passwd >/dev/null 2>&1
-  PASSFILE="/tmp/.vnc/passwd"
-  log "x11vnc: password protected"
-else
-  log "x11vnc: NO password (bind $NOVNC_PORT to 127.0.0.1 on host + SSH tunnel)"
-fi
-
-# Start noVNC (websockify) -- proxies to x11vnc regardless of whether it's up yet
-NOVNC_DIR="/usr/share/novnc"
-if [ ! -d "$NOVNC_DIR" ]; then
-  log "ERROR: $NOVNC_DIR not found; noVNC cannot start"
-  exit 1
-fi
-VNC_BIND="${VNC_BIND:-127.0.0.1}"
-log "Starting noVNC (websockify) on $VNC_BIND:$NOVNC_PORT -> 127.0.0.1:$VNC_PORT"
-websockify --web "$NOVNC_DIR" "$VNC_BIND:$NOVNC_PORT" "127.0.0.1:$VNC_PORT" >/var/log/novnc.log 2>&1 &
-
-log "VNC watcher started -- will attach x11vnc when Camoufox's Xvfb appears"
-
-while true; do
-  # Find Xvfb with our patched resolution
-  FOUND=$(ps -eo args= 2>/dev/null | awk -v res="$VNC_RESOLUTION" '
-    /\/Xvfb :[0-9]+/ && index($0, res) {
-      for (i=1;i<=NF;i++) if ($i ~ /^:[0-9]+$/) { print $i; exit }
-    }
-  ' | head -1)
-
-  if [ -n "$FOUND" ] && [ "$FOUND" != "$CURRENT_DISPLAY" ]; then
-    # New or changed display -- (re)attach x11vnc
-    if [ -n "$X11VNC_PID" ] && kill -0 "$X11VNC_PID" 2>/dev/null; then
-      log "Camoufox display changed ($CURRENT_DISPLAY -> $FOUND), restarting x11vnc"
-      kill "$X11VNC_PID" 2>/dev/null || true
-      sleep 0.5
-    fi
-
-    CURRENT_DISPLAY="$FOUND"
-    log "Attaching x11vnc to DISPLAY=$CURRENT_DISPLAY"
-
-    X11VNC_ARGS="-display $CURRENT_DISPLAY -forever -shared -rfbport $VNC_PORT -noxdamage -quiet -bg -o /var/log/x11vnc.log"
-    [ "${VIEW_ONLY:-0}" = "1" ] && X11VNC_ARGS="$X11VNC_ARGS -viewonly"
-    if [ -n "$PASSFILE" ]; then
-      X11VNC_ARGS="$X11VNC_ARGS -rfbauth $PASSFILE"
-    else
-      X11VNC_ARGS="$X11VNC_ARGS -nopw"
-    fi
-
-    # shellcheck disable=SC2086
-    x11vnc $X11VNC_ARGS
-    sleep 1
-    X11VNC_PID=$(pgrep -f "x11vnc.*-display $CURRENT_DISPLAY" | head -1)
-    log "x11vnc running (pid=$X11VNC_PID) on DISPLAY=$CURRENT_DISPLAY"
-  fi
-
-  sleep 2
-done
+#!/bin/sh
+# VNC watcher: detects Camoufox's dynamically-assigned Xvfb display and attaches
+# x11vnc + noVNC to it. Handles browser restarts (re-attaches on display change).
+#
+# Called by the VNC plugin via child_process.spawn. Not meant to run standalone.
+#
+# Env vars (set by the plugin):
+#   VNC_PASSWORD    If set, x11vnc requires this password
+#   VIEW_ONLY       "1" for view-only mode
+#   VNC_PORT        VNC port (default: 5900)
+#   NOVNC_PORT      noVNC websocket port (default: 6080)
+
+set -e
+
+VNC_PORT="${VNC_PORT:-5900}"
+NOVNC_PORT="${NOVNC_PORT:-6080}"
+VNC_RESOLUTION="${VNC_RESOLUTION:-1920x1080x24}"
+
+log() { printf '[vnc-watcher] %s\n' "$*" >&2; }
+
+CURRENT_DISPLAY=""
+X11VNC_PID=""
+
+# Prepare password file if requested
+PASSFILE=""
+if [ -n "${VNC_PASSWORD:-}" ]; then
+  mkdir -p /tmp/.vnc
+  x11vnc -storepasswd "$VNC_PASSWORD" /tmp/.vnc/passwd >/dev/null 2>&1
+  PASSFILE="/tmp/.vnc/passwd"
+  log "x11vnc: password protected"
+else
+  log "x11vnc: NO password (bind $NOVNC_PORT to 127.0.0.1 on host + SSH tunnel)"
+fi
+
+# Start noVNC (websockify) -- proxies to x11vnc regardless of whether it's up yet
+NOVNC_DIR="/usr/share/novnc"
+if [ ! -d "$NOVNC_DIR" ]; then
+  log "ERROR: $NOVNC_DIR not found; noVNC cannot start"
+  exit 1
+fi
+VNC_BIND="${VNC_BIND:-127.0.0.1}"
+log "Starting noVNC (websockify) on $VNC_BIND:$NOVNC_PORT -> 127.0.0.1:$VNC_PORT"
+websockify --web "$NOVNC_DIR" "$VNC_BIND:$NOVNC_PORT" "127.0.0.1:$VNC_PORT" >/var/log/novnc.log 2>&1 &
+
+log "VNC watcher started -- will attach x11vnc when Camoufox's Xvfb appears"
+
+while true; do
+  # Find Xvfb with our patched resolution
+  FOUND=$(ps -eo args= 2>/dev/null | awk -v res="$VNC_RESOLUTION" '
+    /\/Xvfb :[0-9]+/ && index($0, res) {
+      for (i=1;i<=NF;i++) if ($i ~ /^:[0-9]+$/) { print $i; exit }
+    }
+  ' | head -1)
+
+  if [ -n "$FOUND" ] && [ "$FOUND" != "$CURRENT_DISPLAY" ]; then
+    # New or changed display -- (re)attach x11vnc
+    if [ -n "$X11VNC_PID" ] && kill -0 "$X11VNC_PID" 2>/dev/null; then
+      log "Camoufox display changed ($CURRENT_DISPLAY -> $FOUND), restarting x11vnc"
+      kill "$X11VNC_PID" 2>/dev/null || true
+      sleep 0.5
+    fi
+
+    CURRENT_DISPLAY="$FOUND"
+    log "Attaching x11vnc to DISPLAY=$CURRENT_DISPLAY"
+
+    X11VNC_ARGS="-display $CURRENT_DISPLAY -forever -shared -rfbport $VNC_PORT -noxdamage -quiet -bg -o /var/log/x11vnc.log"
+    [ "${VIEW_ONLY:-0}" = "1" ] && X11VNC_ARGS="$X11VNC_ARGS -viewonly"
+    if [ -n "$PASSFILE" ]; then
+      X11VNC_ARGS="$X11VNC_ARGS -rfbauth $PASSFILE"
+    else
+      X11VNC_ARGS="$X11VNC_ARGS -nopw"
+    fi
+
+    # shellcheck disable=SC2086
+    x11vnc $X11VNC_ARGS
+    sleep 1
+    X11VNC_PID=$(pgrep -f "x11vnc.*-display $CURRENT_DISPLAY" | head -1)
+    log "x11vnc running (pid=$X11VNC_PID) on DISPLAY=$CURRENT_DISPLAY"
+  fi
+
+  sleep 2
+done

package/plugins/youtube/AGENTS.md

@@ -1,25 +1,25 @@
-# YouTube Plugin — Agent Guide
-
-Extracts video transcripts via yt-dlp (preferred) with Playwright browser fallback.
-
-## Endpoint
-
-`POST /youtube/transcript` — unauthenticated by default (set `"auth": true` in plugin config to require auth).
-
-## Key Files
-
-- `index.js` — route handler + browser fallback logic
-- `youtube.js` — yt-dlp process management + transcript parsing (`child_process` isolated here)
-- `youtube.test.js` — parser unit tests
-- `apt.txt` — system deps (python3-minimal for yt-dlp)
-- `post-install.sh` — downloads yt-dlp binary
-
-## Code Separation
-
-`child_process` is in `youtube.js`, route handlers are in `index.js` — separate files per project conventions.
-
-## Maintainers
-
-- [@pradeepe](https://github.com/pradeepe) — extracted from core into plugin system
-
-For PRs touching this plugin, tag the maintainers above for review.
+# YouTube Plugin — Agent Guide
+
+Extracts video transcripts via yt-dlp (preferred) with Playwright browser fallback.
+
+## Endpoint
+
+`POST /youtube/transcript` — unauthenticated by default (set `"auth": true` in plugin config to require auth).
+
+## Key Files
+
+- `index.js` — route handler + browser fallback logic
+- `youtube.js` — yt-dlp process management + transcript parsing (`child_process` isolated here)
+- `youtube.test.js` — parser unit tests
+- `apt.txt` — system deps (python3-minimal for yt-dlp)
+- `post-install.sh` — downloads yt-dlp binary
+
+## Code Separation
+
+`child_process` is in `youtube.js`, route handlers are in `index.js` — separate files per project conventions.
+
+## Maintainers
+
+- [@pradeepe](https://github.com/pradeepe) — extracted from core into plugin system
+
+For PRs touching this plugin, tag the maintainers above for review.

package/plugins/youtube/apt.txt

@@ -1 +1 @@
-python3-minimal
+python3-minimal