statusfave.go (2955B)
1 // GoToSocial 2 // Copyright (C) GoToSocial Authors admin@gotosocial.org 3 // SPDX-License-Identifier: AGPL-3.0-or-later 4 // 5 // This program is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Affero General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // This program is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Affero General Public License for more details. 14 // 15 // You should have received a copy of the GNU Affero General Public License 16 // along with this program. If not, see <http://www.gnu.org/licenses/>. 17 18 package db 19 20 import ( 21 "context" 22 23 "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" 24 ) 25 26 type StatusFave interface { 27 // GetStatusFaveByAccountID gets one status fave created by the given 28 // accountID, targeting the given statusID. 29 GetStatusFave(ctx context.Context, accountID string, statusID string) (*gtsmodel.StatusFave, Error) 30 31 // GetStatusFave returns one status fave with the given id. 32 GetStatusFaveByID(ctx context.Context, id string) (*gtsmodel.StatusFave, Error) 33 34 // GetStatusFaves returns a slice of faves/likes of the given status. 35 // This slice will be unfiltered, not taking account of blocks and whatnot, so filter it before serving it back to a user. 36 GetStatusFavesForStatus(ctx context.Context, statusID string) ([]*gtsmodel.StatusFave, Error) 37 38 // PopulateStatusFave ensures that all sub-models of a fave are populated (account, status, etc). 39 PopulateStatusFave(ctx context.Context, statusFave *gtsmodel.StatusFave) error 40 41 // PutStatusFave inserts the given statusFave into the database. 42 PutStatusFave(ctx context.Context, statusFave *gtsmodel.StatusFave) Error 43 44 // DeleteStatusFave deletes one status fave with the given id. 45 DeleteStatusFaveByID(ctx context.Context, id string) Error 46 47 // DeleteStatusFaves mass deletes status faves targeting targetAccountID 48 // and/or originating from originAccountID and/or faving statusID. 49 // 50 // If targetAccountID is set and originAccountID isn't, all status faves 51 // that target the given account will be deleted. 52 // 53 // If originAccountID is set and targetAccountID isn't, all status faves 54 // originating from the given account will be deleted. 55 // 56 // If both are set, then status faves that target targetAccountID and 57 // originate from originAccountID will be deleted. 58 // 59 // At least one parameter must not be an empty string. 60 DeleteStatusFaves(ctx context.Context, targetAccountID string, originAccountID string) Error 61 62 // DeleteStatusFavesForStatus deletes all status faves that target the 63 // given status ID. This is useful when a status has been deleted, and you need 64 // to clean up after it. 65 DeleteStatusFavesForStatus(ctx context.Context, statusID string) Error 66 }