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): plugin internationalization
LinkinStarsb229d12bb4a6
diff --git a/cmd/command.go b/cmd/command.goindex 24284242..bfcb1414 100644--- a/cmd/command.go+++ b/cmd/command.go@@ -199,7 +199,7 @@ To run answer, use:Run: func(_ *cobra.Command, _ []string) {_ = plugin.CallBase(func(base plugin.Base) error {info := base.Info()- fmt.Printf("%s[%s] made by %s\n", info.Name, info.Version, info.Author)+ fmt.Printf("%s[%s] made by %s\n", info.SlugName, info.Version, info.Author)return nil})},diff --git a/internal/base/translator/provider.go b/internal/base/translator/provider.goindex bff57486..0991037f 100644--- a/internal/base/translator/provider.go+++ b/internal/base/translator/provider.go@@ -56,6 +56,7 @@ func NewTranslator(c *I18n) (tr i18n.Translator, err error) {originalTr := struct {Backend map[string]map[string]interface{} `yaml:"backend"`UI map[string]interface{} `yaml:"ui"`+ Plugin map[string]interface{} `yaml:"plugin"`}{}if err = yaml.Unmarshal(buf, &originalTr); err != nil {return nil, err@@ -66,6 +67,7 @@ func NewTranslator(c *I18n) (tr i18n.Translator, err error) {}translation["backend"] = originalTr.Backendtranslation["ui"] = originalTr.UI+ translation["plugin"] = originalTr.Plugincontent, err := yaml.Marshal(translation)if err != nil {diff --git a/internal/cli/build.go b/internal/cli/build.goindex 515359a7..cd01d491 100644--- a/internal/cli/build.go+++ b/internal/cli/build.go@@ -15,7 +15,8 @@ import ("github.com/answerdev/answer/pkg/dir""github.com/answerdev/answer/pkg/writer""github.com/answerdev/answer/ui"- cp "github.com/otiai10/copy"+ "github.com/segmentfault/pacman/log"+ "gopkg.in/yaml.v3")const (@@ -100,6 +101,7 @@ func BuildNewAnswer(outputPath string, plugins []string, originalAnswerInfo Origbuilder := newAnswerBuilder(outputPath, plugins, originalAnswerInfo)builder.DoTask(createMainGoFile)builder.DoTask(downloadGoModFile)+ builder.DoTask(mergeI18nFiles)builder.DoTask(replaceNecessaryFile)builder.DoTask(buildBinary)builder.DoTask(cleanByproduct)@@ -126,19 +128,19 @@ func createMainGoFile(b *buildingMaterial) (err error) {}var (- localPlugins []string+ //localPlugins []stringremotePlugins []string)for _, p := range b.plugins {- if len(p.Path) == 0 {- remotePlugins = append(remotePlugins, versionedModulePath(p.Name, p.Version))- } else {- localPluginDir := filepath.Base(p.Path)- localPlugins = append(localPlugins, localPluginDir)- if err := cp.Copy(p.Path, filepath.Join(b.tmpDir, localPluginDir)); err != nil {- return err- }- }+ //if len(p.Path) == 0 {+ remotePlugins = append(remotePlugins, versionedModulePath(p.Name, p.Version))+ //} else {+ //localPluginDir := filepath.Base(p.Path)+ //localPlugins = append(localPlugins, localPluginDir)+ //if err := cp.Copy(p.Path, filepath.Join(b.tmpDir, localPluginDir)); err != nil {+ // return err+ //}+ //}}mainGoFile := &bytes.Buffer{}@@ -148,7 +150,7 @@ func createMainGoFile(b *buildingMaterial) (err error) {}err = tmpl.Execute(mainGoFile, map[string]any{"remote_plugins": remotePlugins,- "local_plugins": localPlugins,+ //"local_plugins": localPlugins,})if err != nil {return err@@ -163,6 +165,17 @@ func createMainGoFile(b *buildingMaterial) (err error) {if err != nil {return err}++ for _, p := range b.plugins {+ if len(p.Path) == 0 {+ continue+ }+ replacement := fmt.Sprintf("%s@v%s=%s", p.Name, p.Version, p.Path)+ err = b.newExecCmd("go", "mod", "edit", "-replace", replacement).Run()+ if err != nil {+ return err+ }+ }return}@@ -195,6 +208,93 @@ func replaceNecessaryFile(b *buildingMaterial) (err error) {return err}+func mergeI18nFiles(b *buildingMaterial) (err error) {+ fmt.Printf("try to merge i18n files\n")++ type YamlPluginContent struct {+ Plugin map[string]any `yaml:"plugin"`+ }++ pluginAllTranslations := make(map[string]*YamlPluginContent)+ for _, plugin := range b.plugins {+ i18nDir := filepath.Join(b.tmpDir, fmt.Sprintf("vendor/%s/i18n", plugin.Name))+ fmt.Println("i18n dir: ", i18nDir)+ if !dir.CheckDirExist(i18nDir) {+ continue+ }++ entries, err := os.ReadDir(i18nDir)+ if err != nil {+ return err+ }++ for _, file := range entries {+ // ignore directory+ if file.IsDir() {+ continue+ }+ // ignore non-YAML file+ if filepath.Ext(file.Name()) != ".yaml" {+ continue+ }+ buf, err := os.ReadFile(filepath.Join(i18nDir, file.Name()))+ if err != nil {+ log.Debugf("read translation file failed: %s %s", file.Name(), err)+ continue+ }++ translation := &YamlPluginContent{}+ if err = yaml.Unmarshal(buf, translation); err != nil {+ log.Debugf("unmarshal translation file failed: %s %s", file.Name(), err)+ continue+ }++ if pluginAllTranslations[file.Name()] == nil {+ pluginAllTranslations[file.Name()] = &YamlPluginContent{Plugin: make(map[string]any)}+ }+ for k, v := range translation.Plugin {+ pluginAllTranslations[file.Name()].Plugin[k] = v+ }+ }+ }++ originalI18nDir := filepath.Join(b.tmpDir, "vendor/github.com/answerdev/answer/i18n")+ entries, err := os.ReadDir(originalI18nDir)+ if err != nil {+ return err+ }++ for _, file := range entries {+ // ignore directory+ if file.IsDir() {+ continue+ }+ // ignore non-YAML file+ filename := file.Name()+ if filepath.Ext(filename) != ".yaml" && filename != "i18n.yaml" {+ continue+ }++ // if plugin don't have this translation file, ignore it+ if pluginAllTranslations[filename] == nil {+ continue+ }++ out, _ := yaml.Marshal(pluginAllTranslations[filename])++ buf, err := os.OpenFile(filepath.Join(originalI18nDir, filename), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)+ if err != nil {+ log.Debugf("read translation file failed: %s %s", filename, err)+ continue+ }++ _, _ = buf.WriteString("\n")+ _, _ = buf.Write(out)+ _ = buf.Close()+ }+ return err+}+func copyDirEntries(sourceFs embed.FS, sourceDir string, targetDir string) (err error) {entries, err := ui.Build.ReadDir(sourceDir)if err != nil {diff --git a/internal/controller/connector_controller.go b/internal/controller/connector_controller.goindex a736760c..fcdf6e70 100644--- a/internal/controller/connector_controller.go+++ b/internal/controller/connector_controller.go@@ -115,7 +115,7 @@ func (cc *ConnectorController) ConnectorsInfo(ctx *gin.Context) {resp := make([]*schema.ConnectorInfoResp, 0)_ = plugin.CallConnector(func(fn plugin.Connector) error {resp = append(resp, &schema.ConnectorInfoResp{- Name: fn.ConnectorName(),+ Name: fn.ConnectorName()(ctx),Icon: fn.ConnectorLogoSVG(),Link: fmt.Sprintf("%s%s%s%s", general.SiteUrl,commonRouterPrefix, ConnectorLoginRouterPrefix, fn.ConnectorSlugName()),@@ -175,7 +175,7 @@ func (cc *ConnectorController) ConnectorsUserInfo(ctx *gin.Context) {_ = plugin.CallConnector(func(fn plugin.Connector) error {externalID := userExternalLoginMapping[fn.ConnectorSlugName()]resp = append(resp, &schema.ConnectorUserInfoResp{- Name: fn.ConnectorName(),+ Name: fn.ConnectorName()(ctx),Icon: fn.ConnectorLogoSVG(),Link: fmt.Sprintf("%s%s%s%s", general.SiteUrl,commonRouterPrefix, ConnectorLoginRouterPrefix, fn.ConnectorSlugName()),diff --git a/internal/controller_admin/plugin_controller.go b/internal/controller_admin/plugin_controller.goindex a670a9e0..e86d20b7 100644--- a/internal/controller_admin/plugin_controller.go+++ b/internal/controller_admin/plugin_controller.go@@ -49,9 +49,9 @@ func (pc *PluginController) GetPluginList(ctx *gin.Context) {_ = plugin.CallBase(func(base plugin.Base) error {info := base.Info()resp = append(resp, &schema.GetPluginListResp{- Name: info.Name,+ Name: info.Name(ctx),SlugName: info.SlugName,- Description: info.Description,+ Description: info.Description(ctx),Version: info.Version,Enabled: plugin.StatusManager.IsEnabled(info.SlugName),HaveConfig: pluginConfigMapping[info.SlugName],@@ -133,9 +133,9 @@ func (pc *PluginController) GetPluginConfig(ctx *gin.Context) {return nil}info := base.Info()- resp.Name = info.Name+ resp.Name = info.Name(ctx)resp.SlugName = info.SlugName- resp.Description = info.Description+ resp.Description = info.Description(ctx)resp.Version = info.Versionreturn nil})@@ -144,7 +144,7 @@ func (pc *PluginController) GetPluginConfig(ctx *gin.Context) {if fn.Info().SlugName != req.PluginSlugName {return nil}- resp.ConfigFields = fn.ConfigFields()+ resp.SetConfigFields(ctx, fn.ConfigFields())return nil})handler.HandleResponse(ctx, nil, resp)diff --git a/internal/schema/plugin_admin_schema.go b/internal/schema/plugin_admin_schema.goindex 3a4d2eac..cc8be272 100644--- a/internal/schema/plugin_admin_schema.go+++ b/internal/schema/plugin_admin_schema.go@@ -1,6 +1,9 @@package schema-import "github.com/answerdev/answer/plugin"+import (+ "github.com/answerdev/answer/plugin"+ "github.com/gin-gonic/gin"+)const (PluginStatusActive PluginStatus = "active"@@ -33,11 +36,61 @@ type GetPluginConfigReq struct {}type GetPluginConfigResp struct {- Name string `json:"name"`- SlugName string `json:"slug_name"`- Description string `json:"description"`- Version string `json:"version"`- ConfigFields []plugin.ConfigField `json:"config_fields"`+ Name string `json:"name"`+ SlugName string `json:"slug_name"`+ Description string `json:"description"`+ Version string `json:"version"`+ ConfigFields []ConfigField `json:"config_fields"`+}++func (g *GetPluginConfigResp) SetConfigFields(ctx *gin.Context, fields []plugin.ConfigField) {+ for _, field := range fields {+ configField := ConfigField{+ Name: field.Name,+ Type: string(field.Type),+ Title: field.Title(ctx),+ Description: field.Description(ctx),+ Required: field.Required,+ Value: field.Value,+ UIOptions: ConfigFieldUIOptions{+ Rows: field.UIOptions.Rows,+ InputType: string(field.UIOptions.InputType),+ },+ }+ if field.UIOptions.Placeholder != nil {+ configField.UIOptions.Placeholder = field.UIOptions.Placeholder(ctx)+ }++ for _, option := range field.Options {+ configField.Options = append(configField.Options, ConfigFieldOption{+ Label: option.Label(ctx),+ Value: option.Value,+ })+ }+ g.ConfigFields = append(g.ConfigFields, configField)+ }+}++type ConfigField struct {+ Name string `json:"name"`+ Type string `json:"type"`+ Title string `json:"title"`+ Description string `json:"description"`+ Required bool `json:"required"`+ Value string `json:"value"`+ UIOptions ConfigFieldUIOptions `json:"ui_options"`+ Options []ConfigFieldOption `json:"options,omitempty"`+}++type ConfigFieldUIOptions struct {+ Placeholder string `json:"placeholder,omitempty"`+ Rows string `json:"rows,omitempty"`+ InputType string `json:"input_type,omitempty"`+}++type ConfigFieldOption struct {+ Label string `json:"label"`+ Value string `json:"value"`}type UpdatePluginConfigReq struct {