| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482 |
- package handlers
- import (
- "context"
- "log/slog"
- "net/http"
- "strconv"
- "strings"
- "github.com/mk6i/open-oscar-server/state"
- "github.com/mk6i/open-oscar-server/wire"
- )
- // PreferenceHandler handles Web AIM API preference-related endpoints.
- type PreferenceHandler struct {
- SessionManager *state.WebAPISessionManager
- PreferenceManager PreferenceManager
- PermitDenyManager PermitDenyManager
- Logger *slog.Logger
- }
- // PreferenceManager provides methods to manage user preferences.
- type PreferenceManager interface {
- SetPreferences(ctx context.Context, screenName state.IdentScreenName, prefs map[string]interface{}) error
- GetPreferences(ctx context.Context, screenName state.IdentScreenName) (map[string]interface{}, error)
- }
- // PermitDenyManager provides methods to manage permit/deny lists.
- type PermitDenyManager interface {
- SetPDMode(ctx context.Context, screenName state.IdentScreenName, mode wire.FeedbagPDMode) error
- GetPDMode(ctx context.Context, screenName state.IdentScreenName) (wire.FeedbagPDMode, error)
- GetPermitList(ctx context.Context, screenName state.IdentScreenName) ([]state.IdentScreenName, error)
- GetDenyList(ctx context.Context, screenName state.IdentScreenName) ([]state.IdentScreenName, error)
- AddPermitBuddy(ctx context.Context, me state.IdentScreenName, them state.IdentScreenName) error
- RemovePermitBuddy(ctx context.Context, me state.IdentScreenName, them state.IdentScreenName) error
- AddDenyBuddy(ctx context.Context, me state.IdentScreenName, them state.IdentScreenName) error
- RemoveDenyBuddy(ctx context.Context, me state.IdentScreenName, them state.IdentScreenName) error
- }
- // PermitDenyData contains permit/deny list information.
- type PermitDenyData struct {
- PDMode int `json:"pdMode" xml:"pdMode"`
- PermitList []string `json:"permitList,omitempty" xml:"permitList>user,omitempty"`
- DenyList []string `json:"denyList,omitempty" xml:"denyList>user,omitempty"`
- }
- // SetPreferences handles GET /preference/set requests to update user preferences.
- func (h *PreferenceHandler) SetPreferences(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- // Get session ID from parameters
- aimsid := r.URL.Query().Get("aimsid")
- if aimsid == "" {
- h.sendError(w, http.StatusBadRequest, "missing aimsid parameter")
- return
- }
- // Get session
- session, err := h.SessionManager.GetSession(r.Context(), aimsid)
- if err != nil {
- h.sendError(w, http.StatusUnauthorized, "invalid or expired session")
- return
- }
- // Update session activity
- if err := h.SessionManager.TouchSession(r.Context(), aimsid); err != nil {
- h.Logger.WarnContext(ctx, "failed to touch session", "aimsid", aimsid, "error", err)
- }
- // Parse preferences from query parameters
- prefs := make(map[string]interface{})
- // Common preference keys from the Web AIM API spec
- prefKeys := []string{
- "statusMsg", "awayMsg", "profileMsg", "buddyIcon",
- "soundsOn", "alertsOn", "typingStatus", "idleTime",
- "pdMode", "invisibleTo", "visibleTo", "blockList",
- "allowList", "language", "timeZone", "dateFormat",
- "showTimestamps", "fontSize", "fontFamily", "theme",
- "autoResponse", "saveHistory", "encryptMessages",
- }
- // Extract preferences from query parameters
- for _, key := range prefKeys {
- if val := r.URL.Query().Get(key); val != "" {
- // Try to parse as boolean
- if val == "true" || val == "false" {
- prefs[key] = val == "true"
- } else if num, err := strconv.Atoi(val); err == nil {
- // Try to parse as integer
- prefs[key] = num
- } else {
- // Store as string
- prefs[key] = val
- }
- }
- }
- // Allow any other parameters starting with "pref_" for extensibility
- for key, values := range r.URL.Query() {
- if strings.HasPrefix(key, "pref_") && len(values) > 0 {
- actualKey := strings.TrimPrefix(key, "pref_")
- prefs[actualKey] = values[0]
- }
- }
- // Save preferences
- if err := h.PreferenceManager.SetPreferences(ctx, session.ScreenName.IdentScreenName(), prefs); err != nil {
- h.Logger.ErrorContext(ctx, "failed to set preferences", "err", err.Error())
- h.sendError(w, http.StatusInternalServerError, "failed to save preferences")
- return
- }
- h.Logger.DebugContext(ctx, "preferences updated",
- "screenName", session.ScreenName.String(),
- "prefCount", len(prefs),
- )
- // Send success response
- response := BaseResponse{}
- response.Response.StatusCode = 200
- response.Response.StatusText = "OK"
- response.Response.Data = prefs
- SendResponse(w, r, response, h.Logger)
- }
- // GetPreferences handles GET /preference/get requests to retrieve user preferences.
- func (h *PreferenceHandler) GetPreferences(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- // Get session ID from parameters
- aimsid := r.URL.Query().Get("aimsid")
- if aimsid == "" {
- h.sendError(w, http.StatusBadRequest, "missing aimsid parameter")
- return
- }
- // Get session
- session, err := h.SessionManager.GetSession(r.Context(), aimsid)
- if err != nil {
- h.sendError(w, http.StatusUnauthorized, "invalid or expired session")
- return
- }
- // Update session activity
- if err := h.SessionManager.TouchSession(r.Context(), aimsid); err != nil {
- h.Logger.WarnContext(ctx, "failed to touch session", "aimsid", aimsid, "error", err)
- }
- // Get target user (optional, defaults to session user)
- targetUser := session.ScreenName.IdentScreenName()
- if t := r.URL.Query().Get("t"); t != "" {
- targetUser = state.NewIdentScreenName(t)
- }
- // Get all stored preferences or defaults
- allPrefs, err := h.PreferenceManager.GetPreferences(ctx, targetUser)
- if err != nil {
- h.Logger.ErrorContext(ctx, "failed to get preferences", "err", err.Error())
- allPrefs = h.getDefaultPreferences()
- }
- if len(allPrefs) == 0 {
- allPrefs = h.getDefaultPreferences()
- }
- // Check if specific preferences are being requested
- requestedPrefs := make(map[string]interface{})
- defaultPrefs := h.getDefaultPreferences()
- // Check each known preference key in the query parameters
- // When a preference appears in the query (e.g., playIMSound=1),
- // the client is requesting that specific preference value
- for key := range defaultPrefs {
- if r.URL.Query().Has(key) {
- // Client is requesting this specific preference
- if prefValue, exists := allPrefs[key]; exists {
- requestedPrefs[key] = prefValue
- } else {
- requestedPrefs[key] = defaultPrefs[key]
- }
- }
- }
- // If no specific preferences were requested, return all
- var prefs map[string]interface{}
- if len(requestedPrefs) > 0 {
- prefs = requestedPrefs
- } else {
- prefs = allPrefs
- }
- h.Logger.DebugContext(ctx, "preferences retrieved",
- "screenName", targetUser.String(),
- "prefCount", len(prefs),
- "requested", len(requestedPrefs) > 0,
- )
- // Check for AMF format to handle special Gromit compatibility requirements
- format := strings.ToLower(r.URL.Query().Get("f"))
- if format == "amf" || format == "amf3" {
- // Convert string "1"/"0" to numeric values for Gromit compatibility
- // Gromit expects numeric values for boolean preferences
- convertedPrefs := make(map[string]interface{})
- for key, val := range prefs {
- if strVal, ok := val.(string); ok {
- if strVal == "1" {
- convertedPrefs[key] = 1
- } else if strVal == "0" {
- convertedPrefs[key] = 0
- } else {
- // Keep non-boolean values as strings
- convertedPrefs[key] = val
- }
- } else {
- convertedPrefs[key] = val
- }
- }
- prefs = convertedPrefs
- h.Logger.DebugContext(ctx, "AMF preference response",
- "prefs", prefs,
- "prefCount", len(prefs),
- "format", format,
- )
- // Ensure prefs is never nil or empty for Gromit
- if len(prefs) == 0 {
- // If no preferences found, at least return the requested ones with defaults
- if len(requestedPrefs) > 0 {
- prefs = requestedPrefs
- } else {
- // Return playIMSound as default if nothing else
- prefs = map[string]interface{}{
- "playIMSound": 1,
- }
- }
- }
- // For single preference requests, return directly for Gromit compatibility
- // For multiple preferences, wrap in jsonData
- if len(prefs) != 1 {
- prefs = map[string]interface{}{
- "jsonData": prefs,
- }
- }
- }
- // Send response in requested format
- response := BaseResponse{}
- response.Response.StatusCode = 200
- response.Response.StatusText = "OK"
- response.Response.Data = prefs
- SendResponse(w, r, response, h.Logger)
- }
- // SetPermitDeny handles GET /preference/setPermitDeny requests to update permit/deny settings.
- func (h *PreferenceHandler) SetPermitDeny(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- // Get session ID from parameters
- aimsid := r.URL.Query().Get("aimsid")
- if aimsid == "" {
- h.sendError(w, http.StatusBadRequest, "missing aimsid parameter")
- return
- }
- // Get session
- session, err := h.SessionManager.GetSession(r.Context(), aimsid)
- if err != nil {
- h.sendError(w, http.StatusUnauthorized, "invalid or expired session")
- return
- }
- // Update session activity
- if err := h.SessionManager.TouchSession(r.Context(), aimsid); err != nil {
- h.Logger.WarnContext(ctx, "failed to touch session", "aimsid", aimsid, "error", err)
- }
- // Get pdMode parameter
- pdModeStr := r.URL.Query().Get("pdMode")
- if pdModeStr != "" {
- pdMode, err := strconv.Atoi(pdModeStr)
- if err != nil || pdMode < 0 || pdMode > 5 {
- h.sendError(w, http.StatusBadRequest, "invalid pdMode value (must be 0-5)")
- return
- }
- // Set the PD mode
- if err := h.PermitDenyManager.SetPDMode(ctx, session.ScreenName.IdentScreenName(), wire.FeedbagPDMode(pdMode)); err != nil {
- h.Logger.ErrorContext(ctx, "failed to set PD mode", "err", err.Error())
- h.sendError(w, http.StatusInternalServerError, "failed to update PD mode")
- return
- }
- }
- // Handle permit list updates
- if permitAdd := r.URL.Query().Get("permitAdd"); permitAdd != "" {
- users := strings.Split(permitAdd, ",")
- for _, user := range users {
- user = strings.TrimSpace(user)
- if user != "" {
- targetSN := state.NewIdentScreenName(user)
- if err := h.PermitDenyManager.AddPermitBuddy(ctx, session.ScreenName.IdentScreenName(), targetSN); err != nil {
- h.Logger.ErrorContext(ctx, "failed to add to permit list", "user", user, "err", err.Error())
- }
- }
- }
- }
- if permitRemove := r.URL.Query().Get("permitRemove"); permitRemove != "" {
- users := strings.Split(permitRemove, ",")
- for _, user := range users {
- user = strings.TrimSpace(user)
- if user != "" {
- targetSN := state.NewIdentScreenName(user)
- if err := h.PermitDenyManager.RemovePermitBuddy(ctx, session.ScreenName.IdentScreenName(), targetSN); err != nil {
- h.Logger.ErrorContext(ctx, "failed to remove from permit list", "user", user, "err", err.Error())
- }
- }
- }
- }
- // Handle deny list updates
- if denyAdd := r.URL.Query().Get("denyAdd"); denyAdd != "" {
- users := strings.Split(denyAdd, ",")
- for _, user := range users {
- user = strings.TrimSpace(user)
- if user != "" {
- targetSN := state.NewIdentScreenName(user)
- if err := h.PermitDenyManager.AddDenyBuddy(ctx, session.ScreenName.IdentScreenName(), targetSN); err != nil {
- h.Logger.ErrorContext(ctx, "failed to add to deny list", "user", user, "err", err.Error())
- }
- }
- }
- }
- if denyRemove := r.URL.Query().Get("denyRemove"); denyRemove != "" {
- users := strings.Split(denyRemove, ",")
- for _, user := range users {
- user = strings.TrimSpace(user)
- if user != "" {
- targetSN := state.NewIdentScreenName(user)
- if err := h.PermitDenyManager.RemoveDenyBuddy(ctx, session.ScreenName.IdentScreenName(), targetSN); err != nil {
- h.Logger.ErrorContext(ctx, "failed to remove from deny list", "user", user, "err", err.Error())
- }
- }
- }
- }
- // Get updated PD data
- pdMode, _ := h.PermitDenyManager.GetPDMode(ctx, session.ScreenName.IdentScreenName())
- permitList, _ := h.PermitDenyManager.GetPermitList(ctx, session.ScreenName.IdentScreenName())
- denyList, _ := h.PermitDenyManager.GetDenyList(ctx, session.ScreenName.IdentScreenName())
- // Convert to string arrays
- permitUsers := make([]string, len(permitList))
- for i, u := range permitList {
- permitUsers[i] = u.String()
- }
- denyUsers := make([]string, len(denyList))
- for i, u := range denyList {
- denyUsers[i] = u.String()
- }
- h.Logger.DebugContext(ctx, "permit/deny settings updated",
- "screenName", session.ScreenName.String(),
- "pdMode", pdMode,
- "permitCount", len(permitUsers),
- "denyCount", len(denyUsers),
- )
- // Note: We don't broadcast immediate presence changes here.
- // The blocking relationship is now in the database and will be respected
- // by all future presence checks and message routing.
- // The blocked users will appear offline to each other on the next presence update.
- // Send response
- permitDenyData := PermitDenyData{
- PDMode: int(pdMode),
- PermitList: permitUsers,
- DenyList: denyUsers,
- }
- response := BaseResponse{}
- response.Response.StatusCode = 200
- response.Response.StatusText = "OK"
- response.Response.Data = permitDenyData
- SendResponse(w, r, response, h.Logger)
- }
- // GetPermitDeny handles GET /preference/getPermitDeny requests to retrieve permit/deny settings.
- func (h *PreferenceHandler) GetPermitDeny(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- // Get session ID from parameters
- aimsid := r.URL.Query().Get("aimsid")
- if aimsid == "" {
- h.sendError(w, http.StatusBadRequest, "missing aimsid parameter")
- return
- }
- // Get session
- session, err := h.SessionManager.GetSession(r.Context(), aimsid)
- if err != nil {
- h.sendError(w, http.StatusUnauthorized, "invalid or expired session")
- return
- }
- // Update session activity
- if err := h.SessionManager.TouchSession(r.Context(), aimsid); err != nil {
- h.Logger.WarnContext(ctx, "failed to touch session", "aimsid", aimsid, "error", err)
- }
- // Get PD data
- pdMode, _ := h.PermitDenyManager.GetPDMode(ctx, session.ScreenName.IdentScreenName())
- permitList, _ := h.PermitDenyManager.GetPermitList(ctx, session.ScreenName.IdentScreenName())
- denyList, _ := h.PermitDenyManager.GetDenyList(ctx, session.ScreenName.IdentScreenName())
- // Convert to string arrays
- permitUsers := make([]string, len(permitList))
- for i, u := range permitList {
- permitUsers[i] = u.String()
- }
- denyUsers := make([]string, len(denyList))
- for i, u := range denyList {
- denyUsers[i] = u.String()
- }
- h.Logger.DebugContext(ctx, "permit/deny settings retrieved",
- "screenName", session.ScreenName.String(),
- "pdMode", pdMode,
- "permitCount", len(permitUsers),
- "denyCount", len(denyUsers),
- )
- // Send response
- permitDenyData := PermitDenyData{
- PDMode: int(pdMode),
- PermitList: permitUsers,
- DenyList: denyUsers,
- }
- response := BaseResponse{}
- response.Response.StatusCode = 200
- response.Response.StatusText = "OK"
- response.Response.Data = permitDenyData
- SendResponse(w, r, response, h.Logger)
- }
- // sendError sends an error response in Web AIM API format.
- // getDefaultPreferences returns default preference values that clients expect.
- func (h *PreferenceHandler) getDefaultPreferences() map[string]interface{} {
- return map[string]interface{}{
- "autoPlay": "1",
- "playIMSound": "1",
- "playBuddySound": "1",
- "showTimestamps": "1",
- "showAdsFlag": "1",
- "soundSetting": "1",
- "awayMessageOn": "0",
- "awayMessage": "",
- "confirmSignOff": "0",
- "skipNavigator": "1",
- "displayIdleTime": "1",
- "repliesAnyone": "0",
- "repliesUsersOnline": "0",
- "repliesBuddies": "0",
- "replyMessage": "",
- "allowAccessPresence": "0",
- "blockIdleStatus": "0",
- "reportIdleTyping": "1",
- "smileysDisabled": "0",
- "sortBuddiesAlpha": "0",
- "statusMsg": "",
- "statusIcon": "",
- "skin": "default",
- }
- }
- func (h *PreferenceHandler) sendError(w http.ResponseWriter, statusCode int, message string) {
- SendError(w, statusCode, message)
- }
|