From 5431466bc751f1fcaf9ed504c73771966ddcd976 Mon Sep 17 00:00:00 2001
From: Vsevolod Stakhov <vsevolod@highsecure.ru>
Date: Sat, 11 Feb 2017 14:54:57 +0000
Subject: [PATCH] [Feature] Store relational order of all headers in a message

---
 src/libmime/mime_headers.c | 49 ++++++++++++++++++++------------------
 src/libmime/mime_headers.h |  1 +
 src/lua/lua_task.c         |  5 +++-
 3 files changed, 31 insertions(+), 24 deletions(-)

diff --git a/src/libmime/mime_headers.c b/src/libmime/mime_headers.c
index bff84efcc..3cac797d6 100644
--- a/src/libmime/mime_headers.c
+++ b/src/libmime/mime_headers.c
@@ -141,12 +141,13 @@ void
 rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 		const gchar *in, gsize len, gboolean check_newlines)
 {
-	struct rspamd_mime_header *new = NULL;
+	struct rspamd_mime_header *nh = NULL;
 	const gchar *p, *c, *end;
 	gchar *tmp, *tp;
 	gint state = 0, l, next_state = 100, err_state = 100, t_state;
 	gboolean valid_folding = FALSE;
 	guint nlines_count[RSPAMD_TASK_NEWLINES_MAX];
+	guint order = 0;
 
 	p = in;
 	end = p + len;
@@ -172,16 +173,16 @@ rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 		case 1:
 			/* We got something like header's name */
 			if (*p == ':') {
-				new =
+				nh =
 					rspamd_mempool_alloc0 (task->task_pool,
 						sizeof (struct rspamd_mime_header));
 				l = p - c;
 				tmp = rspamd_mempool_alloc (task->task_pool, l + 1);
 				rspamd_strlcpy (tmp, c, l + 1);
-				new->name = tmp;
-				new->empty_separator = TRUE;
-				new->raw_value = c;
-				new->raw_len = p - c; /* Including trailing ':' */
+				nh->name = tmp;
+				nh->empty_separator = TRUE;
+				nh->raw_value = c;
+				nh->raw_len = p - c; /* Including trailing ':' */
 				p++;
 				state = 2;
 				c = p;
@@ -199,12 +200,12 @@ rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 		case 2:
 			/* We got header's name, so skip any \t or spaces */
 			if (*p == '\t') {
-				new->tab_separated = TRUE;
-				new->empty_separator = FALSE;
+				nh->tab_separated = TRUE;
+				nh->empty_separator = FALSE;
 				p++;
 			}
 			else if (*p == ' ') {
-				new->empty_separator = FALSE;
+				nh->empty_separator = FALSE;
 				p++;
 			}
 			else if (*p == '\n' || *p == '\r') {
@@ -227,7 +228,7 @@ rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 				if (l > 0) {
 					tmp = rspamd_mempool_alloc (task->task_pool, l + 1);
 					rspamd_strlcpy (tmp, c, l + 1);
-					new->separator = tmp;
+					nh->separator = tmp;
 				}
 				next_state = 3;
 				err_state = 5;
@@ -239,7 +240,7 @@ rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 				if (l >= 0) {
 					tmp = rspamd_mempool_alloc (task->task_pool, l + 1);
 					rspamd_strlcpy (tmp, c, l + 1);
-					new->separator = tmp;
+					nh->separator = tmp;
 				}
 				c = p;
 				state = 3;
@@ -311,30 +312,32 @@ rspamd_mime_headers_process (struct rspamd_task *task, GHashTable *target,
 			}
 
 			if (p + 1 == end) {
-				new->raw_len = end - new->raw_value;
+				nh->raw_len = end - nh->raw_value;
 			}
 			else {
-				new->raw_len = p - new->raw_value;
+				nh->raw_len = p - nh->raw_value;
 			}
 
-			new->value = tmp;
-			new->decoded = rspamd_mime_header_decode (task->task_pool,
-					new->value, strlen (tmp));
+			nh->value = tmp;
+			nh->decoded = rspamd_mime_header_decode (task->task_pool,
+					nh->value, strlen (tmp));
 
-			if (new->decoded == NULL) {
-				new->decoded = "";
+			if (nh->decoded == NULL) {
+				nh->decoded = "";
 			}
 
 			/* We also validate utf8 and replace all non-valid utf8 chars */
-			rspamd_mime_charset_utf_enforce (new->decoded, strlen (new->decoded));
-			rspamd_mime_header_add (task, target, new, check_newlines);
+			rspamd_mime_charset_utf_enforce (nh->decoded, strlen (nh->decoded));
+			rspamd_mime_header_add (task, target, nh, check_newlines);
+			nh->order = order ++;
 			state = 0;
 			break;
 		case 5:
 			/* Header has only name, no value */
-			new->value = "";
-			new->decoded = "";
-			rspamd_mime_header_add (task, target, new, check_newlines);
+			nh->value = "";
+			nh->decoded = "";
+			rspamd_mime_header_add (task, target, nh, check_newlines);
+			nh->order = order ++;
 			state = 0;
 			break;
 		case 99:
diff --git a/src/libmime/mime_headers.h b/src/libmime/mime_headers.h
index 06d40c516..9e77aa14b 100644
--- a/src/libmime/mime_headers.h
+++ b/src/libmime/mime_headers.h
@@ -33,6 +33,7 @@ struct rspamd_mime_header {
 	gsize raw_len;
 	gboolean tab_separated;
 	gboolean empty_separator;
+	guint order;
 	gchar *separator;
 	gchar *decoded;
 };
diff --git a/src/lua/lua_task.c b/src/lua/lua_task.c
index 2c2e77678..7ae0bd99d 100644
--- a/src/lua/lua_task.c
+++ b/src/lua/lua_task.c
@@ -1495,7 +1495,7 @@ rspamd_lua_push_header (lua_State * L,
 	PTR_ARRAY_FOREACH (ar, i, rh) {
 		if (full) {
 			/* Create new associated table for a header */
-			lua_createtable (L, 0, 6);
+			lua_createtable (L, 0, 7);
 			rspamd_lua_table_set (L, "name",	 rh->name);
 
 			if (rh->value) {
@@ -1513,6 +1513,9 @@ rspamd_lua_push_header (lua_State * L,
 			lua_pushboolean (L, rh->empty_separator);
 			lua_settable (L, -3);
 			rspamd_lua_table_set (L, "separator", rh->separator);
+			lua_pushstring (L, "order");
+			lua_pushnumber (L, rh->order);
+			lua_settable (L, -3);
 			lua_rawseti (L, -2, i + 1);
 		}
 		else {
-- 
2.39.5