api

package

v0.43.4 Latest Latest Go to latest Published: Jul 14, 2026 License: GPL-3.0 Imports: 36 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Ptt-official-app/pttbbs-backend

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AddFavoriteBoard(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func AddFavoriteBoardWrapper(c *gin.Context)
func AddFavoriteFolder(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func AddFavoriteFolderWrapper(c *gin.Context)
func AddFavoriteLine(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func AddFavoriteLineWrapper(c *gin.Context)
func AllHTMLWrapper(c *gin.Context)
func ArticleLockKey(boardID bbs.BBoardID, articleID bbs.ArticleID) (key string)
func AttemptChangeEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func AttemptChangeEmailWrapper(c *gin.Context)
func AttemptLogin(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func AttemptLoginWrapper(c *gin.Context)
func AttemptRegisterUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func AttemptRegisterUserWrapper(c *gin.Context)
func AttemptSetIDEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func AttemptSetIDEmailWrapper(c *gin.Context)
func ChangeEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func ChangeEmailWrapper(c *gin.Context)
func ChangePasswd(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func ChangePasswdWrapper(c *gin.Context)
func CheckExistsUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func CheckExistsUserWrapper(c *gin.Context)
func CheckUserArticlePermDeletable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, c *gin.Context) (err error)
func CheckUserArticlePermEditable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, ...) (err error)
func CheckUserArticlePermReadable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, ...) (err error)
func CheckUserArticlesPermDeletable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, ...) (articlePermMap map[bbs.ArticleID]error, err error)
func CheckUserArticlesPermEditable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, ...) (articlePermMap map[bbs.ArticleID]error, err error)
func CheckUserArticlesPermEditableDeletable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, ...) (articlePermEditableMap map[bbs.ArticleID]error, ...)
func CheckUserBoardPermCreatable(user *UserInfo, c *gin.Context) (err error)
func CheckUserBoardPermEditable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (err error)
func CheckUserBoardPermPostable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (err error)
func CreateArticle(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func CreateArticleWrapper(c *gin.Context)
func CreateBoard(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func CreateBoardWrapper(c *gin.Context)
func CreateComment(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func CreateCommentWrapper(c *gin.Context)
func CreateRank(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func CreateRankWrapper(c *gin.Context)
func CrossPost(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func CrossPostWrapper(c *gin.Context)
func DeleteArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func DeleteArticlesWrapper(c *gin.Context)
func DeleteComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func DeleteCommentsWrapper(c *gin.Context)
func DeleteFavorite(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func DeleteFavoriteWrapper(c *gin.Context)
func DeserializeArticlesAndUpdateDB(articleSummaries_b []*bbs.ArticleSummary, updateNanoTS types.NanoTS, ...) (articleSummaries []*schema.ArticleSummaryWithRegex, err error)
func DeserializeBoardDetailsAndUpdateDB(boardDetails_b []*bbs.BoardDetail, updateNanoTS types.NanoTS) (boardDetails []*schema.BoardDetail, err error)
func DeserializeBoardsAndUpdateDB(boardSummaries_b []*bbs.BoardSummary, updateNanoTS types.NanoTS) (boardSummaries []*schema.BoardSummary, err error)
func DeserializePBArticlesAndUpdateDB(boardID bbs.BBoardID, articleSummaries_b []*boardd.Post, ...) (articleSummaries []*schema.ArticleSummaryWithRegex, err error)
func DeserializePBBoardsAndUpdateDB(boardSummaries_b []*boardd.Board, updateNanoTS types.NanoTS) (boardSummaries []*schema.BoardSummary, err error)
func DeserializePBManArticlesAndUpdateDB(boardID bbs.BBoardID, levelIdx types.ManArticleID, entries []*mand.Entry, ...) (articleSummaries []*schema.ManArticleSummary, err error)
func DeserializeUserDetailAndUpdateDBForTest(user_b pttbbsapi.GetUserResult, updateNanoTS types.NanoTS) (userDetail *schema.UserDetail, err error)
func EditArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func EditArticleDetailWrapper(c *gin.Context)
func ErrBoardCooldown(diffNanoTS types.NanoTS) error
func ErrBoardPosttime(diffNanoTS types.NanoTS) error
func ErrFloodReject(diffNanoTS types.NanoTS) error
func ErrorHTMLWrapper(c *gin.Context)
func Form(theFunc APIFunc, params interface{}, c *gin.Context)
func FormJSON(theFunc APIFunc, params interface{}, c *gin.Context)
func FormLogout(theFunc APIFunc, params interface{}, c *gin.Context)
func GetArticleBlocks(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetArticleBlocksAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetArticleBlocksAllGuestWrapper(c *gin.Context)
func GetArticleBlocksWrapper(c *gin.Context)
func GetArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetArticleDetailAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetArticleDetailAllGuestWrapper(c *gin.Context)
func GetArticleDetailWrapper(c *gin.Context)
func GetBoardDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetBoardDetailAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetBoardDetailAllGuestWrapper(c *gin.Context)
func GetBoardDetailWrapper(c *gin.Context)
func GetBoardSummary(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetBoardSummaryAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetBoardSummaryAllGuestWrapper(c *gin.Context)
func GetBoardSummaryWrapper(c *gin.Context)
func GetManArticleBlocks(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetManArticleBlocksWrapper(c *gin.Context)
func GetManArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetManArticleDetailWrapper(c *gin.Context)
func GetUserID(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func GetUserIDAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func GetUserIDAllGuestWrapper(c *gin.Context)
func GetUserIDWrapper(c *gin.Context)
func GetUserInfo(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func GetUserInfoWrapper(c *gin.Context)
func GetUserVisitCount(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func GetUserVisitCountWrapper(c *gin.Context)
func GetUsername(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func GetUsernameWrapper(c *gin.Context)
func GetVersion(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func GetVersionWrapper(c *gin.Context)
func Index(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func IndexHTMLWrapper(c *gin.Context)
func IndexWrapper(c *gin.Context)
func InitHTMLWrapper(c *gin.Context)
func JSON(theFunc APIFunc, params interface{}, c *gin.Context)
func LoadArticleComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadArticleCommentsAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadArticleCommentsAllGuestWrapper(c *gin.Context)
func LoadArticleCommentsWrapper(c *gin.Context)
func LoadAutoCompleteBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadAutoCompleteBoardsWrapper(c *gin.Context)
func LoadBottomArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadBottomArticlesAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadBottomArticlesAllGuestWrapper(c *gin.Context)
func LoadBottomArticlesWrapper(c *gin.Context)
func LoadClassBoards(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadClassBoardsWrapper(c *gin.Context)
func LoadFavoriteBoards(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadFavoriteBoardsWrapper(c *gin.Context)
func LoadGeneralArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadGeneralArticlesAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadGeneralArticlesAllGuestWrapper(c *gin.Context)
func LoadGeneralArticlesByKeyword(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadGeneralArticlesWrapper(c *gin.Context)
func LoadGeneralBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadGeneralBoardsByClass(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadGeneralBoardsByClassWrapper(c *gin.Context)
func LoadGeneralBoardsWrapper(c *gin.Context)
func LoadManArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadManArticlesWrapper(c *gin.Context)
func LoadPopularArticles(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadPopularArticlesWrapper(c *gin.Context)
func LoadPopularBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadPopularBoardsAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoadPopularBoardsAllGuestWrapper(c *gin.Context)
func LoadPopularBoardsWrapper(c *gin.Context)
func LoadUserArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadUserArticlesWrapper(c *gin.Context)
func LoadUserComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func LoadUserCommentsWrapper(c *gin.Context)
func Login(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LoginHTMLWrapper(c *gin.Context)
func LoginRequiredJSON(theFunc LoginRequiredAPIFunc, params interface{}, c *gin.Context)
func LoginRequiredPathJSON(theFunc LoginRequiredPathAPIFunc, params interface{}, path interface{}, ...)
func LoginRequiredPathQuery(theFunc LoginRequiredPathAPIFunc, params interface{}, path interface{}, ...)
func LoginRequiredQuery(theFunc LoginRequiredAPIFunc, params interface{}, c *gin.Context)
func LoginRequiredRedirectPathQuery(theFunc LoginRequiredRedirectPathAPIFunc, params interface{}, path interface{}, ...)
func LoginWrapper(c *gin.Context)
func Logout(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func LogoutWrapper(c *gin.Context)
func ManArticleLockKey(boardID bbs.BBoardID, articleID types.ManArticleID) (key string)
func OptionsWrapper(c *gin.Context)
func ParseClaimInt(claim jwt.MapClaims, idx string) (ret int, err error)
func ParseClaimString(claim jwt.MapClaims, idx string) (ret string, err error)
func ParseJwt(raw string, secret []byte) (tok *jwt.Token, err error)
func PathQuery(theFunc PathAPIFunc, params interface{}, path interface{}, c *gin.Context)
func Query(theFunc APIFunc, params interface{}, c *gin.Context)
func RedirectFormJSON(theFunc RedirectAPIFunc, params interface{}, c *gin.Context)
func RedirectQuery(theFunc RedirectAPIFunc, params interface{}, c *gin.Context)
func Refresh(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func RefreshBrdnameBlackListMap() (nBoardID int, err error)
func RefreshBrdnameBlackListMapAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func RefreshBrdnameBlackListMapAllGuestWrapper(c *gin.Context)
func RefreshBrdnameWhiteListMap() (nBoardID int, err error)
func RefreshBrdnameWhiteListMapAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func RefreshBrdnameWhiteListMapAllGuestWrapper(c *gin.Context)
func RefreshWrapper(c *gin.Context)
func RegisterClient(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)
func RegisterClientWrapper(c *gin.Context)
func RegisterHTMLWrapper(c *gin.Context)
func RegisterUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result string, statusCode int, err error)
func RegisterUserWrapper(c *gin.Context)
func ReplyComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func ReplyCommentsWrapper(c *gin.Context)
func SetIDEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, ...) (result interface{}, statusCode int, err error)
func SetIDEmailWrapper(c *gin.Context)
func SetIsTest()
func TryGetArticleContentInfo(userID bbs.UUserID, bboardID bbs.BBoardID, articleID bbs.ArticleID, ...) (content [][]*types.Rune, contentPrefix [][]*types.Rune, contentMD5 string, ...)
func TryGetManArticleContentInfo(userID bbs.UUserID, bboardID bbs.BBoardID, articleID types.ManArticleID, ...) (content [][]*types.Rune, contentMD5 string, ...)
func TryLoadPttWebPopularBoards(c *gin.Context) (boards []*schema.BoardSummary, err error)
func UnsetIsTest()
func UpdateArticleContentInfo(boardID bbs.BBoardID, articleID bbs.ArticleID, content [][]*types.Rune, ...) (err error)
func UpdateManArticleContentInfo(boardID bbs.BBoardID, articleID types.ManArticleID, content [][]*types.Rune, ...) (err error)
func UserAttemptChangeEmailHTMLWrapper(c *gin.Context)
func UserAttemptSetIDEmailHTMLWrapper(c *gin.Context)
func UserChangeEmailHTMLWrapper(c *gin.Context)
func UserChangePasswdHTMLWrapper(c *gin.Context)
func UserHTMLWrapper(c *gin.Context)
func UserSetIDEmailHTMLWrapper(c *gin.Context)
func ZKProxyWrapper(zkProxy *httputil.ReverseProxy) func(c *gin.Context)
type APIFunc
type AddFavoriteBoardParams
type AddFavoriteBoardPath
type AddFavoriteFolderParams
type AddFavoriteFolderPath
type AddFavoriteLineParams
type AddFavoriteLinePath
type AddFavoriteResult
type AttemptChangeEmailParams
type AttemptChangeEmailPath
type AttemptChangeEmailResult
type AttemptLoginParams
type AttemptLoginResult
type AttemptRegisterUserParams
type AttemptRegisterUserResult
type AttemptSetIDEmailParams
type AttemptSetIDEmailPath
type AttemptSetIDEmailResult
type ChangeEmailParams
type ChangeEmailPath
type ChangeEmailResult
type ChangePasswdParams
type ChangePasswdPath
type ChangePasswdResult
- func NewChangePasswdResult(result_b *pttbbsapi.ChangePasswdResult) *ChangePasswdResult
type CheckExistsUserParams
type CheckExistsUserResult
type ClientInfo
type CooldownLimit
type CreateArticleParams
type CreateArticlePath
type CreateArticleResult
type CreateBoardParams
type CreateBoardPath
type CreateBoardResult
type CreateCommentParams
type CreateCommentPath
type CreateCommentResult
type CreateRankParams
type CreateRankPath
type CreateRankResult
type CrossPostParams
type CrossPostPath
type CrossPostResult
type DeleteArticlesParams
type DeleteArticlesPath
type DeleteArticlesResult
type DeleteCommentsParams
type DeleteCommentsPath
type DeleteCommentsResult
type DeleteFavoriteParams
type DeleteFavoritePath
type DeleteFavoriteResult
type EditArticleParams
type EditArticlePath
type EditArticleResult
type GetArticleBlocksParams
- func NewGetArticleBlocksParams() *GetArticleBlocksParams
type GetArticleBlocksPath
type GetArticleBlocksResult
type GetArticleDetailParams
type GetArticleDetailPath
type GetArticleDetailResult
type GetBoardDetailParams
type GetBoardDetailPath
type GetBoardDetailResult
type GetBoardSummaryParams
type GetBoardSummaryPath
type GetBoardSummaryResult
type GetManArticleBlocksParams
- func NewGetManArticleBlocksParams() *GetManArticleBlocksParams
type GetManArticleBlocksPath
type GetManArticleBlocksResult
type GetManArticleDetailPath
type GetManArticleDetailResult
type GetUserIDResult
type GetUserInfoParams
type GetUserInfoPath
type GetUserInfoResult
- func NewUserInfoResult(userDetail_db *schema.UserDetail, userNewInfo_db *schema.UserNewInfo, ...) (result *GetUserInfoResult)
type GetUserVisitCountResult
type GetUsernameResult
type GetVersionResult
type HTMLPath
type IndexParams
- func NewIndexParams() *IndexParams
type IndexResult
type JwtClaim
type LoadArticleCommentsParams
- func NewLoadArticleCommentsParams() *LoadArticleCommentsParams
type LoadArticleCommentsPath
type LoadArticleCommentsResult
- func NewLoadArticleCommentsResult(comments_db []*schema.Comment, nextComment *schema.Comment, userID bbs.UUserID) (result *LoadArticleCommentsResult)
type LoadAutoCompleteBoardsParams
- func NewLoadAutoCompleteBoardsParams() *LoadAutoCompleteBoardsParams
type LoadBottomArticlesPath
type LoadBottomArticlesResult
- func NewLoadBottomArticlesResult(a_db []*schema.ArticleSummary, userReadArticleMap map[bbs.ArticleID]bool, ...) *LoadBottomArticlesResult
type LoadClassBoardsParams
- func NewLoadClassBoardsParams() *LoadClassBoardsParams
type LoadClassBoardsPath
type LoadClassBoardsResult
- func NewLoadClassBoardsResult(boardSummaries_db []*schema.BoardSummary, ...) (ret *LoadClassBoardsResult)
type LoadFavoriteBoardsParams
- func NewLoadFavoriteBoardsParams() *LoadFavoriteBoardsParams
type LoadFavoriteBoardsPath
type LoadFavoriteBoardsResult
- func NewLoadFavoriteBoardsResult(userID bbs.UUserID, userFavorites_db []*schema.UserFavorites, ...) (result *LoadFavoriteBoardsResult)
type LoadGeneralArticlesParams
- func NewLoadGeneralArticlesParams() *LoadGeneralArticlesParams
type LoadGeneralArticlesPath
type LoadGeneralArticlesResult
- func NewLoadGeneralArticlesResult(a_db []*schema.ArticleSummary, userReadArticleMap map[bbs.ArticleID]bool, ...) *LoadGeneralArticlesResult
type LoadGeneralBoardsParams
- func NewLoadGeneralBoardsParams() *LoadGeneralBoardsParams
type LoadGeneralBoardsResult
- func NewLoadGeneralBoardsResult(boardSummaries_db []*schema.BoardSummary, ...) *LoadGeneralBoardsResult
type LoadManArticlesParams
type LoadManArticlesPath
type LoadManArticlesResult
- func NewLoadManArticlesResult(articleSummaries_db []*schema.ManArticleSummary, userID bbs.UUserID) (r *LoadManArticlesResult)
type LoadPopularArticlesParams
- func NewLoadPopularArticlesParams() *LoadPopularArticlesParams
type LoadPopularArticlesResult
type LoadPopularBoardsResult
- func NewLoadPopularBoardsResult(boardSummaries_db []*schema.BoardSummary, ...) *LoadPopularBoardsResult
type LoadUserArticlesParams
- func NewUserArticlesParams() *LoadUserArticlesParams
type LoadUserArticlesPath
type LoadUserArticlesResult
- func NewLoadUserArticlesResult(a_db []*schema.ArticleSummary, ...) *LoadUserArticlesResult
type LoadUserCommentsParams
- func NewLoadUserCommentsParams() *LoadUserCommentsParams
type LoadUserCommentsPath
type LoadUserCommentsResult
- func NewLoadUserCommentsResult(commentSummaries_db []*schema.CommentSummary, ...) (result *LoadUserCommentsResult)
type LoginLog
- func (l *LoginLog) String() string
type LoginParams
- func NewLoginParams() *LoginParams
type LoginRequiredAPIFunc
type LoginRequiredPathAPIFunc
type LoginRequiredRedirectPathAPIFunc
type LoginResult
- func NewLoginResult(username string, accessToken string, accessExpireTS types.Time8, ...) *LoginResult
type PathAPIFunc
type RedirectAPIFunc
type RefreshBrdnameBlackListMapResult
type RefreshBrdnameWhiteListMapResult
type RefreshParams
type RefreshResult
type RegisterClientParams
- func NewRegisterClientParams() *RegisterClientParams
type RegisterClientResult
- func NewRegisterClientResult(client *schema.Client, userID bbs.UUserID) *RegisterClientResult
type RegisterUserParams
- func NewRegisterUserParams() *RegisterUserParams
type ReplyCommentsParams
type ReplyCommentsPath
type ReplyCommentsResult
type SetIDEmailParams
type SetIDEmailPath
type SetIDEmailResult
type UserBoardPermReadable
- func CheckUserBoardPermReadable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (userBoardPerm *UserBoardPermReadable, err error)
type UserInfo

Constants ¶

View Source

const (
	DEFAULT_MAX_ARTICLE_BLOCK_LIST = 1
	DEFAULT_MAX_LIST               = 200
	DEFAULT_DESCENDING             = true
	DEFAULT_ASCENDING              = true

	ARTICLE_LOCK_TS          = 10
	ARTICLE_LOCK_TS_DURATION = time.Duration(ARTICLE_LOCK_TS) * time.Second
	ARTICLE_LOCK_NANO_TS     = types.NanoTS(ARTICLE_LOCK_TS) * types.TS_TO_NANO_TS

	HTML_CACHE_CONTROL_TS = 3600
	JS_CACHE_CONTROL_TS   = 86400 * 365

	OFFSET_MTIME_NANO_TS = 1000000000 // 1 second

	REFRESH_IS_OVER18_NANO_TS = 86400 * 1000000000

	INIT_USERNAME_PREFIX     = "friend"
	INIT_USERNAME_RANDOM_LEN = 6
)

View Source

const (
	ROOT_HTML_R  = "/"
	INDEX_HTML_R = "/index.html"
)

View Source

const ADD_FAVORITE_BOARD_R = "/user/:user_id/favorites/addboard"

View Source

const ADD_FAVORITE_FOLDER_R = "/user/:user_id/favorites/addfolder"

View Source

const ADD_FAVORITE_LINE_R = "/user/:user_id/favorites/addline"

View Source

const ARTICLES_HTML_R = "/board/:bid/articles"

View Source

const ARTICLE_HTML_R = "/board/:bid/article/:aid"

View Source

const ATTEMPT_CHANGE_EMAIL_R = "/user/:user_id/attemptchangeemail"

View Source

const ATTEMPT_LOGIN_R = "/account/attemptlogin"

View Source

const ATTEMPT_REGISTER_USER_R = "/account/attemptregister"

View Source

const ATTEMPT_SET_ID_EMAIL_R = "/user/:user_id/attemptsetidemail"

View Source

const BOARDS_FAVORITES_HTML_R = "/user/:user_id/favorites"

View Source

const BOARDS_HTML_R = "/boards"

View Source

const BOARDS_POPULAR_HTML_R = "/boards/popular"

View Source

const CHANGE_EMAIL_R = "/user/:user_id/changeemail"

View Source

const CHANGE_PASSWD_R = "/user/:user_id/updatepasswd" //nolint // passwd as route

View Source

const CHECK_EXISTS_USER_R = "/account/existsuser"

View Source

const CLS_BOARDS_HTML_R = "/cls/:cls_id"

View Source

const CREATE_ARTICLE_HTML_R = "/board/:bid/post"

View Source

const CREATE_ARTICLE_R = "/board/:bid/article"

View Source

const CREATE_BOARD_R = "/class/:cls/board"

View Source

const CREATE_COMMENT_R = "/board/:bid/article/:aid/comment"

View Source

const CREATE_RANK_R = "/board/:bid/article/:aid/rank"

View Source

const CROSS_POST_R = "/board/:bid/article/:aid/crosspost"

View Source

const (
	DEFAULT_FAV_TITLE = "新的目錄"
)

View Source

const DELETE_ARTICLES_R = "/board/:bid/deletearticles"

View Source

const DELETE_COMMENTS_R = "/board/:bid/article/:aid/deletecomments"

View Source

const DELETE_FAVORITE_R = "/user/:user_id/favorites/delete"

View Source

const EDIT_ARTICLE_R = "/board/:bid/article/:aid/edit"

View Source

const ERR_HTML_R = "/error"

View Source

const GET_ARTICLE_BLOCKS_R = "/board/:bid/articleblocks/:aid"

View Source

const GET_ARTICLE_R = "/board/:bid/article/:aid"

View Source

const GET_BOARD_DETAIL_R = "/board/:bid"

View Source

const GET_BOARD_SUMMARY_R = "/board/:bid/summary"

View Source

const GET_MAN_ARTICLE_BLOCKS_R = "/board/:bid/manualblocks/*aid"

View Source

const GET_MAN_ARTICLE_R = "/board/:bid/manual/*aid"

View Source

const GET_USERNAME_R = "/username"

View Source

const GET_USER_ID_R = "/userid"

View Source

const GET_USER_INFO_R = "/user/:username"

View Source

const GET_USER_VISIT_COUNT_R = "/uservisitcount"

View Source

const GET_VERSION_R = "/version"

View Source

const INDEX_R = "/"

View Source

const INIT_HTML_R = "/init"

View Source

const (
	IS_OVER_18_SUBSTRING = "document.cookie.indexOf('over18=1') === -1)"
)

View Source

const LOAD_ARTICLE_COMMENTS_R = "/board/:bid/article/:aid/comments"

View Source

const LOAD_AUTO_COMPLETE_BOARDS_R = "/boards/autocomplete"

View Source

const LOAD_BOTTOM_ARTICLES_R = "/board/:bid/articles/bottom"

View Source

const LOAD_CLASS_BOARDS_R = "/cls/:clsid"

View Source

const LOAD_FAVORITE_BOARDS_R = "/user/:user_id/favorites"

View Source

const LOAD_GENERAL_ARTICLES_R = "/board/:bid/articles"

View Source

const LOAD_GENERAL_BOARDS_BY_CLASS_R = "/boards/byclass"

View Source

const LOAD_GENERAL_BOARDS_R = "/boards"

View Source

const LOAD_MAN_ARTICLES_R = "/board/:bid/manuals"

View Source

const LOAD_POPULAR_ARTICLES_R = "/articles/popular"

View Source

const LOAD_POPULAR_BOARDS_R = "/boards/popular"

View Source

const LOAD_USER_ARTICLES_R = "/user/:user_id/articles"

View Source

const LOAD_USER_COMMENTS_R = "/user/:user_id/comments"

View Source

const LOGIN_HTML_R = "/login"

View Source

const LOGIN_R = "/account/login"

View Source

const LOGOUT_R = "/account/logout"

View Source

const (
	MAX_USER_FAVORITES_BUF_SIZE = 65535
)

View Source

const REFRESH_BRDNAME_BLACK_LIST_MAP_R = "/boards/refresh-black-list"

View Source

const REFRESH_BRDNAME_WHITE_LIST_MAP_R = "/boards/refresh-white-list"

View Source

const REFRESH_R = "/account/refresh"

View Source

const REGISTER_CLIENT_R = "/client/register"

View Source

const REGISTER_HTML_R = "/register"

View Source

const REGISTER_USER_R = "/account/register"

View Source

const REPLY_COMMENTS_R = "/board/:bid/article/:aid/replycomments"

View Source

const SET_ID_EMAIL_R = "/user/:user_id/setidemail"

View Source

const USER_ATTEMPT_CHANGE_EMAIL_HTML_R = "/user/:user_id/attemptchangeemail"

View Source

const USER_ATTEMPT_SET_ID_EMAIL_HTML_R = "/user/:user_id/attemptsetidemail"

View Source

const USER_CHANGE_EMAIL_HTML_R = "/user/:user_id/changeemail"

View Source

const USER_CHANGE_PASSWD_HTML_R = "/user/:user_id/resetpassword" //nolint // passwd as route

View Source

const USER_HTML_R = "/user/:user_id"

View Source

const USER_SET_ID_EMAIL_HTML_R = "/user/:user_id/setidemail"

View Source

const ZK_CREATE_CHALLENGE_R = "/challenge"

View Source

const ZK_GET_CHALLENGE_R = "/challenge/:challenge"

View Source

const ZK_ISSUER_CERT_STATUS_R = "/issuer-cert/status"

View Source

const ZK_LINK_VERIFY_R = "/link-verify"

View Source

const ZK_SMT_ROOT_STATUS_R = "/smt-root/status"

Variables ¶

View Source

var (
	GET_ARTICLE_CONTENT_INFO_TOO_SOON_NANO_TS = ARTICLE_LOCK_NANO_TS + types.NanoTS(1)*types.TS_TO_NANO_TS // 10 + 1 seconds.

	MIME_TYPE_MAP = map[string]string{
		".js":   "text/javascript",
		".html": "text/html",
		".map":  "application/json",
	}

	BRDNAME_WHITE_LIST_MAP = map[string]int{}

	BRDNAME_BLACK_LIST_MAP = map[string]bool{}
)

View Source

var (
	ErrInvalidRemoteAddr = errors.New("invalid remote addr")

	ErrInvalidParams = errors.New("invalid params")

	ErrNoUserID                 = errors.New("no userid")
	ErrNoUsername               = errors.New("no username")
	ErrLoginFailed              = errors.New("login failed")
	ErrNotImplemented           = errors.New("not implemented")
	ErrInvalidPath              = errors.New("invalid path")
	ErrInvalidToken             = errors.New("invalid token")
	ErrInvalidOrigin            = errors.New("invalid origin")
	ErrInvalidBackendStatusCode = errors.New("invalid backend status code")
	ErrNoUser                   = errors.New("no user")
	ErrNoBoard                  = errors.New("no board")
	ErrNoArticle                = errors.New("no article")
	ErrNoUserBoard              = errors.New("no user board")
	ErrInvalidBoardname         = errors.New("invalid boardname")
	ErrNoEmail                  = errors.New("no email")

	ErrAlreadyDeleted = errors.New("already deleted")
	ErrFileNotFound   = errors.New("file not found")

	ErrInvalidUser   = errors.New("invalid user")
	ErrInvalidClient = errors.New("invalid client")

	ErrAlreadyExists = errors.New("already exists")

	ErrInvalidFav = errors.New("invalid fav")

	ErrNotFriend     = errors.New("not friend")
	ErrBoardBlocked  = errors.New("board blocked")
	ErrBoardReported = errors.New("board reported")
	ErrBoardBucket   = errors.New("board bucket")

	ErrBoardNotPopular = errors.New("board not popular")

	ErrPermBoardCreatePermission = errors.New("no board create permission")

	ErrPermBoardReadHidden   = errors.New("hidden board")
	ErrPermBoardReadBlocked  = errors.New("blocked board")
	ErrPermBoardReadReported = errors.New("reported board")

	ErrPermBoardReadNotOver18  = errors.New("not over18")
	ErrPermBoardReadPermission = errors.New("no board read permission")

	ErrPermPostReadOnly        = errors.New("read only")
	ErrPermPostBannedByBoard   = errors.New("banned by board")
	ErrPermBoardPostPost       = errors.New("no user post permission")
	ErrPermBoardPostRestricted = errors.New("only board friends")
	ErrPermBoardPostViolateLaw = errors.New("violate law")
	ErrPermBoardPostPermission = errors.New("no board post permission")

	ErrPermBoardPostLoginDays = errors.New("invalid login days")
	ErrPermBoardPostPostLimit = errors.New("reached post limit")

	ErrPermBoardEditPermission = errors.New("no board edit permission")

	ErrInvalidStatusCode = errors.New("invalid status code")
)

View Source

var COOLDOWN_LIMIT = []*CooldownLimit{
	{NUser: 4000, Posttime: 1},
	{NUser: 2000, Posttime: 2},
	{NUser: 1000, Posttime: 3},
	{NUser: 0, Posttime: 10},
}

View Source

var (
	IsTest = false
)

Functions ¶

func AddFavoriteBoard ¶

func AddFavoriteBoard(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AddFavoriteBoardWrapper ¶

func AddFavoriteBoardWrapper(c *gin.Context)

func AddFavoriteFolder ¶

func AddFavoriteFolder(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AddFavoriteFolderWrapper ¶

func AddFavoriteFolderWrapper(c *gin.Context)

func AddFavoriteLine ¶

func AddFavoriteLine(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AddFavoriteLineWrapper ¶

func AddFavoriteLineWrapper(c *gin.Context)

func AllHTMLWrapper ¶

func AllHTMLWrapper(c *gin.Context)

func ArticleLockKey ¶

func ArticleLockKey(boardID bbs.BBoardID, articleID bbs.ArticleID) (key string)

func AttemptChangeEmail ¶

func AttemptChangeEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AttemptChangeEmailWrapper ¶

func AttemptChangeEmailWrapper(c *gin.Context)

func AttemptLogin ¶ added in v0.43.0

func AttemptLogin(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AttemptLoginWrapper ¶ added in v0.43.0

func AttemptLoginWrapper(c *gin.Context)

func AttemptRegisterUser ¶

func AttemptRegisterUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AttemptRegisterUserWrapper ¶

func AttemptRegisterUserWrapper(c *gin.Context)

func AttemptSetIDEmail ¶

func AttemptSetIDEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func AttemptSetIDEmailWrapper ¶

func AttemptSetIDEmailWrapper(c *gin.Context)

func ChangeEmail ¶

func ChangeEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func ChangeEmailWrapper ¶

func ChangeEmailWrapper(c *gin.Context)

func ChangePasswd ¶

func ChangePasswd(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func ChangePasswdWrapper ¶

func ChangePasswdWrapper(c *gin.Context)

func CheckExistsUser ¶

func CheckExistsUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CheckExistsUserWrapper ¶

func CheckExistsUserWrapper(c *gin.Context)

func CheckUserArticlePermDeletable ¶

func CheckUserArticlePermDeletable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, c *gin.Context) (err error)

CheckUserArticlePermDeletable

Deletable

func CheckUserArticlePermEditable ¶

func CheckUserArticlePermEditable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, isCheckBoard bool, c *gin.Context) (err error)

CheckUserArticlePermEditable

Editable

func CheckUserArticlePermReadable ¶

func CheckUserArticlePermReadable(user *UserInfo, boardID bbs.BBoardID, articleID bbs.ArticleID, isCheckBoard bool, c *gin.Context) (err error)

CheckUserArticlePermReadable

Readable

func CheckUserArticlesPermDeletable ¶

func CheckUserArticlesPermDeletable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, userBoardPermReadable *UserBoardPermReadable, c *gin.Context) (articlePermMap map[bbs.ArticleID]error, err error)

CheckUserArticlePermDeletable

Deletable

func CheckUserArticlesPermEditable ¶

func CheckUserArticlesPermEditable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, userBoardPerm *UserBoardPermReadable, c *gin.Context) (articlePermMap map[bbs.ArticleID]error, err error)

CheckUserArticlesPermEditable

articles Editable

func CheckUserArticlesPermEditableDeletable ¶

func CheckUserArticlesPermEditableDeletable(user *UserInfo, boardID bbs.BBoardID, articleIDs []bbs.ArticleID, userBoardPerm *UserBoardPermReadable, c *gin.Context) (articlePermEditableMap map[bbs.ArticleID]error, articlePermDeletableMap map[bbs.ArticleID]error, err error)

CheckUserArticlesPermEditable

articles Editable

func CheckUserBoardPermCreatable ¶

func CheckUserBoardPermCreatable(user *UserInfo, c *gin.Context) (err error)

CheckUserBoardPermCreatable

func CheckUserBoardPermEditable ¶

func CheckUserBoardPermEditable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (err error)

CheckUserBoardPermEditable

func CheckUserBoardPermPostable ¶

func CheckUserBoardPermPostable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (err error)

CheckUserBoardPermPostable

https://github.com/ptt/pttbbs/blob/master/mbbsd/cache.c#L209

func CreateArticle ¶

func CreateArticle(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CreateArticleWrapper ¶

func CreateArticleWrapper(c *gin.Context)

func CreateBoard ¶

func CreateBoard(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CreateBoardWrapper ¶

func CreateBoardWrapper(c *gin.Context)

func CreateComment ¶

func CreateComment(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CreateCommentWrapper ¶

func CreateCommentWrapper(c *gin.Context)

func CreateRank ¶

func CreateRank(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CreateRankWrapper ¶

func CreateRankWrapper(c *gin.Context)

func CrossPost ¶

func CrossPost(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func CrossPostWrapper ¶

func CrossPostWrapper(c *gin.Context)

func DeleteArticles ¶

func DeleteArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

DeleteArticles provides function from api /board/:bid/deletearticles it will call backend api (go-pttbbs) and deleting all components like: comments, ranks, user_read_records about this articles

func DeleteArticlesWrapper ¶

func DeleteArticlesWrapper(c *gin.Context)

func DeleteComments ¶

func DeleteComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func DeleteCommentsWrapper ¶

func DeleteCommentsWrapper(c *gin.Context)

func DeleteFavorite ¶

func DeleteFavorite(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func DeleteFavoriteWrapper ¶

func DeleteFavoriteWrapper(c *gin.Context)

func DeserializeArticlesAndUpdateDB ¶

func DeserializeArticlesAndUpdateDB(articleSummaries_b []*bbs.ArticleSummary, updateNanoTS types.NanoTS, isBottom bool) (articleSummaries []*schema.ArticleSummaryWithRegex, err error)

func DeserializeBoardDetailsAndUpdateDB ¶

func DeserializeBoardDetailsAndUpdateDB(boardDetails_b []*bbs.BoardDetail, updateNanoTS types.NanoTS) (boardDetails []*schema.BoardDetail, err error)

DeserializeBoards

each_b.Reason happens only with invalid permission.

func DeserializeBoardsAndUpdateDB ¶

func DeserializeBoardsAndUpdateDB(boardSummaries_b []*bbs.BoardSummary, updateNanoTS types.NanoTS) (boardSummaries []*schema.BoardSummary, err error)

DeserializeBoards

each_b.Reason happens only with invalid permission.

func DeserializePBArticlesAndUpdateDB ¶

func DeserializePBArticlesAndUpdateDB(boardID bbs.BBoardID, articleSummaries_b []*boardd.Post, updateNanoTS types.NanoTS, isBottom bool) (articleSummaries []*schema.ArticleSummaryWithRegex, err error)

func DeserializePBBoardsAndUpdateDB ¶

func DeserializePBBoardsAndUpdateDB(boardSummaries_b []*boardd.Board, updateNanoTS types.NanoTS) (boardSummaries []*schema.BoardSummary, err error)

DeserializePBBoardsAndUpdateDB

func DeserializePBManArticlesAndUpdateDB ¶

func DeserializePBManArticlesAndUpdateDB(boardID bbs.BBoardID, levelIdx types.ManArticleID, entries []*mand.Entry, updateNanoTS types.NanoTS) (articleSummaries []*schema.ManArticleSummary, err error)

func DeserializeUserDetailAndUpdateDBForTest ¶ added in v0.43.0

func DeserializeUserDetailAndUpdateDBForTest(user_b pttbbsapi.GetUserResult, updateNanoTS types.NanoTS) (userDetail *schema.UserDetail, err error)

func EditArticleDetail ¶

func EditArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func EditArticleDetailWrapper ¶

func EditArticleDetailWrapper(c *gin.Context)

func ErrBoardCooldown ¶

func ErrBoardCooldown(diffNanoTS types.NanoTS) error

func ErrBoardPosttime ¶

func ErrBoardPosttime(diffNanoTS types.NanoTS) error

func ErrFloodReject ¶

func ErrFloodReject(diffNanoTS types.NanoTS) error

func ErrorHTMLWrapper ¶ added in v0.43.0

func ErrorHTMLWrapper(c *gin.Context)

func Form ¶

func Form(theFunc APIFunc, params interface{}, c *gin.Context)

func FormJSON ¶

func FormJSON(theFunc APIFunc, params interface{}, c *gin.Context)

func FormLogout ¶

func FormLogout(theFunc APIFunc, params interface{}, c *gin.Context)

func GetArticleBlocks ¶

func GetArticleBlocks(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetArticleBlocksAllGuest ¶

func GetArticleBlocksAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetArticleBlocksAllGuestWrapper ¶

func GetArticleBlocksAllGuestWrapper(c *gin.Context)

func GetArticleBlocksWrapper ¶

func GetArticleBlocksWrapper(c *gin.Context)

func GetArticleDetail ¶

func GetArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetArticleDetailAllGuest ¶

func GetArticleDetailAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetArticleDetailAllGuestWrapper ¶

func GetArticleDetailAllGuestWrapper(c *gin.Context)

func GetArticleDetailWrapper ¶

func GetArticleDetailWrapper(c *gin.Context)

func GetBoardDetail ¶

func GetBoardDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetBoardDetailAllGuest ¶

func GetBoardDetailAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetBoardDetailAllGuestWrapper ¶

func GetBoardDetailAllGuestWrapper(c *gin.Context)

func GetBoardDetailWrapper ¶

func GetBoardDetailWrapper(c *gin.Context)

func GetBoardSummary ¶

func GetBoardSummary(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetBoardSummaryAllGuest ¶

func GetBoardSummaryAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetBoardSummaryAllGuestWrapper ¶

func GetBoardSummaryAllGuestWrapper(c *gin.Context)

func GetBoardSummaryWrapper ¶

func GetBoardSummaryWrapper(c *gin.Context)

func GetManArticleBlocks ¶

func GetManArticleBlocks(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetManArticleBlocksWrapper ¶

func GetManArticleBlocksWrapper(c *gin.Context)

func GetManArticleDetail ¶

func GetManArticleDetail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetManArticleDetailWrapper ¶

func GetManArticleDetailWrapper(c *gin.Context)

func GetUserID ¶

func GetUserID(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetUserIDAllGuest ¶

func GetUserIDAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetUserIDAllGuestWrapper ¶

func GetUserIDAllGuestWrapper(c *gin.Context)

func GetUserIDWrapper ¶

func GetUserIDWrapper(c *gin.Context)

func GetUserInfo ¶

func GetUserInfo(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetUserInfoWrapper ¶

func GetUserInfoWrapper(c *gin.Context)

func GetUserVisitCount ¶

func GetUserVisitCount(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetUserVisitCountWrapper ¶

func GetUserVisitCountWrapper(c *gin.Context)

func GetUsername ¶ added in v0.43.0

func GetUsername(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetUsernameWrapper ¶ added in v0.43.0

func GetUsernameWrapper(c *gin.Context)

func GetVersion ¶

func GetVersion(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func GetVersionWrapper ¶

func GetVersionWrapper(c *gin.Context)

func Index ¶

func Index(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func IndexHTMLWrapper ¶

func IndexHTMLWrapper(c *gin.Context)

func IndexWrapper ¶

func IndexWrapper(c *gin.Context)

func InitHTMLWrapper ¶ added in v0.43.0

func InitHTMLWrapper(c *gin.Context)

func JSON ¶

func JSON(theFunc APIFunc, params interface{}, c *gin.Context)

func LoadArticleComments ¶

func LoadArticleComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadArticleCommentsAllGuest ¶

func LoadArticleCommentsAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadArticleCommentsAllGuestWrapper ¶

func LoadArticleCommentsAllGuestWrapper(c *gin.Context)

func LoadArticleCommentsWrapper ¶

func LoadArticleCommentsWrapper(c *gin.Context)

func LoadAutoCompleteBoards ¶

func LoadAutoCompleteBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadAutoCompleteBoardsWrapper ¶

func LoadAutoCompleteBoardsWrapper(c *gin.Context)

func LoadBottomArticles ¶

func LoadBottomArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadBottomArticlesAllGuest ¶

func LoadBottomArticlesAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadBottomArticlesAllGuestWrapper ¶

func LoadBottomArticlesAllGuestWrapper(c *gin.Context)

func LoadBottomArticlesWrapper ¶

func LoadBottomArticlesWrapper(c *gin.Context)

func LoadClassBoards ¶

func LoadClassBoards(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadClassBoardsWrapper ¶

func LoadClassBoardsWrapper(c *gin.Context)

func LoadFavoriteBoards ¶

func LoadFavoriteBoards(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadFavoriteBoardsWrapper ¶

func LoadFavoriteBoardsWrapper(c *gin.Context)

func LoadGeneralArticles ¶

func LoadGeneralArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadGeneralArticlesAllGuest ¶

func LoadGeneralArticlesAllGuest(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadGeneralArticlesAllGuestWrapper ¶

func LoadGeneralArticlesAllGuestWrapper(c *gin.Context)

func LoadGeneralArticlesByKeyword ¶

func LoadGeneralArticlesByKeyword(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadGeneralArticlesWrapper ¶

func LoadGeneralArticlesWrapper(c *gin.Context)

func LoadGeneralBoards ¶

func LoadGeneralBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadGeneralBoardsByClass ¶

func LoadGeneralBoardsByClass(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadGeneralBoardsByClassWrapper ¶

func LoadGeneralBoardsByClassWrapper(c *gin.Context)

func LoadGeneralBoardsWrapper ¶

func LoadGeneralBoardsWrapper(c *gin.Context)

func LoadManArticles ¶

func LoadManArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadManArticlesWrapper ¶

func LoadManArticlesWrapper(c *gin.Context)

func LoadPopularArticles ¶

func LoadPopularArticles(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadPopularArticlesWrapper ¶

func LoadPopularArticlesWrapper(c *gin.Context)

func LoadPopularBoards ¶

func LoadPopularBoards(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadPopularBoardsAllGuest ¶

func LoadPopularBoardsAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadPopularBoardsAllGuestWrapper ¶

func LoadPopularBoardsAllGuestWrapper(c *gin.Context)

func LoadPopularBoardsWrapper ¶

func LoadPopularBoardsWrapper(c *gin.Context)

func LoadUserArticles ¶

func LoadUserArticles(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadUserArticlesWrapper ¶

func LoadUserArticlesWrapper(c *gin.Context)

func LoadUserComments ¶

func LoadUserComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoadUserCommentsWrapper ¶

func LoadUserCommentsWrapper(c *gin.Context)

func Login(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LoginHTMLWrapper ¶

func LoginHTMLWrapper(c *gin.Context)

func LoginRequiredJSON ¶

func LoginRequiredJSON(theFunc LoginRequiredAPIFunc, params interface{}, c *gin.Context)

func LoginRequiredPathJSON ¶

func LoginRequiredPathJSON(theFunc LoginRequiredPathAPIFunc, params interface{}, path interface{}, c *gin.Context)

func LoginRequiredPathQuery ¶

func LoginRequiredPathQuery(theFunc LoginRequiredPathAPIFunc, params interface{}, path interface{}, c *gin.Context)

func LoginRequiredQuery ¶

func LoginRequiredQuery(theFunc LoginRequiredAPIFunc, params interface{}, c *gin.Context)

func LoginRequiredRedirectPathQuery ¶ added in v0.43.0

func LoginRequiredRedirectPathQuery(theFunc LoginRequiredRedirectPathAPIFunc, params interface{}, path interface{}, c *gin.Context)

func LoginWrapper ¶

func LoginWrapper(c *gin.Context)

func Logout ¶

func Logout(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func LogoutWrapper ¶

func LogoutWrapper(c *gin.Context)

func ManArticleLockKey ¶

func ManArticleLockKey(boardID bbs.BBoardID, articleID types.ManArticleID) (key string)

func OptionsWrapper ¶

func OptionsWrapper(c *gin.Context)

func ParseClaimInt ¶ added in v0.43.0

func ParseClaimInt(claim jwt.MapClaims, idx string) (ret int, err error)

func ParseClaimString ¶ added in v0.43.0

func ParseClaimString(claim jwt.MapClaims, idx string) (ret string, err error)

func ParseJwt ¶ added in v0.43.0

func ParseJwt(raw string, secret []byte) (tok *jwt.Token, err error)

func PathQuery ¶

func PathQuery(theFunc PathAPIFunc, params interface{}, path interface{}, c *gin.Context)

func Query ¶

func Query(theFunc APIFunc, params interface{}, c *gin.Context)

func RedirectFormJSON ¶ added in v0.43.0

func RedirectFormJSON(theFunc RedirectAPIFunc, params interface{}, c *gin.Context)

func RedirectQuery ¶ added in v0.43.0

func RedirectQuery(theFunc RedirectAPIFunc, params interface{}, c *gin.Context)

func Refresh ¶

func Refresh(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func RefreshBrdnameBlackListMap ¶ added in v0.42.2

func RefreshBrdnameBlackListMap() (nBoardID int, err error)

func RefreshBrdnameBlackListMapAllGuest ¶ added in v0.42.3

func RefreshBrdnameBlackListMapAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func RefreshBrdnameBlackListMapAllGuestWrapper ¶ added in v0.42.3

func RefreshBrdnameBlackListMapAllGuestWrapper(c *gin.Context)

func RefreshBrdnameWhiteListMap ¶ added in v0.42.2

func RefreshBrdnameWhiteListMap() (nBoardID int, err error)

func RefreshBrdnameWhiteListMapAllGuest ¶ added in v0.42.3

func RefreshBrdnameWhiteListMapAllGuest(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func RefreshBrdnameWhiteListMapAllGuestWrapper ¶ added in v0.42.3

func RefreshBrdnameWhiteListMapAllGuestWrapper(c *gin.Context)

func RefreshWrapper ¶

func RefreshWrapper(c *gin.Context)

func RegisterClient ¶

func RegisterClient(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func RegisterClientWrapper ¶

func RegisterClientWrapper(c *gin.Context)

func RegisterHTMLWrapper ¶

func RegisterHTMLWrapper(c *gin.Context)

func RegisterUser ¶

func RegisterUser(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result string, statusCode int, err error)

func RegisterUserWrapper ¶

func RegisterUserWrapper(c *gin.Context)

func ReplyComments ¶

func ReplyComments(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func ReplyCommentsWrapper ¶

func ReplyCommentsWrapper(c *gin.Context)

func SetIDEmail ¶

func SetIDEmail(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

func SetIDEmailWrapper ¶

func SetIDEmailWrapper(c *gin.Context)

func SetIsTest ¶

func SetIsTest()

func TryGetArticleContentInfo ¶

func TryGetArticleContentInfo(userID bbs.UUserID, bboardID bbs.BBoardID, articleID bbs.ArticleID, c *gin.Context, isSystem bool, isHash bool, isContent bool) (content [][]*types.Rune, contentPrefix [][]*types.Rune, contentMD5 string, ip string, host string, bbs string, signatureMD5 string, signatureDBCS []byte, articleDetailSummary *schema.ArticleDetailSummary, fileSize int, hash cmsys.Fnv64_t, statusCode int, err error)

TryGetArticleContentInfo

嘗試拿到 article-content

根據 article-id 得到相對應的 filename, ownerid, create-time.
嘗試從 schema 拿到 db summary 資訊. (create-time)
如果可以從 schema 拿到 db 資訊: 3.1. 如果已經 deleted: return deleted. 3.2. 如果距離上次跟 pttbbs 拿的時間太近: 從 schema 拿到 content, return schema-content.
嘗試做 lock. 4.1. 如果 lock 失敗: 從 schema 拿到 content, return schema-content.
從 pttbbs 拿到 article
如果從 pttbbs 拿到的時間比 schema 裡拿到的時間舊的話: return schema-content.
parse article 為 content / comments.
將 comments parse 為 firstComments / theRestComments.
將 theRestComments 丟進 queue 裡.

func TryGetManArticleContentInfo ¶

func TryGetManArticleContentInfo(userID bbs.UUserID, bboardID bbs.BBoardID, articleID types.ManArticleID, c *gin.Context, isSystem bool, isContent bool) (content [][]*types.Rune, contentMD5 string, articleDetailSummary *schema.ManArticleDetailSummary, err error)

func TryLoadPttWebPopularBoards ¶

func TryLoadPttWebPopularBoards(c *gin.Context) (boards []*schema.BoardSummary, err error)

func UnsetIsTest ¶

func UnsetIsTest()

func UpdateArticleContentInfo ¶

func UpdateArticleContentInfo(
	boardID bbs.BBoardID,
	articleID bbs.ArticleID,
	content [][]*types.Rune,
	contentPrefix [][]*types.Rune,
	contentMD5 string,
	ip string,
	host string,
	bbs string,
	signatureMD5 string,
	signatureDBCS []byte,
	updateNanoTS types.NanoTS,
) (err error)

func UpdateManArticleContentInfo ¶

func UpdateManArticleContentInfo(
	boardID bbs.BBoardID,
	articleID types.ManArticleID,
	content [][]*types.Rune,
	contentMD5 string,
	updateNanoTS types.NanoTS,
) (err error)

func UserAttemptChangeEmailHTMLWrapper ¶

func UserAttemptChangeEmailHTMLWrapper(c *gin.Context)

func UserAttemptSetIDEmailHTMLWrapper ¶

func UserAttemptSetIDEmailHTMLWrapper(c *gin.Context)

func UserChangeEmailHTMLWrapper ¶

func UserChangeEmailHTMLWrapper(c *gin.Context)

func UserChangePasswdHTMLWrapper ¶

func UserChangePasswdHTMLWrapper(c *gin.Context)

func UserHTMLWrapper ¶

func UserHTMLWrapper(c *gin.Context)

func UserSetIDEmailHTMLWrapper ¶

func UserSetIDEmailHTMLWrapper(c *gin.Context)

func ZKProxyWrapper ¶ added in v0.43.0

func ZKProxyWrapper(zkProxy *httputil.ReverseProxy) func(c *gin.Context)

Types ¶

type APIFunc ¶

type APIFunc func(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

type AddFavoriteBoardParams ¶

type AddFavoriteBoardParams struct {
	LevelIdx schema.LevelIdx   `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
	FBoardID apitypes.FBoardID `json:"bid" form:"bid" url:"bid"`
}

type AddFavoriteBoardPath ¶

type AddFavoriteBoardPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type AddFavoriteFolderParams ¶

type AddFavoriteFolderParams struct {
	LevelIdx schema.LevelIdx `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
	Title    string          `json:"title,omitempty" form:"title,omitempty" url:"title,omitempty"`
}

type AddFavoriteFolderPath ¶

type AddFavoriteFolderPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type AddFavoriteLineParams ¶

type AddFavoriteLineParams struct {
	LevelIdx schema.LevelIdx `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
}

type AddFavoriteLinePath ¶

type AddFavoriteLinePath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type AddFavoriteResult ¶

type AddFavoriteResult *apitypes.BoardSummary

type AttemptChangeEmailParams ¶

type AttemptChangeEmailParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	Password string `json:"password" form:"password"`
	Email    string `json:"email" form:"email"`
}

type AttemptChangeEmailPath ¶

type AttemptChangeEmailPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type AttemptChangeEmailResult ¶

type AttemptChangeEmailResult struct {
	UserID    bbs.UUserID `json:"user_id"`
	Email     string      `json:"email"`
	TokenUser bbs.UUserID `json:"tokenuser"`
}

type AttemptLoginParams ¶ added in v0.43.0

type AttemptLoginParams struct {
	Input string `json:"input" form:"input"`
}

type AttemptLoginResult ¶ added in v0.43.0

type AttemptLoginResult struct{}

type AttemptRegisterUserParams ¶

type AttemptRegisterUserParams struct {
	Email string `json:"email" form:"email"`
}

type AttemptRegisterUserResult ¶

type AttemptRegisterUserResult struct{}

type AttemptSetIDEmailParams ¶

type AttemptSetIDEmailParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	Password string `json:"password" form:"password"`
	Email    string `json:"email"`
}

type AttemptSetIDEmailPath ¶

type AttemptSetIDEmailPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type AttemptSetIDEmailResult ¶

type AttemptSetIDEmailResult struct {
	UserID bbs.UUserID `json:"user_id"`
	Email  string      `json:"email"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type ChangeEmailParams ¶

type ChangeEmailParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`
	Jwt          string `json:"token" form:"token" url:"token"`
}

type ChangeEmailPath ¶

type ChangeEmailPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type ChangeEmailResult ¶

type ChangeEmailResult struct {
	Email string `json:"email"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type ChangePasswdParams ¶

type ChangePasswdParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	OrigPassword    string `json:"orig_password" form:"orig_password"`
	Password        string `json:"password" form:"password"`
	PasswordConfirm string `json:"password_confirm" form:"password_confirm"`
}

type ChangePasswdPath ¶

type ChangePasswdPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type ChangePasswdResult ¶

type ChangePasswdResult LoginResult

func NewChangePasswdResult ¶

func NewChangePasswdResult(result_b *pttbbsapi.ChangePasswdResult) *ChangePasswdResult

type CheckExistsUserParams ¶

type CheckExistsUserParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	Username string `json:"username" form:"username"`
}

type CheckExistsUserResult ¶

type CheckExistsUserResult struct {
	IsExists bool `json:"is_exists"`
}

type ClientInfo ¶

type ClientInfo struct {
	ClientID   string           `json:"c"`
	ClientType types.ClientType `json:"t"`
}

type CooldownLimit ¶

type CooldownLimit struct {
	NUser    int
	Posttime int
}

type CreateArticleParams ¶

type CreateArticleParams struct {
	PostType string          `json:"class" form:"class" url:"class"`
	Title    string          `json:"title" form:"title" url:"title"`
	Content  [][]*types.Rune `json:"content" form:"content" url:"content"`
}

type CreateArticlePath ¶

type CreateArticlePath struct {
	FBoardID apitypes.FBoardID `uri:"bid" binding:"required"`
}

type CreateArticleResult ¶

type CreateArticleResult *apitypes.ArticleSummary

type CreateBoardParams ¶

type CreateBoardParams struct {
	Brdname      string            `json:"brdname" form:"brdname" url:"brdname"`
	BrdClass     string            `json:"class" form:"class" url:"class"`
	BrdTitle     string            `json:"title" form:"title" url:"title"`
	BMs          []bbs.UUserID     `json:"bms,omitempty" form:"bms,omitempty" url:"bms,omitempty"`
	BrdAttr      ptttype.BrdAttr   `json:"brdattr,omitempty" form:"brdattr,omitempty" url:"brdattr,omitempty"`
	Level        ptttype.PERM      `json:"level,omitempty" form:"level,omitempty" url:"level,omitempty"`
	ChessCountry ptttype.ChessCode `json:"chess_country,omitempty" form:"chess_country,omitempty" url:"chess_country,omitempty"`
	IsGroup      bool              `json:"is_group,omitempty" form:"is_group,omitempty" url:"is_group,omitempty"`
}

type CreateBoardPath ¶

type CreateBoardPath struct {
	ClsBid ptttype.Bid `uri:"cls" binding:"required"`
}

type CreateBoardResult ¶

type CreateBoardResult *apitypes.BoardSummary

type CreateCommentParams ¶

type CreateCommentParams struct {
	CommentType ptttype.CommentType `json:"type" form:"type" url:"type"`
	Content     string              `json:"content" form:"content" url:"content"`
}

type CreateCommentPath ¶

type CreateCommentPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid" binding:"required"`
	FArticleID apitypes.FArticleID `uri:"aid" binding:"required"`
}

type CreateCommentResult ¶

type CreateCommentResult *apitypes.Comment

type CreateRankParams ¶

type CreateRankParams struct {
	Rank int `json:"rank" form:"rank" url:"rank"`
}

type CreateRankPath ¶

type CreateRankPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid" binding:"required"`
	FArticleID apitypes.FArticleID `uri:"aid" binding:"required"`
}

type CreateRankResult ¶

type CreateRankResult struct {
	Rank int `json:"rank"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type CrossPostParams ¶

type CrossPostParams struct {
	XBoardID apitypes.FBoardID `json:"xbid" form:"xbid" url:"xbid"`
}

type CrossPostPath ¶

type CrossPostPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid" binding:"required"`
	FArticleID apitypes.FArticleID `uri:"aid" binding:"required"`
}

type CrossPostResult ¶

type CrossPostResult struct {
	Article *apitypes.ArticleSummary `json:"article"`
	Comment *apitypes.Comment        `json:"comment"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type DeleteArticlesParams ¶

type DeleteArticlesParams struct {
	ArticleIDs []apitypes.FArticleID `json:"aids" form:"aids" url:"aids" binding:"required"`
}

type DeleteArticlesPath ¶

type DeleteArticlesPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type DeleteArticlesResult ¶

type DeleteArticlesResult struct {
	Success   bool        `json:"success"`
	TokenUser bbs.UUserID `json:"tokenuser"`
}

type DeleteCommentsParams ¶

type DeleteCommentsParams struct {
	TheList []*apitypes.DeleteCommentParams `json:"list" form:"list" url:"list"`
}

type DeleteCommentsPath ¶

type DeleteCommentsPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type DeleteCommentsResult ¶

type DeleteCommentsResult struct {
	Success   bool        `json:"success"`
	TokenUser bbs.UUserID `json:"tokenuser"`
}

type DeleteFavoriteParams ¶

type DeleteFavoriteParams struct {
	LevelIdx schema.LevelIdx `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
	Idx      string          `json:"idx,omitempty" form:"idx,omitempty" url:"idx,omitempty"`
}

type DeleteFavoritePath ¶

type DeleteFavoritePath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type DeleteFavoriteResult ¶

type DeleteFavoriteResult struct {
	Success   bool        `json:"success"`
	TokenUser bbs.UUserID `json:"tokenuser"`
}

type EditArticleParams ¶

type EditArticleParams struct {
	PostType string          `json:"class" form:"class" url:"class"`
	Title    string          `json:"title" form:"title" url:"title"`
	Content  [][]*types.Rune `json:"content" form:"content" url:"content"`
}

type EditArticlePath ¶

type EditArticlePath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type EditArticleResult ¶

type EditArticleResult struct {
	MTime         types.Time8     `json:"modified"` //
	Content       [][]*types.Rune `json:"content"`
	ContentPrefix [][]*types.Rune `json:"prefix"`
	Title         string          `json:"title"` //
	Class         string          `json:"class"` // can be: R: 轉, [class]
	TokenUser     bbs.UUserID     `json:"tokenuser"`
}

type GetArticleBlocksParams ¶

type GetArticleBlocksParams struct {
	StartIdx string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Max      int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewGetArticleBlocksParams ¶

func NewGetArticleBlocksParams() *GetArticleBlocksParams

type GetArticleBlocksPath ¶

type GetArticleBlocksPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type GetArticleBlocksResult ¶

type GetArticleBlocksResult struct {
	Content [][]*types.Rune `json:"content,omitempty"`

	IsDeleted   bool                `json:"deleted,omitempty"`     //
	CreateTime  types.Time8         `json:"create_time,omitempty"` //
	MTime       types.Time8         `json:"modified,omitempty"`    //
	Recommend   int                 `json:"recommend,omitempty"`   //
	NComments   int                 `json:"n_comments,omitempty"`  //
	Owner       bbs.UUserID         `json:"owner,omitempty"`       //
	Nickname    string              `json:"nickname,omitempty"`
	Title       string              `json:"title,omitempty"` //
	Money       int                 `json:"money,omitempty"` //
	Class       string              `json:"class,omitempty"` // can be: R: 轉, [class]
	Filemode    ptttype.FileMode    `json:"mode,omitempty"`  //
	SubjectType ptttype.SubjectType `json:"subject_type"`

	IP   string `json:"ip,omitempty"`
	Host string `json:"host,omitempty"` // ip 的中文呈現, 外國則為國家.
	BBS  string `json:"bbs,omitempty"`

	Rank int `json:"rank,omitempty"` // 評價

	NextIdx string `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetArticleDetailParams ¶

type GetArticleDetailParams struct{}

type GetArticleDetailPath ¶

type GetArticleDetailPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type GetArticleDetailResult ¶

type GetArticleDetailResult struct {
	BBoardID   apitypes.FBoardID   `json:"bid"`         //
	ArticleID  apitypes.FArticleID `json:"aid"`         //
	IsDeleted  bool                `json:"deleted"`     //
	CreateTime types.Time8         `json:"create_time"` //
	MTime      types.Time8         `json:"modified"`    //
	Recommend  int                 `json:"recommend"`   //
	NComments  int                 `json:"n_comments"`  //
	Owner      bbs.UUserID         `json:"owner"`       //
	Nickname   string              `json:"nickname"`
	Title      string              `json:"title"` //
	Money      int                 `json:"money"` //
	Class      string              `json:"class"` // can be: R: 轉, [class]
	Filemode   ptttype.FileMode    `json:"mode"`  //

	SubjectType ptttype.SubjectType `json:"subject_type"`

	URL  string `json:"url"`  //
	Read bool   `json:"read"` //

	Brdname string `json:"brdname"`

	Content       [][]*types.Rune `json:"content"`
	ContentPrefix [][]*types.Rune `json:"prefix"`

	IP   string `json:"ip"`
	Host string `json:"host"` // ip 的中文呈現, 外國則為國家.
	BBS  string `json:"bbs"`

	Rank int `json:"rank"` // 評價

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetBoardDetailParams ¶

type GetBoardDetailParams struct {
	Fields string `json:"fields,omitempty" form:"fields,omitempty" uri:"fields,omitempty"`
}

type GetBoardDetailPath ¶

type GetBoardDetailPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type GetBoardDetailResult ¶

type GetBoardDetailResult *apitypes.BoardDetail

type GetBoardSummaryParams ¶

type GetBoardSummaryParams struct{}

type GetBoardSummaryPath ¶

type GetBoardSummaryPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type GetBoardSummaryResult ¶

type GetBoardSummaryResult *apitypes.BoardSummary

type GetManArticleBlocksParams ¶

type GetManArticleBlocksParams struct {
	StartIdx string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Max      int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewGetManArticleBlocksParams ¶

func NewGetManArticleBlocksParams() *GetManArticleBlocksParams

type GetManArticleBlocksPath ¶

type GetManArticleBlocksPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type GetManArticleBlocksResult ¶

type GetManArticleBlocksResult struct {
	Content [][]*types.Rune `json:"content,omitempty"`

	IsDeleted  bool        `json:"deleted,omitempty"`     //
	CreateTime types.Time8 `json:"create_time,omitempty"` //
	MTime      types.Time8 `json:"modified,omitempty"`    //
	Title      string      `json:"title,omitempty"`       //

	NextIdx string `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetManArticleDetailPath ¶

type GetManArticleDetailPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type GetManArticleDetailResult ¶

type GetManArticleDetailResult struct {
	BBoardID   apitypes.FBoardID   `json:"bid"` //
	ArticleID  apitypes.FArticleID `json:"aid"` //
	LevelIdx   apitypes.FArticleID `json:"level_idx"`
	IsDeleted  bool                `json:"deleted"`     //
	CreateTime types.Time8         `json:"create_time"` //
	MTime      types.Time8         `json:"modified"`    //
	Title      string              `json:"title"`       //
	IsDir      bool                `json:"is_dir"`

	Content [][]*types.Rune `json:"content"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetUserIDResult ¶

type GetUserIDResult struct {
	UserID bbs.UUserID `json:"user_id"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetUserInfoParams ¶

type GetUserInfoParams struct {
	Fields string `json:"fields,omitempty" form:"fields,omitempty" url:"fields,omitempty"`
}

type GetUserInfoPath ¶

type GetUserInfoPath struct {
	Username string `uri:"username"`
}

type GetUserInfoResult ¶

type GetUserInfoResult struct {
	UserID   bbs.UUserID `json:"user_id"`
	Username string      `json:"username"`
	Realname string      `json:"realtime"`
	Nickname string      `json:"nickname"`

	IsGovernmentID bool `json:"is_government_id"`

	Uflag        ptttype.UFlag `json:"flag"`
	Userlevel    ptttype.PERM  `json:"perm"`
	Numlogindays int           `json:"login_days"`
	Numposts     int           `json:"posts"`
	Firstlogin   types.Time8   `json:"first_login"`
	Lastlogin    types.Time8   `json:"last_login"`
	LastIP       string        `json:"last_ip"`
	LastHost     string        `json:"last_host"` // ip 的中文呈現, 外國則為國家.

	Money    int    `json:"money"`
	PttEmail string `json:"pttemail"`
	Justify  string `json:"justify"`
	Over18   bool   `json:"over18"`

	PagerUIType uint8             `json:"pager_ui"` /* 呼叫器界面類別 (was: WATER_*) */
	Pager       ptttype.PagerMode `json:"pager"`    /* 呼叫器狀態 */
	Invisible   bool              `json:"invisible"`
	Exmailbox   uint32            `json:"exmail"`

	Career        string      `json:"career"`
	Role          uint32      `json:"role"`
	LastSeen      types.Time8 `json:"last_seen"`
	TimeSetAngel  types.Time8 `json:"time_set_angel"`
	TimePlayAngel types.Time8 `json:"time_play_angel"`

	LastSong  types.Time8 `json:"last_song"`
	LoginView uint32      `json:"login_view"`

	Vlcount        int `json:"violation"`
	FiveWin        int `json:"five_win"`
	FiveLose       int `json:"five_lose"`
	FiveTie        int `json:"five_tie"`
	ChcWin         int `json:"chc_win"`
	ChcLose        int `json:"chc_lose"`
	ChcTie         int `json:"chc_tie"`
	Conn6Win       int `json:"conn6_win"`
	Conn6Lose      int `json:"conn6_lose"`
	Conn6Tie       int `json:"conn6_tie"`
	GoWin          int `json:"go_win"`
	GoLose         int `json:"go_lose"`
	GoTie          int `json:"go_tie"`
	DarkWin        int `json:"dark_win"`
	DarkLose       int `json:"dark_lose"`
	DarkTie        int `json:"dark_tie"`   /* 暗棋戰績 和 */
	ChessEloRating int `json:"chess_rank"` /* 象棋等級 */

	UaVersion uint8 `json:"ua_version"`

	Signature uint8       `json:"signaure"` /* 慣用簽名檔 */
	BadPost   int         `json:"bad_post"` /* 評價為壞文章數 */
	MyAngel   bbs.UUserID `json:"angel"`    /* 我的小天使 */

	TimeRemoveBadPost types.Time8 `json:"time_remove_bad_post"`
	TimeViolateLaw    types.Time8 `json:"time_violate_law"`

	IsDeleted bool        `json:"deleted"`
	UpdateTS  types.Time8 `json:"update_ts"`

	UserLevel2 ptttype.PERM2 `bson:"perm2"`
	UpdateTS2  types.Time8   `bson:"update_ts2"`

	Avatar   []byte      `json:"avatar"`
	AvatarTS types.Time8 `json:"avatar_ts"`

	Email   string      `json:"email"`
	EmailTS types.Time8 `json:"email_ts"`

	TwoFactorEnabled   bool        `json:"twofactor_enabled"`
	TwoFactorEnabledTS types.Time8 `json:"twofactor_enabled_ts"`

	IDEmail    string      `json:"idemail"`
	IDEmailSet bool        `json:"idemail_set"`
	IDEmailTS  types.Time8 `json:"idemail_ts"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

func NewUserInfoResult ¶

func NewUserInfoResult(userDetail_db *schema.UserDetail, userNewInfo_db *schema.UserNewInfo, userIDEmail_db *schema.UserIDEmail, userEmail_db *schema.UserEmail, userPermInfo *schema.UserPermInfo) (result *GetUserInfoResult)

type GetUserVisitCountResult ¶

type GetUserVisitCountResult struct {
	Total int64 `json:"total"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetUsernameResult ¶ added in v0.43.0

type GetUsernameResult struct {
	Username string `json:"username"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type GetVersionResult ¶

type GetVersionResult struct {
	Version    string `json:"version"`
	GitVersion string `json:"commit"`

	PttVersion    string `json:"pttversion"`
	PttGitVersion string `json:"pttcommit"`
}

type HTMLPath ¶

type HTMLPath struct {
	Path string `uri:"path"`
}

type IndexParams ¶

type IndexParams struct {
	In int `json:"in,omitempty" form:"in,omitempty" url:"in,omitempty"`
}

func NewIndexParams ¶

func NewIndexParams() *IndexParams

type IndexResult ¶

type IndexResult struct {
	Data interface{} `json:"data,omitempty"`
}

type JwtClaim ¶ added in v0.43.0

type JwtClaim struct {
	ClientInfo string `json:"cli"`
	UUserID    string `json:"sub"`
	Expire     int    `json:"exp"`
}

type LoadArticleCommentsParams ¶

type LoadArticleCommentsParams struct {
	StartIdx   string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Descending bool   `json:"desc,omitempty"  form:"desc,omitempty" url:"desc,omitempty"`
	Max        int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadArticleCommentsParams ¶

func NewLoadArticleCommentsParams() *LoadArticleCommentsParams

type LoadArticleCommentsPath ¶

type LoadArticleCommentsPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type LoadArticleCommentsResult ¶

type LoadArticleCommentsResult struct {
	List    []*apitypes.Comment `json:"list"`
	NextIdx string              `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadArticleCommentsResult ¶

func NewLoadArticleCommentsResult(comments_db []*schema.Comment, nextComment *schema.Comment, userID bbs.UUserID) (result *LoadArticleCommentsResult)

type LoadAutoCompleteBoardsParams ¶

type LoadAutoCompleteBoardsParams struct {
	Keyword   string `json:"brdname,omitempty" form:"brdname,omitempty" url:"brdname,omitempty"`
	StartIdx  string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Ascending bool   `json:"asc,omitempty"  form:"asc,omitempty" url:"asc,omitempty"`
	Max       int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadAutoCompleteBoardsParams ¶

func NewLoadAutoCompleteBoardsParams() *LoadAutoCompleteBoardsParams

type LoadBottomArticlesPath ¶

type LoadBottomArticlesPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type LoadBottomArticlesResult ¶

type LoadBottomArticlesResult struct {
	List []*apitypes.ArticleSummary `json:"list"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadBottomArticlesResult ¶

func NewLoadBottomArticlesResult(a_db []*schema.ArticleSummary, userReadArticleMap map[bbs.ArticleID]bool, articlePermEditableMap map[bbs.ArticleID]error, articlePermDeletableMap map[bbs.ArticleID]error, userID bbs.UUserID) *LoadBottomArticlesResult

type LoadClassBoardsParams ¶

type LoadClassBoardsParams struct {
	StartIdx string          `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	SortBy   ptttype.BSortBy `json:"sortby,omitempty" form:"sortby,omitempty" url:"sortby,omitempty"`

	Ascending bool `json:"asc,omitempty"  form:"asc,omitempty" url:"asc,omitempty"`
	Max       int  `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadClassBoardsParams ¶

func NewLoadClassBoardsParams() *LoadClassBoardsParams

type LoadClassBoardsPath ¶

type LoadClassBoardsPath struct {
	ClsID ptttype.Bid `uri:"clsid"`
}

type LoadClassBoardsResult ¶

type LoadClassBoardsResult struct {
	List    []*apitypes.BoardSummary `json:"list"`
	NextIdx string                   `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadClassBoardsResult ¶

func NewLoadClassBoardsResult(boardSummaries_db []*schema.BoardSummary, userBoardInfoMap map[bbs.BBoardID]*apitypes.UserBoardInfo, nextIdx string, sortBy ptttype.BSortBy, userID bbs.UUserID) (ret *LoadClassBoardsResult)

type LoadFavoriteBoardsParams ¶

type LoadFavoriteBoardsParams struct {
	LevelIdx  schema.LevelIdx `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
	StartIdx  string          `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Ascending bool            `json:"asc,omitempty"  form:"asc,omitempty" url:"asc,omitempty"`
	Max       int             `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadFavoriteBoardsParams ¶

func NewLoadFavoriteBoardsParams() *LoadFavoriteBoardsParams

type LoadFavoriteBoardsPath ¶

type LoadFavoriteBoardsPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type LoadFavoriteBoardsResult ¶

type LoadFavoriteBoardsResult struct {
	List    []*apitypes.BoardSummary `json:"list"`
	NextIdx string                   `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadFavoriteBoardsResult ¶

func NewLoadFavoriteBoardsResult(userID bbs.UUserID, userFavorites_db []*schema.UserFavorites, boardSummaryMap_db map[ptttype.Bid]*schema.BoardSummary, userBoardInfoMap map[bbs.BBoardID]*apitypes.UserBoardInfo, nextIdx string) (result *LoadFavoriteBoardsResult)

type LoadGeneralArticlesParams ¶

type LoadGeneralArticlesParams struct {
	Keyword    string `json:"title,omitempty" form:"title,omitempty" url:"title,omitempty"`
	StartIdx   string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Max        int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
	Descending bool   `json:"desc,omitempty"  form:"desc,omitempty" url:"desc,omitempty"`
}

func NewLoadGeneralArticlesParams ¶

func NewLoadGeneralArticlesParams() *LoadGeneralArticlesParams

type LoadGeneralArticlesPath ¶

type LoadGeneralArticlesPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type LoadGeneralArticlesResult ¶

type LoadGeneralArticlesResult struct {
	List    []*apitypes.ArticleSummary `json:"list"`
	NextIdx string                     `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadGeneralArticlesResult ¶

func NewLoadGeneralArticlesResult(a_db []*schema.ArticleSummary, userReadArticleMap map[bbs.ArticleID]bool, articlePermEditableMap map[bbs.ArticleID]error, articlePermDeletableMap map[bbs.ArticleID]error, nextIdx string, userID bbs.UUserID) *LoadGeneralArticlesResult

type LoadGeneralBoardsParams ¶

type LoadGeneralBoardsParams struct {
	Title     string `json:"title,omitempty" form:"title,omitempty" url:"title,omitempty"`
	Keyword   string `json:"keyword,omitempty" form:"keyword,omitempty" url:"keyword,omitempty"`
	StartIdx  string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Ascending bool   `json:"asc,omitempty"  form:"asc,omitempty" url:"asc,omitempty"`
	Max       int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadGeneralBoardsParams ¶

func NewLoadGeneralBoardsParams() *LoadGeneralBoardsParams

type LoadGeneralBoardsResult ¶

type LoadGeneralBoardsResult struct {
	List    []*apitypes.BoardSummary `json:"list"`
	NextIdx string                   `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadGeneralBoardsResult ¶

func NewLoadGeneralBoardsResult(boardSummaries_db []*schema.BoardSummary, userBoardInfoMap map[bbs.BBoardID]*apitypes.UserBoardInfo, nextIdx string, url string, userID bbs.UUserID) *LoadGeneralBoardsResult

type LoadManArticlesParams ¶

type LoadManArticlesParams struct {
	LevelIdx apitypes.FArticleID `json:"level_idx,omitempty" form:"level_idx,omitempty" url:"level_idx,omitempty"`
}

type LoadManArticlesPath ¶

type LoadManArticlesPath struct {
	FBoardID apitypes.FBoardID `uri:"bid"`
}

type LoadManArticlesResult ¶

type LoadManArticlesResult struct {
	List []*apitypes.ManArticleSummary `json:"list"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadManArticlesResult ¶

func NewLoadManArticlesResult(articleSummaries_db []*schema.ManArticleSummary, userID bbs.UUserID) (r *LoadManArticlesResult)

type LoadPopularArticlesParams ¶

type LoadPopularArticlesParams struct {
	StartIdx   string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Max        int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
	Descending bool   `json:"desc,omitempty"  form:"desc,omitempty" url:"desc,omitempty"`
}

func NewLoadPopularArticlesParams ¶

func NewLoadPopularArticlesParams() *LoadPopularArticlesParams

type LoadPopularArticlesResult ¶

type LoadPopularArticlesResult struct {
	List    []*apitypes.ArticleSummary `json:"list"`
	NextIdx string                     `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

type LoadPopularBoardsResult ¶

type LoadPopularBoardsResult struct {
	List []*apitypes.BoardSummary `json:"list"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadPopularBoardsResult ¶

func NewLoadPopularBoardsResult(boardSummaries_db []*schema.BoardSummary, userBoardInfoMap map[bbs.BBoardID]*apitypes.UserBoardInfo, userID bbs.UUserID) *LoadPopularBoardsResult

type LoadUserArticlesParams ¶

type LoadUserArticlesParams struct {
	StartIdx   string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Descending bool   `json:"desc,omitempty"  form:"desc,omitempty" url:"desc,omitempty"`
	Max        int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewUserArticlesParams ¶

func NewUserArticlesParams() *LoadUserArticlesParams

type LoadUserArticlesPath ¶

type LoadUserArticlesPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type LoadUserArticlesResult ¶

type LoadUserArticlesResult struct {
	List    []*apitypes.ArticleSummary `json:"list"`
	NextIdx string                     `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadUserArticlesResult ¶

func NewLoadUserArticlesResult(a_db []*schema.ArticleSummary, userReadBoardArticleMap map[types.BoardArticleID]bool, nextIdx string, userID bbs.UUserID) *LoadUserArticlesResult

type LoadUserCommentsParams ¶

type LoadUserCommentsParams struct {
	StartIdx   string `json:"start_idx,omitempty" form:"start_idx,omitempty" url:"start_idx,omitempty"`
	Descending bool   `json:"desc,omitempty"  form:"desc,omitempty" url:"desc,omitempty"`
	Max        int    `json:"limit,omitempty" form:"limit,omitempty" url:"limit,omitempty"`
}

func NewLoadUserCommentsParams ¶

func NewLoadUserCommentsParams() *LoadUserCommentsParams

type LoadUserCommentsPath ¶

type LoadUserCommentsPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type LoadUserCommentsResult ¶

type LoadUserCommentsResult struct {
	List    []*apitypes.ArticleComment `json:"list"`
	NextIdx string                     `json:"next_idx"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewLoadUserCommentsResult ¶

func NewLoadUserCommentsResult(
	commentSummaries_db []*schema.CommentSummary,
	articleSummaryMap map[types.BoardArticleID]*schema.ArticleSummary,
	userReadBoardArticleMap map[types.BoardArticleID]types.NanoTS,
	nextIdx string,
	userID bbs.UUserID,
) (result *LoadUserCommentsResult)

type LoginLog ¶

type LoginLog struct {
	ClientInfo
	LoginID   string
	LoginTime types.NanoTS
	LoginIP   string
	IsSuccess bool
}

LoginLog record user login info, no matter success or not

func (*LoginLog) String ¶

func (l *LoginLog) String() string

type LoginParams ¶

type LoginParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	// Input can be username or email
	Input string `json:"input" form:"input"`

	VerifyCode string `json:"verify_code" form:"verify_code"`
}

func NewLoginParams ¶

func NewLoginParams() *LoginParams

type LoginRequiredAPIFunc ¶

type LoginRequiredAPIFunc func(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

type LoginRequiredPathAPIFunc ¶

type LoginRequiredPathAPIFunc func(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

type LoginRequiredRedirectPathAPIFunc ¶ added in v0.43.0

type LoginRequiredRedirectPathAPIFunc func(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (redirectPath string, statusCode int, err error)

type LoginResult ¶

type LoginResult struct {
	Username        string      `json:"username"`
	AccessToken     string      `json:"access_token"`
	TokenType       string      `json:"token_type"`
	RefreshToken    string      `json:"refresh_token"`
	AccessExpireTS  types.Time8 `json:"access_expire"`
	RefreshExpireTS types.Time8 `json:"refresh_expire"`
}

func NewLoginResult ¶

func NewLoginResult(username string, accessToken string, accessExpireTS types.Time8, refreshToken string, refreshExpireTS types.Time8) *LoginResult

type PathAPIFunc ¶

type PathAPIFunc func(remoteAddr string, user *UserInfo, params interface{}, path interface{}, c *gin.Context) (result interface{}, statusCode int, err error)

type RedirectAPIFunc ¶ added in v0.43.0

type RedirectAPIFunc func(remoteAddr string, user *UserInfo, params interface{}, c *gin.Context) (redirectPath string, statusCode int, err error)

type RefreshBrdnameBlackListMapResult ¶ added in v0.42.3

type RefreshBrdnameBlackListMapResult struct {
	Total int `json:"total"`
}

type RefreshBrdnameWhiteListMapResult ¶ added in v0.42.3

type RefreshBrdnameWhiteListMapResult struct {
	Total int `json:"total"`
}

type RefreshParams ¶

type RefreshParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`

	RefreshToken string `json:"refresh_token"`
}

type RefreshResult ¶

type RefreshResult LoginResult

type RegisterClientParams ¶

type RegisterClientParams struct {
	ClientID   string           `json:"client_id"`
	ClientType types.ClientType `json:"client_type"`
}

func NewRegisterClientParams ¶

func NewRegisterClientParams() *RegisterClientParams

type RegisterClientResult ¶

type RegisterClientResult struct {
	ClientSecret string `json:"client_secret"`

	TokenUser bbs.UUserID `json:"tokenuser,omitempty"`
}

func NewRegisterClientResult ¶

func NewRegisterClientResult(client *schema.Client, userID bbs.UUserID) *RegisterClientResult

type RegisterUserParams ¶

type RegisterUserParams struct {
	Token string `json:"token" form:"token" url:"token"`
}

func NewRegisterUserParams ¶

func NewRegisterUserParams() *RegisterUserParams

type ReplyCommentsParams ¶

type ReplyCommentsParams struct {
	TheList []*apitypes.ReplyCommentParams `json:"list" form:"list" url:"list"`
}

type ReplyCommentsPath ¶

type ReplyCommentsPath struct {
	FBoardID   apitypes.FBoardID   `uri:"bid"`
	FArticleID apitypes.FArticleID `uri:"aid"`
}

type ReplyCommentsResult ¶

type ReplyCommentsResult struct {
	Success bool `json:"success"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type SetIDEmailParams ¶

type SetIDEmailParams struct {
	ClientID     string `json:"client_id" form:"client_id"`
	ClientSecret string `json:"client_secret" form:"client_secret"`
	Jwt          string `json:"token" form:"token" url:"token"`
}

type SetIDEmailPath ¶

type SetIDEmailPath struct {
	UserID bbs.UUserID `uri:"user_id"`
}

type SetIDEmailResult ¶

type SetIDEmailResult struct {
	Email string `json:"idemail"`

	TokenUser bbs.UUserID `json:"tokenuser"`
}

type UserBoardPermReadable ¶

type UserBoardPermReadable struct {
	IsSYSOP bool

	IsPolice bool

	IsBM bool

	IsBoardFriend bool
}

func CheckUserBoardPermReadable ¶

func CheckUserBoardPermReadable(user *UserInfo, boardID bbs.BBoardID, c *gin.Context) (userBoardPerm *UserBoardPermReadable, err error)

CheckUserBoardPermReadable

https://github.com/ptt/pttbbs/blob/master/mbbsd/board.c#L185

type UserInfo ¶ added in v0.39.1

type UserInfo struct {
	UserID   bbs.UUserID
	IsOver18 bool
}

Source Files ¶

View all Source files

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