mirror of
https://github.com/cwinfo/matterbridge.git
synced 2024-11-10 06:20:28 +00:00
291594b99c
* Added origin CHANNEL to RemoteNickFormat. Updated config docs. [Fixes #515] * Update matterbridge.toml.sample Co-Authored-By: patcon <patrick.c.connolly@gmail.com>
511 lines
14 KiB
Go
511 lines
14 KiB
Go
package gateway
|
||
|
||
import (
|
||
"bytes"
|
||
"fmt"
|
||
"io/ioutil"
|
||
"net/http"
|
||
"os"
|
||
|
||
"github.com/42wim/matterbridge/bridge"
|
||
"github.com/42wim/matterbridge/bridge/api"
|
||
"github.com/42wim/matterbridge/bridge/config"
|
||
bdiscord "github.com/42wim/matterbridge/bridge/discord"
|
||
bgitter "github.com/42wim/matterbridge/bridge/gitter"
|
||
birc "github.com/42wim/matterbridge/bridge/irc"
|
||
bmatrix "github.com/42wim/matterbridge/bridge/matrix"
|
||
bmattermost "github.com/42wim/matterbridge/bridge/mattermost"
|
||
brocketchat "github.com/42wim/matterbridge/bridge/rocketchat"
|
||
bslack "github.com/42wim/matterbridge/bridge/slack"
|
||
bsshchat "github.com/42wim/matterbridge/bridge/sshchat"
|
||
bsteam "github.com/42wim/matterbridge/bridge/steam"
|
||
btelegram "github.com/42wim/matterbridge/bridge/telegram"
|
||
bxmpp "github.com/42wim/matterbridge/bridge/xmpp"
|
||
bzulip "github.com/42wim/matterbridge/bridge/zulip"
|
||
"github.com/hashicorp/golang-lru"
|
||
log "github.com/sirupsen/logrus"
|
||
// "github.com/davecgh/go-spew/spew"
|
||
"crypto/sha1"
|
||
"path/filepath"
|
||
"regexp"
|
||
"strings"
|
||
"time"
|
||
|
||
"github.com/peterhellberg/emojilib"
|
||
)
|
||
|
||
type Gateway struct {
|
||
*config.Config
|
||
Router *Router
|
||
MyConfig *config.Gateway
|
||
Bridges map[string]*bridge.Bridge
|
||
Channels map[string]*config.ChannelInfo
|
||
ChannelOptions map[string]config.ChannelOptions
|
||
Message chan config.Message
|
||
Name string
|
||
Messages *lru.Cache
|
||
}
|
||
|
||
type BrMsgID struct {
|
||
br *bridge.Bridge
|
||
ID string
|
||
ChannelID string
|
||
}
|
||
|
||
var flog *log.Entry
|
||
|
||
var bridgeMap = map[string]bridge.Factory{
|
||
"api": api.New,
|
||
"discord": bdiscord.New,
|
||
"gitter": bgitter.New,
|
||
"irc": birc.New,
|
||
"mattermost": bmattermost.New,
|
||
"matrix": bmatrix.New,
|
||
"rocketchat": brocketchat.New,
|
||
"slack": bslack.New,
|
||
"sshchat": bsshchat.New,
|
||
"steam": bsteam.New,
|
||
"telegram": btelegram.New,
|
||
"xmpp": bxmpp.New,
|
||
"zulip": bzulip.New,
|
||
}
|
||
|
||
func init() {
|
||
flog = log.WithFields(log.Fields{"prefix": "gateway"})
|
||
}
|
||
|
||
func New(cfg config.Gateway, r *Router) *Gateway {
|
||
gw := &Gateway{Channels: make(map[string]*config.ChannelInfo), Message: r.Message,
|
||
Router: r, Bridges: make(map[string]*bridge.Bridge), Config: r.Config}
|
||
cache, _ := lru.New(5000)
|
||
gw.Messages = cache
|
||
gw.AddConfig(&cfg)
|
||
return gw
|
||
}
|
||
|
||
func (gw *Gateway) AddBridge(cfg *config.Bridge) error {
|
||
br := gw.Router.getBridge(cfg.Account)
|
||
if br == nil {
|
||
br = bridge.New(cfg)
|
||
br.Config = gw.Router.Config
|
||
br.General = &gw.General
|
||
// set logging
|
||
br.Log = log.WithFields(log.Fields{"prefix": "bridge"})
|
||
brconfig := &bridge.Config{Remote: gw.Message, Log: log.WithFields(log.Fields{"prefix": br.Protocol}), Bridge: br}
|
||
// add the actual bridger for this protocol to this bridge using the bridgeMap
|
||
br.Bridger = bridgeMap[br.Protocol](brconfig)
|
||
}
|
||
gw.mapChannelsToBridge(br)
|
||
gw.Bridges[cfg.Account] = br
|
||
return nil
|
||
}
|
||
|
||
func (gw *Gateway) AddConfig(cfg *config.Gateway) error {
|
||
gw.Name = cfg.Name
|
||
gw.MyConfig = cfg
|
||
gw.mapChannels()
|
||
for _, br := range append(gw.MyConfig.In, append(gw.MyConfig.InOut, gw.MyConfig.Out...)...) {
|
||
err := gw.AddBridge(&br)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func (gw *Gateway) mapChannelsToBridge(br *bridge.Bridge) {
|
||
for ID, channel := range gw.Channels {
|
||
if br.Account == channel.Account {
|
||
br.Channels[ID] = *channel
|
||
}
|
||
}
|
||
}
|
||
|
||
func (gw *Gateway) reconnectBridge(br *bridge.Bridge) {
|
||
br.Disconnect()
|
||
time.Sleep(time.Second * 5)
|
||
RECONNECT:
|
||
flog.Infof("Reconnecting %s", br.Account)
|
||
err := br.Connect()
|
||
if err != nil {
|
||
flog.Errorf("Reconnection failed: %s. Trying again in 60 seconds", err)
|
||
time.Sleep(time.Second * 60)
|
||
goto RECONNECT
|
||
}
|
||
br.Joined = make(map[string]bool)
|
||
br.JoinChannels()
|
||
}
|
||
|
||
func (gw *Gateway) mapChannelConfig(cfg []config.Bridge, direction string) {
|
||
for _, br := range cfg {
|
||
if isApi(br.Account) {
|
||
br.Channel = "api"
|
||
}
|
||
// make sure to lowercase irc channels in config #348
|
||
if strings.HasPrefix(br.Account, "irc.") {
|
||
br.Channel = strings.ToLower(br.Channel)
|
||
}
|
||
ID := br.Channel + br.Account
|
||
if _, ok := gw.Channels[ID]; !ok {
|
||
channel := &config.ChannelInfo{Name: br.Channel, Direction: direction, ID: ID, Options: br.Options, Account: br.Account,
|
||
SameChannel: make(map[string]bool)}
|
||
channel.SameChannel[gw.Name] = br.SameChannel
|
||
gw.Channels[channel.ID] = channel
|
||
} else {
|
||
// if we already have a key and it's not our current direction it means we have a bidirectional inout
|
||
if gw.Channels[ID].Direction != direction {
|
||
gw.Channels[ID].Direction = "inout"
|
||
}
|
||
}
|
||
gw.Channels[ID].SameChannel[gw.Name] = br.SameChannel
|
||
}
|
||
}
|
||
|
||
func (gw *Gateway) mapChannels() error {
|
||
gw.mapChannelConfig(gw.MyConfig.In, "in")
|
||
gw.mapChannelConfig(gw.MyConfig.Out, "out")
|
||
gw.mapChannelConfig(gw.MyConfig.InOut, "inout")
|
||
return nil
|
||
}
|
||
|
||
func (gw *Gateway) getDestChannel(msg *config.Message, dest bridge.Bridge) []config.ChannelInfo {
|
||
var channels []config.ChannelInfo
|
||
|
||
// for messages received from the api check that the gateway is the specified one
|
||
if msg.Protocol == "api" && gw.Name != msg.Gateway {
|
||
return channels
|
||
}
|
||
|
||
// if source channel is in only, do nothing
|
||
for _, channel := range gw.Channels {
|
||
// lookup the channel from the message
|
||
if channel.ID == getChannelID(*msg) {
|
||
// we only have destinations if the original message is from an "in" (sending) channel
|
||
if !strings.Contains(channel.Direction, "in") {
|
||
return channels
|
||
}
|
||
continue
|
||
}
|
||
}
|
||
for _, channel := range gw.Channels {
|
||
if _, ok := gw.Channels[getChannelID(*msg)]; !ok {
|
||
continue
|
||
}
|
||
|
||
// do samechannelgateway flogic
|
||
if channel.SameChannel[msg.Gateway] {
|
||
if msg.Channel == channel.Name && msg.Account != dest.Account {
|
||
channels = append(channels, *channel)
|
||
}
|
||
continue
|
||
}
|
||
if strings.Contains(channel.Direction, "out") && channel.Account == dest.Account && gw.validGatewayDest(msg, channel) {
|
||
channels = append(channels, *channel)
|
||
}
|
||
}
|
||
return channels
|
||
}
|
||
|
||
func (gw *Gateway) handleMessage(msg config.Message, dest *bridge.Bridge) []*BrMsgID {
|
||
var brMsgIDs []*BrMsgID
|
||
|
||
// if we have an attached file, or other info
|
||
if msg.Extra != nil {
|
||
if len(msg.Extra[config.EVENT_FILE_FAILURE_SIZE]) != 0 {
|
||
if msg.Text == "" {
|
||
return brMsgIDs
|
||
}
|
||
}
|
||
}
|
||
|
||
// Avatar downloads are only relevant for telegram and mattermost for now
|
||
if msg.Event == config.EVENT_AVATAR_DOWNLOAD {
|
||
if dest.Protocol != "mattermost" &&
|
||
dest.Protocol != "telegram" {
|
||
return brMsgIDs
|
||
}
|
||
}
|
||
|
||
// only relay join/part when configured
|
||
if msg.Event == config.EVENT_JOIN_LEAVE && !gw.Bridges[dest.Account].GetBool("ShowJoinPart") {
|
||
return brMsgIDs
|
||
}
|
||
|
||
// only relay topic change when configured
|
||
if msg.Event == config.EVENT_TOPIC_CHANGE && !gw.Bridges[dest.Account].GetBool("ShowTopicChange") {
|
||
return brMsgIDs
|
||
}
|
||
|
||
// broadcast to every out channel (irc QUIT)
|
||
if msg.Channel == "" && msg.Event != config.EVENT_JOIN_LEAVE {
|
||
flog.Debug("empty channel")
|
||
return brMsgIDs
|
||
}
|
||
|
||
originchannel := msg.Channel
|
||
origmsg := msg
|
||
channels := gw.getDestChannel(&msg, *dest)
|
||
for _, channel := range channels {
|
||
// Only send the avatar download event to ourselves.
|
||
if msg.Event == config.EVENT_AVATAR_DOWNLOAD {
|
||
if channel.ID != getChannelID(origmsg) {
|
||
continue
|
||
}
|
||
} else {
|
||
// do not send to ourself for any other event
|
||
if channel.ID == getChannelID(origmsg) {
|
||
continue
|
||
}
|
||
}
|
||
flog.Debugf("=> Sending %#v from %s (%s) to %s (%s)", msg, msg.Account, originchannel, dest.Account, channel.Name)
|
||
msg.Channel = channel.Name
|
||
msg.Avatar = gw.modifyAvatar(origmsg, dest)
|
||
msg.Username = gw.modifyUsername(origmsg, dest)
|
||
msg.ID = ""
|
||
if res, ok := gw.Messages.Get(origmsg.ID); ok {
|
||
IDs := res.([]*BrMsgID)
|
||
for _, id := range IDs {
|
||
// check protocol, bridge name and channelname
|
||
// for people that reuse the same bridge multiple times. see #342
|
||
if dest.Protocol == id.br.Protocol && dest.Name == id.br.Name && channel.ID == id.ChannelID {
|
||
msg.ID = id.ID
|
||
}
|
||
}
|
||
}
|
||
// for api we need originchannel as channel
|
||
if dest.Protocol == "api" {
|
||
msg.Channel = originchannel
|
||
}
|
||
mID, err := dest.Send(msg)
|
||
if err != nil {
|
||
flog.Error(err)
|
||
}
|
||
// append the message ID (mID) from this bridge (dest) to our brMsgIDs slice
|
||
if mID != "" {
|
||
flog.Debugf("mID %s: %s", dest.Account, mID)
|
||
brMsgIDs = append(brMsgIDs, &BrMsgID{dest, mID, channel.ID})
|
||
}
|
||
}
|
||
return brMsgIDs
|
||
}
|
||
|
||
func (gw *Gateway) ignoreMessage(msg *config.Message) bool {
|
||
// if we don't have the bridge, ignore it
|
||
if _, ok := gw.Bridges[msg.Account]; !ok {
|
||
return true
|
||
}
|
||
|
||
// check if we need to ignore a empty message
|
||
if msg.Text == "" {
|
||
// we have an attachment or actual bytes, do not ignore
|
||
if msg.Extra != nil &&
|
||
(msg.Extra["attachments"] != nil ||
|
||
len(msg.Extra["file"]) > 0 ||
|
||
len(msg.Extra[config.EVENT_FILE_FAILURE_SIZE]) > 0) {
|
||
return false
|
||
}
|
||
flog.Debugf("ignoring empty message %#v from %s", msg, msg.Account)
|
||
return true
|
||
}
|
||
|
||
// is the username in IgnoreNicks field
|
||
for _, entry := range strings.Fields(gw.Bridges[msg.Account].GetString("IgnoreNicks")) {
|
||
if msg.Username == entry {
|
||
flog.Debugf("ignoring %s from %s", msg.Username, msg.Account)
|
||
return true
|
||
}
|
||
}
|
||
|
||
// does the message match regex in IgnoreMessages field
|
||
// TODO do not compile regexps everytime
|
||
for _, entry := range strings.Fields(gw.Bridges[msg.Account].GetString("IgnoreMessages")) {
|
||
if entry != "" {
|
||
re, err := regexp.Compile(entry)
|
||
if err != nil {
|
||
flog.Errorf("incorrect regexp %s for %s", entry, msg.Account)
|
||
continue
|
||
}
|
||
if re.MatchString(msg.Text) {
|
||
flog.Debugf("matching %s. ignoring %s from %s", entry, msg.Text, msg.Account)
|
||
return true
|
||
}
|
||
}
|
||
}
|
||
return false
|
||
}
|
||
|
||
func (gw *Gateway) modifyUsername(msg config.Message, dest *bridge.Bridge) string {
|
||
br := gw.Bridges[msg.Account]
|
||
msg.Protocol = br.Protocol
|
||
if gw.Config.General.StripNick || dest.GetBool("StripNick") {
|
||
re := regexp.MustCompile("[^a-zA-Z0-9]+")
|
||
msg.Username = re.ReplaceAllString(msg.Username, "")
|
||
}
|
||
nick := dest.GetString("RemoteNickFormat")
|
||
if nick == "" {
|
||
nick = gw.Config.General.RemoteNickFormat
|
||
}
|
||
|
||
// loop to replace nicks
|
||
for _, outer := range br.GetStringSlice2D("ReplaceNicks") {
|
||
search := outer[0]
|
||
replace := outer[1]
|
||
// TODO move compile to bridge init somewhere
|
||
re, err := regexp.Compile(search)
|
||
if err != nil {
|
||
flog.Errorf("regexp in %s failed: %s", msg.Account, err)
|
||
break
|
||
}
|
||
msg.Username = re.ReplaceAllString(msg.Username, replace)
|
||
}
|
||
|
||
if len(msg.Username) > 0 {
|
||
// fix utf-8 issue #193
|
||
i := 0
|
||
for index := range msg.Username {
|
||
if i == 1 {
|
||
i = index
|
||
break
|
||
}
|
||
i++
|
||
}
|
||
nick = strings.Replace(nick, "{NOPINGNICK}", msg.Username[:i]+""+msg.Username[i:], -1)
|
||
}
|
||
|
||
nick = strings.Replace(nick, "{BRIDGE}", br.Name, -1)
|
||
nick = strings.Replace(nick, "{PROTOCOL}", br.Protocol, -1)
|
||
nick = strings.Replace(nick, "{GATEWAY}", gw.Name, -1)
|
||
nick = strings.Replace(nick, "{LABEL}", br.GetString("Label"), -1)
|
||
nick = strings.Replace(nick, "{NICK}", msg.Username, -1)
|
||
nick = strings.Replace(nick, "{CHANNEL}", msg.Channel, -1)
|
||
return nick
|
||
}
|
||
|
||
func (gw *Gateway) modifyAvatar(msg config.Message, dest *bridge.Bridge) string {
|
||
iconurl := gw.Config.General.IconURL
|
||
if iconurl == "" {
|
||
iconurl = dest.GetString("IconURL")
|
||
}
|
||
iconurl = strings.Replace(iconurl, "{NICK}", msg.Username, -1)
|
||
if msg.Avatar == "" {
|
||
msg.Avatar = iconurl
|
||
}
|
||
return msg.Avatar
|
||
}
|
||
|
||
func (gw *Gateway) modifyMessage(msg *config.Message) {
|
||
// replace :emoji: to unicode
|
||
msg.Text = emojilib.Replace(msg.Text)
|
||
|
||
br := gw.Bridges[msg.Account]
|
||
// loop to replace messages
|
||
for _, outer := range br.GetStringSlice2D("ReplaceMessages") {
|
||
search := outer[0]
|
||
replace := outer[1]
|
||
// TODO move compile to bridge init somewhere
|
||
re, err := regexp.Compile(search)
|
||
if err != nil {
|
||
flog.Errorf("regexp in %s failed: %s", msg.Account, err)
|
||
break
|
||
}
|
||
msg.Text = re.ReplaceAllString(msg.Text, replace)
|
||
}
|
||
|
||
// messages from api have Gateway specified, don't overwrite
|
||
if msg.Protocol != "api" {
|
||
msg.Gateway = gw.Name
|
||
}
|
||
}
|
||
|
||
// handleFiles uploads or places all files on the given msg to the MediaServer and
|
||
// adds the new URL of the file on the MediaServer onto the given msg.
|
||
func (gw *Gateway) handleFiles(msg *config.Message) {
|
||
reg := regexp.MustCompile("[^a-zA-Z0-9]+")
|
||
|
||
// If we don't have a attachfield or we don't have a mediaserver configured return
|
||
if msg.Extra == nil || (gw.Config.General.MediaServerUpload == "" && gw.Config.General.MediaDownloadPath == "") {
|
||
return
|
||
}
|
||
|
||
// If we don't have files, nothing to upload.
|
||
if len(msg.Extra["file"]) == 0 {
|
||
return
|
||
}
|
||
|
||
client := &http.Client{
|
||
Timeout: time.Second * 5,
|
||
}
|
||
|
||
for i, f := range msg.Extra["file"] {
|
||
fi := f.(config.FileInfo)
|
||
ext := filepath.Ext(fi.Name)
|
||
fi.Name = fi.Name[0 : len(fi.Name)-len(ext)]
|
||
fi.Name = reg.ReplaceAllString(fi.Name, "_")
|
||
fi.Name = fi.Name + ext
|
||
|
||
sha1sum := fmt.Sprintf("%x", sha1.Sum(*fi.Data))[:8]
|
||
|
||
if gw.Config.General.MediaServerUpload != "" {
|
||
// Use MediaServerUpload. Upload using a PUT HTTP request and basicauth.
|
||
|
||
url := gw.Config.General.MediaServerUpload + "/" + sha1sum + "/" + fi.Name
|
||
|
||
req, err := http.NewRequest("PUT", url, bytes.NewReader(*fi.Data))
|
||
if err != nil {
|
||
flog.Errorf("mediaserver upload failed, could not create request: %#v", err)
|
||
continue
|
||
}
|
||
|
||
flog.Debugf("mediaserver upload url: %s", url)
|
||
|
||
req.Header.Set("Content-Type", "binary/octet-stream")
|
||
_, err = client.Do(req)
|
||
if err != nil {
|
||
flog.Errorf("mediaserver upload failed, could not Do request: %#v", err)
|
||
continue
|
||
}
|
||
} else {
|
||
// Use MediaServerPath. Place the file on the current filesystem.
|
||
|
||
dir := gw.Config.General.MediaDownloadPath + "/" + sha1sum
|
||
err := os.Mkdir(dir, os.ModePerm)
|
||
if err != nil && !os.IsExist(err) {
|
||
flog.Errorf("mediaserver path failed, could not mkdir: %s %#v", err, err)
|
||
continue
|
||
}
|
||
|
||
path := dir + "/" + fi.Name
|
||
flog.Debugf("mediaserver path placing file: %s", path)
|
||
|
||
err = ioutil.WriteFile(path, *fi.Data, os.ModePerm)
|
||
if err != nil {
|
||
flog.Errorf("mediaserver path failed, could not writefile: %s %#v", err, err)
|
||
continue
|
||
}
|
||
}
|
||
|
||
// Download URL.
|
||
durl := gw.Config.General.MediaServerDownload + "/" + sha1sum + "/" + fi.Name
|
||
|
||
flog.Debugf("mediaserver download URL = %s", durl)
|
||
|
||
// We uploaded/placed the file successfully. Add the SHA and URL.
|
||
extra := msg.Extra["file"][i].(config.FileInfo)
|
||
extra.URL = durl
|
||
extra.SHA = sha1sum
|
||
msg.Extra["file"][i] = extra
|
||
}
|
||
}
|
||
|
||
func (gw *Gateway) validGatewayDest(msg *config.Message, channel *config.ChannelInfo) bool {
|
||
return msg.Gateway == gw.Name
|
||
}
|
||
|
||
func getChannelID(msg config.Message) string {
|
||
return msg.Channel + msg.Account
|
||
}
|
||
|
||
func isApi(account string) bool {
|
||
return strings.HasPrefix(account, "api.")
|
||
}
|