From d57ed896ec46ec5f081b3031bc8606033fdfd95f Mon Sep 17 00:00:00 2001 From: Fuwn Date: Wed, 12 Jun 2024 06:50:29 -0700 Subject: refactor: clearer network protobuf names --- AppInitCmd.proto | 4 +- Net2Property.proto | 13 ----- NetCmds.proto | 8 --- NetConst.proto | 132 ------------------------------------------------- NetData.proto | 9 ---- NetPacket.proto | 67 ------------------------- NetProperty.proto | 8 --- Network2Property.proto | 13 +++++ NetworkCommands.proto | 8 +++ NetworkConstants.proto | 132 +++++++++++++++++++++++++++++++++++++++++++++++++ NetworkData.proto | 9 ++++ NetworkPacket.proto | 67 +++++++++++++++++++++++++ NetworkProperty.proto | 8 +++ OldPropertyList.proto | 4 +- PropertyList.proto | 4 +- build/test.py | 12 ++--- 16 files changed, 249 insertions(+), 249 deletions(-) delete mode 100644 Net2Property.proto delete mode 100644 NetCmds.proto delete mode 100644 NetConst.proto delete mode 100644 NetData.proto delete mode 100644 NetPacket.proto delete mode 100644 NetProperty.proto create mode 100644 Network2Property.proto create mode 100644 NetworkCommands.proto create mode 100644 NetworkConstants.proto create mode 100644 NetworkData.proto create mode 100644 NetworkPacket.proto create mode 100644 NetworkProperty.proto diff --git a/AppInitCmd.proto b/AppInitCmd.proto index 10b7e73..d7c3bb9 100644 --- a/AppInitCmd.proto +++ b/AppInitCmd.proto @@ -2,8 +2,8 @@ syntax = "proto3"; package whirl; -import "NetProperty.proto"; +import "NetworkProperty.proto"; message AppInitCmd { - repeated NetProperty property_list = 2; + repeated NetworkProperty property_list = 2; } \ No newline at end of file diff --git a/Net2Property.proto b/Net2Property.proto deleted file mode 100644 index 523b17b..0000000 --- a/Net2Property.proto +++ /dev/null @@ -1,13 +0,0 @@ -syntax = "proto3"; - -package whirl; - -message Net2Property { - int32 prop_id = 1; - int32 flags = 2; - int32 access = 3; - oneof value { - string string_value = 4; - bytes binary_value = 5; - } -} \ No newline at end of file diff --git a/NetCmds.proto b/NetCmds.proto deleted file mode 100644 index 83d920c..0000000 --- a/NetCmds.proto +++ /dev/null @@ -1,8 +0,0 @@ -syntax = "proto3"; - -package whirl; - -message NetCmds { - repeated string receivable_net_packet = 1; - map property_list = 2; -} diff --git a/NetConst.proto b/NetConst.proto deleted file mode 100644 index e51476f..0000000 --- a/NetConst.proto +++ /dev/null @@ -1,132 +0,0 @@ -syntax = "proto3"; - -package whirl; - -enum NetConst { - UNKNOWN = 0; - - PROTOCOL_VERSION = 24; - - STATECMD = 2; - - MAXCMD = 255; - CURRENT_ROOM = 253; -} - -enum Client { - UNKNOWN_CLIENT = 0; - - CLIENT = 1; - CO = 254; - PO = 255; -} - -enum Variable { - VAR_NULL = 0; - VAR_APPNAME = 1; - VAR_USERNAME = 2; - VAR_PROTOCOL = 3; - VAR_ERROR = 4; - VAR_CHANNEL = 5; - VAR_BITMAP = 6; - VAR_PASSWORD = 7; - VAR_AVATARS = 8; - VAR_UPDATETIME = 9; - VAR_CLIENT = 10; - VAR_SERIAL = 11; - VAR_EMAIL = 12; - VAR_LOGONOFF = 13; - VAR_DURATION = 14; - VAR_GUEST = 15; - VAR_SERVERTYPE = 16; - VAR_BIZCARD = 17; - VAR_NEW_PASSWD = 18; - VAR_PRIV = 19; - VAR_ASLEEP = 20; - VAR_EXTERNAL_HTTP_SERVER = 21; - VAR_SCRIPT_SERVER = 22; - VAR_SMTP_SERVER = 23; - VAR_MAIL_DOMAIN = 24; - VAR_NEW_USERNAME = 25; - VAR_INTERNAL_HTTP_SERVER = 26; - VAR_INVENTORY = 27; -} - -enum Acknowledgement { - ACK = 0; - NAK_BAD_USER = 1; - NAK_MAX_ORDINARY = 2; - NAK_MAX_PRIORITY = 3; - NAK_BAD_WORLD = 4; - NAK_FATAL = 5; - NAK_BAD_PROTOCOL = 6; - NAK_BAD_CLIENTSW = 7; - NAK_BAD_ROOM = 8; - NAK_BAD_SERIAL = 9; - NAK_TAKEN_SERIAL = 10; - NAK_TAKEN_USER = 11; - NAK_NO_SUCH_USER = 12; - NAK_BAD_PASSWORD = 13; - NAK_BAD_ACCOUNT = 14; - NAK_NOT_LOGGEDON = 15; - NAK_BAD_IPADDRESS = 16; - NAK_LOGGEDON = 17; - NAK_CRYPT_METHOD = 18; - NAK_CRYPT_ERROR = 19; - NAK_SESSIONINIT = 20; - NAK_ROOM_FULL = 21; - NAK_SHUTDOWN = 100; - NAK_WRITE_ERROR = 101; - NAK_READ_ERROR = 102; - NAK_UNEXPECTED = 103; - NAK_CONNECTION = 104; - NAK_IOSTREAMS = 105; - NAK_TIMEOUT = 106; - NAK_UNREACHABLE = 107; -} - -enum Status { - STATUS_UNKNOWN = 0; - - STATUS_CONNECTED = 200; - STATUS_DETACHING = 201; - STATUS_WILLRETRY = 202; - STATUS_DISCONNECTED = 203; - STATUS_DEAD = 204; - STATUS_OFFLINE = 205; - STATUS_GALAXY_ONLINE = 206; - STATUS_GALAXY_OFFLINE = 207; // 206 -} - -enum PropertyFlag { - PROPFLAG_NONE = 0; - PROPFLAG_BINARY = 16; - PROPFLAG_FINGER = 32; - PROPFLAG_AUTOUPDATE = 64; - PROPFLAG_DBSTORE = 128; -} - -enum PropertyAccess { - PROPACCESS_UNKNOWN = 0; - - PROPACCESS_POSSESS = 1; - PROPACCESS_PRIVATE = 2; -} - -enum Server { - SERVER_UNKNOWN = 0; - USER_SERVER_DB = 1; - USER_SERVER_ANON = 2; - ROOM_SERVER_US = 3; - ROOM_SERVER_ANON = 4; -} - -enum Privilage { - PRIV_NONE = 0; - PRIV_BUILD = 1; - PRIV_BROADCAST = 2; - PRIV_PROPERTY = 4; - PRIV_VIP = 8; - PRIV_VIP2 = 16; - PRIV_SPECIALGUEST = 64; -} diff --git a/NetData.proto b/NetData.proto deleted file mode 100644 index 786370e..0000000 --- a/NetData.proto +++ /dev/null @@ -1,9 +0,0 @@ -syntax = "proto3"; - -package whirl; - -message NetData { - bytes data = 1; - int32 packet_size = 2; - int32 offset = 3; -} diff --git a/NetPacket.proto b/NetPacket.proto deleted file mode 100644 index 0e9aff9..0000000 --- a/NetPacket.proto +++ /dev/null @@ -1,67 +0,0 @@ -syntax = "proto3"; - -package whirl; - -import "AppearActorCmd.proto"; -import "AppInitCmd.proto"; -import "PropCmd.proto"; -import "BuddyListNotifyCmd.proto"; -import "BuddyListUpdateCmd.proto"; -import "ChannelCmd.proto"; -import "DisappearActorCmd.proto"; -import "FingerReplyCmd.proto"; -import "FingerRequestCmd.proto"; -import "LongLocationCmd.proto"; -import "PropertySetCmd.proto"; -import "PropertyUpdateCmd.proto"; -import "PropRequestCmd.proto"; -import "RedirectCmd.proto"; -import "RedirectIDCmd.proto"; -import "RoomIDCmd.proto"; -import "RoomIDRequestCmd.proto"; -import "SessionExitCmd.proto"; -import "SessionInitCmd.proto"; -import "ShortLocationCmd.proto"; -import "SubscribeDistanceCmd.proto"; -import "SubscribeRoomCmd.proto"; -import "TeleportCmd.proto"; -import "TextCmd.proto"; -import "UnsubscribeRoomCmd.proto"; -import "WhisperCmd.proto"; - -message NetPacket { - uint32 length = 1; - oneof object_id { - uint32 short_object_id = 2; - string long_object_id = 3; - } - uint32 type = 4; - oneof command { - AppearActorCmd appear_actor_cmd = 5; - AppInitCmd app_init_cmd = 6; - PropCmd prop_cmd = 7; - BuddyListNotifyCmd buddy_list_notify_cmd = 8; - BuddyListUpdateCmd buddy_list_update_cmd = 9; - ChannelCmd channel_cmd = 10; - DisappearActorCmd disappear_actor_cmd = 11; - FingerReplyCmd finger_reply_cmd = 12; - FingerRequestCmd finger_request_cmd = 13; - LongLocationCmd long_location_cmd = 14; - PropertySetCmd property_set_cmd = 15; - PropertyUpdateCmd property_update_cmd = 16; - PropRequestCmd prop_request_cmd = 17; - RedirectCmd redirect_cmd = 18; - RedirectIDCmd redirect_id_cmd = 19; - RoomIDCmd room_id_cmd = 20; - RoomIDRequestCmd room_id_request_cmd = 21; - SessionExitCmd session_exit_cmd = 22; - SessionInitCmd session_init_cmd = 23; - ShortLocationCmd short_location_cmd = 24; - SubscribeDistanceCmd subscribe_distance_cmd = 25; - SubscribeRoomCmd subscribe_room_cmd = 26; - TeleportCmd teleport_cmd = 27; - TextCmd text_cmd = 28; - UnsubscribeRoomCmd unsubscribe_room_cmd = 29; - WhisperCmd whisper_cmd = 30; - } -} diff --git a/NetProperty.proto b/NetProperty.proto deleted file mode 100644 index 8f426d8..0000000 --- a/NetProperty.proto +++ /dev/null @@ -1,8 +0,0 @@ -syntax = "proto3"; - -package whirl; - -message NetProperty { - int32 property_id = 1; - string value = 2; -} diff --git a/Network2Property.proto b/Network2Property.proto new file mode 100644 index 0000000..94f6309 --- /dev/null +++ b/Network2Property.proto @@ -0,0 +1,13 @@ +syntax = "proto3"; + +package whirl; + +message Network2Property { + int32 prop_id = 1; + int32 flags = 2; + int32 access = 3; + oneof value { + string string_value = 4; + bytes binary_value = 5; + } +} \ No newline at end of file diff --git a/NetworkCommands.proto b/NetworkCommands.proto new file mode 100644 index 0000000..d909716 --- /dev/null +++ b/NetworkCommands.proto @@ -0,0 +1,8 @@ +syntax = "proto3"; + +package whirl; + +message NetworkCommands { + repeated string receivable_network_packet = 1; + map property_list = 2; +} diff --git a/NetworkConstants.proto b/NetworkConstants.proto new file mode 100644 index 0000000..e51476f --- /dev/null +++ b/NetworkConstants.proto @@ -0,0 +1,132 @@ +syntax = "proto3"; + +package whirl; + +enum NetConst { + UNKNOWN = 0; + + PROTOCOL_VERSION = 24; + + STATECMD = 2; + + MAXCMD = 255; + CURRENT_ROOM = 253; +} + +enum Client { + UNKNOWN_CLIENT = 0; + + CLIENT = 1; + CO = 254; + PO = 255; +} + +enum Variable { + VAR_NULL = 0; + VAR_APPNAME = 1; + VAR_USERNAME = 2; + VAR_PROTOCOL = 3; + VAR_ERROR = 4; + VAR_CHANNEL = 5; + VAR_BITMAP = 6; + VAR_PASSWORD = 7; + VAR_AVATARS = 8; + VAR_UPDATETIME = 9; + VAR_CLIENT = 10; + VAR_SERIAL = 11; + VAR_EMAIL = 12; + VAR_LOGONOFF = 13; + VAR_DURATION = 14; + VAR_GUEST = 15; + VAR_SERVERTYPE = 16; + VAR_BIZCARD = 17; + VAR_NEW_PASSWD = 18; + VAR_PRIV = 19; + VAR_ASLEEP = 20; + VAR_EXTERNAL_HTTP_SERVER = 21; + VAR_SCRIPT_SERVER = 22; + VAR_SMTP_SERVER = 23; + VAR_MAIL_DOMAIN = 24; + VAR_NEW_USERNAME = 25; + VAR_INTERNAL_HTTP_SERVER = 26; + VAR_INVENTORY = 27; +} + +enum Acknowledgement { + ACK = 0; + NAK_BAD_USER = 1; + NAK_MAX_ORDINARY = 2; + NAK_MAX_PRIORITY = 3; + NAK_BAD_WORLD = 4; + NAK_FATAL = 5; + NAK_BAD_PROTOCOL = 6; + NAK_BAD_CLIENTSW = 7; + NAK_BAD_ROOM = 8; + NAK_BAD_SERIAL = 9; + NAK_TAKEN_SERIAL = 10; + NAK_TAKEN_USER = 11; + NAK_NO_SUCH_USER = 12; + NAK_BAD_PASSWORD = 13; + NAK_BAD_ACCOUNT = 14; + NAK_NOT_LOGGEDON = 15; + NAK_BAD_IPADDRESS = 16; + NAK_LOGGEDON = 17; + NAK_CRYPT_METHOD = 18; + NAK_CRYPT_ERROR = 19; + NAK_SESSIONINIT = 20; + NAK_ROOM_FULL = 21; + NAK_SHUTDOWN = 100; + NAK_WRITE_ERROR = 101; + NAK_READ_ERROR = 102; + NAK_UNEXPECTED = 103; + NAK_CONNECTION = 104; + NAK_IOSTREAMS = 105; + NAK_TIMEOUT = 106; + NAK_UNREACHABLE = 107; +} + +enum Status { + STATUS_UNKNOWN = 0; + + STATUS_CONNECTED = 200; + STATUS_DETACHING = 201; + STATUS_WILLRETRY = 202; + STATUS_DISCONNECTED = 203; + STATUS_DEAD = 204; + STATUS_OFFLINE = 205; + STATUS_GALAXY_ONLINE = 206; + STATUS_GALAXY_OFFLINE = 207; // 206 +} + +enum PropertyFlag { + PROPFLAG_NONE = 0; + PROPFLAG_BINARY = 16; + PROPFLAG_FINGER = 32; + PROPFLAG_AUTOUPDATE = 64; + PROPFLAG_DBSTORE = 128; +} + +enum PropertyAccess { + PROPACCESS_UNKNOWN = 0; + + PROPACCESS_POSSESS = 1; + PROPACCESS_PRIVATE = 2; +} + +enum Server { + SERVER_UNKNOWN = 0; + USER_SERVER_DB = 1; + USER_SERVER_ANON = 2; + ROOM_SERVER_US = 3; + ROOM_SERVER_ANON = 4; +} + +enum Privilage { + PRIV_NONE = 0; + PRIV_BUILD = 1; + PRIV_BROADCAST = 2; + PRIV_PROPERTY = 4; + PRIV_VIP = 8; + PRIV_VIP2 = 16; + PRIV_SPECIALGUEST = 64; +} diff --git a/NetworkData.proto b/NetworkData.proto new file mode 100644 index 0000000..786370e --- /dev/null +++ b/NetworkData.proto @@ -0,0 +1,9 @@ +syntax = "proto3"; + +package whirl; + +message NetData { + bytes data = 1; + int32 packet_size = 2; + int32 offset = 3; +} diff --git a/NetworkPacket.proto b/NetworkPacket.proto new file mode 100644 index 0000000..3922ea9 --- /dev/null +++ b/NetworkPacket.proto @@ -0,0 +1,67 @@ +syntax = "proto3"; + +package whirl; + +import "AppearActorCmd.proto"; +import "AppInitCmd.proto"; +import "PropCmd.proto"; +import "BuddyListNotifyCmd.proto"; +import "BuddyListUpdateCmd.proto"; +import "ChannelCmd.proto"; +import "DisappearActorCmd.proto"; +import "FingerReplyCmd.proto"; +import "FingerRequestCmd.proto"; +import "LongLocationCmd.proto"; +import "PropertySetCmd.proto"; +import "PropertyUpdateCmd.proto"; +import "PropRequestCmd.proto"; +import "RedirectCmd.proto"; +import "RedirectIDCmd.proto"; +import "RoomIDCmd.proto"; +import "RoomIDRequestCmd.proto"; +import "SessionExitCmd.proto"; +import "SessionInitCmd.proto"; +import "ShortLocationCmd.proto"; +import "SubscribeDistanceCmd.proto"; +import "SubscribeRoomCmd.proto"; +import "TeleportCmd.proto"; +import "TextCmd.proto"; +import "UnsubscribeRoomCmd.proto"; +import "WhisperCmd.proto"; + +message NetworkPacket { + uint32 length = 1; + oneof object_id { + uint32 short_object_id = 2; + string long_object_id = 3; + } + uint32 type = 4; + oneof command { + AppearActorCmd appear_actor_cmd = 5; + AppInitCmd app_init_cmd = 6; + PropCmd prop_cmd = 7; + BuddyListNotifyCmd buddy_list_notify_cmd = 8; + BuddyListUpdateCmd buddy_list_update_cmd = 9; + ChannelCmd channel_cmd = 10; + DisappearActorCmd disappear_actor_cmd = 11; + FingerReplyCmd finger_reply_cmd = 12; + FingerRequestCmd finger_request_cmd = 13; + LongLocationCmd long_location_cmd = 14; + PropertySetCmd property_set_cmd = 15; + PropertyUpdateCmd property_update_cmd = 16; + PropRequestCmd prop_request_cmd = 17; + RedirectCmd redirect_cmd = 18; + RedirectIDCmd redirect_id_cmd = 19; + RoomIDCmd room_id_cmd = 20; + RoomIDRequestCmd room_id_request_cmd = 21; + SessionExitCmd session_exit_cmd = 22; + SessionInitCmd session_init_cmd = 23; + ShortLocationCmd short_location_cmd = 24; + SubscribeDistanceCmd subscribe_distance_cmd = 25; + SubscribeRoomCmd subscribe_room_cmd = 26; + TeleportCmd teleport_cmd = 27; + TextCmd text_cmd = 28; + UnsubscribeRoomCmd unsubscribe_room_cmd = 29; + WhisperCmd whisper_cmd = 30; + } +} diff --git a/NetworkProperty.proto b/NetworkProperty.proto new file mode 100644 index 0000000..4f30762 --- /dev/null +++ b/NetworkProperty.proto @@ -0,0 +1,8 @@ +syntax = "proto3"; + +package whirl; + +message NetworkProperty { + int32 property_id = 1; + string value = 2; +} diff --git a/OldPropertyList.proto b/OldPropertyList.proto index 5bb20e9..358ad67 100644 --- a/OldPropertyList.proto +++ b/OldPropertyList.proto @@ -2,8 +2,8 @@ syntax = "proto3"; package whirl; -import "NetProperty.proto"; +import "NetworkProperty.proto"; message OldPropertyList { - repeated NetProperty properties = 1; + repeated NetworkProperty properties = 1; } diff --git a/PropertyList.proto b/PropertyList.proto index 2c83fcb..15e5ec7 100644 --- a/PropertyList.proto +++ b/PropertyList.proto @@ -2,8 +2,8 @@ syntax = "proto3"; package whirl; -import "Net2Property.proto"; +import "Network2Property.proto"; message PropertyList { - repeated Net2Property properties = 1; + repeated Network2Property properties = 1; } diff --git a/build/test.py b/build/test.py index 00cc0f4..417e9eb 100644 --- a/build/test.py +++ b/build/test.py @@ -1,24 +1,24 @@ -import NetPacket_pb2 +import NetworkPacket_pb2 import BuddyListNotifyCmd_pb2 -request = NetPacket_pb2.NetPacket() +request = NetworkPacket_pb2.NetworkPacket() request.length = 3 request.short_object_id = 0xFF -request.command_type = 0x0A +request.type = 0x0A request.buddy_list_notify_cmd.CopyFrom(BuddyListNotifyCmd_pb2.BuddyListNotifyCmd()) request.buddy_list_notify_cmd.buddy_name = "Whirl" request.buddy_list_notify_cmd.logged_on = 1 print(request.SerializeToString()) -print(request.WhichOneof("packet")) +print(request.WhichOneof("command")) -deserialised_request = NetPacket_pb2.NetPacket() +deserialised_request = NetworkPacket_pb2.NetworkPacket() deserialised_request.ParseFromString(request.SerializeToString()) print(deserialised_request.length) print(deserialised_request.short_object_id) -print(deserialised_request.command_type) +print(deserialised_request.type) print(deserialised_request.buddy_list_notify_cmd.buddy_name) print(deserialised_request.buddy_list_notify_cmd.logged_on) -- cgit v1.2.3