refactor: update changelog, enhance logging, and add debug script for better diagnostics

Author: twoone-3

changelog.md

@@ -1,7 +1,8 @@
-# Change Log
+# Changelog
 
-- 优化了 DNS 配置
-- 更新秋风广告规则 1.6.5-release
-- 修改默认安装语言为中文
-- 优化了某些获取进程的方式
-- 取消了 --no-check-update 参数，现在用户可以在网页端自动更新 AdGuardHome
+- 添加了全模块中英双语支持
+- 尝试解决部分设备无法启动的问题
+- 添加了 debug.sh 作为排错工具
+- 移除了无效的黑白名单
+- 配置文件改名 setting.conf
+- 其它文本提示类的改进

docs/index.md

@@ -73,27 +73,6 @@ rm /data/adb/modules/AdGuardHome/disable
 
 如果使用代理模块，强烈建议禁用模块的 iptables 转发规则。禁用后，模块仅运行 AdGuardHome 本身。随后，将代理模块的上游 DNS 服务器配置为 `127.0.0.1:5591`，即可确保代理软件的所有 DNS 查询通过 AdGuardHome 进行广告屏蔽。
 
-以下是 Mihomo 的配置示例：
-
-```yaml
-dns:
-  enable: true
-  ipv6: true
-
-  default-nameserver:
-    - 127.0.0.1:5591 # not necessary
-
-  listen: 0.0.0.0:1053
-  use-hosts: true
-  enhanced-mode: fake-ip
-  fake-ip-range: 198.18.0.1/16
-  fake-ip-filter:
-    - '*.lan'
-
-  nameserver:
-    - 127.0.0.1:5591 # necessary
-```
-
 ---
 
 ### 模块目录与配置文件

src/customize.sh

@@ -10,83 +10,62 @@ function error() {
   [ "$language" = "en" ] && abort "$1" || abort "$2"
 }
 
-info "- Installing AdGuardHome for $ARCH" "- 开始安装 AdGuardHome for $ARCH"
+info "- 🚀 Installing AdGuardHome for $ARCH" "- 🚀 开始安装 AdGuardHome for $ARCH"
 
 AGH_DIR="/data/adb/agh"
 BIN_DIR="$AGH_DIR/bin"
 SCRIPT_DIR="$AGH_DIR/scripts"
-BACKUP_DIR="$AGH_DIR/backup"
 PID_FILE="$AGH_DIR/bin/agh.pid"
 
-info "- Extracting module basic files..." "- 解压模块基本文件..."
-unzip -o "$ZIPFILE" "action.sh" -d $MODPATH >/dev/null 2>&1
-unzip -o "$ZIPFILE" "module.prop" -d $MODPATH >/dev/null 2>&1
-unzip -o "$ZIPFILE" "service.sh" -d $MODPATH >/dev/null 2>&1
-unzip -o "$ZIPFILE" "uninstall.sh" -d $MODPATH >/dev/null 2>&1
+info "- 📦 Extracting module basic files..." "- 📦 解压模块基本文件..."
+unzip -o "$ZIPFILE" "action.sh" -d "$MODPATH" >/dev/null 2>&1
+unzip -o "$ZIPFILE" "module.prop" -d "$MODPATH" >/dev/null 2>&1
+unzip -o "$ZIPFILE" "service.sh" -d "$MODPATH" >/dev/null 2>&1
+unzip -o "$ZIPFILE" "uninstall.sh" -d "$MODPATH" >/dev/null 2>&1
 
 extract_keep_config() {
-  info "- Keeping old configuration files" "- 保留原来的配置文件"
-  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract scripts" "- 解压脚本文件失败"
-  }
-  unzip -o "$ZIPFILE" "bin/*" -x "bin/AdGuardHome.yaml" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract binary files" "- 解压二进制文件失败"
-  }
-  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract configuration files" "- 解压配置文件失败"
-  }
+  info "- 📁 Keeping old configuration files" "- 📁 保留原来的配置文件"
+  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract scripts" "- 解压脚本文件失败"
+  unzip -o "$ZIPFILE" "bin/*" -x "bin/AdGuardHome.yaml" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract binary files" "- 解压二进制文件失败"
+  info "- 📦 Extracting configuration files..." "- 📦 正在解压配置文件..."
+  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract configuration files" "- 解压配置文件失败"
 }
 
 extract_no_config() {
-  [ -d "$BACKUP_DIR" ] && rm -r "$BACKUP_DIR"
-  mkdir -p "$BACKUP_DIR"
-  info "- Backing up old configuration files..." "- 正在备份旧配置文件..."
-  mv "$AGH_DIR/settings.conf" "$BACKUP_DIR"
-  mv "$AGH_DIR/bin/AdGuardHome.yaml" "$BACKUP_DIR"
-  info "- Extracting script files..." "- 正在解压脚本文件..."
-  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract scripts" "- 解压脚本文件失败"
-  }
-  info "- Extracting binary files..." "- 正在解压二进制文件..."
-  unzip -o "$ZIPFILE" "bin/*" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract binary files" "- 解压二进制文件失败"
-  }
-  info "- Extracting configuration files..." "- 正在解压配置文件..."
-  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract configuration files" "- 解压配置文件失败"
-  }
+  info "- 💾 Backing up old configuration files with .bak extension..." "- 💾 使用 .bak 扩展名备份旧配置文件..."
+  [ -f "$AGH_DIR/settings.conf" ] && mv "$AGH_DIR/settings.conf" "$AGH_DIR/settings.conf.bak"
+  [ -f "$AGH_DIR/bin/AdGuardHome.yaml" ] && mv "$AGH_DIR/bin/AdGuardHome.yaml" "$AGH_DIR/bin/AdGuardHome.yaml.bak"
+  info "- 📦 Extracting script files..." "- 📦 正在解压脚本文件..."
+  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract scripts" "- 解压脚本文件失败"
+  info "- 📦 Extracting binary files..." "- 📦 正在解压二进制文件..."
+  unzip -o "$ZIPFILE" "bin/*" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract binary files" "- 解压二进制文件失败"
+  info "- 📦 Extracting configuration files..." "- 📦 正在解压配置文件..."
+  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract configuration files" "- 解压配置文件失败"
 }
 
 first_install_extract() {
-  info "- First time installation, extracting files..." "- 第一次安装，正在解压文件..."
+  info "- 📦 First time installation, extracting files..." "- 📦 第一次安装，正在解压文件..."
   mkdir -p "$AGH_DIR" "$BIN_DIR" "$SCRIPT_DIR"
-  info "- Extracting script files..." "- 正在解压脚本文件..."
-  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract scripts" "- 解压脚本文件失败"
-  }
-  info "- Extracting binary files..." "- 正在解压二进制文件..."
-  unzip -o "$ZIPFILE" "bin/*" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract binary files" "- 解压二进制文件失败"
-  }
-  info "- Extracting configuration files..." "- 正在解压配置文件..."
-  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || {
-    error "- Failed to extract configuration files" "- 解压配置文件失败"
-  }
+  info "- 📦 Extracting script files..." "- 📦 正在解压脚本文件..."
+  unzip -o "$ZIPFILE" "scripts/*" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract scripts" "- 解压脚本文件失败"
+  info "- 📦 Extracting binary files..." "- 📦 正在解压二进制文件..."
+  unzip -o "$ZIPFILE" "bin/*" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract binary files" "- 解压二进制文件失败"
+  info "- 📦 Extracting configuration files..." "- 📦 正在解压配置文件..."
+  unzip -o "$ZIPFILE" "settings.conf" -d $AGH_DIR >/dev/null 2>&1 || error "- Failed to extract configuration files" "- 解压配置文件失败"
 }
 
 if [ -d "$AGH_DIR" ]; then
-  # Kill all processes named AdGuardHome
-  info "- Stopping all AdGuardHome processes..." "- 正在停止所有 AdGuardHome 进程..."
+  info "- ⏹️ Stopping all AdGuardHome processes..." "- ⏹️ 正在停止所有 AdGuardHome 进程..."
   pkill -f "AdGuardHome" || pkill -9 -f "AdGuardHome"
   sleep 1
-  info "- Found old version, do you want to keep the old configuration? (If not, it will be automatically backed up)" "- 发现旧版模块，是否保留原来的配置文件？（若不保留则自动备份）"
-  info "- (Volume Up = Yes, Volume Down = No, 10s no input = No)" "- （音量上键 = 是, 音量下键 = 否，10秒无操作 = 否）"
+  info "- 🔄 Found old version, do you want to keep the old configuration? (If not, it will be automatically backed up)" "- 🔄 发现旧版模块，是否保留原来的配置文件？（若不保留则自动备份）"
+  info "- 🔊 (Volume Up = Yes, Volume Down = No, 10s no input = No)" "- 🔊 （音量上键 = 是, 音量下键 = 否，10秒无操作 = 否）"
   START_TIME=$(date +%s)
   while true ; do
     NOW_TIME=$(date +%s)
     timeout 1 getevent -lc 1 2>&1 | grep KEY_VOLUME > "$TMPDIR/events"
     if [ $(( NOW_TIME - START_TIME )) -gt 9 ]; then
-      info "- No input detected after 10 seconds, defaulting to not keep old configuration." "- 10秒无输入，默认不保留原配置。"
+      info "- ⏰ No input detected after 10 seconds, defaulting to not keep old configuration." "- ⏰ 10秒无输入，默认不保留原配置。"
       extract_no_config
       break
     elif $(cat $TMPDIR/events | grep -q KEY_VOLUMEUP); then
@@ -101,16 +80,11 @@ else
   first_install_extract
 fi
 
-info "- Setting permissions..." "- 设置权限..."
+info "- 🔐 Setting permissions..." "- 🔐 设置权限..."
+
 chmod +x "$BIN_DIR/AdGuardHome"
 chown root:net_raw "$BIN_DIR/AdGuardHome"
 
-chmod +x "$SCRIPT_DIR/inotify.sh"
-chmod +x "$SCRIPT_DIR/iptables.sh"
-chmod +x "$SCRIPT_DIR/tool.sh"
-
-chmod +x "$MODPATH/action.sh"
-chmod +x "$MODPATH/service.sh"
-chmod +x "$MODPATH/uninstall.sh"
+chmod +x "$SCRIPT_DIR"/*.sh "$MODPATH"/*.sh
 
-info "- Installation completed, please reboot." "- 安装完成，请重启设备。"
+info "- ✅ Installation completed, please reboot." "- ✅ 安装完成，请重启设备。"

src/module.prop

@@ -1,7 +1,7 @@
 id=AdGuardHome
 name=AdGuardHome for Root
-version=20250509(preview)
-versionCode=35
+version=20250511
+versionCode=36
 author=twoone3
-description=Active
+description=none
 updateJson=https://raw.githubusercontent.com/twoone-3/AdGuardHomeForRoot/main/version.json

src/scripts/debug.sh

@@ -0,0 +1,65 @@
+#!/system/bin/sh
+
+AGH_DIR="/data/adb/agh"
+LOG="$AGH_DIR/debug.log"
+
+{
+  echo "==== AdGuardHome Debug Log ===="
+  date
+  echo
+
+  echo "== System Info =="
+  uname -a
+  echo "Android Version: $(getprop ro.build.version.release)"
+  echo "Device: $(getprop ro.product.model)"
+  echo "Architecture: $(uname -m)"
+  echo
+
+  echo "== Magisk Info =="
+  [ -f /sbin/magisk ] && /sbin/magisk -v 2>/dev/null
+  echo "Magisk Path: $(magisk --path 2>/dev/null)"
+  echo
+
+  echo "== AGH Directory Listing =="
+  ls -lR "$AGH_DIR"
+  echo
+
+  echo "== AGH Bin Log (last 30 lines) =="
+  tail -n 30 "$AGH_DIR/bin.log" 2>/dev/null
+  echo
+
+  echo "== AGH Settings =="
+  cat "$AGH_DIR/settings.conf" 2>/dev/null
+  echo
+
+  echo "== AGH PID File =="
+  cat "$AGH_DIR/bin/agh.pid" 2>/dev/null
+  echo
+
+  echo "== Running Processes (AdGuardHome) =="
+  ps | grep AdGuardHome
+  echo
+
+  echo "== iptables -t nat -L -n -v =="
+  iptables -t nat -L -n -v
+  echo
+
+  echo "== ip6tables -t filter -L -n -v =="
+  ip6tables -t filter -L -n -v
+  echo
+
+  echo "== Network Interfaces =="
+  ip addr
+  echo
+
+  echo "== Disk Usage =="
+  df -h
+  echo
+
+  echo "== SELinux Status =="
+  getenforce
+  echo
+
+} > "$LOG" 2>&1
+
+echo "Debug info collected in $LOG"

src/scripts/iptables.sh

@@ -1,4 +1,5 @@
 . /data/adb/agh/settings.conf
+
 iptables_w="iptables -w 64"
 ip6tables_w="ip6tables -w 64"
 

src/scripts/tool.sh

@@ -14,15 +14,19 @@ start_adguardhome() {
 
   # check if AdGuardHome started successfully
   if ps | grep -w "$adg_pid" | grep -q "AdGuardHome"; then
-    log "AdGuardHome started, PID: $adg_pid" "- AdGuardHome 启动成功，PID: $adg_pid"
-    update_description "✅ Started 🚀" "✅ 启动成功 🚀"
+    log "🥰 started, PID: $adg_pid" "- 🥰 启动成功，PID: $adg_pid"
+    update_description "🥰 Started, PID: $adg_pid" "🥰 启动成功, PID: $adg_pid"
     echo "$adg_pid" >"$PID_FILE"
     if [ "$enable_iptables" = true ]; then
       $SCRIPT_DIR/iptables.sh enable
     fi
   else
-    log "Failed to start AdGuardHome" "- AdGuardHome 启动失败"
-    update_description "❌ Failed to start" "❌ 启动失败"
+    log "😭 Error occurred, check logs for details" "😭 出现错误，请检查日志以获取详细信息"
+    update_description "😭 Error occurred, check logs for details" "😭 出现错误，请检查日志以获取详细信息"
+    log "==== Last 20 lines of bin.log ====" "==== bin.log 的最后 20 行 ===="
+    tail -n 20 "$AGH_DIR/bin.log" | while read -r line; do
+      log "$line" "$line"
+    done
     exit 1
   fi
 }

version.json

@@ -1,6 +1,6 @@
 {
-  "versionCode": 35,
-  "version": "20250427",
+  "versionCode": 36,
+  "version": "20250511",
   "zipUrl": "https://github.com/twoone-3/AdGuardHomeForRoot/releases/latest/download/AdGuardHomeForRoot_arm64.zip",
   "changelog": "https://raw.githubusercontent.com/twoone-3/AdGuardHomeForRoot/main/changelog.md"
 }