openclaw-xiaoyou 1.0.0

package/docs/install-xiaoyou.sh

@@ -0,0 +1,427 @@
+#!/usr/bin/env bash
+# install-xiayou.sh — OpenClaw xiaoyou channel 一键安装/升级/卸载脚本
+#
+# 用法:
+#   install-xiayou.sh --ws-url <url> --token <token>
+#   install-xiayou.sh --version <ver> --ws-url <url> --token <token>
+#   install-xiayou.sh uninstall
+#   install-xiayou.sh --check-only
+
+if [ -z "${BASH_VERSION:-}" ] || shopt -oq posix 2>/dev/null; then
+  if command -v bash >/dev/null 2>&1; then
+    exec bash "$0" "$@"
+  fi
+  printf '[xiaoyou-install][error] install-xiayou.sh 需要 bash\n' >&2
+  exit 1
+fi
+
+set -Eeuo pipefail
+
+SCRIPT_NAME="$(basename "$0")"
+WS_URL=""
+TOKEN=""
+CHECK_ONLY=0
+ACTION="install"
+REQUESTED_VERSION=""
+PLUGIN_NAME="openclaw-xiaoyou"
+CHANNEL_KEY="xiaoyou"
+STATUS_TIMEOUT="${XIAOYOU_INSTALL_STATUS_TIMEOUT:-30}"
+LIST_TIMEOUT="${XIAOYOU_INSTALL_LIST_TIMEOUT:-30}"
+LATEST_TIMEOUT="${XIAOYOU_INSTALL_LATEST_TIMEOUT:-15}"
+OPENCLAW_PROCESS_PATTERN='openclaw-gateway|(^|[ /])openclaw[[:space:]]+gateway([[:space:]]|$)|(^|[ /])openclaw$'
+
+# -----------------------------------------------------------------------------
+# Logging helpers
+# -----------------------------------------------------------------------------
+
+log()   { printf '[xiaoyou-install] %s\n' "$*"; }
+warn()  { printf '[xiaoyou-install][warn] %s\n' "$*" >&2; }
+die()   { printf '[xiaoyou-install][error] %s\n' "$*" >&2; exit 1; }
+
+phase_start() {
+  printf '[xiaoyou-install][phase.start] name=%s\n' "$1"
+  printf '[xiaoyou-install][phase.start] will_do=%s\n' "$2"
+  printf '[xiaoyou-install][phase.start] why=%s\n' "$3"
+}
+
+phase_end() {
+  printf '[xiaoyou-install][phase.end] name=%s\n' "$1"
+  printf '[xiaoyou-install][phase.end] result=%s\n' "$2"
+  printf '[xiaoyou-install][phase.end] summary=%s\n' "$3"
+}
+
+command_exists() { command -v "$1" >/dev/null 2>&1; }
+
+run() { log "run: $*"; "$@"; }
+
+run_or_dry_run() {
+  if [[ "$CHECK_ONLY" -eq 1 ]]; then log "dry-run: $*"; return 0; fi
+  run "$@"
+}
+
+capture_or_empty() { "$@" 2>/dev/null || true; }
+
+capture_timeout_or_empty() {
+  local seconds="$1"; shift
+  if command_exists perl; then
+    perl -e '
+      use POSIX ":sys_wait_h";
+      my $timeout = shift @ARGV;
+      my $pid = fork(); exit 127 unless defined $pid;
+      if ($pid == 0) { exec @ARGV; exit 127; }
+      my $deadline = time() + $timeout;
+      while (1) {
+        my $done = waitpid($pid, WNOHANG);
+        if ($done == $pid) { exit($? >> 8); }
+        if (time() >= $deadline) { kill "TERM", $pid; sleep 1; kill "KILL", $pid; waitpid($pid, 0); exit 124; }
+        select undef, undef, undef, 0.1;
+      }
+    ' "$seconds" "$@" 2>/dev/null || true
+  else
+    "$@" 2>/dev/null || true
+  fi
+}
+
+# -----------------------------------------------------------------------------
+# Argument parsing
+# -----------------------------------------------------------------------------
+
+usage() {
+  cat <<'USAGE'
+Usage:
+  install-xiayou.sh --ws-url <url> --token <token>
+  install-xiayou.sh --version <ver> --ws-url <url> --token <token>
+  install-xiayou.sh uninstall
+  install-xiayou.sh --check-only
+
+Options:
+  --ws-url <url>     企业 WebSocket 服务地址 (wss://... 或 ws://...)
+  --token <token>    企业服务认证 Token
+  --version <ver>    指定 openclaw-xiaoyou 版本 (默认 latest)
+  --check-only       只输出计划，不执行
+  uninstall          卸载 xiaoyou channel
+USAGE
+}
+
+parse_args() {
+  while [[ $# -gt 0 ]]; do
+    case "$1" in
+      -h|--help) usage; exit 0 ;;
+      --ws-url)
+        [[ $# -ge 2 ]] || die "--ws-url 缺少参数"
+        WS_URL="$2"; shift 2 ;;
+      --token)
+        [[ $# -ge 2 ]] || die "--token 缺少参数"
+        TOKEN="$2"; shift 2 ;;
+      --version)
+        [[ $# -ge 2 ]] || die "--version 缺少参数"
+        REQUESTED_VERSION="$2"; shift 2 ;;
+      --check-only) CHECK_ONLY=1; shift ;;
+      uninstall) ACTION="uninstall"; shift ;;
+      --) shift; break ;;
+      -*) die "未知参数: $1" ;;
+      *)
+        # 兼容位置参数传 token
+        if [[ -z "$TOKEN" ]]; then TOKEN="$1"; shift
+        else die "多余的位置参数: $1"; fi ;;
+    esac
+  done
+}
+
+validate_ws_url() {
+  [[ -z "$WS_URL" ]] && return 0
+  if [[ ! "$WS_URL" =~ ^wss?:// ]]; then
+    die "--ws-url 格式不合法，必须以 ws:// 或 wss:// 开头。当前值: $WS_URL"
+  fi
+}
+
+# -----------------------------------------------------------------------------
+# Version helpers
+# -----------------------------------------------------------------------------
+
+extract_semver() {
+  printf '%s\n' "$1" | grep -Eo '[0-9]+(\.[0-9]+){1,2}' | head -n 1 || true
+}
+
+normalize_semver() {
+  local v="$1"; local major minor patch
+  IFS='.' read -r major minor patch <<<"$v"
+  printf '%s.%s.%s\n' "${major:-0}" "${minor:-0}" "${patch:-0}"
+}
+
+# -----------------------------------------------------------------------------
+# Platform detection
+# -----------------------------------------------------------------------------
+
+process_lines() {
+  ps -axww -o pid,command 2>/dev/null || ps -axo pid,command 2>/dev/null || ps -ef 2>/dev/null || true
+}
+
+openclaw_gateway_running() {
+  process_lines | grep -E "$OPENCLAW_PROCESS_PATTERN" | grep -v grep | grep -v 'install-xiayou' >/dev/null 2>&1
+}
+
+openclaw_installed() {
+  command_exists openclaw || [[ -d "$HOME/.openclaw" ]]
+}
+
+openclaw_version() {
+  local raw version
+  raw="$(capture_or_empty openclaw --version)"
+  version="$(extract_semver "$raw")"
+  [[ -n "$version" ]] || die "无法解析 OpenClaw 版本: $raw"
+  normalize_semver "$version"
+}
+
+# -----------------------------------------------------------------------------
+# Read existing config
+# -----------------------------------------------------------------------------
+
+openclaw_config_file() {
+  local primary="$HOME/.openclaw/openclaw.json"
+  local legacy="$HOME/.openclaw/config.json"
+  if [[ -f "$primary" || ! -f "$legacy" ]]; then printf '%s\n' "$primary"
+  else printf '%s\n' "$legacy"; fi
+}
+
+existing_ws_url() {
+  local cfg; cfg="$(openclaw_config_file)"
+  [[ -f "$cfg" ]] || return 0
+  cat "$cfg" 2>/dev/null | grep -Eo '"wsUrl"[[:space:]]*:[[:space:]]*"[^"]*"' | head -n 1 | sed -E 's/.*"wsUrl"[[:space:]]*:[[:space:]]*"([^"]*)".*/\1/' || true
+}
+
+existing_auth_token() {
+  local cfg; cfg="$(openclaw_config_file)"
+  [[ -f "$cfg" ]] || return 0
+  cat "$cfg" 2>/dev/null | grep -Eo '"authToken"[[:space:]]*:[[:space:]]*"[^"]*"' | head -n 1 | sed -E 's/.*"authToken"[[:space:]]*:[[:space:]]*"([^"]*)".*/\1/' || true
+}
+
+installed_plugin_version() {
+  local list line
+  list="$(capture_timeout_or_empty "$LIST_TIMEOUT" openclaw plugins list)"
+  line="$(printf '%s\n' "$list" | grep -E "$PLUGIN_NAME" | head -n 1 || true)"
+  [[ -n "$line" ]] || return 0
+  printf '%s\n' "$line" | grep -Eo '[0-9]+(\.[0-9]+){1,2}' | head -n 1 || true
+}
+
+npm_latest_version() {
+  capture_timeout_or_empty "$LATEST_TIMEOUT" npm view "$PLUGIN_NAME" version
+}
+
+# -----------------------------------------------------------------------------
+# Install / Upgrade
+# -----------------------------------------------------------------------------
+
+install_or_upgrade() {
+  phase_start \
+    "xiaoyou.install-or-upgrade" \
+    "安装或升级 $PLUGIN_NAME 插件，并写入 xiaoyou channel 配置" \
+    "需要确保插件版本可用，且 wsUrl/authToken 配置完整"
+
+  command_exists openclaw || die "未找到 openclaw 命令，请先安装 OpenClaw"
+
+  local version current latest should_install=0 target final_summary=""
+  version="$(openclaw_version)"
+  log "OpenClaw version: $version"
+
+  # 确定目标包
+  if [[ -n "$REQUESTED_VERSION" ]]; then
+    target="${PLUGIN_NAME}@${REQUESTED_VERSION}"
+  else
+    target="${PLUGIN_NAME}@latest"
+  fi
+  log "target package: $target"
+
+  # 检查已安装版本
+  current="$(installed_plugin_version || true)"
+  current="${current:-}"
+  log "installed $PLUGIN_NAME version: ${current:-<none>}"
+
+  # 决定是否需要安装
+  if [[ -z "$current" ]]; then
+    log "未检测到 $PLUGIN_NAME 插件，进入安装流程"
+    should_install=1
+  elif [[ -n "$REQUESTED_VERSION" ]]; then
+    if [[ "$current" == "$REQUESTED_VERSION" ]]; then
+      log "已安装指定版本 $REQUESTED_VERSION，无需重新安装"
+    else
+      log "当前 ${current}，目标 ${REQUESTED_VERSION}，需要升级"
+      should_install=1
+    fi
+  else
+    latest="$(npm_latest_version || true)"
+    latest="${latest:-}"
+    log "npm latest $PLUGIN_NAME: ${latest:-<unknown>}"
+    if [[ -z "$latest" ]]; then
+      warn "无法查询 npm latest，执行幂等安装"
+      should_install=1
+    elif [[ "$current" != "$latest" ]]; then
+      log "当前 ${current}，latest ${latest}，需要升级"
+      should_install=1
+    else
+      log "$PLUGIN_NAME 已是最新版本: $current"
+    fi
+  fi
+
+  # 首次安装必须有 ws-url 和 token
+  if [[ -z "$current" && "$CHECK_ONLY" -eq 0 ]]; then
+    if [[ -z "$WS_URL" ]]; then
+      die "首次安装必须提供 --ws-url。请运行: $SCRIPT_NAME --ws-url <url> --token <token>"
+    fi
+    if [[ -z "$TOKEN" ]]; then
+      die "首次安装必须提供 --token。请运行: $SCRIPT_NAME --ws-url <url> --token <token>"
+    fi
+  fi
+
+  # 升级时复用现有配置
+  if [[ -n "$current" ]]; then
+    if [[ -z "$WS_URL" ]]; then
+      WS_URL="$(existing_ws_url || true)"
+      WS_URL="${WS_URL:-}"
+      [[ -n "$WS_URL" ]] && log "复用现有 wsUrl: $WS_URL"
+    fi
+    if [[ -z "$TOKEN" ]]; then
+      TOKEN="$(existing_auth_token || true)"
+      TOKEN="${TOKEN:-}"
+      [[ -n "$TOKEN" ]] && log "复用现有 authToken"
+    fi
+  fi
+
+  # 执行
+  if [[ "$CHECK_ONLY" -eq 1 ]]; then
+    if [[ "$should_install" -eq 1 ]]; then
+      final_summary="check-only：需要安装 $target，但当前只输出计划"
+    else
+      final_summary="check-only：当前版本满足要求，无需安装或升级"
+    fi
+    log "$final_summary"
+  elif [[ "$should_install" -eq 1 ]]; then
+    if [[ -n "$current" ]]; then
+      log "升级流程：先卸载旧插件，再安装新版本"
+      xiayou_uninstall_plugin_only
+    fi
+    run env NPM_CONFIG_LEGACY_PEER_DEPS=true openclaw plugins install "$target"
+    final_summary="已安装 $target"
+  else
+    final_summary="无需安装或升级"
+  fi
+
+  # 写入配置
+  if [[ "$CHECK_ONLY" -eq 0 ]]; then
+    patch_config
+    final_summary="${final_summary}，已写入 channel 配置"
+  fi
+
+  xiayou_status
+  phase_end "xiaoyou.install-or-upgrade" "ok" "$final_summary"
+}
+
+patch_config() {
+  [[ -n "$WS_URL" || -n "$TOKEN" ]] || return 0
+
+  log "写入 xiaoyou channel 配置"
+  run openclaw config set "channels.${CHANNEL_KEY}.enabled" true --strict-json
+
+  if [[ -n "$WS_URL" ]]; then
+    run openclaw config set "channels.${CHANNEL_KEY}.wsUrl" "$WS_URL"
+  fi
+  if [[ -n "$TOKEN" ]]; then
+    run openclaw config set "channels.${CHANNEL_KEY}.authToken" "$TOKEN"
+  fi
+
+  run openclaw config set "channels.${CHANNEL_KEY}.dmSecurity" open
+  run openclaw config set "channels.${CHANNEL_KEY}.reconnectIntervalMs" 3000 --strict-json
+  run openclaw config set "channels.${CHANNEL_KEY}.heartbeatIntervalMs" 30000 --strict-json
+  run openclaw config set "channels.${CHANNEL_KEY}.heartbeatTimeoutMs" 10000 --strict-json
+
+  local config_file
+  config_file="$(capture_or_empty openclaw config file)"
+  log "已写入配置: ${config_file:-$(openclaw_config_file)}"
+}
+
+# -----------------------------------------------------------------------------
+# Status
+# -----------------------------------------------------------------------------
+
+xiayou_status() {
+  phase_start "xiaoyou.status" "检查 xiaoyou channel 状态" "确认插件已被识别且 gateway 在运行"
+  log "状态检测"
+
+  if openclaw_gateway_running; then
+    local output
+    output="$(capture_timeout_or_empty "$STATUS_TIMEOUT" openclaw status)"
+    if [[ -n "$output" ]]; then
+      printf '%s\n' "$output"
+      phase_end "xiaoyou.status" "ok" "gateway 运行中，已输出状态"
+    else
+      warn "openclaw status 在 ${STATUS_TIMEOUT}s 内未返回"
+      phase_end "xiaoyou.status" "warning" "gateway 运行中但 status 超时"
+    fi
+  else
+    capture_timeout_or_empty "$LIST_TIMEOUT" openclaw plugins list | grep -E "$PLUGIN_NAME|$CHANNEL_KEY" || true
+    capture_timeout_or_empty "$STATUS_TIMEOUT" openclaw channels list | grep -Ei "$CHANNEL_KEY|xiaoyou" || true
+    warn "未检测到运行中的 OpenClaw gateway；请运行 openclaw gateway 或 openclaw gateway restart"
+    phase_end "xiaoyou.status" "warning" "gateway 未运行，已退回到插件/渠道列表检查"
+  fi
+}
+
+# -----------------------------------------------------------------------------
+# Uninstall
+# -----------------------------------------------------------------------------
+
+xiayou_uninstall_plugin_only() {
+  # 仅删除插件记录和文件，不删除配置（升级时用）
+  if command_exists openclaw; then
+    run_or_dry_run openclaw config unset "plugins.entries.${PLUGIN_NAME}" || true
+    run_or_dry_run openclaw config unset "plugins.installs.${PLUGIN_NAME}" || true
+  fi
+  run_or_dry_run rm -rf "$HOME/.openclaw/extensions/${PLUGIN_NAME}" "$HOME"/.openclaw/extensions/.openclaw-* || true
+}
+
+xiayou_uninstall() {
+  phase_start "xiaoyou.uninstall" "删除 xiaoyou channel 配置、插件记录和扩展目录" "清理所有 xiaoyou 相关状态"
+
+  if ! openclaw_installed; then
+    log "未检测到 OpenClaw，跳过卸载"
+    phase_end "xiaoyou.uninstall" "skipped" "未检测到 OpenClaw"
+    return 0
+  fi
+
+  log "开始卸载 xiaoyou channel"
+  if command_exists openclaw; then
+    run_or_dry_run openclaw config unset "channels.${CHANNEL_KEY}" || warn "删除 channels.${CHANNEL_KEY} 失败"
+    run_or_dry_run openclaw config unset "plugins.entries.${PLUGIN_NAME}" || warn "删除 plugins.entries 失败"
+    run_or_dry_run openclaw config unset "plugins.installs.${PLUGIN_NAME}" || warn "删除 plugins.installs 失败"
+  fi
+
+  run_or_dry_run rm -rf "$HOME/.openclaw/extensions/${PLUGIN_NAME}" "$HOME"/.openclaw/extensions/.openclaw-* || warn "删除插件文件失败"
+
+  if [[ "$CHECK_ONLY" -eq 1 ]]; then
+    phase_end "xiaoyou.uninstall" "planned" "check-only：已输出计划，未执行"
+  else
+    phase_end "xiaoyou.uninstall" "ok" "已完成 xiaoyou channel 卸载"
+  fi
+}
+
+# -----------------------------------------------------------------------------
+# Entrypoint
+# -----------------------------------------------------------------------------
+
+main() {
+  phase_start "main.entry" "解析参数并进入安装或卸载分支" "调度入口"
+  parse_args "$@"
+  validate_ws_url
+
+  if [[ "$ACTION" == "uninstall" ]]; then
+    xiayou_uninstall
+    phase_end "main.entry" "ok" "卸载流程完成"
+    return 0
+  fi
+
+  install_or_upgrade
+
+  log "完成。企业服务端应能收到来自 xiaoyou 插件的 WebSocket 连接。"
+  phase_end "main.entry" "ok" "安装流程完成"
+}
+
+main "$@"