mbop: rework for-all-users

References: GXH-111

Author: jengelh

doc/gromox-mbop.8

@@ -9,7 +9,7 @@ gromox\-mbop \(em Mailbox operations utility
 .SH Global options
 .TP
 \fB\-c\fP
-Continuous operation mode. If a command in a series (e.g. with for\-all\-users)
+Continuous operation mode. If a command in a series (e.g. with foreach.*)
 fails, do not stop.
 .TP
 \fB\-d\fP \fI/var/lib/gromox/user/1/2\fP
@@ -32,11 +32,11 @@ clear\-rwz: delete IPM.RuleOrganizer FAI messages from the inbox
 .IP \(bu 4
 delmsg: issue "delete_message" RPCs for a mailbox
 .IP \(bu 4
-echo\-username: return username (diagnostic for use with for\-all\-users)
+echo\-username: return username (for use with foreach.*)
 .IP \(bu 4
 emptyfld: remove objects from folders
 .IP \(bu 4
-for\-all\-users: iterate over all users
+foreach.*: iterate over security objects
 .IP \(bu 4
 get\-freebusy: test FB schedule lookups
 .IP \(bu 4
@@ -172,9 +172,38 @@ gromox\-mbop \-u [email protected] emptyfld \-\-soft \-\-nuke\-folders DELETED
 .IP \(bu 4
 Timed deletion of trash:
 gromox\-mbop \-u [email protected] emptyfld \-Rt 1week \-\-soft DELETED
-.SH for\-all\-users
+.SH foreach.*
 .SS Synopsis
-\fBfor\-all\-users\fP [\fB\-j\fP \fIjobs\fP] \fIcommand\fP [command-args...]
+\fBforeach.\fP\fIfilter\fP[\fB\.\fP\fIfilter\fP]* [\fB\-j\fP \fIjobs\fP]
+\fIcommand\fP [command-args...]
+.SS Description
+Iterates over security objects and executes one of the other commands
+repeatedly. Filter specifications limit the types of security objects.
+.SS Filters
+.IP \(bu 4
+secobj: limit to objects that can be used in ACLs
+.IP \(bu 4
+user: regular users
+.IP \(bu 4
+dl: distribution lists
+.IP \(bu 4
+sharedmb: shared mailboxes
+.IP \(bu 4
+room: room objects
+.IP \(bu 4
+equipment: equipment objects
+.IP \(bu 4
+contact: GAB contact objects
+.IP \(bu 4
+active: active entities
+.IP \(bu 4
+susp: entities marked as "suspended"
+.IP \(bu 4
+deleted: entities marked as "deleted"
+.IP \(bu 4
+mb: entity has a mailbox directory defined
+.IP \(bu 4
+here: entity has current server as homeserver
 .SS Options
 .TP
 \fB\-j\fP \fIjobs\fP
@@ -187,7 +216,7 @@ Default: \fI1\fP
 Pseudoaction for running one of the other subcommand (e.g. ping, unload.)
 .SS Examples
 .IP \(bu 4
-Command concatenation: gromox\-mbop for\-all\-users \\( purge\-softdelete -r /
+Command concatenation: gromox\-mbop foreach.mb.local \\( purge\-softdelete -r /
 \\) \\( purge\-datafiles \\)
 .SH get\-freebusy
 .SS Synopsis

exch/mysql_adaptor/sql2.cpp

@@ -715,3 +715,33 @@ BOOL SVC_mysql_adaptor(enum plugin_op reason, const struct dlfuncs &data)
 	}
 	return TRUE;
 }
+
+int mysql_adaptor_mbop_userlist(std::vector<sql_user> &out) try
+{
+	auto qstr = "SELECT u.id, u.username, u.address_status, u.maildir, "
+	            "dt.propval_str AS dtypx, sv.hostname "
+	            "FROM users AS u " JOIN_WITH_DISPLAYTYPE
+	            "LEFT JOIN servers AS sv ON u.homeserver=sv.id";
+	auto conn = g_sqlconn_pool.get_wait();
+	if (!conn || !conn->query(qstr)) {
+		mlog(LV_ERR, "Error obtaining user list");
+		return ENOMEM;
+	}
+	auto result = conn->store_result();
+	if (result == nullptr)
+		return ENOMEM;
+	std::vector<sql_user> gv(result.num_rows());
+	for (size_t i = 0; i < gv.size(); ++i) {
+		auto row = result.fetch_row();
+		gv[i].id = strtoul(row[0], nullptr, 0);
+		gv[i].username = row[1];
+		gv[i].addr_status = strtoul(row[2], nullptr, 0);
+		gv[i].maildir = znul(row[3]);
+		gv[i].dtypx = static_cast<enum display_type>(strtoul(row[4], nullptr, 0));
+		gv[i].homeserver = znul(row[5]);
+	}
+	out = std::move(gv);
+	return 0;
+} catch (const std::bad_alloc &) {
+	return ENOMEM;
+}

include/gromox/mysql_adaptor.hpp

@@ -71,18 +71,22 @@ enum { /* for PR_ATTR_HIDDEN_*GROMOX* */
 };
 
 /**
- * @dtex:	%DT_* type as specified for PR_DISPLAY_TYPE_EX.
- * @hidden:	hide bits for the address book
+ * @dtypx:      %DT_* type as specified for PR_DISPLAY_TYPE_EX
+ * @hidden:     hide bits for the address book
  * @list_type:	mlist_type value; only interpret field when
  * 		addr_type==ADDRESS_TYPE_MLIST.
+ *
+ * Whether the fields are filled or not depends on the mysql_adaptor_get*()
+ * function you are using.
  */
 struct sql_user {
 	enum display_type dtypx = DT_MAILUSER;
 	unsigned int id = 0;
+	unsigned int addr_status = AF_USER_DELETED;
 	enum mlist_type list_type = mlist_type::normal;
 	uint32_t hidden = 0;
 	unsigned int list_priv = 0;
-	std::string username, maildir;
+	std::string username, homeserver, maildir;
 	std::vector<std::string> aliases; /* email addresses */
 	std::map<unsigned int, std::string> propvals;
 };
@@ -128,6 +132,7 @@ extern GX_EXPORT BOOL mysql_adaptor_get_mlist_memb(const char *username, const c
 extern GX_EXPORT gromox::errno_t mysql_adaptor_get_homeserver(const char *ent, bool is_pvt, std::pair<std::string, std::string> &);
 extern GX_EXPORT gromox::errno_t mysql_adaptor_scndstore_hints(unsigned int pri, std::vector<sql_user> &hints);
 extern GX_EXPORT int mysql_adaptor_domain_list_query(const char *dom);
+extern GX_EXPORT int mysql_adaptor_mbop_userlist(std::vector<sql_user> &);
 
 /**
  * Determines whether an arbitrary actor can generally open/read the primary

tools/genimport.cpp

@@ -561,29 +561,6 @@ int gi_setup_from_user(const char *username)
 	return EXIT_SUCCESS;
 }
 
-int gi_get_users(gi_user_list_t &out) try
-{
-	auto sqh = sql_login();
-	if (sqh == nullptr)
-		return -1;
-	if (mysql_query(sqh.get(), "SELECT username, maildir FROM users") != 0) {
-		fprintf(stderr, "exm: mysql_query: %s\n", mysql_error(sqh.get()));
-		return -1;
-	}
-	DB_RESULT result = mysql_store_result(sqh.get());
-	if (result == nullptr) {
-		fprintf(stderr, "exm: mysql_store: %s\n", mysql_error(sqh.get()));
-		return -1;
-	}
-	DB_ROW row;
-	while ((row = result.fetch_row()) != nullptr)
-		if (row[0] != nullptr && row[1] != nullptr)
-			out.emplace_back(row[0], row[1]);
-	return 0;
-} catch (const std::bad_alloc &) {
-	return -1;
-}
-
 namespace {
 
 static constexpr std::pair<const char *, uint8_t> fld_special_names[] = {

tools/genimport.hpp

@@ -81,7 +81,6 @@ using gi_folder_map_t = std::unordered_map<uint32_t, tgt_folder>;
 using message_content_ptr = std::unique_ptr<MESSAGE_CONTENT, gromox::mc_delete>;
 using propname_array_ptr = std::unique_ptr<PROPNAME_ARRAY, gi_delete>;
 using tarray_set_ptr = std::unique_ptr<TARRAY_SET, gi_delete>;
-using gi_user_list_t = std::vector<std::pair<std::string, std::string>>;
 
 enum {
 	DELIVERY_TWOSTEP = 0x8000U,
@@ -110,4 +109,3 @@ extern int gi_setup_from_dir(const char *);
 extern int gi_startup_client(unsigned int maxconn = 1);
 extern eid_t gi_lookup_eid_by_name(const char *dir, const char *name);
 extern void gi_shutdown();
-extern int gi_get_users(gi_user_list_t &out);