nex-protocols-common-go/matchmake-extension/auto_matchmake_with_search_criteria_postpone.go
Daniel López Guimaraes 35aed21585 feat: Initial support for persistent gatherings/communities
Implement methods that are needed for Mario Kart 7 communities to work.
Note that support for communities on MK7 is partial since the community
statistics don't load because legacy Ranking isn't implemented. Aside
from that, players can create communities and join others without
issues. Other games which use persistent gatherings may or may not work.

In order to support the `ParticipationCount`, we replace matchmake
session joins with a wrapper which checks if the session is attached to
a community, and if it is, it will increment the participation count of
the player in a new table named `community_participations`. The
`MatchmakeSessionCount` is handled more easily by checking the sessions
that belong to the corresponding community.

A new parameter is also added named `PersistentGatheringCreationMax`
with a default value of 4, as reported and tested on various games. This
allows game servers to change the maximum number of active persistent
gatherings that a player can create. For example, Mario Kart 7 supports
up to 8 persistent gatherings instead of the default of 4.

In Mario Kart 7 there is no limitation on the number of players that can
"join" to a community. That is because they don't really join to it but
they create matchmake sessions linked to the persistent gathering (in
fact, the `MaximumParticipants` parameter on persistent gatherings is
set to 0). Thus, the `participants` parameter is unused in communities
(at least on MK7) and we instead log community participations with a new
tracking table `tracking.participate_community`.

Some changes also had to be done in other places like participant
disconnection handling or gathering registrations in order to implement
persistent gatherings accurately.
2025-02-09 00:04:03 +00:00

118 lines
4.7 KiB
Go

package matchmake_extension
import (
"github.com/PretendoNetwork/nex-go/v2"
"github.com/PretendoNetwork/nex-go/v2/types"
common_globals "github.com/PretendoNetwork/nex-protocols-common-go/v2/globals"
"github.com/PretendoNetwork/nex-protocols-common-go/v2/matchmake-extension/database"
match_making_types "github.com/PretendoNetwork/nex-protocols-go/v2/match-making/types"
matchmake_extension "github.com/PretendoNetwork/nex-protocols-go/v2/matchmake-extension"
)
func (commonProtocol *CommonProtocol) autoMatchmakeWithSearchCriteriaPostpone(err error, packet nex.PacketInterface, callID uint32, lstSearchCriteria types.List[match_making_types.MatchmakeSessionSearchCriteria], anyGathering match_making_types.GatheringHolder, strMessage types.String) (*nex.RMCMessage, *nex.Error) {
if commonProtocol.CleanupMatchmakeSessionSearchCriterias == nil {
common_globals.Logger.Warning("MatchmakeExtension::AutoMatchmakeWithSearchCriteria_Postpone missing CleanupMatchmakeSessionSearchCriterias!")
return nil, nex.NewError(nex.ResultCodes.Core.NotImplemented, "change_error")
}
if err != nil {
common_globals.Logger.Error(err.Error())
return nil, nex.NewError(nex.ResultCodes.Core.InvalidArgument, "change_error")
}
if len(strMessage) > 256 {
return nil, nex.NewError(nex.ResultCodes.Core.InvalidArgument, "change_error")
}
if len(lstSearchCriteria) > 2 {
return nil, nex.NewError(nex.ResultCodes.Core.InvalidArgument, "change_error")
}
connection := packet.Sender().(*nex.PRUDPConnection)
endpoint := connection.Endpoint().(*nex.PRUDPEndPoint)
commonProtocol.manager.Mutex.Lock()
// * A client may disconnect from a session without leaving reliably,
// * so let's make sure the client is removed from the session
database.EndMatchmakeSessionsParticipation(commonProtocol.manager, connection)
var matchmakeSession match_making_types.MatchmakeSession
if anyGathering.Object.GatheringObjectID().Equals(types.NewString("MatchmakeSession")) {
matchmakeSession = anyGathering.Object.(match_making_types.MatchmakeSession)
} else {
common_globals.Logger.Critical("Non-MatchmakeSession DataType?!")
commonProtocol.manager.Mutex.Unlock()
return nil, nex.NewError(nex.ResultCodes.Core.InvalidArgument, "change_error")
}
if !common_globals.CheckValidMatchmakeSession(matchmakeSession) {
commonProtocol.manager.Mutex.Unlock()
return nil, nex.NewError(nex.ResultCodes.Core.InvalidArgument, "change_error")
}
commonProtocol.CleanupMatchmakeSessionSearchCriterias(lstSearchCriteria)
resultRange := types.NewResultRange()
resultRange.Length = 1
resultSessions, nexError := database.FindMatchmakeSessionBySearchCriteria(commonProtocol.manager, connection, lstSearchCriteria, resultRange, &matchmakeSession)
if nexError != nil {
commonProtocol.manager.Mutex.Unlock()
return nil, nexError
}
var resultSession match_making_types.MatchmakeSession
if len(resultSessions) == 0 {
resultSession = matchmakeSession.Copy().(match_making_types.MatchmakeSession)
nexError = database.CreateMatchmakeSession(commonProtocol.manager, connection, &resultSession)
if nexError != nil {
common_globals.Logger.Error(nexError.Error())
commonProtocol.manager.Mutex.Unlock()
return nil, nexError
}
} else {
resultSession = resultSessions[0]
// TODO - What should really happen here?
if resultSession.UserPasswordEnabled || resultSession.SystemPasswordEnabled {
commonProtocol.manager.Mutex.Unlock()
return nil, nex.NewError(nex.ResultCodes.RendezVous.PermissionDenied, "change_error")
}
}
var vacantParticipants uint16 = 1
if len(lstSearchCriteria) > 0 {
vacantParticipants = uint16(lstSearchCriteria[0].VacantParticipants)
}
participants, nexError := database.JoinMatchmakeSession(commonProtocol.manager, resultSession, connection, vacantParticipants, string(strMessage))
if nexError != nil {
commonProtocol.manager.Mutex.Unlock()
return nil, nexError
}
resultSession.ParticipationCount = types.NewUInt32(participants)
commonProtocol.manager.Mutex.Unlock()
matchmakeDataHolder := match_making_types.NewGatheringHolder()
matchmakeDataHolder.Object = resultSession.Copy().(match_making_types.GatheringInterface)
rmcResponseStream := nex.NewByteStreamOut(endpoint.LibraryVersions(), endpoint.ByteStreamSettings())
matchmakeDataHolder.WriteTo(rmcResponseStream)
rmcResponseBody := rmcResponseStream.Bytes()
rmcResponse := nex.NewRMCSuccess(endpoint, rmcResponseBody)
rmcResponse.ProtocolID = matchmake_extension.ProtocolID
rmcResponse.MethodID = matchmake_extension.MethodAutoMatchmakeWithSearchCriteriaPostpone
rmcResponse.CallID = callID
if commonProtocol.OnAfterAutoMatchmakeWithSearchCriteriaPostpone != nil {
go commonProtocol.OnAfterAutoMatchmakeWithSearchCriteriaPostpone(packet, lstSearchCriteria, anyGathering, strMessage)
}
return rmcResponse, nil
}