2 * windlg.c - dialogs for PuTTY(tel), including the configuration dialog.
23 #define TVINSERTSTRUCT TV_INSERTSTRUCT
24 #define TVITEM TV_ITEM
29 * These are the various bits of data required to handle the
30 * portable-dialog stuff in the config box. Having them at file
31 * scope in here isn't too bad a place to put them; if we were ever
32 * to need more than one config box per process we could always
33 * shift them to a per-config-box structure stored in GWL_USERDATA.
35 static struct controlbox *ctrlbox;
37 * ctrls_base holds the OK and Cancel buttons: the controls which
38 * are present in all dialog panels. ctrls_panel holds the ones
39 * which change from panel to panel.
41 static struct winctrls ctrls_base, ctrls_panel;
42 static struct dlgparam dp;
44 static char **events = NULL;
45 static int nevents = 0, negsize = 0;
47 extern Config cfg; /* defined in window.c */
49 #define PRINTER_DISABLED_STRING "None (printing disabled)"
51 void force_normal(HWND hwnd)
53 static int recurse = 0;
61 wp.length = sizeof(wp);
62 if (GetWindowPlacement(hwnd, &wp) && wp.showCmd == SW_SHOWMAXIMIZED) {
63 wp.showCmd = SW_SHOWNORMAL;
64 SetWindowPlacement(hwnd, &wp);
69 static int CALLBACK LogProc(HWND hwnd, UINT msg,
70 WPARAM wParam, LPARAM lParam)
77 char *str = dupprintf("%s Event Log", appname);
78 SetWindowText(hwnd, str);
82 static int tabs[4] = { 78, 108 };
83 SendDlgItemMessage(hwnd, IDN_LIST, LB_SETTABSTOPS, 2,
86 for (i = 0; i < nevents; i++)
87 SendDlgItemMessage(hwnd, IDN_LIST, LB_ADDSTRING,
88 0, (LPARAM) events[i]);
91 switch (LOWORD(wParam)) {
95 SetActiveWindow(GetParent(hwnd));
99 if (HIWORD(wParam) == BN_CLICKED ||
100 HIWORD(wParam) == BN_DOUBLECLICKED) {
103 selcount = SendDlgItemMessage(hwnd, IDN_LIST,
104 LB_GETSELCOUNT, 0, 0);
105 if (selcount == 0) { /* don't even try to copy zero items */
110 selitems = snewn(selcount, int);
112 int count = SendDlgItemMessage(hwnd, IDN_LIST,
119 static unsigned char sel_nl[] = SEL_NL;
121 if (count == 0) { /* can't copy zero stuff */
127 for (i = 0; i < count; i++)
129 strlen(events[selitems[i]]) + sizeof(sel_nl);
131 clipdata = snewn(size, char);
134 for (i = 0; i < count; i++) {
135 char *q = events[selitems[i]];
136 int qlen = strlen(q);
139 memcpy(p, sel_nl, sizeof(sel_nl));
142 write_aclip(NULL, clipdata, size, TRUE);
147 for (i = 0; i < nevents; i++)
148 SendDlgItemMessage(hwnd, IDN_LIST, LB_SETSEL,
157 SetActiveWindow(GetParent(hwnd));
164 static int CALLBACK LicenceProc(HWND hwnd, UINT msg,
165 WPARAM wParam, LPARAM lParam)
170 char *str = dupprintf("%s Licence", appname);
171 SetWindowText(hwnd, str);
176 switch (LOWORD(wParam)) {
190 static int CALLBACK AboutProc(HWND hwnd, UINT msg,
191 WPARAM wParam, LPARAM lParam)
197 str = dupprintf("About %s", appname);
198 SetWindowText(hwnd, str);
200 SetDlgItemText(hwnd, IDA_TEXT1, appname);
201 SetDlgItemText(hwnd, IDA_VERSION, ver);
204 switch (LOWORD(wParam)) {
207 EndDialog(hwnd, TRUE);
210 EnableWindow(hwnd, 0);
211 DialogBox(hinst, MAKEINTRESOURCE(IDD_LICENCEBOX),
213 EnableWindow(hwnd, 1);
214 SetActiveWindow(hwnd);
218 /* Load web browser */
219 ShellExecute(hwnd, "open",
220 "http://www.chiark.greenend.org.uk/~sgtatham/putty/",
221 0, 0, SW_SHOWDEFAULT);
226 EndDialog(hwnd, TRUE);
232 static int SaneDialogBox(HINSTANCE hinst,
235 DLGPROC lpDialogFunc)
244 wc.style = CS_DBLCLKS | CS_SAVEBITS | CS_BYTEALIGNWINDOW;
245 wc.lpfnWndProc = DefDlgProc;
247 wc.cbWndExtra = DLGWINDOWEXTRA + 2*sizeof(LONG_PTR);
248 wc.hInstance = hinst;
250 wc.hCursor = LoadCursor(NULL, IDC_ARROW);
251 wc.hbrBackground = (HBRUSH) (COLOR_BACKGROUND +1);
252 wc.lpszMenuName = NULL;
253 wc.lpszClassName = "PuTTYConfigBox";
256 hwnd = CreateDialog(hinst, tmpl, hwndparent, lpDialogFunc);
258 SetWindowLongPtr(hwnd, BOXFLAGS, 0); /* flags */
259 SetWindowLongPtr(hwnd, BOXRESULT, 0); /* result from SaneEndDialog */
261 while ((gm=GetMessage(&msg, NULL, 0, 0)) > 0) {
262 flags=GetWindowLongPtr(hwnd, BOXFLAGS);
263 if (!(flags & DF_END) && !IsDialogMessage(hwnd, &msg))
264 DispatchMessage(&msg);
270 PostQuitMessage(msg.wParam); /* We got a WM_QUIT, pass it on */
272 ret=GetWindowLongPtr(hwnd, BOXRESULT);
277 static void SaneEndDialog(HWND hwnd, int ret)
279 SetWindowLongPtr(hwnd, BOXRESULT, ret);
280 SetWindowLongPtr(hwnd, BOXFLAGS, DF_END);
284 * Null dialog procedure.
286 static int CALLBACK NullDlgProc(HWND hwnd, UINT msg,
287 WPARAM wParam, LPARAM lParam)
293 IDCX_ABOUT = IDC_ABOUT,
297 IDCX_PANELBASE = IDCX_STDBASE + 32
300 struct treeview_faff {
305 static HTREEITEM treeview_insert(struct treeview_faff *faff,
306 int level, char *text, char *path)
311 ins.hParent = (level > 0 ? faff->lastat[level - 1] : TVI_ROOT);
312 ins.hInsertAfter = faff->lastat[level];
313 #if _WIN32_IE >= 0x0400 && defined NONAMELESSUNION
314 #define INSITEM DUMMYUNIONNAME.item
318 ins.INSITEM.mask = TVIF_TEXT | TVIF_PARAM;
319 ins.INSITEM.pszText = text;
320 ins.INSITEM.cchTextMax = strlen(text)+1;
321 ins.INSITEM.lParam = (LPARAM)path;
322 newitem = TreeView_InsertItem(faff->treeview, &ins);
324 TreeView_Expand(faff->treeview, faff->lastat[level - 1],
326 faff->lastat[level] = newitem;
327 for (i = level + 1; i < 4; i++)
328 faff->lastat[i] = NULL;
333 * Create the panelfuls of controls in the configuration box.
335 static void create_controls(HWND hwnd, char *path)
344 * Here we must create the basic standard controls.
346 ctlposinit(&cp, hwnd, 3, 3, 235);
348 base_id = IDCX_STDBASE;
351 * Otherwise, we're creating the controls for a particular
354 ctlposinit(&cp, hwnd, 100, 3, 13);
356 base_id = IDCX_PANELBASE;
359 for (index=-1; (index = ctrl_find_path(ctrlbox, path, index)) >= 0 ;) {
360 struct controlset *s = ctrlbox->ctrlsets[index];
361 winctrl_layout(&dp, wc, &cp, s, &base_id);
366 * This function is the configuration box.
367 * (Being a dialog procedure, in general it returns 0 if the default
368 * dialog processing should be performed, and 1 if it should not.)
370 static int CALLBACK GenericMainDlgProc(HWND hwnd, UINT msg,
371 WPARAM wParam, LPARAM lParam)
374 struct treeview_faff tvfaff;
380 create_controls(hwnd, ""); /* Open and Cancel buttons etc */
381 SetWindowText(hwnd, dp.wintitle);
382 SetWindowLongPtr(hwnd, GWLP_USERDATA, 0);
384 SetWindowLongPtr(hwnd, GWL_EXSTYLE,
385 GetWindowLongPtr(hwnd, GWL_EXSTYLE) |
388 HWND item = GetDlgItem(hwnd, IDC_HELPBTN);
392 requested_help = FALSE;
393 SendMessage(hwnd, WM_SETICON, (WPARAM) ICON_BIG,
394 (LPARAM) LoadIcon(hinst, MAKEINTRESOURCE(IDI_CFGICON)));
398 { /* centre the window */
401 hw = GetDesktopWindow();
402 if (GetWindowRect(hw, &rs) && GetWindowRect(hwnd, &rd))
404 (rs.right + rs.left + rd.left - rd.right) / 2,
405 (rs.bottom + rs.top + rd.top - rd.bottom) / 2,
406 rd.right - rd.left, rd.bottom - rd.top, TRUE);
410 * Create the tree view.
418 r.right = r.left + 95;
420 r.bottom = r.top + 10;
421 MapDialogRect(hwnd, &r);
422 tvstatic = CreateWindowEx(0, "STATIC", "Cate&gory:",
423 WS_CHILD | WS_VISIBLE,
425 r.right - r.left, r.bottom - r.top,
426 hwnd, (HMENU) IDCX_TVSTATIC, hinst,
428 font = SendMessage(hwnd, WM_GETFONT, 0, 0);
429 SendMessage(tvstatic, WM_SETFONT, font, MAKELPARAM(TRUE, 0));
432 r.right = r.left + 95;
434 r.bottom = r.top + 219;
435 MapDialogRect(hwnd, &r);
436 treeview = CreateWindowEx(WS_EX_CLIENTEDGE, WC_TREEVIEW, "",
437 WS_CHILD | WS_VISIBLE |
438 WS_TABSTOP | TVS_HASLINES |
439 TVS_DISABLEDRAGDROP | TVS_HASBUTTONS
441 TVS_SHOWSELALWAYS, r.left, r.top,
442 r.right - r.left, r.bottom - r.top,
443 hwnd, (HMENU) IDCX_TREEVIEW, hinst,
445 font = SendMessage(hwnd, WM_GETFONT, 0, 0);
446 SendMessage(treeview, WM_SETFONT, font, MAKELPARAM(TRUE, 0));
447 tvfaff.treeview = treeview;
448 memset(tvfaff.lastat, 0, sizeof(tvfaff.lastat));
452 * Set up the tree view contents.
455 HTREEITEM hfirst = NULL;
459 for (i = 0; i < ctrlbox->nctrlsets; i++) {
460 struct controlset *s = ctrlbox->ctrlsets[i];
467 j = path ? ctrl_path_compare(s->pathname, path) : 0;
469 continue; /* same path, nothing to add to tree */
472 * We expect never to find an implicit path
473 * component. For example, we expect never to see
474 * A/B/C followed by A/D/E, because that would
475 * _implicitly_ create A/D. All our path prefixes
476 * are expected to contain actual controls and be
477 * selectable in the treeview; so we would expect
478 * to see A/D _explicitly_ before encountering
481 assert(j == ctrl_path_elements(s->pathname) - 1);
483 c = strrchr(s->pathname, '/');
489 item = treeview_insert(&tvfaff, j, c, s->pathname);
497 * Put the treeview selection on to the Session panel.
498 * This should also cause creation of the relevant
501 TreeView_SelectItem(treeview, hfirst);
505 * Set focus into the first available control.
511 for (i = 0; (c = winctrl_findbyindex(&ctrls_panel, i)) != NULL;
514 dlg_set_focus(c->ctrl, &dp);
520 SetWindowLongPtr(hwnd, GWLP_USERDATA, 1);
524 * Button release should trigger WM_OK if there was a
525 * previous double click on the session list.
529 SaneEndDialog(hwnd, dp.endresult ? 1 : 0);
532 if (LOWORD(wParam) == IDCX_TREEVIEW &&
533 ((LPNMHDR) lParam)->code == TVN_SELCHANGED) {
535 TreeView_GetSelection(((LPNMHDR) lParam)->hwndFrom);
539 SendMessage (hwnd, WM_SETREDRAW, FALSE, 0);
542 item.pszText = buffer;
543 item.cchTextMax = sizeof(buffer);
544 item.mask = TVIF_TEXT | TVIF_PARAM;
545 TreeView_GetItem(((LPNMHDR) lParam)->hwndFrom, &item);
547 /* Destroy all controls in the currently visible panel. */
552 while ((c = winctrl_findbyindex(&ctrls_panel, 0)) != NULL) {
553 for (k = 0; k < c->num_ids; k++) {
554 item = GetDlgItem(hwnd, c->base_id + k);
558 winctrl_rem_shortcuts(&dp, c);
559 winctrl_remove(&ctrls_panel, c);
564 create_controls(hwnd, (char *)item.lParam);
566 dlg_refresh(NULL, &dp); /* set up control values */
568 SendMessage (hwnd, WM_SETREDRAW, TRUE, 0);
569 InvalidateRect (hwnd, NULL, TRUE);
571 SetFocus(((LPNMHDR) lParam)->hwndFrom); /* ensure focus stays */
577 default: /* also handle drag list msg here */
579 * Only process WM_COMMAND once the dialog is fully formed.
581 if (GetWindowLongPtr(hwnd, GWLP_USERDATA) == 1) {
582 ret = winctrl_handle_command(&dp, msg, wParam, lParam);
583 if (dp.ended && GetCapture() != hwnd)
584 SaneEndDialog(hwnd, dp.endresult ? 1 : 0);
590 if (winctrl_context_help(&dp, hwnd,
591 ((LPHELPINFO)lParam)->iCtrlId))
592 requested_help = TRUE;
598 if (requested_help) {
599 WinHelp(hwnd, help_path, HELP_QUIT, 0);
600 requested_help = FALSE;
602 SaneEndDialog(hwnd, 0);
605 /* Grrr Explorer will maximize Dialogs! */
607 if (wParam == SIZE_MAXIMIZED)
615 void modal_about_box(HWND hwnd)
617 EnableWindow(hwnd, 0);
618 DialogBox(hinst, MAKEINTRESOURCE(IDD_ABOUTBOX), hwnd, AboutProc);
619 EnableWindow(hwnd, 1);
620 SetActiveWindow(hwnd);
623 void show_help(HWND hwnd)
626 WinHelp(hwnd, help_path,
627 help_has_contents ? HELP_FINDER : HELP_CONTENTS,
629 requested_help = TRUE;
633 void defuse_showwindow(void)
636 * Work around the fact that the app's first call to ShowWindow
637 * will ignore the default in favour of the shell-provided
642 hwnd = CreateDialog(hinst, MAKEINTRESOURCE(IDD_ABOUTBOX),
644 ShowWindow(hwnd, SW_HIDE);
645 SetActiveWindow(hwnd);
654 ctrlbox = ctrl_new_box();
655 setup_config_box(ctrlbox, FALSE, 0, 0);
656 win_setup_config_box(ctrlbox, &dp.hwnd, (help_path != NULL), FALSE, 0);
658 winctrl_init(&ctrls_base);
659 winctrl_init(&ctrls_panel);
660 dp_add_tree(&dp, &ctrls_base);
661 dp_add_tree(&dp, &ctrls_panel);
662 dp.wintitle = dupprintf("%s Configuration", appname);
663 dp.errtitle = dupprintf("%s Error", appname);
665 dp.shortcuts['g'] = TRUE; /* the treeview: `Cate&gory' */
668 SaneDialogBox(hinst, MAKEINTRESOURCE(IDD_MAINBOX), NULL,
671 ctrl_free_box(ctrlbox);
672 winctrl_cleanup(&ctrls_panel);
673 winctrl_cleanup(&ctrls_base);
679 int do_reconfig(HWND hwnd, int protcfginfo)
684 backup_cfg = cfg; /* structure copy */
686 ctrlbox = ctrl_new_box();
687 setup_config_box(ctrlbox, TRUE, cfg.protocol, protcfginfo);
688 win_setup_config_box(ctrlbox, &dp.hwnd, (help_path != NULL), TRUE,
691 winctrl_init(&ctrls_base);
692 winctrl_init(&ctrls_panel);
693 dp_add_tree(&dp, &ctrls_base);
694 dp_add_tree(&dp, &ctrls_panel);
695 dp.wintitle = dupprintf("%s Reconfiguration", appname);
696 dp.errtitle = dupprintf("%s Error", appname);
698 dp.shortcuts['g'] = TRUE; /* the treeview: `Cate&gory' */
700 ret = SaneDialogBox(hinst, MAKEINTRESOURCE(IDD_MAINBOX), NULL,
703 ctrl_free_box(ctrlbox);
704 winctrl_cleanup(&ctrls_base);
705 winctrl_cleanup(&ctrls_panel);
709 cfg = backup_cfg; /* structure copy */
714 void logevent(void *frontend, const char *string)
719 log_eventlog(logctx, string);
721 if (nevents >= negsize) {
723 events = sresize(events, negsize, char *);
727 strftime(timebuf, sizeof(timebuf), "%Y-%m-%d %H:%M:%S\t", &tm);
729 events[nevents] = snewn(strlen(timebuf) + strlen(string) + 1, char);
730 strcpy(events[nevents], timebuf);
731 strcat(events[nevents], string);
734 SendDlgItemMessage(logbox, IDN_LIST, LB_ADDSTRING,
735 0, (LPARAM) events[nevents]);
736 count = SendDlgItemMessage(logbox, IDN_LIST, LB_GETCOUNT, 0, 0);
737 SendDlgItemMessage(logbox, IDN_LIST, LB_SETTOPINDEX, count - 1, 0);
742 void showeventlog(HWND hwnd)
745 logbox = CreateDialog(hinst, MAKEINTRESOURCE(IDD_LOGBOX),
747 ShowWindow(logbox, SW_SHOWNORMAL);
749 SetActiveWindow(logbox);
752 void showabout(HWND hwnd)
754 DialogBox(hinst, MAKEINTRESOURCE(IDD_ABOUTBOX), hwnd, AboutProc);
757 int verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
758 char *keystr, char *fingerprint,
759 void (*callback)(void *ctx, int result), void *ctx)
763 static const char absentmsg[] =
764 "The server's host key is not cached in the registry. You\n"
765 "have no guarantee that the server is the computer you\n"
767 "The server's %s key fingerprint is:\n"
769 "If you trust this host, hit Yes to add the key to\n"
770 "%s's cache and carry on connecting.\n"
771 "If you want to carry on connecting just once, without\n"
772 "adding the key to the cache, hit No.\n"
773 "If you do not trust this host, hit Cancel to abandon the\n"
776 static const char wrongmsg[] =
777 "WARNING - POTENTIAL SECURITY BREACH!\n"
779 "The server's host key does not match the one %s has\n"
780 "cached in the registry. This means that either the\n"
781 "server administrator has changed the host key, or you\n"
782 "have actually connected to another computer pretending\n"
783 "to be the server.\n"
784 "The new %s key fingerprint is:\n"
786 "If you were expecting this change and trust the new key,\n"
787 "hit Yes to update %s's cache and continue connecting.\n"
788 "If you want to carry on connecting but without updating\n"
789 "the cache, hit No.\n"
790 "If you want to abandon the connection completely, hit\n"
791 "Cancel. Hitting Cancel is the ONLY guaranteed safe\n" "choice.\n";
793 static const char mbtitle[] = "%s Security Alert";
796 * Verify the key against the registry.
798 ret = verify_host_key(host, port, keytype, keystr);
800 if (ret == 0) /* success - key matched OK */
802 if (ret == 2) { /* key was different */
804 char *text = dupprintf(wrongmsg, appname, keytype, fingerprint,
806 char *caption = dupprintf(mbtitle, appname);
807 mbret = message_box(text, caption,
808 MB_ICONWARNING | MB_YESNOCANCEL | MB_DEFBUTTON3,
809 HELPCTXID(errors_hostkey_changed));
810 assert(mbret==IDYES || mbret==IDNO || mbret==IDCANCEL);
813 if (mbret == IDYES) {
814 store_host_key(host, port, keytype, keystr);
816 } else if (mbret == IDNO)
820 if (ret == 1) { /* key was absent */
822 char *text = dupprintf(absentmsg, keytype, fingerprint, appname);
823 char *caption = dupprintf(mbtitle, appname);
824 mbret = message_box(text, caption,
825 MB_ICONWARNING | MB_YESNOCANCEL | MB_DEFBUTTON3,
826 HELPCTXID(errors_hostkey_absent));
827 assert(mbret==IDYES || mbret==IDNO || mbret==IDCANCEL);
830 if (mbret == IDYES) {
831 store_host_key(host, port, keytype, keystr);
833 } else if (mbret == IDNO)
840 * Ask whether the selected algorithm is acceptable (since it was
841 * below the configured 'warn' threshold).
843 int askalg(void *frontend, const char *algtype, const char *algname,
844 void (*callback)(void *ctx, int result), void *ctx)
846 static const char mbtitle[] = "%s Security Alert";
847 static const char msg[] =
848 "The first %s supported by the server\n"
849 "is %.64s, which is below the configured\n"
850 "warning threshold.\n"
851 "Do you want to continue with this connection?\n";
852 char *message, *title;
855 message = dupprintf(msg, algtype, algname);
856 title = dupprintf(mbtitle, appname);
857 mbret = MessageBox(NULL, message, title,
858 MB_ICONWARNING | MB_YESNO | MB_DEFBUTTON2);
868 * Ask whether to wipe a session log file before writing to it.
869 * Returns 2 for wipe, 1 for append, 0 for cancel (don't log).
871 int askappend(void *frontend, Filename filename,
872 void (*callback)(void *ctx, int result), void *ctx)
874 static const char msgtemplate[] =
875 "The session log file \"%.*s\" already exists.\n"
876 "You can overwrite it with a new session log,\n"
877 "append your session log to the end of it,\n"
878 "or disable session logging for this session.\n"
879 "Hit Yes to wipe the file, No to append to it,\n"
880 "or Cancel to disable logging.";
885 message = dupprintf(msgtemplate, FILENAME_MAX, filename.path);
886 mbtitle = dupprintf("%s Log to File", appname);
888 mbret = MessageBox(NULL, message, mbtitle,
889 MB_ICONQUESTION | MB_YESNOCANCEL | MB_DEFBUTTON3);
896 else if (mbret == IDNO)
903 * Warn about the obsolescent key file format.
905 * Uniquely among these functions, this one does _not_ expect a
906 * frontend handle. This means that if PuTTY is ported to a
907 * platform which requires frontend handles, this function will be
908 * an anomaly. Fortunately, the problem it addresses will not have
909 * been present on that platform, so it can plausibly be
910 * implemented as an empty function.
912 void old_keyfile_warning(void)
914 static const char mbtitle[] = "%s Key File Warning";
915 static const char message[] =
916 "You are loading an SSH-2 private key which has an\n"
917 "old version of the file format. This means your key\n"
918 "file is not fully tamperproof. Future versions of\n"
919 "%s may stop supporting this private key format,\n"
920 "so we recommend you convert your key to the new\n"
923 "You can perform this conversion by loading the key\n"
924 "into PuTTYgen and then saving it again.";
927 msg = dupprintf(message, appname);
928 title = dupprintf(mbtitle, appname);
930 MessageBox(NULL, msg, title, MB_OK);