doveadm.c revision 29666594233e23edd98f8ee0fb5763dd2b094b09
e59faf65ce864fe95dc00f5d52b8323cdbd0608aTimo Sirainen/* Copyright (c) 2009-2010 Dovecot authors, see the included COPYING file */
5296198635718c9bf5b2f972c9d5be52092d3d58Timo Sirainenbool doveadm_verbose = FALSE, doveadm_debug = FALSE;
acc039dfc0b0f4588cf2feec04727b61e1c672a1Timo Sirainenstatic ARRAY_DEFINE(doveadm_cmds, struct doveadm_cmd);
acc039dfc0b0f4588cf2feec04727b61e1c672a1Timo Sirainenvoid doveadm_register_cmd(const struct doveadm_cmd *cmd)
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainendoveadm_usage_compress_lines(FILE *out, const char *str, const char *prefix)
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen const char *cmd, *args, *p, *short_name, *prev_name = "";
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen unsigned int i, count, prefix_len = strlen(prefix);
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen /* split lines */
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen lines = p_strsplit(pool_datastack_create(), str, "\n");
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen for (count = 0; lines[count] != NULL; count++) ;
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen /* sort lines */
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen qsort(lines, count, sizeof(*lines), i_strcmp_p);
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen /* print lines, compress subcommands into a single line */
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen for (i = 0; i < count; i++) {
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen fprintf(out, USAGE_CMDNAME_FMT" %s\n", cmd, args);
72c47a26f4ded49d4827dc64818b34bbc9606fc4Timo Sirainen fprintf(out, "usage: doveadm [-Dv] [-f <formatter>] ");
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen str_printfa(str, "%s\t%s\n", cmd->name, cmd->short_usage);
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen doveadm_usage_compress_lines(out, str_c(str), prefix);
9ce62fcb795a4bb57f1c003fc8cbd63bff6e5463Timo Sirainenhelp_to(const struct doveadm_cmd *cmd, FILE *out)
9f3bb0e10835efb0c9b1eb9e09e16b614ec41b97Timo Sirainen fprintf(out, "doveadm %s %s\n", cmd->name, cmd->short_usage);
068357123aba2906c17a4e3bbe57417570be1958Timo Sirainen strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", tm);
1db62753d9e3b5d71018889c8ef0a3722a307455Timo Sirainenconst char *doveadm_plugin_getenv(const char *name)
1db62753d9e3b5d71018889c8ef0a3722a307455Timo Sirainen const char *const *envs;
1db62753d9e3b5d71018889c8ef0a3722a307455Timo Sirainen unsigned int i, count;
1db62753d9e3b5d71018889c8ef0a3722a307455Timo Sirainen if (!array_is_created(&doveadm_settings->plugin_envs))
1db62753d9e3b5d71018889c8ef0a3722a307455Timo Sirainen envs = array_get(&doveadm_settings->plugin_envs, &count);
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainenparse_hostport(const char *str, const char **host_r, unsigned int *port_r)
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen const char *p;
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen /* host:port */
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen if (p == NULL || str_to_uint(p+1, port_r) < 0)
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen /* there is any '/' character (unlikely to be found from host names),
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen assume ':' is part of a file path */
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen if (parse_hostport(path, &host, &port) && stat(path, &st) < 0) {
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen /* it's a host:port, connect via TCP */
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen ret = net_gethostbyname(host, &ips, &ips_count);
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen fd = net_connect_ip_blocking(&ips[0], port, NULL);
91770f85d9b2ac3e91b7aa74f57149412ae33c4cTimo Sirainen i_fatal("net_connect_unix(%s) failed: %m", path);
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainenstatic bool doveadm_has_subcommands(const char *cmd_name)
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen return doveadm_mail_has_subcommands(cmd_name);
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainenstatic bool doveadm_has_unloaded_plugin(const char *name)
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen /* first check that it's not actually loaded */
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen for (module = modules; module != NULL; module = module->next) {
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen if (strcmp(module_get_plugin_name(module), name) == 0)
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen plugin_name = module_file_get_name(d->d_name);
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen if (strncmp(plugin_name, name, name_len) == 0 &&
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen strcmp(plugin_name + name_len, "_plugin") == 0)) {
28b8434ca4cba2e310d13ffc55e895d658725f43Timo Sirainenstatic void cmd_help(int argc ATTR_UNUSED, char *argv[])
28b8434ca4cba2e310d13ffc55e895d658725f43Timo Sirainen man_argv[1] = t_strconcat("doveadm-", argv[1], NULL);
a3a55999bcfe2e57941cb64343f4ea80beabdab7Timo Sirainenstatic void cmd_config(int argc ATTR_UNUSED, char *argv[])
a3a55999bcfe2e57941cb64343f4ea80beabdab7Timo Sirainenstatic struct doveadm_cmd doveadm_cmd_config = {
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainendoveadm_try_run_multi_word(const struct doveadm_cmd *cmd,
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen unsigned int len;
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen /* more args */
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen return doveadm_try_run_multi_word(cmd, cmdname + len + 1,
acc039dfc0b0f4588cf2feec04727b61e1c672a1Timo Sirainenstatic bool doveadm_try_run(const char *cmd_name, int argc, char *argv[])
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen /* see if it matches a multi-word command */
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen if (strncmp(cmd->name, cmd_name, cmd_name_len) == 0 &&
542a32ee5f4ca72626ec93b6313f909811c01534Timo Sirainen const char *subcmd = cmd->name + cmd_name_len + 1;
4909421ac41e143fe07a235c0d11e9f0452d716bTimo Sirainen /* some doveadm plugins have dependencies to mail plugins. we can load
4909421ac41e143fe07a235c0d11e9f0452d716bTimo Sirainen only those whose dependencies have been loaded earlier, the rest are
4909421ac41e143fe07a235c0d11e9f0452d716bTimo Sirainen mod_set.version = master_service_get_version_string(master_service);
78ab753927acf4466f38e4a50694be3f4c4cc9abTimo Sirainen mod_set.ignore_dlopen_errors = !doveadm_debug;
4909421ac41e143fe07a235c0d11e9f0452d716bTimo Sirainen modules = module_dir_load_missing(modules, DOVEADM_MODULEDIR,
968b2f633b7405bc2cf0596d04762994ceb279d0Timo Sirainen static const struct setting_parser_info *set_roots[] = {
968b2f633b7405bc2cf0596d04762994ceb279d0Timo Sirainen if (master_service_settings_read(master_service, &input,
968b2f633b7405bc2cf0596d04762994ceb279d0Timo Sirainen i_fatal("Error reading configuration: %s", error);
968b2f633b7405bc2cf0596d04762994ceb279d0Timo Sirainen doveadm_settings = master_service_settings_get_others(master_service)[0];
ff3337516aad9843599905aeeb29812ea67c09d1Timo Sirainenstatic struct doveadm_cmd *doveadm_commands[] = {
ff3337516aad9843599905aeeb29812ea67c09d1Timo Sirainen unsigned int i;
5296198635718c9bf5b2f972c9d5be52092d3d58Timo Sirainen /* "+" is GNU extension to stop at the first non-option.
5296198635718c9bf5b2f972c9d5be52092d3d58Timo Sirainen others just accept -+ option. */
a672f99363d5f37060c1331d00d2ee3c4626310fTimo Sirainen master_service = master_service_init("doveadm", service_flags,
5296198635718c9bf5b2f972c9d5be52092d3d58Timo Sirainen while ((c = master_getopt(master_service)) > 0) {
4a26584a87ee0e986d23a224b3b3e85c44254d7fTimo Sirainen if (cmd_name != NULL && strcmp(cmd_name, "help") == 0 &&
4a26584a87ee0e986d23a224b3b3e85c44254d7fTimo Sirainen /* "help cmd" doesn't need any configuration */
ff3337516aad9843599905aeeb29812ea67c09d1Timo Sirainen for (i = 0; i < N_ELEMENTS(doveadm_commands); i++)
a2857829c642e2671779576b00c37b7d04693731Timo Sirainen /* special case commands: even if there is something wrong
a2857829c642e2671779576b00c37b7d04693731Timo Sirainen with the config (e.g. mail_plugins), don't fail these
a2857829c642e2671779576b00c37b7d04693731Timo Sirainen /* show usage after registering all plugins */
1d5dbb87f3485544db62896e2d56c663cb728c17Timo Sirainen /* for subcommands allow -options anywhere in command line */
aee3e2f7ab2b27572a90b9e7fd8fe60f13c6637eTimo Sirainen /* disable debugging unless -D is given */
bd417d416988d11a6b555b9aa57779e7ed976951Timo Sirainen !doveadm_mail_try_run(cmd_name, argc, argv)) {
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen i_fatal("Unknown command '%s', but plugin %s exists. "
10515cb90514b169ab6c3693c72c4bf1017476dbTimo Sirainen "Try to set mail_plugins=%s",