forked from mirrors/gotosocial
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
74 lines
4.1 KiB
Go
74 lines
4.1 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 gtsmodel
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
// Mention refers to the 'tagging' or 'mention' of a user within a status.
|
|
type Mention struct {
|
|
ID string `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database
|
|
CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created
|
|
UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated
|
|
StatusID string `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"` // ID of the status this mention originates from
|
|
Status *Status `validate:"-" bun:"rel:belongs-to"` // status referred to by statusID
|
|
OriginAccountID string `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"` // ID of the mention creator account
|
|
OriginAccountURI string `validate:"url" bun:",nullzero,notnull"` // ActivityPub URI of the originator/creator of the mention
|
|
OriginAccount *Account `validate:"-" bun:"rel:belongs-to"` // account referred to by originAccountID
|
|
TargetAccountID string `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"` // Mention target/receiver account ID
|
|
TargetAccount *Account `validate:"-" bun:"rel:belongs-to"` // account referred to by targetAccountID
|
|
Silent *bool `validate:"-" bun:",nullzero,notnull,default:false"` // Prevent this mention from generating a notification?
|
|
|
|
/*
|
|
NON-DATABASE CONVENIENCE FIELDS
|
|
These fields are just for convenience while passing the mention
|
|
around internally, to make fewer database calls and whatnot. They're
|
|
not meant to be put in the database!
|
|
*/
|
|
|
|
// NameString is for putting in the namestring of the mentioned user
|
|
// before the mention is dereferenced. Should be in a form along the lines of:
|
|
// @whatever_username@example.org
|
|
//
|
|
// This will not be put in the database, it's just for convenience.
|
|
NameString string `validate:"-" bun:"-"`
|
|
// TargetAccountURI is the AP ID (uri) of the user mentioned.
|
|
//
|
|
// This will not be put in the database, it's just for convenience.
|
|
TargetAccountURI string `validate:"-" bun:"-"`
|
|
// TargetAccountURL is the web url of the user mentioned.
|
|
//
|
|
// This will not be put in the database, it's just for convenience.
|
|
TargetAccountURL string `validate:"-" bun:"-"`
|
|
// A pointer to the gtsmodel account of the mentioned account.
|
|
}
|
|
|
|
// ParseMentionFunc describes a function that takes a lowercase account name
|
|
// in the form "@test@whatever.example.org" for a remote account, or "@test"
|
|
// for a local account, and returns a fully populated mention for that account,
|
|
// with the given origin status ID and origin account ID.
|
|
//
|
|
// If the account is remote and not yet found in the database, then ParseMentionFunc
|
|
// will try to webfinger the remote account and put it in the database before returning.
|
|
//
|
|
// Mentions generated by this function are not put in the database, that's still up to
|
|
// the caller to do.
|
|
type ParseMentionFunc func(ctx context.Context, targetAccount string, originAccountID string, statusID string) (*Mention, error)
|