forked from MirrorHub/mautrix-whatsapp
550 lines
17 KiB
Go
550 lines
17 KiB
Go
// mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
|
|
// Copyright (C) 2019 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 main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"sort"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/skip2/go-qrcode"
|
|
log "maunium.net/go/maulogger/v2"
|
|
|
|
"maunium.net/go/mautrix"
|
|
"maunium.net/go/mautrix/format"
|
|
|
|
"github.com/Rhymen/go-whatsapp"
|
|
waProto "github.com/Rhymen/go-whatsapp/binary/proto"
|
|
|
|
"maunium.net/go/mautrix-whatsapp/database"
|
|
"maunium.net/go/mautrix-whatsapp/types"
|
|
"maunium.net/go/mautrix-whatsapp/whatsapp-ext"
|
|
)
|
|
|
|
type User struct {
|
|
*database.User
|
|
Conn *whatsappExt.ExtendedConn
|
|
|
|
bridge *Bridge
|
|
log log.Logger
|
|
|
|
Admin bool
|
|
Whitelisted bool
|
|
Connected bool
|
|
|
|
ConnectionErrors int
|
|
}
|
|
|
|
func (bridge *Bridge) GetUserByMXID(userID types.MatrixUserID) *User {
|
|
_, isPuppet := bridge.ParsePuppetMXID(userID)
|
|
if isPuppet || userID == bridge.Bot.UserID {
|
|
return nil
|
|
}
|
|
bridge.usersLock.Lock()
|
|
defer bridge.usersLock.Unlock()
|
|
user, ok := bridge.usersByMXID[userID]
|
|
if !ok {
|
|
dbUser := bridge.DB.User.GetByMXID(userID)
|
|
if dbUser == nil {
|
|
dbUser = bridge.DB.User.New()
|
|
dbUser.MXID = userID
|
|
dbUser.Insert()
|
|
}
|
|
user = bridge.NewUser(dbUser)
|
|
bridge.usersByMXID[user.MXID] = user
|
|
if len(user.JID) > 0 {
|
|
bridge.usersByJID[user.JID] = user
|
|
}
|
|
if len(user.ManagementRoom) > 0 {
|
|
bridge.managementRooms[user.ManagementRoom] = user
|
|
}
|
|
}
|
|
return user
|
|
}
|
|
|
|
func (bridge *Bridge) GetUserByJID(userID types.WhatsAppID) *User {
|
|
bridge.usersLock.Lock()
|
|
defer bridge.usersLock.Unlock()
|
|
user, ok := bridge.usersByJID[userID]
|
|
if !ok {
|
|
dbUser := bridge.DB.User.GetByJID(userID)
|
|
if dbUser == nil {
|
|
return nil
|
|
}
|
|
user = bridge.NewUser(dbUser)
|
|
bridge.usersByMXID[user.MXID] = user
|
|
bridge.usersByJID[user.JID] = user
|
|
if len(user.ManagementRoom) > 0 {
|
|
bridge.managementRooms[user.ManagementRoom] = user
|
|
}
|
|
}
|
|
return user
|
|
}
|
|
|
|
func (bridge *Bridge) GetAllUsers() []*User {
|
|
bridge.usersLock.Lock()
|
|
defer bridge.usersLock.Unlock()
|
|
dbUsers := bridge.DB.User.GetAll()
|
|
output := make([]*User, len(dbUsers))
|
|
for index, dbUser := range dbUsers {
|
|
user, ok := bridge.usersByMXID[dbUser.MXID]
|
|
if !ok {
|
|
user = bridge.NewUser(dbUser)
|
|
bridge.usersByMXID[user.MXID] = user
|
|
if len(user.JID) > 0 {
|
|
bridge.usersByJID[user.JID] = user
|
|
}
|
|
if len(user.ManagementRoom) > 0 {
|
|
bridge.managementRooms[user.ManagementRoom] = user
|
|
}
|
|
}
|
|
output[index] = user
|
|
}
|
|
return output
|
|
}
|
|
|
|
func (bridge *Bridge) NewUser(dbUser *database.User) *User {
|
|
user := &User{
|
|
User: dbUser,
|
|
bridge: bridge,
|
|
log: bridge.Log.Sub("User").Sub(string(dbUser.MXID)),
|
|
}
|
|
user.Whitelisted = user.bridge.Config.Bridge.Permissions.IsWhitelisted(user.MXID)
|
|
user.Admin = user.bridge.Config.Bridge.Permissions.IsAdmin(user.MXID)
|
|
return user
|
|
}
|
|
|
|
func (user *User) SetManagementRoom(roomID types.MatrixRoomID) {
|
|
existingUser, ok := user.bridge.managementRooms[roomID]
|
|
if ok {
|
|
existingUser.ManagementRoom = ""
|
|
existingUser.Update()
|
|
}
|
|
|
|
user.ManagementRoom = roomID
|
|
user.bridge.managementRooms[user.ManagementRoom] = user
|
|
user.Update()
|
|
}
|
|
|
|
func (user *User) SetSession(session *whatsapp.Session) {
|
|
user.Session = session
|
|
if session == nil {
|
|
user.LastConnection = 0
|
|
}
|
|
user.Update()
|
|
}
|
|
|
|
func (user *User) Connect(evenIfNoSession bool) bool {
|
|
if user.Conn != nil {
|
|
return true
|
|
} else if !evenIfNoSession && user.Session == nil {
|
|
return false
|
|
}
|
|
user.log.Debugln("Connecting to WhatsApp")
|
|
timeout := time.Duration(user.bridge.Config.Bridge.ConnectionTimeout)
|
|
if timeout == 0 {
|
|
timeout = 20
|
|
}
|
|
conn, err := whatsapp.NewConn(timeout * time.Second)
|
|
if err != nil {
|
|
user.log.Errorln("Failed to connect to WhatsApp:", err)
|
|
msg := format.RenderMarkdown(fmt.Sprintf("\u26a0 Failed to connect to WhatsApp server. " +
|
|
"This indicates a network problem on the bridge server. See bridge logs for more info."))
|
|
_, _ = user.bridge.Bot.SendMessageEvent(user.ManagementRoom, mautrix.EventMessage, msg)
|
|
return false
|
|
}
|
|
user.Conn = whatsappExt.ExtendConn(conn)
|
|
_ = user.Conn.SetClientName("Mautrix-WhatsApp bridge", "mx-wa")
|
|
user.log.Debugln("WhatsApp connection successful")
|
|
user.Conn.AddHandler(user)
|
|
return user.RestoreSession()
|
|
}
|
|
|
|
func (user *User) RestoreSession() bool {
|
|
if user.Session != nil {
|
|
sess, err := user.Conn.RestoreWithSession(*user.Session)
|
|
if err == whatsapp.ErrAlreadyLoggedIn {
|
|
return true
|
|
} else if err != nil {
|
|
user.log.Errorln("Failed to restore session:", err)
|
|
msg := format.RenderMarkdown(fmt.Sprintf("\u26a0 Failed to connect to WhatsApp. Make sure WhatsApp "+
|
|
"on your phone is reachable and use `%s reconnect` to try connecting again.",
|
|
user.bridge.Config.Bridge.CommandPrefix))
|
|
_, _ = user.bridge.Bot.SendMessageEvent(user.ManagementRoom, mautrix.EventMessage, msg)
|
|
return false
|
|
}
|
|
user.Connected = true
|
|
user.ConnectionErrors = 0
|
|
user.SetSession(&sess)
|
|
user.log.Debugln("Session restored successfully")
|
|
go user.PostLogin()
|
|
}
|
|
return true
|
|
}
|
|
|
|
func (user *User) IsLoggedIn() bool {
|
|
return user.Conn != nil
|
|
}
|
|
|
|
func (user *User) Login(ce *CommandEvent) {
|
|
qrChan := make(chan string, 2)
|
|
go func() {
|
|
code := <-qrChan
|
|
if code == "error" {
|
|
return
|
|
}
|
|
qrCode, err := qrcode.Encode(code, qrcode.Low, 256)
|
|
if err != nil {
|
|
user.log.Errorln("Failed to encode QR code:", err)
|
|
ce.Reply("Failed to encode QR code: %v", err)
|
|
return
|
|
}
|
|
|
|
bot := user.bridge.AS.BotClient()
|
|
|
|
resp, err := bot.UploadBytes(qrCode, "image/png")
|
|
if err != nil {
|
|
user.log.Errorln("Failed to upload QR code:", err)
|
|
ce.Reply("Failed to upload QR code: %v", err)
|
|
return
|
|
}
|
|
|
|
_, err = bot.SendImage(ce.RoomID, string(code), resp.ContentURI)
|
|
if err != nil {
|
|
user.log.Errorln("Failed to send QR code to user:", err)
|
|
}
|
|
}()
|
|
session, err := user.Conn.Login(qrChan)
|
|
if err != nil {
|
|
qrChan <- "error"
|
|
if err == whatsapp.ErrAlreadyLoggedIn {
|
|
ce.Reply("You're already logged in.")
|
|
} else if err == whatsapp.ErrLoginInProgress {
|
|
ce.Reply("You have a login in progress already.")
|
|
} else if err.Error() == "qr code scan timed out" {
|
|
ce.Reply("QR code scan timed out. Please try again.")
|
|
} else {
|
|
user.log.Warnln("Failed to log in:", err)
|
|
ce.Reply("Unknown error while logging in: %v", err)
|
|
}
|
|
return
|
|
}
|
|
user.Connected = true
|
|
user.ConnectionErrors = 0
|
|
user.JID = strings.Replace(user.Conn.Info.Wid, whatsappExt.OldUserSuffix, whatsappExt.NewUserSuffix, 1)
|
|
user.SetSession(&session)
|
|
ce.Reply("Successfully logged in, synchronizing chats...")
|
|
go user.PostLogin()
|
|
}
|
|
|
|
type Chat struct {
|
|
Portal *Portal
|
|
LastMessageTime uint64
|
|
Contact whatsapp.Contact
|
|
}
|
|
|
|
type ChatList []Chat
|
|
|
|
func (cl ChatList) Len() int {
|
|
return len(cl)
|
|
}
|
|
|
|
func (cl ChatList) Less(i, j int) bool {
|
|
return cl[i].LastMessageTime < cl[i].LastMessageTime
|
|
}
|
|
|
|
func (cl ChatList) Swap(i, j int) {
|
|
cl[i], cl[j] = cl[j], cl[i]
|
|
}
|
|
|
|
func (user *User) PostLogin() {
|
|
user.log.Debugln("Waiting for 3 seconds for contacts to arrive")
|
|
// Hacky way to wait for chats and contacts to arrive automatically
|
|
time.Sleep(3 * time.Second)
|
|
user.log.Debugln("Waited 3 seconds:", len(user.Conn.Store.Chats), len(user.Conn.Store.Contacts))
|
|
|
|
go user.syncPortals()
|
|
go user.syncPuppets()
|
|
}
|
|
|
|
func (user *User) syncPortals() {
|
|
var chats ChatList
|
|
for _, chat := range user.Conn.Store.Chats {
|
|
ts, err := strconv.ParseUint(chat.LastMessageTime, 10, 64)
|
|
if err != nil {
|
|
user.log.Warnfln("Non-integer last message time in %s: %s", chat.Jid, chat.LastMessageTime)
|
|
continue
|
|
}
|
|
chats = append(chats, Chat{
|
|
Portal: user.GetPortalByJID(chat.Jid),
|
|
Contact: user.Conn.Store.Contacts[chat.Jid],
|
|
LastMessageTime: ts,
|
|
})
|
|
}
|
|
sort.Sort(chats)
|
|
limit := user.bridge.Config.Bridge.InitialChatSync
|
|
if limit < 0 {
|
|
limit = len(chats)
|
|
}
|
|
for i, chat := range chats {
|
|
create := (chat.LastMessageTime >= user.LastConnection && user.LastConnection > 0) || i < limit
|
|
if len(chat.Portal.MXID) > 0 || create {
|
|
chat.Portal.Sync(user, chat.Contact)
|
|
err := chat.Portal.BackfillHistory(user)
|
|
if err != nil {
|
|
chat.Portal.log.Errorln("Error backfilling history:", err)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (user *User) syncPuppets() {
|
|
for jid, contact := range user.Conn.Store.Contacts {
|
|
if strings.HasSuffix(jid, whatsappExt.NewUserSuffix) {
|
|
puppet := user.bridge.GetPuppetByJID(contact.Jid)
|
|
puppet.Sync(user, contact)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (user *User) updateLastConnectionIfNecessary() {
|
|
if user.LastConnection+60 < uint64(time.Now().Unix()) {
|
|
user.UpdateLastConnection()
|
|
}
|
|
}
|
|
|
|
func (user *User) HandleError(err error) {
|
|
user.log.Errorln("WhatsApp error:", err)
|
|
var msg string
|
|
if closed, ok := err.(*whatsapp.ErrConnectionClosed); ok {
|
|
user.Connected = false
|
|
if closed.Code == 1000 {
|
|
// Normal closure
|
|
return
|
|
}
|
|
user.ConnectionErrors++
|
|
msg = fmt.Sprintf("Your WhatsApp connection was closed with websocket status code %d", closed.Code)
|
|
} else if failed, ok := err.(*whatsapp.ErrConnectionFailed); ok {
|
|
user.Connected = false
|
|
user.ConnectionErrors++
|
|
msg = fmt.Sprintf("Your WhatsApp connection failed: %v", failed.Err)
|
|
} else {
|
|
// Unknown error, probably mostly harmless
|
|
return
|
|
}
|
|
if user.ConnectionErrors > user.bridge.Config.Bridge.MaxConnectionAttempts {
|
|
content := format.RenderMarkdown(fmt.Sprintf("%s. Use the `reconnect` command to reconnect.", msg))
|
|
_, _ = user.bridge.Bot.SendMessageEvent(user.ManagementRoom, mautrix.EventMessage, content)
|
|
return
|
|
}
|
|
if user.bridge.Config.Bridge.ReportConnectionRetry {
|
|
_, _ = user.bridge.Bot.SendNotice(user.ManagementRoom, fmt.Sprintf("%s. Reconnecting...", msg))
|
|
// Don't want the same error to be repeated
|
|
msg = ""
|
|
}
|
|
tries := 0
|
|
for user.ConnectionErrors <= user.bridge.Config.Bridge.MaxConnectionAttempts {
|
|
err = user.Conn.Restore()
|
|
if err == nil {
|
|
user.ConnectionErrors = 0
|
|
user.Connected = true
|
|
_, _ = user.bridge.Bot.SendNotice(user.ManagementRoom, "Reconnected successfully")
|
|
go user.PostLogin()
|
|
return
|
|
}
|
|
user.log.Errorln("Error while trying to reconnect after disconnection:", err)
|
|
tries++
|
|
user.ConnectionErrors++
|
|
if user.ConnectionErrors <= user.bridge.Config.Bridge.MaxConnectionAttempts {
|
|
if user.bridge.Config.Bridge.ReportConnectionRetry {
|
|
_, _ = user.bridge.Bot.SendNotice(user.ManagementRoom,
|
|
fmt.Sprintf("Reconnection attempt failed: %v. Retrying in 10 seconds...", err))
|
|
}
|
|
time.Sleep(10 * time.Second)
|
|
}
|
|
}
|
|
|
|
if user.bridge.Config.Bridge.ReportConnectionRetry {
|
|
msg = fmt.Sprintf("%d reconnection attempts failed. Use the `reconnect` command to try to reconnect manually.", tries)
|
|
} else {
|
|
msg = fmt.Sprintf("\u26a0 %sAdditionally, %d reconnection attempts failed. "+
|
|
"Use the `reconnect` command to try to reconnect.", msg, tries)
|
|
}
|
|
|
|
content := format.RenderMarkdown(msg)
|
|
_, _ = user.bridge.Bot.SendMessageEvent(user.ManagementRoom, mautrix.EventMessage, content)
|
|
}
|
|
|
|
func (user *User) ShouldCallSynchronously() bool {
|
|
return true
|
|
}
|
|
|
|
func (user *User) HandleJSONParseError(err error) {
|
|
user.log.Errorln("WhatsApp JSON parse error:", err)
|
|
}
|
|
|
|
func (user *User) PortalKey(jid types.WhatsAppID) database.PortalKey {
|
|
return database.NewPortalKey(jid, user.JID)
|
|
}
|
|
|
|
func (user *User) GetPortalByJID(jid types.WhatsAppID) *Portal {
|
|
return user.bridge.GetPortalByJID(user.PortalKey(jid))
|
|
}
|
|
|
|
func (user *User) HandleTextMessage(message whatsapp.TextMessage) {
|
|
user.GetPortalByJID(message.Info.RemoteJid).messages <- PortalMessage{user, message, message.Info.Timestamp}
|
|
}
|
|
|
|
func (user *User) HandleImageMessage(message whatsapp.ImageMessage) {
|
|
user.GetPortalByJID(message.Info.RemoteJid).messages <- PortalMessage{user, message, message.Info.Timestamp}
|
|
}
|
|
|
|
func (user *User) HandleVideoMessage(message whatsapp.VideoMessage) {
|
|
user.GetPortalByJID(message.Info.RemoteJid).messages <- PortalMessage{user, message, message.Info.Timestamp}
|
|
}
|
|
|
|
func (user *User) HandleAudioMessage(message whatsapp.AudioMessage) {
|
|
user.GetPortalByJID(message.Info.RemoteJid).messages <- PortalMessage{user, message, message.Info.Timestamp}
|
|
}
|
|
|
|
func (user *User) HandleDocumentMessage(message whatsapp.DocumentMessage) {
|
|
user.GetPortalByJID(message.Info.RemoteJid).messages <- PortalMessage{user, message, message.Info.Timestamp}
|
|
}
|
|
|
|
func (user *User) HandleMessageRevoke(message whatsappExt.MessageRevocation) {
|
|
user.GetPortalByJID(message.RemoteJid).messages <- PortalMessage{user, message, 0}
|
|
}
|
|
|
|
func (user *User) HandlePresence(info whatsappExt.Presence) {
|
|
puppet := user.bridge.GetPuppetByJID(info.SenderJID)
|
|
switch info.Status {
|
|
case whatsappExt.PresenceUnavailable:
|
|
puppet.Intent().SetPresence("offline")
|
|
case whatsappExt.PresenceAvailable:
|
|
if len(puppet.typingIn) > 0 && puppet.typingAt+15 > time.Now().Unix() {
|
|
puppet.Intent().UserTyping(puppet.typingIn, false, 0)
|
|
puppet.typingIn = ""
|
|
puppet.typingAt = 0
|
|
} else {
|
|
puppet.Intent().SetPresence("online")
|
|
}
|
|
case whatsappExt.PresenceComposing:
|
|
portal := user.GetPortalByJID(info.JID)
|
|
if len(puppet.typingIn) > 0 && puppet.typingAt+15 > time.Now().Unix() {
|
|
if puppet.typingIn == portal.MXID {
|
|
return
|
|
}
|
|
puppet.Intent().UserTyping(puppet.typingIn, false, 0)
|
|
}
|
|
puppet.typingIn = portal.MXID
|
|
puppet.typingAt = time.Now().Unix()
|
|
puppet.Intent().UserTyping(portal.MXID, true, 15*1000)
|
|
}
|
|
}
|
|
|
|
func (user *User) HandleMsgInfo(info whatsappExt.MsgInfo) {
|
|
if (info.Command == whatsappExt.MsgInfoCommandAck || info.Command == whatsappExt.MsgInfoCommandAcks) && info.Acknowledgement == whatsappExt.AckMessageRead {
|
|
portal := user.GetPortalByJID(info.ToJID)
|
|
if len(portal.MXID) == 0 {
|
|
return
|
|
}
|
|
|
|
go func() {
|
|
intent := user.bridge.GetPuppetByJID(info.SenderJID).Intent()
|
|
for _, id := range info.IDs {
|
|
msg := user.bridge.DB.Message.GetByJID(portal.Key, id)
|
|
if msg == nil {
|
|
continue
|
|
}
|
|
|
|
err := intent.MarkRead(portal.MXID, msg.MXID)
|
|
if err != nil {
|
|
user.log.Warnln("Failed to mark message %s as read by %s: %v", msg.MXID, info.SenderJID, err)
|
|
}
|
|
}
|
|
}()
|
|
}
|
|
}
|
|
|
|
func (user *User) HandleCommand(cmd whatsappExt.Command) {
|
|
switch cmd.Type {
|
|
case whatsappExt.CommandPicture:
|
|
if strings.HasSuffix(cmd.JID, whatsappExt.NewUserSuffix) {
|
|
puppet := user.bridge.GetPuppetByJID(cmd.JID)
|
|
go puppet.UpdateAvatar(user, cmd.ProfilePicInfo)
|
|
} else {
|
|
portal := user.GetPortalByJID(cmd.JID)
|
|
go portal.UpdateAvatar(user, cmd.ProfilePicInfo)
|
|
}
|
|
case whatsappExt.CommandDisconnect:
|
|
var msg string
|
|
if cmd.Kind == "replaced" {
|
|
msg = "\u26a0 Your WhatsApp connection was closed by the server because you opened another WhatsApp Web client.\n\n" +
|
|
"Use the `reconnect` command to disconnect the other client and resume bridging."
|
|
} else {
|
|
user.log.Warnln("Unknown kind of disconnect:", string(cmd.Raw))
|
|
msg = fmt.Sprintf("\u26a0 Your WhatsApp connection was closed by the server (reason code: %s).\n\n"+
|
|
"Use the `reconnect` command to reconnect.", cmd.Kind)
|
|
}
|
|
go user.bridge.Bot.SendMessageEvent(user.ManagementRoom, mautrix.EventMessage, format.RenderMarkdown(msg))
|
|
}
|
|
}
|
|
|
|
func (user *User) HandleChatUpdate(cmd whatsappExt.ChatUpdate) {
|
|
if cmd.Command != whatsappExt.ChatUpdateCommandAction {
|
|
return
|
|
}
|
|
|
|
portal := user.GetPortalByJID(cmd.JID)
|
|
if len(portal.MXID) == 0 {
|
|
return
|
|
}
|
|
|
|
switch cmd.Data.Action {
|
|
case whatsappExt.ChatActionNameChange:
|
|
go portal.UpdateName(cmd.Data.NameChange.Name, cmd.Data.SenderJID)
|
|
case whatsappExt.ChatActionAddTopic:
|
|
go portal.UpdateTopic(cmd.Data.AddTopic.Topic, cmd.Data.SenderJID)
|
|
case whatsappExt.ChatActionRemoveTopic:
|
|
go portal.UpdateTopic("", cmd.Data.SenderJID)
|
|
case whatsappExt.ChatActionPromote:
|
|
go portal.ChangeAdminStatus(cmd.Data.PermissionChange.JIDs, true)
|
|
case whatsappExt.ChatActionDemote:
|
|
go portal.ChangeAdminStatus(cmd.Data.PermissionChange.JIDs, false)
|
|
case whatsappExt.ChatActionAnnounce:
|
|
go portal.RestrictMessageSending(cmd.Data.Announce)
|
|
case whatsappExt.ChatActionRestrict:
|
|
go portal.RestrictMetadataChanges(cmd.Data.Restrict)
|
|
}
|
|
}
|
|
|
|
func (user *User) HandleJsonMessage(message string) {
|
|
var msg json.RawMessage
|
|
err := json.Unmarshal([]byte(message), &msg)
|
|
if err != nil {
|
|
return
|
|
}
|
|
user.log.Debugln("JSON message:", message)
|
|
user.updateLastConnectionIfNecessary()
|
|
}
|
|
|
|
func (user *User) HandleRawMessage(message *waProto.WebMessageInfo) {
|
|
user.updateLastConnectionIfNecessary()
|
|
}
|