rewrite stringToRoleDescriptor

Author: yp05327

models/issues/comment.go

@@ -23,6 +23,7 @@ import (
 	"code.gitea.io/gitea/modules/references"
 	"code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/modules/timeutil"
+	"code.gitea.io/gitea/modules/translation"
 	"code.gitea.io/gitea/modules/util"
 
 	"xorm.io/builder"
@@ -181,49 +182,40 @@ func (t CommentType) HasAttachmentSupport() bool {
 	return false
 }
 
+type Role string
+
 // RoleDescriptor defines comment tag type
-type RoleDescriptor int
+type RoleDescriptor struct {
+	IsPoster util.OptionalBool
+	Role     Role
+}
 
 // Enumerate all the role tags.
 const (
-	RoleDescriptorNone RoleDescriptor = iota
-	RoleDescriptorPoster
-	RoleDescriptorOwner
-	RoleDescriptorMember
-	RoleDescriptorCollaborator
-	RoleDescriptorFirstTimeContributor
-	RoleDescriptorContributor
+	RoleDescriptorOwner                Role = "owner"
+	RoleDescriptorMember               Role = "member"
+	RoleDescriptorCollaborator         Role = "collaborator"
+	RoleDescriptorFirstTimeContributor Role = "first_time_contributor"
+	RoleDescriptorContributor          Role = "contributor"
 )
 
-// WithRole enable a specific tag on the RoleDescriptor.
-func (rd RoleDescriptor) WithRole(role RoleDescriptor) RoleDescriptor {
-	return rd | (1 << role)
-}
-
-func stringToRoleDescriptor(role string) RoleDescriptor {
-	switch role {
-	case "Poster":
-		return RoleDescriptorPoster
-	case "Owner":
-		return RoleDescriptorOwner
-	case "Member":
-		return RoleDescriptorMember
-	case "Collaborator":
-		return RoleDescriptorCollaborator
-	case "First-time contributor":
-		return RoleDescriptorFirstTimeContributor
-	case "Contributor":
-		return RoleDescriptorContributor
-	default:
-		return RoleDescriptorNone
-	}
-}
-
-// HasRole returns if a certain role is enabled on the RoleDescriptor.
-func (rd RoleDescriptor) HasRole(role string) bool {
-	roleDescriptor := stringToRoleDescriptor(role)
-	bitValue := rd & (1 << roleDescriptor)
-	return (bitValue > 0)
+// HasRole returns if a role is not none
+func (r Role) HasRole() bool {
+	return r.String() != ""
+}
+
+func (r Role) String() string {
+	return string(r)
+}
+
+// LocaleString returns the locale string name of the Status
+func (r Role) LocaleString(lang translation.Locale) string {
+	return lang.Tr("repo.issues." + r.String())
+}
+
+// LocaleHelper returns the locale string name of the Status
+func (r Role) LocaleHelper(lang translation.Locale) string {
+	return lang.Tr("repo.issues." + r.String() + "_helper")
 }
 
 // Comment represents a comment in commit and issue page.

routers/web/repo/issue.go

@@ -1230,79 +1230,80 @@ func NewIssuePost(ctx *context.Context) {
 
 // roleDescriptor returns the Role Descriptor for a comment in/with the given repo, poster and issue
 func roleDescriptor(ctx stdCtx.Context, repo *repo_model.Repository, poster *user_model.User, issue *issues_model.Issue, hasOriginalAuthor bool) (issues_model.RoleDescriptor, error) {
+	roleDescriptor := issues_model.RoleDescriptor{}
+
 	if hasOriginalAuthor {
-		return issues_model.RoleDescriptorNone, nil
+		return roleDescriptor, nil
 	}
 
 	perm, err := access_model.GetUserRepoPermission(ctx, repo, poster)
 	if err != nil {
-		return issues_model.RoleDescriptorNone, err
+		return roleDescriptor, err
 	}
 
-	// By default the poster has no roles on the comment.
-	roleDescriptor := issues_model.RoleDescriptorNone
-
 	// If the poster is the actual poster of the issue, enable Poster role.
 	if issue.IsPoster(poster.ID) {
-		roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorPoster)
+		roleDescriptor.IsPoster = util.OptionalBoolTrue
 	}
 
 	// Check if the poster is owner of the repo.
 	if perm.IsOwner() {
 		// If the poster isn't a admin, enable the owner role.
 		if !poster.IsAdmin {
-			roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorOwner)
+			roleDescriptor.Role = issues_model.RoleDescriptorOwner
 			return roleDescriptor, nil
 		}
 
 		// Otherwise check if poster is the real repo admin.
 		ok, err := access_model.IsUserRealRepoAdmin(repo, poster)
 		if err != nil {
-			return issues_model.RoleDescriptorNone, err
+			return roleDescriptor, err
 		}
 		if ok {
-			roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorOwner)
+			roleDescriptor.Role = issues_model.RoleDescriptorOwner
 			return roleDescriptor, nil
 		}
 	}
 
 	// If repo is organization, check Member role
 	if err := repo.LoadOwner(ctx); err != nil {
-		return issues_model.RoleDescriptorNone, err
+		return roleDescriptor, err
 	}
 	if repo.Owner.IsOrganization() {
 		if isMember, err := organization.IsOrganizationMember(ctx, repo.Owner.ID, poster.ID); err != nil {
-			return issues_model.RoleDescriptorNone, err
+			return roleDescriptor, err
 		} else if isMember {
-			roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorMember)
+			roleDescriptor.Role = issues_model.RoleDescriptorMember
 			return roleDescriptor, nil
 		}
 	}
 
 	// If the poster is the collaborator of the repo
 	if isCollaborator, err := repo_model.IsCollaborator(ctx, repo.ID, poster.ID); err != nil {
-		return issues_model.RoleDescriptorNone, err
+		return roleDescriptor, err
 	} else if isCollaborator {
-		roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorCollaborator)
+		roleDescriptor.Role = issues_model.RoleDescriptorCollaborator
 		return roleDescriptor, nil
 	}
 
 	// If the poster is the contributor of the repo
 	searchOpt := &issue_indexer.SearchOptions{
 		Paginator: &db.ListOptions{
 			Page:     1,
-			PageSize: 2,
+			PageSize: 1,
 		},
 		RepoIDs:  []int64{repo.ID},
+		IsClosed: util.OptionalBoolTrue,
 		IsPull:   util.OptionalBoolTrue,
 		PosterID: &poster.ID,
 	}
 	if _, total, err := issue_indexer.SearchIssues(ctx, searchOpt); err != nil {
-		return issues_model.RoleDescriptorNone, err
-	} else if total == 1 {
-		roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorFirstTimeContributor)
-	} else if total > 1 {
-		roleDescriptor = roleDescriptor.WithRole(issues_model.RoleDescriptorContributor)
+		return roleDescriptor, err
+	} else if total > 0 {
+		roleDescriptor.Role = issues_model.RoleDescriptorContributor
+	} else if total == 0 && issue.IsPull && !issue.IsClosed {
+		// only display first time contributor in the first opening pull request
+		roleDescriptor.Role = issues_model.RoleDescriptorFirstTimeContributor
 	}
 
 	return roleDescriptor, nil

templates/repo/issue/view_content/show_role.tmpl

@@ -1,27 +1,11 @@
-{{if and (.ShowRole.HasRole "Poster") (not .IgnorePoster)}}
+{{if and .ShowRole.IsPoster.IsTrue (not .IgnorePoster)}}
 	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.author_helper"}}">
 		{{ctx.Locale.Tr "repo.issues.author"}}
 	</div>
 {{end}}
 
-{{if (.ShowRole.HasRole "Owner")}}
-	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.owner_helper"}}">
-		{{ctx.Locale.Tr "repo.issues.owner"}}
-	</div>
-{{else if (.ShowRole.HasRole "Member")}}
-	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.member_helper"}}">
-		{{ctx.Locale.Tr "repo.issues.member"}}
-	</div>
-{{else if (.ShowRole.HasRole "Collaborator")}}
-	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.collaborator_helper"}}">
-		{{ctx.Locale.Tr "repo.issues.collaborator"}}
-	</div>
-{{else if and (.ShowRole.HasRole "First-time contributor") (.ShowRole.HasRole "Poster")}}
-	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.first_time_contributor_helper"}}">
-		{{ctx.Locale.Tr "repo.issues.first_time_contributor"}}
-	</div>
-{{else if (.ShowRole.HasRole "Contributor")}}
-	<div class="ui basic label role-label" data-tooltip-content="{{ctx.Locale.Tr "repo.issues.contributor_helper"}}">
-		{{ctx.Locale.Tr "repo.issues.contributor"}}
+{{if (.ShowRole.Role.HasRole)}}
+	<div class="ui basic label role-label" data-tooltip-content="{{.ShowRole.Role.LocaleHelper ctx.Locale}}">
+		{{.ShowRole.Role.LocaleString ctx.Locale}}
 	</div>
 {{end}}