upstream-mattermost/server/public/model/incoming_webhook.go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package model

import (
	"bytes"
	"encoding/json"
	"io"
	"net/http"
	"regexp"
)

const (
	DefaultWebhookUsername = "webhook"
)

type IncomingWebhook struct {
	Id            string `json:"id"`
	CreateAt      int64  `json:"create_at"`
	UpdateAt      int64  `json:"update_at"`
	DeleteAt      int64  `json:"delete_at"`
	UserId        string `json:"user_id"`
	ChannelId     string `json:"channel_id"`
	TeamId        string `json:"team_id"`
	DisplayName   string `json:"display_name"`
	Description   string `json:"description"`
	Username      string `json:"username"`
	IconURL       string `json:"icon_url"`
	ChannelLocked bool   `json:"channel_locked"`
	LastUsed      int64  `json:"last_used"`
}

func (o *IncomingWebhook) Auditable() map[string]any {
	return map[string]any{
		"id":             o.Id,
		"create_at":      o.CreateAt,
		"update_at":      o.UpdateAt,
		"delete_at":      o.DeleteAt,
		"user_id":        o.UserId,
		"channel_id":     o.ChannelId,
		"team_id":        o.TeamId,
		"display_name":   o.DisplayName,
		"description":    o.Description,
		"username":       o.Username,
		"icon_url:":      o.IconURL,
		"channel_locked": o.ChannelLocked,
		"last_used":      o.LastUsed,
	}
}

type IncomingWebhookRequest struct {
	Text        string               `json:"text"`
	Username    string               `json:"username"`
	IconURL     string               `json:"icon_url"`
	ChannelName string               `json:"channel"`
	RootId      string               `json:"root_id"`
	Props       StringInterface      `json:"props"`
	Attachments []*MessageAttachment `json:"attachments"`
	Type        string               `json:"type"`
	IconEmoji   string               `json:"icon_emoji"`
	Priority    *PostPriority        `json:"priority"`
	// Silent requests notification-suppressed delivery; persisted as PostPropsSilentNotification.
	Silent bool `json:"silent"`
}

// HasInteractiveMessageProps reports whether props contain post content beyond the
// message field. Legacy props.attachments always count. mm_blocks, blocks, and cards
// count only when mmBlocksEnabled is true (Interactive Messages feature flag).
func (r *IncomingWebhookRequest) HasInteractiveMessageProps(mmBlocksEnabled bool) bool {
	if r == nil || len(r.Props) == 0 {
		return false
	}
	if interactivePropJSONArrayNonEmpty(r.Props[PostPropsAttachments]) {
		return true
	}
	if !mmBlocksEnabled {
		return false
	}
	return interactivePropJSONArrayNonEmpty(r.Props[PostPropsMmBlocks]) ||
		interactivePropJSONArrayNonEmpty(r.Props[PostPropsBlockKitBlocks]) ||
		interactivePropJSONArrayNonEmpty(r.Props[PostPropsAdaptiveCards])
}

type IncomingWebhooksWithCount struct {
	Webhooks   []*IncomingWebhook `json:"incoming_webhooks"`
	TotalCount int64              `json:"total_count"`
}

func (o *IncomingWebhook) IsValid() *AppError {
	if !IsValidId(o.Id) {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.id.app_error", map[string]any{"Id": o.Id}, "", http.StatusBadRequest)
	}

	if o.CreateAt == 0 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.create_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
	}

	if o.UpdateAt == 0 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.update_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
	}

	if !IsValidId(o.UserId) {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.user_id.app_error", nil, "", http.StatusBadRequest)
	}

	if !IsValidId(o.ChannelId) {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.channel_id.app_error", nil, "", http.StatusBadRequest)
	}

	if !IsValidId(o.TeamId) {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.team_id.app_error", nil, "", http.StatusBadRequest)
	}

	if len(o.DisplayName) > 64 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.display_name.app_error", nil, "", http.StatusBadRequest)
	}

	if len(o.Description) > 500 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.description.app_error", nil, "", http.StatusBadRequest)
	}

	if len(o.Username) > 64 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.username.app_error", nil, "", http.StatusBadRequest)
	}

	if len(o.IconURL) > 1024 {
		return NewAppError("IncomingWebhook.IsValid", "model.incoming_hook.icon_url.app_error", nil, "", http.StatusBadRequest)
	}

	return nil
}

func (o *IncomingWebhook) PreSave() {
	if o.Id == "" {
		o.Id = NewId()
	}

	o.CreateAt = GetMillis()
	o.UpdateAt = o.CreateAt
}

func (o *IncomingWebhook) PreUpdate() {
	o.UpdateAt = GetMillis()
}

// escapeControlCharsFromPayload escapes control chars (\n, \t) from a byte slice.
// Context:
// JSON strings are not supposed to contain control characters such as \n, \t,
// ... but some incoming webhooks might still send invalid JSON and we want to
// try to handle that. An example invalid JSON string from an incoming webhook
// might look like this (strings for both "text" and "fallback" attributes are
// invalid JSON strings because they contain unescaped newlines and tabs):
//
//	 `{
//	   "text": "this is a test
//							 that contains a newline and tabs",
//	   "attachments": [
//	     {
//	       "fallback": "Required plain-text summary of the attachment
//											that contains a newline and tabs",
//	       "color": "#36a64f",
//	 			...
//	       "text": "Optional text that appears within the attachment
//									 that contains a newline and tabs",
//	 			...
//	       "thumb_url": "http://example.com/path/to/thumb.png"
//	     }
//	   ]
//	 }`
//
// This function will search for `"key": "value"` pairs, and escape \n, \t
// from the value.
func escapeControlCharsFromPayload(by []byte) []byte {
	// we'll search for `"text": "..."` or `"fallback": "..."`, ...
	keys := "text|fallback|pretext|author_name|title|value"

	// the regexp reads like this:
	// (?s): this flag let . match \n (default is false)
	// "(keys)": we search for the keys defined above
	// \s*:\s*: followed by 0..n spaces/tabs, a colon then 0..n spaces/tabs
	// ": a double-quote
	// (\\"|[^"])*: any number of times the `\"` string or any char but a double-quote
	// ": a double-quote
	r := `(?s)"(` + keys + `)"\s*:\s*"(\\"|[^"])*"`
	re := regexp.MustCompile(r)

	// the function that will escape \n and \t on the regexp matches
	repl := func(b []byte) []byte {
		if bytes.Contains(b, []byte("\n")) {
			b = bytes.Replace(b, []byte("\n"), []byte("\\n"), -1)
		}
		if bytes.Contains(b, []byte("\t")) {
			b = bytes.Replace(b, []byte("\t"), []byte("\\t"), -1)
		}

		return b
	}

	return re.ReplaceAllFunc(by, repl)
}

func decodeIncomingWebhookRequest(by []byte) (*IncomingWebhookRequest, error) {
	decoder := json.NewDecoder(bytes.NewReader(by))
	var o IncomingWebhookRequest
	err := decoder.Decode(&o)
	if err == nil {
		return &o, nil
	}
	return nil, err
}

func IncomingWebhookRequestFromJSON(data io.Reader) (*IncomingWebhookRequest, *AppError) {
	buf := new(bytes.Buffer)
	buf.ReadFrom(data)
	by := buf.Bytes()

	// Try to decode the JSON data. Only if it fails, try to escape control
	// characters from the strings contained in the JSON data.
	o, err := decodeIncomingWebhookRequest(by)
	if err != nil {
		o, err = decodeIncomingWebhookRequest(escapeControlCharsFromPayload(by))
		if err != nil {
			return nil, NewAppError("IncomingWebhookRequestFromJSON", "model.incoming_hook.parse_data.app_error", nil, "", http.StatusBadRequest).Wrap(err)
		}
	}

	o.Attachments = StringifyMessageAttachmentFieldValue(o.Attachments)

	return o, nil
}