Files
sm-journal-plugin/plugin.go
Jakub Zych 2a3afb5107 feat(16.2-07): purge the host site cache on every admin post and category write
- posts: FormAfterCreate/Update purge after the content_html translations,
  new FormAfterDelete; categories: FormAfterCreate and FormAfterDelete
- NewSiteCachePurger refuses half configuration, non-http(s) URLs, user
  info, fragments, http to a non-loopback host and tokens under 32 chars;
  Boot logs the endpoint host and path once
- TestPostsAdminPurgesSiteCache smoke test
- README: Configuration section (keys, contract, timing, scope), API rows
2026-10-10 18:27:12 +02:00

131 lines
3.4 KiB
Go

package journal
import (
"embed"
"fmt"
"io/fs"
"log/slog"
"net/http"
"strconv"
"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/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 builds the site cache purger from
// golem15.journal.site_cache.purge_url and purge_token and publishes it, so
// admin saves of posts and categories purge the host site's page caches.
// With neither key set nothing is published.
func (p *Plugin) wireSiteCache(app *backpack.App) error {
if app == nil || app.Config == nil {
return nil
}
purger, err := classes.NewSiteCachePurger(
app.Config.String(classes.SiteCachePurgeURLKey),
app.Config.String(classes.SiteCachePurgeTokenKey),
)
if err != nil {
return fmt.Errorf("golem15.journal: site cache: %w", err)
}
if purger == nil {
return nil
}
if err := app.Publish(purger); err != nil {
return err
}
slog.Default().Info("journal: site cache purge enabled", "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{})
}