Uuid from the community

Co-authored-by: heinrich5991 <heinrich5991@gmail.com>

Author: Bamcane

CMakeLists.txt

@@ -26,6 +26,7 @@ if(NOT POLICY CMP0048)
 endif()
 
 project(teeworlds VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
+project(teeworlds C CXX)
 
 set(ORIGINAL_CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH})
 set(ORIGINAL_CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES})
@@ -1272,6 +1273,8 @@ set_src(BASE GLOB_RECURSE src/base
   tl/sorted_array.h
   tl/string.h
   tl/threading.h
+  uuid.c
+  uuid.h
   vmath.h
 )
 set_src(ENGINE_INTERFACE GLOB src/engine
@@ -1343,11 +1346,16 @@ set_src(ENGINE_SHARED GLOB src/engine/shared
   packer.cpp
   packer.h
   protocol.h
+  protocol_ex.cpp
+  protocol_ex.h
+  protocol_ex_msgs.h
   ringbuffer.cpp
   ringbuffer.h
   snapshot.cpp
   snapshot.h
   storage.cpp
+  uuid_manager.cpp
+  uuid_manager.h
 )
 set(ENGINE_GENERATED_SHARED src/generated/nethash.cpp src/generated/protocol.cpp src/generated/protocol.h)
 set_src(GAME_SHARED GLOB src/game

datasrc/compile.py

@@ -3,10 +3,10 @@
 import content
 import network
 
-def create_enum_table(names, num):
+def create_enum_table(names, num, start = "0"):
 	lines = []
 	lines += ["enum", "{"]
-	lines += ["\t%s=0,"%names[0]]
+	lines += [f"\t{names[0]} = {start},"]
 	for name in names[1:]:
 		lines += ["\t%s,"%name]
 	lines += ["\t%s" % num, "};"]
@@ -109,9 +109,16 @@ def EmitFlags(names, num):
 		for l in create_flags_table(["%s_%s" % (e.name, v) for v in e.values]): print(l)
 		print("")
 
-	for l in create_enum_table(["NETOBJ_INVALID"]+[o.enum_name for o in network.Objects], "NUM_NETOBJTYPES"): print(l)
+	non_extended = [o for o in network.Objects if o.ex is None]
+	extended = [o for o in network.Objects if o.ex is not None]
+	for l in create_enum_table(["NETOBJTYPE_EX"]+[o.enum_name for o in non_extended], "NUM_NETOBJTYPES"): print(l)
+	for l in create_enum_table(["__NETOBJTYPE_UUID_HELPER"]+[o.enum_name for o in extended], "OFFSET_NETMSGTYPE_UUID", "OFFSET_GAME_UUID - 1"): print(l)
 	print("")
-	for l in create_enum_table(["NETMSG_INVALID"]+[o.enum_name for o in network.Messages], "NUM_NETMSGTYPES"): print(l)
+
+	non_extended = [o for o in network.Messages if o.ex is None]
+	extended = [o for o in network.Messages if o.ex is not None]
+	for l in create_enum_table(["NETMSGTYPE_EX"]+[o.enum_name for o in non_extended], "NUM_NETMSGTYPES"): print(l)
+	for l in create_enum_table(["__NETMSGTYPE_UUID_HELPER"]+[o.enum_name for o in extended], "OFFSET_MAPITEMTYPE_UUID", "OFFSET_NETMSGTYPE_UUID - 1"): print(l)
 	print("")
 
 	for item in network.Objects + network.Messages:
@@ -267,6 +274,10 @@ class CNetObjHandler
 	lines += ['{']
 	lines += ['\tswitch(Type)']
 	lines += ['\t{']
+	lines += ['\tcase NETOBJTYPE_EX:']
+	lines += ['\t{']
+	lines += ['\t\treturn 0;']
+	lines += ['\t}']
 
 	for item in network.Objects:
 		base_item = None
@@ -332,6 +343,13 @@ class CNetObjHandler
 	lines += ['};']
 	lines += ['']
 
+	lines += ['void RegisterGameUuids(CUuidManager *pManager)']
+	lines += ['{']
+
+	for item in network.Objects + network.Messages:
+		if item.ex is not None:
+			lines += ['\tpManager->RegisterName(%s, "%s");' % (item.enum_name, item.ex)]
+	lines += ['}']
 
 	for l in lines:
 		print(l)

datasrc/datatypes.py

@@ -210,7 +210,7 @@ def __init__(self, name, values):
 		self.values = values
 
 class NetObject:
-	def __init__(self, name, variables):
+	def __init__(self, name, variables, ex=None, fixup=True):
 		l = name.split(":")
 		self.name = l[0]
 		self.base = ""
@@ -220,6 +220,10 @@ def __init__(self, name, variables):
 		self.struct_name = "CNetObj_%s" % self.name
 		self.enum_name = "NETOBJTYPE_%s" % self.name.upper()
 		self.variables = variables
+		if fixup and ex != None:
+			ex = "object-{}".format(ex)
+		self.ex = ex
+
 	def emit_declaration(self):
 		if self.base:
 			lines = ["struct %s : public %s"%(self.struct_name,self.base_struct_name), "{"]
@@ -245,15 +249,17 @@ def emit_validate(self, base_item):
 
 
 class NetEvent(NetObject):
-	def __init__(self, name, variables):
-		NetObject.__init__(self, name, variables)
+	def __init__(self, name, variables, ex=None):
+		NetObject.__init__(self, name, variables, ex=ex)
 		self.base_struct_name = "CNetEvent_%s" % self.base
 		self.struct_name = "CNetEvent_%s" % self.name
 		self.enum_name = "NETEVENTTYPE_%s" % self.name.upper()
 
 class NetMessage(NetObject):
-	def __init__(self, name, variables):
-		NetObject.__init__(self, name, variables)
+	def __init__(self, name, variables, ex=None):
+		if ex != None:
+			ex = "message-{}".format(ex)
+		NetObject.__init__(self, name, variables, ex=ex, fixup=False)
 		self.base_struct_name = "CNetMsg_%s" % self.base
 		self.struct_name = "CNetMsg_%s" % self.name
 		self.enum_name = "NETMSGTYPE_%s" % self.name.upper()
@@ -399,3 +405,15 @@ def emit_unpack_check(self):
 			self.var.name = self.base_name + "[%d]"%i
 			lines += self.var.emit_unpack_check()
 		return lines
+
+class NetObjectEx(NetObject):
+	def __init__(self, name, ex, variables):
+		NetObject.__init__(self, name, variables, ex=ex)
+
+class NetEventEx(NetEvent):
+	def __init__(self, name, ex, variables):
+		NetEvent.__init__(self, name, variables, ex=ex)
+
+class NetMessageEx(NetMessage):
+	def __init__(self, name, ex, variables):
+		NetMessage.__init__(self, name, variables, ex=ex)

datasrc/network.py

@@ -24,6 +24,7 @@
 RawHeader = '''
 
 #include <engine/message.h>
+#include <engine/shared/protocol_ex.h>
 
 enum
 {

src/base/system.c

@@ -2908,6 +2908,65 @@ const char *str_find(const char *haystack, const char *needle)
 	return 0;
 }
 
+static int hexval(char x)
+{
+	switch(x)
+	{
+	case '0': return 0;
+	case '1': return 1;
+	case '2': return 2;
+	case '3': return 3;
+	case '4': return 4;
+	case '5': return 5;
+	case '6': return 6;
+	case '7': return 7;
+	case '8': return 8;
+	case '9': return 9;
+	case 'a':
+	case 'A': return 10;
+	case 'b':
+	case 'B': return 11;
+	case 'c':
+	case 'C': return 12;
+	case 'd':
+	case 'D': return 13;
+	case 'e':
+	case 'E': return 14;
+	case 'f':
+	case 'F': return 15;
+	default: return -1;
+	}
+}
+
+static int byteval(const char *hex, unsigned char *dst)
+{
+	int v1 = hexval(hex[0]);
+	int v2 = hexval(hex[1]);
+
+	if(v1 < 0 || v2 < 0)
+		return 1;
+
+	*dst = v1 * 16 + v2;
+	return 0;
+}
+
+int str_hex_decode(void *dst, int dst_size, const char *src)
+{
+	unsigned char *cdst = (unsigned char *) dst;
+	int slen = str_length(src);
+	int len = slen / 2;
+	int i;
+	if(slen != dst_size * 2)
+		return 2;
+
+	for(i = 0; i < len && dst_size; i++, dst_size--)
+	{
+		if(byteval(src + i * 2, cdst++))
+			return 1;
+	}
+	return 0;
+}
+
 void str_hex(char *dst, int dst_size, const void *data, int data_size)
 {
 	static const char hex[] = "0123456789ABCDEF";

src/base/system.h

@@ -1402,6 +1402,26 @@ const char *str_find_nocase(const char *haystack, const char *needle);
 */
 const char *str_find(const char *haystack, const char *needle);
 
+/*
+	Function: str_hex_decode
+		Takes a hex string *without spaces between bytes* and returns a
+		byte array.
+
+	Parameters:
+		dst - Buffer for the byte array
+		dst_size - size of the buffer
+		data - String to decode
+
+	Returns:
+		2 - String doesn't exactly fit the buffer
+		1 - Invalid character in string
+		0 - Success
+
+	Remarks:
+		- The contents of the buffer is only valid on success
+*/
+int str_hex_decode(void *dst, int dst_size, const char *src);
+
 /*
 	Function: str_hex
 		Takes a datablock and generates a hexstring of it.

src/base/uuid.c

@@ -0,0 +1,98 @@
+/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
+/* If you are missing that file, acquire a complete release at teeworlds.com.                */
+#include <base/hash_ctxt.h>
+#include <base/system.h>
+
+#include "uuid.h"
+
+static const Uuid TEEWORLDS_NAMESPACE = {{// "e05ddaaa-c4e6-4cfb-b642-5d48e80c0029"
+	0xe0, 0x5d, 0xda, 0xaa, 0xc4, 0xe6, 0x4c, 0xfb,
+	0xb6, 0x42, 0x5d, 0x48, 0xe8, 0x0c, 0x00, 0x29}};
+
+const Uuid UUID_ZEROED = {{// "00000000-0000-0000-0000-000000000000"
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}};
+
+Uuid random_uuid()
+{
+	Uuid Result;
+	secure_random_fill(&Result, sizeof(Result));
+
+	// set version 4 (UUID is randomly generated)
+	Result.m_aData[6] &= 0x0f;
+	Result.m_aData[6] |= 0x40;
+
+	// set variant 1 (RFC 4122)
+	Result.m_aData[8] &= 0x3f;
+	Result.m_aData[8] |= 0x80;
+
+	return Result;
+}
+
+Uuid calculate_uuid(const char *name)
+{
+	MD5_CTX Md5;
+	MD5_DIGEST Digest;
+	Uuid Result;
+
+	md5_init(&Md5);
+	md5_update(&Md5, TEEWORLDS_NAMESPACE.m_aData, sizeof(TEEWORLDS_NAMESPACE.m_aData));
+	// Without terminating NUL.
+	md5_update(&Md5, name, str_length(name));
+
+    Digest = md5_finish(&Md5);
+
+	for(unsigned i = 0; i < sizeof(Result.m_aData); i++)
+	{
+		Result.m_aData[i] = Digest.data[i];
+	}
+
+	// set version 3 (UUID is generated by MD5 hashing a namespace identifier and a name)
+	Result.m_aData[6] &= 0x0f;
+	Result.m_aData[6] |= 0x30;
+
+	// set variant 1 (RFC 4122)
+	Result.m_aData[8] &= 0x3f;
+	Result.m_aData[8] |= 0x80;
+
+	return Result;
+}
+
+void format_uuid(Uuid uuid, char *buffer, int size)
+{
+	unsigned char *p = uuid.m_aData;
+	str_format(buffer, size,
+		"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
+		p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
+		p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
+}
+
+int uuid_comp(Uuid uuid1, Uuid uuid2)
+{
+    return mem_comp(uuid1.m_aData, uuid2.m_aData, sizeof(uuid1.m_aData));
+}
+
+int ParseUuid(Uuid *uuid, const char *buffer)
+{
+	char copy[UUID_MAXSTRSIZE];
+	if(str_length(buffer) + 1 != UUID_MAXSTRSIZE)
+	{
+		return 2;
+	}
+	str_copy(copy, buffer, sizeof(copy));
+	// 01234567-9012-4567-9012-456789012345
+	if(copy[8] != '-' || copy[13] != '-' || copy[18] != '-' || copy[23] != '-')
+	{
+		return 1;
+	}
+	copy[8] = copy[13] = copy[18] = copy[23] = 0;
+	if(str_hex_decode(uuid->m_aData + 0, 4, copy + 0) ||
+		str_hex_decode(uuid->m_aData + 4, 2, copy + 9) ||
+		str_hex_decode(uuid->m_aData + 6, 2, copy + 14) ||
+		str_hex_decode(uuid->m_aData + 8, 2, copy + 19) ||
+		str_hex_decode(uuid->m_aData + 10, 6, copy + 24))
+	{
+		return 1;
+	}
+	return 0;
+}