// Package faq is the golem15.faq plugin: FAQs (a question and answer list per
// slug and locale) edited in the admin, a port of the WinterCMS Golem15.FAQ
// plugin.
package faq

import (
	"net/http"
	"time"

	"git.golem15.com/golem15/sm-faq-plugin/console"
	"git.golem15.com/golem15/sm-faq-plugin/models"
	"git.golem15.com/golem15/sm-faq-plugin/updates"
	"git.golem15.com/golem15/summercms/modules/backpack"
	"git.golem15.com/golem15/summercms/modules/bonfire"
	"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.HasCommands    = (*Plugin)(nil)
	_ pact.HasRoutes      = (*Plugin)(nil)
	_ surf.BucketProvider = (*Plugin)(nil)
)

// Plugin is the golem15.faq plugin.
type Plugin struct {
	app *backpack.App
}

func (p *Plugin) ID() string { return "golem15.faq" }

// Requires golem15.translate: every FAQ belongs to a translate Locale.
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
	return nil
}

// Commands registers faq:import-winter.
func (p *Plugin) Commands() []bonfire.Command {
	return []bonfire.Command{console.ImportWinter(p.app)}
}

func (p *Plugin) Migrations() []*gormigrate.Migration { return updates.All() }

func (p *Plugin) Models() []any { return models.All() }

// Buckets registers faq-public-api: 120 requests a minute per client IP
// (behind the configured trusted proxies). 429 bodies are surf's
// {"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{
		"faq-public-api": {
			Name:  BucketPublicAPI,
			Max:   120,
			Decay: time.Minute,
			Key: func(r *http.Request) string {
				return "faq-public|" + surf.ClientIP(r, trusted)
			},
		},
	}
}

func init() {
	party.Register(&Plugin{})
}