2019-02-21 20:28:13 +01:00
package bwhatsapp
import (
2020-01-09 18:14:01 +01:00
"bytes"
2019-02-21 20:28:13 +01:00
"crypto/rand"
"encoding/hex"
"errors"
"fmt"
2020-01-09 18:14:01 +01:00
"mime"
2019-02-21 20:28:13 +01:00
"os"
2020-01-09 18:14:01 +01:00
"path/filepath"
2019-02-21 20:28:13 +01:00
"strings"
"time"
"github.com/42wim/matterbridge/bridge"
"github.com/42wim/matterbridge/bridge/config"
2019-05-30 12:20:56 +02:00
"github.com/Rhymen/go-whatsapp"
2019-02-21 20:28:13 +01:00
)
const (
// Account config parameters
cfgNumber = "Number"
qrOnWhiteTerminal = "QrOnWhiteTerminal"
sessionFile = "SessionFile"
)
// Bwhatsapp Bridge structure keeping all the information needed for relying
type Bwhatsapp struct {
* bridge . Config
// https://github.com/Rhymen/go-whatsapp/blob/c31092027237441cffba1b9cb148eadf7c83c3d2/session.go#L18-L21
2019-06-01 00:53:49 +02:00
session * whatsapp . Session
conn * whatsapp . Conn
2019-02-21 20:28:13 +01:00
startedAt uint64
users map [ string ] whatsapp . Contact
userAvatars map [ string ] string
}
// New Create a new WhatsApp bridge. This will be called for each [whatsapp.<server>] entry you have in the config file
func New ( cfg * bridge . Config ) bridge . Bridger {
number := cfg . GetString ( cfgNumber )
if number == "" {
cfg . Log . Fatalf ( "Missing configuration for WhatsApp bridge: Number" )
}
b := & Bwhatsapp {
Config : cfg ,
users : make ( map [ string ] whatsapp . Contact ) ,
userAvatars : make ( map [ string ] string ) ,
}
return b
}
// Connect to WhatsApp. Required implementation of the Bridger interface
// https://github.com/42wim/matterbridge/blob/2cfd880cdb0df29771bf8f31df8d990ab897889d/bridge/bridge.go#L11-L16
func ( b * Bwhatsapp ) Connect ( ) error {
b . RLock ( ) // TODO do we need locking for Whatsapp?
defer b . RUnlock ( )
number := b . GetString ( cfgNumber )
if number == "" {
return errors . New ( "WhatsApp's telephone Number need to be configured" )
}
// https://github.com/Rhymen/go-whatsapp#creating-a-connection
b . Log . Debugln ( "Connecting to WhatsApp.." )
conn , err := whatsapp . NewConn ( 20 * time . Second )
if err != nil {
return errors . New ( "failed to connect to WhatsApp: " + err . Error ( ) )
}
b . conn = conn
b . conn . AddHandler ( b )
b . Log . Debugln ( "WhatsApp connection successful" )
// load existing session in order to keep it between restarts
if b . session == nil {
var session whatsapp . Session
session , err = b . readSession ( )
if err == nil {
b . Log . Debugln ( "Restoring WhatsApp session.." )
// https://github.com/Rhymen/go-whatsapp#restore
2019-05-30 12:20:56 +02:00
session , err = b . conn . RestoreWithSession ( session )
2019-02-21 20:28:13 +01:00
if err != nil {
// TODO return or continue to normal login?
// restore session connection timed out (I couldn't get over it without logging in again)
return errors . New ( "failed to restore session: " + err . Error ( ) )
}
b . session = & session
b . Log . Debugln ( "Session restored successfully!" )
} else {
b . Log . Warn ( err . Error ( ) )
}
}
// login to a new session
if b . session == nil {
err = b . Login ( )
if err != nil {
return err
}
}
b . startedAt = uint64 ( time . Now ( ) . Unix ( ) )
_ , err = b . conn . Contacts ( )
if err != nil {
return fmt . Errorf ( "error on update of contacts: %v" , err )
}
2020-11-22 21:42:54 +01:00
// see https://github.com/Rhymen/go-whatsapp/issues/137#issuecomment-480316013
for len ( b . conn . Store . Contacts ) == 0 {
b . conn . Contacts ( ) // nolint:errcheck
<- time . After ( 1 * time . Second )
}
2019-02-21 20:28:13 +01:00
// map all the users
for id , contact := range b . conn . Store . Contacts {
if ! isGroupJid ( id ) && id != "status@broadcast" {
// it is user
b . users [ id ] = contact
}
}
// get user avatar asynchronously
go func ( ) {
b . Log . Debug ( "Getting user avatars.." )
for jid := range b . users {
2019-06-01 00:53:49 +02:00
info , err := b . GetProfilePicThumb ( jid )
2019-02-21 20:28:13 +01:00
if err != nil {
b . Log . Warnf ( "Could not get profile photo of %s: %v" , jid , err )
} else {
// TODO any race conditions here?
b . userAvatars [ jid ] = info . URL
}
}
b . Log . Debug ( "Finished getting avatars.." )
} ( )
return nil
}
// Login to WhatsApp creating a new session. This will require to scan a QR code on your mobile device
func ( b * Bwhatsapp ) Login ( ) error {
b . Log . Debugln ( "Logging in.." )
invert := b . GetBool ( qrOnWhiteTerminal ) // false is the default
qrChan := qrFromTerminal ( invert )
session , err := b . conn . Login ( qrChan )
if err != nil {
b . Log . Warnln ( "Failed to log in:" , err )
return err
}
b . session = & session
b . Log . Infof ( "Logged into session: %#v" , session )
b . Log . Infof ( "Connection: %#v" , b . conn )
err = b . writeSession ( session )
if err != nil {
fmt . Fprintf ( os . Stderr , "error saving session: %v\n" , err )
}
// TODO change connection strings to configured ones longClientName:"github.com/rhymen/go-whatsapp", shortClientName:"go-whatsapp"}" prefix=whatsapp
// TODO get also a nice logo
// TODO notification about unplugged and dead battery
// conn.Info: Wid, Pushname, Connected, Battery, Plugged
return nil
}
// Disconnect is called while reconnecting to the bridge
// TODO 42wim Documentation would be helpful on when reconnects happen and what should be done in this function
// Required implementation of the Bridger interface
// https://github.com/42wim/matterbridge/blob/2cfd880cdb0df29771bf8f31df8d990ab897889d/bridge/bridge.go#L11-L16
func ( b * Bwhatsapp ) Disconnect ( ) error {
// We could Logout, but that would close the session completely and would require a new QR code scan
// https://github.com/Rhymen/go-whatsapp/blob/c31092027237441cffba1b9cb148eadf7c83c3d2/session.go#L377-L381
return nil
}
func isGroupJid ( identifier string ) bool {
2020-08-26 22:27:50 +02:00
return strings . HasSuffix ( identifier , "@g.us" ) || strings . HasSuffix ( identifier , "@temp" ) || strings . HasSuffix ( identifier , "@broadcast" )
2019-02-21 20:28:13 +01:00
}
// JoinChannel Join a WhatsApp group specified in gateway config as channel='number-id@g.us' or channel='Channel name'
// Required implementation of the Bridger interface
// https://github.com/42wim/matterbridge/blob/2cfd880cdb0df29771bf8f31df8d990ab897889d/bridge/bridge.go#L11-L16
func ( b * Bwhatsapp ) JoinChannel ( channel config . ChannelInfo ) error {
byJid := isGroupJid ( channel . Name )
2020-11-22 21:42:54 +01:00
// see https://github.com/Rhymen/go-whatsapp/issues/137#issuecomment-480316013
for len ( b . conn . Store . Contacts ) == 0 {
b . conn . Contacts ( ) // nolint:errcheck
<- time . After ( 1 * time . Second )
}
2019-02-21 20:28:13 +01:00
// verify if we are member of the given group
if byJid {
// channel.Name specifies static group jID, not the name
if _ , exists := b . conn . Store . Contacts [ channel . Name ] ; ! exists {
return fmt . Errorf ( "account doesn't belong to group with jid %s" , channel . Name )
}
} else {
// channel.Name specifies group name that might change, warn about it
var jids [ ] string
for id , contact := range b . conn . Store . Contacts {
if isGroupJid ( id ) && contact . Name == channel . Name {
jids = append ( jids , id )
}
}
switch len ( jids ) {
case 0 :
// didn't match any group - print out possibilites
// TODO sort
// copy b;
//sort.Slice(people, func(i, j int) bool {
// return people[i].Age > people[j].Age
//})
for id , contact := range b . conn . Store . Contacts {
if isGroupJid ( id ) {
b . Log . Infof ( "%s %s" , contact . Jid , contact . Name )
}
}
return fmt . Errorf ( "please specify group's JID from the list above instead of the name '%s'" , channel . Name )
case 1 :
return fmt . Errorf ( "group name might change. Please configure gateway with channel=\"%v\" instead of channel=\"%v\"" , jids [ 0 ] , channel . Name )
default :
return fmt . Errorf ( "there is more than one group with name '%s'. Please specify one of JIDs as channel name: %v" , channel . Name , jids )
}
}
return nil
}
2020-01-09 18:14:01 +01:00
// Post a document message from the bridge to WhatsApp
func ( b * Bwhatsapp ) PostDocumentMessage ( msg config . Message , filetype string ) ( string , error ) {
fi := msg . Extra [ "file" ] [ 0 ] . ( config . FileInfo )
// Post document message
message := whatsapp . DocumentMessage {
Info : whatsapp . MessageInfo {
RemoteJid : msg . Channel ,
} ,
Title : fi . Name ,
FileName : fi . Name ,
Type : filetype ,
Content : bytes . NewReader ( * fi . Data ) ,
}
b . Log . Debugf ( "=> Sending %#v" , msg )
// create message ID
// TODO follow and act if https://github.com/Rhymen/go-whatsapp/issues/101 implemented
idBytes := make ( [ ] byte , 10 )
if _ , err := rand . Read ( idBytes ) ; err != nil {
b . Log . Warn ( err . Error ( ) )
}
message . Info . Id = strings . ToUpper ( hex . EncodeToString ( idBytes ) )
_ , err := b . conn . Send ( message )
return message . Info . Id , err
}
// Post an image message from the bridge to WhatsApp
// Handle, for sure image/jpeg, image/png and image/gif MIME types
func ( b * Bwhatsapp ) PostImageMessage ( msg config . Message , filetype string ) ( string , error ) {
fi := msg . Extra [ "file" ] [ 0 ] . ( config . FileInfo )
// Post image message
message := whatsapp . ImageMessage {
Info : whatsapp . MessageInfo {
RemoteJid : msg . Channel ,
} ,
Type : filetype ,
Caption : msg . Username + fi . Comment ,
Content : bytes . NewReader ( * fi . Data ) ,
}
b . Log . Debugf ( "=> Sending %#v" , msg )
// create message ID
// TODO follow and act if https://github.com/Rhymen/go-whatsapp/issues/101 implemented
idBytes := make ( [ ] byte , 10 )
if _ , err := rand . Read ( idBytes ) ; err != nil {
b . Log . Warn ( err . Error ( ) )
}
message . Info . Id = strings . ToUpper ( hex . EncodeToString ( idBytes ) )
_ , err := b . conn . Send ( message )
return message . Info . Id , err
}
2019-02-21 20:28:13 +01:00
// Send a message from the bridge to WhatsApp
// Required implementation of the Bridger interface
// https://github.com/42wim/matterbridge/blob/2cfd880cdb0df29771bf8f31df8d990ab897889d/bridge/bridge.go#L11-L16
func ( b * Bwhatsapp ) Send ( msg config . Message ) ( string , error ) {
b . Log . Debugf ( "=> Receiving %#v" , msg )
// Delete message
if msg . Event == config . EventMsgDelete {
if msg . ID == "" {
// No message ID in case action is executed on a message sent before the bridge was started
// and then the bridge cache doesn't have this message ID mapped
// TODO 42wim Doesn't the app get clogged with a ton of IDs after some time of running?
// WhatsApp allows to set any ID so in that case we could use external IDs and don't do mapping
// but external IDs are not set
return "" , nil
}
// TODO delete message on WhatsApp https://github.com/Rhymen/go-whatsapp/issues/100
return "" , nil
}
// Edit message
if msg . ID != "" {
b . Log . Debugf ( "updating message with id %s" , msg . ID )
msg . Text += " (edited)"
// TODO handle edit as a message reply with updated text
}
2020-01-09 18:14:01 +01:00
// Handle Upload a file
if msg . Extra [ "file" ] != nil {
fi := msg . Extra [ "file" ] [ 0 ] . ( config . FileInfo )
filetype := mime . TypeByExtension ( filepath . Ext ( fi . Name ) )
b . Log . Debugf ( "Extra file is %#v" , filetype )
// TODO: add different types
// TODO: add webp conversion
switch filetype {
case "image/jpeg" , "image/png" , "image/gif" :
return b . PostImageMessage ( msg , filetype )
default :
return b . PostDocumentMessage ( msg , filetype )
}
}
2019-02-21 20:28:13 +01:00
// Post text message
2020-01-09 18:14:01 +01:00
message := whatsapp . TextMessage {
2019-02-21 20:28:13 +01:00
Info : whatsapp . MessageInfo {
RemoteJid : msg . Channel , // which equals to group id
} ,
Text : msg . Username + msg . Text ,
}
b . Log . Debugf ( "=> Sending %#v" , msg )
// create message ID
// TODO follow and act if https://github.com/Rhymen/go-whatsapp/issues/101 implemented
2020-01-09 18:14:01 +01:00
idBytes := make ( [ ] byte , 10 )
if _ , err := rand . Read ( idBytes ) ; err != nil {
2019-02-21 20:28:13 +01:00
b . Log . Warn ( err . Error ( ) )
}
2020-01-09 18:14:01 +01:00
message . Info . Id = strings . ToUpper ( hex . EncodeToString ( idBytes ) )
_ , err := b . conn . Send ( message )
2019-02-21 20:28:13 +01:00
2020-01-09 18:14:01 +01:00
return message . Info . Id , err
2019-02-21 20:28:13 +01:00
}
// TODO do we want that? to allow login with QR code from a bridged channel? https://github.com/tulir/mautrix-whatsapp/blob/513eb18e2d59bada0dd515ee1abaaf38a3bfe3d5/commands.go#L76
//func (b *Bwhatsapp) Command(cmd string) string {
// return ""
//}