exch: better function/variable names for cu_extract_delegate

References: GXH-169

Author: grammmike

exch/emsmdb/oxomsg.cpp

@@ -131,15 +131,17 @@ static ec_error_t oxomsg_rectify_message(message_object *pmessage,
 }
 
 /**
+ * Inspects a message that a delegate (secretary) wants to submit.
+ *
  * Returns:
- * - %true and @username is empty: no delegation was requested
- * - %true and @username is set: delegation with given identity;
+ * - %true and @username is empty: no delegation
+ * - %true and @username is set: delegator ("boss") extracted and
  *   identity guaranteed to exist; caller still needs to perform a
  *   permission check.
  * - %false: unable to contact server,
- *   or requested identity not present in the system
+ *   or requested identity (boss) not present in the system
  */
-static bool oxomsg_extract_delegate(message_object *pmessage,
+static bool oxomsg_extract_delegator(message_object *pmessage,
     std::string &username)
 {
 	static constexpr proptag_t proptag_buff[] =
@@ -312,25 +314,25 @@ ec_error_t rop_submitmessage(uint8_t submit_flags, LOGMAP *plogmap,
 		        static_cast<unsigned long long>(pmessage->get_id()));
 		return ecAccessDenied;
 	}
-	std::string username;
-	if (!oxomsg_extract_delegate(pmessage, username))
+	std::string delegator;
+	if (!oxomsg_extract_delegator(pmessage, delegator))
 		return ecError;
-	auto account = plogon->get_account();
+	auto actor = plogon->get_account();
 	repr_grant repr_grant;
-	if (username.empty()) {
+	if (delegator.empty()) {
 		/* "No impersonation requested" is modeled as {impersonate yourself}. */
-		username = account;
+		delegator = actor;
 		repr_grant = repr_grant::send_as;
 	} else {
-		repr_grant = oxomsg_get_perm(account, username.c_str());
+		repr_grant = oxomsg_get_perm(actor, delegator.c_str());
 	}
 	if (repr_grant < repr_grant::send_on_behalf) {
-		auto ret = pass_scheduling("E-2081", account, username.c_str(), *pmessage,
+		auto ret = pass_scheduling("E-2081", actor, delegator.c_str(), *pmessage,
 		           tmp_propvals.get<const char>(PR_MESSAGE_CLASS));
 		if (ret != ecSuccess)
 			return ret;
 	}
-	auto ret = oxomsg_rectify_message(pmessage, username.c_str(),
+	auto ret = oxomsg_rectify_message(pmessage, delegator.c_str(),
 	           repr_grant >= repr_grant::send_as);
 	if (ret != ecSuccess)
 		return ret;
@@ -618,27 +620,27 @@ ec_error_t rop_transportsend(TPROPVAL_ARRAY **pppropvals, LOGMAP *plogmap,
 		        static_cast<unsigned long long>(pmessage->get_id()));
 		return ecAccessDenied;
 	}
-	std::string username;
-	if (!oxomsg_extract_delegate(pmessage, username))
+	std::string delegator;
+	if (!oxomsg_extract_delegator(pmessage, delegator))
 		return ecError;
-	auto account = plogon->get_account();
+	auto actor = plogon->get_account();
 	repr_grant repr_grant;
-	if (username.empty()) {
-		username = account;
+	if (delegator.empty()) {
+		delegator = actor;
 		repr_grant = repr_grant::send_as;
 	} else {
-		repr_grant = oxomsg_get_perm(account, username.c_str());
+		repr_grant = oxomsg_get_perm(actor, delegator.c_str());
 	}
 	if (repr_grant < repr_grant::send_on_behalf) {
 		TPROPVAL_ARRAY cls_vals{};
 		if (pmessage->get_properties(0, &cls_tags, &cls_vals) != 0)
 			/* ignore, since we can test for cls_vals fill */;
-		auto ret = pass_scheduling("E-2080", account, username.c_str(), *pmessage,
+		auto ret = pass_scheduling("E-2080", actor, delegator.c_str(), *pmessage,
 		           cls_vals.get<const char>(PR_MESSAGE_CLASS));
 		if (ret != ecSuccess)
 			return ret;
 	}
-	auto ret = oxomsg_rectify_message(pmessage, username.c_str(),
+	auto ret = oxomsg_rectify_message(pmessage, delegator.c_str(),
 	           repr_grant >= repr_grant::send_as);
 	if (ret != ecSuccess)
 		return ret;

exch/zcore/common_util.cpp

@@ -114,7 +114,7 @@ BOOL common_util_verify_columns_and_sorts(
 }
 
 /* Cf. oxomsg_extract_delegate for comments */
-bool cu_extract_delegate(message_object *pmessage, std::string &username)
+bool cu_extract_delegator(message_object *pmessage, std::string &username)
 {
 	TPROPVAL_ARRAY tmp_propvals;
 	static constexpr proptag_t proptag_buff[] =

exch/zcore/common_util.hpp

@@ -83,7 +83,7 @@ extern int common_util_run(const char *data_path);
 BOOL common_util_verify_columns_and_sorts(
 	const PROPTAG_ARRAY *pcolumns,
 	const SORTORDER_SET *psort_criteria);
-extern bool cu_extract_delegate(message_object *, std::string &dlgt);
+extern bool cu_extract_delegator(message_object *, std::string &);
 extern repr_grant cu_get_delegate_perm_MD(const char *account, const char *maildir);
 extern repr_grant cu_get_delegate_perm_AA(const char *account, const char *account_representing);
 extern ec_error_t cu_set_propval(TPROPVAL_ARRAY *parray, gromox::proptag_t, const void *);

exch/zcore/zserver.cpp

@@ -3264,23 +3264,23 @@ ec_error_t zs_submitmessage(GUID hsession, uint32_t hmessage) try
 	/* FAI message cannot be sent */
 	if (flag != nullptr && *flag != 0)
 		return ecAccessDenied;
-	std::string username;
-	if (!cu_extract_delegate(pmessage, username))
+	std::string delegator;
+	if (!cu_extract_delegator(pmessage, delegator))
 		return ecSendAsDenied;
-	auto account = pstore->get_account();
+	auto actor = pstore->get_account();
 	repr_grant repr_grant;
-	if (username.empty()) {
-		username = account;
+	if (delegator.empty()) {
+		delegator = actor;
 		repr_grant = repr_grant::send_as;
 	} else {
-		repr_grant = cu_get_delegate_perm_AA(account, username.c_str());
+		repr_grant = cu_get_delegate_perm_AA(actor, delegator.c_str());
 	}
 	if (repr_grant < repr_grant::send_on_behalf) {
 		mlog(LV_INFO, "I-1334: uid %s tried to submit %s:%llxh with from=<%s>, but no impersonation permission given.",
-		        account, pstore->dir, LLU{pmessage->get_id()}, username.c_str());
+		        actor, pstore->dir, LLU{pmessage->get_id()}, delegator.c_str());
 		return ecAccessDenied;
 	}
-	auto err = rectify_message(pmessage, username.c_str(),
+	auto err = rectify_message(pmessage, delegator.c_str(),
 	           repr_grant >= repr_grant::send_as);
 	if (err != ecSuccess)
 		return err;
@@ -3337,8 +3337,7 @@ ec_error_t zs_submitmessage(GUID hsession, uint32_t hmessage) try
 		auto deferred_time = props_to_defer_interval(tmp_propvals);
 		if (deferred_time > 0) {
 			snprintf(command_buff, 1024, "%s %s %llu",
-				common_util_get_submit_command(),
-			         pstore->get_account(),
+			         common_util_get_submit_command(), actor,
 			         LLU{rop_util_get_gc_value(pmessage->get_id())});
 			timer_id = system_services_add_timer(
 					command_buff, deferred_time);