| 1 | // Package webhook filtert gebeurtenissen en vult URL, headers en body. |
| 2 | package webhook |
| 3 | |
| 4 | import ( |
| 5 | "encoding/json" |
| 6 | "regexp" |
| 7 | "strings" |
| 8 | |
| 9 | "gitlab.com/Timfa/bluegit/internal/i18n" |
| 10 | ) |
| 11 | |
| 12 | // Soorten gebeurtenissen. |
| 13 | const ( |
| 14 | EventPush = "push" |
| 15 | EventMergeRequest = "merge_request" |
| 16 | EventPipelineSuccess = "pipeline_success" |
| 17 | EventPipelineFailure = "pipeline_failure" |
| 18 | EventRelease = "release_published" |
| 19 | EventIssue = "issue" |
| 20 | ) |
| 21 | |
| 22 | // AllEvents is de vaste lijst die een webhook mag aanvinken. |
| 23 | func AllEvents() []string { |
| 24 | return []string{EventPush, EventMergeRequest, EventPipelineSuccess, EventPipelineFailure, EventRelease, EventIssue} |
| 25 | } |
| 26 | |
| 27 | // KnownEvent meldt of name een ondersteunde gebeurtenis is. |
| 28 | func KnownEvent(name string) bool { |
| 29 | for _, e := range AllEvents() { |
| 30 | if e == name { |
| 31 | return true |
| 32 | } |
| 33 | } |
| 34 | return false |
| 35 | } |
| 36 | |
| 37 | // Presets. |
| 38 | const ( |
| 39 | PresetDiscord = "discord" |
| 40 | PresetGrok = "grok" |
| 41 | PresetGeneric = "generic" |
| 42 | ) |
| 43 | |
| 44 | // Event is de gegevensset die een webhook te zien krijgt. |
| 45 | // De platte velden blijven beschikbaar als {{event.veld}}. |
| 46 | // Pipeline, Jobs, Ref/Before/After/Commits, MergeRequest en Release |
| 47 | // vullen de JSON-body als het sjabloon leeg is. |
| 48 | type Event struct { |
| 49 | Type string |
| 50 | Project string |
| 51 | Group string |
| 52 | Branch string |
| 53 | Commit string |
| 54 | Summary string |
| 55 | URL string |
| 56 | PipelineID string |
| 57 | ReleaseTag string |
| 58 | Actor string |
| 59 | |
| 60 | Pipeline *PipelineInfo |
| 61 | Jobs []JobInfo |
| 62 | Ref string |
| 63 | Before string |
| 64 | After string |
| 65 | Commits []CommitInfo |
| 66 | MergeRequest *MRInfo |
| 67 | Comment string |
| 68 | Release *ReleaseInfo |
| 69 | Issue *IssueInfo |
| 70 | } |
| 71 | |
| 72 | // Hook is de opgeslagen configuratie, zonder geheimen al ingevuld. |
| 73 | type Hook struct { |
| 74 | Preset string |
| 75 | Events []string |
| 76 | BranchFilter string |
| 77 | } |
| 78 | |
| 79 | // Allows meldt of deze hook de gebeurtenis wil ontvangen. |
| 80 | // Het branchfilter geldt alleen voor push. Leeg betekent alle branches. |
| 81 | // "re:" gevolgd door een reguliere expressie, anders een exacte branchnaam. |
| 82 | func Allows(h Hook, ev Event) (bool, error) { |
| 83 | if !KnownEvent(ev.Type) { |
| 84 | return false, i18n.E("err.whEvent", ev.Type) |
| 85 | } |
| 86 | found := false |
| 87 | for _, e := range h.Events { |
| 88 | if e == ev.Type { |
| 89 | found = true |
| 90 | break |
| 91 | } |
| 92 | } |
| 93 | if !found { |
| 94 | return false, nil |
| 95 | } |
| 96 | if ev.Type != EventPush { |
| 97 | return true, nil |
| 98 | } |
| 99 | return MatchBranch(h.BranchFilter, ev.Branch) |
| 100 | } |
| 101 | |
| 102 | // MatchBranch past een push-filter toe. |
| 103 | func MatchBranch(filter, branch string) (bool, error) { |
| 104 | filter = strings.TrimSpace(filter) |
| 105 | if filter == "" { |
| 106 | return true, nil |
| 107 | } |
| 108 | if strings.HasPrefix(filter, "re:") { |
| 109 | re, err := regexp.Compile(strings.TrimPrefix(filter, "re:")) |
| 110 | if err != nil { |
| 111 | return false, i18n.E("err.whFilter", err.Error()) |
| 112 | } |
| 113 | return re.MatchString(branch), nil |
| 114 | } |
| 115 | return filter == branch, nil |
| 116 | } |
| 117 | |
| 118 | // Expand vult {{event.veld}} en {{secret.NAAM}}. |
| 119 | // Een onbekend geheim of veld is een fout, zodat een webhook niet |
| 120 | // per ongeluk met een leeg token vertrekt. |
| 121 | func Expand(s string, ev Event, secrets map[string]string) (string, error) { |
| 122 | var b strings.Builder |
| 123 | for { |
| 124 | start := strings.Index(s, "{{") |
| 125 | if start < 0 { |
| 126 | b.WriteString(s) |
| 127 | break |
| 128 | } |
| 129 | b.WriteString(s[:start]) |
| 130 | rest := s[start+2:] |
| 131 | end := strings.Index(rest, "}}") |
| 132 | if end < 0 { |
| 133 | return "", i18n.E("err.whTemplate") |
| 134 | } |
| 135 | key := strings.TrimSpace(rest[:end]) |
| 136 | val, err := lookup(key, ev, secrets) |
| 137 | if err != nil { |
| 138 | return "", err |
| 139 | } |
| 140 | b.WriteString(val) |
| 141 | s = rest[end+2:] |
| 142 | } |
| 143 | return b.String(), nil |
| 144 | } |
| 145 | |
| 146 | func lookup(key string, ev Event, secrets map[string]string) (string, error) { |
| 147 | switch { |
| 148 | case strings.HasPrefix(key, "secret."): |
| 149 | name := strings.TrimPrefix(key, "secret.") |
| 150 | v, ok := secrets[name] |
| 151 | if !ok { |
| 152 | return "", i18n.E("err.whSecret", name) |
| 153 | } |
| 154 | return v, nil |
| 155 | case strings.HasPrefix(key, "event."): |
| 156 | field := strings.TrimPrefix(key, "event.") |
| 157 | v, ok := eventField(ev, field) |
| 158 | if !ok { |
| 159 | return "", i18n.E("err.whField", field) |
| 160 | } |
| 161 | return v, nil |
| 162 | default: |
| 163 | return "", i18n.E("err.whPlaceholder", key) |
| 164 | } |
| 165 | } |
| 166 | |
| 167 | func eventField(ev Event, field string) (string, bool) { |
| 168 | if base, ok := strings.CutSuffix(field, "_json"); ok && base != "" { |
| 169 | v, ok := eventField(ev, base) |
| 170 | if !ok { |
| 171 | return "", false |
| 172 | } |
| 173 | b, err := json.Marshal(v) |
| 174 | if err != nil { |
| 175 | return "", false |
| 176 | } |
| 177 | return string(b), true |
| 178 | } |
| 179 | switch field { |
| 180 | case "type": |
| 181 | return ev.Type, true |
| 182 | case "project": |
| 183 | return ev.Project, true |
| 184 | case "group": |
| 185 | return ev.Group, true |
| 186 | case "branch": |
| 187 | return ev.Branch, true |
| 188 | case "commit": |
| 189 | return ev.Commit, true |
| 190 | case "summary": |
| 191 | return ev.Summary, true |
| 192 | case "url": |
| 193 | return ev.URL, true |
| 194 | case "pipeline_id": |
| 195 | return ev.PipelineID, true |
| 196 | case "release_tag": |
| 197 | return ev.ReleaseTag, true |
| 198 | case "actor": |
| 199 | return ev.Actor, true |
| 200 | case "payload": |
| 201 | b, err := json.Marshal(ev.Document()) |
| 202 | if err != nil { |
| 203 | return "", false |
| 204 | } |
| 205 | return string(b), true |
| 206 | default: |
| 207 | return "", false |
| 208 | } |
| 209 | } |
| 210 | |
| 211 | // PresetDefaults vult URL-headers en body als de gebruiker een preset kiest |
| 212 | // en een veld leeg laat. |
| 213 | func PresetDefaults(preset string) (headers map[string]string, body string) { |
| 214 | switch preset { |
| 215 | case PresetDiscord: |
| 216 | return map[string]string{"Content-Type": "application/json"}, `{"content":"{{event.summary}}"}` |
| 217 | case PresetGrok: |
| 218 | return map[string]string{ |
| 219 | "Content-Type": "application/json", |
| 220 | "Authorization": "Bearer {{secret.GROK_TOKEN}}", |
| 221 | }, "" |
| 222 | default: |
| 223 | return map[string]string{"Content-Type": "application/json"}, "" |
| 224 | } |
| 225 | } |
| 226 | |
| 227 | // RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON. |
| 228 | func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) { |
| 229 | if strings.TrimSpace(bodyTemplate) == "" { |
| 230 | return json.Marshal(ev.Document()) |
| 231 | } |
| 232 | s, err := Expand(bodyTemplate, ev, secrets) |
| 233 | if err != nil { |
| 234 | return nil, err |
| 235 | } |
| 236 | return []byte(s), nil |
| 237 | } |
| 238 | |
| 239 | // RenderHeaders vult geheimen in headers. Preset-headers vullen alleen |
| 240 | // ontbrekende sleutels aan. |
| 241 | func RenderHeaders(preset string, configured map[string]string, ev Event, secrets map[string]string) (map[string]string, error) { |
| 242 | base, _ := PresetDefaults(preset) |
| 243 | if base == nil { |
| 244 | base = map[string]string{} |
| 245 | } |
| 246 | for k, v := range configured { |
| 247 | base[k] = v |
| 248 | } |
| 249 | out := map[string]string{} |
| 250 | for k, v := range base { |
| 251 | ek, err := Expand(k, ev, secrets) |
| 252 | if err != nil { |
| 253 | return nil, err |
| 254 | } |
| 255 | evv, err := Expand(v, ev, secrets) |
| 256 | if err != nil { |
| 257 | return nil, err |
| 258 | } |
| 259 | out[ek] = evv |
| 260 | } |
| 261 | return out, nil |
| 262 | } |