First implementation

Signed-off-by: jolheiser <[email protected]>

Author: jolheiser

cmd/web.go

@@ -5,7 +5,6 @@
 package cmd
 
 import (
-	"code.gitea.io/gitea/modules/webhook"
 	"context"
 	"fmt"
 	"net"
@@ -20,6 +19,7 @@ import (
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/process"
 	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/webhook"
 	"code.gitea.io/gitea/routers"
 	"code.gitea.io/gitea/routers/install"
 
@@ -163,8 +163,6 @@ func runWeb(ctx *cli.Context) error {
 		log.Fatal("Could not load custom webhooks: %v", err)
 	}
 
-	log.Info("%#v\n", webhook.Webhooks)
-
 	// We check that AppDataPath exists here (it should have been created during installation)
 	// We can't check it in `GlobalInitInstalled`, because some integration tests
 	// use cmd -> GlobalInitInstalled, but the AppDataPath doesn't exist during those tests.

models/migrations/migrations.go

@@ -387,6 +387,8 @@ var migrations = []Migration{
 	NewMigration("Add auto merge table", addAutoMergeTable),
 	// v215 -> v216
 	NewMigration("allow to view files in PRs", addReviewViewedFiles),
+	// v216 -> v217
+	NewMigration("Add custom webhooks", addCustomWebhooks),
 }
 
 // GetCurrentDBVersion returns the current db version

models/migrations/v217.go

@@ -0,0 +1,77 @@
+// Copyright 2022 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 migrations
+
+import (
+	"fmt"
+
+	"code.gitea.io/gitea/modules/timeutil"
+
+	"xorm.io/xorm"
+)
+
+func addCustomWebhooks(x *xorm.Engine) error {
+	type HookContentType int
+
+	type HookEvents struct {
+		Create               bool `json:"create"`
+		Delete               bool `json:"delete"`
+		Fork                 bool `json:"fork"`
+		Issues               bool `json:"issues"`
+		IssueAssign          bool `json:"issue_assign"`
+		IssueLabel           bool `json:"issue_label"`
+		IssueMilestone       bool `json:"issue_milestone"`
+		IssueComment         bool `json:"issue_comment"`
+		Push                 bool `json:"push"`
+		PullRequest          bool `json:"pull_request"`
+		PullRequestAssign    bool `json:"pull_request_assign"`
+		PullRequestLabel     bool `json:"pull_request_label"`
+		PullRequestMilestone bool `json:"pull_request_milestone"`
+		PullRequestComment   bool `json:"pull_request_comment"`
+		PullRequestReview    bool `json:"pull_request_review"`
+		PullRequestSync      bool `json:"pull_request_sync"`
+		Repository           bool `json:"repository"`
+		Release              bool `json:"release"`
+	}
+
+	type HookEvent struct {
+		PushOnly       bool   `json:"push_only"`
+		SendEverything bool   `json:"send_everything"`
+		ChooseEvents   bool   `json:"choose_events"`
+		BranchFilter   string `json:"branch_filter"`
+
+		HookEvents `json:"events"`
+	}
+
+	type HookType = string
+
+	type HookStatus int
+
+	type Webhook struct {
+		ID              int64  `xorm:"pk autoincr"`
+		CustomID        string `xorm:"VARCHAR(20) 'custom_id'"`
+		RepoID          int64  `xorm:"INDEX"` // An ID of 0 indicates either a default or system webhook
+		OrgID           int64  `xorm:"INDEX"`
+		IsSystemWebhook bool
+		URL             string `xorm:"url TEXT"`
+		HTTPMethod      string `xorm:"http_method"`
+		ContentType     HookContentType
+		Secret          string `xorm:"TEXT"`
+		Events          string `xorm:"TEXT"`
+		*HookEvent      `xorm:"-"`
+		IsActive        bool       `xorm:"INDEX"`
+		Type            HookType   `xorm:"VARCHAR(16) 'type'"`
+		Meta            string     `xorm:"TEXT"` // store hook-specific attributes
+		LastStatus      HookStatus // Last delivery status
+
+		CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
+		UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
+	}
+
+	if err := x.Sync2(new(Webhook)); err != nil {
+		return fmt.Errorf("Sync2: %v", err)
+	}
+	return nil
+}

models/webhook/webhook.go

@@ -163,6 +163,7 @@ const (
 	MATRIX     HookType = "matrix"
 	WECHATWORK HookType = "wechatwork"
 	PACKAGIST  HookType = "packagist"
+	CUSTOM     HookType = "custom"
 )
 
 // HookStatus is the status of a web hook
@@ -177,9 +178,10 @@ const (
 
 // Webhook represents a web hook object.
 type Webhook struct {
-	ID              int64 `xorm:"pk autoincr"`
-	RepoID          int64 `xorm:"INDEX"` // An ID of 0 indicates either a default or system webhook
-	OrgID           int64 `xorm:"INDEX"`
+	ID              int64  `xorm:"pk autoincr"`
+	CustomID        string `xorm:"VARCHAR(20) 'custom_id'"`
+	RepoID          int64  `xorm:"INDEX"` // An ID of 0 indicates either a default or system webhook
+	OrgID           int64  `xorm:"INDEX"`
 	IsSystemWebhook bool
 	URL             string `xorm:"url TEXT"`
 	HTTPMethod      string `xorm:"http_method"`

modules/webhook/webhook.go

@@ -8,32 +8,35 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"path/filepath"
 
 	"gopkg.in/yaml.v2"
 )
 
-var Webhooks map[string]*Webhook
+var Webhooks = make(map[string]*Webhook)
 
 // Webhook is a custom webhook
 type Webhook struct {
-	ID   string   `yaml:"id"`
-	HTTP string   `yaml:"http"`
-	Exec []string `yaml:"exec"`
-	Form []Form   `yaml:"form"`
-	Path string   `yaml:"-"`
+	ID    string   `yaml:"id"`
+	Label string   `yaml:"label"`
+	URL   string   `yaml:"url"`
+	HTTP  string   `yaml:"http"`
+	Exec  []string `yaml:"exec"`
+	Form  []Form   `yaml:"form"`
+	Path  string   `yaml:"-"`
 }
 
 // Image returns a custom webhook image if it exists, else the default image
-func (w *Webhook) Image() ([]byte, error) {
+// Image needs to be CLOSED
+func (w *Webhook) Image() (io.ReadCloser, error) {
 	img, err := os.Open(filepath.Join(w.Path, "image.png"))
 	if err != nil {
 		return nil, fmt.Errorf("could not open custom webhook image: %w", err)
 	}
-	defer img.Close()
 
-	return io.ReadAll(img)
+	return img, nil
 }
 
 // Form is a webhook form
@@ -45,6 +48,22 @@ type Form struct {
 	Default  string `yaml:"default"`
 }
 
+// InputType returns the HTML input type of a Form.Type
+func (f Form) InputType() string {
+	switch f.Type {
+	case "text":
+		return "text"
+	case "secret":
+		return "password"
+	case "number":
+		return "number"
+	case "bool":
+		return "checkbox"
+	default:
+		return "text"
+	}
+}
+
 func (w *Webhook) validate() error {
 	if w.ID == "" {
 		return errors.New("webhook id is required")
@@ -94,6 +113,9 @@ func Parse(r io.Reader) (*Webhook, error) {
 func Init(path string) error {
 	dir, err := os.ReadDir(path)
 	if err != nil {
+		if errors.Is(err, fs.ErrNotExist) {
+			return nil
+		}
 		return fmt.Errorf("could not read dir %q: %w", path, err)
 	}
 

modules/webhook/webhook_test.go

@@ -2,9 +2,11 @@ package webhook
 
 import (
 	"bytes"
+	"testing"
+
 	"code.gitea.io/gitea/testdata"
+
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestWebhook(t *testing.T) {

options/locale/locale_en-US.ini

@@ -1921,6 +1921,7 @@ settings.webhook.payload = Content
 settings.webhook.body = Body
 settings.webhook.replay.description = Replay this webhook.
 settings.webhook.delivery.success = An event has been added to the delivery queue. It may take few seconds before it shows up in the delivery history.
+settings.webhook.display_name = Display Name
 settings.githooks_desc = "Git Hooks are powered by Git itself. You can edit hook files below to set up custom operations."
 settings.githook_edit_desc = If the hook is inactive, sample content will be presented. Leaving content to an empty value will disable this hook.
 settings.githook_name = Hook Name

routers/web/admin/hooks.go

@@ -12,6 +12,7 @@ import (
 	"code.gitea.io/gitea/modules/context"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
+	cwebhook "code.gitea.io/gitea/modules/webhook"
 )
 
 const (
@@ -25,6 +26,7 @@ func DefaultOrSystemWebhooks(ctx *context.Context) {
 
 	ctx.Data["PageIsAdminSystemHooks"] = true
 	ctx.Data["PageIsAdminDefaultHooks"] = true
+	ctx.Data["CustomWebhooks"] = cwebhook.Webhooks
 
 	def := make(map[string]interface{}, len(ctx.Data))
 	sys := make(map[string]interface{}, len(ctx.Data))

routers/web/org/setting.go

@@ -21,6 +21,7 @@ import (
 	repo_module "code.gitea.io/gitea/modules/repository"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/web"
+	cwebhook "code.gitea.io/gitea/modules/webhook"
 	user_setting "code.gitea.io/gitea/routers/web/user/setting"
 	"code.gitea.io/gitea/services/forms"
 	"code.gitea.io/gitea/services/org"
@@ -206,6 +207,7 @@ func Webhooks(ctx *context.Context) {
 	ctx.Data["BaseLink"] = ctx.Org.OrgLink + "/settings/hooks"
 	ctx.Data["BaseLinkNew"] = ctx.Org.OrgLink + "/settings/hooks"
 	ctx.Data["Description"] = ctx.Tr("org.settings.hooks_desc")
+	ctx.Data["CustomWebhooks"] = cwebhook.Webhooks
 
 	ws, err := webhook.ListWebhooksByOpts(&webhook.ListWebhookOptions{OrgID: ctx.Org.Organization.ID})
 	if err != nil {

routers/web/repo/webhook.go

@@ -25,6 +25,7 @@ import (
 	api "code.gitea.io/gitea/modules/structs"
 	"code.gitea.io/gitea/modules/util"
 	"code.gitea.io/gitea/modules/web"
+	cwebhook "code.gitea.io/gitea/modules/webhook"
 	"code.gitea.io/gitea/services/forms"
 	webhook_service "code.gitea.io/gitea/services/webhook"
 )
@@ -50,6 +51,7 @@ func Webhooks(ctx *context.Context) {
 		return
 	}
 	ctx.Data["Webhooks"] = ws
+	ctx.Data["CustomWebhooks"] = cwebhook.Webhooks
 
 	ctx.HTML(http.StatusOK, tplHooks)
 }
@@ -108,19 +110,21 @@ func getOrgRepoCtx(ctx *context.Context) (*orgRepoCtx, error) {
 	return nil, errors.New("unable to set OrgRepo context")
 }
 
-func checkHookType(ctx *context.Context) string {
+func checkHookType(ctx *context.Context) (string, bool) {
 	hookType := strings.ToLower(ctx.Params(":type"))
-	if !util.IsStringInSlice(hookType, setting.Webhook.Types, true) {
+	_, isCustom := cwebhook.Webhooks[hookType]
+	if !util.IsStringInSlice(hookType, setting.Webhook.Types, true) && !isCustom {
 		ctx.NotFound("checkHookType", nil)
-		return ""
+		return "", false
 	}
-	return hookType
+	return hookType, isCustom
 }
 
 // WebhooksNew render creating webhook page
 func WebhooksNew(ctx *context.Context) {
 	ctx.Data["Title"] = ctx.Tr("repo.settings.add_webhook")
 	ctx.Data["Webhook"] = webhook.Webhook{HookEvent: &webhook.HookEvent{}}
+	ctx.Data["CustomWebhooks"] = cwebhook.Webhooks
 
 	orCtx, err := getOrgRepoCtx(ctx)
 	if err != nil {
@@ -139,7 +143,7 @@ func WebhooksNew(ctx *context.Context) {
 		ctx.Data["PageIsSettingsHooksNew"] = true
 	}
 
-	hookType := checkHookType(ctx)
+	hookType, isCustom := checkHookType(ctx)
 	ctx.Data["HookType"] = hookType
 	if ctx.Written() {
 		return
@@ -149,6 +153,9 @@ func WebhooksNew(ctx *context.Context) {
 			"Username": "Gitea",
 		}
 	}
+	if isCustom {
+		ctx.Data["CustomHook"] = cwebhook.Webhooks[hookType]
+	}
 	ctx.Data["BaseLink"] = orCtx.LinkNew
 
 	ctx.HTML(http.StatusOK, orCtx.NewTemplate)
@@ -771,6 +778,13 @@ func checkWebhook(ctx *context.Context) (*orgRepoCtx, *webhook.Webhook) {
 		ctx.Data["MatrixHook"] = webhook_service.GetMatrixHook(w)
 	case webhook.PACKAGIST:
 		ctx.Data["PackagistHook"] = webhook_service.GetPackagistHook(w)
+	case webhook.CUSTOM:
+		ctx.Data["CustomHook"] = cwebhook.Webhooks[w.CustomID]
+		hook := webhook_service.GetCustomHook(w)
+		ctx.Data["Webhook"] = hook
+		for key, val := range hook.Form {
+			ctx.Data["CustomHook_"+key] = val
+		}
 	}
 
 	ctx.Data["History"], err = w.History(1)