azalea_client/plugins/
disconnect.rs

1//! Disconnect a client from the server.
2
3use azalea_chat::FormattedText;
4use azalea_core::entity_id::MinecraftEntityId;
5use azalea_entity::{
6    EntityBundle, HasClientLoaded, InLoadedChunk, LocalEntity, metadata::PlayerMetadataBundle,
7};
8use bevy_app::{App, Plugin, PostUpdate};
9use bevy_ecs::prelude::*;
10use derive_more::Deref;
11use tracing::info;
12
13use super::login::IsAuthenticated;
14#[cfg(feature = "online-mode")]
15use crate::chat_signing;
16use crate::{
17    client::JoinedClientBundle, connection::RawConnection, local_player::WorldHolder, mining,
18    tick_counter::TicksConnected,
19};
20
21pub struct DisconnectPlugin;
22impl Plugin for DisconnectPlugin {
23    fn build(&self, app: &mut App) {
24        app.add_message::<DisconnectEvent>().add_systems(
25            PostUpdate,
26            (
27                update_read_packets_task_running_component,
28                remove_components_from_disconnected_players,
29                // this happens after `remove_components_from_disconnected_players` since that
30                // system removes `IsConnectionAlive`, which ensures that
31                // `DisconnectEvent` won't get called again from
32                // `disconnect_on_connection_dead`
33                disconnect_on_connection_dead,
34            )
35                .chain(),
36        );
37    }
38}
39
40/// An event sent when a client got disconnected from the server.
41///
42/// If the client was kicked with a reason, that reason will be present in the
43/// [`reason`](DisconnectEvent::reason) field.
44///
45/// This event won't be sent if creating the initial connection to the server
46/// failed, for that see [`ConnectionFailedEvent`].
47///
48/// [`ConnectionFailedEvent`]: crate::join::ConnectionFailedEvent
49
50#[derive(Message)]
51pub struct DisconnectEvent {
52    pub entity: Entity,
53    pub reason: Option<FormattedText>,
54}
55
56/// A bundle of components that are removed when a client disconnects.
57///
58/// This shouldn't be used for inserts because not all of the components should
59/// always be present.
60#[derive(Bundle)]
61pub struct RemoveOnDisconnectBundle {
62    pub joined_client: JoinedClientBundle,
63
64    pub entity: EntityBundle,
65    pub minecraft_entity_id: MinecraftEntityId,
66    pub world_holder: WorldHolder,
67    pub player_metadata: PlayerMetadataBundle,
68    pub in_loaded_chunk: InLoadedChunk,
69    //// This makes it close the TCP connection.
70    pub raw_connection: RawConnection,
71    /// This makes it not send [`DisconnectEvent`] again.
72    pub is_connection_alive: IsConnectionAlive,
73    /// Resend our chat signing certs next time.
74    #[cfg(feature = "online-mode")]
75    pub chat_signing_session: chat_signing::ChatSigningSession,
76    /// They're not authenticated anymore if they disconnected.
77    pub is_authenticated: IsAuthenticated,
78    // send ServerboundPlayerLoaded next time we join.
79    pub has_client_loaded: HasClientLoaded,
80    // TickCounter is reset on reconnect
81    pub ticks_alive: TicksConnected,
82
83    // the rest of the mining components are already removed, as JoinedClientBundle includes
84    // MineBundle
85    pub mining: mining::Mining,
86}
87
88/// A system that removes the several components from our clients when they get
89/// a [`DisconnectEvent`].
90pub fn remove_components_from_disconnected_players(
91    mut commands: Commands,
92    mut events: MessageReader<DisconnectEvent>,
93    mut loaded_by_query: Query<&mut azalea_entity::LoadedBy>,
94) {
95    for DisconnectEvent { entity, reason } in events.read() {
96        info!(
97            "A client {entity:?} was disconnected{}",
98            if let Some(reason) = reason {
99                format!(": {reason}")
100            } else {
101                "".to_owned()
102            }
103        );
104        commands
105            .entity(*entity)
106            .remove::<RemoveOnDisconnectBundle>();
107        // note that we don't remove the client from the ECS, so if they decide
108        // to reconnect they'll keep their state
109
110        // now we have to remove ourselves from the LoadedBy for every entity.
111        // in theory this could be inefficient if we have massive swarms... but in
112        // practice this is fine.
113        for mut loaded_by in &mut loaded_by_query.iter_mut() {
114            loaded_by.remove(entity);
115        }
116    }
117}
118
119#[derive(Clone, Component, Copy, Debug, Deref)]
120pub struct IsConnectionAlive(bool);
121
122fn update_read_packets_task_running_component(
123    query: Query<(Entity, &RawConnection)>,
124    mut commands: Commands,
125) {
126    for (entity, raw_connection) in &query {
127        let running = raw_connection.is_alive();
128        commands.entity(entity).insert(IsConnectionAlive(running));
129    }
130}
131
132#[allow(clippy::type_complexity)]
133fn disconnect_on_connection_dead(
134    query: Query<(Entity, &IsConnectionAlive), (Changed<IsConnectionAlive>, With<LocalEntity>)>,
135    mut disconnect_events: MessageWriter<DisconnectEvent>,
136) {
137    for (entity, &is_connection_alive) in &query {
138        if !*is_connection_alive {
139            disconnect_events.write(DisconnectEvent {
140                entity,
141                reason: None,
142            });
143        }
144    }
145}
azalea_client/plugins/disconnect.rs

azalea_client/plugins/
disconnect.rs
