mirror of
https://github.com/tulir/mautrix-whatsapp
synced 2024-11-12 21:12:41 +01:00
368 lines
10 KiB
Go
368 lines
10 KiB
Go
// mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
|
|
// 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"
|
|
"strings"
|
|
"text/template"
|
|
|
|
"github.com/Rhymen/go-whatsapp"
|
|
|
|
"maunium.net/go/mautrix/event"
|
|
"maunium.net/go/mautrix/id"
|
|
)
|
|
|
|
type BridgeConfig struct {
|
|
UsernameTemplate string `yaml:"username_template"`
|
|
DisplaynameTemplate string `yaml:"displayname_template"`
|
|
CommunityTemplate string `yaml:"community_template"`
|
|
|
|
ConnectionTimeout int `yaml:"connection_timeout"`
|
|
FetchMessageOnTimeout bool `yaml:"fetch_message_on_timeout"`
|
|
DeliveryReceipts bool `yaml:"delivery_receipts"`
|
|
MaxConnectionAttempts int `yaml:"max_connection_attempts"`
|
|
ConnectionRetryDelay int `yaml:"connection_retry_delay"`
|
|
ReportConnectionRetry bool `yaml:"report_connection_retry"`
|
|
AggressiveReconnect bool `yaml:"aggressive_reconnect"`
|
|
ChatListWait int `yaml:"chat_list_wait"`
|
|
PortalSyncWait int `yaml:"portal_sync_wait"`
|
|
UserMessageBuffer int `yaml:"user_message_buffer"`
|
|
PortalMessageBuffer int `yaml:"portal_message_buffer"`
|
|
|
|
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"`
|
|
ChatMetaSync bool `yaml:"chat_meta_sync"`
|
|
UserAvatarSync bool `yaml:"user_avatar_sync"`
|
|
BridgeMatrixLeave bool `yaml:"bridge_matrix_leave"`
|
|
SyncChatMaxAge int64 `yaml:"sync_max_chat_age"`
|
|
|
|
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"`
|
|
LoginSharedSecret string `yaml:"login_shared_secret"`
|
|
|
|
InviteOwnPuppetForBackfilling bool `yaml:"invite_own_puppet_for_backfilling"`
|
|
PrivateChatPortalMeta bool `yaml:"private_chat_portal_meta"`
|
|
BridgeNotices bool `yaml:"bridge_notices"`
|
|
ResendBridgeInfo bool `yaml:"resend_bridge_info"`
|
|
MuteBridging bool `yaml:"mute_bridging"`
|
|
ArchiveTag string `yaml:"archive_tag"`
|
|
PinnedTag string `yaml:"pinned_tag"`
|
|
TagOnlyOnCreate bool `yaml:"tag_only_on_create"`
|
|
MarkReadOnlyOnCreate bool `yaml:"mark_read_only_on_create"`
|
|
EnableStatusBroadcast bool `yaml:"enable_status_broadcast"`
|
|
|
|
WhatsappThumbnail bool `yaml:"whatsapp_thumbnail"`
|
|
|
|
AllowUserInvite bool `yaml:"allow_user_invite"`
|
|
|
|
CommandPrefix string `yaml:"command_prefix"`
|
|
|
|
ManagementRoomText struct {
|
|
Welcome string `yaml:"welcome"`
|
|
WelcomeConnected string `yaml:"welcome_connected"`
|
|
WelcomeUnconnected string `yaml:"welcome_unconnected"`
|
|
AdditionalHelp string `yaml:"additional_help"`
|
|
} `yaml:"management_room_text"`
|
|
|
|
Encryption struct {
|
|
Allow bool `yaml:"allow"`
|
|
Default bool `yaml:"default"`
|
|
|
|
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"`
|
|
|
|
Relaybot RelaybotConfig `yaml:"relaybot"`
|
|
|
|
usernameTemplate *template.Template `yaml:"-"`
|
|
displaynameTemplate *template.Template `yaml:"-"`
|
|
communityTemplate *template.Template `yaml:"-"`
|
|
}
|
|
|
|
func (bc *BridgeConfig) setDefaults() {
|
|
bc.ConnectionTimeout = 20
|
|
bc.FetchMessageOnTimeout = false
|
|
bc.DeliveryReceipts = false
|
|
bc.MaxConnectionAttempts = 3
|
|
bc.ConnectionRetryDelay = -1
|
|
bc.ReportConnectionRetry = true
|
|
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.ChatMetaSync = true
|
|
bc.UserAvatarSync = true
|
|
bc.BridgeMatrixLeave = true
|
|
bc.SyncChatMaxAge = 259200
|
|
|
|
bc.SyncWithCustomPuppets = true
|
|
bc.DefaultBridgePresence = true
|
|
bc.DefaultBridgeReceipts = true
|
|
bc.LoginSharedSecret = ""
|
|
|
|
bc.InviteOwnPuppetForBackfilling = true
|
|
bc.PrivateChatPortalMeta = false
|
|
bc.BridgeNotices = true
|
|
bc.EnableStatusBroadcast = true
|
|
|
|
bc.ManagementRoomText.Welcome = "Hello, I'm a WhatsApp bridge bot."
|
|
bc.ManagementRoomText.WelcomeConnected = "Use `help` for help."
|
|
bc.ManagementRoomText.WelcomeUnconnected = "Use `help` for help or `login` to log in."
|
|
}
|
|
|
|
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 {
|
|
UserID id.UserID
|
|
}
|
|
|
|
func (bc BridgeConfig) FormatDisplayname(contact whatsapp.Contact) (string, int8) {
|
|
var buf bytes.Buffer
|
|
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 || len(contact.VName) > 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 whatsapp.JID) 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 (
|
|
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) {
|
|
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 {
|
|
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
|
|
}
|
|
|
|
func (pc PermissionConfig) IsRelaybotWhitelisted(userID id.UserID) bool {
|
|
return pc.GetPermissionLevel(userID) >= PermissionLevelRelaybot
|
|
}
|
|
|
|
func (pc PermissionConfig) IsWhitelisted(userID id.UserID) bool {
|
|
return pc.GetPermissionLevel(userID) >= PermissionLevelUser
|
|
}
|
|
|
|
func (pc PermissionConfig) IsAdmin(userID id.UserID) bool {
|
|
return pc.GetPermissionLevel(userID) >= PermissionLevelAdmin
|
|
}
|
|
|
|
func (pc PermissionConfig) GetPermissionLevel(userID id.UserID) PermissionLevel {
|
|
permissions, ok := pc[string(userID)]
|
|
if ok {
|
|
return permissions
|
|
}
|
|
|
|
_, homeserver, _ := userID.Parse()
|
|
permissions, ok = pc[homeserver]
|
|
if len(homeserver) > 0 && ok {
|
|
return permissions
|
|
}
|
|
|
|
permissions, ok = pc["*"]
|
|
if ok {
|
|
return permissions
|
|
}
|
|
|
|
return PermissionLevelDefault
|
|
}
|
|
|
|
type RelaybotConfig struct {
|
|
Enabled bool `yaml:"enabled"`
|
|
ManagementRoom id.RoomID `yaml:"management"`
|
|
InviteUsers []id.UserID `yaml:"invites"`
|
|
|
|
MessageFormats map[event.MessageType]string `yaml:"message_formats"`
|
|
messageTemplates *template.Template `yaml:"-"`
|
|
}
|
|
|
|
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 {
|
|
UserID id.UserID
|
|
*event.MemberEventContent
|
|
}
|
|
|
|
type formatData struct {
|
|
Sender Sender
|
|
Message string
|
|
Content *event.MessageEventContent
|
|
}
|
|
|
|
func (rc *RelaybotConfig) FormatMessage(content *event.MessageEventContent, sender id.UserID, member *event.MemberEventContent) (string, error) {
|
|
var output strings.Builder
|
|
err := rc.messageTemplates.ExecuteTemplate(&output, string(content.MsgType), formatData{
|
|
Sender: Sender{
|
|
UserID: sender,
|
|
MemberEventContent: member,
|
|
},
|
|
Content: content,
|
|
Message: content.FormattedBody,
|
|
})
|
|
return output.String(), err
|
|
}
|