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