text

Documentation

Index

• func Emojify(emojis []apimodel.Emoji, inputText string) string
• func MinifyHTML(in string) string
• func NormalizeHashtag(text string) (string, bool)
• func SanitizeToHTML(in string) string
• func SanitizeToPlaintext(in string) string
• type FormatFunc
• type FormatResult
• type Formatter
  • func NewFormatter(db db.DB) *Formatter
  • func (f *Formatter) FromMarkdown(ctx context.Context, parseMention gtsmodel.ParseMentionFunc, authorID string, ...) *FormatResult
  • func (f *Formatter) FromPlain(ctx context.Context, parseMention gtsmodel.ParseMentionFunc, authorID string, ...) *FormatResult
  • func (f *Formatter) FromPlainEmojiOnly(ctx context.Context, parseMention gtsmodel.ParseMentionFunc, authorID string, ...) *FormatResult
  • func (f *Formatter) FromPlainNoParagraph(ctx context.Context, parseMention gtsmodel.ParseMentionFunc, authorID string, ...) *FormatResult

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 MinifyHTML

func MinifyHTML(in string) string

MinifyHTML minifies the given string under the assumption that it's HTML.

If input is not HTML encoded, this function will try to do minimization anyway, but this may produce unexpected results.

If an error occurs during minimization, it will be logged and the original string returned unmodified.

func NormalizeHashtag

func NormalizeHashtag(text string) (string, bool)

NormalizeHashtag normalizes the given hashtag text by removing the initial '#' symbol, and then decomposing and canonically recomposing chars + combining diacritics in the text to single unicode characters, following Normalization Form C (https://unicode.org/reports/tr15/).

Finally, it will do a check on the normalized string to ensure that it's below maximumHashtagLength chars, and contains only letters, numbers, and underscores (and not *JUST* underscores).

If all this passes, returned bool will be true.

func SanitizeToHTML

func SanitizeToHTML(in string) string

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

func SanitizeToPlaintext

func SanitizeToPlaintext(in string) string

SanitizeToPlaintext 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,
	parseMention gtsmodel.ParseMentionFunc,
	authorID string,
	statusID string,
	text string,
) *FormatResult

FormatFunc is fulfilled by FromPlain, FromPlainNoParagraph, and FromMarkdown.

type FormatResult

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

type Formatter

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

Formatter wraps logic and functions for parsing statuses and other text input into nice html.

func NewFormatter

func NewFormatter(db db.DB) *Formatter

NewFormatter returns a new Formatter.

func (*Formatter) FromMarkdown

func (f *Formatter) FromMarkdown(
	ctx context.Context,
	parseMention gtsmodel.ParseMentionFunc,
	authorID string,
	statusID string,
	input string,
) *FormatResult

FromMarkdown fulfils FormatFunc by parsing the given markdown input into a FormatResult.

func (*Formatter) FromPlain

func (f *Formatter) FromPlain(
	ctx context.Context,
	parseMention gtsmodel.ParseMentionFunc,
	authorID string,
	statusID string,
	input string,
) *FormatResult

FromPlain fulfils FormatFunc by parsing the given plaintext input into a FormatResult.

func (*Formatter) FromPlainEmojiOnly

func (f *Formatter) FromPlainEmojiOnly(
	ctx context.Context,
	parseMention gtsmodel.ParseMentionFunc,
	authorID string,
	statusID string,
	input string,
) *FormatResult

FromPlainEmojiOnly fulfils FormatFunc by parsing the given plaintext input into a FormatResult.

Unlike FromPlain, it will only parse emojis with the custom renderer, leaving aside mentions and tags.

func (*Formatter) FromPlainNoParagraph

func (f *Formatter) FromPlainNoParagraph(
	ctx context.Context,
	parseMention gtsmodel.ParseMentionFunc,
	authorID string,
	statusID string,
	input string,
) *FormatResult

FromPlainNoParagraph fulfils FormatFunc by parsing the given plaintext input into a FormatResult.

Unlike FromPlain, it will not wrap the resulting HTML in <p> tags, making it useful for parsing short fragments of text that oughtn't be formally wrapped as a paragraph.