bridge.go 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2021 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 config
  17. import (
  18. "fmt"
  19. "strconv"
  20. "strings"
  21. "text/template"
  22. "go.mau.fi/whatsmeow/types"
  23. "maunium.net/go/mautrix/event"
  24. "maunium.net/go/mautrix/id"
  25. )
  26. type BridgeConfig struct {
  27. UsernameTemplate string `yaml:"username_template"`
  28. DisplaynameTemplate string `yaml:"displayname_template"`
  29. DeliveryReceipts bool `yaml:"delivery_receipts"`
  30. PortalMessageBuffer int `yaml:"portal_message_buffer"`
  31. CallStartNotices bool `yaml:"call_start_notices"`
  32. HistorySync struct {
  33. CreatePortals bool `yaml:"create_portals"`
  34. MaxAge int64 `yaml:"max_age"`
  35. Backfill bool `yaml:"backfill"`
  36. DoublePuppetBackfill bool `yaml:"double_puppet_backfill"`
  37. RequestFullSync bool `yaml:"request_full_sync"`
  38. } `yaml:"history_sync"`
  39. UserAvatarSync bool `yaml:"user_avatar_sync"`
  40. BridgeMatrixLeave bool `yaml:"bridge_matrix_leave"`
  41. SyncWithCustomPuppets bool `yaml:"sync_with_custom_puppets"`
  42. SyncDirectChatList bool `yaml:"sync_direct_chat_list"`
  43. DefaultBridgeReceipts bool `yaml:"default_bridge_receipts"`
  44. DefaultBridgePresence bool `yaml:"default_bridge_presence"`
  45. LoginSharedSecret string `yaml:"login_shared_secret"`
  46. PrivateChatPortalMeta bool `yaml:"private_chat_portal_meta"`
  47. BridgeNotices bool `yaml:"bridge_notices"`
  48. ResendBridgeInfo bool `yaml:"resend_bridge_info"`
  49. MuteBridging bool `yaml:"mute_bridging"`
  50. ArchiveTag string `yaml:"archive_tag"`
  51. PinnedTag string `yaml:"pinned_tag"`
  52. TagOnlyOnCreate bool `yaml:"tag_only_on_create"`
  53. MarkReadOnlyOnCreate bool `yaml:"mark_read_only_on_create"`
  54. EnableStatusBroadcast bool `yaml:"enable_status_broadcast"`
  55. WhatsappThumbnail bool `yaml:"whatsapp_thumbnail"`
  56. AllowUserInvite bool `yaml:"allow_user_invite"`
  57. FederateRooms bool `yaml:"federate_rooms"`
  58. CommandPrefix string `yaml:"command_prefix"`
  59. ManagementRoomText struct {
  60. Welcome string `yaml:"welcome"`
  61. WelcomeConnected string `yaml:"welcome_connected"`
  62. WelcomeUnconnected string `yaml:"welcome_unconnected"`
  63. AdditionalHelp string `yaml:"additional_help"`
  64. } `yaml:"management_room_text"`
  65. Encryption struct {
  66. Allow bool `yaml:"allow"`
  67. Default bool `yaml:"default"`
  68. KeySharing struct {
  69. Allow bool `yaml:"allow"`
  70. RequireCrossSigning bool `yaml:"require_cross_signing"`
  71. RequireVerification bool `yaml:"require_verification"`
  72. } `yaml:"key_sharing"`
  73. } `yaml:"encryption"`
  74. Permissions PermissionConfig `yaml:"permissions"`
  75. Relay RelaybotConfig `yaml:"relay"`
  76. usernameTemplate *template.Template `yaml:"-"`
  77. displaynameTemplate *template.Template `yaml:"-"`
  78. }
  79. type umBridgeConfig BridgeConfig
  80. func (bc *BridgeConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
  81. err := unmarshal((*umBridgeConfig)(bc))
  82. if err != nil {
  83. return err
  84. }
  85. bc.usernameTemplate, err = template.New("username").Parse(bc.UsernameTemplate)
  86. if err != nil {
  87. return err
  88. } else if !strings.Contains(bc.FormatUsername("1234567890"), "1234567890") {
  89. return fmt.Errorf("username template is missing user ID placeholder")
  90. }
  91. bc.displaynameTemplate, err = template.New("displayname").Parse(bc.DisplaynameTemplate)
  92. if err != nil {
  93. return err
  94. }
  95. return nil
  96. }
  97. type UsernameTemplateArgs struct {
  98. UserID id.UserID
  99. }
  100. type legacyContactInfo struct {
  101. types.ContactInfo
  102. Phone string
  103. Notify string
  104. VName string
  105. Name string
  106. Short string
  107. JID string
  108. }
  109. func (bc BridgeConfig) FormatDisplayname(jid types.JID, contact types.ContactInfo) (string, int8) {
  110. var buf strings.Builder
  111. _ = bc.displaynameTemplate.Execute(&buf, legacyContactInfo{
  112. ContactInfo: contact,
  113. Notify: contact.PushName,
  114. VName: contact.BusinessName,
  115. Name: contact.FullName,
  116. Short: contact.FirstName,
  117. Phone: "+" + jid.User,
  118. JID: "+" + jid.User,
  119. })
  120. var quality int8
  121. switch {
  122. case len(contact.PushName) > 0 || len(contact.BusinessName) > 0:
  123. quality = 3
  124. case len(contact.FullName) > 0 || len(contact.FirstName) > 0:
  125. quality = 2
  126. default:
  127. quality = 1
  128. }
  129. return buf.String(), quality
  130. }
  131. func (bc BridgeConfig) FormatUsername(username string) string {
  132. var buf strings.Builder
  133. _ = bc.usernameTemplate.Execute(&buf, username)
  134. return buf.String()
  135. }
  136. type PermissionConfig map[string]PermissionLevel
  137. type PermissionLevel int
  138. const (
  139. PermissionLevelDefault PermissionLevel = 0
  140. PermissionLevelRelay PermissionLevel = 5
  141. PermissionLevelUser PermissionLevel = 10
  142. PermissionLevelAdmin PermissionLevel = 100
  143. )
  144. func (pc *PermissionConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
  145. rawPC := make(map[string]string)
  146. err := unmarshal(&rawPC)
  147. if err != nil {
  148. return err
  149. }
  150. if *pc == nil {
  151. *pc = make(map[string]PermissionLevel)
  152. }
  153. for key, value := range rawPC {
  154. switch strings.ToLower(value) {
  155. case "relaybot", "relay":
  156. (*pc)[key] = PermissionLevelRelay
  157. case "user":
  158. (*pc)[key] = PermissionLevelUser
  159. case "admin":
  160. (*pc)[key] = PermissionLevelAdmin
  161. default:
  162. val, err := strconv.Atoi(value)
  163. if err != nil {
  164. (*pc)[key] = PermissionLevelDefault
  165. } else {
  166. (*pc)[key] = PermissionLevel(val)
  167. }
  168. }
  169. }
  170. return nil
  171. }
  172. func (pc *PermissionConfig) MarshalYAML() (interface{}, error) {
  173. if *pc == nil {
  174. return nil, nil
  175. }
  176. rawPC := make(map[string]string)
  177. for key, value := range *pc {
  178. switch value {
  179. case PermissionLevelRelay:
  180. rawPC[key] = "relay"
  181. case PermissionLevelUser:
  182. rawPC[key] = "user"
  183. case PermissionLevelAdmin:
  184. rawPC[key] = "admin"
  185. default:
  186. rawPC[key] = strconv.Itoa(int(value))
  187. }
  188. }
  189. return rawPC, nil
  190. }
  191. func (pc PermissionConfig) IsRelayWhitelisted(userID id.UserID) bool {
  192. return pc.GetPermissionLevel(userID) >= PermissionLevelRelay
  193. }
  194. func (pc PermissionConfig) IsWhitelisted(userID id.UserID) bool {
  195. return pc.GetPermissionLevel(userID) >= PermissionLevelUser
  196. }
  197. func (pc PermissionConfig) IsAdmin(userID id.UserID) bool {
  198. return pc.GetPermissionLevel(userID) >= PermissionLevelAdmin
  199. }
  200. func (pc PermissionConfig) GetPermissionLevel(userID id.UserID) PermissionLevel {
  201. permissions, ok := pc[string(userID)]
  202. if ok {
  203. return permissions
  204. }
  205. _, homeserver, _ := userID.Parse()
  206. permissions, ok = pc[homeserver]
  207. if len(homeserver) > 0 && ok {
  208. return permissions
  209. }
  210. permissions, ok = pc["*"]
  211. if ok {
  212. return permissions
  213. }
  214. return PermissionLevelDefault
  215. }
  216. type RelaybotConfig struct {
  217. Enabled bool `yaml:"enabled"`
  218. AdminOnly bool `yaml:"admin_only"`
  219. MessageFormats map[event.MessageType]string `yaml:"message_formats"`
  220. messageTemplates *template.Template `yaml:"-"`
  221. }
  222. type umRelaybotConfig RelaybotConfig
  223. func (rc *RelaybotConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
  224. err := unmarshal((*umRelaybotConfig)(rc))
  225. if err != nil {
  226. return err
  227. }
  228. rc.messageTemplates = template.New("messageTemplates")
  229. for key, format := range rc.MessageFormats {
  230. _, err := rc.messageTemplates.New(string(key)).Parse(format)
  231. if err != nil {
  232. return err
  233. }
  234. }
  235. return nil
  236. }
  237. type Sender struct {
  238. UserID string
  239. event.MemberEventContent
  240. }
  241. type formatData struct {
  242. Sender Sender
  243. Message string
  244. Content *event.MessageEventContent
  245. }
  246. func (rc *RelaybotConfig) FormatMessage(content *event.MessageEventContent, sender id.UserID, member event.MemberEventContent) (string, error) {
  247. if len(member.Displayname) == 0 {
  248. member.Displayname = sender.String()
  249. }
  250. member.Displayname = template.HTMLEscapeString(member.Displayname)
  251. var output strings.Builder
  252. err := rc.messageTemplates.ExecuteTemplate(&output, string(content.MsgType), formatData{
  253. Sender: Sender{
  254. UserID: template.HTMLEscapeString(sender.String()),
  255. MemberEventContent: member,
  256. },
  257. Content: content,
  258. Message: content.FormattedBody,
  259. })
  260. return output.String(), err
  261. }