gtsocial-umbx

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

mention.go (3515B)


      1 // GoToSocial
      2 // Copyright (C) GoToSocial Authors admin@gotosocial.org
      3 // SPDX-License-Identifier: AGPL-3.0-or-later
      4 //
      5 // This program is free software: you can redistribute it and/or modify
      6 // it under the terms of the GNU Affero General Public License as published by
      7 // the Free Software Foundation, either version 3 of the License, or
      8 // (at your option) any later version.
      9 //
     10 // This program is distributed in the hope that it will be useful,
     11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
     12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     13 // GNU Affero General Public License for more details.
     14 //
     15 // You should have received a copy of the GNU Affero General Public License
     16 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
     17 
     18 package gtsmodel
     19 
     20 import "time"
     21 
     22 // Mention refers to the 'tagging' or 'mention' of a user within a status.
     23 type Mention struct {
     24 	ID               string    `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"`        // id of this item in the database
     25 	CreatedAt        time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created
     26 	UpdatedAt        time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated
     27 	StatusID         string    `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"`                  // ID of the status this mention originates from
     28 	Status           *Status   `validate:"-" bun:"rel:belongs-to"`                                              // status referred to by statusID
     29 	OriginAccountID  string    `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"`                  // ID of the mention creator account
     30 	OriginAccountURI string    `validate:"url" bun:",nullzero,notnull"`                                         // ActivityPub URI of the originator/creator of the mention
     31 	OriginAccount    *Account  `validate:"-" bun:"rel:belongs-to"`                                              // account referred to by originAccountID
     32 	TargetAccountID  string    `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"`                  // Mention target/receiver account ID
     33 	TargetAccount    *Account  `validate:"-" bun:"rel:belongs-to"`                                              // account referred to by targetAccountID
     34 	Silent           bool      `validate:"-" bun:",notnull,default:false"`                                      // Prevent this mention from generating a notification?
     35 
     36 	/*
     37 		NON-DATABASE CONVENIENCE FIELDS
     38 		These fields are just for convenience while passing the mention
     39 		around internally, to make fewer database calls and whatnot. They're
     40 		not meant to be put in the database!
     41 	*/
     42 
     43 	// NameString is for putting in the namestring of the mentioned user
     44 	// before the mention is dereferenced. Should be in a form along the lines of:
     45 	// @whatever_username@example.org
     46 	//
     47 	// This will not be put in the database, it's just for convenience.
     48 	NameString string `validate:"-" bun:"-"`
     49 	// TargetAccountURI is the AP ID (uri) of the user mentioned.
     50 	//
     51 	// This will not be put in the database, it's just for convenience.
     52 	TargetAccountURI string `validate:"-" bun:"-"`
     53 	// TargetAccountURL is the web url of the user mentioned.
     54 	//
     55 	// This will not be put in the database, it's just for convenience.
     56 	TargetAccountURL string `validate:"-" bun:"-"`
     57 	// A pointer to the gtsmodel account of the mentioned account.
     58 }