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.

api.go 27KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  1. // Copyright 2015 The Gogs Authors. All rights reserved.
  2. // Copyright 2016 The Gitea Authors. All rights reserved.
  3. // Use of this source code is governed by a MIT-style
  4. // license that can be found in the LICENSE file.
  5. // Package v1 Gitea API.
  6. //
  7. // This documentation describes the Gitea API.
  8. //
  9. // Schemes: http, https
  10. // BasePath: /api/v1
  11. // Version: 1.1.1
  12. // License: MIT http://opensource.org/licenses/MIT
  13. //
  14. // Consumes:
  15. // - application/json
  16. // - text/plain
  17. //
  18. // Produces:
  19. // - application/json
  20. // - text/html
  21. //
  22. // Security:
  23. // - BasicAuth :
  24. // - Token :
  25. // - AccessToken :
  26. // - AuthorizationHeaderToken :
  27. // - SudoParam :
  28. // - SudoHeader :
  29. //
  30. // SecurityDefinitions:
  31. // BasicAuth:
  32. // type: basic
  33. // Token:
  34. // type: apiKey
  35. // name: token
  36. // in: query
  37. // AccessToken:
  38. // type: apiKey
  39. // name: access_token
  40. // in: query
  41. // AuthorizationHeaderToken:
  42. // type: apiKey
  43. // name: Authorization
  44. // in: header
  45. // description: API tokens must be prepended with "token" followed by a space.
  46. // SudoParam:
  47. // type: apiKey
  48. // name: sudo
  49. // in: query
  50. // description: Sudo API request as the user provided as the key. Admin privileges are required.
  51. // SudoHeader:
  52. // type: apiKey
  53. // name: Sudo
  54. // in: header
  55. // description: Sudo API request as the user provided as the key. Admin privileges are required.
  56. //
  57. // swagger:meta
  58. package v1
  59. import (
  60. "strings"
  61. "code.gitea.io/gitea/models"
  62. "code.gitea.io/gitea/modules/auth"
  63. "code.gitea.io/gitea/modules/context"
  64. "code.gitea.io/gitea/modules/log"
  65. "code.gitea.io/gitea/modules/setting"
  66. api "code.gitea.io/gitea/modules/structs"
  67. "code.gitea.io/gitea/routers/api/v1/admin"
  68. "code.gitea.io/gitea/routers/api/v1/misc"
  69. "code.gitea.io/gitea/routers/api/v1/org"
  70. "code.gitea.io/gitea/routers/api/v1/repo"
  71. _ "code.gitea.io/gitea/routers/api/v1/swagger" // for swagger generation
  72. "code.gitea.io/gitea/routers/api/v1/user"
  73. "gitea.com/macaron/binding"
  74. "gitea.com/macaron/macaron"
  75. )
  76. func sudo() macaron.Handler {
  77. return func(ctx *context.APIContext) {
  78. sudo := ctx.Query("sudo")
  79. if len(sudo) == 0 {
  80. sudo = ctx.Req.Header.Get("Sudo")
  81. }
  82. if len(sudo) > 0 {
  83. if ctx.IsSigned && ctx.User.IsAdmin {
  84. user, err := models.GetUserByName(sudo)
  85. if err != nil {
  86. if models.IsErrUserNotExist(err) {
  87. ctx.NotFound()
  88. } else {
  89. ctx.Error(500, "GetUserByName", err)
  90. }
  91. return
  92. }
  93. log.Trace("Sudo from (%s) to: %s", ctx.User.Name, user.Name)
  94. ctx.User = user
  95. } else {
  96. ctx.JSON(403, map[string]string{
  97. "message": "Only administrators allowed to sudo.",
  98. })
  99. return
  100. }
  101. }
  102. }
  103. }
  104. func repoAssignment() macaron.Handler {
  105. return func(ctx *context.APIContext) {
  106. userName := ctx.Params(":username")
  107. repoName := ctx.Params(":reponame")
  108. var (
  109. owner *models.User
  110. err error
  111. )
  112. // Check if the user is the same as the repository owner.
  113. if ctx.IsSigned && ctx.User.LowerName == strings.ToLower(userName) {
  114. owner = ctx.User
  115. } else {
  116. owner, err = models.GetUserByName(userName)
  117. if err != nil {
  118. if models.IsErrUserNotExist(err) {
  119. ctx.NotFound()
  120. } else {
  121. ctx.Error(500, "GetUserByName", err)
  122. }
  123. return
  124. }
  125. }
  126. ctx.Repo.Owner = owner
  127. // Get repository.
  128. repo, err := models.GetRepositoryByName(owner.ID, repoName)
  129. if err != nil {
  130. if models.IsErrRepoNotExist(err) {
  131. redirectRepoID, err := models.LookupRepoRedirect(owner.ID, repoName)
  132. if err == nil {
  133. context.RedirectToRepo(ctx.Context, redirectRepoID)
  134. } else if models.IsErrRepoRedirectNotExist(err) {
  135. ctx.NotFound()
  136. } else {
  137. ctx.Error(500, "LookupRepoRedirect", err)
  138. }
  139. } else {
  140. ctx.Error(500, "GetRepositoryByName", err)
  141. }
  142. return
  143. }
  144. repo.Owner = owner
  145. ctx.Repo.Repository = repo
  146. ctx.Repo.Permission, err = models.GetUserRepoPermission(repo, ctx.User)
  147. if err != nil {
  148. ctx.Error(500, "GetUserRepoPermission", err)
  149. return
  150. }
  151. if !ctx.Repo.HasAccess() {
  152. ctx.NotFound()
  153. return
  154. }
  155. }
  156. }
  157. // Contexter middleware already checks token for user sign in process.
  158. func reqToken() macaron.Handler {
  159. return func(ctx *context.APIContext) {
  160. if true == ctx.Data["IsApiToken"] {
  161. return
  162. }
  163. if ctx.Context.IsBasicAuth {
  164. ctx.CheckForOTP()
  165. return
  166. }
  167. if ctx.IsSigned {
  168. ctx.RequireCSRF()
  169. return
  170. }
  171. ctx.Context.Error(401)
  172. }
  173. }
  174. func reqBasicAuth() macaron.Handler {
  175. return func(ctx *context.APIContext) {
  176. if !ctx.Context.IsBasicAuth {
  177. ctx.Context.Error(401)
  178. return
  179. }
  180. ctx.CheckForOTP()
  181. }
  182. }
  183. // reqSiteAdmin user should be the site admin
  184. func reqSiteAdmin() macaron.Handler {
  185. return func(ctx *context.Context) {
  186. if !ctx.IsUserSiteAdmin() {
  187. ctx.Error(403)
  188. return
  189. }
  190. }
  191. }
  192. // reqOwner user should be the owner of the repo or site admin.
  193. func reqOwner() macaron.Handler {
  194. return func(ctx *context.Context) {
  195. if !ctx.IsUserRepoOwner() && !ctx.IsUserSiteAdmin() {
  196. ctx.Error(403)
  197. return
  198. }
  199. }
  200. }
  201. // reqAdmin user should be an owner or a collaborator with admin write of a repository, or site admin
  202. func reqAdmin() macaron.Handler {
  203. return func(ctx *context.Context) {
  204. if !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  205. ctx.Error(403)
  206. return
  207. }
  208. }
  209. }
  210. // reqRepoWriter user should have a permission to write to a repo, or be a site admin
  211. func reqRepoWriter(unitTypes ...models.UnitType) macaron.Handler {
  212. return func(ctx *context.Context) {
  213. if !ctx.IsUserRepoWriter(unitTypes) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  214. ctx.Error(403)
  215. return
  216. }
  217. }
  218. }
  219. // reqRepoReader user should have specific read permission or be a repo admin or a site admin
  220. func reqRepoReader(unitType models.UnitType) macaron.Handler {
  221. return func(ctx *context.Context) {
  222. if !ctx.IsUserRepoReaderSpecific(unitType) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  223. ctx.Error(403)
  224. return
  225. }
  226. }
  227. }
  228. // reqAnyRepoReader user should have any permission to read repository or permissions of site admin
  229. func reqAnyRepoReader() macaron.Handler {
  230. return func(ctx *context.Context) {
  231. if !ctx.IsUserRepoReaderAny() && !ctx.IsUserSiteAdmin() {
  232. ctx.Error(403)
  233. return
  234. }
  235. }
  236. }
  237. // reqOrgOwnership user should be an organization owner, or a site admin
  238. func reqOrgOwnership() macaron.Handler {
  239. return func(ctx *context.APIContext) {
  240. if ctx.Context.IsUserSiteAdmin() {
  241. return
  242. }
  243. var orgID int64
  244. if ctx.Org.Organization != nil {
  245. orgID = ctx.Org.Organization.ID
  246. } else if ctx.Org.Team != nil {
  247. orgID = ctx.Org.Team.OrgID
  248. } else {
  249. ctx.Error(500, "", "reqOrgOwnership: unprepared context")
  250. return
  251. }
  252. isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID)
  253. if err != nil {
  254. ctx.Error(500, "IsOrganizationOwner", err)
  255. return
  256. } else if !isOwner {
  257. if ctx.Org.Organization != nil {
  258. ctx.Error(403, "", "Must be an organization owner")
  259. } else {
  260. ctx.NotFound()
  261. }
  262. return
  263. }
  264. }
  265. }
  266. // reqTeamMembership user should be an team member, or a site admin
  267. func reqTeamMembership() macaron.Handler {
  268. return func(ctx *context.APIContext) {
  269. if ctx.Context.IsUserSiteAdmin() {
  270. return
  271. }
  272. if ctx.Org.Team == nil {
  273. ctx.Error(500, "", "reqTeamMembership: unprepared context")
  274. return
  275. }
  276. var orgID = ctx.Org.Team.OrgID
  277. isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID)
  278. if err != nil {
  279. ctx.Error(500, "IsOrganizationOwner", err)
  280. return
  281. } else if isOwner {
  282. return
  283. }
  284. if isTeamMember, err := models.IsTeamMember(orgID, ctx.Org.Team.ID, ctx.User.ID); err != nil {
  285. ctx.Error(500, "IsTeamMember", err)
  286. return
  287. } else if !isTeamMember {
  288. isOrgMember, err := models.IsOrganizationMember(orgID, ctx.User.ID)
  289. if err != nil {
  290. ctx.Error(500, "IsOrganizationMember", err)
  291. } else if isOrgMember {
  292. ctx.Error(403, "", "Must be a team member")
  293. } else {
  294. ctx.NotFound()
  295. }
  296. return
  297. }
  298. }
  299. }
  300. // reqOrgMembership user should be an organization member, or a site admin
  301. func reqOrgMembership() macaron.Handler {
  302. return func(ctx *context.APIContext) {
  303. if ctx.Context.IsUserSiteAdmin() {
  304. return
  305. }
  306. var orgID int64
  307. if ctx.Org.Organization != nil {
  308. orgID = ctx.Org.Organization.ID
  309. } else if ctx.Org.Team != nil {
  310. orgID = ctx.Org.Team.OrgID
  311. } else {
  312. ctx.Error(500, "", "reqOrgMembership: unprepared context")
  313. return
  314. }
  315. if isMember, err := models.IsOrganizationMember(orgID, ctx.User.ID); err != nil {
  316. ctx.Error(500, "IsOrganizationMember", err)
  317. return
  318. } else if !isMember {
  319. if ctx.Org.Organization != nil {
  320. ctx.Error(403, "", "Must be an organization member")
  321. } else {
  322. ctx.NotFound()
  323. }
  324. return
  325. }
  326. }
  327. }
  328. func reqGitHook() macaron.Handler {
  329. return func(ctx *context.APIContext) {
  330. if !ctx.User.CanEditGitHook() {
  331. ctx.Error(403, "", "must be allowed to edit Git hooks")
  332. return
  333. }
  334. }
  335. }
  336. func orgAssignment(args ...bool) macaron.Handler {
  337. var (
  338. assignOrg bool
  339. assignTeam bool
  340. )
  341. if len(args) > 0 {
  342. assignOrg = args[0]
  343. }
  344. if len(args) > 1 {
  345. assignTeam = args[1]
  346. }
  347. return func(ctx *context.APIContext) {
  348. ctx.Org = new(context.APIOrganization)
  349. var err error
  350. if assignOrg {
  351. ctx.Org.Organization, err = models.GetOrgByName(ctx.Params(":orgname"))
  352. if err != nil {
  353. if models.IsErrOrgNotExist(err) {
  354. ctx.NotFound()
  355. } else {
  356. ctx.Error(500, "GetOrgByName", err)
  357. }
  358. return
  359. }
  360. }
  361. if assignTeam {
  362. ctx.Org.Team, err = models.GetTeamByID(ctx.ParamsInt64(":teamid"))
  363. if err != nil {
  364. if models.IsErrUserNotExist(err) {
  365. ctx.NotFound()
  366. } else {
  367. ctx.Error(500, "GetTeamById", err)
  368. }
  369. return
  370. }
  371. }
  372. }
  373. }
  374. func mustEnableIssues(ctx *context.APIContext) {
  375. if !ctx.Repo.CanRead(models.UnitTypeIssues) {
  376. if log.IsTrace() {
  377. if ctx.IsSigned {
  378. log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
  379. "User in Repo has Permissions: %-+v",
  380. ctx.User,
  381. models.UnitTypeIssues,
  382. ctx.Repo.Repository,
  383. ctx.Repo.Permission)
  384. } else {
  385. log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
  386. "Anonymous user in Repo has Permissions: %-+v",
  387. models.UnitTypeIssues,
  388. ctx.Repo.Repository,
  389. ctx.Repo.Permission)
  390. }
  391. }
  392. ctx.NotFound()
  393. return
  394. }
  395. }
  396. func mustAllowPulls(ctx *context.APIContext) {
  397. if !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
  398. if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
  399. if ctx.IsSigned {
  400. log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
  401. "User in Repo has Permissions: %-+v",
  402. ctx.User,
  403. models.UnitTypePullRequests,
  404. ctx.Repo.Repository,
  405. ctx.Repo.Permission)
  406. } else {
  407. log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
  408. "Anonymous user in Repo has Permissions: %-+v",
  409. models.UnitTypePullRequests,
  410. ctx.Repo.Repository,
  411. ctx.Repo.Permission)
  412. }
  413. }
  414. ctx.NotFound()
  415. return
  416. }
  417. }
  418. func mustEnableIssuesOrPulls(ctx *context.APIContext) {
  419. if !ctx.Repo.CanRead(models.UnitTypeIssues) &&
  420. !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
  421. if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
  422. if ctx.IsSigned {
  423. log.Trace("Permission Denied: User %-v cannot read %-v and %-v in Repo %-v\n"+
  424. "User in Repo has Permissions: %-+v",
  425. ctx.User,
  426. models.UnitTypeIssues,
  427. models.UnitTypePullRequests,
  428. ctx.Repo.Repository,
  429. ctx.Repo.Permission)
  430. } else {
  431. log.Trace("Permission Denied: Anonymous user cannot read %-v and %-v in Repo %-v\n"+
  432. "Anonymous user in Repo has Permissions: %-+v",
  433. models.UnitTypeIssues,
  434. models.UnitTypePullRequests,
  435. ctx.Repo.Repository,
  436. ctx.Repo.Permission)
  437. }
  438. }
  439. ctx.NotFound()
  440. return
  441. }
  442. }
  443. func mustEnableUserHeatmap(ctx *context.APIContext) {
  444. if !setting.Service.EnableUserHeatmap {
  445. ctx.NotFound()
  446. return
  447. }
  448. }
  449. func mustNotBeArchived(ctx *context.APIContext) {
  450. if ctx.Repo.Repository.IsArchived {
  451. ctx.NotFound()
  452. return
  453. }
  454. }
  455. // RegisterRoutes registers all v1 APIs routes to web application.
  456. // FIXME: custom form error response
  457. func RegisterRoutes(m *macaron.Macaron) {
  458. bind := binding.Bind
  459. if setting.API.EnableSwagger {
  460. m.Get("/swagger", misc.Swagger) //Render V1 by default
  461. }
  462. m.Group("/v1", func() {
  463. // Miscellaneous
  464. if setting.API.EnableSwagger {
  465. m.Get("/swagger", misc.Swagger)
  466. }
  467. m.Get("/version", misc.Version)
  468. m.Get("/signing-key.gpg", misc.SigningKey)
  469. m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
  470. m.Post("/markdown/raw", misc.MarkdownRaw)
  471. // Users
  472. m.Group("/users", func() {
  473. m.Get("/search", user.Search)
  474. m.Group("/:username", func() {
  475. m.Get("", user.GetInfo)
  476. m.Get("/heatmap", mustEnableUserHeatmap, user.GetUserHeatmapData)
  477. m.Get("/repos", user.ListUserRepos)
  478. m.Group("/tokens", func() {
  479. m.Combo("").Get(user.ListAccessTokens).
  480. Post(bind(api.CreateAccessTokenOption{}), user.CreateAccessToken)
  481. m.Combo("/:id").Delete(user.DeleteAccessToken)
  482. }, reqBasicAuth())
  483. })
  484. })
  485. m.Group("/users", func() {
  486. m.Group("/:username", func() {
  487. m.Get("/keys", user.ListPublicKeys)
  488. m.Get("/gpg_keys", user.ListGPGKeys)
  489. m.Get("/followers", user.ListFollowers)
  490. m.Group("/following", func() {
  491. m.Get("", user.ListFollowing)
  492. m.Get("/:target", user.CheckFollowing)
  493. })
  494. m.Get("/starred", user.GetStarredRepos)
  495. m.Get("/subscriptions", user.GetWatchedRepos)
  496. })
  497. }, reqToken())
  498. m.Group("/user", func() {
  499. m.Get("", user.GetAuthenticatedUser)
  500. m.Combo("/emails").Get(user.ListEmails).
  501. Post(bind(api.CreateEmailOption{}), user.AddEmail).
  502. Delete(bind(api.DeleteEmailOption{}), user.DeleteEmail)
  503. m.Get("/followers", user.ListMyFollowers)
  504. m.Group("/following", func() {
  505. m.Get("", user.ListMyFollowing)
  506. m.Combo("/:username").Get(user.CheckMyFollowing).Put(user.Follow).Delete(user.Unfollow)
  507. })
  508. m.Group("/keys", func() {
  509. m.Combo("").Get(user.ListMyPublicKeys).
  510. Post(bind(api.CreateKeyOption{}), user.CreatePublicKey)
  511. m.Combo("/:id").Get(user.GetPublicKey).
  512. Delete(user.DeletePublicKey)
  513. })
  514. m.Group("/gpg_keys", func() {
  515. m.Combo("").Get(user.ListMyGPGKeys).
  516. Post(bind(api.CreateGPGKeyOption{}), user.CreateGPGKey)
  517. m.Combo("/:id").Get(user.GetGPGKey).
  518. Delete(user.DeleteGPGKey)
  519. })
  520. m.Combo("/repos").Get(user.ListMyRepos).
  521. Post(bind(api.CreateRepoOption{}), repo.Create)
  522. m.Group("/starred", func() {
  523. m.Get("", user.GetMyStarredRepos)
  524. m.Group("/:username/:reponame", func() {
  525. m.Get("", user.IsStarring)
  526. m.Put("", user.Star)
  527. m.Delete("", user.Unstar)
  528. }, repoAssignment())
  529. })
  530. m.Get("/times", repo.ListMyTrackedTimes)
  531. m.Get("/subscriptions", user.GetMyWatchedRepos)
  532. m.Get("/teams", org.ListUserTeams)
  533. }, reqToken())
  534. // Repositories
  535. m.Post("/org/:org/repos", reqToken(), bind(api.CreateRepoOption{}), repo.CreateOrgRepo)
  536. m.Group("/repos", func() {
  537. m.Get("/search", repo.Search)
  538. })
  539. m.Combo("/repositories/:id", reqToken()).Get(repo.GetByID)
  540. m.Group("/repos", func() {
  541. m.Post("/migrate", reqToken(), bind(auth.MigrateRepoForm{}), repo.Migrate)
  542. m.Group("/:username/:reponame", func() {
  543. m.Combo("").Get(reqAnyRepoReader(), repo.Get).
  544. Delete(reqToken(), reqOwner(), repo.Delete).
  545. Patch(reqToken(), reqAdmin(), bind(api.EditRepoOption{}), repo.Edit)
  546. m.Group("/hooks", func() {
  547. m.Combo("").Get(repo.ListHooks).
  548. Post(bind(api.CreateHookOption{}), repo.CreateHook)
  549. m.Group("/:id", func() {
  550. m.Combo("").Get(repo.GetHook).
  551. Patch(bind(api.EditHookOption{}), repo.EditHook).
  552. Delete(repo.DeleteHook)
  553. m.Post("/tests", context.RepoRef(), repo.TestHook)
  554. })
  555. m.Group("/git", func() {
  556. m.Combo("").Get(repo.ListGitHooks)
  557. m.Group("/:id", func() {
  558. m.Combo("").Get(repo.GetGitHook).
  559. Patch(bind(api.EditGitHookOption{}), repo.EditGitHook).
  560. Delete(repo.DeleteGitHook)
  561. })
  562. }, reqGitHook(), context.ReferencesGitRepo(true))
  563. }, reqToken(), reqAdmin())
  564. m.Group("/collaborators", func() {
  565. m.Get("", repo.ListCollaborators)
  566. m.Combo("/:collaborator").Get(repo.IsCollaborator).
  567. Put(bind(api.AddCollaboratorOption{}), repo.AddCollaborator).
  568. Delete(repo.DeleteCollaborator)
  569. }, reqToken(), reqAdmin())
  570. m.Get("/raw/*", context.RepoRefByType(context.RepoRefAny), reqRepoReader(models.UnitTypeCode), repo.GetRawFile)
  571. m.Get("/archive/*", reqRepoReader(models.UnitTypeCode), repo.GetArchive)
  572. m.Combo("/forks").Get(repo.ListForks).
  573. Post(reqToken(), reqRepoReader(models.UnitTypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
  574. m.Group("/branches", func() {
  575. m.Get("", repo.ListBranches)
  576. m.Get("/*", context.RepoRefByType(context.RepoRefBranch), repo.GetBranch)
  577. }, reqRepoReader(models.UnitTypeCode))
  578. m.Group("/tags", func() {
  579. m.Get("", repo.ListTags)
  580. }, reqRepoReader(models.UnitTypeCode))
  581. m.Group("/keys", func() {
  582. m.Combo("").Get(repo.ListDeployKeys).
  583. Post(bind(api.CreateKeyOption{}), repo.CreateDeployKey)
  584. m.Combo("/:id").Get(repo.GetDeployKey).
  585. Delete(repo.DeleteDeploykey)
  586. }, reqToken(), reqAdmin())
  587. m.Group("/times", func() {
  588. m.Combo("").Get(repo.ListTrackedTimesByRepository)
  589. m.Combo("/:timetrackingusername").Get(repo.ListTrackedTimesByUser)
  590. }, mustEnableIssues)
  591. m.Group("/issues", func() {
  592. m.Combo("").Get(repo.ListIssues).
  593. Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueOption{}), repo.CreateIssue)
  594. m.Group("/comments", func() {
  595. m.Get("", repo.ListRepoIssueComments)
  596. m.Combo("/:id", reqToken()).
  597. Patch(mustNotBeArchived, bind(api.EditIssueCommentOption{}), repo.EditIssueComment).
  598. Delete(repo.DeleteIssueComment)
  599. })
  600. m.Group("/:index", func() {
  601. m.Combo("").Get(repo.GetIssue).
  602. Patch(reqToken(), bind(api.EditIssueOption{}), repo.EditIssue)
  603. m.Group("/comments", func() {
  604. m.Combo("").Get(repo.ListIssueComments).
  605. Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueCommentOption{}), repo.CreateIssueComment)
  606. m.Combo("/:id", reqToken()).Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueCommentDeprecated).
  607. Delete(repo.DeleteIssueCommentDeprecated)
  608. })
  609. m.Group("/labels", func() {
  610. m.Combo("").Get(repo.ListIssueLabels).
  611. Post(reqToken(), bind(api.IssueLabelsOption{}), repo.AddIssueLabels).
  612. Put(reqToken(), bind(api.IssueLabelsOption{}), repo.ReplaceIssueLabels).
  613. Delete(reqToken(), repo.ClearIssueLabels)
  614. m.Delete("/:id", reqToken(), repo.DeleteIssueLabel)
  615. })
  616. m.Group("/times", func() {
  617. m.Combo("").Get(repo.ListTrackedTimes).
  618. Post(reqToken(), bind(api.AddTimeOption{}), repo.AddTime)
  619. })
  620. m.Combo("/deadline").Post(reqToken(), bind(api.EditDeadlineOption{}), repo.UpdateIssueDeadline)
  621. m.Group("/stopwatch", func() {
  622. m.Post("/start", reqToken(), repo.StartIssueStopwatch)
  623. m.Post("/stop", reqToken(), repo.StopIssueStopwatch)
  624. })
  625. })
  626. }, mustEnableIssuesOrPulls)
  627. m.Group("/labels", func() {
  628. m.Combo("").Get(repo.ListLabels).
  629. Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateLabelOption{}), repo.CreateLabel)
  630. m.Combo("/:id").Get(repo.GetLabel).
  631. Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditLabelOption{}), repo.EditLabel).
  632. Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteLabel)
  633. })
  634. m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
  635. m.Post("/markdown/raw", misc.MarkdownRaw)
  636. m.Group("/milestones", func() {
  637. m.Combo("").Get(repo.ListMilestones).
  638. Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateMilestoneOption{}), repo.CreateMilestone)
  639. m.Combo("/:id").Get(repo.GetMilestone).
  640. Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditMilestoneOption{}), repo.EditMilestone).
  641. Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteMilestone)
  642. })
  643. m.Get("/stargazers", repo.ListStargazers)
  644. m.Get("/subscribers", repo.ListSubscribers)
  645. m.Group("/subscription", func() {
  646. m.Get("", user.IsWatching)
  647. m.Put("", reqToken(), user.Watch)
  648. m.Delete("", reqToken(), user.Unwatch)
  649. })
  650. m.Group("/releases", func() {
  651. m.Combo("").Get(repo.ListReleases).
  652. Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.CreateReleaseOption{}), repo.CreateRelease)
  653. m.Group("/:id", func() {
  654. m.Combo("").Get(repo.GetRelease).
  655. Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.EditReleaseOption{}), repo.EditRelease).
  656. Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteRelease)
  657. m.Group("/assets", func() {
  658. m.Combo("").Get(repo.ListReleaseAttachments).
  659. Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.CreateReleaseAttachment)
  660. m.Combo("/:asset").Get(repo.GetReleaseAttachment).
  661. Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), bind(api.EditAttachmentOptions{}), repo.EditReleaseAttachment).
  662. Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteReleaseAttachment)
  663. })
  664. })
  665. }, reqRepoReader(models.UnitTypeReleases))
  666. m.Post("/mirror-sync", reqToken(), reqRepoWriter(models.UnitTypeCode), repo.MirrorSync)
  667. m.Get("/editorconfig/:filename", context.RepoRef(), reqRepoReader(models.UnitTypeCode), repo.GetEditorconfig)
  668. m.Group("/pulls", func() {
  669. m.Combo("").Get(bind(api.ListPullRequestsOptions{}), repo.ListPullRequests).
  670. Post(reqToken(), mustNotBeArchived, bind(api.CreatePullRequestOption{}), repo.CreatePullRequest)
  671. m.Group("/:index", func() {
  672. m.Combo("").Get(repo.GetPullRequest).
  673. Patch(reqToken(), reqRepoWriter(models.UnitTypePullRequests), bind(api.EditPullRequestOption{}), repo.EditPullRequest)
  674. m.Combo("/merge").Get(repo.IsPullRequestMerged).
  675. Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest)
  676. })
  677. }, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo(false))
  678. m.Group("/statuses", func() {
  679. m.Combo("/:sha").Get(repo.GetCommitStatuses).
  680. Post(reqToken(), bind(api.CreateStatusOption{}), repo.NewCommitStatus)
  681. }, reqRepoReader(models.UnitTypeCode))
  682. m.Group("/commits", func() {
  683. m.Get("", repo.GetAllCommits)
  684. m.Group("/:ref", func() {
  685. // TODO: Add m.Get("") for single commit (https://developer.github.com/v3/repos/commits/#get-a-single-commit)
  686. m.Get("/status", repo.GetCombinedCommitStatusByRef)
  687. m.Get("/statuses", repo.GetCommitStatusesByRef)
  688. })
  689. }, reqRepoReader(models.UnitTypeCode))
  690. m.Group("/git", func() {
  691. m.Group("/commits", func() {
  692. m.Get("/:sha", repo.GetSingleCommit)
  693. })
  694. m.Get("/refs", repo.GetGitAllRefs)
  695. m.Get("/refs/*", repo.GetGitRefs)
  696. m.Get("/trees/:sha", context.RepoRef(), repo.GetTree)
  697. m.Get("/blobs/:sha", context.RepoRef(), repo.GetBlob)
  698. m.Get("/tags/:sha", context.RepoRef(), repo.GetTag)
  699. }, reqRepoReader(models.UnitTypeCode))
  700. m.Group("/contents", func() {
  701. m.Get("", repo.GetContentsList)
  702. m.Get("/*", repo.GetContents)
  703. m.Group("/*", func() {
  704. m.Post("", bind(api.CreateFileOptions{}), repo.CreateFile)
  705. m.Put("", bind(api.UpdateFileOptions{}), repo.UpdateFile)
  706. m.Delete("", bind(api.DeleteFileOptions{}), repo.DeleteFile)
  707. }, reqRepoWriter(models.UnitTypeCode), reqToken())
  708. }, reqRepoReader(models.UnitTypeCode))
  709. m.Get("/signing-key.gpg", misc.SigningKey)
  710. m.Group("/topics", func() {
  711. m.Combo("").Get(repo.ListTopics).
  712. Put(reqToken(), reqAdmin(), bind(api.RepoTopicOptions{}), repo.UpdateTopics)
  713. m.Group("/:topic", func() {
  714. m.Combo("").Put(reqToken(), repo.AddTopic).
  715. Delete(reqToken(), repo.DeleteTopic)
  716. }, reqAdmin())
  717. }, reqAnyRepoReader())
  718. }, repoAssignment())
  719. })
  720. // Organizations
  721. m.Get("/user/orgs", reqToken(), org.ListMyOrgs)
  722. m.Get("/users/:username/orgs", org.ListUserOrgs)
  723. m.Post("/orgs", reqToken(), bind(api.CreateOrgOption{}), org.Create)
  724. m.Group("/orgs/:orgname", func() {
  725. m.Get("/repos", user.ListOrgRepos)
  726. m.Combo("").Get(org.Get).
  727. Patch(reqToken(), reqOrgOwnership(), bind(api.EditOrgOption{}), org.Edit).
  728. Delete(reqToken(), reqOrgOwnership(), org.Delete)
  729. m.Group("/members", func() {
  730. m.Get("", org.ListMembers)
  731. m.Combo("/:username").Get(org.IsMember).
  732. Delete(reqToken(), reqOrgOwnership(), org.DeleteMember)
  733. })
  734. m.Group("/public_members", func() {
  735. m.Get("", org.ListPublicMembers)
  736. m.Combo("/:username").Get(org.IsPublicMember).
  737. Put(reqToken(), reqOrgMembership(), org.PublicizeMember).
  738. Delete(reqToken(), reqOrgMembership(), org.ConcealMember)
  739. })
  740. m.Group("/teams", func() {
  741. m.Combo("", reqToken()).Get(org.ListTeams).
  742. Post(reqOrgOwnership(), bind(api.CreateTeamOption{}), org.CreateTeam)
  743. m.Get("/search", org.SearchTeam)
  744. }, reqOrgMembership())
  745. m.Group("/hooks", func() {
  746. m.Combo("").Get(org.ListHooks).
  747. Post(bind(api.CreateHookOption{}), org.CreateHook)
  748. m.Combo("/:id").Get(org.GetHook).
  749. Patch(bind(api.EditHookOption{}), org.EditHook).
  750. Delete(org.DeleteHook)
  751. }, reqToken(), reqOrgOwnership())
  752. }, orgAssignment(true))
  753. m.Group("/teams/:teamid", func() {
  754. m.Combo("").Get(org.GetTeam).
  755. Patch(reqOrgOwnership(), bind(api.EditTeamOption{}), org.EditTeam).
  756. Delete(reqOrgOwnership(), org.DeleteTeam)
  757. m.Group("/members", func() {
  758. m.Get("", org.GetTeamMembers)
  759. m.Combo("/:username").
  760. Get(org.GetTeamMember).
  761. Put(reqOrgOwnership(), org.AddTeamMember).
  762. Delete(reqOrgOwnership(), org.RemoveTeamMember)
  763. })
  764. m.Group("/repos", func() {
  765. m.Get("", org.GetTeamRepos)
  766. m.Combo("/:orgname/:reponame").
  767. Put(org.AddTeamRepository).
  768. Delete(org.RemoveTeamRepository)
  769. })
  770. }, orgAssignment(false, true), reqToken(), reqTeamMembership())
  771. m.Any("/*", func(ctx *context.APIContext) {
  772. ctx.NotFound()
  773. })
  774. m.Group("/admin", func() {
  775. m.Get("/orgs", admin.GetAllOrgs)
  776. m.Group("/users", func() {
  777. m.Get("", admin.GetAllUsers)
  778. m.Post("", bind(api.CreateUserOption{}), admin.CreateUser)
  779. m.Group("/:username", func() {
  780. m.Combo("").Patch(bind(api.EditUserOption{}), admin.EditUser).
  781. Delete(admin.DeleteUser)
  782. m.Group("/keys", func() {
  783. m.Post("", bind(api.CreateKeyOption{}), admin.CreatePublicKey)
  784. m.Delete("/:id", admin.DeleteUserPublicKey)
  785. })
  786. m.Get("/orgs", org.ListUserOrgs)
  787. m.Post("/orgs", bind(api.CreateOrgOption{}), admin.CreateOrg)
  788. m.Post("/repos", bind(api.CreateRepoOption{}), admin.CreateRepo)
  789. })
  790. })
  791. }, reqToken(), reqSiteAdmin())
  792. m.Group("/topics", func() {
  793. m.Get("/search", repo.TopicSearch)
  794. })
  795. }, securityHeaders(), context.APIContexter(), sudo())
  796. }
  797. func securityHeaders() macaron.Handler {
  798. return func(ctx *macaron.Context) {
  799. ctx.Resp.Before(func(w macaron.ResponseWriter) {
  800. // CORB: https://www.chromium.org/Home/chromium-security/corb-for-developers
  801. // http://stackoverflow.com/a/3146618/244009
  802. w.Header().Set("x-content-type-options", "nosniff")
  803. })
  804. }
  805. }