main.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2020 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. "fmt"
  19. "os"
  20. "os/signal"
  21. "strings"
  22. "sync"
  23. "syscall"
  24. "time"
  25. flag "maunium.net/go/mauflag"
  26. log "maunium.net/go/maulogger/v2"
  27. "maunium.net/go/mautrix"
  28. "maunium.net/go/mautrix/appservice"
  29. "maunium.net/go/mautrix/event"
  30. "maunium.net/go/mautrix/id"
  31. "maunium.net/go/mautrix-whatsapp/config"
  32. "maunium.net/go/mautrix-whatsapp/database"
  33. "maunium.net/go/mautrix-whatsapp/database/upgrades"
  34. "maunium.net/go/mautrix-whatsapp/types"
  35. )
  36. var (
  37. // These are static
  38. Name = "mautrix-whatsapp"
  39. URL = "https://github.com/tulir/mautrix-whatsapp"
  40. // This is changed when making a release
  41. Version = "0.1.3"
  42. // This is filled by init()
  43. WAVersion = ""
  44. // These are filled at build time with the -X linker flag
  45. Tag = "unknown"
  46. Commit = "unknown"
  47. BuildTime = "unknown"
  48. )
  49. func init() {
  50. if len(Tag) > 0 && Tag[0] == 'v' {
  51. Tag = Tag[1:]
  52. }
  53. if Tag != Version && !strings.HasSuffix(Version, "+dev") {
  54. Version += "+dev"
  55. }
  56. WAVersion = strings.FieldsFunc(Version, func(r rune) bool { return r == '-' || r == '+' })[0]
  57. }
  58. var configPath = flag.MakeFull("c", "config", "The path to your config file.", "config.yaml").String()
  59. //var baseConfigPath = flag.MakeFull("b", "base-config", "The path to the example config file.", "example-config.yaml").String()
  60. var registrationPath = flag.MakeFull("r", "registration", "The path where to save the appservice registration.", "registration.yaml").String()
  61. var generateRegistration = flag.MakeFull("g", "generate-registration", "Generate registration and quit.", "false").Bool()
  62. var version = flag.MakeFull("v", "version", "View bridge version and quit.", "false").Bool()
  63. var ignoreUnsupportedDatabase = flag.Make().LongKey("ignore-unsupported-database").Usage("Run even if database is too new").Default("false").Bool()
  64. var migrateFrom = flag.Make().LongKey("migrate-db").Usage("Source database type and URI to migrate from.").Bool()
  65. var wantHelp, _ = flag.MakeHelpFlag()
  66. func (bridge *Bridge) GenerateRegistration() {
  67. reg, err := bridge.Config.NewRegistration()
  68. if err != nil {
  69. _, _ = fmt.Fprintln(os.Stderr, "Failed to generate registration:", err)
  70. os.Exit(20)
  71. }
  72. err = reg.Save(*registrationPath)
  73. if err != nil {
  74. _, _ = fmt.Fprintln(os.Stderr, "Failed to save registration:", err)
  75. os.Exit(21)
  76. }
  77. err = bridge.Config.Save(*configPath)
  78. if err != nil {
  79. _, _ = fmt.Fprintln(os.Stderr, "Failed to save config:", err)
  80. os.Exit(22)
  81. }
  82. fmt.Println("Registration generated. Add the path to the registration to your Synapse config, restart it, then start the bridge.")
  83. os.Exit(0)
  84. }
  85. func (bridge *Bridge) MigrateDatabase() {
  86. oldDB, err := database.New(flag.Arg(0), flag.Arg(1))
  87. if err != nil {
  88. fmt.Println("Failed to open old database:", err)
  89. os.Exit(30)
  90. }
  91. err = oldDB.Init()
  92. if err != nil {
  93. fmt.Println("Failed to upgrade old database:", err)
  94. os.Exit(31)
  95. }
  96. newDB, err := database.New(bridge.Config.AppService.Database.Type, bridge.Config.AppService.Database.URI)
  97. if err != nil {
  98. fmt.Println("Failed to open new database:", err)
  99. os.Exit(32)
  100. }
  101. err = newDB.Init()
  102. if err != nil {
  103. fmt.Println("Failed to upgrade new database:", err)
  104. os.Exit(33)
  105. }
  106. database.Migrate(oldDB, newDB)
  107. }
  108. type Bridge struct {
  109. AS *appservice.AppService
  110. EventProcessor *appservice.EventProcessor
  111. MatrixHandler *MatrixHandler
  112. Config *config.Config
  113. DB *database.Database
  114. Log log.Logger
  115. StateStore *database.SQLStateStore
  116. Provisioning *ProvisioningAPI
  117. Bot *appservice.IntentAPI
  118. Formatter *Formatter
  119. Relaybot *User
  120. Crypto Crypto
  121. Metrics *MetricsHandler
  122. usersByMXID map[id.UserID]*User
  123. usersByJID map[types.WhatsAppID]*User
  124. usersLock sync.Mutex
  125. managementRooms map[id.RoomID]*User
  126. managementRoomsLock sync.Mutex
  127. portalsByMXID map[id.RoomID]*Portal
  128. portalsByJID map[database.PortalKey]*Portal
  129. portalsLock sync.Mutex
  130. puppets map[types.WhatsAppID]*Puppet
  131. puppetsByCustomMXID map[id.UserID]*Puppet
  132. puppetsLock sync.Mutex
  133. }
  134. type Crypto interface {
  135. HandleMemberEvent(*event.Event)
  136. Decrypt(*event.Event) (*event.Event, error)
  137. Encrypt(id.RoomID, event.Type, event.Content) (*event.EncryptedEventContent, error)
  138. Init() error
  139. Start()
  140. Stop()
  141. }
  142. func NewBridge() *Bridge {
  143. bridge := &Bridge{
  144. usersByMXID: make(map[id.UserID]*User),
  145. usersByJID: make(map[types.WhatsAppID]*User),
  146. managementRooms: make(map[id.RoomID]*User),
  147. portalsByMXID: make(map[id.RoomID]*Portal),
  148. portalsByJID: make(map[database.PortalKey]*Portal),
  149. puppets: make(map[types.WhatsAppID]*Puppet),
  150. puppetsByCustomMXID: make(map[id.UserID]*Puppet),
  151. }
  152. var err error
  153. bridge.Config, err = config.Load(*configPath)
  154. if err != nil {
  155. _, _ = fmt.Fprintln(os.Stderr, "Failed to load config:", err)
  156. os.Exit(10)
  157. }
  158. return bridge
  159. }
  160. func (bridge *Bridge) ensureConnection() {
  161. for {
  162. resp, err := bridge.Bot.Whoami()
  163. if err != nil {
  164. if httpErr, ok := err.(mautrix.HTTPError); ok && httpErr.RespError != nil && httpErr.RespError.ErrCode == "M_UNKNOWN_ACCESS_TOKEN" {
  165. bridge.Log.Fatalln("Access token invalid. Is the registration installed in your homeserver correctly?")
  166. os.Exit(16)
  167. }
  168. bridge.Log.Errorfln("Failed to connect to homeserver: %v. Retrying in 10 seconds...", err)
  169. time.Sleep(10 * time.Second)
  170. } else if resp.UserID != bridge.Bot.UserID {
  171. bridge.Log.Fatalln("Unexpected user ID in whoami call: got %s, expected %s", resp.UserID, bridge.Bot.UserID)
  172. os.Exit(17)
  173. } else {
  174. break
  175. }
  176. }
  177. }
  178. func (bridge *Bridge) Init() {
  179. var err error
  180. bridge.AS, err = bridge.Config.MakeAppService()
  181. if err != nil {
  182. _, _ = fmt.Fprintln(os.Stderr, "Failed to initialize AppService:", err)
  183. os.Exit(11)
  184. }
  185. _, _ = bridge.AS.Init()
  186. bridge.Bot = bridge.AS.BotIntent()
  187. bridge.Log = log.Create()
  188. bridge.Config.Logging.Configure(bridge.Log)
  189. log.DefaultLogger = bridge.Log.(*log.BasicLogger)
  190. if len(bridge.Config.Logging.FileNameFormat) > 0 {
  191. err = log.OpenFile()
  192. if err != nil {
  193. _, _ = fmt.Fprintln(os.Stderr, "Failed to open log file:", err)
  194. os.Exit(12)
  195. }
  196. }
  197. bridge.AS.Log = log.Sub("Matrix")
  198. bridge.Log.Debugln("Initializing database")
  199. bridge.DB, err = database.New(bridge.Config.AppService.Database.Type, bridge.Config.AppService.Database.URI)
  200. if err != nil && (err != upgrades.UnsupportedDatabaseVersion || !*ignoreUnsupportedDatabase) {
  201. bridge.Log.Fatalln("Failed to initialize database:", err)
  202. os.Exit(14)
  203. }
  204. if len(bridge.Config.AppService.StateStore) > 0 && bridge.Config.AppService.StateStore != "./mx-state.json" {
  205. version, err := upgrades.GetVersion(bridge.DB.DB)
  206. if version < 0 && err == nil {
  207. bridge.Log.Fatalln("Non-standard state store path. Please move the state store to ./mx-state.json " +
  208. "and update the config. The state store will be migrated into the db on the next launch.")
  209. os.Exit(18)
  210. }
  211. }
  212. bridge.Log.Debugln("Initializing state store")
  213. bridge.StateStore = database.NewSQLStateStore(bridge.DB)
  214. bridge.AS.StateStore = bridge.StateStore
  215. bridge.DB.SetMaxOpenConns(bridge.Config.AppService.Database.MaxOpenConns)
  216. bridge.DB.SetMaxIdleConns(bridge.Config.AppService.Database.MaxIdleConns)
  217. ss := bridge.Config.AppService.Provisioning.SharedSecret
  218. if len(ss) > 0 && ss != "disable" {
  219. bridge.Provisioning = &ProvisioningAPI{bridge: bridge}
  220. }
  221. bridge.Log.Debugln("Initializing Matrix event processor")
  222. bridge.EventProcessor = appservice.NewEventProcessor(bridge.AS)
  223. bridge.Log.Debugln("Initializing Matrix event handler")
  224. bridge.MatrixHandler = NewMatrixHandler(bridge)
  225. bridge.Formatter = NewFormatter(bridge)
  226. bridge.Crypto = NewCryptoHelper(bridge)
  227. bridge.Metrics = NewMetricsHandler(bridge.Config.Metrics.Listen, bridge.Log.Sub("Metrics"), bridge.DB)
  228. }
  229. func (bridge *Bridge) Start() {
  230. err := bridge.DB.Init()
  231. if err != nil {
  232. bridge.Log.Fatalln("Failed to initialize database:", err)
  233. os.Exit(15)
  234. }
  235. bridge.Log.Debugln("Checking connection to homeserver")
  236. bridge.ensureConnection()
  237. if bridge.Crypto != nil {
  238. err := bridge.Crypto.Init()
  239. if err != nil {
  240. bridge.Log.Fatalln("Error initializing end-to-bridge encryption:", err)
  241. os.Exit(19)
  242. }
  243. }
  244. if bridge.Provisioning != nil {
  245. bridge.Log.Debugln("Initializing provisioning API")
  246. bridge.Provisioning.Init()
  247. }
  248. bridge.LoadRelaybot()
  249. bridge.Log.Debugln("Starting application service HTTP server")
  250. go bridge.AS.Start()
  251. bridge.Log.Debugln("Starting event processor")
  252. go bridge.EventProcessor.Start()
  253. go bridge.UpdateBotProfile()
  254. if bridge.Crypto != nil {
  255. go bridge.Crypto.Start()
  256. }
  257. go bridge.StartUsers()
  258. if bridge.Config.Metrics.Enabled {
  259. go bridge.Metrics.Start()
  260. }
  261. if bridge.Config.Bridge.ResendBridgeInfo {
  262. go bridge.ResendBridgeInfo()
  263. }
  264. }
  265. func (bridge *Bridge) ResendBridgeInfo() {
  266. bridge.Config.Bridge.ResendBridgeInfo = false
  267. err := bridge.Config.Save(*configPath)
  268. if err != nil {
  269. bridge.Log.Errorln("Failed to save config after setting resend_bridge_info to false:", err)
  270. }
  271. bridge.Log.Infoln("Re-sending bridge info state event to all portals")
  272. for _, portal := range bridge.GetAllPortals() {
  273. portal.UpdateBridgeInfo()
  274. }
  275. bridge.Log.Infoln("Finished re-sending bridge info state events")
  276. }
  277. func (bridge *Bridge) LoadRelaybot() {
  278. if !bridge.Config.Bridge.Relaybot.Enabled {
  279. return
  280. }
  281. bridge.Relaybot = bridge.GetUserByMXID("relaybot")
  282. if bridge.Relaybot.HasSession() {
  283. bridge.Log.Debugln("Relaybot is enabled")
  284. } else {
  285. bridge.Log.Debugln("Relaybot is enabled, but not logged in")
  286. }
  287. bridge.Relaybot.ManagementRoom = bridge.Config.Bridge.Relaybot.ManagementRoom
  288. bridge.Relaybot.IsRelaybot = true
  289. bridge.Relaybot.Connect(false)
  290. }
  291. func (bridge *Bridge) UpdateBotProfile() {
  292. bridge.Log.Debugln("Updating bot profile")
  293. botConfig := bridge.Config.AppService.Bot
  294. var err error
  295. var mxc id.ContentURI
  296. if botConfig.Avatar == "remove" {
  297. err = bridge.Bot.SetAvatarURL(mxc)
  298. } else if len(botConfig.Avatar) > 0 {
  299. mxc, err = id.ParseContentURI(botConfig.Avatar)
  300. if err == nil {
  301. err = bridge.Bot.SetAvatarURL(mxc)
  302. }
  303. }
  304. if err != nil {
  305. bridge.Log.Warnln("Failed to update bot avatar:", err)
  306. }
  307. if botConfig.Displayname == "remove" {
  308. err = bridge.Bot.SetDisplayName("")
  309. } else if len(botConfig.Avatar) > 0 {
  310. err = bridge.Bot.SetDisplayName(botConfig.Displayname)
  311. }
  312. if err != nil {
  313. bridge.Log.Warnln("Failed to update bot displayname:", err)
  314. }
  315. }
  316. func (bridge *Bridge) StartUsers() {
  317. bridge.Log.Debugln("Starting users")
  318. for _, user := range bridge.GetAllUsers() {
  319. go user.Connect(false)
  320. }
  321. bridge.Log.Debugln("Starting custom puppets")
  322. for _, loopuppet := range bridge.GetAllPuppetsWithCustomMXID() {
  323. go func(puppet *Puppet) {
  324. puppet.log.Debugln("Starting custom puppet", puppet.CustomMXID)
  325. err := puppet.StartCustomMXID()
  326. if err != nil {
  327. puppet.log.Errorln("Failed to start custom puppet:", err)
  328. }
  329. }(loopuppet)
  330. }
  331. }
  332. func (bridge *Bridge) Stop() {
  333. if bridge.Crypto != nil {
  334. bridge.Crypto.Stop()
  335. }
  336. bridge.AS.Stop()
  337. bridge.Metrics.Stop()
  338. bridge.EventProcessor.Stop()
  339. for _, user := range bridge.usersByJID {
  340. if user.Conn == nil {
  341. continue
  342. }
  343. bridge.Log.Debugln("Disconnecting", user.MXID)
  344. sess, err := user.Conn.Disconnect()
  345. if err != nil {
  346. bridge.Log.Errorfln("Error while disconnecting %s: %v", user.MXID, err)
  347. } else if len(sess.Wid) > 0 {
  348. user.SetSession(&sess)
  349. }
  350. }
  351. }
  352. func (bridge *Bridge) Main() {
  353. if *generateRegistration {
  354. bridge.GenerateRegistration()
  355. return
  356. } else if *migrateFrom {
  357. bridge.MigrateDatabase()
  358. return
  359. }
  360. bridge.Init()
  361. bridge.Log.Infoln("Bridge initialization complete, starting...")
  362. bridge.Start()
  363. bridge.Log.Infoln("Bridge started!")
  364. c := make(chan os.Signal)
  365. signal.Notify(c, os.Interrupt, syscall.SIGTERM)
  366. <-c
  367. bridge.Log.Infoln("Interrupt received, stopping...")
  368. bridge.Stop()
  369. bridge.Log.Infoln("Bridge stopped.")
  370. os.Exit(0)
  371. }
  372. func main() {
  373. flag.SetHelpTitles(
  374. "mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.",
  375. "mautrix-whatsapp [-h] [-c <path>] [-r <path>] [-g] [--migrate-db <source type> <source uri>]")
  376. err := flag.Parse()
  377. if err != nil {
  378. _, _ = fmt.Fprintln(os.Stderr, err)
  379. flag.PrintHelp()
  380. os.Exit(1)
  381. } else if *wantHelp {
  382. flag.PrintHelp()
  383. os.Exit(0)
  384. } else if *version {
  385. if Tag == Version {
  386. fmt.Printf("%s %s (%s)\n", Name, Tag, BuildTime)
  387. } else if len(Commit) > 8 {
  388. fmt.Printf("%s %s.%s (%s)\n", Name, Version, Commit[:8], BuildTime)
  389. } else {
  390. fmt.Printf("%s %s.unknown\n", Name, Version)
  391. }
  392. return
  393. }
  394. NewBridge().Main()
  395. }