summaryrefslogtreecommitdiff
path: root/internal/processing/search/accounts.go
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2023-06-21 18:26:40 +0200
committerLibravatar GitHub <noreply@github.com>2023-06-21 17:26:40 +0100
commit831ae09f8bab04af854243421047371339c3e190 (patch)
treef7709d478cc363dc1899bdb658fe20e2dc7986f3 /internal/processing/search/accounts.go
parent[docs] Disambiguate docker version, don't recommend opening localhost (#1913) (diff)
downloadgotosocial-831ae09f8bab04af854243421047371339c3e190.tar.xz
[feature] Add partial text search for accounts + statuses (#1836)
Diffstat (limited to 'internal/processing/search/accounts.go')
-rw-r--r--internal/processing/search/accounts.go110
1 files changed, 110 insertions, 0 deletions
diff --git a/internal/processing/search/accounts.go b/internal/processing/search/accounts.go
new file mode 100644
index 000000000..eb88647a3
--- /dev/null
+++ b/internal/processing/search/accounts.go
@@ -0,0 +1,110 @@
+// 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"
+ "errors"
+ "strings"
+
+ "codeberg.org/gruf/go-kv"
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/id"
+ "github.com/superseriousbusiness/gotosocial/internal/log"
+)
+
+// Accounts does a partial search for accounts that
+// match the given query. It expects input that looks
+// like a namestring, and will normalize plaintext to look
+// more like a namestring. For queries that include domain,
+// it will only return one match at most. For namestrings
+// that exclude domain, multiple matches may be returned.
+//
+// This behavior aligns more or less with Mastodon's API.
+// See https://docs.joinmastodon.org/methods/accounts/#search.
+func (p *Processor) Accounts(
+ ctx context.Context,
+ requestingAccount *gtsmodel.Account,
+ query string,
+ limit int,
+ offset int,
+ resolve bool,
+ following bool,
+) ([]*apimodel.Account, gtserror.WithCode) {
+ var (
+ foundAccounts = make([]*gtsmodel.Account, 0, limit)
+ appendAccount = func(foundAccount *gtsmodel.Account) { foundAccounts = append(foundAccounts, foundAccount) }
+ )
+
+ // Validate query.
+ query = strings.TrimSpace(query)
+ if query == "" {
+ err := gtserror.New("search query was empty string after trimming space")
+ return nil, gtserror.NewErrorBadRequest(err, err.Error())
+ }
+
+ // Be nice and normalize query by prepending '@'.
+ // This will make it easier for accountsByNamestring
+ // to pick this up as a valid namestring.
+ if query[0] != '@' {
+ query = "@" + query
+ }
+
+ log.
+ WithContext(ctx).
+ WithFields(kv.Fields{
+ {"limit", limit},
+ {"offset", offset},
+ {"query", query},
+ {"resolve", resolve},
+ {"following", following},
+ }...).
+ Debugf("beginning search")
+
+ // todo: Currently we don't support offset for paging;
+ // if caller supplied an offset greater than 0, return
+ // nothing as though there were no additional results.
+ if offset > 0 {
+ return p.packageAccounts(ctx, requestingAccount, foundAccounts)
+ }
+
+ // Return all accounts we can find that match the
+ // provided query. If it's not a namestring, this
+ // won't return an error, it'll just return 0 results.
+ if _, err := p.accountsByNamestring(
+ ctx,
+ requestingAccount,
+ id.Highest,
+ id.Lowest,
+ limit,
+ offset,
+ query,
+ resolve,
+ following,
+ appendAccount,
+ ); err != nil && !errors.Is(err, db.ErrNoEntries) {
+ err = gtserror.Newf("error searching by namestring: %w", err)
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ // Return whatever we got (if anything).
+ return p.packageAccounts(ctx, requestingAccount, foundAccounts)
+}