web

package
v0.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 18, 2024 License: AGPL-3.0 Imports: 46 Imported by: 0

Documentation

Overview

Package web is the client-side router that manages the website If the `server` package interacts with the DB, the `web` package interacts with the user

Index

Constants

View Source 
const (
	PblistCntCacheKey = WebCtx("pblist_cache")
)

Variables

View Source 
var (
	DonationsEnabled = config.GenFlag[bool]("frontend.donations.enabled", true, "Donations page enabled")
	DonationsNag     = config.GenFlag[bool]("frontend.donation.frontpage_nag", true, "Donations front page notification")

	MainPageLogin = config.GenFlag[bool]("feature.frontend.main_page_login", false, "Login modal on front page")

	NavbarProblems    = config.GenFlag[bool]("feature.frontend.navbar.problems_btn", true, "Navbar button: Problems")
	NavbarContests    = config.GenFlag[bool]("feature.frontend.navbar.contests_btn", false, "Navbar button: Contests")
	NavbarSubmissions = config.GenFlag[bool]("feature.frontend.navbar.submissions_btn", true, "Navbar button: Submissions")

	PinnedProblemList = config.GenFlag[int]("frontend.front_page.pinned_problem_list", 0, "Pinned problem list (front page sidebar)")
	RootProblemList   = config.GenFlag[int]("frontend.front_page.root_problem_list", 0, "Root problem list (front page main content)")
)
View Source 
var (
	CCDisclaimer    = config.GenFlag("frontend.footer.cc_disclaimer", true, "CC disclaimer in footer")
	DiscordInviteID = config.GenFlag("frontend.footer.discord_id", "Qa6Ytgh", "Invite ID for Discord server")

	AllSubsPage = config.GenFlag("feature.frontend.all_subs_page", true, "Anyone can view all submissions")

	FrontPageProblems  = config.GenFlag("feature.frontend.front_page_pbs", true, "Show problems on front page")
	FrontPagePbDetails = config.GenFlag("feature.frontend.front_page_pbs_links", true, "On the front page problems, show links to other resources")

	FrontPageAnnouncement = config.GenFlag("frontend.front_page_announcement", "default", `Custom front page announcement ("default" = default text)`)

	SidebarContests = config.GenFlag("feature.frontend.front_page_csidebar", true, "Show contests in sidebar on the front page")
	ShowTrending    = config.GenFlag("frontend.front_page.show_trending", true, "Show trending problems on the front page sidebar")

	ForceLogin = config.GenFlag("behavior.force_authed", false, "Force authentication when accessing website")

	GoatCounterDomain = config.GenFlag("feature.analytics.goat_prefix", "https://goat.kilonova.ro", "URL prefix for GoatCounter analytics")

	NavbarBranding = config.GenFlag("frontend.navbar.branding", "Kilonova", "Branding in navbar")

	FeedbackURL    = config.GenFlag("feature.frontend.feedback_url", "", "Feedback URL for main page")
	QuickSearchBox = config.GenFlag("feature.frontend.quick_search", false, "Quick search box on main page")
)

Functions

func ReadOrTruncate 

func ReadOrTruncate(r io.Reader) ([]byte, bool)

Types

type AttachmentEditorParams 

type AttachmentEditorParams struct {
	Attachments []*kilonova.Attachment
	Problem     *kilonova.Problem
	BlogPost    *kilonova.BlogPost

	APIPrefix string
}

type AuditLogParams 

type AuditLogParams struct {
	Logs     []*kilonova.AuditLog
	Page     int
	NumPages int
}

type BlogPostIndexParams 

type BlogPostIndexParams struct {
	Posts   []*kilonova.BlogPost
	Authors map[int]*kilonova.UserBrief

	Page     int
	NumPages int
}

type BlogPostParams 

type BlogPostParams struct {
	Topbar *PostTopbar

	StatementEditor  *StatementEditorParams
	AttachmentEditor *AttachmentEditorParams

	Attachments []*kilonova.Attachment

	Statement    template.HTML
	StatementAtt *kilonova.Attachment
	Languages    map[string]eval.Language
	Variants     []*kilonova.StatementVariant

	SelectedVariant *kilonova.StatementVariant
}

type ContestInviteParams 

type ContestInviteParams struct {
	Contest *kilonova.Contest
	Invite  *kilonova.ContestInvitation

	AlreadyRegistered bool

	// may be nil
	Inviter *kilonova.UserBrief
}

type ContestParams 

type ContestParams struct {
	Topbar *ProblemTopbar

	Contest *kilonova.Contest

	ContestInvitations []*kilonova.ContestInvitation
	MOSSResults        []*kilonova.MOSSSubmission
}

type ContestsIndexParams 

type ContestsIndexParams struct {
	Contests []*kilonova.Contest

	Page string

	ContestCount int
	PageNum      int
}

type DonateParams 

type DonateParams struct {
	Donations []*kilonova.Donation

	Status   string
	BMACName string
	PayPalID string
}

type IndexParams 

type IndexParams struct {
	FutureContests  []*kilonova.Contest
	RunningContests []*kilonova.Contest

	ChildProblemLists []*kilonova.ProblemList

	HotProblems  []*kilonova.ScoredProblem
	MoreProblems bool

	PinnedLists []*kilonova.ProblemList
}

type MarkdownParams 

type MarkdownParams struct {
	Markdown template.HTML
	Title    string
}

type PasswordResetParams 

type PasswordResetParams struct {
	User      *kilonova.UserFull
	RequestID string
}

type PasteParams 

type PasteParams struct {
	Paste *kilonova.SubmissionPaste

	FullSub *sudoapi.FullSubmission
}

type PblistParams 

type PblistParams struct {
	Pblist *kilonova.ProblemList
	Open   bool
}

type PostTopbar 

type PostTopbar struct {
	IsPostEditor bool

	Post *kilonova.BlogPost

	Page string
}

type ProblemArchiveParams added in v0.25.0 

type ProblemArchiveParams struct {
	Topbar *ProblemTopbar

	Tests   []*kilonova.Test
	Problem *kilonova.Problem
}

type ProblemEditParams 

type ProblemEditParams struct {
	Problem *kilonova.Problem
	Topbar  *ProblemTopbar

	Checklist *kilonova.ProblemChecklist

	AttachmentEditor *AttachmentEditorParams
	StatementEditor  *StatementEditorParams
}

type ProblemListParams 

type ProblemListParams struct {
	ProblemList *kilonova.ProblemList
	Lists       []*kilonova.ProblemList

	RootProblemList int
}

type ProblemListProgressParams 

type ProblemListProgressParams struct {
	ProblemList *sudoapi.FullProblemList
	CheckedUser *kilonova.UserBrief
}

type ProblemListingParams 

type ProblemListingParams struct {
	Problems []*kilonova.ScoredProblem
	ShowID   bool

	ShowPublished bool

	ContestIDScore int

	ListID int
}

type ProblemParams 

type ProblemParams struct {
	Topbar *ProblemTopbar

	Problem     *kilonova.Problem
	Attachments []*kilonova.Attachment
	Tags        []*kilonova.Tag

	Submissions *sudoapi.Submissions

	Statement template.HTML
	Languages map[string]eval.Language
	Variants  []*kilonova.StatementVariant

	SelectedVariant *kilonova.StatementVariant
}

type ProblemSearchParams 

type ProblemSearchParams struct {
	ProblemList *kilonova.ProblemList

	Results   []*sudoapi.FullProblem
	Groups    []*kilonova.TagGroup
	GroupTags []*kilonova.Tag
	Count     int
}

type ProblemTopbar 

type ProblemTopbar struct {
	IsProblemEditor bool
	IsContestEditor bool
	CanViewTests    bool

	Contest *kilonova.Contest
	Problem *kilonova.Problem

	URLPrefix string

	Page   string
	PageID int
}

type ProblemTopbarParams 

type ProblemTopbarParams struct {
	Topbar *ProblemTopbar

	Languages map[string]eval.Language
	Problem   *kilonova.Problem
}

type ProfileParams 

type ProfileParams struct {
	ContentUser       *kilonova.UserFull
	SolvedProblems    []*sudoapi.FullProblem
	SolvedCount       int
	AttemptedProblems []*sudoapi.FullProblem
	AttemptedCount    int

	ChangeHistory []*kilonova.UsernameChange
}

type SessionsParams 

type SessionsParams struct {
	ContentUser *kilonova.UserFull
	Sessions    []*sudoapi.Session
	Page        int
	NumPages    int
}

type StatementEditorParams 

type StatementEditorParams struct {
	Variants []*kilonova.StatementVariant
	Variant  *kilonova.StatementVariant
	Data     string
	Att      *kilonova.Attachment

	APIPrefix string
}

type StatusParams 

type StatusParams struct {
	Code    int
	Message string
}

type SubParams 

type SubParams struct {
	Submission *kilonova.FullSubmission
}

type SubTaskEditParams 

type SubTaskEditParams struct {
	Problem *kilonova.Problem
	SubTask *kilonova.SubTask
	Topbar  *ProblemTopbar
	// contains filtered or unexported fields
}

func (*SubTaskEditParams) TestInSubTask 

func (s *SubTaskEditParams) TestInSubTask(test *kilonova.Test) bool

func (*SubTaskEditParams) TestSubTasks 

func (s *SubTaskEditParams) TestSubTasks(id int) string

type TagPageParams 

type TagPageParams struct {
	Tag *kilonova.Tag

	RelevantTags []*kilonova.Tag
	Problems     []*sudoapi.FullProblem
	ProblemCount int
}

type TestEditParams 

type TestEditParams struct {
	Problem *kilonova.Problem
	Test    *kilonova.Test
	Topbar  *ProblemTopbar
	// contains filtered or unexported fields
}

func (*TestEditParams) GetFullTests 

func (t *TestEditParams) GetFullTests() testDataType

type VerifiedEmailParams 

type VerifiedEmailParams struct {
	ContentUser *kilonova.UserBrief
}

type Web 

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

Web is the struct representing this whole package

func NewWeb 

func NewWeb(base *sudoapi.BaseAPI) *Web

NewWeb returns a new web instance

func (*Web) Handler 

func (rt *Web) Handler() http.Handler

Handler returns a http.Handler

func (*Web) ProblemEditRouter 

func (rt *Web) ProblemEditRouter(r chi.Router)

Handler is the http handler to be attached The caller should ensure a User and a Problem are attached to the context

func (*Web) SubTaskValidator 

func (rt *Web) SubTaskValidator() func(next http.Handler) http.Handler

func (*Web) TestIDValidator 

func (rt *Web) TestIDValidator() func(next http.Handler) http.Handler

func (*Web) ValidateAttachmentID 

func (rt *Web) ValidateAttachmentID(next http.Handler) http.Handler

ValidateAttachmentID makes sure the attachment ID is a valid uint

func (*Web) ValidateBlogPostSlug 

func (rt *Web) ValidateBlogPostSlug(next http.Handler) http.Handler

ValidateBlogPostSlug makes sure the blog post slug is a valid one

func (*Web) ValidateBlogPostVisible 

func (rt *Web) ValidateBlogPostVisible(next http.Handler) http.Handler

ValidateBlogPostVisible checks if the post from context is visible from the logged in user

func (*Web) ValidateContestID 

func (rt *Web) ValidateContestID(next http.Handler) http.Handler

ValidateContestID makes sure the contest ID is a valid uint

func (*Web) ValidateContestVisible 

func (rt *Web) ValidateContestVisible(next http.Handler) http.Handler

ValidateContestVisible checks if the problem from context is visible from the logged in user

func (*Web) ValidateListID 

func (rt *Web) ValidateListID(next http.Handler) http.Handler

ValidateListID makes sure the list ID is a valid uint

func (*Web) ValidatePasteID 

func (rt *Web) ValidatePasteID(next http.Handler) http.Handler

ValidatePasteID puts the ID and the Paste in the router context

func (*Web) ValidateProblemFullyVisible 

func (rt *Web) ValidateProblemFullyVisible(next http.Handler) http.Handler

ValidateProblemFullyVisible checks if the problem from context is FULLY visible from the logged in user

func (*Web) ValidateProblemID 

func (rt *Web) ValidateProblemID(next http.Handler) http.Handler

ValidateProblemID makes sure the problem ID is a valid uint

func (*Web) ValidateProblemVisible 

func (rt *Web) ValidateProblemVisible(next http.Handler) http.Handler

ValidateProblemVisible checks if the problem from context is visible from the logged in user

func (*Web) ValidateSubmissionID 

func (rt *Web) ValidateSubmissionID(next http.Handler) http.Handler

ValidateSubmissionID puts the ID and the Submission in the router context

func (*Web) ValidateTagID 

func (rt *Web) ValidateTagID(next http.Handler) http.Handler

ValidateTagID makes sure the tag ID is a valid uint

type WebCtx 

type WebCtx string

type WebLanguage 

type WebLanguage struct {
	Disabled bool   `json:"disabled"`
	Name     string `json:"name"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.