mirror of
https://github.com/portainer/portainer.git
synced 2025-07-25 16:29:44 +02:00
* Initial pass at adding webhook controller and routes * Moving some objects around * Cleaning up comments * Fixing syntax, switching to using the docker sdk over building an http client * Adding delete and list functionality * Updating the handler to use the correct permissions. Updating some comments * Fixing some comments * Code cleanup per pull request comments * Cleanup per PR feedback. Syntax error fix * Initial creation of webhook app code * Moving ClientFactory creation out of handler code and instead using the one created by the main process. Removing webhookInspect method and updating the list function to use json filters * Delete now works on the webhook ID vs service ID * WIP - Service creates a webhook. Display will show an existing webhook URL. * Adding the webhook field to the service view. There is now the ability to add or remove a webhook from a service * Moving all api calls to be webhooks vs webhook * Code cleanup. Moving all api calls to be webhooks vs webhook * More conversion of webhook to webhooks? * Moving UI elements around. Starting function for copying to clipboard * Finalizing function for copying to clipboard. Adding button that calls function and copies webhook to clipboard. * Fixing UI issues. Hiding field entirely when there is no webhook * Moving URL crafting to a helper method. The edit pane for service now creates/deletes webhooks immidiately. * style(service-details): update webhook line * feat(api): strip sha when updating an image via the update webhook * Fixing up some copy. Only displying the port if it is not http or https * Fixing tooltip copy. Setting the forceupdate to be true to require an update to occur * Fixing code climate errors * Adding WebhookType field and setting to ServiceWebhook for new webhooks. Renaming ServiceID to resourceID so future work can add new types of webhooks in other resource areas. * Adding the webhook type to the payload to support more types of webhooks in the future. Setting the type correctly when creating one for a service * feat(webhooks): changes related to webhook management * API code cleanup, removing unneeded functions, and updating validation logic * Incorrectly ignoring the error that the webhook did not exist * Re-adding missing error handling. Changing error response to be a 404 vs 500 when token can't find an object * fix(webhooks): close Docker client after service webhook execution
151 lines
3.4 KiB
Go
151 lines
3.4 KiB
Go
package webhook
|
|
|
|
import (
|
|
"github.com/portainer/portainer"
|
|
"github.com/portainer/portainer/bolt/internal"
|
|
|
|
"github.com/boltdb/bolt"
|
|
)
|
|
|
|
const (
|
|
// BucketName represents the name of the bucket where this service stores data.
|
|
BucketName = "webhooks"
|
|
)
|
|
|
|
// Service represents a service for managing webhook data.
|
|
type Service struct {
|
|
db *bolt.DB
|
|
}
|
|
|
|
// NewService creates a new instance of a service.
|
|
func NewService(db *bolt.DB) (*Service, error) {
|
|
err := internal.CreateBucket(db, BucketName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &Service{
|
|
db: db,
|
|
}, nil
|
|
}
|
|
|
|
//Webhooks returns an array of all webhooks
|
|
func (service *Service) Webhooks() ([]portainer.Webhook, error) {
|
|
var webhooks = make([]portainer.Webhook, 0)
|
|
|
|
err := service.db.View(func(tx *bolt.Tx) error {
|
|
bucket := tx.Bucket([]byte(BucketName))
|
|
|
|
cursor := bucket.Cursor()
|
|
for k, v := cursor.First(); k != nil; k, v = cursor.Next() {
|
|
var webhook portainer.Webhook
|
|
err := internal.UnmarshalObject(v, &webhook)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
webhooks = append(webhooks, webhook)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
|
|
return webhooks, err
|
|
}
|
|
|
|
// Webhook returns a webhook by ID.
|
|
func (service *Service) Webhook(ID portainer.WebhookID) (*portainer.Webhook, error) {
|
|
var webhook portainer.Webhook
|
|
identifier := internal.Itob(int(ID))
|
|
|
|
err := internal.GetObject(service.db, BucketName, identifier, &webhook)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &webhook, nil
|
|
}
|
|
|
|
// WebhookByResourceID returns a webhook by the ResourceID it is associated with.
|
|
func (service *Service) WebhookByResourceID(ID string) (*portainer.Webhook, error) {
|
|
var webhook *portainer.Webhook
|
|
|
|
err := service.db.View(func(tx *bolt.Tx) error {
|
|
bucket := tx.Bucket([]byte(BucketName))
|
|
cursor := bucket.Cursor()
|
|
|
|
for k, v := cursor.First(); k != nil; k, v = cursor.Next() {
|
|
var w portainer.Webhook
|
|
err := internal.UnmarshalObject(v, &w)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if w.ResourceID == ID {
|
|
webhook = &w
|
|
break
|
|
}
|
|
}
|
|
|
|
if webhook == nil {
|
|
return portainer.ErrObjectNotFound
|
|
}
|
|
|
|
return nil
|
|
})
|
|
|
|
return webhook, err
|
|
}
|
|
|
|
// WebhookByToken returns a webhook by the random token it is associated with.
|
|
func (service *Service) WebhookByToken(token string) (*portainer.Webhook, error) {
|
|
var webhook *portainer.Webhook
|
|
|
|
err := service.db.View(func(tx *bolt.Tx) error {
|
|
bucket := tx.Bucket([]byte(BucketName))
|
|
cursor := bucket.Cursor()
|
|
|
|
for k, v := cursor.First(); k != nil; k, v = cursor.Next() {
|
|
var w portainer.Webhook
|
|
err := internal.UnmarshalObject(v, &w)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if w.Token == token {
|
|
webhook = &w
|
|
break
|
|
}
|
|
}
|
|
|
|
if webhook == nil {
|
|
return portainer.ErrObjectNotFound
|
|
}
|
|
|
|
return nil
|
|
})
|
|
|
|
return webhook, err
|
|
}
|
|
|
|
// DeleteWebhook deletes a webhook.
|
|
func (service *Service) DeleteWebhook(ID portainer.WebhookID) error {
|
|
identifier := internal.Itob(int(ID))
|
|
return internal.DeleteObject(service.db, BucketName, identifier)
|
|
}
|
|
|
|
// CreateWebhook assign an ID to a new webhook and saves it.
|
|
func (service *Service) CreateWebhook(webhook *portainer.Webhook) error {
|
|
return service.db.Update(func(tx *bolt.Tx) error {
|
|
bucket := tx.Bucket([]byte(BucketName))
|
|
|
|
id, _ := bucket.NextSequence()
|
|
webhook.ID = portainer.WebhookID(id)
|
|
|
|
data, err := internal.MarshalObject(webhook)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return bucket.Put(internal.Itob(int(webhook.ID)), data)
|
|
})
|
|
}
|