Merge pull request #143 from inada-s/online-patch

add online patch impl
inada-s · Jul 3, 2021 · f07a451 · f07a451
2 parents 646870d + 21b5f8f
commit f07a451
Show file tree

Hide file tree

Showing 19 changed files with 669 additions and 87 deletions.
diff --git a/gdxsv/db.go b/gdxsv/db.go
@@ -121,6 +121,7 @@ type MLobbySetting struct {
 	TeamShuffle      bool   `db:"team_shuffle" json:"team_shuffle"`
 	PingLimit        int    `db:"ping_limit" json:"ping_limit"`
 	PingRegion       string `db:"ping_region" json:"ping_region"`
+	PatchNames       string `db:"patch_names" json:"patch_names"`
 }
 
 type MRule struct {
@@ -150,6 +151,14 @@ type MRule struct {
 	StageNo      int    `db:"stage_no" json:"stage_no"`
 }
 
+type MPatch struct {
+	Platform  string `db:"platform" json:"platform"`
+	Disk      string `db:"disk" json:"disk"`
+	Name      string `db:"name" json:"name"`
+	WriteOnce bool   `db:"write_once" json:"write_once"`
+	Codes     string `db:"codes" json:"codes"`
+}
+
 // DB is an interface of database operation.
 type DB interface {
 	// Init initializes the database.
@@ -227,4 +236,7 @@ type DB interface {
 
 	// GetRule returns game rule.
 	GetRule(id string) (*MRule, error)
+
+	// GetPatch returns game patch.
+	GetPatch(platform, disk, name string) (*MPatch, error)
 }
diff --git a/gdxsv/db_sqlite.go b/gdxsv/db_sqlite.go
@@ -128,6 +128,7 @@ CREATE TABLE IF NOT EXISTS m_lobby_setting
     team_shuffle       integer not null,
     ping_limit         integer not null,
     ping_region        text default '',
+    patch_names        text default '',
     PRIMARY KEY (platform, disk, no)
 );
 CREATE TABLE IF NOT EXISTS m_rule
@@ -158,6 +159,15 @@ CREATE TABLE IF NOT EXISTS m_rule
     stage_no       integer not null,
     PRIMARY KEY (id)
 );
+CREATE TABLE IF NOT EXISTS m_patch
+(
+    platform 	text not null,
+    disk     	text not null,
+    name     	text not null,
+    write_once 	integer not null,
+    codes 	 	text not null,
+    PRIMARY KEY (platform, disk, name)
+);
 `
 
 const indexes = `
@@ -658,3 +668,12 @@ func (db SQLiteDB) GetRule(id string) (*MRule, error) {
 	}
 	return m, nil
 }
+
+func (db SQLiteDB) GetPatch(platform, disk, name string) (*MPatch, error) {
+	m := &MPatch{}
+	err := db.QueryRowx("SELECT * FROM m_patch WHERE platform = ? AND disk = ? AND name = ?", platform, disk, name).StructScan(m)
+	if err != nil {
+		return nil, err
+	}
+	return m, nil
+}
diff --git a/gdxsv/db_test.go b/gdxsv/db_test.go
@@ -603,3 +603,24 @@ INSERT INTO m_rule (
 		panic(err)
 	}
 }
+
+func mustInsertMPatch(patch MPatch) {
+	db := getDB().(SQLiteDB)
+	_, err := db.NamedExec(`
+INSERT INTO m_patch (
+    platform 	,
+    disk     	,
+    name     	,
+    write_once 	,
+    codes
+) VALUES (
+    :platform 	,
+    :disk     	,
+    :name     	,
+    :write_once ,
+    :codes
+)`, patch)
+	if err != nil {
+		panic(err)
+	}
+}
diff --git a/gdxsv/lbs_handler.go b/gdxsv/lbs_handler.go
@@ -159,6 +159,7 @@ const (
 	// gdxsv extended commands
 	lbsExtSyncSharedData CmdID = 0x9900
 	lbsPlatformInfo      CmdID = 0x9950
+	lbsGamePatch         CmdID = 0x9960
 )
 
 func RequestLineCheck(p *LbsPeer) {
@@ -250,12 +251,12 @@ func sendUserList(p *LbsPeer) {
 	p.SendMessage(n)
 }
 
-func isOldFlycastVersion(userVersion string) bool {
+func isOldFlycastVersion(userVersion string, minVersion string) bool {
 	if strings.HasPrefix(userVersion, "gdxsv-") {
 		// New version-string have the prefix.
 		userVersion = "v" + strings.TrimPrefix(userVersion, "gdxsv-")
 	}
-	if semver.Compare(userVersion, requiredFlycastVersion) < 0 {
+	if semver.Compare(userVersion, minVersion) < 0 {
 		return true
 	}
 	return false
@@ -284,7 +285,7 @@ var _ = register(lbsLoginType, func(p *LbsPeer, m *LbsMessage) {
 
 	switch loginType {
 	case 0:
-		if p.PlatformInfo["flycast"] != "" && isOldFlycastVersion(p.PlatformInfo["flycast"]) {
+		if p.PlatformInfo["flycast"] != "" && isOldFlycastVersion(p.PlatformInfo["flycast"], requiredFlycastVersion) {
 			p.SendMessage(NewServerNotice(lbsShutDown).Writer().
 				WriteString("<LF=5><BODY><CENTER>PLEASE UPDATE Flycast<END>").Msg())
 			return
@@ -334,7 +335,7 @@ var _ = register(lbsLoginType, func(p *LbsPeer, m *LbsMessage) {
 		p.SendMessage(NewServerNotice(lbsShutDown).Writer().
 			WriteString("<LF=5><BODY><CENTER>UNSUPPORTED LOGIN TYPE<END>").Msg())
 	case 2:
-		if p.PlatformInfo["flycast"] != "" && isOldFlycastVersion(p.PlatformInfo["flycast"]) {
+		if p.PlatformInfo["flycast"] != "" && isOldFlycastVersion(p.PlatformInfo["flycast"], requiredFlycastVersion) {
 			p.SendMessage(NewServerNotice(lbsShutDown).Writer().
 				WriteString("<LF=5><BODY><CENTER>PLEASE UPDATE Flycast<END>").Msg())
 			return
@@ -842,6 +843,13 @@ var _ = register(lbsPlazaStatus, func(p *LbsPeer, m *LbsMessage) {
 		}
 	}
 
+	// Check GamePatch feature is available
+	if lobby.LobbySetting.PatchNames != "" {
+		if p.PlatformInfo["flycast"] != "" && isOldFlycastVersion(p.PlatformInfo["flycast"], novelFlycastVersion) {
+			status = 1
+		}
+	}
+
 	p.SendMessage(NewServerAnswer(m).Writer().
 		Write16(lobbyID).
 		Write8(uint8(status)).Msg())

diff --git a/gdxsv/lbs_handler_test.go b/gdxsv/lbs_handler_test.go
@@ -42,13 +42,19 @@ func Test_isOldFlycastVersion(t *testing.T) {
 			args:            args{userVersion: "gdxsv-0.6.9"},
 			want:            true,
 		},
+		{
+			name:            "real semver dev version is old",
+			requiredVersion: "v1.0.4",
+			args:            args{userVersion: "v1.0.4-dev.3+100e01d4"},
+			want:            true,
+		},
 	}
 
 	backup := requiredFlycastVersion
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			requiredFlycastVersion = tt.requiredVersion
-			if got := isOldFlycastVersion(tt.args.userVersion); got != tt.want {
+			if got := isOldFlycastVersion(tt.args.userVersion, requiredFlycastVersion); got != tt.want {
 				t.Errorf("isOldFlycastVersion() = %v, want %v", got, tt.want)
 			}
 		})

diff --git a/gdxsv/lbs_lobby.go b/gdxsv/lbs_lobby.go
@@ -3,7 +3,9 @@ package main
 import (
 	"database/sql"
 	"fmt"
+	"gdxsv/gdxsv/proto"
 	"go.uber.org/zap"
+	pb "google.golang.org/protobuf/proto"
 	"math/rand"
 	"sort"
 	"strconv"
@@ -349,6 +351,20 @@ func (l *LbsLobby) printLobbyReminder(p *LbsPeer) {
 
 func (l *LbsLobby) Enter(p *LbsPeer) {
 	l.Users[p.UserID] = &p.DBUser
+
+	// Send game patch for offline testing
+	if l.LobbySetting.PatchNames != "" {
+		patchList := l.makePatchList()
+		logger.Info("patchList", zap.Any("patchList", patchList))
+		patchBin, err := pb.Marshal(patchList)
+		if err != nil {
+			logger.Error("pb.Marshal patch", zap.Error(err))
+			return
+		}
+		patchMsg := NewServerNotice(lbsGamePatch)
+		patchMsg.Writer().Write(patchBin)
+		p.SendMessage(patchMsg)
+	}
 }
 
 func (l *LbsLobby) Exit(userID string) {
@@ -593,6 +609,33 @@ func (l *LbsLobby) Update() {
 	l.checkRoomBattleStart()
 }
 
+func (l *LbsLobby) makePatchList() *proto.GamePatchList {
+	sp := strings.Split(strings.TrimSpace(l.LobbySetting.PatchNames), ",")
+	if len(sp) == 0 {
+		return nil
+	}
+
+	patchList := new(proto.GamePatchList)
+
+	for _, name := range sp {
+		mPatch, err := getDB().GetPatch(l.Platform, l.GameDisk, name)
+		if err != nil {
+			logger.Warn("failed to load patch", zap.String("name", name), zap.Error(err))
+			continue
+		}
+
+		gamePatch, err := convertGamePatch(mPatch)
+		if err != nil {
+			logger.Warn("failed to convert patch", zap.String("name", name), zap.Error(err))
+			continue
+		}
+
+		patchList.Patches = append(patchList.Patches, gamePatch)
+	}
+
+	return patchList
+}
+
 func (l *LbsLobby) checkLobbyBattleStart(force bool) {
 	if !(force || l.canStartBattle()) {
 		return
@@ -669,13 +712,24 @@ func (l *LbsLobby) checkLobbyBattleStart(force bool) {
 		}
 	}
 
+	patchList := l.makePatchList()
+	logger.Info("patchList", zap.Any("patchList", patchList))
+	patchBin, err := pb.Marshal(patchList)
+	if err != nil {
+		logger.Error("pb.Marshal patch", zap.Error(err))
+		return
+	}
+	patchMsg := NewServerNotice(lbsGamePatch)
+	patchMsg.Writer().Write(patchBin)
+
 	sharedData.ShareMcsGame(&McsGame{
 		BattleCode: b.BattleCode,
 		Rule:       *b.Rule,
 		GameDisk:   l.GameDisk,
 		UpdatedAt:  time.Now(),
 		State:      McsGameStateCreated,
 		McsAddr:    mcsAddr,
+		PatchList:  patchList,
 	})
 
 	for _, q := range participants {
@@ -697,6 +751,7 @@ func (l *LbsLobby) checkLobbyBattleStart(force bool) {
 			State:       McsUserStateCreated,
 		})
 		NotifyReadyBattle(q)
+		q.SendMessage(patchMsg)
 	}
 
 	if mcsPeer != nil {
@@ -830,13 +885,23 @@ func (l *LbsLobby) checkRoomBattleStart() {
 		}
 	}
 
+	patchList := l.makePatchList()
+	patchBin, err := pb.Marshal(patchList)
+	if err != nil {
+		logger.Error("pb.Marshal patch", zap.Error(err))
+		return
+	}
+	patchMsg := NewServerNotice(lbsGamePatch)
+	patchMsg.Writer().Write(patchBin)
+
 	sharedData.ShareMcsGame(&McsGame{
 		BattleCode: b.BattleCode,
 		Rule:       *b.Rule,
 		GameDisk:   l.GameDisk,
 		UpdatedAt:  time.Now(),
 		State:      McsGameStateCreated,
 		McsAddr:    mcsAddr,
+		PatchList:  patchList,
 	})
 
 	for _, q := range participants {

diff --git a/gdxsv/lbs_message.string.go b/gdxsv/lbs_message.string.go
diff --git a/gdxsv/main.go b/gdxsv/main.go
@@ -11,6 +11,7 @@ import (
 	"log"
 	"math/rand"
 	"net/http"
+	_ "net/http/pprof"
 	"os"
 	"os/signal"
 	"runtime"
@@ -31,6 +32,9 @@ var (
 
 	// Minimum required flycast version.
 	requiredFlycastVersion = "v0.7.0"
+
+	// New feature installed version.
+	novelFlycastVersion = "v1.0.5"
 )
 
 var (

diff --git a/gdxsv/main_test.go b/gdxsv/main_test.go
@@ -55,6 +55,13 @@ func TestMain(m *testing.M) {
 	})
 	mustInsertMRule(MRule{ID: "dummy"})
 	mustInsertMString("dummy", "dummy string")
+	mustInsertMPatch(MPatch{
+		Platform:  "emu-x86/64",
+		Disk:      "dc2",
+		Name:      "dummy-patch",
+		WriteOnce: true,
+		Codes:     "1, 8, 0c391d97, 1, 0",
+	})
 
 	os.Exit(m.Run())
 }
diff --git a/gdxsv/mcs.go b/gdxsv/mcs.go
@@ -287,11 +287,18 @@ func (mcs *Mcs) Join(p McsPeer, sessionID string) *McsRoom {
 	mcs.mtx.Lock()
 	mcs.updated = time.Now()
 	room := mcs.rooms[user.BattleCode]
+	created := false
 	if room == nil {
 		room = newMcsRoom(mcs, game)
 		mcs.rooms[user.BattleCode] = room
+		created = true
 	}
 	mcs.mtx.Unlock()
+
+	if created {
+		logger.Info("new McsRoom", zap.String("battle_code", user.BattleCode), zap.Any("game", game))
+	}
+
 	room.Join(p, user)
 
 	sharedData.UpdateMcsUserState(sessionID, McsUserStateJoined)

diff --git a/gdxsv/mcs_room.go b/gdxsv/mcs_room.go
@@ -23,18 +23,20 @@ type McsRoom struct {
 }
 
 func newMcsRoom(mcs *Mcs, gameInfo *McsGame) *McsRoom {
-	return &McsRoom{
+	room := &McsRoom{
 		mcs:  mcs,
 		game: gameInfo,
 		battleLog: &proto.BattleLogFile{
-			LogFileVersion: 20201212,
+			LogFileVersion: 20210702,
 			GameDisk:       gameInfo.GameDisk,
 			GdxsvVersion:   gdxsvVersion,
 			BattleCode:     gameInfo.BattleCode,
 			RuleBin:        SerializeRule(&gameInfo.Rule),
+			Patches:        gameInfo.PatchList.GetPatches(),
 			StartAt:        time.Now().UnixNano(),
 		},
 	}
+	return room
 }
 
 func (r *McsRoom) PeerCount() int {

diff --git a/gdxsv/mcs_udp.go b/gdxsv/mcs_udp.go
@@ -283,6 +283,7 @@ func (u *McsUDPPeer) Serve(mcs *Mcs) {
 			var err error
 			pbBuf, err = pbm.MarshalAppend(pbBuf[:0], pkt)
 			proto.PutPacket(pkt)
+
 			if err != nil {
 				u.logger.Error("Marshal error", zap.Error(err))
 				u.SetCloseReason("sv_marshal_error")