mirror of
https://github.com/PretendoNetwork/nex-protocols-common-go.git
synced 2025-04-02 11:02:13 -04:00
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.
126 lines
5.5 KiB
Go
126 lines
5.5 KiB
Go
package database
|
|
|
|
import (
|
|
"slices"
|
|
|
|
"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/match-making/tracking"
|
|
match_making "github.com/PretendoNetwork/nex-protocols-go/v2/match-making"
|
|
notifications "github.com/PretendoNetwork/nex-protocols-go/v2/notifications"
|
|
notifications_types "github.com/PretendoNetwork/nex-protocols-go/v2/notifications/types"
|
|
)
|
|
|
|
// EndGatheringParticipation ends the participation of a connection within a gathering and performs any additional handling required
|
|
func EndGatheringParticipation(manager *common_globals.MatchmakingManager, gatheringID uint32, connection *nex.PRUDPConnection, message string) *nex.Error {
|
|
gathering, _, participants, _, nexError := FindGatheringByID(manager, gatheringID)
|
|
if nexError != nil {
|
|
return nexError
|
|
}
|
|
|
|
// TODO - Is this the right error?
|
|
if !slices.Contains(participants, uint64(connection.PID())) {
|
|
return nex.NewError(nex.ResultCodes.RendezVous.NotParticipatedGathering, "change_error")
|
|
}
|
|
|
|
newParticipants, nexError := RemoveParticipantFromGathering(manager, gatheringID, uint64(connection.PID()))
|
|
if nexError != nil {
|
|
return nexError
|
|
}
|
|
|
|
nexError = tracking.LogLeaveGathering(manager.Database, connection.PID(), gatheringID, newParticipants)
|
|
if nexError != nil {
|
|
return nexError
|
|
}
|
|
|
|
// * If the gathering is a persistent gathering and allows zero users, only remove the participant from the gathering
|
|
if uint32(gathering.Flags) & (match_making.GatheringFlags.PersistentGathering | match_making.GatheringFlags.PersistentGatheringAllowZeroUsers) != 0 {
|
|
return nil
|
|
}
|
|
|
|
if len(newParticipants) == 0 {
|
|
// * There are no more participants, so we just unregister the gathering
|
|
return UnregisterGathering(manager, connection.PID(), gatheringID)
|
|
}
|
|
|
|
var ownerPID uint64 = uint64(gathering.OwnerPID)
|
|
if connection.PID().Equals(gathering.OwnerPID) {
|
|
// * This flag tells the server to change the matchmake session owner if they disconnect
|
|
// * If the flag is not set, delete the session
|
|
// * More info: https://nintendo-wiki.pretendo.network/docs/nex/protocols/match-making/types#flags
|
|
if uint32(gathering.Flags) & match_making.GatheringFlags.DisconnectChangeOwner == 0 {
|
|
nexError = UnregisterGathering(manager, connection.PID(), gatheringID)
|
|
if nexError != nil {
|
|
return nexError
|
|
}
|
|
|
|
category := notifications.NotificationCategories.GatheringUnregistered
|
|
subtype := notifications.NotificationSubTypes.GatheringUnregistered.None
|
|
|
|
oEvent := notifications_types.NewNotificationEvent()
|
|
oEvent.PIDSource = connection.PID().Copy().(types.PID)
|
|
oEvent.Type = types.NewUInt32(notifications.BuildNotificationType(category, subtype))
|
|
oEvent.Param1 = types.NewUInt32(gatheringID)
|
|
|
|
common_globals.SendNotificationEvent(connection.Endpoint().(*nex.PRUDPEndPoint), oEvent, common_globals.RemoveDuplicates(newParticipants))
|
|
|
|
return nil
|
|
}
|
|
|
|
ownerPID, nexError = MigrateGatheringOwnership(manager, connection, gathering, newParticipants)
|
|
if nexError != nil {
|
|
return nexError
|
|
}
|
|
}
|
|
|
|
// * If the host has disconnected, set the owner as the new host. We can guarantee that the ownerPID is not zero,
|
|
// * since otherwise the gathering would have been unregistered by MigrateGatheringOwnership
|
|
if connection.PID().Equals(gathering.HostPID) && ownerPID != 0 {
|
|
nexError = UpdateSessionHost(manager, gatheringID, types.NewPID(ownerPID), types.NewPID(ownerPID))
|
|
if nexError != nil {
|
|
common_globals.Logger.Error(nexError.Error())
|
|
return nexError
|
|
}
|
|
|
|
category := notifications.NotificationCategories.HostChanged
|
|
subtype := notifications.NotificationSubTypes.HostChanged.None
|
|
|
|
oEvent := notifications_types.NewNotificationEvent()
|
|
oEvent.PIDSource = connection.PID().Copy().(types.PID)
|
|
oEvent.Type = types.NewUInt32(notifications.BuildNotificationType(category, subtype))
|
|
oEvent.Param1 = types.NewUInt32(gatheringID)
|
|
|
|
// TODO - Should the notification actually be sent to all participants?
|
|
common_globals.SendNotificationEvent(connection.Endpoint().(*nex.PRUDPEndPoint), oEvent, common_globals.RemoveDuplicates(participants))
|
|
|
|
nexError = tracking.LogChangeHost(manager.Database, connection.PID(), gatheringID, gathering.HostPID, types.NewPID(ownerPID))
|
|
if nexError != nil {
|
|
common_globals.Logger.Error(nexError.Error())
|
|
return nexError
|
|
}
|
|
}
|
|
|
|
category := notifications.NotificationCategories.Participation
|
|
subtype := notifications.NotificationSubTypes.Participation.Ended
|
|
|
|
oEvent := notifications_types.NewNotificationEvent()
|
|
oEvent.PIDSource = connection.PID().Copy().(types.PID)
|
|
oEvent.Type = types.NewUInt32(notifications.BuildNotificationType(category, subtype))
|
|
oEvent.Param1 = types.NewUInt32(gatheringID)
|
|
oEvent.Param2 = types.NewUInt32(uint32((connection.PID()))) // TODO - This assumes a legacy client. Will not work on the Switch
|
|
oEvent.StrParam = types.NewString(message)
|
|
|
|
var participationEndedTargets []uint64
|
|
|
|
// * When the VerboseParticipants or VerboseParticipantsEx flags are set, all participant notification events are sent to everyone
|
|
if uint32(gathering.Flags) & (match_making.GatheringFlags.VerboseParticipants | match_making.GatheringFlags.VerboseParticipantsEx) != 0 {
|
|
participationEndedTargets = common_globals.RemoveDuplicates(participants)
|
|
} else {
|
|
participationEndedTargets = []uint64{uint64(gathering.OwnerPID)}
|
|
}
|
|
|
|
common_globals.SendNotificationEvent(connection.Endpoint().(*nex.PRUDPEndPoint), oEvent, participationEndedTargets)
|
|
|
|
return nil
|
|
}
|