piclist 1.9.14 → 2.0.0

package/.github/workflows/docker.yml

@@ -11,19 +11,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
+      uses: docker/setup-buildx-action@v3
 
     - name: Login to Docker Hub
-      uses: docker/login-action@v1
+      uses: docker/login-action@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
 
     - name: Build and Push Docker Image
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v6
       with:
         context: .
         file: ./Dockerfile
@@ -33,7 +33,7 @@ jobs:
 
     - name: Build and Push Docker Image with Tag
       if: startsWith(github.ref, 'refs/tags/')
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v6
       with:
         context: .
         file: ./Dockerfile

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+##  (2025-08-12)
+
+* :arrow_up: Upgrade(custom): upgrade deps 75e5a11
+* :package: Chore(custom): remove unused files 6be4d68
+* :sparkles: Feature(custom): add image watermark opacity setting a1d41f5
+* :sparkles: Feature(custom): add options for s3 88e2c7f, closes Kuingsmile/Piclist#343
+* :sparkles: Feature(custom): change  watermark and image compress order bc380a6
+* :sparkles: Feature(custom): migrate to esm 838cb84
+* :sparkles: Feature(custom): optimize server 0dc69b2
+* :sparkles: Feature(custom): remove cjs support 9cd9674
+
+
+
 ## :tada: 1.9.14 (2025-06-12)
 
 

package/License

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2018 Molunerfinn
-Copyright (c) 2023-present Kuingsmile
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2018 Molunerfinn
+Copyright (c) 2023-present Kuingsmile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -37,7 +37,7 @@ You can refer to the [DeepWiki of PiclList-Core](https://deepwiki.com/Kuingsmile
 
 ## Installation
 
-PicList requires Node.js >= 16
+PicList requires Node.js >= 20
 
 ### Prerequisites
 

package/README_cn.md

@@ -37,7 +37,7 @@ PicList-Core 是一个功能强大的图片上传工具，提供 CLI 和 API 两
 
 ## 安装
 
-PicList 需要 Node.js >= 16
+PicList 需要 Node.js >= 20
 
 ### 前置条件
 

package/bin/picgo

@@ -1,18 +1,20 @@
 #!/usr/bin/env node
-const path = require('path')
-const minimist = require('minimist')
-const os = require('os')
+import { homedir } from 'node:os'
+import { resolve } from 'node:path'
+
+import minimist from 'minimist'
+
+import { PicGo } from '../dist/index.js'
 
 const argv = minimist(process.argv.slice(2))
 let configPath = argv.c || argv.config || ''
 if (configPath !== true && configPath !== '') {
-  configPath = configPath.replace(/^~/, os.homedir())
-  configPath = path.resolve(configPath)
+  configPath = configPath.replace(/^~/, homedir())
+  configPath = resolve(configPath)
 } else {
   configPath = ''
 }
-const { PicGo } = require('..')
-const picgo = new PicGo(configPath)
+const picgo = await PicGo.create(configPath)
 picgo.registerCommands()
 
 try {

package/bin/picgo-server

@@ -1,14 +1,18 @@
 #!/usr/bin/env node
-const http = require('http')
-const multer = require('multer')
-const axios = require('axios')
-const minimist = require('minimist')
-const fs = require('fs-extra')
-const path = require('path')
-const os = require('os')
+import http from 'node:http'
+import os from 'node:os'
+import path from 'node:path'
+
+import axios from 'axios'
+import fs from 'fs-extra'
+import { ensureDirSync } from 'fs-extra/esm'
+import minimist from 'minimist'
+import multer from 'multer'
+
+import { PicGo } from '../dist/index.js'
 
 const tempDir = path.join(os.homedir(), '.piclist', 'serverTemp')
-fs.ensureDirSync(tempDir)
+ensureDirSync(tempDir)
 
 const argv = minimist(process.argv.slice(2))
 
@@ -16,33 +20,6 @@ let key = ''
 let defaultPort = 36677
 let defaultHost = '0.0.0.0'
 
-if (argv.h || argv.help) {
-  showHelp()
-  process.exit(0)
-}
-
-if (argv.v || argv.version) {
-  showVersion()
-  process.exit(0)
-}
-
-if (argv.k || argv.key) {
-  key = String(argv.k || argv.key)
-}
-
-if (argv.p || argv.port) {
-  defaultPort = Number(argv.p || argv.port) || defaultPort
-}
-
-if (argv.host) {
-  defaultHost = String(argv.host)
-}
-
-function showVersion() {
-  const pkg = require('../package.json')
-  console.log(`PicList-Core ${pkg.version}`)
-}
-
 function showHelp() {
   console.log(`
     Usage: picgo-server [options]
@@ -61,6 +38,31 @@ function showHelp() {
   `)
 }
 
+const ensureHTTPLink = url => {
+  return url.startsWith('http') ? url : `http://${url}`
+}
+
+function isLoopback(addr = '') {
+  return addr === '127.0.0.1' || addr === '::1' || addr === '::ffff:127.0.0.1'
+}
+
+if (argv.h || argv.help) {
+  showHelp()
+  process.exit(0)
+}
+
+if (argv.k || argv.key) {
+  key = String(argv.k || argv.key)
+}
+
+if (argv.p || argv.port) {
+  defaultPort = Number(argv.p || argv.port) || defaultPort
+}
+
+if (argv.host) {
+  defaultHost = String(argv.host)
+}
+
 let configPath = argv.c || argv.config || ''
 if (configPath !== true && configPath !== '') {
   configPath = configPath.replace(/^~/, os.homedir())
@@ -69,11 +71,10 @@ if (configPath !== true && configPath !== '') {
   configPath = ''
 }
 
-const { PicGo } = require('..')
-const picgo = new PicGo(configPath)
+const picgo = await PicGo.create(configPath)
 const errorMessage = 'Upload failed, please check your network and config'
 
-handleResponse = ({
+const handleResponse = ({
   response,
   statusCode = 200,
   header = {
@@ -89,43 +90,42 @@ handleResponse = ({
   if (body && body.success === false) {
     console.log('[PicList Server] upload failed, see log for more detail ↑')
   }
-  response.writeHead(statusCode, header)
-  response.write(JSON.stringify(body))
-  response.end()
-}
-
-ensureHTTPLink = url => {
-  return url.startsWith('http') ? url : `http://${url}`
+  try {
+    response.writeHead(statusCode, header)
+    response.end(JSON.stringify(body))
+  } catch (e) {
+    console.error('[PicList Server] response error:', e)
+  }
 }
 
 class Router {
   constructor() {
-    this.router = new Map()
+    this.routes = new Map()
   }
 
-  addRoute(method, url, callback, urlparams) {
-    if (!this.router.has(url)) {
-      this.router.set(url, new Map())
+  add(method, url, callback, urlparams) {
+    if (!this.routes.has(url)) {
+      this.routes.set(url, new Map())
     }
-    this.router.get(url).set(method, { handler: callback, urlparams })
+    this.routes.get(url).set(method, { handler: callback, urlparams })
   }
 
   get(url, callback, urlparams) {
-    this.addRoute('GET', url, callback, urlparams)
+    this.add('GET', url, callback, urlparams)
   }
 
   post(url, callback, urlparams) {
-    this.addRoute('POST', url, callback, urlparams)
+    this.add('POST', url, callback, urlparams)
   }
 
   any(url, callback, urlparams) {
-    this.addRoute('GET', url, callback, urlparams)
-    this.addRoute('POST', url, callback, urlparams)
+    this.add('GET', url, callback, urlparams)
+    this.add('POST', url, callback, urlparams)
   }
 
   getHandler(url, method) {
-    if (this.router.has(url)) {
-      const methods = this.router.get(url)
+    if (this.routes.has(url)) {
+      const methods = this.routes.get(url)
       if (methods.has(method)) {
         return methods.get(method)
       }
@@ -134,16 +134,16 @@ class Router {
   }
 }
 
-let router = new Router()
+const router = new Router()
 
 const multerStorage = multer.diskStorage({
-  destination: function (_req, _file, cb) {
+  destination(_req, _file, cb) {
     if (!fs.existsSync(tempDir)) {
       fs.mkdirSync(tempDir)
     }
     cb(null, tempDir)
   },
-  filename: function (_req, file, cb) {
+  filename(_req, file, cb) {
     if (!/[^\u0000-\u00ff]/.test(file.originalname)) {
       file.originalname = Buffer.from(file.originalname, 'latin1').toString('utf8')
     }
@@ -190,11 +190,13 @@ router.post('/upload', async ({ response, list = [], urlparams }) => {
         }
       })
     }
+
+    let needRestore = false
     let currentPicBedType = ''
     let currentPicBedConfig = {}
     let currentPicBedConfigId = ''
     const currentPicBed = picgo.getConfig('picBed') || {}
-    let needRestore = false
+
     if (picbed) {
       currentPicBedType = currentPicBed.uploader || currentPicBed.current || 'smms'
       currentPicBedConfig = currentPicBed[currentPicBedType] || {}
@@ -215,7 +217,7 @@ router.post('/upload', async ({ response, list = [], urlparams }) => {
           const picBeds = picgo.getConfig('uploader')
           const currentPicBedList = picBeds?.[picbed]?.configList
           if (currentPicBedList) {
-            const currentConfig = currentPicBedList?.find((item) => item._configName === configName)
+            const currentConfig = currentPicBedList?.find(item => item._configName === configName)
             changeCurrentUploader(picbed, currentConfig, currentConfig._id)
           }
         }
@@ -292,9 +294,19 @@ router.post('/upload', async ({ response, list = [], urlparams }) => {
   }
 })
 
+router.any('/heartbeat', async ({ response }) => {
+  handleResponse({
+    response,
+    body: {
+      success: true,
+      result: 'alive'
+    }
+  })
+})
+
 async function responseForGet({ response }) {
   response.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' })
-  response.write(`
+  response.end(`
       <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -352,21 +364,9 @@ async function responseForGet({ response }) {
 }</pre>
 
 </body>
-</html>
-      `)
-  response.end()
+</html>`)
 }
 
-router.any('/heartbeat', async ({ response }) => {
-  handleResponse({
-    response,
-    body: {
-      success: true,
-      result: 'alive'
-    }
-  })
-})
-
 class Server {
   constructor() {
     this.httpServer = http.createServer(this.handleRequest)
@@ -378,102 +378,106 @@ class Server {
       return
     }
 
-    if (request.method === 'POST') {
-      const [url, query] = (request.url || '').split('?')
-      if (!router.getHandler(url, 'POST')) {
-        console.log(`[PicList Server] don't support [${url}] endpoint`)
+    const rawUrl = request.url || ''
+    const [url, query] = rawUrl.split('?')
+    const method = request.method || 'GET'
+    const handlerEntry = router.getHandler(url, method)
+
+    if (!handlerEntry) {
+      console.log(`[PicList Server] don't support [${method}] ${url} endpoint`)
+      if (method === 'GET' || method === 'POST') {
         handleResponse({
           response,
-          statusCode: 404,
-          body: {
-            success: false
-          }
+          statusCode: method === 'POST' ? 404 : 404,
+          body: { success: false }
         })
       } else {
-        let urlSP = query ? new URLSearchParams(query) : undefined
-        console.log('[PicList Server] get the request from IP:', request.socket.remoteAddress)
-        if (request.socket.remoteAddress === '127.0.0.1' || request.socket.remoteAddress === '::1') {
-          if (urlSP) {
-            urlSP.set('key', key)
-          } else {
-            urlSP = new URLSearchParams('key=' + key)
-          }
-        }
-        if (request.headers['content-type'] && request.headers['content-type'].startsWith('multipart/form-data')) {
-          uploadMulter.any()(request, response, err => {
-            if (err) {
-              console.log('[PicList Server]', err)
-              return handleResponse({
-                response,
-                body: {
-                  success: false,
-                  message: 'Error processing formData'
-                }
-              })
-            }
-
-            const list = request.files.map(file => file.path)
+        response.statusCode = 405
+        response.end()
+      }
+      return
+    }
 
-            const handler = router.getHandler(url, 'POST')?.handler
-            if (handler) {
-              handler({
-                list: list,
-                response,
-                urlparams: urlSP
-              })
-            }
-          })
+    if (method === 'POST') {
+      let urlSP = query ? new URLSearchParams(query) : undefined
+      const remote = request.socket?.remoteAddress
+      if (isLoopback(remote)) {
+        if (urlSP) {
+          urlSP.set('key', key)
         } else {
-          let body = ''
-          let postObj
-          request.on('data', chunk => {
-            body += chunk
-          })
-          request.on('end', () => {
-            try {
-              postObj = body === '' ? {} : JSON.parse(body)
-            } catch (err) {
-              console.log('[PicList Server]', err)
-              return handleResponse({
-                response,
-                body: {
-                  success: false,
-                  message: 'Not sending data in JSON format'
-                }
-              })
-            }
+          urlSP = new URLSearchParams('key=' + key)
+        }
+      }
+
+      const contentType = String(request.headers['content-type'] || '')
+      const isForm = contentType.startsWith('multipart/form-data')
+      if (isForm) {
+        uploadMulter.any()(request, response, err => {
+          if (err) {
+            console.log('[PicList Server]', err)
+            return handleResponse({
+              response,
+              body: {
+                success: false,
+                message: 'Error processing formData'
+              }
+            })
+          }
+          const list = request.files.map(file => file.path)
+          if (handlerEntry.handler) {
+            handlerEntry.handler({
+              list,
+              response,
+              urlparams: urlSP
+            })
+          }
+        })
+      } else {
+        let body = ''
+        let postObj
+        request.on('data', chunk => {
+          body += chunk
+        })
+        request.on('end', () => {
+          try {
+            postObj = body === '' ? {} : JSON.parse(body)
             console.log('[PicList Server] get the request', body)
-            const handler = router.getHandler(url, 'POST')?.handler
-            if (handler) {
-              handler({
+            if (handlerEntry.handler) {
+              handlerEntry.handler({
                 ...postObj,
                 response,
                 urlparams: urlSP
               })
             }
-          })
-        }
+          } catch (err) {
+            console.log('[PicList Server]', err)
+            return handleResponse({
+              response,
+              body: {
+                success: false,
+                message: 'Not sending data in JSON format'
+              }
+            })
+          }
+        })
       }
-    } else if (request.method === 'GET') {
-      const [url, query] = (request.url || '').split('?')
-      if (!router.getHandler(url, 'GET')) {
-        console.log(`[PicList Server] don't support [${url}] endpoint`)
-        response.statusCode = 404
-        response.end()
-      } else {
-        const handler = router.getHandler(url, 'GET')?.handler
-        if (handler) {
-          handler({
-            response,
-            urlparams: query ? new URLSearchParams(query) : undefined
-          })
-        }
+      return
+    }
+
+    if (request.method === 'GET') {
+      if (handlerEntry.handler) {
+        handlerEntry.handler({
+          response,
+          urlparams: query ? new URLSearchParams(query) : undefined
+        })
       }
-    } else {
-      console.log(`[PicList Server] don't support [${request.method}] method`)
-      response.statusCode = 405
-      response.end()
+
+      return
     }
+
+    console.log(`[PicList Server] don't support [${request.method}] method`)
+    response.statusCode = 405
+    response.end()
   }
 
   listen(port) {
@@ -481,10 +485,12 @@ class Server {
     if (typeof port === 'string') {
       port = parseInt(port, 10)
     }
+
     this.httpServer.listen(port, defaultHost).on('error', async err => {
       if (err.code === 'EADDRINUSE') {
         try {
-          await axios.post(ensureHTTPLink(`${defaultHost}:${port}/heartbeat`))
+          const probeHost = defaultHost === '0.0.0.0' || defaultHost === '::' ? '127.0.0.1' : defaultHost
+          await axios.post(ensureHTTPLink(`${probeHost}:${port}/heartbeat`))
           console.log(`[PicList Server] server is already running at ${port}, no need to start again`)
           this.shutdown(true)
         } catch (e) {
@@ -504,9 +510,13 @@ class Server {
   }
 
   shutdown(hasStarted) {
-    this.httpServer.close()
-    if (!hasStarted) {
-      console.log('[PicList Server] shutdown')
+    try {
+      this.httpServer.close()
+      if (!hasStarted) {
+        console.log('[PicList Server] shutdown')
+      }
+    } catch (error) {
+      console.error('[PicList Server] error shutting down', error)
     }
   }
 
@@ -519,4 +529,13 @@ class Server {
 const server = new Server()
 server.startup()
 
-module.exports = server
+process.on('SIGINT', () => {
+  server.shutdown()
+  process.exit(0)
+})
+process.on('SIGTERM', () => {
+  server.shutdown()
+  process.exit(0)
+})
+
+export default server