common

type Backlinks ¶

type Backlinks map[uint64]map[uint64]uint64

Map of all backlinks on a page.

type Board ¶

type Board []Thread

Board is defined to enable marshalling optimizations and sorting by sticky threads.

func (b Board) Len() int

func (b Board) Less(i, j int) bool

func (b Board) Swap(i, j int)

type Client ¶

type Client interface {
	Send([]byte)
	Redirect(board string)
	IP() string
	Close(error)
}

Client exposes some globally accessible websocket client functionality without causing circular imports

type Command ¶

type Command struct {
	Type CommandType
	Roll int
	Flip bool
}

func (c Command) MarshalEasyJSON(w *jwriter.Writer)

func (c Command) MarshalJSON() ([]byte, error)

func (c *Command) UnmarshalJSON(data []byte) error

type CommandType ¶

type CommandType uint8

const (
	// Roll number between X and Y.
	Roll CommandType = iota
	// Flip coin with X% probability.
	Flip
)

type Commands ¶

type Commands []Command

Post commands.

type ErrInvalidPostID ¶

type ErrInvalidPostID uint64

ErrInvalidPostID signifies that the post ID passed by the client is invalid in some way. In what way exactly should be evident from the API endpoint.

func (e ErrInvalidPostID) Error() string

type ErrTooLong ¶

type ErrTooLong string

ErrTooLong is passed, when a field exceeds the maximum string length for that specific field

func (e ErrTooLong) Error() string

type Files ¶

type Files []*Image

Post files.

type Image ¶

type Image struct {
	ImageCommon
}

Image contains a post's image and thumbnail data.

type ImageCommon ¶

type ImageCommon struct {
	SHA1      string
	Size      int       `json:"size"`
	Video     bool      `json:"video,omitempty"`
	Audio     bool      `json:"audio,omitempty"`
	APNG      bool      `json:"apng,omitempty"`
	FileType  uint8     `json:"fileType"`
	ThumbType uint8     `json:"thumbType"`
	Length    uint32    `json:"length,omitempty"`
	Title     string    `json:"title,omitempty"`
	Dims      [4]uint16 `json:"dims"`
	MD5       string    `json:"-"`
	Artist    string    `json:"-"`
}

ImageCommon contains the common data shared between multiple post referencing the same image.

type Links ¶

type Links [][2]uint64

Post links.

type MessageType ¶

type MessageType uint8

MessageType is the identifier code for websocket message types

const (
	MessageInvalid MessageType = iota

	MessageInsertPost
	MessageAppend
	MessageBackspace
	MessageSplice
	MessageClosePost

	MessageInsertImage
	MessageSpoiler
	MessageDeletePost
	MessageBanned
	MessageDeleteImage
)

const (
	MessageSynchronise MessageType = 30 + iota
	MessageReclaim

	// Send new post ID to client
	MessagePostID

	// Concatenation of multiple websocket messages to reduce transport overhead
	MessageConcat

	// Message from the client meant to invoke no operation. Mostly used as a
	// one way ping, because the JS Websocket API does not provide access to
	// pinging.
	MessageNOOP

	// Transmit current synced IP count to client
	MessageSyncCount

	// Send current server Unix time to client
	MessageServerTime

	// Redirect the client to a specific board
	MessageRedirect

	// Send a notification to a client
	MessageNotification

	// Notify the client, he needs a captcha solved
	MessageCaptcha
)

type NewsEntry ¶

type NewsEntry struct {
	Subject   string
	Body      string
	ImageName string
	Time      time.Time
}

Single news entry. TODO(Kagami): Need to use in both templates/ and db/ and can't keep in db/ because of cyclic imports. Move to some better place.

type Post ¶

type Post struct {
	ID       uint64   `json:"id"`
	Time     int64    `json:"time"`
	Auth     string   `json:"auth,omitempty"`
	UserID   string   `json:"userID,omitempty"`
	UserName string   `json:"userName,omitempty"`
	Body     string   `json:"body"`
	Links    Links    `json:"links,omitempty"`
	Commands Commands `json:"commands,omitempty"`
	Files    Files    `json:"files,omitempty"`
}

Post is a generic post exposed publically through the JSON API.

type Posts ¶

type Posts []*Post

Posts.

type StandalonePost ¶

type StandalonePost struct {
	Post
	OP    uint64 `json:"op"`
	Board string `json:"board"`
}

StandalonePost is a post view that includes the "op" and "board" fields, which are not exposed though Post, but are required for retrieving a post with unknown parenthood.

type Thread ¶

type Thread struct {
	Abbrev    bool   `json:"abbrev,omitempty"`
	Sticky    bool   `json:"sticky,omitempty"`
	PostCtr   uint32 `json:"postCtr"`
	ImageCtr  uint32 `json:"imageCtr"`
	ReplyTime int64  `json:"replyTime"`
	BumpTime  int64  `json:"bumpTime"`
	Subject   string `json:"subject"`
	Board     string `json:"board"`
	*Post
	Posts Posts `json:"posts"`
}

Thread is a transport/export wrapper that stores both the thread metadata, its opening post data and its contained posts. The composite type itself is not stored in the database.