woodpecker/server/model/user.go

94 lines
2.5 KiB
Go
Raw Normal View History

// Copyright 2021 Woodpecker Authors
2018-02-19 22:24:10 +00:00
// Copyright 2018 Drone.IO Inc.
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00:00
// 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
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00:00
// http://www.apache.org/licenses/LICENSE-2.0
2018-03-21 13:02:17 +00:00
//
2018-02-19 22:24:10 +00:00
// 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.
2015-09-30 01:21:17 +00:00
package model
2017-07-17 04:01:35 +00:00
import (
"errors"
"regexp"
)
// Validate a username (e.g. from github).
2017-10-05 21:02:23 +00:00
var reUsername = regexp.MustCompile("^[a-zA-Z0-9-_.]+$")
2017-07-17 04:01:35 +00:00
var errUserLoginInvalid = errors.New("invalid user login")
2017-07-17 04:01:35 +00:00
2024-03-15 17:00:25 +00:00
const maxLoginLen = 250
// User represents a registered user.
type User struct {
// the id for this user.
//
// required: true
ID int64 `json:"id" xorm:"pk autoincr 'id'"`
ForgeID int64 `json:"forge_id,omitempty" xorm:"forge_id"`
ForgeRemoteID ForgeRemoteID `json:"-" xorm:"forge_remote_id"`
// Login is the username for this user.
//
// required: true
Login string `json:"login" xorm:"UNIQUE 'login'"`
// Token is the oauth2 token.
Token string `json:"-" xorm:"TEXT 'token'"`
// Secret is the oauth2 token secret.
Secret string `json:"-" xorm:"TEXT 'secret'"`
2018-02-15 08:39:59 +00:00
// Expiry is the token and secret expiration timestamp.
Expiry int64 `json:"-" xorm:"expiry"`
// Email is the email address for this user.
//
// required: true
Email string `json:"email" xorm:" varchar(500) 'email'"`
// the avatar url for this user.
Avatar string `json:"avatar_url" xorm:" varchar(500) 'avatar'"`
// Admin indicates the user is a system administrator.
2016-05-02 19:21:25 +00:00
//
// NOTE: If the username is part of the WOODPECKER_ADMIN
// environment variable, this value will be set to true on login.
Admin bool `json:"admin,omitempty" xorm:"admin"`
// Hash is a unique token used to sign tokens.
Hash string `json:"-" xorm:"UNIQUE varchar(500) 'hash'"`
2023-08-21 13:04:12 +00:00
// OrgID is the of the user as model.Org.
OrgID int64 `json:"org_id" xorm:"org_id"`
} // @name User
// TableName return database table name for xorm.
func (User) TableName() string {
return "users"
2015-09-30 01:21:17 +00:00
}
2017-07-17 04:01:35 +00:00
// Validate validates the required fields and formats.
func (u *User) Validate() error {
switch {
case len(u.Login) == 0:
return errUserLoginInvalid
2024-03-15 17:00:25 +00:00
case len(u.Login) > maxLoginLen:
2017-07-17 04:01:35 +00:00
return errUserLoginInvalid
case !reUsername.MatchString(u.Login):
return errUserLoginInvalid
default:
return nil
}
}