.BANCHO. Ported packet encoder/decoder to Cython, add distutils setup file, update .gitignore, README and requirements.txt

.gitignore

@@ -7,3 +7,5 @@ common_funzia
 common_refractor
 common_memato
 redistest.py
+*.c
+*.so

README.md

@@ -1,5 +1,8 @@
 ## pep.py
 
+- Origin: https://git.zxq.co/ripple/pep.py
+- Mirror: https://github.com/osuripple/pep.py
+
 This is Ripple's bancho server. It handles:
 - Client login
 - Online users listing and statuses
@@ -8,11 +11,9 @@ This is Ripple's bancho server. It handles:
 - Multiplayer
 - Fokabot
 
-- Origin: https://git.zxq.co/ripple/pep.py
-- Mirror: https://github.com/osuripple/pep.py
-
 ## Requirements
 - Python 3.5
+- Cython
 - MySQLdb (`mysqlclient`)
 - Tornado
 - Bcrypt
@@ -27,9 +28,14 @@ afterwards, install the required dependencies with pip
 ```
 $ pip install -r requirements.txt
 ```
-then, run pep.py once to create the default config file and edit it
+then, compile all `*.pyx` files to `*.so` or `*.dll` files using `setup.py` (distutils file)
+```
+$ python3 setup.py build_ext --inplace
+```
+finally, run pep.py once to create the default config file and edit it
 ```
 $ python3 pep.py
+...
 $ nano config.ini
 ```
 you can run pep.py by typing

helpers/packetHelper.pyx

@@ -1,15 +1,15 @@
 import struct
 from constants import dataTypes
 
-def uleb128Encode(num):
+cpdef bytearray uleb128Encode(int num):
 	"""
 	Encode an int to uleb128
 
 	:param num: int to encode
 	:return: bytearray with encoded number
 	"""
-	arr = bytearray()
+	cdef bytearray arr = bytearray()
-	length = 0
+	cdef int length = 0
 
 	if num == 0:
 		return bytearray(b"\x00")
@@ -23,15 +23,16 @@ def uleb128Encode(num):
 
 	return arr
 
-def uleb128Decode(num):
+cpdef list uleb128Decode(bytes num):
 	"""
 	Decode a uleb128 to int
 
 	:param num: encoded uleb128 int
 	:return: (total, length)
 	"""
-	shift = 0
+	cdef int shift = 0
-	arr = [0,0]	#total, length
+	cdef list arr = [0,0]	#total, length
+	cdef int b
 
 	while True:
 		b = num[arr[1]]
@@ -43,7 +44,7 @@ def uleb128Decode(num):
 
 	return arr
 
-def unpackData(data, dataType):
+cpdef unpackData(bytes data, int dataType):
 	"""
 	Unpacks a single section of a packet.
 
@@ -74,7 +75,7 @@ def unpackData(data, dataType):
 	# Unpack
 	return struct.unpack(unpackType, bytes(data))[0]
 
-def packData(__data, dataType):
+cpdef bytes packData(__data, int dataType):
 	"""
 	Packs a single section of a packet.
 
@@ -82,8 +83,9 @@ def packData(__data, dataType):
 	:param dataType: data type
 	:return: packed bytes
 	"""
-	data = bytes()	# data to return
+	cdef bytes data = bytes()	# data to return
-	pack = True		# if True, use pack. False only with strings
+	cdef bint pack = True		# if True, use pack. False only with strings
+	cdef str packType
 
 	# Get right pack Type
 	if dataType == dataTypes.BBYTES:
@@ -134,7 +136,7 @@ def packData(__data, dataType):
 
 	return data
 
-def buildPacket(__packet, __packetData=None):
+cpdef bytes buildPacket(int __packet, list __packetData = []):
 	"""
 	Builds a packet
 
@@ -143,13 +145,12 @@ def buildPacket(__packet, __packetData=None):
 	:return: packet bytes
 	"""
 	# Set some variables
-	if __packetData is None:
+	cdef bytes packetData = bytes()
-		__packetData = []
+	cdef int packetLength = 0
-	packetData = bytes()
+	cdef bytes packetBytes = bytes()
-	packetLength = 0
-	packetBytes = bytes()
 
 	# Pack packet data
+	cdef list i
 	for i in __packetData:
 		packetData += packData(i[0], i[1])
 
@@ -163,7 +164,7 @@ def buildPacket(__packet, __packetData=None):
 	packetBytes += packetData						# packet data
 	return packetBytes
 
-def readPacketID(stream):
+cpdef int readPacketID(bytes stream):
 	"""
 	Read packetID (first two bytes) from a packet
 
@@ -172,7 +173,7 @@ def readPacketID(stream):
 	"""
 	return unpackData(stream[0:2], dataTypes.UINT16)
 
-def readPacketLength(stream):
+cpdef int readPacketLength(bytes stream):
 	"""
 	Read packet data length (3:7 bytes) from a packet
 
@@ -182,7 +183,7 @@ def readPacketLength(stream):
 	return unpackData(stream[3:7], dataTypes.UINT32)
 
 
-def readPacketData(stream, structure=None, hasFirstBytes = True):
+cpdef readPacketData(bytes stream, list structure=[], bint hasFirstBytes = True):
 	"""
 	Read packet data from `stream` according to `structure`
 	:param stream: packet bytes
@@ -192,11 +193,10 @@ def readPacketData(stream, structure=None, hasFirstBytes = True):
 	:return: {name: unpackedValue, ...}
 	"""
 	# Read packet ID (first 2 bytes)
-	if structure is None:
+	cdef dict data = {}
-		structure = []
-	data = {}
 
 	# Skip packet ID and packet length if needed
+	cdef start, end
 	if hasFirstBytes:
 		end = 7
 		start = 7
@@ -205,6 +205,8 @@ def readPacketData(stream, structure=None, hasFirstBytes = True):
 		start = 0
 
 	# Read packet
+	cdef list i
+	cdef bint unpack
 	for i in structure:
 		start = end
 		unpack = True
@@ -239,7 +241,10 @@ def readPacketData(stream, structure=None, hasFirstBytes = True):
 				end = start+length[0]+length[1]+1
 
 				# Read bytes
-				data[i[0]] = ''.join(chr(j) for j in stream[start+1+length[1]:end])
+				#data[i[0]] = ''.join(chr(j) for j in stream[start+1+length[1]:end])
+				data[i[0]] = ""
+				for j in stream[start+1+length[1]:end]:
+					data[i[0]] += chr(j)
 		elif i[1] == dataTypes.BYTE:
 			end = start+1
 		elif i[1] == dataTypes.UINT16 or i[1] == dataTypes.SINT16:

requirements.txt

@@ -5,4 +5,5 @@ psutil
 raven
 bcrypt>=3.1.1
 dill
-redis
+redis
+cython

setup.py

@@ -0,0 +1,12 @@
+"""Cython build file"""
+from distutils.core import setup
+from distutils.extension import Extension
+from Cython.Build import cythonize
+
+setup(
+    name = "pep.pyx modules",
+    ext_modules = cythonize([
+        Extension("helpers.packetHelper", ["helpers/packetHelper.pyx"]),
+    ],
+    nthreads = 4),
+)