moved new score server setup values to separate setup file

This change prevents wiping out the player UUID when using the setup
file with an older game version that would remove all new setup file
entries when saving setup values. This would especially destroy the
player UUID, which could then not be recovered to its previous value
(while all other new setup values could easily be set back again).

Using a new, different setup file for the player UUID (and all other
new score server setup values) solves this problem.

diff --git a/src/files.c b/src/files.c
index 4efaa553b090521489388493b5cf1a8b9e06bdd9..afccc4a6a295f795d24171be61cf6ad705246e5d 100644 (file)
--- a/src/files.c
+++ b/src/files.c
@@ -9721,10 +9721,6 @@ static struct TokenInfo global_setup_tokens[] =
     TYPE_STRING,
     &setup.player_name,                                "player_name"
   },
     TYPE_STRING,
     &setup.player_name,                                "player_name"
   },

-  {
-    TYPE_STRING,
-    &setup.player_uuid,                                "player_uuid"
-  },

   {
     TYPE_SWITCH,
     &setup.multiple_users,                     "multiple_users"
   {
     TYPE_SWITCH,
     &setup.multiple_users,                     "multiple_users"


@@ -9953,26 +9949,6 @@ static struct TokenInfo global_setup_tokens[] =
     TYPE_STRING,
     &setup.network_server_hostname,            "network_server_hostname"
   },
     TYPE_STRING,
     &setup.network_server_hostname,            "network_server_hostname"
   },

-  {
-    TYPE_SWITCH,
-    &setup.use_api_server,          TEST_PREFIX        "use_api_server"
-  },
-  {
-    TYPE_STRING,
-    &setup.api_server_hostname,     TEST_PREFIX        "api_server_hostname"
-  },
-  {
-    TYPE_STRING,
-    &setup.api_server_password,     TEST_PREFIX        "api_server_password"
-  },
-  {
-    TYPE_SWITCH,
-    &setup.ask_for_uploading_tapes, TEST_PREFIX        "ask_for_uploading_tapes"
-  },
-  {
-    TYPE_SWITCH,
-    &setup.provide_uploading_tapes, TEST_PREFIX        "provide_uploading_tapes"
-  },

   {
     TYPE_STRING,
     &setup.touch.control_type,                 "touch.control_type"
   {
     TYPE_STRING,
     &setup.touch.control_type,                 "touch.control_type"


@@ -10023,6 +9999,34 @@ static struct TokenInfo auto_setup_tokens[] =
   },
 };
 
   },
 };
 

+static struct TokenInfo server_setup_tokens[] =
+{
+  {
+    TYPE_STRING,
+    &setup.player_uuid,                                "player_uuid"
+  },
+  {
+    TYPE_SWITCH,
+    &setup.use_api_server,          TEST_PREFIX        "use_api_server"
+  },
+  {
+    TYPE_STRING,
+    &setup.api_server_hostname,     TEST_PREFIX        "api_server_hostname"
+  },
+  {
+    TYPE_STRING,
+    &setup.api_server_password,     TEST_PREFIX        "api_server_password"
+  },
+  {
+    TYPE_SWITCH,
+    &setup.ask_for_uploading_tapes, TEST_PREFIX        "ask_for_uploading_tapes"
+  },
+  {
+    TYPE_SWITCH,
+    &setup.provide_uploading_tapes, TEST_PREFIX        "provide_uploading_tapes"
+  },
+};
+

 static struct TokenInfo editor_setup_tokens[] =
 {
   {
 static struct TokenInfo editor_setup_tokens[] =
 {
   {


@@ -10544,7 +10548,6 @@ static void setSetupInfoToDefaults(struct SetupInfo *si)
   int i;
 
   si->player_name = getStringCopy(getDefaultUserName(user.nr));
   int i;
 
   si->player_name = getStringCopy(getDefaultUserName(user.nr));

-  si->player_uuid = NULL;      // (will be set later)

 
   si->multiple_users = TRUE;
 
 
   si->multiple_users = TRUE;
 


@@ -10609,12 +10612,6 @@ static void setSetupInfoToDefaults(struct SetupInfo *si)
   si->network_player_nr = 0;           // first player
   si->network_server_hostname = getStringCopy(STR_NETWORK_AUTO_DETECT);
 
   si->network_player_nr = 0;           // first player
   si->network_server_hostname = getStringCopy(STR_NETWORK_AUTO_DETECT);
 

-  si->use_api_server = TRUE;
-  si->api_server_hostname = getStringCopy(API_SERVER_HOSTNAME);
-  si->api_server_password = getStringCopy(UNDEFINED_PASSWORD);
-  si->ask_for_uploading_tapes = TRUE;
-  si->provide_uploading_tapes = TRUE;
-

   si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
   si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT;       // percent
   si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT;       // percent
   si->touch.control_type = getStringCopy(TOUCH_CONTROL_DEFAULT);
   si->touch.move_distance = TOUCH_MOVE_DISTANCE_DEFAULT;       // percent
   si->touch.drop_distance = TOUCH_DROP_DISTANCE_DEFAULT;       // percent


@@ -10821,6 +10818,17 @@ static void setSetupInfoToDefaults_AutoSetup(struct SetupInfo *si)
   si->auto_setup.editor_zoom_tilesize = MINI_TILESIZE;
 }
 
   si->auto_setup.editor_zoom_tilesize = MINI_TILESIZE;
 }
 

+static void setSetupInfoToDefaults_ServerSetup(struct SetupInfo *si)
+{
+  si->player_uuid = NULL;      // (will be set later)
+
+  si->use_api_server = TRUE;
+  si->api_server_hostname = getStringCopy(API_SERVER_HOSTNAME);
+  si->api_server_password = getStringCopy(UNDEFINED_PASSWORD);
+  si->ask_for_uploading_tapes = TRUE;
+  si->provide_uploading_tapes = TRUE;
+}
+

 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
 {
   si->editor_cascade.el_bd             = TRUE;
 static void setSetupInfoToDefaults_EditorCascade(struct SetupInfo *si)
 {
   si->editor_cascade.el_bd             = TRUE;


@@ -11008,6 +11016,19 @@ static void decodeSetupFileHash_AutoSetup(SetupFileHash *setup_file_hash)
                              auto_setup_tokens[i].text));
 }
 
                              auto_setup_tokens[i].text));
 }
 

+static void decodeSetupFileHash_ServerSetup(SetupFileHash *setup_file_hash)
+{
+  int i;
+
+  if (!setup_file_hash)
+    return;
+
+  for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
+    setSetupInfo(server_setup_tokens, i,
+                getHashEntry(setup_file_hash,
+                             server_setup_tokens[i].text));
+}
+

 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
 {
   int i;
 static void decodeSetupFileHash_EditorCascade(SetupFileHash *setup_file_hash)
 {
   int i;


@@ -11093,14 +11114,6 @@ static void LoadSetup_SpecialPostProcessing(void)
   // make sure that scroll delay value stays inside valid range
   setup.scroll_delay_value =
     MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);
   // make sure that scroll delay value stays inside valid range
   setup.scroll_delay_value =
     MIN(MAX(MIN_SCROLL_DELAY, setup.scroll_delay_value), MAX_SCROLL_DELAY);

-
-  if (setup.player_uuid == NULL)
-  {
-    // player UUID does not yet exist in setup file
-    setup.player_uuid = getStringCopy(getUUID());
-
-    SaveSetup();
-  }

 }
 
 void LoadSetup_Default(void)
 }
 
 void LoadSetup_Default(void)


@@ -11144,6 +11157,34 @@ void LoadSetup_AutoSetup(void)
   free(filename);
 }
 
   free(filename);
 }
 

+void LoadSetup_ServerSetup(void)
+{
+  char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
+  SetupFileHash *setup_file_hash = NULL;
+
+  // always start with reliable default values
+  setSetupInfoToDefaults_ServerSetup(&setup);
+
+  setup_file_hash = loadSetupFileHash(filename);
+
+  if (setup_file_hash)
+  {
+    decodeSetupFileHash_ServerSetup(setup_file_hash);
+
+    freeSetupFileHash(setup_file_hash);
+  }
+
+  free(filename);
+
+  if (setup.player_uuid == NULL)
+  {
+    // player UUID does not yet exist in setup file
+    setup.player_uuid = getStringCopy(getUUID());
+
+    SaveSetup_ServerSetup();
+  }
+}
+

 void LoadSetup_EditorCascade(void)
 {
   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
 void LoadSetup_EditorCascade(void)
 {
   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);


@@ -11168,6 +11209,7 @@ void LoadSetup(void)
 {
   LoadSetup_Default();
   LoadSetup_AutoSetup();
 {
   LoadSetup_Default();
   LoadSetup_AutoSetup();

+  LoadSetup_ServerSetup();

   LoadSetup_EditorCascade();
 }
 
   LoadSetup_EditorCascade();
 }
 


@@ -11245,7 +11287,6 @@ void SaveSetup_Default(void)
        global_setup_tokens[i].value == &setup.graphics_set             ||
        global_setup_tokens[i].value == &setup.volume_simple            ||
        global_setup_tokens[i].value == &setup.network_mode             ||
        global_setup_tokens[i].value == &setup.graphics_set             ||
        global_setup_tokens[i].value == &setup.volume_simple            ||
        global_setup_tokens[i].value == &setup.network_mode             ||

-       global_setup_tokens[i].value == &setup.use_api_server           ||

        global_setup_tokens[i].value == &setup.touch.control_type       ||
        global_setup_tokens[i].value == &setup.touch.grid_xsize[0]      ||
        global_setup_tokens[i].value == &setup.touch.grid_xsize[1])
        global_setup_tokens[i].value == &setup.touch.control_type       ||
        global_setup_tokens[i].value == &setup.touch.grid_xsize[0]      ||
        global_setup_tokens[i].value == &setup.touch.grid_xsize[1])


@@ -11352,6 +11393,41 @@ void SaveSetup_AutoSetup(void)
   free(filename);
 }
 
   free(filename);
 }
 

+void SaveSetup_ServerSetup(void)
+{
+  char *filename = getPath2(getSetupDir(), SERVERSETUP_FILENAME);
+  FILE *file;
+  int i;
+
+  InitUserDataDirectory();
+
+  if (!(file = fopen(filename, MODE_WRITE)))
+  {
+    Warn("cannot write server setup file '%s'", filename);
+
+    free(filename);
+
+    return;
+  }
+
+  fprintFileHeader(file, SERVERSETUP_FILENAME);
+
+  for (i = 0; i < ARRAY_SIZE(server_setup_tokens); i++)
+  {
+    // just to make things nicer :)
+    if (server_setup_tokens[i].value == &setup.use_api_server)
+      fprintf(file, "\n");
+
+    fprintf(file, "%s\n", getSetupLine(server_setup_tokens, "", i));
+  }
+
+  fclose(file);
+
+  SetFilePermissions(filename, PERMS_PRIVATE);
+
+  free(filename);
+}
+

 void SaveSetup_EditorCascade(void)
 {
   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);
 void SaveSetup_EditorCascade(void)
 {
   char *filename = getPath2(getSetupDir(), EDITORCASCADE_FILENAME);


@@ -11385,6 +11461,7 @@ void SaveSetup(void)
 {
   SaveSetup_Default();
   SaveSetup_AutoSetup();
 {
   SaveSetup_Default();
   SaveSetup_AutoSetup();

+  SaveSetup_ServerSetup();

   SaveSetup_EditorCascade();
 }
 
   SaveSetup_EditorCascade();
 }
 

diff --git a/src/files.h b/src/files.h
index eb8ddc526f0ef94155bbd652ff1c1409864fc121..596c24a60b6eeca03287fae4357a79b81c8182ed 100644 (file)
--- a/src/files.h
+++ b/src/files.h
@@ -82,6 +82,9 @@ void SaveSetup_Default(void);
 void LoadSetup_AutoSetup(void);
 void SaveSetup_AutoSetup(void);
 
 void LoadSetup_AutoSetup(void);
 void SaveSetup_AutoSetup(void);
 

+void LoadSetup_ServerSetup(void);
+void SaveSetup_ServerSetup(void);
+

 void LoadSetup_EditorCascade(void);
 void SaveSetup_EditorCascade(void);
 
 void LoadSetup_EditorCascade(void);
 void SaveSetup_EditorCascade(void);
 

diff --git a/src/libgame/system.h b/src/libgame/system.h
index 32180326631362a6aca8a9fe2eed0ad1587fb496..6d94d4f1eb41e07da816aae54792e65382f1277d 100644 (file)
--- a/src/libgame/system.h
+++ b/src/libgame/system.h
@@ -674,6 +674,7 @@
 #define USERSETUP_FILENAME     "usersetup.conf"
 #define AUTOSETUP_FILENAME     "autosetup.conf"
 #define LEVELSETUP_FILENAME    "levelsetup.conf"
 #define USERSETUP_FILENAME     "usersetup.conf"
 #define AUTOSETUP_FILENAME     "autosetup.conf"
 #define LEVELSETUP_FILENAME    "levelsetup.conf"

+#define SERVERSETUP_FILENAME   "serversetup.conf"

 #define EDITORSETUP_FILENAME   "editorsetup.conf"
 #define EDITORCASCADE_FILENAME "editorcascade.conf"
 #define HELPANIM_FILENAME      "helpanim.conf"
 #define EDITORSETUP_FILENAME   "editorsetup.conf"
 #define EDITORCASCADE_FILENAME "editorcascade.conf"
 #define HELPANIM_FILENAME      "helpanim.conf"