feat: implement automatic synchronization for ldap users (#371)

Signed-off-by: Товарищ программист <2962928213@qq.com>

controllers/ldap.go

@@ -151,6 +151,9 @@ func (c *ApiController) AddLdap() {
 	if affected {
 		resp.Data2 = ldap
 	}
+	if ldap.AutoSync != 0 {
+		object.GetLdapAutoSynchronizer().StartAutoSync(ldap.Id)
+	}
 
 	c.Data["json"] = resp
 	c.ServeJSON()
@@ -172,6 +175,9 @@ func (c *ApiController) UpdateLdap() {
 	if affected {
 		resp.Data2 = ldap
 	}
+	if ldap.AutoSync != 0 {
+		object.GetLdapAutoSynchronizer().StartAutoSync(ldap.Id)
+	}
 
 	c.Data["json"] = resp
 	c.ServeJSON()
@@ -187,6 +193,7 @@ func (c *ApiController) DeleteLdap() {
 		panic(err)
 	}
 
+	object.GetLdapAutoSynchronizer().StopAutoSync(ldap.Id)
 	c.Data["json"] = wrapActionResponse(object.DeleteLdap(&ldap))
 	c.ServeJSON()
 }

main.go

@@ -32,6 +32,7 @@ func main() {
 	object.InitAdapter()
 	object.InitDb()
 	object.InitDefaultStorageProvider()
+	object.InitLdapAutoSynchronizer()
 	proxy.InitHttpClient()
 	authz.InitAuthz()
 
@@ -73,7 +74,7 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
-	logs.SetLevel(logs.LevelInformational)
+	//logs.SetLevel(logs.LevelInformational)
 	logs.SetLogFuncCall(false)
 
 	beego.Run()

object/ldap.go

@@ -78,6 +78,32 @@ type LdapRespUser struct {
 	Address string `json:"address"`
 }
 
+func LdapUsersToLdapRespUsers(users []ldapUser) []LdapRespUser {
+	returnAnyNotEmpty := func(strs ...string) string {
+		for _, str := range strs {
+			if str != "" {
+				return str
+			}
+		}
+		return ""
+	}
+
+	res := make([]LdapRespUser, 0)
+	for _, user := range users {
+		res = append(res, LdapRespUser{
+			UidNumber: user.UidNumber,
+			Uid:       user.Uid,
+			Cn:        user.Cn,
+			GroupId:   user.GidNumber,
+			Uuid:      user.Uuid,
+			Email:     returnAnyNotEmpty(user.Email, user.EmailAddress, user.Mail),
+			Phone:     returnAnyNotEmpty(user.Mobile, user.MobileTelephoneNumber, user.TelephoneNumber),
+			Address:   returnAnyNotEmpty(user.PostalAddress, user.RegisteredAddress),
+		})
+	}
+	return res
+}
+
 func GetLdapConn(host string, port int, adminUser string, adminPasswd string) (*ldapConn, error) {
 	conn, err := goldap.Dial("tcp", fmt.Sprintf("%s:%d", host, port))
 	if err != nil {
@@ -286,15 +312,16 @@ func SyncLdapUsers(owner string, users []LdapRespUser) (*[]LdapRespUser, *[]Ldap
 	existUuids := CheckLdapUuidExist(owner, uuids)
 
 	for _, user := range users {
+		found := false
 		if len(existUuids) > 0 {
-			for index, existUuid := range existUuids {
+			for _, existUuid := range existUuids {
 				if user.Uuid == existUuid {
 					existUsers = append(existUsers, user)
-					existUuids = append(existUuids[:index], existUuids[index+1:]...)
+					found = true
 				}
 			}
 		}
-		if !AddUser(&User{
+		if !found && !AddUser(&User{
 			Owner:       owner,
 			Name:        buildLdapUserName(user.Uid, user.UidNumber),
 			CreatedTime: util.GetCurrentTime(),
@@ -327,6 +354,7 @@ func UpdateLdapSyncTime(ldapId string) {
 func CheckLdapUuidExist(owner string, uuids []string) []string {
 	var results []User
 	var existUuids []string
+	existUuidSet := make(map[string]struct{})
 
 	//whereStr := ""
 	//for i, uuid := range uuids {
@@ -344,9 +372,13 @@ func CheckLdapUuidExist(owner string, uuids []string) []string {
 
 	if len(results) > 0 {
 		for _, result := range results {
-			existUuids = append(existUuids, result.Ldap)
+			existUuidSet[result.Ldap] = struct{}{}
 		}
 	}
+
+	for uuid, _ := range existUuidSet {
+		existUuids = append(existUuids, uuid)
+	}
 	return existUuids
 }
 

object/ldap_autosync.go

@@ -0,0 +1,111 @@
+package object
+
+import (
+	"fmt"
+	"sync"
+	"time"
+
+	"github.com/astaxie/beego/logs"
+)
+
+type LdapAutoSynchronizer struct {
+	sync.Mutex
+	ldapIdToStopChan map[string]chan struct{}
+}
+
+var globalLdapAutoSynchronizer *LdapAutoSynchronizer
+
+func InitLdapAutoSynchronizer() {
+	globalLdapAutoSynchronizer = NewLdapAutoSynchronizer()
+	globalLdapAutoSynchronizer.LdapAutoSynchronizerStartUpAll()
+}
+
+func NewLdapAutoSynchronizer() *LdapAutoSynchronizer {
+	return &LdapAutoSynchronizer{
+		ldapIdToStopChan: make(map[string]chan struct{}),
+	}
+}
+
+func GetLdapAutoSynchronizer() *LdapAutoSynchronizer {
+	return globalLdapAutoSynchronizer
+}
+
+//start autosync for specified ldap, old existing autosync goroutine will be ceased
+func (l *LdapAutoSynchronizer) StartAutoSync(ldapId string) error {
+	l.Lock()
+	defer l.Unlock()
+
+	ldap := GetLdap(ldapId)
+	if ldap == nil {
+		return fmt.Errorf("ldap %s doesn't exist", ldapId)
+	}
+	if res, ok := l.ldapIdToStopChan[ldapId]; ok {
+		res <- struct{}{}
+		delete(l.ldapIdToStopChan, ldapId)
+	}
+
+	stopChan := make(chan struct{})
+	l.ldapIdToStopChan[ldapId] = stopChan
+	logs.Info(fmt.Sprintf("autoSync started for %s", ldap.Id))
+	go l.syncRoutine(ldap, stopChan)
+	return nil
+}
+
+func (l *LdapAutoSynchronizer) StopAutoSync(ldapId string) {
+	l.Lock()
+	defer l.Unlock()
+	if res, ok := l.ldapIdToStopChan[ldapId]; ok {
+		res <- struct{}{}
+		delete(l.ldapIdToStopChan, ldapId)
+	}
+}
+
+//autosync goroutine
+func (l *LdapAutoSynchronizer) syncRoutine(ldap *Ldap, stopChan chan struct{}) {
+	ticker := time.NewTicker(time.Duration(ldap.AutoSync) * time.Minute)
+	defer ticker.Stop()
+	for {
+		UpdateLdapSyncTime(ldap.Id)
+		//fetch all users
+		conn, err := GetLdapConn(ldap.Host, ldap.Port, ldap.Admin, ldap.Passwd)
+		if err != nil {
+			logs.Warning(fmt.Sprintf("autoSync failed for %s, error %s", ldap.Id, err))
+			continue
+		}
+
+		users, err := conn.GetLdapUsers(ldap.BaseDn)
+		if err != nil {
+			logs.Warning(fmt.Sprintf("autoSync failed for %s, error %s", ldap.Id, err))
+			continue
+		}
+		existed, failed := SyncLdapUsers(ldap.Owner, LdapUsersToLdapRespUsers(users))
+		if len(*failed) != 0 {
+			logs.Warning(fmt.Sprintf("ldap autosync,%d new users,but %d user failed during :", len(users)-len(*existed)-len(*failed), len(*failed)), *failed)
+		} else {
+			logs.Info(fmt.Sprintf("ldap autosync success, %d new users, %d existing users", len(users)-len(*existed), len(*existed)))
+		}
+		select {
+		case <-stopChan:
+			logs.Info(fmt.Sprintf("autoSync goroutine for %s stopped", ldap.Id))
+			return
+		case <-ticker.C:
+		}
+	}
+
+}
+
+//start all autosync goroutine for existing ldap servers in each organizations
+func (l *LdapAutoSynchronizer) LdapAutoSynchronizerStartUpAll() {
+	organizations := []*Organization{}
+	err := adapter.Engine.Desc("created_time").Find(&organizations)
+	if err != nil {
+		logs.Info("failed to Star up LdapAutoSynchronizer; ")
+	}
+	for _, org := range organizations {
+		for _, ldap := range GetLdaps(org.Name) {
+			if ldap.AutoSync != 0 {
+				l.StartAutoSync(ldap.Id)
+			}
+		}
+	}
+}

web/src/LdapEditPage.js

@@ -178,7 +178,7 @@ class LdapEditPage extends React.Component {
             {Setting.getLabel(i18next.t("ldap:Auto Sync"), i18next.t("ldap:Auto Sync - Tooltip"))} :
           </Col>
           <Col span={21}>
-            <InputNumber min={0} formatter={value => value.replace(/\$\s?|(,*)/g, "")} disabled={true}
+            <InputNumber min={0} formatter={value => value.replace(/\$\s?|(,*)/g, "")} disabled={false}
                          value={this.state.ldap.autoSync} onChange={value => {
               this.updateLdapField("autoSync", value);
             }}/><span>&nbsp;mins</span>