settings.c

   1 /*
   2  * settings.c: read and write saved sessions.
   3  */
   4
   5 #include <windows.h>
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include "putty.h"
   9 #include "storage.h"
  10
  11 static void gpps(void *handle, char *name, char *def, char *val, int len)
  12 {
  13     if (!read_setting_s(handle, name, val, len)) {
  14         strncpy(val, def, len);
  15         val[len - 1] = '\0';
  16     }
  17 }
  18
  19 static void gppi(void *handle, char *name, int def, int *i)
  20 {
  21     *i = read_setting_i(handle, name, def);
  22 }
  23
  24 void save_settings(char *section, int do_host, Config * cfg)
  25 {
  26     int i;
  27     char *p;
  28     void *sesskey;
  29
  30     sesskey = open_settings_w(section);
  31     if (!sesskey)
  32         return;
  33
  34     write_setting_i(sesskey, "Present", 1);
  35     if (do_host) {
  36         write_setting_s(sesskey, "HostName", cfg->host);
  37         write_setting_s(sesskey, "LogFileName", cfg->logfilename);
  38         write_setting_i(sesskey, "LogType", cfg->logtype);
  39         write_setting_i(sesskey, "LogFileClash", cfg->logxfovr);
  40     }
  41     p = "raw";
  42     for (i = 0; backends[i].name != NULL; i++)
  43         if (backends[i].protocol == cfg->protocol) {
  44             p = backends[i].name;
  45             break;
  46         }
  47     write_setting_s(sesskey, "Protocol", p);
  48     write_setting_i(sesskey, "PortNumber", cfg->port);
  49     write_setting_i(sesskey, "CloseOnExit", cfg->close_on_exit);
  50     write_setting_i(sesskey, "WarnOnClose", !!cfg->warn_on_close);
  51     write_setting_i(sesskey, "PingInterval", cfg->ping_interval / 60);  /* minutes */
  52     write_setting_i(sesskey, "PingIntervalSecs", cfg->ping_interval % 60);      /* seconds */
  53     write_setting_s(sesskey, "TerminalType", cfg->termtype);
  54     write_setting_s(sesskey, "TerminalSpeed", cfg->termspeed);
  55     {
  56         char buf[2 * sizeof(cfg->environmt)], *p, *q;
  57         p = buf;
  58         q = cfg->environmt;
  59         while (*q) {
  60             while (*q) {
  61                 int c = *q++;
  62                 if (c == '=' || c == ',' || c == '\\')
  63                     *p++ = '\\';
  64                 if (c == '\t')
  65                     c = '=';
  66                 *p++ = c;
  67             }
  68             *p++ = ',';
  69             q++;
  70         }
  71         *p = '\0';
  72         write_setting_s(sesskey, "Environment", buf);
  73     }
  74     write_setting_s(sesskey, "UserName", cfg->username);
  75     write_setting_s(sesskey, "LocalUserName", cfg->localusername);
  76     write_setting_i(sesskey, "NoPTY", cfg->nopty);
  77     write_setting_i(sesskey, "Compression", cfg->compression);
  78     write_setting_i(sesskey, "AgentFwd", cfg->agentfwd);
  79     write_setting_s(sesskey, "Cipher",
  80                     cfg->cipher == CIPHER_BLOWFISH ? "blowfish" :
  81                     cfg->cipher == CIPHER_DES ? "des" :
  82                     cfg->cipher == CIPHER_AES ? "aes" : "3des");
  83     write_setting_i(sesskey, "AuthTIS", cfg->try_tis_auth);
  84     write_setting_i(sesskey, "SshProt", cfg->sshprot);
  85     write_setting_i(sesskey, "BuggyMAC", cfg->buggymac);
  86     write_setting_s(sesskey, "PublicKeyFile", cfg->keyfile);
  87     write_setting_s(sesskey, "RemoteCommand", cfg->remote_cmd);
  88     write_setting_i(sesskey, "RFCEnviron", cfg->rfc_environ);
  89     write_setting_i(sesskey, "PassiveTelnet", cfg->passive_telnet);
  90     write_setting_i(sesskey, "BackspaceIsDelete", cfg->bksp_is_delete);
  91     write_setting_i(sesskey, "RXVTHomeEnd", cfg->rxvt_homeend);
  92     write_setting_i(sesskey, "LinuxFunctionKeys", cfg->funky_type);
  93     write_setting_i(sesskey, "NoApplicationKeys", cfg->no_applic_k);
  94     write_setting_i(sesskey, "NoApplicationCursors", cfg->no_applic_c);
  95     write_setting_i(sesskey, "ApplicationCursorKeys", cfg->app_cursor);
  96     write_setting_i(sesskey, "ApplicationKeypad", cfg->app_keypad);
  97     write_setting_i(sesskey, "NetHackKeypad", cfg->nethack_keypad);
  98     write_setting_i(sesskey, "AltF4", cfg->alt_f4);
  99     write_setting_i(sesskey, "AltSpace", cfg->alt_space);
 100     write_setting_i(sesskey, "AltOnly", cfg->alt_only);
 101     write_setting_i(sesskey, "ComposeKey", cfg->compose_key);
 102     write_setting_i(sesskey, "CtrlAltKeys", cfg->ctrlaltkeys);
 103     write_setting_i(sesskey, "TelnetKey", cfg->telnet_keyboard);
 104     write_setting_i(sesskey, "LocalEcho", cfg->localecho);
 105     write_setting_i(sesskey, "LocalEdit", cfg->localedit);
 106     write_setting_s(sesskey, "Answerback", cfg->answerback);
 107     write_setting_i(sesskey, "AlwaysOnTop", cfg->alwaysontop);
 108     write_setting_i(sesskey, "HideMousePtr", cfg->hide_mouseptr);
 109     write_setting_i(sesskey, "SunkenEdge", cfg->sunken_edge);
 110     write_setting_i(sesskey, "CurType", cfg->cursor_type);
 111     write_setting_i(sesskey, "BlinkCur", cfg->blink_cur);
 112     write_setting_i(sesskey, "Beep", cfg->beep);
 113     write_setting_s(sesskey, "BellWaveFile", cfg->bell_wavefile);
 114     write_setting_i(sesskey, "BellOverload", cfg->bellovl);
 115     write_setting_i(sesskey, "BellOverloadN", cfg->bellovl_n);
 116     write_setting_i(sesskey, "BellOverloadT", cfg->bellovl_t);
 117     write_setting_i(sesskey, "BellOverloadS", cfg->bellovl_s);
 118     write_setting_i(sesskey, "ScrollbackLines", cfg->savelines);
 119     write_setting_i(sesskey, "DECOriginMode", cfg->dec_om);
 120     write_setting_i(sesskey, "AutoWrapMode", cfg->wrap_mode);
 121     write_setting_i(sesskey, "LFImpliesCR", cfg->lfhascr);
 122     write_setting_i(sesskey, "WinNameAlways", cfg->win_name_always);
 123     write_setting_s(sesskey, "WinTitle", cfg->wintitle);
 124     write_setting_i(sesskey, "TermWidth", cfg->width);
 125     write_setting_i(sesskey, "TermHeight", cfg->height);
 126     write_setting_s(sesskey, "Font", cfg->font);
 127     write_setting_i(sesskey, "FontIsBold", cfg->fontisbold);
 128     write_setting_i(sesskey, "FontCharSet", cfg->fontcharset);
 129     write_setting_i(sesskey, "FontHeight", cfg->fontheight);
 130     write_setting_i(sesskey, "FontVTMode", cfg->vtmode);
 131     write_setting_i(sesskey, "TryPalette", cfg->try_palette);
 132     write_setting_i(sesskey, "BoldAsColour", cfg->bold_colour);
 133     for (i = 0; i < 22; i++) {
 134         char buf[20], buf2[30];
 135         sprintf(buf, "Colour%d", i);
 136         sprintf(buf2, "%d,%d,%d", cfg->colours[i][0],
 137                 cfg->colours[i][1], cfg->colours[i][2]);
 138         write_setting_s(sesskey, buf, buf2);
 139     }
 140     write_setting_i(sesskey, "RawCNP", cfg->rawcnp);
 141     write_setting_i(sesskey, "MouseIsXterm", cfg->mouse_is_xterm);
 142     for (i = 0; i < 256; i += 32) {
 143         char buf[20], buf2[256];
 144         int j;
 145         sprintf(buf, "Wordness%d", i);
 146         *buf2 = '\0';
 147         for (j = i; j < i + 32; j++) {
 148             sprintf(buf2 + strlen(buf2), "%s%d",
 149                     (*buf2 ? "," : ""), cfg->wordness[j]);
 150         }
 151         write_setting_s(sesskey, buf, buf2);
 152     }
 153     write_setting_s(sesskey, "LineCodePage", cfg->line_codepage);
 154     write_setting_i(sesskey, "ScrollBar", cfg->scrollbar);
 155     write_setting_i(sesskey, "ScrollOnKey", cfg->scroll_on_key);
 156     write_setting_i(sesskey, "ScrollOnDisp", cfg->scroll_on_disp);
 157     write_setting_i(sesskey, "LockSize", cfg->locksize);
 158     write_setting_i(sesskey, "BCE", cfg->bce);
 159     write_setting_i(sesskey, "BlinkText", cfg->blinktext);
 160     write_setting_i(sesskey, "X11Forward", cfg->x11_forward);
 161     write_setting_s(sesskey, "X11Display", cfg->x11_display);
 162
 163     close_settings_w(sesskey);
 164 }
 165
 166 void load_settings(char *section, int do_host, Config * cfg)
 167 {
 168     int i;
 169     char prot[10];
 170     void *sesskey;
 171
 172     sesskey = open_settings_r(section);
 173
 174     cfg->ssh_subsys = 0;               /* FIXME: load this properly */
 175     cfg->remote_cmd_ptr = cfg->remote_cmd;
 176
 177     gpps(sesskey, "HostName", "", cfg->host, sizeof(cfg->host));
 178     gppi(sesskey, "PortNumber", default_port, &cfg->port);
 179     gpps(sesskey, "LogFileName", "putty.log",
 180          cfg->logfilename, sizeof(cfg->logfilename));
 181     gppi(sesskey, "LogType", 0, &cfg->logtype);
 182     gppi(sesskey, "LogFileClash", LGXF_ASK, &cfg->logxfovr);
 183
 184     gpps(sesskey, "Protocol", "default", prot, 10);
 185     cfg->protocol = default_protocol;
 186     for (i = 0; backends[i].name != NULL; i++)
 187         if (!strcmp(prot, backends[i].name)) {
 188             cfg->protocol = backends[i].protocol;
 189             break;
 190         }
 191
 192     gppi(sesskey, "CloseOnExit", COE_NORMAL, &cfg->close_on_exit);
 193     gppi(sesskey, "WarnOnClose", 1, &cfg->warn_on_close);
 194     {
 195         /* This is two values for backward compatibility with 0.50/0.51 */
 196         int pingmin, pingsec;
 197         gppi(sesskey, "PingInterval", 0, &pingmin);
 198         gppi(sesskey, "PingIntervalSecs", 0, &pingsec);
 199         cfg->ping_interval = pingmin * 60 + pingsec;
 200     }
 201     gpps(sesskey, "TerminalType", "xterm", cfg->termtype,
 202          sizeof(cfg->termtype));
 203     gpps(sesskey, "TerminalSpeed", "38400,38400", cfg->termspeed,
 204          sizeof(cfg->termspeed));
 205     {
 206         char buf[2 * sizeof(cfg->environmt)], *p, *q;
 207         gpps(sesskey, "Environment", "", buf, sizeof(buf));
 208         p = buf;
 209         q = cfg->environmt;
 210         while (*p) {
 211             while (*p && *p != ',') {
 212                 int c = *p++;
 213                 if (c == '=')
 214                     c = '\t';
 215                 if (c == '\\')
 216                     c = *p++;
 217                 *q++ = c;
 218             }
 219             if (*p == ',')
 220                 p++;
 221             *q++ = '\0';
 222         }
 223         *q = '\0';
 224     }
 225     gpps(sesskey, "UserName", "", cfg->username, sizeof(cfg->username));
 226     gpps(sesskey, "LocalUserName", "", cfg->localusername,
 227          sizeof(cfg->localusername));
 228     gppi(sesskey, "NoPTY", 0, &cfg->nopty);
 229     gppi(sesskey, "Compression", 0, &cfg->compression);
 230     gppi(sesskey, "AgentFwd", 0, &cfg->agentfwd);
 231     {
 232         char cipher[10];
 233         gpps(sesskey, "Cipher", "3des", cipher, 10);
 234         if (!strcmp(cipher, "blowfish"))
 235             cfg->cipher = CIPHER_BLOWFISH;
 236         else if (!strcmp(cipher, "des"))
 237             cfg->cipher = CIPHER_DES;
 238         else if (!strcmp(cipher, "aes"))
 239             cfg->cipher = CIPHER_AES;
 240         else
 241             cfg->cipher = CIPHER_3DES;
 242     }
 243     gppi(sesskey, "SshProt", 1, &cfg->sshprot);
 244     gppi(sesskey, "BuggyMAC", 0, &cfg->buggymac);
 245     gppi(sesskey, "AuthTIS", 0, &cfg->try_tis_auth);
 246     gpps(sesskey, "PublicKeyFile", "", cfg->keyfile, sizeof(cfg->keyfile));
 247     gpps(sesskey, "RemoteCommand", "", cfg->remote_cmd,
 248          sizeof(cfg->remote_cmd));
 249     gppi(sesskey, "RFCEnviron", 0, &cfg->rfc_environ);
 250     gppi(sesskey, "PassiveTelnet", 0, &cfg->passive_telnet);
 251     gppi(sesskey, "BackspaceIsDelete", 1, &cfg->bksp_is_delete);
 252     gppi(sesskey, "RXVTHomeEnd", 0, &cfg->rxvt_homeend);
 253     gppi(sesskey, "LinuxFunctionKeys", 0, &cfg->funky_type);
 254     gppi(sesskey, "NoApplicationKeys", 0, &cfg->no_applic_k);
 255     gppi(sesskey, "NoApplicationCursors", 0, &cfg->no_applic_c);
 256     gppi(sesskey, "ApplicationCursorKeys", 0, &cfg->app_cursor);
 257     gppi(sesskey, "ApplicationKeypad", 0, &cfg->app_keypad);
 258     gppi(sesskey, "NetHackKeypad", 0, &cfg->nethack_keypad);
 259     gppi(sesskey, "AltF4", 1, &cfg->alt_f4);
 260     gppi(sesskey, "AltSpace", 0, &cfg->alt_space);
 261     gppi(sesskey, "AltOnly", 0, &cfg->alt_only);
 262     gppi(sesskey, "ComposeKey", 0, &cfg->compose_key);
 263     gppi(sesskey, "CtrlAltKeys", 1, &cfg->ctrlaltkeys);
 264     gppi(sesskey, "TelnetKey", 0, &cfg->telnet_keyboard);
 265     gppi(sesskey, "LocalEcho", LD_BACKEND, &cfg->localecho);
 266     gppi(sesskey, "LocalEdit", LD_BACKEND, &cfg->localedit);
 267     gpps(sesskey, "Answerback", "PuTTY", cfg->answerback,
 268          sizeof(cfg->answerback));
 269     gppi(sesskey, "AlwaysOnTop", 0, &cfg->alwaysontop);
 270     gppi(sesskey, "HideMousePtr", 0, &cfg->hide_mouseptr);
 271     gppi(sesskey, "SunkenEdge", 0, &cfg->sunken_edge);
 272     gppi(sesskey, "CurType", 0, &cfg->cursor_type);
 273     gppi(sesskey, "BlinkCur", 0, &cfg->blink_cur);
 274     gppi(sesskey, "Beep", 1, &cfg->beep);
 275     gpps(sesskey, "BellWaveFile", "", cfg->bell_wavefile,
 276          sizeof(cfg->bell_wavefile));
 277     gppi(sesskey, "BellOverload", 1, &cfg->bellovl);
 278     gppi(sesskey, "BellOverloadN", 5, &cfg->bellovl_n);
 279     gppi(sesskey, "BellOverloadT", 2000, &cfg->bellovl_t);
 280     gppi(sesskey, "BellOverloadS", 5000, &cfg->bellovl_s);
 281     gppi(sesskey, "ScrollbackLines", 200, &cfg->savelines);
 282     gppi(sesskey, "DECOriginMode", 0, &cfg->dec_om);
 283     gppi(sesskey, "AutoWrapMode", 1, &cfg->wrap_mode);
 284     gppi(sesskey, "LFImpliesCR", 0, &cfg->lfhascr);
 285     gppi(sesskey, "WinNameAlways", 0, &cfg->win_name_always);
 286     gpps(sesskey, "WinTitle", "", cfg->wintitle, sizeof(cfg->wintitle));
 287     gppi(sesskey, "TermWidth", 80, &cfg->width);
 288     gppi(sesskey, "TermHeight", 24, &cfg->height);
 289     gpps(sesskey, "Font", "Courier", cfg->font, sizeof(cfg->font));
 290     gppi(sesskey, "FontIsBold", 0, &cfg->fontisbold);
 291     gppi(sesskey, "FontCharSet", ANSI_CHARSET, &cfg->fontcharset);
 292     gppi(sesskey, "FontHeight", 10, &cfg->fontheight);
 293     if (cfg->fontheight < 0) {
 294         int oldh, newh;
 295         HDC hdc = GetDC(NULL);
 296         int logpix = GetDeviceCaps(hdc, LOGPIXELSY);
 297         ReleaseDC(NULL, hdc);
 298
 299         oldh = -cfg->fontheight;
 300         newh = MulDiv(oldh, 72, logpix) + 1;
 301         if (MulDiv(newh, logpix, 72) > oldh)
 302             newh--;
 303         cfg->fontheight = newh;
 304     }
 305     gppi(sesskey, "FontVTMode", VT_OEMANSI, (int *) &cfg->vtmode);
 306     gppi(sesskey, "TryPalette", 0, &cfg->try_palette);
 307     gppi(sesskey, "BoldAsColour", 1, &cfg->bold_colour);
 308     for (i = 0; i < 22; i++) {
 309         static char *defaults[] = {
 310             "187,187,187", "255,255,255", "0,0,0", "85,85,85", "0,0,0",
 311             "0,255,0", "0,0,0", "85,85,85", "187,0,0", "255,85,85",
 312             "0,187,0", "85,255,85", "187,187,0", "255,255,85", "0,0,187",
 313             "85,85,255", "187,0,187", "255,85,255", "0,187,187",
 314             "85,255,255", "187,187,187", "255,255,255"
 315         };
 316         char buf[20], buf2[30];
 317         int c0, c1, c2;
 318         sprintf(buf, "Colour%d", i);
 319         gpps(sesskey, buf, defaults[i], buf2, sizeof(buf2));
 320         if (sscanf(buf2, "%d,%d,%d", &c0, &c1, &c2) == 3) {
 321             cfg->colours[i][0] = c0;
 322             cfg->colours[i][1] = c1;
 323             cfg->colours[i][2] = c2;
 324         }
 325     }
 326     gppi(sesskey, "RawCNP", 0, &cfg->rawcnp);
 327     gppi(sesskey, "MouseIsXterm", 0, &cfg->mouse_is_xterm);
 328     for (i = 0; i < 256; i += 32) {
 329         static char *defaults[] = {
 330             "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",
 331             "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",
 332             "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",
 333             "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",
 334             "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",
 335             "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",
 336             "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",
 337             "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"
 338         };
 339         char buf[20], buf2[256], *p;
 340         int j;
 341         sprintf(buf, "Wordness%d", i);
 342         gpps(sesskey, buf, defaults[i / 32], buf2, sizeof(buf2));
 343         p = buf2;
 344         for (j = i; j < i + 32; j++) {
 345             char *q = p;
 346             while (*p && *p != ',')
 347                 p++;
 348             if (*p == ',')
 349                 *p++ = '\0';
 350             cfg->wordness[j] = atoi(q);
 351         }
 352     }
 353     gpps(sesskey, "LineCodePage", "", cfg->line_codepage,
 354          sizeof(cfg->line_codepage));
 355     gppi(sesskey, "ScrollBar", 1, &cfg->scrollbar);
 356     gppi(sesskey, "ScrollOnKey", 0, &cfg->scroll_on_key);
 357     gppi(sesskey, "ScrollOnDisp", 1, &cfg->scroll_on_disp);
 358     gppi(sesskey, "LockSize", 0, &cfg->locksize);
 359     gppi(sesskey, "BCE", 0, &cfg->bce);
 360     gppi(sesskey, "BlinkText", 0, &cfg->blinktext);
 361     gppi(sesskey, "X11Forward", 0, &cfg->x11_forward);
 362     gpps(sesskey, "X11Display", "localhost:0", cfg->x11_display,
 363          sizeof(cfg->x11_display));
 364
 365     close_settings_r(sesskey);
 366 }
 367
 368 void do_defaults(char *session, Config * cfg)
 369 {
 370     if (session)
 371         load_settings(session, TRUE, cfg);
 372     else
 373         load_settings("Default Settings", FALSE, cfg);
 374 }
 375
 376 static int sessioncmp(const void *av, const void *bv)
 377 {
 378     const char *a = *(const char *const *) av;
 379     const char *b = *(const char *const *) bv;
 380
 381     /*
 382      * Alphabetical order, except that "Default Settings" is a
 383      * special case and comes first.
 384      */
 385     if (!strcmp(a, "Default Settings"))
 386         return -1;                     /* a comes first */
 387     if (!strcmp(b, "Default Settings"))
 388         return +1;                     /* b comes first */
 389     return strcmp(a, b);               /* otherwise, compare normally */
 390 }
 391
 392 void get_sesslist(int allocate)
 393 {
 394     static char otherbuf[2048];
 395     static char *buffer;
 396     int buflen, bufsize, i;
 397     char *p, *ret;
 398     void *handle;
 399
 400     if (allocate) {
 401
 402         if ((handle = enum_settings_start()) == NULL)
 403             return;
 404
 405         buflen = bufsize = 0;
 406         buffer = NULL;
 407         do {
 408             ret = enum_settings_next(handle, otherbuf, sizeof(otherbuf));
 409             if (ret) {
 410                 int len = strlen(otherbuf) + 1;
 411                 if (bufsize < buflen + len) {
 412                     bufsize = buflen + len + 2048;
 413                     buffer = srealloc(buffer, bufsize);
 414                 }
 415                 strcpy(buffer + buflen, otherbuf);
 416                 buflen += strlen(buffer + buflen) + 1;
 417             }
 418         } while (ret);
 419         enum_settings_finish(handle);
 420         buffer = srealloc(buffer, buflen + 1);
 421         buffer[buflen] = '\0';
 422
 423         /*
 424          * Now set up the list of sessions. Note that "Default
 425          * Settings" must always be claimed to exist, even if it
 426          * doesn't really.
 427          */
 428
 429         p = buffer;
 430         nsessions = 1;                 /* "Default Settings" counts as one */
 431         while (*p) {
 432             if (strcmp(p, "Default Settings"))
 433                 nsessions++;
 434             while (*p)
 435                 p++;
 436             p++;
 437         }
 438
 439         sessions = smalloc((nsessions + 1) * sizeof(char *));
 440         sessions[0] = "Default Settings";
 441         p = buffer;
 442         i = 1;
 443         while (*p) {
 444             if (strcmp(p, "Default Settings"))
 445                 sessions[i++] = p;
 446             while (*p)
 447                 p++;
 448             p++;
 449         }
 450
 451         qsort(sessions, i, sizeof(char *), sessioncmp);
 452     } else {
 453         sfree(buffer);
 454         sfree(sessions);
 455     }
 456 }