user.go

package discordgo

import (
	"strconv"
	"strings"
)

// A User stores all data for an individual Discord user.
type User struct {
	// The ID of the user.
	ID string `json:"id"`

	// The user's username.
	Username string `json:"username"`

	// The discriminator of the user (4 numbers after name).
	Discriminator string `json:"discriminator"`

	// The display name of the user, if it is set. For bots, this is the application name.
	GlobalName *string `json:"global_name"`

	// The hash of the user's avatar. Use Session.UserAvatar
	// to retrieve the avatar itself.
	Avatar string `json:"avatar"`

	// Whether the user is a bot.
	Bot bool `json:"bot"`

	// Whether the user is a system user.
	System bool `json:"system"`

	// Whether the user has multi-factor authentication enabled.
	MFAEnabled bool `json:"mfa_enabled"`

	// The user's banner hash.
	Banner *string `json:"banner"`

	// The user's banner color encoded as an integer representation of hexadecimal color code.
	AccentColor *int `json:"accent_color"`

	// The user's chosen language option.
	Locale string `json:"locale"`

	// Whether the user's email is verified.
	Verified bool `json:"verified"`

	// The email of the user. This is only present when
	// the application possesses the email scope for the user.
	Email string `json:"email"`

	// User Account Flags
	Flags int `json:"flags"`

	// Type of Nitro Subscriptions
	PremiumType PremiumType `json:"premium_type"`

	// Public User Account Flags
	PublicFlags UserPublicFlags `json:"public_flags"`

	// The token of the user. This is only present for
	// the user represented by the current session.
	Token string `json:"token"`
}

type PremiumType int

const (
	PremiumTypeNone PremiumType = iota
	PremiumTypeNitroClassic
	PremiumTypeNitro
	PremiumTypeNitroBasic
)

type UserPublicFlags int

const (
	UserPublicFlagsStaff UserPublicFlags = 1 << iota
	UserPublicFlagsPartner
	UserPublicFlagsHypeSquad
	UserPublicFlagsBugHunterLevel1
	UserPublicFlagsHypeSquadBraveryHouse    = 1 << (iota + 2) // HYPE_SQUAD_ONLINE_HOUSE_1 // 1 << 6
	UserPublicFlagsHypeSquadBrillianceHouse                   // HYPE_SQUAD_ONLINE_HOUSE_2
	UserPublicFlagsHypeSquadBalanceHouse                      // HYPE_SQUAD_ONLINE_HOUSE_3
	UserPublicFlagsPremiumEarlySupporter
	UserPublicFlagsTeamPseudoUser
	UserPublicFlagsBugHunterLevel2 = 1 << (iota + 5) // 1 << 14
	UserPublicFlagsVerifiedBot     = 1 << (iota + 6) // 1 << 16
	UserPublicFlagsVerifiedDeveloper
	UserPublicFlagsCertifiedModerator
	UserPublicFlagsBotHTTPInteractions
	UserPublicFlagsActiveDeveloper = 1 << (iota + 8) // 1 << 22
)

// String returns a unique identifier of the form username#discriminator
func (u *User) String() string {
	if u.Discriminator != "0" {
		return u.Username + "#" + u.Discriminator
	}
	return u.Username
}

func (u *User) GetGlobalName() string {
	if u.GlobalName != nil {
		return *u.GlobalName
	}
	return u.String()
}

// Mention return a string which mentions the user
func (u *User) Mention() string {
	return "<@" + u.ID + ">"
}

// DefaultAvatarURL returns a URL to the user's default avatar
func (u *User) DefaultAvatarURL() string {
	if u.Discriminator == "0" {
		id, _ := strconv.Atoi(u.ID)
		return EndpointDefaultUserAvatar((id >> 22) % 6)
	}
	discriminator, _ := strconv.Atoi(u.Discriminator)
	return EndpointDefaultUserAvatar(discriminator & 5)
}

// AvatarURL returns a URL to the user's avatar.
//    size:    The size of the user's avatar as a power of two
//             if size is an empty string, no size parameter will
//             be added to the URL.
func (u *User) AvatarURL(size string) (URL string) {
	if u.Avatar == "" {
		URL = u.DefaultAvatarURL()
	} else if strings.HasPrefix(u.Avatar, "a_") {
		URL = EndpointUserAvatarAnimated(u.ID, u.Avatar)
	} else {
		URL = EndpointUserAvatar(u.ID, u.Avatar)
	}

	if size != "" {
		return URL + "?size=" + size
	}
	return
}

// BannerURL returns a URL to user's banner. If user does not have a banner, empty string will be returned
//    size:    The size of the user banner as a power of two
//             if size is an empty string, no size parameter will
//             be added to the URL.
func (u *User) BannerURL(size string) (URL string) {
	if u.Banner == nil || *u.Banner == "" {
		return ""
	}
	banner := *u.Banner
	if strings.HasPrefix(banner, "a_") {
		URL = EndpointUserBannerAnimated(u.ID, banner)
	} else {
		URL = EndpointUserBanner(u.ID, banner)
	}

	if size != "" {
		return URL + "?size=" + size
	}
	return
}

var PublicFlagNames = map[UserPublicFlags]string{
	UserPublicFlagsStaff:                    "staff",
	UserPublicFlagsPartner:                  "partner",
	UserPublicFlagsHypeSquad:                "hype_squad",
	UserPublicFlagsBugHunterLevel1:          "bug_hunter_level_1",
	UserPublicFlagsHypeSquadBraveryHouse:    "hype_squad_bravery",
	UserPublicFlagsHypeSquadBrillianceHouse: "hype_squad_brilliance",
	UserPublicFlagsHypeSquadBalanceHouse:    "hype_squad_balance",
	UserPublicFlagsPremiumEarlySupporter:    "premium_early_supporter",
	UserPublicFlagsTeamPseudoUser:           "team_pseudo_user",
	UserPublicFlagsBugHunterLevel2:          "bug_hunter_level_2",
	UserPublicFlagsVerifiedBot:              "verified_bot",
	UserPublicFlagsVerifiedDeveloper:        "verified_developer",
	UserPublicFlagsCertifiedModerator:       "certified_moderator",
	UserPublicFlagsBotHTTPInteractions:      "bot_http_interactions",
	UserPublicFlagsActiveDeveloper:          "active_developer",
}

func (u *User) PublicFlagSlice() (res []string) {
	if u.PublicFlags == 0 {
		return
	}
	flagCopy := u.PublicFlags
	for flag, name := range PublicFlagNames {
		if flagCopy&flag == flag {
			res = append(res, name)
			flagCopy -= flag
			if flagCopy == 0 {
				break
			}
		}
	}
	return
}