summaryrefslogtreecommitdiff
path: root/shrine/models/user.go
blob: 503c61a92268e216a6ded5f56c1cbf95e1ccfed3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
package models

import (
	"errors"
	"shrine/enums"
	"shrine/messages"
	"shrine/types/user"
	"shrine/utils/storage"
	"shrine/utils/validators"
	"strings"
	"time"

	"golang.org/x/crypto/bcrypt"
	"gorm.io/gorm"
)

type User struct {
	gorm.Model
	Username        string         `gorm:"uniqueIndex;size:32;not null"`
	Email           string         `gorm:"uniqueIndex;size:255;not null"`
	PasswordHash    string         `gorm:"size:255;not null"`
	DisplayName string         `gorm:"size:50;not null"`
	Bio         string         `gorm:"size:500"`
	Birthday    *time.Time
	AvatarURL   string         `gorm:"size:512;not null;default:defaults/avatar.png"`
	BlinkieURL  string         `gorm:"size:512"`
	Website     string         `gorm:"size:255"`
	Location    string         `gorm:"size:100"`
	Pronouns    string         `gorm:"size:50"`
	Signature   string         `gorm:"size:500"`
	Jade        uint64         `gorm:"not null;default:0"`
	Honor       uint64         `gorm:"not null;default:0"`
	Role            enums.UserRole         `gorm:"size:20;not null;default:member"`
	EmailVerified      bool                `gorm:"not null;default:false"`
	VerificationHash   string              `gorm:"size:64"`
	VerificationExpiry *time.Time
	VerificationType   enums.VerificationType `gorm:"size:20"`
	AccountBanned   bool       `gorm:"not null;default:false"`
	BannedAt        *time.Time
	BannedReason    string     `gorm:"size:500"`
	BannedBy        *uint      `gorm:"index"`
	AccountDisabled bool       `gorm:"not null;default:false"`
	DisabledAt      *time.Time
	DisabledReason  string     `gorm:"size:500"`
	DisabledBy      *uint      `gorm:"index"`
	DisabledUntil   *time.Time
	WarningCount    uint       `gorm:"not null;default:0"`
	LastSeenAt      *time.Time
	IP              string     `gorm:"size:45"`
}

func (self *User) SetPassword(password string) error {
	if len(password) < 8 {
		return errors.New(messages.PasswordTooShort)
	}
	if len(password) > 255 {
		return errors.New(messages.PasswordTooLong)
	}
	hash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
	if err != nil {
		return err
	}
	self.PasswordHash = string(hash)
	return nil
}

func (self *User) CheckPassword(password string) bool {
	return bcrypt.CompareHashAndPassword([]byte(self.PasswordHash), []byte(password)) == nil
}

func (self *User) IsOwner() bool {
	return self.Role == enums.Owner
}

func (self *User) IsAdmin() bool {
	return self.Role == enums.Admin || self.IsOwner()
}

func (self *User) IsModerator() bool {
	return self.Role == enums.Moderator
}

func (self *User) IsStaff() bool {
	return self.IsAdmin() || self.IsModerator()
}

func (self *User) CanAuthenticate() bool {
	return !self.AccountBanned && !self.AccountDisabled
}

func (self *User) ClearExpiredDisable() bool {
	if !self.AccountDisabled || self.DisabledUntil == nil || !self.DisabledUntil.Before(time.Now()) {
		return false
	}

	self.AccountDisabled = false
	self.DisabledAt = nil
	self.DisabledReason = ""
	self.DisabledBy = nil
	self.DisabledUntil = nil
	return true
}

func (self *User) IsVerified() bool {
	return self.EmailVerified
}

func (self *User) SetVerification(hash string, expiry time.Time, verificationType enums.VerificationType) {
	self.VerificationHash = hash
	self.VerificationExpiry = &expiry
	self.VerificationType = verificationType
}

func (self *User) VerifyEmail() {
	self.EmailVerified = true
	self.VerificationHash = ""
	self.VerificationExpiry = nil
	self.VerificationType = ""
}

func (self *User) ToResponse() user.UserResponse {
	return user.UserResponse{
		Username:    self.Username,
		Email:       self.Email,
		DisplayName: self.DisplayName,
		Bio:         self.Bio,
		Birthday:    self.Birthday,
		AvatarURL:   storage.ResolveCDN(self.AvatarURL),
		BlinkieURL:  storage.ResolveCDN(self.BlinkieURL),
		Website:     self.Website,
		Location:    self.Location,
		Pronouns:    self.Pronouns,
		Signature:   self.Signature,
		Role:        string(self.Role),
		CreatedAt:   self.CreatedAt,
	}
}

func (self *User) ToAdminResponse() user.AdminUserResponse {
	return user.AdminUserResponse{
		UserResponse:    self.ToResponse(),
		Jade:            self.Jade,
		Honor:           self.Honor,
		EmailVerified:   self.EmailVerified,
		WarningCount:    self.WarningCount,
		AccountBanned:   self.AccountBanned,
		BannedReason:    self.BannedReason,
		BannedAt:        self.BannedAt,
		AccountDisabled: self.AccountDisabled,
		DisabledReason:  self.DisabledReason,
		DisabledAt:      self.DisabledAt,
		DisabledUntil:   self.DisabledUntil,
		LastSeenAt:      self.LastSeenAt,
	}
}

func (self *User) ToSummary() user.CitizenSummaryResponse {
	return user.CitizenSummaryResponse{
		Username:    self.Username,
		DisplayName: self.DisplayName,
		AvatarURL:   storage.ResolveCDN(self.AvatarURL),
	}
}

func (self *User) BeforeCreate(tx *gorm.DB) error {
	_, bypassUsername := tx.Get("bypass_username_validation")

	if !bypassUsername {
		if !validators.IsValidUsername(self.Username, 3) {
			return errors.New(messages.InvalidUsername)
		}
		if validators.IsReservedUsername(self.Username) {
			return errors.New(messages.UsernameNotAvailable)
		}
	}

	if !validators.IsValidEmail(self.Email) {
		return errors.New(messages.InvalidEmail)
	}

	if len(strings.TrimSpace(self.DisplayName)) < 1 || len(strings.TrimSpace(self.DisplayName)) > 50 {
		return errors.New(messages.InvalidDisplayName)
	}

	if self.PasswordHash == "" {
		return errors.New(messages.PasswordRequired)
	}

	self.Email = strings.ToLower(strings.TrimSpace(self.Email))
	self.DisplayName = strings.TrimSpace(self.DisplayName)
	self.Username = strings.TrimSpace(self.Username)

	return nil
}

func (self *User) BeforeUpdate(tx *gorm.DB) error {
	if !validators.IsValidEmail(self.Email) {
		return errors.New(messages.InvalidEmail)
	}

	if len(strings.TrimSpace(self.DisplayName)) < 1 || len(strings.TrimSpace(self.DisplayName)) > 50 {
		return errors.New(messages.InvalidDisplayName)
	}

	if self.Jade > validators.MaxJade {
		return errors.New(messages.JadeExceedsMax)
	}

	self.Email = strings.ToLower(strings.TrimSpace(self.Email))
	self.DisplayName = strings.TrimSpace(self.DisplayName)

	return nil
}