bbs

type ArticleRecord interface {
	Filename() string
	Modified() time.Time
	SetModified(newModified time.Time)
	Recommend() int
	Date() string
	Title() string
	Money() int
	Owner() string
}

type BadPostUserRecord interface {
	// NumBadPosts return how many bad post this use have
	NumBadPosts() int
}

type BoardRecord interface {
	BoardID() string

	Title() string

	IsClass() bool
	// ClassID should return the class id to which this board/class belongs.
	ClassID() string

	BM() []string
}

type BoardRecordInfo interface {
	GetPostLimitPosts() uint8
	GetPostLimitLogins() uint8
	GetPostLimitBadPost() uint8
}

type BoardRecordSettings interface {
	IsHide() bool
	IsPostMask() bool
	IsAnonymous() bool
	IsDefaultAnonymous() bool
	IsNoCredit() bool
	IsVoteBoard() bool
	IsWarnEL() bool
	IsTop() bool
	IsNoRecommend() bool
	IsAngelAnonymous() bool
	IsBMCount() bool
	IsNoBoo() bool
	IsRestrictedPost() bool
	IsGuestPost() bool
	IsCooldown() bool
	IsCPLog() bool
	IsNoFastRecommend() bool
	IsIPLogRecommend() bool
	IsOver18() bool
	IsNoReply() bool
	IsAlignedComment() bool
	IsNoSelfDeletePost() bool
	IsBMMaskContent() bool
}

type Connector interface {
	// Open provides the driver parameter settings, such as BBSHome parameter and SHM parameters.
	Open(dataSourceName string) error
	// GetUserRecordsPath should return user records file path, eg: BBSHome/.PASSWDS
	GetUserRecordsPath() (string, error)
	// ReadUserRecordsFile should return UserRecord list in the file called name
	ReadUserRecordsFile(name string) ([]UserRecord, error)
	// GetUserFavoriteRecordsPath should return the user favorite records file path
	// for specific user, eg: BBSHOME/home/{{u}}/{{userID}}/.fav
	GetUserFavoriteRecordsPath(userID string) (string, error)
	// ReadUserFavoriteRecordsFile should return FavoriteRecord list in the file called name
	ReadUserFavoriteRecordsFile(name string) ([]FavoriteRecord, error)
	// GetBoardRecordsPath should return the board headers file path, eg: BBSHome/.BRD
	GetBoardRecordsPath() (string, error)
	// ReadBoardRecordsFile shoule return BoardRecord list in file, name is the file name
	ReadBoardRecordsFile(name string) ([]BoardRecord, error)
	// GetBoardArticleRecordsPath should return the article records file path, boardID is the board id,
	// eg: BBSHome/boards/{{b}}/{{boardID}}/.DIR
	GetBoardArticleRecordsPath(boardID string) (string, error)
	// GetBoardArticleRecordsPath should return the treasure records file path, boardID is the board id,
	// eg: BBSHome/man/boards/{{b}}/{{boardID}}/{{treasureID}}/.DIR
	GetBoardTreasureRecordsPath(boardID string, treasureID []string) (string, error)
	// ReadArticleRecordsFile returns ArticleRecord list in file, name is the file name
	ReadArticleRecordsFile(name string) ([]ArticleRecord, error)
	// GetBoardArticleFilePath return file path for specific boardID and filename
	GetBoardArticleFilePath(boardID string, filename string) (string, error)
	// GetBoardTreasureFilePath return file path for specific boardID, treasureID and filename
	GetBoardTreasureFilePath(boardID string, treasureID []string, name string) (string, error)
	// ReadBoardArticleFile should returns raw file of specific file name
	ReadBoardArticleFile(name string) ([]byte, error)
}

type Cstr []byte

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

type FavoriteRecord interface {
	Title() string
	Type() FavoriteType
	BoardID() string

	// Records is FavoriteTypeFolder only.
	Records() []FavoriteRecord
}

type FavoriteType int

type LastCountryUserRecord interface {
	// LastLoginCountry will return the country with this user's last login IP
	LastLoginCountry() string
}

type MailboxUserRecord interface {
	// MailboxDescription will return the mailbox description with this user
	MailboxDescription() string
}

type UserArticleConnector interface {

	// GetUserArticleRecordsPath should return the file path which user article record stores.
	GetUserArticleRecordsPath(userID string) (string, error)

	// ReadUserArticleRecordFile should return the article record in file.
	ReadUserArticleRecordFile(name string) ([]UserArticleRecord, error)

	// WriteUserArticleRecordFile write user article records into file.
	WriteUserArticleRecordFile(name string, records []UserArticleRecord) error

	// AppendUserArticleRecordFile append user article records into file.
	AppendUserArticleRecordFile(name string, record UserArticleRecord) error
}

type UserArticleRecord interface {
	BoardID() string
	Title() string
	Owner() string
	ArticleID() string
}

type UserCommentConnector interface {

	// GetUserCommentRecordsPath should return the file path where storing the
	//  user comment records.
	GetUserCommentRecordsPath(userID string) (string, error)

	// ReadUserCommentRecordFile should return the use comment records from the
	//  file.
	ReadUserCommentRecordFile(name string) ([]UserCommentRecord, error)
}

type UserCommentRecord interface {
	CommentOrder() uint32
	CommentTime() time.Time
	Owner() string
	IP() string
	Comment() string
	String() string
	BoardID() string
	Filename() string
}

type UserDraft interface {
	Raw() []byte
}

type UserDraftConnector interface {

	// GetUserDraftPath should return the user's draft file path
	// eg: BBSHome/home/{{u}}/{{userID}}/buf.{{draftID}}
	GetUserDraftPath(userID, draftID string) (string, error)

	// ReadUserDraft return the user draft from the named file.
	ReadUserDraft(name string) ([]byte, error)

	// DeleteUserDraft should remove the named file.
	DeleteUserDraft(name string) error

	// WriteUserDraft should replace user draft from named file and user draft data
	WriteUserDraft(name string, draft []byte) error
}

type UserRecord interface {
	// UserID return user's identification string, and it is userid in
	// mostly bbs system
	UserID() string
	// HashedPassword return user hashed password, it only for debug,
	// If you want to check is user password correct, please use
	// VerifyPassword insteaded.
	HashedPassword() string
	// VerifyPassword will check user's password is OK. it will return null
	// when OK and error when there are something wrong
	VerifyPassword(password string) error
	// Nickname return a string for user's nickname, this string may change
	// depend on user's mood, return empty string if this bbs system do not support
	Nickname() string
	// RealName return a string for user's real name, this string may not be changed
	// return empty string if this bbs system do not support
	RealName() string
	// NumLoginDays return how many days this have been login since account created.
	NumLoginDays() int
	// NumPosts return how many posts this user has posted.
	NumPosts() int
	// Money return the money this user have.
	Money() int
	// LastLogin return last login time of user
	LastLogin() time.Time
	// LastHost return last login host of user, it is IPv4 address usually, but it
	// could be domain name or IPv6 address.
	LastHost() string
	// UserFlag return user setting.
	// uint32, see https://github.com/ptt/pttbbs/blob/master/include/uflags.h
	UserFlag() uint32
}

type WriteArticleConnector interface {

	// CreateBoardArticleFilename returns available filename for board with boardID
	CreateBoardArticleFilename(boardID string) (filename string, err error)

	// NewArticleRecord return ArticleRecord object in this driver with arguments
	NewArticleRecord(filename, owner, date, title string) (ArticleRecord, error)

	// AddArticleRecordFileRecord given record file name and new record, should append
	// file record in that file.
	AddArticleRecordFileRecord(name string, article ArticleRecord) error

	// UpdateArticleRecordFileRecord will write article in position index of name file
	// position is start with 0.
	UpdateArticleRecordFileRecord(name string, index uint, article ArticleRecord) error

	// WriteBoardArticleFile will turncate name file and write content into that file.
	WriteBoardArticleFile(name string, content []byte) error

	// AppendNewLine append content into file
	AppendBoardArticleFile(name string, content []byte) error
}

type WriteBoardConnector interface {

	// NewBoardRecord return BoardRecord object in this driver with arguments
	NewBoardRecord(args map[string]interface{}) (BoardRecord, error)

	// AddBoardRecordFileRecord given record file name and new record, should append
	// file record in that file.
	AddBoardRecordFileRecord(name string, brd BoardRecord) error

	// UpdateBoardRecordFileRecord update boardRecord brd on index in record file,
	// index is start with 0
	UpdateBoardRecordFileRecord(name string, index uint, brd BoardRecord) error

	// ReadBoardRecordFileRecord return boardRecord brd on index in record file.
	ReadBoardRecordFileRecord(name string, index uint) (BoardRecord, error)

	// RemoveBoardRecordFileRecord remove boardRecord brd on index in record file.
	RemoveBoardRecordFileRecord(name string, index uint) error
}