Andy Hood points out that `#ifdef MONITOR_DEFAULTTONEAREST' would
[u/mdw/putty] / cmdline.c
CommitLineData
dfe3332b 1#include <stdio.h>
2#include <assert.h>
3#include <stdlib.h>
4#include "putty.h"
5
6/*
7 * Some command-line parameters need to be saved up until after
8 * we've loaded the saved session which will form the basis of our
9 * eventual running configuration. For this we use the macro
10 * SAVEABLE, which notices if the `need_save' parameter is set and
11 * saves the parameter and value on a list.
12 *
13 * We also assign priorities to saved parameters, just to slightly
14 * ameliorate silly ordering problems. For example, if you specify
15 * a saved session to load, it will be loaded _before_ all your
16 * local modifications such as -L are evaluated; and if you specify
17 * a protocol and a port, the protocol is set up first so that the
18 * port can override its choice of port number.
c725e24c 19 *
20 * (In fact -load is not saved at all, since in at least Plink the
21 * processing of further command-line options depends on whether or
22 * not the loaded session contained a hostname. So it must be
23 * executed immediately.)
dfe3332b 24 */
25
c725e24c 26#define NPRIORITIES 2
dfe3332b 27
28struct cmdline_saved_param {
29 char *p, *value;
30};
31struct cmdline_saved_param_set {
32 struct cmdline_saved_param *params;
33 int nsaved, savesize;
34};
35
36/*
37 * C guarantees this structure will be initialised to all zero at
38 * program start, which is exactly what we want.
39 */
40static struct cmdline_saved_param_set saves[NPRIORITIES];
41
42static void cmdline_save_param(char *p, char *value, int pri)
43{
44 if (saves[pri].nsaved >= saves[pri].savesize) {
45 saves[pri].savesize = saves[pri].nsaved + 32;
3d88e64d 46 saves[pri].params = sresize(saves[pri].params, saves[pri].savesize,
47 struct cmdline_saved_param);
dfe3332b 48 }
49 saves[pri].params[saves[pri].nsaved].p = p;
50 saves[pri].params[saves[pri].nsaved].value = value;
51 saves[pri].nsaved++;
52}
53
54#define SAVEABLE(pri) do { \
55 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
56} while (0)
57
58char *cmdline_password = NULL;
59
60static int cmdline_get_line(const char *prompt, char *str,
61 int maxlen, int is_pw)
62{
63 static int tried_once = 0;
64
65 assert(is_pw && cmdline_password);
66
67 if (tried_once) {
68 return 0;
69 } else {
70 strncpy(str, cmdline_password, maxlen);
71 str[maxlen - 1] = '\0';
72 tried_once = 1;
73 return 1;
74 }
75}
76
77/*
78 * Here we have a flags word which describes the capabilities of
79 * the particular tool on whose behalf we're running. We will
80 * refuse certain command-line options if a particular tool
81 * inherently can't do anything sensible. For example, the file
82 * transfer tools (psftp, pscp) can't do a great deal with protocol
83 * selections (ever tried running scp over telnet?) or with port
84 * forwarding (even if it wasn't a hideously bad idea, they don't
85 * have the select() infrastructure to make them work).
86 */
87int cmdline_tooltype = 0;
88
89static int cmdline_check_unavailable(int flag, char *p)
90{
91 if (cmdline_tooltype & flag) {
92 cmdline_error("option \"%s\" not available in this tool", p);
93 return 1;
94 }
95 return 0;
96}
97
98#define UNAVAILABLE_IN(flag) do { \
99 if (cmdline_check_unavailable(flag, p)) return ret; \
100} while (0)
101
102/*
103 * Process a standard command-line parameter. `p' is the parameter
104 * in question; `value' is the subsequent element of argv, which
105 * may or may not be required as an operand to the parameter.
106 * Return value is 2 if both arguments were used; 1 if only p was
107 * used; 0 if the parameter wasn't one we recognised; -2 if it
108 * should have been 2 but value was NULL.
109 */
110
111#define RETURN(x) do { \
112 if ((x) == 2 && !value) return -2; \
113 ret = x; \
46a3419b 114 if (need_save < 0) return x; \
dfe3332b 115} while (0)
116
5555d393 117int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
dfe3332b 118{
119 int ret = 0;
120
121 if (!strcmp(p, "-load")) {
122 RETURN(2);
c725e24c 123 /* This parameter must be processed immediately rather than being
124 * saved. */
5555d393 125 do_defaults(value, cfg);
dfe3332b 126 return 2;
127 }
128 if (!strcmp(p, "-ssh")) {
129 RETURN(1);
46a3419b 130 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 131 SAVEABLE(0);
5555d393 132 default_protocol = cfg->protocol = PROT_SSH;
133 default_port = cfg->port = 22;
dfe3332b 134 return 1;
135 }
136 if (!strcmp(p, "-telnet")) {
137 RETURN(1);
46a3419b 138 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 139 SAVEABLE(0);
5555d393 140 default_protocol = cfg->protocol = PROT_TELNET;
141 default_port = cfg->port = 23;
dfe3332b 142 return 1;
143 }
144 if (!strcmp(p, "-rlogin")) {
145 RETURN(1);
46a3419b 146 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 147 SAVEABLE(0);
5555d393 148 default_protocol = cfg->protocol = PROT_RLOGIN;
149 default_port = cfg->port = 513;
dfe3332b 150 return 1;
151 }
152 if (!strcmp(p, "-raw")) {
153 RETURN(1);
46a3419b 154 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 155 SAVEABLE(0);
5555d393 156 default_protocol = cfg->protocol = PROT_RAW;
dfe3332b 157 }
158 if (!strcmp(p, "-v")) {
159 RETURN(1);
160 flags |= FLAG_VERBOSE;
161 }
162 if (!strcmp(p, "-l")) {
163 RETURN(2);
46a3419b 164 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 165 SAVEABLE(0);
5555d393 166 strncpy(cfg->username, value, sizeof(cfg->username));
167 cfg->username[sizeof(cfg->username) - 1] = '\0';
dfe3332b 168 }
820ebe3b 169 if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
6ee9b735 170 char *fwd, *ptr, *q, *qq;
820ebe3b 171 int dynamic, i=0;
dfe3332b 172 RETURN(2);
46a3419b 173 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 174 SAVEABLE(0);
820ebe3b 175 dynamic = !strcmp(p, "-D");
dfe3332b 176 fwd = value;
5555d393 177 ptr = cfg->portfwd;
dfe3332b 178 /* if multiple forwards, find end of list */
820ebe3b 179 if (ptr[0]=='R' || ptr[0]=='L' || ptr[0] == 'D') {
5555d393 180 for (i = 0; i < sizeof(cfg->portfwd) - 2; i++)
dfe3332b 181 if (ptr[i]=='\000' && ptr[i+1]=='\000')
182 break;
183 ptr = ptr + i + 1; /* point to next forward slot */
184 }
820ebe3b 185 ptr[0] = p[1]; /* insert a 'L', 'R' or 'D' at the start */
5555d393 186 if (strlen(fwd) > sizeof(cfg->portfwd) - i - 2) {
dfe3332b 187 cmdline_error("out of space for port forwardings");
188 return ret;
189 }
5555d393 190 strncpy(ptr+1, fwd, sizeof(cfg->portfwd) - i);
820ebe3b 191 if (!dynamic) {
192 /*
193 * We expect _at least_ two colons in this string. The
194 * possible formats are `sourceport:desthost:destport',
195 * or `sourceip:sourceport:desthost:destport' if you're
196 * specifying a particular loopback address. We need to
197 * replace the one between source and dest with a \t;
198 * this means we must find the second-to-last colon in
199 * the string.
200 */
201 q = qq = strchr(ptr, ':');
202 while (qq) {
203 char *qqq = strchr(qq+1, ':');
204 if (qqq)
205 q = qq;
206 qq = qqq;
207 }
208 if (q) *q = '\t'; /* replace second-last colon with \t */
6ee9b735 209 }
5555d393 210 cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
211 cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
dfe3332b 212 ptr[strlen(ptr)+1] = '\000'; /* append two '\000' */
213 }
214 if (!strcmp(p, "-m")) {
215 char *filename, *command;
216 int cmdlen, cmdsize;
217 FILE *fp;
218 int c, d;
219
220 RETURN(2);
46a3419b 221 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 222 SAVEABLE(0);
dfe3332b 223
224 filename = value;
225
226 cmdlen = cmdsize = 0;
227 command = NULL;
228 fp = fopen(filename, "r");
229 if (!fp) {
230 cmdline_error("unable to open command "
231 "file \"%s\"", filename);
232 return ret;
233 }
234 do {
235 c = fgetc(fp);
236 d = c;
237 if (c == EOF)
238 d = 0;
239 if (cmdlen >= cmdsize) {
240 cmdsize = cmdlen + 512;
3d88e64d 241 command = sresize(command, cmdsize, char);
dfe3332b 242 }
243 command[cmdlen++] = d;
244 } while (c != EOF);
5555d393 245 cfg->remote_cmd_ptr = command;
246 cfg->remote_cmd_ptr2 = NULL;
247 cfg->nopty = TRUE; /* command => no terminal */
dfe3332b 248 }
249 if (!strcmp(p, "-P")) {
250 RETURN(2);
46a3419b 251 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 252 SAVEABLE(1); /* lower priority than -ssh,-telnet */
5555d393 253 cfg->port = atoi(value);
dfe3332b 254 }
255 if (!strcmp(p, "-pw")) {
256 RETURN(2);
46a3419b 257 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
dfe3332b 258 cmdline_password = value;
259 ssh_get_line = cmdline_get_line;
260 ssh_getline_pw_only = TRUE;
261 }
262
263 if (!strcmp(p, "-A")) {
264 RETURN(1);
46a3419b 265 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 266 SAVEABLE(0);
5555d393 267 cfg->agentfwd = 1;
dfe3332b 268 }
269 if (!strcmp(p, "-a")) {
270 RETURN(1);
46a3419b 271 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 272 SAVEABLE(0);
5555d393 273 cfg->agentfwd = 0;
dfe3332b 274 }
275
276 if (!strcmp(p, "-X")) {
277 RETURN(1);
46a3419b 278 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 279 SAVEABLE(0);
5555d393 280 cfg->x11_forward = 1;
dfe3332b 281 }
282 if (!strcmp(p, "-x")) {
283 RETURN(1);
46a3419b 284 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 285 SAVEABLE(0);
5555d393 286 cfg->x11_forward = 0;
dfe3332b 287 }
288
289 if (!strcmp(p, "-t")) {
290 RETURN(1);
46a3419b 291 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 292 SAVEABLE(0);
5555d393 293 cfg->nopty = 0;
dfe3332b 294 }
295 if (!strcmp(p, "-T")) {
296 RETURN(1);
46a3419b 297 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 298 SAVEABLE(0);
5555d393 299 cfg->nopty = 1;
dfe3332b 300 }
301
302 if (!strcmp(p, "-C")) {
303 RETURN(1);
46a3419b 304 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 305 SAVEABLE(0);
5555d393 306 cfg->compression = 1;
dfe3332b 307 }
308
309 if (!strcmp(p, "-1")) {
310 RETURN(1);
46a3419b 311 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 312 SAVEABLE(0);
5555d393 313 cfg->sshprot = 0; /* ssh protocol 1 only */
dfe3332b 314 }
315 if (!strcmp(p, "-2")) {
316 RETURN(1);
46a3419b 317 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 318 SAVEABLE(0);
5555d393 319 cfg->sshprot = 3; /* ssh protocol 2 only */
dfe3332b 320 }
321
322 if (!strcmp(p, "-i")) {
323 RETURN(2);
46a3419b 324 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 325 SAVEABLE(0);
9a30e26b 326 cfg->keyfile = filename_from_str(value);
dfe3332b 327 }
328
329 return ret; /* unrecognised */
330}
331
5555d393 332void cmdline_run_saved(Config *cfg)
dfe3332b 333{
334 int pri, i;
335 for (pri = 0; pri < NPRIORITIES; pri++)
336 for (i = 0; i < saves[pri].nsaved; i++)
337 cmdline_process_param(saves[pri].params[i].p,
5555d393 338 saves[pri].params[i].value, 0, cfg);
dfe3332b 339}