Refactor the original db code.

object/syncer.go

@@ -39,6 +39,8 @@ type Syncer struct {
 	AvatarBaseUrl    string `xorm:"varchar(100)" json:"avatarBaseUrl"`
 	SyncInterval     int    `json:"syncInterval"`
 	IsEnabled        bool   `json:"isEnabled"`
+
+	Adapter *Adapter `xorm:"-" json:"-"`
 }
 
 func GetSyncerCount(owner string) int {
@@ -143,6 +145,6 @@ func DeleteSyncer(syncer *Syncer) bool {
 	return affected != 0
 }
 
-func (p *Syncer) GetId() string {
-	return fmt.Sprintf("%s/%s", p.Owner, p.Name)
+func (syncer *Syncer) GetId() string {
+	return fmt.Sprintf("%s/%s", syncer.Owner, syncer.Name)
 }

object/syncer_affiliation.go

@@ -0,0 +1,40 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+type Affiliation struct {
+	Id   int    `xorm:"int notnull pk autoincr" json:"id"`
+	Name string `xorm:"varchar(128)" json:"name"`
+}
+
+func (syncer *Syncer) getAffiliations() []*Affiliation {
+	affiliations := []*Affiliation{}
+	err := syncer.Adapter.Engine.Table(syncer.AffiliationTable).Asc("id").Find(&affiliations)
+	if err != nil {
+		panic(err)
+	}
+
+	return affiliations
+}
+
+func (syncer *Syncer) getAffiliationMap() ([]*Affiliation, map[int]string) {
+	affiliations := syncer.getAffiliations()
+
+	m := map[int]string{}
+	for _, affiliation := range affiliations {
+		m[affiliation.Id] = affiliation.Name
+	}
+	return affiliations, m
+}

object/syncer_cron.go

@@ -0,0 +1,40 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import "github.com/mileusna/crontab"
+
+var cronMap map[string]*crontab.Crontab
+
+func init() {
+	cronMap = map[string]*crontab.Crontab{}
+}
+
+func getCrontab(name string) *crontab.Crontab {
+	ctab, ok := cronMap[name]
+	if !ok {
+		ctab = crontab.New()
+		cronMap[name] = ctab
+	}
+	return ctab
+}
+
+func clearCrontab(name string) {
+	ctab, ok := cronMap[name]
+	if ok {
+		ctab.Clear()
+		delete(cronMap, name)
+	}
+}

object/syncer_public_api.go

@@ -0,0 +1,51 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import "fmt"
+
+func getEnabledSyncerForOrganization(organization string) *Syncer {
+	syncers := GetSyncers("admin")
+	for _, syncer := range syncers {
+		if syncer.Organization == organization && syncer.IsEnabled {
+			return syncer
+		}
+	}
+	return nil
+}
+
+func AddUserToOriginalDatabase(user *User) {
+	syncer := getEnabledSyncerForOrganization(user.Owner)
+	if syncer == nil {
+		return
+	}
+
+	updatedOUser := syncer.createOriginalUserFromUser(user)
+	syncer.addUser(updatedOUser)
+	fmt.Printf("Add from user to oUser: %v\n", updatedOUser)
+}
+
+func UpdateUserToOriginalDatabase(user *User) {
+	syncer := getEnabledSyncerForOrganization(user.Owner)
+	if syncer == nil {
+		return
+	}
+
+	newUser := GetUser(user.GetId())
+
+	updatedOUser := syncer.createOriginalUserFromUser(newUser)
+	syncer.updateUser(updatedOUser)
+	fmt.Printf("Update from user to oUser: %v\n", updatedOUser)
+}

object/syncer_sync.go

@@ -0,0 +1,83 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import (
+	"fmt"
+	"strconv"
+)
+
+func (syncer *Syncer) syncUsers() {
+	fmt.Printf("Running syncUsers()..\n")
+
+	users, userMap := syncer.getUserMap()
+	oUsers, oUserMap := syncer.getUserMapOriginal()
+	fmt.Printf("Users: %d, oUsers: %d\n", len(users), len(oUsers))
+
+	_, affiliationMap := syncer.getAffiliationMap()
+
+	newUsers := []*User{}
+	for _, oUser := range oUsers {
+		id := strconv.Itoa(oUser.Id)
+		if _, ok := userMap[id]; !ok {
+			newUser := syncer.createUserFromOriginalUser(oUser, affiliationMap)
+			fmt.Printf("New user: %v\n", newUser)
+			newUsers = append(newUsers, newUser)
+		} else {
+			user := userMap[id]
+			oHash := syncer.calculateHash(oUser)
+
+			if user.Hash == user.PreHash {
+				if user.Hash != oHash {
+					updatedUser := syncer.createUserFromOriginalUser(oUser, affiliationMap)
+					updatedUser.Hash = oHash
+					updatedUser.PreHash = oHash
+					UpdateUserForOriginalFields(updatedUser)
+					fmt.Printf("Update from oUser to user: %v\n", updatedUser)
+				}
+			} else {
+				if user.PreHash == oHash {
+					updatedOUser := syncer.createOriginalUserFromUser(user)
+					syncer.updateUser(updatedOUser)
+					fmt.Printf("Update from user to oUser: %v\n", updatedOUser)
+
+					// update preHash
+					user.PreHash = user.Hash
+					SetUserField(user, "pre_hash", user.PreHash)
+				} else {
+					if user.Hash == oHash {
+						// update preHash
+						user.PreHash = user.Hash
+						SetUserField(user, "pre_hash", user.PreHash)
+					} else {
+						updatedUser := syncer.createUserFromOriginalUser(oUser, affiliationMap)
+						updatedUser.Hash = oHash
+						updatedUser.PreHash = oHash
+						UpdateUserForOriginalFields(updatedUser)
+						fmt.Printf("Update from oUser to user (2nd condition): %v\n", updatedUser)
+					}
+				}
+			}
+		}
+	}
+	AddUsersInBatch(newUsers)
+
+	for _, user := range users {
+		id := user.Id
+		if _, ok := oUserMap[id]; !ok {
+			panic(fmt.Sprintf("New original user: cannot create now, user = %v", user))
+		}
+	}
+}

object/syncer_user.go

@@ -0,0 +1,109 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/astaxie/beego"
+	"github.com/casbin/casdoor/util"
+)
+
+type DbUser struct {
+	Id        int    `xorm:"int notnull pk autoincr" json:"id"`
+	Name      string `xorm:"varchar(128)" json:"name"`
+	Password  string `xorm:"varchar(128)" json:"password"`
+	Cellphone string `xorm:"varchar(128)" json:"cellphone"`
+	SchoolId  int    `json:"schoolId"`
+	Avatar    string `xorm:"varchar(128)" json:"avatar"`
+	Deleted   int    `xorm:"tinyint(1)" json:"deleted"`
+}
+
+func (syncer *Syncer) getUsersOriginal() []*DbUser {
+	users := []*DbUser{}
+	err := syncer.Adapter.Engine.Table(syncer.Table).Asc("id").Find(&users)
+	if err != nil {
+		panic(err)
+	}
+
+	return users
+}
+
+func (syncer *Syncer) getUserMapOriginal() ([]*DbUser, map[string]*DbUser) {
+	users := syncer.getUsersOriginal()
+
+	m := map[string]*DbUser{}
+	for _, user := range users {
+		m[strconv.Itoa(user.Id)] = user
+	}
+	return users, m
+}
+
+func (syncer *Syncer) addUser(user *DbUser) bool {
+	affected, err := syncer.Adapter.Engine.Table(syncer.Table).Insert(user)
+	if err != nil {
+		panic(err)
+	}
+
+	return affected != 0
+}
+
+func (syncer *Syncer) updateUser(user *DbUser) bool {
+	affected, err := syncer.Adapter.Engine.Table(syncer.Table).ID(user.Id).Cols("name", "password", "cellphone", "school_id", "avatar", "deleted").Update(user)
+	if err != nil {
+		panic(err)
+	}
+
+	return affected != 0
+}
+
+func (syncer *Syncer) calculateHash(user *DbUser) string {
+	s := strings.Join([]string{strconv.Itoa(user.Id), user.Password, user.Name, syncer.getFullAvatarUrl(user.Avatar), user.Cellphone, strconv.Itoa(user.SchoolId)}, "|")
+	return util.GetMd5Hash(s)
+}
+
+func (syncer *Syncer) initAdapter() {
+	if syncer.Adapter == nil {
+		dataSourceName := fmt.Sprintf("%s:%s@tcp(%s:%d)/", syncer.User, syncer.Password, syncer.Host, syncer.Port)
+		syncer.Adapter = NewAdapter(beego.AppConfig.String("driverName"), dataSourceName, syncer.Database)
+	}
+}
+
+func RunSyncUsersJob() {
+	syncers := GetSyncers("admin")
+	for _, syncer := range syncers {
+		if !syncer.IsEnabled {
+			continue
+		}
+
+		syncer.initAdapter()
+
+		syncer.syncUsers()
+
+		// run at every minute
+		//schedule := fmt.Sprintf("* * * * %d", syncer.SyncInterval)
+		schedule := "* * * * *"
+		ctab := getCrontab(syncer.Name)
+		err := ctab.AddJob(schedule, syncer.syncUsers)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	time.Sleep(time.Duration(1<<63 - 1))
+}

object/syncer_user_test.go

@@ -0,0 +1,38 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import (
+	"fmt"
+	"testing"
+)
+
+func TestGetUsers(t *testing.T) {
+	InitConfig()
+	InitAdapter()
+
+	syncer := getEnabledSyncerForOrganization("built-in")
+	users := syncer.getUsersOriginal()
+	for _, user := range users {
+		fmt.Printf("%v\n", user)
+	}
+}
+
+func TestSyncUsers(t *testing.T) {
+	InitConfig()
+	InitAdapter()
+
+	RunSyncUsersJob()
+}

object/syncer_util.go

@@ -0,0 +1,88 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/casbin/casdoor/util"
+)
+
+func (syncer *Syncer) getFullAvatarUrl(avatar string) string {
+	if !strings.HasPrefix(avatar, "https://") {
+		return fmt.Sprintf("%s%s", syncer.AvatarBaseUrl, avatar)
+	}
+	return avatar
+}
+
+func (syncer *Syncer) getPartialAvatarUrl(avatar string) string {
+	if strings.HasPrefix(avatar, syncer.AvatarBaseUrl) {
+		return avatar[len(syncer.AvatarBaseUrl):]
+	}
+	return avatar
+}
+
+func (syncer *Syncer) createUserFromOriginalUser(originalUser *DbUser, affiliationMap map[int]string) *User {
+	affiliation := ""
+	if originalUser.SchoolId != 0 {
+		var ok bool
+		affiliation, ok = affiliationMap[originalUser.SchoolId]
+		if !ok {
+			panic(fmt.Sprintf("SchoolId not found: %d", originalUser.SchoolId))
+		}
+	}
+
+	user := &User{
+		Owner:         syncer.Organization,
+		Name:          strconv.Itoa(originalUser.Id),
+		CreatedTime:   util.GetCurrentTime(),
+		Id:            strconv.Itoa(originalUser.Id),
+		Type:          "normal-user",
+		Password:      originalUser.Password,
+		DisplayName:   originalUser.Name,
+		Avatar:        syncer.getFullAvatarUrl(originalUser.Avatar),
+		Email:         "",
+		Phone:         originalUser.Cellphone,
+		Address:       []string{},
+		Affiliation:   affiliation,
+		Score:         originalUser.SchoolId,
+		IsAdmin:       false,
+		IsGlobalAdmin: false,
+		IsForbidden:   originalUser.Deleted != 0,
+		IsDeleted:     false,
+		Properties:    map[string]string{},
+	}
+	return user
+}
+
+func (syncer *Syncer) createOriginalUserFromUser(user *User) *DbUser {
+	deleted := 0
+	if user.IsForbidden {
+		deleted = 1
+	}
+
+	originalUser := &DbUser{
+		Id:        util.ParseInt(user.Id),
+		Name:      user.DisplayName,
+		Password:  user.Password,
+		Cellphone: user.Phone,
+		SchoolId:  user.Score,
+		Avatar:    syncer.getPartialAvatarUrl(user.Avatar),
+		Deleted:   deleted,
+	}
+	return originalUser
+}

object/syner_db_user.go

@@ -0,0 +1,30 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package object
+
+func (syncer *Syncer) getUsers() []*User {
+	users := GetUsers(syncer.Organization)
+	return users
+}
+
+func (syncer *Syncer) getUserMap() ([]*User, map[string]*User) {
+	users := syncer.getUsers()
+
+	m := map[string]*User{}
+	for _, user := range users {
+		m[user.Name] = user
+	}
+	return users, m
+}