From 5cda1d7c90f7ac2a1d8a851edbe426f07a032946 Mon Sep 17 00:00:00 2001 From: truebrain Date: Mon, 19 Dec 2011 20:50:44 +0000 Subject: (svn r23603) -Add: support for control commands in strings, in both network and safe/load (Rubidium) --- src/command_type.h | 1 + src/network/network_command.cpp | 10 +++++----- src/saveload/saveload.cpp | 11 +++++++++-- src/saveload/saveload.h | 4 +++- src/string.cpp | 2 +- src/string_type.h | 1 + 6 files changed, 20 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/command_type.h b/src/command_type.h index fd8f0d9bf..f5003a999 100644 --- a/src/command_type.h +++ b/src/command_type.h @@ -355,6 +355,7 @@ enum CommandFlags { CMD_NO_WATER = 0x040, ///< set the DC_NO_WATER flag on this command CMD_CLIENT_ID = 0x080, ///< set p2 with the ClientID of the sending client. CMD_DEITY = 0x100, ///< the command may be executed by COMPANY_DEITY + CMD_STR_CTRL = 0x200, ///< the command's string may contain control strings }; DECLARE_ENUM_AS_BIT_SET(CommandFlags) diff --git a/src/network/network_command.cpp b/src/network/network_command.cpp index 070e810d8..02ee6acf8 100644 --- a/src/network/network_command.cpp +++ b/src/network/network_command.cpp @@ -294,16 +294,16 @@ const char *NetworkGameSocketHandler::ReceiveCommand(Packet *p, CommandPacket *c { cp->company = (CompanyID)p->Recv_uint8(); cp->cmd = p->Recv_uint32(); + if (!IsValidCommand(cp->cmd)) return "invalid command"; + if (GetCommandFlags(cp->cmd) & CMD_OFFLINE) return "offline only command"; + if ((cp->cmd & CMD_FLAGS_MASK) != 0) return "invalid command flag"; + cp->p1 = p->Recv_uint32(); cp->p2 = p->Recv_uint32(); cp->tile = p->Recv_uint32(); - p->Recv_string(cp->text, lengthof(cp->text)); + p->Recv_string(cp->text, lengthof(cp->text), (!_network_server && GetCommandFlags(cp->cmd) & CMD_STR_CTRL) != 0 ? SVS_ALLOW_CONTROL_CODE | SVS_REPLACE_WITH_QUESTION_MARK : SVS_REPLACE_WITH_QUESTION_MARK); byte callback = p->Recv_uint8(); - - if (!IsValidCommand(cp->cmd)) return "invalid command"; - if (GetCommandFlags(cp->cmd) & CMD_OFFLINE) return "offline only command"; - if ((cp->cmd & CMD_FLAGS_MASK) != 0) return "invalid command flag"; if (callback >= lengthof(_callback_table)) return "invalid callback"; cp->callback = _callback_table[callback]; diff --git a/src/saveload/saveload.cpp b/src/saveload/saveload.cpp index 55fabe77b..b1655512b 100644 --- a/src/saveload/saveload.cpp +++ b/src/saveload/saveload.cpp @@ -1089,7 +1089,14 @@ static void SlString(void *ptr, size_t length, VarType conv) } ((char *)ptr)[len] = '\0'; // properly terminate the string - str_validate((char *)ptr, (char *)ptr + len); + StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK; + if ((conv & SLF_ALLOW_CONTROL) != 0) { + settings = settings | SVS_ALLOW_CONTROL_CODE; + } + if ((conv & SLF_ALLOW_NEWLINE) != 0) { + settings = settings | SVS_ALLOW_NEWLINE; + } + str_validate((char *)ptr, (char *)ptr + len, settings); break; } case SLA_PTRS: break; @@ -1442,7 +1449,7 @@ bool SlObjectMember(void *ptr, const SaveLoad *sld) } break; case SL_ARR: SlArray(ptr, sld->length, conv); break; - case SL_STR: SlString(ptr, sld->length, conv); break; + case SL_STR: SlString(ptr, sld->length, sld->conv); break; case SL_LST: SlList(ptr, (SLRefType)conv); break; default: NOT_REACHED(); } diff --git a/src/saveload/saveload.h b/src/saveload/saveload.h index cac20ce5a..c5ffbeff8 100644 --- a/src/saveload/saveload.h +++ b/src/saveload/saveload.h @@ -174,7 +174,9 @@ enum VarTypes { SLF_NOT_IN_SAVE = 1 << 8, ///< do not save with savegame, basically client-based SLF_NOT_IN_CONFIG = 1 << 9, ///< do not save to config file SLF_NO_NETWORK_SYNC = 1 << 10, ///< do not synchronize over network (but it is saved if SLF_NOT_IN_SAVE is not set) - /* 5 more possible flags */ + SLF_ALLOW_CONTROL = 1 << 11, ///< allow control codes in the strings + SLF_ALLOW_NEWLINE = 1 << 12, ///< allow new lines in the strings + /* 3 more possible flags */ }; typedef uint32 VarType; diff --git a/src/string.cpp b/src/string.cpp index 94377c1b6..78869614a 100644 --- a/src/string.cpp +++ b/src/string.cpp @@ -207,7 +207,7 @@ void str_validate(char *str, const char *last, StringValidationSettings settings * characters to be skipped */ if (c == '\0') break; - if (IsPrintable(c) && (c < SCC_SPRITE_START || c > SCC_SPRITE_END)) { + if ((IsPrintable(c) && (c < SCC_SPRITE_START || c > SCC_SPRITE_END)) || ((settings & SVS_ALLOW_CONTROL_CODE) != 0 && IsInsideMM(c, SCC_CONTROL_START, SCC_CONTROL_END))) { /* Copy the character back. Even if dst is current the same as str * (i.e. no characters have been changed) this is quicker than * moving the pointers ahead by len */ diff --git a/src/string_type.h b/src/string_type.h index 174606635..10de1e230 100644 --- a/src/string_type.h +++ b/src/string_type.h @@ -49,6 +49,7 @@ enum StringValidationSettings { SVS_NONE = 0, ///< Allow nothing and replace nothing. SVS_REPLACE_WITH_QUESTION_MARK = 1 << 0, ///< Replace the unknown/bad bits with question marks. SVS_ALLOW_NEWLINE = 1 << 1, ///< Allow newlines. + SVS_ALLOW_CONTROL_CODE = 1 << 2, ///< Allow the special control codes. }; DECLARE_ENUM_AS_BIT_SET(StringValidationSettings); -- cgit v1.2.3-70-g09d2