mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-05 10:02:47 +00:00
a237e2b295
* Implement followed tags API * Insert statuses with followed tags into home timelines * Test following and unfollowing tags * Correct Swagger path params * Trim conversation caches * Migration for followed_tags table * Followed tag caches and DB implementation * Lint and tests * Add missing tag info endpoint, reorganize tag API * Unwrap boosts when timelining based on tags * Apply visibility filters to tag followers * Address review comments
212 lines
6.3 KiB
Go
212 lines
6.3 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 search
|
|
|
|
import (
|
|
"context"
|
|
|
|
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
|
statusfilter "github.com/superseriousbusiness/gotosocial/internal/filter/status"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
)
|
|
|
|
// return true if given queryType should include accounts.
|
|
func includeAccounts(queryType string) bool {
|
|
return queryType == queryTypeAny || queryType == queryTypeAccounts
|
|
}
|
|
|
|
// return true if given queryType should include statuses.
|
|
func includeStatuses(queryType string) bool {
|
|
return queryType == queryTypeAny || queryType == queryTypeStatuses
|
|
}
|
|
|
|
// return true if given queryType should include hashtags.
|
|
func includeHashtags(queryType string) bool {
|
|
return queryType == queryTypeAny || queryType == queryTypeHashtags
|
|
}
|
|
|
|
// packageAccounts is a util function that just
|
|
// converts the given accounts into an apimodel
|
|
// account slice, or errors appropriately.
|
|
func (p *Processor) packageAccounts(
|
|
ctx context.Context,
|
|
requestingAccount *gtsmodel.Account,
|
|
accounts []*gtsmodel.Account,
|
|
includeInstanceAccounts bool,
|
|
includeBlockedAccounts bool,
|
|
) ([]*apimodel.Account, gtserror.WithCode) {
|
|
apiAccounts := make([]*apimodel.Account, 0, len(accounts))
|
|
|
|
for _, account := range accounts {
|
|
if !includeInstanceAccounts && account.IsInstance() {
|
|
// No need to show instance accounts.
|
|
continue
|
|
}
|
|
|
|
// Check if block exists between searcher and searchee.
|
|
blocked, err := p.state.DB.IsEitherBlocked(ctx, requestingAccount.ID, account.ID)
|
|
if err != nil {
|
|
err = gtserror.Newf("error checking block between searching account %s and searched account %s: %w", requestingAccount.ID, account.ID, err)
|
|
return nil, gtserror.NewErrorInternalError(err)
|
|
}
|
|
|
|
if blocked && !includeBlockedAccounts {
|
|
// Don't include
|
|
// this result.
|
|
continue
|
|
}
|
|
|
|
var apiAccount *apimodel.Account
|
|
if blocked {
|
|
apiAccount, err = p.converter.AccountToAPIAccountBlocked(ctx, account)
|
|
} else {
|
|
apiAccount, err = p.converter.AccountToAPIAccountPublic(ctx, account)
|
|
}
|
|
|
|
if err != nil {
|
|
log.Debugf(ctx, "skipping account %s because it couldn't be converted to its api representation: %s", account.ID, err)
|
|
continue
|
|
}
|
|
|
|
apiAccounts = append(apiAccounts, apiAccount)
|
|
}
|
|
|
|
return apiAccounts, nil
|
|
}
|
|
|
|
// packageStatuses is a util function that just
|
|
// converts the given statuses into an apimodel
|
|
// status slice, or errors appropriately.
|
|
func (p *Processor) packageStatuses(
|
|
ctx context.Context,
|
|
requestingAccount *gtsmodel.Account,
|
|
statuses []*gtsmodel.Status,
|
|
) ([]*apimodel.Status, gtserror.WithCode) {
|
|
apiStatuses := make([]*apimodel.Status, 0, len(statuses))
|
|
|
|
for _, status := range statuses {
|
|
// Ensure requester can see result status.
|
|
visible, err := p.visFilter.StatusVisible(ctx, requestingAccount, status)
|
|
if err != nil {
|
|
err = gtserror.Newf("error checking visibility of status %s for account %s: %w", status.ID, requestingAccount.ID, err)
|
|
return nil, gtserror.NewErrorInternalError(err)
|
|
}
|
|
|
|
if !visible {
|
|
log.Debugf(ctx, "status %s is not visible to account %s, skipping this result", status.ID, requestingAccount.ID)
|
|
continue
|
|
}
|
|
|
|
apiStatus, err := p.converter.StatusToAPIStatus(ctx, status, requestingAccount, statusfilter.FilterContextNone, nil, nil)
|
|
if err != nil {
|
|
log.Debugf(ctx, "skipping status %s because it couldn't be converted to its api representation: %s", status.ID, err)
|
|
continue
|
|
}
|
|
|
|
apiStatuses = append(apiStatuses, apiStatus)
|
|
}
|
|
|
|
return apiStatuses, nil
|
|
}
|
|
|
|
// packageHashtags is a util function that just
|
|
// converts the given hashtags into an apimodel
|
|
// hashtag slice, or errors appropriately.
|
|
func (p *Processor) packageHashtags(
|
|
ctx context.Context,
|
|
requestingAccount *gtsmodel.Account,
|
|
tags []*gtsmodel.Tag,
|
|
v1 bool,
|
|
) ([]any, gtserror.WithCode) {
|
|
apiTags := make([]any, 0, len(tags))
|
|
|
|
var rangeF func(*gtsmodel.Tag)
|
|
if v1 {
|
|
// If API version 1, just provide slice of tag names.
|
|
rangeF = func(tag *gtsmodel.Tag) {
|
|
apiTags = append(apiTags, tag.Name)
|
|
}
|
|
} else {
|
|
// If API not version 1, provide slice of full tags.
|
|
rangeF = func(tag *gtsmodel.Tag) {
|
|
apiTag, err := p.converter.TagToAPITag(ctx, tag, true, nil)
|
|
if err != nil {
|
|
log.Debugf(
|
|
ctx,
|
|
"skipping tag %s because it couldn't be converted to its api representation: %s",
|
|
tag.Name, err,
|
|
)
|
|
return
|
|
}
|
|
|
|
apiTags = append(apiTags, &apiTag)
|
|
}
|
|
}
|
|
|
|
for _, tag := range tags {
|
|
rangeF(tag)
|
|
}
|
|
|
|
return apiTags, nil
|
|
}
|
|
|
|
// packageSearchResult wraps up the given accounts
|
|
// and statuses into an apimodel SearchResult that
|
|
// can be serialized to an API caller as JSON.
|
|
//
|
|
// Set v1 to 'true' if the search is using v1 of the API.
|
|
func (p *Processor) packageSearchResult(
|
|
ctx context.Context,
|
|
requestingAccount *gtsmodel.Account,
|
|
accounts []*gtsmodel.Account,
|
|
statuses []*gtsmodel.Status,
|
|
tags []*gtsmodel.Tag,
|
|
v1 bool,
|
|
includeInstanceAccounts bool,
|
|
includeBlockedAccounts bool,
|
|
) (*apimodel.SearchResult, gtserror.WithCode) {
|
|
apiAccounts, errWithCode := p.packageAccounts(
|
|
ctx,
|
|
requestingAccount,
|
|
accounts,
|
|
includeInstanceAccounts,
|
|
includeBlockedAccounts,
|
|
)
|
|
if errWithCode != nil {
|
|
return nil, errWithCode
|
|
}
|
|
|
|
apiStatuses, errWithCode := p.packageStatuses(ctx, requestingAccount, statuses)
|
|
if errWithCode != nil {
|
|
return nil, errWithCode
|
|
}
|
|
|
|
apiTags, errWithCode := p.packageHashtags(ctx, requestingAccount, tags, v1)
|
|
if errWithCode != nil {
|
|
return nil, errWithCode
|
|
}
|
|
|
|
return &apimodel.SearchResult{
|
|
Accounts: apiAccounts,
|
|
Statuses: apiStatuses,
|
|
Hashtags: apiTags,
|
|
}, nil
|
|
}
|