ab_tree: restore pre-filtering of objects with AB_HIDE_FROM_GAL for NSP

ab_base::m_users always carries all users (no hiding), because
different users can have different cloak_bits.

zcore has knowledge about when a GAL container is to be opened, and
that it has to create a MAPI table for it. So, zcore will make a copy
of the corresponding ab_base user list, curate it (filter hidden
users), and then attach the list object to the MAPI table for later
cleanup.

Unlike zcore RPC or EMSMDB, the NSPI protocol is rather stateless. A
server does not know when the client-side MAPI implementation opens a
GAL container/creates a MAPI table. All we see are requests "read GAL
at x, for y rows". This means that ab_base needs to do the filtering
ahead of time and keep that state, since nsp/ has no (good) way to
keep it.

That filtered list for container 0 was lost in the ab_tree rewrite.
Reinstate it.

The filtered list for container ids !=0 was retained, but was not
filtered.

Fixes: gromox-2.40-23-g91fc5e139
References: GXL-611, DESK-3546

Author: jengelh

exch/nsp/nsp_interface.cpp

@@ -634,7 +634,7 @@ ec_error_t nsp_interface_unbind(NSPI_HANDLE *phandle, uint32_t reserved)
 static void nsp_interface_position_in_list(const STAT *pstat,
     const ab_tree::ab_base *base, uint32_t *pout_row, uint32_t *pcount)
 {
-	*pcount = base->user_count();
+	*pcount = base->filtered_user_count();
 	if (pstat->cur_rec == ab_tree::minid::CURRENT) {
 		/* fractional positioning MS-OXNSPI v14 §3.1.4.5.2 */
 		*pout_row = *pcount * static_cast<double>(pstat->num_pos) / pstat->total_rec;
@@ -647,12 +647,12 @@ static void nsp_interface_position_in_list(const STAT *pstat,
 	} else if (pstat->cur_rec == ab_tree::minid::END_OF_TABLE) {
 		*pout_row = *pcount;
 	} else {
-		auto it = base->find(pstat->cur_rec);
 		/*
 		 * When not found, the position is undefined.
-		 * To avoid problems we will use first row.
+		 * To avoid problems, Gromox will use the first row.
+		 * (pos_in_filtered has been made to do this directly)
 		 */
-		*pout_row = it != base->end() && it->type() == ab_tree::minid::address ? it.pos()-base->ubegin().pos() : 0;
+		*pout_row = base->pos_in_filtered_users(pstat->cur_rec);
 	}
 }
 
@@ -671,14 +671,15 @@ static void nsp_interface_position_in_table(const STAT *pstat,
 		*pout_row = *pcount;
 	} else {
 		auto it = std::find(node.begin(), node.end(), pstat->cur_rec);
-		if (it == node.end() || node.base->hidden(pstat->cur_rec) & AB_HIDE_FROM_AL)
+		if (it == node.end() || node.base->hidden(pstat->cur_rec) & AB_HIDE_FROM_AL) {
 			/*
 			 * In this case, the position is undefined.
 			 * To avoid problems, we will use the first row.
 			 */
 			*pout_row = 0;
-		else
-			*pout_row = uint32_t(std::distance(node.begin(), it));
+			return;
+		}
+		*pout_row = std::distance(node.begin(), it);
 	}
 }
 
@@ -867,7 +868,7 @@ ec_error_t nsp_interface_query_rows(NSPI_HANDLE handle, uint32_t flags,
 		return ecSuccess;
 	}
 	if (0 == pstat->container_id) {
-		for (auto it = pbase->ubegin() + start_pos; it != pbase->ubegin() + start_pos + tmp_count; ++it) {
+		for (auto it = pbase->ufbegin() + start_pos; it != pbase->ufbegin() + start_pos + tmp_count; ++it) {
 			auto prow = common_util_proprowset_enlarge(rowset);
 			if (prow == nullptr || common_util_propertyrow_init(prow) == nullptr)
 				return ecServerOOM;
@@ -894,7 +895,9 @@ ec_error_t nsp_interface_query_rows(NSPI_HANDLE handle, uint32_t flags,
 	if (start_pos + tmp_count >= total) {
 		pstat->cur_rec = ab_tree::minid::END_OF_TABLE;
 	} else {
-		pstat->cur_rec = pstat->container_id == 0 ? pbase->at(start_pos + tmp_count) : node.at(start_pos + tmp_count);
+		pstat->cur_rec = pstat->container_id == 0 ?
+		                 pbase->at_filtered(start_pos + tmp_count) :
+		                 node.at(start_pos + tmp_count);
 		if (0 == pstat->cur_rec) {
 			pstat->cur_rec = ab_tree::minid::END_OF_TABLE;
 			start_pos = total;
@@ -1010,18 +1013,18 @@ ec_error_t nsp_interface_seek_entries(NSPI_HANDLE handle, uint32_t reserved,
 
 	start_pos = 0;
 	if (0 == pstat->container_id) {
-		auto it = std::lower_bound(pbase->ubegin(), pbase->uend(), ptarget->value.pstr,
+		auto it = std::lower_bound(pbase->ufbegin(), pbase->ufend(), ptarget->value.pstr,
 		                           [&](ab_tree::minid m1, const char *val)
 		                           { return strcasecmp(pbase->displayname(m1).c_str(), val) < 0; });
-		if (it == pbase->uend())
+		if (it == pbase->ufend())
 			return ecNotFound;
 		auto prow = common_util_proprowset_enlarge(rowset);
 		if (prow == nullptr || common_util_propertyrow_init(prow) == nullptr)
 			return ecServerOOM;
 		if (nsp_interface_fetch_row({pbase, *it}, true, pstat->codepage, pproptags, prow) != ecSuccess)
 			return ecError;
 		pstat->cur_rec = *it;
-		pstat->num_pos = uint32_t(it.pos());
+		pstat->num_pos = it - pbase->ufbegin();
 	} else {
 		ab_tree::ab_node node(pbase, pstat->container_id);
 		if (start_pos >= node.children_count())

include/gromox/ab_tree.hpp

@@ -245,6 +245,12 @@ class ab_base {
 	inline iterator uend() const { return iterator(this, m_users.cend()); } ///< Iterator to end of user list
 	iterator find(minid) const;
 
+	inline auto ufbegin() const { return filtered_gal.cbegin(); }
+	inline auto ufend() const { return filtered_gal.cend(); }
+	inline size_t filtered_user_count() const { return filtered_gal.size(); }
+	minid at_filtered(uint32_t pos) const;
+	uint32_t pos_in_filtered_users(minid) const;
+
 	static display_type dtypx_to_etyp(display_type);
 
 	private:
@@ -263,6 +269,7 @@ class ab_base {
 	int m_base_id = 0;
 	std::vector<ab_domain> domains; ///< list of domains belonging to the base
 	std::vector<sql_user> m_users; ///< list of users from all those domains, sorted by displayname
+	std::vector<minid> filtered_gal;
 	std::unordered_map<minid, uint32_t> minid_idx_map; ///< map from minid to index in domain/user list
 	mutable std::mutex m_lock;
 	std::atomic<Status> m_status{Status::CONSTRUCTING};

include/gromox/mysql_adaptor.hpp

@@ -63,7 +63,6 @@ struct GX_EXPORT sql_domain {
  * %AB_HIDE_FROM_AL:	hide from Address Lists, EXC style (container != 0)
  * %AB_HIDE_DELEGATE:	hide from Delegate List
  * %AB_HIDE_RESOLVE:	hide from name resolution ("Check Names" in g-web)
- * %AB_HIDE_MINID:	disable resolution via MINID (experimental)
  *
  * %AB_HIDE__DEFAULT:	default action if AB encounters PR_ATTR_HIDDEN
  */

lib/ab_tree.cpp

@@ -214,8 +214,12 @@ bool ab_base::load()
 	minid_idx_map.reserve(m_users.size() + dmemb.size());
 	for (size_t i = 0; i < m_users.size(); ++i) {
 		const sql_user &u = m_users[i];
-		domains[domid_to_listidx[u.domain_id]].userref.emplace_back(minid(minid::address, u.id));
-		minid_idx_map.emplace(minid(minid::address, u.id), i);
+		minid mid(minid::address, u.id);
+		if (!(u.cloak_bits & AB_HIDE_FROM_GAL)) {
+			filtered_gal.emplace_back(mid);
+			domains[domid_to_listidx[u.domain_id]].userref.emplace_back(mid);
+		}
+		minid_idx_map.emplace(mid, i);
 	}
 	for (size_t i = 0; i < domains.size(); ++i)
 		minid_idx_map.emplace(minid(minid::domain, domains[i].id), i);
@@ -252,6 +256,11 @@ minid ab_base::at(uint32_t idx) const
 	       idx - domains.size() < m_users.size() ? minid(minid::address, m_users[idx-domains.size()].id) : minid();
 }
 
+minid ab_base::at_filtered(uint32_t idx) const
+{
+	return idx < filtered_gal.size() ? minid(minid::address, filtered_gal[idx]) : minid();
+}
+
 /**
  * @brief      Write company info to target strings
  *
@@ -741,6 +750,12 @@ ab_base::iterator ab_base::find(minid mid) const
 	       iterator(this, m_users.begin() + it->second);
 }
 
+uint32_t ab_base::pos_in_filtered_users(minid mid) const
+{
+	auto it = std::find(filtered_gal.cbegin(), filtered_gal.cend(), mid);
+	return it != filtered_gal.cend() ? it - filtered_gal.cbegin() : 0;
+}
+
 /**
  * @brief      Find domain by id
  *