buddy_list_manager.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643
  1. package webapi
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "log/slog"
  7. "math/rand"
  8. "slices"
  9. "strings"
  10. "github.com/mk6i/open-oscar-server/state"
  11. "github.com/mk6i/open-oscar-server/wire"
  12. )
  13. // BuddyListManager handles the conversion of OSCAR feedbag data
  14. // to WebAPI buddy list format for web clients.
  15. type BuddyListManager struct {
  16. feedbagService FeedbagService
  17. locateService LocateService
  18. iconSource BuddyIconSource
  19. logger *slog.Logger
  20. }
  21. // NewBuddyListManager creates a new instance of the buddy list manager.
  22. func NewBuddyListManager(feedbagService FeedbagService, locateService LocateService, iconSource BuddyIconSource, logger *slog.Logger) *BuddyListManager {
  23. return &BuddyListManager{
  24. feedbagService: feedbagService,
  25. locateService: locateService,
  26. iconSource: iconSource,
  27. logger: logger,
  28. }
  29. }
  30. // BuddyGroup represents a group in the WebAPI buddy list format.
  31. type BuddyGroup struct {
  32. Name string `json:"name" xml:"name"`
  33. // ID is the feedbag group id, read strictly by clients. It follows Name to keep
  34. // the rendered element order unchanged.
  35. ID int `json:"id" xml:"id"`
  36. Buddies []BuddyInfo `json:"buddies" xml:"buddies>buddy"`
  37. Recent bool `json:"recent,omitempty" xml:"recent,omitempty"`
  38. // Smart is null or a number. It is a pointer rather than an interface so
  39. // encoding/xml can render it: a non-nil interface holding a map cannot be
  40. // marshalled, while a nil pointer is simply omitted.
  41. Smart *int `json:"smart,omitempty" xml:"smart,omitempty"`
  42. }
  43. // BuddyInfo represents a buddy in the WebAPI format.
  44. type BuddyInfo struct {
  45. AimID string `json:"aimId" xml:"aimId"`
  46. DisplayID string `json:"displayId" xml:"displayId"`
  47. Friendly string `json:"friendly,omitempty" xml:"friendly,omitempty"` // Viewer's private alias, rendered in preference to DisplayID
  48. State string `json:"state" xml:"state"` // "online", "offline", "away", "idle"
  49. StatusMsg string `json:"statusMsg,omitempty" xml:"statusMsg,omitempty"`
  50. AwayMsg string `json:"awayMsg,omitempty" xml:"awayMsg,omitempty"`
  51. OnlineTime int64 `json:"onlineTime,omitempty" xml:"onlineTime,omitempty"`
  52. IdleTime int `json:"idleTime,omitempty" xml:"idleTime,omitempty"` // Minutes idle
  53. UserType string `json:"userType" xml:"userType"` // "aim", "icq", "admin"
  54. Bot bool `json:"bot" xml:"bot"`
  55. Service string `json:"service,omitempty" xml:"service,omitempty"` // "AIM", "ICQ" (Web AIM client compares case-sensitively)
  56. PresenceIcon string `json:"presenceIcon,omitempty" xml:"presenceIcon,omitempty"`
  57. BuddyIcon string `json:"buddyIcon,omitempty" xml:"buddyIcon,omitempty"`
  58. Capabilities []string `json:"capabilities,omitempty" xml:"capabilities>capability,omitempty"`
  59. MemberSince int64 `json:"memberSince,omitempty" xml:"memberSince,omitempty"`
  60. }
  61. // GetBuddyListForUser retrieves and converts the buddy list for a user.
  62. func (m *BuddyListManager) GetBuddyListForUser(ctx context.Context, sess *Session) ([]BuddyGroup, error) {
  63. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  64. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  65. if err != nil {
  66. return nil, fmt.Errorf("failed to retrieve feedbag: %w", err)
  67. }
  68. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  69. if !ok {
  70. return nil, fmt.Errorf("failed to retrieve feedbag: unexpected reply type")
  71. }
  72. items := reply.Items
  73. type buddy struct {
  74. name string
  75. alias string
  76. }
  77. type group struct {
  78. name string
  79. buddies map[uint16]buddy
  80. order []uint16
  81. }
  82. type feedbagBL struct {
  83. order []uint16
  84. groups map[uint16]group
  85. }
  86. bl := feedbagBL{groups: make(map[uint16]group)}
  87. for _, item := range items {
  88. if item.ClassID != wire.FeedbagClassIdGroup {
  89. continue
  90. }
  91. if item.GroupID == 0 {
  92. val, hasVal := item.Uint16SliceBE(wire.FeedbagAttributesOrder)
  93. if hasVal {
  94. bl.order = val
  95. }
  96. continue
  97. }
  98. name := item.Name
  99. if name == "" {
  100. name = "Buddies"
  101. }
  102. g := group{
  103. name: name,
  104. buddies: make(map[uint16]buddy),
  105. }
  106. val, _ := item.Uint16SliceBE(wire.FeedbagAttributesOrder)
  107. g.order = val
  108. bl.groups[item.GroupID] = g
  109. }
  110. for _, item := range items {
  111. if item.ClassID != wire.FeedbagClassIdBuddy || item.Name == "" {
  112. continue
  113. }
  114. if _, exists := bl.groups[item.GroupID]; !exists {
  115. bl.groups[item.GroupID] = group{
  116. name: "Buddies",
  117. buddies: make(map[uint16]buddy),
  118. order: nil,
  119. }
  120. }
  121. b := buddy{name: item.Name}
  122. if val, hasVal := item.String(wire.FeedbagAttributesAlias); hasVal {
  123. b.alias = val
  124. }
  125. g := bl.groups[item.GroupID]
  126. g.buddies[item.ItemID] = b
  127. bl.groups[item.GroupID] = g
  128. }
  129. groupOrder := bl.order
  130. if len(groupOrder) == 0 && len(bl.groups) > 0 {
  131. groupOrder = make([]uint16, 0, len(bl.groups))
  132. for gid := range bl.groups {
  133. groupOrder = append(groupOrder, gid)
  134. }
  135. slices.Sort(groupOrder)
  136. }
  137. var out []BuddyGroup
  138. for _, gid := range groupOrder {
  139. g, ok := bl.groups[gid]
  140. if !ok {
  141. continue
  142. }
  143. groupName := g.name
  144. if groupName == "" {
  145. groupName = "Buddies"
  146. }
  147. wg := BuddyGroup{ID: int(gid), Name: groupName, Buddies: []BuddyInfo{}}
  148. for _, bid := range g.order {
  149. b, ok := g.buddies[bid]
  150. if !ok {
  151. continue
  152. }
  153. info := m.getBuddyInfo(ctx, sess.OSCARSession, sess.BaseURL, b.name)
  154. // The alias belongs in friendly, not displayId: the client renders
  155. // friendly in preference to displayId but still shows displayId as
  156. // the buddy's actual screen name.
  157. info.Friendly = b.alias
  158. wg.Buddies = append(wg.Buddies, info)
  159. }
  160. out = append(out, wg)
  161. }
  162. return out, nil
  163. }
  164. // getBuddyInfo retrieves a buddy's current presence by issuing a locate
  165. // UserInfoQuery on behalf of the requesting session's OSCAR instance.
  166. func (m *BuddyListManager) getBuddyInfo(ctx context.Context, instance *state.SessionInstance, baseURL string, buddyName string) BuddyInfo {
  167. // Default to offline. The web client keys users by the normalized aimId and
  168. // shallow-merges each buddy map onto the shared user object, so a display-form
  169. // aimId here overwrites the id every other event is keyed by.
  170. //
  171. // Feedbag buddy names are stored normalized, so they are not a source of
  172. // display names. DisplayID is filled in from the locate reply below when the
  173. // buddy is online, or overridden by the caller's alias when one is set.
  174. ident := state.NewIdentScreenName(buddyName)
  175. info := BuddyInfo{
  176. AimID: ident.String(),
  177. DisplayID: buddyName,
  178. State: "offline",
  179. UserType: "aim",
  180. Bot: false,
  181. Service: "AIM",
  182. }
  183. reply, err := m.locateService.UserInfoQuery(ctx, instance, wire.SNACFrame{},
  184. wire.SNAC_0x02_0x05_LocateUserInfoQuery{
  185. Type: uint16(wire.LocateTypeUnavailable), // away message
  186. ScreenName: ident.String(),
  187. })
  188. if err != nil {
  189. m.logger.WarnContext(ctx, "failed to query buddy info", "screenName", buddyName, "error", err)
  190. return info
  191. }
  192. userInfo, ok := reply.Body.(wire.SNAC_0x02_0x06_LocateUserInfoReply)
  193. if !ok {
  194. // Locate error => buddy is blocked or offline.
  195. return info
  196. }
  197. info.State = "online"
  198. info.Capabilities = []string{}
  199. // Publish the icon only now that locate has confirmed the buddy is online and
  200. // has not blocked the caller. Offline and blocking buddies return above without
  201. // an icon, so neither their icon nor its activity-revealing hash leaks.
  202. info.BuddyIcon = m.iconSource.PublishedURL(ctx, baseURL, ident)
  203. // The locate reply carries the screen name as the buddy formatted it.
  204. if userInfo.ScreenName != "" {
  205. info.DisplayID = userInfo.ScreenName
  206. }
  207. if tod, ok := userInfo.Uint32BE(wire.OServiceUserInfoSignonTOD); ok {
  208. info.OnlineTime = int64(tod)
  209. }
  210. if st := statusBitState(userInfo.TLVUserInfo); st != "" {
  211. info.State = st
  212. } else if userInfo.IsAway() {
  213. info.State = "away"
  214. if msg, ok := userInfo.LocateInfo.String(wire.LocateTLVTagsInfoUnavailableData); ok {
  215. info.AwayMsg = msg
  216. }
  217. }
  218. if idle, ok := userInfo.Uint16BE(wire.OServiceUserInfoIdleTime); ok && idle > 0 {
  219. info.IdleTime = int(idle)
  220. if info.State == "online" {
  221. info.State = "idle"
  222. }
  223. }
  224. return info
  225. }
  226. // RemoveBuddyFromFeedbag removes a buddy from a group (or all groups if allGroups is true) using feedbag delete/update SNACs.
  227. func (m *BuddyListManager) RemoveBuddyFromFeedbag(ctx context.Context, sess *Session, buddyName, groupName string, allGroups bool) (resultCode string, err error) {
  228. // Buddy items carry the owner's alias for the buddy, and the feedbag service
  229. // relays a session's own writes only to the owner's other instances, so every
  230. // method here that rewrites buddy items has to drop the alias cache itself.
  231. defer sess.InvalidateAliases()
  232. buddyName = strings.TrimSpace(buddyName)
  233. if buddyName == "" {
  234. return "error", fmt.Errorf("empty buddy")
  235. }
  236. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  237. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  238. if err != nil {
  239. m.logger.ErrorContext(ctx, "remove buddy: feedbag query failed", "err", err.Error())
  240. return "error", err
  241. }
  242. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  243. if !ok {
  244. return "error", fmt.Errorf("unexpected feedbag reply type")
  245. }
  246. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  247. target := groupName
  248. if allGroups {
  249. target = "*"
  250. }
  251. if err := fl.DeleteBuddy(target, buddyName); err != nil {
  252. if errors.Is(err, state.ErrGroupNotFound) {
  253. return "notFound", nil
  254. }
  255. m.logger.ErrorContext(ctx, "remove buddy: DeleteBuddy failed", "err", err.Error())
  256. return "error", err
  257. }
  258. if pending := fl.PendingDeletes(); len(pending) > 0 {
  259. delFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem}
  260. delBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: pending}
  261. if _, err := m.feedbagService.DeleteItem(ctx, sess.OSCARSession, delFrame, delBody); err != nil {
  262. m.logger.ErrorContext(ctx, "remove buddy: Feedbag DeleteItem failed", "err", err.Error())
  263. return "error", err
  264. }
  265. } else {
  266. return "notFound", nil
  267. }
  268. if pending := fl.PendingUpdates(); len(pending) > 0 {
  269. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  270. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, pending); err != nil {
  271. m.logger.ErrorContext(ctx, "remove buddy: Feedbag UpsertItem failed", "err", err.Error())
  272. return "error", err
  273. }
  274. }
  275. return "success", nil
  276. }
  277. // RemoveGroupFromFeedbag deletes a buddy group and updates the root order (TOC DelGroup).
  278. func (m *BuddyListManager) RemoveGroupFromFeedbag(ctx context.Context, sess *Session, requestedGroup string) (resultCode string, err error) {
  279. defer sess.InvalidateAliases()
  280. req := strings.TrimSpace(requestedGroup)
  281. if req == "" {
  282. return "error", fmt.Errorf("empty group")
  283. }
  284. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  285. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  286. if err != nil {
  287. m.logger.ErrorContext(ctx, "remove group: feedbag query failed", "err", err.Error())
  288. return "error", err
  289. }
  290. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  291. if !ok {
  292. return "error", fmt.Errorf("unexpected feedbag reply type")
  293. }
  294. storedName, found := storedGroupNameForRequest(reply.Items, req)
  295. if !found {
  296. return "notFound", nil
  297. }
  298. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  299. fl.DeleteGroup(storedName)
  300. if pending := fl.PendingDeletes(); len(pending) > 0 {
  301. delFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem}
  302. delBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: pending}
  303. if _, err := m.feedbagService.DeleteItem(ctx, sess.OSCARSession, delFrame, delBody); err != nil {
  304. m.logger.ErrorContext(ctx, "remove group: Feedbag DeleteItem failed", "err", err.Error())
  305. return "error", err
  306. }
  307. } else {
  308. return "notFound", nil
  309. }
  310. if pending := fl.PendingUpdates(); len(pending) > 0 {
  311. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  312. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, pending); err != nil {
  313. m.logger.ErrorContext(ctx, "remove group: Feedbag UpsertItem failed", "err", err.Error())
  314. return "error", err
  315. }
  316. }
  317. return "success", nil
  318. }
  319. // RenameGroupInFeedbag renames a buddy group, updating the group item in place.
  320. func (m *BuddyListManager) RenameGroupInFeedbag(ctx context.Context, sess *Session, oldGroup, newGroup string) (resultCode string, err error) {
  321. defer sess.InvalidateAliases()
  322. oldGroup = strings.TrimSpace(oldGroup)
  323. newGroup = strings.TrimSpace(newGroup)
  324. if oldGroup == "" || newGroup == "" {
  325. return "error", fmt.Errorf("empty group name")
  326. }
  327. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  328. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  329. if err != nil {
  330. m.logger.ErrorContext(ctx, "rename group: feedbag query failed", "err", err.Error())
  331. return "error", err
  332. }
  333. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  334. if !ok {
  335. return "error", fmt.Errorf("unexpected feedbag reply type")
  336. }
  337. storedName, found := storedGroupNameForRequest(reply.Items, oldGroup)
  338. if !found {
  339. return "notFound", nil
  340. }
  341. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  342. if err := fl.RenameGroup(storedName, newGroup); err != nil {
  343. switch {
  344. case errors.Is(err, state.ErrGroupNotFound):
  345. return "notFound", nil
  346. case errors.Is(err, state.ErrGroupExists):
  347. return "alreadyExists", nil
  348. default:
  349. m.logger.ErrorContext(ctx, "rename group: RenameGroup failed", "err", err.Error())
  350. return "error", err
  351. }
  352. }
  353. if pending := fl.PendingUpdates(); len(pending) > 0 {
  354. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  355. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, pending); err != nil {
  356. m.logger.ErrorContext(ctx, "rename group: Feedbag UpsertItem failed", "err", err.Error())
  357. return "error", err
  358. }
  359. }
  360. return "success", nil
  361. }
  362. // MoveBuddyInFeedbag moves a buddy to a different group and/or repositions it
  363. // within a group's order.
  364. func (m *BuddyListManager) MoveBuddyInFeedbag(ctx context.Context, sess *Session, buddyName, fromGroup, toGroup, beforeBuddy string) (resultCode string, err error) {
  365. defer sess.InvalidateAliases()
  366. buddyName = strings.TrimSpace(buddyName)
  367. fromGroup = strings.TrimSpace(fromGroup)
  368. toGroup = strings.TrimSpace(toGroup)
  369. beforeBuddy = strings.TrimSpace(beforeBuddy)
  370. if buddyName == "" || fromGroup == "" {
  371. return "error", fmt.Errorf("empty buddy or group")
  372. }
  373. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  374. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  375. if err != nil {
  376. m.logger.ErrorContext(ctx, "move buddy: feedbag query failed", "err", err.Error())
  377. return "error", err
  378. }
  379. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  380. if !ok {
  381. return "error", fmt.Errorf("unexpected feedbag reply type")
  382. }
  383. storedFrom, found := storedGroupNameForRequest(reply.Items, fromGroup)
  384. if !found {
  385. return "notFound", nil
  386. }
  387. storedTo := ""
  388. if toGroup != "" {
  389. storedTo, found = storedGroupNameForRequest(reply.Items, toGroup)
  390. if !found {
  391. return "notFound", nil
  392. }
  393. }
  394. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  395. if err := fl.MoveBuddy(storedFrom, storedTo, buddyName, beforeBuddy); err != nil {
  396. if errors.Is(err, state.ErrGroupNotFound) || errors.Is(err, state.ErrBuddyNotFound) {
  397. return "notFound", nil
  398. }
  399. m.logger.ErrorContext(ctx, "move buddy: MoveBuddy failed", "err", err.Error())
  400. return "error", err
  401. }
  402. if pending := fl.PendingDeletes(); len(pending) > 0 {
  403. delFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagDeleteItem}
  404. delBody := wire.SNAC_0x13_0x0A_FeedbagDeleteItem{Items: pending}
  405. if _, err := m.feedbagService.DeleteItem(ctx, sess.OSCARSession, delFrame, delBody); err != nil {
  406. m.logger.ErrorContext(ctx, "move buddy: Feedbag DeleteItem failed", "err", err.Error())
  407. return "error", err
  408. }
  409. }
  410. if pending := fl.PendingUpdates(); len(pending) > 0 {
  411. var inserts, updates []wire.FeedbagItem
  412. for _, item := range pending {
  413. if item.ClassID == wire.FeedbagClassIdBuddy {
  414. inserts = append(inserts, item)
  415. } else {
  416. updates = append(updates, item)
  417. }
  418. }
  419. if len(inserts) > 0 {
  420. insFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagInsertItem}
  421. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, insFrame, inserts); err != nil {
  422. m.logger.ErrorContext(ctx, "move buddy: Feedbag InsertItem failed", "err", err.Error())
  423. return "error", err
  424. }
  425. }
  426. if len(updates) > 0 {
  427. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  428. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, updates); err != nil {
  429. m.logger.ErrorContext(ctx, "move buddy: Feedbag UpdateItem failed", "err", err.Error())
  430. return "error", err
  431. }
  432. }
  433. }
  434. return "success", nil
  435. }
  436. // SetBuddyAttributeInFeedbag sets a buddy's friendly (alias) name across all
  437. // groups it belongs to. An empty friendly clears the alias.
  438. func (m *BuddyListManager) SetBuddyAttributeInFeedbag(ctx context.Context, sess *Session, buddyName, friendly string) (resultCode string, err error) {
  439. defer sess.InvalidateAliases()
  440. buddyName = strings.TrimSpace(buddyName)
  441. if buddyName == "" {
  442. return "error", fmt.Errorf("empty buddy")
  443. }
  444. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  445. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  446. if err != nil {
  447. m.logger.ErrorContext(ctx, "set buddy attribute: feedbag query failed", "err", err.Error())
  448. return "error", err
  449. }
  450. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  451. if !ok {
  452. return "error", fmt.Errorf("unexpected feedbag reply type")
  453. }
  454. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  455. found, err := fl.SetBuddyAlias(buddyName, friendly)
  456. if err != nil {
  457. m.logger.ErrorContext(ctx, "set buddy attribute: SetBuddyAlias failed", "err", err.Error())
  458. return "error", err
  459. }
  460. if !found {
  461. return "notFound", nil
  462. }
  463. if pending := fl.PendingUpdates(); len(pending) > 0 {
  464. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  465. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, pending); err != nil {
  466. m.logger.ErrorContext(ctx, "set buddy attribute: Feedbag UpsertItem failed", "err", err.Error())
  467. return "error", err
  468. }
  469. }
  470. return "success", nil
  471. }
  472. // SetGroupAttributeInFeedbag sets a group's collapsed state. An empty group
  473. // targets the unnamed default group.
  474. func (m *BuddyListManager) SetGroupAttributeInFeedbag(ctx context.Context, sess *Session, groupName string, collapsed bool) (resultCode string, err error) {
  475. defer sess.InvalidateAliases()
  476. groupName = strings.TrimSpace(groupName)
  477. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  478. snac, err := m.feedbagService.Query(ctx, sess.OSCARSession, frame)
  479. if err != nil {
  480. m.logger.ErrorContext(ctx, "set group attribute: feedbag query failed", "err", err.Error())
  481. return "error", err
  482. }
  483. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  484. if !ok {
  485. return "error", fmt.Errorf("unexpected feedbag reply type")
  486. }
  487. // An empty group targets the unnamed default group (stored name ""); a named
  488. // group is resolved through the "Buddies" default-label mapping.
  489. storedName := ""
  490. if groupName != "" {
  491. var found bool
  492. storedName, found = storedGroupNameForRequest(reply.Items, groupName)
  493. if !found {
  494. return "notFound", nil
  495. }
  496. }
  497. fl := state.NewFeedbagList(reply.Items, rand.Intn)
  498. if err := fl.SetGroupCollapsed(storedName, collapsed); err != nil {
  499. if errors.Is(err, state.ErrGroupNotFound) {
  500. return "notFound", nil
  501. }
  502. m.logger.ErrorContext(ctx, "set group attribute: SetGroupCollapsed failed", "err", err.Error())
  503. return "error", err
  504. }
  505. if pending := fl.PendingUpdates(); len(pending) > 0 {
  506. upFrame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagUpdateItem}
  507. if _, err := m.feedbagService.UpsertItem(ctx, sess.OSCARSession, upFrame, pending); err != nil {
  508. m.logger.ErrorContext(ctx, "set group attribute: Feedbag UpsertItem failed", "err", err.Error())
  509. return "error", err
  510. }
  511. }
  512. return "success", nil
  513. }
  514. // feedbagGroupMatchesRequested returns true if a feedbag group row matches the
  515. // group the Web client asked for. OSCAR often stores the default group with an
  516. // empty name; GetBuddyListForUser labels that as "Buddies", so addBuddy must
  517. // treat "" and "Buddies" as the same bucket when the client sends group=Buddies.
  518. func feedbagGroupMatchesRequested(storedName, requested string) bool {
  519. req := strings.TrimSpace(requested)
  520. st := strings.TrimSpace(storedName)
  521. if strings.EqualFold(st, req) {
  522. return true
  523. }
  524. if strings.EqualFold(strings.TrimSpace(req), "Buddies") && st == "" {
  525. return true
  526. }
  527. return false
  528. }
  529. // storedGroupNameForRequest returns the feedbag group row Name for a Web client group label.
  530. // Rows with GroupID 0 are the root order record, not a named buddy group.
  531. func storedGroupNameForRequest(items []wire.FeedbagItem, requested string) (string, bool) {
  532. for _, item := range items {
  533. if item.ClassID != wire.FeedbagClassIdGroup {
  534. continue
  535. }
  536. if item.GroupID == 0 {
  537. continue
  538. }
  539. if feedbagGroupMatchesRequested(item.Name, requested) {
  540. return item.Name, true
  541. }
  542. }
  543. return "", false
  544. }
  545. // FeedbagAliases collects the aliases the feedbag owner has assigned to their
  546. // buddies, keyed by normalized screen name. Buddies without an alias are absent.
  547. func FeedbagAliases(items []wire.FeedbagItem) map[string]string {
  548. aliases := make(map[string]string)
  549. for _, item := range items {
  550. if item.ClassID != wire.FeedbagClassIdBuddy || item.Name == "" {
  551. continue
  552. }
  553. alias, ok := item.String(wire.FeedbagAttributesAlias)
  554. if !ok || alias == "" {
  555. continue
  556. }
  557. aliases[state.NewIdentScreenName(item.Name).String()] = alias
  558. }
  559. return aliases
  560. }
  561. // LookupBuddyAliases returns the aliases the session owner has assigned to their
  562. // buddies, keyed by normalized screen name.
  563. //
  564. // Aliases are private to the viewer and live only in their feedbag, so they cannot
  565. // be derived from a locate reply the way display names are.
  566. func LookupBuddyAliases(ctx context.Context, feedbagService FeedbagService, instance *state.SessionInstance) (map[string]string, error) {
  567. frame := wire.SNACFrame{FoodGroup: wire.Feedbag, SubGroup: wire.FeedbagQuery}
  568. snac, err := feedbagService.Query(ctx, instance, frame)
  569. if err != nil {
  570. return nil, err
  571. }
  572. reply, ok := snac.Body.(wire.SNAC_0x13_0x06_FeedbagReply)
  573. if !ok {
  574. return nil, fmt.Errorf("unexpected feedbag reply type")
  575. }
  576. return FeedbagAliases(reply.Items), nil
  577. }