2 * winutils.c: miscellaneous Windows utilities for GUI apps
13 /* Definitions to allow this module to be compiled standalone for testing
14 * split_into_argv(). */
15 #define smalloc malloc
16 #define srealloc realloc
21 * GetOpenFileName/GetSaveFileName tend to muck around with the process'
22 * working directory on at least some versions of Windows.
23 * Here's a wrapper that gives more control over this, and hides a little
24 * bit of other grottiness.
32 * `of' is expected to be initialised with most interesting fields, but
33 * this function does some administrivia. (assume `of' was memset to 0)
34 * save==1 -> GetSaveFileName; save==0 -> GetOpenFileName
35 * `state' is optional.
37 BOOL
request_file(filereq
*state
, OPENFILENAME
*of
, int preserve
, int save
)
39 TCHAR cwd
[MAX_PATH
]; /* process CWD */
44 DWORD r
= GetCurrentDirectory(lenof(cwd
), cwd
);
45 if (r
== 0 || r
>= lenof(cwd
))
46 /* Didn't work, oh well. Stop trying to be clever. */
50 /* Open the file requester, maybe setting lpstrInitialDir */
52 #ifdef OPENFILENAME_SIZE_VERSION_400
53 of
->lStructSize
= OPENFILENAME_SIZE_VERSION_400
;
55 of
->lStructSize
= sizeof(*of
);
57 of
->lpstrInitialDir
= (state
&& state
->cwd
[0]) ? state
->cwd
: NULL
;
58 /* Actually put up the requester. */
59 ret
= save ?
GetSaveFileName(of
) : GetOpenFileName(of
);
62 /* Get CWD left by requester */
64 DWORD r
= GetCurrentDirectory(lenof(state
->cwd
), state
->cwd
);
65 if (r
== 0 || r
>= lenof(state
->cwd
))
66 /* Didn't work, oh well. */
70 /* Restore process CWD */
72 /* If it fails, there's not much we can do. */
73 (void) SetCurrentDirectory(cwd
);
78 filereq
*filereq_new(void)
80 filereq
*ret
= snew(filereq
);
85 void filereq_free(filereq
*state
)
91 * Message box with optional context help.
94 /* Callback function to launch context help. */
95 static VOID CALLBACK
message_box_help_callback(LPHELPINFO lpHelpInfo
)
98 #define CHECK_CTX(name) \
100 if (lpHelpInfo->dwContextId == WINHELP_CTXID_ ## name) \
101 context = WINHELP_CTX_ ## name; \
103 CHECK_CTX(errors_hostkey_absent
);
104 CHECK_CTX(errors_hostkey_changed
);
105 CHECK_CTX(errors_cantloadkey
);
106 CHECK_CTX(option_cleanup
);
107 CHECK_CTX(pgp_fingerprints
);
110 launch_help(hwnd
, context
);
113 int message_box(LPCTSTR text
, LPCTSTR caption
, DWORD style
, DWORD helpctxid
)
118 * We use MessageBoxIndirect() because it allows us to specify a
119 * callback function for the Help button.
121 mbox
.cbSize
= sizeof(mbox
);
122 /* Assumes the globals `hinst' and `hwnd' have sensible values. */
123 mbox
.hInstance
= hinst
;
124 mbox
.hwndOwner
= hwnd
;
125 mbox
.lpfnMsgBoxCallback
= &message_box_help_callback
;
126 mbox
.dwLanguageId
= LANG_NEUTRAL
;
127 mbox
.lpszText
= text
;
128 mbox
.lpszCaption
= caption
;
129 mbox
.dwContextHelpId
= helpctxid
;
130 mbox
.dwStyle
= style
;
131 if (helpctxid
!= 0 && has_help()) mbox
.dwStyle
|= MB_HELP
;
132 return MessageBoxIndirect(&mbox
);
136 * Display the fingerprints of the PGP Master Keys to the user.
138 void pgp_fingerprints(void)
140 message_box("These are the fingerprints of the PuTTY PGP Master Keys. They can\n"
141 "be used to establish a trust path from this executable to another\n"
142 "one. See the manual for more information.\n"
143 "(Note: these fingerprints have nothing to do with SSH!)\n"
145 "PuTTY Master Key (RSA), 1024-bit:\n"
146 " " PGP_RSA_MASTER_KEY_FP
"\n"
147 "PuTTY Master Key (DSA), 1024-bit:\n"
148 " " PGP_DSA_MASTER_KEY_FP
,
149 "PGP fingerprints", MB_ICONINFORMATION
| MB_OK
,
150 HELPCTXID(pgp_fingerprints
));
154 * Split a complete command line into argc/argv, attempting to do
155 * it exactly the same way Windows itself would do it (so that
156 * console utilities, which receive argc and argv from Windows,
157 * will have their command lines processed in the same way as GUI
158 * utilities which get a whole command line and must break it
161 * Does not modify the input command line.
163 * The final parameter (argstart) is used to return a second array
164 * of char * pointers, the same length as argv, each one pointing
165 * at the start of the corresponding element of argv in the
166 * original command line. So if you get half way through processing
167 * your command line in argc/argv form and then decide you want to
168 * treat the rest as a raw string, you can. If you don't want to,
169 * `argstart' can be safely left NULL.
171 void split_into_argv(char *cmdline
, int *argc
, char ***argv
,
175 char *outputline
, *q
;
176 char **outputargv
, **outputargstart
;
180 * At first glance the rules appeared to be:
182 * - Single quotes are not special characters.
184 * - Double quotes are removed, but within them spaces cease
187 * - Backslashes are _only_ special when a sequence of them
188 * appear just before a double quote. In this situation,
189 * they are treated like C backslashes: so \" just gives a
190 * literal quote, \\" gives a literal backslash and then
191 * opens or closes a double-quoted segment, \\\" gives a
192 * literal backslash and then a literal quote, \\\\" gives
193 * two literal backslashes and then opens/closes a
194 * double-quoted segment, and so forth. Note that this
195 * behaviour is identical inside and outside double quotes.
197 * - Two successive double quotes become one literal double
198 * quote, but only _inside_ a double-quoted segment.
199 * Outside, they just form an empty double-quoted segment
200 * (which may cause an empty argument word).
202 * - That only leaves the interesting question of what happens
203 * when one or more backslashes precedes two or more double
204 * quotes, starting inside a double-quoted string. And the
205 * answer to that appears somewhat bizarre. Here I tabulate
206 * number of backslashes (across the top) against number of
207 * quotes (down the left), and indicate how many backslashes
208 * are output, how many quotes are output, and whether a
209 * quoted segment is open at the end of the sequence:
215 * 0 0,0,y | 1,0,y 2,0,y 3,0,y 4,0,y
216 * --------+-----------------------------
217 * 1 0,0,n | 0,1,y 1,0,n 1,1,y 2,0,n
218 * q 2 0,1,n | 0,1,n 1,1,n 1,1,n 2,1,n
219 * u 3 0,1,y | 0,2,n 1,1,y 1,2,n 2,1,y
220 * o 4 0,1,n | 0,2,y 1,1,n 1,2,y 2,1,n
221 * t 5 0,2,n | 0,2,n 1,2,n 1,2,n 2,2,n
222 * e 6 0,2,y | 0,3,n 1,2,y 1,3,n 2,2,y
223 * s 7 0,2,n | 0,3,y 1,2,n 1,3,y 2,2,n
224 * 8 0,3,n | 0,3,n 1,3,n 1,3,n 2,3,n
225 * 9 0,3,y | 0,4,n 1,3,y 1,4,n 2,3,y
226 * 10 0,3,n | 0,4,y 1,3,n 1,4,y 2,3,n
227 * 11 0,4,n | 0,4,n 1,4,n 1,4,n 2,4,n
230 * [Test fragment was of the form "a\\\"""b c" d.]
232 * There is very weird mod-3 behaviour going on here in the
233 * number of quotes, and it even applies when there aren't any
234 * backslashes! How ghastly.
236 * With a bit of thought, this extremely odd diagram suddenly
237 * coalesced itself into a coherent, if still ghastly, model of
240 * - As before, backslashes are only special when one or more
241 * of them appear contiguously before at least one double
242 * quote. In this situation the backslashes do exactly what
243 * you'd expect: each one quotes the next thing in front of
244 * it, so you end up with n/2 literal backslashes (if n is
245 * even) or (n-1)/2 literal backslashes and a literal quote
246 * (if n is odd). In the latter case the double quote
247 * character right after the backslashes is used up.
249 * - After that, any remaining double quotes are processed. A
250 * string of contiguous unescaped double quotes has a mod-3
253 * * inside a quoted segment, a quote ends the segment.
254 * * _immediately_ after ending a quoted segment, a quote
255 * simply produces a literal quote.
256 * * otherwise, outside a quoted segment, a quote begins a
259 * So, for example, if we started inside a quoted segment
260 * then two contiguous quotes would close the segment and
261 * produce a literal quote; three would close the segment,
262 * produce a literal quote, and open a new segment. If we
263 * started outside a quoted segment, then two contiguous
264 * quotes would open and then close a segment, producing no
265 * output (but potentially creating a zero-length argument);
266 * but three quotes would open and close a segment and then
267 * produce a literal quote.
271 * First deal with the simplest of all special cases: if there
272 * aren't any arguments, return 0,NULL,NULL.
274 while (*cmdline
&& isspace(*cmdline
)) cmdline
++;
277 if (argv
) *argv
= NULL
;
278 if (argstart
) *argstart
= NULL
;
283 * This will guaranteeably be big enough; we can realloc it
286 outputline
= snewn(1+strlen(cmdline
), char);
287 outputargv
= snewn(strlen(cmdline
)+1 / 2, char *);
288 outputargstart
= snewn(strlen(cmdline
)+1 / 2, char *);
290 p
= cmdline
; q
= outputline
; outputargc
= 0;
295 /* Skip whitespace searching for start of argument. */
296 while (*p
&& isspace(*p
)) p
++;
299 /* We have an argument; start it. */
300 outputargv
[outputargc
] = q
;
301 outputargstart
[outputargc
] = p
;
305 /* Copy data into the argument until it's finished. */
307 if (!quote
&& isspace(*p
))
308 break; /* argument is finished */
310 if (*p
== '"' || *p
== '\\') {
312 * We have a sequence of zero or more backslashes
313 * followed by a sequence of zero or more quotes.
314 * Count up how many of each, and then deal with
315 * them as appropriate.
317 int i
, slashes
= 0, quotes
= 0;
318 while (*p
== '\\') slashes
++, p
++;
319 while (*p
== '"') quotes
++, p
++;
323 * Special case: if there are no quotes,
324 * slashes are not special at all, so just copy
325 * n slashes to the output string.
327 while (slashes
--) *q
++ = '\\';
329 /* Slashes annihilate in pairs. */
330 while (slashes
>= 2) slashes
-= 2, *q
++ = '\\';
332 /* One remaining slash takes out the first quote. */
333 if (slashes
) quotes
--, *q
++ = '"';
336 /* Outside a quote segment, a quote starts one. */
337 if (!quote
) quotes
--, quote
= 1;
339 /* Now we produce (n+1)/3 literal quotes... */
340 for (i
= 3; i
<= quotes
+1; i
+= 3) *q
++ = '"';
342 /* ... and end in a quote segment iff 3 divides n. */
343 quote
= (quotes
% 3 == 0);
351 /* At the end of an argument, just append a trailing NUL. */
355 outputargv
= sresize(outputargv
, outputargc
, char *);
356 outputargstart
= sresize(outputargstart
, outputargc
, char *);
358 if (argc
) *argc
= outputargc
;
359 if (argv
) *argv
= outputargv
; else sfree(outputargv
);
360 if (argstart
) *argstart
= outputargstart
; else sfree(outputargstart
);
365 const struct argv_test
{
367 const char *argv
[10];
370 * We generate this set of tests by invoking ourself with
373 {"ab c\" d", {"ab", "c d", NULL
}},
374 {"a\"b c\" d", {"ab c", "d", NULL
}},
375 {"a\"\"b c\" d", {"ab", "c d", NULL
}},
376 {"a\"\"\"b c\" d", {"a\"b", "c d", NULL
}},
377 {"a\"\"\"\"b c\" d", {"a\"b c", "d", NULL
}},
378 {"a\"\"\"\"\"b c\" d", {"a\"b", "c d", NULL
}},
379 {"a\"\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
380 {"a\"\"\"\"\"\"\"b c\" d", {"a\"\"b c", "d", NULL
}},
381 {"a\"\"\"\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
382 {"a\\b c\" d", {"a\\b", "c d", NULL
}},
383 {"a\\\"b c\" d", {"a\"b", "c d", NULL
}},
384 {"a\\\"\"b c\" d", {"a\"b c", "d", NULL
}},
385 {"a\\\"\"\"b c\" d", {"a\"b", "c d", NULL
}},
386 {"a\\\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
387 {"a\\\"\"\"\"\"b c\" d", {"a\"\"b c", "d", NULL
}},
388 {"a\\\"\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
389 {"a\\\"\"\"\"\"\"\"b c\" d", {"a\"\"\"b", "c d", NULL
}},
390 {"a\\\"\"\"\"\"\"\"\"b c\" d", {"a\"\"\"b c", "d", NULL
}},
391 {"a\\\\b c\" d", {"a\\\\b", "c d", NULL
}},
392 {"a\\\\\"b c\" d", {"a\\b c", "d", NULL
}},
393 {"a\\\\\"\"b c\" d", {"a\\b", "c d", NULL
}},
394 {"a\\\\\"\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
395 {"a\\\\\"\"\"\"b c\" d", {"a\\\"b c", "d", NULL
}},
396 {"a\\\\\"\"\"\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
397 {"a\\\\\"\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
398 {"a\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\"\"b c", "d", NULL
}},
399 {"a\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
400 {"a\\\\\\b c\" d", {"a\\\\\\b", "c d", NULL
}},
401 {"a\\\\\\\"b c\" d", {"a\\\"b", "c d", NULL
}},
402 {"a\\\\\\\"\"b c\" d", {"a\\\"b c", "d", NULL
}},
403 {"a\\\\\\\"\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
404 {"a\\\\\\\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
405 {"a\\\\\\\"\"\"\"\"b c\" d", {"a\\\"\"b c", "d", NULL
}},
406 {"a\\\\\\\"\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
407 {"a\\\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b", "c d", NULL
}},
408 {"a\\\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b c", "d", NULL
}},
409 {"a\\\\\\\\b c\" d", {"a\\\\\\\\b", "c d", NULL
}},
410 {"a\\\\\\\\\"b c\" d", {"a\\\\b c", "d", NULL
}},
411 {"a\\\\\\\\\"\"b c\" d", {"a\\\\b", "c d", NULL
}},
412 {"a\\\\\\\\\"\"\"b c\" d", {"a\\\\\"b", "c d", NULL
}},
413 {"a\\\\\\\\\"\"\"\"b c\" d", {"a\\\\\"b c", "d", NULL
}},
414 {"a\\\\\\\\\"\"\"\"\"b c\" d", {"a\\\\\"b", "c d", NULL
}},
415 {"a\\\\\\\\\"\"\"\"\"\"b c\" d", {"a\\\\\"\"b", "c d", NULL
}},
416 {"a\\\\\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\\\"\"b c", "d", NULL
}},
417 {"a\\\\\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\\\"\"b", "c d", NULL
}},
418 {"\"ab c\" d", {"ab c", "d", NULL
}},
419 {"\"a\"b c\" d", {"ab", "c d", NULL
}},
420 {"\"a\"\"b c\" d", {"a\"b", "c d", NULL
}},
421 {"\"a\"\"\"b c\" d", {"a\"b c", "d", NULL
}},
422 {"\"a\"\"\"\"b c\" d", {"a\"b", "c d", NULL
}},
423 {"\"a\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
424 {"\"a\"\"\"\"\"\"b c\" d", {"a\"\"b c", "d", NULL
}},
425 {"\"a\"\"\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
426 {"\"a\"\"\"\"\"\"\"\"b c\" d", {"a\"\"\"b", "c d", NULL
}},
427 {"\"a\\b c\" d", {"a\\b c", "d", NULL
}},
428 {"\"a\\\"b c\" d", {"a\"b c", "d", NULL
}},
429 {"\"a\\\"\"b c\" d", {"a\"b", "c d", NULL
}},
430 {"\"a\\\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
431 {"\"a\\\"\"\"\"b c\" d", {"a\"\"b c", "d", NULL
}},
432 {"\"a\\\"\"\"\"\"b c\" d", {"a\"\"b", "c d", NULL
}},
433 {"\"a\\\"\"\"\"\"\"b c\" d", {"a\"\"\"b", "c d", NULL
}},
434 {"\"a\\\"\"\"\"\"\"\"b c\" d", {"a\"\"\"b c", "d", NULL
}},
435 {"\"a\\\"\"\"\"\"\"\"\"b c\" d", {"a\"\"\"b", "c d", NULL
}},
436 {"\"a\\\\b c\" d", {"a\\\\b c", "d", NULL
}},
437 {"\"a\\\\\"b c\" d", {"a\\b", "c d", NULL
}},
438 {"\"a\\\\\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
439 {"\"a\\\\\"\"\"b c\" d", {"a\\\"b c", "d", NULL
}},
440 {"\"a\\\\\"\"\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
441 {"\"a\\\\\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
442 {"\"a\\\\\"\"\"\"\"\"b c\" d", {"a\\\"\"b c", "d", NULL
}},
443 {"\"a\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
444 {"\"a\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b", "c d", NULL
}},
445 {"\"a\\\\\\b c\" d", {"a\\\\\\b c", "d", NULL
}},
446 {"\"a\\\\\\\"b c\" d", {"a\\\"b c", "d", NULL
}},
447 {"\"a\\\\\\\"\"b c\" d", {"a\\\"b", "c d", NULL
}},
448 {"\"a\\\\\\\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
449 {"\"a\\\\\\\"\"\"\"b c\" d", {"a\\\"\"b c", "d", NULL
}},
450 {"\"a\\\\\\\"\"\"\"\"b c\" d", {"a\\\"\"b", "c d", NULL
}},
451 {"\"a\\\\\\\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b", "c d", NULL
}},
452 {"\"a\\\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b c", "d", NULL
}},
453 {"\"a\\\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\"\"\"b", "c d", NULL
}},
454 {"\"a\\\\\\\\b c\" d", {"a\\\\\\\\b c", "d", NULL
}},
455 {"\"a\\\\\\\\\"b c\" d", {"a\\\\b", "c d", NULL
}},
456 {"\"a\\\\\\\\\"\"b c\" d", {"a\\\\\"b", "c d", NULL
}},
457 {"\"a\\\\\\\\\"\"\"b c\" d", {"a\\\\\"b c", "d", NULL
}},
458 {"\"a\\\\\\\\\"\"\"\"b c\" d", {"a\\\\\"b", "c d", NULL
}},
459 {"\"a\\\\\\\\\"\"\"\"\"b c\" d", {"a\\\\\"\"b", "c d", NULL
}},
460 {"\"a\\\\\\\\\"\"\"\"\"\"b c\" d", {"a\\\\\"\"b c", "d", NULL
}},
461 {"\"a\\\\\\\\\"\"\"\"\"\"\"b c\" d", {"a\\\\\"\"b", "c d", NULL
}},
462 {"\"a\\\\\\\\\"\"\"\"\"\"\"\"b c\" d", {"a\\\\\"\"\"b", "c d", NULL
}},
465 int main(int argc
, char **argv
)
471 * Generation of tests.
473 * Given `-splat <args>', we print out a C-style
474 * representation of each argument (in the form "a", "b",
475 * NULL), backslash-escaping each backslash and double
478 * Given `-split <string>', we first doctor `string' by
479 * turning forward slashes into backslashes, single quotes
480 * into double quotes and underscores into spaces; and then
481 * we feed the resulting string to ourself with `-splat'.
483 * Given `-generate', we concoct a variety of fun test
484 * cases, encode them in quote-safe form (mapping \, " and
485 * space to /, ' and _ respectively) and feed each one to
488 if (!strcmp(argv
[1], "-splat")) {
491 for (i
= 2; i
< argc
; i
++) {
493 for (p
= argv
[i
]; *p
; p
++) {
494 if (*p
== '\\' || *p
== '"')
504 if (!strcmp(argv
[1], "-split") && argc
> 2) {
505 char *str
= malloc(20 + strlen(argv
[0]) + strlen(argv
[2]));
508 q
= str
+ sprintf(str
, "%s -splat ", argv
[0]);
510 for (p
= argv
[2]; *p
; p
++, q
++) {
512 case '/': printf("\\\\"); *q
= '\\'; break;
513 case '\'': printf("\\\""); *q
= '"'; break;
514 case '_': printf(" "); *q
= ' '; break;
515 default: putchar(*p
); *q
= *p
; break;
529 if (!strcmp(argv
[1], "-generate")) {
531 int i
, initialquote
, backslashes
, quotes
;
533 teststr
= malloc(200 + strlen(argv
[0]));
535 for (initialquote
= 0; initialquote
<= 1; initialquote
++) {
536 for (backslashes
= 0; backslashes
< 5; backslashes
++) {
537 for (quotes
= 0; quotes
< 9; quotes
++) {
538 p
= teststr
+ sprintf(teststr
, "%s -split ", argv
[0]);
539 if (initialquote
) *p
++ = '\'';
541 for (i
= 0; i
< backslashes
; i
++) *p
++ = '/';
542 for (i
= 0; i
< quotes
; i
++) *p
++ = '\'';
558 fprintf(stderr
, "unrecognised option: \"%s\"\n", argv
[1]);
563 * If we get here, we were invoked with no arguments, so just
567 for (i
= 0; i
< lenof(argv_tests
); i
++) {
571 split_into_argv(argv_tests
[i
].cmdline
, &ac
, &av
);
573 for (j
= 0; j
< ac
&& argv_tests
[i
].argv
[j
]; j
++) {
574 if (strcmp(av
[j
], argv_tests
[i
].argv
[j
])) {
575 printf("failed test %d (|%s|) arg %d: |%s| should be |%s|\n",
576 i
, argv_tests
[i
].cmdline
,
577 j
, av
[j
], argv_tests
[i
].argv
[j
]);
581 printf("test %d (|%s|) arg %d: |%s| == |%s|\n",
582 i
, argv_tests
[i
].cmdline
,
583 j
, av
[j
], argv_tests
[i
].argv
[j
]);
588 printf("failed test %d (|%s|): %d args returned, should be %d\n",
589 i
, argv_tests
[i
].cmdline
, ac
, j
);
590 if (argv_tests
[i
].argv
[j
])
591 printf("failed test %d (|%s|): %d args returned, should be more\n",
592 i
, argv_tests
[i
].cmdline
, ac
);