@lf_maple/koishi-plugin-phi-plugin-full 0.1.80

package/core/model/user/apiPermission.js

@@ -0,0 +1,62 @@
+import autoSeekApi from '../api/autoSeekApi.js'
+import getNotes from './getNotes.js'
+import Config from '../../components/Config.js'
+
+/** @typedef {'customTheme' | 'scoreStatistics' | 'onlineScore'} ApiCapability */
+
+const capabilityConfigKeys = {
+    customTheme: 'enableCustomThemeApi',
+    scoreStatistics: 'enableScoreStatisticsApi',
+    onlineScore: 'enableOnlineScoreApi',
+}
+
+/** @param {ApiCapability} capability */
+export function isApiCapabilityConfigured(capability) {
+    return Boolean(
+        Config.getUserCfg('config', 'openPhiPluginApi')
+        && Config.getUserCfg('config', /** @type {configName} */ (capabilityConfigKeys[capability])) !== false
+    )
+}
+
+/** @param {ApiCapability} capability */
+export function isApiCapabilityEnabled(capability) {
+    return autoSeekApi.openPhiPluginApi && isApiCapabilityConfigured(capability)
+}
+
+/**
+ * @param {string | number | undefined} userId
+ * @returns {Promise<boolean>}
+ */
+export async function isUserApiEnabled(userId) {
+    if (!userId) return true
+    const uid = String(userId)
+    const pluginData = await getNotes.getNotesData(uid)
+    if (typeof pluginData.allowApiUsage !== 'boolean') {
+        pluginData.allowApiUsage = true
+        getNotes.putNotesData(uid, pluginData)
+    }
+    return pluginData.allowApiUsage !== false
+}
+
+/**
+ * @param {import('../../components/baseClass.js').botEvent} e
+ */
+export async function getApiAccessState(e, capability = /** @type {ApiCapability} */ ('onlineScore')) {
+    const globalEnabled = !!autoSeekApi.openPhiPluginApi;
+    const capabilityEnabled = Config.getUserCfg('config', /** @type {configName} */ (capabilityConfigKeys[capability])) !== false
+    const userEnabled = capability === 'onlineScore' ? await isUserApiEnabled(e?.user_id) : true
+    return {
+        globalEnabled,
+        capability,
+        capabilityEnabled,
+        userEnabled,
+        enabled: globalEnabled && capabilityEnabled && userEnabled
+    }
+}
+
+/**
+ * @param {import('../../components/baseClass.js').botEvent} e
+ */
+export async function canUseApi(e, capability = /** @type {ApiCapability} */ ('onlineScore')) {
+    return (await getApiAccessState(e, capability)).enabled
+}

package/core/model/user/getBanGroup.js

@@ -0,0 +1,120 @@
+import Config from "../../components/Config.js";
+import logger from "../../components/Logger.js";
+import { redisPath } from "../game/constNum.js"
+import { UserCredentials } from './userCredentials.js';
+import userCredentialStore from './userCredentialStore.js';
+import send from "../render/send.js";
+import { canUseApi } from './apiPermission.js';
+import { redis } from "../../components/platform/index.js";
+
+/**@import {botEvent} from "../../components/baseClass.js" */
+
+export default class getBanGroup {
+
+    /**
+     * @param {string} group 
+     * @param {string} fnc 
+     * @returns 
+     */
+    static async redis(group, fnc) {
+        // @ts-ignore
+        return await redis.get(`${redisPath}:banGroup:${group}:${fnc}`) ? true : false
+    }
+
+    /**
+     * 
+     * @param {botEvent} e 
+     * @param {allFnc} fnc 
+     * @returns 
+     */
+    static async get(e, fnc) {
+        const { group_id } = e;
+        const credentials = UserCredentials.fromEvent(e)
+        if (await canUseApi(e)) {
+            if (await credentials.getUserAPIBanStatus({ ignoreUnboundError: true })) {
+                send.send_with_At(e, "当前账户被加入黑名单，详情请联系管理员(1)。")
+                return true;
+            }
+        }
+        if (await credentials.getUserLoaclBanStatus()) {
+            send.send_with_At(e, "当前账户被加入黑名单，详情请联系管理员(2)。")
+            return true;
+        }
+        if (!group_id) {
+            return false
+        }
+        switch (fnc) {
+            case 'help':
+            case 'tkhelp':
+                return await this.redis(group_id, 'help')
+            case 'bind':
+            case 'unbind':
+                return await this.redis(group_id, 'bind')
+            case 'b19':
+            case 'p30':
+            case 'lmtAcc':
+            case 'arcgrosB19':
+            case 'update':
+            case 'info':
+            case 'list':
+            case 'singlescore':
+            case 'lvscore':
+            case 'chap':
+            case 'achievement':
+            case 'suggest':
+            case 'analyze2025SaveHistory':
+            case 'hisb30':
+                return await this.redis(group_id, 'b19')
+            case 'bestn':
+            case 'data':
+                return await this.redis(group_id, 'wb19')
+            case 'song':
+            case 'ill':
+            case 'chart':
+            case 'tag':
+            case 'addtag':
+            case 'retag':
+            case 'search':
+            case 'alias':
+            case 'randmic':
+            case 'randClg':
+            case 'table':
+            case 'comment':
+            case 'recallComment':
+            case 'myComment':
+                return await this.redis(group_id, 'song')
+            case 'rankList':
+            case 'godList':
+                return await this.redis(group_id, 'ranklist')
+            case 'comrks':
+            case 'tips':
+            case 'newSong':
+                return await this.redis(group_id, 'fnc')
+            case 'tipgame':
+                return await this.redis(group_id, 'tipgame')
+            case 'guessgame':
+                return await this.redis(group_id, 'guessgame')
+            case 'ltrgame':
+                return await this.redis(group_id, 'ltrgame')
+            case 'sign':
+            case 'send':
+            case 'tasks':
+            case 'retask':
+            case 'jrrp':
+                return await this.redis(group_id, 'sign')
+            case 'theme':
+                return await this.redis(group_id, 'setting')
+            case 'dan':
+            case 'danupdate':
+                return await this.redis(group_id, 'dan')
+            case 'auth':
+            case 'clearApiData':
+            case 'updateHistory':
+            case 'setApiToken':
+            case 'tokenList':
+                return await this.redis(group_id, 'apiSetting')
+            default:
+                return false;
+        }
+    }
+}

package/core/model/user/getNotes.js

@@ -0,0 +1,48 @@
+import readFile from '../filesystem/getFile.js'
+import path from 'path'
+import { pluginDataPath } from '../filesystem/path.js'
+import fs from 'fs'
+import PluginData from './pluginData.js'
+
+export default class getNotes {
+
+    /**
+     * 获取并初始化用户数据
+     * @param {string} user_id 
+     * @returns {Promise<PluginData>} 娱乐数据
+     */
+    static async getNotesData(user_id) {
+        let data = await readFile.FileReader(path.join(pluginDataPath, `${user_id}_.json`))
+        if (!data) {
+            data = {
+                money: 0,
+                sign_in: "Wed Apr 03 2024 23:03:52 GMT+0800 (中国标准时间)",
+                task_time: "Wed Apr 03 2024 23:03:52 GMT+0800 (中国标准时间)",
+                task: [],
+                theme: "common"
+            }
+        }
+        if (data.plugin_data) {
+            data = data.plugin_data;
+        }
+        return new PluginData(data);
+    }
+
+    /**
+     * 获取并初始化用户数据
+     * @param {string} user_id 
+     * @param {PluginData} data 
+     */
+    static putNotesData(user_id, data) {
+        return readFile.SetFile(path.join(pluginDataPath, `${user_id}_.json`), data)
+    }
+
+    /**
+     * 删除用户数据
+     * @param {string} user_id 
+     */
+    static delNotesData(user_id) {
+        return fs.rmSync(path.join(pluginDataPath, `${user_id}_.json`), { recursive: true, force: true });
+    }
+
+}

package/core/model/user/pluginData.js

@@ -0,0 +1,101 @@
+
+/**
+ * @typedef {object} taskObj 任务对象
+ * @property {idString} song 歌曲ID
+ * @property {number} reward 奖励 notes 数量
+ * @property {boolean} finished 任务是否完成
+ * @property {object} request 任务要求
+ * @property {string} request.type 任务类型 acc / score
+ * @property {levelKind} request.rank 难度
+ * @property {number} request.value 任务要求数值
+ */
+
+import themeManager from '../theme/manager.js'
+
+/**
+ * 内置主题列表（兼容旧版 /theme；新代码请使用 themeManager.getThemeList()）
+ * @type {{id: string, src: string}[]}
+ */
+export const themeList = [{ id: "default", src: "默认" }, { id: "snow", src: "寒冬" }, { id: "star", src: "使一颗心免于哀伤" }, { id: "dss2", src: "大师赛2" }]
+
+const BUILTIN_THEME_IDS = new Set(themeList.map(theme => theme.id))
+const THEME_ID_RE = /^[a-zA-Z0-9_-]{1,120}$/
+
+/** @param {unknown} themeId */
+function normalizeThemePreference(themeId) {
+  if (themeId === 'common') return 'default'
+  return typeof themeId === 'string' && THEME_ID_RE.test(themeId) ? themeId : 'default'
+}
+
+export default class PluginData {
+  /**
+   * @param {any} data 初始化数据
+   */
+  constructor(data) {
+    this.money = isNaN(data?.money) ? 0 : data.money
+    this.sign_in = data?.sign_in || "Wed Apr 03 2024 23:03:52 GMT+0800 (中国标准时间)"
+    /**
+     * 签到记录（YYYY-MM-DD），用于渲染签到日历与累计签到天数
+     * @type {string[]}
+     */
+    this.sign_history = Array.isArray(data?.sign_history) ? data.sign_history : []
+    this.task_time = data?.task_time || "Wed Apr 03 2024 23:03:52 GMT+0800 (中国标准时间)"
+    /**@type {taskObj[]} */
+    this.task = Array.isArray(data?.task) ? data.task : []
+
+    /**@type {number} */
+    this.noticeCode = isNaN(data?.noticeCode) ? 0 : data.noticeCode
+
+    /** @type {string} 持久化的用户主题偏好；策略临时禁用或主题暂时缺失时仍保留。 */
+    this.themePreference = 'default'
+    /** @type {string} 本次运行实际可用于渲染的主题标识。 */
+    this.theme = 'default'
+    this.setThemePreference(data?.theme)
+
+    /**@type {"all" | "b30" | "top"} */
+    this.b30AvgKind = "all"
+    switch (data?.b30AvgKind) {
+      case "all":
+      case "b30":
+      case "top":
+      case "none":
+        this.b30AvgKind = data.b30AvgKind
+    }
+
+    /**@type {"red" | "gold" | "blue" | "green"} avg条的主题色*/
+    this.b30AvgColor = "blue"
+    switch (data?.b30AvgColor) {
+      case "red":
+      case "gold":
+      case "blue":
+      case "green":
+        this.b30AvgColor = data.b30AvgColor
+    }
+
+    /**@type {boolean} 是否允许使用在线API功能 */
+    this.allowApiUsage = data?.allowApiUsage !== false
+
+    /**@type {boolean} 是否展示 B30 统计分析 */
+    this.showB30Analysis = data?.showB30Analysis !== false
+  }
+
+  /**
+   * 更新用户偏好，并根据当前本地注册表与 Bot 策略计算实际渲染主题。
+   * @param {unknown} themeId
+   */
+  setThemePreference(themeId) {
+    const requested = normalizeThemePreference(themeId)
+    this.themePreference = requested
+    this.theme = BUILTIN_THEME_IDS.has(requested)
+      || (themeManager.isCustomTheme(requested) && themeManager.isThemeAvailable(requested))
+      ? requested
+      : 'default'
+    return this.theme
+  }
+
+  /** 保持旧版存储结构：偏好继续写入 theme，不额外落盘运行时字段。 */
+  toJSON() {
+    const { themePreference, ...data } = this
+    return { ...data, theme: themePreference }
+  }
+}

package/core/model/user/userCredentialStore.js

@@ -0,0 +1,154 @@
+import { redis } from '../../components/platform/index.js'
+import { redisPath } from '../game/constNum.js'
+
+/**
+ * 生成用户凭证类 Redis 键。
+ * @param {string} kind 凭证类型
+ * @param {string | number} value 用户 ID或凭证值
+ * @returns {string} 带插件命名空间的 Redis 键
+ */
+function credentialKey(kind, value) {
+    return `${redisPath}:${kind}:${String(value)}`
+}
+
+class UserCredentialStore {
+    /**
+     * 按用户 ID读取本地 sessionToken。
+     * @param {string | number} userId 平台用户 ID
+     * @returns {Promise<phigrosToken>} 已保存的 sessionToken
+     */
+    async getSessionToken(userId) {
+        return /** @type {any} */ (redis.get(credentialKey('userToken', userId)))
+    }
+
+    /**
+     * 按用户 ID保存本地 sessionToken。
+     * @param {string | number} userId 平台用户 ID
+     * @param {phigrosToken} sessionToken Phigros sessionToken
+     */
+    async setSessionToken(userId, sessionToken) {
+        return redis.set(credentialKey('userToken', userId), sessionToken)
+    }
+
+    /**
+     * 删除指定用户的 sessionToken。
+     * @param {string | number} userId 平台用户 ID
+     */
+    async deleteSessionToken(userId) {
+        return redis.del(credentialKey('userToken', userId))
+    }
+
+    /**
+     * 按用户 ID读取本地 API ID。
+     * @param {string | number} userId 平台用户 ID
+     * @returns {Promise<apiUserId>} 已保存的 API ID
+     */
+    async getApiId(userId) {
+        return /** @type {any} */ (redis.get(credentialKey('userApiId', userId)))
+    }
+
+    /**
+     * 按用户 ID保存本地 API ID。
+     * @param {string | number} userId 平台用户 ID
+     * @param {apiUserId} apiId API 用户 ID
+     */
+    async setApiId(userId, apiId) {
+        return redis.set(credentialKey('userApiId', userId), String(apiId))
+    }
+
+    /**
+     * 删除指定用户的本地 API ID。
+     * @param {string | number} userId 平台用户 ID
+     */
+    async deleteApiId(userId) {
+        return redis.del(credentialKey('userApiId', userId))
+    }
+
+    /**
+     * 删除指定用户的 sessionToken和 API ID。
+     * @param {string | number} userId 平台用户 ID
+     */
+    async clearLocalCredentials(userId) {
+        return redis.del(
+            credentialKey('userToken', userId),
+            credentialKey('userApiId', userId),
+        )
+    }
+
+    /**
+     * 使用 Redis SCAN分页列出全部本地用户 sessionToken，供备份和管理员批量任务使用。
+     * @returns {Promise<Map<string, phigrosToken>>} 用户 ID到 sessionToken 的映射
+     */
+    async listSessionCredentials() {
+        /** @type {Map<string, phigrosToken>} */
+        const result = new Map()
+        const prefix = `${redisPath}:userToken:`
+        let cursor = 0
+        do {
+            const info = await redis.scan(cursor, { MATCH: `${prefix}*`, COUNT: 100 })
+            cursor = Number(info.cursor)
+            const values = await Promise.all(info.keys.map(key => redis.get(key)))
+            info.keys.forEach((key, index) => {
+                const value = values[index]
+                if (value) result.set(key.slice(prefix.length), /** @type {phigrosToken} */(value))
+            })
+        } while (cursor !== 0)
+        return result
+    }
+
+    /**
+     * 分页删除旧版派生凭据和别名通知元数据缓存。
+     * @returns {Promise<number>} 实际删除的旧缓存键数量
+     */
+    async deleteLegacyCredentialCaches() {
+        const patterns = [`${redisPath}:apiBotBinding:*`, `${redisPath}:aliasBinding:*`]
+        let deleted = 0
+        for (const pattern of patterns) {
+            let cursor = 0
+            do {
+                const info = await redis.scan(cursor, { MATCH: pattern, COUNT: 100 })
+                cursor = Number(info.cursor)
+                if (info.keys.length) deleted += Number(await redis.del(...info.keys))
+            } while (cursor !== 0)
+        }
+        return deleted
+    }
+
+    /**
+     * 将 sessionToken 加入本地禁用列表。
+     * @param {phigrosToken} sessionToken 待禁用的 sessionToken
+     */
+    async banSessionToken(sessionToken) {
+        return redis.set(credentialKey('banSessionToken', sessionToken), 1)
+    }
+
+    /**
+     * 从本地禁用列表移除 sessionToken。
+     * @param {phigrosToken} sessionToken 待恢复的 sessionToken
+     */
+    async allowSessionToken(sessionToken) {
+        return redis.del(credentialKey('banSessionToken', sessionToken))
+    }
+
+    /**
+     * 检查 sessionToken 是否已被禁用；空值直接视为未禁用。
+     * @param {phigrosToken | null | undefined} sessionToken 待检查的 sessionToken
+     * @returns {Promise<boolean>} Redis 标记；未禁用时为假值
+     */
+    async isSessionTokenBanned(sessionToken) {
+        if (!sessionToken) return false
+        return Boolean(await redis.get(credentialKey('banSessionToken', sessionToken)))
+    }
+
+    /**
+     * 列出全部禁用 sessionToken 的 Redis 键，仅供管理员维护功能使用。
+     * @returns {Promise<string[]>} 禁用记录键列表
+     */
+    async listBannedSessionTokenKeys() {
+        return redis.keys(`${redisPath}:banSessionToken:*`)
+    }
+
+}
+
+export const userCredentialStore = new UserCredentialStore()
+export default userCredentialStore