added functions to handle network level directories
[rocksndiamonds.git] / src / libgame / setup.c
index f28df34f30713cc103e0ce83b88a854fb85fd243..802c673a54d232db51dc336d6b0de18e0878eb7c 100644 (file)
@@ -31,6 +31,7 @@
 
 
 #define ENABLE_UNUSED_CODE     FALSE   /* for currently unused functions */
+#define DEBUG_NO_CONFIG_FILE   FALSE   /* for extra-verbose debug output */
 
 #define NUM_LEVELCLASS_DESC    8
 
@@ -166,6 +167,16 @@ static char *getCacheDir()
   return cache_dir;
 }
 
+static char *getNetworkDir()
+{
+  static char *network_dir = NULL;
+
+  if (network_dir == NULL)
+    network_dir = getPath2(getUserGameDataDir(), NETWORK_DIRECTORY);
+
+  return network_dir;
+}
+
 static char *getLevelDirFromTreeInfo(TreeInfo *node)
 {
   static char *level_dir = NULL;
@@ -197,6 +208,22 @@ char *getUserLevelDir(char *level_subdir)
   return userlevel_dir;
 }
 
+char *getNetworkLevelDir(char *level_subdir)
+{
+  static char *network_level_dir = NULL;
+  char *data_dir = getNetworkDir();
+  char *networklevel_subdir = LEVELS_DIRECTORY;
+
+  checked_free(network_level_dir);
+
+  if (level_subdir != NULL)
+    network_level_dir = getPath3(data_dir, networklevel_subdir, level_subdir);
+  else
+    network_level_dir = getPath2(data_dir, networklevel_subdir);
+
+  return network_level_dir;
+}
+
 char *getCurrentLevelDir()
 {
   return getLevelDirFromTreeInfo(leveldir_current);
@@ -1048,6 +1075,17 @@ void InitUserLevelDirectory(char *level_subdir)
   }
 }
 
+void InitNetworkLevelDirectory(char *level_subdir)
+{
+  if (!directoryExists(getNetworkLevelDir(level_subdir)))
+  {
+    createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE);
+    createDirectory(getNetworkDir(), "network data", PERMS_PRIVATE);
+    createDirectory(getNetworkLevelDir(NULL), "main network level", PERMS_PRIVATE);
+    createDirectory(getNetworkLevelDir(level_subdir), "network level", PERMS_PRIVATE);
+  }
+}
+
 void InitLevelSetupDirectory(char *level_subdir)
 {
   createDirectory(getUserGameDataDir(), "user data", PERMS_PRIVATE);
@@ -1575,7 +1613,7 @@ char *getCookie(char *file_type)
 
   sprintf(cookie, "%s_%s_FILE_VERSION_%d.%d",
          program.cookie_prefix, file_type,
-         program.version_major, program.version_minor);
+         program.version_super, program.version_major);
 
   return cookie;
 }
@@ -1600,7 +1638,7 @@ int getFileVersionFromCookieString(const char *cookie)
   const int len_pattern1 = strlen(pattern1);
   const int len_pattern2 = strlen(pattern2);
   const int len_pattern = len_pattern1 + len_pattern2;
-  int version_major, version_minor;
+  int version_super, version_major;
 
   if (len_cookie <= len_pattern)
     return -1;
@@ -1616,10 +1654,10 @@ int getFileVersionFromCookieString(const char *cookie)
       ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9')
     return -1;
 
-  version_major = ptr_cookie2[0] - '0';
-  version_minor = ptr_cookie2[2] - '0';
+  version_super = ptr_cookie2[0] - '0';
+  version_major = ptr_cookie2[2] - '0';
 
-  return VERSION_IDENT(version_major, version_minor, 0, 0);
+  return VERSION_IDENT(version_super, version_major, 0, 0);
 }
 
 boolean checkCookieString(const char *cookie, const char *template)
@@ -2024,7 +2062,9 @@ static boolean loadSetupFileData(void *setup_file_data, char *filename,
 
   if (!(file = openFile(filename, MODE_READ)))
   {
+#if DEBUG_NO_CONFIG_FILE
     Error(ERR_DEBUG, "cannot open configuration file '%s'", filename);
+#endif
 
     return FALSE;
   }
@@ -2236,27 +2276,30 @@ SetupFileHash *loadSetupFileHash(char *filename)
 #define LEVELINFO_TOKEN_NAME_SORTING           2
 #define LEVELINFO_TOKEN_AUTHOR                 3
 #define LEVELINFO_TOKEN_YEAR                   4
-#define LEVELINFO_TOKEN_IMPORTED_FROM          5
-#define LEVELINFO_TOKEN_IMPORTED_BY            6
-#define LEVELINFO_TOKEN_TESTED_BY              7
-#define LEVELINFO_TOKEN_LEVELS                 8
-#define LEVELINFO_TOKEN_FIRST_LEVEL            9
-#define LEVELINFO_TOKEN_SORT_PRIORITY          10
-#define LEVELINFO_TOKEN_LATEST_ENGINE          11
-#define LEVELINFO_TOKEN_LEVEL_GROUP            12
-#define LEVELINFO_TOKEN_READONLY               13
-#define LEVELINFO_TOKEN_GRAPHICS_SET_ECS       14
-#define LEVELINFO_TOKEN_GRAPHICS_SET_AGA       15
-#define LEVELINFO_TOKEN_GRAPHICS_SET           16
-#define LEVELINFO_TOKEN_SOUNDS_SET             17
-#define LEVELINFO_TOKEN_MUSIC_SET              18
-#define LEVELINFO_TOKEN_FILENAME               19
-#define LEVELINFO_TOKEN_FILETYPE               20
-#define LEVELINFO_TOKEN_SPECIAL_FLAGS          21
-#define LEVELINFO_TOKEN_HANDICAP               22
-#define LEVELINFO_TOKEN_SKIP_LEVELS            23
-
-#define NUM_LEVELINFO_TOKENS                   24
+#define LEVELINFO_TOKEN_PROGRAM_TITLE          5
+#define LEVELINFO_TOKEN_PROGRAM_COPYRIGHT      6
+#define LEVELINFO_TOKEN_PROGRAM_COMPANY                7
+#define LEVELINFO_TOKEN_IMPORTED_FROM          8
+#define LEVELINFO_TOKEN_IMPORTED_BY            9
+#define LEVELINFO_TOKEN_TESTED_BY              10
+#define LEVELINFO_TOKEN_LEVELS                 11
+#define LEVELINFO_TOKEN_FIRST_LEVEL            12
+#define LEVELINFO_TOKEN_SORT_PRIORITY          13
+#define LEVELINFO_TOKEN_LATEST_ENGINE          14
+#define LEVELINFO_TOKEN_LEVEL_GROUP            15
+#define LEVELINFO_TOKEN_READONLY               16
+#define LEVELINFO_TOKEN_GRAPHICS_SET_ECS       17
+#define LEVELINFO_TOKEN_GRAPHICS_SET_AGA       18
+#define LEVELINFO_TOKEN_GRAPHICS_SET           19
+#define LEVELINFO_TOKEN_SOUNDS_SET             20
+#define LEVELINFO_TOKEN_MUSIC_SET              21
+#define LEVELINFO_TOKEN_FILENAME               22
+#define LEVELINFO_TOKEN_FILETYPE               23
+#define LEVELINFO_TOKEN_SPECIAL_FLAGS          24
+#define LEVELINFO_TOKEN_HANDICAP               25
+#define LEVELINFO_TOKEN_SKIP_LEVELS            26
+
+#define NUM_LEVELINFO_TOKENS                   27
 
 static LevelDirTree ldi;
 
@@ -2268,6 +2311,9 @@ static struct TokenInfo levelinfo_tokens[] =
   { TYPE_STRING,       &ldi.name_sorting,      "name_sorting"          },
   { TYPE_STRING,       &ldi.author,            "author"                },
   { TYPE_STRING,       &ldi.year,              "year"                  },
+  { TYPE_STRING,       &ldi.program_title,     "program_title"         },
+  { TYPE_STRING,       &ldi.program_copyright, "program_copyright"     },
+  { TYPE_STRING,       &ldi.program_company,   "program_company"       },
   { TYPE_STRING,       &ldi.imported_from,     "imported_from"         },
   { TYPE_STRING,       &ldi.imported_by,       "imported_by"           },
   { TYPE_STRING,       &ldi.tested_by,         "tested_by"             },
@@ -2297,6 +2343,9 @@ static struct TokenInfo artworkinfo_tokens[] =
   { TYPE_STRING,       &ldi.name,              "name"                  },
   { TYPE_STRING,       &ldi.name_sorting,      "name_sorting"          },
   { TYPE_STRING,       &ldi.author,            "author"                },
+  { TYPE_STRING,       &ldi.program_title,     "program_title"         },
+  { TYPE_STRING,       &ldi.program_copyright, "program_copyright"     },
+  { TYPE_STRING,       &ldi.program_company,   "program_company"       },
   { TYPE_INTEGER,      &ldi.sort_priority,     "sort_priority"         },
   { TYPE_STRING,       &ldi.basepath,          "basepath"              },
   { TYPE_STRING,       &ldi.fullpath,          "fullpath"              },
@@ -2333,6 +2382,10 @@ static void setTreeInfoToDefaults(TreeInfo *ti, int type)
   ti->author = getStringCopy(ANONYMOUS_NAME);
   ti->year = NULL;
 
+  ti->program_title = NULL;
+  ti->program_copyright = NULL;
+  ti->program_company = NULL;
+
   ti->sort_priority = LEVELCLASS_UNDEFINED;    /* default: least priority */
   ti->latest_engine = FALSE;                   /* default: get from level */
   ti->parent_link = FALSE;
@@ -2406,6 +2459,10 @@ static void setTreeInfoToDefaultsFromParent(TreeInfo *ti, TreeInfo *parent)
   ti->author = getStringCopy(parent->author);
   ti->year = getStringCopy(parent->year);
 
+  ti->program_title = getStringCopy(parent->program_title);
+  ti->program_copyright = getStringCopy(parent->program_copyright);
+  ti->program_company = getStringCopy(parent->program_company);
+
   ti->sort_priority = parent->sort_priority;
   ti->latest_engine = parent->latest_engine;
   ti->parent_link = FALSE;
@@ -2471,6 +2528,11 @@ static TreeInfo *getTreeInfoCopy(TreeInfo *ti)
   ti_copy->name_sorting                = getStringCopy(ti->name_sorting);
   ti_copy->author              = getStringCopy(ti->author);
   ti_copy->year                        = getStringCopy(ti->year);
+
+  ti_copy->program_title       = getStringCopy(ti->program_title);
+  ti_copy->program_copyright   = getStringCopy(ti->program_copyright);
+  ti_copy->program_company     = getStringCopy(ti->program_company);
+
   ti_copy->imported_from       = getStringCopy(ti->imported_from);
   ti_copy->imported_by         = getStringCopy(ti->imported_by);
   ti_copy->tested_by           = getStringCopy(ti->tested_by);
@@ -2528,6 +2590,10 @@ void freeTreeInfo(TreeInfo *ti)
   checked_free(ti->author);
   checked_free(ti->year);
 
+  checked_free(ti->program_title);
+  checked_free(ti->program_copyright);
+  checked_free(ti->program_company);
+
   checked_free(ti->class_desc);
 
   checked_free(ti->infotext);
@@ -2603,6 +2669,10 @@ void setSetupInfo(struct TokenInfo *token_info,
       *(char **)setup_value = getStringCopy(token_value);
       break;
 
+    case TYPE_PLAYER:
+      *(int *)setup_value = get_player_nr_from_string(token_value);
+      break;
+
     default:
       break;
   }
@@ -2820,22 +2890,13 @@ static TreeInfo *getArtworkInfoCacheEntry(LevelDirTree *level_node, int type)
       char *token = getCacheToken(token_prefix, artworkinfo_tokens[i].text);
       char *value = getHashEntry(artworkinfo_cache_old, token);
 
-      setSetupInfo(artworkinfo_tokens, i, value);
-
-      /* check if cache entry for this item is invalid or incomplete */
-      if (value == NULL)
-      {
-       Error(ERR_WARN, "cache entry '%s' invalid", token);
-
-       cached = FALSE;
-      }
+      /* if defined, use value from cache, else keep default value */
+      if (value != NULL)
+       setSetupInfo(artworkinfo_tokens, i, value);
     }
 
     *artwork_info = ldi;
-  }
 
-  if (cached)
-  {
     char *filename_levelinfo = getPath2(getLevelDirFromTreeInfo(level_node),
                                        LEVELINFO_FILENAME);
     char *filename_artworkinfo = getPath2(getSetupArtworkDir(artwork_info),
@@ -2945,7 +3006,9 @@ static boolean LoadLevelInfoFromLevelConf(TreeInfo **node_first,
 
   if (setup_file_hash == NULL)
   {
+#if DEBUG_NO_CONFIG_FILE
     Error(ERR_WARN, "ignoring level directory '%s'", directory_path);
+#endif
 
     free(directory_path);
     free(filename);
@@ -3183,8 +3246,10 @@ static boolean LoadArtworkInfoFromArtworkConf(TreeInfo **node_first,
 
     if (!valid_file_found)
     {
+#if DEBUG_NO_CONFIG_FILE
       if (!strEqual(directory_name, "."))
        Error(ERR_WARN, "ignoring artwork directory '%s'", directory_path);
+#endif
 
       free(directory_path);
       free(filename);
@@ -3629,6 +3694,14 @@ char *getArtworkIdentifierForUserLevelSet(int type)
          classic_artwork_set);
 }
 
+TreeInfo *getArtworkTreeInfoForUserLevelSet(int type)
+{
+  char *artwork_set = getArtworkIdentifierForUserLevelSet(type);
+  TreeInfo *artwork_first_node = ARTWORK_FIRST_NODE(artwork, type);
+
+  return getTreeInfoFromIdentifier(artwork_first_node, artwork_set);
+}
+
 boolean checkIfCustomArtworkExistsForCurrentLevelSet()
 {
   char *graphics_set =
@@ -3847,6 +3920,10 @@ char *getSetupValue(int type, void *value)
       strcpy(value_string, *(char **)value);
       break;
 
+    case TYPE_PLAYER:
+      sprintf(value_string, "player_%d", *(int *)value + 1);
+      break;
+
     default:
       value_string[0] = '\0';
       break;