mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-28 06:32:25 -05:00
This pull request implements two new properties on ActivityPub actors: `hidesToPublicFromUnauthedWeb` and `hidesCcPublicFromUnauthedWeb`. As documented, these properties allow actors to signal their preference for whether or not their posts should be hidden from unauthenticated web views (ie., web pages like the GtS frontend, web apps like the Mastodon frontend, web APIs like the Mastodon public timeline API, etc). This allows remote accounts to *opt in* to having their unlisted visibility posts shown in (for example) the replies section of the web view of a GtS thread. In future, we can also use these properties to determine whether we should show boosts of a remote actor's post on a GtS profile, and that sort of thing. In keeping with our stance around privacy by default, GtS assumes `true` for `hidesCcPublicFromUnauthedWeb` if the property is not set on a remote actor, ie., hide unlisted/unlocked posts by default. `hidesToPublicFromUnauthedWeb` is assumed to be `false` if the property is not set on a remote actor, ie., show public posts by default. ~~WIP as I still want to work on the documentation for this a bit.~~ New props are already in the namespace document: https://gotosocial.org/ns Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4315 Reviewed-by: kim <gruf@noreply.codeberg.org> Co-authored-by: tobi <tobi.smethurst@protonmail.com> Co-committed-by: tobi <tobi.smethurst@protonmail.com>
164 lines
4.6 KiB
Go
164 lines
4.6 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 migrations
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"reflect"
|
|
|
|
"code.superseriousbusiness.org/gotosocial/internal/db/bundb/migrations/20250708074906_unauthed_web_updates/common"
|
|
newmodel "code.superseriousbusiness.org/gotosocial/internal/db/bundb/migrations/20250708074906_unauthed_web_updates/new"
|
|
oldmodel "code.superseriousbusiness.org/gotosocial/internal/db/bundb/migrations/20250708074906_unauthed_web_updates/old"
|
|
"code.superseriousbusiness.org/gotosocial/internal/log"
|
|
"github.com/uptrace/bun"
|
|
)
|
|
|
|
func init() {
|
|
up := func(ctx context.Context, db *bun.DB) error {
|
|
return db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
|
|
|
|
var account *newmodel.Account
|
|
accountType := reflect.TypeOf(account)
|
|
|
|
// Add new columns to accounts
|
|
// table if they don't exist already.
|
|
for _, new := range []struct {
|
|
dbCol string
|
|
fieldName string
|
|
}{
|
|
{
|
|
dbCol: "hides_to_public_from_unauthed_web",
|
|
fieldName: "HidesToPublicFromUnauthedWeb",
|
|
},
|
|
{
|
|
dbCol: "hides_cc_public_from_unauthed_web",
|
|
fieldName: "HidesCcPublicFromUnauthedWeb",
|
|
},
|
|
} {
|
|
exists, err := doesColumnExist(
|
|
ctx,
|
|
tx,
|
|
"accounts",
|
|
new.dbCol,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if exists {
|
|
// Column already exists.
|
|
continue
|
|
}
|
|
|
|
// Column doesn't exist yet, add it.
|
|
colDef, err := getBunColumnDef(tx, accountType, new.fieldName)
|
|
if err != nil {
|
|
return fmt.Errorf("error making column def: %w", err)
|
|
}
|
|
|
|
log.Infof(ctx, "adding accounts.%s column...", new.dbCol)
|
|
if _, err := tx.
|
|
NewAddColumn().
|
|
Model(account).
|
|
ColumnExpr(colDef).
|
|
Exec(ctx); err != nil {
|
|
return fmt.Errorf("error adding column: %w", err)
|
|
}
|
|
}
|
|
|
|
// For each account settings we have
|
|
// stored on this instance, set the
|
|
// new account columns to values
|
|
// corresponding to the setting.
|
|
allSettings := []*oldmodel.AccountSettings{}
|
|
if err := tx.
|
|
NewSelect().
|
|
Model(&allSettings).
|
|
Column("account_id", "web_visibility").
|
|
Scan(ctx); err != nil {
|
|
return fmt.Errorf("error selecting settings: %w", err)
|
|
}
|
|
|
|
for _, settings := range allSettings {
|
|
|
|
// Derive web visibility.
|
|
var (
|
|
hidesToPublicFromUnauthedWeb bool
|
|
hidesCcPublicFromUnauthedWeb bool
|
|
)
|
|
|
|
switch settings.WebVisibility {
|
|
|
|
// Show nothing.
|
|
case common.VisibilityNone:
|
|
hidesToPublicFromUnauthedWeb = true
|
|
hidesCcPublicFromUnauthedWeb = true
|
|
|
|
// Show public only (GtS default).
|
|
case common.VisibilityPublic:
|
|
hidesToPublicFromUnauthedWeb = false
|
|
hidesCcPublicFromUnauthedWeb = true
|
|
|
|
// Show public + unlisted (Masto default).
|
|
case common.VisibilityUnlocked:
|
|
hidesToPublicFromUnauthedWeb = false
|
|
hidesCcPublicFromUnauthedWeb = false
|
|
|
|
default:
|
|
log.Warnf(ctx,
|
|
"local account %s had unrecognized settings.WebVisibility %d, skipping...",
|
|
settings.AccountID, settings.WebVisibility,
|
|
)
|
|
continue
|
|
}
|
|
|
|
// Update account.
|
|
if _, err := tx.
|
|
NewUpdate().
|
|
Table("accounts").
|
|
Set("? = ?", bun.Ident("hides_to_public_from_unauthed_web"), hidesToPublicFromUnauthedWeb).
|
|
Set("? = ?", bun.Ident("hides_cc_public_from_unauthed_web"), hidesCcPublicFromUnauthedWeb).
|
|
Where("? = ?", bun.Ident("id"), settings.AccountID).Exec(ctx); err != nil {
|
|
return fmt.Errorf("error updating local account: %w", err)
|
|
}
|
|
}
|
|
|
|
// Drop the old web_visibility column.
|
|
if _, err := tx.
|
|
NewDropColumn().
|
|
Model((*oldmodel.AccountSettings)(nil)).
|
|
Column("web_visibility").
|
|
Exec(ctx); err != nil {
|
|
return fmt.Errorf("error dropping old web_visibility column: %w", err)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
|
|
down := func(ctx context.Context, db *bun.DB) error {
|
|
return db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
|
|
return nil
|
|
})
|
|
}
|
|
|
|
if err := Migrations.Register(up, down); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|