koishi-plugin-wordpress-notifier 1.0.0

package/README.md

@@ -0,0 +1,101 @@
+# WordPress 文章自动推送插件
+
+自动从 WordPress 网站获取最新文章并推送到指定 QQ 群或私聊。
+
+## 功能特性
+
+- 自动从 WordPress REST API 获取最新文章
+- 定时推送新文章到指定 QQ 群或私聊
+- 支持手动查询最新文章和文章列表
+- 支持 @全体成员
+- 完善的去重机制，避免重复推送
+- 采用服务模式架构，便于扩展和维护
+- 支持自动推送开关
+
+## 安装
+
+插件已集成到项目中，无需额外安装。
+
+## 配置
+
+在 `koishi.yml` 中配置插件：
+
+```yaml
+wordpress-notifier:
+  wordpressUrl: 'https://your-wordpress-site.com'  # WordPress 网站地址
+  interval: 3600000  # 检查间隔（毫秒，默认 1 小时）
+  targets:
+    - '2801323326'  # 推送目标（群号或 QQ 号）
+  enableAutoPush: true  # 是否启用自动推送
+  mentionAll: false  # 是否 @全体成员
+  maxArticles: 5  # 每次最多推送的文章数量
+```
+
+## 使用命令
+
+### 查看最新文章
+```
+wordpress.latest
+```
+显示最新的 WordPress 文章列表，包含标题、日期和链接。
+
+### 查看文章列表
+```
+wordpress.list
+```
+显示文章 ID 和标题的简洁列表。
+
+### 手动推送最新文章
+```
+wordpress.push
+```
+立即检查并推送最新文章（即使自动推送已关闭）。
+
+### 查看插件状态
+```
+wordpress.status
+```
+显示当前插件配置状态，包括网站地址、检查间隔、推送目标等。
+
+### 切换自动推送开关
+```
+wordpress.toggle
+```
+开启或关闭自动推送功能。
+
+### 切换 @全体成员 开关
+```
+wordpress.mention
+```
+开启或关闭 @全体成员 功能。
+
+## 工作原理
+
+1. 插件启动时会自动创建数据库表 `wordpress_posts` 用于记录已推送的文章
+2. 定时器每隔指定时间（默认 1 小时）检查一次 WordPress 网站的最新文章
+3. 对于每篇新文章，检查是否已推送过
+4. 如果是新文章，则格式化消息并推送到所有配置的目标
+5. 推送成功后，将文章 ID 记录到数据库中
+
+## 注意事项
+
+- WordPress 网站必须启用 REST API（默认启用）
+- 确保机器人有权限向目标群或私聊发送消息
+- @全体成员 功能需要机器人有相应权限
+- 建议设置合理的检查间隔，避免频繁请求 WordPress 网站
+
+## 开发
+
+插件位于 `external/wordpress-notifier/` 目录。
+
+### 编译插件
+```bash
+cd external/wordpress-notifier
+yarn build
+```
+
+### 重新安装依赖
+```bash
+cd external/wordpress-notifier
+yarn install
+```

package/lib/index.d.ts

@@ -0,0 +1,26 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "wordpress-notifier";
+export interface Config {
+    wordpressUrl: string;
+    interval: number;
+    targets: string[];
+    enableAutoPush: boolean;
+    mentionAll: boolean;
+    maxArticles: number;
+}
+export interface WordPressPost {
+    id: number;
+    title: {
+        rendered: string;
+    };
+    link: string;
+    date: string;
+    excerpt: {
+        rendered: string;
+    };
+    author: number;
+    categories: number[];
+    tags: number[];
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = exports.name = void 0;
+exports.apply = apply;
+const koishi_1 = require("koishi");
+exports.name = 'wordpress-notifier';
+exports.Config = koishi_1.Schema.object({
+    wordpressUrl: koishi_1.Schema.string().description('WordPress 网站地址（例如：https://example.com）'),
+    interval: koishi_1.Schema.number().default(3600000).description('检查间隔（毫秒，默认 1 小时）'),
+    targets: koishi_1.Schema.array(koishi_1.Schema.string()).description('推送目标（群号或 QQ 号）'),
+    enableAutoPush: koishi_1.Schema.boolean().default(true).description('是否启用自动推送'),
+    mentionAll: koishi_1.Schema.boolean().default(false).description('是否 @全体成员'),
+    maxArticles: koishi_1.Schema.number().default(5).description('每次最多推送的文章数量')
+});
+function apply(ctx, config) {
+    ctx.logger.info('WordPress 推送插件已加载');
+    const pushedPosts = new Set();
+    async function fetchLatestPosts() {
+        try {
+            const url = `${config.wordpressUrl}/wp-json/wp/v2/posts?per_page=${config.maxArticles}&orderby=date&order=desc`;
+            ctx.logger.info(`正在获取文章: ${url}`);
+            const response = await ctx.http.get(url);
+            ctx.logger.info(`成功获取 ${response.length} 篇文章`);
+            return response;
+        }
+        catch (error) {
+            ctx.logger.error(`获取 WordPress 文章失败: ${error}`);
+            return [];
+        }
+    }
+    function isPostPushed(postId) {
+        return pushedPosts.has(postId);
+    }
+    function markPostAsPushed(postId) {
+        pushedPosts.add(postId);
+    }
+    function formatPostMessage(post, mention = false) {
+        const title = post.title.rendered.replace(/<[^>]*>/g, '');
+        const excerpt = post.excerpt.rendered.replace(/<[^>]*>/g, '').substring(0, 100);
+        const date = new Date(post.date).toLocaleString('zh-CN');
+        let message = '';
+        if (mention && config.mentionAll) {
+            message += '@全体成员\n';
+        }
+        message += `📝 ${title}\n`;
+        message += `📅 ${date}\n`;
+        message += `📄 ${excerpt}...\n`;
+        message += `🔗 ${post.link}`;
+        return message;
+    }
+    async function pushNewPosts() {
+        if (!config.enableAutoPush)
+            return;
+        const posts = await fetchLatestPosts();
+        if (posts.length === 0)
+            return;
+        for (const post of posts) {
+            if (!isPostPushed(post.id)) {
+                const message = formatPostMessage(post, true);
+                for (const target of config.targets) {
+                    try {
+                        await ctx.broadcast([`onebot:${target}`], message);
+                        ctx.logger.info(`已推送文章到 ${target}: ${post.title.rendered}`);
+                    }
+                    catch (error) {
+                        ctx.logger.error(`推送文章到 ${target} 失败: ${error}`);
+                    }
+                }
+                markPostAsPushed(post.id);
+            }
+        }
+    }
+    ctx.command('wordpress.latest', '查看最新文章')
+        .action(async () => {
+        ctx.logger.info('命令 wordpress.latest 被调用');
+        const posts = await fetchLatestPosts();
+        if (posts.length === 0) {
+            ctx.logger.info('没有找到文章');
+            return '暂无文章';
+        }
+        let message = '📰 最新文章：\n\n';
+        for (const post of posts) {
+            const title = post.title.rendered.replace(/<[^>]*>/g, '');
+            const date = new Date(post.date).toLocaleString('zh-CN');
+            message += `${title}\n📅 ${date}\n🔗 ${post.link}\n\n`;
+        }
+        ctx.logger.info(`准备返回消息，长度: ${message.length}`);
+        return message;
+    });
+    ctx.command('wordpress.list', '查看文章列表')
+        .action(async () => {
+        ctx.logger.info('命令 wordpress.list 被调用');
+        const posts = await fetchLatestPosts();
+        if (posts.length === 0) {
+            return '暂无文章';
+        }
+        let message = '📚 文章列表：\n\n';
+        for (const post of posts) {
+            const title = post.title.rendered.replace(/<[^>]*>/g, '');
+            message += `${post.id}. ${title}\n`;
+        }
+        return message;
+    });
+    ctx.command('wordpress.push', '手动推送最新文章')
+        .action(async () => {
+        ctx.logger.info('命令 wordpress.push 被调用');
+        await pushNewPosts();
+        return '已检查并推送最新文章';
+    });
+    ctx.command('wordpress.status', '查看插件状态')
+        .action(() => {
+        ctx.logger.info('命令 wordpress.status 被调用');
+        return `📊 WordPress 推送插件状态：
+🌐 网站地址: ${config.wordpressUrl}
+⏰ 检查间隔: ${config.interval / 1000} 秒
+🎯 推送目标: ${config.targets.join(', ')}
+🔔 自动推送: ${config.enableAutoPush ? '开启' : '关闭'}
+📢 @全体成员: ${config.mentionAll ? '开启' : '关闭'}
+📝 最多推送: ${config.maxArticles} 篇`;
+    });
+    ctx.command('wordpress.toggle', '切换自动推送开关')
+        .action(async () => {
+        ctx.logger.info('命令 wordpress.toggle 被调用');
+        config.enableAutoPush = !config.enableAutoPush;
+        return `自动推送已${config.enableAutoPush ? '开启' : '关闭'}`;
+    });
+    ctx.command('wordpress.mention', '切换 @全体成员 开关')
+        .action(async () => {
+        ctx.logger.info('命令 wordpress.mention 被调用');
+        config.mentionAll = !config.mentionAll;
+        return `@全体成员 已${config.mentionAll ? '开启' : '关闭'}`;
+    });
+    ctx.command('wordpress', 'WordPress 推送插件菜单')
+        .action(() => {
+        ctx.logger.info('命令 wordpress 被调用');
+        return `📚 WordPress 推送插件菜单：
+
+🔹 /wordpress.status - 查看插件状态
+🔹 /wordpress.latest - 查看最新文章
+🔹 /wordpress.list - 查看文章列表
+🔹 /wordpress.push - 手动推送最新文章
+🔹 /wordpress.toggle - 切换自动推送开关
+🔹 /wordpress.mention - 切换 @全体成员 开关
+
+💡 提示：所有命令都需要加 / 前缀`;
+    });
+    ctx.on('ready', async () => {
+        ctx.logger.info('WordPress 推送插件已就绪');
+        await pushNewPosts();
+    });
+    ctx.setInterval(() => {
+        pushNewPosts();
+    }, config.interval);
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "koishi-plugin-wordpress-notifier",
+  "version": "1.0.0",
+  "description": "WordPress 文章自动推送到 QQ",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "data"
+  ],
+  "license": "MIT",
+  "author": "Your Name <your.email@example.com>",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "koishi": "^4.18.10"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "koishi": "^4.18.10"
+  },
+  "keywords": [
+    "koishi",
+    "plugin",
+    "wordpress",
+    "notifier",
+    "qq"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/koishi-plugin-wordpress-notifier.git"
+  },
+  "homepage": "https://github.com/your-username/koishi-plugin-wordpress-notifier#readme",
+  "bugs": {
+    "url": "https://github.com/your-username/koishi-plugin-wordpress-notifier/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}