Merge branch 'master' into socket-mode

Author: 42wim

Dockerfile_whatsappmulti

@@ -0,0 +1,14 @@
+FROM alpine AS builder
+
+COPY . /go/src/matterbridge
+RUN apk --no-cache add go git \
+        && cd /go/src/matterbridge \
+        && CGO_ENABLED=0 go build -tags whatsappmulti -mod vendor -ldflags "-X github.com/42wim/matterbridge/version.GitHash=$(git log --pretty=format:'%h' -n 1)" -o /bin/matterbridge
+
+FROM alpine
+RUN apk --no-cache add ca-certificates mailcap
+COPY --from=builder /bin/matterbridge /bin/matterbridge
+RUN mkdir /etc/matterbridge \
+  && touch /etc/matterbridge/matterbridge.toml \
+  && ln -sf /matterbridge.toml /etc/matterbridge/matterbridge.toml
+ENTRYPOINT ["/bin/matterbridge", "-conf", "/etc/matterbridge/matterbridge.toml"]

README.md

@@ -58,21 +58,22 @@ And more...
     - [Binaries](#binaries)
     - [Packages](#packages)
   - [Building](#building)
+  - [Building with whatsapp (beta) multidevice support](#building-with-whatsapp-beta-multidevice-support)
   - [Configuration](#configuration)
     - [Basic configuration](#basic-configuration)
     - [Settings](#settings)
     - [Advanced configuration](#advanced-configuration)
-    - [Examples](#examples)
-      - [Bridge mattermost (off-topic) - irc (#testing)](#bridge-mattermost-off-topic---irc-testing)
-      - [Bridge slack (#general) - discord (general)](#bridge-slack-general---discord-general)
-  - [Running](#running)
-    - [Docker](#docker)
-    - [Systemd](#systemd)
-  - [Changelog](#changelog)
-  - [FAQ](#faq)
-  - [Related projects](#related-projects)
-  - [Articles / Tutorials](#articles--tutorials)
-  - [Thanks](#thanks)
+      - [Examples](#examples)
+        - [Bridge mattermost (off-topic) - irc (#testing)](#bridge-mattermost-off-topic---irc-testing)
+        - [Bridge slack (#general) - discord (general)](#bridge-slack-general---discord-general)
+    - [Running](#running)
+      - [Docker](#docker)
+      - [Systemd](#systemd)
+    - [Changelog](#changelog)
+    - [FAQ](#faq)
+    - [Related projects](#related-projects)
+    - [Articles / Tutorials](#articles--tutorials)
+    - [Thanks](#thanks)
 
 ## Features
 
@@ -89,6 +90,7 @@ And more...
 
 - [Discord](https://discordapp.com)
 - [Gitter](https://gitter.im)
+- [Harmony](https://harmonyapp.io)
 - [IRC](http://www.mirc.com/servers.html)
 - [Keybase](https://keybase.io)
 - [Matrix](https://matrix.org)
@@ -105,6 +107,8 @@ And more...
 - [Twitch](https://twitch.tv)
 - [VK](https://vk.com/)
 - [WhatsApp](https://www.whatsapp.com/)
+  - Whatsapp legacy is natively supported
+  - Whatsapp multidevice beta is natively supported but you need to build yourself, see [here](#building-with-whatsapp-beta-multidevice-support)
 - [XMPP](https://xmpp.org)
 - [Zulip](https://zulipchat.com)
 
@@ -120,6 +124,8 @@ And more...
 - [Counter-Strike, half-life and more](https://forums.alliedmods.net/showthread.php?t=319430)
 - [MatterAMXX](https://github.com/GabeIggy/MatterAMXX)
 - [Vintage Story](https://github.com/NikkyAI/vs-matterbridge)
+- [Ultima Online Emulator](https://github.com/kuoushi/ServUO-Matterbridge)
+- [Teamspeak](https://github.com/Archeb/ts-matterbridge)
 
 ### API
 
@@ -138,6 +144,8 @@ Used by the projects below. Feel free to make a PR to add your project to this l
 - [matterbabble](https://github.com/DeclanHoare/matterbabble) (Discourse support)
 - [MatterAMXX](https://forums.alliedmods.net/showthread.php?t=319430) (Counter-Strike, half-life and more via AMXX mod)
 - [Vintage Story](https://github.com/NikkyAI/vs-matterbridge)
+- [ServUO-matterbridge](https://github.com/kuoushi/ServUO-Matterbridge) (A matterbridge connector for ServUO servers)
+- [ts-matterbridge](https://github.com/Archeb/ts-matterbridge) (Integrate teamspeak chat with matterbridge)
 
 ## Chat with us
 
@@ -164,10 +172,10 @@ See <https://github.com/42wim/matterbridge/wiki>
 
 ### Binaries
 
-- Latest stable release [v1.24.0](https://github.com/42wim/matterbridge/releases/latest)
+- Latest stable release [v1.24.1](https://github.com/42wim/matterbridge/releases/latest)
 - Development releases (follows master) can be downloaded [here](https://github.com/42wim/matterbridge/actions) selecting the latest green build and then artifacts.
 
-To install or upgrade just download the latest [binary](https://github.com/42wim/matterbridge/releases/latest). On \*nix platforms you may need to make the binary executable - you can do this by running `chmod a+x` on the binary (example: `chmod a+x matterbridge-1.20.0-linux-64bit`). After downloading (and making the binary executable, if necessary), follow the instructions on the [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
+To install or upgrade just download the latest [binary](https://github.com/42wim/matterbridge/releases/latest). On \*nix platforms you may need to make the binary executable - you can do this by running `chmod a+x` on the binary (example: `chmod a+x matterbridge-1.24.1-linux-64bit`). After downloading (and making the binary executable, if necessary), follow the instructions on the [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
 
 ### Packages
 
@@ -182,10 +190,13 @@ Most people just want to use binaries, you can find those [here](https://github.
 If you really want to build from source, follow these instructions:
 Go 1.17+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed.
 
+Building the binary with **all** the bridges enabled needs about 3GB RAM to compile.
+You can reduce this memory requirement to 0,5GB RAM by adding the `nomsteams` tag if you don't need/use the Microsoft Teams bridge
+
 To install the latest stable run:
 
 ```bash
-go install github.com/42wim/matterbridge
+go install github.com/42wim/matterbridge@17da95b094e4bb433e5fe240fa42067d94d908c1
 ```
 
 To install the latest dev run:
@@ -194,6 +205,36 @@ To install the latest dev run:
 go install github.com/42wim/matterbridge@master
 ```
 
+To install the latest stable run without msteams or zulip bridge:
+
+```bash
+go install -tags nomsteams,nozulip github.com/42wim/matterbridge@17da95b094e4bb433e5fe240fa42067d94d908c1
+```
+
+You should now have matterbridge binary in the ~/go/bin directory:
+
+```bash
+$ ls ~/go/bin/
+matterbridge
+```
+
+## Building with whatsapp (beta) multidevice support
+
+Because the library we use for Whatsapp multidevice support includes a GPL3 library we can not provide you binaries.
+(as this would require the Matterbridge to change it license to GPL)
+
+So this means you have to build it yourself using the instructions below:
+
+```bash
+go install -tags whatsappmulti github.com/42wim/matterbridge@master
+```
+
+If you're low on memory and don't need msteams:
+
+```bash
+go install -tags nomsteams,whatsappmulti github.com/42wim/matterbridge@master
+```
+
 You should now have matterbridge binary in the ~/go/bin directory:
 
 ```bash
@@ -323,6 +364,8 @@ See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ)
 - [nextcloud talk](https://github.com/nextcloud/talk_matterbridge) (Integrates matterbridge in Nextcloud Talk)
 - [mattercraft](https://github.com/raws/mattercraft) (Minecraft bridge)
 - [vs-matterbridge](https://github.com/NikkyAI/vs-matterbridge) (Vintage Story bridge)
+- [ServUO-matterbridge](https://github.com/kuoushi/ServUO-Matterbridge) (A matterbridge connector for ServUO servers)
+- [ts-matterbridge](https://github.com/Archeb/ts-matterbridge) (Integrate teamspeak chat with matterbridge)
 
 ## Articles / Tutorials
 
@@ -356,20 +399,23 @@ Matterbridge wouldn't exist without these libraries:
 - gops - <https://github.com/google/gops>
 - gozulipbot - <https://github.com/ifo/gozulipbot>
 - gumble - <https://github.com/layeh/gumble>
+- harmony - <https://github.com/harmony-development/shibshib>
 - irc - <https://github.com/lrstanley/girc>
 - keybase - <https://github.com/keybase/go-keybase-chat-bot>
 - matrix - <https://github.com/matrix-org/gomatrix>
 - mattermost - <https://github.com/mattermost/mattermost-server>
 - msgraph.go - <https://github.com/yaegashi/msgraph.go>
 - mumble - <https://github.com/layeh/gumble>
 - nctalk - <https://github.com/gary-kim/go-nc-talk>
+- rocketchat - <https://github.com/RocketChat/Rocket.Chat.Go.SDK>
 - slack - <https://github.com/nlopes/slack>
 - sshchat - <https://github.com/shazow/ssh-chat>
 - steam - <https://github.com/Philipp15b/go-steam>
 - telegram - <https://github.com/go-telegram-bot-api/telegram-bot-api>
 - tengo - <https://github.com/d5/tengo>
 - vk - <https://github.com/SevereCloud/vksdk>
 - whatsapp - <https://github.com/Rhymen/go-whatsapp>
+- whatsapp - <https://github.com/tulir/whatsmeow>
 - xmpp - <https://github.com/mattn/go-xmpp>
 - zulip - <https://github.com/ifo/gozulipbot>
 

bridge/irc/charset.go

@@ -0,0 +1,32 @@
+package birc
+
+import (
+	"golang.org/x/text/encoding"
+	"golang.org/x/text/encoding/japanese"
+	"golang.org/x/text/encoding/korean"
+	"golang.org/x/text/encoding/simplifiedchinese"
+	"golang.org/x/text/encoding/traditionalchinese"
+	"golang.org/x/text/encoding/unicode"
+)
+
+var encoders = map[string]encoding.Encoding{
+	"utf-8":       unicode.UTF8,
+	"iso-2022-jp": japanese.ISO2022JP,
+	"big5":        traditionalchinese.Big5,
+	"gbk":         simplifiedchinese.GBK,
+	"euc-kr":      korean.EUCKR,
+	"gb2312":      simplifiedchinese.HZGB2312,
+	"shift-jis":   japanese.ShiftJIS,
+	"euc-jp":      japanese.EUCJP,
+	"gb18030":     simplifiedchinese.GB18030,
+}
+
+func toUTF8(from string, input string) string {
+	enc, ok := encoders[from]
+	if !ok {
+		return input
+	}
+
+	res, _ := enc.NewDecoder().String(input)
+	return res
+}

bridge/irc/handlers.go

@@ -11,7 +11,6 @@ import (
 	"github.com/42wim/matterbridge/bridge/config"
 	"github.com/42wim/matterbridge/bridge/helper"
 	"github.com/lrstanley/girc"
-	"github.com/missdeer/golib/ic"
 	"github.com/paulrosania/go-charset/charset"
 	"github.com/saintfish/chardet"
 
@@ -24,12 +23,12 @@ func (b *Birc) handleCharset(msg *config.Message) error {
 	if b.GetString("Charset") != "" {
 		switch b.GetString("Charset") {
 		case "gbk", "gb18030", "gb2312", "big5", "euc-kr", "euc-jp", "shift-jis", "iso-2022-jp":
-			msg.Text = ic.ConvertString("utf-8", b.GetString("Charset"), msg.Text)
+			msg.Text = toUTF8(b.GetString("Charset"), msg.Text)
 		default:
 			buf := new(bytes.Buffer)
 			w, err := charset.NewWriter(b.GetString("Charset"), buf)
 			if err != nil {
-				b.Log.Errorf("charset from utf-8 conversion failed: %s", err)
+				b.Log.Errorf("charset to utf-8 conversion failed: %s", err)
 				return err
 			}
 			fmt.Fprint(w, msg.Text)
@@ -227,7 +226,7 @@ func (b *Birc) handlePrivMsg(client *girc.Client, event girc.Event) {
 	}
 	switch mycharset {
 	case "gbk", "gb18030", "gb2312", "big5", "euc-kr", "euc-jp", "shift-jis", "iso-2022-jp":
-		rmsg.Text = ic.ConvertString("utf-8", b.GetString("Charset"), rmsg.Text)
+		rmsg.Text = toUTF8(b.GetString("Charset"), rmsg.Text)
 	default:
 		r, err := charset.NewReader(mycharset, strings.NewReader(rmsg.Text))
 		if err != nil {

bridge/matrix/helpers.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 	"time"
 
-	matrix "github.com/matrix-org/gomatrix"
+	matrix "github.com/matterbridge/gomatrix"
 )
 
 func newMatrixUsername(username string) *matrixUsername {

bridge/matrix/matrix.go

@@ -12,7 +12,7 @@ import (
 	"github.com/42wim/matterbridge/bridge"
 	"github.com/42wim/matterbridge/bridge/config"
 	"github.com/42wim/matterbridge/bridge/helper"
-	matrix "github.com/matrix-org/gomatrix"
+	matrix "github.com/matterbridge/gomatrix"
 )
 
 var (

bridge/mumble/codec.go

@@ -0,0 +1,70 @@
+package bmumble
+
+import (
+	"fmt"
+
+	"layeh.com/gumble/gumble"
+)
+
+// This is a dummy implementation of a Gumble audio codec which claims
+// to implement Opus, but does not actually do anything.  This serves
+// as a workaround until https://github.com/layeh/gumble/pull/61 is
+// merged.
+// See https://github.com/42wim/matterbridge/issues/1750 for details.
+
+const (
+	audioCodecIDOpus = 4
+)
+
+func registerNullCodecAsOpus() {
+	codec := &NullCodec{
+		encoder: &NullAudioEncoder{},
+		decoder: &NullAudioDecoder{},
+	}
+	gumble.RegisterAudioCodec(audioCodecIDOpus, codec)
+}
+
+type NullCodec struct {
+	encoder *NullAudioEncoder
+	decoder *NullAudioDecoder
+}
+
+func (c *NullCodec) ID() int {
+	return audioCodecIDOpus
+}
+
+func (c *NullCodec) NewEncoder() gumble.AudioEncoder {
+	e := &NullAudioEncoder{}
+	return e
+}
+
+func (c *NullCodec) NewDecoder() gumble.AudioDecoder {
+	d := &NullAudioDecoder{}
+	return d
+}
+
+type NullAudioEncoder struct{}
+
+func (e *NullAudioEncoder) ID() int {
+	return audioCodecIDOpus
+}
+
+func (e *NullAudioEncoder) Encode(pcm []int16, mframeSize, maxDataBytes int) ([]byte, error) {
+	return nil, fmt.Errorf("not implemented")
+}
+
+func (e *NullAudioEncoder) Reset() {
+}
+
+type NullAudioDecoder struct{}
+
+func (d *NullAudioDecoder) ID() int {
+	return audioCodecIDOpus
+}
+
+func (d *NullAudioDecoder) Decode(data []byte, frameSize int) ([]int16, error) {
+	return nil, fmt.Errorf("not implemented")
+}
+
+func (d *NullAudioDecoder) Reset() {
+}

bridge/mumble/mumble.go

@@ -185,6 +185,7 @@ func (b *Bmumble) doConnect() error {
 		gumbleConfig.Password = password
 	}
 
+	registerNullCodecAsOpus()
 	client, err := gumble.DialWithDialer(new(net.Dialer), b.GetString("Server"), gumbleConfig, &b.tlsConfig)
 	if err != nil {
 		return err