buddy_list_manager.go 22 KB

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