mirror of
https://github.com/go-gitea/gitea
synced 2024-11-16 07:04:25 +00:00
3963625b6e
Add support for triggering webhook notifications on wiki changes. This PR contains frontend and backend for webhook notifications on wiki actions (create a new page, rename a page, edit a page and delete a page). The frontend got a new checkbox under the Custom Event -> Repository Events section. There is only one checkbox for create/edit/rename/delete actions, because it makes no sense to separate it and others like releases or packages follow the same schema. ![image](https://user-images.githubusercontent.com/121972/177018803-26851196-831f-4fde-9a4c-9e639b0e0d6b.png) The actions itself are separated, so that different notifications will be executed (with the "action" field). All the webhook receivers implement the new interface method (Wiki) and the corresponding tests. When implementing this, I encounter a little bug on editing a wiki page. Creating and editing a wiki page is technically the same action and will be handled by the ```updateWikiPage``` function. But the function need to know if it is a new wiki page or just a change. This distinction is done by the ```action``` parameter, but this will not be sent by the frontend (on form submit). This PR will fix this by adding the ```action``` parameter with the values ```_new``` or ```_edit```, which will be used by the ```updateWikiPage``` function. I've done integration tests with matrix and gitea (http). ![image](https://user-images.githubusercontent.com/121972/177018795-eb5cdc01-9ba3-483e-a6b7-ed0e313a71fb.png) Fix #16457 Signed-off-by: Aaron Fischer <mail@aaron-fischer.net>
893 lines
30 KiB
Go
893 lines
30 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package forms
|
|
|
|
import (
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
project_model "code.gitea.io/gitea/models/project"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/web/middleware"
|
|
"code.gitea.io/gitea/services/webhook"
|
|
|
|
"gitea.com/go-chi/binding"
|
|
)
|
|
|
|
// _______________________________________ _________.______________________ _______________.___.
|
|
// \______ \_ _____/\______ \_____ \ / _____/| \__ ___/\_____ \\______ \__ | |
|
|
// | _/| __)_ | ___// | \ \_____ \ | | | | / | \| _// | |
|
|
// | | \| \ | | / | \/ \| | | | / | \ | \\____ |
|
|
// |____|_ /_______ / |____| \_______ /_______ /|___| |____| \_______ /____|_ // ______|
|
|
// \/ \/ \/ \/ \/ \/ \/
|
|
|
|
// CreateRepoForm form for creating repository
|
|
type CreateRepoForm struct {
|
|
UID int64 `binding:"Required"`
|
|
RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"`
|
|
Private bool
|
|
Description string `binding:"MaxSize(255)"`
|
|
DefaultBranch string `binding:"GitRefName;MaxSize(100)"`
|
|
AutoInit bool
|
|
Gitignores string
|
|
IssueLabels string
|
|
License string
|
|
Readme string
|
|
Template bool
|
|
|
|
RepoTemplate int64
|
|
GitContent bool
|
|
Topics bool
|
|
GitHooks bool
|
|
Webhooks bool
|
|
Avatar bool
|
|
Labels bool
|
|
TrustModel string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CreateRepoForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// MigrateRepoForm form for migrating repository
|
|
// this is used to interact with web ui
|
|
type MigrateRepoForm struct {
|
|
// required: true
|
|
CloneAddr string `json:"clone_addr" binding:"Required"`
|
|
Service structs.GitServiceType `json:"service"`
|
|
AuthUsername string `json:"auth_username"`
|
|
AuthPassword string `json:"auth_password"`
|
|
AuthToken string `json:"auth_token"`
|
|
// required: true
|
|
UID int64 `json:"uid" binding:"Required"`
|
|
// required: true
|
|
RepoName string `json:"repo_name" binding:"Required;AlphaDashDot;MaxSize(100)"`
|
|
Mirror bool `json:"mirror"`
|
|
LFS bool `json:"lfs"`
|
|
LFSEndpoint string `json:"lfs_endpoint"`
|
|
Private bool `json:"private"`
|
|
Description string `json:"description" binding:"MaxSize(255)"`
|
|
Wiki bool `json:"wiki"`
|
|
Milestones bool `json:"milestones"`
|
|
Labels bool `json:"labels"`
|
|
Issues bool `json:"issues"`
|
|
PullRequests bool `json:"pull_requests"`
|
|
Releases bool `json:"releases"`
|
|
MirrorInterval string `json:"mirror_interval"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *MigrateRepoForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ParseRemoteAddr checks if given remote address is valid,
|
|
// and returns composed URL with needed username and password.
|
|
func ParseRemoteAddr(remoteAddr, authUsername, authPassword string) (string, error) {
|
|
remoteAddr = strings.TrimSpace(remoteAddr)
|
|
// Remote address can be HTTP/HTTPS/Git URL or local path.
|
|
if strings.HasPrefix(remoteAddr, "http://") ||
|
|
strings.HasPrefix(remoteAddr, "https://") ||
|
|
strings.HasPrefix(remoteAddr, "git://") {
|
|
u, err := url.Parse(remoteAddr)
|
|
if err != nil {
|
|
return "", &models.ErrInvalidCloneAddr{IsURLError: true, Host: remoteAddr}
|
|
}
|
|
if len(authUsername)+len(authPassword) > 0 {
|
|
u.User = url.UserPassword(authUsername, authPassword)
|
|
}
|
|
remoteAddr = u.String()
|
|
}
|
|
|
|
return remoteAddr, nil
|
|
}
|
|
|
|
// RepoSettingForm form for changing repository settings
|
|
type RepoSettingForm struct {
|
|
RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"`
|
|
Description string `binding:"MaxSize(255)"`
|
|
Website string `binding:"ValidUrl;MaxSize(255)"`
|
|
Interval string
|
|
MirrorAddress string
|
|
MirrorUsername string
|
|
MirrorPassword string
|
|
LFS bool `form:"mirror_lfs"`
|
|
LFSEndpoint string `form:"mirror_lfs_endpoint"`
|
|
PushMirrorID string
|
|
PushMirrorAddress string
|
|
PushMirrorUsername string
|
|
PushMirrorPassword string
|
|
PushMirrorSyncOnCommit bool
|
|
PushMirrorInterval string
|
|
Private bool
|
|
Template bool
|
|
EnablePrune bool
|
|
|
|
// Advanced settings
|
|
EnableWiki bool
|
|
EnableExternalWiki bool
|
|
ExternalWikiURL string
|
|
EnableIssues bool
|
|
EnableExternalTracker bool
|
|
ExternalTrackerURL string
|
|
TrackerURLFormat string
|
|
TrackerIssueStyle string
|
|
ExternalTrackerRegexpPattern string
|
|
EnableCloseIssuesViaCommitInAnyBranch bool
|
|
EnableProjects bool
|
|
EnablePackages bool
|
|
EnablePulls bool
|
|
PullsIgnoreWhitespace bool
|
|
PullsAllowMerge bool
|
|
PullsAllowRebase bool
|
|
PullsAllowRebaseMerge bool
|
|
PullsAllowSquash bool
|
|
PullsAllowManualMerge bool
|
|
PullsDefaultMergeStyle string
|
|
EnableAutodetectManualMerge bool
|
|
PullsAllowRebaseUpdate bool
|
|
DefaultDeleteBranchAfterMerge bool
|
|
EnableTimetracker bool
|
|
AllowOnlyContributorsToTrackTime bool
|
|
EnableIssueDependencies bool
|
|
IsArchived bool
|
|
|
|
// Signing Settings
|
|
TrustModel string
|
|
|
|
// Admin settings
|
|
EnableHealthCheck bool
|
|
RequestReindexType string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *RepoSettingForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// __________ .__
|
|
// \______ \____________ ____ ____ | |__
|
|
// | | _/\_ __ \__ \ / \_/ ___\| | \
|
|
// | | \ | | \// __ \| | \ \___| Y \
|
|
// |______ / |__| (____ /___| /\___ >___| /
|
|
// \/ \/ \/ \/ \/
|
|
|
|
// ProtectBranchForm form for changing protected branch settings
|
|
type ProtectBranchForm struct {
|
|
Protected bool
|
|
EnablePush string
|
|
WhitelistUsers string
|
|
WhitelistTeams string
|
|
WhitelistDeployKeys bool
|
|
EnableMergeWhitelist bool
|
|
MergeWhitelistUsers string
|
|
MergeWhitelistTeams string
|
|
EnableStatusCheck bool
|
|
StatusCheckContexts []string
|
|
RequiredApprovals int64
|
|
EnableApprovalsWhitelist bool
|
|
ApprovalsWhitelistUsers string
|
|
ApprovalsWhitelistTeams string
|
|
BlockOnRejectedReviews bool
|
|
BlockOnOfficialReviewRequests bool
|
|
BlockOnOutdatedBranch bool
|
|
DismissStaleApprovals bool
|
|
RequireSignedCommits bool
|
|
ProtectedFilePatterns string
|
|
UnprotectedFilePatterns string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *ProtectBranchForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// __ __ ___. .__ __
|
|
// / \ / \ ____\_ |__ | |__ ____ ____ | | __
|
|
// \ \/\/ // __ \| __ \| | \ / _ \ / _ \| |/ /
|
|
// \ /\ ___/| \_\ \ Y ( <_> | <_> ) <
|
|
// \__/\ / \___ >___ /___| /\____/ \____/|__|_ \
|
|
// \/ \/ \/ \/ \/
|
|
|
|
// WebhookForm form for changing web hook
|
|
type WebhookForm struct {
|
|
Events string
|
|
Create bool
|
|
Delete bool
|
|
Fork bool
|
|
Issues bool
|
|
IssueAssign bool
|
|
IssueLabel bool
|
|
IssueMilestone bool
|
|
IssueComment bool
|
|
Release bool
|
|
Push bool
|
|
PullRequest bool
|
|
PullRequestAssign bool
|
|
PullRequestLabel bool
|
|
PullRequestMilestone bool
|
|
PullRequestComment bool
|
|
PullRequestReview bool
|
|
PullRequestSync bool
|
|
Wiki bool
|
|
Repository bool
|
|
Package bool
|
|
Active bool
|
|
BranchFilter string `binding:"GlobPattern"`
|
|
}
|
|
|
|
// PushOnly if the hook will be triggered when push
|
|
func (f WebhookForm) PushOnly() bool {
|
|
return f.Events == "push_only"
|
|
}
|
|
|
|
// SendEverything if the hook will be triggered any event
|
|
func (f WebhookForm) SendEverything() bool {
|
|
return f.Events == "send_everything"
|
|
}
|
|
|
|
// ChooseEvents if the hook will be triggered choose events
|
|
func (f WebhookForm) ChooseEvents() bool {
|
|
return f.Events == "choose_events"
|
|
}
|
|
|
|
// NewWebhookForm form for creating web hook
|
|
type NewWebhookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
HTTPMethod string `binding:"Required;In(POST,GET)"`
|
|
ContentType int `binding:"Required"`
|
|
Secret string
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewWebhookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewGogshookForm form for creating gogs hook
|
|
type NewGogshookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
ContentType int `binding:"Required"`
|
|
Secret string
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewGogshookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewSlackHookForm form for creating slack hook
|
|
type NewSlackHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
Channel string `binding:"Required"`
|
|
Username string
|
|
IconURL string
|
|
Color string
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewSlackHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
if !webhook.IsValidSlackChannel(strings.TrimSpace(f.Channel)) {
|
|
errs = append(errs, binding.Error{
|
|
FieldNames: []string{"Channel"},
|
|
Classification: "",
|
|
Message: ctx.Tr("repo.settings.add_webhook.invalid_channel_name"),
|
|
})
|
|
}
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewDiscordHookForm form for creating discord hook
|
|
type NewDiscordHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
Username string
|
|
IconURL string
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewDiscordHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewDingtalkHookForm form for creating dingtalk hook
|
|
type NewDingtalkHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewDingtalkHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewTelegramHookForm form for creating telegram hook
|
|
type NewTelegramHookForm struct {
|
|
BotToken string `binding:"Required"`
|
|
ChatID string `binding:"Required"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewTelegramHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewMatrixHookForm form for creating Matrix hook
|
|
type NewMatrixHookForm struct {
|
|
HomeserverURL string `binding:"Required;ValidUrl"`
|
|
RoomID string `binding:"Required"`
|
|
AccessToken string `binding:"Required"`
|
|
MessageType int
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewMatrixHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewMSTeamsHookForm form for creating MS Teams hook
|
|
type NewMSTeamsHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewMSTeamsHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewFeishuHookForm form for creating feishu hook
|
|
type NewFeishuHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewFeishuHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewWechatWorkHookForm form for creating wechatwork hook
|
|
type NewWechatWorkHookForm struct {
|
|
PayloadURL string `binding:"Required;ValidUrl"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewWechatWorkHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// NewPackagistHookForm form for creating packagist hook
|
|
type NewPackagistHookForm struct {
|
|
Username string `binding:"Required"`
|
|
APIToken string `binding:"Required"`
|
|
PackageURL string `binding:"Required;ValidUrl"`
|
|
WebhookForm
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewPackagistHookForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// .___
|
|
// | | ______ ________ __ ____
|
|
// | |/ ___// ___/ | \_/ __ \
|
|
// | |\___ \ \___ \| | /\ ___/
|
|
// |___/____ >____ >____/ \___ >
|
|
// \/ \/ \/
|
|
|
|
// CreateIssueForm form for creating issue
|
|
type CreateIssueForm struct {
|
|
Title string `binding:"Required;MaxSize(255)"`
|
|
LabelIDs string `form:"label_ids"`
|
|
AssigneeIDs string `form:"assignee_ids"`
|
|
Ref string `form:"ref"`
|
|
MilestoneID int64
|
|
ProjectID int64
|
|
AssigneeID int64
|
|
Content string
|
|
Files []string
|
|
AllowMaintainerEdit bool
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CreateIssueForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// CreateCommentForm form for creating comment
|
|
type CreateCommentForm struct {
|
|
Content string
|
|
Status string `binding:"OmitEmpty;In(reopen,close)"`
|
|
Files []string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CreateCommentForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ReactionForm form for adding and removing reaction
|
|
type ReactionForm struct {
|
|
Content string `binding:"Required"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *ReactionForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// IssueLockForm form for locking an issue
|
|
type IssueLockForm struct {
|
|
Reason string `binding:"Required"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (i *IssueLockForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, i, ctx.Locale)
|
|
}
|
|
|
|
// HasValidReason checks to make sure that the reason submitted in
|
|
// the form matches any of the values in the config
|
|
func (i IssueLockForm) HasValidReason() bool {
|
|
if strings.TrimSpace(i.Reason) == "" {
|
|
return true
|
|
}
|
|
|
|
for _, v := range setting.Repository.Issue.LockReasons {
|
|
if v == i.Reason {
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
// __________ __ __
|
|
// \______ \_______ ____ |__| ____ _____/ |_ ______
|
|
// | ___/\_ __ \/ _ \ | |/ __ \_/ ___\ __\/ ___/
|
|
// | | | | \( <_> ) | \ ___/\ \___| | \___ \
|
|
// |____| |__| \____/\__| |\___ >\___ >__| /____ >
|
|
// \______| \/ \/ \/
|
|
|
|
// CreateProjectForm form for creating a project
|
|
type CreateProjectForm struct {
|
|
Title string `binding:"Required;MaxSize(100)"`
|
|
Content string
|
|
BoardType project_model.BoardType
|
|
}
|
|
|
|
// UserCreateProjectForm is a from for creating an individual or organization
|
|
// form.
|
|
type UserCreateProjectForm struct {
|
|
Title string `binding:"Required;MaxSize(100)"`
|
|
Content string
|
|
BoardType project_model.BoardType
|
|
UID int64 `binding:"Required"`
|
|
}
|
|
|
|
// EditProjectBoardForm is a form for editing a project board
|
|
type EditProjectBoardForm struct {
|
|
Title string `binding:"Required;MaxSize(100)"`
|
|
Sorting int8
|
|
Color string `binding:"MaxSize(7)"`
|
|
}
|
|
|
|
// _____ .__.__ __
|
|
// / \ |__| | ____ _______/ |_ ____ ____ ____
|
|
// / \ / \| | | _/ __ \ / ___/\ __\/ _ \ / \_/ __ \
|
|
// / Y \ | |_\ ___/ \___ \ | | ( <_> ) | \ ___/
|
|
// \____|__ /__|____/\___ >____ > |__| \____/|___| /\___ >
|
|
// \/ \/ \/ \/ \/
|
|
|
|
// CreateMilestoneForm form for creating milestone
|
|
type CreateMilestoneForm struct {
|
|
Title string `binding:"Required;MaxSize(50)"`
|
|
Content string
|
|
Deadline string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CreateMilestoneForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// .____ ___. .__
|
|
// | | _____ \_ |__ ____ | |
|
|
// | | \__ \ | __ \_/ __ \| |
|
|
// | |___ / __ \| \_\ \ ___/| |__
|
|
// |_______ (____ /___ /\___ >____/
|
|
// \/ \/ \/ \/
|
|
|
|
// CreateLabelForm form for creating label
|
|
type CreateLabelForm struct {
|
|
ID int64
|
|
Title string `binding:"Required;MaxSize(50)" locale:"repo.issues.label_title"`
|
|
Description string `binding:"MaxSize(200)" locale:"repo.issues.label_description"`
|
|
Color string `binding:"Required;MaxSize(7)" locale:"repo.issues.label_color"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CreateLabelForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// InitializeLabelsForm form for initializing labels
|
|
type InitializeLabelsForm struct {
|
|
TemplateName string `binding:"Required"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *InitializeLabelsForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// __________ .__ .__ __________ __
|
|
// \______ \__ __| | | | \______ \ ____ ________ __ ____ _______/ |_
|
|
// | ___/ | \ | | | | _// __ \/ ____/ | \_/ __ \ / ___/\ __\
|
|
// | | | | / |_| |__ | | \ ___< <_| | | /\ ___/ \___ \ | |
|
|
// |____| |____/|____/____/ |____|_ /\___ >__ |____/ \___ >____ > |__|
|
|
// \/ \/ |__| \/ \/
|
|
|
|
// MergePullRequestForm form for merging Pull Request
|
|
// swagger:model MergePullRequestOption
|
|
type MergePullRequestForm struct {
|
|
// required: true
|
|
// enum: merge,rebase,rebase-merge,squash,manually-merged
|
|
Do string `binding:"Required;In(merge,rebase,rebase-merge,squash,manually-merged)"`
|
|
MergeTitleField string
|
|
MergeMessageField string
|
|
MergeCommitID string // only used for manually-merged
|
|
HeadCommitID string `json:"head_commit_id,omitempty"`
|
|
ForceMerge *bool `json:"force_merge,omitempty"`
|
|
MergeWhenChecksSucceed bool `json:"merge_when_checks_succeed,omitempty"`
|
|
DeleteBranchAfterMerge bool `json:"delete_branch_after_merge,omitempty"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *MergePullRequestForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// CodeCommentForm form for adding code comments for PRs
|
|
type CodeCommentForm struct {
|
|
Origin string `binding:"Required;In(timeline,diff)"`
|
|
Content string `binding:"Required"`
|
|
Side string `binding:"Required;In(previous,proposed)"`
|
|
Line int64
|
|
TreePath string `form:"path" binding:"Required"`
|
|
IsReview bool `form:"is_review"`
|
|
Reply int64 `form:"reply"`
|
|
LatestCommitID string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CodeCommentForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// SubmitReviewForm for submitting a finished code review
|
|
type SubmitReviewForm struct {
|
|
Content string
|
|
Type string
|
|
CommitID string
|
|
Files []string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *SubmitReviewForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ReviewType will return the corresponding ReviewType for type
|
|
func (f SubmitReviewForm) ReviewType() issues_model.ReviewType {
|
|
switch f.Type {
|
|
case "approve":
|
|
return issues_model.ReviewTypeApprove
|
|
case "comment":
|
|
return issues_model.ReviewTypeComment
|
|
case "reject":
|
|
return issues_model.ReviewTypeReject
|
|
case "":
|
|
return issues_model.ReviewTypeComment // default to comment when doing quick-submit (Ctrl+Enter) on the review form
|
|
default:
|
|
return issues_model.ReviewTypeUnknown
|
|
}
|
|
}
|
|
|
|
// HasEmptyContent checks if the content of the review form is empty.
|
|
func (f SubmitReviewForm) HasEmptyContent() bool {
|
|
reviewType := f.ReviewType()
|
|
|
|
return (reviewType == issues_model.ReviewTypeComment || reviewType == issues_model.ReviewTypeReject) &&
|
|
len(strings.TrimSpace(f.Content)) == 0
|
|
}
|
|
|
|
// DismissReviewForm for dismissing stale review by repo admin
|
|
type DismissReviewForm struct {
|
|
ReviewID int64 `binding:"Required"`
|
|
Message string
|
|
}
|
|
|
|
// UpdateAllowEditsForm form for changing if PR allows edits from maintainers
|
|
type UpdateAllowEditsForm struct {
|
|
AllowMaintainerEdit bool
|
|
}
|
|
|
|
// __________ .__
|
|
// \______ \ ____ | | ____ _____ ______ ____
|
|
// | _// __ \| | _/ __ \\__ \ / ___// __ \
|
|
// | | \ ___/| |_\ ___/ / __ \_\___ \\ ___/
|
|
// |____|_ /\___ >____/\___ >____ /____ >\___ >
|
|
// \/ \/ \/ \/ \/ \/
|
|
|
|
// NewReleaseForm form for creating release
|
|
type NewReleaseForm struct {
|
|
TagName string `binding:"Required;GitRefName;MaxSize(255)"`
|
|
Target string `form:"tag_target" binding:"Required;MaxSize(255)"`
|
|
Title string `binding:"Required;MaxSize(255)"`
|
|
Content string
|
|
Draft string
|
|
TagOnly string
|
|
Prerelease bool
|
|
AddTagMsg bool
|
|
Files []string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *NewReleaseForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// EditReleaseForm form for changing release
|
|
type EditReleaseForm struct {
|
|
Title string `form:"title" binding:"Required;MaxSize(255)"`
|
|
Content string `form:"content"`
|
|
Draft string `form:"draft"`
|
|
Prerelease bool `form:"prerelease"`
|
|
Files []string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *EditReleaseForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// __ __.__ __ .__
|
|
// / \ / \__| | _|__|
|
|
// \ \/\/ / | |/ / |
|
|
// \ /| | <| |
|
|
// \__/\ / |__|__|_ \__|
|
|
// \/ \/
|
|
|
|
// NewWikiForm form for creating wiki
|
|
type NewWikiForm struct {
|
|
Title string `binding:"Required"`
|
|
Content string `binding:"Required"`
|
|
Message string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
// FIXME: use code generation to generate this method.
|
|
func (f *NewWikiForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ___________ .___.__ __
|
|
// \_ _____/ __| _/|__|/ |_
|
|
// | __)_ / __ | | \ __\
|
|
// | \/ /_/ | | || |
|
|
// /_______ /\____ | |__||__|
|
|
// \/ \/
|
|
|
|
// EditRepoFileForm form for changing repository file
|
|
type EditRepoFileForm struct {
|
|
TreePath string `binding:"Required;MaxSize(500)"`
|
|
Content string
|
|
CommitSummary string `binding:"MaxSize(100)"`
|
|
CommitMessage string
|
|
CommitChoice string `binding:"Required;MaxSize(50)"`
|
|
NewBranchName string `binding:"GitRefName;MaxSize(100)"`
|
|
LastCommit string
|
|
Signoff bool
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *EditRepoFileForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// EditPreviewDiffForm form for changing preview diff
|
|
type EditPreviewDiffForm struct {
|
|
Content string
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *EditPreviewDiffForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// _________ .__ __________.__ __
|
|
// \_ ___ \| |__ __________________ ___.__. \______ \__| ____ | | __
|
|
// / \ \/| | \_/ __ \_ __ \_ __ < | | | ___/ |/ ___\| |/ /
|
|
// \ \___| Y \ ___/| | \/| | \/\___ | | | | \ \___| <
|
|
// \______ /___| /\___ >__| |__| / ____| |____| |__|\___ >__|_ \
|
|
// \/ \/ \/ \/ \/ \/
|
|
|
|
// CherryPickForm form for changing repository file
|
|
type CherryPickForm struct {
|
|
CommitSummary string `binding:"MaxSize(100)"`
|
|
CommitMessage string
|
|
CommitChoice string `binding:"Required;MaxSize(50)"`
|
|
NewBranchName string `binding:"GitRefName;MaxSize(100)"`
|
|
LastCommit string
|
|
Revert bool
|
|
Signoff bool
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *CherryPickForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ____ ___ .__ .___
|
|
// | | \______ | | _________ __| _/
|
|
// | | /\____ \| | / _ \__ \ / __ |
|
|
// | | / | |_> > |_( <_> ) __ \_/ /_/ |
|
|
// |______/ | __/|____/\____(____ /\____ |
|
|
// |__| \/ \/
|
|
//
|
|
|
|
// UploadRepoFileForm form for uploading repository file
|
|
type UploadRepoFileForm struct {
|
|
TreePath string `binding:"MaxSize(500)"`
|
|
CommitSummary string `binding:"MaxSize(100)"`
|
|
CommitMessage string
|
|
CommitChoice string `binding:"Required;MaxSize(50)"`
|
|
NewBranchName string `binding:"GitRefName;MaxSize(100)"`
|
|
Files []string
|
|
Signoff bool
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *UploadRepoFileForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// RemoveUploadFileForm form for removing uploaded file
|
|
type RemoveUploadFileForm struct {
|
|
File string `binding:"Required;MaxSize(50)"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *RemoveUploadFileForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ________ .__ __
|
|
// \______ \ ____ | | _____/ |_ ____
|
|
// | | \_/ __ \| | _/ __ \ __\/ __ \
|
|
// | ` \ ___/| |_\ ___/| | \ ___/
|
|
// /_______ /\___ >____/\___ >__| \___ >
|
|
// \/ \/ \/ \/
|
|
|
|
// DeleteRepoFileForm form for deleting repository file
|
|
type DeleteRepoFileForm struct {
|
|
CommitSummary string `binding:"MaxSize(100)"`
|
|
CommitMessage string
|
|
CommitChoice string `binding:"Required;MaxSize(50)"`
|
|
NewBranchName string `binding:"GitRefName;MaxSize(100)"`
|
|
LastCommit string
|
|
Signoff bool
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *DeleteRepoFileForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// ___________.__ ___________ __
|
|
// \__ ___/|__| _____ ____ \__ ___/___________ ____ | | __ ___________
|
|
// | | | |/ \_/ __ \ | | \_ __ \__ \ _/ ___\| |/ // __ \_ __ \
|
|
// | | | | Y Y \ ___/ | | | | \// __ \\ \___| <\ ___/| | \/
|
|
// |____| |__|__|_| /\___ > |____| |__| (____ /\___ >__|_ \\___ >__|
|
|
// \/ \/ \/ \/ \/ \/
|
|
|
|
// AddTimeManuallyForm form that adds spent time manually.
|
|
type AddTimeManuallyForm struct {
|
|
Hours int `binding:"Range(0,1000)"`
|
|
Minutes int `binding:"Range(0,1000)"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *AddTimeManuallyForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|
|
|
|
// SaveTopicForm form for save topics for repository
|
|
type SaveTopicForm struct {
|
|
Topics []string `binding:"topics;Required;"`
|
|
}
|
|
|
|
// DeadlineForm hold the validation rules for deadlines
|
|
type DeadlineForm struct {
|
|
DateString string `form:"date" binding:"Required;Size(10)"`
|
|
}
|
|
|
|
// Validate validates the fields
|
|
func (f *DeadlineForm) Validate(req *http.Request, errs binding.Errors) binding.Errors {
|
|
ctx := context.GetContext(req)
|
|
return middleware.Validate(errs, ctx.Data, f, ctx.Locale)
|
|
}
|