1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* 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"
#include "lua/lua_common.h"
static gboolean json = FALSE;
static gboolean compact = FALSE;
extern struct rspamd_main *rspamd_main;
/* Defined in modules.c */
extern module_t *modules[];
extern worker_t *workers[];
static void rspamadm_confighelp (gint argc, gchar **argv);
static const char *rspamadm_confighelp_help (gboolean full_help);
struct rspamadm_command confighelp_command = {
.name = "confighelp",
.flags = 0,
.help = rspamadm_confighelp_help,
.run = rspamadm_confighelp
};
static GOptionEntry entries[] = {
{"json", 'j', 0, G_OPTION_ARG_NONE, &json,
"Output json", NULL},
{"compact", 'c', 0, G_OPTION_ARG_NONE, &compact,
"Output compacted", NULL},
{NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL, NULL}
};
static const char *
rspamadm_confighelp_help (gboolean full_help)
{
const char *help_str;
if (full_help) {
help_str = "Shows help for the specified configuration options\n\n"
"Usage: rspamadm confighelp [option[, option...]]\n"
"Where options are:\n\n"
"--help: shows available options and commands";
}
else {
help_str = "Shows help for configuration options";
}
return help_str;
}
static void
rspamadm_confighelp_show (const char *key, const ucl_object_t *obj)
{
rspamd_fstring_t *out;
out = rspamd_fstring_new ();
if (json) {
rspamd_ucl_emit_fstring (obj, UCL_EMIT_JSON, &out);
}
else if (compact) {
rspamd_ucl_emit_fstring (obj, UCL_EMIT_JSON_COMPACT, &out);
}
else {
/* TODO: add lua helper for output */
if (key) {
rspamd_fprintf (stdout, "Showing help for %s:\n", key);
}
else {
rspamd_fprintf (stdout, "Showing help for all options:\n");
}
rspamd_ucl_emit_fstring (obj, UCL_EMIT_CONFIG, &out);
}
rspamd_fprintf (stdout, "%V", out);
rspamd_fprintf (stdout, "\n");
rspamd_fstring_free (out);
}
static void
rspamadm_confighelp (gint argc, gchar **argv)
{
struct rspamd_rcl_section *top;
struct rspamd_config *cfg;
const ucl_object_t *doc_obj;
GOptionContext *context;
GError *error = NULL;
module_t *mod, **pmod;
worker_t **pworker;
struct module_ctx *mod_ctx;
gint i = 1, ret = 0;
context = g_option_context_new (
"confighelp - displays help for the configuration options");
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);
g_option_context_set_ignore_unknown_options (context, TRUE);
if (!g_option_context_parse (context, &argc, &argv, &error)) {
rspamd_fprintf (stderr, "option parsing failed: %s\n", error->message);
g_error_free (error);
exit (1);
}
cfg = rspamd_config_new ();
cfg->compiled_modules = modules;
cfg->compiled_workers = workers;
top = rspamd_rcl_config_init (cfg);
/* Init modules to get documentation strings */
for (pmod = cfg->compiled_modules; pmod != NULL && *pmod != NULL; pmod++) {
mod = *pmod;
mod_ctx = g_slice_alloc0 (sizeof (struct module_ctx));
if (mod->module_init_func (cfg, &mod_ctx) == 0) {
g_hash_table_insert (cfg->c_modules,
(gpointer) mod->name,
mod_ctx);
mod_ctx->mod = mod;
}
}
/* Also init all workers */
for (pworker = cfg->compiled_workers; *pworker != NULL; pworker ++) {
(*pworker)->worker_init_func (cfg);
}
if (argc > 1) {
while (argc > 1) {
if (argv[i][0] != '-') {
doc_obj = ucl_lookup_path (cfg->doc_strings, argv[i]);
if (doc_obj != NULL) {
rspamadm_confighelp_show (argv[i], doc_obj);
}
else {
rspamd_fprintf (stderr,
"Cannot find help for %s\n",
argv[i]);
ret = EXIT_FAILURE;
}
}
i++;
argc--;
}
}
else {
/* Show all documentation strings */
rspamadm_confighelp_show (NULL, cfg->doc_strings);
}
rspamd_config_free (cfg);
exit (ret);
}
|
