web.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package cmd
  5. import (
  6. "crypto/tls"
  7. "fmt"
  8. "io"
  9. "net"
  10. "net/http"
  11. "net/http/fcgi"
  12. "os"
  13. "path/filepath"
  14. "strings"
  15. "github.com/go-macaron/binding"
  16. "github.com/go-macaron/cache"
  17. "github.com/go-macaron/captcha"
  18. "github.com/go-macaron/csrf"
  19. "github.com/go-macaron/gzip"
  20. "github.com/go-macaron/i18n"
  21. "github.com/go-macaron/session"
  22. "github.com/go-macaron/toolbox"
  23. "github.com/prometheus/client_golang/prometheus/promhttp"
  24. "github.com/unknwon/com"
  25. "github.com/urfave/cli"
  26. "gopkg.in/macaron.v1"
  27. log "unknwon.dev/clog/v2"
  28. embedConf "gogs.io/gogs/conf"
  29. "gogs.io/gogs/internal/app"
  30. "gogs.io/gogs/internal/conf"
  31. "gogs.io/gogs/internal/context"
  32. "gogs.io/gogs/internal/db"
  33. "gogs.io/gogs/internal/form"
  34. "gogs.io/gogs/internal/osutil"
  35. "gogs.io/gogs/internal/route"
  36. "gogs.io/gogs/internal/route/admin"
  37. apiv1 "gogs.io/gogs/internal/route/api/v1"
  38. "gogs.io/gogs/internal/route/dev"
  39. "gogs.io/gogs/internal/route/lfs"
  40. "gogs.io/gogs/internal/route/org"
  41. "gogs.io/gogs/internal/route/repo"
  42. "gogs.io/gogs/internal/route/user"
  43. "gogs.io/gogs/internal/template"
  44. "gogs.io/gogs/public"
  45. "gogs.io/gogs/templates"
  46. )
  47. var Web = cli.Command{
  48. Name: "web",
  49. Usage: "Start web server",
  50. Description: `Gogs web server is the only thing you need to run,
  51. and it takes care of all the other things for you`,
  52. Action: runWeb,
  53. Flags: []cli.Flag{
  54. stringFlag("port, p", "3000", "Temporary port number to prevent conflict"),
  55. stringFlag("config, c", "", "Custom configuration file path"),
  56. },
  57. }
  58. // newMacaron initializes Macaron instance.
  59. func newMacaron() *macaron.Macaron {
  60. m := macaron.New()
  61. if !conf.Server.DisableRouterLog {
  62. m.Use(macaron.Logger())
  63. }
  64. m.Use(macaron.Recovery())
  65. if conf.Server.EnableGzip {
  66. m.Use(gzip.Gziper())
  67. }
  68. if conf.Server.Protocol == "fcgi" {
  69. m.SetURLPrefix(conf.Server.Subpath)
  70. }
  71. // Register custom middleware first to make it possible to override files under "public".
  72. m.Use(macaron.Static(
  73. filepath.Join(conf.CustomDir(), "public"),
  74. macaron.StaticOptions{
  75. SkipLogging: conf.Server.DisableRouterLog,
  76. },
  77. ))
  78. var publicFs http.FileSystem
  79. if !conf.Server.LoadAssetsFromDisk {
  80. publicFs = http.FS(public.Files)
  81. }
  82. m.Use(macaron.Static(
  83. filepath.Join(conf.WorkDir(), "public"),
  84. macaron.StaticOptions{
  85. ETag: true,
  86. SkipLogging: conf.Server.DisableRouterLog,
  87. FileSystem: publicFs,
  88. },
  89. ))
  90. m.Use(macaron.Static(
  91. conf.Picture.AvatarUploadPath,
  92. macaron.StaticOptions{
  93. ETag: true,
  94. Prefix: conf.UsersAvatarPathPrefix,
  95. SkipLogging: conf.Server.DisableRouterLog,
  96. },
  97. ))
  98. m.Use(macaron.Static(
  99. conf.Picture.RepositoryAvatarUploadPath,
  100. macaron.StaticOptions{
  101. ETag: true,
  102. Prefix: db.REPO_AVATAR_URL_PREFIX,
  103. SkipLogging: conf.Server.DisableRouterLog,
  104. },
  105. ))
  106. renderOpt := macaron.RenderOptions{
  107. Directory: filepath.Join(conf.WorkDir(), "templates"),
  108. AppendDirectories: []string{filepath.Join(conf.CustomDir(), "templates")},
  109. Funcs: template.FuncMap(),
  110. IndentJSON: macaron.Env != macaron.PROD,
  111. }
  112. if !conf.Server.LoadAssetsFromDisk {
  113. renderOpt.TemplateFileSystem = templates.NewTemplateFileSystem("", renderOpt.AppendDirectories[0])
  114. }
  115. m.Use(macaron.Renderer(renderOpt))
  116. localeNames, err := embedConf.FileNames("locale")
  117. if err != nil {
  118. log.Fatal("Failed to list locale files: %v", err)
  119. }
  120. localeFiles := make(map[string][]byte)
  121. for _, name := range localeNames {
  122. localeFiles[name], err = embedConf.Files.ReadFile("locale/" + name)
  123. if err != nil {
  124. log.Fatal("Failed to read locale file %q: %v", name, err)
  125. }
  126. }
  127. m.Use(i18n.I18n(i18n.Options{
  128. SubURL: conf.Server.Subpath,
  129. Files: localeFiles,
  130. CustomDirectory: filepath.Join(conf.CustomDir(), "conf", "locale"),
  131. Langs: conf.I18n.Langs,
  132. Names: conf.I18n.Names,
  133. DefaultLang: "en-US",
  134. Redirect: true,
  135. }))
  136. m.Use(cache.Cacher(cache.Options{
  137. Adapter: conf.Cache.Adapter,
  138. AdapterConfig: conf.Cache.Host,
  139. Interval: conf.Cache.Interval,
  140. }))
  141. m.Use(captcha.Captchaer(captcha.Options{
  142. SubURL: conf.Server.Subpath,
  143. }))
  144. m.Use(toolbox.Toolboxer(m, toolbox.Options{
  145. HealthCheckFuncs: []*toolbox.HealthCheckFuncDesc{
  146. {
  147. Desc: "Database connection",
  148. Func: db.Ping,
  149. },
  150. },
  151. }))
  152. return m
  153. }
  154. func runWeb(c *cli.Context) error {
  155. err := route.GlobalInit(c.String("config"))
  156. if err != nil {
  157. log.Fatal("Failed to initialize application: %v", err)
  158. }
  159. m := newMacaron()
  160. reqSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: true})
  161. ignSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: conf.Auth.RequireSigninView})
  162. reqSignOut := context.Toggle(&context.ToggleOptions{SignOutRequired: true})
  163. bindIgnErr := binding.BindIgnErr
  164. m.SetAutoHead(true)
  165. m.Group("", func() {
  166. m.Get("/", ignSignIn, route.Home)
  167. m.Group("/explore", func() {
  168. m.Get("", func(c *context.Context) {
  169. c.Redirect(conf.Server.Subpath + "/explore/repos")
  170. })
  171. m.Get("/repos", route.ExploreRepos)
  172. m.Get("/users", route.ExploreUsers)
  173. m.Get("/organizations", route.ExploreOrganizations)
  174. }, ignSignIn)
  175. m.Combo("/install", route.InstallInit).Get(route.Install).
  176. Post(bindIgnErr(form.Install{}), route.InstallPost)
  177. m.Get("/^:type(issues|pulls)$", reqSignIn, user.Issues)
  178. // ***** START: User *****
  179. m.Group("/user", func() {
  180. m.Group("/login", func() {
  181. m.Combo("").Get(user.Login).
  182. Post(bindIgnErr(form.SignIn{}), user.LoginPost)
  183. m.Combo("/two_factor").Get(user.LoginTwoFactor).Post(user.LoginTwoFactorPost)
  184. m.Combo("/two_factor_recovery_code").Get(user.LoginTwoFactorRecoveryCode).Post(user.LoginTwoFactorRecoveryCodePost)
  185. })
  186. m.Get("/sign_up", user.SignUp)
  187. m.Post("/sign_up", bindIgnErr(form.Register{}), user.SignUpPost)
  188. m.Get("/reset_password", user.ResetPasswd)
  189. m.Post("/reset_password", user.ResetPasswdPost)
  190. }, reqSignOut)
  191. m.Group("/user/settings", func() {
  192. m.Get("", user.Settings)
  193. m.Post("", bindIgnErr(form.UpdateProfile{}), user.SettingsPost)
  194. m.Combo("/avatar").Get(user.SettingsAvatar).
  195. Post(binding.MultipartForm(form.Avatar{}), user.SettingsAvatarPost)
  196. m.Post("/avatar/delete", user.SettingsDeleteAvatar)
  197. m.Combo("/email").Get(user.SettingsEmails).
  198. Post(bindIgnErr(form.AddEmail{}), user.SettingsEmailPost)
  199. m.Post("/email/delete", user.DeleteEmail)
  200. m.Get("/password", user.SettingsPassword)
  201. m.Post("/password", bindIgnErr(form.ChangePassword{}), user.SettingsPasswordPost)
  202. m.Combo("/ssh").Get(user.SettingsSSHKeys).
  203. Post(bindIgnErr(form.AddSSHKey{}), user.SettingsSSHKeysPost)
  204. m.Post("/ssh/delete", user.DeleteSSHKey)
  205. m.Group("/security", func() {
  206. m.Get("", user.SettingsSecurity)
  207. m.Combo("/two_factor_enable").Get(user.SettingsTwoFactorEnable).
  208. Post(user.SettingsTwoFactorEnablePost)
  209. m.Combo("/two_factor_recovery_codes").Get(user.SettingsTwoFactorRecoveryCodes).
  210. Post(user.SettingsTwoFactorRecoveryCodesPost)
  211. m.Post("/two_factor_disable", user.SettingsTwoFactorDisable)
  212. })
  213. m.Group("/repositories", func() {
  214. m.Get("", user.SettingsRepos)
  215. m.Post("/leave", user.SettingsLeaveRepo)
  216. })
  217. m.Group("/organizations", func() {
  218. m.Get("", user.SettingsOrganizations)
  219. m.Post("/leave", user.SettingsLeaveOrganization)
  220. })
  221. m.Combo("/applications").Get(user.SettingsApplications).
  222. Post(bindIgnErr(form.NewAccessToken{}), user.SettingsApplicationsPost)
  223. m.Post("/applications/delete", user.SettingsDeleteApplication)
  224. m.Route("/delete", "GET,POST", user.SettingsDelete)
  225. }, reqSignIn, func(c *context.Context) {
  226. c.Data["PageIsUserSettings"] = true
  227. })
  228. m.Group("/user", func() {
  229. m.Any("/activate", user.Activate)
  230. m.Any("/activate_email", user.ActivateEmail)
  231. m.Get("/email2user", user.Email2User)
  232. m.Get("/forget_password", user.ForgotPasswd)
  233. m.Post("/forget_password", user.ForgotPasswdPost)
  234. m.Post("/logout", user.SignOut)
  235. })
  236. // ***** END: User *****
  237. reqAdmin := context.Toggle(&context.ToggleOptions{SignInRequired: true, AdminRequired: true})
  238. // ***** START: Admin *****
  239. m.Group("/admin", func() {
  240. m.Combo("").Get(admin.Dashboard).Post(admin.Operation) // "/admin"
  241. m.Get("/config", admin.Config)
  242. m.Post("/config/test_mail", admin.SendTestMail)
  243. m.Get("/monitor", admin.Monitor)
  244. m.Group("/users", func() {
  245. m.Get("", admin.Users)
  246. m.Combo("/new").Get(admin.NewUser).Post(bindIgnErr(form.AdminCrateUser{}), admin.NewUserPost)
  247. m.Combo("/:userid").Get(admin.EditUser).Post(bindIgnErr(form.AdminEditUser{}), admin.EditUserPost)
  248. m.Post("/:userid/delete", admin.DeleteUser)
  249. })
  250. m.Group("/orgs", func() {
  251. m.Get("", admin.Organizations)
  252. })
  253. m.Group("/repos", func() {
  254. m.Get("", admin.Repos)
  255. m.Post("/delete", admin.DeleteRepo)
  256. })
  257. m.Group("/auths", func() {
  258. m.Get("", admin.Authentications)
  259. m.Combo("/new").Get(admin.NewAuthSource).Post(bindIgnErr(form.Authentication{}), admin.NewAuthSourcePost)
  260. m.Combo("/:authid").Get(admin.EditAuthSource).
  261. Post(bindIgnErr(form.Authentication{}), admin.EditAuthSourcePost)
  262. m.Post("/:authid/delete", admin.DeleteAuthSource)
  263. })
  264. m.Group("/notices", func() {
  265. m.Get("", admin.Notices)
  266. m.Post("/delete", admin.DeleteNotices)
  267. m.Get("/empty", admin.EmptyNotices)
  268. })
  269. }, reqAdmin)
  270. // ***** END: Admin *****
  271. m.Group("", func() {
  272. m.Group("/:username", func() {
  273. m.Get("", user.Profile)
  274. m.Get("/followers", user.Followers)
  275. m.Get("/following", user.Following)
  276. m.Get("/stars", user.Stars)
  277. }, context.InjectParamsUser())
  278. m.Get("/attachments/:uuid", func(c *context.Context) {
  279. attach, err := db.GetAttachmentByUUID(c.Params(":uuid"))
  280. if err != nil {
  281. c.NotFoundOrError(err, "get attachment by UUID")
  282. return
  283. } else if !com.IsFile(attach.LocalPath()) {
  284. c.NotFound()
  285. return
  286. }
  287. fr, err := os.Open(attach.LocalPath())
  288. if err != nil {
  289. c.Error(err, "open attachment file")
  290. return
  291. }
  292. defer fr.Close()
  293. c.Header().Set("Content-Security-Policy", "default-src 'none'; style-src 'unsafe-inline'; sandbox")
  294. c.Header().Set("Cache-Control", "public,max-age=86400")
  295. c.Header().Set("Content-Disposition", fmt.Sprintf(`inline; filename="%s"`, attach.Name))
  296. if _, err = io.Copy(c.Resp, fr); err != nil {
  297. c.Error(err, "copy from file to response")
  298. return
  299. }
  300. })
  301. m.Post("/issues/attachments", repo.UploadIssueAttachment)
  302. m.Post("/releases/attachments", repo.UploadReleaseAttachment)
  303. }, ignSignIn)
  304. m.Group("/:username", func() {
  305. m.Post("/action/:action", user.Action)
  306. }, reqSignIn, context.InjectParamsUser())
  307. if macaron.Env == macaron.DEV {
  308. m.Get("/template/*", dev.TemplatePreview)
  309. }
  310. reqRepoAdmin := context.RequireRepoAdmin()
  311. reqRepoWriter := context.RequireRepoWriter()
  312. webhookRoutes := func() {
  313. m.Group("", func() {
  314. m.Get("", repo.Webhooks)
  315. m.Post("/delete", repo.DeleteWebhook)
  316. m.Get("/:type/new", repo.WebhooksNew)
  317. m.Post("/gogs/new", bindIgnErr(form.NewWebhook{}), repo.WebhooksNewPost)
  318. m.Post("/slack/new", bindIgnErr(form.NewSlackHook{}), repo.WebhooksSlackNewPost)
  319. m.Post("/discord/new", bindIgnErr(form.NewDiscordHook{}), repo.WebhooksDiscordNewPost)
  320. m.Post("/dingtalk/new", bindIgnErr(form.NewDingtalkHook{}), repo.WebhooksDingtalkNewPost)
  321. m.Get("/:id", repo.WebhooksEdit)
  322. m.Post("/gogs/:id", bindIgnErr(form.NewWebhook{}), repo.WebhooksEditPost)
  323. m.Post("/slack/:id", bindIgnErr(form.NewSlackHook{}), repo.WebhooksSlackEditPost)
  324. m.Post("/discord/:id", bindIgnErr(form.NewDiscordHook{}), repo.WebhooksDiscordEditPost)
  325. m.Post("/dingtalk/:id", bindIgnErr(form.NewDingtalkHook{}), repo.WebhooksDingtalkEditPost)
  326. }, repo.InjectOrgRepoContext())
  327. }
  328. // ***** START: Organization *****
  329. m.Group("/org", func() {
  330. m.Group("", func() {
  331. m.Get("/create", org.Create)
  332. m.Post("/create", bindIgnErr(form.CreateOrg{}), org.CreatePost)
  333. }, func(c *context.Context) {
  334. if !c.User.CanCreateOrganization() {
  335. c.NotFound()
  336. }
  337. })
  338. m.Group("/:org", func() {
  339. m.Get("/dashboard", user.Dashboard)
  340. m.Get("/^:type(issues|pulls)$", user.Issues)
  341. m.Get("/members", org.Members)
  342. m.Get("/members/action/:action", org.MembersAction)
  343. m.Get("/teams", org.Teams)
  344. }, context.OrgAssignment(true))
  345. m.Group("/:org", func() {
  346. m.Get("/teams/:team", org.TeamMembers)
  347. m.Get("/teams/:team/repositories", org.TeamRepositories)
  348. m.Route("/teams/:team/action/:action", "GET,POST", org.TeamsAction)
  349. m.Route("/teams/:team/action/repo/:action", "GET,POST", org.TeamsRepoAction)
  350. }, context.OrgAssignment(true, false, true))
  351. m.Group("/:org", func() {
  352. m.Get("/teams/new", org.NewTeam)
  353. m.Post("/teams/new", bindIgnErr(form.CreateTeam{}), org.NewTeamPost)
  354. m.Get("/teams/:team/edit", org.EditTeam)
  355. m.Post("/teams/:team/edit", bindIgnErr(form.CreateTeam{}), org.EditTeamPost)
  356. m.Post("/teams/:team/delete", org.DeleteTeam)
  357. m.Group("/settings", func() {
  358. m.Combo("").Get(org.Settings).
  359. Post(bindIgnErr(form.UpdateOrgSetting{}), org.SettingsPost)
  360. m.Post("/avatar", binding.MultipartForm(form.Avatar{}), org.SettingsAvatar)
  361. m.Post("/avatar/delete", org.SettingsDeleteAvatar)
  362. m.Group("/hooks", webhookRoutes)
  363. m.Route("/delete", "GET,POST", org.SettingsDelete)
  364. })
  365. m.Route("/invitations/new", "GET,POST", org.Invitation)
  366. }, context.OrgAssignment(true, true))
  367. }, reqSignIn)
  368. // ***** END: Organization *****
  369. // ***** START: Repository *****
  370. m.Group("/repo", func() {
  371. m.Get("/create", repo.Create)
  372. m.Post("/create", bindIgnErr(form.CreateRepo{}), repo.CreatePost)
  373. m.Get("/migrate", repo.Migrate)
  374. m.Post("/migrate", bindIgnErr(form.MigrateRepo{}), repo.MigratePost)
  375. m.Combo("/fork/:repoid").Get(repo.Fork).
  376. Post(bindIgnErr(form.CreateRepo{}), repo.ForkPost)
  377. }, reqSignIn)
  378. m.Group("/:username/:reponame", func() {
  379. m.Group("/settings", func() {
  380. m.Combo("").Get(repo.Settings).
  381. Post(bindIgnErr(form.RepoSetting{}), repo.SettingsPost)
  382. m.Combo("/avatar").Get(repo.SettingsAvatar).
  383. Post(binding.MultipartForm(form.Avatar{}), repo.SettingsAvatarPost)
  384. m.Post("/avatar/delete", repo.SettingsDeleteAvatar)
  385. m.Group("/collaboration", func() {
  386. m.Combo("").Get(repo.SettingsCollaboration).Post(repo.SettingsCollaborationPost)
  387. m.Post("/access_mode", repo.ChangeCollaborationAccessMode)
  388. m.Post("/delete", repo.DeleteCollaboration)
  389. })
  390. m.Group("/branches", func() {
  391. m.Get("", repo.SettingsBranches)
  392. m.Post("/default_branch", repo.UpdateDefaultBranch)
  393. m.Combo("/*").Get(repo.SettingsProtectedBranch).
  394. Post(bindIgnErr(form.ProtectBranch{}), repo.SettingsProtectedBranchPost)
  395. }, func(c *context.Context) {
  396. if c.Repo.Repository.IsMirror {
  397. c.NotFound()
  398. return
  399. }
  400. })
  401. m.Group("/hooks", func() {
  402. webhookRoutes()
  403. m.Group("/:id", func() {
  404. m.Post("/test", repo.TestWebhook)
  405. m.Post("/redelivery", repo.RedeliveryWebhook)
  406. })
  407. m.Group("/git", func() {
  408. m.Get("", repo.SettingsGitHooks)
  409. m.Combo("/:name").Get(repo.SettingsGitHooksEdit).
  410. Post(repo.SettingsGitHooksEditPost)
  411. }, context.GitHookService())
  412. })
  413. m.Group("/keys", func() {
  414. m.Combo("").Get(repo.SettingsDeployKeys).
  415. Post(bindIgnErr(form.AddSSHKey{}), repo.SettingsDeployKeysPost)
  416. m.Post("/delete", repo.DeleteDeployKey)
  417. })
  418. }, func(c *context.Context) {
  419. c.Data["PageIsSettings"] = true
  420. })
  421. }, reqSignIn, context.RepoAssignment(), reqRepoAdmin, context.RepoRef())
  422. m.Post("/:username/:reponame/action/:action", reqSignIn, context.RepoAssignment(), repo.Action)
  423. m.Group("/:username/:reponame", func() {
  424. m.Get("/issues", repo.RetrieveLabels, repo.Issues)
  425. m.Get("/issues/:index", repo.ViewIssue)
  426. m.Get("/labels/", repo.RetrieveLabels, repo.Labels)
  427. m.Get("/milestones", repo.Milestones)
  428. }, ignSignIn, context.RepoAssignment(true))
  429. m.Group("/:username/:reponame", func() {
  430. // FIXME: should use different URLs but mostly same logic for comments of issue and pull reuqest.
  431. // So they can apply their own enable/disable logic on routers.
  432. m.Group("/issues", func() {
  433. m.Combo("/new", repo.MustEnableIssues).Get(context.RepoRef(), repo.NewIssue).
  434. Post(bindIgnErr(form.NewIssue{}), repo.NewIssuePost)
  435. m.Group("/:index", func() {
  436. m.Post("/title", repo.UpdateIssueTitle)
  437. m.Post("/content", repo.UpdateIssueContent)
  438. m.Combo("/comments").Post(bindIgnErr(form.CreateComment{}), repo.NewComment)
  439. })
  440. })
  441. m.Group("/comments/:id", func() {
  442. m.Post("", repo.UpdateCommentContent)
  443. m.Post("/delete", repo.DeleteComment)
  444. })
  445. }, reqSignIn, context.RepoAssignment(true))
  446. m.Group("/:username/:reponame", func() {
  447. m.Group("/wiki", func() {
  448. m.Get("/?:page", repo.Wiki)
  449. m.Get("/_pages", repo.WikiPages)
  450. }, repo.MustEnableWiki, context.RepoRef())
  451. }, ignSignIn, context.RepoAssignment(false, true))
  452. m.Group("/:username/:reponame", func() {
  453. // FIXME: should use different URLs but mostly same logic for comments of issue and pull reuqest.
  454. // So they can apply their own enable/disable logic on routers.
  455. m.Group("/issues", func() {
  456. m.Group("/:index", func() {
  457. m.Post("/label", repo.UpdateIssueLabel)
  458. m.Post("/milestone", repo.UpdateIssueMilestone)
  459. m.Post("/assignee", repo.UpdateIssueAssignee)
  460. }, reqRepoWriter)
  461. })
  462. m.Group("/labels", func() {
  463. m.Post("/new", bindIgnErr(form.CreateLabel{}), repo.NewLabel)
  464. m.Post("/edit", bindIgnErr(form.CreateLabel{}), repo.UpdateLabel)
  465. m.Post("/delete", repo.DeleteLabel)
  466. m.Post("/initialize", bindIgnErr(form.InitializeLabels{}), repo.InitializeLabels)
  467. }, reqRepoWriter, context.RepoRef())
  468. m.Group("/milestones", func() {
  469. m.Combo("/new").Get(repo.NewMilestone).
  470. Post(bindIgnErr(form.CreateMilestone{}), repo.NewMilestonePost)
  471. m.Get("/:id/edit", repo.EditMilestone)
  472. m.Post("/:id/edit", bindIgnErr(form.CreateMilestone{}), repo.EditMilestonePost)
  473. m.Get("/:id/:action", repo.ChangeMilestonStatus)
  474. m.Post("/delete", repo.DeleteMilestone)
  475. }, reqRepoWriter, context.RepoRef())
  476. m.Group("/releases", func() {
  477. m.Get("/new", repo.NewRelease)
  478. m.Post("/new", bindIgnErr(form.NewRelease{}), repo.NewReleasePost)
  479. m.Post("/delete", repo.DeleteRelease)
  480. m.Get("/edit/*", repo.EditRelease)
  481. m.Post("/edit/*", bindIgnErr(form.EditRelease{}), repo.EditReleasePost)
  482. }, repo.MustBeNotBare, reqRepoWriter, func(c *context.Context) {
  483. c.Data["PageIsViewFiles"] = true
  484. })
  485. // FIXME: Should use c.Repo.PullRequest to unify template, currently we have inconsistent URL
  486. // for PR in same repository. After select branch on the page, the URL contains redundant head user name.
  487. // e.g. /org1/test-repo/compare/master...org1:develop
  488. // which should be /org1/test-repo/compare/master...develop
  489. m.Combo("/compare/*", repo.MustAllowPulls).Get(repo.CompareAndPullRequest).
  490. Post(bindIgnErr(form.NewIssue{}), repo.CompareAndPullRequestPost)
  491. m.Group("", func() {
  492. m.Combo("/_edit/*").Get(repo.EditFile).
  493. Post(bindIgnErr(form.EditRepoFile{}), repo.EditFilePost)
  494. m.Combo("/_new/*").Get(repo.NewFile).
  495. Post(bindIgnErr(form.EditRepoFile{}), repo.NewFilePost)
  496. m.Post("/_preview/*", bindIgnErr(form.EditPreviewDiff{}), repo.DiffPreviewPost)
  497. m.Combo("/_delete/*").Get(repo.DeleteFile).
  498. Post(bindIgnErr(form.DeleteRepoFile{}), repo.DeleteFilePost)
  499. m.Group("", func() {
  500. m.Combo("/_upload/*").Get(repo.UploadFile).
  501. Post(bindIgnErr(form.UploadRepoFile{}), repo.UploadFilePost)
  502. m.Post("/upload-file", repo.UploadFileToServer)
  503. m.Post("/upload-remove", bindIgnErr(form.RemoveUploadFile{}), repo.RemoveUploadFileFromServer)
  504. }, func(c *context.Context) {
  505. if !conf.Repository.Upload.Enabled {
  506. c.NotFound()
  507. return
  508. }
  509. })
  510. }, repo.MustBeNotBare, reqRepoWriter, context.RepoRef(), func(c *context.Context) {
  511. if !c.Repo.CanEnableEditor() {
  512. c.NotFound()
  513. return
  514. }
  515. c.Data["PageIsViewFiles"] = true
  516. })
  517. }, reqSignIn, context.RepoAssignment())
  518. m.Group("/:username/:reponame", func() {
  519. m.Group("", func() {
  520. m.Get("/releases", repo.MustBeNotBare, repo.Releases)
  521. m.Get("/pulls", repo.RetrieveLabels, repo.Pulls)
  522. m.Get("/pulls/:index", repo.ViewPull)
  523. }, context.RepoRef())
  524. m.Group("/branches", func() {
  525. m.Get("", repo.Branches)
  526. m.Get("/all", repo.AllBranches)
  527. m.Post("/delete/*", reqSignIn, reqRepoWriter, repo.DeleteBranchPost)
  528. }, repo.MustBeNotBare, func(c *context.Context) {
  529. c.Data["PageIsViewFiles"] = true
  530. })
  531. m.Group("/wiki", func() {
  532. m.Group("", func() {
  533. m.Combo("/_new").Get(repo.NewWiki).
  534. Post(bindIgnErr(form.NewWiki{}), repo.NewWikiPost)
  535. m.Combo("/:page/_edit").Get(repo.EditWiki).
  536. Post(bindIgnErr(form.NewWiki{}), repo.EditWikiPost)
  537. m.Post("/:page/delete", repo.DeleteWikiPagePost)
  538. }, reqSignIn, reqRepoWriter)
  539. }, repo.MustEnableWiki, context.RepoRef())
  540. m.Get("/archive/*", repo.MustBeNotBare, repo.Download)
  541. m.Group("/pulls/:index", func() {
  542. m.Get("/commits", context.RepoRef(), repo.ViewPullCommits)
  543. m.Get("/files", context.RepoRef(), repo.ViewPullFiles)
  544. m.Post("/merge", reqRepoWriter, repo.MergePullRequest)
  545. }, repo.MustAllowPulls)
  546. m.Group("", func() {
  547. m.Get("/src/*", repo.Home)
  548. m.Get("/raw/*", repo.SingleDownload)
  549. m.Get("/commits/*", repo.RefCommits)
  550. m.Get("/commit/:sha([a-f0-9]{7,40})$", repo.Diff)
  551. m.Get("/forks", repo.Forks)
  552. }, repo.MustBeNotBare, context.RepoRef())
  553. m.Get("/commit/:sha([a-f0-9]{7,40})\\.:ext(patch|diff)", repo.MustBeNotBare, repo.RawDiff)
  554. m.Get("/compare/:before([a-z0-9]{40})\\.\\.\\.:after([a-z0-9]{40})", repo.MustBeNotBare, context.RepoRef(), repo.CompareDiff)
  555. }, ignSignIn, context.RepoAssignment())
  556. m.Group("/:username/:reponame", func() {
  557. m.Get("", repo.Home)
  558. m.Get("/stars", repo.Stars)
  559. m.Get("/watchers", repo.Watchers)
  560. }, context.ServeGoGet(), ignSignIn, context.RepoAssignment(), context.RepoRef())
  561. // ***** END: Repository *****
  562. // **********************
  563. // ----- API routes -----
  564. // **********************
  565. // TODO: Without session and CSRF
  566. m.Group("/api", func() {
  567. apiv1.RegisterRoutes(m)
  568. }, ignSignIn)
  569. },
  570. session.Sessioner(session.Options{
  571. Provider: conf.Session.Provider,
  572. ProviderConfig: conf.Session.ProviderConfig,
  573. CookieName: conf.Session.CookieName,
  574. CookiePath: conf.Server.Subpath,
  575. Gclifetime: conf.Session.GCInterval,
  576. Maxlifetime: conf.Session.MaxLifeTime,
  577. Secure: conf.Session.CookieSecure,
  578. }),
  579. csrf.Csrfer(csrf.Options{
  580. Secret: conf.Security.SecretKey,
  581. Header: "X-CSRF-Token",
  582. Cookie: conf.Session.CSRFCookieName,
  583. CookieDomain: conf.Server.URL.Hostname(),
  584. CookiePath: conf.Server.Subpath,
  585. CookieHttpOnly: true,
  586. SetCookie: true,
  587. Secure: conf.Server.URL.Scheme == "https",
  588. }),
  589. context.Contexter(),
  590. )
  591. // ***************************
  592. // ----- HTTP Git routes -----
  593. // ***************************
  594. m.Group("/:username/:reponame", func() {
  595. m.Get("/tasks/trigger", repo.TriggerTask)
  596. m.Group("/info/lfs", func() {
  597. lfs.RegisterRoutes(m.Router)
  598. })
  599. m.Route("/*", "GET,POST,OPTIONS", context.ServeGoGet(), repo.HTTPContexter(), repo.HTTP)
  600. })
  601. // ***************************
  602. // ----- Internal routes -----
  603. // ***************************
  604. m.Group("/-", func() {
  605. m.Get("/metrics", app.MetricsFilter(), promhttp.Handler()) // "/-/metrics"
  606. m.Group("/api", func() {
  607. m.Post("/sanitize_ipynb", app.SanitizeIpynb()) // "/-/api/sanitize_ipynb"
  608. })
  609. })
  610. // **********************
  611. // ----- robots.txt -----
  612. // **********************
  613. m.Get("/robots.txt", func(w http.ResponseWriter, r *http.Request) {
  614. if conf.HasRobotsTxt {
  615. http.ServeFile(w, r, filepath.Join(conf.CustomDir(), "robots.txt"))
  616. } else {
  617. w.WriteHeader(http.StatusNotFound)
  618. }
  619. })
  620. m.NotFound(route.NotFound)
  621. // Flag for port number in case first time run conflict.
  622. if c.IsSet("port") {
  623. conf.Server.URL.Host = strings.Replace(conf.Server.URL.Host, ":"+conf.Server.URL.Port(), ":"+c.String("port"), 1)
  624. conf.Server.ExternalURL = conf.Server.URL.String()
  625. conf.Server.HTTPPort = c.String("port")
  626. }
  627. var listenAddr string
  628. if conf.Server.Protocol == "unix" {
  629. listenAddr = conf.Server.HTTPAddr
  630. } else {
  631. listenAddr = fmt.Sprintf("%s:%s", conf.Server.HTTPAddr, conf.Server.HTTPPort)
  632. }
  633. log.Info("Available on %s", conf.Server.ExternalURL)
  634. switch conf.Server.Protocol {
  635. case "http":
  636. err = http.ListenAndServe(listenAddr, m)
  637. case "https":
  638. tlsMinVersion := tls.VersionTLS12
  639. switch conf.Server.TLSMinVersion {
  640. case "TLS13":
  641. tlsMinVersion = tls.VersionTLS13
  642. case "TLS12":
  643. tlsMinVersion = tls.VersionTLS12
  644. case "TLS11":
  645. tlsMinVersion = tls.VersionTLS11
  646. case "TLS10":
  647. tlsMinVersion = tls.VersionTLS10
  648. }
  649. server := &http.Server{
  650. Addr: listenAddr,
  651. TLSConfig: &tls.Config{
  652. MinVersion: uint16(tlsMinVersion),
  653. CurvePreferences: []tls.CurveID{tls.X25519, tls.CurveP256, tls.CurveP384, tls.CurveP521},
  654. PreferServerCipherSuites: true,
  655. CipherSuites: []uint16{
  656. tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
  657. tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
  658. tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
  659. tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
  660. tls.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,
  661. tls.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,
  662. },
  663. }, Handler: m,
  664. }
  665. err = server.ListenAndServeTLS(conf.Server.CertFile, conf.Server.KeyFile)
  666. case "fcgi":
  667. err = fcgi.Serve(nil, m)
  668. case "unix":
  669. if osutil.IsExist(listenAddr) {
  670. err = os.Remove(listenAddr)
  671. if err != nil {
  672. log.Fatal("Failed to remove existing Unix domain socket: %v", err)
  673. }
  674. }
  675. var listener *net.UnixListener
  676. listener, err = net.ListenUnix("unix", &net.UnixAddr{Name: listenAddr, Net: "unix"})
  677. if err != nil {
  678. log.Fatal("Failed to listen on Unix networks: %v", err)
  679. }
  680. // FIXME: add proper implementation of signal capture on all protocols
  681. // execute this on SIGTERM or SIGINT: listener.Close()
  682. if err = os.Chmod(listenAddr, conf.Server.UnixSocketMode); err != nil {
  683. log.Fatal("Failed to change permission of Unix domain socket: %v", err)
  684. }
  685. err = http.Serve(listener, m)
  686. default:
  687. log.Fatal("Unexpected server protocol: %s", conf.Server.Protocol)
  688. }
  689. if err != nil {
  690. log.Fatal("Failed to start server: %v", err)
  691. }
  692. return nil
  693. }