util

Documentation

Index

• Constants
• func CommunityAPI() gin.HandlerFunc
• func CurrentMillisecond() uint64
• func GetPage(c *gin.Context) int
• func GetRemoteAddr(c *gin.Context) string
• func HacPaiUserInfo(accessToken string) (ret map[string]interface{})
• func ImageSize(imageURL string, width, height int) string
• func IsBot(uaStr string) bool
• func IsDomain(s string) bool
• func IsIP(s string) bool
• func IsReservedPath(path string) bool
• func RandImage() string
• func RandImages(n int) []string
• func Uploaded(url string) bool
• type MarkdownResult
  • func Markdown(mdText string) *MarkdownResult
• type Pagination
  • func NewPagination(currentPageNum, pageSize, windowSize, recordCount int) *Pagination
• type SessionData
  • func GetSession(c *gin.Context) *SessionData
  • func (sd *SessionData) AvatarURLWithSize(size int) string
  • func (sd *SessionData) Save(c *gin.Context) error

Constants

const (
	PathRoot           = "/"
	PathInit           = "/start"
	PathSearch         = "/search"
	PathOpensearch     = "/opensearch.xml"
	PathBlogs          = "/blogs"
	PathConsoleDist    = "/console/dist"
	PathAdmin          = "/admin"
	PathAPI            = "/api"
	PathFavicon        = "/favicon.ico"
	PathTheme          = "/theme"
	PathActivities     = "/activities"
	PathArchives       = "/archives"
	PathArticles       = "/articles"
	PathAuthors        = "/authors"
	PathCategories     = "/categories"
	PathTags           = "/tags"
	PathComments       = "/comments"
	PathAtom           = "/atom"
	PathRSS            = "/rss"
	PathSitemap        = "/sitemap.xml"
	PathChangelogs     = "/changelogs"
	PathRobots         = "/robots.txt"
	PathAPIsSymArticle = "/apis/symphony/article"
	PathPlatInfo       = "/blog/info"
	PathManifest       = "/manifest.json"
)

Path prefixes.

const (
	CodeOk      = 0  // OK
	CodeErr     = -1 // general error
	CodeAuthErr = 2  // unauthenticated request
)

Result codes.

const (
	// Version of Pipe.
	Version = "2.1.0"

	// UserAgent represents HTTP client user agent.
	UserAgent = "Pipe/" + Version + "; +https://github.com/leimeng-go/pipe"
)

const CommunityFileURL = "https://b3logfile.com"

CommunityFileURL is the community file service URL.

const CommunityURL = "https://ld246.com"

CommunityURL is the URL of LianDi community.

Functions

func CommunityAPI

func CommunityAPI() gin.HandlerFunc

CommunityAPI is a reverse proxy for https://ld246.com.

func CurrentMillisecond

func CurrentMillisecond() uint64

CurrentMillisecond returns the current time in millisecond.

func GetPage

func GetPage(c *gin.Context) int

GetPage returns paging parameter.

func GetRemoteAddr

func GetRemoteAddr(c *gin.Context) string

GetRemoteAddr returns remote address of the context.

func HacPaiUserInfo

func HacPaiUserInfo(accessToken string) (ret map[string]interface{})

HacPaiUserInfo returns HacPai community user info specified by the given access token.

func ImageSize

func ImageSize(imageURL string, width, height int) string

ImageSize returns image URL of Qiniu image processing style with the specified width and height.

func IsBot

func IsBot(uaStr string) bool

IsBot checks the specified user-agent is a bot.

func IsDomain

func IsDomain(s string) bool

IsDomain checks the specified string is domain name.

func IsIP

func IsIP(s string) bool

IsIP checks the specified string is IP.

func IsReservedPath

func IsReservedPath(path string) bool

IsReservedPath checks the specified path is a reserved path or not.

func RandImage

func RandImage() string

RandImage returns an image URL randomly for article thumbnail. https://github.com/88250/bing

func RandImages

func RandImages(n int) []string

RandImages returns random image URLs.

func Uploaded

func Uploaded(url string) bool

Uploaded checks whether the specified URL has uploaded.

Types

type MarkdownResult

type MarkdownResult struct {
	ContentHTML  string
	AbstractText string
	ThumbURL     string
}

MarkdownResult represents markdown result.

func Markdown

func Markdown(mdText string) *MarkdownResult

Markdown process the specified markdown text to HTML.

type Pagination

type Pagination struct {
	CurrentPageNum  int    `json:"currentPageNum"`
	PageSize        int    `json:"pageSize"`
	PageCount       int    `json:"pageCount"`
	WindowSize      int    `json:"windowSize"`
	RecordCount     int    `json:"recordCount"`
	PageNums        []int  `json:"pageNums"`
	NextPageNum     int    `json:"nextPageNum"`
	PreviousPageNum int    `json:"previousPageNum"`
	FirstPageNum    int    `json:"firstPageNum"`
	LastPageNum     int    `json:"lastPageNum"`
	PageURL         string `json:"pageURL"`
}

Pagination represents pagination info.

func NewPagination

func NewPagination(currentPageNum, pageSize, windowSize, recordCount int) *Pagination

NewPagination creates a new pagination with the specified current page num, page size, window size and record count.

type SessionData

type SessionData struct {
	UID     uint64 // user ID
	UName   string // username
	UB3Key  string // user B3 key
	URole   int    // user role
	UAvatar string // user avatar URL
	BID     uint64 // blog ID
	BURL    string // blog url
}

SessionData represents the session.

func GetSession

func GetSession(c *gin.Context) *SessionData

GetSession returns session of the specified context.

func (*SessionData) AvatarURLWithSize

func (sd *SessionData) AvatarURLWithSize(size int) string

AvatarURLWithSize returns avatar URL with the specified size.

func (*SessionData) Save

func (sd *SessionData) Save(c *gin.Context) error

Save saves the current session of the specified context.