Re-work async code + more

Lots of changes but I'll try to summarize:
- Changed around lots of exports
- Removed EventDispatcher (in favor of inheriting from client classes and overriding their handlers)
- Add AsyncClientBase and update all clients to inherit from it (handles receiving from a socket through packet reader classes and manages receive + keep alive tasks.
- Add HEADER_SIZE attribute to PacketReader. Implementations should define this as the size of the header bytes. AsyncClientBase will reset the reader to this position after checking for handlers to receive into.
- Clean up CheckRevision code, add preload() and get_files() function
- Significant rewrite of BnetClient. See the related script for new usage example. Only partially tested.
- Probably other things

Author: Davnit

bncs/__init__.py

@@ -1,24 +1,14 @@
 
+from . import chat
 from . import crev
 from . import hashing
+from . import packets
 from . import utils
 
-from .packets import *
+from .chat import ChatUser, ChatEvent, ChatEventType, ChannelFlags, UserFlags
 
-from .client import BnetClient, ChatEvent
-
-# Chat event IDs
-from .chat import EID_SHOWUSER, EID_JOIN, EID_LEAVE, EID_WHISPER, EID_TALK, EID_BROADCAST, EID_CHANNEL, EID_USERFLAGS, \
-    EID_WHISPERSENT, EID_CHANNELFULL, EID_CHANNELDOESNOTEXIST, EID_CHANNELRESTRICTED, EID_INFO, EID_ERROR, \
-    EID_IGNORE, EID_ACCEPT, EID_EMOTE, ChatEventType
-
-# Channel flags
-from .chat import CHANNEL_PUBLIC, CHANNEL_MODERATED, CHANNEL_RESTRICTED, CHANNEL_SILENT, CHANNEL_SYSTEM, \
-    CHANNEL_PRODUCT, CHANNEL_GLOBAL, CHANNEL_REDIRECT, CHANNEL_CHAT, CHANNEL_SUPPORT, ChannelFlags
-
-# User flags
-from .chat import FLAG_BLIZZARD, FLAG_CHANOP, FLAG_CHANVOICE, FLAG_BNETADMIN, FLAG_NOUDP, FLAG_SQUELCH, FLAG_GUEST, \
-    UserFlags
+from .client import BnetClient, InvalidOperationError, ClientStatus, ClientAuthResult, AccountLoginResult, \
+    AccountCreateResult, LadderDataSorting, FriendStatus, FriendLocation
 
 from .products import BncsProduct, PRODUCT_STAR, PRODUCT_SEXP, PRODUCT_W2BN, PRODUCT_D2DV, PRODUCT_D2XP, \
     PRODUCT_JSTR, PRODUCT_WAR3, PRODUCT_W3XP, PRODUCT_DRTL, PRODUCT_DSHR, PRODUCT_SSHR, PRODUCT_W3DM, \

bncs/chat.py

@@ -63,6 +63,7 @@ class ChatEventType(enum.IntEnum):
 
 
 class ChannelFlags(enum.IntFlag):
+    Private = 0
     Public = CHANNEL_PUBLIC
     Moderated = CHANNEL_MODERATED
     Restricted = CHANNEL_RESTRICTED
@@ -76,10 +77,110 @@ class ChannelFlags(enum.IntFlag):
 
 
 class UserFlags(enum.IntFlag):
+    NoFlags = 0
     Blizzard = FLAG_BLIZZARD
     ChannelOperator = FLAG_CHANOP
     ChannelSpeaker = FLAG_CHANVOICE
     ServerAdmin = FLAG_BNETADMIN
     UdpPlug = FLAG_NOUDP
     Squelched = FLAG_SQUELCH
     Guest = FLAG_GUEST
+
+
+class ChatUser:
+    def __init__(self, username, flags=0, ping=0, statstring=None):
+        self.name = username
+        self.flags = flags
+        self.ping = ping
+        self.statstring = statstring
+
+        self.ip_address = None
+        self.account_id = None
+        self.regauth = None
+
+
+class ChatEvent:
+    def __init__(self, event_id, user=None, msg=None):
+        self.eid = ChatEventType(event_id)
+        self.text = msg
+        self.text_encoding = None
+        self.is_update = False
+
+        self.flags = user.flags if user else 0
+        self.ping = user.ping if user else 0
+        self.username = user.name if user else ""
+
+        # Deprecated fields, may be supported on some private servers
+        self.ip_address = user.ip_address if user else None
+        self.account_id = user.account_id if user else None
+        self.regauth = user.regauth if user else None
+
+    def __repr__(self):
+        s = f"<BncsChatEvent eid={self.eid.name}, " \
+            f"flags={self.flags.name or hex(self.flags.value)}, ping={self.ping}ms"
+
+        # Defunct values, only show if they are different from expected.
+        if self.ip_address != "0.0.0.0":
+            s += f", ip={self.ip_address}"
+        if self.account_id != 0xbaadf00d:
+            s += f", account={self.account_id}"
+        if self.regauth != 0xbaadf00d:
+            s += f", authority={self.regauth}",
+
+        s += f", username='{self.username}', text='{self.text}'>"
+        return s
+
+    def build_packet(self, hide_private_info=True):
+        """Builds a BncsPacket to represent this chat event.
+
+            If hide_private_info is TRUE then the IpAddress, AccountId, and RegAuth fields will be obscured.
+        """
+        from .packets import BncsPacket, SID_CHATEVENT
+        pak = BncsPacket(SID_CHATEVENT)
+        pak.insert_dword(self.eid.value)
+        pak.insert_dword(self.flags.value)
+        pak.insert_dword(self.ping)
+
+        hidden_value = 0xbaadf00d
+        if hide_private_info:
+            pak.insert_dword(0)
+            pak.insert_dword(hidden_value)
+            pak.insert_dword(hidden_value)
+        else:
+            pak.insert_ipv4(self.ip_address or 0)
+            pak.insert_dword(self.account_id or hidden_value)
+            pak.insert_dword(self.regauth or hidden_value)
+
+        pak.insert_string(self.username)
+        pak.insert_string(self.text, encoding=self.text_encoding)
+        return pak
+
+    @classmethod
+    def parse(cls, packet):
+        from .packets import BncsReader
+
+        if not isinstance(packet, BncsReader):
+            raise TypeError("ChatEvent can only be parsed from a BncsReader")
+
+        event = cls(packet.get_dword())
+        flag_type = ChannelFlags if event.eid == ChatEventType.JoinChannel else UserFlags
+
+        event.flags = flag_type(packet.get_dword())
+        event.ping = packet.get_dword()
+        event.ip_address = packet.get_ipv4()
+        event.account_id = packet.get_dword()
+        event.regauth = packet.get_dword()
+        event.username = packet.get_string()
+
+        # The text field can have mixed encodings depending on context
+        event.text = packet.get_string(encoding=None)
+        if event.eid not in [ChatEventType.ShowUser, ChatEventType.UserJoin, ChatEventType.UserLeave,
+                             ChatEventType.FlagUpdate]:
+            try:
+                event.text = event.text.decode("utf-8")
+                event.text_encoding = "utf-8"
+            except UnicodeDecodeError:
+                event.text = event.text.decode("latin-1", errors='ignore')
+                event.text_encoding = "latin-1"
+
+        return event