package journal import ( "embed" "fmt" "io/fs" "log/slog" "net/http" "strconv" "strings" "time" "git.golem15.com/golem15/sm-journal-plugin/classes" "git.golem15.com/golem15/sm-journal-plugin/console" "git.golem15.com/golem15/sm-journal-plugin/models" "git.golem15.com/golem15/sm-journal-plugin/updates" "git.golem15.com/golem15/summercms/modules/backpack" "git.golem15.com/golem15/summercms/modules/bonfire" "git.golem15.com/golem15/summercms/modules/bouncer" "git.golem15.com/golem15/summercms/modules/cooler" "git.golem15.com/golem15/summercms/modules/pact" "git.golem15.com/golem15/summercms/modules/party" "git.golem15.com/golem15/summercms/modules/surf" "github.com/go-gormigrate/gormigrate/v2" ) var ( _ party.Plugin = (*Plugin)(nil) _ pact.HasMigrations = (*Plugin)(nil) _ pact.HasModels = (*Plugin)(nil) _ pact.HasLang = (*Plugin)(nil) _ pact.HasCommands = (*Plugin)(nil) _ pact.HasRoutes = (*Plugin)(nil) _ surf.BucketProvider = (*Plugin)(nil) ) //go:embed lang var langFS embed.FS // Plugin is the golem15.journal plugin. type Plugin struct { app *backpack.App } func (p *Plugin) ID() string { return "golem15.journal" } func (p *Plugin) Requires() []string { return []string{"golem15.translate"} } func (p *Plugin) Register(app *backpack.App) error { p.app = app return nil } func (p *Plugin) Boot(app *backpack.App) error { p.app = app if err := p.wireSiteCache(app); err != nil { return err } return p.wireSearch(app) } // wireSiteCache keeps the Journal's deprecated purge keys working for one // release. When the framework keys site_cache.purge_url or purge_token are // set, the framework owns the purger (cooler.Install, cooler.SiteCacheFromApp) // and the Journal keys are ignored with a warning. Otherwise, when // golem15.journal.site_cache.purge_url and purge_token are set, it builds // the purger from them, publishes it, so the framework and every plugin's // admin saves purge through it, and logs a deprecation warning. An invalid // configuration of the Journal keys fails boot, naming the key. func (p *Plugin) wireSiteCache(app *backpack.App) error { if app == nil || app.Config == nil { return nil } cfg := app.Config log := slog.Default() aliasURL := cfg.String(classes.SiteCachePurgeURLKey) aliasToken := cfg.String(classes.SiteCachePurgeTokenKey) aliasSet := strings.TrimSpace(aliasURL) != "" || aliasToken != "" if strings.TrimSpace(cfg.String(cooler.SiteCachePurgeURLKey)) != "" || cfg.String(cooler.SiteCachePurgeTokenKey) != "" { if aliasSet { log.Warn("journal: golem15.journal.site_cache.purge_url and purge_token are ignored because the framework keys are set", "use", cooler.SiteCachePurgeURLKey+", "+cooler.SiteCachePurgeTokenKey) } return nil } if !aliasSet { return nil } purger, err := classes.NewSiteCachePurger(aliasURL, aliasToken) if err != nil { return fmt.Errorf("golem15.journal: site cache: %w", err) } if purger == nil { return nil } if existing, ok := app.Lookup[*cooler.SiteCachePurger](); ok && existing != nil { return nil } if err := app.Publish(purger); err != nil { return err } log.Warn("journal: golem15.journal.site_cache.purge_url and purge_token are deprecated and will be removed; set "+ cooler.SiteCachePurgeURLKey+" and "+cooler.SiteCachePurgeTokenKey+" instead", "endpoint", purger.Endpoint()) return nil } func (p *Plugin) LangFS() fs.FS { return langFS } func (p *Plugin) Migrations() []*gormigrate.Migration { return updates.All() } func (p *Plugin) Models() []any { return models.All() } func (p *Plugin) Commands() []bonfire.Command { return []bonfire.Command{ console.ExportPosts(p.app), console.ImportPosts(p.app), } } // Buckets registers PHP limiter names journal-public-api and journal-api // (D-17). 429 bodies stay surf {"message":"Too Many Attempts."}. func (p *Plugin) Buckets() map[string]surf.Bucket { trusted := surf.TrustedProxies(nil) if p.app != nil { trusted = surf.TrustedProxies(p.app.Config) } return map[string]surf.Bucket{ "journal-public-api": { Name: "journal-public-api", Max: 120, Decay: time.Minute, Key: func(r *http.Request) string { return "journal-public|" + surf.ClientIP(r, trusted) }, }, "journal-api": { Name: "journal-api", Max: 120, Decay: time.Minute, Key: func(r *http.Request) string { if pr, ok := bouncer.User(r.Context()); ok && pr != nil && pr.Backend { return "journal-api|u:" + strconv.FormatUint(uint64(pr.ID), 10) } return "journal-api|" + surf.ClientIP(r, trusted) }, }, } } func init() { party.Register(&Plugin{}) }