mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-30 23:22:26 -05:00
5e2bf0bdca* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
57 lines
2.3 KiB
Go
57 lines
2.3 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package text
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
// 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.
|
|
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
|
|
// 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
|
|
}
|
|
|
|
type FormatFunc func(ctx context.Context, pmf gtsmodel.ParseMentionFunc, authorID string, statusID string, text string) *FormatResult
|
|
|
|
type formatter struct {
|
|
db db.DB
|
|
}
|
|
|
|
// NewFormatter returns a new Formatter interface for parsing statuses and other text input into nice html.
|
|
func NewFormatter(db db.DB) Formatter {
|
|
return &formatter{
|
|
db: db,
|
|
}
|
|
}
|
|
|
|
type FormatResult struct {
|
|
HTML string
|
|
Mentions []*gtsmodel.Mention
|
|
Tags []*gtsmodel.Tag
|
|
Emojis []*gtsmodel.Emoji
|
|
}
|