@nocobase/plugin-file-manager 0.11.1-alpha.5 → 0.12.0-alpha.2

package/src/server/__tests__/storages/tx-cos.test.ts

@@ -1,69 +0,0 @@
-import path from 'path';
-import { MockServer } from '@nocobase/test';
-import txStorage from '../../storages/tx-cos';
-import { FILE_FIELD_NAME } from '../../constants';
-import { getApp, requestFile } from '..';
-import { Database } from '@nocobase/database';
-
-const itif = process.env.TX_COS_ACCESS_KEY_SECRET ? it : it.skip;
-
-describe('storage:tx-cos', () => {
-  let app: MockServer;
-  let agent;
-  let db: Database;
-  let storage;
-
-  beforeEach(async () => {
-    app = await getApp();
-    agent = app.agent();
-    db = app.db;
-
-    const Storage = db.getCollection('storages').model;
-    storage = await Storage.create({
-      ...txStorage.defaults(),
-      name: 'tx-cos',
-      default: true,
-      path: 'test/path',
-    });
-  });
-
-  afterEach(async () => {
-    await db.close();
-  });
-
-  describe('direct attachment', () => {
-    itif('upload file should be ok', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-
-      const Attachment = db.getCollection('attachments').model;
-      const attachment = await Attachment.findOne<any>({
-        where: { id: body.data.id },
-        include: ['storage'],
-      });
-
-      const matcher = {
-        title: 'text',
-        extname: '.txt',
-        path: 'test/path',
-        size: 13,
-        mimetype: 'text/plain',
-        meta: {},
-        storageId: storage.id,
-      };
-
-      // 文件上传和解析是否正常
-      expect(body.data).toMatchObject(matcher);
-      // 文件的 url 是否正常生成
-      expect(body.data.url).toBe(`${attachment.storage.baseUrl}/${body.data.path}/${body.data.filename}`);
-      // 文件的数据是否正常保存
-      expect(attachment).toMatchObject(matcher);
-
-      // 通过 url 是否能正确访问
-      const content = await requestFile(attachment.url, agent);
-
-      expect(content.text).toBe('Hello world!\n');
-    });
-  });
-});

package/src/server/__tests__/tables/users.ts

@@ -1,26 +0,0 @@
-import { CollectionOptions } from '@nocobase/database';
-
-export default {
-  name: 'users',
-  fields: [
-    {
-      type: 'string',
-      name: 'name',
-    },
-    {
-      type: 'belongsTo',
-      name: 'avatar',
-      target: 'attachments',
-    },
-    {
-      type: 'belongsToMany',
-      name: 'pubkeys',
-      target: 'attachments',
-    },
-    {
-      type: 'belongsToMany',
-      name: 'photos',
-      target: 'attachments',
-    },
-  ],
-} as CollectionOptions;

package/src/server/actions/attachments.ts

@@ -1,175 +0,0 @@
-import { Context, Next } from '@nocobase/actions';
-import { koaMulter as multer } from '@nocobase/utils';
-import path from 'path';
-
-import { DEFAULT_MAX_FILE_SIZE, FILE_FIELD_NAME, LIMIT_FILES } from '../constants';
-import * as Rules from '../rules';
-import { getStorageConfig } from '../storages';
-
-// TODO(optimize): 需要优化错误处理，计算失败后需要抛出对应错误，以便程序处理
-function getFileFilter(storage) {
-  return (req, file, cb) => {
-    // size 交给 limits 处理
-    const { size, ...rules } = storage.rules;
-    const ruleKeys = Object.keys(rules);
-    const result =
-      !ruleKeys.length || !ruleKeys.some((key) => typeof Rules[key] !== 'function' || !Rules[key](file, rules[key]));
-    cb(null, result);
-  };
-}
-
-function getFileData(ctx: Context) {
-  const { [FILE_FIELD_NAME]: file, storage } = ctx;
-  if (!file) {
-    return ctx.throw(400, 'file validation failed');
-  }
-
-  const storageConfig = getStorageConfig(storage.type);
-  const { [storageConfig.filenameKey || 'filename']: name } = file;
-  // make compatible filename across cloud service (with path)
-  const filename = path.basename(name);
-  const extname = path.extname(filename);
-  const urlPath = storage.path ? storage.path.replace(/^([^/])/, '/$1') : '';
-
-  return {
-    title: file.originalname.replace(extname, ''),
-    filename,
-    extname,
-    // TODO(feature): 暂时两者相同，后面 storage.path 模版化以后，这里只是 file 实际的 path
-    path: storage.path,
-    size: file.size,
-    // 直接缓存起来
-    url: `${storage.baseUrl}${urlPath}/${filename}`,
-    mimetype: file.mimetype,
-    // @ts-ignore
-    meta: ctx.request.body,
-    storageId: storage.id,
-    ...(storageConfig.getFileData ? storageConfig.getFileData(file) : {}),
-  };
-}
-
-async function multipart(ctx: Context, next: Next) {
-  const { storage } = ctx;
-  if (!storage) {
-    ctx.logger.error('[file-manager] no linked or default storage provided');
-    return ctx.throw(500);
-  }
-
-  const storageConfig = getStorageConfig(storage.type);
-  if (!storageConfig) {
-    ctx.logger.error(`[file-manager] storage type "${storage.type}" is not defined`);
-    return ctx.throw(500);
-  }
-
-  const multerOptions = {
-    fileFilter: getFileFilter(storage),
-    limits: {
-      fileSize: storage.rules.size ?? DEFAULT_MAX_FILE_SIZE,
-      // 每次只允许提交一个文件
-      files: LIMIT_FILES,
-    },
-    storage: storageConfig.make(storage),
-  };
-  const upload = multer(multerOptions).single(FILE_FIELD_NAME);
-  try {
-    // NOTE: empty next and invoke after success
-    await upload(ctx, () => {});
-  } catch (err) {
-    if (err.name === 'MulterError') {
-      return ctx.throw(400, err);
-    }
-    return ctx.throw(500);
-  }
-
-  const values = getFileData(ctx);
-
-  ctx.action.mergeParams({
-    values,
-  });
-
-  await next();
-}
-
-export async function createMiddleware(ctx: Context, next: Next) {
-  const { resourceName, actionName } = ctx.action;
-  const { attachmentField } = ctx.action.params;
-  const collection = ctx.db.getCollection(resourceName);
-
-  if (collection?.options?.template !== 'file' || !['upload', 'create'].includes(actionName)) {
-    return next();
-  }
-
-  const storageName = ctx.db.getFieldByPath(attachmentField)?.options?.storage || collection.options.storage;
-  const StorageRepo = ctx.db.getRepository('storages');
-  const storage = await StorageRepo.findOne({ filter: storageName ? { name: storageName } : { default: true } });
-
-  ctx.storage = storage;
-
-  await multipart(ctx, next);
-}
-
-export async function destroyMiddleware(ctx: Context, next: Next) {
-  const { resourceName, actionName } = ctx.action;
-  const collection = ctx.db.getCollection(resourceName);
-
-  if (collection?.options?.template !== 'file' || actionName !== 'destroy') {
-    return next();
-  }
-
-  const repository = ctx.db.getRepository(resourceName);
-
-  const { filterByTk, filter } = ctx.action.params;
-
-  const records = await repository.find({
-    filterByTk,
-    filter,
-    context: ctx,
-  });
-
-  const storageIds = new Set(records.map((record) => record.storageId));
-  const storageGroupedRecords = records.reduce((result, record) => {
-    const storageId = record.storageId;
-    if (!result[storageId]) {
-      result[storageId] = [];
-    }
-    result[storageId].push(record);
-    return result;
-  }, {});
-
-  const storages = await ctx.db.getRepository('storages').find({
-    filter: {
-      id: [...storageIds] as any[],
-      paranoid: {
-        $ne: true,
-      },
-    },
-  });
-
-  let count = 0;
-  const undeleted = [];
-  await storages.reduce(
-    (promise, storage) =>
-      promise.then(async () => {
-        const storageConfig = getStorageConfig(storage.type);
-        const result = await storageConfig.delete(storage, storageGroupedRecords[storage.id]);
-        count += result[0];
-        undeleted.push(...result[1]);
-      }),
-    Promise.resolve(),
-  );
-
-  if (undeleted.length) {
-    const ids = undeleted.map((record) => record.id);
-    ctx.action.mergeParams({
-      filter: {
-        id: {
-          $notIn: ids,
-        },
-      },
-    });
-
-    ctx.logger.error('[file-manager] some of attachment files are not successfully deleted: ', { ids });
-  }
-
-  await next();
-}

package/src/server/actions/index.ts

@@ -1,9 +0,0 @@
-import actions from '@nocobase/actions';
-import { createMiddleware, destroyMiddleware } from './attachments';
-
-export default function ({ app }) {
-  app.resourcer.use(createMiddleware);
-  app.resourcer.registerActionHandler('upload', actions.create);
-
-  app.resourcer.use(destroyMiddleware);
-}

package/src/server/collections/attachments.ts

@@ -1,65 +0,0 @@
-import { CollectionOptions } from '@nocobase/database';
-
-export default {
-  namespace: 'file-manager.attachmentRecords',
-  duplicator: 'optional',
-  name: 'attachments',
-  title: '文件管理器',
-  createdBy: true,
-  updatedBy: true,
-  template: 'file',
-  fields: [
-    {
-      comment: '用户文件名（不含扩展名）',
-      type: 'string',
-      name: 'title',
-    },
-    {
-      comment: '系统文件名（含扩展名）',
-      type: 'string',
-      name: 'filename',
-    },
-    {
-      comment: '扩展名（含“.”）',
-      type: 'string',
-      name: 'extname',
-    },
-    {
-      comment: '文件体积（字节）',
-      type: 'integer',
-      name: 'size',
-    },
-    // TODO: 使用暂不明确，以后再考虑
-    // {
-    //   comment: '文件类型（mimetype 前半段，通常用于预览）',
-    //   type: 'string',
-    //   name: 'type',
-    // },
-    {
-      type: 'string',
-      name: 'mimetype',
-    },
-    {
-      comment: '存储引擎',
-      type: 'belongsTo',
-      name: 'storage',
-    },
-    {
-      comment: '相对路径（含“/”前缀）',
-      type: 'string',
-      name: 'path',
-    },
-    {
-      comment: '其他文件信息（如图片的宽高）',
-      type: 'jsonb',
-      name: 'meta',
-      defaultValue: {},
-    },
-    {
-      comment: '网络访问地址',
-      type: 'string',
-      name: 'url',
-      // formula: '{{ storage.baseUrl }}{{ path }}/{{ filename }}'
-    },
-  ],
-} as CollectionOptions;

package/src/server/collections/storages.ts

@@ -1,65 +0,0 @@
-import { CollectionOptions } from '@nocobase/database';
-
-export default {
-  namespace: 'file-manager.storageSetting',
-  duplicator: 'optional',
-  name: 'storages',
-  title: '存储引擎',
-  fields: [
-    {
-      title: '存储引擎名称',
-      comment: '存储引擎名称',
-      type: 'string',
-      name: 'title',
-      translation: true,
-    },
-    {
-      title: '英文标识',
-      // comment: '英文标识，用于代码层面配置',
-      type: 'string',
-      name: 'name',
-      unique: true,
-    },
-    {
-      comment: '类型标识，如 local/ali-oss 等',
-      type: 'string',
-      name: 'type',
-    },
-    {
-      comment: '配置项',
-      type: 'jsonb',
-      name: 'options',
-      defaultValue: {},
-    },
-    {
-      comment: '文件规则',
-      type: 'jsonb',
-      name: 'rules',
-      defaultValue: {},
-    },
-    {
-      comment: '存储相对路径模板',
-      type: 'string',
-      name: 'path',
-      defaultValue: '',
-    },
-    {
-      comment: '访问地址前缀',
-      type: 'string',
-      name: 'baseUrl',
-      defaultValue: '',
-    },
-    // TODO(feature): 需要使用一个实现了可设置默认值的字段
-    {
-      comment: '默认引擎',
-      type: 'radio',
-      name: 'default',
-      defaultValue: false,
-    },
-    {
-      type: 'boolean',
-      name: 'paranoid',
-      defaultValue: false,
-    },
-  ],
-} as CollectionOptions;

package/src/server/constants.ts

@@ -1,8 +0,0 @@
-export const FILE_FIELD_NAME = 'file';
-export const LIMIT_FILES = 1;
-export const DEFAULT_MAX_FILE_SIZE = 1024 * 1024 * 1024;
-
-export const STORAGE_TYPE_LOCAL = 'local';
-export const STORAGE_TYPE_ALI_OSS = 'ali-oss';
-export const STORAGE_TYPE_S3 = 's3';
-export const STORAGE_TYPE_TX_COS = 'tx-cos';

package/src/server/index.ts

@@ -1,2 +0,0 @@
-export * from './constants';
-export { default } from './server';

package/src/server/rules/index.ts

@@ -1,3 +0,0 @@
-export { default as mimetype } from './mimetype';
-
-// TODO(feature): 提供注册新规则的方法，规则可动态添加

package/src/server/rules/mimetype.ts

@@ -1,5 +0,0 @@
-import match from 'mime-match';
-
-export default function (file, options: string | string[] = '*'): boolean {
-  return options.toString().split(',').some(match(file.mimetype));
-}

package/src/server/server.ts

@@ -1,79 +0,0 @@
-import { Plugin } from '@nocobase/server';
-import { resolve } from 'path';
-import initActions from './actions';
-import { STORAGE_TYPE_LOCAL } from './constants';
-import { getStorageConfig } from './storages';
-
-export { default as storageTypes } from './storages';
-
-export default class PluginFileManager extends Plugin {
-  storageType() {
-    return process.env.DEFAULT_STORAGE_TYPE ?? 'local';
-  }
-
-  async install() {
-    const defaultStorageConfig = getStorageConfig(this.storageType());
-
-    if (defaultStorageConfig) {
-      const Storage = this.db.getCollection('storages');
-      if (
-        await Storage.repository.findOne({
-          filter: {
-            name: defaultStorageConfig.defaults().name,
-          },
-        })
-      ) {
-        return;
-      }
-      await Storage.repository.create({
-        values: {
-          ...defaultStorageConfig.defaults(),
-          type: this.storageType(),
-          default: true,
-        },
-      });
-    }
-  }
-
-  async load() {
-    await this.importCollections(resolve(__dirname, './collections'));
-
-    this.app.acl.registerSnippet({
-      name: `pm.${this.name}.storages`,
-      actions: ['storages:*'],
-    });
-
-    initActions(this);
-
-    this.app.acl.allow('attachments', 'upload', 'loggedIn');
-    this.app.acl.allow('attachments', 'create', 'loggedIn');
-
-    // this.app.resourcer.use(uploadMiddleware);
-    // this.app.resourcer.use(createAction);
-    // this.app.resourcer.registerActionHandler('upload', uploadAction);
-
-    if (process.env.APP_ENV !== 'production') {
-      await getStorageConfig(STORAGE_TYPE_LOCAL).middleware!(this.app);
-    }
-
-    const defaultStorageName = getStorageConfig(this.storageType()).defaults().name;
-
-    this.app.acl.addFixedParams('storages', 'destroy', () => {
-      return {
-        filter: { 'name.$ne': defaultStorageName },
-      };
-    });
-
-    const ownMerger = () => {
-      return {
-        filter: {
-          createdById: '{{ctx.state.currentUser.id}}',
-        },
-      };
-    };
-
-    this.app.acl.addFixedParams('attachments', 'update', ownMerger);
-    this.app.acl.addFixedParams('attachments', 'create', ownMerger);
-    this.app.acl.addFixedParams('attachments', 'destroy', ownMerger);
-  }
-}

package/src/server/storages/index.ts

@@ -1,46 +0,0 @@
-import { StorageEngine } from 'multer';
-import Application from '@nocobase/server';
-import { Registry } from '@nocobase/utils';
-
-import local from './local';
-import oss from './ali-oss';
-import s3 from './s3';
-import cos from './tx-cos';
-
-import { STORAGE_TYPE_LOCAL, STORAGE_TYPE_ALI_OSS, STORAGE_TYPE_S3, STORAGE_TYPE_TX_COS } from '../constants';
-
-export interface StorageModel {
-  title: string;
-  type: string;
-  name: string;
-  baseUrl: string;
-  options: { [key: string]: string };
-  deleteFileOnDestroy?: boolean;
-}
-
-export interface AttachmentModel {
-  title: string;
-  filename: string;
-  path: string;
-}
-
-export interface IStorage {
-  filenameKey?: string;
-  middleware?(app: Application): void;
-  getFileData?(file: { [key: string]: any }): { [key: string]: any };
-  make(storage: StorageModel): StorageEngine;
-  defaults(): StorageModel;
-  delete(storage: StorageModel, records: AttachmentModel[]): Promise<[number, AttachmentModel[]]>;
-}
-
-const storageTypes = new Registry<IStorage>();
-storageTypes.register(STORAGE_TYPE_LOCAL, local);
-storageTypes.register(STORAGE_TYPE_ALI_OSS, oss);
-storageTypes.register(STORAGE_TYPE_S3, s3);
-storageTypes.register(STORAGE_TYPE_TX_COS, cos);
-
-export function getStorageConfig(key: string): IStorage {
-  return storageTypes.get(key);
-}
-
-export default storageTypes;