3 * - useful general-purpose resolver client program
4 * option handling tables etc.
8 * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
10 * It is part of adns, which is
11 * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
12 * Copyright (C) 1999 Tony Finch <dot@dotat.at>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
31 int ov_env=1, ov_pipe=0, ov_asynch=0;
33 adns_rrtype ov_type= adns_r_none;
34 int ov_search=0, ov_qc_query=0, ov_qc_anshost=0, ov_qc_cname=1;
35 int ov_tcp=0, ov_cname=0, ov_format=fmt_default;
37 struct perqueryflags_remember ov_pqfr = { 1,1,1, tm_none };
39 static const struct optioninfo global_options[]= {
40 { ot_desconly, "global binary options:" },
41 { ot_flag, "Do not look at environment variables at all",
42 "e", "env", &ov_env, 0 },
43 { ot_flag, "Read queries on stdin instead of using args",
44 "f", "pipe", &ov_pipe, 1 },
45 { ot_flag, "Allow answers to be reordered",
46 "a", "asynch", &ov_asynch, 1 },
48 { ot_desconly, "answer/error output format and destination (see below):" },
49 { ot_value, "Answers to stdout, errors as messages to stderr (default)",
50 "Fs", "fmt-simple", &ov_format, fmt_simple },
51 { ot_value, "Answers and errors both to stdout in parseable format",
52 "Fi", "fmt-inline", &ov_format, fmt_inline },
53 { ot_value, "Fully-parseable output format (default for --asynch)",
54 "Fa", "fmt-asynch", &ov_format, fmt_asynch },
56 { ot_desconly, "global verbosity level:" },
57 { ot_value, "Do not print anything to stderr",
58 "Vq", "quiet", &ov_verbose, adns_if_noerrprint },
59 { ot_value, "Report unexpected kinds of problem only (default)",
60 "Vn", "no-quiet", &ov_verbose, 0 },
61 { ot_value, "Debugging mode",
62 "Vd", "debug", &ov_verbose, adns_if_debug },
64 { ot_desconly, "other global options:" },
65 { ot_func, "Print usage information",
66 0, "help", 0,0, of_help },
71 static const struct optioninfo perquery_options[]= {
72 { ot_desconly, "per-query options:" },
73 { ot_funcarg, "Query type (see below)",
74 "t", "type", 0,0, &of_type, "type" },
75 { ot_funcarg, "Do reverse query (address -> name lookup)",
76 "i", "ptr", 0,0, &of_ptr, "addr" },
78 { ot_desconly, "per-query binary options:" },
79 { ot_flag, "Use the search list",
80 "s", "search", &ov_search, 1 },
81 { ot_flag, "Let query domains contain quote-requiring chars",
82 "Qq", "qc-query", &ov_qc_query, 1 },
83 { ot_flag, "Let hostnames in answers contain ...",
84 "Qa", "qc-anshost", &ov_qc_anshost, 1 },
85 { ot_flag, "Prevent CNAME target domains from containing ...",
86 "Qc", "qc-cname", &ov_qc_cname, 0 },
87 { ot_flag, "Force use of a virtual circuit",
88 "u", "tcp", &ov_tcp, 1 },
89 { ot_flag, "Do not display owner name in output",
90 "Do", "show-owner", &ov_pqfr.show_owner, 0 },
91 { ot_flag, "Do not display RR type in output",
92 "Dt", "show-type", &ov_pqfr.show_type, 0 },
93 { ot_flag, "Do not display CNAME target in output",
94 "Dc", "show-cname", &ov_pqfr.show_cname, 0 },
96 { ot_desconly, "per-query TTL mode (NB TTL is minimum across all info in reply):" },
97 { ot_value, "Show the TTL as a TTL",
98 "Tt", "ttl-ttl", &ov_pqfr.ttl, tm_rel },
99 { ot_value, "Show the TTL as a time_t when the data might expire",
100 "Ta", "ttl-abs", &ov_pqfr.ttl, tm_abs },
101 { ot_value, "Do not show the TTL (default)",
102 "Tn", "no-ttl", &ov_pqfr.ttl, tm_none },
104 { ot_desconly, "per-query CNAME handling mode:" },
105 { ot_value, "Call it an error if a CNAME is found",
106 "Cf", "cname-reject", &ov_cname, adns_qf_cname_forbid },
107 { ot_value, "Allow references to CNAMEs in other RRs",
108 "Cl", "cname-loose", &ov_cname, adns_qf_cname_loose },
109 { ot_value, "CNAME ok for query domain, but not in RRs (default)",
110 "Cs", "cname-ok", &ov_cname, 0 },
112 { ot_desconly, "asynchronous/pipe mode options:" },
113 { ot_funcarg, "Set <id>, default is decimal sequence starting 0",
114 0, "asynch-id", 0,0, &of_asynch_id, "id" },
115 { ot_funcarg, "Cancel the query with id <id> (no error if not found)",
116 0, "cancel-id", 0,0, &of_cancel_id, "id" },
121 static void printusage(void) {
122 static const struct optioninfo *const all_optiontables[]= {
123 global_options, perquery_options, 0
126 const struct optioninfo *const *oiap, *oip=0;
127 int maxsopt, maxlopt, l;
131 for (oiap=all_optiontables; *oiap; oiap++) {
132 for (oip=*oiap; oip->type != ot_end; oip++) {
133 if (oip->type == ot_funcarg) continue;
134 if (oip->sopt) { l= strlen(oip->sopt); if (l>maxsopt) maxsopt= l; }
136 l= strlen(oip->lopt);
137 if (oip->type == ot_flag && !oip->value) l+= 3;
138 if (l>maxlopt) maxlopt= l;
143 fputs("usage: adnshost [global-opts] [query-opts] query-domain\n"
144 " [[query-opts] query-domain ...]\n"
145 " adnshost [global-opts] [query-opts] -f|--pipe\n",
148 for (oiap=all_optiontables; *oiap; oiap++) {
150 for (oip=*oiap; oip->type != ot_end; oip++) {
155 printf(" +%-*s --no-%-*s %s\n",
157 maxlopt-2, oip->lopt,
160 printf(" --no-%-*s %s\n",
161 maxlopt+maxsopt+1, oip->lopt,
166 case ot_value: case ot_func: /* fall through */
168 printf(" -%-*s --%-*s %s\n",
170 maxlopt+1, oip->lopt,
173 printf(" --%-*s %s\n",
174 maxlopt+maxsopt+3, oip->lopt,
180 l= (maxlopt + maxsopt - 9 -
181 (strlen(oip->sopt) + strlen(oip->lopt) + 2*strlen(oip->argdesc)));
182 printf(" -%s<%s> / --%s <%s>%*s%s\n",
183 oip->sopt, oip->argdesc, oip->lopt, oip->argdesc,
187 l= (maxlopt + maxsopt + 1 -
188 (strlen(oip->lopt) + strlen(oip->argdesc)));
189 printf(" --%s <%s>%*s%s\n",
190 oip->lopt, oip->argdesc,
196 printf("%s\n", oip->desc);
204 printf("\nEscaping domains which might start with `-':\n"
205 " - %-*s Next argument is a domain, but more options may follow\n",
206 maxlopt+maxsopt+3, "<domain>");
209 "Query domains should always be quoted according to master file format.\n"
211 "For binary options, --FOO and --no-FOO are opposites, as are\n"
212 "-X and +X. In each case the default is the one not listed.\n"
213 "Per query options stay set a particular way until they are reset,\n"
214 "whether they appear on the command line or on stdin.\n"
215 "All global options must preceed the first query domain.\n"
217 "With -f, the input should be lines with either an option, possibly\n"
218 "with a value argument (separated from the option by a space if it's a long\n"
219 "option), or a domain (possibly preceded by a hyphen and a space to\n"
220 "distinguish it from an option).\n"
222 "Output format is master file format without class or TTL by default:\n"
223 " [<owner>] [<ttl>] [<type>] <data>\n"
224 "or if the <owner> domain refers to a CNAME and --show-cname is on\n"
225 " [<owner>] [<ttl>] CNAME <cname>\n"
226 " [<cname>] [<ttl>] <type> <data>\n"
227 "When a query fails you get an error message to stderr (with --fmt-simple).\n"
228 "Specify --fmt-inline for lines like this (broken here for readability):\n"
229 " ; failed <statustype> <statusnum> <statusabbrev> \\\n"
230 " [<owner>] [<ttl>] [<cname>] \"<status string>\"\n"
231 "If you use --fmt-asynch, which is the default for --asynch,\n"
232 "each answer (success or failure) is preceded by a line\n"
233 " <id> <nrrs> <statustype> <statusnum> <statusabbrev> \\\n"
234 " [<owner>] [<ttl>] [<cname>] \"<status string>\"\n"
235 "where <nrrs> is the number of RRs that follow and <cname> will be `$' or\n"
236 "the CNAME target; the CNAME indirection and error formats above are not used.\n"
240 " 1-6 at least one query failed with statustype:\n"
242 " 2 remotefail ) temporary errors\n"
243 " 3 tempfail __)_________________\n"
245 " 5 misquery ) permanent errors\n"
247 " 10 system trouble\n"
248 " 11 usage problems\n"
250 "Query types (see adns.h; default is addr):\n"
251 " ns soa ptr mx rp addr - enhanced versions\n"
252 " cname hinfo txt - types with only one version\n"
253 " a ns- soa- ptr- mx- rp- - _raw versions\n"
254 "Default is addr, or ptr for -i/--ptr queries\n",
256 if (ferror(stdout)) sysfail("write usage message",errno);
259 void of_help(const struct optioninfo *oi, const char *arg) {
261 if (fclose(stdout)) sysfail("finish writing output",errno);
265 typedef int comparer_type(const char **optp, const struct optioninfo *entry);
267 static int oc_long(const char **optp, const struct optioninfo *entry) {
268 return entry->lopt && !strcmp(*optp,entry->lopt);
271 static int oc_short(const char **optp, const struct optioninfo *entry) {
278 if (memcmp(*optp,sopt,l)) return 0;
283 static const struct optioninfo *find1(const char **optp,
284 const struct optioninfo *table,
285 comparer_type *comparer) {
287 if (table->type == ot_end) return 0;
288 if (comparer(optp,table)) return table;
293 static const struct optioninfo *find(const char **optp,
295 comparer_type *comparer) {
296 const struct optioninfo *oip;
300 oip= find1(optp,perquery_options,comparer);
302 oip= find1(optp,global_options,comparer);
303 if (!oip) usageerr("unknown option %s%s",prefix,opt);
304 if (ads) usageerr("global option %s%s specified after query domain(s)",prefix,opt);
308 const struct optioninfo *opt_findl(const char *opt) { return find(&opt,"--",oc_long); }
309 const struct optioninfo *opt_finds(const char **optp) { return find(optp,"-",oc_short); }
311 static void noninvert(const struct optioninfo *oip) NONRETURNING;
312 static void noninvert(const struct optioninfo *oip) {
313 usageerr("option %s%s%s%s%s may not be inverted",
314 oip->sopt ? "-" : "", oip->sopt ? oip->sopt : "",
315 oip->lopt && oip->sopt ? " / " : "",
316 oip->lopt ? "--" : "", oip->lopt ? oip->lopt : "");
319 void opt_do(const struct optioninfo *oip, const char *arg, int invert) {
323 *oip->storep= !invert;
327 if (invert) noninvert(oip);
328 *oip->storep= oip->value;
330 case ot_func: case ot_funcarg:
331 if (invert) noninvert(oip);