krz/gitbay
A CLI-first git forge.
clone: git clone https://gitbay.org/krz/gitbay.git
main: internal/httpd/routes.go · raw
1package httpd
2
3import "net/http"
4
5// Route is one entry in the explicit route table. The view-only guarantee is
6// structural: Handler() consults web.mode when building the table, and the
7// route test asserts no mutating route exists in view_only mode.
8type Route struct {
9 Method string
10 Pattern string // without method prefix
11 // Mutating marks routes that can change server state. The git transport
12 // POSTs are not mutating: upload-pack is a pure read, and the
13 // receive-pack endpoint is a static refusal that writes nothing.
14 Mutating bool
15 Handler http.HandlerFunc
16}
17
18// Routes returns the route table for the configured web.mode.
19func (s *Server) Routes() []Route {
20 // Git smart transport (anonymous, public repos only).
21 routes := []Route{
22 {Method: "GET", Pattern: "/{owner}/{repo}/info/refs", Handler: s.infoRefs},
23 {Method: "POST", Pattern: "/{owner}/{repo}/git-upload-pack", Handler: s.uploadPack},
24 {Method: "POST", Pattern: "/{owner}/{repo}/git-receive-pack", Handler: s.receivePackRefusal},
25 }
26
27 // Web UI, read-only. These exist in every mode.
28 routes = append(routes,
29 Route{Method: "GET", Pattern: "/{$}", Handler: s.index},
30 Route{Method: "GET", Pattern: "/static/style.css", Handler: s.stylesheet},
31 Route{Method: "GET", Pattern: "/{owner}", Handler: s.ownerPage},
32 Route{Method: "GET", Pattern: "/{owner}/{repo}", Handler: s.repoHome},
33 Route{Method: "GET", Pattern: "/{owner}/{repo}/tree/{ref}/{path...}", Handler: s.tree},
34 Route{Method: "GET", Pattern: "/{owner}/{repo}/blob/{ref}/{path...}", Handler: s.blob},
35 Route{Method: "GET", Pattern: "/{owner}/{repo}/raw/{ref}/{path...}", Handler: s.raw},
36 Route{Method: "GET", Pattern: "/{owner}/{repo}/log", Handler: s.log},
37 Route{Method: "GET", Pattern: "/{owner}/{repo}/log/{ref}", Handler: s.log},
38 Route{Method: "GET", Pattern: "/{owner}/{repo}/commit/{sha}", Handler: s.commit},
39 Route{Method: "GET", Pattern: "/{owner}/{repo}/refs", Handler: s.refs},
40 Route{Method: "GET", Pattern: "/{owner}/{repo}/archive/{file}", Handler: s.archive},
41 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues", Handler: s.issues},
42 Route{Method: "GET", Pattern: "/{owner}/{repo}/issues/{n}", Handler: s.issue},
43 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs", Handler: s.mrs},
44 Route{Method: "GET", Pattern: "/{owner}/{repo}/mrs/{n}", Handler: s.mr},
45 )
46
47 // The JSON API is its own opt-in surface, independent of web.mode.
48 if s.cfg.API.Enabled {
49 routes = append(routes,
50 Route{Method: "POST", Pattern: "/api/v1/cmd", Mutating: true, Handler: s.apiCmd},
51 )
52 }
53
54 // Account-mode routes exist only when web.mode = "accounts". In
55 // view_only they are never registered — the structural guarantee.
56 if s.cfg.Web.Mode == "accounts" {
57 routes = append(routes,
58 Route{Method: "GET", Pattern: "/login", Handler: s.login, Mutating: true}, // consumes a one-time token
59 Route{Method: "POST", Pattern: "/logout", Mutating: true,
60 Handler: s.checkOrigin(s.logout)},
61 Route{Method: "GET", Pattern: "/new", Handler: s.requireUser(s.newRepoForm)},
62 Route{Method: "POST", Pattern: "/new", Mutating: true,
63 Handler: s.checkOrigin(s.requireUser(s.newRepoSubmit))},
64 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/new", Mutating: true,
65 Handler: s.checkOrigin(s.requireUser(s.issueCreateSubmit))},
66 Route{Method: "POST", Pattern: "/{owner}/{repo}/issues/{n}/comment", Mutating: true,
67 Handler: s.checkOrigin(s.requireUser(s.issueCommentSubmit))},
68 Route{Method: "POST", Pattern: "/{owner}/{repo}/mrs/{n}/comment", Mutating: true,
69 Handler: s.checkOrigin(s.requireUser(s.mrCommentSubmit))},
70 Route{Method: "GET", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}",
71 Handler: s.requireUser(s.editForm)},
72 Route{Method: "POST", Pattern: "/{owner}/{repo}/edit/{ref}/{path...}", Mutating: true,
73 Handler: s.checkOrigin(s.requireUser(s.editSubmit))},
74 )
75 }
76 return routes
77}
78
79func (s *Server) Handler() http.Handler {
80 mux := http.NewServeMux()
81 for _, r := range s.Routes() {
82 mux.HandleFunc(r.Method+" "+r.Pattern, r.Handler)
83 }
84 return mux
85}