api.go 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. package v1
  2. import (
  3. "gitote/gitote/models"
  4. "gitote/gitote/models/errors"
  5. "gitote/gitote/pkg/context"
  6. "gitote/gitote/pkg/form"
  7. "gitote/gitote/routes/api/v1/admin"
  8. "gitote/gitote/routes/api/v1/misc"
  9. "gitote/gitote/routes/api/v1/org"
  10. "gitote/gitote/routes/api/v1/repo"
  11. "gitote/gitote/routes/api/v1/user"
  12. "net/http"
  13. "strings"
  14. "github.com/go-macaron/binding"
  15. api "gitlab.com/gitote/go-gitote-client"
  16. "gopkg.in/macaron.v1"
  17. )
  18. func repoAssignment() macaron.Handler {
  19. return func(c *context.APIContext) {
  20. userName := c.Params(":username")
  21. repoName := c.Params(":reponame")
  22. var (
  23. owner *models.User
  24. err error
  25. )
  26. // Check if the user is the same as the repository owner.
  27. if c.IsLogged && c.User.LowerName == strings.ToLower(userName) {
  28. owner = c.User
  29. } else {
  30. owner, err = models.GetUserByName(userName)
  31. if err != nil {
  32. c.NotFoundOrServerError("GetUserByName", errors.IsUserNotExist, err)
  33. return
  34. }
  35. }
  36. c.Repo.Owner = owner
  37. repo, err := models.GetRepositoryByName(owner.ID, repoName)
  38. if err != nil {
  39. c.NotFoundOrServerError("GetRepositoryByName", errors.IsRepoNotExist, err)
  40. return
  41. } else if err = repo.GetOwner(); err != nil {
  42. c.ServerError("GetOwner", err)
  43. return
  44. }
  45. if c.IsTokenAuth && c.User.IsAdmin {
  46. c.Repo.AccessMode = models.ACCESS_MODE_OWNER
  47. } else {
  48. mode, err := models.AccessLevel(c.UserID(), repo)
  49. if err != nil {
  50. c.ServerError("AccessLevel", err)
  51. return
  52. }
  53. c.Repo.AccessMode = mode
  54. }
  55. if !c.Repo.HasAccess() {
  56. c.NotFound()
  57. return
  58. }
  59. c.Repo.Repository = repo
  60. }
  61. }
  62. // Contexter middleware already checks token for user sign in process.
  63. func reqToken() macaron.Handler {
  64. return func(c *context.Context) {
  65. if !c.IsTokenAuth {
  66. c.Error(http.StatusUnauthorized)
  67. return
  68. }
  69. }
  70. }
  71. func reqBasicAuth() macaron.Handler {
  72. return func(c *context.Context) {
  73. if !c.IsBasicAuth {
  74. c.Error(http.StatusUnauthorized)
  75. return
  76. }
  77. }
  78. }
  79. func reqAdmin() macaron.Handler {
  80. return func(c *context.Context) {
  81. if !c.IsLogged || !c.User.IsAdmin {
  82. c.Error(http.StatusForbidden)
  83. return
  84. }
  85. }
  86. }
  87. func reqRepoWriter() macaron.Handler {
  88. return func(c *context.Context) {
  89. if !c.Repo.IsWriter() {
  90. c.Error(http.StatusForbidden)
  91. return
  92. }
  93. }
  94. }
  95. func orgAssignment(args ...bool) macaron.Handler {
  96. var (
  97. assignOrg bool
  98. assignTeam bool
  99. )
  100. if len(args) > 0 {
  101. assignOrg = args[0]
  102. }
  103. if len(args) > 1 {
  104. assignTeam = args[1]
  105. }
  106. return func(c *context.APIContext) {
  107. c.Org = new(context.APIOrganization)
  108. var err error
  109. if assignOrg {
  110. c.Org.Organization, err = models.GetUserByName(c.Params(":orgname"))
  111. if err != nil {
  112. c.NotFoundOrServerError("GetUserByName", errors.IsUserNotExist, err)
  113. return
  114. }
  115. }
  116. if assignTeam {
  117. c.Org.Team, err = models.GetTeamByID(c.ParamsInt64(":teamid"))
  118. if err != nil {
  119. c.NotFoundOrServerError("GetTeamByID", errors.IsTeamNotExist, err)
  120. return
  121. }
  122. }
  123. }
  124. }
  125. func mustEnableIssues(c *context.APIContext) {
  126. if !c.Repo.Repository.EnableIssues || c.Repo.Repository.EnableExternalTracker {
  127. c.NotFound()
  128. return
  129. }
  130. }
  131. // RegisterRoutes registers all v1 APIs routes to web application.
  132. // FIXME: custom form error response
  133. func RegisterRoutes(m *macaron.Macaron) {
  134. bind := binding.Bind
  135. m.Group("/v1", func() {
  136. // Handle preflight OPTIONS request
  137. m.Options("/*", func() {})
  138. // Miscellaneous
  139. m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
  140. m.Post("/markdown/raw", misc.MarkdownRaw)
  141. // Users
  142. m.Group("/users", func() {
  143. m.Get("/search", user.Search)
  144. m.Group("/:username", func() {
  145. m.Get("", user.GetInfo)
  146. m.Group("/tokens", func() {
  147. m.Combo("").Get(user.ListAccessTokens).
  148. Post(bind(api.CreateAccessTokenOption{}), user.CreateAccessToken)
  149. }, reqBasicAuth())
  150. })
  151. })
  152. m.Group("/users", func() {
  153. m.Group("/:username", func() {
  154. m.Get("/keys", user.ListPublicKeys)
  155. m.Get("/followers", user.ListFollowers)
  156. m.Group("/following", func() {
  157. m.Get("", user.ListFollowing)
  158. m.Get("/:target", user.CheckFollowing)
  159. })
  160. })
  161. }, reqToken())
  162. m.Group("/user", func() {
  163. m.Get("", user.GetAuthenticatedUser)
  164. m.Combo("/emails").Get(user.ListEmails).
  165. Post(bind(api.CreateEmailOption{}), user.AddEmail).
  166. Delete(bind(api.CreateEmailOption{}), user.DeleteEmail)
  167. m.Get("/followers", user.ListMyFollowers)
  168. m.Group("/following", func() {
  169. m.Get("", user.ListMyFollowing)
  170. m.Combo("/:username").Get(user.CheckMyFollowing).Put(user.Follow).Delete(user.Unfollow)
  171. })
  172. m.Group("/keys", func() {
  173. m.Combo("").Get(user.ListMyPublicKeys).
  174. Post(bind(api.CreateKeyOption{}), user.CreatePublicKey)
  175. m.Combo("/:id").Get(user.GetPublicKey).
  176. Delete(user.DeletePublicKey)
  177. })
  178. m.Combo("/issues").Get(repo.ListUserIssues)
  179. }, reqToken())
  180. // Repositories
  181. m.Get("/users/:username/repos", reqToken(), repo.ListUserRepositories)
  182. m.Get("/orgs/:org/repos", reqToken(), repo.ListOrgRepositories)
  183. m.Combo("/user/repos", reqToken()).Get(repo.ListMyRepos).
  184. Post(bind(api.CreateRepoOption{}), repo.Create)
  185. m.Post("/org/:org/repos", reqToken(), bind(api.CreateRepoOption{}), repo.CreateOrgRepo)
  186. m.Group("/repos", func() {
  187. m.Get("/search", repo.Search)
  188. m.Get("/:username/:reponame", repoAssignment(), repo.Get)
  189. })
  190. m.Group("/repos", func() {
  191. m.Post("/migrate", bind(form.MigrateRepo{}), repo.Migrate)
  192. m.Delete("/:username/:reponame", repoAssignment(), repo.Delete)
  193. m.Group("/:username/:reponame", func() {
  194. m.Group("/hooks", func() {
  195. m.Combo("").Get(repo.ListHooks).
  196. Post(bind(api.CreateHookOption{}), repo.CreateHook)
  197. m.Combo("/:id").Patch(bind(api.EditHookOption{}), repo.EditHook).
  198. Delete(repo.DeleteHook)
  199. })
  200. m.Group("/collaborators", func() {
  201. m.Get("", repo.ListCollaborators)
  202. m.Combo("/:collaborator").Get(repo.IsCollaborator).Put(bind(api.AddCollaboratorOption{}), repo.AddCollaborator).
  203. Delete(repo.DeleteCollaborator)
  204. })
  205. m.Get("/raw/*", context.RepoRef(), repo.GetRawFile)
  206. m.Get("/archive/*", repo.GetArchive)
  207. m.Get("/forks", repo.ListForks)
  208. m.Group("/branches", func() {
  209. m.Get("", repo.ListBranches)
  210. m.Get("/*", repo.GetBranch)
  211. })
  212. m.Group("/keys", func() {
  213. m.Combo("").Get(repo.ListDeployKeys).
  214. Post(bind(api.CreateKeyOption{}), repo.CreateDeployKey)
  215. m.Combo("/:id").Get(repo.GetDeployKey).
  216. Delete(repo.DeleteDeploykey)
  217. })
  218. m.Group("/issues", func() {
  219. m.Combo("").Get(repo.ListIssues).Post(bind(api.CreateIssueOption{}), repo.CreateIssue)
  220. m.Group("/comments", func() {
  221. m.Get("", repo.ListRepoIssueComments)
  222. m.Combo("/:id").Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueComment)
  223. })
  224. m.Group("/:index", func() {
  225. m.Combo("").Get(repo.GetIssue).Patch(bind(api.EditIssueOption{}), repo.EditIssue)
  226. m.Group("/comments", func() {
  227. m.Combo("").Get(repo.ListIssueComments).Post(bind(api.CreateIssueCommentOption{}), repo.CreateIssueComment)
  228. m.Combo("/:id").Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueComment).
  229. Delete(repo.DeleteIssueComment)
  230. })
  231. m.Group("/labels", func() {
  232. m.Combo("").Get(repo.ListIssueLabels).
  233. Post(bind(api.IssueLabelsOption{}), repo.AddIssueLabels).
  234. Put(bind(api.IssueLabelsOption{}), repo.ReplaceIssueLabels).
  235. Delete(repo.ClearIssueLabels)
  236. m.Delete("/:id", repo.DeleteIssueLabel)
  237. })
  238. })
  239. }, mustEnableIssues)
  240. m.Group("/labels", func() {
  241. m.Combo("").Get(repo.ListLabels).
  242. Post(bind(api.CreateLabelOption{}), repo.CreateLabel)
  243. m.Combo("/:id").Get(repo.GetLabel).Patch(bind(api.EditLabelOption{}), repo.EditLabel).
  244. Delete(repo.DeleteLabel)
  245. })
  246. m.Group("/milestones", func() {
  247. m.Combo("").Get(repo.ListMilestones).
  248. Post(reqRepoWriter(), bind(api.CreateMilestoneOption{}), repo.CreateMilestone)
  249. m.Combo("/:id").Get(repo.GetMilestone).
  250. Patch(reqRepoWriter(), bind(api.EditMilestoneOption{}), repo.EditMilestone).
  251. Delete(reqRepoWriter(), repo.DeleteMilestone)
  252. })
  253. m.Post("/mirror-sync", repo.MirrorSync)
  254. m.Get("/editorconfig/:filename", context.RepoRef(), repo.GetEditorconfig)
  255. }, repoAssignment())
  256. }, reqToken())
  257. m.Get("/issues", reqToken(), repo.ListUserIssues)
  258. // Organizations
  259. m.Combo("/user/orgs", reqToken()).Get(org.ListMyOrgs).Post(bind(api.CreateOrgOption{}), org.CreateMyOrg)
  260. m.Get("/users/:username/orgs", org.ListUserOrgs)
  261. m.Group("/orgs/:orgname", func() {
  262. m.Combo("").Get(org.Get).Patch(bind(api.EditOrgOption{}), org.Edit)
  263. m.Combo("/teams").Get(org.ListTeams)
  264. }, orgAssignment(true))
  265. m.Any("/*", func(c *context.Context) {
  266. c.NotFound()
  267. })
  268. m.Group("/admin", func() {
  269. m.Group("/users", func() {
  270. m.Post("", bind(api.CreateUserOption{}), admin.CreateUser)
  271. m.Group("/:username", func() {
  272. m.Combo("").Patch(bind(api.EditUserOption{}), admin.EditUser).
  273. Delete(admin.DeleteUser)
  274. m.Post("/keys", bind(api.CreateKeyOption{}), admin.CreatePublicKey)
  275. m.Post("/orgs", bind(api.CreateOrgOption{}), admin.CreateOrg)
  276. m.Post("/repos", bind(api.CreateRepoOption{}), admin.CreateRepo)
  277. })
  278. })
  279. m.Group("/orgs/:orgname", func() {
  280. m.Group("/teams", func() {
  281. m.Post("", orgAssignment(true), bind(api.CreateTeamOption{}), admin.CreateTeam)
  282. })
  283. })
  284. m.Group("/teams", func() {
  285. m.Group("/:teamid", func() {
  286. m.Combo("/members/:username").Put(admin.AddTeamMember).Delete(admin.RemoveTeamMember)
  287. m.Combo("/repos/:reponame").Put(admin.AddTeamRepository).Delete(admin.RemoveTeamRepository)
  288. }, orgAssignment(false, true))
  289. })
  290. }, reqAdmin())
  291. }, context.APIContexter())
  292. }