access.go 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package models
  5. import (
  6. "fmt"
  7. log "gopkg.in/clog.v1"
  8. )
  9. type AccessMode int
  10. const (
  11. ACCESS_MODE_NONE AccessMode = iota // 0
  12. ACCESS_MODE_READ // 1
  13. ACCESS_MODE_WRITE // 2
  14. ACCESS_MODE_ADMIN // 3
  15. ACCESS_MODE_OWNER // 4
  16. )
  17. func (mode AccessMode) String() string {
  18. switch mode {
  19. case ACCESS_MODE_READ:
  20. return "read"
  21. case ACCESS_MODE_WRITE:
  22. return "write"
  23. case ACCESS_MODE_ADMIN:
  24. return "admin"
  25. case ACCESS_MODE_OWNER:
  26. return "owner"
  27. default:
  28. return "none"
  29. }
  30. }
  31. // ParseAccessMode returns corresponding access mode to given permission string.
  32. func ParseAccessMode(permission string) AccessMode {
  33. switch permission {
  34. case "write":
  35. return ACCESS_MODE_WRITE
  36. case "admin":
  37. return ACCESS_MODE_ADMIN
  38. default:
  39. return ACCESS_MODE_READ
  40. }
  41. }
  42. // Access represents the highest access level of a user to the repository. The only access type
  43. // that is not in this table is the real owner of a repository. In case of an organization
  44. // repository, the members of the owners team are in this table.
  45. type Access struct {
  46. ID int64 `xorm:"pk autoincr"`
  47. UserID int64 `xorm:"UNIQUE(s)"`
  48. RepoID int64 `xorm:"UNIQUE(s)"`
  49. Mode AccessMode
  50. }
  51. func accessLevel(e Engine, userID int64, repo *Repository) (AccessMode, error) {
  52. mode := ACCESS_MODE_NONE
  53. // Everyone has read access to public repository
  54. if !repo.IsPrivate {
  55. mode = ACCESS_MODE_READ
  56. }
  57. if userID <= 0 {
  58. return mode, nil
  59. }
  60. if userID == repo.OwnerID {
  61. return ACCESS_MODE_OWNER, nil
  62. }
  63. access := &Access{
  64. UserID: userID,
  65. RepoID: repo.ID,
  66. }
  67. if has, err := e.Get(access); !has || err != nil {
  68. return mode, err
  69. }
  70. return access.Mode, nil
  71. }
  72. // AccessLevel returns the Access a user has to a repository. Will return NoneAccess if the
  73. // user does not have access.
  74. func AccessLevel(userID int64, repo *Repository) (AccessMode, error) {
  75. return accessLevel(x, userID, repo)
  76. }
  77. func hasAccess(e Engine, userID int64, repo *Repository, testMode AccessMode) (bool, error) {
  78. mode, err := accessLevel(e, userID, repo)
  79. return mode >= testMode, err
  80. }
  81. // HasAccess returns true if someone has the request access level. User can be nil!
  82. func HasAccess(userID int64, repo *Repository, testMode AccessMode) (bool, error) {
  83. return hasAccess(x, userID, repo, testMode)
  84. }
  85. // GetRepositoryAccesses finds all repositories with their access mode where a user has access but does not own.
  86. func (u *User) GetRepositoryAccesses() (map[*Repository]AccessMode, error) {
  87. accesses := make([]*Access, 0, 10)
  88. if err := x.Find(&accesses, &Access{UserID: u.ID}); err != nil {
  89. return nil, err
  90. }
  91. repos := make(map[*Repository]AccessMode, len(accesses))
  92. for _, access := range accesses {
  93. repo, err := GetRepositoryByID(access.RepoID)
  94. if err != nil {
  95. if IsErrRepoNotExist(err) {
  96. log.Error(4, "GetRepositoryByID: %v", err)
  97. continue
  98. }
  99. return nil, err
  100. }
  101. if err = repo.GetOwner(); err != nil {
  102. return nil, err
  103. } else if repo.OwnerID == u.ID {
  104. continue
  105. }
  106. repos[repo] = access.Mode
  107. }
  108. return repos, nil
  109. }
  110. // GetAccessibleRepositories finds repositories which the user has access but does not own.
  111. // If limit is smaller than 1 means returns all found results.
  112. func (user *User) GetAccessibleRepositories(limit int) (repos []*Repository, _ error) {
  113. sess := x.Where("owner_id !=? ", user.ID).Desc("updated_unix")
  114. if limit > 0 {
  115. sess.Limit(limit)
  116. repos = make([]*Repository, 0, limit)
  117. } else {
  118. repos = make([]*Repository, 0, 10)
  119. }
  120. return repos, sess.Join("INNER", "access", "access.user_id = ? AND access.repo_id = repository.id", user.ID).Find(&repos)
  121. }
  122. func maxAccessMode(modes ...AccessMode) AccessMode {
  123. max := ACCESS_MODE_NONE
  124. for _, mode := range modes {
  125. if mode > max {
  126. max = mode
  127. }
  128. }
  129. return max
  130. }
  131. // FIXME: do corss-comparison so reduce deletions and additions to the minimum?
  132. func (repo *Repository) refreshAccesses(e Engine, accessMap map[int64]AccessMode) (err error) {
  133. newAccesses := make([]Access, 0, len(accessMap))
  134. for userID, mode := range accessMap {
  135. newAccesses = append(newAccesses, Access{
  136. UserID: userID,
  137. RepoID: repo.ID,
  138. Mode: mode,
  139. })
  140. }
  141. // Delete old accesses and insert new ones for repository.
  142. if _, err = e.Delete(&Access{RepoID: repo.ID}); err != nil {
  143. return fmt.Errorf("delete old accesses: %v", err)
  144. } else if _, err = e.Insert(newAccesses); err != nil {
  145. return fmt.Errorf("insert new accesses: %v", err)
  146. }
  147. return nil
  148. }
  149. // refreshCollaboratorAccesses retrieves repository collaborations with their access modes.
  150. func (repo *Repository) refreshCollaboratorAccesses(e Engine, accessMap map[int64]AccessMode) error {
  151. collaborations, err := repo.getCollaborations(e)
  152. if err != nil {
  153. return fmt.Errorf("getCollaborations: %v", err)
  154. }
  155. for _, c := range collaborations {
  156. accessMap[c.UserID] = c.Mode
  157. }
  158. return nil
  159. }
  160. // recalculateTeamAccesses recalculates new accesses for teams of an organization
  161. // except the team whose ID is given. It is used to assign a team ID when
  162. // remove repository from that team.
  163. func (repo *Repository) recalculateTeamAccesses(e Engine, ignTeamID int64) (err error) {
  164. accessMap := make(map[int64]AccessMode, 20)
  165. if err = repo.getOwner(e); err != nil {
  166. return err
  167. } else if !repo.Owner.IsOrganization() {
  168. return fmt.Errorf("owner is not an organization: %d", repo.OwnerID)
  169. }
  170. if err = repo.refreshCollaboratorAccesses(e, accessMap); err != nil {
  171. return fmt.Errorf("refreshCollaboratorAccesses: %v", err)
  172. }
  173. if err = repo.Owner.getTeams(e); err != nil {
  174. return err
  175. }
  176. for _, t := range repo.Owner.Teams {
  177. if t.ID == ignTeamID {
  178. continue
  179. }
  180. // Owner team gets owner access, and skip for teams that do not
  181. // have relations with repository.
  182. if t.IsOwnerTeam() {
  183. t.Authorize = ACCESS_MODE_OWNER
  184. } else if !t.hasRepository(e, repo.ID) {
  185. continue
  186. }
  187. if err = t.getMembers(e); err != nil {
  188. return fmt.Errorf("getMembers '%d': %v", t.ID, err)
  189. }
  190. for _, m := range t.Members {
  191. accessMap[m.ID] = maxAccessMode(accessMap[m.ID], t.Authorize)
  192. }
  193. }
  194. return repo.refreshAccesses(e, accessMap)
  195. }
  196. func (repo *Repository) recalculateAccesses(e Engine) error {
  197. if repo.Owner.IsOrganization() {
  198. return repo.recalculateTeamAccesses(e, 0)
  199. }
  200. accessMap := make(map[int64]AccessMode, 10)
  201. if err := repo.refreshCollaboratorAccesses(e, accessMap); err != nil {
  202. return fmt.Errorf("refreshCollaboratorAccesses: %v", err)
  203. }
  204. return repo.refreshAccesses(e, accessMap)
  205. }
  206. // RecalculateAccesses recalculates all accesses for repository.
  207. func (r *Repository) RecalculateAccesses() error {
  208. return r.recalculateAccesses(x)
  209. }