text

Documentation

Index

• func Emojify(emojis []apimodel.Emoji, inputText string) string
• func SanitizeHTML(in string) string
• func SanitizePlaintext(in string) string
• type FormatFunc
• type FormatResult
• type Formatter
  • func NewFormatter(db db.DB) Formatter

Functions

func Emojify

func Emojify(emojis []apimodel.Emoji, inputText string) string

Emojify replaces shortcodes in `inputText` with the emoji in `emojis`.

Callers should ensure that inputText and resulting text are escaped appropriately depending on what they're used for.

func SanitizeHTML

func SanitizeHTML(in string) string

SanitizeHTML sanitizes risky html elements from the given string, allowing only safe ones through.

func SanitizePlaintext

func SanitizePlaintext(in string) string

SanitizePlaintext runs text through basic sanitization. This removes any html elements that were in the string, and returns clean plaintext.

Types

type FormatFunc

type FormatFunc func(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, text string) *FormatResult

type FormatResult

type FormatResult struct {
	HTML     string
	Mentions []*gtsmodel.Mention
	Tags     []*gtsmodel.Tag
	Emojis   []*gtsmodel.Emoji
}

type Formatter

type Formatter interface {
	// FromPlain parses an HTML text from a plaintext.
	FromPlain(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, plain string) *FormatResult
	// FromPlainNoParagraph parses an HTML text from a plaintext, without wrapping the resulting text in <p> tags.
	FromPlainNoParagraph(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, plain string) *FormatResult
	// FromMarkdown parses an HTML text from a markdown-formatted text.
	FromMarkdown(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, md string) *FormatResult
	// FromPlainEmojiOnly parses an HTML text from a plaintext, only parsing emojis and not mentions etc.
	FromPlainEmojiOnly(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, plain string) *FormatResult
}

Formatter wraps some logic and functions for parsing statuses and other text input into nice html. Each of the member functions returns a struct containing the formatted HTML and any tags, mentions, and emoji that were found in the text.

func NewFormatter

func NewFormatter(db db.DB) Formatter

NewFormatter returns a new Formatter interface for parsing statuses and other text input into nice html.