2 * settings.c: read and write saved sessions.
12 * Tables of string <-> enum value mappings
14 struct keyval { char *s; int v; };
16 static const struct keyval ciphernames[] = {
17 { "aes", CIPHER_AES },
18 { "blowfish", CIPHER_BLOWFISH },
19 { "3des", CIPHER_3DES },
20 { "WARN", CIPHER_WARN },
24 static void gpps(void *handle, char *name, char *def, char *val, int len)
26 if (!read_setting_s(handle, name, val, len)) {
27 strncpy(val, def, len);
32 static void gppi(void *handle, char *name, int def, int *i)
34 *i = read_setting_i(handle, name, def);
37 static int key2val(const struct keyval *mapping, int nmaps, char *key)
40 for (i = 0; i < nmaps; i++)
41 if (!strcmp(mapping[i].s, key)) return mapping[i].v;
45 static const char *val2key(const struct keyval *mapping, int nmaps, int val)
48 for (i = 0; i < nmaps; i++)
49 if (mapping[i].v == val) return mapping[i].s;
54 * Helper function to parse a comma-separated list of strings into
55 * a preference list array of values. Any missing values are added
56 * to the end and duplicates are weeded.
57 * XXX: assumes vals in 'mapping' are small +ve integers
59 static void gprefs(void *sesskey, char *name, char *def,
60 const struct keyval *mapping, int nvals,
65 unsigned long seen = 0; /* bitmap for weeding dups etc */
66 gpps(sesskey, name, def, commalist, sizeof(commalist));
68 /* Grotty parsing of commalist. */
73 key = strtok(n==0 ? commalist : NULL, ","); /* sorry */
75 if (((v = key2val(mapping, nvals, key)) != -1) &&
82 /* Add any missing values (backward compatibility ect). */
85 for (i = 0; i < nvals; i++) {
86 if (!(seen & 1<<mapping[i].v)) {
87 array[n] = mapping[i].v;
95 * Write out a preference list.
97 static void wprefs(void *sesskey, char *name,
98 const struct keyval *mapping, int nvals,
101 char buf[80] = ""; /* XXX assumed big enough */
102 int l = sizeof(buf)-1, i;
104 for (i = 0; l > 0 && i < nvals; i++) {
105 const char *s = val2key(mapping, nvals, array[i]);
109 strncat(buf, ",", l);
116 write_setting_s(sesskey, name, buf);
119 void save_settings(char *section, int do_host, Config * cfg)
125 sesskey = open_settings_w(section);
129 write_setting_i(sesskey, "Present", 1);
131 write_setting_s(sesskey, "HostName", cfg->host);
132 write_setting_s(sesskey, "LogFileName", cfg->logfilename);
133 write_setting_i(sesskey, "LogType", cfg->logtype);
134 write_setting_i(sesskey, "LogFileClash", cfg->logxfovr);
137 for (i = 0; backends[i].name != NULL; i++)
138 if (backends[i].protocol == cfg->protocol) {
139 p = backends[i].name;
142 write_setting_s(sesskey, "Protocol", p);
143 write_setting_i(sesskey, "PortNumber", cfg->port);
144 write_setting_i(sesskey, "CloseOnExit", cfg->close_on_exit);
145 write_setting_i(sesskey, "WarnOnClose", !!cfg->warn_on_close);
146 write_setting_i(sesskey, "PingInterval", cfg->ping_interval / 60); /* minutes */
147 write_setting_i(sesskey, "PingIntervalSecs", cfg->ping_interval % 60); /* seconds */
148 write_setting_s(sesskey, "TerminalType", cfg->termtype);
149 write_setting_s(sesskey, "TerminalSpeed", cfg->termspeed);
151 char buf[2 * sizeof(cfg->environmt)], *p, *q;
157 if (c == '=' || c == ',' || c == '\\')
167 write_setting_s(sesskey, "Environment", buf);
169 write_setting_s(sesskey, "UserName", cfg->username);
170 write_setting_s(sesskey, "LocalUserName", cfg->localusername);
171 write_setting_i(sesskey, "NoPTY", cfg->nopty);
172 write_setting_i(sesskey, "Compression", cfg->compression);
173 write_setting_i(sesskey, "AgentFwd", cfg->agentfwd);
174 wprefs(sesskey, "Cipher", ciphernames, CIPHER_MAX,
175 cfg->ssh_cipherlist);
176 write_setting_i(sesskey, "AuthTIS", cfg->try_tis_auth);
177 write_setting_i(sesskey, "SshProt", cfg->sshprot);
178 write_setting_i(sesskey, "BuggyMAC", cfg->buggymac);
179 write_setting_s(sesskey, "PublicKeyFile", cfg->keyfile);
180 write_setting_s(sesskey, "RemoteCommand", cfg->remote_cmd);
181 write_setting_i(sesskey, "RFCEnviron", cfg->rfc_environ);
182 write_setting_i(sesskey, "PassiveTelnet", cfg->passive_telnet);
183 write_setting_i(sesskey, "BackspaceIsDelete", cfg->bksp_is_delete);
184 write_setting_i(sesskey, "RXVTHomeEnd", cfg->rxvt_homeend);
185 write_setting_i(sesskey, "LinuxFunctionKeys", cfg->funky_type);
186 write_setting_i(sesskey, "NoApplicationKeys", cfg->no_applic_k);
187 write_setting_i(sesskey, "NoApplicationCursors", cfg->no_applic_c);
188 write_setting_i(sesskey, "ApplicationCursorKeys", cfg->app_cursor);
189 write_setting_i(sesskey, "ApplicationKeypad", cfg->app_keypad);
190 write_setting_i(sesskey, "NetHackKeypad", cfg->nethack_keypad);
191 write_setting_i(sesskey, "AltF4", cfg->alt_f4);
192 write_setting_i(sesskey, "AltSpace", cfg->alt_space);
193 write_setting_i(sesskey, "AltOnly", cfg->alt_only);
194 write_setting_i(sesskey, "ComposeKey", cfg->compose_key);
195 write_setting_i(sesskey, "CtrlAltKeys", cfg->ctrlaltkeys);
196 write_setting_i(sesskey, "TelnetKey", cfg->telnet_keyboard);
197 write_setting_i(sesskey, "LocalEcho", cfg->localecho);
198 write_setting_i(sesskey, "LocalEdit", cfg->localedit);
199 write_setting_s(sesskey, "Answerback", cfg->answerback);
200 write_setting_i(sesskey, "AlwaysOnTop", cfg->alwaysontop);
201 write_setting_i(sesskey, "HideMousePtr", cfg->hide_mouseptr);
202 write_setting_i(sesskey, "SunkenEdge", cfg->sunken_edge);
203 write_setting_i(sesskey, "CurType", cfg->cursor_type);
204 write_setting_i(sesskey, "BlinkCur", cfg->blink_cur);
205 write_setting_i(sesskey, "Beep", cfg->beep);
206 write_setting_i(sesskey, "BeepInd", cfg->beep_ind);
207 write_setting_s(sesskey, "BellWaveFile", cfg->bell_wavefile);
208 write_setting_i(sesskey, "BellOverload", cfg->bellovl);
209 write_setting_i(sesskey, "BellOverloadN", cfg->bellovl_n);
210 write_setting_i(sesskey, "BellOverloadT", cfg->bellovl_t);
211 write_setting_i(sesskey, "BellOverloadS", cfg->bellovl_s);
212 write_setting_i(sesskey, "ScrollbackLines", cfg->savelines);
213 write_setting_i(sesskey, "DECOriginMode", cfg->dec_om);
214 write_setting_i(sesskey, "AutoWrapMode", cfg->wrap_mode);
215 write_setting_i(sesskey, "LFImpliesCR", cfg->lfhascr);
216 write_setting_i(sesskey, "WinNameAlways", cfg->win_name_always);
217 write_setting_s(sesskey, "WinTitle", cfg->wintitle);
218 write_setting_i(sesskey, "TermWidth", cfg->width);
219 write_setting_i(sesskey, "TermHeight", cfg->height);
220 write_setting_s(sesskey, "Font", cfg->font);
221 write_setting_i(sesskey, "FontIsBold", cfg->fontisbold);
222 write_setting_i(sesskey, "FontCharSet", cfg->fontcharset);
223 write_setting_i(sesskey, "FontHeight", cfg->fontheight);
224 write_setting_i(sesskey, "FontVTMode", cfg->vtmode);
225 write_setting_i(sesskey, "TryPalette", cfg->try_palette);
226 write_setting_i(sesskey, "BoldAsColour", cfg->bold_colour);
227 for (i = 0; i < 22; i++) {
228 char buf[20], buf2[30];
229 sprintf(buf, "Colour%d", i);
230 sprintf(buf2, "%d,%d,%d", cfg->colours[i][0],
231 cfg->colours[i][1], cfg->colours[i][2]);
232 write_setting_s(sesskey, buf, buf2);
234 write_setting_i(sesskey, "RawCNP", cfg->rawcnp);
235 write_setting_i(sesskey, "MouseIsXterm", cfg->mouse_is_xterm);
236 write_setting_i(sesskey, "MouseOverride", cfg->mouse_override);
237 for (i = 0; i < 256; i += 32) {
238 char buf[20], buf2[256];
240 sprintf(buf, "Wordness%d", i);
242 for (j = i; j < i + 32; j++) {
243 sprintf(buf2 + strlen(buf2), "%s%d",
244 (*buf2 ? "," : ""), cfg->wordness[j]);
246 write_setting_s(sesskey, buf, buf2);
248 write_setting_s(sesskey, "LineCodePage", cfg->line_codepage);
249 write_setting_i(sesskey, "ScrollBar", cfg->scrollbar);
250 write_setting_i(sesskey, "ScrollOnKey", cfg->scroll_on_key);
251 write_setting_i(sesskey, "ScrollOnDisp", cfg->scroll_on_disp);
252 write_setting_i(sesskey, "LockSize", cfg->locksize);
253 write_setting_i(sesskey, "BCE", cfg->bce);
254 write_setting_i(sesskey, "BlinkText", cfg->blinktext);
255 write_setting_i(sesskey, "X11Forward", cfg->x11_forward);
256 write_setting_s(sesskey, "X11Display", cfg->x11_display);
257 write_setting_i(sesskey, "LocalPortAcceptAll", cfg->lport_acceptall);
259 char buf[2 * sizeof(cfg->portfwd)], *p, *q;
265 if (c == '=' || c == ',' || c == '\\')
275 write_setting_s(sesskey, "PortForwardings", buf);
278 close_settings_w(sesskey);
281 void load_settings(char *section, int do_host, Config * cfg)
287 sesskey = open_settings_r(section);
289 cfg->ssh_subsys = 0; /* FIXME: load this properly */
290 cfg->remote_cmd_ptr = cfg->remote_cmd;
291 cfg->remote_cmd_ptr2 = NULL;
293 gpps(sesskey, "HostName", "", cfg->host, sizeof(cfg->host));
294 gppi(sesskey, "PortNumber", default_port, &cfg->port);
295 gpps(sesskey, "LogFileName", "putty.log",
296 cfg->logfilename, sizeof(cfg->logfilename));
297 gppi(sesskey, "LogType", 0, &cfg->logtype);
298 gppi(sesskey, "LogFileClash", LGXF_ASK, &cfg->logxfovr);
300 gpps(sesskey, "Protocol", "default", prot, 10);
301 cfg->protocol = default_protocol;
302 for (i = 0; backends[i].name != NULL; i++)
303 if (!strcmp(prot, backends[i].name)) {
304 cfg->protocol = backends[i].protocol;
308 gppi(sesskey, "CloseOnExit", COE_NORMAL, &cfg->close_on_exit);
309 gppi(sesskey, "WarnOnClose", 1, &cfg->warn_on_close);
311 /* This is two values for backward compatibility with 0.50/0.51 */
312 int pingmin, pingsec;
313 gppi(sesskey, "PingInterval", 0, &pingmin);
314 gppi(sesskey, "PingIntervalSecs", 0, &pingsec);
315 cfg->ping_interval = pingmin * 60 + pingsec;
317 gpps(sesskey, "TerminalType", "xterm", cfg->termtype,
318 sizeof(cfg->termtype));
319 gpps(sesskey, "TerminalSpeed", "38400,38400", cfg->termspeed,
320 sizeof(cfg->termspeed));
322 char buf[2 * sizeof(cfg->environmt)], *p, *q;
323 gpps(sesskey, "Environment", "", buf, sizeof(buf));
327 while (*p && *p != ',') {
341 gpps(sesskey, "UserName", "", cfg->username, sizeof(cfg->username));
342 gpps(sesskey, "LocalUserName", "", cfg->localusername,
343 sizeof(cfg->localusername));
344 gppi(sesskey, "NoPTY", 0, &cfg->nopty);
345 gppi(sesskey, "Compression", 0, &cfg->compression);
346 gppi(sesskey, "AgentFwd", 0, &cfg->agentfwd);
347 gprefs(sesskey, "Cipher", "\0",
348 ciphernames, CIPHER_MAX, cfg->ssh_cipherlist);
349 gppi(sesskey, "SshProt", 1, &cfg->sshprot);
350 gppi(sesskey, "BuggyMAC", 0, &cfg->buggymac);
351 gppi(sesskey, "AuthTIS", 0, &cfg->try_tis_auth);
352 gpps(sesskey, "PublicKeyFile", "", cfg->keyfile, sizeof(cfg->keyfile));
353 gpps(sesskey, "RemoteCommand", "", cfg->remote_cmd,
354 sizeof(cfg->remote_cmd));
355 gppi(sesskey, "RFCEnviron", 0, &cfg->rfc_environ);
356 gppi(sesskey, "PassiveTelnet", 0, &cfg->passive_telnet);
357 gppi(sesskey, "BackspaceIsDelete", 1, &cfg->bksp_is_delete);
358 gppi(sesskey, "RXVTHomeEnd", 0, &cfg->rxvt_homeend);
359 gppi(sesskey, "LinuxFunctionKeys", 0, &cfg->funky_type);
360 gppi(sesskey, "NoApplicationKeys", 0, &cfg->no_applic_k);
361 gppi(sesskey, "NoApplicationCursors", 0, &cfg->no_applic_c);
362 gppi(sesskey, "ApplicationCursorKeys", 0, &cfg->app_cursor);
363 gppi(sesskey, "ApplicationKeypad", 0, &cfg->app_keypad);
364 gppi(sesskey, "NetHackKeypad", 0, &cfg->nethack_keypad);
365 gppi(sesskey, "AltF4", 1, &cfg->alt_f4);
366 gppi(sesskey, "AltSpace", 0, &cfg->alt_space);
367 gppi(sesskey, "AltOnly", 0, &cfg->alt_only);
368 gppi(sesskey, "ComposeKey", 0, &cfg->compose_key);
369 gppi(sesskey, "CtrlAltKeys", 1, &cfg->ctrlaltkeys);
370 gppi(sesskey, "TelnetKey", 0, &cfg->telnet_keyboard);
371 gppi(sesskey, "LocalEcho", LD_BACKEND, &cfg->localecho);
372 gppi(sesskey, "LocalEdit", LD_BACKEND, &cfg->localedit);
373 gpps(sesskey, "Answerback", "PuTTY", cfg->answerback,
374 sizeof(cfg->answerback));
375 gppi(sesskey, "AlwaysOnTop", 0, &cfg->alwaysontop);
376 gppi(sesskey, "HideMousePtr", 0, &cfg->hide_mouseptr);
377 gppi(sesskey, "SunkenEdge", 0, &cfg->sunken_edge);
378 gppi(sesskey, "CurType", 0, &cfg->cursor_type);
379 gppi(sesskey, "BlinkCur", 0, &cfg->blink_cur);
380 /* pedantic compiler tells me I can't use &cfg->beep as an int * :-) */
381 gppi(sesskey, "Beep", 1, &i); cfg->beep = i;
382 gppi(sesskey, "BeepInd", 0, &i); cfg->beep_ind = i;
383 gpps(sesskey, "BellWaveFile", "", cfg->bell_wavefile,
384 sizeof(cfg->bell_wavefile));
385 gppi(sesskey, "BellOverload", 1, &cfg->bellovl);
386 gppi(sesskey, "BellOverloadN", 5, &cfg->bellovl_n);
387 gppi(sesskey, "BellOverloadT", 2000, &cfg->bellovl_t);
388 gppi(sesskey, "BellOverloadS", 5000, &cfg->bellovl_s);
389 gppi(sesskey, "ScrollbackLines", 200, &cfg->savelines);
390 gppi(sesskey, "DECOriginMode", 0, &cfg->dec_om);
391 gppi(sesskey, "AutoWrapMode", 1, &cfg->wrap_mode);
392 gppi(sesskey, "LFImpliesCR", 0, &cfg->lfhascr);
393 gppi(sesskey, "WinNameAlways", 0, &cfg->win_name_always);
394 gpps(sesskey, "WinTitle", "", cfg->wintitle, sizeof(cfg->wintitle));
395 gppi(sesskey, "TermWidth", 80, &cfg->width);
396 gppi(sesskey, "TermHeight", 24, &cfg->height);
397 gpps(sesskey, "Font", "Courier", cfg->font, sizeof(cfg->font));
398 gppi(sesskey, "FontIsBold", 0, &cfg->fontisbold);
399 gppi(sesskey, "FontCharSet", ANSI_CHARSET, &cfg->fontcharset);
400 gppi(sesskey, "FontHeight", 10, &cfg->fontheight);
401 if (cfg->fontheight < 0) {
403 HDC hdc = GetDC(NULL);
404 int logpix = GetDeviceCaps(hdc, LOGPIXELSY);
405 ReleaseDC(NULL, hdc);
407 oldh = -cfg->fontheight;
408 newh = MulDiv(oldh, 72, logpix) + 1;
409 if (MulDiv(newh, logpix, 72) > oldh)
411 cfg->fontheight = newh;
413 gppi(sesskey, "FontVTMode", VT_OEMANSI, (int *) &cfg->vtmode);
414 gppi(sesskey, "TryPalette", 0, &cfg->try_palette);
415 gppi(sesskey, "BoldAsColour", 1, &cfg->bold_colour);
416 for (i = 0; i < 22; i++) {
417 static char *defaults[] = {
418 "187,187,187", "255,255,255", "0,0,0", "85,85,85", "0,0,0",
419 "0,255,0", "0,0,0", "85,85,85", "187,0,0", "255,85,85",
420 "0,187,0", "85,255,85", "187,187,0", "255,255,85", "0,0,187",
421 "85,85,255", "187,0,187", "255,85,255", "0,187,187",
422 "85,255,255", "187,187,187", "255,255,255"
424 char buf[20], buf2[30];
426 sprintf(buf, "Colour%d", i);
427 gpps(sesskey, buf, defaults[i], buf2, sizeof(buf2));
428 if (sscanf(buf2, "%d,%d,%d", &c0, &c1, &c2) == 3) {
429 cfg->colours[i][0] = c0;
430 cfg->colours[i][1] = c1;
431 cfg->colours[i][2] = c2;
434 gppi(sesskey, "RawCNP", 0, &cfg->rawcnp);
435 gppi(sesskey, "MouseIsXterm", 0, &cfg->mouse_is_xterm);
436 gppi(sesskey, "MouseOverride", 1, &cfg->mouse_override);
437 for (i = 0; i < 256; i += 32) {
438 static char *defaults[] = {
439 "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0",
440 "0,1,2,1,1,1,1,1,1,1,1,1,1,2,2,2,2,2,2,2,2,2,2,2,2,2,1,1,1,1,1,1",
441 "1,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,1,1,1,1,2",
442 "1,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,1,1,1,1,1",
443 "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1",
444 "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1",
445 "2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,1,2,2,2,2,2,2,2,2",
446 "2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,1,2,2,2,2,2,2,2,2"
448 char buf[20], buf2[256], *p;
450 sprintf(buf, "Wordness%d", i);
451 gpps(sesskey, buf, defaults[i / 32], buf2, sizeof(buf2));
453 for (j = i; j < i + 32; j++) {
455 while (*p && *p != ',')
459 cfg->wordness[j] = atoi(q);
463 * The empty default for LineCodePage will be converted later
464 * into a plausible default for the locale.
466 gpps(sesskey, "LineCodePage", "", cfg->line_codepage,
467 sizeof(cfg->line_codepage));
468 gppi(sesskey, "ScrollBar", 1, &cfg->scrollbar);
469 gppi(sesskey, "ScrollOnKey", 0, &cfg->scroll_on_key);
470 gppi(sesskey, "ScrollOnDisp", 1, &cfg->scroll_on_disp);
471 gppi(sesskey, "LockSize", 0, &cfg->locksize);
472 gppi(sesskey, "BCE", 0, &cfg->bce);
473 gppi(sesskey, "BlinkText", 0, &cfg->blinktext);
474 gppi(sesskey, "X11Forward", 0, &cfg->x11_forward);
475 gpps(sesskey, "X11Display", "localhost:0", cfg->x11_display,
476 sizeof(cfg->x11_display));
478 gppi(sesskey, "LocalPortAcceptAll", 0, &cfg->lport_acceptall);
480 char buf[2 * sizeof(cfg->portfwd)], *p, *q;
481 gpps(sesskey, "PortForwardings", "", buf, sizeof(buf));
485 while (*p && *p != ',') {
500 close_settings_r(sesskey);
503 void do_defaults(char *session, Config * cfg)
506 load_settings(session, TRUE, cfg);
508 load_settings("Default Settings", FALSE, cfg);
511 static int sessioncmp(const void *av, const void *bv)
513 const char *a = *(const char *const *) av;
514 const char *b = *(const char *const *) bv;
517 * Alphabetical order, except that "Default Settings" is a
518 * special case and comes first.
520 if (!strcmp(a, "Default Settings"))
521 return -1; /* a comes first */
522 if (!strcmp(b, "Default Settings"))
523 return +1; /* b comes first */
524 return strcmp(a, b); /* otherwise, compare normally */
527 void get_sesslist(int allocate)
529 static char otherbuf[2048];
531 int buflen, bufsize, i;
537 if ((handle = enum_settings_start()) == NULL)
540 buflen = bufsize = 0;
543 ret = enum_settings_next(handle, otherbuf, sizeof(otherbuf));
545 int len = strlen(otherbuf) + 1;
546 if (bufsize < buflen + len) {
547 bufsize = buflen + len + 2048;
548 buffer = srealloc(buffer, bufsize);
550 strcpy(buffer + buflen, otherbuf);
551 buflen += strlen(buffer + buflen) + 1;
554 enum_settings_finish(handle);
555 buffer = srealloc(buffer, buflen + 1);
556 buffer[buflen] = '\0';
559 * Now set up the list of sessions. Note that "Default
560 * Settings" must always be claimed to exist, even if it
565 nsessions = 1; /* "Default Settings" counts as one */
567 if (strcmp(p, "Default Settings"))
574 sessions = smalloc((nsessions + 1) * sizeof(char *));
575 sessions[0] = "Default Settings";
579 if (strcmp(p, "Default Settings"))
586 qsort(sessions, i, sizeof(char *), sessioncmp);