2016-11-07 08:53:13 -05:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2019-05-11 05:21:34 -05:00
package structs
2016-11-07 08:53:13 -05:00
import (
2020-09-09 13:29:10 -05:00
"strings"
2016-11-07 08:53:13 -05:00
"time"
)
2017-11-13 02:02:25 -05:00
// Permission represents a set of permissions
2016-11-07 08:53:13 -05:00
type Permission struct {
Admin bool ` json:"admin" `
Push bool ` json:"push" `
Pull bool ` json:"pull" `
}
2019-10-02 04:30:41 -05:00
// InternalTracker represents settings for internal tracker
// swagger:model
type InternalTracker struct {
// Enable time tracking (Built-in issue tracker)
EnableTimeTracker bool ` json:"enable_time_tracker" `
// Let only contributors track time (Built-in issue tracker)
AllowOnlyContributorsToTrackTime bool ` json:"allow_only_contributors_to_track_time" `
// Enable dependencies for issues and pull requests (Built-in issue tracker)
EnableIssueDependencies bool ` json:"enable_issue_dependencies" `
}
// ExternalTracker represents settings for external tracker
// swagger:model
type ExternalTracker struct {
// URL of external issue tracker.
ExternalTrackerURL string ` json:"external_tracker_url" `
// External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.
ExternalTrackerFormat string ` json:"external_tracker_format" `
// External Issue Tracker Number Format, either `numeric` or `alphanumeric`
ExternalTrackerStyle string ` json:"external_tracker_style" `
}
// ExternalWiki represents setting for external wiki
// swagger:model
type ExternalWiki struct {
// URL of external wiki.
ExternalWikiURL string ` json:"external_wiki_url" `
}
2017-11-13 02:02:25 -05:00
// Repository represents a repository
2016-11-07 08:53:13 -05:00
type Repository struct {
ID int64 ` json:"id" `
Owner * User ` json:"owner" `
Name string ` json:"name" `
FullName string ` json:"full_name" `
Description string ` json:"description" `
2017-05-04 21:55:54 -05:00
Empty bool ` json:"empty" `
2016-11-07 08:53:13 -05:00
Private bool ` json:"private" `
Fork bool ` json:"fork" `
2019-11-11 10:15:29 -05:00
Template bool ` json:"template" `
2017-05-11 22:09:26 -05:00
Parent * Repository ` json:"parent" `
2017-02-22 18:53:33 -05:00
Mirror bool ` json:"mirror" `
2017-05-04 21:55:54 -05:00
Size int ` json:"size" `
2016-11-07 08:53:13 -05:00
HTMLURL string ` json:"html_url" `
SSHURL string ` json:"ssh_url" `
CloneURL string ` json:"clone_url" `
2019-07-07 21:14:12 -05:00
OriginalURL string ` json:"original_url" `
2016-11-07 08:53:13 -05:00
Website string ` json:"website" `
Stars int ` json:"stars_count" `
Forks int ` json:"forks_count" `
Watchers int ` json:"watchers_count" `
OpenIssues int ` json:"open_issues_count" `
2019-11-29 10:14:24 -05:00
OpenPulls int ` json:"open_pr_counter" `
2019-11-30 14:28:47 -05:00
Releases int ` json:"release_counter" `
2016-11-07 08:53:13 -05:00
DefaultBranch string ` json:"default_branch" `
2018-10-28 17:03:02 -05:00
Archived bool ` json:"archived" `
2017-11-13 02:02:25 -05:00
// swagger:strfmt date-time
2018-03-05 20:22:16 -05:00
Created time . Time ` json:"created_at" `
2017-11-13 02:02:25 -05:00
// swagger:strfmt date-time
2019-10-02 04:30:41 -05:00
Updated time . Time ` json:"updated_at" `
Permissions * Permission ` json:"permissions,omitempty" `
HasIssues bool ` json:"has_issues" `
InternalTracker * InternalTracker ` json:"internal_tracker,omitempty" `
ExternalTracker * ExternalTracker ` json:"external_tracker,omitempty" `
HasWiki bool ` json:"has_wiki" `
ExternalWiki * ExternalWiki ` json:"external_wiki,omitempty" `
HasPullRequests bool ` json:"has_pull_requests" `
2020-08-16 22:07:38 -05:00
HasProjects bool ` json:"has_projects" `
2019-10-02 04:30:41 -05:00
IgnoreWhitespaceConflicts bool ` json:"ignore_whitespace_conflicts" `
AllowMerge bool ` json:"allow_merge_commits" `
AllowRebase bool ` json:"allow_rebase" `
AllowRebaseMerge bool ` json:"allow_rebase_explicit" `
AllowSquash bool ` json:"allow_squash_merge" `
AvatarURL string ` json:"avatar_url" `
2020-06-05 06:41:06 -05:00
Internal bool ` json:"internal" `
2016-11-07 08:53:13 -05:00
}
2016-11-29 03:09:17 -05:00
// CreateRepoOption options when creating repository
2017-11-13 02:02:25 -05:00
// swagger:model
2016-11-07 08:53:13 -05:00
type CreateRepoOption struct {
2017-05-02 08:35:59 -05:00
// Name of the repository to create
//
2017-11-13 02:02:25 -05:00
// required: true
2017-05-02 08:35:59 -05:00
// unique: true
Name string ` json:"name" binding:"Required;AlphaDashDot;MaxSize(100)" `
// Description of the repository to create
2016-11-07 08:53:13 -05:00
Description string ` json:"description" binding:"MaxSize(255)" `
2017-11-13 02:02:25 -05:00
// Whether the repository is private
2017-05-02 08:35:59 -05:00
Private bool ` json:"private" `
2019-09-08 03:28:40 -05:00
// Issue Label set to use
IssueLabels string ` json:"issue_labels" `
2017-11-13 02:02:25 -05:00
// Whether the repository should be auto-intialized?
2017-05-02 08:35:59 -05:00
AutoInit bool ` json:"auto_init" `
// Gitignores to use
Gitignores string ` json:"gitignores" `
// License to use
License string ` json:"license" `
// Readme of the repository to create
Readme string ` json:"readme" `
2020-03-26 14:14:51 -05:00
// DefaultBranch of the repository (used when initializes and in template)
DefaultBranch string ` json:"default_branch" binding:"GitRefName;MaxSize(100)" `
2016-11-07 08:53:13 -05:00
}
2019-05-11 05:21:34 -05:00
// EditRepoOption options when editing a repository's properties
// swagger:model
type EditRepoOption struct {
2019-05-30 10:09:05 -05:00
// name of the repository
2019-05-11 05:21:34 -05:00
// unique: true
2019-05-30 10:09:05 -05:00
Name * string ` json:"name,omitempty" binding:"OmitEmpty;AlphaDashDot;MaxSize(100);" `
// a short description of the repository.
2019-05-11 05:21:34 -05:00
Description * string ` json:"description,omitempty" binding:"MaxSize(255)" `
2019-05-30 10:09:05 -05:00
// a URL with more information about the repository.
2019-05-11 05:21:34 -05:00
Website * string ` json:"website,omitempty" binding:"MaxSize(255)" `
2019-05-30 10:09:05 -05:00
// either `true` to make the repository private or `false` to make it public.
// Note: you will get a 422 error if the organization restricts changing repository visibility to organization
2019-05-11 05:21:34 -05:00
// owners and a non-owner tries to change the value of private.
Private * bool ` json:"private,omitempty" `
2019-11-11 10:15:29 -05:00
// either `true` to make this repository a template or `false` to make it a normal repository
Template * bool ` json:"template,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to enable issues for this repository or `false` to disable them.
HasIssues * bool ` json:"has_issues,omitempty" `
2019-10-02 04:30:41 -05:00
// set this structure to configure internal issue tracker (requires has_issues)
InternalTracker * InternalTracker ` json:"internal_tracker,omitempty" `
// set this structure to use external issue tracker (requires has_issues)
ExternalTracker * ExternalTracker ` json:"external_tracker,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to enable the wiki for this repository or `false` to disable it.
HasWiki * bool ` json:"has_wiki,omitempty" `
2019-10-02 04:30:41 -05:00
// set this structure to use external wiki instead of internal (requires has_wiki)
ExternalWiki * ExternalWiki ` json:"external_wiki,omitempty" `
2019-05-30 10:09:05 -05:00
// sets the default branch for this repository.
2019-05-11 05:21:34 -05:00
DefaultBranch * string ` json:"default_branch,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to allow pull requests, or `false` to prevent pull request.
HasPullRequests * bool ` json:"has_pull_requests,omitempty" `
2020-08-16 22:07:38 -05:00
// either `true` to enable project unit, or `false` to disable them.
HasProjects * bool ` json:"has_projects,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.
IgnoreWhitespaceConflicts * bool ` json:"ignore_whitespace_conflicts,omitempty" `
// either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.
2019-05-11 05:21:34 -05:00
AllowMerge * bool ` json:"allow_merge_commits,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.
2019-05-11 05:21:34 -05:00
AllowRebase * bool ` json:"allow_rebase,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.
2019-05-11 05:21:34 -05:00
AllowRebaseMerge * bool ` json:"allow_rebase_explicit,omitempty" `
2019-05-30 10:09:05 -05:00
// either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.
AllowSquash * bool ` json:"allow_squash_merge,omitempty" `
// set to `true` to archive this repository.
2019-05-11 05:21:34 -05:00
Archived * bool ` json:"archived,omitempty" `
2016-11-07 08:53:13 -05:00
}
2020-05-29 13:16:20 -05:00
// CreateBranchRepoOption options when creating a branch in a repository
// swagger:model
type CreateBranchRepoOption struct {
// Name of the branch to create
//
// required: true
// unique: true
BranchName string ` json:"new_branch_name" binding:"Required;GitRefName;MaxSize(100)" `
// Name of the old branch to create from
//
// unique: true
OldBranchName string ` json:"old_branch_name" binding:"GitRefName;MaxSize(100)" `
}
2020-01-31 10:49:04 -05:00
// TransferRepoOption options when transfer a repository's ownership
// swagger:model
type TransferRepoOption struct {
// required: true
NewOwner string ` json:"new_owner" `
// ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
TeamIDs * [ ] int64 ` json:"team_ids" `
}
2019-10-14 01:10:42 -05:00
// GitServiceType represents a git service
type GitServiceType int
// enumerate all GitServiceType
const (
NotMigrated GitServiceType = iota // 0 not migrated from external sites
PlainGitService // 1 plain git service
GithubService // 2 github.com
GiteaService // 3 gitea service
GitlabService // 4 gitlab service
GogsService // 5 gogs service
)
// Name represents the service type's name
// WARNNING: the name have to be equal to that on goth's library
func ( gt GitServiceType ) Name ( ) string {
2020-09-09 13:29:10 -05:00
return strings . ToLower ( gt . Title ( ) )
2019-10-14 01:10:42 -05:00
}
2020-08-27 20:36:37 -05:00
// Title represents the service type's proper title
func ( gt GitServiceType ) Title ( ) string {
switch gt {
case GithubService :
return "GitHub"
case GiteaService :
return "Gitea"
case GitlabService :
return "GitLab"
case GogsService :
return "Gogs"
case PlainGitService :
return "Git"
}
return ""
}
// TokenAuth represents whether a service type supports token-based auth
func ( gt GitServiceType ) TokenAuth ( ) bool {
switch gt {
case GithubService , GiteaService , GitlabService :
return true
}
return false
}
2019-10-14 01:10:42 -05:00
var (
// SupportedFullGitService represents all git services supported to migrate issues/labels/prs and etc.
// TODO: add to this list after new git service added
SupportedFullGitService = [ ] GitServiceType {
GithubService ,
2020-04-19 10:44:11 -05:00
GitlabService ,
2019-10-14 01:10:42 -05:00
}
)
2017-11-13 02:02:25 -05:00
// MigrateRepoOption options for migrating a repository from an external service
2016-11-07 08:53:13 -05:00
type MigrateRepoOption struct {
2017-11-13 02:02:25 -05:00
// required: true
2018-03-05 20:22:16 -05:00
CloneAddr string ` json:"clone_addr" binding:"Required" `
2016-11-07 08:53:13 -05:00
AuthUsername string ` json:"auth_username" `
AuthPassword string ` json:"auth_password" `
2020-08-27 20:36:37 -05:00
AuthToken string ` json:"auth_token" `
2017-11-13 02:02:25 -05:00
// required: true
2017-08-21 06:13:47 -05:00
UID int ` json:"uid" binding:"Required" `
2017-11-13 02:02:25 -05:00
// required: true
2019-10-13 08:23:14 -05:00
RepoName string ` json:"repo_name" binding:"Required" `
Mirror bool ` json:"mirror" `
Private bool ` json:"private" `
Description string ` json:"description" `
2019-10-14 01:10:42 -05:00
OriginalURL string
GitServiceType GitServiceType
2019-10-13 08:23:14 -05:00
Wiki bool
Issues bool
Milestones bool
Labels bool
Releases bool
Comments bool
PullRequests bool
MigrateToRepoID int64
2016-11-07 08:53:13 -05:00
}