rest

package
v0.0.0-...-aac29df Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 25, 2020 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const (
	TRUE  = "true"
	FALSE = "false"

	DIRECTION_ASC  = "ASC"
	DIRECTION_DESC = "DESC"
)
View Source
const (
	//guest
	USER_ROLE_GUEST = "GUEST"
	//normal user
	USER_ROLE_USER = "USER"
	//administrator
	USER_ROLE_ADMINISTRATOR = "ADMINISTRATOR"
)
View Source
const (
	//ok
	USER_STATUS_OK = "OK"
	//disabled
	USER_STATUS_DISABLED = "DISABLED"
)
View Source
const (
	//username pattern
	USERNAME_PATTERN = `^[0-9a-z_]+$`
	USERNAME_DEMO    = "demo"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Article

type Article struct {
	Base
	UserUuid       string `json:"userUuid" gorm:"type:char(36)"`
	Title          string `json:"title" gorm:"type:varchar(255) not null"`
	Path           string `json:"path" gorm:"type:varchar(45) not null"`
	Tags           string `json:"tags" gorm:"type:varchar(1024) not null"`
	PosterTankUuid string `json:"posterTankUuid" gorm:"type:char(36)"`
	PosterUrl      string `json:"posterUrl" gorm:"type:varchar(512) not null"`
	Author         string `json:"author" gorm:"type:varchar(45) not null"`
	Digest         string `json:"digest" gorm:"type:varchar(512) not null"`
	IsMarkdown     bool   `json:"isMarkdown" gorm:"type:tinyint(1) not null;default:1"`
	Markdown       string `json:"markdown" gorm:"type:mediumtext"`
	Html           string `json:"html" gorm:"type:mediumtext"`
	Privacy        bool   `json:"privacy" gorm:"type:tinyint(1) not null;default:0"`
	Top            bool   `json:"top" gorm:"type:tinyint(1) not null;default:0"`
	Agree          int64  `json:"agree" gorm:"type:bigint(20) not null;default:0"`
	Words          int64  `json:"words" gorm:"type:bigint(20) not null;default:0"`
	Hit            int64  `json:"hit" gorm:"type:bigint(20) not null;default:0"`
	CommentNum     int64  `json:"commentNum" gorm:"type:bigint(20) not null;default:0"`
}

*

  • article

func (*Article) TableName

func (this *Article) TableName() string

set File's table name to be `profiles`

type ArticleController

type ArticleController struct {
	BaseController
	// contains filtered or unexported fields
}

func (*ArticleController) Create

func (this *ArticleController) Create(writer http.ResponseWriter, request *http.Request) *result.WebResult

Create an article.

func (*ArticleController) Delete

func (this *ArticleController) Delete(writer http.ResponseWriter, request *http.Request) *result.WebResult

delete an article.

func (*ArticleController) Detail

func (this *ArticleController) Detail(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*ArticleController) Edit

func (this *ArticleController) Edit(writer http.ResponseWriter, request *http.Request) *result.WebResult

Edit an article.

func (*ArticleController) Init

func (this *ArticleController) Init()

func (*ArticleController) List

func (this *ArticleController) List(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*ArticleController) RegisterRoutes

func (this *ArticleController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

type ArticleDao

type ArticleDao struct {
	BaseDao
}

func (*ArticleDao) CheckByUuid

func (this *ArticleDao) CheckByUuid(uuid string) *Article

find by uuid. if not found panic NotFound error

func (*ArticleDao) Cleanup

func (this *ArticleDao) Cleanup()

System cleanup.

func (*ArticleDao) CountBetweenTime

func (this *ArticleDao) CountBetweenTime(startTime time.Time, endTime time.Time) int64

func (*ArticleDao) Create

func (this *ArticleDao) Create(article *Article) *Article

func (*ArticleDao) Delete

func (this *ArticleDao) Delete(article *Article)

func (*ArticleDao) FindByUuid

func (this *ArticleDao) FindByUuid(uuid string) *Article

find by uuid. if not found return nil.

func (*ArticleDao) Page

func (this *ArticleDao) Page(page int, pageSize int, userUuid string, title string, path string, author string, sortArray []builder.OrderPair) *Pager

func (*ArticleDao) Save

func (this *ArticleDao) Save(article *Article) *Article

type ArticleService

type ArticleService struct {
	BaseBean
	// contains filtered or unexported fields
}

@Service

func (*ArticleService) Bootstrap

func (this *ArticleService) Bootstrap()

func (*ArticleService) Detail

func (this *ArticleService) Detail(uuid string) *Article

func (*ArticleService) Init

func (this *ArticleService) Init()

type Base

type Base struct {
	Uuid       string    `json:"uuid" gorm:"type:char(36);primary_key;unique"`
	Sort       int64     `json:"sort" gorm:"type:bigint(20) not null"`
	UpdateTime time.Time `json:"updateTime" gorm:"type:timestamp not null;default:CURRENT_TIMESTAMP"`
	CreateTime time.Time `json:"createTime" gorm:"type:timestamp not null;default:'2018-01-01 00:00:00'"`
}

Mysql 5.5 only support one CURRENT_TIMESTAMP so we use 2018-01-01 00:00:00 as default, which is the first release date of EyeblueBamboo

func (*Base) TableName

func (this *Base) TableName() string

type BaseBean

type BaseBean struct {
	// contains filtered or unexported fields
}

func (*BaseBean) Bootstrap

func (this *BaseBean) Bootstrap()

func (*BaseBean) Cleanup

func (this *BaseBean) Cleanup()

clean up the application.

func (*BaseBean) Init

func (this *BaseBean) Init()

func (*BaseBean) PanicError

func (this *BaseBean) PanicError(err error)

shortcut for panic check.

type BaseController

type BaseController struct {
	BaseBean
	// contains filtered or unexported fields
}

func (*BaseController) HandleRoutes

func (this *BaseController) HandleRoutes(writer http.ResponseWriter, request *http.Request) (func(writer http.ResponseWriter, request *http.Request), bool)

handle some special routes, eg. params in the url.

func (*BaseController) Init

func (this *BaseController) Init()

func (*BaseController) RegisterRoutes

func (this *BaseController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

func (*BaseController) Success

func (this *BaseController) Success(data interface{}) *result.WebResult

response a success result. 1.string 2. WebResult 3.nil pointer 4.any type

func (*BaseController) Wrap

func (this *BaseController) Wrap(f func(writer http.ResponseWriter, request *http.Request) *result.WebResult, qualifiedRole string) func(w http.ResponseWriter, r *http.Request)

wrap the handle method.

type BaseDao

type BaseDao struct {
	BaseBean
}

func (*BaseDao) GetSortString

func (this *BaseDao) GetSortString(sortArray []builder.OrderPair) string

get an order string by sortMap

type Footprint

type Footprint struct {
	Base
	UserUuid string `json:"userUuid" gorm:"type:char(36)"`
	Ip       string `json:"ip" gorm:"type:varchar(128) not null"`
	Host     string `json:"host" gorm:"type:varchar(45) not null"`
	Uri      string `json:"uri" gorm:"type:varchar(255) not null"`
	Params   string `json:"params" gorm:"type:text"`
	Cost     int64  `json:"cost" gorm:"type:bigint(20) not null;default:0"`
	Success  bool   `json:"success" gorm:"type:tinyint(1) not null;default:0"`
}

*

  • visit record.

func (*Footprint) TableName

func (this *Footprint) TableName() string

set File's table name to be `profiles`

type FootprintController

type FootprintController struct {
	BaseController
	// contains filtered or unexported fields
}

func (*FootprintController) Init

func (this *FootprintController) Init()

func (*FootprintController) RegisterRoutes

func (this *FootprintController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

type FootprintDao

type FootprintDao struct {
	BaseDao
}

func (*FootprintDao) AvgCostBetweenTime

func (this *FootprintDao) AvgCostBetweenTime(startTime time.Time, endTime time.Time) int64

func (*FootprintDao) CheckByUuid

func (this *FootprintDao) CheckByUuid(uuid string) *Footprint

find by uuid. if not found panic NotFound error

func (*FootprintDao) Cleanup

func (this *FootprintDao) Cleanup()

System cleanup.

func (*FootprintDao) CountBetweenTime

func (this *FootprintDao) CountBetweenTime(startTime time.Time, endTime time.Time) int64

func (*FootprintDao) Create

func (this *FootprintDao) Create(footprint *Footprint) *Footprint

func (*FootprintDao) Delete

func (this *FootprintDao) Delete(footprint *Footprint)

func (*FootprintDao) DeleteByCreateTimeBefore

func (this *FootprintDao) DeleteByCreateTimeBefore(createTime time.Time)

func (*FootprintDao) FindByUuid

func (this *FootprintDao) FindByUuid(uuid string) *Footprint

find by uuid. if not found return nil.

func (*FootprintDao) Page

func (this *FootprintDao) Page(page int, pageSize int, userUuid string, sortArray []builder.OrderPair) *Pager

func (*FootprintDao) Save

func (this *FootprintDao) Save(footprint *Footprint) *Footprint

func (*FootprintDao) UvBetweenTime

func (this *FootprintDao) UvBetweenTime(startTime time.Time, endTime time.Time) int64

type FootprintService

type FootprintService struct {
	BaseBean
	// contains filtered or unexported fields
}

@Service

func (*FootprintService) Bootstrap

func (this *FootprintService) Bootstrap()

func (*FootprintService) Detail

func (this *FootprintService) Detail(uuid string) *Footprint

func (*FootprintService) Init

func (this *FootprintService) Init()

func (*FootprintService) Trace

func (this *FootprintService) Trace(request *http.Request, duration time.Duration, success bool)

log a request.

type IBase

type IBase interface {
	//name of db table
	TableName() string
}

type InstallController

type InstallController struct {
	BaseController
	// contains filtered or unexported fields
}

install apis. Only when installing period can be visited.

func (*InstallController) AdminList

func (this *InstallController) AdminList(writer http.ResponseWriter, request *http.Request) *result.WebResult

get the list of admin.

func (*InstallController) CreateAdmin

func (this *InstallController) CreateAdmin(writer http.ResponseWriter, request *http.Request) *result.WebResult

create admin

func (*InstallController) CreateTable

func (this *InstallController) CreateTable(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*InstallController) Finish

func (this *InstallController) Finish(writer http.ResponseWriter, request *http.Request) *result.WebResult

Finish the installation

func (*InstallController) Init

func (this *InstallController) Init()

func (*InstallController) RegisterRoutes

func (this *InstallController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

func (*InstallController) TableInfoList

func (this *InstallController) TableInfoList(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*InstallController) ValidateAdmin

func (this *InstallController) ValidateAdmin(writer http.ResponseWriter, request *http.Request) *result.WebResult

(if there is admin in db)Validate admin.

func (*InstallController) Verify

func (this *InstallController) Verify(writer http.ResponseWriter, request *http.Request) *result.WebResult

Ping db.

type InstallTableInfo

type InstallTableInfo struct {
	Name          string              `json:"name"`
	TableExist    bool                `json:"tableExist"`
	AllFields     []*gorm.StructField `json:"allFields"`
	MissingFields []*gorm.StructField `json:"missingFields"`
}

*

  • table meta info.

type Pager

type Pager struct {
	Page       int         `json:"page"`
	PageSize   int         `json:"pageSize"`
	TotalItems int         `json:"totalItems"`
	TotalPages int         `json:"totalPages"`
	Data       interface{} `json:"data"`
}

pager

func NewPager

func NewPager(page int, pageSize int, totalItems int, data interface{}) *Pager

type Preference

type Preference struct {
	Base
	Name          string `json:"name" gorm:"type:varchar(45)"`
	LogoUrl       string `json:"logoUrl" gorm:"type:varchar(255)"`
	FaviconUrl    string `json:"faviconUrl" gorm:"type:varchar(255)"`
	Copyright     string `json:"copyright" gorm:"type:varchar(1024)"`
	Record        string `json:"record" gorm:"type:varchar(1024)"`
	AllowRegister bool   `json:"allowRegister" gorm:"type:tinyint(1) not null;default:0"`
	Version       string `json:"version" gorm:"-"`
}

func (*Preference) TableName

func (this *Preference) TableName() string

set File's table name to be `profiles`

type PreferenceController

type PreferenceController struct {
	BaseController
	// contains filtered or unexported fields
}

func (*PreferenceController) Edit

func (this *PreferenceController) Edit(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*PreferenceController) Fetch

func (this *PreferenceController) Fetch(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*PreferenceController) Init

func (this *PreferenceController) Init()

func (*PreferenceController) Ping

func (this *PreferenceController) Ping(writer http.ResponseWriter, request *http.Request) *result.WebResult

ping the application. Return current version.

func (*PreferenceController) RegisterRoutes

func (this *PreferenceController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

func (*PreferenceController) SystemCleanup

func (this *PreferenceController) SystemCleanup(writer http.ResponseWriter, request *http.Request) *result.WebResult

cleanup system data.

type PreferenceDao

type PreferenceDao struct {
	BaseDao
}

func (*PreferenceDao) Cleanup

func (this *PreferenceDao) Cleanup()

System cleanup.

func (*PreferenceDao) Create

func (this *PreferenceDao) Create(preference *Preference) *Preference

func (*PreferenceDao) Fetch

func (this *PreferenceDao) Fetch() *Preference

find by uuid. if not found return nil.

func (*PreferenceDao) Save

func (this *PreferenceDao) Save(preference *Preference) *Preference

type PreferenceService

type PreferenceService struct {
	BaseBean
	// contains filtered or unexported fields
}

@Service

func (*PreferenceService) Cleanup

func (this *PreferenceService) Cleanup()

System cleanup.

func (*PreferenceService) Fetch

func (this *PreferenceService) Fetch() *Preference

func (*PreferenceService) Init

func (this *PreferenceService) Init()

func (*PreferenceService) Reset

func (this *PreferenceService) Reset()

清空单例配置。

type Session

type Session struct {
	Base
	UserUuid   string    `json:"userUuid" gorm:"type:char(36)"`
	Ip         string    `json:"ip" gorm:"type:varchar(128) not null"`
	ExpireTime time.Time `json:"expireTime" gorm:"type:timestamp not null;default:'2018-01-01 00:00:00'"`
}

func (*Session) TableName

func (this *Session) TableName() string

set User's table name to be `profiles`

type SessionDao

type SessionDao struct {
	BaseDao
}

func (*SessionDao) CheckByUuid

func (this *SessionDao) CheckByUuid(uuid string) *Session

find by uuid. if not found panic NotFound error

func (*SessionDao) Cleanup

func (this *SessionDao) Cleanup()

System cleanup.

func (*SessionDao) Create

func (this *SessionDao) Create(session *Session) *Session

func (*SessionDao) Delete

func (this *SessionDao) Delete(uuid string)

func (*SessionDao) FindByUuid

func (this *SessionDao) FindByUuid(uuid string) *Session

find by uuid. if not found return nil.

func (*SessionDao) Save

func (this *SessionDao) Save(session *Session) *Session

type SessionService

type SessionService struct {
	BaseBean
	// contains filtered or unexported fields
}

@Service

func (*SessionService) Cleanup

func (this *SessionService) Cleanup()

System cleanup.

func (*SessionService) Init

func (this *SessionService) Init()

type User

type User struct {
	Base
	Role      string    `json:"role" gorm:"type:varchar(45)"`
	Username  string    `json:"username" gorm:"type:varchar(45) not null;unique"`
	Password  string    `json:"-" gorm:"type:varchar(255)"`
	AvatarUrl string    `json:"avatarUrl" gorm:"type:varchar(255)"`
	LastIp    string    `json:"lastIp" gorm:"type:varchar(128)"`
	LastTime  time.Time `json:"lastTime" gorm:"type:timestamp not null;default:'2018-01-01 00:00:00'"`
	Status    string    `json:"status" gorm:"type:varchar(45)"`
}

func (*User) TableName

func (this *User) TableName() string

set User's table name to be `profiles`

type UserController

type UserController struct {
	BaseController
	// contains filtered or unexported fields
}

func (*UserController) AuthenticationLogin

func (this *UserController) AuthenticationLogin(writer http.ResponseWriter, request *http.Request) *result.WebResult

login by authentication.

func (*UserController) ChangePassword

func (this *UserController) ChangePassword(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Create

func (this *UserController) Create(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Detail

func (this *UserController) Detail(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Edit

func (this *UserController) Edit(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Info

func (this *UserController) Info(writer http.ResponseWriter, request *http.Request) *result.WebResult

Get the info of current login user.

func (*UserController) Init

func (this *UserController) Init()

func (*UserController) List

func (this *UserController) List(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Login

func (this *UserController) Login(writer http.ResponseWriter, request *http.Request) *result.WebResult

login by username and password

func (*UserController) Logout

func (this *UserController) Logout(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Register

func (this *UserController) Register(writer http.ResponseWriter, request *http.Request) *result.WebResult

register by username and password. After registering, will auto login.

func (*UserController) RegisterRoutes

func (this *UserController) RegisterRoutes() map[string]func(writer http.ResponseWriter, request *http.Request)

func (*UserController) ResetPassword

func (this *UserController) ResetPassword(writer http.ResponseWriter, request *http.Request) *result.WebResult

admin reset password.

func (*UserController) ToggleStatus

func (this *UserController) ToggleStatus(writer http.ResponseWriter, request *http.Request) *result.WebResult

func (*UserController) Transfiguration

func (this *UserController) Transfiguration(writer http.ResponseWriter, request *http.Request) *result.WebResult

type UserDao

type UserDao struct {
	BaseDao
}

func (*UserDao) CheckByUuid

func (this *UserDao) CheckByUuid(uuid string) *User

find by uuid. if not found panic NotFound error

func (*UserDao) Cleanup

func (this *UserDao) Cleanup()

System cleanup.

func (*UserDao) CountByUsername

func (this *UserDao) CountByUsername(username string) int

func (*UserDao) Create

func (this *UserDao) Create(user *User) *User

func (*UserDao) DeleteUsers20

func (this *UserDao) DeleteUsers20()

func (*UserDao) FindByUsername

func (this *UserDao) FindByUsername(username string) *User

func (*UserDao) FindByUuid

func (this *UserDao) FindByUuid(uuid string) *User

find by uuid. if not found return nil.

func (*UserDao) FindUsers20

func (this *UserDao) FindUsers20() []*User

find all 2.0 users.

func (*UserDao) Init

func (this *UserDao) Init()

func (*UserDao) Page

func (this *UserDao) Page(page int, pageSize int, username string, status string, sortArray []builder.OrderPair) *Pager

func (*UserDao) Save

func (this *UserDao) Save(user *User) *User

type UserService

type UserService struct {
	BaseBean
	// contains filtered or unexported fields
}

@Service

func (*UserService) FindCacheUsersByUuid

func (this *UserService) FindCacheUsersByUuid(userUuid string) []*User

find a cache user by its userUuid

func (*UserService) Init

func (this *UserService) Init()

func (*UserService) MatterLock

func (this *UserService) MatterLock(userUuid string)

lock a user's operation. If lock, user cannot operate file.

func (*UserService) MatterUnlock

func (this *UserService) MatterUnlock(userUuid string)

unlock

func (*UserService) PreHandle

func (this *UserService) PreHandle(writer http.ResponseWriter, request *http.Request)

load session to SessionCache. This method will be invoked in every request. authorize by 1. cookie 2. username and password in request form. 3. Basic Auth

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址