mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-23 02:32:12 +00:00
5e2bf0bdca
* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
88 lines
4.5 KiB
Go
88 lines
4.5 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 db
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
// Status contains functions for getting statuses, creating statuses, and checking various other fields on statuses.
|
|
type Status interface {
|
|
// GetStatusByID returns one status from the database, with no rel fields populated, only their linking ID / URIs
|
|
GetStatusByID(ctx context.Context, id string) (*gtsmodel.Status, Error)
|
|
|
|
// GetStatuses gets a slice of statuses corresponding to the given status IDs.
|
|
GetStatuses(ctx context.Context, ids []string) ([]*gtsmodel.Status, Error)
|
|
|
|
// GetStatusByURI returns one status from the database, with no rel fields populated, only their linking ID / URIs
|
|
GetStatusByURI(ctx context.Context, uri string) (*gtsmodel.Status, Error)
|
|
|
|
// GetStatusByURL returns one status from the database, with no rel fields populated, only their linking ID / URIs
|
|
GetStatusByURL(ctx context.Context, uri string) (*gtsmodel.Status, Error)
|
|
|
|
// PutStatus stores one status in the database.
|
|
PutStatus(ctx context.Context, status *gtsmodel.Status) Error
|
|
|
|
// UpdateStatus updates one status in the database.
|
|
UpdateStatus(ctx context.Context, status *gtsmodel.Status, columns ...string) Error
|
|
|
|
// DeleteStatusByID deletes one status from the database.
|
|
DeleteStatusByID(ctx context.Context, id string) Error
|
|
|
|
// CountStatusReplies returns the amount of replies recorded for a status, or an error if something goes wrong
|
|
CountStatusReplies(ctx context.Context, status *gtsmodel.Status) (int, Error)
|
|
|
|
// CountStatusReblogs returns the amount of reblogs/boosts recorded for a status, or an error if something goes wrong
|
|
CountStatusReblogs(ctx context.Context, status *gtsmodel.Status) (int, Error)
|
|
|
|
// CountStatusFaves returns the amount of faves/likes recorded for a status, or an error if something goes wrong
|
|
CountStatusFaves(ctx context.Context, status *gtsmodel.Status) (int, Error)
|
|
|
|
// GetStatusParents gets the parent statuses of a given status.
|
|
//
|
|
// If onlyDirect is true, only the immediate parent will be returned.
|
|
GetStatusParents(ctx context.Context, status *gtsmodel.Status, onlyDirect bool) ([]*gtsmodel.Status, Error)
|
|
|
|
// GetStatusChildren gets the child statuses of a given status.
|
|
//
|
|
// If onlyDirect is true, only the immediate children will be returned.
|
|
GetStatusChildren(ctx context.Context, status *gtsmodel.Status, onlyDirect bool, minID string) ([]*gtsmodel.Status, Error)
|
|
|
|
// IsStatusFavedBy checks if a given status has been faved by a given account ID
|
|
IsStatusFavedBy(ctx context.Context, status *gtsmodel.Status, accountID string) (bool, Error)
|
|
|
|
// IsStatusRebloggedBy checks if a given status has been reblogged/boosted by a given account ID
|
|
IsStatusRebloggedBy(ctx context.Context, status *gtsmodel.Status, accountID string) (bool, Error)
|
|
|
|
// IsStatusMutedBy checks if a given status has been muted by a given account ID
|
|
IsStatusMutedBy(ctx context.Context, status *gtsmodel.Status, accountID string) (bool, Error)
|
|
|
|
// IsStatusBookmarkedBy checks if a given status has been bookmarked by a given account ID
|
|
IsStatusBookmarkedBy(ctx context.Context, status *gtsmodel.Status, accountID string) (bool, Error)
|
|
|
|
// GetStatusFaves returns a slice of faves/likes of the given status.
|
|
// This slice will be unfiltered, not taking account of blocks and whatnot, so filter it before serving it back to a user.
|
|
GetStatusFaves(ctx context.Context, status *gtsmodel.Status) ([]*gtsmodel.StatusFave, Error)
|
|
|
|
// GetStatusReblogs returns a slice of statuses that are a boost/reblog of the given status.
|
|
// This slice will be unfiltered, not taking account of blocks and whatnot, so filter it before serving it back to a user.
|
|
GetStatusReblogs(ctx context.Context, status *gtsmodel.Status) ([]*gtsmodel.Status, Error)
|
|
}
|