2016-11-07 08:53:13 -05:00
|
|
|
// Copyright 2016 The Gogs Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2016-11-07 08:53:13 -05:00
|
|
|
|
2019-05-11 05:21:34 -05:00
|
|
|
package structs
|
2016-11-07 08:53:13 -05:00
|
|
|
|
|
|
|
import (
|
2022-11-19 10:22:15 -05:00
|
|
|
"fmt"
|
2022-11-16 06:14:58 -05:00
|
|
|
"path"
|
2022-11-19 10:22:15 -05:00
|
|
|
"strings"
|
2016-11-07 08:53:13 -05:00
|
|
|
"time"
|
2022-11-19 10:22:15 -05:00
|
|
|
|
|
|
|
"gopkg.in/yaml.v3"
|
2016-11-07 08:53:13 -05:00
|
|
|
)
|
|
|
|
|
2016-11-29 03:09:17 -05:00
|
|
|
// StateType issue state type
|
2016-11-07 08:53:13 -05:00
|
|
|
type StateType string
|
|
|
|
|
|
|
|
const (
|
2016-11-29 03:09:17 -05:00
|
|
|
// StateOpen pr is opend
|
|
|
|
StateOpen StateType = "open"
|
|
|
|
// StateClosed pr is closed
|
|
|
|
StateClosed StateType = "closed"
|
2019-06-05 19:37:45 -05:00
|
|
|
// StateAll is all
|
|
|
|
StateAll StateType = "all"
|
2016-11-07 08:53:13 -05:00
|
|
|
)
|
|
|
|
|
2016-11-29 03:09:17 -05:00
|
|
|
// PullRequestMeta PR info if an issue is a PR
|
2016-11-07 08:53:13 -05:00
|
|
|
type PullRequestMeta struct {
|
|
|
|
HasMerged bool `json:"merged"`
|
|
|
|
Merged *time.Time `json:"merged_at"`
|
|
|
|
}
|
|
|
|
|
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 00:06:10 -05:00
|
|
|
// RepositoryMeta basic repository information
|
|
|
|
type RepositoryMeta struct {
|
|
|
|
ID int64 `json:"id"`
|
|
|
|
Name string `json:"name"`
|
2020-02-04 00:05:17 -05:00
|
|
|
Owner string `json:"owner"`
|
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 00:06:10 -05:00
|
|
|
FullName string `json:"full_name"`
|
|
|
|
}
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// Issue represents an issue in a repository
|
|
|
|
// swagger:model
|
2016-11-07 08:53:13 -05:00
|
|
|
type Issue struct {
|
2022-12-09 01:35:56 -05:00
|
|
|
ID int64 `json:"id"`
|
|
|
|
URL string `json:"url"`
|
|
|
|
HTMLURL string `json:"html_url"`
|
|
|
|
Index int64 `json:"number"`
|
|
|
|
Poster *User `json:"user"`
|
|
|
|
OriginalAuthor string `json:"original_author"`
|
|
|
|
OriginalAuthorID int64 `json:"original_author_id"`
|
|
|
|
Title string `json:"title"`
|
|
|
|
Body string `json:"body"`
|
|
|
|
Ref string `json:"ref"`
|
|
|
|
Attachments []*Attachment `json:"assets"`
|
|
|
|
Labels []*Label `json:"labels"`
|
|
|
|
Milestone *Milestone `json:"milestone"`
|
2020-12-15 13:38:10 -05:00
|
|
|
// deprecated
|
|
|
|
Assignee *User `json:"assignee"`
|
|
|
|
Assignees []*User `json:"assignees"`
|
2017-11-13 02:02:25 -05:00
|
|
|
// Whether the issue is open or closed
|
|
|
|
//
|
|
|
|
// type: string
|
|
|
|
// enum: open,closed
|
2018-03-05 20:22:16 -05:00
|
|
|
State StateType `json:"state"`
|
2020-06-01 16:01:55 -05:00
|
|
|
IsLocked bool `json:"is_locked"`
|
2018-03-05 20:22:16 -05:00
|
|
|
Comments int `json:"comments"`
|
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
|
2018-03-05 20:22:16 -05:00
|
|
|
Updated time.Time `json:"updated_at"`
|
2018-05-01 14:05:28 -05:00
|
|
|
// swagger:strfmt date-time
|
|
|
|
Closed *time.Time `json:"closed_at"`
|
|
|
|
// swagger:strfmt date-time
|
|
|
|
Deadline *time.Time `json:"due_date"`
|
2016-11-07 08:53:13 -05:00
|
|
|
|
|
|
|
PullRequest *PullRequestMeta `json:"pull_request"`
|
Allow cross-repository dependencies on issues (#7901)
* in progress changes for #7405, added ability to add cross-repo dependencies
* removed unused repolink var
* fixed query that was breaking ci tests; fixed check in issue dependency add so that the id of the issue and dependency is checked rather than the indexes
* reverted removal of string in local files becasue these are done via crowdin, not updated manually
* removed 'Select("issue.*")' from getBlockedByDependencies and getBlockingDependencies based on comments in PR review
* changed getBlockedByDependencies and getBlockingDependencies to use a more xorm-like query, also updated the sidebar as a result
* simplified the getBlockingDependencies and getBlockedByDependencies methods; changed the sidebar to show the dependencies in a different format where you can see the name of the repository
* made some changes to the issue view in the dependencies (issue name on top, repo full name on separate line). Change view of issue in the dependency search results (also showing the full repo name on separate line)
* replace call to FindUserAccessibleRepoIDs with SearchRepositoryByName. The former was hardcoded to use isPrivate = false on the repo search, but this code needed it to be true. The SearchRepositoryByName method is used more in the code including on the user's dashboard
* some more tweaks to the layout of the issues when showing dependencies and in the search box when you add new dependencies
* added Name to the RepositoryMeta struct
* updated swagger doc
* fixed total count for link header on SearchIssues
* fixed indentation
* fixed aligment of remove icon on dependencies in issue sidebar
* removed unnecessary nil check (unnecessary because issue.loadRepo is called prior to this block)
* reverting .css change, somehow missed or forgot that less is used
* updated less file and generated css; updated sidebar template with styles to line up delete and issue index
* added ordering to the blocked by/depends on queries
* fixed sorting in issue dependency search and the depends on/blocks views to show issues from the current repo first, then by created date descending; added a "all cross repository dependencies" setting to allow this feature to be turned off, if turned off, the issue dependency search will work the way it did before (restricted to the current repository)
* re-applied my swagger changes after merge
* fixed split string condition in issue search
* changed ALLOW_CROSS_REPOSITORY_DEPENDENCIES description to sound more global than just the issue dependency search; returning 400 in the cross repo issue search api method if not enabled; fixed bug where the issue count did not respect the state parameter
* when adding a dependency to an issue, added a check to make sure the issue and dependency are in the same repo if cross repo dependencies is not enabled
* updated sortIssuesSession call in PullRequests, another commit moved this method from pull.go to pull_list.go so I had to re-apply my change here
* fixed incorrect setting of user id parameter in search repos call
2019-10-31 00:06:10 -05:00
|
|
|
Repo *RepositoryMeta `json:"repository"`
|
2023-05-25 08:17:19 -05:00
|
|
|
|
|
|
|
PinOrder int `json:"pin_order"`
|
2016-11-07 08:53:13 -05:00
|
|
|
}
|
|
|
|
|
2016-11-29 03:09:17 -05:00
|
|
|
// CreateIssueOption options to create one issue
|
2016-11-07 08:53:13 -05:00
|
|
|
type CreateIssueOption struct {
|
2017-11-13 02:02:25 -05:00
|
|
|
// required:true
|
2018-03-05 20:22:16 -05:00
|
|
|
Title string `json:"title" binding:"Required"`
|
|
|
|
Body string `json:"body"`
|
2020-12-15 13:38:10 -05:00
|
|
|
Ref string `json:"ref"`
|
|
|
|
// deprecated
|
2018-05-01 14:05:28 -05:00
|
|
|
Assignee string `json:"assignee"`
|
|
|
|
Assignees []string `json:"assignees"`
|
|
|
|
// swagger:strfmt date-time
|
|
|
|
Deadline *time.Time `json:"due_date"`
|
2017-11-13 02:02:25 -05:00
|
|
|
// milestone id
|
2018-03-05 20:22:16 -05:00
|
|
|
Milestone int64 `json:"milestone"`
|
2017-11-13 02:02:25 -05:00
|
|
|
// list of label ids
|
2018-03-05 20:22:16 -05:00
|
|
|
Labels []int64 `json:"labels"`
|
|
|
|
Closed bool `json:"closed"`
|
2016-11-07 08:53:13 -05:00
|
|
|
}
|
|
|
|
|
2017-11-13 02:02:25 -05:00
|
|
|
// EditIssueOption options for editing an issue
|
2016-11-07 08:53:13 -05:00
|
|
|
type EditIssueOption struct {
|
2020-12-15 13:38:10 -05:00
|
|
|
Title string `json:"title"`
|
|
|
|
Body *string `json:"body"`
|
|
|
|
Ref *string `json:"ref"`
|
|
|
|
// deprecated
|
2018-05-16 09:01:55 -05:00
|
|
|
Assignee *string `json:"assignee"`
|
|
|
|
Assignees []string `json:"assignees"`
|
|
|
|
Milestone *int64 `json:"milestone"`
|
|
|
|
State *string `json:"state"`
|
2018-05-01 14:05:28 -05:00
|
|
|
// swagger:strfmt date-time
|
2019-11-03 09:46:32 -05:00
|
|
|
Deadline *time.Time `json:"due_date"`
|
|
|
|
RemoveDeadline *bool `json:"unset_due_date"`
|
2016-11-07 08:53:13 -05:00
|
|
|
}
|
|
|
|
|
2018-05-16 09:01:55 -05:00
|
|
|
// EditDeadlineOption options for creating a deadline
|
|
|
|
type EditDeadlineOption struct {
|
|
|
|
// required:true
|
|
|
|
// swagger:strfmt date-time
|
|
|
|
Deadline *time.Time `json:"due_date"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// IssueDeadline represents an issue deadline
|
|
|
|
// swagger:model
|
|
|
|
type IssueDeadline struct {
|
|
|
|
// swagger:strfmt date-time
|
|
|
|
Deadline *time.Time `json:"due_date"`
|
|
|
|
}
|
2020-09-11 09:48:39 -05:00
|
|
|
|
2022-09-02 02:58:49 -05:00
|
|
|
// IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes"
|
|
|
|
type IssueFormFieldType string
|
|
|
|
|
|
|
|
const (
|
|
|
|
IssueFormFieldTypeMarkdown IssueFormFieldType = "markdown"
|
|
|
|
IssueFormFieldTypeTextarea IssueFormFieldType = "textarea"
|
|
|
|
IssueFormFieldTypeInput IssueFormFieldType = "input"
|
|
|
|
IssueFormFieldTypeDropdown IssueFormFieldType = "dropdown"
|
|
|
|
IssueFormFieldTypeCheckboxes IssueFormFieldType = "checkboxes"
|
|
|
|
)
|
|
|
|
|
|
|
|
// IssueFormField represents a form field
|
|
|
|
// swagger:model
|
|
|
|
type IssueFormField struct {
|
|
|
|
Type IssueFormFieldType `json:"type" yaml:"type"`
|
|
|
|
ID string `json:"id" yaml:"id"`
|
|
|
|
Attributes map[string]interface{} `json:"attributes" yaml:"attributes"`
|
|
|
|
Validations map[string]interface{} `json:"validations" yaml:"validations"`
|
|
|
|
}
|
|
|
|
|
2020-09-11 09:48:39 -05:00
|
|
|
// IssueTemplate represents an issue template for a repository
|
|
|
|
// swagger:model
|
|
|
|
type IssueTemplate struct {
|
2022-11-19 10:22:15 -05:00
|
|
|
Name string `json:"name" yaml:"name"`
|
|
|
|
Title string `json:"title" yaml:"title"`
|
|
|
|
About string `json:"about" yaml:"about"` // Using "description" in a template file is compatible
|
|
|
|
Labels IssueTemplateLabels `json:"labels" yaml:"labels"`
|
|
|
|
Ref string `json:"ref" yaml:"ref"`
|
|
|
|
Content string `json:"content" yaml:"-"`
|
|
|
|
Fields []*IssueFormField `json:"body" yaml:"body"`
|
|
|
|
FileName string `json:"file_name" yaml:"-"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type IssueTemplateLabels []string
|
|
|
|
|
|
|
|
func (l *IssueTemplateLabels) UnmarshalYAML(value *yaml.Node) error {
|
|
|
|
var labels []string
|
|
|
|
if value.IsZero() {
|
|
|
|
*l = labels
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
switch value.Kind {
|
|
|
|
case yaml.ScalarNode:
|
|
|
|
str := ""
|
|
|
|
err := value.Decode(&str)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
for _, v := range strings.Split(str, ",") {
|
|
|
|
if v = strings.TrimSpace(v); v == "" {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
labels = append(labels, v)
|
|
|
|
}
|
|
|
|
*l = labels
|
|
|
|
return nil
|
|
|
|
case yaml.SequenceNode:
|
|
|
|
if err := value.Decode(&labels); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*l = labels
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return fmt.Errorf("line %d: cannot unmarshal %s into IssueTemplateLabels", value.Line, value.ShortTag())
|
2020-09-11 09:48:39 -05:00
|
|
|
}
|
|
|
|
|
2023-03-28 13:22:07 -05:00
|
|
|
type IssueConfigContactLink struct {
|
|
|
|
Name string `json:"name" yaml:"name"`
|
|
|
|
URL string `json:"url" yaml:"url"`
|
|
|
|
About string `json:"about" yaml:"about"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type IssueConfig struct {
|
|
|
|
BlankIssuesEnabled bool `json:"blank_issues_enabled" yaml:"blank_issues_enabled"`
|
|
|
|
ContactLinks []IssueConfigContactLink `json:"contact_links" yaml:"contact_links"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type IssueConfigValidation struct {
|
|
|
|
Valid bool `json:"valid"`
|
|
|
|
Message string `json:"message"`
|
|
|
|
}
|
|
|
|
|
2022-09-02 02:58:49 -05:00
|
|
|
// IssueTemplateType defines issue template type
|
|
|
|
type IssueTemplateType string
|
|
|
|
|
|
|
|
const (
|
|
|
|
IssueTemplateTypeMarkdown IssueTemplateType = "md"
|
|
|
|
IssueTemplateTypeYaml IssueTemplateType = "yaml"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Type returns the type of IssueTemplate, can be "md", "yaml" or empty for known
|
|
|
|
func (it IssueTemplate) Type() IssueTemplateType {
|
2022-11-16 06:14:58 -05:00
|
|
|
if base := path.Base(it.FileName); base == "config.yaml" || base == "config.yml" {
|
2022-09-02 02:58:49 -05:00
|
|
|
// ignore config.yaml which is a special configuration file
|
|
|
|
return ""
|
|
|
|
}
|
2022-11-16 06:14:58 -05:00
|
|
|
if ext := path.Ext(it.FileName); ext == ".md" {
|
2022-09-02 02:58:49 -05:00
|
|
|
return IssueTemplateTypeMarkdown
|
|
|
|
} else if ext == ".yaml" || ext == ".yml" {
|
2022-10-31 10:10:33 -05:00
|
|
|
return IssueTemplateTypeYaml
|
2022-09-02 02:58:49 -05:00
|
|
|
}
|
2022-10-31 10:10:33 -05:00
|
|
|
return ""
|
2020-09-11 09:48:39 -05:00
|
|
|
}
|
2023-03-28 12:23:25 -05:00
|
|
|
|
|
|
|
// IssueMeta basic issue information
|
|
|
|
// swagger:model
|
|
|
|
type IssueMeta struct {
|
|
|
|
Index int64 `json:"index"`
|
|
|
|
Owner string `json:"owner"`
|
|
|
|
Name string `json:"repo"`
|
|
|
|
}
|