twikoo-func 1.6.16 → 1.6.18

package/index.js

@@ -40,6 +40,7 @@ const {
 const { postCheckSpam } = require('./utils/spam')
 const { sendNotice, emailTest } = require('./utils/notify')
 const { uploadImage } = require('./utils/image')
+const logger = require('./utils/logger')
 
 // 云函数 SDK / tencent cloudbase sdk
 const app = tcb.init({ env: tcb.SYMBOL_CURRENT_ENV })
@@ -60,9 +61,9 @@ const requestTimes = {}
 
 // 云函数入口点 / entry point
 exports.main = async (event, context) => {
-  console.log('请求 IP：', auth.getClientIP())
-  console.log('请求函数：', event.event)
-  console.log('请求参数：', event)
+  logger.log('请求 IP：', auth.getClientIP())
+  logger.log('请求函数：', event.event)
+  logger.log('请求参数：', event)
   let res = {}
   try {
     protect()
@@ -141,13 +142,13 @@ exports.main = async (event, context) => {
         }
     }
   } catch (e) {
-    console.error('Twikoo 遇到错误，请参考以下错误信息。如有疑问，请反馈至 https://github.com/imaegoo/twikoo/issues')
-    console.error('请求参数：', event)
-    console.error('错误信息：', e)
+    logger.error('Twikoo 遇到错误，请参考以下错误信息。如有疑问，请反馈至 https://github.com/imaegoo/twikoo/issues')
+    logger.error('请求参数：', event)
+    logger.error('错误信息：', e)
     res.code = RES_CODE.FAIL
     res.message = e.message
   }
-  console.log('请求返回：', res)
+  logger.log('请求返回：', res)
   return res
 }
 
@@ -182,7 +183,7 @@ async function checkAndSaveCredentials (credentials) {
     await writeConfig({ CREDENTIALS: credentials })
     return true
   } catch (e) {
-    console.error('私钥文件异常：', e)
+    logger.error('私钥文件异常：', e)
     return false
   }
 }
@@ -452,7 +453,7 @@ async function commentImportForAdmin (event) {
     }
     res.code = RES_CODE.SUCCESS
     res.log = logText
-    console.log(logText)
+    logger.info(logText)
   } else {
     res.code = RES_CODE.NEED_LOGIN
     res.message = '请先登录'
@@ -572,7 +573,7 @@ async function commentSubmit (event, context) {
       data: { event: 'POST_SUBMIT', comment }
     }, { timeout: 300 }) // 设置较短的 timeout 来实现异步
   } catch (e) {
-    console.log('开始异步垃圾检测、发送评论通知')
+    logger.log('开始异步垃圾检测、发送评论通知')
   }
   return res
 }
@@ -836,10 +837,10 @@ function protect () {
   const ip = auth.getClientIP()
   requestTimes[ip] = (requestTimes[ip] || 0) + 1
   if (requestTimes[ip] > MAX_REQUEST_TIMES) {
-    console.log(`${ip} 当前请求次数为 ${requestTimes[ip]}，已超过最大请求次数`)
+    logger.warn(`${ip} 当前请求次数为 ${requestTimes[ip]}，已超过最大请求次数`)
     throw new Error('Too Many Requests')
   } else {
-    console.log(`${ip} 当前请求次数为 ${requestTimes[ip]}`)
+    logger.log(`${ip} 当前请求次数为 ${requestTimes[ip]}`)
   }
 }
 
@@ -853,7 +854,7 @@ async function readConfig () {
     config = res.data[0] || {}
     return config
   } catch (e) {
-    console.error('读取配置失败：', e)
+    logger.error('读取配置失败：', e)
     await createCollections()
     config = {}
     return config
@@ -863,7 +864,7 @@ async function readConfig () {
 // 写入配置
 async function writeConfig (newConfig) {
   if (!Object.keys(newConfig).length) return 0
-  console.log('写入配置：', newConfig)
+  logger.info('写入配置：', newConfig)
   try {
     let updated
     let res = await db
@@ -882,7 +883,7 @@ async function writeConfig (newConfig) {
     if (updated > 0) config = null
     return updated
   } catch (e) {
-    console.error('写入配置失败：', e)
+    logger.error('写入配置失败：', e)
     return null
   }
 }
@@ -913,7 +914,7 @@ async function createCollections () {
     try {
       res[collection] = await db.createCollection(collection)
     } catch (e) {
-      console.error('建立数据库失败：', e)
+      logger.error('建立数据库失败：', e)
     }
   }
   return res

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twikoo-func",
-  "version": "1.6.16",
+  "version": "1.6.18",
   "description": "A simple comment system.",
   "author": "imaegoo <hello@imaegoo.com> (https://github.com/imaegoo)",
   "license": "MIT",
@@ -27,6 +27,6 @@
     "nodemailer": "^6.4.17",
     "pushoo": "latest",
     "tencentcloud-sdk-nodejs": "^4.0.65",
-    "xml2js": "^0.4.23"
+    "xml2js": "^0.6.0"
   }
 }

package/utils/image.js

@@ -4,6 +4,7 @@ const path = require('path')
 const { isUrl } = require('.')
 const { RES_CODE } = require('./constants')
 const { axios, FormData } = require('./lib')
+const logger = require('./logger')
 
 const fn = {
   async uploadImage (event, config) {
@@ -22,7 +23,7 @@ const fn = {
         await fn.uploadImageToLskyPro({ photo, fileName, config, res, imageCdn: config.IMAGE_CDN })
       }
     } catch (e) {
-      console.error(e)
+      logger.error(e)
       res.code = RES_CODE.UPLOAD_FAILED
       res.err = e.message
     }

package/utils/index.js

@@ -2,6 +2,7 @@ const { URL } = require('url')
 const { axios, bowser, ipToRegion, md5 } = require('./lib')
 const { RES_CODE } = require('./constants')
 const ipRegionSearcher = ipToRegion.create() // 初始化 IP 属地
+const logger = require('./logger')
 
 const fn = {
   // 获取 Twikoo 云函数版本
@@ -48,7 +49,7 @@ const fn = {
         displayOs = [os.name, os.versionName ? os.versionName : os.version].join(' ')
         displayBrowser = [ua.getBrowserName(), ua.getBrowserVersion()].join(' ')
       } catch (e) {
-        console.log('bowser 错误：', e)
+        logger.warn('bowser 错误：', e)
       }
     }
     const showRegion = !!config.SHOW_REGION && config.SHOW_REGION !== 'false'
@@ -90,17 +91,19 @@ const fn = {
     try {
       // 将 IPv6 格式的 IPv4 地址转换为 IPv4 格式
       ip = ip.replace(/^::ffff:/, '')
+      // Zeabur 返回的地址带端口号，去掉端口号。TODO: 不知道该怎么去掉 IPv6 地址后面的端口号
+      ip = ip.replace(/:[0-9]*$/, '')
       const { region } = ipRegionSearcher.binarySearchSync(ip)
       const [country,, province, city, isp] = region.split('|')
       // 有省显示省，没有省显示国家
-      const area = province.trim() ? province : country
+      const area = province.trim() && province !== '0' ? province : country
       if (detail) {
         return area === city ? [city, isp].join(' ') : [area, city, isp].join(' ')
       } else {
         return area.replace(/(省|市)$/, '')
       }
     } catch (e) {
-      console.error('IP 属地查询失败：', e.message)
+      logger.warn('IP 属地查询失败：', e.message, ip)
       return ''
     }
   },
@@ -151,15 +154,13 @@ const fn = {
   async getQQAvatar (qq) {
     try {
       const qqNum = qq.replace(/@qq.com/ig, '')
-      const result = await axios.get(`https://ptlogin2.qq.com/getface?imgtype=4&uin=${qqNum}`)
-      if (result && result.data) {
-        const start = result.data.indexOf('http')
-        const end = result.data.indexOf('"', start)
-        if (start === -1 || end === -1) return null
-        return result.data.substring(start, end)
-      }
+      const result = await axios.get(`https://s.p.qq.com/pub/get_face?img_type=4&uin=${qqNum}`, {
+        maxRedirects: 0,
+        validateStatus: status => [301, 302, 307, 308].includes(status)
+      })
+      return result?.headers?.location || null
     } catch (e) {
-      console.error('获取 QQ 头像失败：', e)
+      logger.warn('获取 QQ 头像失败：', e)
     }
   },
   // 判断是否存在管理员密码
@@ -181,13 +182,13 @@ const fn = {
     }
     if (config.AKISMET_KEY === 'MANUAL_REVIEW') {
       // 人工审核
-      console.log('已使用人工审核模式，评论审核后才会发表~')
+      logger.info('已使用人工审核模式，评论审核后才会发表~')
       return true
     } else if (config.FORBIDDEN_WORDS) {
       // 违禁词检测
       for (const forbiddenWord of config.FORBIDDEN_WORDS.split(',')) {
         if (comment.indexOf(forbiddenWord.trim()) !== -1 || nick.indexOf(forbiddenWord.trim()) !== -1) {
-          console.log('包含违禁词，直接标记为垃圾评论~')
+          logger.warn('包含违禁词，直接标记为垃圾评论~')
           return true
         }
       }
@@ -211,6 +212,7 @@ const fn = {
         SHOW_EMOTION: config.SHOW_EMOTION || 'true',
         EMOTION_CDN: config.EMOTION_CDN,
         COMMENT_PLACEHOLDER: config.COMMENT_PLACEHOLDER,
+        DISPLAYED_FIELDS: config.DISPLAYED_FIELDS,
         REQUIRED_FIELDS: config.REQUIRED_FIELDS,
         HIDE_ADMIN_CRYPT: config.HIDE_ADMIN_CRYPT,
         HIGHLIGHT: config.HIGHLIGHT || 'true',

package/utils/logger.js

@@ -0,0 +1,22 @@
+let envLogLevel = process.env.TWIKOO_LOG_LEVEL || 'info'
+envLogLevel = envLogLevel.toLowerCase()
+const logLevel = { verbose: 1, info: 2, warn: 3, error: 4 }[envLogLevel] || 2
+
+const logger = {
+  log: (...messages) => {
+    if (logLevel <= 1) console.log(logPrefix(), ...messages)
+  },
+  info: (...messages) => {
+    if (logLevel <= 2) console.info(logPrefix(), ...messages)
+  },
+  warn: (...messages) => {
+    if (logLevel <= 3) console.warn(logPrefix(), ...messages)
+  },
+  error: (...messages) => {
+    if (logLevel <= 4) console.error(logPrefix(), ...messages)
+  }
+}
+
+const logPrefix = () => `${new Date().toLocaleString()} Twikoo:`
+
+module.exports = logger

package/utils/notify.js

@@ -5,6 +5,7 @@ const {
   pushoo
 } = require('./lib')
 const { RES_CODE } = require('./constants')
+const logger = require('./logger')
 
 let transporter
 
@@ -17,7 +18,7 @@ const fn = {
       fn.noticeReply(comment, config, getParentComment),
       fn.noticePushoo(comment, config)
     ]).catch(err => {
-      console.error('通知异常：', err)
+      logger.error('通知异常：', err)
     })
   },
   // 初始化邮件插件
@@ -44,31 +45,35 @@ const fn = {
       transporter = nodemailer.createTransport(transportConfig)
       try {
         const success = await transporter.verify()
-        if (success) console.log('SMTP 邮箱配置正常')
+        if (success) logger.info('SMTP 邮箱配置正常')
       } catch (error) {
         throw new Error('SMTP 邮箱配置异常：', error)
       }
       return true
     } catch (e) {
-      console.error('邮件初始化异常：', e.message)
-      if (throwErr) throw e
+      if (throwErr) {
+        logger.error('邮件初始化异常：', e.message)
+        throw e
+      } else {
+        logger.warn('邮件初始化异常：', e.message)
+      }
       return false
     }
   },
   // 博主通知
   async noticeMaster (comment, config) {
     if (!transporter && !await fn.initMailer({ config })) {
-      console.log('未配置邮箱或邮箱配置有误，不通知')
+      logger.info('未配置邮箱或邮箱配置有误，不通知')
       return
     }
     if (config.BLOGGER_EMAIL && config.BLOGGER_EMAIL === comment.mail) {
-      console.log('博主本人评论，不发送通知给博主')
+      logger.info('博主本人评论，不发送通知给博主')
       return
     }
     // 判断是否存在即时消息推送配置
     const hasIMPushConfig = config.PUSHOO_CHANNEL && config.PUSHOO_TOKEN
     if (hasIMPushConfig && config.SC_MAIL_NOTIFY !== 'true') {
-      console.log('存在即时消息推送配置，默认不发送邮件给博主，您可以在管理面板修改此行为')
+      logger.info('存在即时消息推送配置，默认不发送邮件给博主，您可以在管理面板修改此行为')
       return
     }
     const SITE_NAME = config.SITE_NAME
@@ -113,17 +118,17 @@ const fn = {
     } catch (e) {
       sendResult = e
     }
-    console.log('博主通知结果：', sendResult)
+    logger.log('博主通知结果：', sendResult)
     return sendResult
   },
   // 即时消息通知
   async noticePushoo (comment, config) {
     if (!config.PUSHOO_CHANNEL || !config.PUSHOO_TOKEN) {
-      console.log('没有配置 pushoo，放弃即时消息通知')
+      logger.info('没有配置 pushoo，放弃即时消息通知')
       return
     }
     if (config.BLOGGER_EMAIL && config.BLOGGER_EMAIL === comment.mail) {
-      console.log('博主本人评论，不发送通知给博主')
+      logger.info('博主本人评论，不发送通知给博主')
       return
     }
     const pushContent = fn.getIMPushContent(comment, config)
@@ -137,7 +142,7 @@ const fn = {
         }
       }
     })
-    console.log('即时消息通知结果：', sendResult)
+    logger.info('即时消息通知结果：', sendResult)
   },
   // 即时消息推送内容获取
   getIMPushContent (comment, config) {
@@ -165,20 +170,20 @@ const fn = {
   // 回复通知
   async noticeReply (currentComment, config, getParentComment) {
     if (!currentComment.pid) {
-      console.log('无父级评论，不通知')
+      logger.info('无父级评论，不通知')
       return
     }
     if (!transporter && !await fn.initMailer({ config })) {
-      console.log('未配置邮箱或邮箱配置有误，不通知')
+      logger.info('未配置邮箱或邮箱配置有误，不通知')
       return
     }
     const parentComment = await getParentComment(currentComment)
     if (config.BLOGGER_EMAIL === parentComment.mail) {
-      console.log('回复给博主，因为会发博主通知邮件，所以不再重复通知')
+      logger.info('回复给博主，因为会发博主通知邮件，所以不再重复通知')
       return
     }
     if (currentComment.mail === parentComment.mail) {
-      console.log('回复自己的评论，不邮件通知')
+      logger.info('回复自己的评论，不邮件通知')
       return
     }
     const PARENT_NICK = parentComment.nick
@@ -232,7 +237,7 @@ const fn = {
     } catch (e) {
       sendResult = e
     }
-    console.log('回复通知结果：', sendResult)
+    logger.log('回复通知结果：', sendResult)
     return sendResult
   },
   appendHashToUrl (url, hash) {

package/utils/spam.js

@@ -3,6 +3,7 @@ const {
   CryptoJS,
   tencentcloud
 } = require('./lib')
+const logger = require('./logger')
 
 const fn = {
   // 后垃圾评论检测
@@ -24,7 +25,7 @@ const fn = {
           Device: { IP: comment.ip },
           User: { Nickname: comment.nick }
         })
-        console.log('腾讯云返回结果：', checkResult)
+        logger.log('腾讯云返回结果：', checkResult)
         isSpam = checkResult.EvilFlag !== 0
       } else if (config.AKISMET_KEY) {
         // Akismet
@@ -34,7 +35,7 @@ const fn = {
         })
         const isValid = await akismetClient.verifyKey()
         if (!isValid) {
-          console.log('Akismet key 不可用：', config.AKISMET_KEY)
+          logger.warn('Akismet key 不可用：', config.AKISMET_KEY)
           return
         }
         isSpam = await akismetClient.checkSpam({
@@ -48,10 +49,10 @@ const fn = {
           comment_content: comment.comment
         })
       }
-      console.log('垃圾评论检测结果：', isSpam)
+      logger.log('垃圾评论检测结果：', isSpam)
       return isSpam
     } catch (err) {
-      console.error('垃圾评论检测异常：', err)
+      logger.error('垃圾评论检测异常：', err)
     }
   }
 }