status-im
/
matterbridge
mirror of https://github.com/status-im/matterbridge.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Refactor mattermost

This commit is contained in:
Wim 2018-02-23 23:07:23 +01:00
parent 82396e73f5
commit bd2a672c14
2 changed files with 227 additions and 177 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
bridge/helper/helper.go
View File

@ -4,6 +4,7 @@ import (
"bytes" "bytes"
"fmt" "fmt"
"github.com/42wim/matterbridge/bridge/config" "github.com/42wim/matterbridge/bridge/config"
log "github.com/sirupsen/logrus"
"io" "io"
"net/http" "net/http"
"time" "time"
@ -61,3 +62,22 @@ func GetAvatar(av map[string]string, userid string, general *config.Protocol) st
} }
return "" return ""
} }
func HandleDownloadSize(flog *log.Entry, msg *config.Message, name string, size int64, general *config.Protocol) error {
flog.Debugf("Trying to download %#v with size %#v", name, size)
if int(size) > general.MediaDownloadSize {
msg.Event = config.EVENT_FILE_FAILURE_SIZE
msg.Extra[msg.Event] = append(msg.Extra[msg.Event], config.FileInfo{Name: name, Comment: msg.Text, Size: size})
return fmt.Errorf("File %#v to large to download (%#v). MediaDownloadSize is %#v", name, size, general.MediaDownloadSize)
}
return nil
}
func HandleDownloadData(flog *log.Entry, msg *config.Message, name, comment, url string, data *[]byte, general *config.Protocol) {
var avatar bool
flog.Debugf("Download OK %#v %#v", name, len(*data))
if msg.Event == config.EVENT_AVATAR_DOWNLOAD {
avatar = true
}
msg.Extra["file"] = append(msg.Extra["file"], config.FileInfo{Name: name, Data: data, URL: url, Comment: comment, Avatar: avatar})
}

366
bridge/mattermost/mattermost.go
View File

@ -11,28 +11,9 @@ import (
"strings" "strings"
) )
type MMhook struct {
mh *matterhook.Client
}
type MMapi struct {
mc *matterclient.MMClient
mmMap map[string]string
}
type MMMessage struct {
Text string
Channel string
Username string
UserID string
ID string
Event string
Extra map[string][]interface{}
}
type Bmattermost struct { type Bmattermost struct {
MMhook mh *matterhook.Client
MMapi mc *matterclient.MMClient
TeamId string TeamId string
*config.BridgeConfig *config.BridgeConfig
avatarMap map[string]string avatarMap map[string]string
@ -47,7 +28,6 @@ func init() {
func New(cfg *config.BridgeConfig) *Bmattermost { func New(cfg *config.BridgeConfig) *Bmattermost {
b := &Bmattermost{BridgeConfig: cfg, avatarMap: make(map[string]string)} b := &Bmattermost{BridgeConfig: cfg, avatarMap: make(map[string]string)}
b.mmMap = make(map[string]string)
return b return b
} }
@ -143,135 +123,87 @@ func (b *Bmattermost) JoinChannel(channel config.ChannelInfo) error {
func (b *Bmattermost) Send(msg config.Message) (string, error) { func (b *Bmattermost) Send(msg config.Message) (string, error) {
flog.Debugf("Receiving %#v", msg) flog.Debugf("Receiving %#v", msg)
// Make a action /me of the message
if msg.Event == config.EVENT_USER_ACTION { if msg.Event == config.EVENT_USER_ACTION {
msg.Text = "*" + msg.Text + "*" msg.Text = "*" + msg.Text + "*"
} }
nick := msg.Username
message := msg.Text
channel := msg.Channel
// map the file SHA to our user (caches the avatar) // map the file SHA to our user (caches the avatar)
if msg.Event == config.EVENT_AVATAR_DOWNLOAD { if msg.Event == config.EVENT_AVATAR_DOWNLOAD {
fi := msg.Extra["file"][0].(config.FileInfo) return b.cacheAvatar(&msg)
/* if we have a sha we have successfully uploaded the file to the media server,
so we can now cache the sha */
if fi.SHA != "" {
flog.Debugf("Added %s to %s in avatarMap", fi.SHA, msg.UserID)
b.avatarMap[msg.UserID] = fi.SHA
}
return "", nil
} }
if b.Config.PrefixMessagesWithNick { // Use webhook to send the message
message = nick + message
}
if b.Config.WebhookURL != "" { if b.Config.WebhookURL != "" {
return b.sendWebhook(msg)
if msg.Extra != nil {
for _, rmsg := range helper.HandleExtra(&msg, b.General) {
matterMessage := matterhook.OMessage{IconURL: b.Config.IconURL, Channel: channel, UserName: rmsg.Username,
Text: rmsg.Text, Props: make(map[string]interface{})}
matterMessage.Props["matterbridge"] = true
b.mh.Send(matterMessage)
}
if len(msg.Extra["file"]) > 0 {
for _, f := range msg.Extra["file"] {
fi := f.(config.FileInfo)
if fi.URL != "" {
message += fi.URL
}
}
}
} }
matterMessage := matterhook.OMessage{IconURL: b.Config.IconURL} // Delete message
matterMessage.IconURL = msg.Avatar
matterMessage.Channel = channel
matterMessage.UserName = nick
matterMessage.Type = ""
matterMessage.Text = message
matterMessage.Props = make(map[string]interface{})
matterMessage.Props["matterbridge"] = true
err := b.mh.Send(matterMessage)
if err != nil {
flog.Info(err)
return "", err
}
return "", nil
}
if msg.Event == config.EVENT_MSG_DELETE { if msg.Event == config.EVENT_MSG_DELETE {
if msg.ID == "" { if msg.ID == "" {
return "", nil return "", nil
} }
return msg.ID, b.mc.DeleteMessage(msg.ID) return msg.ID, b.mc.DeleteMessage(msg.ID)
} }
// Upload a file if it exists
if msg.Extra != nil { if msg.Extra != nil {
for _, rmsg := range helper.HandleExtra(&msg, b.General) { for _, rmsg := range helper.HandleExtra(&msg, b.General) {
b.mc.PostMessage(b.mc.GetChannelId(channel, ""), rmsg.Username+rmsg.Text) b.mc.PostMessage(b.mc.GetChannelId(rmsg.Channel, ""), rmsg.Username+rmsg.Text)
} }
if len(msg.Extra["file"]) > 0 { if len(msg.Extra["file"]) > 0 {
var err error return b.handleUploadFile(&msg)
var res, id string
for _, f := range msg.Extra["file"] {
fi := f.(config.FileInfo)
id, err = b.mc.UploadFile(*fi.Data, b.mc.GetChannelId(channel, ""), fi.Name)
if err != nil {
flog.Debugf("ERROR %#v", err)
return "", err
} }
message = fi.Comment }
// Prepend nick if configured
if b.Config.PrefixMessagesWithNick { if b.Config.PrefixMessagesWithNick {
message = nick + fi.Comment msg.Text = msg.Username + msg.Text
}
res, err = b.mc.PostMessageWithFiles(b.mc.GetChannelId(channel, ""), message, []string{id})
}
return res, err
}
} }
// Edit message if we have an ID
if msg.ID != "" { if msg.ID != "" {
return b.mc.EditMessage(msg.ID, message) return b.mc.EditMessage(msg.ID, msg.Text)
} }
return b.mc.PostMessage(b.mc.GetChannelId(channel, ""), message)
// Post normal message
return b.mc.PostMessage(b.mc.GetChannelId(msg.Channel, ""), msg.Text)
} }
func (b *Bmattermost) handleMatter() { func (b *Bmattermost) handleMatter() {
mchan := make(chan *MMMessage) messages := make(chan *config.Message)
if b.Config.WebhookBindAddress != "" { if b.Config.WebhookBindAddress != "" {
flog.Debugf("Choosing webhooks based receiving") flog.Debugf("Choosing webhooks based receiving")
go b.handleMatterHook(mchan) go b.handleMatterHook(messages)
} else { } else {
if b.Config.Token != "" { if b.Config.Token != "" {
flog.Debugf("Choosing token based receiving") flog.Debugf("Choosing token based receiving")
} else { } else {
flog.Debugf("Choosing login/password based receiving") flog.Debugf("Choosing login/password based receiving")
} }
go b.handleMatterClient(mchan) go b.handleMatterClient(messages)
} }
for message := range mchan { var ok bool
avatar := helper.GetAvatar(b.avatarMap, message.UserID, b.General) for message := range messages {
rmsg := config.Message{Username: message.Username, Channel: message.Channel, Account: b.Account, UserID: message.UserID, ID: message.ID, Event: message.Event, Extra: message.Extra, Avatar: avatar} message.Avatar = helper.GetAvatar(b.avatarMap, message.UserID, b.General)
text, ok := b.replaceAction(message.Text) message.Account = b.Account
message.Text, ok = b.replaceAction(message.Text)
if ok { if ok {
rmsg.Event = config.EVENT_USER_ACTION message.Event = config.EVENT_USER_ACTION
} }
rmsg.Text = text
flog.Debugf("Sending message from %s on %s to gateway", message.Username, b.Account) flog.Debugf("Sending message from %s on %s to gateway", message.Username, b.Account)
flog.Debugf("Message is %#v", rmsg) flog.Debugf("Message is %#v", message)
b.Remote <- rmsg b.Remote <- *message
} }
} }
func (b *Bmattermost) handleMatterClient(mchan chan *MMMessage) { func (b *Bmattermost) handleMatterClient(messages chan *config.Message) {
for message := range b.mc.MessageChan { for message := range b.mc.MessageChan {
flog.Debugf("%#v", message.Raw.Data) flog.Debugf("%#v", message.Raw.Data)
if message.Type == "system_join_leave" ||
message.Type == "system_join_channel" || if b.skipMessage(message) {
message.Type == "system_leave_channel" { flog.Debugf("Skipped message: %#v", message)
flog.Debugf("Sending JOIN_LEAVE event from %s to gateway", b.Account)
b.Remote <- config.Message{Username: "system", Text: message.Text, Channel: message.Channel, Account: b.Account, Event: config.EVENT_JOIN_LEAVE}
continue
}
if (message.Raw.Event == "post_edited") && b.Config.EditDisable {
continue continue
} }
@ -280,79 +212,47 @@ func (b *Bmattermost) handleMatterClient(mchan chan *MMMessage) {
b.handleDownloadAvatar(message.UserID, message.Channel) b.handleDownloadAvatar(message.UserID, message.Channel)
} }
m := &MMMessage{Extra: make(map[string][]interface{})} flog.Debugf("Receiving from matterclient %#v", message)
rmsg := &config.Message{Username: message.Username, UserID: message.UserID, Channel: message.Channel, Text: message.Text, ID: message.Post.Id, Extra: make(map[string][]interface{})}
// handle mattermost post properties (override username and attachments)
props := message.Post.Props props := message.Post.Props
if props != nil { if props != nil {
if _, ok := props["matterbridge"].(bool); ok {
flog.Debugf("sent by matterbridge, ignoring")
continue
}
if _, ok := props["override_username"].(string); ok { if _, ok := props["override_username"].(string); ok {
message.Username = props["override_username"].(string) rmsg.Username = props["override_username"].(string)
} }
if _, ok := props["attachments"].([]interface{}); ok { if _, ok := props["attachments"].([]interface{}); ok {
m.Extra["attachments"] = props["attachments"].([]interface{}) rmsg.Extra["attachments"] = props["attachments"].([]interface{})
} }
} }
// do not post our own messages back to irc
// only listen to message from our team // create a text for bridges that don't support native editing
if (message.Raw.Event == "posted" || message.Raw.Event == "post_edited" || message.Raw.Event == "post_deleted") &&
b.mc.User.Username != message.Username && message.Raw.Data["team_id"].(string) == b.TeamId {
// if the message has reactions don't repost it (for now, until we can correlate reaction with message)
if message.Post.HasReactions {
continue
}
flog.Debugf("Receiving from matterclient %#v", message)
m.UserID = message.UserID
m.Username = message.Username
m.Channel = message.Channel
m.Text = message.Text
m.ID = message.Post.Id
if message.Raw.Event == "post_edited" && !b.Config.EditDisable { if message.Raw.Event == "post_edited" && !b.Config.EditDisable {
m.Text = message.Text + b.Config.EditSuffix rmsg.Text = message.Text + b.Config.EditSuffix
} }
if message.Raw.Event == "post_deleted" { if message.Raw.Event == "post_deleted" {
m.Event = config.EVENT_MSG_DELETE rmsg.Event = config.EVENT_MSG_DELETE
} }
if len(message.Post.FileIds) > 0 { if len(message.Post.FileIds) > 0 {
for _, id := range message.Post.FileIds { for _, id := range message.Post.FileIds {
url, _ := b.mc.Client.GetFileLink(id) err := b.handleDownloadFile(rmsg, id)
finfo, resp := b.mc.Client.GetFileInfo(id) if err != nil {
if resp.Error != nil { flog.Errorf("download failed: %s", err)
continue
}
flog.Debugf("trying to download %#v fileid %#v with size %#v", finfo.Name, finfo.Id, finfo.Size)
if int(finfo.Size) > b.General.MediaDownloadSize {
flog.Errorf("File %#v to large to download (%#v). MediaDownloadSize is %#v", finfo.Name, finfo.Size, b.General.MediaDownloadSize)
m.Event = config.EVENT_FILE_FAILURE_SIZE
m.Extra[m.Event] = append(m.Extra[m.Event], config.FileInfo{Name: finfo.Name, Comment: message.Text, Size: int64(finfo.Size)})
continue
}
data, resp := b.mc.Client.DownloadFile(id, true)
if resp.Error != nil {
flog.Errorf("download %s failed %#v", finfo.Name, resp.Error)
continue
}
flog.Debugf("download OK %#v %#v", finfo.Name, len(data))
m.Extra["file"] = append(m.Extra["file"], config.FileInfo{Name: finfo.Name, Data: &data, URL: url, Comment: message.Text})
} }
} }
mchan <- m
} }
messages <- rmsg
} }
} }
func (b *Bmattermost) handleMatterHook(mchan chan *MMMessage) { func (b *Bmattermost) handleMatterHook(messages chan *config.Message) {
for { for {
message := b.mh.Receive() message := b.mh.Receive()
flog.Debugf("Receiving from matterhook %#v", message) flog.Debugf("Receiving from matterhook %#v", message)
m := &MMMessage{} messages <- &config.Message{UserID: message.UserID, Username: message.UserName, Text: message.Text, Channel: message.ChannelName}
m.UserID = message.UserID
m.Username = message.UserName
m.Text = message.Text
m.Channel = message.ChannelName
mchan <- m
} }
} }
@ -362,8 +262,7 @@ func (b *Bmattermost) apiLogin() error {
password = "MMAUTHTOKEN=" + b.Config.Token password = "MMAUTHTOKEN=" + b.Config.Token
} }
b.mc = matterclient.New(b.Config.Login, password, b.mc = matterclient.New(b.Config.Login, password, b.Config.Team, b.Config.Server)
b.Config.Team, b.Config.Server)
if b.General.Debug { if b.General.Debug {
b.mc.SetLogLevel("debug") b.mc.SetLogLevel("debug")
} }
@ -381,6 +280,7 @@ func (b *Bmattermost) apiLogin() error {
return nil return nil
} }
// replaceAction replace the message with the correct action (/me) code
func (b *Bmattermost) replaceAction(text string) (string, bool) { func (b *Bmattermost) replaceAction(text string) (string, bool) {
if strings.HasPrefix(text, "*") && strings.HasSuffix(text, "*") { if strings.HasPrefix(text, "*") && strings.HasSuffix(text, "*") {
return strings.Replace(text, "*", "", -1), true return strings.Replace(text, "*", "", -1), true
@ -388,26 +288,156 @@ func (b *Bmattermost) replaceAction(text string) (string, bool) {
return text, false return text, false
} }
func (b *Bmattermost) cacheAvatar(msg *config.Message) (string, error) {
fi := msg.Extra["file"][0].(config.FileInfo)
/* if we have a sha we have successfully uploaded the file to the media server,
so we can now cache the sha */
if fi.SHA != "" {
flog.Debugf("Added %s to %s in avatarMap", fi.SHA, msg.UserID)
b.avatarMap[msg.UserID] = fi.SHA
}
return "", nil
}
// handleDownloadAvatar downloads the avatar of userid from channel // handleDownloadAvatar downloads the avatar of userid from channel
// sends a EVENT_AVATAR_DOWNLOAD message to the gateway if successful. // sends a EVENT_AVATAR_DOWNLOAD message to the gateway if successful.
// logs an error message if it fails // logs an error message if it fails
func (b *Bmattermost) handleDownloadAvatar(userid string, channel string) { func (b *Bmattermost) handleDownloadAvatar(userid string, channel string) {
var name string rmsg := config.Message{Username: "system", Text: "avatar", Channel: channel, Account: b.Account, UserID: userid, Event: config.EVENT_AVATAR_DOWNLOAD, Extra: make(map[string][]interface{})}
msg := config.Message{Username: "system", Text: "avatar", Channel: channel, Account: b.Account, UserID: userid, Event: config.EVENT_AVATAR_DOWNLOAD, Extra: make(map[string][]interface{})}
if _, ok := b.avatarMap[userid]; !ok { if _, ok := b.avatarMap[userid]; !ok {
data, resp := b.mc.Client.GetProfileImage(userid, "") data, resp := b.mc.Client.GetProfileImage(userid, "")
if resp.Error != nil { if resp.Error != nil {
flog.Errorf("ProfileImage download failed for %#v %s", userid, resp.Error) flog.Errorf("ProfileImage download failed for %#v %s", userid, resp.Error)
return
} }
if len(data) <= b.General.MediaDownloadSize { err := helper.HandleDownloadSize(flog, &rmsg, userid+".png", int64(len(data)), b.General)
name = userid + ".png" if err != nil {
flog.Debugf("download OK %#v %#v", name, len(data)) flog.Error(err)
msg.Extra["file"] = append(msg.Extra["file"], config.FileInfo{Name: name, Data: &data, Avatar: true}) return
flog.Debugf("Sending avatar download message from %#v on %s to gateway", userid, b.Account)
flog.Debugf("Message is %#v", msg)
b.Remote <- msg
} else {
flog.Errorf("File %#v to large to download (%#v). MediaDownloadSize is %#v", name, len(data), b.General.MediaDownloadSize)
} }
helper.HandleDownloadData(flog, &rmsg, userid+".png", rmsg.Text, "", &data, b.General)
b.Remote <- rmsg
} }
} }
// handleDownloadFile handles file download
func (b *Bmattermost) handleDownloadFile(rmsg *config.Message, id string) error {
url, _ := b.mc.Client.GetFileLink(id)
finfo, resp := b.mc.Client.GetFileInfo(id)
if resp.Error != nil {
return resp.Error
}
err := helper.HandleDownloadSize(flog, rmsg, finfo.Name, int64(finfo.Size), b.General)
if err != nil {
return err
}
data, resp := b.mc.Client.DownloadFile(id, true)
if resp.Error != nil {
return resp.Error
}
helper.HandleDownloadData(flog, rmsg, finfo.Name, rmsg.Text, url, &data, b.General)
return nil
}
// handleUploadFile handles native upload of files
func (b *Bmattermost) handleUploadFile(msg *config.Message) (string, error) {
var err error
var res, id string
channelID := b.mc.GetChannelId(msg.Channel, "")
for _, f := range msg.Extra["file"] {
fi := f.(config.FileInfo)
id, err = b.mc.UploadFile(*fi.Data, channelID, fi.Name)
if err != nil {
return "", err
}
msg.Text = fi.Comment
if b.Config.PrefixMessagesWithNick {
msg.Text = msg.Username + msg.Text
}
res, err = b.mc.PostMessageWithFiles(channelID, msg.Text, []string{id})
}
return res, err
}
// sendWebhook uses the configured WebhookURL to send the message
func (b *Bmattermost) sendWebhook(msg config.Message) (string, error) {
if b.Config.PrefixMessagesWithNick {
msg.Text = msg.Username + msg.Text
}
if msg.Extra != nil {
// this sends a message only if we received a config.EVENT_FILE_FAILURE_SIZE
for _, rmsg := range helper.HandleExtra(&msg, b.General) {
matterMessage := matterhook.OMessage{IconURL: b.Config.IconURL, Channel: rmsg.Channel, UserName: rmsg.Username, Text: rmsg.Text, Props: make(map[string]interface{})}
matterMessage.Props["matterbridge"] = true
b.mh.Send(matterMessage)
}
// webhook doesn't support file uploads, so we add the url manually
if len(msg.Extra["file"]) > 0 {
for _, f := range msg.Extra["file"] {
fi := f.(config.FileInfo)
if fi.URL != "" {
msg.Text += fi.URL
}
}
}
}
matterMessage := matterhook.OMessage{IconURL: b.Config.IconURL, Channel: msg.Channel, UserName: msg.Username, Text: msg.Text, Props: make(map[string]interface{})}
if msg.Avatar != "" {
matterMessage.IconURL = msg.Avatar
}
matterMessage.Props["matterbridge"] = true
err := b.mh.Send(matterMessage)
if err != nil {
flog.Info(err)
return "", err
}
return "", nil
}
// skipMessages returns true if this message should not be handled
func (b *Bmattermost) skipMessage(message *matterclient.Message) bool {
// Handle join/leave
if message.Type == "system_join_leave" ||
message.Type == "system_join_channel" ||
message.Type == "system_leave_channel" {
flog.Debugf("Sending JOIN_LEAVE event from %s to gateway", b.Account)
b.Remote <- config.Message{Username: "system", Text: message.Text, Channel: message.Channel, Account: b.Account, Event: config.EVENT_JOIN_LEAVE}
return true
}
// Handle edited messages
if (message.Raw.Event == "post_edited") && b.Config.EditDisable {
return true
}
// Ignore messages sent from matterbridge
if message.Post.Props != nil {
if _, ok := message.Post.Props["matterbridge"].(bool); ok {
flog.Debugf("sent by matterbridge, ignoring")
return true
}
}
// Ignore messages sent from a user logged in as the bot
if b.mc.User.Username == message.Username {
return true
}
// if the message has reactions don't repost it (for now, until we can correlate reaction with message)
if message.Post.HasReactions {
return true
}
// ignore messages from other teams than ours
if message.Raw.Data["team_id"].(string) != b.TeamId {
return true
}
// only handle posted, edited or deleted events
if !(message.Raw.Event == "posted" || message.Raw.Event == "post_edited" || message.Raw.Event == "post_deleted") {
return true
}
return false
}