// 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 . package main import ( "fmt" "math" "sort" "strconv" "strings" "github.com/Rhymen/go-whatsapp" "maunium.net/go/maulogger/v2" "maunium.net/go/mautrix" "maunium.net/go/mautrix/appservice" "maunium.net/go/mautrix/event" "maunium.net/go/mautrix/format" "maunium.net/go/mautrix/id" "maunium.net/go/mautrix-whatsapp/database" "maunium.net/go/mautrix-whatsapp/whatsapp-ext" ) type CommandHandler struct { bridge *Bridge log maulogger.Logger } // NewCommandHandler creates a CommandHandler func NewCommandHandler(bridge *Bridge) *CommandHandler { return &CommandHandler{ bridge: bridge, log: bridge.Log.Sub("Command handler"), } } // CommandEvent stores all data which might be used to handle commands type CommandEvent struct { Bot *appservice.IntentAPI Bridge *Bridge Handler *CommandHandler RoomID id.RoomID User *User Command string Args []string } // Reply sends a reply to command as notice func (ce *CommandEvent) Reply(msg string, args ...interface{}) { content := format.RenderMarkdown(fmt.Sprintf(msg, args...), true, false) content.MsgType = event.MsgNotice room := ce.User.ManagementRoom if len(room) == 0 { room = ce.RoomID } _, err := ce.Bot.SendMessageEvent(room, event.EventMessage, content) if err != nil { ce.Handler.log.Warnfln("Failed to reply to command from %s: %v", ce.User.MXID, err) } } // Handle handles messages to the bridge func (handler *CommandHandler) Handle(roomID id.RoomID, user *User, message string) { args := strings.Fields(message) ce := &CommandEvent{ Bot: handler.bridge.Bot, Bridge: handler.bridge, Handler: handler, RoomID: roomID, User: user, Command: strings.ToLower(args[0]), Args: args[1:], } handler.log.Debugfln("%s sent '%s' in %s", user.MXID, message, roomID) if roomID == handler.bridge.Config.Bridge.Relaybot.ManagementRoom { handler.CommandRelaybot(ce) } else { handler.CommandMux(ce) } } func (handler *CommandHandler) CommandMux(ce *CommandEvent) { switch ce.Command { case "relaybot": handler.CommandRelaybot(ce) case "login": handler.CommandLogin(ce) case "logout-matrix": handler.CommandLogoutMatrix(ce) case "help": handler.CommandHelp(ce) case "version": handler.CommandVersion(ce) case "reconnect": handler.CommandReconnect(ce) case "disconnect": handler.CommandDisconnect(ce) case "ping": handler.CommandPing(ce) case "delete-connection": handler.CommandDeleteConnection(ce) case "delete-session": handler.CommandDeleteSession(ce) case "delete-portal": handler.CommandDeletePortal(ce) case "delete-all-portals": handler.CommandDeleteAllPortals(ce) case "dev-test": handler.CommandDevTest(ce) case "set-pl": handler.CommandSetPowerLevel(ce) case "logout": handler.CommandLogout(ce) case "login-matrix", "sync", "list", "open", "pm": if !ce.User.HasSession() { ce.Reply("You are not logged in. Use the `login` command to log into WhatsApp.") return } else if !ce.User.IsConnected() { ce.Reply("You are not connected to WhatsApp. Use the `reconnect` command to reconnect.") return } switch ce.Command { case "login-matrix": handler.CommandLoginMatrix(ce) case "sync": handler.CommandSync(ce) case "list": handler.CommandList(ce) case "open": handler.CommandOpen(ce) case "pm": handler.CommandPM(ce) } default: ce.Reply("Unknown Command") } } func (handler *CommandHandler) CommandRelaybot(ce *CommandEvent) { if handler.bridge.Relaybot == nil { ce.Reply("The relaybot is disabled") } else if !ce.User.Admin { ce.Reply("Only admins can manage the relaybot") } else { if ce.Command == "relaybot" { if len(ce.Args) == 0 { ce.Reply("**Usage:** `relaybot `") return } ce.Command = strings.ToLower(ce.Args[0]) ce.Args = ce.Args[1:] } ce.User = handler.bridge.Relaybot handler.CommandMux(ce) } } func (handler *CommandHandler) CommandDevTest(_ *CommandEvent) { } const cmdVersionHelp = `version - View the bridge version` func (handler *CommandHandler) CommandVersion(ce *CommandEvent) { version := fmt.Sprintf("%s.unknown", Version) if Tag == Version { version = fmt.Sprintf("[%s](%s/releases/%s) (%s)", Version, URL, Tag, BuildTime) } else if len(Commit) > 8 { version = fmt.Sprintf("%s.[%s](%s/commit/%s) (%s)", Version, Commit[:8], URL, Commit, BuildTime) } ce.Reply(fmt.Sprintf("[%s](%s) %s", Name, URL, version)) } const cmdSetPowerLevelHelp = `set-pl [user ID] - Change the power level in a portal room. Only for bridge admins.` func (handler *CommandHandler) CommandSetPowerLevel(ce *CommandEvent) { portal := ce.Bridge.GetPortalByMXID(ce.RoomID) if portal == nil { ce.Reply("Not a portal room") return } var level int var userID id.UserID var err error if len(ce.Args) == 1 { level, err = strconv.Atoi(ce.Args[0]) if err != nil { ce.Reply("Invalid power level \"%s\"", ce.Args[0]) return } userID = ce.User.MXID } else if len(ce.Args) == 2 { userID = id.UserID(ce.Args[0]) _, _, err := userID.Parse() if err != nil { ce.Reply("Invalid user ID \"%s\"", ce.Args[0]) return } level, err = strconv.Atoi(ce.Args[1]) if err != nil { ce.Reply("Invalid power level \"%s\"", ce.Args[1]) return } } else { ce.Reply("**Usage:** `set-pl [user] `") return } intent := portal.MainIntent() _, err = intent.SetPowerLevel(ce.RoomID, userID, level) if err != nil { ce.Reply("Failed to set power levels: %v", err) } } const cmdLoginHelp = `login - Authenticate this Bridge as WhatsApp Web Client` // CommandLogin handles login command func (handler *CommandHandler) CommandLogin(ce *CommandEvent) { if !ce.User.Connect(true) { ce.User.log.Debugln("Connect() returned false, assuming error was logged elsewhere and canceling login.") return } ce.User.Login(ce) } const cmdLogoutHelp = `logout - Logout from WhatsApp` // CommandLogout handles !logout command func (handler *CommandHandler) CommandLogout(ce *CommandEvent) { if ce.User.Session == nil { ce.Reply("You're not logged in.") return } else if !ce.User.IsConnected() { ce.Reply("You are not connected to WhatsApp. Use the `reconnect` command to reconnect, or `delete-session` to forget all login information.") return } puppet := handler.bridge.GetPuppetByJID(ce.User.JID) if puppet.CustomMXID != "" { err := puppet.SwitchCustomMXID("", "") if err != nil { ce.User.log.Warnln("Failed to logout-matrix while logging out of WhatsApp:", err) } } err := ce.User.Conn.Logout() if err != nil { ce.User.log.Warnln("Error while logging out:", err) ce.Reply("Unknown error while logging out: %v", err) return } _, err = ce.User.Conn.Disconnect() if err != nil { ce.User.log.Warnln("Error while disconnecting after logout:", err) } ce.User.Conn.RemoveHandlers() ce.User.Conn = nil ce.User.removeFromJIDMap() // TODO this causes a foreign key violation, which should be fixed //ce.User.JID = "" ce.User.SetSession(nil) ce.Reply("Logged out successfully.") } const cmdDeleteSessionHelp = `delete-session - Delete session information and disconnect from WhatsApp without sending a logout request` func (handler *CommandHandler) CommandDeleteSession(ce *CommandEvent) { if ce.User.Session == nil && ce.User.Conn == nil { ce.Reply("Nothing to purge: no session information stored and no active connection.") return } ce.User.SetSession(nil) if ce.User.Conn != nil { _, _ = ce.User.Conn.Disconnect() ce.User.Conn.RemoveHandlers() ce.User.Conn = nil } ce.Reply("Session information purged") } const cmdReconnectHelp = `reconnect - Reconnect to WhatsApp` func (handler *CommandHandler) CommandReconnect(ce *CommandEvent) { if ce.User.Conn == nil { if ce.User.Session == nil { ce.Reply("No existing connection and no session. Did you mean `login`?") } else { ce.Reply("No existing connection, creating one...") ce.User.Connect(false) } return } wasConnected := true sess, err := ce.User.Conn.Disconnect() if err == whatsapp.ErrNotConnected { wasConnected = false } else if err != nil { ce.User.log.Warnln("Error while disconnecting:", err) } else if len(sess.Wid) > 0 { ce.User.SetSession(&sess) } err = ce.User.Conn.Restore() if err == whatsapp.ErrInvalidSession { if ce.User.Session != nil { ce.User.log.Debugln("Got invalid session error when reconnecting, but user has session. Retrying using RestoreWithSession()...") var sess whatsapp.Session sess, err = ce.User.Conn.RestoreWithSession(*ce.User.Session) if err == nil { ce.User.SetSession(&sess) } } else { ce.Reply("You are not logged in.") return } } else if err == whatsapp.ErrLoginInProgress { ce.Reply("A login or reconnection is already in progress.") return } else if err == whatsapp.ErrAlreadyLoggedIn { ce.Reply("You were already connected.") return } if err != nil { ce.User.log.Warnln("Error while reconnecting:", err) if err.Error() == "restore session connection timed out" { ce.Reply("Reconnection timed out. Is WhatsApp on your phone reachable?") } else { ce.Reply("Unknown error while reconnecting: %v", err) } ce.User.log.Debugln("Disconnecting due to failed session restore in reconnect command...") sess, err := ce.User.Conn.Disconnect() if err != nil { ce.User.log.Errorln("Failed to disconnect after failed session restore in reconnect command:", err) } else if len(sess.Wid) > 0 { ce.User.SetSession(&sess) } return } ce.User.ConnectionErrors = 0 var msg string if wasConnected { msg = "Reconnected successfully." } else { msg = "Connected successfully." } ce.Reply(msg) ce.User.PostLogin() } const cmdDeleteConnectionHelp = `delete-connection - Disconnect ignoring errors and delete internal connection state.` func (handler *CommandHandler) CommandDeleteConnection(ce *CommandEvent) { if ce.User.Conn == nil { ce.Reply("You don't have a WhatsApp connection.") return } sess, err := ce.User.Conn.Disconnect() if err == nil && len(sess.Wid) > 0 { ce.User.SetSession(&sess) } ce.User.Conn.RemoveHandlers() ce.User.Conn = nil ce.Reply("Successfully disconnected. Use the `reconnect` command to reconnect.") } const cmdDisconnectHelp = `disconnect - Disconnect from WhatsApp (without logging out)` func (handler *CommandHandler) CommandDisconnect(ce *CommandEvent) { if ce.User.Conn == nil { ce.Reply("You don't have a WhatsApp connection.") return } sess, err := ce.User.Conn.Disconnect() if err == whatsapp.ErrNotConnected { ce.Reply("You were not connected.") return } else if err != nil { ce.User.log.Warnln("Error while disconnecting:", err) ce.Reply("Unknown error while disconnecting: %v", err) return } else if len(sess.Wid) > 0 { ce.User.SetSession(&sess) } ce.Reply("Successfully disconnected. Use the `reconnect` command to reconnect.") } const cmdPingHelp = `ping - Check your connection to WhatsApp.` func (handler *CommandHandler) CommandPing(ce *CommandEvent) { if ce.User.Session == nil { if ce.User.IsLoginInProgress() { ce.Reply("You're not logged into WhatsApp, but there's a login in progress.") } else { ce.Reply("You're not logged into WhatsApp.") } } else if ce.User.Conn == nil { ce.Reply("You don't have a WhatsApp connection.") } else if ok, err := ce.User.Conn.AdminTest(); err != nil { if ce.User.IsLoginInProgress() { ce.Reply("Connection not OK: %v, but login in progress", err) } else { ce.Reply("Connection not OK: %v", err) } } else if !ok { if ce.User.IsLoginInProgress() { ce.Reply("Connection not OK, but no error received and login in progress") } else { ce.Reply("Connection not OK, but no error received") } } else { ce.Reply("Connection to WhatsApp OK") } } const cmdHelpHelp = `help - Prints this help` // CommandHelp handles help command func (handler *CommandHandler) CommandHelp(ce *CommandEvent) { cmdPrefix := "" if ce.User.ManagementRoom != ce.RoomID || ce.User.IsRelaybot { cmdPrefix = handler.bridge.Config.Bridge.CommandPrefix + " " } ce.Reply("* " + strings.Join([]string{ cmdPrefix + cmdHelpHelp, cmdPrefix + cmdLoginHelp, cmdPrefix + cmdLogoutHelp, cmdPrefix + cmdDeleteSessionHelp, cmdPrefix + cmdReconnectHelp, cmdPrefix + cmdDisconnectHelp, cmdPrefix + cmdDeleteConnectionHelp, cmdPrefix + cmdPingHelp, cmdPrefix + cmdLoginMatrixHelp, cmdPrefix + cmdLogoutMatrixHelp, cmdPrefix + cmdSyncHelp, cmdPrefix + cmdListHelp, cmdPrefix + cmdOpenHelp, cmdPrefix + cmdPMHelp, cmdPrefix + cmdSetPowerLevelHelp, cmdPrefix + cmdDeletePortalHelp, cmdPrefix + cmdDeleteAllPortalsHelp, }, "\n* ")) } const cmdSyncHelp = `sync [--create-all] - Synchronize contacts from phone and optionally create portals for group chats.` // CommandSync handles sync command func (handler *CommandHandler) CommandSync(ce *CommandEvent) { user := ce.User create := len(ce.Args) > 0 && ce.Args[0] == "--create-all" ce.Reply("Updating contact and chat list...") handler.log.Debugln("Importing contacts of", user.MXID) _, err := user.Conn.Contacts() if err != nil { user.log.Errorln("Error updating contacts:", err) ce.Reply("Failed to sync contact list (see logs for details)") return } handler.log.Debugln("Importing chats of", user.MXID) _, err = user.Conn.Chats() if err != nil { user.log.Errorln("Error updating chats:", err) ce.Reply("Failed to sync chat list (see logs for details)") return } ce.Reply("Syncing contacts...") user.syncPuppets(nil) ce.Reply("Syncing chats...") user.syncPortals(nil, create) ce.Reply("Sync complete.") } const cmdDeletePortalHelp = `delete-portal - Delete the current portal. If the portal is used by other people, this is limited to bridge admins.` func (handler *CommandHandler) CommandDeletePortal(ce *CommandEvent) { portal := ce.Bridge.GetPortalByMXID(ce.RoomID) if portal == nil { ce.Reply("You must be in a portal room to use that command") return } if !ce.User.Admin { users := portal.GetUserIDs() if len(users) > 1 || (len(users) == 1 && users[0] != ce.User.MXID) { ce.Reply("Only bridge admins can delete portals with other Matrix users") return } } portal.log.Infoln(ce.User.MXID, "requested deletion of portal.") portal.Delete() portal.Cleanup(false) } const cmdDeleteAllPortalsHelp = `delete-all-portals - Delete all your portals that aren't used by any other user.'` func (handler *CommandHandler) CommandDeleteAllPortals(ce *CommandEvent) { portals := ce.User.GetPortals() portalsToDelete := make([]*Portal, 0, len(portals)) for _, portal := range portals { users := portal.GetUserIDs() if len(users) == 1 && users[0] == ce.User.MXID { portalsToDelete = append(portalsToDelete, portal) } } leave := func(portal *Portal) { if len(portal.MXID) > 0 { _, _ = portal.MainIntent().KickUser(portal.MXID, &mautrix.ReqKickUser{ Reason: "Deleting portal", UserID: ce.User.MXID, }) } } customPuppet := handler.bridge.GetPuppetByCustomMXID(ce.User.MXID) if customPuppet != nil && customPuppet.CustomIntent() != nil { intent := customPuppet.CustomIntent() leave = func(portal *Portal) { if len(portal.MXID) > 0 { _, _ = intent.LeaveRoom(portal.MXID) _, _ = intent.ForgetRoom(portal.MXID) } } } ce.Reply("Found %d portals with no other users, deleting...", len(portalsToDelete)) for _, portal := range portalsToDelete { portal.Delete() leave(portal) } ce.Reply("Finished deleting portal info. Now cleaning up rooms in background. " + "You may already continue using the bridge. Use `sync` to recreate portals.") go func() { for _, portal := range portalsToDelete { portal.Cleanup(false) } ce.Reply("Finished background cleanup of deleted portal rooms.") }() } const cmdListHelp = `list [page] [items per page] - Get a list of all contacts and groups.` func formatContacts(contacts bool, input map[string]whatsapp.Contact) (result []string) { for jid, contact := range input { if strings.HasSuffix(jid, whatsappExt.NewUserSuffix) != contacts { continue } if contacts { result = append(result, fmt.Sprintf("* %s / %s - `%s`", contact.Name, contact.Notify, contact.Jid[:len(contact.Jid)-len(whatsappExt.NewUserSuffix)])) } else { result = append(result, fmt.Sprintf("* %s - `%s`", contact.Name, contact.Jid)) } } sort.Sort(sort.StringSlice(result)) return } func (handler *CommandHandler) CommandList(ce *CommandEvent) { if len(ce.Args) == 0 { ce.Reply("**Usage:** `list [page] [items per page]`") return } mode := strings.ToLower(ce.Args[0]) if mode[0] != 'g' && mode[0] != 'c' { ce.Reply("**Usage:** `list [page] [items per page]`") return } var err error page := 1 max := 100 if len(ce.Args) > 1 { page, err = strconv.Atoi(ce.Args[1]) if err != nil || page <= 0 { ce.Reply("\"%s\" isn't a valid page number", ce.Args[1]) return } } if len(ce.Args) > 2 { max, err = strconv.Atoi(ce.Args[2]) if err != nil || max <= 0 { ce.Reply("\"%s\" isn't a valid number of items per page", ce.Args[2]) return } else if max > 400 { ce.Reply("Warning: a high number of items per page may fail to send a reply") } } contacts := mode[0] == 'c' typeName := "Groups" if contacts { typeName = "Contacts" } result := formatContacts(contacts, ce.User.Conn.Store.Contacts) if len(result) == 0 { ce.Reply("No %s found", strings.ToLower(typeName)) return } pages := int(math.Ceil(float64(len(result)) / float64(max))) if (page-1)*max >= len(result) { if pages == 1 { ce.Reply("There is only 1 page of %s", strings.ToLower(typeName)) } else { ce.Reply("There are only %d pages of %s", pages, strings.ToLower(typeName)) } return } lastIndex := page * max if lastIndex > len(result) { lastIndex = len(result) } result = result[(page-1)*max : lastIndex] ce.Reply("### %s (page %d of %d)\n\n%s", typeName, page, pages, strings.Join(result, "\n")) } const cmdOpenHelp = `open <_group JID_> - Open a group chat portal.` func (handler *CommandHandler) CommandOpen(ce *CommandEvent) { if len(ce.Args) == 0 { ce.Reply("**Usage:** `open `") return } user := ce.User jid := ce.Args[0] if strings.HasSuffix(jid, whatsappExt.NewUserSuffix) { ce.Reply("That looks like a user JID. Did you mean `pm %s`?", jid[:len(jid)-len(whatsappExt.NewUserSuffix)]) return } contact, ok := user.Conn.Store.Contacts[jid] if !ok { ce.Reply("Group JID not found in contacts. Try syncing contacts with `sync` first.") return } handler.log.Debugln("Importing", jid, "for", user) portal := user.bridge.GetPortalByJID(database.GroupPortalKey(jid)) if len(portal.MXID) > 0 { portal.Sync(user, contact) ce.Reply("Portal room synced.") } else { portal.Sync(user, contact) ce.Reply("Portal room created.") } _, _ = portal.MainIntent().InviteUser(portal.MXID, &mautrix.ReqInviteUser{UserID: user.MXID}) } const cmdPMHelp = `pm [--force] <_international phone number_> - Open a private chat with the given phone number.` func (handler *CommandHandler) CommandPM(ce *CommandEvent) { if len(ce.Args) == 0 { ce.Reply("**Usage:** `pm [--force] `") return } force := ce.Args[0] == "--force" if force { ce.Args = ce.Args[1:] } user := ce.User number := strings.Join(ce.Args, "") if number[0] == '+' { number = number[1:] } for _, char := range number { if char < '0' || char > '9' { ce.Reply("Invalid phone number.") return } } jid := number + whatsappExt.NewUserSuffix handler.log.Debugln("Importing", jid, "for", user) contact, ok := user.Conn.Store.Contacts[jid] if !ok { if !force { ce.Reply("Phone number not found in contacts. Try syncing contacts with `sync` first. " + "To create a portal anyway, use `pm --force `.") return } contact = whatsapp.Contact{Jid: jid} } puppet := user.bridge.GetPuppetByJID(contact.Jid) puppet.Sync(user, contact) portal := user.bridge.GetPortalByJID(database.NewPortalKey(contact.Jid, user.JID)) if len(portal.MXID) > 0 { _, err := portal.MainIntent().InviteUser(portal.MXID, &mautrix.ReqInviteUser{UserID: user.MXID}) if err != nil { fmt.Println(err) } else { ce.Reply("Existing portal room found, invited you to it.") } return } err := portal.CreateMatrixRoom(user) if err != nil { ce.Reply("Failed to create portal room: %v", err) return } ce.Reply("Created portal room and invited you to it.") } const cmdLoginMatrixHelp = `login-matrix <_access token_> - Replace your WhatsApp account's Matrix puppet with your real Matrix account.'` func (handler *CommandHandler) CommandLoginMatrix(ce *CommandEvent) { if len(ce.Args) == 0 { ce.Reply("**Usage:** `login-matrix `") return } puppet := handler.bridge.GetPuppetByJID(ce.User.JID) err := puppet.SwitchCustomMXID(ce.Args[0], ce.User.MXID) if err != nil { ce.Reply("Failed to switch puppet: %v", err) return } ce.Reply("Successfully switched puppet") } const cmdLogoutMatrixHelp = `logout-matrix - Switch your WhatsApp account's Matrix puppet back to the default one.` func (handler *CommandHandler) CommandLogoutMatrix(ce *CommandEvent) { puppet := handler.bridge.GetPuppetByJID(ce.User.JID) if len(puppet.CustomMXID) == 0 { ce.Reply("You had not changed your WhatsApp account's Matrix puppet.") return } err := puppet.SwitchCustomMXID("", "") if err != nil { ce.Reply("Failed to remove custom puppet: %v", err) return } ce.Reply("Successfully removed custom puppet") }