diff options
Diffstat (limited to 'internal/visibility/status.go')
-rw-r--r-- | internal/visibility/status.go | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/internal/visibility/status.go b/internal/visibility/status.go new file mode 100644 index 000000000..dc8261624 --- /dev/null +++ b/internal/visibility/status.go @@ -0,0 +1,217 @@ +// 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 visibility + +import ( + "context" + "fmt" + + "github.com/superseriousbusiness/gotosocial/internal/cache" + "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" + "github.com/superseriousbusiness/gotosocial/internal/log" +) + +// StatusesVisible calls StatusVisible for each status in the statuses slice, and returns a slice of only statuses which are visible to the requester. +func (f *Filter) StatusesVisible(ctx context.Context, requester *gtsmodel.Account, statuses []*gtsmodel.Status) ([]*gtsmodel.Status, error) { + // Preallocate slice of maximum possible length. + filtered := make([]*gtsmodel.Status, 0, len(statuses)) + + for _, status := range statuses { + // Check whether status is visible to requester. + visible, err := f.StatusVisible(ctx, requester, status) + if err != nil { + return nil, err + } + + if visible { + // Add filtered status to ret slice. + filtered = append(filtered, status) + } + } + + return filtered, nil +} + +// StatusVisible will check if given status is visible to requester, accounting for requester with no auth (i.e is nil), suspensions, disabled local users, account blocks and status privacy. +func (f *Filter) StatusVisible(ctx context.Context, requester *gtsmodel.Account, status *gtsmodel.Status) (bool, error) { + // By default we assume no auth. + requesterID := noauth + + if requester != nil { + // Use provided account ID. + requesterID = requester.ID + } + + visibility, err := f.state.Caches.Visibility.Load("Type.RequesterID.ItemID", func() (*cache.CachedVisibility, error) { + // Visibility not yet cached, perform visibility lookup. + visible, err := f.isStatusVisible(ctx, requester, status) + if err != nil { + return nil, err + } + + // Return visibility value. + return &cache.CachedVisibility{ + ItemID: status.ID, + RequesterID: requesterID, + Type: cache.VisibilityTypeStatus, + Value: visible, + }, nil + }, "status", requesterID, status.ID) + if err != nil { + return false, err + } + + return visibility.Value, nil +} + +// isStatusVisible will check if status is visible to requester. It is the "meat" of the logic to Filter{}.StatusVisible() which is called within cache loader callback. +func (f *Filter) isStatusVisible(ctx context.Context, requester *gtsmodel.Account, status *gtsmodel.Status) (bool, error) { + // Ensure that status is fully populated for further processing. + if err := f.state.DB.PopulateStatus(ctx, status); err != nil { + return false, err + } + + // Check whether status accounts are visible to the requester. + visible, err := f.areStatusAccountsVisible(ctx, requester, status) + if err != nil { + return false, fmt.Errorf("isStatusVisible: error checking status %s account visibility: %w", status.ID, err) + } else if !visible { + return false, nil + } + + if status.Visibility == gtsmodel.VisibilityPublic { + // This status will be visible to all. + return true, nil + } + + if requester == nil { + // This request is WITHOUT auth, and status is NOT public. + log.Trace(ctx, "unauthorized request to non-public status") + return false, nil + } + + if status.Visibility == gtsmodel.VisibilityUnlocked { + // This status is visible to all auth'd accounts. + return true, nil + } + + if requester.ID == status.AccountID { + // Author can always see their own status. + return true, nil + } + + if status.MentionsAccount(requester.ID) { + // Status mentions the requesting account. + return true, nil + } + + if status.BoostOf != nil { + if !status.BoostOf.MentionsPopulated() { + // Boosted status needs its mentions populating, fetch these from database. + status.BoostOf.Mentions, err = f.state.DB.GetMentions(ctx, status.BoostOf.MentionIDs) + if err != nil { + return false, fmt.Errorf("isStatusVisible: error populating boosted status %s mentions: %w", status.BoostOfID, err) + } + } + + if status.BoostOf.MentionsAccount(requester.ID) { + // Boosted status mentions the requesting account. + return true, nil + } + } + + switch status.Visibility { + case gtsmodel.VisibilityFollowersOnly: + // Check requester follows status author. + follows, err := f.state.DB.IsFollowing(ctx, + requester.ID, + status.AccountID, + ) + if err != nil { + return false, fmt.Errorf("isStatusVisible: error checking follow %s->%s: %w", requester.ID, status.AccountID, err) + } + + if !follows { + log.Trace(ctx, "follow-only status not visible to requester") + return false, nil + } + + return true, nil + + case gtsmodel.VisibilityMutualsOnly: + // Check mutual following between requester and author. + mutuals, err := f.state.DB.IsMutualFollowing(ctx, + requester.ID, + status.AccountID, + ) + if err != nil { + return false, fmt.Errorf("isStatusVisible: error checking mutual follow %s<->%s: %w", requester.ID, status.AccountID, err) + } + + if !mutuals { + log.Trace(ctx, "mutual-only status not visible to requester") + return false, nil + } + + return true, nil + + case gtsmodel.VisibilityDirect: + log.Trace(ctx, "direct status not visible to requester") + return false, nil + + default: + log.Warnf(ctx, "unexpected status visibility %s for %s", status.Visibility, status.URI) + return false, nil + } +} + +// areStatusAccountsVisible calls Filter{}.AccountVisible() on status author and the status boost-of (if set) author, returning visibility of status (and boost-of) to requester. +func (f *Filter) areStatusAccountsVisible(ctx context.Context, requester *gtsmodel.Account, status *gtsmodel.Status) (bool, error) { + // Check whether status author's account is visible to requester. + visible, err := f.AccountVisible(ctx, requester, status.Account) + if err != nil { + return false, err + } + + if !visible { + log.Trace(ctx, "status author not visible to requester") + return false, nil + } + + if status.BoostOfID != "" { + // This is a boosted status. + + if status.AccountID == status.BoostOfAccountID { + // Some clout-chaser boosted their own status, tch. + return true, nil + } + + // Check whether boosted status author's account is visible to requester. + visible, err := f.AccountVisible(ctx, requester, status.BoostOfAccount) + if err != nil { + return false, err + } + + if !visible { + log.Trace(ctx, "boosted status author not visible to requester") + return false, nil + } + } + + return true, nil +} |