Skip to content

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.

feat(plugin): Add plugin config repo

LinkinStar8d0bd2be20cd
diff --git a/cmd/answer/wire_gen.go b/cmd/answer/wire_gen.go
index 7b5001fa..1df8e810 100644
--- a/cmd/answer/wire_gen.go
+++ b/cmd/answer/wire_gen.go
@@ -28,6 +28,7 @@ import (
"github.com/answerdev/answer/internal/repo/export"
"github.com/answerdev/answer/internal/repo/meta"
"github.com/answerdev/answer/internal/repo/notification"
+ "github.com/answerdev/answer/internal/repo/plugin_config"
"github.com/answerdev/answer/internal/repo/question"
"github.com/answerdev/answer/internal/repo/rank"
"github.com/answerdev/answer/internal/repo/reason"
@@ -58,6 +59,7 @@ import (
notification2 "github.com/answerdev/answer/internal/service/notification"
"github.com/answerdev/answer/internal/service/notification_common"
"github.com/answerdev/answer/internal/service/object_info"
+ "github.com/answerdev/answer/internal/service/plugin_common"
"github.com/answerdev/answer/internal/service/question_common"
rank2 "github.com/answerdev/answer/internal/service/rank"
reason2 "github.com/answerdev/answer/internal/service/reason"
@@ -206,7 +208,9 @@ func initApplication(debug bool, serverConf *conf.Server, dbConf *data.Database,
activityService := activity2.NewActivityService(activityActivityRepo, userCommon, activityCommon, tagCommonService, objService, commentCommonService, revisionService, metaService)
activityController := controller.NewActivityController(activityCommon, activityService)
roleController := controller_admin.NewRoleController(roleService)
- pluginController := controller_admin.NewPluginController()
+ pluginConfigRepo := plugin_config.NewPluginConfigRepo(dataData)
+ pluginCommonService := plugin_common.NewPluginCommonService(pluginConfigRepo, configRepo)
+ pluginController := controller_admin.NewPluginController(pluginCommonService)
answerAPIRouter := router.NewAnswerAPIRouter(langController, userController, commentController, reportController, voteController, tagController, followController, collectionController, questionController, answerController, searchController, revisionController, rankController, controller_adminReportController, userAdminController, reasonController, themeController, siteInfoController, siteinfoController, notificationController, dashboardController, uploadController, activityController, roleController, pluginController)
swaggerRouter := router.NewSwaggerRouter(swaggerConf)
uiRouter := router.NewUIRouter(siteinfoController, siteInfoCommonService)
diff --git a/internal/base/constant/config_key.go b/internal/base/constant/config_key.go
new file mode 100644
index 00000000..a184badf
--- /dev/null
+++ b/internal/base/constant/config_key.go
@@ -0,0 +1,5 @@
+package constant
+
+const (
+ PluginStatus = "plugin.status"
+)
diff --git a/internal/controller_admin/plugin_controller.go b/internal/controller_admin/plugin_controller.go
index e7ddf3e2..d22d11d8 100644
--- a/internal/controller_admin/plugin_controller.go
+++ b/internal/controller_admin/plugin_controller.go
@@ -6,16 +6,18 @@ import (
"github.com/answerdev/answer/internal/base/handler"
"github.com/answerdev/answer/internal/plugin"
"github.com/answerdev/answer/internal/schema"
+ "github.com/answerdev/answer/internal/service/plugin_common"
"github.com/gin-gonic/gin"
)
// PluginController role controller
type PluginController struct {
+ PluginCommonService *plugin_common.PluginCommonService
}
// NewPluginController new controller
-func NewPluginController() *PluginController {
- return &PluginController{}
+func NewPluginController(PluginCommonService *plugin_common.PluginCommonService) *PluginController {
+ return &PluginController{PluginCommonService: PluginCommonService}
}
// GetPluginList get plugin list
@@ -106,7 +108,8 @@ func (pc *PluginController) UpdatePluginStatus(ctx *gin.Context) {
}
plugin.StatusManager.Enable(req.PluginSlugName, req.Enabled)
- handler.HandleResponse(ctx, nil, nil)
+ err := pc.PluginCommonService.UpdatePluginStatus(ctx)
+ handler.HandleResponse(ctx, err, nil)
}
// GetPluginConfig get plugin config
@@ -186,5 +189,11 @@ func (pc *PluginController) UpdatePluginConfig(ctx *gin.Context) {
}
return nil
})
+ if err != nil {
+ handler.HandleResponse(ctx, err, nil)
+ return
+ }
+
+ err = pc.PluginCommonService.UpdatePluginConfig(ctx, req)
handler.HandleResponse(ctx, err, nil)
}
diff --git a/internal/entity/plugin_config_entity.go b/internal/entity/plugin_config_entity.go
new file mode 100644
index 00000000..f8260069
--- /dev/null
+++ b/internal/entity/plugin_config_entity.go
@@ -0,0 +1,13 @@
+package entity
+
+// PluginConfig plugin config
+type PluginConfig struct {
+ ID int `xorm:"not null pk autoincr INT(11) id"`
+ PluginSlugName string `xorm:"unique VARCHAR(128) plugin_slug_name"`
+ Value string `xorm:"TEXT value"`
+}
+
+// TableName config table name
+func (PluginConfig) TableName() string {
+ return "plugin_config"
+}
diff --git a/internal/migrations/init.go b/internal/migrations/init.go
index dad2028a..8f98b45e 100644
--- a/internal/migrations/init.go
+++ b/internal/migrations/init.go
@@ -50,6 +50,7 @@ var tables = []interface{}{
&entity.RolePowerRel{},
&entity.Power{},
&entity.UserRoleRel{},
+ &entity.PluginConfig{},
}
// InitDB init db
@@ -344,6 +345,7 @@ func initConfigTable(engine *xorm.Engine) error {
{ID: 115, Key: "rank.question.close", Value: `-1`},
{ID: 116, Key: "rank.question.reopen", Value: `-1`},
{ID: 117, Key: "rank.tag.use_reserved_tag", Value: `-1`},
+ {ID: 118, Key: "plugin.status", Value: `{}`},
}
_, err := engine.Insert(defaultConfigTable)
return err
diff --git a/internal/migrations/migrations.go b/internal/migrations/migrations.go
index bbe0a958..b67bd77d 100644
--- a/internal/migrations/migrations.go
+++ b/internal/migrations/migrations.go
@@ -55,6 +55,7 @@ var migrations = []Migration{
NewMigration("add activity timeline", addActivityTimeline, false),
NewMigration("add user role", addRoleFeatures, false),
NewMigration("add theme and private mode", addThemeAndPrivateMode, true),
+ NewMigration("add plugin", addPlugin, false),
}
// GetCurrentDBVersion returns the current db version
diff --git a/internal/migrations/v6.go b/internal/migrations/v6.go
new file mode 100644
index 00000000..2faf6389
--- /dev/null
+++ b/internal/migrations/v6.go
@@ -0,0 +1,34 @@
+package migrations
+
+import (
+ "fmt"
+
+ "github.com/answerdev/answer/internal/entity"
+ "github.com/segmentfault/pacman/log"
+ "xorm.io/xorm"
+)
+
+func addPlugin(x *xorm.Engine) error {
+ defaultConfigTable := []*entity.Config{
+ {ID: 118, Key: "plugin.status", Value: `{}`},
+ }
+ for _, c := range defaultConfigTable {
+ exist, err := x.Get(&entity.Config{ID: c.ID, Key: c.Key})
+ if err != nil {
+ return fmt.Errorf("get config failed: %w", err)
+ }
+ if exist {
+ if _, err = x.Update(c, &entity.Config{ID: c.ID, Key: c.Key}); err != nil {
+ log.Errorf("update %+v config failed: %s", c, err)
+ return fmt.Errorf("update config failed: %w", err)
+ }
+ continue
+ }
+ if _, err = x.Insert(&entity.Config{ID: c.ID, Key: c.Key, Value: c.Value}); err != nil {
+ log.Errorf("insert %+v config failed: %s", c, err)
+ return fmt.Errorf("add config failed: %w", err)
+ }
+ }
+
+ return x.Sync(new(entity.PluginConfig))
+}
diff --git a/internal/repo/plugin_config/plugin_config_repo.go b/internal/repo/plugin_config/plugin_config_repo.go
new file mode 100644
index 00000000..d615577f
--- /dev/null
+++ b/internal/repo/plugin_config/plugin_config_repo.go
@@ -0,0 +1,49 @@
+package plugin_config
+
+import (
+ "context"
+
+ "github.com/answerdev/answer/internal/base/data"
+ "github.com/answerdev/answer/internal/base/reason"
+ "github.com/answerdev/answer/internal/entity"
+ "github.com/answerdev/answer/internal/service/plugin_common"
+ "github.com/segmentfault/pacman/errors"
+)
+
+type pluginConfigRepo struct {
+ data *data.Data
+}
+
+// NewPluginConfigRepo new repository
+func NewPluginConfigRepo(data *data.Data) plugin_common.PluginConfigRepo {
+ return &pluginConfigRepo{
+ data: data,
+ }
+}
+
+func (ur *pluginConfigRepo) SavePluginConfig(ctx context.Context, pluginSlugName, configValue string) (err error) {
+ old := &entity.PluginConfig{PluginSlugName: pluginSlugName}
+ exist, err := ur.data.DB.Get(old)
+ if err != nil {
+ return errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+ }
+ if exist {
+ old.Value = configValue
+ _, err = ur.data.DB.ID(old.ID).Update(old)
+ } else {
+ _, err = ur.data.DB.InsertOne(&entity.PluginConfig{PluginSlugName: pluginSlugName, Value: configValue})
+ }
+ if err != nil {
+ return errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+ }
+ return nil
+}
+
+func (ur *pluginConfigRepo) GetPluginConfigAll(ctx context.Context) (pluginConfigs []*entity.PluginConfig, err error) {
+ pluginConfigs = make([]*entity.PluginConfig, 0)
+ err = ur.data.DB.Find(&pluginConfigs)
+ if err != nil {
+ err = errors.InternalServer(reason.DatabaseError).WithError(err).WithStack()
+ }
+ return pluginConfigs, err
+}
diff --git a/internal/repo/provider.go b/internal/repo/provider.go
index 2064d11b..b0dc6f8a 100644
--- a/internal/repo/provider.go
+++ b/internal/repo/provider.go
@@ -14,6 +14,7 @@ import (
"github.com/answerdev/answer/internal/repo/export"
"github.com/answerdev/answer/internal/repo/meta"
"github.com/answerdev/answer/internal/repo/notification"
+ "github.com/answerdev/answer/internal/repo/plugin_config"
"github.com/answerdev/answer/internal/repo/question"
"github.com/answerdev/answer/internal/repo/rank"
"github.com/answerdev/answer/internal/repo/reason"
@@ -74,4 +75,5 @@ var ProviderSetRepo = wire.NewSet(
role.NewRolePowerRelRepo,
role.NewPowerRepo,
user_external_login.NewUserExternalLoginRepo,
+ plugin_config.NewPluginConfigRepo,
)
diff --git a/internal/service/plugin_common/plugin_common_service.go b/internal/service/plugin_common/plugin_common_service.go
index 83726334..00d58c94 100644
--- a/internal/service/plugin_common/plugin_common_service.go
+++ b/internal/service/plugin_common/plugin_common_service.go
@@ -1,3 +1,80 @@
package plugin_common
-type PluginConfig struct{}
+import (
+ "context"
+ "encoding/json"
+
+ "github.com/answerdev/answer/internal/base/constant"
+ "github.com/answerdev/answer/internal/base/reason"
+ "github.com/answerdev/answer/internal/entity"
+ "github.com/answerdev/answer/internal/plugin"
+ "github.com/answerdev/answer/internal/schema"
+ "github.com/answerdev/answer/internal/service/config"
+ "github.com/segmentfault/pacman/errors"
+ "github.com/segmentfault/pacman/log"
+)
+
+type PluginConfigRepo interface {
+ SavePluginConfig(ctx context.Context, pluginSlugName, configValue string) (err error)
+ GetPluginConfigAll(ctx context.Context) (pluginConfigs []*entity.PluginConfig, err error)
+}
+
+// PluginCommonService user service
+type PluginCommonService struct {
+ configRepo config.ConfigRepo
+ PluginConfigRepo PluginConfigRepo
+}
+
+// NewPluginCommonService new report service
+func NewPluginCommonService(
+ PluginConfigRepo PluginConfigRepo,
+ configRepo config.ConfigRepo) *PluginCommonService {
+
+ // init plugin status
+ pluginStatus, err := configRepo.GetString(constant.PluginStatus)
+ if err != nil {
+ log.Error(err)
+ } else {
+ if err := plugin.StatusManager.UnmarshalJSON([]byte(pluginStatus)); err != nil {
+ log.Error(err)
+ }
+ }
+
+ // init plugin config
+ pluginConfigs, err := PluginConfigRepo.GetPluginConfigAll(context.Background())
+ if err != nil {
+ log.Error(err)
+ } else {
+ for _, pluginConfig := range pluginConfigs {
+ err := plugin.CallConfig(func(fn plugin.Config) error {
+ if fn.Info().SlugName == pluginConfig.PluginSlugName {
+ return fn.ConfigReceiver([]byte(pluginConfig.Value))
+ }
+ return nil
+ })
+ if err != nil {
+ log.Errorf("parse plugin config failed: %s %v", pluginConfig.PluginSlugName, err)
+ }
+ }
+ }
+
+ return &PluginCommonService{
+ configRepo: configRepo,
+ PluginConfigRepo: PluginConfigRepo,
+ }
+}
+
+// UpdatePluginStatus update plugin status
+func (ps *PluginCommonService) UpdatePluginStatus(ctx context.Context) (err error) {
+ content, err := plugin.StatusManager.MarshalJSON()
+ if err != nil {
+ return errors.InternalServer(reason.UnknownError).WithError(err)
+ }
+ return ps.configRepo.SetConfig(constant.PluginStatus, string(content))
+}
+
+// UpdatePluginConfig update plugin config
+func (ps *PluginCommonService) UpdatePluginConfig(ctx context.Context, req *schema.UpdatePluginConfigReq) (err error) {
+ configValue, _ := json.Marshal(req.ConfigFields)
+ return ps.PluginConfigRepo.SavePluginConfig(ctx, req.PluginSlugName, string(configValue))
+}
diff --git a/internal/service/provider.go b/internal/service/provider.go
index 1ea813c1..bf7541af 100644
--- a/internal/service/provider.go
+++ b/internal/service/provider.go
@@ -16,6 +16,7 @@ import (
"github.com/answerdev/answer/internal/service/notification"
notficationcommon "github.com/answerdev/answer/internal/service/notification_common"
"github.com/answerdev/answer/internal/service/object_info"
+ "github.com/answerdev/answer/internal/service/plugin_common"
questioncommon "github.com/answerdev/answer/internal/service/question_common"
"github.com/answerdev/answer/internal/service/rank"
"github.com/answerdev/answer/internal/service/reason"
@@ -81,4 +82,5 @@ var ProviderSetService = wire.NewSet(
role.NewUserRoleRelService,
role.NewRolePowerRelService,
user_external_login.NewUserExternalLoginService,
+ plugin_common.NewPluginCommonService,
)