Feat actiontech/dms-ee/issues/125: plugin interface define

Author: wangyue

driver_v2.pb.go

@@ -577,6 +577,10 @@ func (i *MysqlDriverImpl) getPrimaryKey(stmt *ast.CreateTableStmt) (map[string]s
 	return pkColumnsName, hasPk, nil
 }
 
+func (i *MysqlDriverImpl) GetSQLOp(ctx context.Context, sqls string) ([]*driverV2.SQLObjectOps, error) {
+	return nil, fmt.Errorf("not implement yet")
+}
+
 type PluginProcessor struct{}
 
 func (p *PluginProcessor) GetDriverMetas() (*driverV2.DriverMetas, error) {

sqle/driver/mysql/mysql.go

@@ -314,3 +314,7 @@ func (p *PluginImplV1) GetTableMetaBySQL(ctx context.Context, conf *GetTableMeta
 func (p *PluginImplV1) EstimateSQLAffectRows(ctx context.Context, sql string) (*driverV2.EstimatedAffectRows, error) {
 	return nil, NewErrPluginAPINotImplement(driverV2.OptionalModuleEstimateSQLAffectRows)
 }
+
+func (p *PluginImplV1) GetSQLOp(ctx context.Context, sqls string) ([]*driverV2.SQLObjectOps, error) {
+	return nil, NewErrPluginAPINotImplement(driverV2.OptionalModuleProvision)
+}

sqle/driver/plugin_adapter_v1.go

@@ -485,6 +485,22 @@ func (s *PluginImplV2) EstimateSQLAffectRows(ctx context.Context, sql string) (*
 	}, nil
 }
 
+func (s *PluginImplV2) GetSQLOp(ctx context.Context, sqls string) ([]*driverV2.SQLObjectOps, error) {
+	api := "GetSQLOp"
+	s.preLog(api)
+	resp, err := s.client.GetSQLOp(ctx, &protoV2.GetSQLOpRequest{
+		Session: s.Session,
+		SqlText: &protoV2.GetSQLOpSQL{
+			Sql: sqls,
+		},
+	})
+	s.afterLog(api, err)
+	if err != nil {
+		return nil, err
+	}
+	return driverV2.ConvertProtoSQLOpsResponseToDriver(resp)
+}
+
 type dbDriverResult struct {
 	lastInsertId    int64
 	lastInsertIdErr string

sqle/driver/plugin_adapter_v2.go

@@ -40,6 +40,10 @@ type Plugin interface {
 
 	// Introduced from v2.2304.0
 	EstimateSQLAffectRows(ctx context.Context, sql string) (*driverV2.EstimatedAffectRows, error)
+
+	// 权限相关接口，目前用于provision的权限校验
+	// GetSqlOp 获取sql中涉及的对象操作，sql可以是单条语句，也可以是多条语句
+	GetSQLOp(ctx context.Context, sqls string) ([]*driverV2.SQLObjectOps, error)
 }
 
 type PluginProcessor interface {

sqle/driver/plugin_interface.go

@@ -449,3 +449,18 @@ func (d *DriverGrpcServer) KillProcess(ctx context.Context, req *protoV2.KillPro
 		ErrMessage: info.ErrMessage,
 	}, nil
 }
+
+func (d *DriverGrpcServer) GetSQLOp(ctx context.Context, req *protoV2.GetSQLOpRequest) (*protoV2.GetSQLOpResponse, error) {
+	driver, err := d.getDriverBySession(req.Session)
+	if err != nil {
+		return &protoV2.GetSQLOpResponse{}, err
+	}
+	if req.GetSqlText() == nil {
+		return &protoV2.GetSQLOpResponse{}, ErrSQLisEmpty
+	}
+	ops, err := driver.GetSQLOp(ctx, req.GetSqlText().Sql)
+	if err != nil {
+		return &protoV2.GetSQLOpResponse{}, err
+	}
+	return ConvertDriverSQLOpsResponseToProto(ops)
+}

sqle/driver/v2/driver_grpc_server.go

@@ -88,6 +88,10 @@ type Driver interface {
 	ExtractTableFromSQL(ctx context.Context, sql string) ([]*Table, error)
 	EstimateSQLAffectRows(ctx context.Context, sql string) (*EstimatedAffectRows, error)
 	KillProcess(ctx context.Context) (*KillProcessInfo, error)
+
+	// 权限相关接口，目前用于provision的权限校验
+	// GetSQLOp 获取sql中涉及的对象操作，sql可以是单条语句，也可以是多条语句
+	GetSQLOp(ctx context.Context, sqls string) ([]*SQLObjectOps, error)
 }
 
 type Node struct {
@@ -304,3 +308,49 @@ func NewKillProcessInfo(errorMessage string) *KillProcessInfo {
 type RuleKnowledge struct {
 	Content string
 }
+
+type SQLObjectOps struct {
+	// ObjectOps 表示sql中涉及的对象及对对象的操作
+	ObjectOps []*SQLObjectOp
+	Sql       SQLInfo
+}
+
+type SQLObjectOp struct {
+	Op     SQLOp      // 对象操作
+	Object *SQLObject // 对象
+}
+
+type SQLObject struct {
+	// Type 表示对象的类型
+	Type SQLObjectType
+	// SchemaName 表示对象所在的库名，若对象不属于库，或无法从Sql中解析出当前库，则为空字符串
+	SchemaName string
+	// TableName 表示对象的表名，如果对象不是表，则为空字符串
+	TableName string
+}
+
+type SQLObjectType string
+
+const (
+	SQLObjectTypeTable    SQLObjectType = "Table"
+	SQLObjectTypeSchema   SQLObjectType = "Schema"
+	SQLObjectTypeInstance SQLObjectType = "Instance"
+)
+
+type SQLInfo struct {
+	Sql string
+}
+type SQLOp string
+
+const (
+	// 增或改操作
+	SQLOpAddOrUpdate SQLOp = "AddOrUpdate"
+	// 读取操作
+	SQLOpRead SQLOp = "Read"
+	// 删除操作
+	SQLOpDelete SQLOp = "Delete"
+	// 授权操作
+	SQLOpGrant SQLOp = "Grant"
+	// 高权限操作，如锁表、导出表到文件等
+	SQLOpAdmin SQLOp = "Admin"
+)