mautrix-whatsapp/asmux.go
2021-03-19 20:52:15 +02:00

153 lines
4.9 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 main
import (
"errors"
"net/http"
"time"
"github.com/Rhymen/go-whatsapp"
"maunium.net/go/mautrix/id"
)
type AsmuxError string
const (
AsmuxWANotLoggedIn AsmuxError = "wa-not-logged-in"
AsmuxWANotConnected AsmuxError = "wa-not-connected"
AsmuxWAConnecting AsmuxError = "wa-connecting"
AsmuxWATimeout AsmuxError = "wa-timeout"
AsmuxWAPingFalse AsmuxError = "wa-ping-false"
AsmuxWAPingError AsmuxError = "wa-ping-error"
)
var asmuxHumanErrors = map[AsmuxError]string{
AsmuxWANotLoggedIn: "You're not logged into WhatsApp",
AsmuxWANotConnected: "You're not connected to WhatsApp",
AsmuxWAConnecting: "Trying to reconnect to WhatsApp. Please make sure WhatsApp is running on your phone and connected to the internet.",
AsmuxWATimeout: "WhatsApp on your phone is not responding. Please make sure it is running and connected to the internet.",
AsmuxWAPingFalse: "WhatsApp returned an error, reconnecting. Please make sure WhatsApp is running on your phone and connected to the internet.",
AsmuxWAPingError: "WhatsApp returned an unknown error",
}
type AsmuxPong struct {
OK bool `json:"ok"`
Timestamp int64 `json:"timestamp"`
TTL int `json:"ttl"`
ErrorSource string `json:"error_source,omitempty"`
Error AsmuxError `json:"error,omitempty"`
Message string `json:"message,omitempty"`
}
func (pong *AsmuxPong) fill() {
pong.Timestamp = time.Now().Unix()
if !pong.OK {
pong.TTL = 60
pong.ErrorSource = "bridge"
pong.Message = asmuxHumanErrors[pong.Error]
} else {
pong.TTL = 240
}
}
func (pong *AsmuxPong) shouldDeduplicate(newPong *AsmuxPong) bool {
if pong == nil || pong.OK != newPong.OK || pong.Error != newPong.Error {
return false
}
return pong.Timestamp+int64(pong.TTL/5) > time.Now().Unix()
}
func (user *User) setupAdminTestHooks() {
if !user.bridge.Config.Homeserver.Asmux {
return
}
user.Conn.AdminTestHook = func(err error) {
if errors.Is(err, whatsapp.ErrConnectionTimeout) {
user.sendBridgeStatus(AsmuxPong{Error: AsmuxWATimeout})
} else if errors.Is(err, whatsapp.ErrPingFalse) {
user.sendBridgeStatus(AsmuxPong{Error: AsmuxWAPingFalse})
} else if err == nil {
user.sendBridgeStatus(AsmuxPong{OK: true})
} else {
user.sendBridgeStatus(AsmuxPong{Error: AsmuxWAPingError})
}
}
user.Conn.CountTimeoutHook = func() {
user.sendBridgeStatus(AsmuxPong{Error: AsmuxWATimeout})
}
}
func (user *User) sendBridgeStatus(state AsmuxPong) {
if !user.bridge.Config.Homeserver.Asmux {
return
}
state.fill()
if user.prevBridgeStatus.shouldDeduplicate(&state) {
return
}
cli := user.bridge.AS.BotClient()
url := cli.BuildBaseURL("_matrix", "client", "unstable", "com.beeper.asmux", "pong")
_, err := cli.MakeRequest("POST", url, &state, nil)
if err != nil {
user.log.Warnln("Failed to update bridge state in asmux:", err)
} else {
user.prevBridgeStatus = &state
}
}
func (prov *ProvisioningAPI) AsmuxPing(w http.ResponseWriter, r *http.Request) {
if !prov.bridge.AS.CheckServerToken(w, r) {
return
}
userID := r.URL.Query().Get("user_id")
user := prov.bridge.GetUserByMXID(id.UserID(userID))
var resp AsmuxPong
if user.Conn == nil {
if user.Session == nil {
resp.Error = AsmuxWANotLoggedIn
} else {
resp.Error = AsmuxWANotConnected
}
} else {
if user.Conn.IsConnected() && user.Conn.IsLoggedIn() {
user.log.Debugln("Pinging WhatsApp mobile due to asmux /ping API request")
err := user.Conn.AdminTestWithSuppress(true)
user.log.Debugln("Ping response:", err)
if err == whatsapp.ErrPingFalse {
user.log.Debugln("Forwarding ping false error from provisioning API to HandleError")
go user.HandleError(err)
resp.Error = AsmuxWAPingFalse
} else if errors.Is(err, whatsapp.ErrConnectionTimeout) {
resp.Error = AsmuxWATimeout
} else if err != nil {
resp.Error = AsmuxWAPingError
} else {
resp.OK = true
}
} else if user.Conn.IsLoginInProgress() {
resp.Error = AsmuxWAConnecting
} else if user.Conn.IsConnected() {
resp.Error = AsmuxWANotLoggedIn
} else {
resp.Error = AsmuxWANotConnected
}
}
resp.fill()
jsonResponse(w, http.StatusOK, &resp)
user.prevBridgeStatus = &resp
}