[chore] Deinterface processor and subprocessors (#1501)

* [chore] Deinterface processor and subprocessors * expose subprocessors via function calls * missing license header
2025-06-05 21:59:39 +02:00 · 2023-02-22 16:05:26 +01:00
parent adb596600b
commit b6fbdc66c1
246 changed files with 2545 additions and 4549 deletions
--- a/internal/processing/status/create.go
+++ b/internal/processing/status/create.go
@ -20,20 +20,25 @@ package status

 import (
 	"context"
+	"errors"
 	"fmt"
 	"time"

 	"github.com/superseriousbusiness/gotosocial/internal/ap"
 	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/id"
 	"github.com/superseriousbusiness/gotosocial/internal/messages"
 	"github.com/superseriousbusiness/gotosocial/internal/text"
+	"github.com/superseriousbusiness/gotosocial/internal/typeutils"
 	"github.com/superseriousbusiness/gotosocial/internal/uris"
 )

-func (p *processor) Create(ctx context.Context, account *gtsmodel.Account, application *gtsmodel.Application, form *apimodel.AdvancedStatusCreateForm) (*apimodel.Status, gtserror.WithCode) {
+// Create processes the given form to create a new status, returning the api model representation of that status if it's OK.
+func (p *Processor) Create(ctx context.Context, account *gtsmodel.Account, application *gtsmodel.Application, form *apimodel.AdvancedStatusCreateForm) (*apimodel.Status, gtserror.WithCode) {
 	accountURIs := uris.GenerateURIsForAccount(account.Username)
 	thisStatusID := id.NewULID()
 	local := true
@ -56,23 +61,23 @@ func (p *processor) Create(ctx context.Context, account *gtsmodel.Account, appli
 		Text:                     form.Status,
 	}

-	if errWithCode := p.ProcessReplyToID(ctx, form, account.ID, newStatus); errWithCode != nil {
+	if errWithCode := processReplyToID(ctx, p.db, form, account.ID, newStatus); errWithCode != nil {
 		return nil, errWithCode
 	}

-	if errWithCode := p.ProcessMediaIDs(ctx, form, account.ID, newStatus); errWithCode != nil {
+	if errWithCode := processMediaIDs(ctx, p.db, form, account.ID, newStatus); errWithCode != nil {
 		return nil, errWithCode
 	}

-	if err := p.ProcessVisibility(ctx, form, account.Privacy, newStatus); err != nil {
+	if err := processVisibility(ctx, form, account.Privacy, newStatus); err != nil {
 		return nil, gtserror.NewErrorInternalError(err)
 	}

-	if err := p.ProcessLanguage(ctx, form, account.Language, newStatus); err != nil {
+	if err := processLanguage(ctx, form, account.Language, newStatus); err != nil {
 		return nil, gtserror.NewErrorInternalError(err)
 	}

-	if err := p.ProcessContent(ctx, form, account.ID, newStatus); err != nil {
+	if err := processContent(ctx, p.db, p.formatter, p.parseMention, form, account.ID, newStatus); err != nil {
 		return nil, gtserror.NewErrorInternalError(err)
 	}

@ -97,3 +102,249 @@ func (p *processor) Create(ctx context.Context, account *gtsmodel.Account, appli

 	return apiStatus, nil
 }
+
+func processReplyToID(ctx context.Context, dbService db.DB, form *apimodel.AdvancedStatusCreateForm, thisAccountID string, status *gtsmodel.Status) gtserror.WithCode {
+	if form.InReplyToID == "" {
+		return nil
+	}
+
+	// If this status is a reply to another status, we need to do a bit of work to establish whether or not this status can be posted:
+	//
+	// 1. Does the replied status exist in the database?
+	// 2. Is the replied status marked as replyable?
+	// 3. Does a block exist between either the current account or the account that posted the status it's replying to?
+	//
+	// If this is all OK, then we fetch the repliedStatus and the repliedAccount for later processing.
+	repliedStatus := &gtsmodel.Status{}
+	repliedAccount := &gtsmodel.Account{}
+
+	if err := dbService.GetByID(ctx, form.InReplyToID, repliedStatus); err != nil {
+		if err == db.ErrNoEntries {
+			err := fmt.Errorf("status with id %s not replyable because it doesn't exist", form.InReplyToID)
+			return gtserror.NewErrorBadRequest(err, err.Error())
+		}
+		err := fmt.Errorf("db error fetching status with id %s: %s", form.InReplyToID, err)
+		return gtserror.NewErrorInternalError(err)
+	}
+	if !*repliedStatus.Replyable {
+		err := fmt.Errorf("status with id %s is marked as not replyable", form.InReplyToID)
+		return gtserror.NewErrorForbidden(err, err.Error())
+	}
+
+	if err := dbService.GetByID(ctx, repliedStatus.AccountID, repliedAccount); err != nil {
+		if err == db.ErrNoEntries {
+			err := fmt.Errorf("status with id %s not replyable because account id %s is not known", form.InReplyToID, repliedStatus.AccountID)
+			return gtserror.NewErrorBadRequest(err, err.Error())
+		}
+		err := fmt.Errorf("db error fetching account with id %s: %s", repliedStatus.AccountID, err)
+		return gtserror.NewErrorInternalError(err)
+	}
+
+	if blocked, err := dbService.IsBlocked(ctx, thisAccountID, repliedAccount.ID, true); err != nil {
+		err := fmt.Errorf("db error checking block: %s", err)
+		return gtserror.NewErrorInternalError(err)
+	} else if blocked {
+		err := fmt.Errorf("status with id %s not replyable", form.InReplyToID)
+		return gtserror.NewErrorNotFound(err)
+	}
+
+	status.InReplyToID = repliedStatus.ID
+	status.InReplyToURI = repliedStatus.URI
+	status.InReplyToAccountID = repliedAccount.ID
+
+	return nil
+}
+
+func processMediaIDs(ctx context.Context, dbService db.DB, form *apimodel.AdvancedStatusCreateForm, thisAccountID string, status *gtsmodel.Status) gtserror.WithCode {
+	if form.MediaIDs == nil {
+		return nil
+	}
+
+	attachments := []*gtsmodel.MediaAttachment{}
+	attachmentIDs := []string{}
+	for _, mediaID := range form.MediaIDs {
+		attachment, err := dbService.GetAttachmentByID(ctx, mediaID)
+		if err != nil {
+			if errors.Is(err, db.ErrNoEntries) {
+				err = fmt.Errorf("ProcessMediaIDs: media not found for media id %s", mediaID)
+				return gtserror.NewErrorBadRequest(err, err.Error())
+			}
+			err = fmt.Errorf("ProcessMediaIDs: db error for media id %s", mediaID)
+			return gtserror.NewErrorInternalError(err)
+		}
+
+		if attachment.AccountID != thisAccountID {
+			err = fmt.Errorf("ProcessMediaIDs: media with id %s does not belong to account %s", mediaID, thisAccountID)
+			return gtserror.NewErrorBadRequest(err, err.Error())
+		}
+
+		if attachment.StatusID != "" || attachment.ScheduledStatusID != "" {
+			err = fmt.Errorf("ProcessMediaIDs: media with id %s is already attached to a status", mediaID)
+			return gtserror.NewErrorBadRequest(err, err.Error())
+		}
+
+		minDescriptionChars := config.GetMediaDescriptionMinChars()
+		if descriptionLength := len([]rune(attachment.Description)); descriptionLength < minDescriptionChars {
+			err = fmt.Errorf("ProcessMediaIDs: description too short! media description of at least %d chararacters is required but %d was provided for media with id %s", minDescriptionChars, descriptionLength, mediaID)
+			return gtserror.NewErrorBadRequest(err, err.Error())
+		}
+
+		attachments = append(attachments, attachment)
+		attachmentIDs = append(attachmentIDs, attachment.ID)
+	}
+
+	status.Attachments = attachments
+	status.AttachmentIDs = attachmentIDs
+	return nil
+}
+
+func processVisibility(ctx context.Context, form *apimodel.AdvancedStatusCreateForm, accountDefaultVis gtsmodel.Visibility, status *gtsmodel.Status) error {
+	// by default all flags are set to true
+	federated := true
+	boostable := true
+	replyable := true
+	likeable := true
+
+	// If visibility isn't set on the form, then just take the account default.
+	// If that's also not set, take the default for the whole instance.
+	var vis gtsmodel.Visibility
+	switch {
+	case form.Visibility != "":
+		vis = typeutils.APIVisToVis(form.Visibility)
+	case accountDefaultVis != "":
+		vis = accountDefaultVis
+	default:
+		vis = gtsmodel.VisibilityDefault
+	}
+
+	switch vis {
+	case gtsmodel.VisibilityPublic:
+		// for public, there's no need to change any of the advanced flags from true regardless of what the user filled out
+		break
+	case gtsmodel.VisibilityUnlocked:
+		// for unlocked the user can set any combination of flags they like so look at them all to see if they're set and then apply them
+		if form.Federated != nil {
+			federated = *form.Federated
+		}
+
+		if form.Boostable != nil {
+			boostable = *form.Boostable
+		}
+
+		if form.Replyable != nil {
+			replyable = *form.Replyable
+		}
+
+		if form.Likeable != nil {
+			likeable = *form.Likeable
+		}
+
+	case gtsmodel.VisibilityFollowersOnly, gtsmodel.VisibilityMutualsOnly:
+		// for followers or mutuals only, boostable will *always* be false, but the other fields can be set so check and apply them
+		boostable = false
+
+		if form.Federated != nil {
+			federated = *form.Federated
+		}
+
+		if form.Replyable != nil {
+			replyable = *form.Replyable
+		}
+
+		if form.Likeable != nil {
+			likeable = *form.Likeable
+		}
+
+	case gtsmodel.VisibilityDirect:
+		// direct is pretty easy: there's only one possible setting so return it
+		federated = true
+		boostable = false
+		replyable = true
+		likeable = true
+	}
+
+	status.Visibility = vis
+	status.Federated = &federated
+	status.Boostable = &boostable
+	status.Replyable = &replyable
+	status.Likeable = &likeable
+	return nil
+}
+
+func processLanguage(ctx context.Context, form *apimodel.AdvancedStatusCreateForm, accountDefaultLanguage string, status *gtsmodel.Status) error {
+	if form.Language != "" {
+		status.Language = form.Language
+	} else {
+		status.Language = accountDefaultLanguage
+	}
+	if status.Language == "" {
+		return errors.New("no language given either in status create form or account default")
+	}
+	return nil
+}
+
+func processContent(ctx context.Context, dbService db.DB, formatter text.Formatter, parseMention gtsmodel.ParseMentionFunc, form *apimodel.AdvancedStatusCreateForm, accountID string, status *gtsmodel.Status) error {
+	// if there's nothing in the status at all we can just return early
+	if form.Status == "" {
+		status.Content = ""
+		return nil
+	}
+
+	// if format wasn't specified we should try to figure out what format this user prefers
+	if form.Format == "" {
+		acct, err := dbService.GetAccountByID(ctx, accountID)
+		if err != nil {
+			return fmt.Errorf("error processing new content: couldn't retrieve account from db to check post format: %s", err)
+		}
+
+		switch acct.StatusFormat {
+		case "plain":
+			form.Format = apimodel.StatusFormatPlain
+		case "markdown":
+			form.Format = apimodel.StatusFormatMarkdown
+		default:
+			form.Format = apimodel.StatusFormatDefault
+		}
+	}
+
+	// parse content out of the status depending on what format has been submitted
+	var f text.FormatFunc
+	switch form.Format {
+	case apimodel.StatusFormatPlain:
+		f = formatter.FromPlain
+	case apimodel.StatusFormatMarkdown:
+		f = formatter.FromMarkdown
+	default:
+		return fmt.Errorf("format %s not recognised as a valid status format", form.Format)
+	}
+	formatted := f(ctx, parseMention, accountID, status.ID, form.Status)
+
+	// add full populated gts {mentions, tags, emojis} to the status for passing them around conveniently
+	// add just their ids to the status for putting in the db
+	status.Mentions = formatted.Mentions
+	status.MentionIDs = make([]string, 0, len(formatted.Mentions))
+	for _, gtsmention := range formatted.Mentions {
+		status.MentionIDs = append(status.MentionIDs, gtsmention.ID)
+	}
+
+	status.Tags = formatted.Tags
+	status.TagIDs = make([]string, 0, len(formatted.Tags))
+	for _, gtstag := range formatted.Tags {
+		status.TagIDs = append(status.TagIDs, gtstag.ID)
+	}
+
+	status.Emojis = formatted.Emojis
+	status.EmojiIDs = make([]string, 0, len(formatted.Emojis))
+	for _, gtsemoji := range formatted.Emojis {
+		status.EmojiIDs = append(status.EmojiIDs, gtsemoji.ID)
+	}
+
+	spoilerformatted := formatter.FromPlainEmojiOnly(ctx, parseMention, accountID, status.ID, form.SpoilerText)
+	for _, gtsemoji := range spoilerformatted.Emojis {
+		status.Emojis = append(status.Emojis, gtsemoji)
+		status.EmojiIDs = append(status.EmojiIDs, gtsemoji.ID)
+	}
+
+	status.Content = formatted.HTML
+	return nil
+}