Merge branch 'pr_15'

This commit is contained in:
Kokomi 2023-04-17 04:35:27 +08:00
commit 9e20c1ccc9
8 changed files with 494 additions and 380 deletions

View File

@ -0,0 +1,2 @@
# 渲染后端, 默认为 puppeteer
name:

View File

@ -58,6 +58,10 @@ class Cfg {
return this.getConfig('redis')
}
get renderer() {
return this.getConfig('renderer');
}
/** 主人qq */
get masterQQ () {
let masterQQ = this.getConfig('other').masterQQ || []

View File

@ -1,392 +1,60 @@
import fs from 'node:fs'
import os from 'node:os'
import lodash from 'lodash'
import template from 'art-template'
import chokidar from 'chokidar'
import path from 'path'
import { fileURLToPath } from 'url'
import cfg from '../config/config.js'
import common from '../common/common.js'
const _path = process.cwd()
const __dirname = path.dirname(fileURLToPath(import.meta.url))
let puppeteer = {}
const rendererDir = path.join(__dirname, "../../renderers/");
// mac地址
let mac = ''
let rendererBackends = {};
class Puppeteer {
constructor () {
this.browser = false
this.lock = false
this.shoting = []
/** 截图数达到时重启浏览器 避免生成速度越来越慢 */
this.restartNum = 100
/** 截图次数 */
this.renderNum = 0
this.config = {
headless: true,
args: [
'--disable-gpu',
'--disable-setuid-sandbox',
'--no-sandbox',
'--no-zygote'
]
const rendererProxyHandler = {
get(target, prop, receiver) {
if (!(prop in receiver)) {
logger.fatal("在类 " + target.constructor.name + " 上访问了未实现的方法或属性 " + prop + ", 请报告错误!");
return undefined;
}
return Reflect.get(...arguments);
},
}
if (cfg.bot?.chromium_path) {
/** chromium其他路径 */
this.config.executablePath = cfg.bot.chromium_path
}
this.html = {}
this.watcher = {}
this.createDir('./temp/html')
}
async initPupp () {
if (!lodash.isEmpty(puppeteer)) return puppeteer
puppeteer = (await import('puppeteer')).default
return puppeteer
}
createDir (dir) {
if (!fs.existsSync(dir)) {
let dirs = dir.split('/')
for (let idx = 1; idx <= dirs.length; idx++) {
let temp = dirs.slice(0, idx).join('/')
if (!fs.existsSync(temp)) {
fs.mkdirSync(temp)
}
}
}
}
/**
* 初始化chromium
*/
async browserInit () {
await this.initPupp()
if (this.browser) return this.browser
if (this.lock) return false
this.lock = true
logger.mark('puppeteer Chromium 启动中...')
let connectFlag = false
try {
// 如果是pm2启动尝试连接已有实例
if (process.env.pm_id) {
// 获取Mac地址
if (!mac) {
mac = await this.getMac()
this.browserMacKey = `Yz:chromium:browserWSEndpoint:${mac}`
}
// 是否有browser实例
const browserUrl = await redis.get(this.browserMacKey)
if (browserUrl) {
const browserWSEndpoint = await puppeteer.connect({ browserWSEndpoint: browserUrl }).catch((err) => {
logger.error('puppeteer Chromium 缓存的实例已关闭')
redis.del(this.browserMacKey)
})
// 如果有实例,直接使用
if (browserWSEndpoint) {
this.browser = browserWSEndpoint
if (this.browser) {
connectFlag = true
}
}
}
}
} catch (e) {
logger.error('puppeteer Chromium 尝试连接已有实例失败')
}
if (!this.browser || !connectFlag) {
// 如果没有实例初始化puppeteer
this.browser = await puppeteer.launch(this.config).catch((err, trace) => {
let errMsg = err.toString() + (trace ? trace.toString() : '')
if (typeof err == 'object') {
logger.error(JSON.stringify(err))
} else {
logger.error(err.toString())
if (errMsg.includes('Could not find Chromium')) {
logger.error('没有正确安装Chromium可以尝试执行安装命令node ./node_modules/puppeteer/install.js')
} else if (errMsg.includes('libatk-bridge')) {
logger.error('没有正确安装Chromium可尝试执行 sudo yum install -y chromium')
}
}
console.log(err, trace)
})
}
this.lock = false
if (!this.browser) {
logger.error('puppeteer Chromium 启动失败')
return false
}
if (connectFlag) {
logger.mark('puppeteer Chromium 已连接启动的实例')
} else {
console.log('chromium', this.browser.wsEndpoint())
if (process.env.pm_id && this.browserMacKey) {
//缓存一下实例30天
const expireTime = 60 * 60 * 24 * 30
await redis.set(this.browserMacKey, this.browser.wsEndpoint(), { EX: expireTime })
}
logger.mark('puppeteer Chromium 启动成功')
}
/** 监听Chromium实例是否断开 */
this.browser.on('disconnected', (e) => {
logger.error('Chromium实例关闭或崩溃')
this.browser = false
})
return this.browser
}
// 获取Mac地址
async getMac () {
// 获取Mac地址
let mac = '00:00:00:00:00:00'
try {
const network = os.networkInterfaces()
let osMac
// 判断系统
if (os.platform() === 'win32') {
// windows下获取mac地址
let osMacList = Object.keys(network).map(key => network[key]).flat()
osMacList = osMacList.filter(item => item.family === 'IPv4' && item.mac !== mac)
osMac = osMacList[0].mac
} else if (os.platform() === 'linux') {
// linux下获取mac地址
osMac = network.eth0.filter(item => item.family === 'IPv4' && item.mac !== mac)[0].mac
}
if (osMac) {
mac = String(osMac)
}
} catch (e) {
console.log('获取Mac地址失败', e.toString())
}
mac = mac.replace(/:/g, '')
return mac
}
/**
* `chromium` 截图
* @param data 模板参数
* @param data.tplFile 模板路径必传
* @param data.saveId 生成html名称为空name代替
* @param data.imgType screenshot参数生成图片类型jpegpng
* @param data.quality screenshot参数图片质量 0-100jpeg是可传默认90
* @param data.omitBackground screenshot参数隐藏默认的白色背景背景透明默认不透明
* @param data.path screenshot参数截图保存路径截图图片类型将从文件扩展名推断出来如果是相对路径则从当前路径解析如果没有指定路径图片将不会保存到硬盘
* @return icqq img
*/
async screenshot (name, data = {}) {
if (!await this.browserInit()) {
return false
}
let savePath = this.dealTpl(name, data)
if (!savePath) return false
let buff = ''
let start = Date.now()
this.shoting.push(name)
try {
const page = await this.browser.newPage()
await page.goto(`file://${_path}${lodash.trim(savePath, '.')}`, data.pageGotoParams || {})
let body = await page.$('#container') || await page.$('body')
let randData = {
// encoding: 'base64',
type: data.imgType || 'jpeg',
omitBackground: data.omitBackground || false,
quality: data.quality || 90,
path: data.path || ''
}
if (data.imgType === 'png') delete randData.quality
buff = await body.screenshot(randData)
page.close().catch((err) => logger.error(err))
} catch (error) {
logger.error(`图片生成失败:${name}:${error}`)
/** 关闭浏览器 */
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
buff = ''
return false
}
this.shoting.pop()
if (!buff) {
logger.error(`图片生成为空:${name}`)
return false
}
this.renderNum++
/** 计算图片大小 */
let kb = (buff.length / 1024).toFixed(2) + 'kb'
logger.mark(`[图片生成][${name}][${this.renderNum}次] ${kb} ${logger.green(`${Date.now() - start}ms`)}`)
this.restart()
return segment.image(buff)
}
/**
* `chromium` 分片截图
*/
async screenshots (name, data = {}) {
// FIXME: pageHeight 作为参数?
const pageHeight = 7000
await this.browserInit()
if (!this.browser) return false
const savePath = this.dealTpl(name, data)
if (!savePath) return false
const page = await this.browser.newPage()
try {
await page.goto(`file://${_path}${lodash.trim(savePath, '.')}`, { timeout: 120000 })
const body = await page.$('#container') || await page.$('body')
const boundingBox = await body.boundingBox()
const num = Math.round(boundingBox.height / pageHeight) || 1
if (num > 1) {
await page.setViewport({
width: boundingBox.width,
height: pageHeight + 100
})
}
const img = []
for (let i = 1; i <= num; i++) {
const randData = {
type: 'jpeg',
quality: 90
}
if (i !== 1 && i === num) {
await page.setViewport({
width: boundingBox.width,
height: parseInt(boundingBox.height) - pageHeight * (num - 1)
})
}
if (i !== 1 && i <= num) {
await page.evaluate(() => window.scrollBy(0, 7000))
}
let buff
if (num === 1) {
buff = await body.screenshot(randData)
} else {
buff = await page.screenshot(randData)
}
if (num > 2) await common.sleep(200)
this.renderNum++
/** 计算图片大小 */
const kb = (buff.length / 1024).toFixed(2) + 'kb'
logger.mark(`[图片生成][${name}][${this.renderNum}次] ${kb}`)
img.push(segment.image(buff))
}
await page.close().catch((err) => logger.error(err))
if (num > 1) {
logger.mark(`[图片生成][${name}] 处理完成`)
}
return img
} catch (error) {
logger.error(`图片生成失败:${name}:${error}`)
/** 关闭浏览器 */
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
}
}
/** 模板 */
dealTpl (name, data) {
let { tplFile, saveId = name } = data
let savePath = `./temp/html/${name}/${saveId}.html`
/** 读取html模板 */
if (!this.html[tplFile]) {
this.createDir(`./temp/html/${name}`)
try {
this.html[tplFile] = fs.readFileSync(tplFile, 'utf8')
} catch (error) {
logger.error(`加载html错误${tplFile}`)
return false
}
this.watch(tplFile)
}
data.resPath = `${_path}/resources/`
/** 替换模板 */
let tmpHtml = template.render(this.html[tplFile], data)
/** 保存模板 */
fs.writeFileSync(savePath, tmpHtml)
logger.debug(`[图片生成][使用模板] ${savePath}`)
return savePath
}
/** 监听配置文件 */
watch (tplFile) {
if (this.watcher[tplFile]) return
const watcher = chokidar.watch(tplFile)
watcher.on('change', path => {
delete this.html[tplFile]
logger.mark(`[修改html模板] ${tplFile}`)
})
this.watcher[tplFile] = watcher
}
/** 重启 */
restart () {
/** 截图超过重启数时,自动关闭重启浏览器,避免生成速度越来越慢 */
if (this.renderNum % this.restartNum === 0) {
if (this.shoting.length <= 0) {
setTimeout(async () => {
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
logger.mark('puppeteer 关闭重启...')
}, 100)
}
async function registerRendererBackends() {
const subFolders = fs.readdirSync(rendererDir, { withFileTypes: true }).filter((dirent) => dirent.isDirectory());
for (let subFolder of subFolders) {
const newRendererBackends = (await import(path.join(rendererDir, subFolder.name, 'index.js'))).default;
for (let rendererBackendName in newRendererBackends) {
rendererBackends[rendererBackendName] = newRendererBackends[rendererBackendName];
logger.mark("[渲染后端加载]: 导入 " + rendererBackendName);
}
}
}
export default new Puppeteer()
function selectRendererBackend() {
let rendererBackendName = cfg.renderer?.name;
// 未指定,回退到 puppeteer
if (!rendererBackendName) rendererBackendName = "puppeteer";
let rendererBackendConstructor = rendererBackends[rendererBackendName];
if (!rendererBackendConstructor) {
logger.warn("未知的渲染后端 " + rendererBackendName + ", 回退到 puppeteer");
rendererBackendName = "puppeteer";
rendererBackendConstructor = rendererBackends[rendererBackendName];
}
if (!rendererBackendConstructor.isImportable()) {
logger.warn("渲染后端 " + rendererBackendName + " 不可用 (导入失败), 回退到 puppeteer");
rendererBackendName = "puppeteer";
rendererBackendConstructor = rendererBackends[rendererBackendName];
}
logger.mark("当前渲染后端:" + rendererBackendName);
return rendererBackendConstructor;
}
async function newRenderer() {
// 自动扫描,并注册渲染后端
await registerRendererBackends();
// 选择渲染后端
let rendererBackendConstructor = selectRendererBackend();
return new rendererBackendConstructor();
}
export default new Proxy(await newRenderer(), rendererProxyHandler);

View File

@ -1,2 +1,3 @@
packages:
- 'plugins/**'
- 'renderers/**'

6
renderers/.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
*
!.gitignore
!base_renderer.js
!puppeteer
!puppeteer/**

View File

@ -0,0 +1,28 @@
export default class BaseRenderer {
/**
* 截图
*/
async screenshot(name, data = {}) {
this.constructor._WARNING('screenshot(name, data)');
return false;
}
/**
* 分片截图
*/
async screenshots(name, data = {}) {
this.constructor._WARNING('screenshots(name, data)');
return false;
}
/**
* 该渲染后端是否可导入
*/
static isImportable() {
return false;
}
static _WARNING(fName) {
logger.fatal('方法 "' + fName + ' 在类 ' + this.name + ' 中未被实现,请报告错误!');
}
}

View File

@ -0,0 +1,7 @@
import PuppeteerRenderer from './puppeteer_renderer.js';
const newRendererBackends = {
'puppeteer': PuppeteerRenderer
};
export default newRendererBackends;

View File

@ -0,0 +1,398 @@
import fs from 'node:fs'
import os from 'node:os'
import lodash from 'lodash'
import template from 'art-template'
import chokidar from 'chokidar'
import cfg from '../../lib/config/config.js'
import common from '../../lib/common/common.js'
import BaseRenderer from '../base_renderer.js'
const _path = process.cwd()
let puppeteer = {}
// mac地址
let mac = ''
export default class PuppeteerRenderer extends BaseRenderer {
constructor() {
super()
this.browser = false
this.lock = false
this.shoting = []
/** 截图数达到时重启浏览器 避免生成速度越来越慢 */
this.restartNum = 100
/** 截图次数 */
this.renderNum = 0
this.config = {
headless: true,
args: [
'--disable-gpu',
'--disable-setuid-sandbox',
'--no-sandbox',
'--no-zygote'
]
}
if (cfg.bot?.chromium_path) {
/** chromium其他路径 */
this.config.executablePath = cfg.bot.chromium_path
}
this.html = {}
this.watcher = {}
this.createDir('./temp/html')
}
async initPupp() {
if (!lodash.isEmpty(puppeteer)) return puppeteer
puppeteer = (await import('puppeteer')).default
return puppeteer
}
createDir(dir) {
if (!fs.existsSync(dir)) {
let dirs = dir.split('/')
for (let idx = 1; idx <= dirs.length; idx++) {
let temp = dirs.slice(0, idx).join('/')
if (!fs.existsSync(temp)) {
fs.mkdirSync(temp)
}
}
}
}
/**
* 初始化chromium
*/
async browserInit() {
await this.initPupp()
if (this.browser) return this.browser
if (this.lock) return false
this.lock = true
logger.mark('puppeteer Chromium 启动中...')
let connectFlag = false
try {
// 如果是pm2启动尝试连接已有实例
if (process.env.pm_id) {
// 获取Mac地址
if (!mac) {
mac = await this.getMac()
this.browserMacKey = `Yz:chromium:browserWSEndpoint:${mac}`
}
// 是否有browser实例
const browserUrl = await redis.get(this.browserMacKey)
if (browserUrl) {
const browserWSEndpoint = await puppeteer.connect({ browserWSEndpoint: browserUrl }).catch((err) => {
logger.error('puppeteer Chromium 缓存的实例已关闭')
redis.del(this.browserMacKey)
})
// 如果有实例,直接使用
if (browserWSEndpoint) {
this.browser = browserWSEndpoint
if (this.browser) {
connectFlag = true
}
}
}
}
} catch (e) {
logger.error('puppeteer Chromium 尝试连接已有实例失败')
}
if (!this.browser || !connectFlag) {
// 如果没有实例初始化puppeteer
this.browser = await puppeteer.launch(this.config).catch((err, trace) => {
let errMsg = err.toString() + (trace ? trace.toString() : '')
if (typeof err == 'object') {
logger.error(JSON.stringify(err))
} else {
logger.error(err.toString())
if (errMsg.includes('Could not find Chromium')) {
logger.error('没有正确安装Chromium可以尝试执行安装命令node ./node_modules/puppeteer/install.js')
} else if (errMsg.includes('libatk-bridge')) {
logger.error('没有正确安装Chromium可尝试执行 sudo yum install -y chromium')
}
}
console.log(err, trace)
})
}
this.lock = false
if (!this.browser) {
logger.error('puppeteer Chromium 启动失败')
return false
}
if (connectFlag) {
logger.mark('puppeteer Chromium 已连接启动的实例')
} else {
console.log('chromium', this.browser.wsEndpoint())
if (process.env.pm_id && this.browserMacKey) {
//缓存一下实例30天
const expireTime = 60 * 60 * 24 * 30
await redis.set(this.browserMacKey, this.browser.wsEndpoint(), { EX: expireTime })
}
logger.mark('puppeteer Chromium 启动成功')
}
/** 监听Chromium实例是否断开 */
this.browser.on('disconnected', (e) => {
logger.error('Chromium实例关闭或崩溃')
this.browser = false
})
return this.browser
}
// 获取Mac地址
async getMac() {
// 获取Mac地址
let mac = '00:00:00:00:00:00'
try {
const network = os.networkInterfaces()
let osMac
// 判断系统
if (os.platform() === 'win32') {
// windows下获取mac地址
let osMacList = Object.keys(network).map(key => network[key]).flat()
osMacList = osMacList.filter(item => item.family === 'IPv4' && item.mac !== mac)
osMac = osMacList[0].mac
} else if (os.platform() === 'linux') {
// linux下获取mac地址
osMac = network.eth0.filter(item => item.family === 'IPv4' && item.mac !== mac)[0].mac
}
if (osMac) {
mac = String(osMac)
}
} catch (e) {
console.log('获取Mac地址失败', e.toString())
}
mac = mac.replace(/:/g, '')
return mac
}
/**
* `chromium` 截图
* @param data 模板参数
* @param data.tplFile 模板路径必传
* @param data.saveId 生成html名称为空name代替
* @param data.imgType screenshot参数生成图片类型jpegpng
* @param data.quality screenshot参数图片质量 0-100jpeg是可传默认90
* @param data.omitBackground screenshot参数隐藏默认的白色背景背景透明默认不透明
* @param data.path screenshot参数截图保存路径截图图片类型将从文件扩展名推断出来如果是相对路径则从当前路径解析如果没有指定路径图片将不会保存到硬盘
* @return icqq img
*/
async screenshot(name, data = {}) {
if (!await this.browserInit()) {
return false
}
let savePath = this.dealTpl(name, data)
if (!savePath) return false
let buff = ''
let start = Date.now()
this.shoting.push(name)
try {
const page = await this.browser.newPage()
await page.goto(`file://${_path}${lodash.trim(savePath, '.')}`, data.pageGotoParams || {})
let body = await page.$('#container') || await page.$('body')
let randData = {
// encoding: 'base64',
type: data.imgType || 'jpeg',
omitBackground: data.omitBackground || false,
quality: data.quality || 90,
path: data.path || ''
}
if (data.imgType === 'png') delete randData.quality
buff = await body.screenshot(randData)
page.close().catch((err) => logger.error(err))
} catch (error) {
logger.error(`图片生成失败:${name}:${error}`)
/** 关闭浏览器 */
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
buff = ''
return false
}
this.shoting.pop()
if (!buff) {
logger.error(`图片生成为空:${name}`)
return false
}
this.renderNum++
/** 计算图片大小 */
let kb = (buff.length / 1024).toFixed(2) + 'kb'
logger.mark(`[图片生成][${name}][${this.renderNum}次] ${kb} ${logger.green(`${Date.now() - start}ms`)}`)
this.restart()
return segment.image(buff)
}
/**
* `chromium` 分片截图
*/
async screenshots(name, data = {}) {
// FIXME: pageHeight 作为参数?
const pageHeight = 7000
await this.browserInit()
if (!this.browser) return false
const savePath = this.dealTpl(name, data)
if (!savePath) return false
const page = await this.browser.newPage()
try {
await page.goto(`file://${_path}${lodash.trim(savePath, '.')}`, { timeout: 120000 })
const body = await page.$('#container') || await page.$('body')
const boundingBox = await body.boundingBox()
const num = Math.round(boundingBox.height / pageHeight) || 1
if (num > 1) {
await page.setViewport({
width: boundingBox.width,
height: pageHeight + 100
})
}
const img = []
for (let i = 1; i <= num; i++) {
const randData = {
type: 'jpeg',
quality: 90
}
if (i !== 1 && i === num) {
await page.setViewport({
width: boundingBox.width,
height: parseInt(boundingBox.height) - pageHeight * (num - 1)
})
}
if (i !== 1 && i <= num) {
await page.evaluate(() => window.scrollBy(0, 7000))
}
let buff
if (num === 1) {
buff = await body.screenshot(randData)
} else {
buff = await page.screenshot(randData)
}
if (num > 2) await common.sleep(200)
this.renderNum++
/** 计算图片大小 */
const kb = (buff.length / 1024).toFixed(2) + 'kb'
logger.mark(`[图片生成][${name}][${this.renderNum}次] ${kb}`)
img.push(segment.image(buff))
}
await page.close().catch((err) => logger.error(err))
if (num > 1) {
logger.mark(`[图片生成][${name}] 处理完成`)
}
return img
} catch (error) {
logger.error(`图片生成失败:${name}:${error}`)
/** 关闭浏览器 */
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
}
}
/** 模板 */
dealTpl(name, data) {
let { tplFile, saveId = name } = data
let savePath = `./temp/html/${name}/${saveId}.html`
/** 读取html模板 */
if (!this.html[tplFile]) {
this.createDir(`./temp/html/${name}`)
try {
this.html[tplFile] = fs.readFileSync(tplFile, 'utf8')
} catch (error) {
logger.error(`加载html错误${tplFile}`)
return false
}
this.watch(tplFile)
}
data.resPath = `${_path}/resources/`
/** 替换模板 */
let tmpHtml = template.render(this.html[tplFile], data)
/** 保存模板 */
fs.writeFileSync(savePath, tmpHtml)
logger.debug(`[图片生成][使用模板] ${savePath}`)
return savePath
}
/** 监听配置文件 */
watch(tplFile) {
if (this.watcher[tplFile]) return
const watcher = chokidar.watch(tplFile)
watcher.on('change', path => {
delete this.html[tplFile]
logger.mark(`[修改html模板] ${tplFile}`)
})
this.watcher[tplFile] = watcher
}
/** 重启 */
restart() {
/** 截图超过重启数时,自动关闭重启浏览器,避免生成速度越来越慢 */
if (this.renderNum % this.restartNum === 0) {
if (this.shoting.length <= 0) {
setTimeout(async () => {
if (this.browser) {
await this.browser.close().catch((err) => logger.error(err))
}
this.browser = false
logger.mark('puppeteer 关闭重启...')
}, 100)
}
}
}
static isImportable() {
// XXX: Puppeteer 为默认的,因此总可以被导入
return true;
}
}