feat: Custom text login (#1925)

* feat: default custom message text

* feat: org custom message text

* feat: org custom message text

* feat: custom messages query side

* feat: default messages

* feat: message text user fields

* feat: check for inactive user

* feat: fix send password reset

* feat: fix custom org text

* feat: add variables to docs

* feat: custom text tests

* feat: fix notifications

* feat: add custom text feature

* feat: add custom text feature

* feat: feature in custom message texts

* feat: add custom text feature in frontend

* feat: merge main

* feat: feature tests

* feat: change phone message in setup

* fix: remove unused code, add event translation

* fix: merge main and fix problems

* fix: english translation file

* fix: migration versions

* fix: setup

* fix: custom login text

* feat: add all possible custom texts for login

* feat: iam login texts

* feat: org login texts

* feat: protos

* fix: custom text in admin api

* fix: add success login text

* fix: docs

* fix: add custom login texts to management api

* fix: add sub messages to custom login texts

* fix: setup custom texts

* feat: get org login texts

* feat: get org login texts

* feat: handler in adminapi

* feat: handlers in auth and admin

* feat: render login texts

* feat: custom login text

* feat: add all login text keys

* feat: handle correct login texts

* feat: custom login texts in command side

* feat: custom login texts in command side

* feat: fix yaml file

* feat: merge master and add confirmation text

* feat: fix html

* feat: read default login texts

* feat: get default text files

* feat: get custom texts org

* feat: tests

* feat: change translator handling

* fix translator from authReq

* feat: change h1 on login screens

* feat: add custom login text for remove

* feat: add custom login text for remove

* feat: cache translation files

* feat: cache translation files

* feat: zitadel user in env var

* feat: add registration user description

* feat: better func naming

* feat: tests

* feat: add mutex to read file

* feat: add mutex to read file

* fix mutex for accessing translation map

* fix: translation key

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

internal/admin/repository/eventsourcing/eventstore/iam.go

@@ -2,7 +2,13 @@ package eventstore
 
 import (
 	"context"
+	"fmt"
+	"io/ioutil"
+	"net/http"
 	"strings"
+	"sync"
+
+	"github.com/ghodss/yaml"
 
 	"github.com/caos/zitadel/internal/domain"
 	v1 "github.com/caos/zitadel/internal/eventstore/v1"
@@ -23,12 +29,15 @@ import (
 )
 
 type IAMRepository struct {
-	Eventstore      v1.Eventstore
-	SearchLimit     uint64
-	View            *admin_view.View
-	SystemDefaults  systemdefaults.SystemDefaults
-	Roles           []string
-	PrefixAvatarURL string
+	Eventstore              v1.Eventstore
+	SearchLimit             uint64
+	View                    *admin_view.View
+	SystemDefaults          systemdefaults.SystemDefaults
+	Roles                   []string
+	PrefixAvatarURL         string
+	LoginDir                http.FileSystem
+	TranslationFileContents map[string][]byte
+	mutex                   sync.Mutex
 }
 
 func (repo *IAMRepository) IAMMemberByID(ctx context.Context, iamID, userID string) (*iam_model.IAMMemberView, error) {
@@ -399,6 +408,32 @@ func (repo *IAMRepository) GetDefaultPrivacyPolicy(ctx context.Context) (*iam_mo
 	return result, nil
 }
 
+func (repo *IAMRepository) GetDefaultLoginTexts(ctx context.Context, lang string) (*domain.CustomLoginText, error) {
+	repo.mutex.Lock()
+	defer repo.mutex.Unlock()
+	contents, ok := repo.TranslationFileContents[lang]
+	if !ok {
+		contents, err := repo.readTranslationFile(fmt.Sprintf("/i18n/%s.yaml", lang))
+		if err != nil {
+			return nil, err
+		}
+		repo.TranslationFileContents[lang] = contents
+	}
+	loginText := new(domain.CustomLoginText)
+	if err := yaml.Unmarshal(contents, loginText); err != nil {
+		return nil, caos_errs.ThrowInternal(err, "TEXT-GHR3Q", "Errors.TranslationFile.ReadError")
+	}
+	return loginText, nil
+}
+
+func (repo *IAMRepository) GetCustomLoginTexts(ctx context.Context, lang string) (*domain.CustomLoginText, error) {
+	texts, err := repo.View.CustomTextsByAggregateIDAndTemplateAndLand(repo.SystemDefaults.IamID, domain.LoginCustomText, lang)
+	if err != nil {
+		return nil, err
+	}
+	return iam_es_model.CustomTextViewsToLoginDomain(repo.SystemDefaults.IamID, lang, texts), err
+}
+
 func (repo *IAMRepository) getIAMEvents(ctx context.Context, sequence uint64) ([]*models.Event, error) {
 	query, err := iam_view.IAMByIDQuery(domain.IAMID, sequence)
 	if err != nil {
@@ -406,3 +441,15 @@ func (repo *IAMRepository) getIAMEvents(ctx context.Context, sequence uint64) ([
 	}
 	return repo.Eventstore.FilterEvents(ctx, query)
 }
+
+func (repo *IAMRepository) readTranslationFile(filename string) ([]byte, error) {
+	r, err := repo.LoginDir.Open(filename)
+	if err != nil {
+		return nil, caos_errs.ThrowInternal(err, "TEXT-93njw", "Errors.TranslationFile.ReadError")
+	}
+	contents, err := ioutil.ReadAll(r)
+	if err != nil {
+		return nil, caos_errs.ThrowInternal(err, "TEXT-l0fse", "Errors.TranslationFile.ReadError")
+	}
+	return contents, nil
+}

internal/admin/repository/eventsourcing/eventstore/org.go

@@ -13,6 +13,7 @@ import (
 	"github.com/caos/zitadel/internal/telemetry/tracing"
 
 	"github.com/caos/logging"
+
 	admin_view "github.com/caos/zitadel/internal/admin/repository/eventsourcing/view"
 	"github.com/caos/zitadel/internal/config/systemdefaults"
 	iam_es_model "github.com/caos/zitadel/internal/iam/repository/view/model"

internal/admin/repository/eventsourcing/handler/custom_text.go

@@ -0,0 +1,121 @@
+package handler
+
+import (
+	"github.com/caos/logging"
+	caos_errs "github.com/caos/zitadel/internal/errors"
+	"github.com/caos/zitadel/internal/eventstore/v1"
+	es_models "github.com/caos/zitadel/internal/eventstore/v1/models"
+	"github.com/caos/zitadel/internal/eventstore/v1/query"
+	"github.com/caos/zitadel/internal/eventstore/v1/spooler"
+	iam_es_model "github.com/caos/zitadel/internal/iam/repository/eventsourcing/model"
+	iam_model "github.com/caos/zitadel/internal/iam/repository/view/model"
+	"github.com/caos/zitadel/internal/org/repository/eventsourcing/model"
+)
+
+type CustomText struct {
+	handler
+	subscription *v1.Subscription
+}
+
+func newCustomText(handler handler) *CustomText {
+	h := &CustomText{
+		handler: handler,
+	}
+
+	h.subscribe()
+
+	return h
+}
+
+func (m *CustomText) subscribe() {
+	m.subscription = m.es.Subscribe(m.AggregateTypes()...)
+	go func() {
+		for event := range m.subscription.Events {
+			query.ReduceEvent(m, event)
+		}
+	}()
+}
+
+const (
+	customTextTable = "adminapi.custom_texts"
+)
+
+func (m *CustomText) ViewModel() string {
+	return customTextTable
+}
+
+func (_ *CustomText) AggregateTypes() []es_models.AggregateType {
+	return []es_models.AggregateType{model.OrgAggregate, iam_es_model.IAMAggregate}
+}
+
+func (p *CustomText) CurrentSequence() (uint64, error) {
+	sequence, err := p.view.GetLatestCustomTextSequence()
+	if err != nil {
+		return 0, err
+	}
+	return sequence.CurrentSequence, nil
+}
+
+func (m *CustomText) EventQuery() (*es_models.SearchQuery, error) {
+	sequence, err := m.view.GetLatestCustomTextSequence()
+	if err != nil {
+		return nil, err
+	}
+	return es_models.NewSearchQuery().
+		AggregateTypeFilter(m.AggregateTypes()...).
+		LatestSequenceFilter(sequence.CurrentSequence), nil
+}
+
+func (m *CustomText) Reduce(event *es_models.Event) (err error) {
+	switch event.AggregateType {
+	case model.OrgAggregate, iam_es_model.IAMAggregate:
+		err = m.processCustomText(event)
+	}
+	return err
+}
+
+func (m *CustomText) processCustomText(event *es_models.Event) (err error) {
+	customText := new(iam_model.CustomTextView)
+	switch event.Type {
+	case iam_es_model.CustomTextSet, model.CustomTextSet:
+		text := new(iam_model.CustomTextView)
+		err = text.SetData(event)
+		if err != nil {
+			return err
+		}
+		customText, err = m.view.CustomTextByIDs(event.AggregateID, text.Template, text.Key, text.Language)
+		if err != nil && !caos_errs.IsNotFound(err) {
+			return err
+		}
+		if caos_errs.IsNotFound(err) {
+			err = nil
+			customText = new(iam_model.CustomTextView)
+			customText.Language = text.Language
+			customText.Template = text.Template
+			customText.CreationDate = event.CreationDate
+		}
+		err = customText.AppendEvent(event)
+	case iam_es_model.CustomTextRemoved, model.CustomTextRemoved:
+		text := new(iam_model.CustomTextView)
+		err = text.SetData(event)
+		if err != nil {
+			return err
+		}
+		return m.view.DeleteCustomText(event.AggregateID, text.Template, text.Language, event)
+	default:
+		return m.view.ProcessedCustomTextSequence(event)
+	}
+	if err != nil {
+		return err
+	}
+	return m.view.PutCustomText(customText, event)
+}
+
+func (m *CustomText) OnError(event *es_models.Event, err error) error {
+	logging.LogWithFields("SPOOL-3m912", "id", event.AggregateID).WithError(err).Warn("something went wrong in custom text handler")
+	return spooler.HandleError(event, err, m.view.GetLatestCustomTextFailedEvent, m.view.ProcessedCustomTextFailedEvent, m.view.ProcessedCustomTextSequence, m.errorCountUntilSkip)
+}
+
+func (o *CustomText) OnSuccess() error {
+	return spooler.HandleSuccess(o.view.UpdateCustomTextSpoolerRunTimestamp)
+}

internal/admin/repository/eventsourcing/handler/handler.go

@@ -68,6 +68,8 @@ func Register(configs Configs, bulkLimit, errorCount uint64, view *view.View, es
 			handler{view, bulkLimit, configs.cycleDuration("Features"), errorCount, es}),
 		newPrivacyPolicy(
 			handler{view, bulkLimit, configs.cycleDuration("PrivacyPolicy"), errorCount, es}),
+		newCustomText(
+			handler{view, bulkLimit, configs.cycleDuration("CustomTexts"), errorCount, es}),
 	}
 	if static != nil {
 		handlers = append(handlers, newStyling(

internal/admin/repository/eventsourcing/handler/message_text.go

@@ -80,19 +80,19 @@ func (m *MessageText) processMessageText(event *es_models.Event) (err error) {
 	switch event.Type {
 	case model.CustomTextSet,
 		model.CustomTextRemoved:
-		text := new(iam_model.CustomText)
+		text := new(iam_model.CustomTextView)
 		err = text.SetData(event)
 		if err != nil {
 			return err
 		}
-		message, err = m.view.MessageTextByIDs(event.AggregateID, text.Template, text.Language.String())
+		message, err = m.view.MessageTextByIDs(event.AggregateID, text.Template, text.Language)
 		if err != nil && !caos_errs.IsNotFound(err) {
 			return err
 		}
 		if caos_errs.IsNotFound(err) {
 			err = nil
 			message = new(iam_model.MessageTextView)
-			message.Language = text.Language.String()
+			message.Language = text.Language
 			message.MessageTextType = text.Template
 			message.CreationDate = event.CreationDate
 		}

internal/admin/repository/eventsourcing/repository.go

@@ -3,6 +3,9 @@ package eventsourcing
 import (
 	"context"
 
+	"github.com/caos/logging"
+	"github.com/rakyll/statik/fs"
+
 	"github.com/caos/zitadel/internal/admin/repository/eventsourcing/eventstore"
 	"github.com/caos/zitadel/internal/admin/repository/eventsourcing/spooler"
 	admin_view "github.com/caos/zitadel/internal/admin/repository/eventsourcing/view"
@@ -48,6 +51,9 @@ func Start(ctx context.Context, conf Config, systemDefaults sd.SystemDefaults, s
 	spool := spooler.StartSpooler(conf.Spooler, es, view, sqlClient, systemDefaults, static, localDevMode)
 	assetsAPI := conf.APIDomain + "/assets/v1/"
 
+	statikLoginFS, err := fs.NewWithNamespace("login")
+	logging.Log("CONFI-7usEW").OnError(err).Panic("unable to start login statik dir")
+
 	return &EsRepository{
 		spooler: spool,
 		OrgRepo: eventstore.OrgRepo{
@@ -57,12 +63,14 @@ func Start(ctx context.Context, conf Config, systemDefaults sd.SystemDefaults, s
 			SystemDefaults: systemDefaults,
 		},
 		IAMRepository: eventstore.IAMRepository{
-			Eventstore:      es,
-			View:            view,
-			SystemDefaults:  systemDefaults,
-			SearchLimit:     conf.SearchLimit,
-			Roles:           roles,
-			PrefixAvatarURL: assetsAPI,
+			Eventstore:              es,
+			View:                    view,
+			SystemDefaults:          systemDefaults,
+			SearchLimit:             conf.SearchLimit,
+			Roles:                   roles,
+			PrefixAvatarURL:         assetsAPI,
+			LoginDir:                statikLoginFS,
+			TranslationFileContents: make(map[string][]byte),
 		},
 		AdministratorRepo: eventstore.AdministratorRepo{
 			View: view,

internal/admin/repository/eventsourcing/view/custom_texts.go

@@ -0,0 +1,57 @@
+package view
+
+import (
+	"github.com/caos/zitadel/internal/errors"
+	"github.com/caos/zitadel/internal/eventstore/v1/models"
+	"github.com/caos/zitadel/internal/iam/repository/view"
+	"github.com/caos/zitadel/internal/iam/repository/view/model"
+	global_view "github.com/caos/zitadel/internal/view/repository"
+)
+
+const (
+	customTextTable = "adminapi.custom_texts"
+)
+
+func (v *View) CustomTextByIDs(aggregateID, template, lang, key string) (*model.CustomTextView, error) {
+	return view.CustomTextByIDs(v.Db, customTextTable, aggregateID, template, lang, key)
+}
+
+func (v *View) CustomTextsByAggregateIDAndTemplateAndLand(aggregateID, template, lang string) ([]*model.CustomTextView, error) {
+	return view.GetCustomTexts(v.Db, customTextTable, aggregateID, template, lang)
+}
+
+func (v *View) PutCustomText(template *model.CustomTextView, event *models.Event) error {
+	err := view.PutCustomText(v.Db, customTextTable, template)
+	if err != nil {
+		return err
+	}
+	return v.ProcessedCustomTextSequence(event)
+}
+
+func (v *View) DeleteCustomText(aggregateID, textType, lang string, event *models.Event) error {
+	err := view.DeleteCustomText(v.Db, customTextTable, aggregateID, textType, lang)
+	if err != nil && !errors.IsNotFound(err) {
+		return err
+	}
+	return v.ProcessedCustomTextSequence(event)
+}
+
+func (v *View) GetLatestCustomTextSequence() (*global_view.CurrentSequence, error) {
+	return v.latestSequence(customTextTable)
+}
+
+func (v *View) ProcessedCustomTextSequence(event *models.Event) error {
+	return v.saveCurrentSequence(customTextTable, event)
+}
+
+func (v *View) UpdateCustomTextSpoolerRunTimestamp() error {
+	return v.updateSpoolerRunSequence(customTextTable)
+}
+
+func (v *View) GetLatestCustomTextFailedEvent(sequence uint64) (*global_view.FailedEvent, error) {
+	return v.latestFailedEvent(customTextTable, sequence)
+}
+
+func (v *View) ProcessedCustomTextFailedEvent(failedEvent *global_view.FailedEvent) error {
+	return v.saveFailedEvent(failedEvent)
+}

internal/admin/repository/iam.go

@@ -2,6 +2,7 @@ package repository
 
 import (
 	"context"
+	"github.com/caos/zitadel/internal/domain"
 	usr_model "github.com/caos/zitadel/internal/user/model"
 
 	iam_model "github.com/caos/zitadel/internal/iam/model"
@@ -30,6 +31,8 @@ type IAMRepository interface {
 
 	GetDefaultMessageTexts(ctx context.Context) (*iam_model.MessageTextsView, error)
 	GetDefaultMessageText(ctx context.Context, textType string, language string) (*iam_model.MessageTextView, error)
+	GetDefaultLoginTexts(ctx context.Context, lang string) (*domain.CustomLoginText, error)
+	GetCustomLoginTexts(ctx context.Context, lang string) (*domain.CustomLoginText, error)
 
 	GetDefaultPasswordComplexityPolicy(ctx context.Context) (*iam_model.PasswordComplexityPolicyView, error)