support user features restrictions

This commit is contained in:
MaysWind
2024-11-10 01:44:58 +08:00
parent b8253b6dcc
commit 1f159bf826
11 changed files with 289 additions and 0 deletions
+90
View File
@@ -2,6 +2,7 @@ package models
import (
"fmt"
"strings"
"time"
"github.com/mayswind/ezbookkeeping/pkg/core"
@@ -80,6 +81,94 @@ func (s AmountColorType) String() string {
}
}
// UserFeatureRestrictions represents all the restrictions of user features
type UserFeatureRestrictions int64
// Add returns a new feature restrictions with the specified feature
func (r UserFeatureRestrictions) Add(featureRestrictionType UserFeatureRestrictionType) UserFeatureRestrictions {
typeValue := int64(1 << (featureRestrictionType - 1))
return UserFeatureRestrictions(int64(r) | typeValue)
}
// Remove returns a new feature restrictions without the specified feature
func (r UserFeatureRestrictions) Remove(featureRestrictionType UserFeatureRestrictionType) UserFeatureRestrictions {
typeValue := int64(1 << (featureRestrictionType - 1))
return UserFeatureRestrictions(int64(r) & (^typeValue))
}
// Contains returns whether contains the specified feature
func (r UserFeatureRestrictions) Contains(featureRestrictionType UserFeatureRestrictionType) bool {
typeValue := int64(1 << (featureRestrictionType - 1))
return int64(r)&typeValue == typeValue
}
// String returns a textual representation of all the restrictions of user features
func (r UserFeatureRestrictions) String() string {
builder := strings.Builder{}
for restrictionType := USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD; restrictionType <= USER_FEATURE_RESTRICTION_TYPE_CLEAR_ALL_DATA; restrictionType++ {
if !r.Contains(restrictionType) {
continue
}
if builder.Len() > 0 {
builder.WriteRune(',')
}
builder.WriteString(restrictionType.String())
}
return builder.String()
}
// UserFeatureRestrictionType represents the restriction type of user features
type UserFeatureRestrictionType int64
// User Feature Restriction Type
const (
USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD UserFeatureRestrictionType = 1
USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL UserFeatureRestrictionType = 2
USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO UserFeatureRestrictionType = 3
USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR UserFeatureRestrictionType = 4
USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION UserFeatureRestrictionType = 5
USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA UserFeatureRestrictionType = 6
USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA UserFeatureRestrictionType = 7
USER_FEATURE_RESTRICTION_TYPE_FORGET_PASSWORD UserFeatureRestrictionType = 8
USER_FEATURE_RESTRICTION_TYPE_IMPORT_TRANSACTION UserFeatureRestrictionType = 9
USER_FEATURE_RESTRICTION_TYPE_EXPORT_TRANSACTION UserFeatureRestrictionType = 10
USER_FEATURE_RESTRICTION_TYPE_CLEAR_ALL_DATA UserFeatureRestrictionType = 11
)
// String returns a textual representation of the restriction type of user features
func (t UserFeatureRestrictionType) String() string {
switch t {
case USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD:
return "Update Password"
case USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL:
return "Update Email"
case USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO:
return "Update Profile Basic Info"
case USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR:
return "Update Avatar"
case USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION:
return "Logout Other Session"
case USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA:
return "Enable Two-Factor Authentication"
case USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA:
return "Disable Enable Two-Factor Authentication"
case USER_FEATURE_RESTRICTION_TYPE_FORGET_PASSWORD:
return "Forget Password"
case USER_FEATURE_RESTRICTION_TYPE_IMPORT_TRANSACTION:
return "Import Transactions"
case USER_FEATURE_RESTRICTION_TYPE_EXPORT_TRANSACTION:
return "Export Transactions"
case USER_FEATURE_RESTRICTION_TYPE_CLEAR_ALL_DATA:
return "Clear All Data"
default:
return fmt.Sprintf("Invalid(%d)", int(t))
}
}
// User represents user data stored in database
type User struct {
Uid int64 `xorm:"PK"`
@@ -104,6 +193,7 @@ type User struct {
CurrencyDisplayType core.CurrencyDisplayType `xorm:"TINYINT"`
ExpenseAmountColor AmountColorType `xorm:"TINYINT"`
IncomeAmountColor AmountColorType `xorm:"TINYINT"`
FeatureRestriction UserFeatureRestrictions
Disabled bool
Deleted bool `xorm:"NOT NULL"`
EmailVerified bool `xorm:"NOT NULL"`
+89
View File
@@ -10,6 +10,95 @@ import (
"github.com/mayswind/ezbookkeeping/pkg/utils"
)
func TestUserFeatureRestrictionsAdd(t *testing.T) {
var featureRestrictions UserFeatureRestrictions
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD)
expectedValue := UserFeatureRestrictions(1)
assert.Equal(t, expectedValue, featureRestrictions)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_FORGET_PASSWORD)
expectedValue = UserFeatureRestrictions(255)
assert.Equal(t, expectedValue, featureRestrictions)
}
func TestUserFeatureRestrictionsRemove(t *testing.T) {
var featureRestrictions UserFeatureRestrictions
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION)
expectedValue := UserFeatureRestrictions(1)
assert.Equal(t, expectedValue, featureRestrictions)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_FORGET_PASSWORD)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA)
featureRestrictions = featureRestrictions.Remove(USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA)
expectedValue = UserFeatureRestrictions(153)
assert.Equal(t, expectedValue, featureRestrictions)
}
func TestUserFeatureRestrictionsContains(t *testing.T) {
var featureRestrictions UserFeatureRestrictions
assert.False(t, featureRestrictions.Contains(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD))
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD)
assert.True(t, featureRestrictions.Contains(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD))
assert.False(t, featureRestrictions.Contains(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO))
}
func TestUserFeatureRestrictionsString(t *testing.T) {
var featureRestrictions UserFeatureRestrictions
expectedValue := ""
actualValue := featureRestrictions.String()
assert.Equal(t, expectedValue, actualValue)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PASSWORD)
expectedValue = "Update Password"
actualValue = featureRestrictions.String()
assert.Equal(t, expectedValue, actualValue)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_FORGET_PASSWORD)
expectedValue = "Update Password,Forget Password"
actualValue = featureRestrictions.String()
assert.Equal(t, expectedValue, actualValue)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_EMAIL)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_PROFILE_BASIC_INFO)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_UPDATE_AVATAR)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_REVOKE_OTHER_SESSION)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_ENABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_DISABLE_2FA)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_IMPORT_TRANSACTION)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_EXPORT_TRANSACTION)
featureRestrictions = featureRestrictions.Add(USER_FEATURE_RESTRICTION_TYPE_CLEAR_ALL_DATA)
expectedValue = "Update Password," +
"Update Email," +
"Update Profile Basic Info," +
"Update Avatar," +
"Logout Other Session," +
"Enable Two-Factor Authentication," +
"Disable Enable Two-Factor Authentication," +
"Forget Password," +
"Import Transactions," +
"Export Transactions," +
"Clear All Data"
actualValue = featureRestrictions.String()
assert.Equal(t, expectedValue, actualValue)
}
func TestUserCanEditTransactionByTransactionTime_ScopeIsNone(t *testing.T) {
user := &User{
TransactionEditScope: TRANSACTION_EDIT_SCOPE_NONE,