Mercurial > dovecot > core-2.2

changeset 13628:c9594ff166a9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
imapc: Support retrying some IMAP commands if we get disconnected.
author Timo Sirainen <tss@iki.fi>
date Sun, 09 Oct 2011 20:38:11 +0300
parents f63f2b2217c3
children 8a2ec8284b61
files src/lib-imap-client/imapc-client-private.h src/lib-imap-client/imapc-client.c src/lib-imap-client/imapc-connection.c src/lib-imap-client/imapc-connection.h src/lib-storage/index/imapc/imapc-mail-fetch.c src/lib-storage/index/imapc/imapc-storage.c src/lib-storage/index/imapc/imapc-storage.h src/lib-storage/index/imapc/imapc-sync.c src/lib-storage/index/imapc/imapc-sync.h
diffstat 9 files changed, 142 insertions(+), 59 deletions(-) [+]
line wrap: on
line diff
--- a/src/lib-imap-client/imapc-client-private.h	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-imap-client/imapc-client-private.h	Sun Oct 09 20:38:11 2011 +0300
@@ -35,6 +35,7 @@
 	unsigned int pending_box_command_count;
 
 	bool reconnect_ok;
+	bool reconnecting;
 };
 
 void imapc_client_ref(struct imapc_client *client);
--- a/src/lib-imap-client/imapc-client.c	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-imap-client/imapc-client.c	Sun Oct 09 20:38:11 2011 +0300
@@ -258,16 +258,27 @@
 {
 	struct imapc_client_mailbox *box = context;
 
+	i_assert(box->reconnecting);
+	box->reconnecting = FALSE;
+
 	if (reply->state == IMAPC_COMMAND_STATE_OK) {
 		/* reopen the mailbox */
 		box->reopen_callback(box->reopen_context);
+	} else {
+		imapc_connection_abort_commands(box->conn);
 	}
 }
 
 void imapc_client_mailbox_reconnect(struct imapc_client_mailbox *box)
 {
+	bool reconnect = box->reopen_callback != NULL && box->reconnect_ok;
+
+	if (reconnect) {
+		i_assert(!box->reconnecting);
+		box->reconnecting = TRUE;
+	}
 	imapc_connection_disconnect(box->conn);
-	if (box->reopen_callback != NULL && box->reconnect_ok) {
+	if (reconnect) {
 		imapc_connection_connect(box->conn,
 					 imapc_client_reconnect_cb, box);
 	}
@@ -282,6 +293,12 @@
 	/* cancel any pending commands */
 	imapc_connection_unselect(box);
 
+	if (box->reconnecting) {
+		/* need to abort the reconnection so it won't try to access
+		   the box */
+		imapc_connection_disconnect(box->conn);
+	}
+
 	/* set this only after unselect, which may cancel some commands that
 	   reference this box */
 	*_box = NULL;
--- a/src/lib-imap-client/imapc-connection.c	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-imap-client/imapc-connection.c	Sun Oct 09 20:38:11 2011 +0300
@@ -63,6 +63,7 @@
 	/* Waiting for '+' literal reply before we can continue */
 	unsigned int wait_for_literal:1;
 };
+ARRAY_DEFINE_TYPE(imapc_command, struct imapc_command *);
 
 struct imapc_connection_literal {
 	char *temp_path;
@@ -103,9 +104,9 @@
 	void *login_context;
 
 	/* commands pending in queue to be sent */
-	ARRAY_DEFINE(cmd_send_queue, struct imapc_command *);
+	ARRAY_TYPE(imapc_command) cmd_send_queue;
 	/* commands that have been sent, waiting for their tagged reply */
-	ARRAY_DEFINE(cmd_wait_list, struct imapc_command *);
+	ARRAY_TYPE(imapc_command) cmd_wait_list;
 
 	unsigned int ips_count, prev_connect_idx;
 	struct ip_addr *ips;
@@ -209,29 +210,70 @@
 }
 
 static void
-imapc_connection_abort_pending_commands(struct imapc_connection *conn,
-					const struct imapc_command_reply *reply)
+imapc_connection_abort_commands_array(ARRAY_TYPE(imapc_command) *cmd_array,
+				      ARRAY_TYPE(imapc_command) *dest_array,
+				      bool keep_retriable)
+{
+	struct imapc_command *const *cmdp, *cmd;
+	unsigned int i;
+
+	for (i = 0; i < array_count(cmd_array); ) {
+		cmdp = array_idx(cmd_array, i);
+		cmd = *cmdp;
+
+		if (keep_retriable &&
+		    (cmd->flags & IMAPC_COMMAND_FLAG_RETRIABLE) != 0) {
+			cmd->send_pos = 0;
+			cmd->wait_for_literal = 0;
+			i++;
+		} else {
+			array_delete(cmd_array, i, 1);
+			array_append(dest_array, &cmd, 1);
+		}
+	}
+}
+
+static void
+imapc_connection_abort_commands_full(struct imapc_connection *conn,
+				     bool keep_retriable)
 {
 	struct imapc_command *const *cmdp, *cmd;
+	ARRAY_TYPE(imapc_command) tmp_array;
+	struct imapc_command_reply reply;
 
-	while (array_count(&conn->cmd_wait_list) > 0) {
-		cmdp = array_idx(&conn->cmd_wait_list, 0);
+	t_array_init(&tmp_array, 8);
+	imapc_connection_abort_commands_array(&conn->cmd_wait_list,
+					      &tmp_array, keep_retriable);
+	imapc_connection_abort_commands_array(&conn->cmd_send_queue,
+					      &tmp_array, keep_retriable);
+
+	if (array_count(&conn->cmd_wait_list) > 0) {
+		/* need to move all the waiting commands to send queue */
+		array_append_array(&conn->cmd_wait_list,
+				   &conn->cmd_send_queue);
+		array_clear(&conn->cmd_send_queue);
+		array_append_array(&conn->cmd_send_queue,
+				   &conn->cmd_wait_list);
+		array_clear(&conn->cmd_wait_list);
+	}
+
+	/* abort the commands. we'll do it here later so that if the
+	   callback recurses us back here we don't crash */
+	memset(&reply, 0, sizeof(reply));
+	reply.state = IMAPC_COMMAND_STATE_DISCONNECTED;
+	reply.text_without_resp = reply.text_full =
+		"Disconnected from server";
+	array_foreach(&tmp_array, cmdp) {
 		cmd = *cmdp;
-		array_delete(&conn->cmd_wait_list, 0, 1);
 
-		if (cmd->callback != NULL)
-			cmd->callback(reply, cmd->context);
+		cmd->callback(&reply, cmd->context);
 		imapc_command_free(cmd);
 	}
-	while (array_count(&conn->cmd_send_queue) > 0) {
-		cmdp = array_idx(&conn->cmd_send_queue, 0);
-		cmd = *cmdp;
-		array_delete(&conn->cmd_send_queue, 0, 1);
+}
 
-		if (cmd->callback != NULL)
-			cmd->callback(reply, cmd->context);
-		imapc_command_free(cmd);
-	}
+void imapc_connection_abort_commands(struct imapc_connection *conn)
+{
+	imapc_connection_abort_commands_full(conn, FALSE);
 }
 
 static void
@@ -262,7 +304,6 @@
 		reply.state = IMAPC_COMMAND_STATE_DISCONNECTED;
 		reply.text_without_resp = reply.text_full =
 			"Disconnected from server";
-		imapc_connection_abort_pending_commands(conn, &reply);
 		imapc_login_callback(conn, &reply);
 
 		conn->idling = FALSE;
@@ -272,9 +313,6 @@
 		conn->selecting_box = NULL;
 		conn->selected_box = NULL;
 		break;
-	case IMAPC_CONNECTION_STATE_DONE:
-		imapc_command_send_more(conn);
-		break;
 	default:
 		break;
 	}
@@ -306,6 +344,9 @@
 
 void imapc_connection_disconnect(struct imapc_connection *conn)
 {
+	bool reconnecting = conn->selected_box != NULL &&
+		conn->selected_box->reconnecting;
+
 	if (conn->fd == -1)
 		return;
 
@@ -327,6 +368,13 @@
 	net_disconnect(conn->fd);
 	conn->fd = -1;
 
+	imapc_connection_abort_commands_full(conn, reconnecting);
+	imapc_connection_set_state(conn, IMAPC_CONNECTION_STATE_DISCONNECTED);
+}
+
+static void imapc_connection_set_disconnected(struct imapc_connection *conn)
+{
+	imapc_connection_abort_commands(conn);
 	imapc_connection_set_state(conn, IMAPC_CONNECTION_STATE_DISCONNECTED);
 }
 
@@ -794,6 +842,7 @@
 {
 	const struct imap_arg *imap_args;
 	const char *name, *value;
+	struct imap_parser *parser;
 	struct imapc_untagged_reply reply;
 	int ret;
 
@@ -854,7 +903,12 @@
 		reply.untagged_box_context =
 			conn->selected_box->untagged_box_context;
 	}
+
+	/* the callback may disconnect and destroy the parser */
+	parser = conn->parser;
+	imap_parser_ref(parser);
 	conn->client->untagged_callback(&reply, conn->client->untagged_context);
+	imap_parser_unref(&parser);
 	imapc_connection_input_reset(conn);
 	return 1;
 }
@@ -893,8 +947,7 @@
 imapc_command_reply_free(struct imapc_command *cmd,
 			 const struct imapc_command_reply *reply)
 {
-	if (cmd->callback != NULL)
-		cmd->callback(reply, cmd->context);
+	cmd->callback(reply, cmd->context);
 	imapc_command_free(cmd);
 }
 
@@ -904,6 +957,7 @@
 	unsigned int i, count;
 	char *line, *linep;
 	const char *p;
+	struct imap_parser *parser;
 	struct imapc_command_reply reply;
 
 	line = i_stream_next_line(conn->input);
@@ -985,7 +1039,13 @@
 	}
 
 	imapc_connection_input_reset(conn);
+
+	parser = conn->parser;
+	imap_parser_ref(parser);
 	imapc_command_reply_free(cmd, &reply);
+	imap_parser_unref(&parser);
+
+	imapc_command_send_more(conn);
 	return 1;
 }
 
@@ -1215,8 +1275,7 @@
 	ip = &conn->ips[conn->prev_connect_idx];
 	fd = net_connect_ip(ip, conn->client->set.port, NULL);
 	if (fd == -1) {
-		imapc_connection_set_state(conn,
-			IMAPC_CONNECTION_STATE_DISCONNECTED);
+		imapc_connection_set_disconnected(conn);
 		return;
 	}
 	conn->fd = fd;
@@ -1252,8 +1311,7 @@
 	if (result->ret != 0) {
 		i_error("imapc(%s): dns_lookup(%s) failed: %s",
 			conn->name, conn->client->set.host, result->error);
-		imapc_connection_set_state(conn,
-			IMAPC_CONNECTION_STATE_DISCONNECTED);
+		imapc_connection_set_disconnected(conn);
 		return;
 	}
 
@@ -1483,10 +1541,14 @@
 		/* SELECT/EXAMINE command */
 		imapc_connection_set_selecting(cmd->box);
 	} else if (!imapc_client_mailbox_is_opened(cmd->box)) {
+		if (cmd->box->reconnecting) {
+			/* wait for SELECT/EXAMINE */
+			return;
+		}
 		/* shouldn't normally happen */
 		memset(&reply, 0, sizeof(reply));
 		reply.text_without_resp = reply.text_full = "Mailbox not open";
-		reply.state = IMAPC_COMMAND_STATE_BAD;
+		reply.state = IMAPC_COMMAND_STATE_DISCONNECTED;
 
 		array_delete(&conn->cmd_send_queue, 0, 1);
 		imapc_command_reply_free(cmd, &reply);
@@ -1577,7 +1639,14 @@
 					       imapc_command_timeout, conn);
 		}
 	}
-	array_append(&conn->cmd_send_queue, &cmd, 1);
+	if ((cmd->flags & IMAPC_COMMAND_FLAG_SELECT) != 0 &&
+	    conn->selected_box == NULL) {
+		/* reopening the mailbox. add it before other
+		   queued commands. */
+		array_insert(&conn->cmd_send_queue, 0, &cmd, 1);
+	} else {
+		array_append(&conn->cmd_send_queue, &cmd, 1);
+	}
 	imapc_command_send_more(conn);
 }
 
@@ -1735,37 +1804,9 @@
 void imapc_connection_unselect(struct imapc_client_mailbox *box)
 {
 	struct imapc_connection *conn = box->conn;
-	struct imapc_command *const *cmdp, *cmd;
-	struct imapc_command_reply reply;
-	unsigned int i;
-
-	/* mailbox is being closed. if there are any pending commands, we must
-	   finish them immediately so callbacks don't access any freed
-	   contexts */
-	memset(&reply, 0, sizeof(reply));
-	reply.state = IMAPC_COMMAND_STATE_DISCONNECTED;
-	reply.text_without_resp = reply.text_full = "Closing mailbox";
 
 	imapc_connection_send_idle_done(conn);
-
-	array_foreach(&conn->cmd_wait_list, cmdp) {
-		if ((*cmdp)->callback != NULL && (*cmdp)->box != NULL) {
-			(*cmdp)->callback(&reply, (*cmdp)->context);
-			(*cmdp)->callback = NULL;
-		}
-	}
-	for (i = 0; i < array_count(&conn->cmd_send_queue); ) {
-		cmdp = array_idx(&conn->cmd_send_queue, i);
-		cmd = *cmdp;
-		if (cmd->box == NULL)
-			i++;
-		else {
-			array_delete(&conn->cmd_send_queue, i, 1);
-			if (cmd->callback != NULL)
-				cmd->callback(&reply, cmd->context);
-			imapc_command_free(cmd);
-		}
-	}
+	imapc_connection_abort_commands(conn);
 
 	if (conn->selected_box != NULL || conn->selecting_box != NULL) {
 		i_assert(conn->selected_box == box ||
--- a/src/lib-imap-client/imapc-connection.h	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-imap-client/imapc-connection.h	Sun Oct 09 20:38:11 2011 +0300
@@ -25,6 +25,7 @@
 			      imapc_command_callback_t *login_callback,
 			      void *login_context);
 void imapc_connection_disconnect(struct imapc_connection *conn);
+void imapc_connection_abort_commands(struct imapc_connection *conn);
 void imapc_connection_ioloop_changed(struct imapc_connection *conn);
 void imapc_connection_input_pending(struct imapc_connection *conn);
 
--- a/src/lib-storage/index/imapc/imapc-mail-fetch.c	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-storage/index/imapc/imapc-mail-fetch.c	Sun Oct 09 20:38:11 2011 +0300
@@ -109,6 +109,7 @@
 
 	cmd = imapc_client_mailbox_cmd(mbox->client_box,
 				       imapc_mail_prefetch_callback, mail);
+	imapc_command_set_flags(cmd, IMAPC_COMMAND_FLAG_RETRIABLE);
 	imapc_command_send(cmd, str_c(str));
 	mail->imail.data.prefetch_sent = TRUE;
 	return 0;
--- a/src/lib-storage/index/imapc/imapc-storage.c	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-storage/index/imapc/imapc-storage.c	Sun Oct 09 20:38:11 2011 +0300
@@ -380,6 +380,9 @@
 	else
 		imapc_command_sendf(cmd, "SELECT %s", mbox->box.name);
 	mbox->storage->reopen_count++;
+
+	if (mbox->syncing)
+		imapc_sync_mailbox_reopened(mbox);
 }
 
 static void
--- a/src/lib-storage/index/imapc/imapc-storage.h	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-storage/index/imapc/imapc-storage.h	Sun Oct 09 20:38:11 2011 +0300
@@ -80,6 +80,7 @@
 	struct imapc_mail_cache prev_mail_cache;
 
 	uint32_t prev_skipped_rseq, prev_skipped_uid;
+	struct imapc_sync_context *sync_ctx;
 
 	unsigned int selecting:1;
 	unsigned int syncing:1;
--- a/src/lib-storage/index/imapc/imapc-sync.c	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-storage/index/imapc/imapc-sync.c	Sun Oct 09 20:38:11 2011 +0300
@@ -44,6 +44,7 @@
 	ctx->sync_command_count++;
 	cmd = imapc_client_mailbox_cmd(ctx->mbox->client_box,
 				       imapc_sync_callback, ctx);
+	imapc_command_set_flags(cmd, IMAPC_COMMAND_FLAG_RETRIABLE);
 	imapc_command_send(cmd, cmd_str);
 }
 
@@ -365,6 +366,20 @@
 	}
 }
 
+void imapc_sync_mailbox_reopened(struct imapc_mailbox *mbox)
+{
+	struct imapc_sync_context *ctx = mbox->sync_ctx;
+
+	i_assert(mbox->syncing);
+
+	/* we got disconnected while syncing. need to
+	   re-fetch everything */
+	mbox->sync_next_lseq = 1;
+	mbox->sync_next_rseq = 1;
+
+	imapc_sync_cmd(ctx, "UID FETCH 1:* FLAGS");
+}
+
 static int
 imapc_sync_begin(struct imapc_mailbox *mbox,
 		 struct imapc_sync_context **ctx_r, bool force)
@@ -402,6 +417,7 @@
 	mbox->min_append_uid = mail_index_get_header(ctx->sync_view)->next_uid;
 
 	mbox->syncing = TRUE;
+	mbox->sync_ctx = ctx;
 	if (!mbox->box.deleting)
 		imapc_sync_index(ctx);
 
@@ -429,6 +445,7 @@
 		mail_index_sync_rollback(&ctx->index_sync_ctx);
 	}
 	ctx->mbox->syncing = FALSE;
+	ctx->mbox->sync_ctx = NULL;
 
 	/* this is done simply to commit delayed expunges if there are any
 	   (has to be done after sync is committed) */
--- a/src/lib-storage/index/imapc/imapc-sync.h	Sun Oct 09 20:36:28 2011 +0300
+++ b/src/lib-storage/index/imapc/imapc-sync.h	Sun Oct 09 20:38:11 2011 +0300
@@ -22,5 +22,6 @@
 imapc_mailbox_sync_init(struct mailbox *box, enum mailbox_sync_flags flags);
 int imapc_mailbox_sync_deinit(struct mailbox_sync_context *ctx,
 			      struct mailbox_sync_status *status_r);
+void imapc_sync_mailbox_reopened(struct imapc_mailbox *mbox);
 
 #endif