summaryrefslogtreecommitdiff
path: root/internal/filter/visibility
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2024-07-24 13:27:42 +0200
committerLibravatar GitHub <noreply@github.com>2024-07-24 12:27:42 +0100
commitc9b6220fef01dce80a31436660cd06b4e1db030f (patch)
tree5fbade865a920a5ea04fdd63763eca1880d60c5d /internal/filter/visibility
parent[chore] renames the `GTS` caches to `DB` caches (#3127) (diff)
downloadgotosocial-c9b6220fef01dce80a31436660cd06b4e1db030f.tar.xz
[chore] Add interaction filter to complement existing visibility filter (#3111)
* [chore] Add interaction filter to complement existing visibility filter * pass in ptr to visibility and interaction filters to Processor{} to ensure shared * use int constants for for match type, cache db calls in filterctx * function name typo :innocent: --------- Co-authored-by: kim <grufwub@gmail.com>
Diffstat (limited to 'internal/filter/visibility')
-rw-r--r--internal/filter/visibility/boostable.go57
-rw-r--r--internal/filter/visibility/boostable_test.go154
-rw-r--r--internal/filter/visibility/status.go65
-rw-r--r--internal/filter/visibility/status_test.go44
4 files changed, 105 insertions, 215 deletions
diff --git a/internal/filter/visibility/boostable.go b/internal/filter/visibility/boostable.go
deleted file mode 100644
index 7362ad45c..000000000
--- a/internal/filter/visibility/boostable.go
+++ /dev/null
@@ -1,57 +0,0 @@
-// 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"
-
- "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
- "github.com/superseriousbusiness/gotosocial/internal/log"
-)
-
-// StatusBoostable checks if given status is boostable by requester, checking boolean status visibility to requester and ultimately the AP status visibility setting.
-func (f *Filter) StatusBoostable(ctx context.Context, requester *gtsmodel.Account, status *gtsmodel.Status) (bool, error) {
- if status.Visibility == gtsmodel.VisibilityDirect {
- log.Trace(ctx, "direct statuses are not boostable")
- return false, nil
- }
-
- // Check whether status is visible to requesting account.
- visible, err := f.StatusVisible(ctx, requester, status)
- if err != nil {
- return false, err
- }
-
- if !visible {
- log.Trace(ctx, "status not visible to requesting account")
- return false, nil
- }
-
- if requester.ID == status.AccountID {
- // Status author can always boost non-directs.
- return true, nil
- }
-
- if status.Visibility == gtsmodel.VisibilityFollowersOnly ||
- status.Visibility == gtsmodel.VisibilityMutualsOnly {
- log.Trace(ctx, "unauthored %s status not boostable", status.Visibility)
- return false, nil
- }
-
- return true, nil
-}
diff --git a/internal/filter/visibility/boostable_test.go b/internal/filter/visibility/boostable_test.go
deleted file mode 100644
index fd29e7305..000000000
--- a/internal/filter/visibility/boostable_test.go
+++ /dev/null
@@ -1,154 +0,0 @@
-// 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_test
-
-import (
- "context"
- "testing"
-
- "github.com/stretchr/testify/suite"
-)
-
-type StatusBoostableTestSuite struct {
- FilterStandardTestSuite
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnPublicBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_1"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnUnlockedBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_2"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnMutualsOnlyNonInteractiveBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_3"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnMutualsOnlyBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_4"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnFollowersOnlyBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_5"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOwnDirectNotBoostable() {
- testStatus := suite.testStatuses["local_account_2_status_6"]
- testAccount := suite.testAccounts["local_account_2"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.False(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOtherPublicBoostable() {
- testStatus := suite.testStatuses["local_account_2_status_1"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOtherUnlistedBoostable() {
- testStatus := suite.testStatuses["local_account_1_status_2"]
- testAccount := suite.testAccounts["local_account_2"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.True(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOtherFollowersOnlyNotBoostable() {
- testStatus := suite.testStatuses["local_account_2_status_7"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.False(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestOtherDirectNotBoostable() {
- testStatus := suite.testStatuses["local_account_2_status_6"]
- testAccount := suite.testAccounts["local_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.False(boostable)
-}
-
-func (suite *StatusBoostableTestSuite) TestRemoteFollowersOnlyNotVisible() {
- testStatus := suite.testStatuses["local_account_1_status_5"]
- testAccount := suite.testAccounts["remote_account_1"]
- ctx := context.Background()
-
- boostable, err := suite.filter.StatusBoostable(ctx, testAccount, testStatus)
- suite.NoError(err)
-
- suite.False(boostable)
-}
-
-func TestStatusBoostableTestSuite(t *testing.T) {
- suite.Run(t, new(StatusBoostableTestSuite))
-}
diff --git a/internal/filter/visibility/status.go b/internal/filter/visibility/status.go
index 5e2052ae4..be1c6a350 100644
--- a/internal/filter/visibility/status.go
+++ b/internal/filter/visibility/status.go
@@ -25,6 +25,7 @@ import (
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
"github.com/superseriousbusiness/gotosocial/internal/log"
+ "github.com/superseriousbusiness/gotosocial/internal/util"
)
// StatusesVisible calls StatusVisible for each status in the statuses slice, and returns a slice of only statuses which are visible to the requester.
@@ -41,8 +42,15 @@ func (f *Filter) StatusesVisible(ctx context.Context, requester *gtsmodel.Accoun
return filtered, errs.Combine()
}
-// 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) {
+// StatusVisible will check if status is visible to requester,
+// accounting for requester with no auth (i.e is nil), suspensions,
+// disabled local users, pending approvals, account blocks,
+// and status visibility settings.
+func (f *Filter) StatusVisible(
+ ctx context.Context,
+ requester *gtsmodel.Account,
+ status *gtsmodel.Status,
+) (bool, error) {
const vtype = cache.VisibilityTypeStatus
// By default we assume no auth.
@@ -75,8 +83,14 @@ func (f *Filter) StatusVisible(ctx context.Context, requester *gtsmodel.Account,
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) {
+// 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, gtserror.Newf("error populating status %s: %w", status.ID, err)
@@ -90,6 +104,14 @@ func (f *Filter) isStatusVisible(ctx context.Context, requester *gtsmodel.Accoun
return false, nil
}
+ if util.PtrOrValue(status.PendingApproval, false) {
+ // Use a different visibility heuristic
+ // for pending approval statuses.
+ return f.isPendingStatusVisible(ctx,
+ requester, status,
+ )
+ }
+
if status.Visibility == gtsmodel.VisibilityPublic {
// This status will be visible to all.
return true, nil
@@ -176,6 +198,41 @@ func (f *Filter) isStatusVisible(ctx context.Context, requester *gtsmodel.Accoun
}
}
+func (f *Filter) isPendingStatusVisible(
+ _ context.Context,
+ requester *gtsmodel.Account,
+ status *gtsmodel.Status,
+) (bool, error) {
+ if requester == nil {
+ // Any old tom, dick, and harry can't
+ // see pending-approval statuses,
+ // no matter what their visibility.
+ return false, nil
+ }
+
+ if status.AccountID == requester.ID {
+ // This is requester's status,
+ // so they can always see it.
+ return true, nil
+ }
+
+ if status.InReplyToAccountID == requester.ID {
+ // This status replies to requester,
+ // so they can always see it (else
+ // they can't approve it).
+ return true, nil
+ }
+
+ if status.BoostOfAccountID == requester.ID {
+ // This status boosts requester,
+ // so they can always see it.
+ return true, nil
+ }
+
+ // Nobody else can see this.
+ 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.
diff --git a/internal/filter/visibility/status_test.go b/internal/filter/visibility/status_test.go
index ad6bc66df..6f8bb12b4 100644
--- a/internal/filter/visibility/status_test.go
+++ b/internal/filter/visibility/status_test.go
@@ -23,6 +23,7 @@ import (
"github.com/stretchr/testify/suite"
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/util"
)
type StatusVisibleTestSuite struct {
@@ -156,6 +157,49 @@ func (suite *StatusVisibleTestSuite) TestStatusNotVisibleIfNotFollowingCached()
suite.False(visible)
}
+func (suite *StatusVisibleTestSuite) TestVisiblePending() {
+ ctx := context.Background()
+
+ // Copy the test status and mark
+ // the copy as pending approval.
+ //
+ // This is a status from admin
+ // that replies to zork.
+ testStatus := new(gtsmodel.Status)
+ *testStatus = *suite.testStatuses["admin_account_status_3"]
+ testStatus.PendingApproval = util.Ptr(true)
+
+ for _, testCase := range []struct {
+ acct *gtsmodel.Account
+ visible bool
+ }{
+ {
+ acct: suite.testAccounts["admin_account"],
+ visible: true, // Own status, always visible.
+ },
+ {
+ acct: suite.testAccounts["local_account_1"],
+ visible: true, // Reply to zork, always visible.
+ },
+ {
+ acct: suite.testAccounts["local_account_2"],
+ visible: false, // None of their business.
+ },
+ {
+ acct: suite.testAccounts["remote_account_1"],
+ visible: false, // None of their business.
+ },
+ {
+ acct: nil, // Unauthed request.
+ visible: false, // None of their business.
+ },
+ } {
+ visible, err := suite.filter.StatusVisible(ctx, testCase.acct, testStatus)
+ suite.NoError(err)
+ suite.Equal(testCase.visible, visible)
+ }
+}
+
func TestStatusVisibleTestSuite(t *testing.T) {
suite.Run(t, new(StatusVisibleTestSuite))
}