mautrix-whatsapp/config/bridge.go

347 lines
9.3 KiB
Go
Raw Normal View History

// mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
2020-05-08 21:32:22 +02:00
// Copyright (C) 2020 Tulir Asokan
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package config
import (
"bytes"
"strconv"
2018-08-26 21:53:13 +02:00
"strings"
"text/template"
"github.com/Rhymen/go-whatsapp"
2019-01-11 20:17:31 +01:00
2020-05-08 21:32:22 +02:00
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
2019-01-11 20:17:31 +01:00
"maunium.net/go/mautrix-whatsapp/types"
)
type BridgeConfig struct {
UsernameTemplate string `yaml:"username_template"`
DisplaynameTemplate string `yaml:"displayname_template"`
CommunityTemplate string `yaml:"community_template"`
2019-05-17 22:53:57 +02:00
ConnectionTimeout int `yaml:"connection_timeout"`
FetchMessageOnTimeout bool `yaml:"fetch_message_on_timeout"`
DeliveryReceipts bool `yaml:"delivery_receipts"`
LoginQRRegenCount int `yaml:"login_qr_regen_count"`
2019-05-17 22:53:57 +02:00
MaxConnectionAttempts int `yaml:"max_connection_attempts"`
ConnectionRetryDelay int `yaml:"connection_retry_delay"`
2019-05-17 22:53:57 +02:00
ReportConnectionRetry bool `yaml:"report_connection_retry"`
AggressiveReconnect bool `yaml:"aggressive_reconnect"`
2019-08-30 19:57:08 +02:00
ChatListWait int `yaml:"chat_list_wait"`
PortalSyncWait int `yaml:"portal_sync_wait"`
UserMessageBuffer int `yaml:"user_message_buffer"`
PortalMessageBuffer int `yaml:"portal_message_buffer"`
2019-05-16 17:08:30 +02:00
CallNotices struct {
Start bool `yaml:"start"`
End bool `yaml:"end"`
} `yaml:"call_notices"`
InitialChatSync int `yaml:"initial_chat_sync_count"`
InitialHistoryFill int `yaml:"initial_history_fill_count"`
HistoryDisableNotifs bool `yaml:"initial_history_disable_notifications"`
RecoverChatSync int `yaml:"recovery_chat_sync_count"`
RecoverHistory bool `yaml:"recovery_history_backfill"`
SyncChatMaxAge uint64 `yaml:"sync_max_chat_age"`
2020-05-08 21:32:22 +02:00
SyncWithCustomPuppets bool `yaml:"sync_with_custom_puppets"`
SyncDirectChatList bool `yaml:"sync_direct_chat_list"`
DefaultBridgeReceipts bool `yaml:"default_bridge_receipts"`
DefaultBridgePresence bool `yaml:"default_bridge_presence"`
2020-05-08 21:32:22 +02:00
LoginSharedSecret string `yaml:"login_shared_secret"`
InviteOwnPuppetForBackfilling bool `yaml:"invite_own_puppet_for_backfilling"`
PrivateChatPortalMeta bool `yaml:"private_chat_portal_meta"`
ResendBridgeInfo bool `yaml:"resend_bridge_info"`
WhatsappThumbnail bool `yaml:"whatsapp_thumbnail"`
AllowUserInvite bool `yaml:"allow_user_invite"`
CommandPrefix string `yaml:"command_prefix"`
Encryption struct {
Allow bool `yaml:"allow"`
Default bool `yaml:"default"`
2020-08-05 13:58:46 +02:00
KeySharing struct {
Allow bool `yaml:"allow"`
RequireCrossSigning bool `yaml:"require_cross_signing"`
RequireVerification bool `yaml:"require_verification"`
} `yaml:"key_sharing"`
} `yaml:"encryption"`
Permissions PermissionConfig `yaml:"permissions"`
2019-11-10 20:22:11 +01:00
Relaybot RelaybotConfig `yaml:"relaybot"`
usernameTemplate *template.Template `yaml:"-"`
displaynameTemplate *template.Template `yaml:"-"`
communityTemplate *template.Template `yaml:"-"`
}
2019-05-17 22:53:57 +02:00
func (bc *BridgeConfig) setDefaults() {
bc.ConnectionTimeout = 20
bc.FetchMessageOnTimeout = false
bc.DeliveryReceipts = false
bc.LoginQRRegenCount = 2
2019-05-17 22:53:57 +02:00
bc.MaxConnectionAttempts = 3
bc.ConnectionRetryDelay = -1
2019-05-17 22:53:57 +02:00
bc.ReportConnectionRetry = true
2019-08-30 19:57:08 +02:00
bc.ChatListWait = 30
bc.PortalSyncWait = 600
bc.UserMessageBuffer = 1024
bc.PortalMessageBuffer = 128
bc.CallNotices.Start = true
bc.CallNotices.End = true
bc.InitialChatSync = 10
bc.InitialHistoryFill = 20
bc.RecoverChatSync = -1
bc.RecoverHistory = true
bc.SyncChatMaxAge = 259200
bc.SyncWithCustomPuppets = true
bc.DefaultBridgePresence = true
bc.DefaultBridgeReceipts = true
bc.LoginSharedSecret = ""
bc.InviteOwnPuppetForBackfilling = true
bc.PrivateChatPortalMeta = false
2019-05-17 22:53:57 +02:00
}
type umBridgeConfig BridgeConfig
func (bc *BridgeConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
err := unmarshal((*umBridgeConfig)(bc))
if err != nil {
return err
}
bc.usernameTemplate, err = template.New("username").Parse(bc.UsernameTemplate)
if err != nil {
return err
}
bc.displaynameTemplate, err = template.New("displayname").Parse(bc.DisplaynameTemplate)
if err != nil {
return err
}
if len(bc.CommunityTemplate) > 0 {
bc.communityTemplate, err = template.New("community").Parse(bc.CommunityTemplate)
if err != nil {
return err
}
}
return nil
}
type UsernameTemplateArgs struct {
2020-05-08 21:32:22 +02:00
UserID id.UserID
}
func (bc BridgeConfig) FormatDisplayname(contact whatsapp.Contact) (string, int8) {
var buf bytes.Buffer
2018-08-26 21:50:28 +02:00
if index := strings.IndexRune(contact.Jid, '@'); index > 0 {
contact.Jid = "+" + contact.Jid[:index]
}
bc.displaynameTemplate.Execute(&buf, contact)
var quality int8
switch {
case len(contact.Notify) > 0:
quality = 3
case len(contact.Name) > 0 || len(contact.Short) > 0:
quality = 2
case len(contact.Jid) > 0:
quality = 1
default:
quality = 0
}
return buf.String(), quality
}
func (bc BridgeConfig) FormatUsername(userID types.WhatsAppID) string {
var buf bytes.Buffer
bc.usernameTemplate.Execute(&buf, userID)
return buf.String()
}
type CommunityTemplateArgs struct {
Localpart string
Server string
}
func (bc BridgeConfig) EnableCommunities() bool {
return bc.communityTemplate != nil
}
func (bc BridgeConfig) FormatCommunity(localpart, server string) string {
var buf bytes.Buffer
bc.communityTemplate.Execute(&buf, CommunityTemplateArgs{localpart, server})
return buf.String()
}
type PermissionConfig map[string]PermissionLevel
type PermissionLevel int
const (
2019-11-10 20:22:11 +01:00
PermissionLevelDefault PermissionLevel = 0
PermissionLevelRelaybot PermissionLevel = 5
PermissionLevelUser PermissionLevel = 10
PermissionLevelAdmin PermissionLevel = 100
)
func (pc *PermissionConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
rawPC := make(map[string]string)
err := unmarshal(&rawPC)
if err != nil {
return err
}
if *pc == nil {
*pc = make(map[string]PermissionLevel)
}
for key, value := range rawPC {
switch strings.ToLower(value) {
2019-11-10 20:22:11 +01:00
case "relaybot":
(*pc)[key] = PermissionLevelRelaybot
case "user":
(*pc)[key] = PermissionLevelUser
case "admin":
(*pc)[key] = PermissionLevelAdmin
default:
val, err := strconv.Atoi(value)
if err != nil {
(*pc)[key] = PermissionLevelDefault
} else {
(*pc)[key] = PermissionLevel(val)
}
}
}
return nil
}
func (pc *PermissionConfig) MarshalYAML() (interface{}, error) {
if *pc == nil {
return nil, nil
}
rawPC := make(map[string]string)
for key, value := range *pc {
switch value {
2019-11-10 20:22:11 +01:00
case PermissionLevelRelaybot:
rawPC[key] = "relaybot"
case PermissionLevelUser:
rawPC[key] = "user"
case PermissionLevelAdmin:
rawPC[key] = "admin"
default:
rawPC[key] = strconv.Itoa(int(value))
}
}
return rawPC, nil
}
2020-05-08 21:32:22 +02:00
func (pc PermissionConfig) IsRelaybotWhitelisted(userID id.UserID) bool {
2019-11-10 20:22:11 +01:00
return pc.GetPermissionLevel(userID) >= PermissionLevelRelaybot
}
2020-05-08 21:32:22 +02:00
func (pc PermissionConfig) IsWhitelisted(userID id.UserID) bool {
2019-11-10 20:22:11 +01:00
return pc.GetPermissionLevel(userID) >= PermissionLevelUser
}
2020-05-08 21:32:22 +02:00
func (pc PermissionConfig) IsAdmin(userID id.UserID) bool {
2019-11-10 20:22:11 +01:00
return pc.GetPermissionLevel(userID) >= PermissionLevelAdmin
}
2020-05-08 21:32:22 +02:00
func (pc PermissionConfig) GetPermissionLevel(userID id.UserID) PermissionLevel {
permissions, ok := pc[string(userID)]
if ok {
return permissions
}
2020-05-08 21:32:22 +02:00
_, homeserver, _ := userID.Parse()
permissions, ok = pc[homeserver]
if len(homeserver) > 0 && ok {
return permissions
}
permissions, ok = pc["*"]
if ok {
return permissions
}
return PermissionLevelDefault
}
2019-11-10 20:22:11 +01:00
type RelaybotConfig struct {
2020-05-08 21:32:22 +02:00
Enabled bool `yaml:"enabled"`
ManagementRoom id.RoomID `yaml:"management"`
InviteUsers []id.UserID `yaml:"invites"`
2019-11-10 20:22:11 +01:00
2020-05-08 21:32:22 +02:00
MessageFormats map[event.MessageType]string `yaml:"message_formats"`
messageTemplates *template.Template `yaml:"-"`
2019-11-10 20:22:11 +01:00
}
type umRelaybotConfig RelaybotConfig
func (rc *RelaybotConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
err := unmarshal((*umRelaybotConfig)(rc))
if err != nil {
return err
}
rc.messageTemplates = template.New("messageTemplates")
for key, format := range rc.MessageFormats {
_, err := rc.messageTemplates.New(string(key)).Parse(format)
if err != nil {
return err
}
}
return nil
}
type Sender struct {
2020-05-08 21:32:22 +02:00
UserID id.UserID
*event.MemberEventContent
2019-11-10 20:22:11 +01:00
}
type formatData struct {
Sender Sender
Message string
2020-05-08 21:32:22 +02:00
Content *event.MessageEventContent
2019-11-10 20:22:11 +01:00
}
2020-05-08 21:32:22 +02:00
func (rc *RelaybotConfig) FormatMessage(content *event.MessageEventContent, sender id.UserID, member *event.MemberEventContent) (string, error) {
2019-11-10 20:22:11 +01:00
var output strings.Builder
2020-05-08 21:32:22 +02:00
err := rc.messageTemplates.ExecuteTemplate(&output, string(content.MsgType), formatData{
2019-11-10 20:22:11 +01:00
Sender: Sender{
2020-05-08 21:32:22 +02:00
UserID: sender,
MemberEventContent: member,
2019-11-10 20:22:11 +01:00
},
2020-05-08 21:32:22 +02:00
Content: content,
Message: content.FormattedBody,
2019-11-10 20:22:11 +01:00
})
return output.String(), err
}