outgoing_webhook.go 7.26 KB
Newer Older
1
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
2 3 4 5 6 7 8 9
// See License.txt for license information.

package model

import (
	"encoding/json"
	"fmt"
	"io"
10
	"net/http"
11 12
	"net/url"
	"strconv"
13
	"strings"
14 15 16 17 18 19 20 21 22 23 24 25
)

type OutgoingWebhook struct {
	Id           string      `json:"id"`
	Token        string      `json:"token"`
	CreateAt     int64       `json:"create_at"`
	UpdateAt     int64       `json:"update_at"`
	DeleteAt     int64       `json:"delete_at"`
	CreatorId    string      `json:"creator_id"`
	ChannelId    string      `json:"channel_id"`
	TeamId       string      `json:"team_id"`
	TriggerWords StringArray `json:"trigger_words"`
26
	TriggerWhen  int         `json:"trigger_when"`
27
	CallbackURLs StringArray `json:"callback_urls"`
28 29
	DisplayName  string      `json:"display_name"`
	Description  string      `json:"description"`
30
	ContentType  string      `json:"content_type"`
31 32
	Username     string      `json:"username"`
	IconURL      string      `json:"icon_url"`
33 34 35 36 37 38 39 40 41 42 43 44 45 46
}

type OutgoingWebhookPayload struct {
	Token       string `json:"token"`
	TeamId      string `json:"team_id"`
	TeamDomain  string `json:"team_domain"`
	ChannelId   string `json:"channel_id"`
	ChannelName string `json:"channel_name"`
	Timestamp   int64  `json:"timestamp"`
	UserId      string `json:"user_id"`
	UserName    string `json:"user_name"`
	PostId      string `json:"post_id"`
	Text        string `json:"text"`
	TriggerWord string `json:"trigger_word"`
47
	FileIds     string `json:"file_ids"`
48 49
}

50
type OutgoingWebhookResponse struct {
51 52 53 54 55 56 57
	Text         *string            `json:"text"`
	Username     string             `json:"username"`
	IconURL      string             `json:"icon_url"`
	Props        StringInterface    `json:"props"`
	Attachments  []*SlackAttachment `json:"attachments"`
	Type         string             `json:"type"`
	ResponseType string             `json:"response_type"`
58 59
}

60 61
const OUTGOING_HOOK_RESPONSE_TYPE_COMMENT = "comment"

62
func (o *OutgoingWebhookPayload) ToJSON() string {
Chris's avatar
Chris committed
63 64
	b, _ := json.Marshal(o)
	return string(b)
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
}

func (o *OutgoingWebhookPayload) ToFormValues() string {
	v := url.Values{}
	v.Set("token", o.Token)
	v.Set("team_id", o.TeamId)
	v.Set("team_domain", o.TeamDomain)
	v.Set("channel_id", o.ChannelId)
	v.Set("channel_name", o.ChannelName)
	v.Set("timestamp", strconv.FormatInt(o.Timestamp/1000, 10))
	v.Set("user_id", o.UserId)
	v.Set("user_name", o.UserName)
	v.Set("post_id", o.PostId)
	v.Set("text", o.Text)
	v.Set("trigger_word", o.TriggerWord)
80
	v.Set("file_ids", o.FileIds)
81 82

	return v.Encode()
83 84 85
}

func (o *OutgoingWebhook) ToJson() string {
Chris's avatar
Chris committed
86 87
	b, _ := json.Marshal(o)
	return string(b)
88 89 90
}

func OutgoingWebhookFromJson(data io.Reader) *OutgoingWebhook {
Chris's avatar
Chris committed
91 92 93
	var o *OutgoingWebhook
	json.NewDecoder(data).Decode(&o)
	return o
94 95 96
}

func OutgoingWebhookListToJson(l []*OutgoingWebhook) string {
Chris's avatar
Chris committed
97 98
	b, _ := json.Marshal(l)
	return string(b)
99 100 101 102
}

func OutgoingWebhookListFromJson(data io.Reader) []*OutgoingWebhook {
	var o []*OutgoingWebhook
Chris's avatar
Chris committed
103 104
	json.NewDecoder(data).Decode(&o)
	return o
105 106
}

107
func (o *OutgoingWebhookResponse) ToJson() string {
Chris's avatar
Chris committed
108 109
	b, _ := json.Marshal(o)
	return string(b)
110 111 112
}

func OutgoingWebhookResponseFromJson(data io.Reader) *OutgoingWebhookResponse {
Chris's avatar
Chris committed
113 114 115
	var o *OutgoingWebhookResponse
	json.NewDecoder(data).Decode(&o)
	return o
116 117
}

118 119 120
func (o *OutgoingWebhook) IsValid() *AppError {

	if len(o.Id) != 26 {
121
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.id.app_error", nil, "", http.StatusBadRequest)
122 123 124
	}

	if len(o.Token) != 26 {
125
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.token.app_error", nil, "", http.StatusBadRequest)
126 127 128
	}

	if o.CreateAt == 0 {
129
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.create_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
130 131 132
	}

	if o.UpdateAt == 0 {
133
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.update_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
134 135 136
	}

	if len(o.CreatorId) != 26 {
137
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.user_id.app_error", nil, "", http.StatusBadRequest)
138 139 140
	}

	if len(o.ChannelId) != 0 && len(o.ChannelId) != 26 {
141
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.channel_id.app_error", nil, "", http.StatusBadRequest)
142 143 144
	}

	if len(o.TeamId) != 26 {
145
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.team_id.app_error", nil, "", http.StatusBadRequest)
146 147 148
	}

	if len(fmt.Sprintf("%s", o.TriggerWords)) > 1024 {
149
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.words.app_error", nil, "", http.StatusBadRequest)
150 151
	}

152 153 154
	if len(o.TriggerWords) != 0 {
		for _, triggerWord := range o.TriggerWords {
			if len(triggerWord) == 0 {
155
				return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.trigger_words.app_error", nil, "", http.StatusBadRequest)
156 157 158 159
			}
		}
	}

160
	if len(o.CallbackURLs) == 0 || len(fmt.Sprintf("%s", o.CallbackURLs)) > 1024 {
161
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.callback.app_error", nil, "", http.StatusBadRequest)
162 163
	}

164 165
	for _, callback := range o.CallbackURLs {
		if !IsValidHttpUrl(callback) {
166
			return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.url.app_error", nil, "", http.StatusBadRequest)
167 168 169
		}
	}

170
	if len(o.DisplayName) > 64 {
171
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.display_name.app_error", nil, "", http.StatusBadRequest)
172 173
	}

174
	if len(o.Description) > 500 {
175
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.description.app_error", nil, "", http.StatusBadRequest)
176 177
	}

178
	if len(o.ContentType) > 128 {
179
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.content_type.app_error", nil, "", http.StatusBadRequest)
180 181
	}

182
	if o.TriggerWhen > 1 {
183
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.is_valid.content_type.app_error", nil, "", http.StatusBadRequest)
184 185
	}

186 187 188 189 190 191 192 193
	if len(o.Username) > 64 {
		return NewAppError("OutgoingWebhook.IsValid", "model.outgoing_hook.username.app_error", nil, "", http.StatusBadRequest)
	}

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

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
	return nil
}

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

	if o.Token == "" {
		o.Token = NewId()
	}

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

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

214 215
func (o *OutgoingWebhook) TriggerWordExactMatch(word string) bool {
	if len(word) == 0 {
216 217 218 219 220 221 222 223 224 225 226
		return false
	}

	for _, trigger := range o.TriggerWords {
		if trigger == word {
			return true
		}
	}

	return false
}
227 228

func (o *OutgoingWebhook) TriggerWordStartsWith(word string) bool {
229
	if len(word) == 0 {
230 231 232 233 234 235 236 237 238 239 240
		return false
	}

	for _, trigger := range o.TriggerWords {
		if strings.HasPrefix(word, trigger) {
			return true
		}
	}

	return false
}
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

func (o *OutgoingWebhook) GetTriggerWord(word string, isExactMatch bool) (triggerWord string) {
	if len(word) == 0 {
		return
	}

	if isExactMatch {
		for _, trigger := range o.TriggerWords {
			if trigger == word {
				triggerWord = trigger
				break
			}
		}
	} else {
		for _, trigger := range o.TriggerWords {
			if strings.HasPrefix(word, trigger) {
				triggerWord = trigger
				break
			}
		}
	}

	return triggerWord
}