forgejo/models/webhook.go

210 lines
5.3 KiB
Go
Raw Normal View History

2014-05-06 00:52:25 +00:00
// Copyright 2014 The Gogs 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 models
import (
"encoding/json"
2014-05-06 01:36:08 +00:00
"errors"
2014-06-08 08:45:34 +00:00
"time"
2014-05-06 00:52:25 +00:00
2014-06-08 08:45:34 +00:00
"github.com/gogits/gogs/modules/httplib"
2014-05-06 00:52:25 +00:00
"github.com/gogits/gogs/modules/log"
2014-06-08 08:45:34 +00:00
"github.com/gogits/gogs/modules/setting"
2014-05-06 00:52:25 +00:00
)
2014-05-06 01:36:08 +00:00
var (
ErrWebhookNotExist = errors.New("Webhook does not exist")
)
2014-06-08 08:45:34 +00:00
type HookContentType int
2014-05-06 00:52:25 +00:00
const (
2014-06-08 08:45:34 +00:00
JSON HookContentType = iota + 1
FORM
2014-05-06 00:52:25 +00:00
)
2014-06-08 08:45:34 +00:00
// HookEvent represents events that will delivery hook.
2014-05-06 00:52:25 +00:00
type HookEvent struct {
PushOnly bool `json:"push_only"`
}
2014-06-08 08:45:34 +00:00
// Webhook represents a web hook object.
2014-05-06 00:52:25 +00:00
type Webhook struct {
Id int64
RepoId int64
2014-05-06 15:50:31 +00:00
Url string `xorm:"TEXT"`
2014-06-08 08:45:34 +00:00
ContentType HookContentType
2014-05-06 00:52:25 +00:00
Secret string `xorm:"TEXT"`
Events string `xorm:"TEXT"`
2014-05-06 01:36:08 +00:00
*HookEvent `xorm:"-"`
2014-05-06 00:52:25 +00:00
IsSsl bool
IsActive bool
}
2014-06-08 08:54:52 +00:00
// GetEvent handles conversion from Events to HookEvent.
2014-05-06 01:36:08 +00:00
func (w *Webhook) GetEvent() {
w.HookEvent = &HookEvent{}
if err := json.Unmarshal([]byte(w.Events), w.HookEvent); err != nil {
2014-05-06 00:52:25 +00:00
log.Error("webhook.GetEvent(%d): %v", w.Id, err)
}
}
2014-06-08 08:54:52 +00:00
// UpdateEvent handles conversion from HookEvent to Events.
2014-06-08 08:45:34 +00:00
func (w *Webhook) UpdateEvent() error {
2014-05-06 01:36:08 +00:00
data, err := json.Marshal(w.HookEvent)
2014-05-06 00:52:25 +00:00
w.Events = string(data)
return err
}
2014-06-08 08:54:52 +00:00
// HasPushEvent returns true if hook enbaled push event.
2014-05-06 15:50:31 +00:00
func (w *Webhook) HasPushEvent() bool {
if w.PushOnly {
return true
}
return false
}
2014-06-08 08:45:34 +00:00
// CreateWebhook creates a new web hook.
2014-05-06 00:52:25 +00:00
func CreateWebhook(w *Webhook) error {
_, err := orm.Insert(w)
return err
}
2014-05-06 01:36:08 +00:00
// GetWebhookById returns webhook by given ID.
func GetWebhookById(hookId int64) (*Webhook, error) {
w := &Webhook{Id: hookId}
has, err := orm.Get(w)
if err != nil {
return nil, err
} else if !has {
return nil, ErrWebhookNotExist
}
return w, nil
}
2014-05-06 15:50:31 +00:00
// GetActiveWebhooksByRepoId returns all active webhooks of repository.
func GetActiveWebhooksByRepoId(repoId int64) (ws []*Webhook, err error) {
err = orm.Find(&ws, &Webhook{RepoId: repoId, IsActive: true})
return ws, err
}
2014-05-06 00:52:25 +00:00
// GetWebhooksByRepoId returns all webhooks of repository.
func GetWebhooksByRepoId(repoId int64) (ws []*Webhook, err error) {
err = orm.Find(&ws, &Webhook{RepoId: repoId})
return ws, err
}
2014-05-06 01:36:08 +00:00
2014-06-08 08:45:34 +00:00
// UpdateWebhook updates information of webhook.
func UpdateWebhook(w *Webhook) error {
_, err := orm.AllCols().Update(w)
return err
}
2014-05-06 01:36:08 +00:00
// DeleteWebhook deletes webhook of repository.
func DeleteWebhook(hookId int64) error {
_, err := orm.Delete(&Webhook{Id: hookId})
return err
}
2014-06-08 08:45:34 +00:00
// ___ ___ __ ___________ __
// / | \ ____ ____ | | _\__ ___/____ _____| | __
// / ~ \/ _ \ / _ \| |/ / | | \__ \ / ___/ |/ /
// \ Y ( <_> | <_> ) < | | / __ \_\___ \| <
// \___|_ / \____/ \____/|__|_ \ |____| (____ /____ >__|_ \
// \/ \/ \/ \/ \/
type HookTaskType int
const (
2014-06-08 08:54:52 +00:00
WEBHOOK HookTaskType = iota + 1
2014-06-08 08:45:34 +00:00
SERVICE
)
type PayloadAuthor struct {
Name string `json:"name"`
Email string `json:"email"`
}
type PayloadCommit struct {
Id string `json:"id"`
Message string `json:"message"`
Url string `json:"url"`
Author *PayloadAuthor `json:"author"`
}
type PayloadRepo struct {
Id int64 `json:"id"`
Name string `json:"name"`
Url string `json:"url"`
Description string `json:"description"`
Website string `json:"website"`
Watchers int `json:"watchers"`
Owner *PayloadAuthor `json:"author"`
Private bool `json:"private"`
}
2014-06-08 08:54:52 +00:00
// Payload represents a payload information of hook.
2014-06-08 08:45:34 +00:00
type Payload struct {
Secret string `json:"secret"`
Ref string `json:"ref"`
Commits []*PayloadCommit `json:"commits"`
Repo *PayloadRepo `json:"repository"`
Pusher *PayloadAuthor `json:"pusher"`
}
2014-06-08 08:54:52 +00:00
// HookTask represents a hook task.
2014-06-08 08:45:34 +00:00
type HookTask struct {
Id int64
2014-06-08 08:54:52 +00:00
Type HookTaskType
2014-06-08 08:45:34 +00:00
Url string
*Payload `xorm:"-"`
PayloadContent string `xorm:"TEXT"`
ContentType HookContentType
IsSsl bool
IsDeliveried bool
}
// CreateHookTask creates a new hook task,
// it handles conversion from Payload to PayloadContent.
func CreateHookTask(t *HookTask) error {
data, err := json.Marshal(t.Payload)
if err != nil {
return err
}
t.PayloadContent = string(data)
_, err = orm.Insert(t)
return err
}
// UpdateHookTask updates information of hook task.
func UpdateHookTask(t *HookTask) error {
_, err := orm.AllCols().Update(t)
return err
}
// DeliverHooks checks and delivers undelivered hooks.
func DeliverHooks() {
timeout := time.Duration(setting.WebhookDeliverTimeout) * time.Second
orm.Where("is_deliveried=?", false).Iterate(new(HookTask),
func(idx int, bean interface{}) error {
t := bean.(*HookTask)
// Only support JSON now.
if _, err := httplib.Post(t.Url).SetTimeout(timeout, timeout).
Body([]byte(t.PayloadContent)).Response(); err != nil {
log.Error("webhook.DeliverHooks(Delivery): %v", err)
return nil
}
t.IsDeliveried = true
if err := UpdateHookTask(t); err != nil {
log.Error("webhook.DeliverHooks(UpdateHookTask): %v", err)
return nil
}
log.Trace("Hook delivered: %s", t.PayloadContent)
return nil
})
}