2023-03-12 16:00:57 +01:00
|
|
|
// 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/>.
|
2023-02-25 13:16:30 +01:00
|
|
|
|
|
|
|
package status
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
|
|
)
|
|
|
|
|
|
|
|
const allowedPinnedCount = 10
|
|
|
|
|
|
|
|
// getPinnableStatus fetches targetStatusID status and ensures that requestingAccountID
|
|
|
|
// can pin or unpin it.
|
|
|
|
//
|
|
|
|
// It checks:
|
2023-03-03 13:35:49 +01:00
|
|
|
// - Status is visible to requesting account.
|
2023-02-25 13:16:30 +01:00
|
|
|
// - Status belongs to requesting account.
|
|
|
|
// - Status is public, unlisted, or followers-only.
|
|
|
|
// - Status is not a boost.
|
2023-03-20 19:10:08 +01:00
|
|
|
func (p *Processor) getPinnableStatus(ctx context.Context, requestingAccount *gtsmodel.Account, targetStatusID string) (*gtsmodel.Status, gtserror.WithCode) {
|
2023-10-25 16:04:53 +02:00
|
|
|
targetStatus, errWithCode := p.c.GetVisibleTargetStatus(ctx, requestingAccount, targetStatusID)
|
2023-03-20 19:10:08 +01:00
|
|
|
if errWithCode != nil {
|
|
|
|
return nil, errWithCode
|
2023-03-03 13:35:49 +01:00
|
|
|
}
|
|
|
|
|
2023-03-20 19:10:08 +01:00
|
|
|
if targetStatus.AccountID != requestingAccount.ID {
|
|
|
|
err := fmt.Errorf("status %s does not belong to account %s", targetStatusID, requestingAccount.ID)
|
2023-02-25 13:16:30 +01:00
|
|
|
return nil, gtserror.NewErrorUnprocessableEntity(err, err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
if targetStatus.Visibility == gtsmodel.VisibilityDirect {
|
2023-03-20 19:10:08 +01:00
|
|
|
err := errors.New("cannot pin direct messages")
|
2023-02-25 13:16:30 +01:00
|
|
|
return nil, gtserror.NewErrorUnprocessableEntity(err, err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
if targetStatus.BoostOfID != "" {
|
2023-03-20 19:10:08 +01:00
|
|
|
err := errors.New("cannot pin boosts")
|
2023-02-25 13:16:30 +01:00
|
|
|
return nil, gtserror.NewErrorUnprocessableEntity(err, err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
return targetStatus, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// PinCreate pins the target status to the top of requestingAccount's profile, if possible.
|
|
|
|
//
|
|
|
|
// Conditions for a pin to work:
|
|
|
|
// - Status belongs to requesting account.
|
|
|
|
// - Status is public, unlisted, or followers-only.
|
|
|
|
// - Status is not a boost.
|
|
|
|
// - Status is not already pinnd.
|
|
|
|
// - Limit of pinned statuses not yet met or exceeded.
|
|
|
|
//
|
|
|
|
// If the conditions can't be met, then code 422 Unprocessable Entity will be returned.
|
|
|
|
func (p *Processor) PinCreate(ctx context.Context, requestingAccount *gtsmodel.Account, targetStatusID string) (*apimodel.Status, gtserror.WithCode) {
|
2023-03-20 19:10:08 +01:00
|
|
|
targetStatus, errWithCode := p.getPinnableStatus(ctx, requestingAccount, targetStatusID)
|
2023-02-25 13:16:30 +01:00
|
|
|
if errWithCode != nil {
|
|
|
|
return nil, errWithCode
|
|
|
|
}
|
|
|
|
|
|
|
|
if !targetStatus.PinnedAt.IsZero() {
|
|
|
|
err := errors.New("status already pinned")
|
|
|
|
return nil, gtserror.NewErrorUnprocessableEntity(err, err.Error())
|
|
|
|
}
|
|
|
|
|
2023-03-01 19:26:53 +01:00
|
|
|
pinnedCount, err := p.state.DB.CountAccountPinned(ctx, requestingAccount.ID)
|
2023-02-25 13:16:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return nil, gtserror.NewErrorInternalError(fmt.Errorf("error checking number of pinned statuses: %w", err))
|
|
|
|
}
|
|
|
|
|
|
|
|
if pinnedCount >= allowedPinnedCount {
|
|
|
|
err = fmt.Errorf("status pin limit exceeded, you've already pinned %d status(es) out of %d", pinnedCount, allowedPinnedCount)
|
|
|
|
return nil, gtserror.NewErrorUnprocessableEntity(err, err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
targetStatus.PinnedAt = time.Now()
|
2023-03-01 19:26:53 +01:00
|
|
|
if err := p.state.DB.UpdateStatus(ctx, targetStatus, "pinned_at"); err != nil {
|
2023-06-11 11:18:44 +02:00
|
|
|
err = gtserror.Newf("db error pinning status: %w", err)
|
|
|
|
return nil, gtserror.NewErrorInternalError(err)
|
|
|
|
}
|
|
|
|
|
2023-10-25 16:04:53 +02:00
|
|
|
if err := p.c.InvalidateTimelinedStatus(ctx, requestingAccount.ID, targetStatusID); err != nil {
|
2023-06-11 11:18:44 +02:00
|
|
|
err = gtserror.Newf("error invalidating status from timelines: %w", err)
|
|
|
|
return nil, gtserror.NewErrorInternalError(err)
|
2023-02-25 13:16:30 +01:00
|
|
|
}
|
|
|
|
|
2023-10-25 16:04:53 +02:00
|
|
|
return p.c.GetAPIStatus(ctx, requestingAccount, targetStatus)
|
2023-02-25 13:16:30 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// PinRemove unpins the target status from the top of requestingAccount's profile, if possible.
|
|
|
|
//
|
|
|
|
// Conditions for an unpin to work:
|
|
|
|
// - Status belongs to requesting account.
|
|
|
|
// - Status is public, unlisted, or followers-only.
|
|
|
|
// - Status is not a boost.
|
|
|
|
//
|
|
|
|
// If the conditions can't be met, then code 422 Unprocessable Entity will be returned.
|
|
|
|
//
|
|
|
|
// Unlike with PinCreate, statuses that are already unpinned will not return 422, but just do
|
|
|
|
// nothing and return the api model representation of the status, to conform to the masto API.
|
|
|
|
func (p *Processor) PinRemove(ctx context.Context, requestingAccount *gtsmodel.Account, targetStatusID string) (*apimodel.Status, gtserror.WithCode) {
|
2023-03-20 19:10:08 +01:00
|
|
|
targetStatus, errWithCode := p.getPinnableStatus(ctx, requestingAccount, targetStatusID)
|
2023-02-25 13:16:30 +01:00
|
|
|
if errWithCode != nil {
|
|
|
|
return nil, errWithCode
|
|
|
|
}
|
|
|
|
|
2023-06-11 11:18:44 +02:00
|
|
|
if targetStatus.PinnedAt.IsZero() {
|
2023-10-25 16:04:53 +02:00
|
|
|
return p.c.GetAPIStatus(ctx, requestingAccount, targetStatus)
|
2023-06-11 11:18:44 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
targetStatus.PinnedAt = time.Time{}
|
|
|
|
if err := p.state.DB.UpdateStatus(ctx, targetStatus, "pinned_at"); err != nil {
|
|
|
|
err = gtserror.Newf("db error unpinning status: %w", err)
|
|
|
|
return nil, gtserror.NewErrorInternalError(err)
|
|
|
|
}
|
|
|
|
|
2023-10-25 16:04:53 +02:00
|
|
|
if err := p.c.InvalidateTimelinedStatus(ctx, requestingAccount.ID, targetStatusID); err != nil {
|
2023-06-11 11:18:44 +02:00
|
|
|
err = gtserror.Newf("error invalidating status from timelines: %w", err)
|
|
|
|
return nil, gtserror.NewErrorInternalError(err)
|
2023-02-25 13:16:30 +01:00
|
|
|
}
|
|
|
|
|
2023-10-25 16:04:53 +02:00
|
|
|
return p.c.GetAPIStatus(ctx, requestingAccount, targetStatus)
|
2023-02-25 13:16:30 +01:00
|
|
|
}
|