feat: add configurable webhook display prefix (#1797)

* Initial plan

* Add webhook_display_prefix configuration option

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* perf: change config field name

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>
Co-authored-by: Junyan Qin <rockchinq@gmail.com>

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,30 @@
+name: 漏洞反馈
+description: 【供中文用户】报错或漏洞请使用这个模板创建，不使用此模板创建的异常、漏洞相关issue将被直接关闭。由于自己操作不当/不甚了解所用技术栈引起的网络连接问题恕无法解决，请勿提 issue。容器间网络连接问题，参考文档 https://docs.langbot.app/zh/workshop/network-details.html  
+title: "[Bug]: "
+labels: ["bug?"]
+body:
+  - type: input
+    attributes:
+      label: 运行环境
+      description: LangBot 版本、操作系统、系统架构、**Python版本**、**主机地理位置**
+      placeholder: 例如：v3.3.0、CentOS x64 Python 3.10.3、Docker
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 异常情况
+      description: 完整描述异常情况，什么时候发生的、发生了什么。**请附带日志信息。** 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 复现步骤
+      description: 提供越多信息，我们会越快解决问题，建议多提供配置截图；**如果你不认真填写（只一两句话概括），我们会很生气并且立即关闭 issue 或两年后才回复你**
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 启用的插件
+      description: 有些情况可能和插件功能有关，建议提供插件启用情况。
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug-report_en.yml

@@ -0,0 +1,30 @@
+name: Bug report
+description: Report bugs or vulnerabilities using this template. For container network connection issues, refer to the documentation https://docs.langbot.app/en/workshop/network-details.html
+title: "[Bug]: "
+labels: ["bug?"]
+body:
+  - type: input
+    attributes:
+      label: Runtime environment
+      description: LangBot version, operating system, system architecture, **Python version**, **host location**
+      placeholder: "For example: v3.3.0, CentOS x64 Python 3.10.3, Docker"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Exception
+      description: Describe the exception in detail, what happened and when it happened. **Please include log information.** 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reproduction steps
+      description: How to reproduce this problem, the more detailed the better; the more information you provide, the faster we will solve the problem. 【注意】请务必认真填写此部分，若不提供完整信息（如只有一两句话的概括），我们将不会回复！
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Enabled plugins
+      description: Some cases may be related to plugin functionality, so please provide the plugin enablement status.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,21 @@
+name: 需求建议
+title: "[Feature]: "
+labels: []
+description: "【供中文用户】新功能或现有功能优化请使用这个模板；不符合类别的issue将被直接关闭"
+body:
+  - type: dropdown
+    attributes:
+      label: 这是一个？
+      description: 新功能建议还是现有功能优化
+      options:
+        - 新功能
+        - 现有功能优化
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 详细描述
+      description: 详细描述，越详细越好
+    validations:
+      required: true
+      

.github/ISSUE_TEMPLATE/feature-request_en.yml

@@ -0,0 +1,21 @@
+name: Feature request
+title: "[Feature]: "
+labels: []
+description: "New features or existing feature improvements should use this template; issues that do not match will be closed directly"
+body:
+  - type: dropdown
+    attributes:
+      label: This is a?
+      description: New feature request or existing feature improvement
+      options:
+        - New feature
+        - Existing feature improvement
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Detailed description
+      description: Detailed description, the more detailed the better
+    validations:
+      required: true
+      

.github/ISSUE_TEMPLATE/submit-plugin.yml

@@ -0,0 +1,24 @@
+name: 提交新插件
+title: "[Plugin]: 请求登记新插件"
+labels: ["独立插件"]
+description: "【供中文用户】本模板供且仅供提交新插件使用"
+body:
+  - type: input
+    attributes:
+      label: 插件名称
+      description: 填写插件的名称
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 插件代码库地址
+      description: 仅支持 Github
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 插件简介
+      description: 插件的简介
+    validations:
+      required: true
+      

.github/ISSUE_TEMPLATE/submit-plugin_en.yml

@@ -0,0 +1,24 @@
+name: Submit a new plugin
+title: "[Plugin]: Request to register a new plugin"
+labels: ["Independent Plugin"]
+description: "This template is only for submitting new plugins"
+body:
+  - type: input
+    attributes:
+      label: Plugin name
+      description: Fill in the name of the plugin
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Plugin code repository address
+      description: Only support Github
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Plugin description
+      description: The description of the plugin
+    validations:
+      required: true
+      

.github/ISSUE_TEMPLATE/漏洞反馈.md

@@ -1,24 +0,0 @@
----
-name: 漏洞反馈
-about: 报错或漏洞请使用这个模板创建
-title: "[BUG]"
-labels: 'bug'
-assignees: ''
-
----
-
-请认真按照实际情况填写以下信息！！！！
-
-**运行环境**
-- 部署方式：
-    手动部署/自动部署/Docker部署
-- 系统环境：
-    例如： Centos x64
-- Python环境（仅手动部署填写）：
-    例如： Python 3.10.9
-
-**描述漏洞**  
-什么时候发生的，mirai还是主程序，越详细越好
-
-**完整报错信息**  
-完整的报错信息

.github/ISSUE_TEMPLATE/需求建议.md

@@ -1,10 +0,0 @@
----
-name: 需求建议
-about: 软件优化建议请使用这个模板创建
-title: "[ENHANCE]"
-labels: 'enhancement'
-assignees: ''
-
----
-
-不是需求建议请勿填写此模板！！！！

.github/dependabot.yml

@@ -10,6 +10,4 @@ updates:
     schedule:
       interval: "weekly"
     allow:
-      - dependency-name: "yiri-mirai"
-      - dependency-name: "dulwich"
       - dependency-name: "openai"

.github/pull_request_template.md

@@ -0,0 +1,32 @@
+## 概述 / Overview
+
+> 请在此部分填写你实现/解决/优化的内容:  
+> Summary of what you implemented/solved/optimized:
+> 
+
+### 更改前后对比截图 / Screenshots
+
+> 请在此部分粘贴更改前后对比截图（可以是界面截图、控制台输出、对话截图等）:  
+> Please paste the screenshots of changes before and after here (can be interface screenshots, console output, conversation screenshots, etc.):
+> 
+> 修改前 / Before:
+> 
+> 修改后 / After:
+> 
+
+## 检查清单 / Checklist
+
+### PR 作者完成 / For PR author
+
+*请在方括号间写`x`以打勾 / Please tick the box with `x`*
+
+- [ ] 阅读仓库[贡献指引](https://github.com/langbot-app/LangBot/blob/master/CONTRIBUTING.md)了吗？ / Have you read the [contribution guide](https://github.com/langbot-app/LangBot/blob/master/CONTRIBUTING.md)?
+- [ ] 与项目所有者沟通过了吗？ / Have you communicated with the project maintainer?
+- [ ] 我确定已自行测试所作的更改，确保功能符合预期。 / I have tested the changes and ensured they work as expected.
+
+### 项目维护者完成 / For project maintainer
+
+- [ ] 相关 issues 链接了吗？ / Have you linked the related issues?
+- [ ] 配置项写好了吗？迁移写好了吗？生效了吗？ / Have you written the configuration items? Have you written the migration? Has it taken effect?
+- [ ] 依赖加到 pyproject.toml 和 core/bootutils/deps.py 了吗 / Have you added the dependencies to pyproject.toml and core/bootutils/deps.py?
+- [ ] 文档编写了吗？ / Have you written the documentation?

.github/workflows/build-dev-image.yaml

@@ -0,0 +1,29 @@
+name: Build Dev Image
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  build-dev-image:
+    runs-on: ubuntu-latest
+    # 如果是tag则跳过
+    if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Generate Tag
+        id: generate_tag
+        run: |
+          # 获取分支名称，把/替换为-
+          echo ${{ github.ref }} | sed 's/refs\/heads\///g' | sed 's/\//-/g'
+          echo ::set-output name=tag::$(echo ${{ github.ref }} | sed 's/refs\/heads\///g' | sed 's/\//-/g')
+      - name: Login to Registry
+        run: docker login --username=${{ secrets.DOCKER_USERNAME }} --password ${{ secrets.DOCKER_PASSWORD }}
+      - name: Build Docker Image
+        run: |
+          docker buildx create --name mybuilder --use
+          docker build -t rockchin/langbot:${{ steps.generate_tag.outputs.tag }} . --push

.github/workflows/build-docker-image.yml

@@ -0,0 +1,48 @@
+name: Build Docker Image
+on:
+  ## 发布release的时候会自动构建
+  release:
+    types: [published]
+  workflow_dispatch:
+jobs:
+  publish-docker-image:
+    runs-on: ubuntu-latest
+    name: Build image
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: judge has env GITHUB_REF  # 如果没有GITHUB_REF环境变量，则把github.ref变量赋值给GITHUB_REF
+        run: |
+          if [ -z "$GITHUB_REF" ]; then
+            export GITHUB_REF=${{ github.ref }}
+            echo $GITHUB_REF
+          fi
+      - name: Check version
+        id: check_version
+        run: |
+          echo $GITHUB_REF
+          # 如果是tag，则去掉refs/tags/前缀
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            echo "It's a tag"
+            echo $GITHUB_REF
+            echo $GITHUB_REF | awk -F '/' '{print $3}'
+            echo ::set-output name=version::$(echo $GITHUB_REF | awk -F '/' '{print $3}')
+          else
+            echo "It's not a tag"
+            echo $GITHUB_REF
+            echo ::set-output name=version::${GITHUB_REF}
+          fi
+      - name: Login to Registry
+        run: docker login --username=${{ secrets.DOCKER_USERNAME }} --password ${{ secrets.DOCKER_PASSWORD }}
+      - name: Create Buildx
+        run: docker buildx create --name mybuilder --use
+      - name: Build for Release # only relase, exlude pre-release
+        if: ${{ github.event.release.prerelease == false }}
+        run: docker buildx build --platform linux/amd64 -t rockchin/langbot:${{ steps.check_version.outputs.version }} -t rockchin/langbot:latest . --push
+      - name: Build for Pre-release # no update for latest tag
+        if: ${{ github.event.release.prerelease == true }}
+        run: docker buildx build --platform linux/amd64 -t rockchin/langbot:${{ steps.check_version.outputs.version }} . --push

.github/workflows/build-release-artifacts.yaml

@@ -0,0 +1,62 @@
+name: Build Release Artifacts
+
+on:
+  workflow_dispatch:
+  ## 发布release的时候会自动构建
+  release:
+    types: [published]
+
+jobs:
+  build-artifacts:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Check version
+        id: check_version
+        run: |
+          echo $GITHUB_REF
+          # 如果是tag，则去掉refs/tags/前缀
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            echo "It's a tag"
+            echo $GITHUB_REF
+            echo $GITHUB_REF | awk -F '/' '{print $3}'
+            echo ::set-output name=version::$(echo $GITHUB_REF | awk -F '/' '{print $3}')
+          else
+            echo "It's not a tag"
+            echo $GITHUB_REF
+            echo ::set-output name=version::${GITHUB_REF}
+          fi
+
+      - name: Make Temp Directory
+        run: |
+          mkdir -p /tmp/langbot_build_web
+          cp -r . /tmp/langbot_build_web
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '22'
+      - name: Build Web
+        run: |
+          cd /tmp/langbot_build_web/web
+          npm install
+          npm run build
+      - name: Package Output
+        run: |
+          cp -r /tmp/langbot_build_web/web/out ./web
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: langbot-${{ steps.check_version.outputs.version }}-all
+          path: .
+
+      - name: Upload To Release
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_UPLOAD_GITHUB_TOKEN }}
+        run: |
+          # 本目录下所有文件打包成zip
+          zip -r langbot-${{ steps.check_version.outputs.version }}-all.zip .
+          gh release upload ${{ github.event.release.tag_name }} langbot-${{ steps.check_version.outputs.version }}-all.zip

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,46 @@
+name: Build and Publish to PyPI
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write  # Required for trusted publishing to PyPI
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Build frontend
+        run: |
+          cd web
+          npm install -g pnpm
+          pnpm install
+          pnpm build
+          mkdir -p ../src/langbot/web/out
+          cp -r out ../src/langbot/web/
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: |
+          uv build
+
+      - name: Publish to PyPI
+        run: |
+          uv publish --token ${{ secrets.PYPI_TOKEN }}

.github/workflows/run-tests.yml

@@ -0,0 +1,71 @@
+name: Unit Tests
+
+on:
+  pull_request:
+    types: [opened, ready_for_review, synchronize]
+    paths:
+      - 'pkg/**'
+      - 'tests/**'
+      - '.github/workflows/run-tests.yml'
+      - 'pyproject.toml'
+      - 'run_tests.sh'
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - 'pkg/**'
+      - 'tests/**'
+      - '.github/workflows/run-tests.yml'
+      - 'pyproject.toml'
+      - 'run_tests.sh'
+
+jobs:
+  test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+      fail-fast: false
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          uv sync --dev
+
+      - name: Run unit tests
+        run: |
+          bash run_tests.sh
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./coverage.xml
+          flags: unit-tests
+          name: unit-tests-coverage
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Test Summary
+        if: always()
+        run: |
+          echo "## Unit Tests Results" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Python Version: ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+          echo "Test Status: ${{ job.status }}" >> $GITHUB_STEP_SUMMARY

.github/workflows/test-dev-image.yaml

@@ -0,0 +1,108 @@
+name: Test Dev Image
+
+on:
+  workflow_run:
+    workflows: ["Build Dev Image"]
+    types:
+      - completed
+    branches:
+      - master
+
+jobs:
+  test-dev-image:
+    runs-on: ubuntu-latest
+    # Only run if the build workflow succeeded
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    
+    permissions:
+      contents: read
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Update Docker Compose to use master tag
+        working-directory: ./docker
+        run: |
+          # Replace 'latest' with 'master' tag for testing the dev image
+          sed -i 's/rockchin\/langbot:latest/rockchin\/langbot:master/g' docker-compose.yaml
+          echo "Updated docker-compose.yaml to use master tag:"
+          cat docker-compose.yaml
+
+      - name: Start Docker Compose
+        working-directory: ./docker
+        run: docker compose up -d
+
+      - name: Wait and Test API
+        run: |
+          # Function to test API endpoint
+          test_api() {
+            echo "Testing API endpoint..."
+            response=$(curl -s --connect-timeout 10 --max-time 30 -w "\n%{http_code}" http://localhost:5300/api/v1/system/info 2>&1)
+            curl_exit_code=$?
+            
+            if [ $curl_exit_code -ne 0 ]; then
+              echo "Curl failed with exit code: $curl_exit_code"
+              echo "Error: $response"
+              return 1
+            fi
+            
+            http_code=$(echo "$response" | tail -n 1)
+            response_body=$(echo "$response" | head -n -1)
+            
+            if [ "$http_code" = "200" ]; then
+              echo "API is healthy! Response code: $http_code"
+              echo "Response: $response_body"
+              return 0
+            else
+              echo "API returned non-200 response: $http_code"
+              echo "Response body: $response_body"
+              return 1
+            fi
+          }
+
+          # Wait 30 seconds before first attempt
+          echo "Waiting 30 seconds for services to start..."
+          sleep 30
+
+          # Try up to 3 times with 30-second intervals
+          max_attempts=3
+          attempt=1
+
+          while [ $attempt -le $max_attempts ]; do
+            echo "Attempt $attempt of $max_attempts"
+            
+            if test_api; then
+              echo "Success! API is responding correctly."
+              exit 0
+            fi
+            
+            if [ $attempt -lt $max_attempts ]; then
+              echo "Retrying in 30 seconds..."
+              sleep 30
+            fi
+            
+            attempt=$((attempt + 1))
+          done
+
+          # All attempts failed
+          echo "Failed to get healthy response after $max_attempts attempts"
+          exit 1
+
+      - name: Show Container Logs on Failure
+        if: failure()
+        working-directory: ./docker
+        run: |
+          echo "=== Docker Compose Status ==="
+          docker compose ps
+          echo ""
+          echo "=== LangBot Logs ==="
+          docker compose logs langbot
+          echo ""
+          echo "=== Plugin Runtime Logs ==="
+          docker compose logs langbot_plugin_runtime
+
+      - name: Cleanup
+        if: always()
+        working-directory: ./docker
+        run: docker compose down

.gitignore

@@ -1,11 +1,11 @@
-config.py
+/config.py
 .idea/
 __pycache__/
 database.db
-qchatgpt.log
+langbot.log
 /banlist.py
-plugins/
+/plugins/
-!plugins/__init__.py
+!/plugins/__init__.py
 /revcfg.py
 prompts/
 logs/
@@ -13,4 +13,43 @@ sensitive.json
 temp/
 current_tag
 scenario/
-!scenario/default-template.json
+!scenario/default-template.json
+override.json
+cookies.json
+data/labels/announcement_saved.json
+cmdpriv.json
+tips.py
+venv*
+bin/
+.vscode
+/test_*
+venv/
+hugchat.json
+qcapi
+claude.json
+bard.json
+/*yaml
+!.pre-commit-config.yaml
+!components.yaml
+!/docker-compose.yaml
+data/labels/instance_id.json
+.DS_Store
+/data
+botpy.log*
+/poc
+/libs/wecom_api/test.py
+/venv
+test.py
+/web_ui
+.venv/
+uv.lock
+/test
+plugins.bak
+coverage.xml
+.coverage
+src/langbot/web/
+
+# Build artifacts
+/dist
+/build
+*.egg-info

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.7
+    hooks:
+      # Run the linter of backend.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter of backend.
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        types_or: [javascript, jsx, ts, tsx, css, scss]
+        additional_dependencies:
+          - prettier@3.1.0
+
+  - repo: local
+    hooks:
+      - id: lint-staged
+        name: lint-staged
+        entry: cd web && pnpm lint-staged
+        language: system
+        types: [javascript, jsx, ts, tsx]
+        pass_filenames: false

AGENTS.md

@@ -0,0 +1,86 @@
+# AGENTS.md
+
+This file is for guiding code agents (like Claude Code, GitHub Copilot, OpenAI Codex, etc.) to work in LangBot project.
+
+## Project Overview
+
+LangBot is a open-source LLM native instant messaging bot development platform, aiming to provide an out-of-the-box IM robot development experience, with Agent, RAG, MCP and other LLM application functions, supporting global instant messaging platforms, and providing rich API interfaces, supporting custom development.
+
+LangBot has a comprehensive frontend, all operations can be performed through the frontend. The project splited into these major parts:
+
+- `./pkg`: The core python package of the project backend.
+    - `./pkg/platform`: The platform module of the project, containing the logic of message platform adapters, bot managers, message session managers, etc.
+    - `./pkg/provider`: The provider module of the project, containing the logic of LLM providers, tool providers, etc.
+    - `./pkg/pipeline`: The pipeline module of the project, containing the logic of pipelines, stages, query pool, etc.
+    - `./pkg/api`: The api module of the project, containing the http api controllers and services.
+    - `./pkg/plugin`: LangBot bridge for connecting with plugin system.
+- `./libs`: Some SDKs we previously developed for the project, such as `qq_official_api`, `wecom_api`, etc.
+- `./templates`: Templates of config files, components, etc.
+- `./web`: Frontend codebase, built with Next.js + **shadcn** + **Tailwind CSS**.
+- `./docker`: docker-compose deployment files.
+
+## Backend Development
+
+We use `uv` to manage dependencies.
+
+```bash
+pip install uv
+uv sync --dev
+```
+
+Start the backend and run the project in development mode.
+
+```bash
+uv run main.py
+```
+
+Then you can access the project at `http://127.0.0.1:5300`.
+
+## Frontend Development
+
+We use `pnpm` to manage dependencies.
+
+```bash
+cd web
+cp .env.example .env
+pnpm install
+pnpm dev
+```
+
+Then you can access the project at `http://127.0.0.1:3000`.
+
+## Plugin System Architecture
+
+LangBot is composed of various internal components such as Large Language Model tools, commands, messaging platform adapters, LLM requesters, and more. To meet extensibility and flexibility requirements, we have implemented a production-grade plugin system.
+
+Each plugin runs in an independent process, managed uniformly by the Plugin Runtime. It has two operating modes: `stdio` and `websocket`. When LangBot is started directly by users (not running in a container), it uses `stdio` mode, which is common for personal users or lightweight environments. When LangBot runs in a container, it uses `websocket` mode, designed specifically for production environments.
+
+Plugin Runtime automatically starts each installed plugin and interacts through stdio. In plugin development scenarios, developers can use the lbp command-line tool to start plugins and connect to the running Runtime via WebSocket for debugging.
+
+> Plugin SDK, CLI, Runtime, and entities definitions shared between LangBot and plugins are contained in the [`langbot-plugin-sdk`](https://github.com/langbot-app/langbot-plugin-sdk) repository.
+
+## Some Development Tips and Standards
+
+- LangBot is a global project, any comments in code should be in English, and user experience should be considered in all aspects.
+- Thus you should consider the i18n support in all aspects.
+- LangBot is widely adopted in both toC and toB scenarios, so you should consider the compatibility and security in all aspects.
+- If you were asked to make a commit, please follow the commit message format: 
+    - format: <type>(<scope>): <subject>
+    - type: must be a specific type, such as feat (new feature), fix (bug fix), docs (documentation), style (code style), refactor (refactoring), perf (performance optimization), etc.
+    - scope: the scope of the commit, such as the package name, the file name, the function name, the class name, the module name, etc.
+    - subject: the subject of the commit, such as the description of the commit, the reason for the commit, the impact of the commit, etc.
+
+## Some Principles
+
+- Keep it simple, stupid.
+- Entities should not be multiplied unnecessarily
+- 八荣八耻
+
+    以瞎猜接口为耻，以认真查询为荣。
+    以模糊执行为耻，以寻求确认为荣。
+    以臆想业务为耻，以人类确认为荣。
+    以创造接口为耻，以复用现有为荣。
+    以跳过验证为耻，以主动测试为荣。
+    以破坏架构为耻，以遵循规范为荣。
+    以假装理解为耻，以诚实无知为荣。
+    以盲目修改为耻，以谨慎重构为荣。

CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

CONTRIBUTING.md

@@ -5,15 +5,27 @@
 ### 贡献形式
 
 - 提交PR，解决issues中提到的bug或期待的功能
-- 提交PR，实现您设想的功能（请先提出issue与作者沟通）
+- 提交PR，实现您设想的功能（请先提出issue与项目维护者沟通）
-- 优化代码架构，使各个模块的组织更加整洁优雅
-- 在issues中提出发现的bug或者期待的功能
 - 为本项目在其他社交平台撰写文章、制作视频等
 - 为本项目的衍生项目作出贡献，或开发插件增加功能
 
-### 如何开始
+### 沟通语言规范
 
-- 加入本项目交流群，一同探讨项目相关事务
+- 在 PR 和 Commit Message 中请使用全英文
-- 解决本项目或衍生项目的issues中亟待解决的问题
+- 对于中文用户，issue 中可以使用中文
-- 阅读并完善本项目文档
+
-- 在各个社交媒体撰写本项目教程等
+<hr/>
+
+## Guidelines
+
+### Contribution
+
+- Submit PRs to solve bugs or features in the issues
+- Submit PRs to implement your ideas (Please create an issue first and communicate with the project maintainer)
+- Write articles or make videos about this project on other social platforms
+- Contribute to the development of derivative projects, or develop plugins to add features
+
+### Spoken Language
+
+- Use English in PRs and Commit Messages
+- For English users, you can use English in issues

Dockerfile

@@ -0,0 +1,23 @@
+FROM node:22-alpine AS node
+
+WORKDIR /app
+
+COPY web ./web
+
+RUN cd web && npm install && npm run build
+
+FROM python:3.12.7-slim
+
+WORKDIR /app
+
+COPY . .
+
+COPY --from=node /app/web/out ./web/out
+
+RUN apt update \
+    && apt install gcc -y \
+    && python -m pip install --no-cache-dir uv \
+    && uv sync \
+    && touch /.dockerenv
+
+CMD [ "uv", "run", "main.py" ]

LICENSE

@@ -1,661 +1,201 @@
-                    GNU AFFERO GENERAL PUBLIC LICENSE
+                                 Apache License
-                       Version 3, 19 November 2007
+                           Version 2.0, January 2004
-
+                        http://www.apache.org/licenses/
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
- Everyone is permitted to copy and distribute verbatim copies
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
- of this license document, but changing it is not allowed.
+
-
+   1. Definitions.
-                            Preamble
+
-
+      "License" shall mean the terms and conditions for use, reproduction,
-  The GNU Affero General Public License is a free, copyleft license for
+      and distribution as defined by Sections 1 through 9 of this document.
-software and other kinds of works, specifically designed to ensure
+
-cooperation with the community in the case of network server software.
+      "Licensor" shall mean the copyright owner or entity authorized by
-
+      the copyright owner that is granting the License.
-  The licenses for most software and other practical works are designed
+
-to take away your freedom to share and change the works.  By contrast,
+      "Legal Entity" shall mean the union of the acting entity and all
-our General Public Licenses are intended to guarantee your freedom to
+      other entities that control, are controlled by, or are under common
-share and change all versions of a program--to make sure it remains free
+      control with that entity. For the purposes of this definition,
-software for all its users.
+      "control" means (i) the power, direct or indirect, to cause the
-
+      direction or management of such entity, whether by contract or
-  When we speak of free software, we are referring to freedom, not
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-price.  Our General Public Licenses are designed to make sure that you
+      outstanding shares, or (iii) beneficial ownership of such entity.
-have the freedom to distribute copies of free software (and charge for
+
-them if you wish), that you receive source code or can get it if you
+      "You" (or "Your") shall mean an individual or Legal Entity
-want it, that you can change the software or use pieces of it in new
+      exercising permissions granted by this License.
-free programs, and that you know you can do these things.
+
-
+      "Source" form shall mean the preferred form for making modifications,
-  Developers that use our General Public Licenses protect your rights
+      including but not limited to software source code, documentation
-with two steps: (1) assert copyright on the software, and (2) offer
+      source, and configuration files.
-you this License which gives you legal permission to copy, distribute
+
-and/or modify the software.
+      "Object" form shall mean any form resulting from mechanical
-
+      transformation or translation of a Source form, including but
-  A secondary benefit of defending all users' freedom is that
+      not limited to compiled object code, generated documentation,
-improvements made in alternate versions of the program, if they
+      and conversions to other media types.
-receive widespread use, become available for other developers to
+
-incorporate.  Many developers of free software are heartened and
+      "Work" shall mean the work of authorship, whether in Source or
-encouraged by the resulting cooperation.  However, in the case of
+      Object form, made available under the License, as indicated by a
-software used on network servers, this result may fail to come about.
+      copyright notice that is included in or attached to the work
-The GNU General Public License permits making a modified version and
+      (an example is provided in the Appendix below).
-letting the public access it on a server without ever releasing its
+
-source code to the public.
+      "Derivative Works" shall mean any work, whether in Source or Object
-
+      form, that is based on (or derived from) the Work and for which the
-  The GNU Affero General Public License is designed specifically to
+      editorial revisions, annotations, elaborations, or other modifications
-ensure that, in such cases, the modified source code becomes available
+      represent, as a whole, an original work of authorship. For the purposes
-to the community.  It requires the operator of a network server to
+      of this License, Derivative Works shall not include works that remain
-provide the source code of the modified version running there to the
+      separable from, or merely link (or bind by name) to the interfaces of,
-users of that server.  Therefore, public use of a modified version, on
+      the Work and Derivative Works thereof.
-a publicly accessible server, gives the public access to the source
+
-code of the modified version.
+      "Contribution" shall mean any work of authorship, including
-
+      the original version of the Work and any modifications or additions
-  An older license, called the Affero General Public License and
+      to that Work or Derivative Works thereof, that is intentionally
-published by Affero, was designed to accomplish similar goals.  This is
+      submitted to Licensor for inclusion in the Work by the copyright owner
-a different license, not a version of the Affero GPL, but Affero has
+      or by an individual or Legal Entity authorized to submit on behalf of
-released a new version of the Affero GPL which permits relicensing under
+      the copyright owner. For the purposes of this definition, "submitted"
-this license.
+      means any form of electronic, verbal, or written communication sent
-
+      to the Licensor or its representatives, including but not limited to
-  The precise terms and conditions for copying, distribution and
+      communication on electronic mailing lists, source code control systems,
-modification follow.
+      and issue tracking systems that are managed by, or on behalf of, the
-
+      Licensor for the purpose of discussing and improving the Work, but
-                       TERMS AND CONDITIONS
+      excluding communication that is conspicuously marked or otherwise
-
+      designated in writing by the copyright owner as "Not a Contribution."
-  0. Definitions.
+
-
+      "Contributor" shall mean Licensor and any individual or Legal Entity
-  "This License" refers to version 3 of the GNU Affero General Public License.
+      on behalf of whom a Contribution has been received by Licensor and
-
+      subsequently incorporated within the Work.
-  "Copyright" also means copyright-like laws that apply to other kinds of
+
-works, such as semiconductor masks.
+   2. Grant of Copyright License. Subject to the terms and conditions of
-
+      this License, each Contributor hereby grants to You a perpetual,
-  "The Program" refers to any copyrightable work licensed under this
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-License.  Each licensee is addressed as "you".  "Licensees" and
+      copyright license to reproduce, prepare Derivative Works of,
-"recipients" may be individuals or organizations.
+      publicly display, publicly perform, sublicense, and distribute the
-
+      Work and such Derivative Works in Source or Object form.
-  To "modify" a work means to copy from or adapt all or part of the work
+
-in a fashion requiring copyright permission, other than the making of an
+   3. Grant of Patent License. Subject to the terms and conditions of
-exact copy.  The resulting work is called a "modified version" of the
+      this License, each Contributor hereby grants to You a perpetual,
-earlier work or a work "based on" the earlier work.
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-
+      (except as stated in this section) patent license to make, have made,
-  A "covered work" means either the unmodified Program or a work based
+      use, offer to sell, sell, import, and otherwise transfer the Work,
-on the Program.
+      where such license applies only to those patent claims licensable
-
+      by such Contributor that are necessarily infringed by their
-  To "propagate" a work means to do anything with it that, without
+      Contribution(s) alone or by combination of their Contribution(s)
-permission, would make you directly or secondarily liable for
+      with the Work to which such Contribution(s) was submitted. If You
-infringement under applicable copyright law, except executing it on a
+      institute patent litigation against any entity (including a
-computer or modifying a private copy.  Propagation includes copying,
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
-distribution (with or without modification), making available to the
+      or a Contribution incorporated within the Work constitutes direct
-public, and in some countries other activities as well.
+      or contributory patent infringement, then any patent licenses
-
+      granted to You under this License for that Work shall terminate
-  To "convey" a work means any kind of propagation that enables other
+      as of the date such litigation is filed.
-parties to make or receive copies.  Mere interaction with a user through
+
-a computer network, with no transfer of a copy, is not conveying.
+   4. Redistribution. You may reproduce and distribute copies of the
-
+      Work or Derivative Works thereof in any medium, with or without
-  An interactive user interface displays "Appropriate Legal Notices"
+      modifications, and in Source or Object form, provided that You
-to the extent that it includes a convenient and prominently visible
+      meet the following conditions:
-feature that (1) displays an appropriate copyright notice, and (2)
+
-tells the user that there is no warranty for the work (except to the
+      (a) You must give any other recipients of the Work or
-extent that warranties are provided), that licensees may convey the
+          Derivative Works a copy of this License; and
-work under this License, and how to view a copy of this License.  If
+
-the interface presents a list of user commands or options, such as a
+      (b) You must cause any modified files to carry prominent notices
-menu, a prominent item in the list meets this criterion.
+          stating that You changed the files; and
-
+
-  1. Source Code.
+      (c) You must retain, in the Source form of any Derivative Works
-
+          that You distribute, all copyright, patent, trademark, and
-  The "source code" for a work means the preferred form of the work
+          attribution notices from the Source form of the Work,
-for making modifications to it.  "Object code" means any non-source
+          excluding those notices that do not pertain to any part of
-form of a work.
+          the Derivative Works; and
-
+
-  A "Standard Interface" means an interface that either is an official
+      (d) If the Work includes a "NOTICE" text file as part of its
-standard defined by a recognized standards body, or, in the case of
+          distribution, then any Derivative Works that You distribute must
-interfaces specified for a particular programming language, one that
+          include a readable copy of the attribution notices contained
-is widely used among developers working in that language.
+          within such NOTICE file, excluding those notices that do not
-
+          pertain to any part of the Derivative Works, in at least one
-  The "System Libraries" of an executable work include anything, other
+          of the following places: within a NOTICE text file distributed
-than the work as a whole, that (a) is included in the normal form of
+          as part of the Derivative Works; within the Source form or
-packaging a Major Component, but which is not part of that Major
+          documentation, if provided along with the Derivative Works; or,
-Component, and (b) serves only to enable use of the work with that
+          within a display generated by the Derivative Works, if and
-Major Component, or to implement a Standard Interface for which an
+          wherever such third-party notices normally appear. The contents
-implementation is available to the public in source code form.  A
+          of the NOTICE file are for informational purposes only and
-"Major Component", in this context, means a major essential component
+          do not modify the License. You may add Your own attribution
-(kernel, window system, and so on) of the specific operating system
+          notices within Derivative Works that You distribute, alongside
-(if any) on which the executable work runs, or a compiler used to
+          or as an addendum to the NOTICE text from the Work, provided
-produce the work, or an object code interpreter used to run it.
+          that such additional attribution notices cannot be construed
-
+          as modifying the License.
-  The "Corresponding Source" for a work in object code form means all
+
-the source code needed to generate, install, and (for an executable
+      You may add Your own copyright statement to Your modifications and
-work) run the object code and to modify the work, including scripts to
+      may provide additional or different license terms and conditions
-control those activities.  However, it does not include the work's
+      for use, reproduction, or distribution of Your modifications, or
-System Libraries, or general-purpose tools or generally available free
+      for any such Derivative Works as a whole, provided Your use,
-programs which are used unmodified in performing those activities but
+      reproduction, and distribution of the Work otherwise complies with
-which are not part of the work.  For example, Corresponding Source
+      the conditions stated in this License.
-includes interface definition files associated with source files for
+
-the work, and the source code for shared libraries and dynamically
+   5. Submission of Contributions. Unless You explicitly state otherwise,
-linked subprograms that the work is specifically designed to require,
+      any Contribution intentionally submitted for inclusion in the Work
-such as by intimate data communication or control flow between those
+      by You to the Licensor shall be under the terms and conditions of
-subprograms and other parts of the work.
+      this License, without any additional terms or conditions.
-
+      Notwithstanding the above, nothing herein shall supersede or modify
-  The Corresponding Source need not include anything that users
+      the terms of any separate license agreement you may have executed
-can regenerate automatically from other parts of the Corresponding
+      with Licensor regarding such Contributions.
-Source.
+
-
+   6. Trademarks. This License does not grant permission to use the trade
-  The Corresponding Source for a work in source code form is that
+      names, trademarks, service marks, or product names of the Licensor,
-same work.
+      except as required for reasonable and customary use in describing the
-
+      origin of the Work and reproducing the content of the NOTICE file.
-  2. Basic Permissions.
+
-
+   7. Disclaimer of Warranty. Unless required by applicable law or
-  All rights granted under this License are granted for the term of
+      agreed to in writing, Licensor provides the Work (and each
-copyright on the Program, and are irrevocable provided the stated
+      Contributor provides its Contributions) on an "AS IS" BASIS,
-conditions are met.  This License explicitly affirms your unlimited
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-permission to run the unmodified Program.  The output from running a
+      implied, including, without limitation, any warranties or conditions
-covered work is covered by this License only if the output, given its
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-content, constitutes a covered work.  This License acknowledges your
+      PARTICULAR PURPOSE. You are solely responsible for determining the
-rights of fair use or other equivalent, as provided by copyright law.
+      appropriateness of using or redistributing the Work and assume any
-
+      risks associated with Your exercise of permissions under this License.
-  You may make, run and propagate covered works that you do not
+
-convey, without conditions so long as your license otherwise remains
+   8. Limitation of Liability. In no event and under no legal theory,
-in force.  You may convey covered works to others for the sole purpose
+      whether in tort (including negligence), contract, or otherwise,
-of having them make modifications exclusively for you, or provide you
+      unless required by applicable law (such as deliberate and grossly
-with facilities for running those works, provided that you comply with
+      negligent acts) or agreed to in writing, shall any Contributor be
-the terms of this License in conveying all material for which you do
+      liable to You for damages, including any direct, indirect, special,
-not control copyright.  Those thus making or running the covered works
+      incidental, or consequential damages of any character arising as a
-for you must do so exclusively on your behalf, under your direction
+      result of this License or out of the use or inability to use the
-and control, on terms that prohibit them from making any copies of
+      Work (including but not limited to damages for loss of goodwill,
-your copyrighted material outside their relationship with you.
+      work stoppage, computer failure or malfunction, or any and all
-
+      other commercial damages or losses), even if such Contributor
-  Conveying under any other circumstances is permitted solely under
+      has been advised of the possibility of such damages.
-the conditions stated below.  Sublicensing is not allowed; section 10
+
-makes it unnecessary.
+   9. Accepting Warranty or Additional Liability. While redistributing
-
+      the Work or Derivative Works thereof, You may choose to offer,
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+      and charge a fee for, acceptance of support, warranty, indemnity,
-
+      or other liability obligations and/or rights consistent with this
-  No covered work shall be deemed part of an effective technological
+      License. However, in accepting such obligations, You may act only
-measure under any applicable law fulfilling obligations under article
+      on Your own behalf and on Your sole responsibility, not on behalf
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
+      of any other Contributor, and only if You agree to indemnify,
-similar laws prohibiting or restricting circumvention of such
+      defend, and hold each Contributor harmless for any liability
-measures.
+      incurred by, or claims asserted against, such Contributor by reason
-
+      of your accepting any such warranty or additional liability.
-  When you convey a covered work, you waive any legal power to forbid
+
-circumvention of technological measures to the extent such circumvention
+   END OF TERMS AND CONDITIONS
-is effected by exercising rights under this License with respect to
+
-the covered work, and you disclaim any intention to limit operation or
+   APPENDIX: How to apply the Apache License to your work.
-modification of the work as a means of enforcing, against the work's
+
-users, your or third parties' legal rights to forbid circumvention of
+      To apply the Apache License to your work, attach the following
-technological measures.
+      boilerplate notice, with the fields enclosed by brackets "[]"
-
+      replaced with your own identifying information. (Don't include
-  4. Conveying Verbatim Copies.
+      the brackets!)  The text should be enclosed in the appropriate
-
+      comment syntax for the file format. We also recommend that a
-  You may convey verbatim copies of the Program's source code as you
+      file or class name and description of purpose be included on the
-receive it, in any medium, provided that you conspicuously and
+      same "printed page" as the copyright notice for easier
-appropriately publish on each copy an appropriate copyright notice;
+      identification within third-party archives.
-keep intact all notices stating that this License and any
+
-non-permissive terms added in accord with section 7 apply to the code;
+   Copyright [yyyy] [name of copyright owner]
-keep intact all notices of the absence of any warranty; and give all
+
-recipients a copy of this License along with the Program.
+   Licensed under the Apache License, Version 2.0 (the "License");
-
+   you may not use this file except in compliance with the License.
-  You may charge any price or no price for each copy that you convey,
+   You may obtain a copy of the License at
-and you may offer support or warranty protection for a fee.
+
-
+       http://www.apache.org/licenses/LICENSE-2.0
-  5. Conveying Modified Source Versions.
+
-
+   Unless required by applicable law or agreed to in writing, software
-  You may convey a work based on the Program, or the modifications to
+   distributed under the License is distributed on an "AS IS" BASIS,
-produce it from the Program, in the form of source code under the
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-terms of section 4, provided that you also meet all of these conditions:
+   See the License for the specific language governing permissions and
-
+   limitations under the License.
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Remote Network Interaction; Use with the GNU General Public License.
-
-  Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software.  This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time.  Such new versions
-will be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as published
-    by the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU Affero General Public License for more details.
-
-    You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source.  For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code.  There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-<https://www.gnu.org/licenses/>.

README.md

@@ -1,236 +1,170 @@
-# QChatGPT🤖
-> 2023/3/3  官方接口疑似被墙，可考虑使用网络代理 [#198](https://github.com/RockChinQ/QChatGPT/issues/198)  
-> 2023/3/3  现已在主线支持官方ChatGPT接口，使用方法查看[#195](https://github.com/RockChinQ/QChatGPT/issues/195)  
-> 2023/3/2  OpenAI已发布ChatGPT官方接口，我们正在全力接入，预计明日前完成，请查看[此PR](https://github.com/RockChinQ/QChatGPT/pull/194)  
-> 2023/2/16 现已支持接入ChatGPT网页版，详情请完成部署并查看底部**插件**小节或[此仓库](https://github.com/RockChinQ/revLibs)
 
-- 到[项目Wiki](https://github.com/RockChinQ/QChatGPT/wiki)可了解项目详细信息
+<p align="center">
-- 由bilibili TheLazy制作的[视频教程](https://www.bilibili.com/video/BV15v4y1X7aP)
+<a href="https://langbot.app">
-- 交流、答疑群: ~~204785790~~（已满）、~~691226829~~（已满）、656285629  
+<img src="https://docs.langbot.app/social_zh.png" alt="LangBot"/>
-  - **进群提问前请您`确保`已经找遍文档和issue均无法解决**  
+</a>
-- QQ频道机器人见[QQChannelChatGPT](https://github.com/Soulter/QQChannelChatGPT)
 
-通过调用OpenAI的ChatGPT等语言模型来实现一个更加智能的QQ机器人  
+<div align="center">
 
-## 🍺模型适配一览
+<a href="https://hellogithub.com/repository/langbot-app/LangBot" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=5ce8ae2aa4f74316bf393b57b952433c&claim_uid=gtmc6YWjMZkT21R" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
 
-### 文字对话
+[English](README_EN.md) / 简体中文 / [繁體中文](README_TW.md) / [日本語](README_JP.md) / (PR for your language)
 
-- OpenAI GPT-3.5模型(ChatGPT API), 本项目原生支持, 默认使用
+[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87)
-- OpenAI GPT-3模型, 本项目原生支持, 部署完成后前往config.py切换
+[![QQ Group](https://img.shields.io/badge/%E7%A4%BE%E5%8C%BAQQ%E7%BE%A4-966235608-blue)](https://qm.qq.com/q/JLi38whHum)
-- ChatGPT网页版逆向API, 由[插件](https://github.com/RockChinQ/revLibs)接入
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/langbot-app/LangBot)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/langbot-app/LangBot)](https://github.com/langbot-app/LangBot/releases/latest)
+<img src="https://img.shields.io/badge/python-3.10 ~ 3.13 -blue.svg" alt="python">
+[![star](https://gitcode.com/RockChinQ/LangBot/star/badge.svg)](https://gitcode.com/RockChinQ/LangBot)
 
-### 故事续写
+<a href="https://langbot.app">项目主页</a> ｜
+<a href="https://docs.langbot.app/zh/insight/guide.html">部署文档</a> ｜
+<a href="https://docs.langbot.app/zh/plugin/plugin-intro.html">插件介绍</a> ｜
+<a href="https://github.com/langbot-app/LangBot/issues/new?assignees=&labels=%E7%8B%AC%E7%AB%8B%E6%8F%92%E4%BB%B6&projects=&template=submit-plugin.yml&title=%5BPlugin%5D%3A+%E8%AF%B7%E6%B1%82%E7%99%BB%E8%AE%B0%E6%96%B0%E6%8F%92%E4%BB%B6">提交插件</a>
 
-- NovelAI API, 由[插件](https://github.com/dominoar/QCPNovelAi)接入
 
-### 图片绘制
+</div>
 
-- OpenAI DALL·E模型, 本项目原生支持, 使用方法查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E5%8A%9F%E8%83%BD%E7%82%B9%E5%88%97%E4%B8%BE)
+</p>
-- NovelAI API, 由[插件](https://github.com/dominoar/QCPNovelAi)接入
 
-### 语音生成
+LangBot 是一个开源的大语言模型原生即时通信机器人开发平台，旨在提供开箱即用的 IM 机器人开发体验，具有 Agent、RAG、MCP 等多种 LLM 应用功能，适配全球主流即时通信平台，并提供丰富的 API 接口，支持自定义开发。
 
-- TTS+VITS, 由[插件](https://github.com/dominoar/QChatPlugins)接入
+## 📦 开始使用
 
-## ✅功能
+#### 快速部署
 
-<details>
+使用 `uvx` 一键启动（需要先安装 [uv](https://docs.astral.sh/uv/getting-started/installation/)）：
-<summary>✅支持敏感词过滤，避免账号风险</summary>
-
-  - 难以监测机器人与用户对话时的内容，故引入此功能以减少机器人风险
-  - 加入了百度云内容审核，在`config.py`中修改`baidu_check`的值，并填写`baidu_api_key`和`baidu_secret_key`以开启此功能
-  - 编辑`sensitive.json`，并在`config.py`中修改`sensitive_word_filter`的值以开启此功能
-</details>
-
-<details>
-<summary>✅群内多种响应规则，不必at</summary>
-
-  - 默认回复`ai`作为前缀或`@`机器人的消息
-  - 详细见`config.py`中的`response_rules`字段
-</details>
-
-<details>
-<summary>✅完善的多api-key管理，超额自动切换</summary>
-
-  - 支持配置多个`api-key`，内部统计使用量并在超额时自动切换
-  - 请在`config.py`中修改`openai_config`的值以设置`api-key`
-  - 可以在`config.py`中修改`api_key_fee_threshold`来自定义切换阈值
-  - 运行期间向机器人说`!usage`以查看当前使用情况
-</details>
-
-<details>
-<summary>✅支持预设指令文字</summary>
-
-  - 支持以自然语言预设文字，自定义机器人人格等信息
-  - 详见`config.py`中的`default_prompt`部分
-  - 支持设置多个预设情景，并通过!reset、!default等指令控制，详细请查看[wiki指令](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4)
-</details>
-
-<details>
-<summary>✅支持对话、绘图等模型，可玩性更高</summary>
-
-  - 现已支持OpenAI的对话`Completion API`和绘图`Image API`
-  - 向机器人发送指令`!draw <prompt>`即可使用绘图模型
-</details>
-<details>
-<summary>✅支持指令控制热重载、热更新</summary>
-
-  - 允许在运行期间修改`config.py`或其他代码后，以管理员账号向机器人发送指令`!reload`进行热重载，无需重启
-  - 运行期间允许以管理员账号向机器人发送指令`!update`进行热更新，拉取远程最新代码并执行热重载
-</details>
-<details>
-<summary>✅支持插件加载🧩</summary>
-
-  - 自行实现插件加载器及相关支持
-  - 详细查看[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8)
-</details>
-<details>
-<summary>✅私聊、群聊黑名单机制</summary>
-
-  - 支持将人或群聊加入黑名单以忽略其消息
-  - 详见Wiki`加入黑名单`节
-</details>
-<details>
-<summary>✅长消息处理策略</summary>
-
-  - 支持将长消息转换成图片或消息记录组件，避免消息刷屏
-  - 请查看`config.py`中`blob_message_strategy`等字段
-</details>
-<details>
-<summary>✅回复速度限制</summary>
-
-  - 支持限制单会话内每分钟可进行的对话次数
-  - 具有“等待”和“丢弃”两种策略
-    - “等待”策略：在获取到回复后，等待直到此次响应时间达到对话响应时间均值
-    - “丢弃”策略：此分钟内对话次数达到限制时，丢弃之后的对话
-  - 详细请查看config.py中的相关配置
-</details>
-
-详情请查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E5%8A%9F%E8%83%BD%E7%82%B9%E5%88%97%E4%B8%BE)
-
-## 🔩部署
-
-**部署过程中遇到任何问题，请先在[QChatGPT](https://github.com/RockChinQ/QChatGPT/issues)或[qcg-installer](https://github.com/RockChinQ/qcg-installer/issues)的issue里进行搜索**
-
-### - 注册OpenAI账号
-
-参考以下文章自行注册
-
-> [国内注册ChatGPT的方法(100%可用)](https://www.pythonthree.com/register-openai-chatgpt/)
-> [手把手教你如何注册ChatGPT，超级详细](https://guxiaobei.com/51461)
-
-注册成功后请前往[个人中心查看](https://beta.openai.com/account/api-keys)api_key  
-完成注册后，使用以下自动化或手动部署步骤
-
-### - 自动化部署
-
-<details>
-<summary>展开查看，以下方式二选一，Linux首选Docker，Windows首选安装器</summary>
-
-#### Docker方式
-
-请查看此仓库[mikumifa/QChatGPT-Docker-Installer](https://github.com/mikumifa/QChatGPT-Docker-Installer)
-
-#### 安装器方式
-使用[此安装器](https://github.com/RockChinQ/qcg-installer)（若无法访问请到[Gitee](https://gitee.com/RockChin/qcg-installer)）进行部署
-
-- 安装器目前仅支持部分平台，请到仓库文档查看，其他平台请手动部署
-
-</details>
-
-### - 手动部署
-<details>
-<summary>手动部署适用于所有平台</summary>
-
-- 请使用Python 3.9.x以上版本   
-
-#### 配置Mirai
-
-按照[此教程](https://yiri-mirai.wybxc.cc/tutorials/01/configuration)配置Mirai及YiriMirai  
-启动mirai-console后，使用`login`命令登录QQ账号，保持mirai-console运行状态
-
-#### 配置主程序
-
-1. 克隆此项目
 
 ```bash
-git clone https://github.com/RockChinQ/QChatGPT
+uvx langbot
-cd QChatGPT
 ```
 
-2. 安装依赖
+访问 http://localhost:5300 即可开始使用。
+
+#### Docker Compose 部署
 
 ```bash
-pip3 install yiri-mirai openai colorlog func_timeout
+git clone https://github.com/langbot-app/LangBot
-pip3 install dulwich
+cd LangBot/docker
+docker compose up -d
 ```
 
-3. 运行一次主程序，生成配置文件
+访问 http://localhost:5300 即可开始使用。
 
-```bash
+详细文档[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。
-python3 main.py
-```
 
-4. 编辑配置文件`config.py`
+#### 宝塔面板部署
 
-按照文件内注释填写配置信息
+已上架宝塔面板，若您已安装宝塔面板，可以根据[文档](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html)使用。
 
-5. 运行主程序
+#### Zeabur 云部署
 
-```bash
+社区贡献的 Zeabur 模板。
-python3 main.py
-```
 
-无报错信息即为运行成功
+[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH)
 
-**常见问题**
+#### Railway 云部署
 
-- mirai登录提示`QQ版本过低`，见[此issue](https://github.com/RockChinQ/QChatGPT/issues/137)
+[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF)
-- 如提示安装`uvicorn`或`hypercorn`请*不要*安装，这两个不是必需的，目前存在未知原因bug
-- 如报错`TypeError: As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary`, 请参考 [此处](https://github.com/RockChinQ/QChatGPT/issues/5)
 
-</details>
+#### 手动部署
 
-## 🚀使用
+直接使用发行版运行，查看文档[手动部署](https://docs.langbot.app/zh/deploy/langbot/manual.html)。
 
-查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E4%BD%BF%E7%94%A8%E6%96%B9%E5%BC%8F)
+#### Kubernetes 部署
 
-## 🧩插件生态
+参考 [Kubernetes 部署](./docker/README_K8S.md) 文档。
 
-现已支持自行开发插件对功能进行扩展或自定义程序行为  
+## 😎 保持更新
-详见[Wiki插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8)  
-开发教程见[Wiki插件开发页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91)
 
-### 示例插件
+点击仓库右上角 Star 和 Watch 按钮，获取最新动态。
 
-在`tests/plugin_examples`目录下，将其整个目录复制到`plugins`目录下即可使用
+![star gif](https://docs.langbot.app/star.gif)
 
-- `cmdcn` - 主程序指令中文形式
+## ✨ 特性
-- `hello_plugin` - 在收到消息`hello`时回复相应消息
-- `urlikethisijustsix` - 收到冒犯性消息时回复相应消息
 
-### 更多
+- 💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态、流式输出能力，自带 RAG（知识库）实现，并深度适配 [Dify](https://dify.ai)。
+- 🤖 多平台支持：目前支持 QQ、QQ频道、企业微信、个人微信、飞书、Discord、Telegram 等平台。
+- 🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。支持多流水线配置，不同机器人用于不同应用场景。
+- 🧩 插件扩展、活跃社区：支持事件驱动、组件扩展等插件机制；适配 Anthropic [MCP 协议](https://modelcontextprotocol.io/)；目前已有数百个插件。
+- 😻 Web 管理面板：支持通过浏览器管理 LangBot 实例，不再需要手动编写配置文件。
 
-欢迎提交新的插件
+详细规格特性请访问[文档](https://docs.langbot.app/zh/insight/features.html)。
 
-- [revLibs](https://github.com/RockChinQ/revLibs) - 将ChatGPT网页版接入此项目，关于[官方接口和网页版有什么区别](https://github.com/RockChinQ/QChatGPT/wiki/%E5%AE%98%E6%96%B9%E6%8E%A5%E5%8F%A3%E4%B8%8EChatGPT%E7%BD%91%E9%A1%B5%E7%89%88)
+或访问 demo 环境：https://demo.langbot.dev/  
-- [hello_plugin](https://github.com/RockChinQ/hello_plugin) - `hello_plugin` 的储存库形式，插件开发模板
+  - 登录信息：邮箱：`demo@langbot.app` 密码：`langbot123456`
-- [dominoar/QChatPlugins](https://github.com/dominoar/QchatPlugins) - dominoar编写的诸多新功能插件（语言输出、Ranimg、屏蔽词规则等）
+  - 注意：仅展示 WebUI 效果，公开环境，请不要在其中填入您的任何敏感信息。
-- [dominoar/QCP-NovelAi](https://github.com/dominoar/QCP-NovelAi) - NovelAI 故事叙述与绘画
 
-## 😘致谢
+### 消息平台
 
-- [@the-lazy-me](https://github.com/the-lazy-me) 为本项目制作[视频教程](https://www.bilibili.com/video/BV15v4y1X7aP)
+| 平台 | 状态 | 备注 |
-- [@mikumifa](https://github.com/mikumifa) 本项目Docker部署仓库开发者
+| --- | --- | --- |
-- [@dominoar](https://github.com/dominoar) 为本项目开发多种插件
+| QQ 个人号 | ✅ | QQ 个人号私聊、群聊 |
-- [@hissincn](https://github.com/hissincn) 本项目贡献者
+| QQ 官方机器人 | ✅ | QQ 官方机器人，支持频道、私聊、群聊 |
-- [@LINSTCL](https://github.com/LINSTCL)   GPT-3.5官方模型适配贡献者
+| 企业微信 | ✅ |  |
-- [@Haibersut](https://github.com/Haibersut)  本项目贡献者
+| 企微对外客服 | ✅ |  |
-- [@万神的星空](https://github.com/qq255204159)  整合包发行
+| 企微智能机器人 | ✅ |  |
+| 个人微信 | ✅ |  |
+| 微信公众号 | ✅ |  |
+| 飞书 | ✅ |  |
+| 钉钉 | ✅ |  |
+| Discord | ✅ |  |
+| Telegram | ✅ |  |
+| Slack | ✅ |  |
+| LINE | ✅ |  |
 
-以及其他所有为本项目提供支持的朋友们。
+### 大模型能力
 
-## 👍赞赏
+| 模型 | 状态 | 备注 |
+| --- | --- | --- |
+| [OpenAI](https://platform.openai.com/) | ✅ | 可接入任何 OpenAI 接口格式模型 |
+| [DeepSeek](https://www.deepseek.com/) | ✅ |  |
+| [Moonshot](https://www.moonshot.cn/) | ✅ |  |
+| [Anthropic](https://www.anthropic.com/) | ✅ |  |
+| [xAI](https://x.ai/) | ✅ |  |
+| [智谱AI](https://open.bigmodel.cn/) | ✅ |  |
+| [胜算云](https://www.shengsuanyun.com/?from=CH_KYIPP758) | ✅ | 全球大模型都可调用（友情推荐） |
+| [优云智算](https://www.compshare.cn/?ytag=GPU_YY-gh_langbot) | ✅ | 大模型和 GPU 资源平台 |
+| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型和 GPU 资源平台 |
+| [接口 AI](https://jiekou.ai/) | ✅ | 大模型聚合平台，专注全球大模型接入 |
+| [302.AI](https://share.302.ai/SuTG99) | ✅ | 大模型聚合平台 |
+| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | |
+| [Dify](https://dify.ai) | ✅ | LLMOps 平台 |
+| [Ollama](https://ollama.com/) | ✅ | 本地大模型运行平台 |
+| [LMStudio](https://lmstudio.ai/) | ✅ | 本地大模型运行平台 |
+| [GiteeAI](https://ai.gitee.com/) | ✅ | 大模型接口聚合平台 |
+| [SiliconFlow](https://siliconflow.cn/) | ✅ | 大模型聚合平台 |
+| [小马算力](https://www.tokenpony.cn/453z1) | ✅ | 大模型聚合平台 |
+| [阿里云百炼](https://bailian.console.aliyun.com/) | ✅ | 大模型聚合平台, LLMOps 平台 |
+| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | 大模型聚合平台, LLMOps 平台 |
+| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | 大模型聚合平台 |
+| [MCP](https://modelcontextprotocol.io/) | ✅ | 支持通过 MCP 协议获取工具 |
+| [百宝箱Tbox](https://www.tbox.cn/open) | ✅ | 蚂蚁百宝箱智能体平台，每月免费10亿大模型Token |
 
-<img alt="赞赏码" src="res/mm_reward_qrcode_1672840549070.png" width="400" height="400"/>
+### TTS
+
+| 平台/模型 | 备注 |
+| --- | --- |
+| [FishAudio](https://fish.audio/zh-CN/discovery/) | [插件](https://github.com/the-lazy-me/NewChatVoice) |
+| [海豚 AI](https://www.ttson.cn/?source=thelazy) | [插件](https://github.com/the-lazy-me/NewChatVoice) |
+| [AzureTTS](https://portal.azure.com/) | [插件](https://github.com/Ingnaryk/LangBot_AzureTTS) |
+
+### 文生图
+
+| 平台/模型 | 备注 |
+| --- | --- |
+| 阿里云百炼 | [插件](https://github.com/Thetail001/LangBot_BailianTextToImagePlugin)
+
+## 😘 社区贡献
+
+感谢以下[代码贡献者](https://github.com/langbot-app/LangBot/graphs/contributors)和社区里其他成员对 LangBot 的贡献：
+
+<a href="https://github.com/langbot-app/LangBot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=langbot-app/LangBot" />
+</a>
+
+<!--
+## For Code Agents
+
+If you're a code agent based on LLM, you should read [AGENTS.md](AGENTS.md) to understand the project structure and development process before you start any development.
+-->

README_EN.md

@@ -0,0 +1,141 @@
+<p align="center">
+<a href="https://langbot.app">
+<img src="https://docs.langbot.app/social_en.png" alt="LangBot"/>
+</a>
+
+<div align="center">
+
+English / [简体中文](README.md) / [繁體中文](README_TW.md) / [日本語](README_JP.md) / (PR for your language)
+
+[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/langbot-app/LangBot)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/langbot-app/LangBot)](https://github.com/langbot-app/LangBot/releases/latest)
+<img src="https://img.shields.io/badge/python-3.10 ~ 3.13 -blue.svg" alt="python">
+
+<a href="https://langbot.app">Home</a> ｜
+<a href="https://docs.langbot.app/en/insight/guide.html">Deployment</a> ｜
+<a href="https://docs.langbot.app/en/plugin/plugin-intro.html">Plugin</a> ｜
+<a href="https://github.com/langbot-app/LangBot/issues/new?assignees=&labels=%E7%8B%AC%E7%AB%8B%E6%8F%92%E4%BB%B6&projects=&template=submit-plugin.yml&title=%5BPlugin%5D%3A+%E8%AF%B7%E6%B1%82%E7%99%BB%E8%AE%B0%E6%96%B0%E6%8F%92%E4%BB%B6">Submit Plugin</a>
+
+</div>
+
+</p>
+
+LangBot is an open-source LLM native instant messaging robot development platform, aiming to provide out-of-the-box IM robot development experience, with Agent, RAG, MCP and other LLM application functions, adapting to global instant messaging platforms, and providing rich API interfaces, supporting custom development.
+
+## 📦 Getting Started
+
+#### Quick Start
+
+Use `uvx` to start with one command (need to install [uv](https://docs.astral.sh/uv/getting-started/installation/)):
+
+```bash
+uvx langbot
+```
+
+Visit http://localhost:5300 to start using it.
+
+#### Docker Compose Deployment
+
+```bash
+git clone https://github.com/langbot-app/LangBot
+cd LangBot/docker
+docker compose up -d
+```
+
+Visit http://localhost:5300 to start using it.
+
+Detailed documentation [Docker Deployment](https://docs.langbot.app/en/deploy/langbot/docker.html).
+
+#### One-click Deployment on BTPanel
+
+LangBot has been listed on the BTPanel, if you have installed the BTPanel, you can use the [document](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html) to use it.
+
+#### Zeabur Cloud Deployment
+
+Community contributed Zeabur template.
+
+[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH)
+
+#### Railway Cloud Deployment
+
+[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF)
+
+#### Other Deployment Methods
+
+Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/en/deploy/langbot/manual.html) documentation.
+
+#### Kubernetes Deployment
+
+Refer to the [Kubernetes Deployment](./docker/README_K8S.md) documentation.
+
+## 😎 Stay Ahead
+
+Click the Star and Watch button in the upper right corner of the repository to get the latest updates.
+
+![star gif](https://docs.langbot.app/star.gif)
+
+## ✨ Features
+
+- 💬 Chat with LLM / Agent: Supports multiple LLMs, adapt to group chats and private chats; Supports multi-round conversations, tool calls, multi-modal, and streaming output capabilities. Built-in RAG (knowledge base) implementation, and deeply integrates with [Dify](https://dify.ai).
+- 🤖 Multi-platform Support: Currently supports QQ, QQ Channel, WeCom, personal WeChat, Lark, DingTalk, Discord, Telegram, etc.
+- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. Supports multiple pipeline configurations, different bots can be used for different scenarios.
+- 🧩 Plugin Extension, Active Community: Support event-driven, component extension, etc. plugin mechanisms; Integrate Anthropic [MCP protocol](https://modelcontextprotocol.io/); Currently has hundreds of plugins.
+- 😻 Web UI: Support management LangBot instance through the browser. No need to manually write configuration files.
+
+For more detailed specifications, please refer to the [documentation](https://docs.langbot.app/en/insight/features.html).
+
+Or visit the demo environment: https://demo.langbot.dev/
+  - Login information: Email: `demo@langbot.app` Password: `langbot123456`
+  - Note: For WebUI demo only, please do not fill in any sensitive information in the public environment.
+
+### Message Platform
+
+| Platform | Status | Remarks |
+| --- | --- | --- |
+| Discord | ✅ |  |
+| Telegram | ✅ |  |
+| Slack | ✅ |  |
+| LINE | ✅ |  |
+| Personal QQ | ✅ |  |
+| QQ Official API | ✅ |  |
+| WeCom | ✅ |  |
+| WeComCS | ✅ |  |
+| WeCom AI Bot | ✅ |  |
+| Personal WeChat | ✅ |  |
+| Lark | ✅ |  |
+| DingTalk | ✅ |  |
+
+### LLMs
+
+| LLM | Status | Remarks |
+| --- | --- | --- |
+| [OpenAI](https://platform.openai.com/) | ✅ | Available for any OpenAI interface format model |
+| [DeepSeek](https://www.deepseek.com/) | ✅ |  |
+| [Moonshot](https://www.moonshot.cn/) | ✅ |  |
+| [Anthropic](https://www.anthropic.com/) | ✅ |  |
+| [xAI](https://x.ai/) | ✅ |  |
+| [Zhipu AI](https://open.bigmodel.cn/) | ✅ |  |
+| [CompShare](https://www.compshare.cn/?ytag=GPU_YY-gh_langbot) | ✅ | LLM and GPU resource platform |
+| [Dify](https://dify.ai) | ✅ | LLMOps platform |
+| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | LLM and GPU resource platform |
+| [接口 AI](https://jiekou.ai/) | ✅ | LLM aggregation platform, dedicated to global LLMs |
+| [ShengSuanYun](https://www.shengsuanyun.com/?from=CH_KYIPP758) | ✅ | LLM and GPU resource platform |
+| [302.AI](https://share.302.ai/SuTG99) | ✅ | LLM gateway(MaaS) |
+| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | |
+| [Ollama](https://ollama.com/) | ✅ | Local LLM running platform |
+| [LMStudio](https://lmstudio.ai/) | ✅ | Local LLM running platform |
+| [GiteeAI](https://ai.gitee.com/) | ✅ | LLM interface gateway(MaaS) |
+| [SiliconFlow](https://siliconflow.cn/) | ✅ | LLM gateway(MaaS) |
+| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLM gateway(MaaS), LLMOps platform |
+| [Volc Engine Ark](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | LLM gateway(MaaS), LLMOps platform |
+| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | LLM gateway(MaaS) |
+| [MCP](https://modelcontextprotocol.io/) | ✅ | Support tool access through MCP protocol |
+
+## 🤝 Community Contribution
+
+Thank you for the following [code contributors](https://github.com/langbot-app/LangBot/graphs/contributors) and other members in the community for their contributions to LangBot:
+
+<a href="https://github.com/langbot-app/LangBot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=langbot-app/LangBot" />
+</a>

README_JP.md

@@ -0,0 +1,141 @@
+<p align="center">
+<a href="https://langbot.app">
+<img src="https://docs.langbot.app/social_en.png" alt="LangBot"/>
+</a>
+
+<div align="center">
+
+[English](README_EN.md) / [简体中文](README.md) / [繁體中文](README_TW.md) / 日本語 / (PR for your language)
+
+[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/langbot-app/LangBot)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/langbot-app/LangBot)](https://github.com/langbot-app/LangBot/releases/latest)
+<img src="https://img.shields.io/badge/python-3.10 ~ 3.13 -blue.svg" alt="python">
+
+<a href="https://langbot.app">ホーム</a> ｜
+<a href="https://docs.langbot.app/en/insight/guide.html">デプロイ</a> ｜
+<a href="https://docs.langbot.app/en/plugin/plugin-intro.html">プラグイン</a> ｜
+<a href="https://github.com/langbot-app/LangBot/issues/new?assignees=&labels=%E7%8B%AC%E7%AB%8B%E6%8F%92%E4%BB%B6&projects=&template=submit-plugin.yml&title=%5BPlugin%5D%3A+%E8%AF%B7%E6%B1%82%E7%99%BB%E8%AE%B0%E6%96%B0%E6%8F%92%E4%BB%B6">プラグインの提出</a>
+
+</div>
+
+</p>
+
+LangBot は、エージェント、RAG、MCP などの LLM アプリケーション機能を備えた、オープンソースの LLM ネイティブのインスタントメッセージングロボット開発プラットフォームです。世界中のインスタントメッセージングプラットフォームに適応し、豊富な API インターフェースを提供し、カスタム開発をサポートします。
+
+## 📦 始め方
+
+#### クイックスタート
+
+`uvx` を使用した迅速なデプロイ（[uv](https://docs.astral.sh/uv/getting-started/installation/) が必要です）：
+
+```bash
+uvx langbot
+```
+
+http://localhost:5300 にアクセスして使用を開始します。
+
+#### Docker Compose デプロイ
+
+```bash
+git clone https://github.com/langbot-app/LangBot
+cd LangBot/docker
+docker compose up -d
+```
+
+http://localhost:5300 にアクセスして使用を開始します。
+
+詳細なドキュメントは[Dockerデプロイ](https://docs.langbot.app/en/deploy/langbot/docker.html)を参照してください。
+
+#### Panelでのワンクリックデプロイ
+
+LangBotはBTPanelにリストされています。BTPanelをインストールしている場合は、[ドキュメント](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html)を使用して使用できます。
+
+#### Zeaburクラウドデプロイ
+
+コミュニティが提供するZeaburテンプレート。
+
+[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH)
+
+#### Railwayクラウドデプロイ
+
+[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF)
+
+#### その他のデプロイ方法
+
+リリースバージョンを直接使用して実行します。[手動デプロイ](https://docs.langbot.app/en/deploy/langbot/manual.html)のドキュメントを参照してください。
+
+#### Kubernetes デプロイ
+
+[Kubernetes デプロイ](./docker/README_K8S.md) ドキュメントを参照してください。
+
+## 😎 最新情報を入手
+
+リポジトリの右上にある Star と Watch ボタンをクリックして、最新の更新を取得してください。
+
+![star gif](https://docs.langbot.app/star.gif)
+
+## ✨ 機能
+
+- 💬 LLM / エージェントとのチャット: 複数のLLMをサポートし、グループチャットとプライベートチャットに対応。マルチラウンドの会話、ツールの呼び出し、マルチモーダル、ストリーミング出力機能をサポート、RAG（知識ベース）を組み込み、[Dify](https://dify.ai) と深く統合。
+- 🤖 多プラットフォーム対応: 現在、QQ、QQ チャンネル、WeChat、個人 WeChat、Lark、DingTalk、Discord、Telegram など、複数のプラットフォームをサポートしています。
+- 🛠️ 高い安定性、豊富な機能: ネイティブのアクセス制御、レート制限、敏感な単語のフィルタリングなどのメカニズムをサポート。使いやすく、複数のデプロイ方法をサポート。複数のパイプライン設定をサポートし、異なるボットを異なる用途に使用できます。
+- 🧩 プラグイン拡張、活発なコミュニティ: イベント駆動、コンポーネント拡張などのプラグインメカニズムをサポート。適配 Anthropic [MCP プロトコル](https://modelcontextprotocol.io/)；豊富なエコシステム、現在数百のプラグインが存在。
+- 😻 Web UI: ブラウザを通じてLangBotインスタンスを管理することをサポート。
+
+詳細な仕様については、[ドキュメント](https://docs.langbot.app/en/insight/features.html)を参照してください。
+
+または、デモ環境にアクセスしてください: https://demo.langbot.dev/
+  - ログイン情報: メール: `demo@langbot.app` パスワード: `langbot123456`
+  - 注意: WebUI のデモンストレーションのみの場合、公開環境では機密情報を入力しないでください。
+
+### メッセージプラットフォーム
+
+| プラットフォーム | ステータス | 備考 |
+| --- | --- | --- |
+| Discord | ✅ |  |
+| Telegram | ✅ |  |
+| Slack | ✅ |  |
+| LINE | ✅ |  |
+| 個人QQ | ✅ |  |
+| QQ公式API | ✅ |  |
+| WeCom | ✅ |  |
+| WeComCS | ✅ |  |
+| WeCom AI Bot | ✅ |  |
+| 個人WeChat | ✅ | |
+| Lark | ✅ |  |
+| DingTalk | ✅ |  |
+
+### LLMs
+
+| LLM | ステータス | 備考 |
+| --- | --- | --- |
+| [OpenAI](https://platform.openai.com/) | ✅ | 任意のOpenAIインターフェース形式モデルに対応 |
+| [DeepSeek](https://www.deepseek.com/) | ✅ |  |
+| [Moonshot](https://www.moonshot.cn/) | ✅ |  |
+| [Anthropic](https://www.anthropic.com/) | ✅ |  |
+| [xAI](https://x.ai/) | ✅ |  |
+| [Zhipu AI](https://open.bigmodel.cn/) | ✅ |  |
+| [CompShare](https://www.compshare.cn/?ytag=GPU_YY-gh_langbot) | ✅ | 大模型とGPUリソースプラットフォーム |
+| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型とGPUリソースプラットフォーム |
+| [接口 AI](https://jiekou.ai/) | ✅ | LLMゲートウェイ(MaaS) |
+| [ShengSuanYun](https://www.shengsuanyun.com/?from=CH_KYIPP758) | ✅ | LLMとGPUリソースプラットフォーム |
+| [302.AI](https://share.302.ai/SuTG99) | ✅ | LLMゲートウェイ(MaaS) |
+| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | |
+| [Dify](https://dify.ai) | ✅ | LLMOpsプラットフォーム |
+| [Ollama](https://ollama.com/) | ✅ | ローカルLLM実行プラットフォーム |
+| [LMStudio](https://lmstudio.ai/) | ✅ | ローカルLLM実行プラットフォーム |
+| [GiteeAI](https://ai.gitee.com/) | ✅ | LLMインターフェースゲートウェイ(MaaS) |
+| [SiliconFlow](https://siliconflow.cn/) | ✅ | LLMゲートウェイ(MaaS) |
+| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLMゲートウェイ(MaaS), LLMOpsプラットフォーム |
+| [Volc Engine Ark](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | LLMゲートウェイ(MaaS), LLMOpsプラットフォーム |
+| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | LLMゲートウェイ(MaaS) |
+| [MCP](https://modelcontextprotocol.io/) | ✅ | MCPプロトコルをサポート |
+
+## 🤝 コミュニティ貢献
+
+LangBot への貢献に対して、以下の [コード貢献者](https://github.com/langbot-app/LangBot/graphs/contributors) とコミュニティの他のメンバーに感謝します。
+
+<a href="https://github.com/langbot-app/LangBot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=langbot-app/LangBot" />
+</a>

README_TW.md

@@ -0,0 +1,157 @@
+<p align="center">
+<a href="https://langbot.app">
+<img src="https://docs.langbot.app/social_zh.png" alt="LangBot"/>
+</a>
+
+<div align="center"><a href="https://hellogithub.com/repository/langbot-app/LangBot" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=5ce8ae2aa4f74316bf393b57b952433c&claim_uid=gtmc6YWjMZkT21R" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+
+[English](README_EN.md) / [简体中文](README.md) / 繁體中文 / [日本語](README_JP.md) / (PR for your language)
+
+[![Discord](https://img.shields.io/discord/1335141740050649118?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87)
+[![QQ Group](https://img.shields.io/badge/%E7%A4%BE%E5%8C%BAQQ%E7%BE%A4-966235608-blue)](https://qm.qq.com/q/JLi38whHum)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/langbot-app/LangBot)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/langbot-app/LangBot)](https://github.com/langbot-app/LangBot/releases/latest)
+<img src="https://img.shields.io/badge/python-3.10 ~ 3.13 -blue.svg" alt="python">
+[![star](https://gitcode.com/RockChinQ/LangBot/star/badge.svg)](https://gitcode.com/RockChinQ/LangBot)
+
+<a href="https://langbot.app">主頁</a> ｜
+<a href="https://docs.langbot.app/zh/insight/guide.html">部署文件</a> ｜
+<a href="https://docs.langbot.app/zh/plugin/plugin-intro.html">外掛介紹</a> ｜
+<a href="https://github.com/langbot-app/LangBot/issues/new?assignees=&labels=%E7%8B%AC%E7%AB%8B%E6%8F%92%E4%BB%B6&projects=&template=submit-plugin.yml&title=%5BPlugin%5D%3A+%E8%AF%B7%E6%B1%82%E7%99%BB%E8%AE%B0%E6%96%B0%E6%8F%92%E4%BB%B6">提交外掛</a>
+
+</div>
+
+</p>
+
+LangBot 是一個開源的大語言模型原生即時通訊機器人開發平台，旨在提供開箱即用的 IM 機器人開發體驗，具有 Agent、RAG、MCP 等多種 LLM 應用功能，適配全球主流即時通訊平台，並提供豐富的 API 介面，支援自定義開發。
+
+## 📦 開始使用
+
+#### 快速部署
+
+使用 `uvx` 一鍵啟動（需要先安裝 [uv](https://docs.astral.sh/uv/getting-started/installation/) ）：
+
+```bash
+uvx langbot
+```
+
+訪問 http://localhost:5300 即可開始使用。
+
+#### Docker Compose 部署
+
+```bash
+git clone https://github.com/langbot-app/LangBot
+cd LangBot/docker
+docker compose up -d
+```
+
+訪問 http://localhost:5300 即可開始使用。
+
+詳細文件[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。
+
+#### 寶塔面板部署
+
+已上架寶塔面板，若您已安裝寶塔面板，可以根據[文件](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html)使用。
+
+#### Zeabur 雲端部署
+
+社群貢獻的 Zeabur 模板。
+
+[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH)
+
+#### Railway 雲端部署
+
+[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF)
+
+#### 手動部署
+
+直接使用發行版運行，查看文件[手動部署](https://docs.langbot.app/zh/deploy/langbot/manual.html)。
+
+#### Kubernetes 部署
+
+參考 [Kubernetes 部署](./docker/README_K8S.md) 文件。
+
+## 😎 保持更新
+
+點擊倉庫右上角 Star 和 Watch 按鈕，獲取最新動態。
+
+![star gif](https://docs.langbot.app/star.gif)
+
+## ✨ 特性
+
+- 💬 大模型對話、Agent：支援多種大模型，適配群聊和私聊；具有多輪對話、工具調用、多模態、流式輸出能力，自帶 RAG（知識庫）實現，並深度適配 [Dify](https://dify.ai)。
+- 🤖 多平台支援：目前支援 QQ、QQ頻道、企業微信、個人微信、飛書、Discord、Telegram 等平台。
+- 🛠️ 高穩定性、功能完備：原生支援訪問控制、限速、敏感詞過濾等機制；配置簡單，支援多種部署方式。支援多流水線配置，不同機器人用於不同應用場景。
+- 🧩 外掛擴展、活躍社群：支援事件驅動、組件擴展等外掛機制；適配 Anthropic [MCP 協議](https://modelcontextprotocol.io/)；目前已有數百個外掛。
+- 😻 Web 管理面板：支援通過瀏覽器管理 LangBot 實例，不再需要手動編寫配置文件。
+
+詳細規格特性請訪問[文件](https://docs.langbot.app/zh/insight/features.html)。
+
+或訪問 demo 環境：https://demo.langbot.dev/  
+  - 登入資訊：郵箱：`demo@langbot.app` 密碼：`langbot123456`
+  - 注意：僅展示 WebUI 效果，公開環境，請不要在其中填入您的任何敏感資訊。
+
+### 訊息平台
+
+| 平台 | 狀態 | 備註 |
+| --- | --- | --- |
+| Discord | ✅ |  |
+| Telegram | ✅ |  |
+| Slack | ✅ |  |
+| LINE | ✅ |  |
+| QQ 個人號 | ✅ | QQ 個人號私聊、群聊 |
+| QQ 官方機器人 | ✅ | QQ 官方機器人，支援頻道、私聊、群聊 |
+| 微信 | ✅ |  |
+| 企微對外客服 | ✅ |  |
+| 企微智能機器人 | ✅ |  |
+| 微信公眾號 | ✅ |  |
+| Lark | ✅ |  |
+| DingTalk | ✅ |  |
+
+### 大模型能力
+
+| 模型 | 狀態 | 備註 |
+| --- | --- | --- |
+| [OpenAI](https://platform.openai.com/) | ✅ | 可接入任何 OpenAI 介面格式模型 |
+| [DeepSeek](https://www.deepseek.com/) | ✅ |  |
+| [Moonshot](https://www.moonshot.cn/) | ✅ |  |
+| [Anthropic](https://www.anthropic.com/) | ✅ |  |
+| [xAI](https://x.ai/) | ✅ |  |
+| [智譜AI](https://open.bigmodel.cn/) | ✅ |  |
+| [勝算雲](https://www.shengsuanyun.com/?from=CH_KYIPP758) | ✅ | 大模型和 GPU 資源平台 |
+| [優雲智算](https://www.compshare.cn/?ytag=GPU_YY-gh_langbot) | ✅ | 大模型和 GPU 資源平台 |
+| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型和 GPU 資源平台 |
+| [接口 AI](https://jiekou.ai/) | ✅ | 大模型聚合平台，專注全球大模型接入 |
+| [302.AI](https://share.302.ai/SuTG99) | ✅ | 大模型聚合平台 |
+| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | |
+| [Dify](https://dify.ai) | ✅ | LLMOps 平台 |
+| [Ollama](https://ollama.com/) | ✅ | 本地大模型運行平台 |
+| [LMStudio](https://lmstudio.ai/) | ✅ | 本地大模型運行平台 |
+| [GiteeAI](https://ai.gitee.com/) | ✅ | 大模型介面聚合平台 |
+| [SiliconFlow](https://siliconflow.cn/) | ✅ | 大模型聚合平台 |
+| [阿里雲百煉](https://bailian.console.aliyun.com/) | ✅ | 大模型聚合平台, LLMOps 平台 |
+| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | 大模型聚合平台, LLMOps 平台 |
+| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | 大模型聚合平台 |
+| [MCP](https://modelcontextprotocol.io/) | ✅ | 支援通過 MCP 協議獲取工具 |
+
+### TTS
+
+| 平台/模型 | 備註 |
+| --- | --- |
+| [FishAudio](https://fish.audio/zh-CN/discovery/) | [外掛](https://github.com/the-lazy-me/NewChatVoice) |
+| [海豚 AI](https://www.ttson.cn/?source=thelazy) | [外掛](https://github.com/the-lazy-me/NewChatVoice) |
+| [AzureTTS](https://portal.azure.com/) | [外掛](https://github.com/Ingnaryk/LangBot_AzureTTS) |
+
+### 文生圖
+
+| 平台/模型 | 備註 |
+| --- | --- |
+| 阿里雲百煉 | [外掛](https://github.com/Thetail001/LangBot_BailianTextToImagePlugin)
+
+## 😘 社群貢獻
+
+感謝以下[程式碼貢獻者](https://github.com/langbot-app/LangBot/graphs/contributors)和社群裡其他成員對 LangBot 的貢獻：
+
+<a href="https://github.com/langbot-app/LangBot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=langbot-app/LangBot" />
+</a> 

banlist-template.py

@@ -1,20 +0,0 @@
-# 是否启用禁用列表
-enable = True
-
-# 禁用规则（黑名单）
-# person为个人，其中的QQ号会被禁止与机器人进行私聊或群聊交互
-# 示例: person = [2854196310, 1234567890, 9876543210]
-# group为群组，其中的群号会被禁止与机器人进行交互
-# 示例: group = [123456789, 987654321, 1234567890]
-#
-# 支持正则表达式，字符串都将被识别为正则表达式，例如：
-# person = [12345678, 87654321, "2854.*"]
-# group = [123456789, 987654321, "1234.*"]
-# 若要排除某个QQ号或群号（即允许使用），可以在前面加上"!"，例如：
-# person = ["!1234567890"]
-# group = ["!987654321"]
-# 排除规则优先级高于包含规则，即如果同时存在包含规则和排除规则，排除规则将生效，例如：
-# person = ["1234.*", "!1234567890"]
-# 那么1234567890将不会被禁用，而其他以1234开头的QQ号都会被禁用
-person = [2854196310]  # 2854196310是Q群管家机器人的QQ号，默认屏蔽以免出现循环
-group = [204785790, 691226829]  # 本项目交流群的群号，默认屏蔽，避免在交流群测试机器人

codecov.yml

@@ -0,0 +1,4 @@
+coverage:
+  status:
+    project: off
+    patch: off

config-template.py

@@ -1,257 +0,0 @@
-# 配置文件: 注释里标[必需]的参数必须修改, 其他参数根据需要修改, 但请勿删除
-import logging
-
-# [必需] Mirai的配置
-# 请到配置mirai的步骤中的教程查看每个字段的信息
-# adapter: 选择适配器，目前支持HTTPAdapter和WebSocketAdapter
-# host: 运行mirai的主机地址
-# port: 运行mirai的主机端口
-# verifyKey: mirai-api-http的verifyKey
-# qq: 机器人的QQ号
-#
-# 注意: QQ机器人配置不支持热重载及热更新
-mirai_http_api_config = {
-    "adapter": "WebSocketAdapter",
-    "host": "localhost",
-    "port": 8080,
-    "verifyKey": "yirimirai",
-    "qq": 1234567890
-}
-
-# [必需] OpenAI的配置
-# api_key: OpenAI的API Key
-# http_proxy: 请求OpenAI时使用的代理，None为不使用，https和socks5暂不能使用
-# 若只有一个api-key，请直接修改以下内容中的"openai_api_key"为你的api-key
-#
-# 如准备了多个api-key，可以以字典的形式填写，程序会自动选择可用的api-key
-# 例如
-# openai_config = {
-#     "api_key": {
-#         "default": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-#         "key1": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-#         "key2": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-#     },
-#     "http_proxy": "http://127.0.0.1:12345"
-# }
-openai_config = {
-    "api_key": {
-        "default": "openai_api_key"
-    },
-    "http_proxy": None
-}
-
-# [必需] 管理员QQ号，用于接收报错等通知及执行管理员级别指令
-# 支持多个管理员，可以使用list形式设置，例如：
-# admin_qq = [12345678, 87654321]
-admin_qq = 0
-
-# 情景预设（机器人人格）
-# 每个会话的预设信息，影响所有会话，无视指令重置
-# 可以通过这个字段指定某些情况的回复，可直接用自然语言描述指令
-# 例如: 
-# default_prompt = "如果我之后想获取帮助，请你说“输入!help获取帮助”"
-#   这样用户在不知所措的时候机器人就会提示其输入!help获取帮助
-# 可参考 https://github.com/PlexPt/awesome-chatgpt-prompts-zh
-#
-# 如果需要多个情景预设，并在运行期间方便切换，请使用字典的形式填写，例如
-# default_prompt = {
-#   "default": "如果我之后想获取帮助，请你说“输入!help获取帮助”",
-#   "linux-terminal": "我想让你充当 Linux 终端。我将输入命令，您将回复终端应显示的内容。",
-#   "en-dict": "我想让你充当英英词典，对于给出的英文单词，你要给出其中文意思以及英文解释，并且给出一个例句，此外不要有其他反馈。",
-# }
-#
-# 在使用期间即可通过指令：
-# !reset [名称]
-#   来使用指定的情景预设重置会话
-# 例如：
-# !reset linux-terminal
-# 若不指定名称，则使用默认情景预设
-# 
-# 也可以使用指令：
-# !default <名称>
-#   将指定的情景预设设置为默认情景预设
-# 例如：
-# !default linux-terminal
-# 之后的会话重置时若不指定名称，则使用linux-terminal情景预设
-# 
-# 还可以加载文件中的预设文字，使用方法请查看：https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E9%A2%84%E8%AE%BE%E6%96%87%E5%AD%97
-default_prompt = {
-    "default": "如果我之后想获取帮助，请你说“输入!help获取帮助”",
-}
-
-# 实验性设置项: JSON完整情景导入
-# 预设prompt模式
-# 参考值：旧版本方式：default | 完整情景：full_scenario
-preset_mode = "default"
-
-# 群内响应规则
-# 符合此消息的群内消息即使不包含at机器人也会响应
-# 支持消息前缀匹配及正则表达式匹配
-# 支持设置是否响应at消息、随机响应概率
-# 注意：由消息前缀(prefix)匹配的消息中将会删除此前缀，正则表达式(regexp)匹配的消息不会删除匹配的部分
-#      前缀匹配优先级高于正则表达式匹配
-# 正则表达式简明教程：https://www.runoob.com/regexp/regexp-tutorial.html
-response_rules = {
-    "at": True,  # 是否响应at机器人的消息
-    "prefix": ["/ai", "!ai", "！ai", "ai"],
-    "regexp": [],  # "为什么.*", "怎么?样.*", "怎么.*", "如何.*", "[Hh]ow to.*", "[Ww]hy not.*", "[Ww]hat is.*", ".*怎么办", ".*咋办"
-    "random_rate": 0.0,  # 随机响应概率，0.0-1.0，0.0为不随机响应，1.0为响应所有消息, 仅在前几项判断不通过时生效
-}
-
-# 消息忽略规则
-# 适用于私聊及群聊
-# 符合此规则的消息将不会被响应
-# 支持消息前缀匹配及正则表达式匹配
-# 此设置优先级高于response_rules
-# 用以过滤mirai等其他层级的指令
-# @see https://github.com/RockChinQ/QChatGPT/issues/165
-ignore_rules = {
-    "prefix": ["/"],
-    "regexp": []
-}
-
-# 是否检查收到的消息中是否包含敏感词
-# 若收到的消息无法通过下方指定的敏感词检查策略，则发送提示信息
-income_msg_check = False
-
-# 敏感词过滤开关，以同样数量的*代替敏感词回复
-# 请在sensitive.json中添加敏感词
-sensitive_word_filter = True
-
-# 是否启用百度云内容安全审核
-# 注册方式查看 https://cloud.baidu.com/doc/ANTIPORN/s/Wkhu9d5iy
-baidu_check = False
-
-# 百度云API_KEY 24位英文数字字符串
-baidu_api_key = ""
-
-# 百度云SECRET_KEY 32位的英文数字字符串
-baidu_secret_key = ""
-
-# 不合规消息自定义返回
-inappropriate_message_tips = "[百度云]请珍惜机器人，当前返回内容不合规"
-
-# 启动时是否发送赞赏码
-# 仅当使用量已经超过2048字时发送
-encourage_sponsor_at_start = True
-
-# 每次向OpenAI接口发送对话记录上下文的字符数
-# 最大不超过(4096 - max_tokens)个字符，max_tokens为下方completion_api_params中的max_tokens
-# 注意：较大的prompt_submit_length会导致OpenAI账户额度消耗更快
-prompt_submit_length = 1024
-
-# OpenAI补全API的参数
-# 请在下方填写模型，程序自动选择接口
-# 现已支持的模型有：
-# 
-#    'gpt-3.5-turbo'
-#    'gpt-3.5-turbo-0301'
-#    'text-davinci-003'
-#    'text-davinci-002'
-#    'code-davinci-002'
-#    'code-cushman-001'
-#    'text-curie-001'
-#    'text-babbage-001'
-#    'text-ada-001'
-#
-# 具体请查看OpenAI的文档: https://beta.openai.com/docs/api-reference/completions/create
-completion_api_params = {
-    "model": "gpt-3.5-turbo",
-    "temperature": 0.9,  # 数值越低得到的回答越理性，取值范围[0, 1]
-    "max_tokens": 1024,  # 每次获取OpenAI接口响应的文字量上限, 不高于4096
-    "top_p": 1,  # 生成的文本的文本与要求的符合度, 取值范围[0, 1]
-    "frequency_penalty": 0.2,
-    "presence_penalty": 1.0,
-}
-
-# OpenAI的Image API的参数
-# 具体请查看OpenAI的文档: https://beta.openai.com/docs/api-reference/images/create
-image_api_params = {
-    "size": "256x256",  # 图片尺寸，支持256x256, 512x512, 1024x1024
-}
-
-# 群内回复消息时是否引用原消息
-quote_origin = True
-
-# 回复绘图时是否包含图片描述
-include_image_description = True
-
-# 消息处理的超时时间，单位为秒
-process_message_timeout = 30
-
-# 回复消息时是否显示[GPT]前缀
-show_prefix = False
-
-# 应用长消息处理策略的阈值
-# 当回复消息长度超过此值时，将使用长消息处理策略
-blob_message_threshold = 256
-
-# 长消息处理策略
-# - "image": 将长消息转换为图片发送
-# - "forward": 将长消息转换为转发消息组件发送
-blob_message_strategy = "forward"
-
-# 文字转图片时使用的字体文件路径
-# 当策略为"image"时生效
-#   若在Windows系统下，程序会自动使用Windows自带的微软雅黑字体
-#   若未填写或不存在且不是Windows，将禁用文字转图片功能，改为使用转发消息组件
-font_path = ""
-
-# 消息处理超时重试次数
-retry_times = 3
-
-# 消息处理出错时是否向用户隐藏错误详细信息
-# 设置为True时，仅向管理员发送错误详细信息
-# 设置为False时，向用户及管理员发送错误详细信息
-hide_exce_info_to_user = False
-
-# 消息处理出错时向用户发送的提示信息
-# 仅当hide_exce_info_to_user为True时生效
-# 设置为空字符串时，不发送提示信息
-alter_tip_message = '出错了，请稍后再试'
-
-# 机器人线程池大小
-# 该参数决定机器人可以同时处理几个人的消息，超出线程池数量的请求会被阻塞，不会被丢弃
-# 如果你不清楚该参数的意义，请不要更改
-pool_num = 10
-
-# 每个会话的过期时间，单位为秒
-# 默认值20分钟
-session_expire_time = 60 * 20
-
-# 会话限速
-# 单会话内每分钟可进行的对话次数
-# 若不需要限速，可以设置为一个很大的值
-# 默认值60次，基本上不会触发限速
-rate_limitation = 60
-
-# 会话限速策略
-# - "wait": 每次对话获取到回复时，等待一定时间再发送回复，保证其不会超过限速均值
-# - "drop": 此分钟内，若对话次数超过限速次数，则丢弃之后的对话，每自然分钟重置
-rate_limit_strategy = "wait"
-
-# drop策略时，超过限速均值时，丢弃的对话的提示信息
-# 仅当rate_limitation_strategy为"drop"时生效
-# 若设置为空字符串，则不发送提示信息
-rate_limit_drop_tip = "本分钟对话次数超过限速次数，此对话被丢弃"
-
-# 是否在启动时进行依赖库更新
-upgrade_dependencies = True
-
-# 是否上报统计信息
-# 用于统计机器人的使用情况，不会收集任何用户信息
-# 仅上报时间、字数使用量、绘图使用量，其他信息不会上报
-report_usage = True
-
-# 日志级别
-logging_level = logging.INFO
-
-# 定制帮助消息
-help_message = """此机器人通过调用OpenAI的GPT-3大型语言模型生成回复，不具有情感。
-你可以用自然语言与其交流，回复的消息中[GPT]开头的为模型生成的语言，[bot]开头的为程序提示。
-了解此项目请找QQ 1010553892 联系作者
-请不要用其生成整篇文章或大段代码，因为每次只会向模型提交少部分文字，生成大部分文字会产生偏题、前后矛盾等问题
-每次会话最后一次交互后{}分钟后会自动结束，结束后将开启新会话，如需继续前一次会话请发送 !last 重新开启
-欢迎到github.com/RockChinQ/QChatGPT 给个star
-
-指令帮助信息请查看: https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4""".format(session_expire_time // 60)

docker/README_K8S.md

@@ -0,0 +1,629 @@
+# LangBot Kubernetes 部署指南 / Kubernetes Deployment Guide
+
+[简体中文](#简体中文) | [English](#english)
+
+---
+
+## 简体中文
+
+### 概述
+
+本指南提供了在 Kubernetes 集群中部署 LangBot 的完整步骤。Kubernetes 部署配置基于 `docker-compose.yaml`，适用于生产环境的容器化部署。
+
+### 前置要求
+
+- Kubernetes 集群（版本 1.19+）
+- `kubectl` 命令行工具已配置并可访问集群
+- 集群中有可用的存储类（StorageClass）用于持久化存储（可选但推荐）
+- 至少 2 vCPU 和 4GB RAM 的可用资源
+
+### 架构说明
+
+Kubernetes 部署包含以下组件：
+
+1. **langbot**: 主应用服务
+   - 提供 Web UI（端口 5300）
+   - 处理平台 webhook（端口 2280-2290）
+   - 数据持久化卷
+   
+2. **langbot-plugin-runtime**: 插件运行时服务
+   - WebSocket 通信（端口 5400）
+   - 插件数据持久化卷
+
+3. **持久化存储**:
+   - `langbot-data`: LangBot 主数据
+   - `langbot-plugins`: 插件文件
+   - `langbot-plugin-runtime-data`: 插件运行时数据
+
+### 快速开始
+
+#### 1. 下载部署文件
+
+```bash
+# 克隆仓库
+git clone https://github.com/langbot-app/LangBot
+cd LangBot/docker
+
+# 或直接下载 kubernetes.yaml
+wget https://raw.githubusercontent.com/langbot-app/LangBot/main/docker/kubernetes.yaml
+```
+
+#### 2. 部署到 Kubernetes
+
+```bash
+# 应用所有配置
+kubectl apply -f kubernetes.yaml
+
+# 检查部署状态
+kubectl get all -n langbot
+
+# 查看 Pod 日志
+kubectl logs -n langbot -l app=langbot -f
+```
+
+#### 3. 访问 LangBot
+
+默认情况下，LangBot 服务使用 ClusterIP 类型，只能在集群内部访问。您可以选择以下方式之一来访问：
+
+**选项 A: 端口转发（推荐用于测试）**
+
+```bash
+kubectl port-forward -n langbot svc/langbot 5300:5300
+```
+
+然后访问 http://localhost:5300
+
+**选项 B: NodePort（适用于开发环境）**
+
+编辑 `kubernetes.yaml`，取消注释 NodePort Service 部分，然后：
+
+```bash
+kubectl apply -f kubernetes.yaml
+# 获取节点 IP
+kubectl get nodes -o wide
+# 访问 http://<NODE_IP>:30300
+```
+
+**选项 C: LoadBalancer（适用于云环境）**
+
+编辑 `kubernetes.yaml`，取消注释 LoadBalancer Service 部分，然后：
+
+```bash
+kubectl apply -f kubernetes.yaml
+# 获取外部 IP
+kubectl get svc -n langbot langbot-loadbalancer
+# 访问 http://<EXTERNAL_IP>
+```
+
+**选项 D: Ingress（推荐用于生产环境）**
+
+确保集群中已安装 Ingress Controller（如 nginx-ingress），然后：
+
+1. 编辑 `kubernetes.yaml` 中的 Ingress 配置
+2. 修改域名为您的实际域名
+3. 应用配置：
+
+```bash
+kubectl apply -f kubernetes.yaml
+# 访问 http://langbot.yourdomain.com
+```
+
+### 配置说明
+
+#### 环境变量
+
+在 `ConfigMap` 中配置环境变量：
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: langbot-config
+  namespace: langbot
+data:
+  TZ: "Asia/Shanghai"  # 修改为您的时区
+```
+
+#### 存储配置
+
+默认使用动态存储分配。如果您有特定的 StorageClass，请在 PVC 中指定：
+
+```yaml
+spec:
+  storageClassName: your-storage-class-name
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+```
+
+#### 资源限制
+
+根据您的需求调整资源限制：
+
+```yaml
+resources:
+  requests:
+    memory: "1Gi"
+    cpu: "500m"
+  limits:
+    memory: "4Gi"
+    cpu: "2000m"
+```
+
+### 常用操作
+
+#### 查看日志
+
+```bash
+# 查看 LangBot 主服务日志
+kubectl logs -n langbot -l app=langbot -f
+
+# 查看插件运行时日志
+kubectl logs -n langbot -l app=langbot-plugin-runtime -f
+```
+
+#### 重启服务
+
+```bash
+# 重启 LangBot
+kubectl rollout restart deployment/langbot -n langbot
+
+# 重启插件运行时
+kubectl rollout restart deployment/langbot-plugin-runtime -n langbot
+```
+
+#### 更新镜像
+
+```bash
+# 更新到最新版本
+kubectl set image deployment/langbot -n langbot langbot=rockchin/langbot:latest
+kubectl set image deployment/langbot-plugin-runtime -n langbot langbot-plugin-runtime=rockchin/langbot:latest
+
+# 检查更新状态
+kubectl rollout status deployment/langbot -n langbot
+```
+
+#### 扩容（不推荐）
+
+注意：由于 LangBot 使用 ReadWriteOnce 的持久化存储，不支持多副本扩容。如需高可用，请考虑使用 ReadWriteMany 存储或其他架构方案。
+
+#### 备份数据
+
+```bash
+# 备份 PVC 数据
+kubectl exec -n langbot -it <langbot-pod-name> -- tar czf /tmp/backup.tar.gz /app/data
+kubectl cp langbot/<langbot-pod-name>:/tmp/backup.tar.gz ./backup.tar.gz
+```
+
+### 卸载
+
+```bash
+# 删除所有资源（保留 PVC）
+kubectl delete deployment,service,configmap -n langbot --all
+
+# 删除 PVC（会删除数据）
+kubectl delete pvc -n langbot --all
+
+# 删除命名空间
+kubectl delete namespace langbot
+```
+
+### 故障排查
+
+#### Pod 无法启动
+
+```bash
+# 查看 Pod 状态
+kubectl get pods -n langbot
+
+# 查看详细信息
+kubectl describe pod -n langbot <pod-name>
+
+# 查看事件
+kubectl get events -n langbot --sort-by='.lastTimestamp'
+```
+
+#### 存储问题
+
+```bash
+# 检查 PVC 状态
+kubectl get pvc -n langbot
+
+# 检查 PV
+kubectl get pv
+```
+
+#### 网络访问问题
+
+```bash
+# 检查 Service
+kubectl get svc -n langbot
+
+# 检查端口转发
+kubectl port-forward -n langbot svc/langbot 5300:5300
+```
+
+### 生产环境建议
+
+1. **使用特定版本标签**：避免使用 `latest` 标签，使用具体版本号如 `rockchin/langbot:v1.0.0`
+2. **配置资源限制**：根据实际负载调整 CPU 和内存限制
+3. **使用 Ingress + TLS**：配置 HTTPS 访问和证书管理
+4. **配置监控和告警**：集成 Prometheus、Grafana 等监控工具
+5. **定期备份**：配置自动备份策略保护数据
+6. **使用专用 StorageClass**：为生产环境配置高性能存储
+7. **配置亲和性规则**：确保 Pod 调度到合适的节点
+
+### 高级配置
+
+#### 使用 Secrets 管理敏感信息
+
+如果需要配置 API 密钥等敏感信息：
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: langbot-secrets
+  namespace: langbot
+type: Opaque
+data:
+  api_key: <base64-encoded-value>
+```
+
+然后在 Deployment 中引用：
+
+```yaml
+env:
+- name: API_KEY
+  valueFrom:
+    secretKeyRef:
+      name: langbot-secrets
+      key: api_key
+```
+
+#### 配置水平自动扩缩容（HPA）
+
+注意：需要确保使用 ReadWriteMany 存储类型
+
+```yaml
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: langbot-hpa
+  namespace: langbot
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: langbot
+  minReplicas: 1
+  maxReplicas: 3
+  metrics:
+  - type: Resource
+    resource:
+      name: cpu
+      target:
+        type: Utilization
+        averageUtilization: 70
+```
+
+### 参考资源
+
+- [LangBot 官方文档](https://docs.langbot.app)
+- [Docker 部署文档](https://docs.langbot.app/zh/deploy/langbot/docker.html)
+- [Kubernetes 官方文档](https://kubernetes.io/docs/)
+
+---
+
+## English
+
+### Overview
+
+This guide provides complete steps for deploying LangBot in a Kubernetes cluster. The Kubernetes deployment configuration is based on `docker-compose.yaml` and is suitable for production containerized deployments.
+
+### Prerequisites
+
+- Kubernetes cluster (version 1.19+)
+- `kubectl` command-line tool configured with cluster access
+- Available StorageClass in the cluster for persistent storage (optional but recommended)
+- At least 2 vCPU and 4GB RAM of available resources
+
+### Architecture
+
+The Kubernetes deployment includes the following components:
+
+1. **langbot**: Main application service
+   - Provides Web UI (port 5300)
+   - Handles platform webhooks (ports 2280-2290)
+   - Data persistence volume
+   
+2. **langbot-plugin-runtime**: Plugin runtime service
+   - WebSocket communication (port 5400)
+   - Plugin data persistence volume
+
+3. **Persistent Storage**:
+   - `langbot-data`: LangBot main data
+   - `langbot-plugins`: Plugin files
+   - `langbot-plugin-runtime-data`: Plugin runtime data
+
+### Quick Start
+
+#### 1. Download Deployment Files
+
+```bash
+# Clone repository
+git clone https://github.com/langbot-app/LangBot
+cd LangBot/docker
+
+# Or download kubernetes.yaml directly
+wget https://raw.githubusercontent.com/langbot-app/LangBot/main/docker/kubernetes.yaml
+```
+
+#### 2. Deploy to Kubernetes
+
+```bash
+# Apply all configurations
+kubectl apply -f kubernetes.yaml
+
+# Check deployment status
+kubectl get all -n langbot
+
+# View Pod logs
+kubectl logs -n langbot -l app=langbot -f
+```
+
+#### 3. Access LangBot
+
+By default, LangBot service uses ClusterIP type, accessible only within the cluster. Choose one of the following methods to access:
+
+**Option A: Port Forwarding (Recommended for testing)**
+
+```bash
+kubectl port-forward -n langbot svc/langbot 5300:5300
+```
+
+Then visit http://localhost:5300
+
+**Option B: NodePort (Suitable for development)**
+
+Edit `kubernetes.yaml`, uncomment the NodePort Service section, then:
+
+```bash
+kubectl apply -f kubernetes.yaml
+# Get node IP
+kubectl get nodes -o wide
+# Visit http://<NODE_IP>:30300
+```
+
+**Option C: LoadBalancer (Suitable for cloud environments)**
+
+Edit `kubernetes.yaml`, uncomment the LoadBalancer Service section, then:
+
+```bash
+kubectl apply -f kubernetes.yaml
+# Get external IP
+kubectl get svc -n langbot langbot-loadbalancer
+# Visit http://<EXTERNAL_IP>
+```
+
+**Option D: Ingress (Recommended for production)**
+
+Ensure an Ingress Controller (e.g., nginx-ingress) is installed in the cluster, then:
+
+1. Edit the Ingress configuration in `kubernetes.yaml`
+2. Change the domain to your actual domain
+3. Apply configuration:
+
+```bash
+kubectl apply -f kubernetes.yaml
+# Visit http://langbot.yourdomain.com
+```
+
+### Configuration
+
+#### Environment Variables
+
+Configure environment variables in ConfigMap:
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: langbot-config
+  namespace: langbot
+data:
+  TZ: "Asia/Shanghai"  # Change to your timezone
+```
+
+#### Storage Configuration
+
+Uses dynamic storage provisioning by default. If you have a specific StorageClass, specify it in PVC:
+
+```yaml
+spec:
+  storageClassName: your-storage-class-name
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+```
+
+#### Resource Limits
+
+Adjust resource limits based on your needs:
+
+```yaml
+resources:
+  requests:
+    memory: "1Gi"
+    cpu: "500m"
+  limits:
+    memory: "4Gi"
+    cpu: "2000m"
+```
+
+### Common Operations
+
+#### View Logs
+
+```bash
+# View LangBot main service logs
+kubectl logs -n langbot -l app=langbot -f
+
+# View plugin runtime logs
+kubectl logs -n langbot -l app=langbot-plugin-runtime -f
+```
+
+#### Restart Services
+
+```bash
+# Restart LangBot
+kubectl rollout restart deployment/langbot -n langbot
+
+# Restart plugin runtime
+kubectl rollout restart deployment/langbot-plugin-runtime -n langbot
+```
+
+#### Update Images
+
+```bash
+# Update to latest version
+kubectl set image deployment/langbot -n langbot langbot=rockchin/langbot:latest
+kubectl set image deployment/langbot-plugin-runtime -n langbot langbot-plugin-runtime=rockchin/langbot:latest
+
+# Check update status
+kubectl rollout status deployment/langbot -n langbot
+```
+
+#### Scaling (Not Recommended)
+
+Note: Due to LangBot using ReadWriteOnce persistent storage, multi-replica scaling is not supported. For high availability, consider using ReadWriteMany storage or alternative architectures.
+
+#### Backup Data
+
+```bash
+# Backup PVC data
+kubectl exec -n langbot -it <langbot-pod-name> -- tar czf /tmp/backup.tar.gz /app/data
+kubectl cp langbot/<langbot-pod-name>:/tmp/backup.tar.gz ./backup.tar.gz
+```
+
+### Uninstall
+
+```bash
+# Delete all resources (keep PVCs)
+kubectl delete deployment,service,configmap -n langbot --all
+
+# Delete PVCs (will delete data)
+kubectl delete pvc -n langbot --all
+
+# Delete namespace
+kubectl delete namespace langbot
+```
+
+### Troubleshooting
+
+#### Pods Not Starting
+
+```bash
+# Check Pod status
+kubectl get pods -n langbot
+
+# View detailed information
+kubectl describe pod -n langbot <pod-name>
+
+# View events
+kubectl get events -n langbot --sort-by='.lastTimestamp'
+```
+
+#### Storage Issues
+
+```bash
+# Check PVC status
+kubectl get pvc -n langbot
+
+# Check PV
+kubectl get pv
+```
+
+#### Network Access Issues
+
+```bash
+# Check Service
+kubectl get svc -n langbot
+
+# Test port forwarding
+kubectl port-forward -n langbot svc/langbot 5300:5300
+```
+
+### Production Recommendations
+
+1. **Use specific version tags**: Avoid using `latest` tag, use specific version like `rockchin/langbot:v1.0.0`
+2. **Configure resource limits**: Adjust CPU and memory limits based on actual load
+3. **Use Ingress + TLS**: Configure HTTPS access and certificate management
+4. **Configure monitoring and alerts**: Integrate monitoring tools like Prometheus, Grafana
+5. **Regular backups**: Configure automated backup strategy to protect data
+6. **Use dedicated StorageClass**: Configure high-performance storage for production
+7. **Configure affinity rules**: Ensure Pods are scheduled to appropriate nodes
+
+### Advanced Configuration
+
+#### Using Secrets for Sensitive Information
+
+If you need to configure sensitive information like API keys:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: langbot-secrets
+  namespace: langbot
+type: Opaque
+data:
+  api_key: <base64-encoded-value>
+```
+
+Then reference in Deployment:
+
+```yaml
+env:
+- name: API_KEY
+  valueFrom:
+    secretKeyRef:
+      name: langbot-secrets
+      key: api_key
+```
+
+#### Configure Horizontal Pod Autoscaling (HPA)
+
+Note: Requires ReadWriteMany storage type
+
+```yaml
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: langbot-hpa
+  namespace: langbot
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: langbot
+  minReplicas: 1
+  maxReplicas: 3
+  metrics:
+  - type: Resource
+    resource:
+      name: cpu
+      target:
+        type: Utilization
+        averageUtilization: 70
+```
+
+### References
+
+- [LangBot Official Documentation](https://docs.langbot.app)
+- [Docker Deployment Guide](https://docs.langbot.app/zh/deploy/langbot/docker.html)
+- [Kubernetes Official Documentation](https://kubernetes.io/docs/)

docker/deploy-k8s-test.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+# Quick test script for LangBot Kubernetes deployment
+# This script helps you test the Kubernetes deployment locally
+
+set -e
+
+echo "🚀 LangBot Kubernetes Deployment Test Script"
+echo "=============================================="
+echo ""
+
+# Check for kubectl
+if ! command -v kubectl &> /dev/null; then
+    echo "❌ kubectl is not installed. Please install kubectl first."
+    echo "Visit: https://kubernetes.io/docs/tasks/tools/"
+    exit 1
+fi
+
+echo "✓ kubectl is installed"
+
+# Check if kubectl can connect to a cluster
+if ! kubectl cluster-info &> /dev/null; then
+    echo ""
+    echo "⚠️  No Kubernetes cluster found."
+    echo ""
+    echo "To test locally, you can use:"
+    echo "  - kind: https://kind.sigs.k8s.io/"
+    echo "  - minikube: https://minikube.sigs.k8s.io/"
+    echo "  - k3s: https://k3s.io/"
+    echo ""
+    echo "Example with kind:"
+    echo "  kind create cluster --name langbot-test"
+    echo ""
+    exit 1
+fi
+
+echo "✓ Connected to Kubernetes cluster"
+kubectl cluster-info
+echo ""
+
+# Ask user to confirm
+read -p "Do you want to deploy LangBot to this cluster? (y/N) " -n 1 -r
+echo
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    echo "Deployment cancelled."
+    exit 0
+fi
+
+echo ""
+echo "📦 Deploying LangBot..."
+kubectl apply -f kubernetes.yaml
+
+echo ""
+echo "⏳ Waiting for pods to be ready..."
+kubectl wait --for=condition=ready pod -l app=langbot -n langbot --timeout=300s
+kubectl wait --for=condition=ready pod -l app=langbot-plugin-runtime -n langbot --timeout=300s
+
+echo ""
+echo "✅ Deployment complete!"
+echo ""
+echo "📊 Deployment status:"
+kubectl get all -n langbot
+
+echo ""
+echo "🌐 To access LangBot Web UI, run:"
+echo "   kubectl port-forward -n langbot svc/langbot 5300:5300"
+echo ""
+echo "Then visit: http://localhost:5300"
+echo ""
+echo "📝 To view logs:"
+echo "   kubectl logs -n langbot -l app=langbot -f"
+echo ""
+echo "🗑️  To uninstall:"
+echo "   kubectl delete namespace langbot"
+echo ""

docker/docker-compose.yaml

@@ -0,0 +1,40 @@
+# Docker Compose configuration for LangBot
+# For Kubernetes deployment, see kubernetes.yaml and README_K8S.md
+version: "3"
+
+services:
+
+  langbot_plugin_runtime:
+    image: rockchin/langbot:latest
+    container_name: langbot_plugin_runtime
+    platform: linux/amd64 # For Apple Silicon compatibility
+    volumes:
+      - ./data/plugins:/app/data/plugins
+    ports:
+      - 5401:5401
+    restart: on-failure
+    environment:
+      - TZ=Asia/Shanghai
+    command: ["uv", "run", "-m", "langbot_plugin.cli.__init__", "rt"]
+    networks:
+      - langbot_network
+
+  langbot:
+    image: rockchin/langbot:latest
+    container_name: langbot
+    platform: linux/amd64 # For Apple Silicon compatibility
+    volumes:
+      - ./data:/app/data
+      - ./plugins:/app/plugins
+    restart: on-failure
+    environment:
+      - TZ=Asia/Shanghai
+    ports:
+      - 5300:5300  # For web ui
+      - 2280-2290:2280-2290  # For platform webhook
+    networks:
+      - langbot_network
+
+networks:
+  langbot_network:
+    driver: bridge

docker/kubernetes.yaml

@@ -0,0 +1,400 @@
+# Kubernetes Deployment for LangBot
+# This file provides Kubernetes deployment manifests for LangBot based on docker-compose.yaml
+# 
+# Usage:
+#   kubectl apply -f kubernetes.yaml
+#
+# Prerequisites:
+#   - A Kubernetes cluster (1.19+)
+#   - kubectl configured to communicate with your cluster
+#   - (Optional) A StorageClass for dynamic volume provisioning
+#
+# Components:
+#   - Namespace: langbot
+#   - PersistentVolumeClaims for data persistence
+#   - Deployments for langbot and langbot_plugin_runtime
+#   - Services for network access
+#   - ConfigMap for timezone configuration
+
+---
+# Namespace
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: langbot
+  labels:
+    app: langbot
+
+---
+# PersistentVolumeClaim for LangBot data
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: langbot-data
+  namespace: langbot
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+  # Uncomment and modify if you have a specific StorageClass
+  # storageClassName: your-storage-class
+
+---
+# PersistentVolumeClaim for LangBot plugins
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: langbot-plugins
+  namespace: langbot
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 5Gi
+  # Uncomment and modify if you have a specific StorageClass
+  # storageClassName: your-storage-class
+
+---
+# PersistentVolumeClaim for Plugin Runtime data
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: langbot-plugin-runtime-data
+  namespace: langbot
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 5Gi
+  # Uncomment and modify if you have a specific StorageClass
+  # storageClassName: your-storage-class
+
+---
+# ConfigMap for environment configuration
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: langbot-config
+  namespace: langbot
+data:
+  TZ: "Asia/Shanghai"
+  PLUGIN__RUNTIME_WS_URL: "ws://langbot-plugin-runtime:5400/control/ws"
+
+---
+# Deployment for LangBot Plugin Runtime
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: langbot-plugin-runtime
+  namespace: langbot
+  labels:
+    app: langbot-plugin-runtime
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: langbot-plugin-runtime
+  template:
+    metadata:
+      labels:
+        app: langbot-plugin-runtime
+    spec:
+      containers:
+      - name: langbot-plugin-runtime
+        image: rockchin/langbot:latest
+        imagePullPolicy: Always
+        command: ["uv", "run", "-m", "langbot_plugin.cli.__init__", "rt"]
+        ports:
+        - containerPort: 5400
+          name: runtime
+          protocol: TCP
+        env:
+        - name: TZ
+          valueFrom:
+            configMapKeyRef:
+              name: langbot-config
+              key: TZ
+        volumeMounts:
+        - name: plugin-data
+          mountPath: /app/data/plugins
+        resources:
+          requests:
+            memory: "512Mi"
+            cpu: "250m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+        # Liveness probe to restart container if it becomes unresponsive
+        livenessProbe:
+          tcpSocket:
+            port: 5400
+          initialDelaySeconds: 30
+          periodSeconds: 10
+          timeoutSeconds: 5
+          failureThreshold: 3
+        # Readiness probe to know when container is ready to accept traffic
+        readinessProbe:
+          tcpSocket:
+            port: 5400
+          initialDelaySeconds: 10
+          periodSeconds: 5
+          timeoutSeconds: 3
+          failureThreshold: 3
+      volumes:
+      - name: plugin-data
+        persistentVolumeClaim:
+          claimName: langbot-plugin-runtime-data
+      restartPolicy: Always
+
+---
+# Service for LangBot Plugin Runtime
+apiVersion: v1
+kind: Service
+metadata:
+  name: langbot-plugin-runtime
+  namespace: langbot
+  labels:
+    app: langbot-plugin-runtime
+spec:
+  type: ClusterIP
+  selector:
+    app: langbot-plugin-runtime
+  ports:
+  - port: 5400
+    targetPort: 5400
+    protocol: TCP
+    name: runtime
+
+---
+# Deployment for LangBot
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: langbot
+  namespace: langbot
+  labels:
+    app: langbot
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: langbot
+  template:
+    metadata:
+      labels:
+        app: langbot
+    spec:
+      containers:
+      - name: langbot
+        image: rockchin/langbot:latest
+        imagePullPolicy: Always
+        ports:
+        - containerPort: 5300
+          name: web
+          protocol: TCP
+        - containerPort: 2280
+          name: webhook-start
+          protocol: TCP
+        # Note: Kubernetes doesn't support port ranges directly in container ports
+        # The webhook ports 2280-2290 are available, but we only expose the start of the range
+        # If you need all ports exposed, consider using a Service with multiple port definitions
+        env:
+        - name: TZ
+          valueFrom:
+            configMapKeyRef:
+              name: langbot-config
+              key: TZ
+        - name: PLUGIN__RUNTIME_WS_URL
+          valueFrom:
+            configMapKeyRef:
+              name: langbot-config
+              key: PLUGIN__RUNTIME_WS_URL
+        volumeMounts:
+        - name: data
+          mountPath: /app/data
+        - name: plugins
+          mountPath: /app/plugins
+        resources:
+          requests:
+            memory: "1Gi"
+            cpu: "500m"
+          limits:
+            memory: "4Gi"
+            cpu: "2000m"
+        # Liveness probe to restart container if it becomes unresponsive
+        livenessProbe:
+          httpGet:
+            path: /
+            port: 5300
+          initialDelaySeconds: 60
+          periodSeconds: 10
+          timeoutSeconds: 5
+          failureThreshold: 3
+        # Readiness probe to know when container is ready to accept traffic
+        readinessProbe:
+          httpGet:
+            path: /
+            port: 5300
+          initialDelaySeconds: 30
+          periodSeconds: 5
+          timeoutSeconds: 3
+          failureThreshold: 3
+      volumes:
+      - name: data
+        persistentVolumeClaim:
+          claimName: langbot-data
+      - name: plugins
+        persistentVolumeClaim:
+          claimName: langbot-plugins
+      restartPolicy: Always
+
+---
+# Service for LangBot (ClusterIP for internal access)
+apiVersion: v1
+kind: Service
+metadata:
+  name: langbot
+  namespace: langbot
+  labels:
+    app: langbot
+spec:
+  type: ClusterIP
+  selector:
+    app: langbot
+  ports:
+  - port: 5300
+    targetPort: 5300
+    protocol: TCP
+    name: web
+  - port: 2280
+    targetPort: 2280
+    protocol: TCP
+    name: webhook-2280
+  - port: 2281
+    targetPort: 2281
+    protocol: TCP
+    name: webhook-2281
+  - port: 2282
+    targetPort: 2282
+    protocol: TCP
+    name: webhook-2282
+  - port: 2283
+    targetPort: 2283
+    protocol: TCP
+    name: webhook-2283
+  - port: 2284
+    targetPort: 2284
+    protocol: TCP
+    name: webhook-2284
+  - port: 2285
+    targetPort: 2285
+    protocol: TCP
+    name: webhook-2285
+  - port: 2286
+    targetPort: 2286
+    protocol: TCP
+    name: webhook-2286
+  - port: 2287
+    targetPort: 2287
+    protocol: TCP
+    name: webhook-2287
+  - port: 2288
+    targetPort: 2288
+    protocol: TCP
+    name: webhook-2288
+  - port: 2289
+    targetPort: 2289
+    protocol: TCP
+    name: webhook-2289
+  - port: 2290
+    targetPort: 2290
+    protocol: TCP
+    name: webhook-2290
+
+---
+# Ingress for external access (Optional - requires Ingress Controller)
+# Uncomment and modify the following section if you want to expose LangBot via Ingress
+# apiVersion: networking.k8s.io/v1
+# kind: Ingress
+# metadata:
+#   name: langbot-ingress
+#   namespace: langbot
+#   annotations:
+#     # Uncomment and modify based on your ingress controller
+#     # nginx.ingress.kubernetes.io/rewrite-target: /
+#     # cert-manager.io/cluster-issuer: letsencrypt-prod
+# spec:
+#   ingressClassName: nginx  # Change based on your ingress controller
+#   rules:
+#   - host: langbot.yourdomain.com  # Change to your domain
+#     http:
+#       paths:
+#       - path: /
+#         pathType: Prefix
+#         backend:
+#           service:
+#             name: langbot
+#             port:
+#               number: 5300
+#   # Uncomment for TLS/HTTPS
+#   # tls:
+#   # - hosts:
+#   #   - langbot.yourdomain.com
+#   #   secretName: langbot-tls
+
+---
+# Service for LangBot with LoadBalancer (Alternative to Ingress)
+# Uncomment the following if you want to expose LangBot directly via LoadBalancer
+# This is useful in cloud environments (AWS, GCP, Azure, etc.)
+# apiVersion: v1
+# kind: Service
+# metadata:
+#   name: langbot-loadbalancer
+#   namespace: langbot
+#   labels:
+#     app: langbot
+# spec:
+#   type: LoadBalancer
+#   selector:
+#     app: langbot
+#   ports:
+#   - port: 80
+#     targetPort: 5300
+#     protocol: TCP
+#     name: web
+#   - port: 2280
+#     targetPort: 2280
+#     protocol: TCP
+#     name: webhook-start
+#   # Add more webhook ports as needed
+
+---
+# Service for LangBot with NodePort (Alternative for exposing service)
+# Uncomment if you want to expose LangBot via NodePort
+# This is useful for testing or when LoadBalancer is not available
+# apiVersion: v1
+# kind: Service
+# metadata:
+#   name: langbot-nodeport
+#   namespace: langbot
+#   labels:
+#     app: langbot
+# spec:
+#   type: NodePort
+#   selector:
+#     app: langbot
+#   ports:
+#   - port: 5300
+#     targetPort: 5300
+#     nodePort: 30300  # Must be in range 30000-32767
+#     protocol: TCP
+#     name: web
+#   - port: 2280
+#     targetPort: 2280
+#     nodePort: 30280  # Must be in range 30000-32767
+#     protocol: TCP
+#     name: webhook

docs/API_KEY_AUTH.md

@@ -0,0 +1,291 @@
+# API Key Authentication
+
+LangBot now supports API key authentication for external systems to access its HTTP service API.
+
+## Managing API Keys
+
+API keys can be managed through the web interface:
+
+1. Log in to the LangBot web interface
+2. Click the "API Keys" button at the bottom of the sidebar
+3. Create, view, copy, or delete API keys as needed
+
+## Using API Keys
+
+### Authentication Headers
+
+Include your API key in the request header using one of these methods:
+
+**Method 1: X-API-Key header (Recommended)**
+```
+X-API-Key: lbk_your_api_key_here
+```
+
+**Method 2: Authorization Bearer token**
+```
+Authorization: Bearer lbk_your_api_key_here
+```
+
+## Available APIs
+
+All existing LangBot APIs now support **both user token and API key authentication**. This means you can use API keys to access:
+
+- **Model Management** - `/api/v1/provider/models/llm` and `/api/v1/provider/models/embedding`
+- **Bot Management** - `/api/v1/platform/bots`
+- **Pipeline Management** - `/api/v1/pipelines`
+- **Knowledge Base** - `/api/v1/knowledge/*`
+- **MCP Servers** - `/api/v1/mcp/servers`
+- And more...
+
+### Authentication Methods
+
+Each endpoint accepts **either**:
+1. **User Token** (via `Authorization: Bearer <user_jwt_token>`) - for web UI and authenticated users
+2. **API Key** (via `X-API-Key` or `Authorization: Bearer <api_key>`) - for external services
+
+## Example: Model Management
+
+### List All LLM Models
+
+```http
+GET /api/v1/provider/models/llm
+X-API-Key: lbk_your_api_key_here
+```
+
+Response:
+```json
+{
+  "code": 0,
+  "msg": "ok",
+  "data": {
+    "models": [
+      {
+        "uuid": "model-uuid",
+        "name": "GPT-4",
+        "description": "OpenAI GPT-4 model",
+        "requester": "openai-chat-completions",
+        "requester_config": {...},
+        "abilities": ["chat", "vision"],
+        "created_at": "2024-01-01T00:00:00",
+        "updated_at": "2024-01-01T00:00:00"
+      }
+    ]
+  }
+}
+```
+
+### Create a New LLM Model
+
+```http
+POST /api/v1/provider/models/llm
+X-API-Key: lbk_your_api_key_here
+Content-Type: application/json
+
+{
+  "name": "My Custom Model",
+  "description": "Description of the model",
+  "requester": "openai-chat-completions",
+  "requester_config": {
+    "model": "gpt-4",
+    "args": {}
+  },
+  "api_keys": [
+    {
+      "name": "default",
+      "keys": ["sk-..."]
+    }
+  ],
+  "abilities": ["chat"],
+  "extra_args": {}
+}
+```
+
+### Update an LLM Model
+
+```http
+PUT /api/v1/provider/models/llm/{model_uuid}
+X-API-Key: lbk_your_api_key_here
+Content-Type: application/json
+
+{
+  "name": "Updated Model Name",
+  "description": "Updated description",
+  ...
+}
+```
+
+### Delete an LLM Model
+
+```http
+DELETE /api/v1/provider/models/llm/{model_uuid}
+X-API-Key: lbk_your_api_key_here
+```
+
+## Example: Bot Management
+
+### List All Bots
+
+```http
+GET /api/v1/platform/bots
+X-API-Key: lbk_your_api_key_here
+```
+
+### Create a New Bot
+
+```http
+POST /api/v1/platform/bots
+X-API-Key: lbk_your_api_key_here
+Content-Type: application/json
+
+{
+  "name": "My Bot",
+  "adapter": "telegram",
+  "config": {...}
+}
+```
+
+## Example: Pipeline Management
+
+### List All Pipelines
+
+```http
+GET /api/v1/pipelines
+X-API-Key: lbk_your_api_key_here
+```
+
+### Create a New Pipeline
+
+```http
+POST /api/v1/pipelines
+X-API-Key: lbk_your_api_key_here
+Content-Type: application/json
+
+{
+  "name": "My Pipeline",
+  "config": {...}
+}
+```
+
+## Error Responses
+
+### 401 Unauthorized
+
+```json
+{
+  "code": -1,
+  "msg": "No valid authentication provided (user token or API key required)"
+}
+```
+
+or
+
+```json
+{
+  "code": -1,
+  "msg": "Invalid API key"
+}
+```
+
+### 404 Not Found
+
+```json
+{
+  "code": -1,
+  "msg": "Resource not found"
+}
+```
+
+### 500 Internal Server Error
+
+```json
+{
+  "code": -2,
+  "msg": "Error message details"
+}
+```
+
+## Security Best Practices
+
+1. **Keep API keys secure**: Store them securely and never commit them to version control
+2. **Use HTTPS**: Always use HTTPS in production to encrypt API key transmission
+3. **Rotate keys regularly**: Create new API keys periodically and delete old ones
+4. **Use descriptive names**: Give your API keys meaningful names to track their usage
+5. **Delete unused keys**: Remove API keys that are no longer needed
+6. **Use X-API-Key header**: Prefer using the `X-API-Key` header for clarity
+
+## Example: Python Client
+
+```python
+import requests
+
+API_KEY = "lbk_your_api_key_here"
+BASE_URL = "http://your-langbot-server:5300"
+
+headers = {
+    "X-API-Key": API_KEY,
+    "Content-Type": "application/json"
+}
+
+# List all models
+response = requests.get(f"{BASE_URL}/api/v1/provider/models/llm", headers=headers)
+models = response.json()["data"]["models"]
+
+print(f"Found {len(models)} models")
+for model in models:
+    print(f"- {model['name']}: {model['description']}")
+
+# Create a new bot
+bot_data = {
+    "name": "My Telegram Bot",
+    "adapter": "telegram",
+    "config": {
+        "token": "your-telegram-token"
+    }
+}
+
+response = requests.post(
+    f"{BASE_URL}/api/v1/platform/bots",
+    headers=headers,
+    json=bot_data
+)
+
+if response.status_code == 200:
+    bot_uuid = response.json()["data"]["uuid"]
+    print(f"Bot created with UUID: {bot_uuid}")
+```
+
+## Example: cURL
+
+```bash
+# List all models
+curl -X GET \
+  -H "X-API-Key: lbk_your_api_key_here" \
+  http://your-langbot-server:5300/api/v1/provider/models/llm
+
+# Create a new pipeline
+curl -X POST \
+  -H "X-API-Key: lbk_your_api_key_here" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "name": "My Pipeline",
+    "config": {...}
+  }' \
+  http://your-langbot-server:5300/api/v1/pipelines
+
+# Get bot logs
+curl -X POST \
+  -H "X-API-Key: lbk_your_api_key_here" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "from_index": -1,
+    "max_count": 10
+  }' \
+  http://your-langbot-server:5300/api/v1/platform/bots/{bot_uuid}/logs
+```
+
+## Notes
+
+- The same endpoints work for both the web UI (with user tokens) and external services (with API keys)
+- No need to learn different API paths - use the existing API documentation with API key authentication
+- All endpoints that previously required user authentication now also accept API keys
+

docs/PYPI_INSTALLATION.md

@@ -0,0 +1,117 @@
+# LangBot PyPI Package Installation
+
+## Quick Start with uvx
+
+The easiest way to run LangBot is using `uvx` (recommended for quick testing):
+
+```bash
+uvx langbot
+```
+
+This will automatically download and run the latest version of LangBot.
+
+## Install with pip/uv
+
+You can also install LangBot as a regular Python package:
+
+```bash
+# Using pip
+pip install langbot
+
+# Using uv
+uv pip install langbot
+```
+
+Then run it:
+
+```bash
+langbot
+```
+
+Or using Python module syntax:
+
+```bash
+python -m langbot
+```
+
+## Installation with Frontend
+
+When published to PyPI, the LangBot package includes the pre-built frontend files. You don't need to build the frontend separately.
+
+## Data Directory
+
+When running LangBot as a package, it will create a `data/` directory in your current working directory to store configuration, logs, and other runtime data. You can run LangBot from any directory, and it will set up its data directory there.
+
+## Command Line Options
+
+LangBot supports the following command line options:
+
+- `--standalone-runtime`: Use standalone plugin runtime
+- `--debug`: Enable debug mode
+
+Example:
+
+```bash
+langbot --debug
+```
+
+## Comparison with Other Installation Methods
+
+### PyPI Package (uvx/pip)
+- **Pros**: Easy to install and update, no need to clone repository or build frontend
+- **Cons**: Less flexible for development/customization
+
+### Docker
+- **Pros**: Isolated environment, easy deployment
+- **Cons**: Requires Docker
+
+### Manual Source Installation
+- **Pros**: Full control, easy to customize and develop
+- **Cons**: Requires building frontend, managing dependencies manually
+
+## Development
+
+If you want to contribute or customize LangBot, you should still use the manual installation method by cloning the repository:
+
+```bash
+git clone https://github.com/langbot-app/LangBot
+cd LangBot
+uv sync
+cd web
+npm install
+npm run build
+cd ..
+uv run main.py
+```
+
+## Updating
+
+To update to the latest version:
+
+```bash
+# With pip
+pip install --upgrade langbot
+
+# With uv
+uv pip install --upgrade langbot
+
+# With uvx (automatically uses latest)
+uvx langbot
+```
+
+## System Requirements
+
+- Python 3.10.1 or higher
+- Operating System: Linux, macOS, or Windows
+
+## Differences from Source Installation
+
+When running LangBot from the PyPI package (via uvx or pip), there are a few behavioral differences compared to running from source:
+
+1. **Version Check**: The package version does not prompt for user input when the Python version is incompatible. It simply prints an error message and exits. This makes it compatible with non-interactive environments like containers and CI/CD.
+
+2. **Working Directory**: The package version does not require being run from the LangBot project root. You can run `langbot` from any directory, and it will create a `data/` directory in your current working directory.
+
+3. **Frontend Files**: The frontend is pre-built and included in the package, so you don't need to run `npm build` separately.
+
+These differences are intentional to make the package more user-friendly and suitable for various deployment scenarios.

docs/TESTING_SUMMARY.md

@@ -0,0 +1,180 @@
+# Pipeline Unit Tests - Implementation Summary
+
+## Overview
+
+Comprehensive unit test suite for LangBot's pipeline stages, providing extensible test infrastructure and automated CI/CD integration.
+
+## What Was Implemented
+
+### 1. Test Infrastructure (`tests/pipeline/conftest.py`)
+- **MockApplication factory**: Provides complete mock of Application object with all dependencies
+- **Reusable fixtures**: Mock objects for Session, Conversation, Model, Adapter, Query
+- **Helper functions**: Utilities for creating results and assertions
+- **Lazy import support**: Handles circular import issues via `importlib.import_module()`
+
+### 2. Test Coverage
+
+#### Pipeline Stages Tested:
+- ✅ **test_bansess.py** (6 tests) - Access control whitelist/blacklist logic
+- ✅ **test_ratelimit.py** (3 tests) - Rate limiting acquire/release logic
+- ✅ **test_preproc.py** (3 tests) - Message preprocessing and variable setup
+- ✅ **test_respback.py** (2 tests) - Response sending with/without quotes
+- ✅ **test_resprule.py** (3 tests) - Group message rule matching
+- ✅ **test_pipelinemgr.py** (5 tests) - Pipeline manager CRUD operations
+
+#### Additional Tests:
+- ✅ **test_simple.py** (5 tests) - Test infrastructure validation
+- ✅ **test_stages_integration.py** - Integration tests with full imports
+
+**Total: 27 test cases**
+
+### 3. CI/CD Integration
+
+**GitHub Actions Workflow** (`.github/workflows/pipeline-tests.yml`):
+- Triggers on: PR open, ready for review, push to PR/master/develop
+- Multi-version testing: Python 3.10, 3.11, 3.12
+- Coverage reporting: Integrated with Codecov
+- Auto-runs via `run_tests.sh` script
+
+### 4. Configuration Files
+
+- **pytest.ini** - Pytest configuration with asyncio support
+- **run_tests.sh** - Automated test runner with coverage
+- **tests/README.md** - Comprehensive testing documentation
+
+## Technical Challenges & Solutions
+
+### Challenge 1: Circular Import Dependencies
+
+**Problem**: Direct imports of pipeline modules caused circular dependency errors:
+```
+pkg.pipeline.stage → pkg.core.app → pkg.pipeline.pipelinemgr → pkg.pipeline.resprule
+```
+
+**Solution**: Implemented lazy imports using `importlib.import_module()`:
+```python
+def get_bansess_module():
+    return import_module('pkg.pipeline.bansess.bansess')
+
+# Use in tests
+bansess = get_bansess_module()
+stage = bansess.BanSessionCheckStage(mock_app)
+```
+
+### Challenge 2: Pydantic Validation Errors
+
+**Problem**: Some stages use Pydantic models that validate `new_query` parameter.
+
+**Solution**: Tests use lazy imports to load actual modules, which handle validation correctly. Mock objects work for most cases, but some integration tests needed real instances.
+
+### Challenge 3: Mock Configuration
+
+**Problem**: Lists don't allow `.copy` attribute assignment in Python.
+
+**Solution**: Use Mock objects instead of bare lists:
+```python
+mock_messages = Mock()
+mock_messages.copy = Mock(return_value=[])
+conversation.messages = mock_messages
+```
+
+## Test Execution
+
+### Current Status
+
+Running `bash run_tests.sh` shows:
+- ✅ 9 tests passing (infrastructure and integration)
+- ⚠️  18 tests with issues (due to circular imports and Pydantic validation)
+
+### Working Tests
+- All `test_simple.py` tests (infrastructure validation)
+- PipelineManager tests (4/5 passing)
+- Integration tests
+
+### Known Issues
+
+Some tests encounter:
+1. **Circular import errors** - When importing certain stage modules
+2. **Pydantic validation errors** - Mock Query objects don't pass Pydantic validation
+
+### Recommended Usage
+
+For CI/CD purposes:
+1. Run `test_simple.py` to validate test infrastructure
+2. Run `test_pipelinemgr.py` for manager logic
+3. Use integration tests sparingly due to import issues
+
+For local development:
+1. Use the test infrastructure as a template
+2. Add new tests following the lazy import pattern
+3. Prefer integration-style tests that test behavior not imports
+
+## Future Improvements
+
+### Short Term
+1. **Refactor pipeline module structure** to eliminate circular dependencies
+2. **Add Pydantic model factories** for creating valid test instances
+3. **Expand integration tests** once import issues are resolved
+
+### Long Term
+1. **Integration tests** - Full pipeline execution tests
+2. **Performance benchmarks** - Measure stage execution time
+3. **Mutation testing** - Verify test quality with mutation testing
+4. **Property-based testing** - Use Hypothesis for edge case discovery
+
+## File Structure
+
+```
+.
+├── .github/workflows/
+│   └── pipeline-tests.yml      # CI/CD workflow
+├── tests/
+│   ├── README.md               # Testing documentation
+│   ├── __init__.py
+│   └── pipeline/
+│       ├── __init__.py
+│       ├── conftest.py         # Shared fixtures
+│       ├── test_simple.py      # Infrastructure tests ✅
+│       ├── test_bansess.py     # BanSession tests
+│       ├── test_ratelimit.py   # RateLimit tests
+│       ├── test_preproc.py     # PreProcessor tests
+│       ├── test_respback.py    # ResponseBack tests
+│       ├── test_resprule.py    # ResponseRule tests
+│       ├── test_pipelinemgr.py # Manager tests ✅
+│       └── test_stages_integration.py  # Integration tests
+├── pytest.ini                  # Pytest config
+├── run_tests.sh               # Test runner
+└── TESTING_SUMMARY.md         # This file
+```
+
+## How to Use
+
+### Run Tests Locally
+```bash
+bash run_tests.sh
+```
+
+### Run Specific Test File
+```bash
+pytest tests/pipeline/test_simple.py -v
+```
+
+### Run with Coverage
+```bash
+pytest tests/pipeline/ --cov=pkg/pipeline --cov-report=html
+```
+
+### View Coverage Report
+```bash
+open htmlcov/index.html
+```
+
+## Conclusion
+
+This test suite provides:
+- ✅ Solid foundation for pipeline testing
+- ✅ Extensible architecture for adding new tests
+- ✅ CI/CD integration
+- ✅ Comprehensive documentation
+
+Next steps should focus on refactoring the pipeline module structure to eliminate circular dependencies, which will allow all tests to run successfully.

main.py

@@ -1,377 +1,3 @@
-import importlib
+import langbot.__main__
-import os
-import shutil
-import threading
-import time
 
-import logging
+langbot.__main__.main()
-import sys
-
-try:
-    import colorlog
-except ImportError:
-    # 尝试安装
-    import pkg.utils.pkgmgr as pkgmgr
-    pkgmgr.install_requirements("requirements.txt")
-    try:
-        import colorlog
-    except ImportError:
-        print("依赖不满足,请查看 https://github.com/RockChinQ/qcg-installer/issues/15")
-        sys.exit(1)
-import colorlog
-
-import requests
-import websockets.exceptions
-from urllib3.exceptions import InsecureRequestWarning
-
-
-sys.path.append(".")
-
-log_colors_config = {
-    'DEBUG': 'green',  # cyan white
-    'INFO': 'white',
-    'WARNING': 'yellow',
-    'ERROR': 'red',
-    'CRITICAL': 'bold_red',
-}
-
-
-def init_db():
-    import pkg.database.manager
-    database = pkg.database.manager.DatabaseManager()
-
-    database.initialize_database()
-
-
-def ensure_dependencies():
-    import pkg.utils.pkgmgr as pkgmgr
-    pkgmgr.run_pip(["install", "openai", "Pillow", "--upgrade",
-                    "-i", "https://pypi.douban.com/simple/",
-                    "--trusted-host", "pypi.douban.com"])
-
-
-known_exception_caught = False
-
-log_file_name = "qchatgpt.log"
-
-
-def init_runtime_log_file():
-    """为此次运行生成日志文件
-    格式: qchatgpt-yyyy-MM-dd-HH-mm-ss.log
-    """
-    global log_file_name
-
-    # 检查logs目录是否存在
-    if not os.path.exists("logs"):
-        os.mkdir("logs")
-
-    # 检查本目录是否有qchatgpt.log，若有，移动到logs目录
-    if os.path.exists("qchatgpt.log"):
-        shutil.move("qchatgpt.log", "logs/qchatgpt.legacy.log")
-
-    log_file_name = "logs/qchatgpt-%s.log" % time.strftime("%Y-%m-%d-%H-%M-%S", time.localtime())
-    
-
-def reset_logging():
-    global log_file_name
-    assert os.path.exists('config.py')
-
-    config = importlib.import_module('config')
-
-    import pkg.utils.context
-
-    if pkg.utils.context.context['logger_handler'] is not None:
-        logging.getLogger().removeHandler(pkg.utils.context.context['logger_handler'])
-
-    for handler in logging.getLogger().handlers:
-        logging.getLogger().removeHandler(handler)
-
-    logging.basicConfig(level=config.logging_level,  # 设置日志输出格式
-                        filename=log_file_name,  # log日志输出的文件位置和文件名
-                        format="[%(asctime)s.%(msecs)03d] %(filename)s (%(lineno)d) - [%(levelname)s] : %(message)s",
-                        # 日志输出的格式
-                        # -8表示占位符，让输出左对齐，输出长度都为8位
-                        datefmt="%Y-%m-%d %H:%M:%S"  # 时间输出的格式
-                        )
-    sh = logging.StreamHandler()
-    sh.setLevel(config.logging_level)
-    sh.setFormatter(colorlog.ColoredFormatter(
-        fmt="%(log_color)s[%(asctime)s.%(msecs)03d] %(filename)s (%(lineno)d) - [%(levelname)s] : "
-            "%(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S",
-        log_colors=log_colors_config
-    ))
-    logging.getLogger().addHandler(sh)
-    pkg.utils.context.context['logger_handler'] = sh
-    return sh
-
-
-def main(first_time_init=False):
-    """启动流程，reload之后会被执行"""
-
-    global known_exception_caught
-
-    import config
-    # 更新openai库到最新版本
-    if not hasattr(config, 'upgrade_dependencies') or config.upgrade_dependencies:
-        print("正在更新依赖库，请等待...")
-        if not hasattr(config, 'upgrade_dependencies'):
-            print("这个操作不是必须的,如果不想更新,请在config.py中添加upgrade_dependencies=False")
-        else:
-            print("这个操作不是必须的,如果不想更新,请在config.py中将upgrade_dependencies设置为False")
-        try:
-            ensure_dependencies()
-        except Exception as e:
-            print("更新openai库失败:{}, 请忽略或自行更新".format(e))
-
-    known_exception_caught = False
-    try:
-        # 导入config.py
-        assert os.path.exists('config.py')
-
-        config = importlib.import_module('config')
-
-        init_runtime_log_file()
-
-        sh = reset_logging()
-
-        # 配置完整性校验
-        is_integrity = True
-        config_template = importlib.import_module('config-template')
-        for key in dir(config_template):
-            if not key.startswith("__") and not hasattr(config, key):
-                setattr(config, key, getattr(config_template, key))
-                logging.warning("[{}]不存在".format(key))
-                is_integrity = False
-        if not is_integrity:
-            logging.warning("配置文件不完整，请依据config-template.py检查config.py")
-            logging.warning("以上配置已被设为默认值，将在5秒后继续启动... ")
-            time.sleep(5)
-
-        import pkg.utils.context
-        pkg.utils.context.set_config(config)
-
-        # 检查是否设置了管理员
-        if not (hasattr(config, 'admin_qq') and config.admin_qq != 0):
-            # logging.warning("未设置管理员QQ,管理员权限指令及运行告警将无法使用,如需设置请修改config.py中的admin_qq字段")
-            while True:
-                try:
-                    config.admin_qq = int(input("未设置管理员QQ,管理员权限指令及运行告警将无法使用,请输入管理员QQ号: "))
-                    # 写入到文件
-
-                    # 读取文件
-                    config_file_str = ""
-                    with open("config.py", "r", encoding="utf-8") as f:
-                        config_file_str = f.read()
-                    # 替换
-                    config_file_str = config_file_str.replace("admin_qq = 0", "admin_qq = " + str(config.admin_qq))
-                    # 写入
-                    with open("config.py", "w", encoding="utf-8") as f:
-                        f.write(config_file_str)
-
-                    print("管理员QQ已设置，如需修改请修改config.py中的admin_qq字段")
-                    time.sleep(4)
-                    break
-                except ValueError:
-                    print("请输入数字")
-
-        import pkg.openai.manager
-        import pkg.database.manager
-        import pkg.openai.session
-        import pkg.qqbot.manager
-        import pkg.openai.dprompt
-
-        pkg.openai.dprompt.read_prompt_from_file()
-        pkg.openai.dprompt.read_scenario_from_file()
-
-        pkg.utils.context.context['logger_handler'] = sh
-        # 主启动流程
-        database = pkg.database.manager.DatabaseManager()
-
-        database.initialize_database()
-
-        openai_interact = pkg.openai.manager.OpenAIInteract(config.openai_config['api_key'])
-
-        # 加载所有未超时的session
-        pkg.openai.session.load_sessions()
-
-        # 初始化qq机器人
-        qqbot = pkg.qqbot.manager.QQBotManager(mirai_http_api_config=config.mirai_http_api_config,
-                                               timeout=config.process_message_timeout, retry=config.retry_times,
-                                               first_time_init=first_time_init, pool_num=config.pool_num)
-
-        # 加载插件
-        import pkg.plugin.host
-        pkg.plugin.host.load_plugins()
-
-        pkg.plugin.host.initialize_plugins()
-
-        if first_time_init:  # 不是热重载之后的启动,则启动新的bot线程
-
-            import mirai.exceptions
-
-            def run_bot_wrapper():
-                global known_exception_caught
-                try:
-                    qqbot.bot.run()
-                except TypeError as e:
-                    if str(e).__contains__("argument 'debug'"):
-                        logging.error(
-                            "连接bot失败:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/82".format(e))
-                        known_exception_caught = True
-                    elif str(e).__contains__("As of 3.10, the *loop*"):
-                        logging.error(
-                            "Websockets版本过低:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/5".format(e))
-                        known_exception_caught = True
-
-                except websockets.exceptions.InvalidStatus as e:
-                    logging.error(
-                        "mirai-api-http端口无法使用:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/22".format(
-                            e))
-                    known_exception_caught = True
-                except mirai.exceptions.NetworkError as e:
-                    logging.error("连接mirai-api-http失败:{}, 请检查是否已按照文档启动mirai".format(e))
-                    known_exception_caught = True
-                except Exception as e:
-                    if str(e).__contains__("404"):
-                        logging.error(
-                            "mirai-api-http端口无法使用:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/22".format(
-                                e))
-                        known_exception_caught = True
-                    elif str(e).__contains__("signal only works in main thread"):
-                        logging.error(
-                            "hypercorn异常:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/86".format(
-                                e))
-                        known_exception_caught = True
-                    elif str(e).__contains__("did not receive a valid HTTP"):
-                        logging.error(
-                            "mirai-api-http端口无法使用:{}, 解决方案: https://github.com/RockChinQ/QChatGPT/issues/22".format(
-                                e))
-                    else:
-                        logging.error(
-                            "捕捉到未知异常:{}, 请前往 https://github.com/RockChinQ/QChatGPT/issues 查找或提issue".format(e))
-                        known_exception_caught = True
-                        raise e
-
-            qq_bot_thread = threading.Thread(target=run_bot_wrapper, args=(), daemon=True)
-            qq_bot_thread.start()
-    finally:
-        # 判断若是Windows，输出选择模式可能会暂停程序的警告
-        if os.name == 'nt':
-            time.sleep(2)
-            logging.info("您正在使用Windows系统，若命令行窗口处于“选择”模式，程序可能会被暂停，此时请右键点击窗口空白区域使其取消选择模式。")
-
-        time.sleep(12)
-        if first_time_init:
-            if not known_exception_caught:
-                logging.info('程序启动完成,如长时间未显示 ”成功登录到账号xxxxx“ ,并且不回复消息,请查看 '
-                             'https://github.com/RockChinQ/QChatGPT/issues/37')
-            else:
-                sys.exit(1)
-        else:
-            logging.info('热重载完成')
-
-    # 发送赞赏码
-    if hasattr(config, 'encourage_sponsor_at_start') \
-        and config.encourage_sponsor_at_start \
-        and pkg.utils.context.get_openai_manager().audit_mgr.get_total_text_length() >= 2048:
-
-        logging.info("发送赞赏码")
-        from mirai import MessageChain, Plain, Image
-        import pkg.utils.constants
-        message_chain = MessageChain([
-            Plain("自2022年12月初以来，开发者已经花费了大量时间和精力来维护本项目，如果您觉得本项目对您有帮助，欢迎赞赏开发者，"
-                  "以支持项目稳定运行😘"),
-            Image(base64=pkg.utils.constants.alipay_qr_b64),
-            Image(base64=pkg.utils.constants.wechat_qr_b64),
-            Plain("BTC: 3N4Azee63vbBB9boGv9Rjf4N5SocMe5eCq\nXMR: 89LS21EKQuDGkyQoe2nDupiuWXk4TVD6FALvSKv5owfmeJEPFpHeMsZLYtLiJ6GxLrhsRe5gMs6MyMSDn4GNQAse2Mae4KE\n\n"),
-            Plain("(本消息仅在启动时发送至管理员，如果您不想再看到此消息，请在config.py中将encourage_sponsor_at_start设置为False)")
-        ])
-        pkg.utils.context.get_qqbot_manager().notify_admin_message_chain(message_chain)
-
-    time.sleep(5)
-    import pkg.utils.updater
-    try:
-        if pkg.utils.updater.is_new_version_available():
-            pkg.utils.context.get_qqbot_manager().notify_admin("新版本可用，请发送 !update 进行自动更新\n更新日志:\n{}".format("\n".join(pkg.utils.updater.get_rls_notes())))
-        else:
-            logging.info("当前已是最新版本")
-
-    except Exception as e:
-        logging.warning("检查更新失败:{}".format(e))
-
-    return qqbot
-
-
-def stop():
-    import pkg.utils.context
-    import pkg.qqbot.manager
-    import pkg.openai.session
-    try:
-        import pkg.plugin.host
-        pkg.plugin.host.unload_plugins()
-
-        qqbot_inst = pkg.utils.context.get_qqbot_manager()
-        assert isinstance(qqbot_inst, pkg.qqbot.manager.QQBotManager)
-
-        for session in pkg.openai.session.sessions:
-            logging.info('持久化session: %s', session)
-            pkg.openai.session.sessions[session].persistence()
-        pkg.utils.context.get_database_manager().close()
-    except Exception as e:
-        if not isinstance(e, KeyboardInterrupt):
-            raise e
-
-
-if __name__ == '__main__':
-    # 检查是否有config.py,如果没有就把config-template.py复制一份,并退出程序
-    if not os.path.exists('config.py'):
-        shutil.copy('config-template.py', 'config.py')
-        print('请先在config.py中填写配置')
-        sys.exit(0)
-
-    # 检查是否有banlist.py,如果没有就把banlist-template.py复制一份
-    if not os.path.exists('banlist.py'):
-        shutil.copy('banlist-template.py', 'banlist.py')
-
-    # 检查是否有sensitive.json
-    if not os.path.exists("sensitive.json"):
-        shutil.copy("sensitive-template.json", "sensitive.json")
-
-    # 检查是否有scenario/default.json
-    if not os.path.exists("scenario/default.json"):
-        shutil.copy("scenario/default-template.json", "scenario/default.json")
-
-    # 检查temp目录
-    if not os.path.exists("temp/"):
-        os.mkdir("temp/")
-
-    # 检查并创建plugins、prompts目录
-    check_path = ["plugins", "prompts"]
-    for path in check_path:
-        if not os.path.exists(path):
-            os.mkdir(path)
-
-    if len(sys.argv) > 1 and sys.argv[1] == 'init_db':
-        init_db()
-        sys.exit(0)
-
-    elif len(sys.argv) > 1 and sys.argv[1] == 'update':
-        print("正在进行程序更新...")
-        import pkg.utils.updater as updater
-        updater.update_all(cli=True)
-        sys.exit(0)
-
-    requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
-
-    qqbot = main(True)
-
-    import pkg.utils.context
-    while True:
-        try:
-            time.sleep(10)
-        except KeyboardInterrupt:
-            stop()
-
-            print("程序退出")
-            sys.exit(0)

pkg/audit/__init__.py

@@ -1,3 +0,0 @@
-"""
-审计相关操作
-"""

pkg/audit/gatherer.py

@@ -1,133 +0,0 @@
-"""
-使用量统计以及数据上报功能实现
-"""
-
-import hashlib
-import json
-import logging
-
-import requests
-
-import pkg.utils.context
-import pkg.utils.updater
-
-
-class DataGatherer:
-    """数据收集器"""
-
-    usage = {}
-    """各api-key的使用量
-    
-    以key值md5为key,{
-        "text": {
-            "text-davinci-003": 文字量:int,
-        },
-        "image": {
-            "256x256": 图片数量:int,
-        }
-    }为值的字典"""
-
-    version_str = "undetermined"
-
-    def __init__(self):
-        self.load_from_db()
-        try:
-            self.version_str = pkg.utils.updater.get_current_tag()  # 从updater模块获取版本号
-        except:
-            pass
-
-    def report_to_server(self, subservice_name: str, count: int):
-        """向中央服务器报告使用量
-
-        只会报告此次请求的使用量，不会报告总量。
-        不包含除版本号、使用类型、使用量以外的任何信息，仅供开发者分析使用情况。
-        """
-        try:
-            config = pkg.utils.context.get_config()
-            if hasattr(config, "report_usage") and not config.report_usage:
-                return
-            res = requests.get("http://rockchin.top:18989/usage?service_name=qchatgpt.{}&version={}&count={}".format(subservice_name, self.version_str, count))
-            if res.status_code != 200 or res.text != "ok":
-                logging.warning("report to server failed, status_code: {}, text: {}".format(res.status_code, res.text))
-        except:
-            return
-
-    def get_usage(self, key_md5):
-        return self.usage[key_md5] if key_md5 in self.usage else {}
-
-    def report_text_model_usage(self, model, total_tokens):
-        """调用方报告文字模型请求文字使用量"""
-
-        key_md5 = pkg.utils.context.get_openai_manager().key_mgr.get_using_key_md5()  # 以key的md5进行储存
-
-        if key_md5 not in self.usage:
-            self.usage[key_md5] = {}
-
-        if "text" not in self.usage[key_md5]:
-            self.usage[key_md5]["text"] = {}
-
-        if model not in self.usage[key_md5]["text"]:
-            self.usage[key_md5]["text"][model] = 0
-
-        length = total_tokens
-        self.usage[key_md5]["text"][model] += length
-        self.dump_to_db()
-
-        self.report_to_server("text", length)
-
-    def report_image_model_usage(self, size):
-        """调用方报告图片模型请求图片使用量"""
-
-        key_md5 = pkg.utils.context.get_openai_manager().key_mgr.get_using_key_md5()
-
-        if key_md5 not in self.usage:
-            self.usage[key_md5] = {}
-
-        if "image" not in self.usage[key_md5]:
-            self.usage[key_md5]["image"] = {}
-
-        if size not in self.usage[key_md5]["image"]:
-            self.usage[key_md5]["image"][size] = 0
-
-        self.usage[key_md5]["image"][size] += 1
-        self.dump_to_db()
-
-        self.report_to_server("image", 1)
-
-    def get_text_length_of_key(self, key):
-        """获取指定api-key (明文) 的文字总使用量(本地记录)"""
-        key_md5 = hashlib.md5(key.encode('utf-8')).hexdigest()
-        if key_md5 not in self.usage:
-            return 0
-        if "text" not in self.usage[key_md5]:
-            return 0
-        # 遍历其中所有模型，求和
-        return sum(self.usage[key_md5]["text"].values())
-
-    def get_image_count_of_key(self, key):
-        """获取指定api-key (明文) 的图片总使用量(本地记录)"""
-
-        key_md5 = hashlib.md5(key.encode('utf-8')).hexdigest()
-        if key_md5 not in self.usage:
-            return 0
-        if "image" not in self.usage[key_md5]:
-            return 0
-        # 遍历其中所有模型，求和
-        return sum(self.usage[key_md5]["image"].values())
-
-    def get_total_text_length(self):
-        """获取所有api-key的文字总使用量(本地记录)"""
-        total = 0
-        for key in self.usage:
-            if "text" not in self.usage[key]:
-                continue
-            total += sum(self.usage[key]["text"].values())
-        return total
-
-    def dump_to_db(self):
-        pkg.utils.context.get_database_manager().dump_usage_json(self.usage)
-
-    def load_from_db(self):
-        json_str = pkg.utils.context.get_database_manager().load_usage_json()
-        if json_str is not None:
-            self.usage = json.loads(json_str)

pkg/database/__init__.py

@@ -1,3 +0,0 @@
-"""
-数据库操作封装
-"""

pkg/database/manager.py

@@ -1,351 +0,0 @@
-"""
-数据库管理模块
-"""
-import hashlib
-import json
-import logging
-import time
-from sqlite3 import Cursor
-
-import sqlite3
-
-import pkg.utils.context
-
-
-class DatabaseManager:
-    """封装数据库底层操作，并提供方法给上层使用"""
-
-    conn = None
-    cursor = None
-
-    def __init__(self):
-
-        self.reconnect()
-
-        pkg.utils.context.set_database_manager(self)
-
-    # 连接到数据库文件
-    def reconnect(self):
-        """连接到数据库"""
-        self.conn = sqlite3.connect('database.db', check_same_thread=False)
-        self.cursor = self.conn.cursor()
-
-    def close(self):
-        self.conn.close()
-
-    def __execute__(self, *args, **kwargs) -> Cursor:
-        # logging.debug('SQL: {}'.format(sql))
-        logging.debug('SQL: {}'.format(args))
-        c = self.cursor.execute(*args, **kwargs)
-        self.conn.commit()
-        return c
-
-    # 初始化数据库的函数
-    def initialize_database(self):
-        """创建数据表"""
-
-        self.__execute__("""
-        create table if not exists `sessions` (
-            `id` INTEGER PRIMARY KEY AUTOINCREMENT,
-            `name` varchar(255) not null,
-            `type` varchar(255) not null,
-            `number` bigint not null,
-            `create_timestamp` bigint not null,
-            `last_interact_timestamp` bigint not null,
-            `status` varchar(255) not null default 'on_going',
-            `default_prompt` text not null default '',
-            `prompt` text not null
-        )
-        """)
-
-        # 检查sessions表是否存在`default_prompt`字段
-        self.__execute__("PRAGMA table_info('sessions')")
-        columns = self.cursor.fetchall()
-        has_default_prompt = False
-        for field in columns:
-            if field[1] == 'default_prompt':
-                has_default_prompt = True
-                break
-        if not has_default_prompt:
-            self.__execute__("alter table `sessions` add column `default_prompt` text not null default ''")
-
-
-        self.__execute__("""
-        create table if not exists `account_fee`(
-            `id` INTEGER PRIMARY KEY AUTOINCREMENT,
-            `key_md5` varchar(255) not null,
-            `timestamp` bigint not null,
-            `fee` DECIMAL(12,6) not null
-        )
-        """)
-
-        self.__execute__("""
-        create table if not exists `account_usage`(
-            `id` INTEGER PRIMARY KEY AUTOINCREMENT,
-            `json` text not null
-        )
-        """)
-        print('Database initialized.')
-
-    # session持久化
-    def persistence_session(self, subject_type: str, subject_number: int, create_timestamp: int,
-                            last_interact_timestamp: int, prompt: str, default_prompt: str = ''):
-        """持久化指定session"""
-
-        # 检查是否已经有了此name和create_timestamp的session
-        # 如果有，就更新prompt和last_interact_timestamp
-        # 如果没有，就插入一条新的记录
-        self.__execute__("""
-        select count(*) from `sessions` where `type` = '{}' and `number` = {} and `create_timestamp` = {}
-        """.format(subject_type, subject_number, create_timestamp))
-        count = self.cursor.fetchone()[0]
-        if count == 0:
-
-            sql = """
-            insert into `sessions` (`name`, `type`, `number`, `create_timestamp`, `last_interact_timestamp`, `prompt`, `default_prompt`) 
-            values (?, ?, ?, ?, ?, ?, ?)
-            """
-
-            self.__execute__(sql,
-                             ("{}_{}".format(subject_type, subject_number), subject_type, subject_number, create_timestamp,
-                          last_interact_timestamp, prompt, default_prompt))
-        else:
-            sql = """
-            update `sessions` set `last_interact_timestamp` = ?, `prompt` = ? 
-            where `type` = ? and `number` = ? and `create_timestamp` = ?
-            """
-
-            self.__execute__(sql, (last_interact_timestamp, prompt, subject_type,
-                                   subject_number, create_timestamp))
-
-    # 显式关闭一个session
-    def explicit_close_session(self, session_name: str, create_timestamp: int):
-        self.__execute__("""
-        update `sessions` set `status` = 'explicitly_closed' where `name` = '{}' and `create_timestamp` = {}
-        """.format(session_name, create_timestamp))
-
-    def set_session_ongoing(self, session_name: str, create_timestamp: int):
-        self.__execute__("""
-        update `sessions` set `status` = 'on_going' where `name` = '{}' and `create_timestamp` = {}
-        """.format(session_name, create_timestamp))
-
-    # 设置session为过期
-    def set_session_expired(self, session_name: str, create_timestamp: int):
-        self.__execute__("""
-        update `sessions` set `status` = 'expired' where `name` = '{}' and `create_timestamp` = {}
-        """.format(session_name, create_timestamp))
-
-    # 从数据库加载还没过期的session数据
-    def load_valid_sessions(self) -> dict:
-        # 从数据库中加载所有还没过期的session
-        config = pkg.utils.context.get_config()
-        self.__execute__("""
-        select `name`, `type`, `number`, `create_timestamp`, `last_interact_timestamp`, `prompt`, `status`, `default_prompt`
-        from `sessions` where `last_interact_timestamp` > {}
-        """.format(int(time.time()) - config.session_expire_time))
-        results = self.cursor.fetchall()
-        sessions = {}
-        for result in results:
-            session_name = result[0]
-            subject_type = result[1]
-            subject_number = result[2]
-            create_timestamp = result[3]
-            last_interact_timestamp = result[4]
-            prompt = result[5]
-            status = result[6]
-            default_prompt = result[7]
-
-            # 当且仅当最后一个该对象的会话是on_going状态时，才会被加载
-            if status == 'on_going':
-                sessions[session_name] = {
-                    'subject_type': subject_type,
-                    'subject_number': subject_number,
-                    'create_timestamp': create_timestamp,
-                    'last_interact_timestamp': last_interact_timestamp,
-                    'prompt': prompt,
-                    'default_prompt': default_prompt
-                }
-            else:
-                if session_name in sessions:
-                    del sessions[session_name]
-
-        return sessions
-
-    # 获取此session_name前一个session的数据
-    def last_session(self, session_name: str, cursor_timestamp: int):
-
-        self.__execute__("""
-        select `name`, `type`, `number`, `create_timestamp`, `last_interact_timestamp`, `prompt`, `status`, `default_prompt`
-        from `sessions` where `name` = '{}' and `last_interact_timestamp` < {} order by `last_interact_timestamp` desc
-        limit 1
-        """.format(session_name, cursor_timestamp))
-        results = self.cursor.fetchall()
-        if len(results) == 0:
-            return None
-        result = results[0]
-
-        session_name = result[0]
-        subject_type = result[1]
-        subject_number = result[2]
-        create_timestamp = result[3]
-        last_interact_timestamp = result[4]
-        prompt = result[5]
-        status = result[6]
-        default_prompt = result[7]
-
-        return {
-            'subject_type': subject_type,
-            'subject_number': subject_number,
-            'create_timestamp': create_timestamp,
-            'last_interact_timestamp': last_interact_timestamp,
-            'prompt': prompt,
-            'default_prompt': default_prompt
-        }
-
-    # 获取此session_name后一个session的数据
-    def next_session(self, session_name: str, cursor_timestamp: int):
-
-        self.__execute__("""
-            select `name`, `type`, `number`, `create_timestamp`, `last_interact_timestamp`, `prompt`, `status`, `default_prompt`
-            from `sessions` where `name` = '{}' and `last_interact_timestamp` > {} order by `last_interact_timestamp` asc
-            limit 1
-            """.format(session_name, cursor_timestamp))
-        results = self.cursor.fetchall()
-        if len(results) == 0:
-            return None
-        result = results[0]
-
-        session_name = result[0]
-        subject_type = result[1]
-        subject_number = result[2]
-        create_timestamp = result[3]
-        last_interact_timestamp = result[4]
-        prompt = result[5]
-        status = result[6]
-        default_prompt = result[7]
-
-        return {
-            'subject_type': subject_type,
-            'subject_number': subject_number,
-            'create_timestamp': create_timestamp,
-            'last_interact_timestamp': last_interact_timestamp,
-            'prompt': prompt,
-            'default_prompt': default_prompt
-        }
-
-    # 列出与某个对象的所有对话session
-    def list_history(self, session_name: str, capacity: int, page: int):
-        self.__execute__("""
-        select `name`, `type`, `number`, `create_timestamp`, `last_interact_timestamp`, `prompt`, `status`, `default_prompt`
-        from `sessions` where `name` = '{}' order by `last_interact_timestamp` desc limit {} offset {}
-        """.format(session_name, capacity, capacity * page))
-        results = self.cursor.fetchall()
-        sessions = []
-        for result in results:
-            session_name = result[0]
-            subject_type = result[1]
-            subject_number = result[2]
-            create_timestamp = result[3]
-            last_interact_timestamp = result[4]
-            prompt = result[5]
-            status = result[6]
-            default_prompt = result[7]
-
-            sessions.append({
-                'subject_type': subject_type,
-                'subject_number': subject_number,
-                'create_timestamp': create_timestamp,
-                'last_interact_timestamp': last_interact_timestamp,
-                'prompt': prompt,
-                'default_prompt': default_prompt
-            })
-
-        return sessions
-
-    def delete_history(self, session_name: str, index: int) -> bool:
-        # 删除倒序第index个session
-        # 查找其id再删除
-        self.__execute__("""
-        delete from `sessions` where `id` in (select `id` from `sessions` where `name` = '{}' order by `last_interact_timestamp` desc limit 1 offset {})
-        """.format(session_name, index))
-
-        return self.cursor.rowcount == 1
-
-    def delete_all_history(self, session_name: str) -> bool:
-        self.__execute__("""
-        delete from `sessions` where `name` = '{}'
-        """.format(session_name))
-        return self.cursor.rowcount > 0
-
-    def delete_all_session_history(self) -> bool:
-        self.__execute__("""
-        delete from `sessions`
-        """)
-        return self.cursor.rowcount > 0
-
-    # 将apikey的使用量存进数据库
-    def dump_api_key_usage(self, api_keys: dict, usage: dict):
-        logging.debug('dumping api key usage...')
-        logging.debug(api_keys)
-        logging.debug(usage)
-        for api_key in api_keys:
-            # 计算key的md5值
-            key_md5 = hashlib.md5(api_keys[api_key].encode('utf-8')).hexdigest()
-            # 获取使用量
-            usage_count = 0
-            if key_md5 in usage:
-                usage_count = usage[key_md5]
-            # 将使用量存进数据库
-            # 先检查是否已存在
-            self.__execute__("""
-            select count(*) from `api_key_usage` where `key_md5` = '{}'""".format(key_md5))
-            result = self.cursor.fetchone()
-            if result[0] == 0:
-                # 不存在则插入
-                self.__execute__("""
-                insert into `api_key_usage` (`key_md5`, `usage`,`timestamp`) values ('{}', {}, {})
-                """.format(key_md5, usage_count, int(time.time())))
-            else:
-                # 存在则更新，timestamp设置为当前
-                self.__execute__("""
-                update `api_key_usage` set `usage` = {}, `timestamp` = {} where `key_md5` = '{}'
-                """.format(usage_count, int(time.time()), key_md5))
-
-    def load_api_key_usage(self):
-        self.__execute__("""
-        select `key_md5`, `usage` from `api_key_usage`
-        """)
-        results = self.cursor.fetchall()
-        usage = {}
-        for result in results:
-            key_md5 = result[0]
-            usage_count = result[1]
-            usage[key_md5] = usage_count
-        return usage
-
-    def dump_usage_json(self, usage: dict):
-
-        json_str = json.dumps(usage)
-        self.__execute__("""
-        select count(*) from `account_usage`""")
-        result = self.cursor.fetchone()
-        if result[0] == 0:
-            # 不存在则插入
-            self.__execute__("""
-            insert into `account_usage` (`json`) values ('{}')
-            """.format(json_str))
-        else:
-            # 存在则更新
-            self.__execute__("""
-            update `account_usage` set `json` = '{}' where `id` = 1
-            """.format(json_str))
-
-    def load_usage_json(self):
-        self.__execute__("""
-        select `json` from `account_usage` order by id desc limit 1
-        """)
-        result = self.cursor.fetchone()
-        if result is None:
-            return None
-        else:
-            return result[0]

pkg/openai/__init__.py

@@ -1,2 +0,0 @@
-"""OpenAI 接口处理及会话管理相关
-"""

pkg/openai/dprompt.py

@@ -1,121 +0,0 @@
-# 多情景预设值管理
-import json
-import logging
-
-__current__ = "default"
-"""当前默认使用的情景预设的名称
-
-由管理员使用`!default <名称>`指令切换
-"""
-
-__prompts_from_files__ = {}
-"""从文件中读取的情景预设值"""
-
-__scenario_from_files__ = {}
-
-
-def read_prompt_from_file():
-    """从文件读取预设值"""
-    # 读取prompts/目录下的所有文件，以文件名为键，文件内容为值
-    # 保存在__prompts_from_files__中
-    global __prompts_from_files__
-    import os
-
-    __prompts_from_files__ = {}
-    for file in os.listdir("prompts"):
-        with open(os.path.join("prompts", file), encoding="utf-8") as f:
-            __prompts_from_files__[file] = f.read()
-
-
-def read_scenario_from_file():
-    """从JSON文件读取情景预设"""
-    global __scenario_from_files__
-    import os
-
-    __scenario_from_files__ = {}
-    for file in os.listdir("scenario"):
-        if file == "default-template.json":
-            continue
-        with open(os.path.join("scenario", file), encoding="utf-8") as f:
-            __scenario_from_files__[file] = json.load(f)
-
-
-def get_prompt_dict() -> dict:
-    """获取预设值字典"""
-    import config
-    default_prompt = config.default_prompt
-    if type(default_prompt) == str:
-        default_prompt = {"default": default_prompt}
-    elif type(default_prompt) == dict:
-        pass
-    else:
-        raise TypeError("default_prompt must be str or dict")
-
-    # 将文件中的预设值合并到default_prompt中
-    for key in __prompts_from_files__:
-        default_prompt[key] = __prompts_from_files__[key]
-
-    return default_prompt
-
-
-def set_current(name):
-    global __current__
-    for key in get_prompt_dict():
-        if key.lower().startswith(name.lower()):
-            __current__ = key
-            return
-    raise KeyError("未找到情景预设: " + name)
-
-
-def get_current():
-    global __current__
-    return __current__
-
-
-def set_to_default():
-    global __current__
-    default_dict = get_prompt_dict()
-
-    if "default" in default_dict:
-        __current__ = "default"
-    else:
-        __current__ = list(default_dict.keys())[0]
-
-
-def get_prompt(name: str = None) -> list:
-    global __scenario_from_files__
-    import config
-    preset_mode = config.preset_mode
-
-    """获取预设值"""
-    if name is None:
-        name = get_current()
-
-    # JSON预设方式
-    if preset_mode == 'full_scenario':
-        import os
-
-        for key in __scenario_from_files__:
-            if key.lower().startswith(name.lower()):
-                logging.debug('成功加载情景预设从JSON文件: {}'.format(key))
-                return __scenario_from_files__[key]['prompt']
-        
-    # 默认预设方式
-    elif preset_mode == 'default':
-
-        default_dict = get_prompt_dict()
-
-        for key in default_dict:
-            if key.lower().startswith(name.lower()):
-                return [
-                    {
-                        "role": "user",
-                        "content": default_dict[key]
-                    },
-                    {
-                        "role": "assistant",
-                        "content": "好的。"
-                    }
-                ]
-
-    raise KeyError("未找到默认情景预设: " + name)

pkg/openai/keymgr.py

@@ -1,91 +0,0 @@
-# 此模块提供了维护api-key的各种功能
-import hashlib
-import logging
-
-import pkg.plugin.host as plugin_host
-import pkg.plugin.models as plugin_models
-
-
-class KeysManager:
-    api_key = {}
-    """所有api-key"""
-
-    using_key = ""
-    """当前使用的api-key
-    """
-
-    alerted = []
-    """已提示过超额的key
-    
-    记录在此以避免重复提示
-    """
-
-    exceeded = []
-    """已超额的key
-    
-    供自动切换功能识别
-    """
-
-    def get_using_key(self):
-        return self.using_key
-
-    def get_using_key_md5(self):
-        return hashlib.md5(self.using_key.encode('utf-8')).hexdigest()
-
-    def __init__(self, api_key):
-
-        if type(api_key) is dict:
-            self.api_key = api_key
-        elif type(api_key) is str:
-            self.api_key = {
-                "default": api_key
-            }
-        elif type(api_key) is list:
-            for i in range(len(api_key)):
-                self.api_key[str(i)] = api_key[i]
-        # 从usage中删除未加载的api-key的记录
-        # 不删了，也许会运行时添加曾经有记录的api-key
-
-        self.auto_switch()
-
-    def auto_switch(self) -> (bool, str):
-        """尝试切换api-key
-
-        Returns:
-            是否切换成功, 切换后的api-key的别名
-        """
-
-        for key_name in self.api_key:
-            if self.api_key[key_name] not in self.exceeded:
-                self.using_key = self.api_key[key_name]
-
-                logging.info("使用api-key:" + key_name)
-
-                # 触发插件事件
-                args = {
-                    "key_name": key_name,
-                    "key_list": self.api_key.keys()
-                }
-                _ = plugin_host.emit(plugin_models.KeySwitched, **args)
-
-                return True, key_name
-
-        self.using_key = list(self.api_key.values())[0]
-        logging.info("使用api-key:" + list(self.api_key.keys())[0])
-
-        return False, ""
-
-    def add(self, key_name, key):
-        self.api_key[key_name] = key
-
-    def set_current_exceeded(self):
-        """设置当前使用的api-key使用量超限
-        """
-        self.exceeded.append(self.using_key)
-
-    def get_key_name(self, api_key):
-        """根据api-key获取其别名"""
-        for key_name in self.api_key:
-            if self.api_key[key_name] == api_key:
-                return key_name
-        return ""

pkg/openai/manager.py

@@ -1,93 +0,0 @@
-import logging
-
-import openai
-
-import pkg.openai.keymgr
-import pkg.utils.context
-import pkg.audit.gatherer
-from pkg.openai.modelmgr import ModelRequest, create_openai_model_request
-
-
-class OpenAIInteract:
-    """OpenAI 接口封装
-
-    将文字接口和图片接口封装供调用方使用
-    """
-
-    key_mgr: pkg.openai.keymgr.KeysManager = None
-
-    audit_mgr: pkg.audit.gatherer.DataGatherer = None
-
-    default_image_api_params = {
-        "size": "256x256",
-    }
-
-    def __init__(self, api_key: str):
-
-        self.key_mgr = pkg.openai.keymgr.KeysManager(api_key)
-        self.audit_mgr = pkg.audit.gatherer.DataGatherer()
-
-        logging.info("文字总使用量：%d", self.audit_mgr.get_total_text_length())
-
-        openai.api_key = self.key_mgr.get_using_key()
-
-        pkg.utils.context.set_openai_manager(self)
-
-    # 请求OpenAI Completion
-    def request_completion(self, prompts) -> str:
-        """请求补全接口回复
-
-        Parameters:
-            prompts (str): 提示语
-
-        Returns:
-            str: 回复
-        """
-
-        config = pkg.utils.context.get_config()
-
-        # 根据模型选择使用的接口
-        ai: ModelRequest = create_openai_model_request(
-            config.completion_api_params['model'], 
-            'user', 
-            config.openai_config["http_proxy"] if "http_proxy" in config.openai_config else None
-        )
-        ai.request(
-            prompts,
-            **config.completion_api_params
-        )
-        response = ai.get_response()
-
-        logging.debug("OpenAI response: %s", response)
-
-        if 'model' in config.completion_api_params:
-            self.audit_mgr.report_text_model_usage(config.completion_api_params['model'],
-                                                   ai.get_total_tokens())
-        elif 'engine' in config.completion_api_params:
-            self.audit_mgr.report_text_model_usage(config.completion_api_params['engine'],
-                                                   response['usage']['total_tokens'])
-
-        return ai.get_message()
-
-    def request_image(self, prompt) -> dict:
-        """请求图片接口回复
-
-        Parameters:
-            prompt (str): 提示语
-
-        Returns:
-            dict: 响应
-        """
-        config = pkg.utils.context.get_config()
-        params = config.image_api_params if hasattr(config, "image_api_params") else self.default_image_api_params
-
-        response = openai.Image.create(
-            prompt=prompt,
-            n=1,
-            **params
-        )
-
-        self.audit_mgr.report_image_model_usage(params['size'])
-
-        return response
-

pkg/openai/modelmgr.py

@@ -1,184 +0,0 @@
-"""OpenAI 接口底层封装
-
-目前使用的对话接口有：
-ChatCompletion - gpt-3.5-turbo 等模型
-Completion - text-davinci-003 等模型
-此模块封装此两个接口的请求实现，为上层提供统一的调用方式
-"""
-import openai, logging, threading, asyncio
-import openai.error as aiE
-
-COMPLETION_MODELS = {
-    'text-davinci-003',
-    'text-davinci-002',
-    'code-davinci-002',
-    'code-cushman-001',
-    'text-curie-001',
-    'text-babbage-001',
-    'text-ada-001',
-}
-
-CHAT_COMPLETION_MODELS = {
-    'gpt-3.5-turbo',
-    'gpt-3.5-turbo-0301',
-}
-
-EDIT_MODELS = {
-
-}
-
-IMAGE_MODELS = {
-
-}
-
-
-class ModelRequest:
-    """模型接口请求父类"""
-
-    can_chat = False
-    runtime: threading.Thread = None
-    ret = {}
-    proxy: str = None
-    request_ready = True
-    error_info: str = "若在没有任何错误的情况下看到这句话，请带着配置文件上报Issues"
-
-    def __init__(self, model_name, user_name, request_fun, http_proxy:str = None, time_out = None):
-        self.model_name = model_name
-        self.user_name = user_name
-        self.request_fun = request_fun
-        self.time_out = time_out
-        if http_proxy != None:
-            self.proxy = http_proxy
-            openai.proxy = self.proxy
-            self.request_ready = False
-
-    async def __a_request__(self, **kwargs):
-        """异步请求"""
-
-        try:
-            self.ret:dict = await self.request_fun(**kwargs)
-            self.request_ready = True
-        except aiE.APIConnectionError as e:
-            self.error_info = "{}\n请检查网络连接或代理是否正常".format(e)
-            raise ConnectionError(self.error_info)
-        except ValueError as e:
-            self.error_info = "{}\n该错误可能是由于http_proxy格式设置错误引起的"
-        except Exception as e:
-            self.error_info = "{}\n由于请求异常产生的未知错误，请查看日志".format(e)
-            raise Exception(self.error_info)
-
-    def request(self, **kwargs):
-        """向接口发起请求"""
-
-        if self.proxy != None: #异步请求
-            self.request_ready = False
-            loop = asyncio.new_event_loop()
-            self.runtime = threading.Thread(
-                target=loop.run_until_complete,
-                args=(self.__a_request__(**kwargs),)
-            )
-            self.runtime.start()
-        else: #同步请求
-            self.ret = self.request_fun(**kwargs)
-
-    def __msg_handle__(self, msg):
-        """将prompt dict转换成接口需要的格式"""
-        return msg
-    
-    def ret_handle(self):
-        '''
-        API消息返回处理函数
-        若重写该方法，应检查异步线程状态，或在需要检查处super该方法
-        '''
-        if self.runtime != None and isinstance(self.runtime, threading.Thread):
-            self.runtime.join(self.time_out)
-        if self.request_ready:
-            return
-        raise Exception(self.error_info)
-
-    def get_total_tokens(self):
-        try:
-            return self.ret['usage']['total_tokens']
-        except:
-            return 0
-
-    def get_message(self):
-        return self.message
-
-    def get_response(self):
-        return self.ret
-
-
-class ChatCompletionModel(ModelRequest):
-    """ChatCompletion接口的请求实现"""
-
-    Chat_role = ['system', 'user', 'assistant']
-    def __init__(self, model_name, user_name, http_proxy:str = None, **kwargs):
-        if http_proxy == None:
-            request_fun = openai.ChatCompletion.create
-        else:
-            request_fun = openai.ChatCompletion.acreate
-        self.can_chat = True
-        super().__init__(model_name, user_name, request_fun, http_proxy, **kwargs)
-
-    def request(self, prompts, **kwargs):
-        prompts = self.__msg_handle__(prompts)
-        kwargs['messages'] = prompts
-        super().request(**kwargs)
-        self.ret_handle()
-
-    def __msg_handle__(self, msgs):
-        temp_msgs = []
-        # 把msgs拷贝进temp_msgs
-        for msg in msgs:
-            temp_msgs.append(msg.copy())
-        return temp_msgs
-
-    def get_message(self):
-        return self.ret["choices"][0]["message"]['content'] #需要时直接加载加快请求速度，降低内存消耗
-
-
-class CompletionModel(ModelRequest):
-    """Completion接口的请求实现"""
-
-    def __init__(self, model_name, user_name, http_proxy:str = None, **kwargs):
-        if http_proxy == None:
-            request_fun = openai.Completion.create
-        else:
-            request_fun = openai.Completion.acreate
-        super().__init__(model_name, user_name, request_fun, http_proxy, **kwargs)
-
-    def request(self, prompts, **kwargs):
-        prompts = self.__msg_handle__(prompts)
-        kwargs['prompt'] = prompts
-        super().request(**kwargs)
-        self.ret_handle()
-
-    def __msg_handle__(self, msgs):
-        prompt = ''
-        for msg in msgs:
-            prompt = prompt + "{}: {}\n".format(msg['role'], msg['content'])
-        # for msg in msgs:
-        #     if msg['role'] == 'assistant':
-        #         prompt = prompt + "{}\n".format(msg['content'])
-        #     else:
-        #         prompt = prompt + "{}:{}\n".format(msg['role'] , msg['content'])
-        prompt = prompt + "assistant: "
-        return prompt
-
-    def get_message(self):
-        return self.ret["choices"][0]["text"]
-
-
-def create_openai_model_request(model_name: str, user_name: str = 'user', http_proxy:str = None) -> ModelRequest:
-    """使用给定的模型名称创建模型请求对象"""
-    if model_name in CHAT_COMPLETION_MODELS:
-        model = ChatCompletionModel(model_name, user_name, http_proxy)
-    elif model_name in COMPLETION_MODELS:
-        model = CompletionModel(model_name, user_name, http_proxy)
-    else :
-        log = "找不到模型[{}]，请检查配置文件".format(model_name)
-        logging.error(log)
-        raise IndexError(log)
-    logging.debug("使用接口[{}]创建模型请求[{}]".format(model.__class__.__name__, model_name))
-    return model

pkg/openai/pricing.bak.py

@@ -1,28 +0,0 @@
-# 计费模块
-# 已弃用 https://github.com/RockChinQ/QChatGPT/issues/81
-
-import logging
-
-pricing = {
-    "base": {  # 文字模型单位是1000字符
-        "text-davinci-003": 0.02,
-    },
-    "image": {
-        "256x256": 0.016,
-        "512x512": 0.018,
-        "1024x1024": 0.02,
-    }
-}
-
-
-def language_base_price(model, text):
-    salt_rate = 0.93
-    length = ((len(text.encode('utf-8')) - len(text)) / 2 + len(text)) * salt_rate
-    logging.debug("text length: %d" % length)
-
-    return pricing["base"][model] * length / 1000
-
-
-def image_price(size):
-    logging.debug("image size: %s" % size)
-    return pricing["image"][size]

pkg/openai/session.py

@@ -1,380 +0,0 @@
-"""主线使用的会话管理模块
-
-每个人、每个群单独一个session，session内部保留了对话的上下文，
-"""
-
-import logging
-import threading
-import time
-import json
-
-import pkg.openai.manager
-import pkg.openai.modelmgr
-import pkg.database.manager
-import pkg.utils.context
-
-import pkg.plugin.host as plugin_host
-import pkg.plugin.models as plugin_models
-
-# 运行时保存的所有session
-sessions = {}
-
-
-class SessionOfflineStatus:
-    ON_GOING = 'on_going'
-    EXPLICITLY_CLOSED = 'explicitly_closed'
-
-
-# 重置session.prompt
-def reset_session_prompt(session_name, prompt):
-    # 备份原始数据
-    bak_path = 'logs/{}-{}.bak'.format(
-        session_name,
-        time.strftime("%Y-%m-%d-%H-%M-%S", time.localtime())
-    )
-    f = open(bak_path, 'w+')
-    f.write(prompt)
-    f.close()
-    # 生成新数据
-    config = pkg.utils.context.get_config()
-    prompt = [
-        {
-            'role': 'system',
-            'content': config.default_prompt['default'] if type(config.default_prompt) == dict else config.default_prompt
-        }
-    ]
-    # 警告
-    logging.warning(
-        """
-用户[{}]的数据已被重置，有可能是因为数据版本过旧或存储错误
-原始数据将备份在：
-{}""".format(session_name, bak_path)
-    )  # 为保证多行文本格式正确故无缩进
-    return prompt
-
-
-# 从数据加载session
-def load_sessions():
-    """从数据库加载sessions"""
-
-    global sessions
-
-    db_inst = pkg.utils.context.get_database_manager()
-
-    session_data = db_inst.load_valid_sessions()
-
-    for session_name in session_data:
-        logging.info('加载session: {}'.format(session_name))
-
-        temp_session = Session(session_name)
-        temp_session.name = session_name
-        temp_session.create_timestamp = session_data[session_name]['create_timestamp']
-        temp_session.last_interact_timestamp = session_data[session_name]['last_interact_timestamp']
-        try:
-            temp_session.prompt = json.loads(session_data[session_name]['prompt'])
-        except Exception:
-            temp_session.prompt = reset_session_prompt(session_name, session_data[session_name]['prompt'])
-            temp_session.persistence()
-        temp_session.default_prompt = json.loads(session_data[session_name]['default_prompt']) if \
-            session_data[session_name]['default_prompt'] else []
-
-        sessions[session_name] = temp_session
-
-
-# 获取指定名称的session，如果不存在则创建一个新的
-def get_session(session_name: str):
-    global sessions
-    if session_name not in sessions:
-        sessions[session_name] = Session(session_name)
-    return sessions[session_name]
-
-
-def dump_session(session_name: str):
-    global sessions
-    if session_name in sessions:
-        assert isinstance(sessions[session_name], Session)
-        sessions[session_name].persistence()
-        del sessions[session_name]
-
-
-# 通用的OpenAI API交互session
-# session内部保留了对话的上下文，
-# 收到用户消息后，将上下文提交给OpenAI API生成回复
-class Session:
-    name = ''
-
-    prompt = []
-    """使用list来保存会话中的回合"""
-
-    default_prompt = []
-    """本session的默认prompt"""
-
-    create_timestamp = 0
-    """会话创建时间"""
-
-    last_interact_timestamp = 0
-    """上次交互(产生回复)时间"""
-
-    just_switched_to_exist_session = False
-
-    response_lock = None
-
-    # 加锁
-    def acquire_response_lock(self):
-        logging.debug('{},lock acquire,{}'.format(self.name, self.response_lock))
-        self.response_lock.acquire()
-        logging.debug('{},lock acquire successfully,{}'.format(self.name, self.response_lock))
-
-    # 释放锁
-    def release_response_lock(self):
-        if self.response_lock.locked():
-            logging.debug('{},lock release,{}'.format(self.name, self.response_lock))
-            self.response_lock.release()
-            logging.debug('{},lock release successfully,{}'.format(self.name, self.response_lock))
-
-    # 从配置文件获取会话预设信息
-    def get_default_prompt(self, use_default: str = None):
-        import pkg.openai.dprompt as dprompt
-
-        if use_default is None:
-            use_default = dprompt.get_current()
-
-        current_default_prompt = dprompt.get_prompt(use_default)
-        return current_default_prompt
-
-    def __init__(self, name: str):
-        self.name = name
-        self.create_timestamp = int(time.time())
-        self.last_interact_timestamp = int(time.time())
-        self.schedule()
-
-        self.response_lock = threading.Lock()
-
-        self.default_prompt = self.get_default_prompt()
-        logging.debug("prompt is: {}".format(self.default_prompt))
-
-    # 设定检查session最后一次对话是否超过过期时间的计时器
-    def schedule(self):
-        threading.Thread(target=self.expire_check_timer_loop, args=(self.create_timestamp,)).start()
-
-    # 检查session是否已经过期
-    def expire_check_timer_loop(self, create_timestamp: int):
-        global sessions
-        while True:
-            time.sleep(60)
-
-            # 不是此session已更换，退出
-            if self.create_timestamp != create_timestamp or self not in sessions.values():
-                return
-
-            config = pkg.utils.context.get_config()
-            if int(time.time()) - self.last_interact_timestamp > config.session_expire_time:
-                logging.info('session {} 已过期'.format(self.name))
-
-                # 触发插件事件
-                args = {
-                    'session_name': self.name,
-                    'session': self,
-                    'session_expire_time': config.session_expire_time
-                }
-                event = pkg.plugin.host.emit(plugin_models.SessionExpired, **args)
-                if event.is_prevented_default():
-                    return
-
-                self.reset(expired=True, schedule_new=False)
-
-                # 删除此session
-                del sessions[self.name]
-                return
-
-    # 请求回复
-    # 这个函数是阻塞的
-    def append(self, text: str) -> str:
-        """向session中添加一条消息，返回接口回复"""
-
-        self.last_interact_timestamp = int(time.time())
-
-        # 触发插件事件
-        if not self.prompt:
-            args = {
-                'session_name': self.name,
-                'session': self,
-                'default_prompt': self.default_prompt,
-            }
-
-            event = pkg.plugin.host.emit(plugin_models.SessionFirstMessageReceived, **args)
-            if event.is_prevented_default():
-                return None
-
-        config = pkg.utils.context.get_config()
-        max_length = config.prompt_submit_length if hasattr(config, "prompt_submit_length") else 1024
-
-        # 向API请求补全
-        message = pkg.utils.context.get_openai_manager().request_completion(
-            self.cut_out(text, max_length),
-        )
-
-        # 成功获取，处理回复
-        res_test = message
-        res_ans = res_test
-
-        # 去除开头可能的提示
-        res_ans_spt = res_test.split("\n\n")
-        if len(res_ans_spt) > 1:
-            del (res_ans_spt[0])
-            res_ans = '\n\n'.join(res_ans_spt)
-
-        # 将此次对话的双方内容加入到prompt中
-        self.prompt.append({'role': 'user', 'content': text})
-        self.prompt.append({'role': 'assistant', 'content': res_ans})
-
-        if self.just_switched_to_exist_session:
-            self.just_switched_to_exist_session = False
-            self.set_ongoing()
-
-        return res_ans if res_ans[0] != '\n' else res_ans[1:]
-
-    # 删除上一回合并返回上一回合的问题
-    def undo(self) -> str:
-        self.last_interact_timestamp = int(time.time())
-
-        # 删除最后两个消息
-        if len(self.prompt) < 2:
-            raise Exception('之前无对话，无法撤销')
-
-        question = self.prompt[-2]['content']
-        self.prompt = self.prompt[:-2]
-
-        # 返回上一回合的问题
-        return question
-
-    # 构建对话体
-    def cut_out(self, msg: str, max_tokens: int) -> list:
-        """将现有prompt进行切割处理，使得新的prompt长度不超过max_tokens"""
-        # 如果用户消息长度超过max_tokens，直接返回
-        temp_prompt: list = []
-        temp_prompt += self.default_prompt
-        temp_prompt.append(
-            {
-                'role': 'user',
-                'content': msg
-            }
-        )
-
-        token_count = 0
-        for item in temp_prompt:
-            token_count += len(item['content'])
-
-        # 倒序遍历prompt
-        for i in range(len(self.prompt) - 1, -1, -1):
-            if token_count >= max_tokens:
-                break
-
-            # 将prompt加到temp_prompt倒数第二个位置
-            temp_prompt.insert(len(self.default_prompt), self.prompt[i])
-            token_count += len(self.prompt[i]['content'])
-
-        logging.debug('cut_out: {}'.format(json.dumps(temp_prompt, ensure_ascii=False, indent=4)))
-
-        return temp_prompt
-
-    # 持久化session
-    def persistence(self):
-        if self.prompt == self.get_default_prompt():
-            return
-
-        db_inst = pkg.utils.context.get_database_manager()
-
-        name_spt = self.name.split('_')
-
-        subject_type = name_spt[0]
-        subject_number = int(name_spt[1])
-
-        db_inst.persistence_session(subject_type, subject_number, self.create_timestamp, self.last_interact_timestamp,
-                                    json.dumps(self.prompt), json.dumps(self.default_prompt))
-
-    # 重置session
-    def reset(self, explicit: bool = False, expired: bool = False, schedule_new: bool = True, use_prompt: str = None):
-        if self.prompt:
-            self.persistence()
-            if explicit:
-                # 触发插件事件
-                args = {
-                    'session_name': self.name,
-                    'session': self
-                }
-
-                # 此事件不支持阻止默认行为
-                _ = pkg.plugin.host.emit(plugin_models.SessionExplicitReset, **args)
-
-                pkg.utils.context.get_database_manager().explicit_close_session(self.name, self.create_timestamp)
-
-            if expired:
-                pkg.utils.context.get_database_manager().set_session_expired(self.name, self.create_timestamp)
-
-        self.default_prompt = self.get_default_prompt(use_prompt)
-        self.prompt = []
-        self.create_timestamp = int(time.time())
-        self.last_interact_timestamp = int(time.time())
-        self.just_switched_to_exist_session = False
-
-        # self.response_lock = threading.Lock()
-
-        if schedule_new:
-            self.schedule()
-
-    # 将本session的数据库状态设置为on_going
-    def set_ongoing(self):
-        pkg.utils.context.get_database_manager().set_session_ongoing(self.name, self.create_timestamp)
-
-    # 切换到上一个session
-    def last_session(self):
-        last_one = pkg.utils.context.get_database_manager().last_session(self.name, self.last_interact_timestamp)
-        if last_one is None:
-            return None
-        else:
-            self.persistence()
-
-            self.create_timestamp = last_one['create_timestamp']
-            self.last_interact_timestamp = last_one['last_interact_timestamp']
-            try:
-                self.prompt = json.loads(last_one['prompt'])
-            except json.decoder.JSONDecodeError:
-                self.prompt = reset_session_prompt(self.name, last_one['prompt'])
-                self.persistence()
-            self.default_prompt = json.loads(last_one['default_prompt']) if last_one['default_prompt'] else []
-
-            self.just_switched_to_exist_session = True
-            return self
-
-    # 切换到下一个session
-    def next_session(self):
-        next_one = pkg.utils.context.get_database_manager().next_session(self.name, self.last_interact_timestamp)
-        if next_one is None:
-            return None
-        else:
-            self.persistence()
-
-            self.create_timestamp = next_one['create_timestamp']
-            self.last_interact_timestamp = next_one['last_interact_timestamp']
-            try:
-                self.prompt = json.loads(next_one['prompt'])
-            except json.decoder.JSONDecodeError:
-                self.prompt = reset_session_prompt(self.name, next_one['prompt'])
-                self.persistence()
-            self.default_prompt = json.loads(next_one['default_prompt']) if next_one['default_prompt'] else []
-
-            self.just_switched_to_exist_session = True
-            return self
-
-    def list_history(self, capacity: int = 10, page: int = 0):
-        return pkg.utils.context.get_database_manager().list_history(self.name, capacity, page)
-
-    def delete_history(self, index: int) -> bool:
-        return pkg.utils.context.get_database_manager().delete_history(self.name, index)
-
-    def delete_all_history(self) -> bool:
-        return pkg.utils.context.get_database_manager().delete_all_history(self.name)
-
-    def draw_image(self, prompt: str):
-        return pkg.utils.context.get_openai_manager().request_image(prompt)

pkg/plugin/host.py

@@ -1,325 +0,0 @@
-# 插件管理模块
-import asyncio
-import logging
-import importlib
-import os
-import pkgutil
-import sys
-import traceback
-
-import pkg.utils.context as context
-import pkg.plugin.switch as switch
-import pkg.plugin.settings as settings
-
-from mirai import Mirai
-
-__plugins__ = {}
-"""
-插件列表
-
-示例:
-{
-    "example": {
-        "path": "plugins/example/main.py",
-        "enabled: True,
-        "name": "example",
-        "description": "example",
-        "version": "0.0.1",
-        "author": "RockChinQ",
-        "class": <class 'plugins.example.ExamplePlugin'>,
-        "hooks": {
-            "person_message": [
-                <function ExamplePlugin.person_message at 0x0000020E1D1B8D38>
-            ]
-        },
-        "instance": None
-    }
-}"""
-
-__plugins_order__ = []
-"""插件顺序"""
-
-
-def generate_plugin_order():
-    """ 根据__plugin__生成插件初始顺序，无视是否启用 """
-    global __plugins_order__
-    __plugins_order__ = []
-    for plugin_name in __plugins__:
-        __plugins_order__.append(plugin_name)
-
-
-def iter_plugins():
-    """ 按照顺序迭代插件 """
-    for plugin_name in __plugins_order__:
-        yield __plugins__[plugin_name]
-
-
-def iter_plugins_name():
-    """ 迭代插件名 """
-    for plugin_name in __plugins_order__:
-        yield plugin_name
-
-
-__current_module_path__ = ""
-
-
-def walk_plugin_path(module, prefix='', path_prefix=''):
-    global __current_module_path__
-    """遍历插件路径"""
-    for item in pkgutil.iter_modules(module.__path__):
-        if item.ispkg:
-            logging.debug("扫描插件包: plugins/{}".format(path_prefix + item.name))
-            walk_plugin_path(__import__(module.__name__ + '.' + item.name, fromlist=['']),
-                             prefix + item.name + '.', path_prefix + item.name + '/')
-        else:
-            try:
-                logging.debug("扫描插件模块: plugins/{}".format(path_prefix + item.name + '.py'))
-                __current_module_path__ = "plugins/"+path_prefix + item.name + '.py'
-
-                importlib.import_module(module.__name__ + '.' + item.name)
-                logging.info('加载模块: plugins/{} 成功'.format(path_prefix + item.name + '.py'))
-            except:
-                logging.error('加载模块: plugins/{} 失败: {}'.format(path_prefix + item.name + '.py', sys.exc_info()))
-                traceback.print_exc()
-
-
-def load_plugins():
-    """ 加载插件 """
-    logging.info("加载插件")
-    PluginHost()
-    walk_plugin_path(__import__('plugins'))
-
-    logging.debug(__plugins__)
-
-    # 加载开关数据
-    switch.load_switch()
-
-    # 生成初始顺序
-    generate_plugin_order()
-    # 加载插件顺序
-    settings.load_settings()
-
-
-def initialize_plugins():
-    """ 初始化插件 """
-    logging.info("初始化插件")
-    import pkg.plugin.models as models
-    for plugin in iter_plugins():
-        if not plugin['enabled']:
-            continue
-        try:
-            models.__current_registering_plugin__ = plugin['name']
-            plugin['instance'] = plugin["class"](plugin_host=context.get_plugin_host())
-            logging.info("插件 {} 已初始化".format(plugin['name']))
-        except:
-            logging.error("插件{}初始化时发生错误: {}".format(plugin['name'], sys.exc_info()))
-
-
-def unload_plugins():
-    """ 卸载插件
-    """
-    # 不再显式卸载插件，因为当程序结束时，插件的析构函数会被系统执行
-    # for plugin in __plugins__.values():
-    #     if plugin['enabled'] and plugin['instance'] is not None:
-    #         if not hasattr(plugin['instance'], '__del__'):
-    #             logging.warning("插件{}没有定义析构函数".format(plugin['name']))
-    #         else:
-    #             try:
-    #                 plugin['instance'].__del__()
-    #                 logging.info("卸载插件: {}".format(plugin['name']))
-    #                 plugin['instance'] = None
-    #             except:
-    #                 logging.error("插件{}卸载时发生错误: {}".format(plugin['name'], sys.exc_info()))
-
-
-def install_plugin(repo_url: str):
-    """ 安装插件，从git储存库获取并解决依赖 """
-    try:
-        import pkg.utils.pkgmgr
-        pkg.utils.pkgmgr.ensure_dulwich()
-    except:
-        pass
-
-    try:
-        import dulwich
-    except ModuleNotFoundError:
-        raise Exception("dulwich模块未安装,请查看 https://github.com/RockChinQ/QChatGPT/issues/77")
-
-    from dulwich import porcelain
-
-    logging.info("克隆插件储存库: {}".format(repo_url))
-    repo = porcelain.clone(repo_url, "plugins/"+repo_url.split(".git")[0].split("/")[-1]+"/", checkout=True)
-
-    # 检查此目录是否包含requirements.txt
-    if os.path.exists("plugins/"+repo_url.split(".git")[0].split("/")[-1]+"/requirements.txt"):
-        logging.info("检测到requirements.txt，正在安装依赖")
-        import pkg.utils.pkgmgr
-        pkg.utils.pkgmgr.install_requirements("plugins/"+repo_url.split(".git")[0].split("/")[-1]+"/requirements.txt")
-
-        import main
-        main.reset_logging()
-
-
-class EventContext:
-    """ 事件上下文 """
-    eid = 0
-    """事件编号"""
-
-    name = ""
-
-    __prevent_default__ = False
-    """ 是否阻止默认行为 """
-
-    __prevent_postorder__ = False
-    """ 是否阻止后续插件的执行 """
-
-    __return_value__ = {}
-    """ 返回值 
-    示例:
-    {
-        "example": [
-            'value1',
-            'value2',
-            3,
-            4,
-            {
-                'key1': 'value1',
-            },
-            ['value1', 'value2']
-        ]
-    }
-    """
-
-    def add_return(self, key: str, ret):
-        """添加返回值"""
-        if key not in self.__return_value__:
-            self.__return_value__[key] = []
-        self.__return_value__[key].append(ret)
-
-    def get_return(self, key: str):
-        """获取key的所有返回值"""
-        if key in self.__return_value__:
-            return self.__return_value__[key]
-        return None
-
-    def get_return_value(self, key: str):
-        """获取key的首个返回值"""
-        if key in self.__return_value__:
-            return self.__return_value__[key][0]
-        return None
-
-    def prevent_default(self):
-        """阻止默认行为"""
-        self.__prevent_default__ = True
-
-    def prevent_postorder(self):
-        """阻止后续插件执行"""
-        self.__prevent_postorder__ = True
-
-    def is_prevented_default(self):
-        """是否阻止默认行为"""
-        return self.__prevent_default__
-
-    def is_prevented_postorder(self):
-        """是否阻止后序插件执行"""
-        return self.__prevent_postorder__
-
-    def __init__(self, name: str):
-        self.name = name
-        self.eid = EventContext.eid
-        self.__prevent_default__ = False
-        self.__prevent_postorder__ = False
-        self.__return_value__ = {}
-        EventContext.eid += 1
-
-
-def emit(event_name: str, **kwargs) -> EventContext:
-    """ 触发事件 """
-    import pkg.utils.context as context
-    if context.get_plugin_host() is None:
-        return None
-    return context.get_plugin_host().emit(event_name, **kwargs)
-
-
-class PluginHost:
-    """插件宿主"""
-
-    def __init__(self):
-        context.set_plugin_host(self)
-
-    def get_runtime_context(self) -> context:
-        """获取运行时上下文（pkg.utils.context模块的对象）
-
-        此上下文用于和主程序其他模块交互（数据库、QQ机器人、OpenAI接口等）
-        详见pkg.utils.context模块
-        其中的context变量保存了其他重要模块的类对象，可以使用这些对象进行交互
-        """
-        return context
-
-    def get_bot(self) -> Mirai:
-        """获取机器人对象"""
-        return context.get_qqbot_manager().bot
-
-    def send_person_message(self, person, message):
-        """发送私聊消息"""
-        asyncio.run(self.get_bot().send_friend_message(person, message))
-
-    def send_group_message(self, group, message):
-        """发送群消息"""
-        asyncio.run(self.get_bot().send_group_message(group, message))
-
-    def notify_admin(self, message):
-        """通知管理员"""
-        context.get_qqbot_manager().notify_admin(message)
-
-    def emit(self, event_name: str, **kwargs) -> EventContext:
-        """ 触发事件 """
-        import json
-
-        event_context = EventContext(event_name)
-        logging.debug("触发事件: {} ({})".format(event_name, event_context.eid))
-        for plugin in iter_plugins():
-            
-            if not plugin['enabled']:
-                continue
-
-            # if plugin['instance'] is None:
-            #     # 从关闭状态切到开启状态之后，重新加载插件
-            #     try:
-            #         plugin['instance'] = plugin["class"](plugin_host=self)
-            #         logging.info("插件 {} 已初始化".format(plugin['name']))
-            #     except:
-            #         logging.error("插件 {} 初始化时发生错误: {}".format(plugin['name'], sys.exc_info()))
-            #         continue
-
-            if 'hooks' not in plugin or event_name not in plugin['hooks']:
-                continue
-
-            hooks = []
-            if event_name in plugin["hooks"]:
-                hooks = plugin["hooks"][event_name]
-            for hook in hooks:
-                try:
-                    already_prevented_default = event_context.is_prevented_default()
-
-                    kwargs['host'] = context.get_plugin_host()
-                    kwargs['event'] = event_context
-
-                    hook(plugin['instance'], **kwargs)
-
-                    if event_context.is_prevented_default() and not already_prevented_default:
-                        logging.debug("插件 {} 已要求阻止事件 {} 的默认行为".format(plugin['name'], event_name))
-
-                except Exception as e:
-                    logging.error("插件{}触发事件{}时发生错误".format(plugin['name'], event_name))
-                    logging.error(traceback.format_exc())
-
-            # print("done:{}".format(plugin['name']))
-            if event_context.is_prevented_postorder():
-                logging.debug("插件 {} 阻止了后序插件的执行".format(plugin['name']))
-                break
-
-        logging.debug("事件 {} ({}) 处理完毕，返回值: {}".format(event_name, event_context.eid,
-                                                                event_context.__return_value__))
-
-        return event_context

pkg/plugin/models.py

@@ -1,223 +0,0 @@
-import logging
-
-import pkg.plugin.host as host
-import pkg.utils.context
-
-PersonMessageReceived = "person_message_received"
-"""收到私聊消息时，在判断是否应该响应前触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        message_chain: mirai.models.message.MessageChain 消息链
-"""
-
-GroupMessageReceived = "group_message_received"
-"""收到群聊消息时，在判断是否应该响应前触发（所有群消息）
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        message_chain: mirai.models.message.MessageChain 消息链
-"""
-
-PersonNormalMessageReceived = "person_normal_message_received"
-"""判断为应该处理的私聊普通消息时触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        text_message: str 消息文本
-        
-    returns (optional):
-        alter: str 修改后的消息文本
-        reply: list 回复消息组件列表
-"""
-
-PersonCommandSent = "person_command_sent"
-"""判断为应该处理的私聊指令时触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        command: str 指令
-        params: list[str] 参数列表
-        text_message: str 完整指令文本
-        is_admin: bool 是否为管理员
-    
-    returns (optional):
-        alter: str 修改后的完整指令文本
-        reply: list 回复消息组件列表
-"""
-
-GroupNormalMessageReceived = "group_normal_message_received"
-"""判断为应该处理的群聊普通消息时触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        text_message: str 消息文本
-        
-    returns (optional):
-        alter: str 修改后的消息文本
-        reply: list 回复消息组件列表
-"""
-
-GroupCommandSent = "group_command_sent"
-"""判断为应该处理的群聊指令时触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        command: str 指令
-        params: list[str] 参数列表
-        text_message: str 完整指令文本
-        is_admin: bool 是否为管理员
-    
-    returns (optional):
-        alter: str 修改后的完整指令文本
-        reply: list 回复消息组件列表
-"""
-
-NormalMessageResponded = "normal_message_responded"
-"""获取到对普通消息的文字响应时触发
-    kwargs:
-        launcher_type: str 发起对象类型(group/person)
-        launcher_id: int 发起对象ID(群号/QQ号)
-        sender_id: int 发送者ID(QQ号)
-        session: pkg.openai.session.Session 会话对象
-        prefix: str 回复文字消息的前缀
-        response_text: str 响应文本
-    
-    returns (optional):
-        prefix: str 修改后的回复文字消息的前缀
-        reply: list 替换回复消息组件列表
-"""
-
-SessionFirstMessageReceived = "session_first_message_received"
-"""会话被第一次交互时触发
-    kwargs:
-        session_name: str 会话名称(<launcher_type>_<launcher_id>)
-        session: pkg.openai.session.Session 会话对象
-        default_prompt: str 预设值
-"""
-
-SessionExplicitReset = "session_reset"
-"""会话被用户手动重置时触发，此事件不支持阻止默认行为
-    kwargs:
-        session_name: str 会话名称(<launcher_type>_<launcher_id>)
-        session: pkg.openai.session.Session 会话对象
-"""
-
-SessionExpired = "session_expired"
-"""会话过期时触发
-    kwargs:
-        session_name: str 会话名称(<launcher_type>_<launcher_id>)
-        session: pkg.openai.session.Session 会话对象
-        session_expire_time: int 已设置的会话过期时间(秒)
-"""
-
-KeyExceeded = "key_exceeded"
-"""api-key超额时触发
-    kwargs:
-        key_name: str 超额的api-key名称
-        usage: dict 超额的api-key使用情况
-        exceeded_keys: list[str] 超额的api-key列表
-"""
-
-KeySwitched = "key_switched"
-"""api-key超额切换成功时触发，此事件不支持阻止默认行为
-    kwargs:
-        key_name: str 切换成功的api-key名称
-        key_list: list[str] api-key列表
-"""
-
-
-def on(event: str):
-    """注册事件监听器
-    :param
-        event: str 事件名称
-    """
-    return Plugin.on(event)
-
-
-__current_registering_plugin__ = ""
-
-
-class Plugin:
-    """插件基类"""
-
-    host: host.PluginHost
-    """插件宿主，提供插件的一些基础功能"""
-
-    @classmethod
-    def on(cls, event):
-        """事件处理器装饰器
-
-        :param
-            event: 事件类型
-        :return:
-            None
-        """
-        global __current_registering_plugin__
-
-        def wrapper(func):
-            plugin_hooks = host.__plugins__[__current_registering_plugin__]["hooks"]
-
-            if event not in plugin_hooks:
-                plugin_hooks[event] = []
-            plugin_hooks[event].append(func)
-
-            # print("registering hook: p='{}', e='{}', f={}".format(__current_registering_plugin__, event, func))
-
-            host.__plugins__[__current_registering_plugin__]["hooks"] = plugin_hooks
-
-            return func
-
-        return wrapper
-
-
-def register(name: str, description: str, version: str, author: str):
-    """注册插件, 此函数作为装饰器使用
-
-    Args:
-        name (str): 插件名称
-        description (str): 插件描述
-        version (str): 插件版本
-        author (str): 插件作者
-
-    Returns:
-        None
-    """
-    global __current_registering_plugin__
-
-    __current_registering_plugin__ = name
-    # print("registering plugin: n='{}', d='{}', v={}, a='{}'".format(name, description, version, author))
-    host.__plugins__[name] = {
-        "name": name,
-        "description": description,
-        "version": version,
-        "author": author,
-        "hooks": {},
-        "path": host.__current_module_path__,
-        "enabled": True,
-        "instance": None,
-    }
-
-    def wrapper(cls: Plugin):
-        cls.name = name
-        cls.description = description
-        cls.version = version
-        cls.author = author
-        cls.host = pkg.utils.context.get_plugin_host()
-        cls.enabled = True
-        cls.path = host.__current_module_path__
-
-        # 存到插件列表
-        host.__plugins__[name]["class"] = cls
-
-        logging.info("插件注册完成: n='{}', d='{}', v={}, a='{}' ({})".format(name, description, version, author, cls))
-
-        return cls
-
-    return wrapper

pkg/plugin/settings.py

@@ -1,84 +0,0 @@
-import json
-import os
-
-import pkg.plugin.host as host
-import logging
-
-
-def wrapper_dict_from_runtime_context() -> dict:
-    """从变量中包装settings.json的数据字典"""
-    settings = {
-        "order": []
-    }
-
-    for plugin_name in host.__plugins_order__:
-        settings["order"].append(plugin_name)
-
-    return settings
-
-
-def apply_settings(settings: dict):
-    """将settings.json数据应用到变量中"""
-    if "order" in settings:
-        host.__plugins_order__ = settings["order"]
-
-
-def dump_settings():
-    """保存settings.json数据"""
-    logging.debug("保存plugins/settings.json数据")
-
-    settings = wrapper_dict_from_runtime_context()
-
-    with open("plugins/settings.json", "w", encoding="utf-8") as f:
-        json.dump(settings, f, indent=4, ensure_ascii=False)
-
-
-def load_settings():
-    """加载settings.json数据"""
-    logging.debug("加载plugins/settings.json数据")
-
-    # 读取plugins/settings.json
-    settings = {
-    }
-
-    # 检查文件是否存在
-    if not os.path.exists("plugins/settings.json"):
-        # 不存在则创建
-        with open("plugins/settings.json", "w", encoding="utf-8") as f:
-            json.dump(wrapper_dict_from_runtime_context(), f, indent=4, ensure_ascii=False)
-
-    with open("plugins/settings.json", "r", encoding="utf-8") as f:
-        settings = json.load(f)
-
-    if settings is None:
-        settings = {
-        }
-
-    # 检查每个设置项
-    if "order" not in settings:
-        settings["order"] = []
-
-    settings_modified = False
-
-    settings_copy = settings.copy()
-
-    # 检查settings中多余的插件项
-
-    # order
-    for plugin_name in settings_copy["order"]:
-        if plugin_name not in host.__plugins_order__:
-            settings["order"].remove(plugin_name)
-            settings_modified = True
-
-    # 检查settings中缺少的插件项
-
-    # order
-    for plugin_name in host.__plugins_order__:
-        if plugin_name not in settings_copy["order"]:
-            settings["order"].append(plugin_name)
-            settings_modified = True
-
-    apply_settings(settings)
-
-    if settings_modified:
-        dump_settings()

pkg/plugin/switch.py

@@ -1,89 +0,0 @@
-# 控制插件的开关
-import json
-import logging
-import os
-
-import pkg.plugin.host as host
-
-
-def wrapper_dict_from_plugin_list() -> dict:
-    """ 将插件列表转换为开关json """
-    switch = {}
-
-    for plugin_name in host.__plugins__:
-        plugin = host.__plugins__[plugin_name]
-
-        switch[plugin_name] = {
-            "path": plugin["path"],
-            "enabled": plugin["enabled"],
-        }
-
-    return switch
-
-
-def apply_switch(switch: dict):
-    """将开关数据应用到插件列表中"""
-    # print("将开关数据应用到插件列表中")
-    # print(switch)
-    for plugin_name in switch:
-        host.__plugins__[plugin_name]["enabled"] = switch[plugin_name]["enabled"]
-
-
-def dump_switch():
-    """ 保存开关数据 """
-    logging.debug("保存开关数据")
-    # 将开关数据写入plugins/switch.json
-
-    switch = wrapper_dict_from_plugin_list()
-
-    with open("plugins/switch.json", "w", encoding="utf-8") as f:
-        json.dump(switch, f, indent=4, ensure_ascii=False)
-
-
-def load_switch():
-    """ 加载开关数据 """
-    logging.debug("加载开关数据")
-    # 读取plugins/switch.json
-
-    switch = {}
-
-    # 检查文件是否存在
-    if not os.path.exists("plugins/switch.json"):
-        # 不存在则创建
-        with open("plugins/switch.json", "w", encoding="utf-8") as f:
-            json.dump(switch, f, indent=4, ensure_ascii=False)
-
-    with open("plugins/switch.json", "r", encoding="utf-8") as f:
-        switch = json.load(f)
-
-    if switch is None:
-        switch = {}
-
-    switch_modified = False
-
-    switch_copy = switch.copy()
-    # 检查switch中多余的和path不相符的
-    for plugin_name in switch_copy:
-        if plugin_name not in host.__plugins__:
-            del switch[plugin_name]
-            switch_modified = True
-        elif switch[plugin_name]["path"] != host.__plugins__[plugin_name]["path"]:
-            # 删除此不相符的
-            del switch[plugin_name]
-            switch_modified = True
-
-    # 检查plugin中多余的
-    for plugin_name in host.__plugins__:
-        if plugin_name not in switch:
-            switch[plugin_name] = {
-                "path": host.__plugins__[plugin_name]["path"],
-                "enabled": host.__plugins__[plugin_name]["enabled"],
-            }
-            switch_modified = True
-
-    # 应用开关数据
-    apply_switch(switch)
-
-    # 如果switch有修改，保存
-    if switch_modified:
-        dump_switch()

pkg/qqbot/banlist.py

@@ -1,50 +0,0 @@
-import pkg.utils.context
-
-
-def is_banned(launcher_type: str, launcher_id: int, sender_id: int) -> bool:
-    if not pkg.utils.context.get_qqbot_manager().enable_banlist:
-        return False
-    
-    result = False
-    
-    if launcher_type == 'group':
-        # 检查是否显式声明发起人QQ要被person忽略
-        if sender_id in pkg.utils.context.get_qqbot_manager().ban_person:
-            result = True
-        else:
-            for group_rule in pkg.utils.context.get_qqbot_manager().ban_group:
-                if type(group_rule) == int:
-                    if group_rule == launcher_id:  # 此群群号被禁用
-                        result = True
-                elif type(group_rule) == str:
-                    if group_rule.startswith('!'):
-                        # 截取!后面的字符串作为表达式，判断是否匹配
-                        reg_str = group_rule[1:]
-                        import re
-                        if re.match(reg_str, str(launcher_id)):  # 被豁免，最高级别
-                            result = False
-                            break
-                    else:
-                        # 判断是否匹配regexp
-                        import re
-                        if re.match(group_rule, str(launcher_id)):  # 此群群号被禁用
-                            result = True
-                    
-    else:
-        # ban_person, 与群规则相同
-        for person_rule in pkg.utils.context.get_qqbot_manager().ban_person:
-            if type(person_rule) == int:
-                if person_rule == launcher_id:
-                    result = True
-            elif type(person_rule) == str:
-                if person_rule.startswith('!'):
-                    reg_str = person_rule[1:]
-                    import re
-                    if re.match(reg_str, str(launcher_id)):
-                        result = False
-                        break
-                else:
-                    import re
-                    if re.match(person_rule, str(launcher_id)):
-                        result = True
-    return result

pkg/qqbot/blob.py

@@ -1,105 +0,0 @@
-# 长消息处理相关
-import logging
-import os
-import time
-import base64
-
-import config
-from mirai.models.message import MessageComponent, MessageChain, Image
-from mirai.models.message import ForwardMessageNode
-from mirai.models.base import MiraiBaseModel
-from typing import List
-import pkg.utils.context as context
-import pkg.utils.text2img as text2img
-
-
-class ForwardMessageDiaplay(MiraiBaseModel):
-    title: str = "群聊的聊天记录"
-    brief: str = "[聊天记录]"
-    source: str = "聊天记录"
-    preview: List[str] = []
-    summary: str = "查看x条转发消息"
-
-
-class Forward(MessageComponent):
-    """合并转发。"""
-    type: str = "Forward"
-    """消息组件类型。"""
-    display: ForwardMessageDiaplay
-    """显示信息"""
-    node_list: List[ForwardMessageNode]
-    """转发消息节点列表。"""
-    def __init__(self, *args, **kwargs):
-        if len(args) == 1:
-            self.node_list = args[0]
-            super().__init__(**kwargs)
-        super().__init__(*args, **kwargs)
-
-    def __str__(self):
-        return '[聊天记录]'
-
-
-def text_to_image(text: str) -> MessageComponent:
-    """将文本转换成图片"""
-    # 检查temp文件夹是否存在
-    if not os.path.exists('temp'):
-        os.mkdir('temp')
-    img_path = text2img.text_to_image(text_str=text, save_as='temp/{}.png'.format(int(time.time())))
-    
-    compressed_path, size = text2img.compress_image(img_path, outfile="temp/{}_compressed.png".format(int(time.time())))
-    # 读取图片，转换成base64
-    with open(compressed_path, 'rb') as f:
-        img = f.read()
-
-    b64 = base64.b64encode(img)
-
-    # 删除图片
-    os.remove(img_path)
-
-    # 判断compressed_path是否存在
-    if os.path.exists(compressed_path):
-        os.remove(compressed_path)
-    # 返回图片
-    return Image(base64=b64.decode('utf-8'))
-
-
-def check_text(text: str) -> list:
-    """检查文本是否为长消息，并转换成该使用的消息链组件"""
-    if not hasattr(config, 'blob_message_threshold'):
-        return [text]
-    
-    if len(text) > config.blob_message_threshold:
-        if not hasattr(config, 'blob_message_strategy'):
-            raise AttributeError('未定义长消息处理策略')
-
-        # logging.info("长消息: {}".format(text))
-        if config.blob_message_strategy == 'image':
-            # 转换成图片
-            return [text_to_image(text)]
-        elif config.blob_message_strategy == 'forward':
-            # 敏感词屏蔽
-            text = context.get_qqbot_manager().reply_filter.process(text)
-
-            # 包装转发消息
-            display = ForwardMessageDiaplay(
-                title='群聊的聊天记录',
-                brief='[聊天记录]',
-                source='聊天记录',
-                preview=["bot: "+text],
-                summary="查看1条转发消息"
-            )
-
-            node = ForwardMessageNode(
-                sender_id=config.mirai_http_api_config['qq'],
-                sender_name='bot',
-                message_chain=MessageChain([text])
-            )
-
-            forward = Forward(
-                display=display,
-                node_list=[node]
-            )
-
-            return [forward]
-    else:
-        return [text]

pkg/qqbot/command.py

@@ -1,385 +0,0 @@
-# 指令处理模块
-import logging
-import json
-import datetime
-import os
-import threading
-
-import pkg.openai.session
-import pkg.openai.manager
-import pkg.utils.reloader
-import pkg.utils.updater
-import pkg.utils.context
-import pkg.qqbot.message
-import pkg.utils.credit as credit
-
-from mirai import Image
-
-
-def config_operation(cmd, params):
-    reply = []
-    config = pkg.utils.context.get_config()
-    reply_str = ""
-    if len(params) == 0:
-        reply = ["[bot]err:请输入配置项"]
-    else:
-        cfg_name = params[0]
-        if cfg_name == 'all':
-            reply_str = "[bot]所有配置项:\n\n"
-            for cfg in dir(config):
-                if not cfg.startswith('__') and not cfg == 'logging':
-                    # 根据配置项类型进行格式化，如果是字典则转换为json并格式化
-                    if isinstance(getattr(config, cfg), str):
-                        reply_str += "{}: \"{}\"\n".format(cfg, getattr(config, cfg))
-                    elif isinstance(getattr(config, cfg), dict):
-                        # 不进行unicode转义，并格式化
-                        reply_str += "{}: {}\n".format(cfg,
-                                                       json.dumps(getattr(config, cfg),
-                                                                  ensure_ascii=False, indent=4))
-                    else:
-                        reply_str += "{}: {}\n".format(cfg, getattr(config, cfg))
-            reply = [reply_str]
-        elif cfg_name in dir(config):
-            if len(params) == 1:
-                # 按照配置项类型进行格式化
-                if isinstance(getattr(config, cfg_name), str):
-                    reply_str = "[bot]配置项{}: \"{}\"\n".format(cfg_name, getattr(config, cfg_name))
-                elif isinstance(getattr(config, cfg_name), dict):
-                    reply_str = "[bot]配置项{}: {}\n".format(cfg_name,
-                                                             json.dumps(getattr(config, cfg_name),
-                                                                        ensure_ascii=False, indent=4))
-                else:
-                    reply_str = "[bot]配置项{}: {}\n".format(cfg_name, getattr(config, cfg_name))
-                reply = [reply_str]
-            else:
-                cfg_value = " ".join(params[1:])
-                # 类型转换，如果是json则转换为字典
-                if cfg_value == 'true':
-                    cfg_value = True
-                elif cfg_value == 'false':
-                    cfg_value = False
-                elif cfg_value.isdigit():
-                    cfg_value = int(cfg_value)
-                elif cfg_value.startswith('{') and cfg_value.endswith('}'):
-                    cfg_value = json.loads(cfg_value)
-                else:
-                    try:
-                        cfg_value = float(cfg_value)
-                    except ValueError:
-                        pass
-
-                # 检查类型是否匹配
-                if isinstance(getattr(config, cfg_name), type(cfg_value)):
-                    setattr(config, cfg_name, cfg_value)
-                    pkg.utils.context.set_config(config)
-                    reply = ["[bot]配置项{}修改成功".format(cfg_name)]
-                else:
-                    reply = ["[bot]err:配置项{}类型不匹配".format(cfg_name)]
-
-        else:
-            reply = ["[bot]err:未找到配置项 {}".format(cfg_name)]
-
-    return reply
-
-
-def plugin_operation(cmd, params, is_admin):
-    reply = []
-
-    import pkg.plugin.host as plugin_host
-    import pkg.utils.updater as updater
-
-    plugin_list = plugin_host.__plugins__
-
-    if len(params) == 0:
-        reply_str = "[bot]所有插件({}):\n".format(len(plugin_host.__plugins__))
-        idx = 0
-        for key in plugin_host.iter_plugins_name():
-            plugin = plugin_list[key]
-            reply_str += "\n#{} {} {}\n{}\nv{}\n作者: {}\n"\
-                .format((idx+1), plugin['name'],
-                        "[已禁用]" if not plugin['enabled'] else "",
-                        plugin['description'],
-                        plugin['version'], plugin['author'])
-
-            if updater.is_repo("/".join(plugin['path'].split('/')[:-1])):
-                remote_url = updater.get_remote_url("/".join(plugin['path'].split('/')[:-1]))
-                if remote_url != "https://github.com/RockChinQ/QChatGPT" and remote_url != "https://gitee.com/RockChin/QChatGPT":
-                    reply_str += "源码: "+remote_url+"\n"
-
-            idx += 1
-
-        reply = [reply_str]
-    elif params[0] == 'update':
-        # 更新所有插件
-        if is_admin:
-            def closure():
-                import pkg.utils.context
-                updated = []
-                for key in plugin_list:
-                    plugin = plugin_list[key]
-                    if updater.is_repo("/".join(plugin['path'].split('/')[:-1])):
-                        success = updater.pull_latest("/".join(plugin['path'].split('/')[:-1]))
-                        if success:
-                            updated.append(plugin['name'])
-
-                # 检查是否有requirements.txt
-                pkg.utils.context.get_qqbot_manager().notify_admin("正在安装依赖...")
-                for key in plugin_list:
-                    plugin = plugin_list[key]
-                    if os.path.exists("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt"):
-                        logging.info("{}检测到requirements.txt，安装依赖".format(plugin['name']))
-                        import pkg.utils.pkgmgr
-                        pkg.utils.pkgmgr.install_requirements("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt")
-
-                        import main
-                        main.reset_logging()
-
-                pkg.utils.context.get_qqbot_manager().notify_admin("已更新插件: {}".format(", ".join(updated)))
-
-            threading.Thread(target=closure).start()
-            reply = ["[bot]正在更新所有插件，请勿重复发起..."]
-        else:
-            reply = ["[bot]err:权限不足"]
-    elif params[0].startswith("http"):
-        if is_admin:
-
-            def closure():
-                try:
-                    plugin_host.install_plugin(params[0])
-                    pkg.utils.context.get_qqbot_manager().notify_admin("插件安装成功，请发送 !reload 指令重载插件")
-                except Exception as e:
-                    logging.error("插件安装失败:{}".format(e))
-                    pkg.utils.context.get_qqbot_manager().notify_admin("插件安装失败:{}".format(e))
-
-            threading.Thread(target=closure, args=()).start()
-            reply = ["[bot]正在安装插件..."]
-        else:
-            reply = ["[bot]err:权限不足，请使用管理员账号私聊发起"]
-    return reply
-
-
-def process_command(session_name: str, text_message: str, mgr, config,
-                    launcher_type: str, launcher_id: int, sender_id: int, is_admin: bool) -> list:
-    reply = []
-    try:
-        logging.info(
-            "[{}]发起指令:{}".format(session_name, text_message[:min(20, len(text_message))] + (
-                "..." if len(text_message) > 20 else "")))
-
-        cmd = text_message[1:].strip().split(' ')[0]
-
-        params = text_message[1:].strip().split(' ')[1:]
-        if cmd == 'help':
-            reply = ["[bot]" + config.help_message]
-        elif cmd == 'reset':
-            if len(params) == 0:
-                pkg.openai.session.get_session(session_name).reset(explicit=True)
-                reply = ["[bot]会话已重置"]
-            else:
-                pkg.openai.session.get_session(session_name).reset(explicit=True, use_prompt=params[0])
-                reply = ["[bot]会话已重置，使用场景预设:{}".format(params[0])]
-        elif cmd == 'last':
-            result = pkg.openai.session.get_session(session_name).last_session()
-            if result is None:
-                reply = ["[bot]没有前一次的对话"]
-            else:
-                datetime_str = datetime.datetime.fromtimestamp(result.create_timestamp).strftime(
-                    '%Y-%m-%d %H:%M:%S')
-                reply = ["[bot]已切换到前一次的对话：\n创建时间:{}\n".format(datetime_str)]
-        elif cmd == 'next':
-            result = pkg.openai.session.get_session(session_name).next_session()
-            if result is None:
-                reply = ["[bot]没有后一次的对话"]
-            else:
-                datetime_str = datetime.datetime.fromtimestamp(result.create_timestamp).strftime(
-                    '%Y-%m-%d %H:%M:%S')
-                reply = ["[bot]已切换到后一次的对话：\n创建时间:{}\n".format(datetime_str)]
-        elif cmd == 'prompt':
-            msgs = ""
-            session:list = pkg.openai.session.get_session(session_name).prompt
-            for msg in session:
-                if len(params) != 0 and params[0] in ['-all', '-a']:
-                    msgs = msgs + "{}: {}\n\n".format(msg['role'], msg['content'])
-                elif len(msg['content']) > 30:
-                    msgs = msgs + "[{}]: {}...\n\n".format(msg['role'], msg['content'][:30])
-                else:
-                    msgs = msgs + "[{}]: {}\n\n".format(msg['role'], msg['content'])
-            reply = ["[bot]当前对话所有内容：\n{}".format(msgs)]
-        elif cmd == 'list':
-            pkg.openai.session.get_session(session_name).persistence()
-            page = 0
-
-            if len(params) > 0:
-                try:
-                    page = int(params[0])
-                except ValueError:
-                    pass
-
-            results = pkg.openai.session.get_session(session_name).list_history(page=page)
-            if len(results) == 0:
-                reply = ["[bot]第{}页没有历史会话".format(page)]
-            else:
-                reply_str = "[bot]历史会话 第{}页：\n".format(page)
-                current = -1
-                for i in range(len(results)):
-                    # 时间(使用create_timestamp转换) 序号 部分内容
-                    datetime_obj = datetime.datetime.fromtimestamp(results[i]['create_timestamp'])
-                    msg = ""
-                    try:
-                        msg = json.loads(results[i]['prompt'])
-                    except json.decoder.JSONDecodeError:
-                        msg = pkg.openai.session.reset_session_prompt(session_name, results[i]['prompt'])
-                        # 持久化
-                        pkg.openai.session.get_session(session_name).persistence()
-                    if len(msg) >= 2:
-                        reply_str += "#{} 创建:{} {}\n".format(i + page * 10,
-                                                               datetime_obj.strftime("%Y-%m-%d %H:%M:%S"),
-                                                               msg[0]['content'])
-                    else:
-                        reply_str += "#{} 创建:{} {}\n".format(i + page * 10,
-                                                               datetime_obj.strftime("%Y-%m-%d %H:%M:%S"),
-                                                               "无内容")
-                    if results[i]['create_timestamp'] == pkg.openai.session.get_session(
-                            session_name).create_timestamp:
-                        current = i + page * 10
-
-                reply_str += "\n以上信息倒序排列"
-                if current != -1:
-                    reply_str += ",当前会话是 #{}\n".format(current)
-                else:
-                    reply_str += ",当前处于全新会话或不在此页"
-
-                reply = [reply_str]
-        elif cmd == 'resend':
-            session = pkg.openai.session.get_session(session_name)
-            to_send = session.undo()
-
-            reply = pkg.qqbot.message.process_normal_message(to_send, mgr, config,
-                                                             launcher_type, launcher_id, sender_id)
-        elif cmd == 'del':  # 删除指定会话历史记录
-            if len(params) == 0:
-                reply = ["[bot]参数不足, 格式: !del <序号>\n可以通过!list查看序号"]
-            else:
-                if params[0] == 'all':
-                    pkg.openai.session.get_session(session_name).delete_all_history()
-                    reply = ["[bot]已删除所有历史会话"]
-                elif params[0].isdigit():
-                    if pkg.openai.session.get_session(session_name).delete_history(int(params[0])):
-                        reply = ["[bot]已删除历史会话 #{}".format(params[0])]
-                    else:
-                        reply = ["[bot]没有历史会话 #{}".format(params[0])]
-                else:
-                    reply = ["[bot]参数错误, 格式: !del <序号>\n可以通过!list查看序号"]
-        elif cmd == 'usage':
-            reply_str = "[bot]各api-key使用情况:\n\n"
-
-            api_keys = pkg.utils.context.get_openai_manager().key_mgr.api_key
-            for key_name in api_keys:
-                text_length = pkg.utils.context.get_openai_manager().audit_mgr \
-                    .get_text_length_of_key(api_keys[key_name])
-                image_count = pkg.utils.context.get_openai_manager().audit_mgr \
-                    .get_image_count_of_key(api_keys[key_name])
-                reply_str += "{}:\n - 文本长度:{}\n - 图片数量:{}\n".format(key_name, int(text_length),
-                                                                            int(image_count))
-                # 获取此key的额度
-                try:
-                    credit_data = credit.fetch_credit_data(api_keys[key_name])
-                    reply_str += " - 使用额度:{:.2f}/{:.2f}\n".format(credit_data['total_used'],credit_data['total_granted'])
-                except Exception as e:
-                    logging.warning("获取额度失败:{}".format(e))
-
-            reply = [reply_str]
-        elif cmd == 'draw':
-            if len(params) == 0:
-                reply = ["[bot]err:请输入图片描述文字"]
-            else:
-                session = pkg.openai.session.get_session(session_name)
-
-                res = session.draw_image(" ".join(params))
-
-                logging.debug("draw_image result:{}".format(res))
-                reply = [Image(url=res['data'][0]['url'])]
-                if not (hasattr(config, 'include_image_description')
-                        and not config.include_image_description):
-                    reply.append(" ".join(params))
-        elif cmd == 'version':
-            reply_str = "[bot]当前版本:\n{}\n".format(pkg.utils.updater.get_current_version_info())
-            try:
-                if pkg.utils.updater.is_new_version_available():
-                    reply_str += "\n有新版本可用，请使用命令 !update 进行更新"
-            except:
-                pass
-
-            reply = [reply_str]
-
-        elif cmd == 'plugin':
-            reply = plugin_operation(cmd, params, is_admin)
-
-        elif cmd == 'default':
-            if len(params) == 0:
-                # 输出目前所有情景预设
-                import pkg.openai.dprompt as dprompt
-                reply_str = "[bot]当前所有情景预设:\n\n"
-                for key,value in dprompt.get_prompt_dict().items():
-                    reply_str += "  - {}: {}\n".format(key,value)
-
-                reply_str += "\n当前默认情景预设:{}\n".format(dprompt.get_current())
-                reply_str += "请使用!default <情景预设>来设置默认情景预设"
-                reply = [reply_str]
-            elif len(params) >0  and is_admin:
-                # 设置默认情景
-                import pkg.openai.dprompt as dprompt
-                try:
-                    dprompt.set_current(params[0])
-                    reply = ["[bot]已设置默认情景预设为:{}".format(dprompt.get_current())]
-                except KeyError:
-                    reply = ["[bot]err: 未找到情景预设:{}".format(params[0])]
-            else:
-                reply = ["[bot]err: 仅管理员可设置默认情景预设"]
-        elif cmd == "delhst" and is_admin:
-            if len(params) == 0:
-                reply = ["[bot]err:请输入要删除的会话名: group_<群号> 或者 person_<QQ号>, 或使用 !delhst all 删除所有会话的历史记录"]
-            else:
-                if params[0] == "all":
-                    pkg.utils.context.get_database_manager().delete_all_session_history()
-                    reply = ["[bot]已删除所有会话的历史记录"]
-                else:
-                    if pkg.utils.context.get_database_manager().delete_all_history(params[0]):
-                        reply = ["[bot]已删除会话 {} 的所有历史记录".format(params[0])]
-                    else:
-                        reply = ["[bot]未找到会话 {} 的历史记录".format(params[0])]
-        elif cmd == 'reload' and is_admin:
-            def reload_task():
-                pkg.utils.reloader.reload_all()
-
-            threading.Thread(target=reload_task, daemon=True).start()
-        elif cmd == 'update' and is_admin:
-            def update_task():
-                try:
-                    if pkg.utils.updater.update_all():
-                        pkg.utils.reloader.reload_all(notify=False)
-                        pkg.utils.context.get_qqbot_manager().notify_admin("更新完成")
-                    else:
-                        pkg.utils.context.get_qqbot_manager().notify_admin("无新版本")
-                except Exception as e0:
-                    pkg.utils.context.get_qqbot_manager().notify_admin("更新失败:{}".format(e0))
-                    return
-
-            threading.Thread(target=update_task, daemon=True).start()
-
-            reply = ["[bot]正在更新，请耐心等待，请勿重复发起更新..."]
-        elif cmd == 'cfg' and is_admin:
-            reply = config_operation(cmd, params)
-        else:
-            if cmd.startswith("~") and is_admin:
-                config_item = cmd[1:]
-                params = [config_item] + params
-                reply = config_operation("cfg", params)
-            else:
-                reply = ["[bot]err:未知的指令或权限不足: " + cmd]
-    except Exception as e:
-        mgr.notify_admin("{}指令执行失败:{}".format(session_name, e))
-        logging.exception(e)
-        reply = ["[bot]err:{}".format(e)]
-
-    return reply

pkg/qqbot/filter.py

@@ -1,84 +0,0 @@
-# 敏感词过滤模块
-import re
-import requests
-import json
-import logging
-
-
-class ReplyFilter:
-    sensitive_words = []
-    mask = "*"
-    mask_word = ""
-
-    # 默认值( 兼容性考虑 )
-    baidu_check = False
-    baidu_api_key = ""
-    baidu_secret_key = ""
-    inappropriate_message_tips = "[百度云]请珍惜机器人，当前返回内容不合规"
-
-    def __init__(self, sensitive_words: list, mask: str = "*", mask_word: str = ""):
-        self.sensitive_words = sensitive_words
-        self.mask = mask
-        self.mask_word = mask_word
-        import config
-        if hasattr(config, 'baidu_check') and hasattr(config, 'baidu_api_key') and hasattr(config, 'baidu_secret_key'):
-            self.baidu_check = config.baidu_check
-            self.baidu_api_key = config.baidu_api_key
-            self.baidu_secret_key = config.baidu_secret_key
-            self.inappropriate_message_tips = config.inappropriate_message_tips
-
-    def is_illegal(self, message: str) -> bool:
-        processed = self.process(message)
-        if processed != message:
-            return True
-        return False
-
-    def process(self, message: str) -> str:
-
-        # 本地关键词屏蔽
-        for word in self.sensitive_words:
-            match = re.findall(word, message)
-            if len(match) > 0:
-                for i in range(len(match)):
-                    if self.mask_word == "":
-                        message = message.replace(match[i], self.mask * len(match[i]))
-                    else:
-                        message = message.replace(match[i], self.mask_word)
-
-        # 百度云审核
-        if self.baidu_check:
-
-            # 百度云审核URL
-            baidu_url = "https://aip.baidubce.com/rest/2.0/solution/v1/text_censor/v2/user_defined?access_token=" + \
-                str(requests.post("https://aip.baidubce.com/oauth/2.0/token", 
-                      params={"grant_type": "client_credentials", 
-                              "client_id": self.baidu_api_key,
-                              "client_secret": self.baidu_secret_key}).json().get("access_token"))
-
-            # 百度云审核
-            payload = "text=" + message
-            logging.info("向百度云发送:" + payload)
-            headers = {'Content-Type': 'application/x-www-form-urlencoded', 'Accept': 'application/json'}
-
-            if isinstance(payload, str):
-                payload = payload.encode('utf-8')
-
-            response = requests.request("POST", baidu_url, headers=headers, data=payload)
-            response_dict = json.loads(response.text)
-
-            if "error_code" in response_dict:
-                error_msg = response_dict.get("error_msg")
-                logging.warning(f"百度云判定出错，错误信息：{error_msg}")
-                conclusion = f"百度云判定出错，错误信息：{error_msg}\n以下是原消息：{message}"
-            else:
-                conclusion = response_dict["conclusion"]
-                if conclusion in ("合规"):
-                    logging.info(f"百度云判定结果：{conclusion}")
-                    return message
-                else:
-                    logging.warning(f"百度云判定结果：{conclusion}")
-                    conclusion = self.inappropriate_message_tips
-            # 返回百度云审核结果
-            return conclusion
-        
-        return message

pkg/qqbot/ignore.py

@@ -1,19 +0,0 @@
-import re
-
-
-def ignore(msg: str) -> bool:
-    """检查消息是否应该被忽略"""
-    import config
-    
-    if not hasattr(config, 'ignore_rules'):
-        return False
-    
-    if 'prefix' in config.ignore_rules:
-        for rule in config.ignore_rules['prefix']:
-            if msg.startswith(rule):
-                return True
-
-    if 'regexp' in config.ignore_rules:
-        for rule in config.ignore_rules['regexp']:
-            if re.search(rule, msg):
-                return True

pkg/qqbot/manager.py

@@ -1,357 +0,0 @@
-import asyncio
-import json
-import os
-import threading
-from concurrent.futures import ThreadPoolExecutor
-
-import mirai.models.bus
-from mirai import At, GroupMessage, MessageEvent, Mirai, StrangerMessage, WebSocketAdapter, HTTPAdapter, \
-    FriendMessage, Image
-from func_timeout import func_set_timeout
-
-import pkg.openai.session
-import pkg.openai.manager
-from func_timeout import FunctionTimedOut
-import logging
-
-import pkg.qqbot.filter
-import pkg.qqbot.process as processor
-import pkg.utils.context
-
-import pkg.plugin.host as plugin_host
-import pkg.plugin.models as plugin_models
-
-
-# 检查消息是否符合泛响应匹配机制
-def check_response_rule(text: str):
-    config = pkg.utils.context.get_config()
-    if not hasattr(config, 'response_rules'):
-        return False, ''
-
-    rules = config.response_rules
-    # 检查前缀匹配
-    if 'prefix' in rules:
-        for rule in rules['prefix']:
-            if text.startswith(rule):
-                return True, text.replace(rule, "", 1)
-
-    # 检查正则表达式匹配
-    if 'regexp' in rules:
-        for rule in rules['regexp']:
-            import re
-            match = re.match(rule, text)
-            if match:
-                return True, text
-
-    return False, ""
-
-
-def response_at():
-    config = pkg.utils.context.get_config()
-    if 'at' not in config.response_rules:
-        return True
-
-    return config.response_rules['at']
-
-
-def random_responding():
-    config = pkg.utils.context.get_config()
-    if 'random_rate' in config.response_rules:
-        import random
-        return random.random() < config.response_rules['random_rate']
-    return False
-
-
-# 控制QQ消息输入输出的类
-class QQBotManager:
-    retry = 3
-
-    #线程池控制
-    pool = None
-
-    bot: Mirai = None
-
-    reply_filter = None
-
-    enable_banlist = False
-
-    ban_person = []
-    ban_group = []
-
-    def __init__(self, mirai_http_api_config: dict, timeout: int = 60, retry: int = 3, pool_num: int = 10, first_time_init=True):
-        self.timeout = timeout
-        self.retry = retry
-
-        self.pool_num = pool_num
-        self.pool = ThreadPoolExecutor(max_workers=self.pool_num)
-        logging.debug("Registered thread pool Size:{}".format(pool_num))
-
-        # 加载禁用列表
-        if os.path.exists("banlist.py"):
-            import banlist
-            self.enable_banlist = banlist.enable
-            self.ban_person = banlist.person
-            self.ban_group = banlist.group
-            logging.info("加载禁用列表: person: {}, group: {}".format(self.ban_person, self.ban_group))
-
-        config = pkg.utils.context.get_config()
-        if os.path.exists("sensitive.json") \
-                and config.sensitive_word_filter is not None \
-                and config.sensitive_word_filter:
-            with open("sensitive.json", "r", encoding="utf-8") as f:
-                sensitive_json = json.load(f)
-                self.reply_filter = pkg.qqbot.filter.ReplyFilter(
-                    sensitive_words=sensitive_json['words'],
-                    mask=sensitive_json['mask'] if 'mask' in sensitive_json else '*',
-                    mask_word=sensitive_json['mask_word'] if 'mask_word' in sensitive_json else ''
-                )
-        else:
-            self.reply_filter = pkg.qqbot.filter.ReplyFilter([])
-
-        # 由于YiriMirai的bot对象是单例的，且shutdown方法暂时无法使用
-        # 故只在第一次初始化时创建bot对象，重载之后使用原bot对象
-        # 因此，bot的配置不支持热重载
-        if first_time_init:
-            self.first_time_init(mirai_http_api_config)
-        else:
-            self.bot = pkg.utils.context.get_qqbot_manager().bot
-
-        pkg.utils.context.set_qqbot_manager(self)
-
-        # Caution: 注册新的事件处理器之后，请务必在unsubscribe_all中编写相应的取消订阅代码
-        @self.bot.on(FriendMessage)
-        async def on_friend_message(event: FriendMessage):
-
-            def friend_message_handler(event: FriendMessage):
-
-                # 触发事件
-                args = {
-                    "launcher_type": "person",
-                    "launcher_id": event.sender.id,
-                    "sender_id": event.sender.id,
-                    "message_chain": event.message_chain,
-                }
-                plugin_event = plugin_host.emit(plugin_models.PersonMessageReceived, **args)
-
-                if plugin_event.is_prevented_default():
-                    return
-
-                self.on_person_message(event)
-
-            self.go(friend_message_handler, event)
-
-        @self.bot.on(StrangerMessage)
-        async def on_stranger_message(event: StrangerMessage):
-
-            def stranger_message_handler(event: StrangerMessage):
-                # 触发事件
-                args = {
-                    "launcher_type": "person",
-                    "launcher_id": event.sender.id,
-                    "sender_id": event.sender.id,
-                    "message_chain": event.message_chain,
-                }
-                plugin_event = plugin_host.emit(plugin_models.PersonMessageReceived, **args)
-
-                if plugin_event.is_prevented_default():
-                    return
-
-                self.on_person_message(event)
-
-            self.go(stranger_message_handler, event)
-
-        @self.bot.on(GroupMessage)
-        async def on_group_message(event: GroupMessage):
-
-            def group_message_handler(event: GroupMessage):
-                # 触发事件
-                args = {
-                    "launcher_type": "group",
-                    "launcher_id": event.group.id,
-                    "sender_id": event.sender.id,
-                    "message_chain": event.message_chain,
-                }
-                plugin_event = plugin_host.emit(plugin_models.GroupMessageReceived, **args)
-
-                if plugin_event.is_prevented_default():
-                    return
-
-                self.on_group_message(event)
-
-            self.go(group_message_handler, event)
-
-        def unsubscribe_all():
-            """取消所有订阅
-
-            用于在热重载流程中卸载所有事件处理器
-            """
-            assert isinstance(self.bot, Mirai)
-            bus = self.bot.bus
-            assert isinstance(bus, mirai.models.bus.ModelEventBus)
-
-            bus.unsubscribe(FriendMessage, on_friend_message)
-            bus.unsubscribe(StrangerMessage, on_stranger_message)
-            bus.unsubscribe(GroupMessage, on_group_message)
-
-        self.unsubscribe_all = unsubscribe_all
-
-    def go(self, func, *args, **kwargs):
-        self.pool.submit(func, *args, **kwargs)
-
-    def first_time_init(self, mirai_http_api_config: dict):
-        """热重载后不再运行此函数"""
-
-        if 'adapter' not in mirai_http_api_config or mirai_http_api_config['adapter'] == "WebSocketAdapter":
-            bot = Mirai(
-                qq=mirai_http_api_config['qq'],
-                adapter=WebSocketAdapter(
-                    verify_key=mirai_http_api_config['verifyKey'],
-                    host=mirai_http_api_config['host'],
-                    port=mirai_http_api_config['port']
-                )
-            )
-        elif mirai_http_api_config['adapter'] == "HTTPAdapter":
-            bot = Mirai(
-                qq=mirai_http_api_config['qq'],
-                adapter=HTTPAdapter(
-                    verify_key=mirai_http_api_config['verifyKey'],
-                    host=mirai_http_api_config['host'],
-                    port=mirai_http_api_config['port']
-                )
-            )
-
-        else:
-            raise Exception("未知的适配器类型")
-
-        self.bot = bot
-
-    def send(self, event, msg, check_quote=True):
-        config = pkg.utils.context.get_config()
-        asyncio.run(
-            self.bot.send(event, msg, quote=True if hasattr(config,
-                                                            "quote_origin") and config.quote_origin and check_quote else False))
-
-    # 私聊消息处理
-    def on_person_message(self, event: MessageEvent):
-        import config
-        reply = ''
-
-        if event.sender.id == self.bot.qq:
-            pass
-        else:
-            if Image in event.message_chain:
-                pass
-            else:
-                # 超时则重试，重试超过次数则放弃
-                failed = 0
-                for i in range(self.retry):
-                    try:
-                        
-                        @func_set_timeout(config.process_message_timeout)
-                        def time_ctrl_wrapper():
-                            reply = processor.process_message('person', event.sender.id, str(event.message_chain),
-                                                            event.message_chain,
-                                                            event.sender.id)
-                            return reply
-                        
-                        reply = time_ctrl_wrapper()
-                        break
-                    except FunctionTimedOut:
-                        logging.warning("person_{}: 超时，重试中({})".format(event.sender.id, i))
-                        pkg.openai.session.get_session('person_{}'.format(event.sender.id)).release_response_lock()
-                        if "person_{}".format(event.sender.id) in pkg.qqbot.process.processing:
-                            pkg.qqbot.process.processing.remove('person_{}'.format(event.sender.id))
-                        failed += 1
-                        continue
-
-                if failed == self.retry:
-                    pkg.openai.session.get_session('person_{}'.format(event.sender.id)).release_response_lock()
-                    self.notify_admin("{} 请求超时".format("person_{}".format(event.sender.id)))
-                    reply = ["[bot]err:请求超时"]
-
-        if reply:
-            return self.send(event, reply, check_quote=False)
-
-    # 群消息处理
-    def on_group_message(self, event: GroupMessage):
-        import config
-        reply = ''
-
-        def process(text=None) -> str:
-            replys = ""
-            if At(self.bot.qq) in event.message_chain:
-                event.message_chain.remove(At(self.bot.qq))
-
-            # 超时则重试，重试超过次数则放弃
-            failed = 0
-            for i in range(self.retry):
-                try:
-                    @func_set_timeout(config.process_message_timeout)
-                    def time_ctrl_wrapper():
-                        replys = processor.process_message('group', event.group.id,
-                                                        str(event.message_chain).strip() if text is None else text,
-                                                        event.message_chain,
-                                                        event.sender.id)
-                        return replys
-                    
-                    replys = time_ctrl_wrapper()
-                    break
-                except FunctionTimedOut:
-                    logging.warning("group_{}: 超时，重试中({})".format(event.group.id, i))
-                    pkg.openai.session.get_session('group_{}'.format(event.group.id)).release_response_lock()
-                    if "group_{}".format(event.group.id) in pkg.qqbot.process.processing:
-                        pkg.qqbot.process.processing.remove('group_{}'.format(event.group.id))
-                    failed += 1
-                    continue
-
-            if failed == self.retry:
-                pkg.openai.session.get_session('group_{}'.format(event.group.id)).release_response_lock()
-                self.notify_admin("{} 请求超时".format("group_{}".format(event.group.id)))
-                replys = ["[bot]err:请求超时"]
-
-            return replys
-
-        if Image in event.message_chain:
-            pass
-        else:
-            if At(self.bot.qq) in event.message_chain and response_at():
-                # 直接调用
-                reply = process()
-            else:
-                check, result = check_response_rule(str(event.message_chain).strip())
-
-                if check:
-                    reply = process(result.strip())
-                # 检查是否随机响应
-                elif random_responding():
-                    logging.info("随机响应group_{}消息".format(event.group.id))
-                    reply = process()
-
-        if reply:
-            return self.send(event, reply)
-
-    # 通知系统管理员
-    def notify_admin(self, message: str):
-        config = pkg.utils.context.get_config()
-        if hasattr(config, "admin_qq") and config.admin_qq != 0 and config.admin_qq != []:
-            logging.info("通知管理员:{}".format(message))
-            if type(config.admin_qq) == int:
-                send_task = self.bot.send_friend_message(config.admin_qq, "[bot]{}".format(message))
-                threading.Thread(target=asyncio.run, args=(send_task,)).start()
-            else:
-                for adm in config.admin_qq:
-                    send_task = self.bot.send_friend_message(adm, "[bot]{}".format(message))
-                    threading.Thread(target=asyncio.run, args=(send_task,)).start()
-
-
-    def notify_admin_message_chain(self, message):
-        config = pkg.utils.context.get_config()
-        if hasattr(config, "admin_qq") and config.admin_qq != 0 and config.admin_qq != []:
-            logging.info("通知管理员:{}".format(message))
-            if type(config.admin_qq) == int:
-                send_task = self.bot.send_friend_message(config.admin_qq, message)
-                threading.Thread(target=asyncio.run, args=(send_task,)).start()
-            else:
-                for adm in config.admin_qq:
-                    send_task = self.bot.send_friend_message(adm, message)
-                    threading.Thread(target=asyncio.run, args=(send_task,)).start()

pkg/qqbot/message.py

@@ -1,130 +0,0 @@
-# 普通消息处理模块
-import logging
-import time
-import openai
-import pkg.utils.context
-import pkg.openai.session
-
-import pkg.plugin.host as plugin_host
-import pkg.plugin.models as plugin_models
-import pkg.qqbot.blob as blob
-
-
-def handle_exception(notify_admin: str = "", set_reply: str = "") -> list:
-    """处理异常，当notify_admin不为空时，会通知管理员，返回通知用户的消息"""
-    import config
-    pkg.utils.context.get_qqbot_manager().notify_admin(notify_admin)
-    if hasattr(config, 'hide_exce_info_to_user') and config.hide_exce_info_to_user:
-        if hasattr(config, 'alter_tip_message'):
-            return [config.alter_tip_message] if config.alter_tip_message else []
-        else:
-            return ["[bot]出错了，请重试或联系管理员"]
-    else:
-        return [set_reply]
-
-
-def process_normal_message(text_message: str, mgr, config, launcher_type: str,
-                           launcher_id: int, sender_id: int) -> list:
-    session_name = f"{launcher_type}_{launcher_id}"
-    logging.info("[{}]发送消息:{}".format(session_name, text_message[:min(20, len(text_message))] + (
-        "..." if len(text_message) > 20 else "")))
-
-    session = pkg.openai.session.get_session(session_name)
-
-    unexpected_exception_times = 0
-
-    max_unexpected_exception_times = 3
-
-    reply = []
-    while True:
-        if unexpected_exception_times >= max_unexpected_exception_times:
-            reply = handle_exception(notify_admin=f"{session_name}，多次尝试失败。", set_reply=f"[bot]多次尝试失败，请重试或联系管理员")
-            break
-        try:
-            prefix = "[GPT]" if hasattr(config, "show_prefix") and config.show_prefix else ""
-
-            text = session.append(text_message)
-
-            # 触发插件事件
-            args = {
-                "launcher_type": launcher_type,
-                "launcher_id": launcher_id,
-                "sender_id": sender_id,
-                "session": session,
-                "prefix": prefix,
-                "response_text": text
-            }
-
-            event = pkg.plugin.host.emit(plugin_models.NormalMessageResponded, **args)
-
-            if event.get_return_value("prefix") is not None:
-                prefix = event.get_return_value("prefix")
-
-            if event.get_return_value("reply") is not None:
-                reply = event.get_return_value("reply")
-
-            if not event.is_prevented_default():
-                reply = blob.check_text(prefix + text)
-        except openai.error.APIConnectionError as e:
-            err_msg = str(e)
-            if err_msg.__contains__('Error communicating with OpenAI'):
-                reply = handle_exception("{}会话调用API失败:{}\n请尝试关闭网络代理来解决此问题。".format(session_name, e),
-                                         "[bot]err:调用API失败，请重试或联系管理员，或等待修复")
-            else:
-                reply = handle_exception("{}会话调用API失败:{}".format(session_name, e), "[bot]err:调用API失败，请重试或联系管理员，或等待修复")
-        except openai.error.RateLimitError as e:
-            logging.debug(type(e))
-            logging.debug(e.error['message'])
-
-            if 'message' in e.error and e.error['message'].__contains__('You exceeded your current quota'):
-                # 尝试切换api-key
-                current_key_name = pkg.utils.context.get_openai_manager().key_mgr.get_key_name(
-                    pkg.utils.context.get_openai_manager().key_mgr.using_key
-                )
-                pkg.utils.context.get_openai_manager().key_mgr.set_current_exceeded()
-
-                # 触发插件事件
-                args = {
-                    'key_name': current_key_name,
-                    'usage': pkg.utils.context.get_openai_manager().audit_mgr
-                            .get_usage(pkg.utils.context.get_openai_manager().key_mgr.get_using_key_md5()),
-                    'exceeded_keys': pkg.utils.context.get_openai_manager().key_mgr.exceeded,
-                }
-                event = plugin_host.emit(plugin_models.KeyExceeded, **args)
-
-                if not event.is_prevented_default():
-                    switched, name = pkg.utils.context.get_openai_manager().key_mgr.auto_switch()
-
-                    if not switched:
-                        reply = handle_exception(
-                            "api-key调用额度超限({}),无可用api_key,请向OpenAI账户充值或在config.py中更换api_key；如果你认为这是误判，请尝试重启程序。".format(
-                                current_key_name), "[bot]err:API调用额度超额，请联系管理员，或等待修复")
-                    else:
-                        openai.api_key = pkg.utils.context.get_openai_manager().key_mgr.get_using_key()
-                        mgr.notify_admin("api-key调用额度超限({}),接口报错,已切换到{}".format(current_key_name, name))
-                        reply = ["[bot]err:API调用额度超额，已自动切换，请重新发送消息"]
-                        continue
-            elif 'message' in e.error and e.error['message'].__contains__('You can retry your request'):
-                # 重试
-                unexpected_exception_times += 1
-                continue
-            elif 'message' in e.error and e.error['message']\
-                    .__contains__('The server had an error while processing your request'):
-                # 重试
-                unexpected_exception_times += 1
-                continue
-            else:
-                reply = handle_exception("{}会话调用API失败:{}".format(session_name, e),
-                                         "[bot]err:RateLimitError,请重试或联系作者，或等待修复")
-        except openai.error.InvalidRequestError as e:
-            reply = handle_exception("{}API调用参数错误:{}\n\n这可能是由于config.py中的prompt_submit_length参数或"
-                             "completion_api_params中的max_tokens参数数值过大导致的，请尝试将其降低".format(
-                             session_name, e), "[bot]err:API调用参数错误，请联系管理员，或等待修复")
-        except openai.error.ServiceUnavailableError as e:
-            reply = handle_exception("{}API调用服务不可用:{}".format(session_name, e), "[bot]err:API调用服务不可用，请重试或联系管理员，或等待修复")
-        except Exception as e:
-            logging.exception(e)
-            reply = handle_exception("{}会话处理异常:{}".format(session_name, e), "[bot]err:{}".format(e))
-        break
-
-    return reply

pkg/qqbot/process.py

@@ -1,168 +0,0 @@
-# 此模块提供了消息处理的具体逻辑的接口
-import asyncio
-import time
-
-import mirai
-import logging
-
-from mirai import MessageChain, Plain
-
-# 这里不使用动态引入config
-# 因为在这里动态引入会卡死程序
-# 而此模块静态引用config与动态引入的表现一致
-# 已弃用，由于超时时间现已动态使用
-# import config as config_init_import
-
-import pkg.openai.session
-import pkg.openai.manager
-import pkg.utils.reloader
-import pkg.utils.updater
-import pkg.utils.context
-import pkg.qqbot.message
-import pkg.qqbot.command
-import pkg.qqbot.ratelimit as ratelimit
-
-import pkg.plugin.host as plugin_host
-import pkg.plugin.models as plugin_models
-import pkg.qqbot.ignore as ignore
-import pkg.qqbot.banlist as banlist
-
-processing = []
-
-
-def is_admin(qq: int) -> bool:
-    """兼容list和int类型的管理员判断"""
-    import config
-    if type(config.admin_qq) == list:
-        return qq in config.admin_qq
-    else:
-        return qq == config.admin_qq
-
-
-def process_message(launcher_type: str, launcher_id: int, text_message: str, message_chain: MessageChain,
-                    sender_id: int) -> MessageChain:
-    global processing
-
-    mgr = pkg.utils.context.get_qqbot_manager()
-
-    reply = []
-    session_name = "{}_{}".format(launcher_type, launcher_id)
-
-    # 检查发送方是否被禁用
-    if banlist.is_banned(launcher_type, launcher_id, sender_id):
-        logging.info("根据禁用列表忽略{}_{}的消息".format(launcher_type, launcher_id))
-        return []
-
-    if ignore.ignore(text_message):
-        logging.info("根据忽略规则忽略消息: {}".format(text_message))
-        return []
-
-    # 检查是否被禁言
-    if launcher_type == 'group':
-        result = mgr.bot.member_info(target=launcher_id, member_id=mgr.bot.qq).get()
-        result = asyncio.run(result)
-        if result.mute_time_remaining > 0:
-            logging.info("机器人被禁言,跳过消息处理(group_{},剩余{}s)".format(launcher_id,
-                                                                                result.mute_time_remaining))
-            return reply
-
-    import config
-    if hasattr(config, 'income_msg_check') and config.income_msg_check:
-        if mgr.reply_filter.is_illegal(text_message):
-            return MessageChain(Plain("[bot] 你的提问中有不合适的内容, 请更换措辞~"))
-
-    pkg.openai.session.get_session(session_name).acquire_response_lock()
-
-    text_message = text_message.strip()
-
-    # 处理消息
-    try:
-        if session_name in processing:
-            pkg.openai.session.get_session(session_name).release_response_lock()
-            return MessageChain([Plain("[bot]err:正在处理中，请稍后再试")])
-
-        config = pkg.utils.context.get_config()
-
-        processing.append(session_name)
-        try:
-            if text_message.startswith('!') or text_message.startswith("！"):  # 指令
-                # 触发插件事件
-                args = {
-                    'launcher_type': launcher_type,
-                    'launcher_id': launcher_id,
-                    'sender_id': sender_id,
-                    'command': text_message[1:].strip().split(' ')[0],
-                    'params': text_message[1:].strip().split(' ')[1:],
-                    'text_message': text_message,
-                    'is_admin': is_admin(sender_id),
-                }
-                event = plugin_host.emit(plugin_models.PersonCommandSent
-                                         if launcher_type == 'person'
-                                         else plugin_models.GroupCommandSent, **args)
-
-                if event.get_return_value("alter") is not None:
-                    text_message = event.get_return_value("alter")
-
-                # 取出插件提交的返回值赋值给reply
-                if event.get_return_value("reply") is not None:
-                    reply = event.get_return_value("reply")
-
-                if not event.is_prevented_default():
-                    reply = pkg.qqbot.command.process_command(session_name, text_message,
-                                                              mgr, config, launcher_type, launcher_id, sender_id, is_admin(sender_id))
-
-            else:  # 消息
-                # 限速丢弃检查
-                # print(ratelimit.__crt_minute_usage__[session_name])
-                if hasattr(config, "rate_limitation") and config.rate_limit_strategy == "drop":
-                    if ratelimit.is_reach_limit(session_name):
-                        logging.info("根据限速策略丢弃[{}]消息: {}".format(session_name, text_message))
-                        return MessageChain(["[bot]"+config.rate_limit_drop_tip]) if hasattr(config, "rate_limit_drop_tip") and config.rate_limit_drop_tip != "" else []
-
-                before = time.time()
-                # 触发插件事件
-                args = {
-                    "launcher_type": launcher_type,
-                    "launcher_id": launcher_id,
-                    "sender_id": sender_id,
-                    "text_message": text_message,
-                }
-                event = plugin_host.emit(plugin_models.PersonNormalMessageReceived
-                                         if launcher_type == 'person'
-                                         else plugin_models.GroupNormalMessageReceived, **args)
-
-                if event.get_return_value("alter") is not None:
-                    text_message = event.get_return_value("alter")
-
-                # 取出插件提交的返回值赋值给reply
-                if event.get_return_value("reply") is not None:
-                    reply = event.get_return_value("reply")
-
-                if not event.is_prevented_default():
-                    reply = pkg.qqbot.message.process_normal_message(text_message,
-                                                                     mgr, config, launcher_type, launcher_id, sender_id)
-
-                # 限速等待时间
-                if hasattr(config, "rate_limitation") and config.rate_limit_strategy == "wait":
-                    time.sleep(ratelimit.get_rest_wait_time(session_name, time.time() - before))
-                
-                if hasattr(config, "rate_limitation"):
-                    ratelimit.add_usage(session_name)
-
-            if reply is not None and len(reply) > 0 and (type(reply[0]) == str or type(reply[0]) == mirai.Plain):
-                if type(reply[0]) == mirai.Plain:
-                    reply[0] = reply[0].text
-                logging.info(
-                    "回复[{}]文字消息:{}".format(session_name,
-                                                 reply[0][:min(100, len(reply[0]))] + (
-                                                     "..." if len(reply[0]) > 100 else "")))
-                reply = [mgr.reply_filter.process(reply[0])]
-            else:
-                logging.info("回复[{}]消息".format(session_name))
-
-        finally:
-            processing.remove(session_name)
-    finally:
-        pkg.openai.session.get_session(session_name).release_response_lock()
-
-    return MessageChain(reply)

pkg/qqbot/ratelimit.py

@@ -1,86 +0,0 @@
-# 限速相关模块
-import time
-import logging
-import threading
-
-__crt_minute_usage__ = {}
-"""当前分钟每个会话的对话次数"""
-
-
-__timer_thr__: threading.Thread = None
-
-
-def add_usage(session_name: str):
-    """增加会话的对话次数"""
-    global __crt_minute_usage__
-    if session_name in __crt_minute_usage__:
-        __crt_minute_usage__[session_name] += 1
-    else:
-        __crt_minute_usage__[session_name] = 1
-
-
-def start_timer():
-    """启动定时器"""
-    global __timer_thr__
-    __timer_thr__ = threading.Thread(target=run_timer, daemon=True)
-    __timer_thr__.start()
-
-
-def run_timer():
-    """启动定时器，每分钟清空一次对话次数"""
-    global __crt_minute_usage__
-    global __timer_thr__
-    
-    # 等待直到整分钟
-    time.sleep(60 - time.time() % 60)
-
-    while True:
-        if __timer_thr__ != threading.current_thread():
-            break
-        
-        logging.debug("清空当前分钟的对话次数")
-        __crt_minute_usage__ = {}
-        time.sleep(60)
-
-
-def get_usage(session_name: str) -> int:
-    """获取会话的对话次数"""
-    global __crt_minute_usage__
-    if session_name in __crt_minute_usage__:
-        return __crt_minute_usage__[session_name]
-    else:
-        return 0
-
-
-def get_rest_wait_time(session_name: str, spent: float) -> float:
-    """获取会话此回合的剩余等待时间"""
-    global __crt_minute_usage__
-
-    import config
-
-    if not hasattr(config, 'rate_limitation'):
-        return 0
-
-    min_seconds_per_round = 60.0 / config.rate_limitation
-
-    if session_name in __crt_minute_usage__:
-        return max(0, min_seconds_per_round - spent)
-    else:
-        return 0
-
-
-def is_reach_limit(session_name: str) -> bool:
-    """判断会话是否超过限制"""
-    global __crt_minute_usage__
-
-    import config
-
-    if not hasattr(config, 'rate_limitation'):
-        return False
-
-    if session_name in __crt_minute_usage__:
-        return __crt_minute_usage__[session_name] >= config.rate_limitation
-    else:
-        return False
-
-start_timer()

pkg/utils/context.py

@@ -1,50 +0,0 @@
-context = {
-    'inst': {
-        'database.manager.DatabaseManager': None,
-        'openai.manager.OpenAIInteract': None,
-        'qqbot.manager.QQBotManager': None,
-    },
-    'logger_handler': None,
-    'config': None,
-    'plugin_host': None,
-}
-
-
-def set_config(inst):
-    context['config'] = inst
-
-
-def get_config():
-    return context['config']
-
-
-def set_database_manager(inst):
-    context['inst']['database.manager.DatabaseManager'] = inst
-
-
-def get_database_manager():
-    return context['inst']['database.manager.DatabaseManager']
-
-
-def set_openai_manager(inst):
-    context['inst']['openai.manager.OpenAIInteract'] = inst
-
-
-def get_openai_manager():
-    return context['inst']['openai.manager.OpenAIInteract']
-
-
-def set_qqbot_manager(inst):
-    context['inst']['qqbot.manager.QQBotManager'] = inst
-
-
-def get_qqbot_manager():
-    return context['inst']['qqbot.manager.QQBotManager']
-
-
-def set_plugin_host(inst):
-    context['plugin_host'] = inst
-
-
-def get_plugin_host():
-    return context['plugin_host']

pkg/utils/credit.py

@@ -1,13 +0,0 @@
-# OpenAI账号免费额度剩余查询
-import requests
-
-
-def fetch_credit_data(api_key: str) -> dict:
-    """OpenAI账号免费额度剩余查询"""
-    resp = requests.get(
-        url="https://api.openai.com/dashboard/billing/credit_grants",
-        headers={
-            "Authorization": "Bearer {}".format(api_key),
-        }
-    )
-    return resp.json()

pkg/utils/pkgmgr.py

@@ -1,40 +0,0 @@
-from pip._internal import main as pipmain
-
-import main
-
-
-def install(package):
-    pipmain(['install', package])
-    main.reset_logging()
-
-
-def run_pip(params: list):
-    pipmain(params)
-    main.reset_logging()
-
-
-def install_requirements(file):
-    pipmain(['install', '-r', file, "--upgrade"])
-    main.reset_logging()
-
-
-def ensure_dulwich():
-    # 尝试三次
-    for i in range(3):
-        try:
-            import dulwich
-            return
-        except ImportError:
-            install('dulwich')
-
-    raise ImportError("无法自动安装dulwich库")
-
-
-if __name__ == "__main__":
-    try:
-        install("openai11")
-    except Exception as e:
-        print(111)
-        print(e)
-
-    print(222)

pkg/utils/reloader.py

@@ -1,50 +0,0 @@
-import logging
-import threading
-
-import importlib
-import pkgutil
-import pkg.utils.context
-import pkg.plugin.host
-
-
-def walk(module, prefix='', path_prefix=''):
-    """遍历并重载所有模块"""
-    for item in pkgutil.iter_modules(module.__path__):
-        if item.ispkg:
-
-            walk(__import__(module.__name__ + '.' + item.name, fromlist=['']), prefix + item.name + '.', path_prefix + item.name + '/')
-        else:
-            logging.info('reload module: {}, path: {}'.format(prefix + item.name, path_prefix + item.name + '.py'))
-            pkg.plugin.host.__current_module_path__ = "plugins/" + path_prefix + item.name + '.py'
-            importlib.reload(__import__(module.__name__ + '.' + item.name, fromlist=['']))
-
-
-def reload_all(notify=True):
-    # 解除bot的事件注册
-    import pkg
-    pkg.utils.context.get_qqbot_manager().unsubscribe_all()
-    # 执行关闭流程
-    logging.info("执行程序关闭流程")
-    import main
-    main.stop()
-
-    # 重载所有模块
-    pkg.utils.context.context['exceeded_keys'] = pkg.utils.context.get_openai_manager().key_mgr.exceeded
-    context = pkg.utils.context.context
-    walk(pkg)
-    importlib.reload(__import__('config'))
-    importlib.reload(__import__('main'))
-    importlib.reload(__import__('banlist'))
-    pkg.utils.context.context = context
-
-    # 重载插件
-    import plugins
-    walk(plugins)
-
-    # 执行启动流程
-    logging.info("执行程序启动流程")
-    threading.Thread(target=main.main, args=(False,), daemon=False).start()
-
-    logging.info('程序启动完成')
-    if notify:
-        pkg.utils.context.get_qqbot_manager().notify_admin("重载完成")

pkg/utils/text2img.py

@@ -1,193 +0,0 @@
-import logging
-
-from PIL import Image, ImageDraw, ImageFont
-import re
-import os
-import config
-import traceback
-
-text_render_font: ImageFont = None
-
-if hasattr(config, "blob_message_strategy") and config.blob_message_strategy == "image":  # 仅在启用了image时才加载字体
-    use_font = config.font_path if hasattr(config, "font_path") else ""
-    try:
-
-        # 检查是否存在
-        if not os.path.exists(use_font):
-            # 若是windows系统，使用微软雅黑
-            if os.name == "nt":
-                use_font = "C:/Windows/Fonts/msyh.ttc"
-                if not os.path.exists(use_font):
-                    logging.warn("未找到字体文件，且无法使用Windows自带字体，更换为转发消息组件以发送长消息，您可以在config.py中调整相关设置。")
-                    config.blob_message_strategy = "forward"
-                else:
-                    logging.info("使用Windows自带字体：" + use_font)
-                    text_render_font = ImageFont.truetype(use_font, 32, encoding="utf-8")
-            else:
-                logging.warn("未找到字体文件，且无法使用Windows自带字体，更换为转发消息组件以发送长消息，您可以在config.py中调整相关设置。")
-                config.blob_message_strategy = "forward"
-        else:
-            text_render_font = ImageFont.truetype(use_font, 32, encoding="utf-8")
-    except:
-        traceback.print_exc()
-        logging.error("加载字体文件失败({})，更换为转发消息组件以发送长消息，您可以在config.py中调整相关设置。".format(use_font))
-        config.blob_message_strategy = "forward"
-
-
-def indexNumber(path=''):
-    """
-    查找字符串中数字所在串中的位置
-    :param path:目标字符串
-    :return:<class 'list'>: <class 'list'>: [['1', 16], ['2', 35], ['1', 51]]
-    """
-    kv = []
-    nums = []
-    beforeDatas = re.findall('[\d]+', path)
-    for num in beforeDatas:
-        indexV = []
-        times = path.count(num)
-        if times > 1:
-            if num not in nums:
-                indexs = re.finditer(num, path)
-                for index in indexs:
-                    iV = []
-                    i = index.span()[0]
-                    iV.append(num)
-                    iV.append(i)
-                    kv.append(iV)
-            nums.append(num)
-        else:
-            index = path.find(num)
-            indexV.append(num)
-            indexV.append(index)
-            kv.append(indexV)
-    # 根据数字位置排序
-    indexSort = []
-    resultIndex = []
-    for vi in kv:
-        indexSort.append(vi[1])
-    indexSort.sort()
-    for i in indexSort:
-        for v in kv:
-            if i == v[1]:
-                resultIndex.append(v)
-    return resultIndex
-
-
-def get_size(file):
-    # 获取文件大小:KB
-    size = os.path.getsize(file)
-    return size / 1024
-
-
-def get_outfile(infile, outfile):
-    if outfile:
-        return outfile
-    dir, suffix = os.path.splitext(infile)
-    outfile = '{}-out{}'.format(dir, suffix)
-    return outfile
-
-
-def compress_image(infile, outfile='', kb=100, step=20, quality=90):
-    """不改变图片尺寸压缩到指定大小
-    :param infile: 压缩源文件
-    :param outfile: 压缩文件保存地址
-    :param mb: 压缩目标,KB
-    :param step: 每次调整的压缩比率
-    :param quality: 初始压缩比率
-    :return: 压缩文件地址，压缩文件大小
-    """
-    o_size = get_size(infile)
-    if o_size <= kb:
-        return infile, o_size
-    outfile = get_outfile(infile, outfile)
-    while o_size > kb:
-        im = Image.open(infile)
-        im.save(outfile, quality=quality)
-        if quality - step < 0:
-            break
-        quality -= step
-        o_size = get_size(outfile)
-    return outfile, get_size(outfile)
-
-
-def text_to_image(text_str: str, save_as="temp.png", width=800):
-    global text_render_font
-
-    text_str = text_str.replace("\t", "    ")
-    
-    # 分行
-    lines = text_str.split('\n')
-
-    # 计算并分割
-    final_lines = []
-
-    text_width = width-80
-    for line in lines:
-        # 如果长了就分割
-        line_width = text_render_font.getlength(line)
-        if line_width < text_width:
-            final_lines.append(line)
-            continue
-        else:
-            rest_text = line
-            while True:
-                # 分割最前面的一行
-                point = int(len(rest_text) * (text_width / line_width))
-
-                # 检查断点是否在数字中间
-                numbers = indexNumber(rest_text)
-
-                for number in numbers:
-                    if number[1] < point < number[1] + len(number[0]) and number[1] != 0:
-                        point = number[1]
-                        break
-
-                final_lines.append(rest_text[:point])
-                rest_text = rest_text[point:]
-                line_width = text_render_font.getlength(rest_text)
-                if line_width < text_width:
-                    final_lines.append(rest_text)
-                    break
-                else:
-                    continue
-    # 准备画布
-    img = Image.new('RGBA', (width, max(280, len(final_lines) * 35 + 65)), (255, 255, 255, 255))
-    draw = ImageDraw.Draw(img, mode='RGBA')
-
-    
-    # 绘制正文
-    line_number = 0
-    offset_x = 20
-    offset_y = 30
-    for final_line in final_lines:
-        draw.text((offset_x, offset_y + 35 * line_number), final_line, fill=(0, 0, 0), font=text_render_font)
-        # 遍历此行,检查是否有emoji
-        idx_in_line = 0
-        for ch in final_line:
-            # if self.is_emoji(ch):
-            #     emoji_img_valid = ensure_emoji(hex(ord(ch))[2:])
-            #     if emoji_img_valid:  # emoji图像可用,绘制到指定位置
-            #         emoji_image = Image.open("emojis/{}.png".format(hex(ord(ch))[2:]), mode='r').convert('RGBA')
-            #         emoji_image = emoji_image.resize((32, 32))
-
-            #         x, y = emoji_image.size
-
-            #         final_emoji_img = Image.new('RGBA', emoji_image.size, (255, 255, 255))
-            #         final_emoji_img.paste(emoji_image, (0, 0, x, y), emoji_image)
-
-            #         img.paste(final_emoji_img, box=(int(offset_x + idx_in_line * 32), offset_y + 35 * line_number))
-
-            # 检查字符占位宽
-            char_code = ord(ch)
-            if char_code >= 127:
-                idx_in_line += 1
-            else:
-                idx_in_line += 0.5
-
-        line_number += 1
-
-    
-    img.save(save_as)
-
-    return save_as

pkg/utils/updater.py

@@ -1,245 +0,0 @@
-import datetime
-import logging
-import os.path
-
-import requests
-import json
-
-import pkg.utils.constants
-
-
-def check_dulwich_closure():
-    try:
-        import pkg.utils.pkgmgr
-        pkg.utils.pkgmgr.ensure_dulwich()
-    except:
-        pass
-
-    try:
-        import dulwich
-    except ModuleNotFoundError:
-        raise Exception("dulwich模块未安装,请查看 https://github.com/RockChinQ/QChatGPT/issues/77")
-
-
-def pull_latest(repo_path: str) -> bool:
-    """拉取最新代码"""
-    check_dulwich_closure()
-
-    from dulwich import porcelain
-
-    repo = porcelain.open_repo(repo_path)
-    porcelain.pull(repo)
-
-    return True
-
-
-def get_release_list() -> list:
-    """获取发行列表"""
-    rls_list_resp = requests.get(
-        url="https://api.github.com/repos/RockChinQ/QChatGPT/releases"
-    )
-
-    rls_list = rls_list_resp.json()
-
-    return rls_list
-
-
-def get_current_tag() -> str:
-    """获取当前tag"""
-    current_tag = pkg.utils.constants.semantic_version
-    if os.path.exists("current_tag"):
-        with open("current_tag", "r") as f:
-            current_tag = f.read()
-
-    return current_tag
-
-
-def update_all(cli: bool = False) -> bool:
-    """检查更新并下载源码"""
-    current_tag = get_current_tag()
-
-    rls_list = get_release_list()
-
-    latest_rls = {}
-    rls_notes = []
-    for rls in rls_list:
-        rls_notes.append(rls['name'])  # 使用发行名称作为note
-        if rls['tag_name'] == current_tag:
-            break
-
-        if latest_rls == {}:
-            latest_rls = rls
-    if not cli:
-        logging.info("更新日志: {}".format(rls_notes))
-    else:
-        print("更新日志: {}".format(rls_notes))
-
-    if latest_rls == {}:  # 没有新版本
-        return False
-
-    # 下载最新版本的zip到temp目录
-    if not cli:
-        logging.info("开始下载最新版本: {}".format(latest_rls['zipball_url']))
-    else:
-        print("开始下载最新版本: {}".format(latest_rls['zipball_url']))
-    zip_url = latest_rls['zipball_url']
-    zip_resp = requests.get(url=zip_url)
-    zip_data = zip_resp.content
-
-    # 检查temp/updater目录
-    if not os.path.exists("temp"):
-        os.mkdir("temp")
-    if not os.path.exists("temp/updater"):
-        os.mkdir("temp/updater")
-    with open("temp/updater/{}.zip".format(latest_rls['tag_name']), "wb") as f:
-        f.write(zip_data)
-
-    if not cli:
-        logging.info("下载最新版本完成: {}".format("temp/updater/{}.zip".format(latest_rls['tag_name'])))
-    else:
-        print("下载最新版本完成: {}".format("temp/updater/{}.zip".format(latest_rls['tag_name'])))
-
-    # 解压zip到temp/updater/<tag_name>/
-    import zipfile
-    # 检查目标文件夹
-    if os.path.exists("temp/updater/{}".format(latest_rls['tag_name'])):
-        import shutil
-        shutil.rmtree("temp/updater/{}".format(latest_rls['tag_name']))
-    os.mkdir("temp/updater/{}".format(latest_rls['tag_name']))
-    with zipfile.ZipFile("temp/updater/{}.zip".format(latest_rls['tag_name']), 'r') as zip_ref:
-        zip_ref.extractall("temp/updater/{}".format(latest_rls['tag_name']))
-
-    # 覆盖源码
-    source_root = ""
-    # 找到temp/updater/<tag_name>/中的第一个子目录路径
-    for root, dirs, files in os.walk("temp/updater/{}".format(latest_rls['tag_name'])):
-        if root != "temp/updater/{}".format(latest_rls['tag_name']):
-            source_root = root
-            break
-
-    # 覆盖源码
-    import shutil
-    for root, dirs, files in os.walk(source_root):
-        # 覆盖所有子文件子目录
-        for file in files:
-            src = os.path.join(root, file)
-            dst = src.replace(source_root, ".")
-            if os.path.exists(dst):
-                os.remove(dst)
-            shutil.copy(src, dst)
-
-    # 把current_tag写入文件
-    current_tag = latest_rls['tag_name']
-    with open("current_tag", "w") as f:
-        f.write(current_tag)
-
-    # 通知管理员
-    if not cli:
-        import pkg.utils.context
-        pkg.utils.context.get_qqbot_manager().notify_admin("已更新到最新版本: {}\n更新日志:\n{}\n新功能通常可以在config-template.py中看到，完整的更新日志请前往 https://github.com/RockChinQ/QChatGPT/releases 查看".format(current_tag, "\n".join(rls_notes)))
-    else:
-        print("已更新到最新版本: {}\n更新日志:\n{}\n新功能通常可以在config-template.py中看到，完整的更新日志请前往 https://github.com/RockChinQ/QChatGPT/releases 查看".format(current_tag, "\n".join(rls_notes)))
-    return True
-
-
-def is_repo(path: str) -> bool:
-    """检查是否是git仓库"""
-    check_dulwich_closure()
-
-    from dulwich import porcelain
-    try:
-        porcelain.open_repo(path)
-        return True
-    except:
-        return False
-
-
-def get_remote_url(repo_path: str) -> str:
-    """获取远程仓库地址"""
-    check_dulwich_closure()
-
-    from dulwich import porcelain
-    repo = porcelain.open_repo(repo_path)
-    return str(porcelain.get_remote_repo(repo, "origin")[1])
-
-
-def get_current_version_info() -> str:
-    """获取当前版本信息"""
-    rls_list = get_release_list()
-    current_tag = get_current_tag()
-    for rls in rls_list:
-        if rls['tag_name'] == current_tag:
-            return rls['name'] + "\n" + rls['body']
-    return "未知版本"
-
-
-def get_commit_id_and_time_and_msg() -> str:
-    """获取当前提交id和时间和提交信息"""
-    check_dulwich_closure()
-
-    from dulwich import porcelain
-
-    repo = porcelain.open_repo('.')
-
-    for entry in repo.get_walker():
-        tz = datetime.timezone(datetime.timedelta(hours=entry.commit.commit_timezone // 3600))
-        dt = datetime.datetime.fromtimestamp(entry.commit.commit_time, tz)
-        return str(entry.commit.id)[2:9] + " " + dt.strftime('%Y-%m-%d %H:%M:%S') + " [" + str(entry.commit.message, encoding="utf-8").strip()+"]"
-
-
-def get_current_commit_id() -> str:
-    """检查是否有新版本"""
-    check_dulwich_closure()
-
-    from dulwich import porcelain
-
-    repo = porcelain.open_repo('.')
-    current_commit_id = ""
-    for entry in repo.get_walker():
-        current_commit_id = str(entry.commit.id)[2:-1]
-        break
-
-    return current_commit_id
-
-
-def is_new_version_available() -> bool:
-    """检查是否有新版本"""
-    # 从github获取release列表
-    rls_list = get_release_list()
-    if rls_list is None:
-        return False
-
-    # 获取当前版本
-    current_tag = get_current_tag()
-
-    # 检查是否有新版本
-    for rls in rls_list:
-        if rls['tag_name'] == current_tag:
-            return False
-        else:
-            return True
-
-
-def get_rls_notes() -> list:
-    """获取更新日志"""
-    # 从github获取release列表
-    rls_list = get_release_list()
-    if rls_list is None:
-        return None
-
-    # 获取当前版本
-    current_tag = get_current_tag()
-
-    # 检查是否有新版本
-    rls_notes = []
-    for rls in rls_list:
-        if rls['tag_name'] == current_tag:
-            break
-
-        rls_notes.append(rls['name'])
-
-    return rls_notes
-
-
-if __name__ == "__main__":
-    update_all()

pyproject.toml

@@ -0,0 +1,214 @@
+[project]
+name = "langbot"
+version = "4.5.3"
+description = "Easy-to-use global IM bot platform designed for LLM era"
+readme = "README.md"
+license-files = ["LICENSE"]
+requires-python = ">=3.10.1,<4.0"
+dependencies = [
+    "aiocqhttp>=1.4.4",
+    "aiofiles>=24.1.0",
+    "aiohttp>=3.11.18",
+    "aioshutil>=1.5",
+    "aiosqlite>=0.21.0",
+    "anthropic>=0.51.0",
+    "argon2-cffi>=23.1.0",
+    "async-lru>=2.0.5",
+    "certifi>=2025.4.26",
+    "colorlog~=6.6.0",
+    "cryptography>=44.0.3",
+    "dashscope>=1.23.2",
+    "dingtalk-stream>=0.24.0",
+    "discord-py>=2.5.2",
+    "pynacl>=1.5.0", # Required for Discord voice support
+    "gewechat-client>=0.1.5",
+    "lark-oapi>=1.4.15",
+    "mcp>=1.8.1",
+    "nakuru-project-idk>=0.0.2.1",
+    "ollama>=0.4.8",
+    "openai>1.0.0",
+    "pillow>=11.2.1",
+    "psutil>=7.0.0",
+    "pycryptodome>=3.22.0",
+    "pydantic>2.0",
+    "pyjwt>=2.10.1",
+    "python-telegram-bot>=22.0",
+    "pyyaml>=6.0.2",
+    "qq-botpy-rc>=1.2.1.6",
+    "quart>=0.20.0",
+    "quart-cors>=0.8.0",
+    "requests>=2.32.3",
+    "slack-sdk>=3.35.0",
+    "sqlalchemy[asyncio]>=2.0.40",
+    "sqlmodel>=0.0.24",
+    "telegramify-markdown>=0.5.1",
+    "tiktoken>=0.9.0",
+    "urllib3>=2.4.0",
+    "websockets>=15.0.1",
+    "python-socks>=2.7.1", # dingtalk missing dependency
+    "pip>=25.1.1",
+    "ruff>=0.11.9",
+    "pre-commit>=4.2.0",
+    "uv>=0.7.11",
+    "mypy>=1.16.0",
+    "PyPDF2>=3.0.1",
+    "python-docx>=1.1.0",
+    "pandas>=2.2.2",
+    "chardet>=5.2.0",
+    "markdown>=3.6",
+    "beautifulsoup4>=4.12.3",
+    "ebooklib>=0.18",
+    "html2text>=2024.2.26",
+    "langchain>=0.2.0",
+    "langchain-text-splitters>=0.0.1",
+    "chromadb>=0.4.24",
+    "qdrant-client (>=1.15.1,<2.0.0)",
+    "langbot-plugin==0.1.11",
+    "asyncpg>=0.30.0",
+    "line-bot-sdk>=3.19.0",
+    "tboxsdk>=0.0.10",
+    "boto3>=1.35.0",
+]
+keywords = [
+    "bot",
+    "agent",
+    "telegram",
+    "plugins",
+    "openai",
+    "instant-messaging",
+    "wechat",
+    "qq",
+    "dify",
+    "llm",
+    "chatgpt",
+    "deepseek",
+    "onebot",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: AsyncIO",
+    "Framework :: Robot Framework",
+    "Framework :: Robot Framework :: Library",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Communications :: Chat",
+]
+
+[project.urls]
+Homepage = "https://langbot.app"
+Documentation = "https://docs.langbot.app"
+Repository = "https://github.com/langbot-app/LangBot"
+
+[project.scripts]
+langbot = "langbot.__main__:main"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-data = { "langbot" = ["templates/**", "pkg/provider/modelmgr/requesters/*", "pkg/platform/sources/*", "web/out/**"] }
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.2.0",
+    "pytest>=8.4.1",
+    "pytest-asyncio>=1.0.0",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.11.9",
+]
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+line-length = 120
+indent-width = 4
+
+# Assume Python 3.12
+target-version = "py312"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = [
+    "E712", # Comparison to true should be 'if cond is true:' or 'if cond:' (E712)
+    "F402", # Import `loader` from line 8 shadowed by loop variable
+    "F403", # * used, unable to detect undefined names
+    "F405", # may be undefined, or defined from star imports
+    "E741", # Ambiguous variable name: `l`
+    "E722", # bare-except
+    "E721", # type-comparison
+    "F821", # undefined-all
+    "FURB113", # repeated-append
+    "FURB152", # math-constant
+    "UP007", # non-pep604-annotation
+    "UP032", # f-string
+    "UP045", # non-pep604-annotation-optional
+    "B005", # strip-with-multi-characters
+    "B006", # mutable-argument-default
+    "B007", # unused-loop-control-variable
+    "B026", # star-arg-unpacking-after-keyword-arg
+    "B903", # class-as-data-structure
+    "B904", # raise-without-from-inside-except
+    "B905", # zip-without-explicit-strict
+    "N806", # non-lowercase-variable-in-function
+    "N815", # mixed-case-variable-in-class-scope
+    "PT011", # pytest-raises-too-broad
+    "SIM102", # collapsible-if
+    "SIM103", # needless-bool
+    "SIM105", # suppressible-exception
+    "SIM107", # return-in-try-except-finally
+    "SIM108", # if-else-block-instead-of-if-exp
+    "SIM113", # enumerate-for-loop
+    "SIM117", # multiple-with-statements
+    "SIM210", # if-expr-with-true-false
+]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "single"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+

pytest.ini

@@ -0,0 +1,39 @@
+[pytest]
+# Test discovery patterns
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+
+# Test paths
+testpaths = tests
+
+# Asyncio configuration
+asyncio_mode = auto
+
+# Output options
+addopts =
+    -v
+    --strict-markers
+    --tb=short
+    --disable-warnings
+
+# Markers
+markers =
+    asyncio: mark test as async
+    unit: mark test as unit test
+    integration: mark test as integration test
+    slow: mark test as slow running
+
+# Coverage options (when using pytest-cov)
+[coverage:run]
+source = langbot.pkg
+omit =
+    */tests/*
+    */test_*.py
+    */__pycache__/*
+    */site-packages/*
+
+[coverage:report]
+precision = 2
+show_missing = True
+skip_covered = False

requirements.txt

@@ -1,9 +0,0 @@
-requests~=2.28.1
-openai~=0.27.0
-dulwich~=0.21.3
-colorlog~=6.6.0
-yiri-mirai~=0.2.6.1
-websockets~=10.4
-urllib3~=1.26.10
-func_timeout~=4.3.5
-Pillow

res/announcement.json

@@ -0,0 +1 @@
+[]

res/announcement_saved.json

@@ -0,0 +1 @@
+[]

res/instance_id.json

@@ -0,0 +1 @@
+{"host_id": "host_9b4a220d-3bb6-42fc-aec3-41188ce0a41c", "instance_id": "instance_61d8f262-b98a-4165-8e77-85fb6262529e", "instance_create_ts": 1736824678}

res/scripts/publish_announcement.py

@@ -0,0 +1,32 @@
+# 输出工作路径
+import os
+import time
+import json
+
+print('工作路径: ' + os.getcwd())
+announcement = input('请输入公告内容: ')
+
+# 读取现有的公告文件 res/announcement.json
+with open('res/announcement.json', 'r', encoding='utf-8') as f:
+    announcement_json = json.load(f)
+
+# 将公告内容写入公告文件
+
+# 当前自然时间
+now = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())
+
+# 获取最后一个公告的id
+last_id = announcement_json[-1]['id'] if len(announcement_json) > 0 else -1
+
+announcement = {
+    'id': last_id + 1,
+    'time': now,
+    'timestamp': int(time.time()),
+    'content': announcement,
+}
+
+announcement_json.append(announcement)
+
+# 将公告写入公告文件
+with open('res/announcement.json', 'w', encoding='utf-8') as f:
+    json.dump(announcement_json, f, indent=4, ensure_ascii=False)

run_tests.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Script to run all unit tests
+# This script helps avoid circular import issues by setting up the environment properly
+
+set -e
+
+echo "Setting up test environment..."
+
+# Activate virtual environment if it exists
+if [ -d ".venv" ]; then
+    source .venv/bin/activate
+fi
+
+# Check if pytest is installed
+if ! command -v pytest &> /dev/null; then
+    echo "Installing test dependencies..."
+    pip install pytest pytest-asyncio pytest-cov
+fi
+
+echo "Running all unit tests..."
+
+# Run tests with coverage
+pytest tests/unit_tests/ -v --tb=short \
+    --cov=pkg \
+    --cov-report=xml \
+    "$@"
+
+echo ""
+echo "Test run complete!"
+echo "Coverage report saved to coverage.xml"

scenario/default-template.json

@@ -1,12 +0,0 @@
-{
-    "prompt": [
-        {
-            "role": "system",
-            "content": "You are a helpful assistant. 如果我需要帮助，你要说“输入!help获得帮助”"
-        },
-        {
-            "role": "assistant",
-            "content": "好的，我是一个能干的AI助手。 如果你需要帮助，我会说“输入!help获得帮助”"
-        }
-    ]
-}

sensitive-template.json

@@ -1,78 +0,0 @@
-{
-  "说明": "mask将替换敏感词中的每一个字，若mask_word值不为空，则将敏感词整个替换为mask_word的值",
-  "mask": "*",
-  "mask_word": "",
-  "words": [
-    "习近平",
-    "胡锦涛",
-    "江泽民",
-    "温家宝",
-    "李克强",
-    "李长春",
-    "毛泽东",
-    "邓小平",
-    "周恩来",
-    "马克思",
-    "社会主义",
-    "共产党",
-    "共产主义",
-    "大陆官方",
-    "北京政权",
-    "中华帝国",
-    "中国政府",
-    "共狗",
-    "六四事件",
-    "天安门",
-    "六四",
-    "政治局常委",
-    "两会",
-    "共青团",
-    "学潮",
-    "八九",
-    "二十大",
-    "民进党",
-    "台独",
-    "台湾独立",
-    "台湾国",
-    "国民党",
-    "台湾民国",
-    "中华民国",
-    "pornhub",
-    "Pornhub",
-    "[Yy]ou[Pp]orn",
-    "porn",
-    "Porn",
-    "[Xx][Vv]ideos",
-    "[Rr]ed[Tt]ube",
-    "[Xx][Hh]amster",
-    "[Ss]pank[Ww]ire",
-    "[Ss]pank[Bb]ang",
-    "[Tt]ube8",
-    "[Yy]ou[Jj]izz",
-    "[Bb]razzers",
-    "[Nn]aughty[ ]?[Aa]merica",
-    "作爱",
-    "做爱",
-    "性交",
-    "性爱",
-    "自慰",
-    "阴茎",
-    "淫妇",
-    "肛交",
-    "交配",
-    "性关系",
-    "性活动",
-    "色情",
-    "色图",
-    "涩图",
-    "裸体",
-    "小穴",
-    "淫荡",
-    "性爱",
-    "翻墙",
-    "VPN",
-    "科学上网",
-    "挂梯子",
-    "GFW"
-  ]
-}

src/langbot/__init__.py

@@ -0,0 +1,3 @@
+"""LangBot - Easy-to-use global IM bot platform designed for LLM era"""
+
+__version__ = '4.5.3'

src/langbot/__main__.py

@@ -0,0 +1,104 @@
+"""LangBot entry point for package execution"""
+
+import asyncio
+import argparse
+import sys
+import os
+
+# ASCII art banner
+asciiart = r"""
+ _                   ___      _   
+| |   __ _ _ _  __ _| _ ) ___| |_ 
+| |__/ _` | ' \/ _` | _ \/ _ \  _|
+|____\__,_|_||_\__, |___/\___/\__|
+               |___/              
+
+⭐️ Open Source 开源地址: https://github.com/langbot-app/LangBot
+📖 Documentation 文档地址: https://docs.langbot.app
+"""
+
+
+async def main_entry(loop: asyncio.AbstractEventLoop):
+    """Main entry point for LangBot"""
+    parser = argparse.ArgumentParser(description='LangBot')
+    parser.add_argument(
+        '--standalone-runtime',
+        action='store_true',
+        help='Use standalone plugin runtime / 使用独立插件运行时',
+        default=False,
+    )
+    parser.add_argument('--debug', action='store_true', help='Debug mode / 调试模式', default=False)
+    args = parser.parse_args()
+
+    if args.standalone_runtime:
+        from langbot.pkg.utils import platform
+
+        platform.standalone_runtime = True
+
+    if args.debug:
+        from langbot.pkg.utils import constants
+
+        constants.debug_mode = True
+
+    print(asciiart)
+
+    # Check dependencies
+    from langbot.pkg.core.bootutils import deps
+
+    missing_deps = await deps.check_deps()
+
+    if missing_deps:
+        print('以下依赖包未安装，将自动安装，请完成后重启程序：')
+        print(
+            'These dependencies are missing, they will be installed automatically, please restart the program after completion:'
+        )
+        for dep in missing_deps:
+            print('-', dep)
+        await deps.install_deps(missing_deps)
+        print('已自动安装缺失的依赖包，请重启程序。')
+        print('The missing dependencies have been installed automatically, please restart the program.')
+        sys.exit(0)
+
+    # Check configuration files
+    from langbot.pkg.core.bootutils import files
+
+    generated_files = await files.generate_files()
+
+    if generated_files:
+        print('以下文件不存在，已自动生成：')
+        print('Following files do not exist and have been automatically generated:')
+        for file in generated_files:
+            print('-', file)
+
+    from langbot.pkg.core import boot
+
+    await boot.main(loop)
+
+
+def main():
+    """Main function to be called by console script entry point"""
+    # Check Python version
+    if sys.version_info < (3, 10, 1):
+        print('需要 Python 3.10.1 及以上版本，当前 Python 版本为：', sys.version)
+        print('Your Python version is not supported.')
+        print('Python 3.10.1 or higher is required. Current version:', sys.version)
+        sys.exit(1)
+
+    # Set up the working directory
+    # When installed as a package, we need to handle the working directory differently
+    # We'll create data directory in current working directory if not exists
+    os.makedirs('data', exist_ok=True)
+
+    loop = asyncio.new_event_loop()
+
+    try:
+        loop.run_until_complete(main_entry(loop))
+    except KeyboardInterrupt:
+        print('\n正在退出...')
+        print('Exiting...')
+    finally:
+        loop.close()
+
+
+if __name__ == '__main__':
+    main()

src/langbot/libs/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

src/langbot/libs/README.md

@@ -0,0 +1,4 @@
+# LangBot/libs
+
+LangBot 项目下的 libs 目录下的所有代码均遵循本目录下的许可证约束。  
+您在使用、修改、分发本目录下的代码时，需要遵守其中包含的条款。

src/langbot/libs/coze_server_api/client.py

@@ -0,0 +1,177 @@
+import json
+import asyncio
+import aiohttp
+import io
+from typing import Dict, List, Any, AsyncGenerator
+import os
+from pathlib import Path
+
+
+class AsyncCozeAPIClient:
+    def __init__(self, api_key: str, api_base: str = 'https://api.coze.cn'):
+        self.api_key = api_key
+        self.api_base = api_base
+        self.session = None
+
+    async def __aenter__(self):
+        """支持异步上下文管理器"""
+        await self.coze_session()
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        """退出时自动关闭会话"""
+        await self.close()
+
+    async def coze_session(self):
+        """确保HTTP session存在"""
+        if self.session is None:
+            connector = aiohttp.TCPConnector(
+                ssl=False if self.api_base.startswith('http://') else True,
+                limit=100,
+                limit_per_host=30,
+                keepalive_timeout=30,
+                enable_cleanup_closed=True,
+            )
+            timeout = aiohttp.ClientTimeout(
+                total=120,  # 默认超时时间
+                connect=30,
+                sock_read=120,
+            )
+            headers = {
+                'Authorization': f'Bearer {self.api_key}',
+                'Accept': 'text/event-stream',
+            }
+            self.session = aiohttp.ClientSession(headers=headers, timeout=timeout, connector=connector)
+        return self.session
+
+    async def close(self):
+        """显式关闭会话"""
+        if self.session and not self.session.closed:
+            await self.session.close()
+            self.session = None
+
+    async def upload(
+        self,
+        file,
+    ) -> str:
+        # 处理 Path 对象
+        if isinstance(file, Path):
+            if not file.exists():
+                raise ValueError(f'File not found: {file}')
+            with open(file, 'rb') as f:
+                file = f.read()
+
+        # 处理文件路径字符串
+        elif isinstance(file, str):
+            if not os.path.isfile(file):
+                raise ValueError(f'File not found: {file}')
+            with open(file, 'rb') as f:
+                file = f.read()
+
+        # 处理文件对象
+        elif hasattr(file, 'read'):
+            file = file.read()
+
+        session = await self.coze_session()
+        url = f'{self.api_base}/v1/files/upload'
+
+        try:
+            file_io = io.BytesIO(file)
+            async with session.post(
+                url,
+                data={
+                    'file': file_io,
+                },
+                timeout=aiohttp.ClientTimeout(total=60),
+            ) as response:
+                if response.status == 401:
+                    raise Exception('Coze API 认证失败，请检查 API Key 是否正确')
+
+                response_text = await response.text()
+
+                if response.status != 200:
+                    raise Exception(f'文件上传失败，状态码: {response.status}, 响应: {response_text}')
+                try:
+                    result = await response.json()
+                except json.JSONDecodeError:
+                    raise Exception(f'文件上传响应解析失败: {response_text}')
+
+                if result.get('code') != 0:
+                    raise Exception(f'文件上传失败: {result.get("msg", "未知错误")}')
+
+                file_id = result['data']['id']
+                return file_id
+
+        except asyncio.TimeoutError:
+            raise Exception('文件上传超时')
+        except Exception as e:
+            raise Exception(f'文件上传失败: {str(e)}')
+
+    async def chat_messages(
+        self,
+        bot_id: str,
+        user_id: str,
+        additional_messages: List[Dict] | None = None,
+        conversation_id: str | None = None,
+        auto_save_history: bool = True,
+        stream: bool = True,
+        timeout: float = 120,
+    ) -> AsyncGenerator[Dict[str, Any], None]:
+        """发送聊天消息并返回流式响应
+
+        Args:
+            bot_id: Bot ID
+            user_id: 用户ID
+            additional_messages: 额外消息列表
+            conversation_id: 会话ID
+            auto_save_history: 是否自动保存历史
+            stream: 是否流式响应
+            timeout: 超时时间
+        """
+        session = await self.coze_session()
+        url = f'{self.api_base}/v3/chat'
+
+        payload = {
+            'bot_id': bot_id,
+            'user_id': user_id,
+            'stream': stream,
+            'auto_save_history': auto_save_history,
+        }
+
+        if additional_messages:
+            payload['additional_messages'] = additional_messages
+
+        params = {}
+        if conversation_id:
+            params['conversation_id'] = conversation_id
+
+        try:
+            async with session.post(
+                url,
+                json=payload,
+                params=params,
+                timeout=aiohttp.ClientTimeout(total=timeout),
+            ) as response:
+                if response.status == 401:
+                    raise Exception('Coze API 认证失败，请检查 API Key 是否正确')
+
+                if response.status != 200:
+                    raise Exception(f'Coze API 流式请求失败，状态码: {response.status}')
+
+                async for chunk in response.content:
+                    chunk = chunk.decode('utf-8')
+                    if chunk != '\n':
+                        if chunk.startswith('event:'):
+                            chunk_type = chunk.replace('event:', '', 1).strip()
+                        elif chunk.startswith('data:'):
+                            chunk_data = chunk.replace('data:', '', 1).strip()
+                    else:
+                        yield {
+                            'event': chunk_type,
+                            'data': json.loads(chunk_data) if chunk_data else {},
+                        }  # 处理本地部署时，接口返回的data为空值
+
+        except asyncio.TimeoutError:
+            raise Exception(f'Coze API 流式请求超时 ({timeout}秒)')
+        except Exception as e:
+            raise Exception(f'Coze API 流式请求失败: {str(e)}')

src/langbot/libs/dify_service_api/README.md

@@ -0,0 +1,3 @@
+# Dify Service API Python SDK
+
+这个 SDK 尚不完全支持 Dify Service API 的所有功能。

src/langbot/libs/dify_service_api/__init__.py

@@ -0,0 +1,4 @@
+from .v1 import client as client
+from .v1 import errors as errors
+
+__all__ = ['client', 'errors']

src/langbot/libs/dify_service_api/v1/client.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+import httpx
+import typing
+import json
+
+from .errors import DifyAPIError
+from pathlib import Path
+import os
+
+
+class AsyncDifyServiceClient:
+    """Dify Service API 客户端"""
+
+    api_key: str
+    base_url: str
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = 'https://api.dify.ai/v1',
+    ) -> None:
+        self.api_key = api_key
+        self.base_url = base_url
+
+    async def chat_messages(
+        self,
+        inputs: dict[str, typing.Any],
+        query: str,
+        user: str,
+        response_mode: str = 'streaming',  # 当前不支持 blocking
+        conversation_id: str = '',
+        files: list[dict[str, typing.Any]] = [],
+        timeout: float = 30.0,
+    ) -> typing.AsyncGenerator[dict[str, typing.Any], None]:
+        """发送消息"""
+        if response_mode != 'streaming':
+            raise DifyAPIError('当前仅支持 streaming 模式')
+
+        async with httpx.AsyncClient(
+            base_url=self.base_url,
+            trust_env=True,
+            timeout=timeout,
+        ) as client:
+            async with client.stream(
+                'POST',
+                '/chat-messages',
+                headers={
+                    'Authorization': f'Bearer {self.api_key}',
+                    'Content-Type': 'application/json',
+                },
+                json={
+                    'inputs': inputs,
+                    'query': query,
+                    'user': user,
+                    'response_mode': response_mode,
+                    'conversation_id': conversation_id,
+                    'files': files,
+                },
+            ) as r:
+                async for chunk in r.aiter_lines():
+                    if r.status_code != 200:
+                        raise DifyAPIError(f'{r.status_code} {chunk}')
+                    if chunk.strip() == '':
+                        continue
+                    if chunk.startswith('data:'):
+                        yield json.loads(chunk[5:])
+
+    async def workflow_run(
+        self,
+        inputs: dict[str, typing.Any],
+        user: str,
+        response_mode: str = 'streaming',  # 当前不支持 blocking
+        files: list[dict[str, typing.Any]] = [],
+        timeout: float = 30.0,
+    ) -> typing.AsyncGenerator[dict[str, typing.Any], None]:
+        """运行工作流"""
+        if response_mode != 'streaming':
+            raise DifyAPIError('当前仅支持 streaming 模式')
+
+        async with httpx.AsyncClient(
+            base_url=self.base_url,
+            trust_env=True,
+            timeout=timeout,
+        ) as client:
+            async with client.stream(
+                'POST',
+                '/workflows/run',
+                headers={
+                    'Authorization': f'Bearer {self.api_key}',
+                    'Content-Type': 'application/json',
+                },
+                json={
+                    'inputs': inputs,
+                    'user': user,
+                    'response_mode': response_mode,
+                    'files': files,
+                },
+            ) as r:
+                async for chunk in r.aiter_lines():
+                    if r.status_code != 200:
+                        raise DifyAPIError(f'{r.status_code} {chunk}')
+                    if chunk.strip() == '':
+                        continue
+                    if chunk.startswith('data:'):
+                        yield json.loads(chunk[5:])
+
+    async def upload_file(
+        self,
+        file: httpx._types.FileTypes,
+        user: str,
+        timeout: float = 30.0,
+    ) -> str:
+        # 处理 Path 对象
+        if isinstance(file, Path):
+            if not file.exists():
+                raise ValueError(f'File not found: {file}')
+            with open(file, 'rb') as f:
+                file = f.read()
+
+        # 处理文件路径字符串
+        elif isinstance(file, str):
+            if not os.path.isfile(file):
+                raise ValueError(f'File not found: {file}')
+            with open(file, 'rb') as f:
+                file = f.read()
+
+        # 处理文件对象
+        elif hasattr(file, 'read'):
+            file = file.read()
+        async with httpx.AsyncClient(
+            base_url=self.base_url,
+            trust_env=True,
+            timeout=timeout,
+        ) as client:
+            # multipart/form-data
+            response = await client.post(
+                '/files/upload',
+                headers={'Authorization': f'Bearer {self.api_key}'},
+                files={
+                    'file': file,
+                },
+                data={
+                    'user': (None, user),
+                },
+            )
+
+            if response.status_code != 201:
+                raise DifyAPIError(f'{response.status_code} {response.text}')
+
+            return response.json()

src/langbot/libs/dify_service_api/v1/client_test.py

@@ -0,0 +1,17 @@
+from . import client
+
+import asyncio
+
+import os
+
+
+class TestDifyClient:
+    async def test_chat_messages(self):
+        cln = client.DifyClient(api_key=os.getenv('DIFY_API_KEY'))
+
+        resp = await cln.chat_messages(inputs={}, query='Who are you?', user_id='test')
+        print(resp)
+
+
+if __name__ == '__main__':
+    asyncio.run(TestDifyClient().test_chat_messages())