From edcc0d09178bfb64fbaa7620a7b0176d9b57b9d1 Mon Sep 17 00:00:00 2001
From: orwell96 <orwell@bleipb.de>
Date: Sun, 4 Apr 2021 19:50:04 +0200
Subject: [PATCH] Open files in binary mode; also serialize carriage return
 Bumps serialization version as CR escape would not be read correctly in older
 version

---
 atomic.lua    | 12 ++++++------
 serialize.lua | 21 +++++++++++++--------
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/atomic.lua b/atomic.lua
index 182cf42..4a48c27 100644
--- a/atomic.lua
+++ b/atomic.lua
@@ -65,7 +65,7 @@ local function save_atomic_move_file(filename)
 end
 
 local function open_file_and_save_callback(callback, filename)
-	local file, err = io.open(filename, "w")
+	local file, err = io.open(filename, "wb")
 	if not file then
 		error("Failed opening file '"..filename.."' for write:\n"..err)
 	end
@@ -75,7 +75,7 @@ local function open_file_and_save_callback(callback, filename)
 end
 
 local function open_file_and_load_callback(filename, callback)
-	local file, err = io.open(filename, "r")
+	local file, err = io.open(filename, "rb")
 	if not file then
 		error("Failed opening file '"..filename.."' for read:\n"..err)
 	end
@@ -97,7 +97,7 @@ function serialize_lib.load_atomic(filename, callback)
 	local cbfunc = callback or ser.read_from_fd
 	
 	-- try <filename>
-	local file, ret = io.open(filename, "r")
+	local file, ret = io.open(filename, "rb")
 	if file then
 		-- read the file using the callback
 		local success
@@ -117,7 +117,7 @@ function serialize_lib.load_atomic(filename, callback)
 	serialize_lib.log_warn(ret)
 	
 	-- try <filename>.new
-	file, ret = io.open(filename..".new", "r")
+	file, ret = io.open(filename..".new", "rb")
 	if file then
 		-- read the file using the callback
 		local success
@@ -151,7 +151,7 @@ function serialize_lib.save_atomic(data, filename, callback, config)
 	
 	local cbfunc = callback or ser.write_to_fd
 
-	local file, ret = io.open(filename..".new", "w")
+	local file, ret = io.open(filename..".new", "wb")
 	if file then
 		-- save the file using the callback
 		local success
@@ -189,7 +189,7 @@ function serialize_lib.save_atomic_multiple(parts_table, filename_prefix, callba
 		end
 		
 		local success = false
-		local file, ret = io.open(filename..".new", "w")
+		local file, ret = io.open(filename..".new", "wb")
 		if file then
 			-- save the file using the callback
 			success, ret = pcall(cbfunc, data, file, config)
diff --git a/serialize.lua b/serialize.lua
index 12a26c4..4b1ebb7 100644
--- a/serialize.lua
+++ b/serialize.lua
@@ -3,6 +3,9 @@
 -- Contains the serialization and deserialization routines
 
 --[[
+Version history:
+1 - initial
+2 - also escaping CR character as &r
 
 Structure of entry:
 [keytype][key]:[valuetype][val]
@@ -19,7 +22,7 @@ Table:
 E
 
 example:
-LUA_SER v=1		{
+LUA_SER v=2		{
 Skey:Svalue			key = "value",
 N1:Seins			[1] = "eins",
 B1:T				[true] = {
@@ -32,7 +35,7 @@ String representations:
 In strings the following characters are escaped by &
 '&' -> '&&'
 (line break) -> '&n'
-(CR) -> '&r'			--> required?
+(CR) -> '&r'
 ':' -> '&:'
 All other characters are unchanged as they bear no special meaning.
 ]]
@@ -97,6 +100,7 @@ end
 function escape_chars(str)
 	local rstr = string.gsub(str, "&", "&&")
 	rstr = string.gsub(rstr, ":", "&:")
+	rstr = string.gsub(rstr, "\r", "&r")
 	rstr = string.gsub(rstr, "\n", "&n")
 	return rstr
 end
@@ -172,6 +176,7 @@ end
 function unescape_chars(str) --TODO
 	local rstr = string.gsub(str, "&:", ":")
 	rstr = string.gsub(rstr, "&n", "\n")
+	rstr = string.gsub(rstr, "&r", "\r")
 	rstr = string.gsub(rstr, "&&", "&")
 	return rstr
 end
@@ -187,7 +192,7 @@ config = {
 
 -- Writes the passed table into the passed file descriptor, and closes the file
 local function write_to_fd(root_table, file, config)
-	file:write("LUA_SER v=1\n")
+	file:write("LUA_SER v=2\n")
 	write_table(root_table, file, config)
 	file:write("E\nEND_SER\n")
 	file:close()
@@ -197,14 +202,14 @@ end
 -- Throws errors when something is wrong. Closes the file.
 -- config: see above
 local function read_from_fd(file)
-	local first_line = file:read("*l")
-	if first_line ~= "LUA_SER v=1" then
+	local first_line = file:read("*line")
+	if not string.match(first_line, "LUA_SER v=[12]") then
 		file:close()
 		error("Expected header, got '"..first_line.."' instead!")
 	end
 	local t = {}
 	read_table(t, file)
-	local last_line = file:read("*l")
+	local last_line = file:read("*line")
 	file:close()
 	if last_line ~= "END_SER" then
 		error("Missing END_SER, got '"..last_line.."' instead!")
@@ -216,7 +221,7 @@ end
 -- config: see above
 function write_to_file(root_table, filename, config)
 	-- try opening the file
-	local file, err = io.open(filename, "w")
+	local file, err = io.open(filename, "wb")
 	if not file then
 		error("Failed opening file '"..filename.."' for write:\n"..err)
 	end
@@ -228,7 +233,7 @@ end
 -- Opens the passed filename, and returns its deserialized contents
 function read_from_file(filename)
 	-- try opening the file
-	local file, err = io.open(filename, "r")
+	local file, err = io.open(filename, "rb")
 	if not file then
 		error("Failed opening file '"..filename.."' for read:\n"..err)
 	end