@kne/fastify-file-manager 2.0.14 → 3.0.0-alpha.1

package/libs/models/file-record.js

@@ -27,13 +27,21 @@ module.exports = ({ DataTypes }) => {
         type: DataTypes.STRING,
         allowNull: false,
         comment: '存储类型:local本地文件系统,oss远程oss存储'
+      },
+      options: {
+        type: DataTypes.JSONB,
+        defaultValue: {},
+        comment: '扩展字段'
       }
     },
     options: {
       indexes: [
         {
           unique: true,
-          fields: ['uuid', 'deleted_at']
+          fields: ['uuid'],
+          where: {
+            deleted_at: null
+          }
         },
         {
           fields: ['namespace']

package/libs/services/file-record.js

@@ -6,12 +6,14 @@ const { NotFound } = require('http-errors');
 const os = require('node:os');
 const { Readable } = require('node:stream');
 const compressing = require('compressing');
+const { glob } = require('glob');
+const MimeTypes = require('mime-types');
 
-module.exports = fp(async (fastify, options) => {
+module.exports = fp(async (fastify, fastifyOptions) => {
   const { models, services } = fastify.fileManager;
   const { Op } = fastify.sequelize.Sequelize;
 
-  const detail = async ({ id, uuid }) => {
+  const detail = async ({ id, uuid, namespace }) => {
     const file = await models.fileRecord.findOne({
       where: { uuid: String(id || uuid).split('?')[0] }
     });
@@ -22,7 +24,7 @@ module.exports = fp(async (fastify, options) => {
 
     return file;
   };
-  const uploadToFileSystem = async ({ id, file, namespace }) => {
+  const uploadToFileSystem = async ({ id, file, namespace, options }) => {
     const { filename, encoding, mimetype } = file;
     const hash = crypto.createHash('md5');
     const extension = path.extname(filename);
@@ -63,7 +65,7 @@ module.exports = fp(async (fastify, options) => {
     const digest = hash.digest('hex');
 
     let storageType;
-    const ossServices = options.ossAdapter();
+    const ossServices = fastifyOptions.ossAdapter();
     if (typeof ossServices.uploadFile === 'function') {
       // 使用流上传到OSS
       const readStream = fs.createReadStream(tmpPath);
@@ -71,7 +73,7 @@ module.exports = fp(async (fastify, options) => {
       storageType = 'oss';
     } else {
       // 使用流写入本地文件
-      const filepath = path.resolve(options.root, `${digest}${extension}`);
+      const filepath = path.resolve(fastifyOptions.root, `${digest}${extension}`);
       const writeStream = fs.createWriteStream(filepath);
       const readStream = fs.createReadStream(tmpPath);
       await new Promise((resolve, reject) => {
@@ -94,23 +96,25 @@ module.exports = fp(async (fastify, options) => {
       file.hash = digest;
       file.size = fileSize;
       file.storageType = storageType;
+      file.options = options;
       await file.save();
       return file;
     })(() =>
       models.fileRecord.create({
         filename,
-        namespace: namespace || options.namespace,
+        namespace: namespace || fastifyOptions.namespace,
         encoding,
         mimetype,
         hash: digest,
         size: fileSize,
-        storageType
+        storageType,
+        options
       })
     );
     return Object.assign({}, outputFile.get({ plain: true }), { id: outputFile.uuid });
   };
 
-  const uploadFromUrl = async ({ id, url, filename: originFilename, namespace }) => {
+  const uploadFromUrl = async ({ id, url, filename: originFilename, namespace, options }) => {
     const response = await fetch(url);
     if (!response.ok) {
       throw new Error('下载文件失败');
@@ -166,13 +170,13 @@ module.exports = fp(async (fastify, options) => {
       encoding: 'binary',
       file: nodeStream
     };
-    return await uploadToFileSystem({ id, file: tempFile, namespace });
+    return await uploadToFileSystem({ id, file: tempFile, namespace, options });
   };
 
   const getFileUrl = async ({ id, namespace }) => {
-    const file = await detail({ id });
+    const file = await detail({ id, namespace });
     const extension = path.extname(file.filename);
-    const ossServices = options.ossAdapter();
+    const ossServices = fastifyOptions.ossAdapter();
     if (file.storageType === 'oss' && typeof ossServices.getFileLink !== 'function') {
       throw new Error('ossAdapter未正确配置无法读取oss类型存储文件');
     }
@@ -180,17 +184,17 @@ module.exports = fp(async (fastify, options) => {
       return await ossServices.getFileLink({ filename: `${file.hash}${extension}` });
     }
 
-    if (!(await fs.exists(`${options.root}/${file.hash}${extension}`))) {
+    if (!(await fs.exists(`${fastifyOptions.root}/${file.hash}${extension}`))) {
       throw new NotFound();
     }
-    return `${options.prefix}/file/${file.hash}${extension}?filename=${file.filename}`;
+    return `${fastifyOptions.prefix}/file/${file.hash}${extension}?filename=${file.filename}`;
   };
 
-  const getFileInfo = async ({ id }) => {
-    const file = await detail({ id });
+  const getFileInfo = async ({ id, namespace }) => {
+    const file = await detail({ id, namespace });
     const extension = path.extname(file.filename);
     const targetFileName = `${file.hash}${extension}`;
-    const ossServices = options.ossAdapter();
+    const ossServices = fastifyOptions.ossAdapter();
     if (file.storageType === 'oss' && typeof ossServices.downloadFile !== 'function') {
       throw new Error('ossAdapter未正确配置无法读取oss类型存储文件');
     }
@@ -205,8 +209,7 @@ module.exports = fp(async (fastify, options) => {
     });
   };
 
-  const getFileList = async ({ filter = {}, currentPage, perPage }) => {
-    // namespace: namespace || options.namespace
+  const getFileList = async ({ filter = {}, namespace, currentPage, perPage }) => {
     const queryFilter = {};
 
     if (filter?.filename) {
@@ -228,6 +231,9 @@ module.exports = fp(async (fastify, options) => {
         [Op.like]: `%${filter.namespace}%`
       };
     }
+    if (namespace) {
+      queryFilter.namespace = namespace;
+    }
 
     if (filter?.id) {
       queryFilter.uuid = filter.id;
@@ -281,15 +287,15 @@ module.exports = fp(async (fastify, options) => {
     await file.save();
   };
 
-  const getFileBlob = async ({ id }) => {
-    const file = await detail({ id });
+  const getFileBlob = async ({ id, namespace }) => {
+    const file = await detail({ id, namespace });
     if (!file) {
       throw new Error('文件不存在');
     }
 
     const extension = path.extname(file.filename);
     const targetFileName = `${file.hash}${extension}`;
-    const ossServices = options.ossAdapter();
+    const ossServices = fastifyOptions.ossAdapter();
 
     let buffer;
     if (file.storageType === 'oss') {
@@ -298,7 +304,7 @@ module.exports = fp(async (fastify, options) => {
       }
       buffer = await ossServices.downloadFile({ filename: targetFileName });
     } else {
-      const filePath = path.resolve(options.root, targetFileName);
+      const filePath = path.resolve(fastifyOptions.root, targetFileName);
       if (!(await fs.exists(filePath))) {
         throw new NotFound();
       }
@@ -314,14 +320,14 @@ module.exports = fp(async (fastify, options) => {
   const getFileReadStream = file => {
     const extension = path.extname(file.filename);
     const targetFileName = `${file.hash}${extension}`;
-    const ossServices = options.ossAdapter();
+    const ossServices = fastifyOptions.ossAdapter();
     if (file.storageType === 'oss') {
       if (typeof ossServices.getFileStream !== 'function') {
         throw new Error('ossAdapter未正确配置无法读取oss类型存储文件');
       }
       return ossServices.getFileStream({ filename: targetFileName });
     } else {
-      const filePath = path.resolve(options.root, targetFileName);
+      const filePath = path.resolve(fastifyOptions.root, targetFileName);
       return fs.createReadStream(filePath);
     }
   };
@@ -376,6 +382,46 @@ module.exports = fp(async (fastify, options) => {
     });
   };
 
+  //文件解压缩
+  const uncompressFile = async ({ id, type = 'zip', namespace, globOptions = '**/*' }) => {
+    const file = await detail({ id });
+    const fileStream = await getFileReadStream(file);
+    const tmpPath = path.resolve(os.tmpdir(), `temp_${id}_${crypto.randomBytes(6).toString('hex')}`);
+    await compressing[type].uncompress(fileStream, tmpPath);
+    const files = await glob(globOptions, {
+      cwd: tmpPath,
+      nodir: true
+    });
+    //将文件上传到文件系统
+    const fileList = await Promise.all(
+      files.map(async dir => {
+        const filepath = path.resolve(tmpPath, dir);
+        const filename = path.basename(dir);
+        const fileStream = fs.createReadStream(filepath);
+
+        const mimetype = MimeTypes.lookup(filepath) || 'application/octet-stream';
+        const file = await uploadToFileSystem({
+          file: {
+            filename,
+            mimetype,
+            encoding: 'binary',
+            file: fileStream
+          },
+          filename,
+          namespace
+        });
+        return {
+          dir,
+          file
+        };
+      })
+    );
+    //清除临时文件
+    await fs.remove(tmpPath);
+
+    return fileList;
+  };
+
   const getFileInstance = async ({ id, uuid }) => {
     return detail({ id, uuid });
   };
@@ -393,6 +439,7 @@ module.exports = fp(async (fastify, options) => {
     getFileReadStream,
     getCompressFileStream,
     getCompressFileBlob,
+    uncompressFile,
     getFileInstance, // 兼容之前api，后面可能会删掉
     fileRecord: {
       uploadToFileSystem,
@@ -407,6 +454,7 @@ module.exports = fp(async (fastify, options) => {
       getFileReadStream,
       getCompressFileStream,
       getCompressFileBlob,
+      uncompressFile,
       getFileInstance
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kne/fastify-file-manager",
-  "version": "2.0.14",
+  "version": "3.0.0-alpha.1",
   "description": "用于管理静态文件上传查看等",
   "main": "index.js",
   "scripts": {
@@ -51,6 +51,8 @@
     "@fastify/static": "^8.1.1",
     "compressing": "^2.0.0",
     "fs-extra": "^11.2.0",
-    "http-errors": "^2.0.0"
+    "glob": "^13.0.0",
+    "http-errors": "^2.0.0",
+    "mime-types": "^3.0.2"
   }
 }