From e591a7ea0f223a845ea70fe8b514dad9fb7e0606 Mon Sep 17 00:00:00 2001 From: Vsevolod Stakhov Date: Mon, 5 Oct 2015 12:38:44 +0100 Subject: [PATCH] Add configdump routine. --- src/rspamadm/CMakeLists.txt | 2 +- src/rspamadm/commands.c | 2 + src/rspamadm/configdump.c | 191 ++++++++++++++++++++++++++++++++++++ 3 files changed, 194 insertions(+), 1 deletion(-) create mode 100644 src/rspamadm/configdump.c diff --git a/src/rspamadm/CMakeLists.txt b/src/rspamadm/CMakeLists.txt index 336ffd156..13e0dc477 100644 --- a/src/rspamadm/CMakeLists.txt +++ b/src/rspamadm/CMakeLists.txt @@ -6,7 +6,7 @@ SET(RSPAMADMSRC rspamadm.c commands.c pw.c keypair.c configtest.c ${CMAKE_SOURCE_DIR}/src/lua_worker.c ${CMAKE_SOURCE_DIR}/src/smtp_proxy.c ${CMAKE_SOURCE_DIR}/src/worker.c - ${CMAKE_SOURCE_DIR}/src/http_proxy.c fuzzy_merge.c) + ${CMAKE_SOURCE_DIR}/src/http_proxy.c fuzzy_merge.c configdump.c) ADD_EXECUTABLE(rspamadm ${RSPAMADMSRC}) TARGET_LINK_LIBRARIES(rspamadm rspamd-server) diff --git a/src/rspamadm/commands.c b/src/rspamadm/commands.c index 8df1c9ed8..aa0302eb9 100644 --- a/src/rspamadm/commands.c +++ b/src/rspamadm/commands.c @@ -27,6 +27,7 @@ extern struct rspamadm_command pw_command; extern struct rspamadm_command keypair_command; extern struct rspamadm_command configtest_command; extern struct rspamadm_command fuzzy_merge_command; +extern struct rspamadm_command configdump_command; const struct rspamadm_command *commands[] = { &help_command, @@ -34,6 +35,7 @@ const struct rspamadm_command *commands[] = { &keypair_command, &configtest_command, &fuzzy_merge_command, + &configdump_command, NULL }; diff --git a/src/rspamadm/configdump.c b/src/rspamadm/configdump.c new file mode 100644 index 000000000..59ffabbd6 --- /dev/null +++ b/src/rspamadm/configdump.c @@ -0,0 +1,191 @@ +/* + * Copyright (c) 2015, Vsevolod Stakhov + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY AUTHOR ''AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include "config.h" +#include "rspamadm.h" +#include "cfg_file.h" +#include "cfg_rcl.h" +#include "rspamd.h" + +static gboolean json = FALSE; +static gboolean compact = FALSE; +static gchar *config = NULL; +extern struct rspamd_main *rspamd_main; +/* Defined in modules.c */ +extern module_t *modules[]; +extern worker_t *workers[]; + +static void rspamadm_configdump (gint argc, gchar **argv); +static const char *rspamadm_configdump_help (gboolean full_help); + +struct rspamadm_command configdump_command = { + .name = "configdump", + .flags = 0, + .help = rspamadm_configdump_help, + .run = rspamadm_configdump +}; + +static GOptionEntry entries[] = { + {"json", 'j', 0, G_OPTION_ARG_NONE, &json, + "Json output (pretty formatted)", NULL}, + {"compact", 'C', 0, G_OPTION_ARG_NONE, &compact, + "Compacted json output", NULL}, + {"config", 'c', 0, G_OPTION_ARG_STRING, &config, + "Config file to test", NULL}, + {NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL, NULL} +}; + +static const char * +rspamadm_configdump_help (gboolean full_help) +{ + const char *help_str; + + if (full_help) { + help_str = "Perform configuration file dump\n\n" + "Usage: rspamadm configdump [-c -j --compact]\n" + "Where options are:\n\n" + "-j: output plain json\n" + "--compact: output compacted json\n" + "-c: config file to test\n" + "--help: shows available options and commands"; + } + else { + help_str = "Perform configuration file dump"; + } + + return help_str; +} + +static void +config_logger (rspamd_mempool_t *pool, gpointer ud) +{ + struct rspamd_main *rm = ud; + + rm->cfg->log_type = RSPAMD_LOG_CONSOLE; + rm->cfg->log_level = G_LOG_LEVEL_CRITICAL; + + rspamd_set_logger (rm->cfg, g_quark_try_string ("main"), rm); + if (rspamd_log_open_priv (rm->logger, rm->workers_uid, rm->workers_gid) == + -1) { + fprintf (stderr, "Fatal error, cannot open logfile, exiting\n"); + exit (EXIT_FAILURE); + } +} + +static void +rspamadm_configdump (gint argc, gchar **argv) +{ + GOptionContext *context; + GError *error = NULL; + const gchar *confdir; + struct rspamd_config *cfg = rspamd_main->cfg; + gboolean ret = FALSE; + worker_t **pworker; + GString *output; + + context = g_option_context_new ( + "keypair - create encryption keys"); + g_option_context_set_summary (context, + "Summary:\n Rspamd administration utility version " + RVERSION + "\n Release id: " + RID); + g_option_context_add_main_entries (context, entries, NULL); + + if (!g_option_context_parse (context, &argc, &argv, &error)) { + fprintf (stderr, "option parsing failed: %s\n", error->message); + g_error_free (error); + exit (1); + } + + if (config == NULL) { + if ((confdir = g_hash_table_lookup (ucl_vars, "CONFDIR")) == NULL) { + confdir = RSPAMD_CONFDIR; + } + + config = g_strdup_printf ("%s%c%s", confdir, G_DIR_SEPARATOR, + "rspamd.conf"); + } + + pworker = &workers[0]; + while (*pworker) { + /* Init string quarks */ + (void) g_quark_from_static_string ((*pworker)->name); + pworker++; + } + cfg->cache = rspamd_symbols_cache_new (cfg); + cfg->compiled_modules = modules; + cfg->compiled_workers = workers; + cfg->cfg_name = config; + + if (!rspamd_config_read (cfg, cfg->cfg_name, NULL, + config_logger, rspamd_main, ucl_vars)) { + ret = FALSE; + } + else { + /* Do post-load actions */ + rspamd_config_post_load (cfg); + ret = TRUE; + } + + if (ret) { + rspamd_symbols_cache_init (rspamd_main->cfg->cache); + + if (!rspamd_init_filters (rspamd_main->cfg, FALSE)) { + ret = FALSE; + } + + /* Insert classifiers symbols */ + (void) rspamd_config_insert_classify_symbols (rspamd_main->cfg); + + if (!rspamd_symbols_cache_validate (rspamd_main->cfg->cache, + rspamd_main->cfg, + FALSE)) { + ret = FALSE; + } + } + + if (ret) { + /* Output configuration */ + output = g_string_new (""); + + if (json) { + rspamd_ucl_emit_gstring (cfg->rcl_obj, UCL_EMIT_JSON, output); + } + else if (compact) { + rspamd_ucl_emit_gstring (cfg->rcl_obj, UCL_EMIT_JSON_COMPACT, output); + } + else { + rspamd_ucl_emit_gstring (cfg->rcl_obj, UCL_EMIT_CONFIG, output); + } + + rspamd_printf ("%v", output); + + g_string_free (output, TRUE); + } + + if (!ret) { + exit (EXIT_FAILURE); + } +} -- 2.39.5