From 68a65798520556ff7130d7e7e53bd260d890bb7c Mon Sep 17 00:00:00 2001 From: haixunlu Date: Thu, 13 Sep 2018 10:49:07 -0700 Subject: [PATCH] login_source: add default authentication switch (#5338) * Add default Authentication Switch. * adjust the code accroding to reviews * #1. Remove redudant logic. #2, Fix a bug in "Edit" panel. * Remove unused logic * Fix local authentication files are not flushed. * refactor according to review. --- models/login_source.go | 48 ++++++++++++++++++++++++++++------ pkg/form/auth.go | 1 + routes/admin/auths.go | 4 +++ routes/user/auth.go | 19 +++++++++++++- templates/admin/auth/edit.tmpl | 7 ++++- templates/admin/auth/list.tmpl | 2 ++ templates/admin/auth/new.tmpl | 8 ++++++ templates/user/auth/login.tmpl | 34 +++++++++++++++++------- 8 files changed, 103 insertions(+), 20 deletions(-) diff --git a/models/login_source.go b/models/login_source.go index 88ad42dc5..546be132d 100644 --- a/models/login_source.go +++ b/models/login_source.go @@ -133,6 +133,7 @@ type LoginSource struct { Type LoginType Name string `xorm:"UNIQUE"` IsActived bool `xorm:"NOT NULL DEFAULT false"` + IsDefault bool `xorm:"DEFAULT false"` Cfg core.Conversion `xorm:"TEXT"` Created time.Time `xorm:"-" json:"-"` @@ -257,7 +258,12 @@ func CreateLoginSource(source *LoginSource) error { } _, err = x.Insert(source) - return err + if err != nil { + return err + } else if source.IsDefault { + return ResetNonDefaultLoginSources(source) + } + return nil } // LoginSources returns all login sources defined. @@ -291,23 +297,48 @@ func GetLoginSourceByID(id int64) (*LoginSource, error) { return source, nil } +// ResetNonDefaultLoginSources clean other default source flag +func ResetNonDefaultLoginSources(source *LoginSource) error { + // update changes to DB + if _, err := x.NotIn("id", []int64{source.ID}).Cols("is_default").Update(&LoginSource{IsDefault: false}); err != nil { + return err + } + // write changes to local authentications + for i := range localLoginSources.sources { + if localLoginSources.sources[i].LocalFile != nil && localLoginSources.sources[i].ID != source.ID { + localLoginSources.sources[i].LocalFile.SetGeneral("is_default", "false") + if err := localLoginSources.sources[i].LocalFile.SetConfig(source.Cfg); err != nil { + return fmt.Errorf("LocalFile.SetConfig: %v", err) + } else if err = localLoginSources.sources[i].LocalFile.Save(); err != nil { + return fmt.Errorf("LocalFile.Save: %v", err) + } + } + } + // flush memory so that web page can show the same behaviors + localLoginSources.UpdateLoginSource(source) + return nil +} + // UpdateLoginSource updates information of login source to database or local file. func UpdateLoginSource(source *LoginSource) error { if source.LocalFile == nil { - _, err := x.Id(source.ID).AllCols().Update(source) - return err + if _, err := x.Id(source.ID).AllCols().Update(source); err != nil { + return err + } else { + return ResetNonDefaultLoginSources(source) + } + } source.LocalFile.SetGeneral("name", source.Name) source.LocalFile.SetGeneral("is_activated", com.ToStr(source.IsActived)) + source.LocalFile.SetGeneral("is_default", com.ToStr(source.IsDefault)) if err := source.LocalFile.SetConfig(source.Cfg); err != nil { return fmt.Errorf("LocalFile.SetConfig: %v", err) } else if err = source.LocalFile.Save(); err != nil { return fmt.Errorf("LocalFile.Save: %v", err) } - - localLoginSources.UpdateLoginSource(source) - return nil + return ResetNonDefaultLoginSources(source) } func DeleteSource(source *LoginSource) error { @@ -361,7 +392,6 @@ func (s *LocalLoginSources) ActivatedList() []*LoginSource { if !s.sources[i].IsActived { continue } - source := &LoginSource{} *source = *s.sources[i] list = append(list, source) @@ -394,7 +424,8 @@ func (s *LocalLoginSources) UpdateLoginSource(source *LoginSource) { for i := range s.sources { if s.sources[i].ID == source.ID { *s.sources[i] = *source - break + } else if source.IsDefault { + s.sources[i].IsDefault = false } } } @@ -429,6 +460,7 @@ func LoadAuthSources() { ID: s.Key("id").MustInt64(), Name: s.Key("name").String(), IsActived: s.Key("is_activated").MustBool(), + IsDefault: s.Key("is_default").MustBool(), LocalFile: &AuthSourceFile{ abspath: fpath, file: authSource, diff --git a/pkg/form/auth.go b/pkg/form/auth.go index b846fc19c..b2ee3ae80 100644 --- a/pkg/form/auth.go +++ b/pkg/form/auth.go @@ -32,6 +32,7 @@ type Authentication struct { GroupMemberUID string UserUID string IsActive bool + IsDefault bool SMTPAuth string SMTPHost string SMTPPort int diff --git a/routes/admin/auths.go b/routes/admin/auths.go index 49f014333..d013c793a 100644 --- a/routes/admin/auths.go +++ b/routes/admin/auths.go @@ -69,6 +69,7 @@ func NewAuthSource(c *context.Context) { c.Data["CurrentSecurityProtocol"] = models.SecurityProtocolNames[ldap.SECURITY_PROTOCOL_UNENCRYPTED] c.Data["smtp_auth"] = "PLAIN" c.Data["is_active"] = true + c.Data["is_default"] = true c.Data["AuthSources"] = authSources c.Data["SecurityProtocols"] = securityProtocols c.Data["SMTPAuths"] = models.SMTPAuths @@ -152,6 +153,7 @@ func NewAuthSourcePost(c *context.Context, f form.Authentication) { Type: models.LoginType(f.Type), Name: f.Name, IsActived: f.IsActive, + IsDefault: f.IsDefault, Cfg: config, }); err != nil { if models.IsErrLoginSourceAlreadyExist(err) { @@ -225,11 +227,13 @@ func EditAuthSourcePost(c *context.Context, f form.Authentication) { source.Name = f.Name source.IsActived = f.IsActive + source.IsDefault = f.IsDefault source.Cfg = config if err := models.UpdateLoginSource(source); err != nil { c.ServerError("UpdateLoginSource", err) return } + log.Trace("Authentication changed by admin '%s': %d", c.User.Name, source.ID) c.Flash.Success(c.Tr("admin.auths.update_success")) diff --git a/routes/user/auth.go b/routes/user/auth.go index 76e51c366..84e171a14 100644 --- a/routes/user/auth.go +++ b/routes/user/auth.go @@ -113,7 +113,15 @@ func Login(c *context.Context) { return } c.Data["LoginSources"] = loginSources - + for i := range loginSources { + if loginSources[i].IsDefault { + c.Data["DefaultSource"] = *loginSources[i] + c.Data["login_source"] = loginSources[i].ID + newLoginSources := append(loginSources[:i], loginSources[i+1:]...) + c.Data["LoginSources"] = newLoginSources + break + } + } c.Success(LOGIN) } @@ -173,6 +181,15 @@ func LoginPost(c *context.Context, f form.SignIn) { default: c.ServerError("UserLogin", err) } + for i := range loginSources { + if loginSources[i].IsDefault { + c.Data["DefaultSource"] = *loginSources[i] + c.Data["login_source"] = loginSources[i].ID + newLoginSources := append(loginSources[:i], loginSources[i+1:]...) + c.Data["LoginSources"] = newLoginSources + break + } + } return } diff --git a/templates/admin/auth/edit.tmpl b/templates/admin/auth/edit.tmpl index fba6fe48c..1db69e690 100644 --- a/templates/admin/auth/edit.tmpl +++ b/templates/admin/auth/edit.tmpl @@ -186,7 +186,12 @@ - +
+
+ + +
+
{{if not .Source.LocalFile}} diff --git a/templates/admin/auth/list.tmpl b/templates/admin/auth/list.tmpl index cb95cb95d..df5b3b78b 100644 --- a/templates/admin/auth/list.tmpl +++ b/templates/admin/auth/list.tmpl @@ -16,6 +16,7 @@ {{.i18n.Tr "admin.auths.name"}} {{.i18n.Tr "admin.auths.type"}} {{.i18n.Tr "admin.auths.enabled"}} + {{.i18n.Tr "admin.auths.default"}} {{.i18n.Tr "admin.auths.updated"}} {{.i18n.Tr "admin.users.created"}} {{.i18n.Tr "admin.users.edit"}} @@ -28,6 +29,7 @@ {{.Name}} {{.TypeName}} + {{DateFmtShort .Updated}} {{if .Created.IsZero}} diff --git a/templates/admin/auth/new.tmpl b/templates/admin/auth/new.tmpl index d6b0c6e89..fa4c1271e 100644 --- a/templates/admin/auth/new.tmpl +++ b/templates/admin/auth/new.tmpl @@ -176,6 +176,7 @@
+
@@ -183,6 +184,13 @@
+
+
+ + +
+
+
diff --git a/templates/user/auth/login.tmpl b/templates/user/auth/login.tmpl index 3bc8e13f6..62c739020 100644 --- a/templates/user/auth/login.tmpl +++ b/templates/user/auth/login.tmpl @@ -22,16 +22,30 @@
- - {{.i18n.Tr "auth.local"}} - - -
-
{{.i18n.Tr "auth.local"}}
- {{range .LoginSources}} -
{{.Name}}
- {{end}} -
+ {{if .DefaultSource}} + + {{.DefaultSource.Name}} + + +
+
{{.DefaultSource.Name}}
+
{{.i18n.Tr "auth.local"}}
+ {{range .LoginSources}} +
{{.Name}}
+ {{end}} +
+ {{else}} + + {{.i18n.Tr "auth.local"}} + + +
+
{{.i18n.Tr "auth.local"}}
+ {{range .LoginSources}} +
{{.Name}}
+ {{end}} +
+ {{end}}
{{end}}