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
377 lines
11 KiB
Go
377 lines
11 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 cache
|
|
|
|
import (
|
|
"codeberg.org/gruf/go-cache/v3/result"
|
|
"codeberg.org/gruf/go-cache/v3/ttl"
|
|
"github.com/superseriousbusiness/gotosocial/internal/cache/domain"
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
type GTSCaches interface {
|
|
// Init will initialize all the gtsmodel caches in this collection.
|
|
// NOTE: the cache MUST NOT be in use anywhere, this is not thread-safe.
|
|
Init()
|
|
|
|
// Start will attempt to start all of the gtsmodel caches, or panic.
|
|
Start()
|
|
|
|
// Stop will attempt to stop all of the gtsmodel caches, or panic.
|
|
Stop()
|
|
|
|
// Account provides access to the gtsmodel Account database cache.
|
|
Account() *result.Cache[*gtsmodel.Account]
|
|
|
|
// Block provides access to the gtsmodel Block (account) database cache.
|
|
Block() *result.Cache[*gtsmodel.Block]
|
|
|
|
// DomainBlock provides access to the domain block database cache.
|
|
DomainBlock() *domain.BlockCache
|
|
|
|
// Emoji provides access to the gtsmodel Emoji database cache.
|
|
Emoji() *result.Cache[*gtsmodel.Emoji]
|
|
|
|
// EmojiCategory provides access to the gtsmodel EmojiCategory database cache.
|
|
EmojiCategory() *result.Cache[*gtsmodel.EmojiCategory]
|
|
|
|
// Mention provides access to the gtsmodel Mention database cache.
|
|
Mention() *result.Cache[*gtsmodel.Mention]
|
|
|
|
// Media provides access to the gtsmodel Media database cache.
|
|
Media() *result.Cache[*gtsmodel.MediaAttachment]
|
|
|
|
// Notification provides access to the gtsmodel Notification database cache.
|
|
Notification() *result.Cache[*gtsmodel.Notification]
|
|
|
|
// Report provides access to the gtsmodel Report database cache.
|
|
Report() *result.Cache[*gtsmodel.Report]
|
|
|
|
// Status provides access to the gtsmodel Status database cache.
|
|
Status() *result.Cache[*gtsmodel.Status]
|
|
|
|
// Tombstone provides access to the gtsmodel Tombstone database cache.
|
|
Tombstone() *result.Cache[*gtsmodel.Tombstone]
|
|
|
|
// User provides access to the gtsmodel User database cache.
|
|
User() *result.Cache[*gtsmodel.User]
|
|
|
|
// Webfinger
|
|
Webfinger() *ttl.Cache[string, string]
|
|
}
|
|
|
|
// NewGTS returns a new default implementation of GTSCaches.
|
|
func NewGTS() GTSCaches {
|
|
return >sCaches{}
|
|
}
|
|
|
|
type gtsCaches struct {
|
|
account *result.Cache[*gtsmodel.Account]
|
|
block *result.Cache[*gtsmodel.Block]
|
|
domainBlock *domain.BlockCache
|
|
emoji *result.Cache[*gtsmodel.Emoji]
|
|
emojiCategory *result.Cache[*gtsmodel.EmojiCategory]
|
|
media *result.Cache[*gtsmodel.MediaAttachment]
|
|
mention *result.Cache[*gtsmodel.Mention]
|
|
notification *result.Cache[*gtsmodel.Notification]
|
|
report *result.Cache[*gtsmodel.Report]
|
|
status *result.Cache[*gtsmodel.Status]
|
|
tombstone *result.Cache[*gtsmodel.Tombstone]
|
|
user *result.Cache[*gtsmodel.User]
|
|
webfinger *ttl.Cache[string, string]
|
|
}
|
|
|
|
func (c *gtsCaches) Init() {
|
|
c.initAccount()
|
|
c.initBlock()
|
|
c.initDomainBlock()
|
|
c.initEmoji()
|
|
c.initEmojiCategory()
|
|
c.initMedia()
|
|
c.initMention()
|
|
c.initNotification()
|
|
c.initReport()
|
|
c.initStatus()
|
|
c.initTombstone()
|
|
c.initUser()
|
|
c.initWebfinger()
|
|
}
|
|
|
|
func (c *gtsCaches) Start() {
|
|
tryUntil("starting gtsmodel.Account cache", 5, func() bool {
|
|
return c.account.Start(config.GetCacheGTSAccountSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Block cache", 5, func() bool {
|
|
return c.block.Start(config.GetCacheGTSBlockSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.DomainBlock cache", 5, func() bool {
|
|
return c.domainBlock.Start(config.GetCacheGTSDomainBlockSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Emoji cache", 5, func() bool {
|
|
return c.emoji.Start(config.GetCacheGTSEmojiSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.EmojiCategory cache", 5, func() bool {
|
|
return c.emojiCategory.Start(config.GetCacheGTSEmojiCategorySweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.MediaAttachment cache", 5, func() bool {
|
|
return c.media.Start(config.GetCacheGTSMediaSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Mention cache", 5, func() bool {
|
|
return c.mention.Start(config.GetCacheGTSMentionSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Notification cache", 5, func() bool {
|
|
return c.notification.Start(config.GetCacheGTSNotificationSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Report cache", 5, func() bool {
|
|
return c.report.Start(config.GetCacheGTSReportSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Status cache", 5, func() bool {
|
|
return c.status.Start(config.GetCacheGTSStatusSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Tombstone cache", 5, func() bool {
|
|
return c.tombstone.Start(config.GetCacheGTSTombstoneSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.User cache", 5, func() bool {
|
|
return c.user.Start(config.GetCacheGTSUserSweepFreq())
|
|
})
|
|
tryUntil("starting gtsmodel.Webfinger cache", 5, func() bool {
|
|
return c.webfinger.Start(config.GetCacheGTSWebfingerSweepFreq())
|
|
})
|
|
}
|
|
|
|
func (c *gtsCaches) Stop() {
|
|
tryUntil("stopping gtsmodel.Account cache", 5, c.account.Stop)
|
|
tryUntil("stopping gtsmodel.Block cache", 5, c.block.Stop)
|
|
tryUntil("stopping gtsmodel.DomainBlock cache", 5, c.domainBlock.Stop)
|
|
tryUntil("stopping gtsmodel.Emoji cache", 5, c.emoji.Stop)
|
|
tryUntil("stopping gtsmodel.EmojiCategory cache", 5, c.emojiCategory.Stop)
|
|
tryUntil("stopping gtsmodel.MediaAttachment cache", 5, c.media.Stop)
|
|
tryUntil("stopping gtsmodel.Mention cache", 5, c.mention.Stop)
|
|
tryUntil("stopping gtsmodel.Notification cache", 5, c.notification.Stop)
|
|
tryUntil("stopping gtsmodel.Report cache", 5, c.report.Stop)
|
|
tryUntil("stopping gtsmodel.Status cache", 5, c.status.Stop)
|
|
tryUntil("stopping gtsmodel.Tombstone cache", 5, c.tombstone.Stop)
|
|
tryUntil("stopping gtsmodel.User cache", 5, c.user.Stop)
|
|
tryUntil("stopping gtsmodel.Webfinger cache", 5, c.webfinger.Stop)
|
|
}
|
|
|
|
func (c *gtsCaches) Account() *result.Cache[*gtsmodel.Account] {
|
|
return c.account
|
|
}
|
|
|
|
func (c *gtsCaches) Block() *result.Cache[*gtsmodel.Block] {
|
|
return c.block
|
|
}
|
|
|
|
func (c *gtsCaches) DomainBlock() *domain.BlockCache {
|
|
return c.domainBlock
|
|
}
|
|
|
|
func (c *gtsCaches) Emoji() *result.Cache[*gtsmodel.Emoji] {
|
|
return c.emoji
|
|
}
|
|
|
|
func (c *gtsCaches) EmojiCategory() *result.Cache[*gtsmodel.EmojiCategory] {
|
|
return c.emojiCategory
|
|
}
|
|
|
|
func (c *gtsCaches) Media() *result.Cache[*gtsmodel.MediaAttachment] {
|
|
return c.media
|
|
}
|
|
|
|
func (c *gtsCaches) Mention() *result.Cache[*gtsmodel.Mention] {
|
|
return c.mention
|
|
}
|
|
|
|
func (c *gtsCaches) Notification() *result.Cache[*gtsmodel.Notification] {
|
|
return c.notification
|
|
}
|
|
|
|
func (c *gtsCaches) Report() *result.Cache[*gtsmodel.Report] {
|
|
return c.report
|
|
}
|
|
|
|
func (c *gtsCaches) Status() *result.Cache[*gtsmodel.Status] {
|
|
return c.status
|
|
}
|
|
|
|
func (c *gtsCaches) Tombstone() *result.Cache[*gtsmodel.Tombstone] {
|
|
return c.tombstone
|
|
}
|
|
|
|
func (c *gtsCaches) User() *result.Cache[*gtsmodel.User] {
|
|
return c.user
|
|
}
|
|
|
|
func (c *gtsCaches) Webfinger() *ttl.Cache[string, string] {
|
|
return c.webfinger
|
|
}
|
|
|
|
func (c *gtsCaches) initAccount() {
|
|
c.account = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "URI"},
|
|
{Name: "URL"},
|
|
{Name: "Username.Domain"},
|
|
{Name: "PublicKeyURI"},
|
|
}, func(a1 *gtsmodel.Account) *gtsmodel.Account {
|
|
a2 := new(gtsmodel.Account)
|
|
*a2 = *a1
|
|
return a2
|
|
}, config.GetCacheGTSAccountMaxSize())
|
|
c.account.SetTTL(config.GetCacheGTSAccountTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initBlock() {
|
|
c.block = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "AccountID.TargetAccountID"},
|
|
{Name: "URI"},
|
|
}, func(b1 *gtsmodel.Block) *gtsmodel.Block {
|
|
b2 := new(gtsmodel.Block)
|
|
*b2 = *b1
|
|
return b2
|
|
}, config.GetCacheGTSBlockMaxSize())
|
|
c.block.SetTTL(config.GetCacheGTSBlockTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initDomainBlock() {
|
|
c.domainBlock = domain.New(
|
|
config.GetCacheGTSDomainBlockMaxSize(),
|
|
config.GetCacheGTSDomainBlockTTL(),
|
|
)
|
|
}
|
|
|
|
func (c *gtsCaches) initEmoji() {
|
|
c.emoji = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "URI"},
|
|
{Name: "Shortcode.Domain"},
|
|
{Name: "ImageStaticURL"},
|
|
}, func(e1 *gtsmodel.Emoji) *gtsmodel.Emoji {
|
|
e2 := new(gtsmodel.Emoji)
|
|
*e2 = *e1
|
|
return e2
|
|
}, config.GetCacheGTSEmojiMaxSize())
|
|
c.emoji.SetTTL(config.GetCacheGTSEmojiTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initEmojiCategory() {
|
|
c.emojiCategory = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "Name"},
|
|
}, func(c1 *gtsmodel.EmojiCategory) *gtsmodel.EmojiCategory {
|
|
c2 := new(gtsmodel.EmojiCategory)
|
|
*c2 = *c1
|
|
return c2
|
|
}, config.GetCacheGTSEmojiCategoryMaxSize())
|
|
c.emojiCategory.SetTTL(config.GetCacheGTSEmojiCategoryTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initMedia() {
|
|
c.media = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
}, func(m1 *gtsmodel.MediaAttachment) *gtsmodel.MediaAttachment {
|
|
m2 := new(gtsmodel.MediaAttachment)
|
|
*m2 = *m1
|
|
return m2
|
|
}, config.GetCacheGTSMediaMaxSize())
|
|
c.media.SetTTL(config.GetCacheGTSMediaTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initMention() {
|
|
c.mention = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
}, func(m1 *gtsmodel.Mention) *gtsmodel.Mention {
|
|
m2 := new(gtsmodel.Mention)
|
|
*m2 = *m1
|
|
return m2
|
|
}, config.GetCacheGTSMentionMaxSize())
|
|
c.mention.SetTTL(config.GetCacheGTSMentionTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initNotification() {
|
|
c.notification = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
}, func(n1 *gtsmodel.Notification) *gtsmodel.Notification {
|
|
n2 := new(gtsmodel.Notification)
|
|
*n2 = *n1
|
|
return n2
|
|
}, config.GetCacheGTSNotificationMaxSize())
|
|
c.notification.SetTTL(config.GetCacheGTSNotificationTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initReport() {
|
|
c.report = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
}, func(r1 *gtsmodel.Report) *gtsmodel.Report {
|
|
r2 := new(gtsmodel.Report)
|
|
*r2 = *r1
|
|
return r2
|
|
}, config.GetCacheGTSReportMaxSize())
|
|
c.report.SetTTL(config.GetCacheGTSReportTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initStatus() {
|
|
c.status = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "URI"},
|
|
{Name: "URL"},
|
|
}, func(s1 *gtsmodel.Status) *gtsmodel.Status {
|
|
s2 := new(gtsmodel.Status)
|
|
*s2 = *s1
|
|
return s2
|
|
}, config.GetCacheGTSStatusMaxSize())
|
|
c.status.SetTTL(config.GetCacheGTSStatusTTL(), true)
|
|
}
|
|
|
|
// initTombstone will initialize the gtsmodel.Tombstone cache.
|
|
func (c *gtsCaches) initTombstone() {
|
|
c.tombstone = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "URI"},
|
|
}, func(t1 *gtsmodel.Tombstone) *gtsmodel.Tombstone {
|
|
t2 := new(gtsmodel.Tombstone)
|
|
*t2 = *t1
|
|
return t2
|
|
}, config.GetCacheGTSTombstoneMaxSize())
|
|
c.tombstone.SetTTL(config.GetCacheGTSTombstoneTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initUser() {
|
|
c.user = result.New([]result.Lookup{
|
|
{Name: "ID"},
|
|
{Name: "AccountID"},
|
|
{Name: "Email"},
|
|
{Name: "ConfirmationToken"},
|
|
{Name: "ExternalID"},
|
|
}, func(u1 *gtsmodel.User) *gtsmodel.User {
|
|
u2 := new(gtsmodel.User)
|
|
*u2 = *u1
|
|
return u2
|
|
}, config.GetCacheGTSUserMaxSize())
|
|
c.user.SetTTL(config.GetCacheGTSUserTTL(), true)
|
|
}
|
|
|
|
func (c *gtsCaches) initWebfinger() {
|
|
c.webfinger = ttl.New[string, string](
|
|
0,
|
|
config.GetCacheGTSWebfingerMaxSize(),
|
|
config.GetCacheGTSWebfingerTTL())
|
|
}
|