plugin

type Activator interface {
	Activate(context.Context, *Runtime) error
}

type AdminAction struct {
	Name        string
	Label       string
	Icon        string
	Variant     string
	Description string
}

type AdminActionProvider interface {
	AdminActions() []AdminAction
	HandleAdminAction(context.Context, *Runtime, string) (AdminNotice, error)
}

type AdminMenuItem struct {
	Label      string
	URL        string
	Icon       string
	OpenNewTab bool
	// Owner is assigned by Manager so the admin renderer can use the
	// registering plugin's optional Translator. Plugins normally leave it blank.
	Owner string
}

type AdminMenuProvider interface {
	AdminMenuItems(context.Context) []AdminMenuItem
}

type AdminNotice struct {
	Type         string `json:"type"`
	Mode         string `json:"mode,omitempty"`
	Message      string `json:"message"`
	SkipCoreI18n bool   `json:"skipCoreI18n,omitempty"`
}

type AdminNoticeProvider interface {
	AdminNotices(context.Context, *Runtime, map[string]string) []AdminNotice
}

type AdminPage struct {
	Name        string
	Label       string
	Icon        string
	Title       string
	Description string
}

type AdminPageActionProvider interface {
	HandleAdminPageAction(context.Context, *Runtime, string, map[string][]string) (AdminPageActionResult, error)
}

type AdminPageActionResult struct {
	ConfigPatch map[string]string
	Notice      AdminNotice
}

type AdminPageProvider interface {
	AdminPages() []AdminPage
	RenderAdminPage(context.Context, *Runtime, string, AdminPageRenderContext) (template.HTML, error)
}

type AdminPageRenderContext struct {
	CSRF   string
	Config map[string]string
	// Query carries the GET query parameters of the page request (same shape as
	// url.Values), so native pages can support pagination, filtering and other
	// stateful views through their own ?key=value links without a custom route.
	Query map[string][]string
}

type ArchivePayload struct {
	Type    string
	Slug    string
	Query   *PublicContentQuery
	Results []PublicContent
	Total   int64
	Data    map[string]any
	Handled bool
}

type AttachmentDataPayload struct {
	Content any
	Meta    any
	Data    []byte
	Handled bool
}

type AttachmentDeleteHandlePayload struct {
	Content any
	Meta    any
	Handled bool
}

type AttachmentEditPayload struct {
	Content     any
	Title       string
	Description string
	Meta        any
}

type AttachmentMetaInfo struct {
	Name        string
	Description string
	URL         string
	MIME        string
	Size        int64
	IsImage     bool
	Width       int
	Height      int
}

type AttachmentPayload struct {
	Content any
	Meta    any
}

type AttachmentReplacePayload struct {
	Content      any
	PreviousMeta any
	Name         string
	ParentID     int64
	Size         int64
	Open         func() (io.ReadCloser, error)
	Meta         any
	Warning      string
	Handled      bool
}

type AttachmentURLPayload struct {
	Content any
	Meta    any
	URL     string
}

type AutosavePayload struct {
	ContentID int64
	Input     any
	Result    any
	Handled   bool
}

type BackupPayload struct {
	Data    any
	Handled bool
}

type ColumnDefinition struct {
	Name     string
	Type     ColumnType
	Length   int
	Nullable bool
	Default  string
	Primary  bool
	AutoInc  bool
}

type ColumnType string

type CommentActionPayload struct {
	ID             int64
	Status         string
	PreviousStatus string
	Comment        any
	Content        any
}

type CommentAvatarPayload struct {
	Comment any
	Mail    string
	Size    int
	URL     string
}

type CommentBadge struct {
	Label string
	Icon  string
	Tone  string
}

type CommentEnrichment struct {
	Badges     []CommentBadge
	CSSClasses []string
	Extra      map[string]any
}

type CommentFilterPayload struct {
	Comment any
}

type CommentGuardPayload struct {
	Request *http.Request
	CID     int64
	Token   string
	Valid   bool
	Reason  string
	Handled bool
}

type CommentLinkPayload struct {
	Comment PublicComment
	Content PublicContent
	URL     string
	HTML    template.HTML
}

type CommentListPayload struct {
	Content  PublicContent
	Comments []PublicComment
	Views    any
	Pager    any
	HTML     template.HTML
	Handled  bool
}

type CommentParserPayload struct {
	Comment any
	Text    string
	Mode    string
	HTML    template.HTML
	Handled bool
}

type CommentPermalinkPayload struct {
	Comment PublicComment
	Content PublicContent
	URL     string
}

type CommentRenderPayload struct {
	Comment any
	Text    string
	HTML    template.HTML
}

type CommentSavePayload struct {
	ID        int64
	Operation string
	Input     any
	Content   any
	Comment   any
}

type CommentWriteInput struct {
	ID        int64
	Operation string
	CID       int64
	Author    string
	AuthorID  int64
	OwnerID   int64
	Mail      string
	URL       string
	Text      string
	Type      string
	Status    string
	Parent    int64
	IP        string
	Agent     string
}

type ConfigHandler interface {
	HandleConfig(ctx context.Context, rt *Runtime, values map[string]string, isInit bool) error
}

type ConfigProvider interface {
	ConfigSchema() []FieldSchema
}

type ConfigValidator interface {
	ValidateConfig(values map[string]string) map[string]string
}

type ContentAuthorPayload struct {
	Content PublicContent
	Author  PublicUser
}

type ContentDeletePayload struct {
	ID      int64
	Content any
}

type ContentFieldInput struct {
	Name       string
	Type       string
	StrValue   string
	IntValue   int64
	FloatValue float64
}

type ContentFieldReadOnlyPayload struct {
	ContentID int64
	Type      string
	Name      string
	ReadOnly  bool
}

type ContentFieldsPayload struct {
	ContentID int64
	Type      string
	Fields    []FieldSchema
}

type ContentFieldsProvider interface {
	ContentFieldSchema() []FieldSchema
}

type ContentFilterPayload struct {
	Content any
}

type ContentListPayload struct {
	Stage   string
	View    string
	Title   string
	Query   any
	Results any
	Total   int64
	Handled bool
}

type ContentParserPayload struct {
	Content any
	Text    string
	Mode    string
	HTML    template.HTML
	Handled bool
}

type ContentPermalinkPayload struct {
	Content PublicContent
	URL     string
}

type ContentRenderPayload struct {
	Content any
	HTML    template.HTML
	Data    map[string]any
}

type ContentSavePayload struct {
	ID          int64
	PublishedID int64
	AuthorID    int64
	Operation   string
	Input       any
	Content     any
}

type ContentStatusPayload struct {
	ID             int64
	PreviousStatus string
	Status         string
	Content        any
}

type ContentTitlePayload struct {
	Content any
	Title   string
}

type ContentWriteInput struct {
	ID           int64
	PublishedID  int64
	AuthorID     int64
	Operation    string
	Title        string
	Slug         string
	SlugID       int64
	Text         string
	Type         string
	Status       string
	Password     string
	Created      int64
	SortOrder    int64
	Template     string
	Parent       int64
	AllowComment bool
	AllowPing    bool
	AllowFeed    bool
	CategoryIDs  []int64
	Tags         []string
	Fields       []ContentFieldInput
	DraftOf      int64
}

type DatabaseMigrator interface {
	Migrate(ctx context.Context, db *sql.DB, dialect string, fromVersion, toVersion int) error
}

type DatabaseProvider interface {
	DatabaseTables() []TableDefinition
	DatabaseVersion() int
}

type Deactivator interface {
	Deactivate(context.Context, *Runtime) error
}

type ExcerptAfterPayload struct {
	Content PublicContent
	Text    string
	Limit   int
	Excerpt string
}

type ExcerptPayload struct {
	Text   string
	Limit  int
	Output string
}

type FeedItemPayload struct {
	Kind    string
	Content PublicContent
	Comment PublicComment
	Item    any
	Handled bool
}

type FieldOption struct {
	Label string
	Value string
}

type FieldSchema struct {
	Name          string
	Label         string
	Group         string
	Type          FieldType
	Default       string
	Description   string
	Required      bool
	ShowWhenField string
	ShowWhenValue string
	Min           string
	Max           string
	Step          string
	Options       []FieldOption
	ForTypes      []string
	ReadOnly      bool
	Wide          bool
	// Translate is attached while core collects theme and plugin content
	// fields, keeping extension-owned labels out of the core translation table.
	Translate func(string) string
}

type FieldType string

type FrontendHTMLPayload struct {
	Location string
	HTML     template.HTML
	Data     map[string]any
}

type HookControl struct {
	Payload any
	Stop    bool
}

type HookDispatch struct {
	Payload   any
	Triggered bool
	Stopped   bool
}

type HookFunc func(context.Context, any) (any, error)

type ImageProcessPayload struct {
	Name    string
	Data    []byte
	MIME    string
	Result  []byte
	Warning string
	Handled bool
}

type IndexDefinition struct {
	Name    string
	Columns []string
	Unique  bool
}

type InfoProvider interface {
	Info() PluginInfo
}

type Manager struct {
	// contains filtered or unexported fields
}

type MetaPermalinkPayload struct {
	Meta PublicMeta
	URL  string
}

type PersonalConfigProvider interface {
	PersonalConfigSchema() []FieldSchema
}

type Plugin interface {
	Name() string
	Version() string
	Description() string
	Init(*Manager)
}

type PluginInfo struct {
	Name             string
	Version          string
	Author           string
	Description      string
	Homepage         string
	RequireGopherInk string
}

type PublicArchivePeriod struct {
	Year  int
	Month int
	Day   int
	Date  string
	Count int
	URL   string
}

type PublicComment struct {
	COID     int64
	CID      int64
	Created  int64
	Author   string
	AuthorID int64
	// OwnerID is the author UID of the content this comment belongs to.
	OwnerID int64
	Mail    string
	URL     string
	IP      string
	Agent   string
	Text    string
	Type    string
	Status  string
	Parent  int64
	// Title, Slug and ContentType carry the source metadata that trackback and
	// pingback comments store; for a normal comment Title/Slug are empty and
	// ContentType mirrors the parent content type.
	Title       string
	Slug        string
	ContentType string
}

type PublicCommentQuery struct {
	COID     int64
	Status   string
	Type     string
	Keywords string
	CID      int64
	AuthorID int64
	OwnerID  int64
	Mail     string
	IP       string
	Limit    int
	Offset   int
}

type PublicContent struct {
	CID          int64
	Title        string
	Slug         string
	SlugID       int64
	Created      int64
	Modified     int64
	Text         string
	Type         string
	Status       string
	AuthorID     int64
	Password     string
	CommentsNum  int64
	AllowComment string
	AllowPing    string
	AllowFeed    string
	Template     string
	Parent       int64
	SortOrder    int64
	DraftOf      int64
}

type PublicContentQuery struct {
	CID           int64
	Slug          string
	SlugID        int64
	Type          string
	Status        string
	Keywords      string
	Category      int64
	Tag           int64
	AuthorID      int64
	Year          int
	Month         int
	Day           int
	Limit         int
	Offset        int
	IncludeDrafts bool
	ExcludeFuture bool
}

type PublicMeta struct {
	MID         int64
	Name        string
	Slug        string
	Type        string
	Description string
	Count       int64
	SortOrder   int64
	Parent      int64
}

type PublicMetaQuery struct {
	MID    int64
	Type   string
	Slug   string
	Parent int64
	Used   bool
	Limit  int
	Offset int
}

type PublicPathProvider func(context.Context, *Runtime) ([]string, error)

type PublicRevision struct {
	RID          int64
	CID          int64
	Created      int64
	AuthorID     int64
	Title        string
	Slug         string
	Text         string
	Status       string
	Password     string
	SortOrder    int64
	Template     string
	Parent       int64
	AllowComment string
	AllowPing    string
	AllowFeed    string
}

type PublicUser struct {
	UID        int64
	Name       string
	Mail       string
	URL        string
	ScreenName string
	Role       string
}

type PublicUserQuery struct {
	UID      int64
	Name     string
	Mail     string
	Role     string
	Keywords string
	Limit    int
	Offset   int
}

type RequestPayload struct {
	Method          string
	Path            string
	RawQuery        string
	RemoteAddr      string
	IP              string
	UserAgent       string
	Referer         string
	Status          int
	Bytes           int64
	Duration        int64
	Admin           bool
	Static          bool
	ContentType     string
	Headers         map[string]string
	ResponseHeaders map[string]string
	Body            string
	Handled         bool
}

type RevisionPayload struct {
	ContentID int64
	Revision  any
	Input     any
	Handled   bool
}

type Route struct {
	Plugin                string
	Method                string
	Pattern               string
	Handler               RouteHandler
	InvalidatesPublicData bool
}

type RouteHandler func(*Runtime, http.ResponseWriter, *http.Request)

type Runtime struct {
	OwnerKind                string
	Owner                    string
	ListContents             func(context.Context, PublicContentQuery) ([]PublicContent, int64, error)
	ListComments             func(context.Context, PublicCommentQuery) ([]PublicComment, int64, error)
	ListUsers                func(context.Context, PublicUserQuery) ([]PublicUser, int64, error)
	ListMetas                func(context.Context, PublicMetaQuery) ([]PublicMeta, int64, error)
	ListRevisions            func(context.Context, int64) ([]PublicRevision, error)
	GetRevision              func(context.Context, int64) (PublicRevision, error)
	RestoreRevision          func(context.Context, int64, int64) error
	DeleteRevision           func(context.Context, int64, int64) error
	ArchiveMonths            func(context.Context, int) ([]PublicArchivePeriod, error)
	AdjacentPosts            func(context.Context, int64) (PublicContent, PublicContent, error)
	RelatedPosts             func(context.Context, int64, int) ([]PublicContent, error)
	GetEditingDraft          func(context.Context, int64) (PublicContent, error)
	PublishDraft             func(context.Context, int64) error
	ListThemeFiles           func(context.Context, ...string) ([]string, error)
	ThemeEditableDir         func(context.Context, ...string) (string, bool)
	ContentURL               func(context.Context, int64) (string, error)
	CommentURL               func(context.Context, int64) (string, error)
	AvatarURL                func(context.Context, string, int) string
	Language                 func(context.Context) string
	SiteURL                  func(context.Context) string
	AdminURL                 func(context.Context) string
	ClientIP                 func(*http.Request) string
	CurrentUser              func(*http.Request) (PublicUser, bool)
	CSRFToken                func(*http.Request, string) string
	ValidateCSRF             func(*http.Request, string) bool
	Option                   func(context.Context, string) (string, error)
	SetOption                func(context.Context, string, string) error
	SaveContent              func(context.Context, ContentWriteInput) (PublicContent, error)
	DeleteContent            func(context.Context, int64) error
	SaveComment              func(context.Context, CommentWriteInput) (PublicComment, error)
	DeleteComment            func(context.Context, int64) error
	Config                   func(context.Context, string) (map[string]string, error)
	PersonalConfig           func(context.Context, string, int64) (map[string]string, error)
	DispatchHook             func(context.Context, string, any) (HookDispatch, error)
	ServiceAvailable         func(string) bool
	CallService              func(context.Context, string, ...any) (any, error)
	NotifyAdmin              func(http.ResponseWriter, *http.Request, ...AdminNotice)
	OpenPluginDB             func(context.Context) (*sql.DB, error)
	PluginDBDialect          func(context.Context) string
	IsIPBanned               func(context.Context, string) bool
	IsURLAllowed             func(context.Context, string) bool
	BanIP                    func(context.Context, string, time.Duration, string) error
	UnbanIP                  func(context.Context, string) error
	WAFStats                 func(context.Context) (WAFStatistics, error)
	GetContentAuthor         func(context.Context, int64) (PublicUser, error)
	ListContentMetas         func(context.Context, int64) ([]PublicMeta, error)
	GetContentFields         func(context.Context, int64) (map[string]any, error)
	SetContentField          func(context.Context, int64, ContentFieldInput) error
	IncrementContentFieldInt func(context.Context, int64, string, int64) (int64, error)
	DeleteContentField       func(context.Context, int64, string) error
	ThumbnailURL             func(context.Context, int64, int, int) (string, error)
	AttachmentMeta           func(context.Context, int64) (AttachmentMetaInfo, error)
	ActiveTheme              func(context.Context) string
	ContentRenderMode        func(context.Context) string
	// PluginActive reports whether a named plugin is currently activated,
	// equivalent to Typecho's Plugin::export()['activated'] lookup.
	PluginActive func(string) bool
	// PluginURL returns the public base URL for a plugin's bundled static
	// assets (served under /plugin/<name>/). When owner is empty the calling
	// plugin's own asset base is returned.
	PluginURL func(ctx context.Context, owner string) string
	// RenderContent returns the rendered HTML of any content by CID, applying
	// the same markdown/autop pipeline and render hooks the frontend uses.
	RenderContent func(context.Context, int64) (template.HTML, error)
	// Excerpt returns a plain-text/HTML excerpt of the given text, honoring the
	// content.excerpt hooks. limit is the maximum rune length.
	Excerpt func(ctx context.Context, text string, limit int) string
	// FeedURL, CommentsFeedURL, XMLRPCURL, LoginURL, RegisterURL, LogoutURL,
	// ProfileURL and ThemeURL expose core-defined route shapes so extensions
	// need not hardcode them. ThemeURL(name, file) resolves a theme asset URL.
	FeedURL         func(context.Context) string
	CommentsFeedURL func(context.Context) string
	XMLRPCURL       func(context.Context) string
	LoginURL        func(context.Context) string
	RegisterURL     func(context.Context) string
	LogoutURL       func(context.Context) string
	ProfileURL      func(context.Context) string
	ThemeURL        func(ctx context.Context, name, file string) string
	// PluginDataDir returns and creates a private on-disk directory for the
	// calling extension under the data directory, for swappable side files such
	// as an IP database that should not be bundled into the binary. It mirrors
	// the theme ThemeEditableDir capability for plugins.
	PluginDataDir func(context.Context) (string, error)
}

type RuntimeHookFunc func(context.Context, *Runtime, any) (any, error)

type ServiceFunc func(context.Context, *Runtime, ...any) (any, error)

type StaticProvider interface {
	PluginStatic() fs.FS
}

type TableDefinition struct {
	Name    string
	Columns []ColumnDefinition
	Indexes []IndexDefinition
}

type Theme struct {
	Name                  string
	DisplayName           string
	Version               string
	Author                string
	Description           string
	Homepage              string
	Screenshot            string
	TemplateList          []string
	Templates             fs.FS
	Static                fs.FS
	Funcs                 template.FuncMap
	Translate             func(lang, key string) string
	ConfigSchema          []FieldSchema
	ContentFields         []FieldSchema
	ConfigValidator       func(map[string]string) map[string]string
	ConfigHandler         func(context.Context, *Runtime, map[string]string, bool) error
	AdminNotices          func(context.Context, *Runtime, map[string]string) []AdminNotice
	AdminPages            []AdminPage
	RenderAdminPage       func(context.Context, *Runtime, string, AdminPageRenderContext) (template.HTML, error)
	HandleAdminPageAction func(context.Context, *Runtime, string, map[string][]string) (AdminPageActionResult, error)
	EnrichComments        func(context.Context, *Runtime, map[string]string, []PublicComment) map[int64]CommentEnrichment
	Capabilities          ThemeCapabilities
	InitRuntime           func(context.Context, *Runtime) error
	AdjustData            func(context.Context, map[string]any) error
	Routes                []Route
	EditableDir           string
	Embedded              bool
}

type ThemeCapabilities struct {
	CommentGuard bool
}

type TrackbackPayload struct {
	Content PublicContent
	Input   any
	Comment PublicComment
	Handled bool
}

type Translator interface {
	Translate(lang, key string) string
}

type UploadHandlePayload struct {
	Name     string
	ParentID int64
	Bucket   string
	Size     int64
	MIME     string
	Open     func() (io.ReadCloser, error)
	Meta     any
	Handled  bool
}

type UploadPayload struct {
	Name     string
	ParentID int64
	Meta     any
}

type UserHashValidatePayload struct {
	Name     string
	Password string
	Hash     string
	User     PublicUser
	Valid    bool
	Handled  bool
}

type UserLoginPayload struct {
	Name      string
	User      PublicUser
	IP        string
	UserAgent string
	Next      string
	Success   bool
	Error     string
	Blocked   bool
	Message   string
}

type UserLogoutPayload struct {
	User      PublicUser
	IP        string
	UserAgent string
}

type UserRegisterPayload struct {
	User      PublicUser
	Input     any
	IP        string
	UserAgent string
	Blocked   bool
	Message   string
}

type WAFPayload struct {
	Request *http.Request
	IP      string
	Path    string
	Blocked bool
	Reason  string
	Handled bool
}

type WAFStatistics struct {
	BannedIPs    int
	AllowedPaths int
	RecentBlocks int64
}

type XMLRPCPingbackPayload struct {
	SourceURI string
	TargetURI string
	Content   PublicContent
	Comment   PublicComment
	Message   string
	Handled   bool
}

type XMLRPCTextPayload struct {
	Method  string
	Content PublicContent
	Text    string
}

type XMLRPCUploadPayload struct {
	Name    string
	Data    []byte
	Result  map[string]any
	Handled bool
}