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

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