diff options
| author | Mistivia <i@mistivia.com> | 2025-11-02 15:27:18 +0800 |
|---|---|---|
| committer | Mistivia <i@mistivia.com> | 2025-11-02 15:27:18 +0800 |
| commit | e9c24f4af7ed56760f6db7941827d09f6db9020b (patch) | |
| tree | 62128c43b883ce5e3148113350978755779bb5de /teleirc/matterbridge/bridge/mattermost | |
| parent | 58d5e7cfda4781d8a57ec52aefd02983835c301a (diff) | |
add matterbridge
Diffstat (limited to 'teleirc/matterbridge/bridge/mattermost')
| -rw-r--r-- | teleirc/matterbridge/bridge/mattermost/handlers.go | 215 | ||||
| -rw-r--r-- | teleirc/matterbridge/bridge/mattermost/helpers.go | 283 | ||||
| -rw-r--r-- | teleirc/matterbridge/bridge/mattermost/mattermost.go | 193 |
3 files changed, 691 insertions, 0 deletions
diff --git a/teleirc/matterbridge/bridge/mattermost/handlers.go b/teleirc/matterbridge/bridge/mattermost/handlers.go new file mode 100644 index 0000000..8c4ea36 --- /dev/null +++ b/teleirc/matterbridge/bridge/mattermost/handlers.go @@ -0,0 +1,215 @@ +package bmattermost + +import ( + "github.com/42wim/matterbridge/bridge/config" + "github.com/42wim/matterbridge/bridge/helper" + "github.com/matterbridge/matterclient" + "github.com/mattermost/mattermost-server/v6/model" +) + +// handleDownloadAvatar downloads the avatar of userid from channel +// sends a EVENT_AVATAR_DOWNLOAD message to the gateway if successful. +// logs an error message if it fails +func (b *Bmattermost) handleDownloadAvatar(userid string, channel string) { + rmsg := config.Message{ + Username: "system", + Text: "avatar", + Channel: channel, + Account: b.Account, + UserID: userid, + Event: config.EventAvatarDownload, + Extra: make(map[string][]interface{}), + } + if _, ok := b.avatarMap[userid]; !ok { + var ( + data []byte + err error + ) + data, _, err = b.mc.Client.GetProfileImage(userid, "") + if err != nil { + b.Log.Errorf("ProfileImage download failed for %#v %s", userid, err) + return + } + + err = helper.HandleDownloadSize(b.Log, &rmsg, userid+".png", int64(len(data)), b.General) + if err != nil { + b.Log.Error(err) + return + } + helper.HandleDownloadData(b.Log, &rmsg, userid+".png", rmsg.Text, "", &data, b.General) + b.Remote <- rmsg + } +} + +//nolint:wrapcheck +func (b *Bmattermost) handleDownloadFile(rmsg *config.Message, id string) error { + url, _, _ := b.mc.Client.GetFileLink(id) + finfo, _, err := b.mc.Client.GetFileInfo(id) + if err != nil { + return err + } + err = helper.HandleDownloadSize(b.Log, rmsg, finfo.Name, finfo.Size, b.General) + if err != nil { + return err + } + data, _, err := b.mc.Client.DownloadFile(id, true) + if err != nil { + return err + } + helper.HandleDownloadData(b.Log, rmsg, finfo.Name, rmsg.Text, url, &data, b.General) + return nil +} + +func (b *Bmattermost) handleMatter() { + messages := make(chan *config.Message) + if b.GetString("WebhookBindAddress") != "" { + b.Log.Debugf("Choosing webhooks based receiving") + go b.handleMatterHook(messages) + } else { + if b.GetString("Token") != "" { + b.Log.Debugf("Choosing token based receiving") + } else { + b.Log.Debugf("Choosing login/password based receiving") + } + // if for some reason we only want to sent stuff to mattermost but not receive, return + if b.GetString("WebhookBindAddress") == "" && b.GetString("WebhookURL") != "" && b.GetString("Token") == "" && b.GetString("Login") == "" { + b.Log.Debugf("No WebhookBindAddress specified, only WebhookURL. You will not receive messages from mattermost, only sending is possible.") + } + go b.handleMatterClient(messages) + } + var ok bool + for message := range messages { + message.Avatar = helper.GetAvatar(b.avatarMap, message.UserID, b.General) + message.Account = b.Account + message.Text, ok = b.replaceAction(message.Text) + if ok { + message.Event = config.EventUserAction + } + b.Log.Debugf("<= Sending message from %s on %s to gateway", message.Username, b.Account) + b.Log.Debugf("<= Message is %#v", message) + b.Remote <- *message + } +} + +//nolint:cyclop +func (b *Bmattermost) handleMatterClient(messages chan *config.Message) { + for message := range b.mc.MessageChan { + b.Log.Debugf("%#v %#v", message.Raw.GetData(), message.Raw.EventType()) + + if b.skipMessage(message) { + b.Log.Debugf("Skipped message: %#v", message) + continue + } + + channelName := b.getChannelName(message.Post.ChannelId) + if channelName == "" { + channelName = message.Channel + } + + // only download avatars if we have a place to upload them (configured mediaserver) + if b.General.MediaServerUpload != "" || b.General.MediaDownloadPath != "" { + b.handleDownloadAvatar(message.UserID, channelName) + } + + b.Log.Debugf("== Receiving event %#v", message) + + rmsg := &config.Message{ + Username: message.Username, + UserID: message.UserID, + Channel: channelName, + Text: message.Text, + ID: message.Post.Id, + ParentID: message.Post.RootId, // ParentID is obsolete with mattermost + Extra: make(map[string][]interface{}), + } + + // handle mattermost post properties (override username and attachments) + b.handleProps(rmsg, message) + + // create a text for bridges that don't support native editing + if message.Raw.EventType() == model.WebsocketEventPostEdited && !b.GetBool("EditDisable") { + rmsg.Text = message.Text + b.GetString("EditSuffix") + } + + if message.Raw.EventType() == model.WebsocketEventPostDeleted { + rmsg.Event = config.EventMsgDelete + } + + for _, id := range message.Post.FileIds { + err := b.handleDownloadFile(rmsg, id) + if err != nil { + b.Log.Errorf("download failed: %s", err) + } + } + + // Use nickname instead of username if defined + if !b.GetBool("useusername") { + if nick := b.mc.GetNickName(rmsg.UserID); nick != "" { + rmsg.Username = nick + } + } + + messages <- rmsg + } +} + +func (b *Bmattermost) handleMatterHook(messages chan *config.Message) { + for { + message := b.mh.Receive() + b.Log.Debugf("Receiving from matterhook %#v", message) + + messages <- &config.Message{ + UserID: message.UserID, + Username: message.UserName, + Text: message.Text, + Channel: message.ChannelName, + } + } +} + +func (b *Bmattermost) handleUploadFile(msg *config.Message) (string, error) { + var err error + var res, id string + channelID := b.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.GetBool("PrefixMessagesWithNick") { + msg.Text = msg.Username + msg.Text + } + res, err = b.mc.PostMessageWithFiles(channelID, msg.Text, msg.ParentID, []string{id}) + } + return res, err +} + +//nolint:forcetypeassert +func (b *Bmattermost) handleProps(rmsg *config.Message, message *matterclient.Message) { + props := message.Post.Props + if props == nil { + return + } + if _, ok := props["override_username"].(string); ok { + rmsg.Username = props["override_username"].(string) + } + if _, ok := props["attachments"].([]interface{}); ok { + rmsg.Extra["attachments"] = props["attachments"].([]interface{}) + if rmsg.Text != "" { + return + } + + for _, attachment := range rmsg.Extra["attachments"] { + attach := attachment.(map[string]interface{}) + if attach["text"].(string) != "" { + rmsg.Text += attach["text"].(string) + continue + } + if attach["fallback"].(string) != "" { + rmsg.Text += attach["fallback"].(string) + } + } + } +} diff --git a/teleirc/matterbridge/bridge/mattermost/helpers.go b/teleirc/matterbridge/bridge/mattermost/helpers.go new file mode 100644 index 0000000..cca1c4e --- /dev/null +++ b/teleirc/matterbridge/bridge/mattermost/helpers.go @@ -0,0 +1,283 @@ +package bmattermost + +import ( + "net/http" + "strings" + + "github.com/42wim/matterbridge/bridge/config" + "github.com/42wim/matterbridge/bridge/helper" + "github.com/42wim/matterbridge/matterhook" + "github.com/matterbridge/matterclient" + "github.com/mattermost/mattermost-server/v6/model" +) + +func (b *Bmattermost) doConnectWebhookBind() error { + switch { + case b.GetString("WebhookURL") != "": + b.Log.Info("Connecting using webhookurl (sending) and webhookbindaddress (receiving)") + b.mh = matterhook.New(b.GetString("WebhookURL"), + matterhook.Config{ + InsecureSkipVerify: b.GetBool("SkipTLSVerify"), + BindAddress: b.GetString("WebhookBindAddress"), + }) + case b.GetString("Token") != "": + b.Log.Info("Connecting using token (sending)") + err := b.apiLogin() + if err != nil { + return err + } + case b.GetString("Login") != "": + b.Log.Info("Connecting using login/password (sending)") + err := b.apiLogin() + if err != nil { + return err + } + default: + b.Log.Info("Connecting using webhookbindaddress (receiving)") + b.mh = matterhook.New(b.GetString("WebhookURL"), + matterhook.Config{ + InsecureSkipVerify: b.GetBool("SkipTLSVerify"), + BindAddress: b.GetString("WebhookBindAddress"), + }) + } + return nil +} + +func (b *Bmattermost) doConnectWebhookURL() error { + b.Log.Info("Connecting using webhookurl (sending)") + b.mh = matterhook.New(b.GetString("WebhookURL"), + matterhook.Config{ + InsecureSkipVerify: b.GetBool("SkipTLSVerify"), + DisableServer: true, + }) + if b.GetString("Token") != "" { + b.Log.Info("Connecting using token (receiving)") + err := b.apiLogin() + if err != nil { + return err + } + } else if b.GetString("Login") != "" { + b.Log.Info("Connecting using login/password (receiving)") + err := b.apiLogin() + if err != nil { + return err + } + } + return nil +} + +//nolint:wrapcheck +func (b *Bmattermost) apiLogin() error { + password := b.GetString("Password") + if b.GetString("Token") != "" { + password = "token=" + b.GetString("Token") + } + + b.mc = matterclient.New(b.GetString("Login"), password, b.GetString("Team"), b.GetString("Server"), "") + if b.GetBool("debug") { + b.mc.SetLogLevel("debug") + } + b.mc.SkipTLSVerify = b.GetBool("SkipTLSVerify") + b.mc.SkipVersionCheck = b.GetBool("SkipVersionCheck") + b.mc.NoTLS = b.GetBool("NoTLS") + b.Log.Infof("Connecting %s (team: %s) on %s", b.GetString("Login"), b.GetString("Team"), b.GetString("Server")) + + if err := b.mc.Login(); err != nil { + return err + } + + b.Log.Info("Connection succeeded") + b.TeamID = b.mc.GetTeamID() + return nil +} + +// replaceAction replace the message with the correct action (/me) code +func (b *Bmattermost) replaceAction(text string) (string, bool) { + if strings.HasPrefix(text, "*") && strings.HasSuffix(text, "*") { + return strings.Replace(text, "*", "", -1), true + } + 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 != "" { + b.Log.Debugf("Added %s to %s in avatarMap", fi.SHA, msg.UserID) + b.avatarMap[msg.UserID] = fi.SHA + } + return "", nil +} + +// sendWebhook uses the configured WebhookURL to send the message +func (b *Bmattermost) sendWebhook(msg config.Message) (string, error) { + // skip events + if msg.Event != "" { + return "", nil + } + + if b.GetBool("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) { + rmsg := rmsg // scopelint + iconURL := config.GetIconURL(&rmsg, b.GetString("iconurl")) + matterMessage := matterhook.OMessage{ + IconURL: iconURL, + Channel: rmsg.Channel, + UserName: rmsg.Username, + Text: rmsg.Text, + Props: make(map[string]interface{}), + } + matterMessage.Props["matterbridge_"+b.uuid] = true + if err := b.mh.Send(matterMessage); err != nil { + b.Log.Errorf("sendWebhook failed: %s ", err) + } + } + + // 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 + } + } + } + } + + iconURL := config.GetIconURL(&msg, b.GetString("iconurl")) + matterMessage := matterhook.OMessage{ + IconURL: 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_"+b.uuid] = true + err := b.mh.Send(matterMessage) + if err != nil { + b.Log.Info(err) + return "", err + } + return "", nil +} + +// skipMessages returns true if this message should not be handled +//nolint:gocyclo,cyclop +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" { + if b.GetBool("nosendjoinpart") { + return true + } + + channelName := b.getChannelName(message.Post.ChannelId) + if channelName == "" { + channelName = message.Channel + } + + b.Log.Debugf("Sending JOIN_LEAVE event from %s to gateway", b.Account) + b.Remote <- config.Message{ + Username: "system", + Text: message.Text, + Channel: channelName, + Account: b.Account, + Event: config.EventJoinLeave, + } + return true + } + + // Handle edited messages + if (message.Raw.EventType() == model.WebsocketEventPostEdited) && b.GetBool("EditDisable") { + return true + } + + // Ignore non-post messages + if message.Post == nil { + b.Log.Debugf("ignoring nil message.Post: %#v", message) + return true + } + + // Ignore messages sent from matterbridge + if message.Post.Props != nil { + if _, ok := message.Post.Props["matterbridge_"+b.uuid].(bool); ok { + b.Log.Debug("sent by matterbridge, ignoring") + return true + } + } + + // Ignore messages sent from a user logged in as the bot + if b.mc.User.Username == message.Username { + b.Log.Debug("message from same user as bot, ignoring") + 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.GetData()["team_id"].(string) != b.TeamID { + b.Log.Debug("message from other team, ignoring") + return true + } + + // only handle posted, edited or deleted events + if !(message.Raw.EventType() == "posted" || message.Raw.EventType() == model.WebsocketEventPostEdited || + message.Raw.EventType() == model.WebsocketEventPostDeleted) { + return true + } + return false +} + +func (b *Bmattermost) getVersion() string { + proto := "https" + + if b.GetBool("notls") { + proto = "http" + } + + resp, err := http.Get(proto + "://" + b.GetString("server")) + if err != nil { + b.Log.Error("failed getting version") + return "" + } + + defer resp.Body.Close() + + return resp.Header.Get("X-Version-Id") +} + +func (b *Bmattermost) getChannelID(name string) string { + idcheck := strings.Split(name, "ID:") + if len(idcheck) > 1 { + return idcheck[1] + } + + return b.mc.GetChannelID(name, b.TeamID) +} + +func (b *Bmattermost) getChannelName(id string) string { + b.channelsMutex.RLock() + defer b.channelsMutex.RUnlock() + + for _, c := range b.channelInfoMap { + if c.Name == "ID:"+id { + // if we have ID: specified in our gateway configuration return this + return c.Name + } + } + + return "" +} diff --git a/teleirc/matterbridge/bridge/mattermost/mattermost.go b/teleirc/matterbridge/bridge/mattermost/mattermost.go new file mode 100644 index 0000000..2b44dcf --- /dev/null +++ b/teleirc/matterbridge/bridge/mattermost/mattermost.go @@ -0,0 +1,193 @@ +package bmattermost + +import ( + "errors" + "fmt" + "strings" + "sync" + + "github.com/42wim/matterbridge/bridge" + "github.com/42wim/matterbridge/bridge/config" + "github.com/42wim/matterbridge/bridge/helper" + "github.com/42wim/matterbridge/matterhook" + "github.com/matterbridge/matterclient" + "github.com/rs/xid" +) + +type Bmattermost struct { + mh *matterhook.Client + mc *matterclient.Client + v6 bool + uuid string + TeamID string + *bridge.Config + avatarMap map[string]string + channelsMutex sync.RWMutex + channelInfoMap map[string]*config.ChannelInfo +} + +const mattermostPlugin = "mattermost.plugin" + +func New(cfg *bridge.Config) bridge.Bridger { + b := &Bmattermost{ + Config: cfg, + avatarMap: make(map[string]string), + channelInfoMap: make(map[string]*config.ChannelInfo), + } + + b.v6 = b.GetBool("v6") + b.uuid = xid.New().String() + + return b +} + +func (b *Bmattermost) Command(cmd string) string { + return "" +} + +func (b *Bmattermost) Connect() error { + if b.Account == mattermostPlugin { + return nil + } + + if strings.HasPrefix(b.getVersion(), "6.") || strings.HasPrefix(b.getVersion(), "7.") { + if !b.v6 { + b.v6 = true + } + } + + if b.GetString("WebhookBindAddress") != "" { + if err := b.doConnectWebhookBind(); err != nil { + return err + } + go b.handleMatter() + return nil + } + switch { + case b.GetString("WebhookURL") != "": + if err := b.doConnectWebhookURL(); err != nil { + return err + } + go b.handleMatter() + return nil + case b.GetString("Token") != "": + b.Log.Info("Connecting using token (sending and receiving)") + err := b.apiLogin() + if err != nil { + return err + } + go b.handleMatter() + case b.GetString("Login") != "": + b.Log.Info("Connecting using login/password (sending and receiving)") + b.Log.Infof("Using mattermost v6 methods: %t", b.v6) + err := b.apiLogin() + if err != nil { + return err + } + go b.handleMatter() + } + if b.GetString("WebhookBindAddress") == "" && b.GetString("WebhookURL") == "" && + b.GetString("Login") == "" && b.GetString("Token") == "" { + return errors.New("no connection method found. See that you have WebhookBindAddress, WebhookURL or Token/Login/Password/Server/Team configured") + } + return nil +} + +func (b *Bmattermost) Disconnect() error { + return nil +} + +func (b *Bmattermost) JoinChannel(channel config.ChannelInfo) error { + if b.Account == mattermostPlugin { + return nil + } + + b.channelsMutex.Lock() + b.channelInfoMap[channel.ID] = &channel + b.channelsMutex.Unlock() + + // we can only join channels using the API + if b.GetString("WebhookURL") == "" && b.GetString("WebhookBindAddress") == "" { + id := b.getChannelID(channel.Name) + if id == "" { + return fmt.Errorf("Could not find channel ID for channel %s", channel.Name) + } + + return b.mc.JoinChannel(id) + } + + return nil +} + +func (b *Bmattermost) Send(msg config.Message) (string, error) { + if b.Account == mattermostPlugin { + return "", nil + } + b.Log.Debugf("=> Receiving %#v", msg) + + // Make a action /me of the message + if msg.Event == config.EventUserAction { + msg.Text = "*" + msg.Text + "*" + } + + // map the file SHA to our user (caches the avatar) + if msg.Event == config.EventAvatarDownload { + return b.cacheAvatar(&msg) + } + + // Use webhook to send the message + if b.GetString("WebhookURL") != "" { + return b.sendWebhook(msg) + } + + // Delete message + if msg.Event == config.EventMsgDelete { + if msg.ID == "" { + return "", nil + } + + return msg.ID, b.mc.DeleteMessage(msg.ID) + } + + // Handle prefix hint for unthreaded messages. + if msg.ParentNotFound() { + msg.ParentID = "" + msg.Text = fmt.Sprintf("[thread]: %s", msg.Text) + } + + // we only can reply to the root of the thread, not to a specific ID (like discord for example does) + if msg.ParentID != "" { + post, _, err := b.mc.Client.GetPost(msg.ParentID, "") + if err != nil { + b.Log.Errorf("getting post %s failed: %s", msg.ParentID, err) + } + if post.RootId != "" { + msg.ParentID = post.RootId + } + } + + // Upload a file if it exists + if msg.Extra != nil { + for _, rmsg := range helper.HandleExtra(&msg, b.General) { + if _, err := b.mc.PostMessage(b.getChannelID(rmsg.Channel), rmsg.Username+rmsg.Text, msg.ParentID); err != nil { + b.Log.Errorf("PostMessage failed: %s", err) + } + } + if len(msg.Extra["file"]) > 0 { + return b.handleUploadFile(&msg) + } + } + + // Prepend nick if configured + if b.GetBool("PrefixMessagesWithNick") { + msg.Text = msg.Username + msg.Text + } + + // Edit message if we have an ID + if msg.ID != "" { + return b.mc.EditMessage(msg.ID, msg.Text) + } + + // Post normal message + return b.mc.PostMessage(b.getChannelID(msg.Channel), msg.Text, msg.ParentID) +} |
