web

Documentation

Index

• type Config
  • func (s Config) EmailService() email.Service
  • func (s Config) Valid() error
• type DataAccess
  • func NewDBDataAccess(ctx context.Context, ps problems.Store, DB *sql.DB, ms email.Service) (*DataAccess, error)
  • func NewDemoDataAccess(ctx context.Context, ps problems.Store, ms email.Service) (*DataAccess, error)
• type DatabaseConfig
  • func (db DatabaseConfig) Connect() (*sql.DB, error)
  • func (db DatabaseConfig) ConnectAndPing(log *slog.Logger) (*sql.DB, error)
• type GoogleAuthConfig
• type Mode
  • func (m Mode) UsesDB() bool
  • func (m Mode) Valid() bool
• type SMTPConfig
• type SendgridConfig
• type Server
  • func NewServer(logger *slog.Logger, cfg Config, dataAccess DataAccess, db *sql.DB) (*Server, error)
  • func (s *Server) Run(ctx context.Context) error
  • func (s *Server) SetupEcho(ctx context.Context, e *echo.Echo)
  • func (s *Server) SetupEnvironment(ctx context.Context) error
  • func (s *Server) StartBackgroundJobs(ctx context.Context)

Types

type Config

type Config struct {
	Mode     Mode   `mapstructure:"mode" yaml:"mode"`
	Url      string `mapstructure:"url" yaml:"url"`
	Port     string `mapstructure:"port" yaml:"port"`
	TimeZone string `mapstructure:"time_zone" yaml:"time_zone"`

	CookieSecret string `mapstructure:"cookie_secret" yaml:"cookie_secret"`

	GoogleAuth GoogleAuthConfig `mapstructure:"google_auth" yaml:"google_auth"`

	Sendgrid SendgridConfig `yaml:"sendgrid" mapstructure:"sendgrid"`

	SMTP SMTPConfig `yaml:"smtp" mapstructure:"smtp"`

	DatabaseConfig `yaml:"db" mapstructure:"db"`
}

func (Config) EmailService

func (s Config) EmailService() email.Service

func (Config) Valid

func (s Config) Valid() error

type DataAccess

type DataAccess struct {
	ProblemStore  problems.Store
	MailService   email.Service
	PartialsStore templates.Store

	Categories          njudge.Categories
	Tags                njudge.Tags
	Problems            njudge.Problems
	Users               njudge.Users
	Submissions         njudge.Submissions
	SolvedStatusQuery   njudge.SolvedStatusQuery
	ProblemInfoQuery    njudge.ProblemInfoQuery
	ProblemQuery        njudge.ProblemQuery
	ProblemListQuery    njudge.ProblemListQuery
	SubmissionListQuery njudge.SubmissionListQuery
	Problemsets         njudge.Problemsets

	SubmitService             *njudge.SubmitService
	TagsService               njudge.TagsService
	TaskArchiveService        njudge.TaskArchiveService
	ProblemsetRanklistService njudge.ProblemsetRanklistService
}

DataAccess provides access to the business logic in handlers

func NewDBDataAccess

func NewDBDataAccess(ctx context.Context, ps problems.Store, DB *sql.DB, ms email.Service) (*DataAccess, error)

NewDBDataAccess creates a DataAccess backed by "database"-kind business logic (internal/njudge/db)

func NewDemoDataAccess

func NewDemoDataAccess(ctx context.Context, ps problems.Store, ms email.Service) (*DataAccess, error)

NewDemoDataAccess creates in-memory (internal/njudge/memory) "demo" data

type DatabaseConfig

type DatabaseConfig struct {
	User     string `mapstructure:"user" yaml:"user"`
	Password string `mapstructure:"password" yaml:"password"`
	Host     string `mapstructure:"host" yaml:"host"`
	Name     string `mapstructure:"name" yaml:"name"`
	Port     int    `mapstructure:"port" yaml:"port"`
	SSLMode  bool   `mapstructure:"ssl_mode" yaml:"ssl_mode"`
}

func (DatabaseConfig) Connect

func (db DatabaseConfig) Connect() (*sql.DB, error)

func (DatabaseConfig) ConnectAndPing

func (db DatabaseConfig) ConnectAndPing(log *slog.Logger) (*sql.DB, error)

type GoogleAuthConfig

type GoogleAuthConfig struct {
	Enabled   bool   `mapstructure:"enabled" yaml:"enabled"`
	ClientKey string `mapstructure:"client_key" yaml:"client_key"`
	Secret    string `mapstructure:"secret" yaml:"secret"`
}

type Mode

type Mode string

const (
	ModeDebug       Mode = "debug"
	ModeDevelopment Mode = "development"
	ModeDemo        Mode = "demo"
	ModeProduction  Mode = "production"
)

func (Mode) UsesDB

func (m Mode) UsesDB() bool

func (Mode) Valid

func (m Mode) Valid() bool

type SMTPConfig

type SMTPConfig struct {
	Enabled             bool   `yaml:"enabled" mapstructure:"enabled"`
	MailAccount         string `yaml:"mail_account" mapstructure:"mail_account"`
	MailServerHost      string `yaml:"mail_server" mapstructure:"mail_server"`
	MailServerPort      int    `yaml:"mail_port" mapstructure:"mail_port"`
	MailAccountPassword string `yaml:"mail_password" mapstructure:"mail_password"`
}

type SendgridConfig

type SendgridConfig struct {
	Enabled       bool   `yaml:"enabled" mapstructure:"enabled"`
	ApiKey        string `yaml:"api_key" mapstructure:"api_key"`
	SenderName    string `yaml:"sender_name" mapstructure:"sender_name"`
	SenderAddress string `yaml:"sender_address" mapstructure:"sender_address"`
}

type Server

type Server struct {
	Logger *slog.Logger
	Config
	DataAccess
	DB *sql.DB
}

func NewServer

func NewServer(logger *slog.Logger, cfg Config, dataAccess DataAccess, db *sql.DB) (*Server, error)

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

func (*Server) SetupEcho

func (s *Server) SetupEcho(ctx context.Context, e *echo.Echo)

func (*Server) SetupEnvironment

func (s *Server) SetupEnvironment(ctx context.Context) error

func (*Server) StartBackgroundJobs

func (s *Server) StartBackgroundJobs(ctx context.Context)