main.go 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2022 Tulir Asokan
  3. //
  4. // This program is free software: you can redistribute it and/or modify
  5. // it under the terms of the GNU Affero General Public License as published by
  6. // the Free Software Foundation, either version 3 of the License, or
  7. // (at your option) any later version.
  8. //
  9. // This program is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU Affero General Public License for more details.
  13. //
  14. // You should have received a copy of the GNU Affero General Public License
  15. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  16. package main
  17. import (
  18. _ "embed"
  19. "net/http"
  20. "os"
  21. "strconv"
  22. "strings"
  23. "sync"
  24. "time"
  25. "google.golang.org/protobuf/proto"
  26. "go.mau.fi/whatsmeow"
  27. waProto "go.mau.fi/whatsmeow/binary/proto"
  28. "go.mau.fi/whatsmeow/store"
  29. "go.mau.fi/whatsmeow/store/sqlstore"
  30. "go.mau.fi/whatsmeow/types"
  31. "maunium.net/go/mautrix"
  32. "maunium.net/go/mautrix/bridge"
  33. "maunium.net/go/mautrix/bridge/commands"
  34. "maunium.net/go/mautrix/bridge/status"
  35. "maunium.net/go/mautrix/event"
  36. "maunium.net/go/mautrix/id"
  37. "maunium.net/go/mautrix/util/configupgrade"
  38. "maunium.net/go/mautrix-whatsapp/config"
  39. "maunium.net/go/mautrix-whatsapp/database"
  40. )
  41. // Information to find out exactly which commit the bridge was built from.
  42. // These are filled at build time with the -X linker flag.
  43. var (
  44. Tag = "unknown"
  45. Commit = "unknown"
  46. BuildTime = "unknown"
  47. )
  48. //go:embed example-config.yaml
  49. var ExampleConfig string
  50. type WABridge struct {
  51. bridge.Bridge
  52. Config *config.Config
  53. DB *database.Database
  54. Provisioning *ProvisioningAPI
  55. Formatter *Formatter
  56. Metrics *MetricsHandler
  57. WAContainer *sqlstore.Container
  58. WAVersion string
  59. usersByMXID map[id.UserID]*User
  60. usersByUsername map[string]*User
  61. usersLock sync.Mutex
  62. spaceRooms map[id.RoomID]*User
  63. spaceRoomsLock sync.Mutex
  64. managementRooms map[id.RoomID]*User
  65. managementRoomsLock sync.Mutex
  66. portalsByMXID map[id.RoomID]*Portal
  67. portalsByJID map[database.PortalKey]*Portal
  68. portalsLock sync.Mutex
  69. puppets map[types.JID]*Puppet
  70. puppetsByCustomMXID map[id.UserID]*Puppet
  71. puppetsLock sync.Mutex
  72. }
  73. func (br *WABridge) Init() {
  74. br.CommandProcessor = commands.NewProcessor(&br.Bridge)
  75. br.RegisterCommands()
  76. // TODO this is a weird place for this
  77. br.EventProcessor.On(event.EphemeralEventPresence, br.HandlePresence)
  78. Segment.log = br.Log.Sub("Segment")
  79. Segment.key = br.Config.SegmentKey
  80. if Segment.IsEnabled() {
  81. Segment.log.Infoln("Segment metrics are enabled")
  82. }
  83. br.DB = database.New(br.Bridge.DB, br.Log.Sub("Database"))
  84. br.WAContainer = sqlstore.NewWithDB(br.DB.RawDB, br.DB.Dialect.String(), &waLogger{br.Log.Sub("Database").Sub("WhatsApp")})
  85. br.WAContainer.DatabaseErrorHandler = br.DB.HandleSignalStoreError
  86. ss := br.Config.Bridge.Provisioning.SharedSecret
  87. if len(ss) > 0 && ss != "disable" {
  88. br.Provisioning = &ProvisioningAPI{bridge: br}
  89. }
  90. br.Formatter = NewFormatter(br)
  91. br.Metrics = NewMetricsHandler(br.Config.Metrics.Listen, br.Log.Sub("Metrics"), br.DB)
  92. br.MatrixHandler.TrackEventDuration = br.Metrics.TrackMatrixEvent
  93. store.BaseClientPayload.UserAgent.OsVersion = proto.String(br.WAVersion)
  94. store.BaseClientPayload.UserAgent.OsBuildNumber = proto.String(br.WAVersion)
  95. store.DeviceProps.Os = proto.String(br.Config.WhatsApp.OSName)
  96. store.DeviceProps.RequireFullSync = proto.Bool(br.Config.Bridge.HistorySync.RequestFullSync)
  97. versionParts := strings.Split(br.WAVersion, ".")
  98. if len(versionParts) > 2 {
  99. primary, _ := strconv.Atoi(versionParts[0])
  100. secondary, _ := strconv.Atoi(versionParts[1])
  101. tertiary, _ := strconv.Atoi(versionParts[2])
  102. store.DeviceProps.Version.Primary = proto.Uint32(uint32(primary))
  103. store.DeviceProps.Version.Secondary = proto.Uint32(uint32(secondary))
  104. store.DeviceProps.Version.Tertiary = proto.Uint32(uint32(tertiary))
  105. }
  106. platformID, ok := waProto.DeviceProps_PlatformType_value[strings.ToUpper(br.Config.WhatsApp.BrowserName)]
  107. if ok {
  108. store.DeviceProps.PlatformType = waProto.DeviceProps_PlatformType(platformID).Enum()
  109. }
  110. }
  111. func (br *WABridge) Start() {
  112. err := br.WAContainer.Upgrade()
  113. if err != nil {
  114. br.Log.Fatalln("Failed to upgrade whatsmeow database: %v", err)
  115. os.Exit(15)
  116. }
  117. if br.Provisioning != nil {
  118. br.Log.Debugln("Initializing provisioning API")
  119. br.Provisioning.Init()
  120. }
  121. go br.CheckWhatsAppUpdate()
  122. go br.StartUsers()
  123. if br.Config.Metrics.Enabled {
  124. go br.Metrics.Start()
  125. }
  126. go br.Loop()
  127. }
  128. func (br *WABridge) CheckWhatsAppUpdate() {
  129. br.Log.Debugfln("Checking for WhatsApp web update")
  130. resp, err := whatsmeow.CheckUpdate(http.DefaultClient)
  131. if err != nil {
  132. br.Log.Warnfln("Failed to check for WhatsApp web update: %v", err)
  133. return
  134. }
  135. if store.GetWAVersion() == resp.ParsedVersion {
  136. br.Log.Debugfln("Bridge is using latest WhatsApp web protocol")
  137. } else if store.GetWAVersion().LessThan(resp.ParsedVersion) {
  138. if resp.IsBelowHard || resp.IsBroken {
  139. br.Log.Warnfln("Bridge is using outdated WhatsApp web protocol and probably doesn't work anymore (%s, latest is %s)", store.GetWAVersion(), resp.ParsedVersion)
  140. } else if resp.IsBelowSoft {
  141. br.Log.Infofln("Bridge is using outdated WhatsApp web protocol (%s, latest is %s)", store.GetWAVersion(), resp.ParsedVersion)
  142. } else {
  143. br.Log.Debugfln("Bridge is using outdated WhatsApp web protocol (%s, latest is %s)", store.GetWAVersion(), resp.ParsedVersion)
  144. }
  145. } else {
  146. br.Log.Debugfln("Bridge is using newer than latest WhatsApp web protocol")
  147. }
  148. }
  149. func (br *WABridge) Loop() {
  150. for {
  151. br.SleepAndDeleteUpcoming()
  152. time.Sleep(1 * time.Hour)
  153. br.WarnUsersAboutDisconnection()
  154. }
  155. }
  156. func (br *WABridge) WarnUsersAboutDisconnection() {
  157. br.usersLock.Lock()
  158. for _, user := range br.usersByUsername {
  159. if user.IsConnected() && !user.PhoneRecentlySeen(true) {
  160. go user.sendPhoneOfflineWarning()
  161. }
  162. }
  163. br.usersLock.Unlock()
  164. }
  165. func (br *WABridge) StartUsers() {
  166. br.Log.Debugln("Starting users")
  167. foundAnySessions := false
  168. for _, user := range br.GetAllUsers() {
  169. if !user.JID.IsEmpty() {
  170. foundAnySessions = true
  171. }
  172. go user.Connect()
  173. }
  174. if !foundAnySessions {
  175. br.SendGlobalBridgeState(status.BridgeState{StateEvent: status.StateUnconfigured}.Fill(nil))
  176. }
  177. br.Log.Debugln("Starting custom puppets")
  178. for _, loopuppet := range br.GetAllPuppetsWithCustomMXID() {
  179. go func(puppet *Puppet) {
  180. puppet.log.Debugln("Starting custom puppet", puppet.CustomMXID)
  181. err := puppet.StartCustomMXID(true)
  182. if err != nil {
  183. puppet.log.Errorln("Failed to start custom puppet:", err)
  184. }
  185. }(loopuppet)
  186. }
  187. }
  188. func (br *WABridge) Stop() {
  189. br.Metrics.Stop()
  190. for _, user := range br.usersByUsername {
  191. if user.Client == nil {
  192. continue
  193. }
  194. br.Log.Debugln("Disconnecting", user.MXID)
  195. user.Client.Disconnect()
  196. close(user.historySyncs)
  197. }
  198. }
  199. func (br *WABridge) GetExampleConfig() string {
  200. return ExampleConfig
  201. }
  202. func (br *WABridge) GetConfigPtr() interface{} {
  203. br.Config = &config.Config{
  204. BaseConfig: &br.Bridge.Config,
  205. }
  206. br.Config.BaseConfig.Bridge = &br.Config.Bridge
  207. return br.Config
  208. }
  209. const unstableFeatureBatchSending = "org.matrix.msc2716"
  210. func (br *WABridge) CheckFeatures(versions *mautrix.RespVersions) (string, bool) {
  211. if br.Config.Bridge.HistorySync.Backfill {
  212. supported, known := versions.UnstableFeatures[unstableFeatureBatchSending]
  213. if !known {
  214. return "Backfilling is enabled in bridge config, but homeserver does not support MSC2716 batch sending", false
  215. } else if !supported {
  216. return "Backfilling is enabled in bridge config, but MSC2716 batch sending is not enabled on homeserver", false
  217. }
  218. }
  219. return "", true
  220. }
  221. func main() {
  222. br := &WABridge{
  223. usersByMXID: make(map[id.UserID]*User),
  224. usersByUsername: make(map[string]*User),
  225. spaceRooms: make(map[id.RoomID]*User),
  226. managementRooms: make(map[id.RoomID]*User),
  227. portalsByMXID: make(map[id.RoomID]*Portal),
  228. portalsByJID: make(map[database.PortalKey]*Portal),
  229. puppets: make(map[types.JID]*Puppet),
  230. puppetsByCustomMXID: make(map[id.UserID]*Puppet),
  231. }
  232. br.Bridge = bridge.Bridge{
  233. Name: "mautrix-whatsapp",
  234. URL: "https://github.com/mautrix/whatsapp",
  235. Description: "A Matrix-WhatsApp puppeting bridge.",
  236. Version: "0.7.1",
  237. ProtocolName: "WhatsApp",
  238. CryptoPickleKey: "maunium.net/go/mautrix-whatsapp",
  239. ConfigUpgrader: &configupgrade.StructUpgrader{
  240. SimpleUpgrader: configupgrade.SimpleUpgrader(config.DoUpgrade),
  241. Blocks: config.SpacedBlocks,
  242. Base: ExampleConfig,
  243. },
  244. Child: br,
  245. }
  246. br.InitVersion(Tag, Commit, BuildTime)
  247. br.WAVersion = strings.FieldsFunc(br.Version, func(r rune) bool { return r == '-' || r == '+' })[0]
  248. br.Main()
  249. }