tachybase_todo/packages/plugins/@nocobase/plugin-verification/src/server/Plugin.ts
jack zhang 705b7449f0
feat: new plugin manager, supports adding plugins through UI (#2430)
* refactor: plugin manager page

* fix: bug

* feat: addByNpm api

* fix: improve the addByNpm

* feat: improve applicationPlugins:list api

* fix: re-download npm package when restart app

* fix: plugin delete api

* feat: plugin detail api

* feat: zipUrl add api

* fix: upload api bug

* fix: plugin detail info

* feat: upgrade api

* fix: upload api

* feat: handle plugin load error

* feat: support authToken

* feat: muti lang

* fix: build error

* fix: self review

* Update plugin-manager.ts

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bugs

* fix: detail click and remove isOfficial

* fix: upgrade no refresh

* fix: file size and type check

* fix: bug

* fix: upgrade error

* fix: bug

* fix: bug

* fix: plugin card layout

* fix: handling exceptional cases

* fix: tgz file support

* fix: macos compress file

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: add upgrade npm type

* fix: bugs

* fix: bug

* fix: change plugins static expose url

* fix: api prefix

* fix: bug

* fix: add nginx `/static/plugin/` path

* fix: bugs and pr docker build no dts

* fix: bug

* fix: build tools bug

* fix: improve code

* fix: build bug

* feat: improve plugin info

* fix: ui bug

* fix: plugin document bug

* feat: improve code

* feat: improve code

* feat: process dev deps check

* feat: improve code

* feat: process.env.IS_DEV_CMD

* fix: do not delete the plugin package

* feat: plugin symlink

* fix: tsx watch --ignore=./storage/plugins/**

* fix: test error

* fix: improve code

* fix: improve code

* fix: emitStartedEvent

* fix: improve code

* fix: type error

* fix: test error

* test: console.log

* fix: createStoragePluginSymLink

* fix: clientStaticMiddleware rename to clientStaticUtils

* feat: build tools support plugins folder

* fix: 350px

* fix: error

* feat: client dev support plugin folder

* fix: clear cli options

* fix: typeError: Converting circular structure to JSON

* fix: plugin name

* chore: restart application after command

* feat: upgrade error & docs

* Update v14-changelog.md

* Update v14-changelog.md

* Update v14-changelog.md

* fix: gateway test

* refactor(plugin-workflow): add ready state for gracefully tearing down

* Revert "chore: restart application after command"

This reverts commit 5015274f8e4e06e506e15754b672330330e8c7f8.

* chore: stop application whe restart

* T 1218 change plugin folder (#2629)

* feat: change folder name

* feat: change `pm create` command

* feat:  revert plugin name change

* fix: delete samples

* feat: change plugins folder

* fix: pm create

* feat: update docs

* fix: link package error

* fix: docs

* fix: create command

* fix: pm add error

* fix: create  add build

* fix: pm creatre + add

* feat: add tar command

* fix: docs

* fix: bug

* fix: docs

---------

Co-authored-by: chenos <chenlinxh@gmail.com>

* feat: docs

* Update your-fisrt-plugin.md

* Update your-fisrt-plugin.md

* chore: application reload

* chore: test

* fix: pm add error

* chore: preset install skip exists plugin

* fix: createIfNotExists

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
Co-authored-by: chareice <chareice@live.com>
Co-authored-by: Zhou <zhou.working@gmail.com>
Co-authored-by: mytharcher <mytharcher@gmail.com>
2023-09-12 22:39:23 +08:00

163 lines
4.4 KiB
TypeScript

import path from 'path';
import { Context } from '@nocobase/actions';
import { Op } from '@nocobase/database';
import { HandlerType } from '@nocobase/resourcer';
import { Plugin } from '@nocobase/server';
import { Registry } from '@nocobase/utils';
import { namespace } from '.';
import initActions from './actions';
import { CODE_STATUS_UNUSED, CODE_STATUS_USED, PROVIDER_TYPE_SMS_ALIYUN } from './constants';
import { zhCN } from './locale';
import initProviders, { Provider } from './providers';
export interface Interceptor {
manual?: boolean;
expiresIn?: number;
getReceiver(ctx): string;
getCode?(ctx): string;
validate?(ctx: Context, receiver: string): boolean | Promise<boolean>;
}
export default class VerificationPlugin extends Plugin {
providers: Registry<typeof Provider> = new Registry();
interceptors: Registry<Interceptor> = new Registry();
intercept: HandlerType = async (context, next) => {
const { resourceName, actionName, values } = context.action.params;
const key = `${resourceName}:${actionName}`;
const interceptor = this.interceptors.get(key);
if (!interceptor) {
return context.throw(400);
}
const receiver = interceptor.getReceiver(context);
const content = interceptor.getCode ? interceptor.getCode(context) : values.code;
if (!receiver || !content) {
return context.throw(400);
}
// check if code match, then call next
// find the code based on action params
const VerificationRepo = this.db.getRepository('verifications');
const item = await VerificationRepo.findOne({
filter: {
receiver,
type: key,
content,
expiresAt: {
[Op.gt]: new Date(),
},
status: CODE_STATUS_UNUSED,
},
});
if (!item) {
return context.throw(400, {
code: 'InvalidVerificationCode',
message: context.t('Verification code is invalid', { ns: namespace }),
});
}
// TODO: code should be removed if exists in values
// context.action.mergeParams({
// values: {
// }
// });
try {
await next();
} finally {
// or delete
await item.update({
status: CODE_STATUS_USED,
});
}
};
async install() {
const {
DEFAULT_SMS_VERIFY_CODE_PROVIDER,
INIT_ALI_SMS_ACCESS_KEY,
INIT_ALI_SMS_ACCESS_KEY_SECRET,
INIT_ALI_SMS_ENDPOINT = 'dysmsapi.aliyuncs.com',
INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
INIT_ALI_SMS_VERIFY_CODE_SIGN,
} = process.env;
if (
DEFAULT_SMS_VERIFY_CODE_PROVIDER &&
INIT_ALI_SMS_ACCESS_KEY &&
INIT_ALI_SMS_ACCESS_KEY_SECRET &&
INIT_ALI_SMS_VERIFY_CODE_TEMPLATE &&
INIT_ALI_SMS_VERIFY_CODE_SIGN
) {
const ProviderRepo = this.db.getRepository('verifications_providers');
const existed = await ProviderRepo.count({
filterByTk: DEFAULT_SMS_VERIFY_CODE_PROVIDER,
});
if (existed) {
return;
}
await ProviderRepo.create({
values: {
id: DEFAULT_SMS_VERIFY_CODE_PROVIDER,
type: PROVIDER_TYPE_SMS_ALIYUN,
title: 'Default SMS sender',
options: {
accessKeyId: INIT_ALI_SMS_ACCESS_KEY,
accessKeySecret: INIT_ALI_SMS_ACCESS_KEY_SECRET,
endpoint: INIT_ALI_SMS_ENDPOINT,
sign: INIT_ALI_SMS_VERIFY_CODE_SIGN,
template: INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
},
default: true,
},
});
}
}
async load() {
const { app, db, options } = this;
app.i18n.addResources('zh-CN', namespace, zhCN);
await this.importCollections(path.resolve(__dirname, 'collections'));
initProviders(this);
initActions(this);
// add middleware to action
app.resourcer.use(async (context, next) => {
const { resourceName, actionName, values } = context.action.params;
const key = `${resourceName}:${actionName}`;
const interceptor = this.interceptors.get(key);
if (!interceptor || interceptor.manual) {
return next();
}
return this.intercept(context, next);
});
app.acl.allow('verifications', 'create', 'public');
this.app.acl.registerSnippet({
name: `pm.${this.name}.providers`,
actions: ['verifications_providers:*'],
});
}
async getDefault() {
const providerRepo = this.db.getRepository('verifications_providers');
return providerRepo.findOne({
filter: {
default: true,
},
});
}
}