From: Timo Sirainen <timo.sirainen@dovecot.fi>
Date: Tue, 5 Jul 2016 17:58:29 +0000 (+0300)
Subject: lib-storage: Clarify that mail_namespace_find_inbox() never returns NULL.
X-Git-Tag: 2.3.0.rc1~3335
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bb1da4a6320eec11890c852e74a08868837e7be3;p=thirdparty%2Fdovecot%2Fcore.git

lib-storage: Clarify that mail_namespace_find_inbox() never returns NULL.

If namespaces==NULL, this function isn't even supposed to be called.
---

diff --git a/src/lib-storage/mail-namespace.c b/src/lib-storage/mail-namespace.c
index 6b80894626..d6db49b1f7 100644
--- a/src/lib-storage/mail-namespace.c
+++ b/src/lib-storage/mail-namespace.c
@@ -730,8 +730,13 @@ mail_namespace_find_unsubscribable(struct mail_namespace *namespaces,
 struct mail_namespace *
 mail_namespace_find_inbox(struct mail_namespace *namespaces)
 {
-	while ((namespaces->flags & NAMESPACE_FLAG_INBOX_USER) == 0)
+	i_assert(namespaces != NULL);
+
+	/* there should always be an INBOX */
+	while ((namespaces->flags & NAMESPACE_FLAG_INBOX_USER) == 0) {
 		namespaces = namespaces->next;
+		i_assert(namespaces != NULL);
+	}
 	return namespaces;
 }
 
diff --git a/src/lib-storage/mail-namespace.h b/src/lib-storage/mail-namespace.h
index ca2e2b3708..a789f80b70 100644
--- a/src/lib-storage/mail-namespace.h
+++ b/src/lib-storage/mail-namespace.h
@@ -142,7 +142,7 @@ mail_namespace_find_subscribable(struct mail_namespace *namespaces,
 struct mail_namespace *
 mail_namespace_find_unsubscribable(struct mail_namespace *namespaces,
 				   const char *mailbox);
-/* Returns the INBOX namespace, or NULL if there is no such  */
+/* Returns the INBOX namespace. It always exists, so NULL is never returned. */
 struct mail_namespace *
 mail_namespace_find_inbox(struct mail_namespace *namespaces);
 /* Find a namespace with given prefix. */