WIP: Custom Webhooks

cmd/web.go

@@ -10,6 +10,7 @@ import (
 	"net"
 	"net/http"
 	"os"
+	"path/filepath"
 	"strings"
 
 	_ "net/http/pprof" // Used for debugging if enabled and a web server is running
@@ -18,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"
 
@@ -157,6 +159,10 @@ func runWeb(ctx *cli.Context) error {
 	setting.LoadFromExisting()
 	routers.GlobalInitInstalled(graceful.GetManager().HammerContext())
 
+	if err := webhook.Init(filepath.Join(setting.CustomPath, "webhooks")); err != nil {
+		log.Fatal("Could not load custom webhooks: %v", err)
+	}
+
 	// 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.

go.mod

@@ -42,6 +42,7 @@ require (
 	github.com/gogs/go-gogs-client v0.0.0-20210131175652-1d7215cd8d85
 	github.com/golang-jwt/jwt/v4 v4.4.1
 	github.com/google/go-github/v39 v39.2.0
+	github.com/google/go-jsonnet v0.18.0
 	github.com/google/pprof v0.0.0-20220509035851-59ca7ad80af3
 	github.com/google/uuid v1.3.0
 	github.com/gorilla/feeds v1.1.1

go.sum

@@ -426,6 +426,7 @@ github.com/ethantkoenig/rupture v1.0.1 h1:6aAXghmvtnngMgQzy7SMGdicMvkV86V4n9fT0m
 github.com/ethantkoenig/rupture v1.0.1/go.mod h1:Sjqo/nbffZp1pVVXNGhpugIjsWmuS9KiIB4GtpEBur4=
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
+github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
 github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
 github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
 github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
@@ -745,6 +746,8 @@ github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8
 github.com/google/go-github/v28 v28.1.1/go.mod h1:bsqJWQX05omyWVmc00nEUql9mhQyv38lDZ8kPZcQVoM=
 github.com/google/go-github/v39 v39.2.0 h1:rNNM311XtPOz5rDdsJXAp2o8F67X9FnROXTvto3aSnQ=
 github.com/google/go-github/v39 v39.2.0/go.mod h1:C1s8C5aCC9L+JXIYpJM5GYytdX52vC1bLvHEF1IhBrE=
+github.com/google/go-jsonnet v0.18.0 h1:/6pTy6g+Jh1a1I2UMoAODkqELFiVIdOxbNwv0DDzoOg=
+github.com/google/go-jsonnet v0.18.0/go.mod h1:C3fTzyVJDslXdiTqw/bTFk7vSGyCtH3MGRbDfvEwGd0=
 github.com/google/go-licenses v0.0.0-20210329231322-ce1d9163b77d/go.mod h1:+TYOmkVoJOpwnS0wfdsJCV9CoD5nJYsHoFk/0CrTK4M=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
@@ -1120,6 +1123,7 @@ github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcncea
 github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
 github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
 github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
 github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
@@ -2317,6 +2321,7 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=

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/schema.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gitea.com/gitea/gitea/modules/webhook/schema.json",
+  "title": "Custom webhook configuration",
+  "description": "A custom webhook for Gitea",
+  "type": "object",
+  "required": ["id", "label", "docs", "form"],
+  "oneOf": [
+    {
+      "required": ["exec"]
+    },
+    {
+      "required": ["http"]
+    }
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "id": {
+      "description": "Webhook ID",
+      "type": "string"
+    },
+    "label": {
+      "description": "Webhook Label",
+      "type": "string"
+    },
+    "docs": {
+      "description": "Webhook Docs URL",
+      "type": "string"
+    },
+    "http": {
+      "description": "HTTP Endpoint",
+      "type": "string"
+    },
+    "exec": {
+      "description": "Command to execute",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "form": {
+      "description": "Webhook form",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "label", "type"],
+        "properties": {
+          "id": {
+            "description": "Form ID",
+            "type": "string"
+          },
+          "label": {
+            "description": "Form label",
+            "type": "string"
+          },
+          "type": {
+            "description": "Form type",
+            "type": "string",
+            "enum": ["text", "number", "bool", "secret"]
+          },
+          "required": {
+            "description": "Input required",
+            "type": "boolean"
+          },
+          "default": {
+            "description": "Input default",
+            "type": "string"
+          },
+          "pattern": {
+            "description": "Input pattern",
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}