eolib 2.0.1__tar.gz → 2.0.2__tar.gz

{eolib-2.0.1 → eolib-2.0.2}/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.2] - 2025-07-29
+
+### Fixed
+
+- Fix inaccurate deserialization of `WelcomeReplyServerPacket` where non-chunked portions of the
+  data structure were being treated as if they were chunked.
+
 ## [2.0.1] - 2025-07-06
 
 ### Fixed
@@ -163,7 +170,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Data encryption
   - Packet sequencer
 
-[Unreleased]: https://github.com/cirras/eolib-python/compare/v2.0.1...HEAD
+[Unreleased]: https://github.com/cirras/eolib-python/compare/v2.0.2...HEAD
+[2.0.2]: https://github.com/cirras/eolib-python/compare/v2.0.1...v2.0.2
 [2.0.1]: https://github.com/cirras/eolib-python/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/cirras/eolib-python/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/cirras/eolib-python/compare/v1.1.1...v1.2.0

{eolib-2.0.1 → eolib-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eolib
-Version: 2.0.1
+Version: 2.0.2
 Summary: Core library for writing applications related to Endless Online.
 Project-URL: Documentation, https://cirras.github.io/eolib-python
 Project-URL: Issues, https://github.com/Cirras/eolib-python/issues

{eolib-2.0.1 → eolib-2.0.2}/eo-protocol/xml/net/server/protocol.xml

@@ -1125,22 +1125,22 @@
     <packet family="Welcome" action="Reply">
         <comment>Reply to selecting a character / entering game</comment>
         <field name="welcome_code" type="WelcomeCode"/>
-        <chunked>
-            <switch field="welcome_code">
-                <case value="SelectCharacter">
-                    <field name="session_id" type="short"/>
-                    <field name="character_id" type="int"/>
-                    <field name="map_id" type="short"/>
-                    <array name="map_rid" type="short" length="2"/>
-                    <field name="map_file_size" type="three"/>
-                    <array name="eif_rid" type="short" length="2"/>
-                    <field name="eif_length" type="short"/>
-                    <array name="enf_rid" type="short" length="2"/>
-                    <field name="enf_length" type="short"/>
-                    <array name="esf_rid" type="short" length="2"/>
-                    <field name="esf_length" type="short"/>
-                    <array name="ecf_rid" type="short" length="2"/>
-                    <field name="ecf_length" type="short"/>
+        <switch field="welcome_code">
+            <case value="SelectCharacter">
+                <field name="session_id" type="short"/>
+                <field name="character_id" type="int"/>
+                <field name="map_id" type="short"/>
+                <array name="map_rid" type="short" length="2"/>
+                <field name="map_file_size" type="three"/>
+                <array name="eif_rid" type="short" length="2"/>
+                <field name="eif_length" type="short"/>
+                <array name="enf_rid" type="short" length="2"/>
+                <field name="enf_length" type="short"/>
+                <array name="esf_rid" type="short" length="2"/>
+                <field name="esf_length" type="short"/>
+                <array name="ecf_rid" type="short" length="2"/>
+                <field name="ecf_length" type="short"/>
+                <chunked>
                     <field name="name" type="string"/>
                     <break/>
                     <field name="title" type="string"/>
@@ -1161,8 +1161,10 @@
                     <field name="settings" type="ServerSettings"/>
                     <field name="login_message_code" type="LoginMessageCode"/>
                     <break/>
-                </case>
-                <case value="EnterGame">
+                </chunked>
+            </case>
+            <case value="EnterGame">
+                <chunked>
                     <break/>
                     <array name="news" type="string" length="9" delimited="true"/>
                     <field name="weight" type="Weight"/>
@@ -1171,9 +1173,9 @@
                     <array name="spells" type="Spell"/>
                     <break/>
                     <field name="nearby" type="NearbyInfo"/>
-                </case>
-            </switch>
-        </chunked>
+                </chunked>
+            </case>
+        </switch>
     </packet>
 
     <packet family="AdminInteract" action="Reply">

eolib-2.0.2/src/eolib/__about__.py

@@ -0,0 +1 @@
+__version__ = "2.0.2"

{eolib-2.0.1 → eolib-2.0.2}/src/eolib/protocol/_generated/net/server/welcome_reply_server_packet.py

@@ -106,7 +106,6 @@ class WelcomeReplyServerPacket(Packet):
             if data._welcome_code is None:
                 raise SerializationError("welcome_code must be provided.")
             writer.add_short(int(data._welcome_code))
-            writer.string_sanitization_mode = True
             if data._welcome_code == WelcomeCode.SelectCharacter:
                 if not isinstance(data._welcome_code_data, WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter):
                     raise SerializationError("Expected welcome_code_data to be type WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter for welcome_code " + WelcomeCode(data._welcome_code).name + ".")
@@ -115,7 +114,6 @@ class WelcomeReplyServerPacket(Packet):
                 if not isinstance(data._welcome_code_data, WelcomeReplyServerPacket.WelcomeCodeDataEnterGame):
                     raise SerializationError("Expected welcome_code_data to be type WelcomeReplyServerPacket.WelcomeCodeDataEnterGame for welcome_code " + WelcomeCode(data._welcome_code).name + ".")
                 WelcomeReplyServerPacket.WelcomeCodeDataEnterGame.serialize(writer, data._welcome_code_data)
-            writer.string_sanitization_mode = False
         finally:
             writer.string_sanitization_mode = old_string_sanitization_mode
 
@@ -134,13 +132,11 @@ class WelcomeReplyServerPacket(Packet):
         try:
             reader_start_position: int = reader.position
             welcome_code = WelcomeCode(reader.get_short())
-            reader.chunked_reading_mode = True
             welcome_code_data: WelcomeReplyServerPacket.WelcomeCodeData = None
             if welcome_code == WelcomeCode.SelectCharacter:
                 welcome_code_data = WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter.deserialize(reader)
             elif welcome_code == WelcomeCode.EnterGame:
                 welcome_code_data = WelcomeReplyServerPacket.WelcomeCodeDataEnterGame.deserialize(reader)
-            reader.chunked_reading_mode = False
             result = WelcomeReplyServerPacket(welcome_code=welcome_code, welcome_code_data=welcome_code_data)
             result._byte_size = reader.position - reader_start_position
             return result
@@ -439,6 +435,7 @@ class WelcomeReplyServerPacket(Packet):
                 if data._ecf_length is None:
                     raise SerializationError("ecf_length must be provided.")
                 writer.add_short(data._ecf_length)
+                writer.string_sanitization_mode = True
                 if data._name is None:
                     raise SerializationError("name must be provided.")
                 writer.add_string(data._name)
@@ -491,6 +488,7 @@ class WelcomeReplyServerPacket(Packet):
                     raise SerializationError("login_message_code must be provided.")
                 writer.add_char(int(data._login_message_code))
                 writer.add_byte(0xFF)
+                writer.string_sanitization_mode = False
             finally:
                 writer.string_sanitization_mode = old_string_sanitization_mode
 
@@ -531,6 +529,7 @@ class WelcomeReplyServerPacket(Packet):
                 for i in range(2):
                     ecf_rid.append(reader.get_short())
                 ecf_length = reader.get_short()
+                reader.chunked_reading_mode = True
                 name = reader.get_string()
                 reader.next_chunk()
                 title = reader.get_string()
@@ -551,6 +550,7 @@ class WelcomeReplyServerPacket(Packet):
                 settings = ServerSettings.deserialize(reader)
                 login_message_code = LoginMessageCode(reader.get_char())
                 reader.next_chunk()
+                reader.chunked_reading_mode = False
                 result = WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter(session_id=session_id, character_id=character_id, map_id=map_id, map_rid=map_rid, map_file_size=map_file_size, eif_rid=eif_rid, eif_length=eif_length, enf_rid=enf_rid, enf_length=enf_length, esf_rid=esf_rid, esf_length=esf_length, ecf_rid=ecf_rid, ecf_length=ecf_length, name=name, title=title, guild_name=guild_name, guild_rank_name=guild_rank_name, class_id=class_id, guild_tag=guild_tag, admin=admin, level=level, experience=experience, usage=usage, stats=stats, equipment=equipment, guild_rank=guild_rank, settings=settings, login_message_code=login_message_code)
                 result._byte_size = reader.position - reader_start_position
                 return result
@@ -629,6 +629,7 @@ class WelcomeReplyServerPacket(Packet):
             """
             old_string_sanitization_mode: bool = writer.string_sanitization_mode
             try:
+                writer.string_sanitization_mode = True
                 writer.add_byte(0xFF)
                 if data._news is None:
                     raise SerializationError("news must be provided.")
@@ -653,6 +654,7 @@ class WelcomeReplyServerPacket(Packet):
                 if data._nearby is None:
                     raise SerializationError("nearby must be provided.")
                 NearbyInfo.serialize(writer, data._nearby)
+                writer.string_sanitization_mode = False
             finally:
                 writer.string_sanitization_mode = old_string_sanitization_mode
 
@@ -670,6 +672,7 @@ class WelcomeReplyServerPacket(Packet):
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
+                reader.chunked_reading_mode = True
                 reader.next_chunk()
                 news = []
                 for i in range(9):
@@ -687,6 +690,7 @@ class WelcomeReplyServerPacket(Packet):
                     spells.append(Spell.deserialize(reader))
                 reader.next_chunk()
                 nearby = NearbyInfo.deserialize(reader)
+                reader.chunked_reading_mode = False
                 result = WelcomeReplyServerPacket.WelcomeCodeDataEnterGame(news=news, weight=weight, items=items, spells=spells, nearby=nearby)
                 result._byte_size = reader.position - reader_start_position
                 return result

eolib-2.0.1/src/eolib/__about__.py

@@ -1 +0,0 @@
-__version__ = "2.0.1"