Browse Source
* Remove dead code * Filter statuses when converting to frontend representation * status.filtered is an array * Make matching case-insensitive * Remove TODOs that don't need to be done now * Add missing filter check for notification * lint: rename ErrHideStatus * APIFilterActionToFilterAction not used yet * swaggerino docseroni * Address review comments * Add apimodel.FilterActionNone --------- Co-authored-by: tobi <31960611+tsmethurst@users.noreply.github.com> Co-authored-by: tobi <tobi.smethurst@protonmail.com>pull/2904/head
Vyr Cossont
2 years ago
committed by
GitHub
24 changed files with 855 additions and 130 deletions
@ -0,0 +1,34 @@
|
||||
// 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 model |
||||
|
||||
// FilterResult is returned along with a filtered status to explain why it was filtered.
|
||||
//
|
||||
// swagger:model filterResult
|
||||
//
|
||||
// ---
|
||||
// tags:
|
||||
// - filters
|
||||
type FilterResult struct { |
||||
// The filter that was matched.
|
||||
Filter FilterV2 `json:"filter"` |
||||
// The keywords within the filter that were matched.
|
||||
KeywordMatches []string `json:"keyword_matches"` |
||||
// The status IDs within the filter that were matched.
|
||||
StatusMatches []string `json:"status_matches"` |
||||
} |
||||
@ -0,0 +1,106 @@
|
||||
// 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 model |
||||
|
||||
// FilterV2 represents a user-defined filter for determining which statuses should not be shown to the user.
|
||||
// v2 filters have names and can include multiple phrases and status IDs to filter.
|
||||
//
|
||||
// swagger:model filterV2
|
||||
//
|
||||
// ---
|
||||
// tags:
|
||||
// - filters
|
||||
type FilterV2 struct { |
||||
// The ID of the filter in the database.
|
||||
ID string `json:"id"` |
||||
// The name of the filter.
|
||||
//
|
||||
// Example: Linux Words
|
||||
Title string `json:"title"` |
||||
// The contexts in which the filter should be applied.
|
||||
//
|
||||
// Minimum items: 1
|
||||
// Unique: true
|
||||
// Enum:
|
||||
// - home
|
||||
// - notifications
|
||||
// - public
|
||||
// - thread
|
||||
// - account
|
||||
// Example: ["home", "public"]
|
||||
Context []FilterContext `json:"context"` |
||||
// When the filter should no longer be applied. Null if the filter does not expire.
|
||||
//
|
||||
// Example: 2024-02-01T02:57:49Z
|
||||
ExpiresAt *string `json:"expires_at"` |
||||
// The action to be taken when a status matches this filter.
|
||||
// Enum:
|
||||
// - warn
|
||||
// - hide
|
||||
FilterAction FilterAction `json:"filter_action"` |
||||
// The keywords grouped under this filter.
|
||||
Keywords []FilterKeyword `json:"keywords"` |
||||
// The statuses grouped under this filter.
|
||||
Statuses []FilterStatus `json:"statuses"` |
||||
} |
||||
|
||||
// FilterAction is the action to apply to statuses matching a filter.
|
||||
type FilterAction string |
||||
|
||||
const ( |
||||
// FilterActionNone filters should not exist, except internally, for partially constructed or invalid filters.
|
||||
FilterActionNone FilterAction = "" |
||||
// FilterActionWarn filters will include this status in API results with a warning.
|
||||
FilterActionWarn FilterAction = "warn" |
||||
// FilterActionHide filters will remove this status from API results.
|
||||
FilterActionHide FilterAction = "hide" |
||||
) |
||||
|
||||
// FilterKeyword represents text to filter within a v2 filter.
|
||||
//
|
||||
// swagger:model filterKeyword
|
||||
//
|
||||
// ---
|
||||
// tags:
|
||||
// - filters
|
||||
type FilterKeyword struct { |
||||
// The ID of the filter keyword entry in the database.
|
||||
ID string `json:"id"` |
||||
// The text to be filtered.
|
||||
//
|
||||
// Example: fnord
|
||||
Keyword string `json:"keyword"` |
||||
// Should the filter consider word boundaries?
|
||||
//
|
||||
// Example: true
|
||||
WholeWord bool `json:"whole_word"` |
||||
} |
||||
|
||||
// FilterStatus represents a single status to filter within a v2 filter.
|
||||
//
|
||||
// swagger:model filterStatus
|
||||
//
|
||||
// ---
|
||||
// tags:
|
||||
// - filters
|
||||
type FilterStatus struct { |
||||
// The ID of the filter status entry in the database.
|
||||
ID string `json:"id"` |
||||
// The status ID to be filtered.
|
||||
StatusID string `json:"phrase"` |
||||
} |
||||
@ -0,0 +1,45 @@
|
||||
// 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 status represents status filters managed by the user through the API.
|
||||
package status |
||||
|
||||
import ( |
||||
"errors" |
||||
) |
||||
|
||||
// ErrHideStatus indicates that a status has been filtered and should not be returned at all.
|
||||
var ErrHideStatus = errors.New("hide status") |
||||
|
||||
// FilterContext determines the filters that apply to a given status or list of statuses.
|
||||
type FilterContext string |
||||
|
||||
const ( |
||||
// FilterContextNone means no filters should be applied.
|
||||
// There are no filters with this context; it's for internal use only.
|
||||
FilterContextNone FilterContext = "" |
||||
// FilterContextHome means this status is being filtered as part of a home or list timeline.
|
||||
FilterContextHome FilterContext = "home" |
||||
// FilterContextNotifications means this status is being filtered as part of the notifications timeline.
|
||||
FilterContextNotifications FilterContext = "notifications" |
||||
// FilterContextPublic means this status is being filtered as part of a public or tag timeline.
|
||||
FilterContextPublic FilterContext = "public" |
||||
// FilterContextThread means this status is being filtered as part of a thread's context.
|
||||
FilterContextThread FilterContext = "thread" |
||||
// FilterContextAccount means this status is being filtered as part of an account's statuses.
|
||||
FilterContextAccount FilterContext = "account" |
||||
) |
||||
Loading…
Reference in new issue