mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-11 17:40:46 +01: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
77 lines
2.6 KiB
Go
77 lines
2.6 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 (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
)
|
|
|
|
const (
|
|
// BasePathV1 is the base path for serving v1 of the search API, minus the 'api' prefix
|
|
BasePathV1 = "/v1/search"
|
|
|
|
// BasePathV2 is the base path for serving v2 of the search API, minus the 'api' prefix
|
|
BasePathV2 = "/v2/search"
|
|
|
|
// AccountIDKey -- If provided, statuses returned will be authored only by this account
|
|
AccountIDKey = "account_id"
|
|
// MaxIDKey -- Return results older than this id
|
|
MaxIDKey = "max_id"
|
|
// MinIDKey -- Return results immediately newer than this id
|
|
MinIDKey = "min_id"
|
|
// TypeKey -- Enum(accounts, hashtags, statuses)
|
|
TypeKey = "type"
|
|
// ExcludeUnreviewedKey -- Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.
|
|
ExcludeUnreviewedKey = "exclude_unreviewed"
|
|
// QueryKey -- The search query
|
|
QueryKey = "q"
|
|
// ResolveKey -- Attempt WebFinger lookup. Defaults to false.
|
|
ResolveKey = "resolve"
|
|
// LimitKey -- Maximum number of results to load, per type. Defaults to 20. Max 40.
|
|
LimitKey = "limit"
|
|
// OffsetKey -- Offset in search results. Used for pagination. Defaults to 0.
|
|
OffsetKey = "offset"
|
|
// FollowingKey -- Only include accounts that the user is following. Defaults to false.
|
|
FollowingKey = "following"
|
|
|
|
// TypeAccounts --
|
|
TypeAccounts = "accounts"
|
|
// TypeHashtags --
|
|
TypeHashtags = "hashtags"
|
|
// TypeStatuses --
|
|
TypeStatuses = "statuses"
|
|
)
|
|
|
|
type Module struct {
|
|
processor *processing.Processor
|
|
}
|
|
|
|
func New(processor *processing.Processor) *Module {
|
|
return &Module{
|
|
processor: processor,
|
|
}
|
|
}
|
|
|
|
func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) {
|
|
attachHandler(http.MethodGet, BasePathV1, m.SearchGETHandler)
|
|
attachHandler(http.MethodGet, BasePathV2, m.SearchGETHandler)
|
|
}
|