forked from mattermost/mattermost
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
9 changed files
with
170 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved. | ||
// See License.txt for license information. | ||
|
||
package app | ||
|
||
import ( | ||
"regexp" | ||
|
||
"fmt" | ||
"strings" | ||
|
||
"github.com/mattermost/mattermost-server/model" | ||
"github.com/mattermost/mattermost-server/store" | ||
) | ||
|
||
func (a *App) ProcessSlackText(text string) string { | ||
text = expandAnnouncement(text) | ||
text = replaceUserIds(a.Srv.Store.User(), text) | ||
|
||
return text | ||
} | ||
|
||
// Expand announcements in incoming webhooks from Slack. Those announcements | ||
// can be found in the text attribute, or in the pretext, text, title and value | ||
// attributes of the attachment structure. The Slack attachment structure is | ||
// documented here: https://api.slack.com/docs/attachments | ||
func (app *App) ProcessSlackAttachments(a []*model.SlackAttachment) []*model.SlackAttachment { | ||
var nonNilAttachments = model.StringifySlackFieldValue(a) | ||
for _, attachment := range a { | ||
attachment.Pretext = app.ProcessSlackText(attachment.Pretext) | ||
attachment.Text = app.ProcessSlackText(attachment.Text) | ||
attachment.Title = app.ProcessSlackText(attachment.Title) | ||
|
||
for _, field := range attachment.Fields { | ||
if field.Value != nil { | ||
// Ensure the value is set to a string if it is set | ||
field.Value = app.ProcessSlackText(fmt.Sprintf("%v", field.Value)) | ||
} | ||
} | ||
} | ||
return nonNilAttachments | ||
} | ||
|
||
// To mention @channel or @here via a webhook in Slack, the message should contain | ||
// <!channel> or <!here>, as explained at the bottom of this article: | ||
// https://get.slack.help/hc/en-us/articles/202009646-Making-announcements | ||
func expandAnnouncement(text string) string { | ||
a1 := [3]string{"<!channel>", "<!here>", "<!all>"} | ||
a2 := [3]string{"@channel", "@here", "@all"} | ||
|
||
for i, a := range a1 { | ||
text = strings.Replace(text, a, a2[i], -1) | ||
} | ||
return text | ||
} | ||
|
||
// Replaces user IDs mentioned like this <@userID> to a normal username (eg. @bob) | ||
// This is required so that Mattermost maintains Slack compatibility | ||
// Refer to: https://api.slack.com/changelog/2017-09-the-one-about-usernames | ||
func replaceUserIds(userStore store.UserStore, text string) string { | ||
rgx, err := regexp.Compile("<@([a-zA-Z0-9]+)>") | ||
if err == nil { | ||
userIds := make([]string, 0) | ||
matches := rgx.FindAllStringSubmatch(text, -1) | ||
for _, match := range matches { | ||
userIds = append(userIds, match[1]) | ||
} | ||
|
||
if res := <-userStore.GetProfileByIds(userIds, true); res.Err == nil { | ||
for _, user := range res.Data.([]*model.User) { | ||
text = strings.Replace(text, "<@"+user.Id+">", "@"+user.Username, -1) | ||
} | ||
} | ||
} | ||
return text | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
package app | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/mattermost/mattermost-server/model" | ||
) | ||
|
||
func TestProcessSlackText(t *testing.T) { | ||
th := Setup().InitBasic() | ||
defer th.TearDown() | ||
|
||
if th.App.ProcessSlackText("<!channel> foo <!channel>") != "@channel foo @channel" { | ||
t.Fail() | ||
} | ||
|
||
if th.App.ProcessSlackText("<!here> bar <!here>") != "@here bar @here" { | ||
t.Fail() | ||
} | ||
|
||
if th.App.ProcessSlackText("<!all> bar <!all>") != "@all bar @all" { | ||
t.Fail() | ||
} | ||
|
||
userId := th.BasicUser.Id | ||
username := th.BasicUser.Username | ||
if th.App.ProcessSlackText("<@"+userId+"> hello") != "@"+username+" hello" { | ||
t.Fail() | ||
} | ||
} | ||
|
||
func TestProcessSlackAnnouncement(t *testing.T) { | ||
th := Setup().InitBasic() | ||
defer th.TearDown() | ||
|
||
userId := th.BasicUser.Id | ||
username := th.BasicUser.Username | ||
|
||
attachments := []*model.SlackAttachment{ | ||
{ | ||
Pretext: "<!channel> pretext <!here>", | ||
Text: "<!channel> text <!here>", | ||
Title: "<!channel> title <!here>", | ||
Fields: []*model.SlackAttachmentField{ | ||
{ | ||
Title: "foo", | ||
Value: "<!channel> bar <!here>", | ||
Short: true, | ||
}, | ||
}, | ||
}, | ||
{ | ||
Pretext: "<@" + userId + "> pretext", | ||
Text: "<@" + userId + "> text", | ||
Title: "<@" + userId + "> title", | ||
Fields: []*model.SlackAttachmentField{ | ||
{ | ||
Title: "foo", | ||
Value: "<@" + userId + "> bar", | ||
Short: true, | ||
}, | ||
}, | ||
}, | ||
} | ||
attachments = th.App.ProcessSlackAttachments(attachments) | ||
if len(attachments) != 2 || len(attachments[0].Fields) != 1 || len(attachments[1].Fields) != 1 { | ||
t.Fail() | ||
} | ||
|
||
if attachments[0].Pretext != "@channel pretext @here" || | ||
attachments[0].Text != "@channel text @here" || | ||
attachments[0].Title != "@channel title @here" || | ||
attachments[0].Fields[0].Value != "@channel bar @here" { | ||
t.Fail() | ||
} | ||
|
||
if attachments[1].Pretext != "@"+username+" pretext" || | ||
attachments[1].Text != "@"+username+" text" || | ||
attachments[1].Title != "@"+username+" title" || | ||
attachments[1].Fields[0].Value != "@"+username+" bar" { | ||
t.Fail() | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.