Add setting to set default and global disabled repository units. (#8788)

* Add possibility to global disable repo units.

* Add Default Repo Unit app.ini setting.

* Hide units

* Hide disabled repo units

* Minor fixes

* Indicate disabled units in team settings.

Co-authored-by: Lauris BH <[email protected]>
Co-authored-by: Lunny Xiao <[email protected]>
Co-authored-by: zeripath <[email protected]>

custom/conf/app.ini.sample

@@ -42,6 +42,13 @@ DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH = false
 ; Allow users to push local repositories to Gitea and have them automatically created for a user or an org
 ENABLE_PUSH_CREATE_USER = false
 ENABLE_PUSH_CREATE_ORG = false
+; Comma separated list of globally disabled repo units. Allowed values: repo.issues, repo.ext_issues, repo.pulls, repo.wiki, repo.ext_wiki
+DISABLED_REPO_UNITS = 
+; Comma separated list of default repo units. Allowed values: repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki.
+; Note: Code and Releases can currently not be deactivated. If you specify default repo units you should still list them for future compatibility.
+; External wiki and issue tracker can't be enabled by default as it requires additional settings.
+; Disabled repo units will not be added to new repositories regardless if it is in the default list.
+DEFAULT_REPO_UNITS = repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki
 
 [repository.editor]
 ; List of file extensions for which lines should be wrapped in the CodeMirror editor

models/repo.go

@@ -128,6 +128,7 @@ func loadRepoConfig() {
 // NewRepoContext creates a new repository context
 func NewRepoContext() {
  loadRepoConfig()
+ loadUnitConfig()
 
  RemoveAllWithNotice("Clean up repository temporary data", filepath.Join(setting.AppDataPath, "tmp"))
 }
@@ -393,6 +394,7 @@ func (repo *Repository) getUnits(e Engine) (err error) {
  }
 
  repo.Units, err = getUnitsByRepoID(e, repo.ID)
+ log.Trace("repo.Units: %-+v", repo.Units)
  return err
 }
 
@@ -1442,14 +1444,19 @@ func UpdateRepositoryUpdatedTime(repoID int64, updateTime time.Time) error {
 }
 
 // UpdateRepositoryUnits updates a repository's units
-func UpdateRepositoryUnits(repo *Repository, units []RepoUnit) (err error) {
+func UpdateRepositoryUnits(repo *Repository, units []RepoUnit, deleteUnitTypes []UnitType) (err error) {
  sess := x.NewSession()
  defer sess.Close()
  if err = sess.Begin(); err != nil {
  return err
  }
 
- if _, err = sess.Where("repo_id = ?", repo.ID).Delete(new(RepoUnit)); err != nil {
+ // Delete existing settings of units before adding again
+ for _, u := range units {
+ deleteUnitTypes = append(deleteUnitTypes, u.Type)
+ }
+
+ if _, err = sess.Where("repo_id = ?", repo.ID).In("type", deleteUnitTypes).Delete(new(RepoUnit)); err != nil {
  return err
  }
 

models/repo_unit.go

@@ -170,5 +170,16 @@ func (r *RepoUnit) ExternalTrackerConfig() *ExternalTrackerConfig {
 }
 
 func getUnitsByRepoID(e Engine, repoID int64) (units []*RepoUnit, err error) {
- return units, e.Where("repo_id = ?", repoID).Find(&units)
+ var tmpUnits []*RepoUnit
+ if err := e.Where("repo_id = ?", repoID).Find(&tmpUnits); err != nil {
+ return nil, err
+ }
+
+ for _, u := range tmpUnits {
+ if !u.Type.UnitGlobalDisabled() {
+ units = append(units, u)
+ }
+ }
+
+ return units, nil
 }

models/unit.go

@@ -9,6 +9,7 @@ import (
  "strings"
 
  "code.gitea.io/gitea/modules/log"
+ "code.gitea.io/gitea/modules/setting"
 )
 
 // UnitType is Unit's Type
@@ -78,13 +79,89 @@ var (
  UnitTypeWiki,
  }
 
+ // NotAllowedDefaultRepoUnits contains units that can't be default
+ NotAllowedDefaultRepoUnits = []UnitType{
+ UnitTypeExternalWiki,
+ UnitTypeExternalTracker,
+ }
+
  // MustRepoUnits contains the units could not be disabled currently
  MustRepoUnits = []UnitType{
  UnitTypeCode,
  UnitTypeReleases,
  }
+
+ // DisabledRepoUnits contains the units that have been globally disabled
+ DisabledRepoUnits = []UnitType{}
 )
 
+func loadUnitConfig() {
+ setDefaultRepoUnits := FindUnitTypes(setting.Repository.DefaultRepoUnits...)
+ // Default repo units set if setting is not empty
+ if len(setDefaultRepoUnits) > 0 {
+ // MustRepoUnits required as default
+ DefaultRepoUnits = make([]UnitType, len(MustRepoUnits))
+ copy(DefaultRepoUnits, MustRepoUnits)
+ for _, defaultU := range setDefaultRepoUnits {
+ if !defaultU.CanBeDefault() {
+ log.Warn("Not allowed as default unit: %s", defaultU.String())
+ continue
+ }
+ // MustRepoUnits already added
+ if defaultU.CanDisable() {
+ DefaultRepoUnits = append(DefaultRepoUnits, defaultU)
+ }
+ }
+ }
+
+ DisabledRepoUnits = FindUnitTypes(setting.Repository.DisabledRepoUnits...)
+ // Check that must units are not disabled
+ for i, disabledU := range DisabledRepoUnits {
+ if !disabledU.CanDisable() {
+ log.Warn("Not allowed to global disable unit %s", disabledU.String())
+ DisabledRepoUnits = append(DisabledRepoUnits[:i], DisabledRepoUnits[i+1:]...)
+ }
+ }
+ // Remove disabled units from default units
+ for _, disabledU := range DisabledRepoUnits {
+ for i, defaultU := range DefaultRepoUnits {
+ if defaultU == disabledU {
+ DefaultRepoUnits = append(DefaultRepoUnits[:i], DefaultRepoUnits[i+1:]...)
+ }
+ }
+ }
+}
+
+// UnitGlobalDisabled checks if unit type is global disabled
+func (u UnitType) UnitGlobalDisabled() bool {
+ for _, ud := range DisabledRepoUnits {
+ if u == ud {
+ return true
+ }
+ }
+ return false
+}
+
+// CanDisable checks if this unit type can be disabled.
+func (u *UnitType) CanDisable() bool {
+ for _, mu := range MustRepoUnits {
+ if *u == mu {
+ return false
+ }
+ }
+ return true
+}
+
+// CanBeDefault checks if the unit type can be a default repo unit
+func (u *UnitType) CanBeDefault() bool {
+ for _, nadU := range NotAllowedDefaultRepoUnits {
+ if *u == nadU {
+ return false
+ }
+ }
+ return true
+}
+
 // Unit is a section of one repository
 type Unit struct {
  Type UnitType
@@ -96,7 +173,7 @@ type Unit struct {
 
 // CanDisable returns if this unit could be disabled.
 func (u *Unit) CanDisable() bool {
- return true
+ return u.Type.CanDisable()
 }
 
 // IsLessThan compares order of two units

models/user.go

@@ -622,6 +622,7 @@ func (u *User) GetRepositories(page, pageSize int) (err error) {
 }
 
 // GetRepositoryIDs returns repositories IDs where user owned and has unittypes
+// Caller shall check that units is not globally disabled
 func (u *User) GetRepositoryIDs(units ...UnitType) ([]int64, error) {
  var ids []int64
 
@@ -636,6 +637,7 @@ func (u *User) GetRepositoryIDs(units ...UnitType) ([]int64, error) {
 }
 
 // GetOrgRepositoryIDs returns repositories IDs where user's team owned and has unittypes
+// Caller shall check that units is not globally disabled
 func (u *User) GetOrgRepositoryIDs(units ...UnitType) ([]int64, error) {
  var ids []int64
 
@@ -656,6 +658,7 @@ func (u *User) GetOrgRepositoryIDs(units ...UnitType) ([]int64, error) {
 }
 
 // GetAccessRepoIDs returns all repositories IDs where user's or user is a team member organizations
+// Caller shall check that units is not globally disabled
 func (u *User) GetAccessRepoIDs(units ...UnitType) ([]int64, error) {
  ids, err := u.GetRepositoryIDs(units...)
  if err != nil {

modules/setting/repository.go

@@ -37,6 +37,8 @@ var (
  DefaultCloseIssuesViaCommitsInAnyBranch bool
  EnablePushCreateUser bool
  EnablePushCreateOrg bool
+ DisabledRepoUnits []string
+ DefaultRepoUnits []string
 
  // Repository editor settings
  Editor struct {
@@ -98,6 +100,8 @@ var (
  DefaultCloseIssuesViaCommitsInAnyBranch: false,
  EnablePushCreateUser: false,
  EnablePushCreateOrg: false,
+ DisabledRepoUnits: []string{},
+ DefaultRepoUnits: []string{},
 
  // Repository editor settings
  Editor: struct {

options/locale/locale_en-US.ini

@@ -636,6 +636,7 @@ stargazers = Stargazers
 forks = Forks
 pick_reaction = Pick your reaction
 reactions_more = and %d more
+unit_disabled = The site administrator has disabled this repository section.
 
 template.items = Template Items
 template.git_content = Git Content (Default Branch)
@@ -1613,6 +1614,7 @@ team_desc_helper = Describe the purpose or role of the team.
 team_access_desc = Repository access
 team_permission_desc = Permission
 team_unit_desc = Allow Access to Repository Sections
+team_unit_disabled = (Disabled)
 
 form.name_reserved = The organization name '%s' is reserved.
 form.name_pattern_not_allowed = The pattern '%s' is not allowed in an organization name.