Merge pull request #13 from Retro-Rewind-Team/discord-link-rebase

Author: lilousky

api/link.go

@@ -0,0 +1,85 @@
+package api
+
+import (
+	"errors"
+	"net/http"
+	"wwfc/database"
+	"wwfc/gpcm"
+)
+
+
+type LinkRequest struct {
+		Secret    string `json:"secret"`
+		ProfileID uint32 `json:"pid"`
+		DiscordID string `json:"discordId"`
+		Action    string `json:"action"`
+}
+
+var LinkRoute = MakeRouteSpec[LinkRequest, UserActionResponse](
+	true,
+	"/api/link",
+	func(req any, v bool, _ *http.Request) (any, int, error) {
+		return handleUserAction(req.(LinkRequest), v, HandleLink)
+	},
+	http.MethodPost,
+)
+
+var (
+	ErrPIDIsMissing = errors.New("Profile ID missing or invalid")
+	ErrDiscordIDMissing = errors.New("Discord ID missing or invalid")
+	ErrDiscordLinked	    = errors.New("Discord ID already linked to another profile")
+	ErrDiscordWrongStep	    = errors.New("Profile is not in the correct step to link Discord ID")
+	ErrDiscordCannotUnlink  = errors.New("Discord ID cannot be unlinked")
+	ErrActionMissing        = errors.New("Action missing in request")
+)
+
+func HandleLink(req LinkRequest, _ bool) (*database.User, int, error) {
+	var err error
+
+	if req.ProfileID == 0 {
+		return nil, http.StatusBadRequest, ErrPIDIsMissing
+	}
+
+	if  req.DiscordID == "" {
+		return nil, http.StatusBadRequest, ErrDiscordIDMissing
+	}
+
+	if req.Action == "" || (req.Action != "link" && req.Action != "check" && req.Action != "unlink") {
+		return nil, http.StatusBadRequest, ErrActionMissing
+	}
+
+	user, success := database.GetProfile(pool, ctx, req.ProfileID)
+	if success != nil {
+		return nil, http.StatusInternalServerError, ErrUserQuery
+	}
+
+	if req.Action == "link" {
+		if user.DiscordID != "" {
+			return nil, http.StatusForbidden, ErrDiscordLinked
+		}
+		gpcm.SetSessionDiscordID(user.ProfileId, "1")
+		err = user.UpdateDiscordID(pool, ctx, "1")
+		if err != nil {
+			return nil, http.StatusInternalServerError, err
+		}
+	} else if req.Action == "check" {
+		if user.DiscordID != "2" {
+			return nil, http.StatusForbidden, ErrDiscordWrongStep
+		}
+		gpcm.SetSessionDiscordID(user.ProfileId, req.DiscordID)
+		err = user.UpdateDiscordID(pool, ctx, req.DiscordID)
+		if err != nil {
+			return nil, http.StatusInternalServerError, err
+		}
+	} else if req.Action == "unlink" {
+		if user.DiscordID != "1" && user.DiscordID != "2" && user.DiscordID != req.DiscordID {
+			return nil, http.StatusForbidden, ErrDiscordCannotUnlink
+		}
+		err = user.UpdateDiscordID(pool, ctx, "")
+		if err != nil {
+			return nil, http.StatusInternalServerError, err
+		}
+	}
+
+	return &user, http.StatusOK, nil
+}

api/main.go

@@ -97,6 +97,7 @@ func StartServer(reload bool) {
 		ClearRoute,
 		GetHashRoute,
 		KickRoute,
+		LinkRoute,
 		MotdRoute,
 		PinfoRoute,
 		QueryRoute,

api/query.go

@@ -13,6 +13,7 @@ type QueryRequest struct {
 	IP       string `json:"ip"`
 	DeviceID uint32 `json:"deviceID"`
 	Csnum    string `json:"csnum"`
+	DiscordID string `json:"discordId"`	
 	// 0: Either, 1: No Ban, 2: Ban
 	HasBan byte `json:"hasban"`
 }
@@ -34,9 +35,9 @@ var (
 	ErrInvalidIPFormat = errors.New("Invalid IP Format. IPs must be in the format 'xx.xx.xx.xx'.")
 	ErrInvalidDeviceID = errors.New("DeviceID cannot be 0.")
 	ErrInvalidCsnum    = errors.New("Csnums must be less than 16 characters long and match the format '^[a-zA-Z0-9]+$'.")
+	ErrInvalidDiscordID = errors.New("Discord ID must be less than 18 characters long.")
 	ErrInvalidHasBan   = errors.New("HasBan must be either 0 (Either), 1 (No Ban), 2 (Ban)")
 	ErrEmptyParams     = errors.New("At least one of IP, Csnum, and DeviceID must be nonzero or nonempty")
-
 	ipRegex    = regexp.MustCompile(`^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$`)
 	csnumRegex = regexp.MustCompile(`^[a-zA-Z0-9]+$`)
 )
@@ -54,11 +55,15 @@ func HandleQuery(req any, _ bool, _ *http.Request) (any, int, error) {
 		return nil, http.StatusBadRequest, ErrInvalidCsnum
 	}
 
+	if _req.DiscordID != "" && len(_req.DiscordID) > 18 {
+		return nil, http.StatusBadRequest, ErrInvalidDiscordID
+	}
+
 	if _req.HasBan != 0 && _req.HasBan != 1 && _req.HasBan != 2 {
 		return nil, http.StatusBadRequest, ErrInvalidHasBan
 	}
 
-	if _req.IP == "" && _req.Csnum == "" && _req.DeviceID == 0 {
+	if _req.IP == "" && _req.Csnum == "" && _req.DeviceID == 0 && _req.DiscordID == "" {
 		return nil, http.StatusBadRequest, ErrEmptyParams
 	}
 
@@ -76,6 +81,10 @@ func HandleQuery(req any, _ bool, _ *http.Request) (any, int, error) {
 		query += fmt.Sprintf(" '%s' = ANY(csnum) AND", _req.Csnum)
 	}
 
+	if _req.DiscordID != "" {
+		query += fmt.Sprintf(" discord_id = '%s' AND", _req.DiscordID)
+	}
+
 	if _req.HasBan == 1 {
 		query += fmt.Sprintf(" has_ban = false AND")
 	} else if _req.HasBan == 2 {

common/config.go

@@ -40,6 +40,7 @@ type Config struct {
 	WiiCertPathDS string `xml:"wiiCertDerPathDS"`
 	KeyPathDS     string `xml:"keyPathDS"`
 
+	FriendBotPID string `xml:"friendBotPID"`
 	APISecret string `xml:"apiSecret"`
 
 	AllowDefaultDolphinKeys     bool   `xml:"allowDefaultDolphinKeys"`

config_example.xml

@@ -81,6 +81,9 @@
     -->
     <logOutput>StdOutAndFile</logOutput>
 
+    <!-- FriendBot PID -->
+    <friendBotPID>1234</friendBotPID>
+
     <!-- API secret -->
     <apiSecret>hQ3f57b3tW2WnjJH3v</apiSecret>
 </Config>

database/login.go

@@ -109,8 +109,9 @@ func LoginUserToGPCM(pool *pgxpool.Pool, ctx context.Context, userId uint64, gsb
 	} else {
 		var firstName *string
 		var lastName *string
+		var discordId *string
 
-		err := pool.QueryRow(ctx, GetUserProfileID, userId, gsbrcd).Scan(&user.ProfileId, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.OpenHost, &lastIPAddress, &user.Csnum)
+		err := pool.QueryRow(ctx, GetUserProfileID, userId, gsbrcd).Scan(&user.ProfileId, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.OpenHost, &discordId, &lastIPAddress, &user.Csnum)
 		if err != nil {
 			return User{}, err
 		}
@@ -123,6 +124,10 @@ func LoginUserToGPCM(pool *pgxpool.Pool, ctx context.Context, userId uint64, gsb
 			user.LastName = *lastName
 		}
 
+		if discordId != nil {
+			user.DiscordID = *discordId
+		}
+
 		validDeviceId := false
 		deviceIdList := ""
 		for index, id := range user.NgDeviceId {
@@ -269,7 +274,8 @@ func LoginUserToGameStats(pool *pgxpool.Pool, ctx context.Context, userId uint64
 	var firstName *string
 	var lastName *string
 	var lastIPAddress *string
-	err := pool.QueryRow(ctx, GetUserProfileID, userId, gsbrcd).Scan(&user.ProfileId, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.OpenHost, &lastIPAddress, &user.Csnum)
+	var discordId *string
+	err := pool.QueryRow(ctx, GetUserProfileID, userId, gsbrcd).Scan(&user.ProfileId, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.OpenHost, &discordId, &lastIPAddress, &user.Csnum)
 	if err != nil {
 		return User{}, err
 	}
@@ -282,5 +288,9 @@ func LoginUserToGameStats(pool *pgxpool.Pool, ctx context.Context, userId uint64
 		user.LastName = *lastName
 	}
 
+	if discordId != nil {
+		user.DiscordID = *discordId
+	}
+
 	return user, nil
 }

database/schema.go

@@ -20,6 +20,7 @@ func UpdateTables(pool *pgxpool.Pool, ctx context.Context) {
 		ADD IF NOT EXISTS ban_moderator character varying,
 		ADD IF NOT EXISTS ban_tos boolean,
 		ADD IF NOT EXISTS open_host boolean DEFAULT false;
+		ADD IF NOT EXISTS discord_id character varying
 
 	`)
 

database/user.go

@@ -16,13 +16,14 @@ const (
 	UpdateUserProfileID     = `UPDATE users SET profile_id = $3 WHERE user_id = $1 AND gsbrcd = $2`
 	UpdateUserNGDeviceID    = `UPDATE users SET ng_device_id = $2 WHERE profile_id = $1`
 	UpdateUserCsnum         = `UPDATE users SET csnum = $2 WHERE profile_id = $1`
-	GetUser                 = `SELECT user_id, gsbrcd, ng_device_id, email, unique_nick, firstname, lastname, has_ban, ban_reason, open_host, last_ingamesn, last_ip_address, csnum, ban_moderator, ban_reason_hidden, ban_issued, ban_expires FROM users WHERE profile_id = $1`
+	GetUser                 = `SELECT user_id, gsbrcd, ng_device_id, email, unique_nick, firstname, lastname, has_ban, ban_reason, open_host, last_ingamesn, last_ip_address, csnum, discord_id, ban_moderator, ban_reason_hidden, ban_issued, ban_expires FROM users WHERE profile_id = $1`
 	ClearProfileQuery       = `DELETE FROM users WHERE profile_id = $1 RETURNING user_id, gsbrcd, email, unique_nick, firstname, lastname, open_host, last_ip_address, last_ingamesn, csnum`
 	DoesUserExist           = `SELECT EXISTS(SELECT 1 FROM users WHERE user_id = $1 AND gsbrcd = $2)`
 	IsProfileIDInUse        = `SELECT EXISTS(SELECT 1 FROM users WHERE profile_id = $1)`
 	DeleteUserSession       = `DELETE FROM sessions WHERE profile_id = $1`
-	GetUserProfileID        = `SELECT profile_id, ng_device_id, email, unique_nick, firstname, lastname, open_host, last_ip_address, csnum FROM users WHERE user_id = $1 AND gsbrcd = $2`
+	GetUserProfileID        = `SELECT profile_id, ng_device_id, email, unique_nick, firstname, lastname, open_host, discord_id, last_ip_address, csnum FROM users WHERE user_id = $1 AND gsbrcd = $2`
 	UpdateUserLastIPAddress = `UPDATE users SET last_ip_address = $2, last_ingamesn = $3 WHERE profile_id = $1`
+	UpdateDiscordID         = `UPDATE users SET discord_id = $2 WHERE profile_id = $1`
 	UpdateUserBan           = `UPDATE users SET has_ban = true, ban_issued = $2, ban_expires = $3, ban_reason = $4, ban_reason_hidden = $5, ban_moderator = $6, ban_tos = $7 WHERE profile_id = $1`
 	DisableUserBan          = `UPDATE users SET has_ban = false WHERE profile_id = $1`
 
@@ -46,6 +47,7 @@ type User struct {
 	LastInGameSn       string
 	LastIPAddress      string
 	Csnum              []string
+	DiscordID          string
 	// Following fields only used in GetUser query
 	BanModerator    string
 	BanReasonHidden string
@@ -104,6 +106,14 @@ func (user *User) UpdateProfileID(pool *pgxpool.Pool, ctx context.Context, newPr
 	return err
 }
 
+func (user *User) UpdateDiscordID(pool *pgxpool.Pool, ctx context.Context, discordId string) error {
+	_, err := pool.Exec(ctx, UpdateDiscordID, user.ProfileId, discordId)
+	if err == nil {
+		user.DiscordID = discordId
+	}
+	return err
+}
+
 func GetUniqueUserID() uint64 {
 	// Not guaranteed unique but doesn't matter in practice if multiple people have the same user ID.
 	return uint64(rand.Int63n(0x80000000000))
@@ -148,8 +158,9 @@ func GetProfile(pool *pgxpool.Pool, ctx context.Context, profileId uint32) (User
 	var lastIPAddress *string
 	var banModerator *string
 	var banHiddenReason *string
+	var discordID *string
 
-	err := row.Scan(&user.UserId, &user.GsbrCode, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.Restricted, &banReason, &user.OpenHost, &lastInGameSn, &lastIPAddress, &user.Csnum, &banModerator, &banHiddenReason, &user.BanIssued, &user.BanExpires)
+	err := row.Scan(&user.UserId, &user.GsbrCode, &user.NgDeviceId, &user.Email, &user.UniqueNick, &firstName, &lastName, &user.Restricted, &banReason, &user.OpenHost, &lastInGameSn, &lastIPAddress, &user.Csnum, &discordID, &banModerator, &banHiddenReason, &user.BanIssued, &user.BanExpires)
 
 	if err != nil {
 		return User{}, err
@@ -185,6 +196,10 @@ func GetProfile(pool *pgxpool.Pool, ctx context.Context, profileId uint32) (User
 		user.BanReasonHidden = *banHiddenReason
 	}
 
+	if discordID != nil {
+		user.DiscordID = *discordID
+	}
+
 	return user, nil
 }
 

gpcm/friend.go

@@ -62,6 +62,23 @@ func (g *GameSpySession) getAuthorizedFriendIndex(profileId uint32) int {
 	return -1
 }
 
+func (g *GameSpySession) handleFriendBot() {
+
+	if g.User.DiscordID != "1" {
+		logging.Warn(g.ModuleName, "FriendBot is added but verification is not initialized, currently", g.User.DiscordID)
+		return
+	}
+	
+	logging.Info(g.ModuleName, "FriendBot verification progressed to step 2")
+	SetSessionDiscordID(g.User.ProfileId, "2")
+	err := g.User.UpdateDiscordID(pool, ctx, "2")
+	if err != nil {
+		logging.Error(g.ModuleName, "Failed to update discord ID:", err)
+	return
+	
+	}
+}
+
 const (
 	// addFriendMessage = "\r\n\r\n|signed|00000000000000000000000000000000"
 
@@ -77,6 +94,11 @@ func (g *GameSpySession) isBm1AuthMessageNeeded() bool {
 
 func (g *GameSpySession) addFriend(command common.GameSpyCommand) {
 	strNewProfileId := command.OtherValues["newprofileid"]
+
+	if strNewProfileId == config.FriendBotPID {
+		logging.Info(g.ModuleName, "Attempt to add FriendBot as a friend")
+		g.handleFriendBot()
+	}
 	newProfileId, err := strconv.ParseUint(strNewProfileId, 10, 32)
 	if err != nil {
 		g.replyError(ErrAddFriend)

gpcm/main.go

@@ -68,13 +68,15 @@ var (
 	mutex               = deadlock.Mutex{}
 
 	allowDefaultDolphinKeys bool
+	config common.Config
 )
 
+
 func StartServer(reload bool) {
 	qr2.SetGPErrorCallback(KickPlayer)
 
 	// Get config
-	config := common.GetConfig()
+	config = common.GetConfig()
 
 	// Start SQL
 	dbString := fmt.Sprintf("postgres://%s:%s@%s/%s", config.Username, config.Password, config.DatabaseAddress, config.DatabaseName)