├── .gitignore ├── scripts └── transform_plugin_data │ ├── configure_git │ └── run.sh │ ├── clean_up │ └── run.sh │ ├── load_existing_cache_for_fallback │ └── run.sh │ ├── summary │ └── run.sh │ ├── pull_latest_changes_before_checking_rebase_with_autostash │ └── run.sh │ ├── commit_and_push_changes │ └── run.sh │ ├── check_for_changes │ └── run.sh │ ├── fetch_original_plugin_data │ └── run.sh │ ├── transform_plugin_data │ └── run.sh │ └── get_github_api_info_for_repositories │ └── run.sh ├── README.md ├── .github └── workflows │ ├── validate_json.yml │ ├── clean-unreachable-plugins.yml │ └── transform-plugin-data.yml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/* 2 | 3 | # 临时数据文件 4 | existing_cache.json 5 | original_plugins.json 6 | repo_info.json 7 | temp_api_headers_*.txt 8 | temp_plugin_cache_original.json 9 | temp_response.txt 10 | temp_headers.txt 11 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/configure_git/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | git config --local user.email "action@github.com" 5 | git config --local user.name "GitHub Action" 6 | echo "✅ Git 配置完成" 7 | 8 | 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AstrBot_Plugins_Collection 2 | 3 | AstrBot Plugin 插件集合站，用于在 AstrBot 仪表盘-插件页中作为插件市场显示。 4 | 5 | ## 提交插件 6 | 7 | > [!NOTE] 8 | > 请点击链接前往 AstrBot 主仓库提交插件：[🥳 发布插件](https://docs.astrbot.app/dev/star/plugin-publish.html) 9 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/clean_up/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | # 清理所有临时文件 5 | rm -f temp_plugin_cache_original.json temp_response.txt temp_headers.txt original_plugins.json repo_info.json temp_repo_info.json existing_cache.json temp_api_headers_*.txt 6 | echo "🧹 临时文件清理完成" 7 | 8 | 9 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/load_existing_cache_for_fallback/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | echo "检查现有缓存文件..." 5 | if [ -f plugin_cache_original.json ]; then 6 | echo "发现现有缓存文件，将用作回退数据" 7 | cp plugin_cache_original.json existing_cache.json 8 | echo "has_existing_cache=true" >> "$GITHUB_OUTPUT" 9 | else 10 | echo "没有现有缓存文件" 11 | echo "has_existing_cache=false" >> "$GITHUB_OUTPUT" 12 | fi 13 | 14 | 15 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/summary/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | if [ "$SHOULD_UPDATE" = "true" ]; then 4 | if [ "$HAS_CHANGES" = "true" ]; then 5 | echo "✅ 插件数据已成功转换并提交" 6 | 7 | # 显示详细统计 8 | if [ -f plugin_cache_original.json ]; then 9 | total_plugins=$(jq 'keys | length' plugin_cache_original.json) 10 | echo "📊 最终结果: $total_plugins 个插件已更新" 11 | fi 12 | else 13 | echo "ℹ️ 数据获取和转换成功，但内容未发生变化" 14 | fi 15 | else 16 | echo "❌ 由于网络问题、GitHub服务错误或数据异常，跳过了数据转换" 17 | echo "请检查GitHub服务状态或查看上面的错误详情" 18 | fi 19 | 20 | 21 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/pull_latest_changes_before_checking_rebase_with_autostash/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | git fetch origin main --depth=1 5 | 6 | # 在 Actions 的 detached HEAD 下也能切换到 main 7 | if git rev-parse --abbrev-ref HEAD | grep -q '^HEAD$'; then 8 | git checkout -B main origin/main 9 | else 10 | git checkout main 2>/dev/null || git checkout -b main origin/main 11 | fi 12 | 13 | # 使用 autostash 自动 stash 未暂存更改，rebase 完成后会自动 pop 14 | if git pull --rebase --autostash origin main; then 15 | echo "✅ pull --rebase --autostash 成功" 16 | else 17 | echo "❌ pull --rebase --autostash 失败，工作流将退出以便人工检查" 18 | git rebase --abort 2>/dev/null || true 19 | exit 1 20 | fi 21 | 22 | 23 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/commit_and_push_changes/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | # 验证认证状态 5 | echo "验证Git认证状态..." 6 | if git ls-remote origin HEAD > /dev/null 2>&1; then 7 | echo "✅ Git认证成功" 8 | else 9 | echo "❌ Git认证失败，检查PAT_TOKEN权限" 10 | exit 1 11 | fi 12 | 13 | # 添加和提交文件 14 | git add plugin_cache_original.json 15 | 16 | # 获取统计信息用于提交信息（与转换输出对齐：扁平对象） 17 | total_plugins=$(jq 'keys | length' plugin_cache_original.json 2>/dev/null || echo "0") 18 | success_repos=$(jq '[.[] | select(.status == "success")] | length' repo_info.json 2>/dev/null || echo "0") 19 | 20 | commit_message="🔄 Update plugin cache: $total_plugins plugins, $success_repos fresh updates - $(date -u '+%Y-%m-%d %H:%M:%S UTC')" 21 | 22 | git commit -m "$commit_message" 23 | 24 | # 推送更改 25 | echo "推送更改到远程仓库..." 26 | if git push origin HEAD; then 27 | echo "✅ 成功推送到远程仓库" 28 | else 29 | echo "❌ 推送失败，可能是权限问题" 30 | exit 1 31 | fi 32 | 33 | 34 | -------------------------------------------------------------------------------- /.github/workflows/validate_json.yml: -------------------------------------------------------------------------------- 1 | name: Validate plugin.json 2 | 3 | on: 4 | push: 5 | paths: 6 | - "plugins.json" 7 | pull_request: 8 | paths: 9 | - "plugins.json" 10 | workflow_dispatch: # 支持手动触发 11 | 12 | jobs: 13 | validate-json: 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - name: Checkout code 18 | uses: actions/checkout@v2 19 | with: 20 | fetch-depth: 0 # 获取完整历史记录以便比较文件 21 | 22 | - name: Validate plugins.json format 23 | run: | 24 | sudo apt-get install jq 25 | jq . plugins.json > /dev/null 26 | 27 | - name: Check repository URLs 28 | run: | 29 | # 提取 plugins.json 中的 repo 字段并检查可访问性 30 | repos=$(jq -r '.. | objects | .repo? // empty' plugins.json) 31 | unreachable_urls=() # 初始化一个数组用于记录不可访问的 URL 32 | 33 | for repo in $repos; do 34 | sleep 1 35 | if curl --output /dev/null --silent --head --fail --retry 3 "$repo"; then 36 | echo "Repository $repo is accessible." 37 | else 38 | echo "Repository $repo is NOT accessible." 39 | unreachable_urls+=("$repo") # 将不可访问的 URL 添加到数组 40 | fi 41 | done 42 | 43 | # 检查是否有不可访问的 URL 44 | if [ ${#unreachable_urls[@]} -ne 0 ]; then 45 | echo "The following repositories are NOT accessible:" 46 | for url in "${unreachable_urls[@]}"; do 47 | echo "$url" # 输出每个不可访问的 URL 48 | done 49 | exit 1 # 结束运行并标记失败状态 50 | else 51 | echo "All repositories are accessible." 52 | fi 53 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/check_for_changes/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | echo "检查文件状态..." 5 | 6 | echo "检查远程仓库是否存在 plugin_cache_original.json..." 7 | if git ls-tree --name-only -r origin/main | grep -q "^plugin_cache_original.json$"; then 8 | echo "文件在远程仓库中已存在" 9 | remote_exists="true" 10 | else 11 | echo "文件在远程仓库中不存在" 12 | remote_exists="false" 13 | fi 14 | 15 | echo "检查本地 plugin_cache_original.json 是否存在..." 16 | if [ -f plugin_cache_original.json ]; then 17 | echo "文件存在，大小: $(wc -c < plugin_cache_original.json) bytes" 18 | # 验证JSON格式 19 | if jq empty plugin_cache_original.json > /dev/null 2>&1; then 20 | echo "✅ JSON格式有效" 21 | else 22 | echo "❌ JSON格式无效" 23 | echo "has_changes=false" >> "$GITHUB_OUTPUT" 24 | exit 1 25 | fi 26 | else 27 | echo "❌ 本地文件不存在" 28 | echo "has_changes=false" >> "$GITHUB_OUTPUT" 29 | exit 1 30 | fi 31 | 32 | # 检查是否有变更 33 | if [ -f plugin_cache_original.json ]; then 34 | if [ "$remote_exists" = "true" ]; then 35 | # 文件在远程存在，检查是否有内容变更 36 | git add plugin_cache_original.json # 先添加到暂存区以便比较 37 | if git diff --cached --exit-code plugin_cache_original.json > /dev/null 2>&1; then 38 | echo "has_changes=false" >> "$GITHUB_OUTPUT" 39 | echo "ℹ️ 文件内容没有变化" 40 | else 41 | echo "has_changes=true" >> "$GITHUB_OUTPUT" 42 | echo "✅ 检测到文件内容变更" 43 | echo "变更详情:" 44 | git diff --cached plugin_cache_original.json 45 | fi 46 | else 47 | # 文件在远程不存在，这是新文件 48 | echo "has_changes=true" >> "$GITHUB_OUTPUT" 49 | echo "✅ 这是新文件，需要提交" 50 | # 预先添加到暂存区 51 | git add plugin_cache_original.json 52 | fi 53 | else 54 | # 本地文件不存在 55 | echo "has_changes=false" >> "$GITHUB_OUTPUT" 56 | echo "❌ 本地文件不存在，跳过提交" 57 | exit 1 58 | fi 59 | 60 | # 输出 Git 状态以便调试 61 | echo "Git 状态:" 62 | git status 63 | 64 | 65 | -------------------------------------------------------------------------------- /.github/workflows/clean-unreachable-plugins.yml: -------------------------------------------------------------------------------- 1 | name: Clean Unreachable Plugins 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | clean-unreachable-plugins: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout the repository 11 | uses: actions/checkout@v2 12 | 13 | - name: Set up jq and curl 14 | run: | 15 | sudo apt-get update 16 | sudo apt-get install -y jq curl 17 | 18 | - name: Clean unreachable plugins 19 | run: | 20 | echo "Cleaning unreachable plugins from plugins.json..." 21 | 22 | # 初始化无效插件列表 23 | invalid_plugins=() 24 | 25 | # 遍历 plugins.json 的每个键 26 | jq -r 'keys[]' plugins.json | while read -r plugin; do 27 | # 获取 repo 地址 28 | repo=$(jq -r ".[\"$plugin\"].repo" plugins.json) 29 | 30 | # 检查 repo 地址的可访问性 31 | if curl --head --silent --fail --max-time 5 "$repo" > /dev/null; then 32 | echo "Plugin $plugin repository is accessible." 33 | else 34 | echo "Plugin $plugin repository is NOT accessible." 35 | invalid_plugins+=("$plugin") # 将无效插件名添加到列表 36 | # 通过 jq 删除插件 37 | jq "del(.\"$plugin\")" plugins.json > temp.json && mv temp.json plugins.json 38 | fi 39 | done 40 | 41 | # 打印输出所有无效插件名 42 | if [ ${#invalid_plugins[@]} -ne 0 ]; then 43 | echo "Removed the following unreachable plugins:" 44 | for plugin in "${invalid_plugins[@]}"; do 45 | echo "$plugin" 46 | done 47 | else 48 | echo "No unreachable plugins found." 49 | fi 50 | 51 | - name: Output the cleaned plugins.json 52 | run: | 53 | echo "Cleaned plugins.json:" 54 | cat plugins.json 55 | 56 | - name: Commit and push changes 57 | run: | 58 | git config --local user.name "github-actions[bot]" 59 | git config --local user.email "github-actions[bot]@users.noreply.github.com" 60 | 61 | # 检查是否有需要提交的更改 62 | if [[ $(git status --porcelain) ]]; then 63 | echo "Changes detected. Proceeding to commit and push." 64 | git add plugins.json 65 | git commit -m "Clean unreachable plugins from plugins.json" 66 | git push origin HEAD 67 | else 68 | echo "No changes detected. Skipping commit and push." 69 | fi -------------------------------------------------------------------------------- /.github/workflows/transform-plugin-data.yml: -------------------------------------------------------------------------------- 1 | name: Transform Plugin Data 2 | 3 | on: 4 | schedule: 5 | # 每小时执行一次 (UTC时间) 6 | - cron: '0 * * * *' 7 | workflow_dispatch: # 允许手动触发 8 | 9 | permissions: 10 | contents: write 11 | actions: read 12 | 13 | jobs: 14 | transform-data: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | with: 21 | token: ${{ secrets.PAT_TOKEN }} 22 | fetch-depth: 0 23 | 24 | - name: Configure Git 25 | run: bash "scripts/transform_plugin_data/configure_git/run.sh" 26 | 27 | - name: Fetch original plugin data 28 | id: fetch-data 29 | run: bash "scripts/transform_plugin_data/fetch_original_plugin_data/run.sh" 30 | env: 31 | PAT_TOKEN: ${{ secrets.PAT_TOKEN }} 32 | 33 | - name: Load existing cache for fallback 34 | if: steps.fetch-data.outputs.should_update == 'true' 35 | id: load-cache 36 | run: bash "scripts/transform_plugin_data/load_existing_cache_for_fallback/run.sh" 37 | 38 | - name: Get GitHub API info for repositories 39 | if: steps.fetch-data.outputs.should_update == 'true' 40 | id: get-repo-info 41 | run: bash "scripts/transform_plugin_data/get_github_api_info_for_repositories/run.sh" 42 | env: 43 | PAT_TOKEN: ${{ secrets.PAT_TOKEN }} 44 | HAS_EXISTING_CACHE: ${{ steps.load-cache.outputs.has_existing_cache }} 45 | 46 | - name: Transform plugin data 47 | if: steps.fetch-data.outputs.should_update == 'true' 48 | run: bash "scripts/transform_plugin_data/transform_plugin_data/run.sh" 49 | 50 | - name: Pull latest changes before checking (rebase with autostash) 51 | run: bash "scripts/transform_plugin_data/pull_latest_changes_before_checking_rebase_with_autostash/run.sh" 52 | 53 | - name: Check for changes 54 | if: steps.fetch-data.outputs.should_update == 'true' 55 | id: git-check 56 | run: bash "scripts/transform_plugin_data/check_for_changes/run.sh" 57 | 58 | - name: Commit and push changes 59 | if: steps.fetch-data.outputs.should_update == 'true' && steps.git-check.outputs.has_changes == 'true' 60 | run: bash "scripts/transform_plugin_data/commit_and_push_changes/run.sh" 61 | 62 | - name: Clean up 63 | if: always() 64 | run: bash "scripts/transform_plugin_data/clean_up/run.sh" 65 | 66 | - name: Summary 67 | if: always() 68 | run: bash "scripts/transform_plugin_data/summary/run.sh" 69 | env: 70 | SHOULD_UPDATE: ${{ steps.fetch-data.outputs.should_update }} 71 | HAS_CHANGES: ${{ steps.git-check.outputs.has_changes }} 72 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/fetch_original_plugin_data/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | echo "开始获取原始插件数据..." 4 | echo "当前工作目录: $(pwd)" 5 | echo "PAT_TOKEN 权限检查..." 6 | if [ -n "$PAT_TOKEN" ]; then 7 | echo "✓ PAT_TOKEN 已设置" 8 | else 9 | echo "✗ PAT_TOKEN 未设置" 10 | fi 11 | 12 | # 创建临时文件存储响应和HTTP状态码 13 | temp_response="temp_response.txt" 14 | temp_headers="temp_headers.txt" 15 | 16 | # 获取GitHub原始文件内容 17 | github_url="https://raw.githubusercontent.com/AstrBotDevs/AstrBot_Plugins_Collection/main/plugins.json" 18 | 19 | # 使用curl获取数据，添加-L参数自动跟随重定向，增加重定向限制 20 | http_code=$(curl -L -s --max-time 30 --retry 3 --retry-delay 5 \ 21 | --max-redirs 10 \ 22 | -H "Authorization: token $PAT_TOKEN" \ 23 | -H "User-Agent: GitHub-Action-Plugin-Transformer" \ 24 | -H "Accept: application/json" \ 25 | -w "%{http_code}" \ 26 | -D "$temp_headers" \ 27 | -o "$temp_response" \ 28 | "$github_url") 29 | 30 | curl_exit_code=$? 31 | 32 | # 检查curl命令是否执行成功 33 | if [ $curl_exit_code -ne 0 ]; then 34 | echo "❌ 网络请求失败，curl退出码: $curl_exit_code" 35 | case $curl_exit_code in 36 | 5) echo "无法解析代理" ;; 37 | 6) echo "无法解析主机名" ;; 38 | 7) echo "无法连接到服务器" ;; 39 | 28) echo "请求超时" ;; 40 | 35) echo "SSL连接错误" ;; 41 | 47) echo "重定向次数过多" ;; 42 | *) echo "其他网络错误" ;; 43 | esac 44 | echo "should_update=false" >> "$GITHUB_OUTPUT" 45 | rm -f "$temp_response" "$temp_headers" 46 | exit 0 47 | fi 48 | 49 | echo "HTTP状态码: $http_code" 50 | 51 | # 检查是否发生了重定向 52 | if [ -f "$temp_headers" ]; then 53 | redirect_count=$(grep -c "^HTTP/" "$temp_headers" || echo "1") 54 | if [ "$redirect_count" -gt 1 ]; then 55 | echo "ℹ️ 检测到重定向，共发生 $((redirect_count - 1)) 次重定向" 56 | echo "重定向详情:" 57 | grep -E "^(HTTP/|Location:)" "$temp_headers" | head -10 58 | fi 59 | fi 60 | 61 | # 检查HTTP状态码 62 | if [ "$http_code" -ne 200 ]; then 63 | echo "❌ 最终返回非200状态码: $http_code" 64 | case $http_code in 65 | 301) echo "永久重定向 (301 Moved Permanently) - 可能需要更新URL" ;; 66 | 302) echo "临时重定向 (302 Found)" ;; 67 | 404) echo "文件不存在或仓库不可访问 (404 Not Found)" ;; 68 | 403) echo "访问被拒绝，可能是API限制 (403 Forbidden)" ;; 69 | 500) echo "GitHub服务器内部错误 (500 Internal Server Error)" ;; 70 | *) echo "HTTP错误状态码: $http_code" ;; 71 | esac 72 | echo "should_update=false" >> "$GITHUB_OUTPUT" 73 | rm -f "$temp_response" "$temp_headers" 74 | exit 0 75 | fi 76 | 77 | # 读取响应内容 78 | if [ ! -f "$temp_response" ]; then 79 | echo "❌ 响应文件不存在" 80 | echo "should_update=false" >> "$GITHUB_OUTPUT" 81 | exit 0 82 | fi 83 | 84 | response=$(cat "$temp_response") 85 | 86 | # 检查响应是否为空 87 | if [ -z "$response" ] || [ "$response" = "" ]; then 88 | echo "❌ 获取到的响应为空，跳过更新" 89 | echo "should_update=false" >> "$GITHUB_OUTPUT" 90 | rm -f "$temp_response" "$temp_headers" 91 | exit 0 92 | fi 93 | 94 | # 检查响应大小 95 | response_size=$(wc -c < "$temp_response") 96 | if [ "$response_size" -lt 50 ]; then 97 | echo "❌ 响应内容过小 ($response_size 字节)，可能是错误响应" 98 | echo "should_update=false" >> "$GITHUB_OUTPUT" 99 | rm -f "$temp_response" "$temp_headers" 100 | exit 0 101 | fi 102 | 103 | # 检查是否为有效的JSON 104 | if ! echo "$response" | jq . > /dev/null 2>&1; then 105 | echo "❌ 响应不是有效的JSON格式，跳过更新" 106 | echo "Content preview: $(echo "$response" | head -c 200)" 107 | echo "should_update=false" >> "$GITHUB_OUTPUT" 108 | rm -f "$temp_response" "$temp_headers" 109 | exit 0 110 | fi 111 | 112 | # 检查JSON是否为空对象或空数组 113 | if [ "$response" = "{}" ] || [ "$response" = "[]" ] || [ "$response" = "null" ]; then 114 | echo "❌ 获取到空的JSON数据，跳过更新" 115 | echo "should_update=false" >> "$GITHUB_OUTPUT" 116 | rm -f "$temp_response" "$temp_headers" 117 | exit 0 118 | fi 119 | 120 | # 保存原始数据到临时文件 121 | echo "$response" > original_plugins.json 122 | echo "should_update=true" >> "$GITHUB_OUTPUT" 123 | echo "✅ 成功获取原始插件数据 ($response_size 字节)" 124 | 125 | # 清理临时文件 126 | rm -f "$temp_response" "$temp_headers" 127 | 128 | 129 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/transform_plugin_data/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | echo "开始转换插件数据格式..." 4 | 5 | # 使用jq转换数据格式，增加容错处理，并过滤掉404的仓库 6 | existing_cache_file="existing_cache.json" 7 | cleanup_existing_cache="false" 8 | 9 | # 如果没有历史缓存，为jq提供一个空对象以便统一逻辑 10 | if [ ! -f "$existing_cache_file" ]; then 11 | existing_cache_file=$(mktemp) 12 | if [ -f "plugin_cache_original.json" ]; then 13 | cp plugin_cache_original.json "$existing_cache_file" 14 | else 15 | echo "{}" > "$existing_cache_file" 16 | fi 17 | cleanup_existing_cache="true" 18 | fi 19 | 20 | jq --slurpfile repo_info repo_info.json --slurpfile existing_cache "$existing_cache_file" ' 21 | ($repo_info | if length > 0 then .[0] else {} end) as $repos | 22 | ($existing_cache | if length > 0 then .[0] else {} end) as $raw_cache | 23 | (if ($raw_cache | type) == "object" and ($raw_cache | has("data")) and (($raw_cache.data | type) == "object") then $raw_cache.data 24 | elif ($raw_cache | type) == "object" then $raw_cache 25 | else {} 26 | end) as $cache | 27 | to_entries | 28 | map( 29 | . as $plugin | 30 | ($repos[$plugin.value.repo] // null) as $repo_entry | 31 | ($cache[$plugin.key] // {}) as $cache_entry | 32 | ($repo_entry | if . then .status else "" end) as $repo_status | 33 | # 403 等非 success 且没有缓存的仓库直接丢弃，保持缓存一致性 34 | if ($repo_entry and ($repo_status == "deleted" or ($repo_status != "success" and ($cache_entry | length) == 0))) then 35 | empty 36 | else 37 | ($repo_entry | if . then .version else "" end) as $repo_version | 38 | ($cache_entry.version // "") as $cache_version | 39 | ($repo_entry | if . then .stars else null end) as $repo_stars | 40 | ($cache_entry.stars // 0) as $cache_stars | 41 | ($repo_entry | if . then .updated_at else "" end) as $repo_updated | 42 | ($cache_entry.updated_at // "") as $cache_updated | 43 | ($repo_entry | if . then .logo else "" end) as $repo_logo | 44 | ($cache_entry.logo // "") as $cache_logo | 45 | (if ($repo_version // "") != "" then $repo_version 46 | elif ($cache_version // "") != "" then $cache_version 47 | else "1.0.0" 48 | end) as $final_version | 49 | (if ($repo_status == "success") and ($repo_stars != null) then $repo_stars else $cache_stars end) as $final_stars | 50 | (if ($repo_updated // "") != "" then $repo_updated 51 | elif ($cache_updated // "") != "" then $cache_updated 52 | else "" 53 | end) as $final_updated | 54 | (if ($repo_logo // "") != "" then $repo_logo 55 | elif ($cache_logo // "") != "" then $cache_logo 56 | else "" 57 | end) as $final_logo | 58 | { 59 | key: $plugin.key, 60 | value: 61 | ( 62 | $plugin.value + { 63 | # 保持原有字段 64 | desc: $plugin.value.desc, 65 | author: $plugin.value.author, 66 | repo: $plugin.value.repo, 67 | tags: ($plugin.value.tags // []) 68 | } 69 | + (if $plugin.value.social_link then { social_link: $plugin.value.social_link } else {} end) 70 | + { 71 | stars: ($final_stars // 0), 72 | version: $final_version 73 | } 74 | + (if ($final_updated // "") != "" then { updated_at: $final_updated } else {} end) 75 | + (if ($final_logo // "") != "" then { logo: $final_logo } else {} end) 76 | ) 77 | } 78 | end 79 | ) | from_entries' original_plugins.json > temp_plugin_cache_original.json 80 | 81 | if [ "$cleanup_existing_cache" = "true" ]; then 82 | rm -f "$existing_cache_file" 83 | fi 84 | 85 | # 格式化JSON使其更易读 86 | jq . temp_plugin_cache_original.json > plugin_cache_original.json 87 | 88 | echo "✅ 数据转换完成" 89 | 90 | # 显示转换统计 91 | original_count=$(jq 'keys | length' original_plugins.json) 92 | new_count=$(jq 'keys | length' plugin_cache_original.json) 93 | removed_count=$((original_count - new_count)) 94 | 95 | # 统计不同状态的仓库 96 | success_repos=$(jq '[.[] | select(.status == "success")] | length' repo_info.json) 97 | cached_repos=$(jq '[.[] | select(.status == "cached")] | length' repo_info.json) 98 | redirected_repos=$(jq '[.[] | select(.status == "redirected")] | length' repo_info.json) 99 | deleted_repos=$(jq '[.[] | select(.status == "deleted")] | length' repo_info.json) 100 | failed_repos=$(jq '[.[] | select(.status != "success" and .status != "cached" and .status != "redirected" and .status != "deleted")] | length' repo_info.json) 101 | 102 | echo "" 103 | echo "📊 转换统计:" 104 | echo " 插件数量变化: $original_count -> $new_count" 105 | if [ $removed_count -gt 0 ]; then 106 | echo " 🗑️ 已移除: $removed_count 个失效插件" 107 | fi 108 | echo " ✅ 实时数据: $success_repos 个仓库" 109 | echo " 🔄 缓存数据: $cached_repos 个仓库" 110 | echo " 🔄 重定向: $redirected_repos 个仓库" 111 | echo " 🗑️ 已删除(已移除): $deleted_repos 个仓库" 112 | echo " ❌ 网络错误(已保留): $failed_repos 个仓库" 113 | 114 | # 列出被移除的仓库 115 | if [ $removed_count -gt 0 ]; then 116 | echo "" 117 | echo "🗑️ 以下仓库已从缓存中移除:" 118 | jq -r 'to_entries[] | select(.value.status == "deleted") | " - " + .key + " (404 Not Found)"' repo_info.json 119 | fi 120 | 121 | # 列出网络错误的仓库（保留但使用缓存数据） 122 | if [ "$failed_repos" -gt 0 ]; then 123 | echo "" 124 | echo "❌ 网络错误的仓库（已保留，使用缓存数据）:" 125 | jq -r 'to_entries[] | select(.value.status != "success" and .value.status != "cached" and .value.status != "redirected" and .value.status != "deleted") | " - " + .key + " (" + .value.status + ")"' repo_info.json 126 | fi 127 | 128 | # 列出重定向的仓库（保留但标记） 129 | if [ "$redirected_repos" -gt 0 ]; then 130 | echo "" 131 | echo "🔄 发生重定向的仓库列表（已保留）:" 132 | jq -r 'to_entries[] | select(.value.status == "redirected") | " - " + .key' repo_info.json 133 | fi 134 | 135 | 136 | -------------------------------------------------------------------------------- /scripts/transform_plugin_data/get_github_api_info_for_repositories/run.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | echo "开始获取仓库信息..." 4 | 5 | # 创建一个临时文件存储仓库信息 6 | echo "{}" > repo_info.json 7 | 8 | # 初始化统计计数器 9 | total_repos=0 10 | success_count=0 11 | failed_count=0 12 | deleted_count=0 13 | network_error_count=0 14 | redirect_count=0 15 | 16 | # 重试配置 17 | MAX_RETRIES=5 18 | BASE_DELAY=2 19 | MAX_DELAY=30 20 | 21 | # 重试函数 22 | retry_api_call() { 23 | local owner="$1" 24 | local repo="$2" 25 | local attempt="$3" 26 | 27 | # 计算退避延迟 (指数退避 + 随机抖动) 28 | local delay=$((BASE_DELAY * (2 ** (attempt - 1)))) 29 | if [ $delay -gt $MAX_DELAY ]; then 30 | delay=$MAX_DELAY 31 | fi 32 | # 添加随机抖动 (0-50% 的延迟时间) 33 | local jitter=$((RANDOM % (delay / 2 + 1))) 34 | delay=$((delay + jitter)) 35 | 36 | echo " 第 $attempt 次尝试 (延迟 ${delay}s)..." 37 | sleep $delay 38 | 39 | # 使用临时文件捕获响应头 40 | local temp_headers="temp_api_headers_${total_repos}_${attempt}.txt" 41 | 42 | # 执行API调用，增强网络配置 43 | local response=$(curl -L -s \ 44 | --max-time 20 \ 45 | --connect-timeout 10 \ 46 | --retry 0 \ 47 | --max-redirs 5 \ 48 | --keepalive-time 60 \ 49 | --tcp-nodelay \ 50 | -H "Authorization: token $PAT_TOKEN" \ 51 | -H "Accept: application/vnd.github.v3+json" \ 52 | -H "User-Agent: GitHub-Action-Plugin-Transformer" \ 53 | -H "Connection: keep-alive" \ 54 | -D "$temp_headers" \ 55 | -w "HTTPSTATUS:%{http_code}:CURL_EXIT:%{exitcode}" \ 56 | "https://api.github.com/repos/$owner/$repo" 2>/dev/null || echo "CURL_ERROR:-1") 57 | 58 | # 解析响应 59 | if [[ "$response" == "CURL_ERROR"* ]]; then 60 | rm -f "$temp_headers" 61 | return 1 62 | fi 63 | 64 | # 提取状态码和curl退出码 65 | local http_code=$(echo "$response" | grep -o "HTTPSTATUS:[0-9]*" | cut -d: -f2) 66 | local curl_exit=$(echo "$response" | grep -o "CURL_EXIT:[0-9]*" | cut -d: -f2) 67 | local body=$(echo "$response" | sed 's/HTTPSTATUS:[0-9]*:CURL_EXIT:[0-9]*$//') 68 | 69 | # 检查curl退出码 70 | if [ "$curl_exit" != "0" ]; then 71 | echo " CURL错误码: $curl_exit" 72 | rm -f "$temp_headers" 73 | return 1 74 | fi 75 | 76 | # 检查HTTP状态码是否需要重试 77 | case "$http_code" in 78 | 200) 79 | # 验证响应是否为有效JSON 80 | if echo "$body" | jq -e '.stargazers_count' > /dev/null 2>&1; then 81 | echo "$body" 82 | rm -f "$temp_headers" 83 | return 0 84 | else 85 | echo " 响应不是有效JSON" 86 | rm -f "$temp_headers" 87 | return 1 88 | fi 89 | ;; 90 | 429|502|503|504) 91 | # 这些状态码应该重试 92 | echo " 临时错误 HTTP $http_code，将重试" 93 | rm -f "$temp_headers" 94 | return 1 95 | ;; 96 | 301|302|404|403) 97 | # 这些状态码不应该重试，直接返回 98 | echo "$body:HTTP:$http_code" 99 | rm -f "$temp_headers" 100 | return 0 101 | ;; 102 | *) 103 | echo " 未知HTTP状态码: $http_code" 104 | rm -f "$temp_headers" 105 | return 1 106 | ;; 107 | esac 108 | } 109 | 110 | # 从原始数据中提取所有仓库URL 111 | jq -r 'to_entries[] | .value.repo // empty' original_plugins.json | while read -r repo_url; do 112 | # 提取GitHub用户名和仓库名 113 | if [[ "$repo_url" =~ https://github\.com/([^/]+)/([^/]+) ]]; then 114 | owner="${BASH_REMATCH[1]}" 115 | repo="${BASH_REMATCH[2]}" 116 | total_repos=$((total_repos + 1)) 117 | 118 | echo "[$total_repos] 获取仓库信息: $owner/$repo" 119 | 120 | # 执行重试逻辑 121 | api_response="" 122 | success=false 123 | 124 | for attempt in $(seq 1 $MAX_RETRIES); do 125 | if [ $attempt -eq 1 ]; then 126 | echo " 初次尝试..." 127 | # 第一次尝试，无延迟 128 | temp_headers="temp_api_headers_${total_repos}_1.txt" 129 | api_response=$(curl -L -s \ 130 | --max-time 15 \ 131 | --connect-timeout 8 \ 132 | --retry 0 \ 133 | --max-redirs 5 \ 134 | -H "Authorization: token $PAT_TOKEN" \ 135 | -H "Accept: application/vnd.github.v3+json" \ 136 | -H "User-Agent: GitHub-Action-Plugin-Transformer" \ 137 | -D "$temp_headers" \ 138 | -w "HTTPSTATUS:%{http_code}" \ 139 | "https://api.github.com/repos/$owner/$repo" 2>/dev/null || echo "CURL_ERROR") 140 | 141 | if [[ "$api_response" != "CURL_ERROR" ]]; then 142 | http_code=$(echo "$api_response" | grep -o "HTTPSTATUS:[0-9]*" | cut -d: -f2) 143 | api_response=$(echo "$api_response" | sed 's/HTTPSTATUS:[0-9]*$//') 144 | 145 | # 检查是否成功或不需要重试的错误 146 | case "$http_code" in 147 | 200) 148 | if echo "$api_response" | jq -e '.stargazers_count' > /dev/null 2>&1; then 149 | success=true 150 | break 151 | fi 152 | ;; 153 | 301|302|404|403) 154 | # 不需要重试的状态码 155 | success=true 156 | break 157 | ;; 158 | 429|502|503|504) 159 | # 需要重试的状态码 160 | echo " 临时错误 HTTP $http_code，准备重试" 161 | ;; 162 | esac 163 | fi 164 | rm -f "$temp_headers" 165 | else 166 | # 重试调用 167 | retry_response=$(retry_api_call "$owner" "$repo" "$attempt") 168 | if [ $? -eq 0 ]; then 169 | api_response="$retry_response" 170 | success=true 171 | break 172 | fi 173 | fi 174 | 175 | # 如果不是最后一次尝试，显示重试信息 176 | if [ $attempt -lt $MAX_RETRIES ]; then 177 | echo " 尝试 $attempt/$MAX_RETRIES 失败，准备重试..." 178 | fi 179 | done 180 | 181 | # 处理最终结果 182 | stars=0 183 | updated_at="" 184 | version="" 185 | logo="" 186 | status="unknown" 187 | 188 | if [ "$success" = true ]; then 189 | # 检查是否包含HTTP状态码信息 190 | if [[ "$api_response" == *":HTTP:"* ]]; then 191 | http_code=$(echo "$api_response" | grep -o ":HTTP:[0-9]*" | cut -d: -f3) 192 | api_response=$(echo "$api_response" | sed 's/:HTTP:[0-9]*$//') 193 | fi 194 | 195 | case "$http_code" in 196 | 200) 197 | if echo "$api_response" | jq -e '.stargazers_count' > /dev/null 2>&1; then 198 | stars=$(echo "$api_response" | jq -r '.stargazers_count // 0') 199 | updated_at=$(echo "$api_response" | jq -r '.updated_at // ""') 200 | success_count=$((success_count + 1)) 201 | status="success" 202 | 203 | echo " ✅ 成功 - Stars: $stars, 更新时间: $updated_at" 204 | 205 | # 获取metadata版本 206 | for metadata_file in "metadata.yml" "metadata.yaml"; do 207 | metadata_response=$(curl -L -s --max-time 10 --max-redirs 3 \ 208 | -H "Authorization: token $PAT_TOKEN" \ 209 | -H "Accept: application/vnd.github.v3.raw" \ 210 | -H "User-Agent: GitHub-Action-Plugin-Transformer" \ 211 | "https://api.github.com/repos/$owner/$repo/contents/$metadata_file" 2>/dev/null || echo "{}") 212 | 213 | if [[ ! "$metadata_response" =~ "Not Found" ]] && [[ ! "$metadata_response" =~ "Bad Gateway" ]]; then 214 | # 检查是否是base64编码的内容 215 | if echo "$metadata_response" | jq -e '.content' > /dev/null 2>&1; then 216 | metadata_content=$(echo "$metadata_response" | jq -r '.content' | base64 -d 2>/dev/null || echo "") 217 | else 218 | metadata_content="$metadata_response" 219 | fi 220 | 221 | # 尝试解析YAML并提取版本 222 | if [ ! -z "$metadata_content" ]; then 223 | parsed_version=$(echo "$metadata_content" | grep -E "^version:\s*['\"]?([^'\"]+)['\"]?" | sed -E "s/version:\s*['\"]?([^'\"]+)['\"]?/\1/" || echo "") 224 | # 去除注释和多余的空白字符 225 | cleaned_version=$(echo "$parsed_version" | sed -E 's/[#].*$//' | sed -E 's/\r$//' | xargs) 226 | if [ ! -z "$cleaned_version" ]; then 227 | version="$cleaned_version" 228 | break 229 | fi 230 | fi 231 | fi 232 | done 233 | 234 | # 检查logo.png是否存在 235 | logo_response=$(curl -L -s --max-time 10 --max-redirs 3 \ 236 | -H "Authorization: token $PAT_TOKEN" \ 237 | -H "Accept: application/vnd.github.v3+json" \ 238 | -H "User-Agent: GitHub-Action-Plugin-Transformer" \ 239 | "https://api.github.com/repos/$owner/$repo/contents/logo.png" 2>/dev/null || echo "{}") 240 | 241 | # 检查logo.png是否存在（验证响应包含name字段且不是错误消息） 242 | # 使用单个jq调用进行验证以提高性能 243 | logo_valid=$(echo "$logo_response" | jq -r 'if .name and (.message | not) then "true" else "false" end' 2>/dev/null || echo "false") 244 | if [ "$logo_valid" = "true" ]; then 245 | # 获取默认分支 246 | default_branch=$(echo "$api_response" | jq -r '.default_branch // "main"') 247 | logo="https://raw.githubusercontent.com/$owner/$repo/$default_branch/logo.png" 248 | echo " 🖼️ 找到logo: $logo" 249 | fi 250 | fi 251 | ;; 252 | 301|302) 253 | echo " 🔄 仓库重定向 ($http_code)" 254 | redirect_count=$((redirect_count + 1)) 255 | status="redirected" 256 | ;; 257 | 404) 258 | echo " 🗑️ 仓库已删除或不可访问 (404)" 259 | deleted_count=$((deleted_count + 1)) 260 | status="deleted" 261 | ;; 262 | 403) 263 | echo " ⚠️ API限制或访问被拒绝 (403)" 264 | failed_count=$((failed_count + 1)) 265 | status="api_limit" 266 | ;; 267 | esac 268 | else 269 | echo " ❌ 所有重试均失败" 270 | network_error_count=$((network_error_count + 1)) 271 | status="network_error" 272 | fi 273 | 274 | # 如果失败，尝试使用缓存数据 275 | if [ "$status" != "success" ] && [ "$HAS_EXISTING_CACHE" = "true" ]; then 276 | cached_data=$(jq -r --arg url "$repo_url" '.data // {} | to_entries[] | select(.value.repo == $url) | .value | {stars: .stars, updated_at: .updated_at, version: .version, logo: .logo}' existing_cache.json 2>/dev/null || echo "{}") 277 | 278 | if [ "$cached_data" != "{}" ] && [ "$cached_data" != "" ]; then 279 | cached_stars=$(echo "$cached_data" | jq -r '.stars // 0') 280 | cached_updated=$(echo "$cached_data" | jq -r '.updated_at // ""') 281 | cached_version=$(echo "$cached_data" | jq -r '.version // ""') 282 | cached_logo=$(echo "$cached_data" | jq -r '.logo // ""') 283 | 284 | if [ "$cached_stars" != "0" ] || [ "$cached_updated" != "" ]; then 285 | echo " 🔄 使用缓存数据: Stars: $cached_stars" 286 | stars="$cached_stars" 287 | updated_at="$cached_updated" 288 | version="$cached_version" 289 | logo="$cached_logo" 290 | status="cached" 291 | fi 292 | fi 293 | fi 294 | 295 | # 将信息添加到repo_info.json 296 | jq --arg url "$repo_url" \ 297 | --arg stars "$stars" \ 298 | --arg updated "$updated_at" \ 299 | --arg version "$version" \ 300 | --arg logo "$logo" \ 301 | --arg status "$status" \ 302 | '. + {($url): {stars: ($stars | tonumber), updated_at: $updated, version: $version, logo: $logo, status: $status}}' \ 303 | repo_info.json > temp_repo_info.json && mv temp_repo_info.json repo_info.json 304 | 305 | # 添加基础延迟避免API限制 306 | sleep 0.5 307 | fi 308 | done 309 | 310 | # 成功率检查 311 | if [ $total_repos -gt 0 ]; then 312 | success_rate=$((success_count * 100 / total_repos)) 313 | echo "📈 成功率: $success_rate%" 314 | 315 | if [ $success_rate -lt 50 ]; then 316 | echo "⚠️ 警告: 成功率过低，可能存在网络问题或GitHub服务异常" 317 | if [ "$HAS_EXISTING_CACHE" = "true" ]; then 318 | echo "已启用缓存回退机制" 319 | fi 320 | fi 321 | fi 322 | 323 | echo "✅ 仓库信息获取完成" 324 | 325 | 326 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------