From 90ae61b79e1f924a585a0a06a410a5f29c019b21 Mon Sep 17 00:00:00 2001
From: Rossen Georgiev <rossen@rgp.io>
Date: Mon, 11 Jan 2016 21:18:58 +0000
Subject: [PATCH] added GC proxy object

---
 Makefile                  |   9 ++-
 protobuf_list.txt         |   1 +
 steam/client/gc.py        |  51 ++++++++++++
 steam/core/msg.py         |  81 +++++++++++++++++++
 steam/protobufs/gc_pb2.py | 161 ++++++++++++++++++++++++++++++++++++++
 5 files changed, 301 insertions(+), 2 deletions(-)
 create mode 100644 steam/client/gc.py
 create mode 100644 steam/protobufs/gc_pb2.py

diff --git a/Makefile b/Makefile
index 685a792..7c83a2d 100644
--- a/Makefile
+++ b/Makefile
@@ -41,6 +41,11 @@ pb_fetch:
 	wget -nv --show-progress -N -P ./steam/protobufs/ -i protobuf_list.txt
 
 pb_compile:
-	protoc --python_out ./steam/protobufs/ --proto_path=/usr/include --proto_path=./steam/protobufs ./steam/protobufs/*.proto
+	for filepath in `ls ./steam/protobufs/*.proto`; do \
+		protoc --python_out ./steam/protobufs/ --proto_path=/usr/include --proto_path=./steam/protobufs "$$filepath"; \
+	done;
 
-pb_update: pb_fetch pb_compile
+pb_clear:
+	rm -f ./stema/protobufs/*.proto
+
+pb_update: pb_fetch pb_compile pb_clear
diff --git a/protobuf_list.txt b/protobuf_list.txt
index 16b7a54..472613e 100644
--- a/protobuf_list.txt
+++ b/protobuf_list.txt
@@ -2,3 +2,4 @@ https://github.com/SteamRE/SteamKit/raw/master/Resources/Protobufs/steamclient/e
 https://github.com/SteamRE/SteamKit/raw/master/Resources/Protobufs/steamclient/steammessages_base.proto
 https://github.com/SteamRE/SteamKit/raw/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto
 https://github.com/SteamRE/SteamKit/raw/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto
+https://github.com/SteamRE/SteamKit/raw/master/Resources/Protobufs/gc/gc.proto
diff --git a/steam/client/gc.py b/steam/client/gc.py
new file mode 100644
index 0000000..ae30a9e
--- /dev/null
+++ b/steam/client/gc.py
@@ -0,0 +1,51 @@
+import logging
+import gevent
+from steam.util.events import EventEmitter
+from steam.util import set_proto_bit, clear_proto_bit, is_proto
+from steam.enums.emsg import EMsg
+from steam.enums import EResult
+from steam.core.msg import GCMsgHdr, GCMsgHdrProto, MsgProto
+
+
+class GameCoordinator(EventEmitter):
+    def __init__(self, client, app_id):
+        self.client = client
+        self.app_id = app_id
+        self._log = logging.getLogger("GC(appid:%d)" % app_id)
+
+        # listen for GC messages
+        self.client.on(EMsg.ClientFromGC, self._handle_from_gc)
+
+    def emit(self, event, *args):
+        if event is not None:
+            self._log.debug("Emit event: %s" % repr(event))
+        super(GameCoordinator, self).emit(event, *args)
+
+    def send(self, header, body):
+        message = MsgProto(EMsg.ClientToGC)
+        message.header.routing_appid = self.app_id
+        message.body.appid = self.app_id
+        message.body.msgtype = (set_proto_bit(header.msg)
+                                if header.proto
+                                else header.msg
+                                )
+        message.body.payload = header.serialize() + body
+
+        self.client.send(message)
+
+    def _handle_from_gc(self, msg):
+        if msg.body.appid != self.app_id:
+            return
+
+        emsg = msg.body.msgtype
+
+        if is_proto(emsg):
+            header = GCMsgHdrProto(emsg, msg.body.payload)
+            header_size = GCMsgHdrProto._size + header.headerLength
+        else:
+            header = GCMsgHdr(emsg, msg.body.payload)
+            header_size = GCMsgHdr._size
+
+        body = msg.body.payload[header_size:]
+
+        self.emit(clear_proto_bit(emsg), header, body)
diff --git a/steam/core/msg.py b/steam/core/msg.py
index 31e0f4c..0531770 100644
--- a/steam/core/msg.py
+++ b/steam/core/msg.py
@@ -5,6 +5,7 @@ from steam.enums.emsg import EMsg
 from steam.protobufs import steammessages_base_pb2
 from steam.protobufs import steammessages_clientserver_pb2
 from steam.protobufs import steammessages_clientserver_2_pb2
+from steam.protobufs import gc_pb2
 from steam.util import set_proto_bit, clear_proto_bit
 
 
@@ -382,3 +383,83 @@ class ClientLogOnResponse:
 
     def __str__(self):
         return "eresult: %s" % repr(self.eresult)
+
+
+class GCMsgHdr:
+    _size = struct.calcsize("<Hqq")
+
+    def __init__(self, msg, data=None):
+        self.proto = None
+        self.msg = clear_proto_bit(msg)
+
+        if data:
+            self.load(data)
+        else:
+            self.headerVersion = 1
+            self.targetJobID = -1
+            self.sourceJobID = -1
+
+    def serialize(self):
+        return struct.pack("<Hqq",
+                           self.headerVersion,
+                           self.targetJobID,
+                           self.sourceJobID,
+                           )
+
+    def load(self, data):
+        (self.headerVersion,
+         self.targetJobID,
+         self.sourceJobID,
+         ) = struct.unpack_from("<Hqq", data)
+
+    def __str__(self):
+        return '\n'.join(["headerVersion: %s" % self.headerVersion,
+                          "targetJobID: %s" % self.targetJobID,
+                          "sourceJobID: %s" % self.sourceJobID,
+                          ])
+
+class GCMsgHdrProto:
+    _size = struct.calcsize("<Ii")
+
+    def __init__(self, msg, data=None):
+        self.proto = gc_pb2.CMsgProtoBufHeader()
+
+        if data:
+            self.load(data)
+        else:
+            self.msg = clear_proto_bit(msg)
+            self.headerLength = 0
+
+
+    def serialize(self):
+        proto_data = self.proto.SerializeToString()
+        self.headerLength = len(proto_data)
+
+        return struct.pack("<Ii",
+                           set_proto_bit(self.msg),
+                           self.headerLength,
+                           ) + proto_data
+
+    def load(self, data):
+        (msg,
+         self.headerLength,
+         ) = struct.unpack_from("<Ii", data)
+
+        self.msg = clear_proto_bit(msg)
+
+        if self.headerLength:
+            x = GCMsgHdrProto._size
+            self.proto.ParseFromString(data[x:x+self.headerLength])
+
+    def __str__(self):
+        resp = ["msg: %s" % self.msg,
+                "headerLength: %s" % self.headerLength,
+                ]
+
+        proto = str(self.proto)
+
+        if proto:
+            resp.append('-- proto --')
+            resp.append(proto)
+
+        return '\n'.join(resp)
diff --git a/steam/protobufs/gc_pb2.py b/steam/protobufs/gc_pb2.py
new file mode 100644
index 0000000..6c001df
--- /dev/null
+++ b/steam/protobufs/gc_pb2.py
@@ -0,0 +1,161 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: gc.proto
+
+from google.protobuf.internal import enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import descriptor_pb2
+# @@protoc_insertion_point(imports)
+
+
+
+
+DESCRIPTOR = _descriptor.FileDescriptor(
+  name='gc.proto',
+  package='',
+  serialized_pb='\n\x08gc.proto\"\xe1\x02\n\x12\x43MsgProtoBufHeader\x12\x17\n\x0f\x63lient_steam_id\x18\x01 \x01(\x06\x12\x19\n\x11\x63lient_session_id\x18\x02 \x01(\x05\x12\x15\n\rsource_app_id\x18\x03 \x01(\r\x12+\n\rjob_id_source\x18\n \x01(\x06:\x14\x31\x38\x34\x34\x36\x37\x34\x34\x30\x37\x33\x37\x30\x39\x35\x35\x31\x36\x31\x35\x12+\n\rjob_id_target\x18\x0b \x01(\x06:\x14\x31\x38\x34\x34\x36\x37\x34\x34\x30\x37\x33\x37\x30\x39\x35\x35\x31\x36\x31\x35\x12\x17\n\x0ftarget_job_name\x18\x0c \x01(\t\x12\x12\n\x07\x65result\x18\r \x01(\x05:\x01\x32\x12\x15\n\rerror_message\x18\x0e \x01(\t\x12\x44\n\ngc_msg_src\x18\xc8\x01 \x01(\x0e\x32\x11.GCProtoBufMsgSrc:\x1cGCProtoBufMsgSrc_Unspecified\x12\x1c\n\x13gc_dir_index_source\x18\xc9\x01 \x01(\r*\xb6\x01\n\x10GCProtoBufMsgSrc\x12 \n\x1cGCProtoBufMsgSrc_Unspecified\x10\x00\x12\x1f\n\x1bGCProtoBufMsgSrc_FromSystem\x10\x01\x12 \n\x1cGCProtoBufMsgSrc_FromSteamID\x10\x02\x12\x1b\n\x17GCProtoBufMsgSrc_FromGC\x10\x03\x12 \n\x1cGCProtoBufMsgSrc_ReplySystem\x10\x04')
+
+_GCPROTOBUFMSGSRC = _descriptor.EnumDescriptor(
+  name='GCProtoBufMsgSrc',
+  full_name='GCProtoBufMsgSrc',
+  filename=None,
+  file=DESCRIPTOR,
+  values=[
+    _descriptor.EnumValueDescriptor(
+      name='GCProtoBufMsgSrc_Unspecified', index=0, number=0,
+      options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='GCProtoBufMsgSrc_FromSystem', index=1, number=1,
+      options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='GCProtoBufMsgSrc_FromSteamID', index=2, number=2,
+      options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='GCProtoBufMsgSrc_FromGC', index=3, number=3,
+      options=None,
+      type=None),
+    _descriptor.EnumValueDescriptor(
+      name='GCProtoBufMsgSrc_ReplySystem', index=4, number=4,
+      options=None,
+      type=None),
+  ],
+  containing_type=None,
+  options=None,
+  serialized_start=369,
+  serialized_end=551,
+)
+
+GCProtoBufMsgSrc = enum_type_wrapper.EnumTypeWrapper(_GCPROTOBUFMSGSRC)
+GCProtoBufMsgSrc_Unspecified = 0
+GCProtoBufMsgSrc_FromSystem = 1
+GCProtoBufMsgSrc_FromSteamID = 2
+GCProtoBufMsgSrc_FromGC = 3
+GCProtoBufMsgSrc_ReplySystem = 4
+
+
+
+_CMSGPROTOBUFHEADER = _descriptor.Descriptor(
+  name='CMsgProtoBufHeader',
+  full_name='CMsgProtoBufHeader',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='client_steam_id', full_name='CMsgProtoBufHeader.client_steam_id', index=0,
+      number=1, type=6, cpp_type=4, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='client_session_id', full_name='CMsgProtoBufHeader.client_session_id', index=1,
+      number=2, type=5, cpp_type=1, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='source_app_id', full_name='CMsgProtoBufHeader.source_app_id', index=2,
+      number=3, type=13, cpp_type=3, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='job_id_source', full_name='CMsgProtoBufHeader.job_id_source', index=3,
+      number=10, type=6, cpp_type=4, label=1,
+      has_default_value=True, default_value=18446744073709551615,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='job_id_target', full_name='CMsgProtoBufHeader.job_id_target', index=4,
+      number=11, type=6, cpp_type=4, label=1,
+      has_default_value=True, default_value=18446744073709551615,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='target_job_name', full_name='CMsgProtoBufHeader.target_job_name', index=5,
+      number=12, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=unicode("", "utf-8"),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='eresult', full_name='CMsgProtoBufHeader.eresult', index=6,
+      number=13, type=5, cpp_type=1, label=1,
+      has_default_value=True, default_value=2,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='error_message', full_name='CMsgProtoBufHeader.error_message', index=7,
+      number=14, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=unicode("", "utf-8"),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='gc_msg_src', full_name='CMsgProtoBufHeader.gc_msg_src', index=8,
+      number=200, type=14, cpp_type=8, label=1,
+      has_default_value=True, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+    _descriptor.FieldDescriptor(
+      name='gc_dir_index_source', full_name='CMsgProtoBufHeader.gc_dir_index_source', index=9,
+      number=201, type=13, cpp_type=3, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      options=None),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  options=None,
+  is_extendable=False,
+  extension_ranges=[],
+  serialized_start=13,
+  serialized_end=366,
+)
+
+_CMSGPROTOBUFHEADER.fields_by_name['gc_msg_src'].enum_type = _GCPROTOBUFMSGSRC
+DESCRIPTOR.message_types_by_name['CMsgProtoBufHeader'] = _CMSGPROTOBUFHEADER
+
+class CMsgProtoBufHeader(_message.Message):
+  __metaclass__ = _reflection.GeneratedProtocolMessageType
+  DESCRIPTOR = _CMSGPROTOBUFHEADER
+
+  # @@protoc_insertion_point(class_scope:CMsgProtoBufHeader)
+
+
+# @@protoc_insertion_point(module_scope)