View sent messages (new database, add maillists) (#26)

* Add tabheader & sent formspec

* Add show_sent function and show sent messages

* Remove comment on selected_idxs test (show_sent)

* Add variable to keep the previous tab instead of going back to the first one

* Remove index variable verification on mark read/unread buttons since they are necessarily clicked on inbox view

* Resize messages table to be aligned with close button at the bottom

* Show date time (#27)

* Show date in message reading

* Fix wrong registered dates

Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>

* Rework header layout to add better space for date

---------

Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>

* Add insertion of messages into global storage mail.messages.json

* Receive player messages from global storage

* Add automatic generation of status for a new message (unread)

* Mark read/unread/delete a message

* Fix messages loading

* Show every message received/sent via specific functions

* Use global contacts functions and reconfigure add/remove functions

* Create mail lists formspec based on contacts

* Add deleting contact

* Add ability to create mail lists

* Fix inability to edit contact

* Rework on editing/deletion of contacts/maillists

* Add at symbol as prefix on maillists view

* Add ability to choose default status (to/cc/bcc)

Signed-off-by: Athozus <athozus@gmail.com>

* Add ability to add multiples players and choose their default status (to/cc/bcc)

* Add ability to use maillist in messages and receive messages from them

* Fix repetition of code causing a crash

* Avoid multiples occurences of the same messages due to player both in maillist and receivers

* Fix selected indexes for inbox/sent

Now separated, fixed show_message() func selection of id from table dcl/read btn

* Fix many issues related to maillists

Notably : edit, delete, selection, creation, registration of players

* Set up database version v3 and its migration from v2

+ Check versions to choose v1->v2 or v2->v3

* Fix mtt.lua

Due to old function getMessages(), replaced by getPlayerInboxMessages()

* Add 10 seconds security to mtt.lua

* Fix migrate.lua non-declared variable

* Send msg table with string keys in mtt

* Better log messages

* Add message check

* Fix mtt crash

* Better syntax in storage.lua

* Fix bcc forgotten in mail.send()

* Fix mtt issue

* Better compatibility for messages storage

Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>

* Replace mail.split by builtin func

Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>

* Use builtin split func

Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>

* Use builtin split func in storage.lua

* re-add mtt if

* luacheck on PR

* add check for an ancient issue with missing `to` field

* Fix luacheck on storage.lua

* Fix luacheck warnings in migrate.lua

* Fix luacheck warnings in gui.lua

* Fix luacheck (too long lines) in storage.lua

* Unused loop values in migrate.lua

* Whitespace line in gui.lua

* Whitespace line (init.lua)

* Whitespace line (api.lua)

* Significantly improve maillist behaviour

Replace maillist by its players when sending a message
List of players separated by ,
Avoid doublons when editing more than 2 times a maillist

* Fix luacheck

* Fix table insertions at first index when no needed

* Use funcs

* Do not add maillist as a new contact when sending a mail

* Fix removing elements from tables

* Check maillists not added in contacts

* storage rewrite wip

* storage format docs

* refactor ui components

* show_compose cleanup

* remove unused channel.lua

* error -> err

* status refactoring

* contacts refactoring

* maillist refactoring

* docs

* tests

* fix some issues

* re-enable migrations

* contributors

* prefix mail entries in the mod storage

* internalize old mail-paths to migration module

* add v1 and v2 player db examples and migration test

* Ui improvements & fixes

Move events code (if fields.x then) to events.lua (instead of inbox.lua), fix tab selection when going backward

* Show most recent messages at first (outbox)

* unified-inv fix

---------

Signed-off-by: Athozus <athozus@gmail.com>
Co-authored-by: SX <50966843+S-S-X@users.noreply.github.com>
Co-authored-by: BuckarooBanzay <BuckarooBanzay@users.noreply.github.com>

api.lua

@@ -10,36 +10,15 @@ end
 mail.receive_mail_message = "You have a new message from %s! Subject: %s\nTo view it, type /mail"
 mail.read_later_message = "You can read your messages later by using the /mail command"
 
---[[
-mail sending function, can be invoked with one object argument (new api) or
-all 4 parameters (old compat version)
-see: "Mail format" api.md
+function mail.send(m)
+	if type(m.from) ~= "string" then return false, "'from' is not a string" end
+	if type(m.to) ~= "string" then return false, "'to' is not a string" end
+	if type(m.body) ~= "string" then return false, "'body' is not a string" end
 
-TODO: refactor this garbage code!
---]]
-function mail.send(...)
-	-- figure out format
-	local m
-	if #{...} == 1 then
-		-- new format (one table param)
-		m = ...
-		-- populate "to" field
-		m.to = m.to or m.dst
-		-- populate "from" field
-		m.from = m.from or m.src
-	else
-		-- old format
-		m = {}
-		m.from, m.to, m.subject, m.body = ...
-	end
+	-- defaults
+	m.subject = m.subject or "(No subject)"
 
-	-- sane default values
-	m.subject = m.subject or ""
-	m.body = m.body or ""
-
-	if m.subject == "" then
-		m.subject = "(No subject)"
-	end
+	-- limit subject line
 	if string.len(m.subject) > 30 then
 		m.subject = string.sub(m.subject,1,27) .. "..."
 	end
@@ -47,11 +26,14 @@ function mail.send(...)
 	-- normalize to, cc and bcc while compiling a list of all recipients
 	local recipients = {}
 	local undeliverable = {}
+	m.to = mail.concat_player_list(mail.extractMaillists(m.to, m.from))
 	m.to = mail.normalize_players_and_add_recipients(m.to, recipients, undeliverable)
 	if m.cc then
+		m.cc = mail.concat_player_list(mail.extractMaillists(m.cc, m.from))
 		m.cc = mail.normalize_players_and_add_recipients(m.cc, recipients, undeliverable)
 	end
 	if m.bcc then
+		m.bcc = mail.concat_player_list(mail.extractMaillists(m.bcc, m.from))
 		m.bcc = mail.normalize_players_and_add_recipients(m.bcc, recipients, undeliverable)
 	end
 
@@ -60,9 +42,7 @@ function mail.send(...)
 		for name in pairs(undeliverable) do
 			undeliverable_names[#undeliverable_names + 1] = '"' .. name .. '"'
 		end
-		return f("recipients %s don't exist; cannot send mail.",
-			table.concat(undeliverable_names, ", ")
-		)
+		return false, f("recipients %s don't exist; cannot send mail.", table.concat(undeliverable_names, ", "))
 	end
 
 	local extra = {}
@@ -85,20 +65,26 @@ function mail.send(...)
 
 	-- form the actual mail
 	local msg = {
-		unread  = true,
-		sender  = m.from,
-		to      = m.to,
-		cc      = m.cc,
+		id = mail.new_uuid(),
+		from = m.from,
+		to = m.to,
+		cc = m.cc,
+		bcc = m.bcc,
 		subject = m.subject,
-		body    = m.body,
-		time    = os.time(),
+		body = m.body,
+		time = os.time(),
 	}
 
-	-- send the mail to all recipients
+	-- add in senders outbox
+	local entry = mail.get_storage_entry(m.from)
+	table.insert(entry.outbox, 1, msg)
+	mail.set_storage_entry(m.from, entry)
+
+	-- add in every receivers inbox
 	for recipient in pairs(recipients) do
-		local messages = mail.getMessages(recipient)
-		table.insert(messages, 1, msg)
-		mail.setMessages(recipient, messages)
+		entry = mail.get_storage_entry(recipient)
+		table.insert(entry.inbox, msg)
+		mail.set_storage_entry(recipient, entry)
 	end
 
 	-- notify recipients that happen to be online
@@ -115,4 +101,6 @@ function mail.send(...)
 			break
 		end
 	end
+
+	return true
 end