Added a start and limit params to messages.list camelface function.

Author: ladar

check/magma/servers/camel/camel_check.c

@@ -416,7 +416,6 @@ START_TEST (check_camel_basic_s) {
 }
 END_TEST
 
-
 Suite * suite_check_camel(void) {
 
 	Suite *s = suite_create("\tCAMEL");
@@ -429,7 +428,7 @@ Suite * suite_check_camel(void) {
 	// which has significantly more overhead for each allocate/free oepration. As a result we give the camelface
 	// tests twice as much time to complete when applicable. (The timeout is disabled when a debugger, or profiler
 	// is in use.)
-	suite_check_testcase_timeout(s, "HTTP CAMEL", "HTTP Network Camel Basic/S", check_camel_basic_s, ( case_timeout * 2 ));
+	suite_check_testcase_timeout(s, "HTTP CAMEL", "HTTP Network Camel Basic/S", check_camel_basic_s, ( case_timeout * 4 ));
 
 	return s;
 }

check/magma/servers/camel/camel_check_network.c

@@ -195,19 +195,17 @@ int32_t check_camel_msg_id(uint32_t folder_id, stringer_t *cookie, bool_t secure
 	int32_t msg_id = -1;
 	stringer_t *command = NULL, *json = NULL;
 	json_t *json_root = NULL, *json_array = NULL, *json_cursor = NULL;
-	chr_t *messages_list = "{\"id\":2,\"method\":\"messages.list\",\"params\":{\"folderID\":%u}}";
+	chr_t *messages_list = "{\"id\":2,\"method\":\"messages.list\",\"params\":{\"folderID\":%u, \"limit\":1}}";
 
 	// Contruct the command string.
 	if (!(command = st_alloc(ns_length_get(messages_list) - 2 + uint32_digits(folder_id) + 1)) ||
 		st_sprint(command, messages_list, folder_id) == -1) {
-
 		st_cleanup(command);
 		return msg_id;
 	}
 	// Query for the contents of the folder.
 	else if (!(json = check_camel_print(command, cookie, secure)) || !(json_root = json_loads_d(st_char_get(json), 0, &err)) ||
 		!(json_array = json_object_get_d(json_root, "result"))) {
-
 		if (json_root) json_decref_d(json_root);
 		st_cleanup(command, json);
 		return msg_id;
@@ -216,7 +214,6 @@ int32_t check_camel_msg_id(uint32_t folder_id, stringer_t *cookie, bool_t secure
 	// If the folder contains mail, return the messageID of the first message.
 	if (json_array_size_d(json_array) <= 0 || !(json_cursor = json_array_get_d(json_array, 0)) ||
 		json_unpack_d(json_cursor, "{s:i}", "messageID", &msg_id) != 0) {
-
 		msg_id = -1;
 	}
 
@@ -379,8 +376,8 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	/// Test config.edit 		: {"id":2,"method":"config.edit","params":{<rand_strs[0]>:<rand_strs[1]>}}"
 	/// Expected Response 	: {"jsonrpc":"2.0","result":{"config.edit":"success"},"id":2}
 
-  // Set the current command string.
-  chr_command = "{\"id\":2,\"method\":\"config.edit\",\"params\":{\"%.*s\":\"%.*s\"}}";
+	// Set the current command string.
+	chr_command = "{\"id\":2,\"method\":\"config.edit\",\"params\":{\"%.*s\":\"%.*s\"}}";
 
 	// Generate the random inputs for "key" and "value".
 	if (!rand_choices(choices, 64, rand_strs[0]) || !rand_choices(choices, 64, rand_strs[1])) {
@@ -2423,8 +2420,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
-
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 41 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 41 }");
 		return false;
 	}
 
@@ -2484,8 +2480,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
-
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 42 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 42 }");
 		return false;
 	}
 
@@ -2588,8 +2583,8 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Test folders.add		: {"id":46,"method":"folders.add","params":{"context":"mail","name":<rand_strs[0]>}}
 	// Expected Response 	: {"jsonrpc":"2.0","result":{"folderID":<folder_ids[0]>},"id":46}
 
-  // Set the current command string.
-  chr_command = "{\"id\":46,\"method\":\"folders.add\",\"params\":{\"context\":\"mail\",\"name\":\"%.*s\"}}";
+	// Set the current command string.
+	chr_command = "{\"id\":46,\"method\":\"folders.add\",\"params\":{\"context\":\"mail\",\"name\":\"%.*s\"}}";
 
 	// Generate the random input for "name".
 	if (!rand_choices(choices, 16, rand_strs[0])) {
@@ -2646,7 +2641,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	if ((folder_ids[1] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[1], cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 45 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 45 }");
 		return false;
 	}
 
@@ -2691,14 +2686,13 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	//											"targetFolderID":<folder_ids[0]>}}",
 	// Expected Response 	: {"jsonrpc":"2.0","result":[],"id":48}
 
-  // Set the current command string.
-  chr_command = "{\"id\":48,\"method\":\"messages.copy\",\"params\":{\"messageIDs\":[%lu],\"sourceFolderID\":%lu,\"targetFolderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":48,\"method\":\"messages.copy\",\"params\":{\"messageIDs\":[%lu],\"sourceFolderID\":%lu,\"targetFolderID\":%lu}}";
 
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[1] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[1], cookie, secure)) == -1) {
-
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 46 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 46 }");
 		return false;
 	}
 
@@ -2750,8 +2744,8 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Test folders.remove	: {"id":49,"method":"folders.remove","params":{"context":"contacts","folderID":<folder_ids[0]>}}",
 	// Expected Response 		: {"jsonrpc":"2.0","result":{"folder.remove":"success"},"id":49}
 
-  // Set the current command string.
-  chr_command = "{\"id\":49,\"method\":\"folders.remove\",\"params\":{\"context\":\"mail\",\"folderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":49,\"method\":\"folders.remove\",\"params\":{\"context\":\"mail\",\"folderID\":%lu}}";
 
 	// Construct the command string.
 	if (!(st_sprint(command, chr_command, folder_ids[0]))) {
@@ -2802,14 +2796,14 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	//											"messageIDs":[<message_ids[0]>], "folderID":<folder_ids[0]>}}
 	// Expected Response 	: {"jsonrpc":"2.0","result":{"messages.flag":"success"},"id":50}
 
-  // Set the current command string.
-  chr_command = "{\"id\":50,\"method\":\"messages.flag\",\"params\":{\"action\":\"add\",\"flags\":[\"flagged\"],\"messageIDs\":[%lu],\"folderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":50,\"method\":\"messages.flag\",\"params\":{\"action\":\"add\",\"flags\":[\"flagged\"],\"messageIDs\":[%lu],\"folderID\":%lu}}";
 
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 48 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 48 }");
 		return false;
 	}
 
@@ -2822,7 +2816,6 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 
 	// Submit the command and check the status of the response.
 	else if (!(json = check_camel_print(command, cookie, secure))) {
-
 		st_sprint(errmsg, "Failed to return a successful HTTP response. { command = %.*s }", st_length_int(command),
 			st_char_get(command));
 		return false;
@@ -2841,7 +2834,6 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 
 	// Check if the returned JSON is correct.
 	else if (st_cmp_cs_eq(NULLER((chr_t *)json_values[0]), PLACER("success", 7))) {
-
 		st_sprint(errmsg, "Failed parsing the returned JSON. { command = %.*s, json = %.*s }", st_length_int(command),
 			st_char_get(command), st_length_int(json), st_char_get(json));
 		json_decref_d(json_objs[0]);
@@ -2871,7 +2863,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 49 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 49 }");
 		return false;
 	}
 
@@ -2924,14 +2916,14 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	//											"folderID":<folder_ids[0]>}}
 	// Expected Response 	: {"jsonrpc":"2.0","result":[ { an object matching messageID[0] }, ... ],"id":52}
 
-  // Set the current command string.
-  chr_command = "{\"id\":52,\"method\":\"messages.flag\",\"params\":{\"action\":\"list\",\"messageIDs\":[%lu],\"folderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":52,\"method\":\"messages.flag\",\"params\":{\"action\":\"list\",\"messageIDs\":[%lu],\"folderID\":%lu}}";
 
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 50 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 50 }");
 		return false;
 	}
 
@@ -2992,7 +2984,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 51 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 51 }");
 		return false;
 	}
 
@@ -3035,20 +3027,18 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Test messages.list	: {"id":54,"method":"messages.list","params":{"folderID":<folder_ids[0]>}}",
 	// Expected Response 	: {"jsonrpc":"2.0","result":{"messages.flag":"success"},"id":54}
 
-  // Set the current command string.
-  chr_command = "{\"id\":54,\"method\":\"messages.list\",\"params\":{\"folderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":54,\"method\":\"messages.list\",\"params\":{\"folderID\":%lu}}";
 
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
-
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 52 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 52 }");
 		return false;
 	}
 
 	// Construct the command string.
 	if (!(st_sprint(command, chr_command, folder_ids[0]))) {
-
 		st_sprint(errmsg, "Failed to create command string. { command # = 52 }");
 		return false;
 	}
@@ -3084,13 +3074,13 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Test messages.list	: {"id":55,"method":"messages.list","params":{"context":"mail","folderID":<folder_ids[0]>}}",
 	// Expected Response 	: {"jsonrpc":"2.0","result":{"messages.flag":"success"},"id":55}
 
-  // Set the current command string.
-  chr_command = "{\"id\":55,\"method\":\"folders.tags\",\"params\":{\"context\":\"mail\",\"folderID\":%lu}}";
+	// Set the current command string.
+	chr_command = "{\"id\":55,\"method\":\"folders.tags\",\"params\":{\"context\":\"mail\",\"folderID\":%lu}}";
 
 	// Retrieve the folderID of Inbox.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1) {
 
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 53 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 53 }");
 		return false;
 	}
 
@@ -3188,8 +3178,7 @@ bool_t check_camel_basic_sthread(bool_t secure, stringer_t *errmsg) {
 	// Retrieve the folderID of Inbox and a messageID.
 	if ((folder_ids[0] = check_camel_folder_id(PLACER("Inbox", 5), cookie, secure)) == -1 ||
 		(message_ids[0] = check_camel_msg_id(folder_ids[0], cookie, secure)) == -1) {
-
-		st_sprint(errmsg, "Failed to retrieve the folderID of Inbox or Inbox is empty. { command # = 55 }");
+		st_sprint(errmsg, "Failed to retrieve the folderID of the Inbox or the Inbox is empty. { command # = 55 }");
 		return false;
 	}
 

src/engine/controller/queue.c

@@ -136,7 +136,8 @@ void queue_signal(void) {
 
 	for (uint64_t i = 0; queue.workers && i < magma.system.worker_threads; i++) {
 
-		if (queue.workers + i && (ret = thread_signal(*(queue.workers + i), SIGALRM))) {
+		// Don't bother logging errors if the process is already shutting down.
+		if (queue.workers + i && (ret = thread_signal(*(queue.workers + i), SIGALRM)) && status()) {
 			log_info("Unable to signal the worker thread. {ret = %i}", ret);
 		}
 

src/web/portal/endpoint.c

@@ -458,7 +458,8 @@ void portal_endpoint_alert_acknowledge(connection_t *con) {
 			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), err.text);
 		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
 		return;
-	} else if (!json_is_array(alerts)) {
+	}
+	else if (!json_is_array(alerts)) {
 		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
 		return;
 	}
@@ -597,7 +598,7 @@ void portal_endpoint_folders_add(connection_t *con) {
 		return;
 	}
 	// Validate the request format and extract the submitted values.
-	if ((count = json_object_size_d(con->http.portal.params)) && (count > 3 || count < 2)) {
+	else if ((count = json_object_size_d(con->http.portal.params)) && (count > 3 || count < 2)) {
 		log_pedantic("Received invalid portal folder add request parameters { user = %.*s, count = %u }",
 			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), (unsigned int) count);
 		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
@@ -989,19 +990,42 @@ void portal_endpoint_folders_tags(connection_t *con) {
  */
 void portal_endpoint_messages_list(connection_t *con) {
 
-	json_error_t err;;
+	json_error_t err;
 	json_t *tags, *list, *entry;
 	inx_cursor_t *cursor;
 	meta_message_t *active;
-	uint64_t foldernum, count;
+	uint64_t foldernum, count, current = 0, start = 0, limit = 0;
 	stringer_t *header, *fields[8];
 
+//	if ((count = json_object_size_d(con->http.portal.params)) && (count > 3 || count < 2)) {
+//		log_pedantic("Received invalid portal folder add request parameters { user = %.*s, count = %u }",
+//			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), (unsigned int) count);
+//		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
+//		return;
+//	}
+//	else if ((count == 2 && json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:s, s:s}", "context", &method, "name", &name)) ||
+//		(count == 3 && json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:s, s:s, s:I}", "context", &method, "name", &name, "parentID", &parent))) {
+//		log_pedantic("Received invalid portal folder add request parameters { user = %.*s, errmsg = %s }",
+//			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), err.text);
+//		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
+//		return;
+//	}
 	// Check the session state. Method has 1 parameter.
-	if (!portal_validate_request (con, PORTAL_ENDPOINT_ERROR_MESSAGES_LIST, "messages.list", true, 1)) {
+	if (!portal_validate_request (con, PORTAL_ENDPOINT_ERROR_MESSAGES_LIST, "messages.list", true, 0)) {
 		return;
 	}
 	// Validate the request format and extract the submitted values.
-	else if (json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:I}", "folderID", &foldernum)) {
+	else if ((count = json_object_size_d(con->http.portal.params)) && (count < 1 || count > 3)) {
+		log_pedantic("Received invalid portal messages list request parameters { user = %.*s, count = %u }",
+			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), (unsigned int) count);
+		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
+		return;
+	}
+	// Validate the request format and extract the submitted values.
+	else if ((count == 1 && json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:I}", "folderID", &foldernum)) ||
+	(count == 2 && json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:I, s:I}", "folderID", &foldernum, "start", &start) &&
+	json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:I, s:I}", "folderID", &foldernum, "limit", &limit)) ||
+	(count == 3 && json_unpack_ex_d(con->http.portal.params, &err, JSON_STRICT, "{s:I, s:I, s:I}", "folderID", &foldernum, "start", &start, "limit", &limit))) {
 		log_pedantic("Received invalid portal messages list request parameters { user = %.*s, errmsg = %s }",
 			(int)st_length_get(con->http.session->user->username), st_char_get(con->http.session->user->username), err.text);
 		portal_endpoint_error(con, 400, JSON_RPC_2_ERROR_SERVER_METHOD_PARAMS, "Invalid method parameters.");
@@ -1018,9 +1042,16 @@ void portal_endpoint_messages_list(connection_t *con) {
 
 	if ((cursor = inx_cursor_alloc(con->http.session->user->messages)))	{
 
-		while ((active = inx_cursor_value_next(cursor))) {
+		while ((active = inx_cursor_value_next(cursor)) && (limit == 0 || current < limit)) {
 
-			if (active->foldernum == foldernum && (header = mail_load_header(active, con->http.session->user, con->server, true))) {
+			// If a start value was provided, then skip the requested number of messagres before we start adding results
+			// to the response object.
+			if (active->foldernum == foldernum && start) {
+				start--;
+			}
+
+			// Otherwise add any messages in the matching folder, which can be loaded.
+			else if (active->foldernum == foldernum && (header = mail_load_header(active, con->http.session->user, con->server, true))) {
 
 				fields[0] = mail_header_fetch_cleaned(header, PLACER("From", 4));
 				fields[1] = mail_header_fetch_cleaned(header, PLACER("To", 2));
@@ -1064,6 +1095,9 @@ void portal_endpoint_messages_list(connection_t *con) {
 
 				// Release header string.
 				st_free(header);
+
+				// Track the number of messages that have been added.
+				current++;
 			}
 		}
 

web/doc/methods/messages.list.md

@@ -6,6 +6,14 @@ List messages of the given folder.
 
 - integer
 
+["start"] - *given to skip the specified number of messages in the folder, before constructing the response*
+
+- integer
+
+["limit"] - *stop adding messages to the response, when it reaches this number*
+
+- integer
+
 ### Response Params
 
 "messageID"