You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

routes.go 33KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  1. // Copyright 2017 The Gitea 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 routes
  5. import (
  6. "encoding/gob"
  7. "fmt"
  8. "net/http"
  9. "os"
  10. "path"
  11. "time"
  12. "code.gitea.io/gitea/models"
  13. "code.gitea.io/gitea/modules/auth"
  14. "code.gitea.io/gitea/modules/context"
  15. "code.gitea.io/gitea/modules/gzip"
  16. "code.gitea.io/gitea/modules/lfs"
  17. "code.gitea.io/gitea/modules/log"
  18. "code.gitea.io/gitea/modules/metrics"
  19. "code.gitea.io/gitea/modules/options"
  20. "code.gitea.io/gitea/modules/public"
  21. "code.gitea.io/gitea/modules/setting"
  22. "code.gitea.io/gitea/modules/templates"
  23. "code.gitea.io/gitea/modules/validation"
  24. "code.gitea.io/gitea/routers"
  25. "code.gitea.io/gitea/routers/admin"
  26. apiv1 "code.gitea.io/gitea/routers/api/v1"
  27. "code.gitea.io/gitea/routers/dev"
  28. "code.gitea.io/gitea/routers/org"
  29. "code.gitea.io/gitea/routers/private"
  30. "code.gitea.io/gitea/routers/repo"
  31. "code.gitea.io/gitea/routers/user"
  32. userSetting "code.gitea.io/gitea/routers/user/setting"
  33. "github.com/go-macaron/binding"
  34. "github.com/go-macaron/cache"
  35. "github.com/go-macaron/captcha"
  36. "github.com/go-macaron/csrf"
  37. "github.com/go-macaron/i18n"
  38. "github.com/go-macaron/session"
  39. "github.com/go-macaron/toolbox"
  40. "github.com/prometheus/client_golang/prometheus"
  41. "github.com/tstranex/u2f"
  42. macaron "gopkg.in/macaron.v1"
  43. )
  44. func giteaLogger(l *log.LoggerAsWriter) macaron.Handler {
  45. return func(ctx *macaron.Context) {
  46. start := time.Now()
  47. l.Log(fmt.Sprintf("[Macaron] Started %s %s for %s", ctx.Req.Method, ctx.Req.RequestURI, ctx.RemoteAddr()))
  48. ctx.Next()
  49. rw := ctx.Resp.(macaron.ResponseWriter)
  50. l.Log(fmt.Sprintf("[Macaron] Completed %s %s %v %s in %v", ctx.Req.Method, ctx.Req.RequestURI, rw.Status(), http.StatusText(rw.Status()), time.Since(start)))
  51. }
  52. }
  53. // NewMacaron initializes Macaron instance.
  54. func NewMacaron() *macaron.Macaron {
  55. gob.Register(&u2f.Challenge{})
  56. var m *macaron.Macaron
  57. if setting.RedirectMacaronLog {
  58. loggerAsWriter := log.NewLoggerAsWriter("INFO")
  59. m = macaron.NewWithLogger(loggerAsWriter)
  60. if !setting.DisableRouterLog {
  61. m.Use(giteaLogger(loggerAsWriter))
  62. }
  63. } else {
  64. m = macaron.New()
  65. if !setting.DisableRouterLog {
  66. m.Use(macaron.Logger())
  67. }
  68. }
  69. m.Use(macaron.Recovery())
  70. if setting.EnableGzip {
  71. m.Use(gzip.Middleware())
  72. }
  73. if setting.Protocol == setting.FCGI {
  74. m.SetURLPrefix(setting.AppSubURL)
  75. }
  76. m.Use(public.Custom(
  77. &public.Options{
  78. SkipLogging: setting.DisableRouterLog,
  79. ExpiresAfter: time.Hour * 6,
  80. },
  81. ))
  82. m.Use(public.Static(
  83. &public.Options{
  84. Directory: path.Join(setting.StaticRootPath, "public"),
  85. SkipLogging: setting.DisableRouterLog,
  86. ExpiresAfter: time.Hour * 6,
  87. },
  88. ))
  89. m.Use(public.StaticHandler(
  90. setting.AvatarUploadPath,
  91. &public.Options{
  92. Prefix: "avatars",
  93. SkipLogging: setting.DisableRouterLog,
  94. ExpiresAfter: time.Hour * 6,
  95. },
  96. ))
  97. m.Use(templates.HTMLRenderer())
  98. models.InitMailRender(templates.Mailer())
  99. localeNames, err := options.Dir("locale")
  100. if err != nil {
  101. log.Fatal(4, "Failed to list locale files: %v", err)
  102. }
  103. localFiles := make(map[string][]byte)
  104. for _, name := range localeNames {
  105. localFiles[name], err = options.Locale(name)
  106. if err != nil {
  107. log.Fatal(4, "Failed to load %s locale file. %v", name, err)
  108. }
  109. }
  110. m.Use(i18n.I18n(i18n.Options{
  111. SubURL: setting.AppSubURL,
  112. Files: localFiles,
  113. Langs: setting.Langs,
  114. Names: setting.Names,
  115. DefaultLang: "en-US",
  116. Redirect: false,
  117. }))
  118. m.Use(cache.Cacher(cache.Options{
  119. Adapter: setting.CacheService.Adapter,
  120. AdapterConfig: setting.CacheService.Conn,
  121. Interval: setting.CacheService.Interval,
  122. }))
  123. m.Use(captcha.Captchaer(captcha.Options{
  124. SubURL: setting.AppSubURL,
  125. }))
  126. m.Use(session.Sessioner(setting.SessionConfig))
  127. m.Use(csrf.Csrfer(csrf.Options{
  128. Secret: setting.SecretKey,
  129. Cookie: setting.CSRFCookieName,
  130. SetCookie: true,
  131. Secure: setting.SessionConfig.Secure,
  132. CookieHttpOnly: true,
  133. Header: "X-Csrf-Token",
  134. CookiePath: setting.AppSubURL,
  135. }))
  136. m.Use(toolbox.Toolboxer(m, toolbox.Options{
  137. HealthCheckFuncs: []*toolbox.HealthCheckFuncDesc{
  138. {
  139. Desc: "Database connection",
  140. Func: models.Ping,
  141. },
  142. },
  143. DisableDebug: !setting.EnablePprof,
  144. }))
  145. m.Use(context.Contexter())
  146. // OK we are now set-up enough to allow us to create a nicer recovery than
  147. // the default macaron recovery
  148. m.Use(context.Recovery())
  149. m.SetAutoHead(true)
  150. return m
  151. }
  152. // RegisterRoutes routes routes to Macaron
  153. func RegisterRoutes(m *macaron.Macaron) {
  154. reqSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: true})
  155. ignSignIn := context.Toggle(&context.ToggleOptions{SignInRequired: setting.Service.RequireSignInView})
  156. ignSignInAndCsrf := context.Toggle(&context.ToggleOptions{DisableCSRF: true})
  157. reqSignOut := context.Toggle(&context.ToggleOptions{SignOutRequired: true})
  158. bindIgnErr := binding.BindIgnErr
  159. validation.AddBindingRules()
  160. openIDSignInEnabled := func(ctx *context.Context) {
  161. if !setting.Service.EnableOpenIDSignIn {
  162. ctx.Error(403)
  163. return
  164. }
  165. }
  166. openIDSignUpEnabled := func(ctx *context.Context) {
  167. if !setting.Service.EnableOpenIDSignUp {
  168. ctx.Error(403)
  169. return
  170. }
  171. }
  172. m.Use(user.GetNotificationCount)
  173. // FIXME: not all routes need go through same middlewares.
  174. // Especially some AJAX requests, we can reduce middleware number to improve performance.
  175. // Routers.
  176. // for health check
  177. m.Head("/", func() string {
  178. return ""
  179. })
  180. m.Get("/", routers.Home)
  181. m.Group("/explore", func() {
  182. m.Get("", func(ctx *context.Context) {
  183. ctx.Redirect(setting.AppSubURL + "/explore/repos")
  184. })
  185. m.Get("/repos", routers.ExploreRepos)
  186. m.Get("/users", routers.ExploreUsers)
  187. m.Get("/organizations", routers.ExploreOrganizations)
  188. m.Get("/code", routers.ExploreCode)
  189. }, ignSignIn)
  190. m.Combo("/install", routers.InstallInit).Get(routers.Install).
  191. Post(bindIgnErr(auth.InstallForm{}), routers.InstallPost)
  192. m.Get("/^:type(issues|pulls)$", reqSignIn, user.Issues)
  193. // ***** START: User *****
  194. m.Group("/user", func() {
  195. m.Get("/login", user.SignIn)
  196. m.Post("/login", bindIgnErr(auth.SignInForm{}), user.SignInPost)
  197. m.Group("", func() {
  198. m.Combo("/login/openid").
  199. Get(user.SignInOpenID).
  200. Post(bindIgnErr(auth.SignInOpenIDForm{}), user.SignInOpenIDPost)
  201. }, openIDSignInEnabled)
  202. m.Group("/openid", func() {
  203. m.Combo("/connect").
  204. Get(user.ConnectOpenID).
  205. Post(bindIgnErr(auth.ConnectOpenIDForm{}), user.ConnectOpenIDPost)
  206. m.Group("/register", func() {
  207. m.Combo("").
  208. Get(user.RegisterOpenID, openIDSignUpEnabled).
  209. Post(bindIgnErr(auth.SignUpOpenIDForm{}), user.RegisterOpenIDPost)
  210. }, openIDSignUpEnabled)
  211. }, openIDSignInEnabled)
  212. m.Get("/sign_up", user.SignUp)
  213. m.Post("/sign_up", bindIgnErr(auth.RegisterForm{}), user.SignUpPost)
  214. m.Get("/reset_password", user.ResetPasswd)
  215. m.Post("/reset_password", user.ResetPasswdPost)
  216. m.Group("/oauth2", func() {
  217. m.Get("/:provider", user.SignInOAuth)
  218. m.Get("/:provider/callback", user.SignInOAuthCallback)
  219. })
  220. m.Get("/link_account", user.LinkAccount)
  221. m.Post("/link_account_signin", bindIgnErr(auth.SignInForm{}), user.LinkAccountPostSignIn)
  222. m.Post("/link_account_signup", bindIgnErr(auth.RegisterForm{}), user.LinkAccountPostRegister)
  223. m.Group("/two_factor", func() {
  224. m.Get("", user.TwoFactor)
  225. m.Post("", bindIgnErr(auth.TwoFactorAuthForm{}), user.TwoFactorPost)
  226. m.Get("/scratch", user.TwoFactorScratch)
  227. m.Post("/scratch", bindIgnErr(auth.TwoFactorScratchAuthForm{}), user.TwoFactorScratchPost)
  228. })
  229. m.Group("/u2f", func() {
  230. m.Get("", user.U2F)
  231. m.Get("/challenge", user.U2FChallenge)
  232. m.Post("/sign", bindIgnErr(u2f.SignResponse{}), user.U2FSign)
  233. })
  234. }, reqSignOut)
  235. m.Group("/user/settings", func() {
  236. m.Get("", userSetting.Profile)
  237. m.Post("", bindIgnErr(auth.UpdateProfileForm{}), userSetting.ProfilePost)
  238. m.Get("/change_password", user.MustChangePassword)
  239. m.Post("/change_password", bindIgnErr(auth.MustChangePasswordForm{}), user.MustChangePasswordPost)
  240. m.Post("/avatar", binding.MultipartForm(auth.AvatarForm{}), userSetting.AvatarPost)
  241. m.Post("/avatar/delete", userSetting.DeleteAvatar)
  242. m.Group("/account", func() {
  243. m.Combo("").Get(userSetting.Account).Post(bindIgnErr(auth.ChangePasswordForm{}), userSetting.AccountPost)
  244. m.Post("/email", bindIgnErr(auth.AddEmailForm{}), userSetting.EmailPost)
  245. m.Post("/email/delete", userSetting.DeleteEmail)
  246. m.Post("/delete", userSetting.DeleteAccount)
  247. m.Post("/theme", bindIgnErr(auth.UpdateThemeForm{}), userSetting.UpdateUIThemePost)
  248. })
  249. m.Group("/security", func() {
  250. m.Get("", userSetting.Security)
  251. m.Group("/two_factor", func() {
  252. m.Post("/regenerate_scratch", userSetting.RegenerateScratchTwoFactor)
  253. m.Post("/disable", userSetting.DisableTwoFactor)
  254. m.Get("/enroll", userSetting.EnrollTwoFactor)
  255. m.Post("/enroll", bindIgnErr(auth.TwoFactorAuthForm{}), userSetting.EnrollTwoFactorPost)
  256. })
  257. m.Group("/u2f", func() {
  258. m.Post("/request_register", bindIgnErr(auth.U2FRegistrationForm{}), userSetting.U2FRegister)
  259. m.Post("/register", bindIgnErr(u2f.RegisterResponse{}), userSetting.U2FRegisterPost)
  260. m.Post("/delete", bindIgnErr(auth.U2FDeleteForm{}), userSetting.U2FDelete)
  261. })
  262. m.Group("/openid", func() {
  263. m.Post("", bindIgnErr(auth.AddOpenIDForm{}), userSetting.OpenIDPost)
  264. m.Post("/delete", userSetting.DeleteOpenID)
  265. m.Post("/toggle_visibility", userSetting.ToggleOpenIDVisibility)
  266. }, openIDSignInEnabled)
  267. m.Post("/account_link", userSetting.DeleteAccountLink)
  268. })
  269. m.Combo("/applications").Get(userSetting.Applications).
  270. Post(bindIgnErr(auth.NewAccessTokenForm{}), userSetting.ApplicationsPost)
  271. m.Post("/applications/delete", userSetting.DeleteApplication)
  272. m.Combo("/keys").Get(userSetting.Keys).
  273. Post(bindIgnErr(auth.AddKeyForm{}), userSetting.KeysPost)
  274. m.Post("/keys/delete", userSetting.DeleteKey)
  275. m.Get("/organization", userSetting.Organization)
  276. m.Get("/repos", userSetting.Repos)
  277. // redirects from old settings urls to new ones
  278. // TODO: can be removed on next major version
  279. m.Get("/avatar", func(ctx *context.Context) {
  280. ctx.Redirect(setting.AppSubURL+"/user/settings", http.StatusMovedPermanently)
  281. })
  282. m.Get("/email", func(ctx *context.Context) {
  283. ctx.Redirect(setting.AppSubURL+"/user/settings/account", http.StatusMovedPermanently)
  284. })
  285. m.Get("/delete", func(ctx *context.Context) {
  286. ctx.Redirect(setting.AppSubURL+"/user/settings/account", http.StatusMovedPermanently)
  287. })
  288. m.Get("/openid", func(ctx *context.Context) {
  289. ctx.Redirect(setting.AppSubURL+"/user/settings/security", http.StatusMovedPermanently)
  290. })
  291. m.Get("/account_link", func(ctx *context.Context) {
  292. ctx.Redirect(setting.AppSubURL+"/user/settings/security", http.StatusMovedPermanently)
  293. })
  294. }, reqSignIn, func(ctx *context.Context) {
  295. ctx.Data["PageIsUserSettings"] = true
  296. ctx.Data["AllThemes"] = setting.UI.Themes
  297. })
  298. m.Group("/user", func() {
  299. // r.Get("/feeds", binding.Bind(auth.FeedsForm{}), user.Feeds)
  300. m.Any("/activate", user.Activate)
  301. m.Any("/activate_email", user.ActivateEmail)
  302. m.Get("/email2user", user.Email2User)
  303. m.Get("/forgot_password", user.ForgotPasswd)
  304. m.Post("/forgot_password", user.ForgotPasswdPost)
  305. m.Get("/logout", user.SignOut)
  306. })
  307. // ***** END: User *****
  308. adminReq := context.Toggle(&context.ToggleOptions{SignInRequired: true, AdminRequired: true})
  309. // ***** START: Admin *****
  310. m.Group("/admin", func() {
  311. m.Get("", adminReq, admin.Dashboard)
  312. m.Get("/config", admin.Config)
  313. m.Post("/config/test_mail", admin.SendTestMail)
  314. m.Get("/monitor", admin.Monitor)
  315. m.Group("/users", func() {
  316. m.Get("", admin.Users)
  317. m.Combo("/new").Get(admin.NewUser).Post(bindIgnErr(auth.AdminCreateUserForm{}), admin.NewUserPost)
  318. m.Combo("/:userid").Get(admin.EditUser).Post(bindIgnErr(auth.AdminEditUserForm{}), admin.EditUserPost)
  319. m.Post("/:userid/delete", admin.DeleteUser)
  320. })
  321. m.Group("/orgs", func() {
  322. m.Get("", admin.Organizations)
  323. })
  324. m.Group("/repos", func() {
  325. m.Get("", admin.Repos)
  326. m.Post("/delete", admin.DeleteRepo)
  327. })
  328. m.Group("/auths", func() {
  329. m.Get("", admin.Authentications)
  330. m.Combo("/new").Get(admin.NewAuthSource).Post(bindIgnErr(auth.AuthenticationForm{}), admin.NewAuthSourcePost)
  331. m.Combo("/:authid").Get(admin.EditAuthSource).
  332. Post(bindIgnErr(auth.AuthenticationForm{}), admin.EditAuthSourcePost)
  333. m.Post("/:authid/delete", admin.DeleteAuthSource)
  334. })
  335. m.Group("/notices", func() {
  336. m.Get("", admin.Notices)
  337. m.Post("/delete", admin.DeleteNotices)
  338. m.Get("/empty", admin.EmptyNotices)
  339. })
  340. }, adminReq)
  341. // ***** END: Admin *****
  342. m.Group("", func() {
  343. m.Group("/:username", func() {
  344. m.Get("", user.Profile)
  345. m.Get("/followers", user.Followers)
  346. m.Get("/following", user.Following)
  347. })
  348. m.Get("/attachments/:uuid", func(ctx *context.Context) {
  349. attach, err := models.GetAttachmentByUUID(ctx.Params(":uuid"))
  350. if err != nil {
  351. if models.IsErrAttachmentNotExist(err) {
  352. ctx.Error(404)
  353. } else {
  354. ctx.ServerError("GetAttachmentByUUID", err)
  355. }
  356. return
  357. }
  358. fr, err := os.Open(attach.LocalPath())
  359. if err != nil {
  360. ctx.ServerError("Open", err)
  361. return
  362. }
  363. defer fr.Close()
  364. if err := attach.IncreaseDownloadCount(); err != nil {
  365. ctx.ServerError("Update", err)
  366. return
  367. }
  368. if err = repo.ServeData(ctx, attach.Name, fr); err != nil {
  369. ctx.ServerError("ServeData", err)
  370. return
  371. }
  372. })
  373. m.Post("/attachments", repo.UploadAttachment)
  374. }, ignSignIn)
  375. m.Group("/:username", func() {
  376. m.Get("/action/:action", user.Action)
  377. }, reqSignIn)
  378. if macaron.Env == macaron.DEV {
  379. m.Get("/template/*", dev.TemplatePreview)
  380. }
  381. reqRepoAdmin := context.RequireRepoAdmin()
  382. reqRepoCodeWriter := context.RequireRepoWriter(models.UnitTypeCode)
  383. reqRepoCodeReader := context.RequireRepoReader(models.UnitTypeCode)
  384. reqRepoReleaseWriter := context.RequireRepoWriter(models.UnitTypeReleases)
  385. reqRepoReleaseReader := context.RequireRepoReader(models.UnitTypeReleases)
  386. reqRepoWikiWriter := context.RequireRepoWriter(models.UnitTypeWiki)
  387. reqRepoIssueReader := context.RequireRepoReader(models.UnitTypeIssues)
  388. reqRepoPullsWriter := context.RequireRepoWriter(models.UnitTypePullRequests)
  389. reqRepoPullsReader := context.RequireRepoReader(models.UnitTypePullRequests)
  390. reqRepoIssuesOrPullsWriter := context.RequireRepoWriterOr(models.UnitTypeIssues, models.UnitTypePullRequests)
  391. reqRepoIssuesOrPullsReader := context.RequireRepoReaderOr(models.UnitTypeIssues, models.UnitTypePullRequests)
  392. // ***** START: Organization *****
  393. m.Group("/org", func() {
  394. m.Group("", func() {
  395. m.Get("/create", org.Create)
  396. m.Post("/create", bindIgnErr(auth.CreateOrgForm{}), org.CreatePost)
  397. })
  398. m.Group("/:org", func() {
  399. m.Get("/dashboard", user.Dashboard)
  400. m.Get("/^:type(issues|pulls)$", user.Issues)
  401. m.Get("/members", org.Members)
  402. m.Get("/members/action/:action", org.MembersAction)
  403. m.Get("/teams", org.Teams)
  404. }, context.OrgAssignment(true))
  405. m.Group("/:org", func() {
  406. m.Get("/teams/:team", org.TeamMembers)
  407. m.Get("/teams/:team/repositories", org.TeamRepositories)
  408. m.Route("/teams/:team/action/:action", "GET,POST", org.TeamsAction)
  409. m.Route("/teams/:team/action/repo/:action", "GET,POST", org.TeamsRepoAction)
  410. }, context.OrgAssignment(true, false, true))
  411. m.Group("/:org", func() {
  412. m.Get("/teams/new", org.NewTeam)
  413. m.Post("/teams/new", bindIgnErr(auth.CreateTeamForm{}), org.NewTeamPost)
  414. m.Get("/teams/:team/edit", org.EditTeam)
  415. m.Post("/teams/:team/edit", bindIgnErr(auth.CreateTeamForm{}), org.EditTeamPost)
  416. m.Post("/teams/:team/delete", org.DeleteTeam)
  417. m.Group("/settings", func() {
  418. m.Combo("").Get(org.Settings).
  419. Post(bindIgnErr(auth.UpdateOrgSettingForm{}), org.SettingsPost)
  420. m.Post("/avatar", binding.MultipartForm(auth.AvatarForm{}), org.SettingsAvatar)
  421. m.Post("/avatar/delete", org.SettingsDeleteAvatar)
  422. m.Group("/hooks", func() {
  423. m.Get("", org.Webhooks)
  424. m.Post("/delete", org.DeleteWebhook)
  425. m.Get("/:type/new", repo.WebhooksNew)
  426. m.Post("/gitea/new", bindIgnErr(auth.NewWebhookForm{}), repo.WebHooksNewPost)
  427. m.Post("/gogs/new", bindIgnErr(auth.NewGogshookForm{}), repo.GogsHooksNewPost)
  428. m.Post("/slack/new", bindIgnErr(auth.NewSlackHookForm{}), repo.SlackHooksNewPost)
  429. m.Post("/discord/new", bindIgnErr(auth.NewDiscordHookForm{}), repo.DiscordHooksNewPost)
  430. m.Post("/dingtalk/new", bindIgnErr(auth.NewDingtalkHookForm{}), repo.DingtalkHooksNewPost)
  431. m.Get("/:id", repo.WebHooksEdit)
  432. m.Post("/gitea/:id", bindIgnErr(auth.NewWebhookForm{}), repo.WebHooksEditPost)
  433. m.Post("/gogs/:id", bindIgnErr(auth.NewGogshookForm{}), repo.GogsHooksEditPost)
  434. m.Post("/slack/:id", bindIgnErr(auth.NewSlackHookForm{}), repo.SlackHooksEditPost)
  435. m.Post("/discord/:id", bindIgnErr(auth.NewDiscordHookForm{}), repo.DiscordHooksEditPost)
  436. m.Post("/dingtalk/:id", bindIgnErr(auth.NewDingtalkHookForm{}), repo.DingtalkHooksEditPost)
  437. })
  438. m.Route("/delete", "GET,POST", org.SettingsDelete)
  439. })
  440. }, context.OrgAssignment(true, true))
  441. }, reqSignIn)
  442. // ***** END: Organization *****
  443. // ***** START: Repository *****
  444. m.Group("/repo", func() {
  445. m.Get("/create", repo.Create)
  446. m.Post("/create", bindIgnErr(auth.CreateRepoForm{}), repo.CreatePost)
  447. m.Get("/migrate", repo.Migrate)
  448. m.Post("/migrate", bindIgnErr(auth.MigrateRepoForm{}), repo.MigratePost)
  449. m.Group("/fork", func() {
  450. m.Combo("/:repoid").Get(repo.Fork).
  451. Post(bindIgnErr(auth.CreateRepoForm{}), repo.ForkPost)
  452. }, context.RepoIDAssignment(), context.UnitTypes(), reqRepoCodeReader)
  453. }, reqSignIn)
  454. // ***** Release Attachment Download without Signin
  455. m.Get("/:username/:reponame/releases/download/:vTag/:fileName", ignSignIn, context.RepoAssignment(), repo.MustBeNotEmpty, repo.RedirectDownload)
  456. m.Group("/:username/:reponame", func() {
  457. m.Group("/settings", func() {
  458. m.Combo("").Get(repo.Settings).
  459. Post(bindIgnErr(auth.RepoSettingForm{}), repo.SettingsPost)
  460. m.Group("/collaboration", func() {
  461. m.Combo("").Get(repo.Collaboration).Post(repo.CollaborationPost)
  462. m.Post("/access_mode", repo.ChangeCollaborationAccessMode)
  463. m.Post("/delete", repo.DeleteCollaboration)
  464. })
  465. m.Group("/branches", func() {
  466. m.Combo("").Get(repo.ProtectedBranch).Post(repo.ProtectedBranchPost)
  467. m.Combo("/*").Get(repo.SettingsProtectedBranch).
  468. Post(bindIgnErr(auth.ProtectBranchForm{}), context.RepoMustNotBeArchived(), repo.SettingsProtectedBranchPost)
  469. }, repo.MustBeNotEmpty)
  470. m.Group("/hooks", func() {
  471. m.Get("", repo.Webhooks)
  472. m.Post("/delete", repo.DeleteWebhook)
  473. m.Get("/:type/new", repo.WebhooksNew)
  474. m.Post("/gitea/new", bindIgnErr(auth.NewWebhookForm{}), repo.WebHooksNewPost)
  475. m.Post("/gogs/new", bindIgnErr(auth.NewGogshookForm{}), repo.GogsHooksNewPost)
  476. m.Post("/slack/new", bindIgnErr(auth.NewSlackHookForm{}), repo.SlackHooksNewPost)
  477. m.Post("/discord/new", bindIgnErr(auth.NewDiscordHookForm{}), repo.DiscordHooksNewPost)
  478. m.Post("/dingtalk/new", bindIgnErr(auth.NewDingtalkHookForm{}), repo.DingtalkHooksNewPost)
  479. m.Get("/:id", repo.WebHooksEdit)
  480. m.Post("/:id/test", repo.TestWebhook)
  481. m.Post("/gitea/:id", bindIgnErr(auth.NewWebhookForm{}), repo.WebHooksEditPost)
  482. m.Post("/gogs/:id", bindIgnErr(auth.NewGogshookForm{}), repo.GogsHooksEditPost)
  483. m.Post("/slack/:id", bindIgnErr(auth.NewSlackHookForm{}), repo.SlackHooksEditPost)
  484. m.Post("/discord/:id", bindIgnErr(auth.NewDiscordHookForm{}), repo.DiscordHooksEditPost)
  485. m.Post("/dingtalk/:id", bindIgnErr(auth.NewDingtalkHookForm{}), repo.DingtalkHooksEditPost)
  486. m.Group("/git", func() {
  487. m.Get("", repo.GitHooks)
  488. m.Combo("/:name").Get(repo.GitHooksEdit).
  489. Post(repo.GitHooksEditPost)
  490. }, context.GitHookService())
  491. })
  492. m.Group("/keys", func() {
  493. m.Combo("").Get(repo.DeployKeys).
  494. Post(bindIgnErr(auth.AddKeyForm{}), repo.DeployKeysPost)
  495. m.Post("/delete", repo.DeleteDeployKey)
  496. })
  497. }, func(ctx *context.Context) {
  498. ctx.Data["PageIsSettings"] = true
  499. })
  500. }, reqSignIn, context.RepoAssignment(), reqRepoAdmin, context.UnitTypes(), context.RepoRef())
  501. m.Get("/:username/:reponame/action/:action", reqSignIn, context.RepoAssignment(), context.RepoMustNotBeArchived(), repo.Action)
  502. m.Group("/:username/:reponame", func() {
  503. m.Group("/issues", func() {
  504. m.Combo("/new").Get(context.RepoRef(), repo.NewIssue).
  505. Post(bindIgnErr(auth.CreateIssueForm{}), repo.NewIssuePost)
  506. }, context.RepoMustNotBeArchived(), reqRepoIssueReader)
  507. // FIXME: should use different URLs but mostly same logic for comments of issue and pull reuqest.
  508. // So they can apply their own enable/disable logic on routers.
  509. m.Group("/issues", func() {
  510. m.Group("/:index", func() {
  511. m.Post("/title", repo.UpdateIssueTitle)
  512. m.Post("/content", repo.UpdateIssueContent)
  513. m.Post("/watch", repo.IssueWatch)
  514. m.Group("/dependency", func() {
  515. m.Post("/add", repo.AddDependency)
  516. m.Post("/delete", repo.RemoveDependency)
  517. })
  518. m.Combo("/comments").Post(bindIgnErr(auth.CreateCommentForm{}), repo.NewComment)
  519. m.Group("/times", func() {
  520. m.Post("/add", bindIgnErr(auth.AddTimeManuallyForm{}), repo.AddTimeManually)
  521. m.Group("/stopwatch", func() {
  522. m.Post("/toggle", repo.IssueStopwatch)
  523. m.Post("/cancel", repo.CancelStopwatch)
  524. })
  525. })
  526. m.Post("/reactions/:action", bindIgnErr(auth.ReactionForm{}), repo.ChangeIssueReaction)
  527. }, context.RepoMustNotBeArchived())
  528. m.Post("/labels", reqRepoIssuesOrPullsWriter, repo.UpdateIssueLabel)
  529. m.Post("/milestone", reqRepoIssuesOrPullsWriter, repo.UpdateIssueMilestone)
  530. m.Post("/assignee", reqRepoIssuesOrPullsWriter, repo.UpdateIssueAssignee)
  531. m.Post("/status", reqRepoIssuesOrPullsWriter, repo.UpdateIssueStatus)
  532. }, context.RepoMustNotBeArchived())
  533. m.Group("/comments/:id", func() {
  534. m.Post("", repo.UpdateCommentContent)
  535. m.Post("/delete", repo.DeleteComment)
  536. m.Post("/reactions/:action", bindIgnErr(auth.ReactionForm{}), repo.ChangeCommentReaction)
  537. }, context.RepoMustNotBeArchived())
  538. m.Group("/labels", func() {
  539. m.Post("/new", bindIgnErr(auth.CreateLabelForm{}), repo.NewLabel)
  540. m.Post("/edit", bindIgnErr(auth.CreateLabelForm{}), repo.UpdateLabel)
  541. m.Post("/delete", repo.DeleteLabel)
  542. m.Post("/initialize", bindIgnErr(auth.InitializeLabelsForm{}), repo.InitializeLabels)
  543. }, context.RepoMustNotBeArchived(), reqRepoIssuesOrPullsWriter, context.RepoRef())
  544. m.Group("/milestones", func() {
  545. m.Combo("/new").Get(repo.NewMilestone).
  546. Post(bindIgnErr(auth.CreateMilestoneForm{}), repo.NewMilestonePost)
  547. m.Get("/:id/edit", repo.EditMilestone)
  548. m.Post("/:id/edit", bindIgnErr(auth.CreateMilestoneForm{}), repo.EditMilestonePost)
  549. m.Get("/:id/:action", repo.ChangeMilestonStatus)
  550. m.Post("/delete", repo.DeleteMilestone)
  551. }, context.RepoMustNotBeArchived(), reqRepoIssuesOrPullsWriter, context.RepoRef())
  552. m.Group("/milestone", func() {
  553. m.Get("/:id", repo.MilestoneIssuesAndPulls)
  554. }, reqRepoIssuesOrPullsWriter, context.RepoRef())
  555. m.Combo("/compare/*", context.RepoMustNotBeArchived(), reqRepoCodeReader, reqRepoPullsReader, repo.MustAllowPulls, repo.SetEditorconfigIfExists).
  556. Get(repo.SetDiffViewStyle, repo.CompareAndPullRequest).
  557. Post(bindIgnErr(auth.CreateIssueForm{}), repo.CompareAndPullRequestPost)
  558. m.Group("", func() {
  559. m.Group("", func() {
  560. m.Combo("/_edit/*").Get(repo.EditFile).
  561. Post(bindIgnErr(auth.EditRepoFileForm{}), repo.EditFilePost)
  562. m.Combo("/_new/*").Get(repo.NewFile).
  563. Post(bindIgnErr(auth.EditRepoFileForm{}), repo.NewFilePost)
  564. m.Post("/_preview/*", bindIgnErr(auth.EditPreviewDiffForm{}), repo.DiffPreviewPost)
  565. m.Combo("/_delete/*").Get(repo.DeleteFile).
  566. Post(bindIgnErr(auth.DeleteRepoFileForm{}), repo.DeleteFilePost)
  567. m.Combo("/_upload/*", repo.MustBeAbleToUpload).
  568. Get(repo.UploadFile).
  569. Post(bindIgnErr(auth.UploadRepoFileForm{}), repo.UploadFilePost)
  570. }, context.RepoRefByType(context.RepoRefBranch), repo.MustBeEditable)
  571. m.Group("", func() {
  572. m.Post("/upload-file", repo.UploadFileToServer)
  573. m.Post("/upload-remove", bindIgnErr(auth.RemoveUploadFileForm{}), repo.RemoveUploadFileFromServer)
  574. }, context.RepoRef(), repo.MustBeEditable, repo.MustBeAbleToUpload)
  575. }, context.RepoMustNotBeArchived(), reqRepoCodeWriter, repo.MustBeNotEmpty)
  576. m.Group("/branches", func() {
  577. m.Group("/_new/", func() {
  578. m.Post("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.CreateBranch)
  579. m.Post("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.CreateBranch)
  580. m.Post("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.CreateBranch)
  581. }, bindIgnErr(auth.NewBranchForm{}))
  582. m.Post("/delete", repo.DeleteBranchPost)
  583. m.Post("/restore", repo.RestoreBranchPost)
  584. }, context.RepoMustNotBeArchived(), reqRepoCodeWriter, repo.MustBeNotEmpty)
  585. }, reqSignIn, context.RepoAssignment(), context.UnitTypes())
  586. // Releases
  587. m.Group("/:username/:reponame", func() {
  588. m.Group("/releases", func() {
  589. m.Get("/", repo.MustBeNotEmpty, repo.Releases)
  590. }, repo.MustBeNotEmpty, context.RepoRef())
  591. m.Group("/releases", func() {
  592. m.Get("/new", repo.NewRelease)
  593. m.Post("/new", bindIgnErr(auth.NewReleaseForm{}), repo.NewReleasePost)
  594. m.Post("/delete", repo.DeleteRelease)
  595. }, reqSignIn, repo.MustBeNotEmpty, context.RepoMustNotBeArchived(), reqRepoReleaseWriter, context.RepoRef())
  596. m.Group("/releases", func() {
  597. m.Get("/edit/*", repo.EditRelease)
  598. m.Post("/edit/*", bindIgnErr(auth.EditReleaseForm{}), repo.EditReleasePost)
  599. }, reqSignIn, repo.MustBeNotEmpty, context.RepoMustNotBeArchived(), reqRepoReleaseWriter, func(ctx *context.Context) {
  600. var err error
  601. ctx.Repo.Commit, err = ctx.Repo.GitRepo.GetBranchCommit(ctx.Repo.Repository.DefaultBranch)
  602. if err != nil {
  603. ctx.ServerError("GetBranchCommit", err)
  604. return
  605. }
  606. ctx.Repo.CommitsCount, err = ctx.Repo.GetCommitsCount()
  607. if err != nil {
  608. ctx.ServerError("GetCommitsCount", err)
  609. return
  610. }
  611. ctx.Data["CommitsCount"] = ctx.Repo.CommitsCount
  612. })
  613. }, ignSignIn, context.RepoAssignment(), context.UnitTypes(), reqRepoReleaseReader)
  614. m.Group("/:username/:reponame", func() {
  615. m.Post("/topics", repo.TopicsPost)
  616. }, context.RepoAssignment(), context.RepoMustNotBeArchived(), reqRepoAdmin)
  617. m.Group("/:username/:reponame", func() {
  618. m.Group("", func() {
  619. m.Get("/^:type(issues|pulls)$", repo.Issues)
  620. m.Get("/^:type(issues|pulls)$/:index", repo.ViewIssue)
  621. m.Get("/labels/", reqRepoIssuesOrPullsReader, repo.RetrieveLabels, repo.Labels)
  622. m.Get("/milestones", reqRepoIssuesOrPullsReader, repo.Milestones)
  623. }, context.RepoRef())
  624. m.Group("/wiki", func() {
  625. m.Get("/?:page", repo.Wiki)
  626. m.Get("/_pages", repo.WikiPages)
  627. m.Group("", func() {
  628. m.Combo("/_new").Get(repo.NewWiki).
  629. Post(bindIgnErr(auth.NewWikiForm{}), repo.NewWikiPost)
  630. m.Combo("/:page/_edit").Get(repo.EditWiki).
  631. Post(bindIgnErr(auth.NewWikiForm{}), repo.EditWikiPost)
  632. m.Post("/:page/delete", repo.DeleteWikiPagePost)
  633. }, context.RepoMustNotBeArchived(), reqSignIn, reqRepoWikiWriter)
  634. }, repo.MustEnableWiki, context.RepoRef())
  635. m.Group("/wiki", func() {
  636. m.Get("/raw/*", repo.WikiRaw)
  637. }, repo.MustEnableWiki)
  638. m.Group("/activity", func() {
  639. m.Get("", repo.Activity)
  640. m.Get("/:period", repo.Activity)
  641. }, context.RepoRef(), repo.MustBeNotEmpty, context.RequireRepoReaderOr(models.UnitTypePullRequests, models.UnitTypeIssues, models.UnitTypeReleases))
  642. m.Get("/archive/*", repo.MustBeNotEmpty, reqRepoCodeReader, repo.Download)
  643. m.Group("/branches", func() {
  644. m.Get("", repo.Branches)
  645. }, repo.MustBeNotEmpty, context.RepoRef(), reqRepoCodeReader)
  646. m.Group("/pulls/:index", func() {
  647. m.Get(".diff", repo.DownloadPullDiff)
  648. m.Get(".patch", repo.DownloadPullPatch)
  649. m.Get("/commits", context.RepoRef(), repo.ViewPullCommits)
  650. m.Post("/merge", context.RepoMustNotBeArchived(), reqRepoPullsWriter, bindIgnErr(auth.MergePullRequestForm{}), repo.MergePullRequest)
  651. m.Post("/cleanup", context.RepoMustNotBeArchived(), context.RepoRef(), repo.CleanUpPullRequest)
  652. m.Group("/files", func() {
  653. m.Get("", context.RepoRef(), repo.SetEditorconfigIfExists, repo.SetDiffViewStyle, repo.SetWhitespaceBehavior, repo.ViewPullFiles)
  654. m.Group("/reviews", func() {
  655. m.Post("/comments", bindIgnErr(auth.CodeCommentForm{}), repo.CreateCodeComment)
  656. m.Post("/submit", bindIgnErr(auth.SubmitReviewForm{}), repo.SubmitReview)
  657. }, context.RepoMustNotBeArchived())
  658. })
  659. }, repo.MustAllowPulls)
  660. m.Group("/media", func() {
  661. m.Get("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.SingleDownloadOrLFS)
  662. m.Get("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.SingleDownloadOrLFS)
  663. m.Get("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.SingleDownloadOrLFS)
  664. m.Get("/blob/:sha", context.RepoRefByType(context.RepoRefBlob), repo.DownloadByIDOrLFS)
  665. // "/*" route is deprecated, and kept for backward compatibility
  666. m.Get("/*", context.RepoRefByType(context.RepoRefLegacy), repo.SingleDownloadOrLFS)
  667. }, repo.MustBeNotEmpty, reqRepoCodeReader)
  668. m.Group("/raw", func() {
  669. m.Get("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.SingleDownload)
  670. m.Get("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.SingleDownload)
  671. m.Get("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.SingleDownload)
  672. m.Get("/blob/:sha", context.RepoRefByType(context.RepoRefBlob), repo.DownloadByID)
  673. // "/*" route is deprecated, and kept for backward compatibility
  674. m.Get("/*", context.RepoRefByType(context.RepoRefLegacy), repo.SingleDownload)
  675. }, repo.MustBeNotEmpty, reqRepoCodeReader)
  676. m.Group("/commits", func() {
  677. m.Get("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.RefCommits)
  678. m.Get("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.RefCommits)
  679. m.Get("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.RefCommits)
  680. // "/*" route is deprecated, and kept for backward compatibility
  681. m.Get("/*", context.RepoRefByType(context.RepoRefLegacy), repo.RefCommits)
  682. }, repo.MustBeNotEmpty, reqRepoCodeReader)
  683. m.Group("", func() {
  684. m.Get("/graph", repo.Graph)
  685. m.Get("/commit/:sha([a-f0-9]{7,40})$", repo.SetEditorconfigIfExists, repo.SetDiffViewStyle, repo.Diff)
  686. }, repo.MustBeNotEmpty, context.RepoRef(), reqRepoCodeReader)
  687. m.Group("/src", func() {
  688. m.Get("/branch/*", context.RepoRefByType(context.RepoRefBranch), repo.Home)
  689. m.Get("/tag/*", context.RepoRefByType(context.RepoRefTag), repo.Home)
  690. m.Get("/commit/*", context.RepoRefByType(context.RepoRefCommit), repo.Home)
  691. // "/*" route is deprecated, and kept for backward compatibility
  692. m.Get("/*", context.RepoRefByType(context.RepoRefLegacy), repo.Home)
  693. }, repo.SetEditorconfigIfExists)
  694. m.Group("", func() {
  695. m.Get("/forks", repo.Forks)
  696. }, context.RepoRef(), reqRepoCodeReader)
  697. m.Get("/commit/:sha([a-f0-9]{7,40})\\.:ext(patch|diff)",
  698. repo.MustBeNotEmpty, reqRepoCodeReader, repo.RawDiff)
  699. m.Get("/compare/:before([a-z0-9]{40})\\.\\.\\.:after([a-z0-9]{40})", repo.SetEditorconfigIfExists,
  700. repo.SetDiffViewStyle, repo.MustBeNotEmpty, reqRepoCodeReader, repo.CompareDiff)
  701. }, ignSignIn, context.RepoAssignment(), context.UnitTypes())
  702. m.Group("/:username/:reponame", func() {
  703. m.Get("/stars", repo.Stars)
  704. m.Get("/watchers", repo.Watchers)
  705. m.Get("/search", reqRepoCodeReader, repo.Search)
  706. }, ignSignIn, context.RepoAssignment(), context.RepoRef(), context.UnitTypes())
  707. m.Group("/:username", func() {
  708. m.Group("/:reponame", func() {
  709. m.Get("", repo.SetEditorconfigIfExists, repo.Home)
  710. m.Get("\\.git$", repo.SetEditorconfigIfExists, repo.Home)
  711. }, ignSignIn, context.RepoAssignment(), context.RepoRef(), context.UnitTypes())
  712. m.Group("/:reponame", func() {
  713. m.Group("\\.git/info/lfs", func() {
  714. m.Post("/objects/batch", lfs.BatchHandler)
  715. m.Get("/objects/:oid/:filename", lfs.ObjectOidHandler)
  716. m.Any("/objects/:oid", lfs.ObjectOidHandler)
  717. m.Post("/objects", lfs.PostHandler)
  718. m.Post("/verify", lfs.VerifyHandler)
  719. m.Group("/locks", func() {
  720. m.Get("/", lfs.GetListLockHandler)
  721. m.Post("/", lfs.PostLockHandler)
  722. m.Post("/verify", lfs.VerifyLockHandler)
  723. m.Post("/:lid/unlock", lfs.UnLockHandler)
  724. }, context.RepoAssignment())
  725. m.Any("/*", func(ctx *context.Context) {
  726. ctx.NotFound("", nil)
  727. })
  728. }, ignSignInAndCsrf)
  729. m.Any("/*", ignSignInAndCsrf, repo.HTTP)
  730. m.Head("/tasks/trigger", repo.TriggerTask)
  731. })
  732. })
  733. // ***** END: Repository *****
  734. m.Group("/notifications", func() {
  735. m.Get("", user.Notifications)
  736. m.Post("/status", user.NotificationStatusPost)
  737. m.Post("/purge", user.NotificationPurgePost)
  738. }, reqSignIn)
  739. if setting.API.EnableSwagger {
  740. m.Get("/swagger.v1.json", templates.JSONRenderer(), routers.SwaggerV1Json)
  741. }
  742. m.Group("/api", func() {
  743. apiv1.RegisterRoutes(m)
  744. }, ignSignIn)
  745. m.Group("/api/internal", func() {
  746. // package name internal is ideal but Golang is not allowed, so we use private as package name.
  747. private.RegisterRoutes(m)
  748. })
  749. // robots.txt
  750. m.Get("/robots.txt", func(ctx *context.Context) {
  751. if setting.HasRobotsTxt {
  752. ctx.ServeFileContent(path.Join(setting.CustomPath, "robots.txt"))
  753. } else {
  754. ctx.NotFound("", nil)
  755. }
  756. })
  757. // Progressive Web App
  758. m.Get("/manifest.json", templates.JSONRenderer(), func(ctx *context.Context) {
  759. ctx.HTML(200, "pwa/manifest_json")
  760. })
  761. m.Get("/serviceworker.js", templates.JSRenderer(), func(ctx *context.Context) {
  762. ctx.HTML(200, "pwa/serviceworker_js")
  763. })
  764. // prometheus metrics endpoint
  765. if setting.Metrics.Enabled {
  766. c := metrics.NewCollector()
  767. prometheus.MustRegister(c)
  768. m.Get("/metrics", routers.Metrics)
  769. }
  770. // Not found handler.
  771. m.NotFound(routers.NotFound)
  772. }