rnd-19981121-1
[rocksndiamonds.git] / src / files.c
index ac1b0fa74a380246fa12e2f8880e3240648f6fae..46671d4631c18ca86423f370eb81c7a3a01dbc70 100644 (file)
@@ -12,6 +12,9 @@
 ***********************************************************/
 
 #include <ctype.h>
+#include <dirent.h>
+#include <sys/stat.h>
+#include <unistd.h>
 
 #include "files.h"
 #include "tools.h"
@@ -21,6 +24,9 @@
 
 #define MAX_LINE_LEN                   1000
 
+static void SaveUserLevelInfo();               /* for 'InitUserLevelDir()' */
+static char *getSetupLine(char *, int);                /* for 'SaveUserLevelInfo()' */
+
 static char *getGlobalDataDir()
 {
   return GAME_DIR;
@@ -47,6 +53,23 @@ static char *getSetupDir()
   return getUserDataDir();
 }
 
+static char *getUserLevelDir(char *level_subdir)
+{
+  static char *userlevel_dir = NULL;
+  char *data_dir = getUserDataDir();
+  char *userlevel_subdir = LEVELS_DIRECTORY;
+
+  if (userlevel_dir)
+    free(userlevel_dir);
+
+  userlevel_dir = checked_malloc(strlen(data_dir) + strlen(userlevel_subdir) +
+                                strlen(level_subdir) + 3);
+  sprintf(userlevel_dir, "%s/%s%s%s", data_dir, userlevel_subdir,
+         (strlen(level_subdir) > 0 ? "/" : ""), level_subdir);
+
+  return userlevel_dir;
+}
+
 static char *getTapeDir(char *level_subdir)
 {
   static char *tape_dir = NULL;
@@ -105,50 +128,15 @@ static void InitScoreDirectory(char *level_subdir)
   createDirectory(getScoreDir(level_subdir), "level score");
 }
 
-boolean LoadLevelInfo()
+static void InitUserLevelDirectory(char *level_subdir)
 {
-  int i;
-  char filename[MAX_FILENAME_LEN];
-  char cookie[MAX_FILENAME_LEN];
-  FILE *file;
-
-  sprintf(filename, "%s/%s", options.level_directory, LEVDIR_FILENAME);
-
-  if (!(file = fopen(filename, "r")))
+  if (access(getUserLevelDir(level_subdir), F_OK) != 0)
   {
-    Error(ERR_WARN, "cannot read level info '%s'", filename);
-    return(FALSE);
-  }
+    createDirectory(getUserLevelDir(""), "main user level");
+    createDirectory(getUserLevelDir(level_subdir), "user level");
 
-  fscanf(file, "%s\n", cookie);
-  if (strcmp(cookie, LEVELDIR_COOKIE))
-  {
-    Error(ERR_WARN, "wrong format of level info file");
-    fclose(file);
-    return(FALSE);
-  }
-
-  num_leveldirs = 0;
-  leveldir_nr = 0;
-  for(i=0; i<MAX_LEVDIR_ENTRIES; i++)
-  {
-    fscanf(file, "%s", leveldir[i].filename);
-    fscanf(file, "%s", leveldir[i].name);
-    fscanf(file, "%d", &leveldir[i].levels);
-    fscanf(file, "%d", &leveldir[i].readonly);
-    if (feof(file))
-      break;
-
-    num_leveldirs++;
+    SaveUserLevelInfo();
   }
-
-  if (!num_leveldirs)
-  {
-    Error(ERR_WARN, "empty level info '%s'", filename);
-    return(FALSE);
-  }
-
-  return(TRUE);
 }
 
 void LoadLevel(int level_nr)
@@ -158,8 +146,12 @@ void LoadLevel(int level_nr)
   char cookie[MAX_FILENAME_LEN];
   FILE *file;
 
-  sprintf(filename, "%s/%s/%d",
-         options.level_directory, leveldir[leveldir_nr].filename, level_nr);
+  if (leveldir[leveldir_nr].user_defined)
+    sprintf(filename, "%s/%s/%d",
+           getUserLevelDir(""), leveldir[leveldir_nr].filename, level_nr);
+  else
+    sprintf(filename, "%s/%s/%d",
+           options.level_directory, leveldir[leveldir_nr].filename, level_nr);
 
   if (!(file = fopen(filename, "r")))
     Error(ERR_WARN, "cannot read level '%s' - creating new level", filename);
@@ -247,8 +239,12 @@ void SaveLevel(int level_nr)
   char filename[MAX_FILENAME_LEN];
   FILE *file;
 
-  sprintf(filename, "%s/%s/%d",
-         options.level_directory, leveldir[leveldir_nr].filename, level_nr);
+  if (leveldir[leveldir_nr].user_defined)
+    sprintf(filename, "%s/%s/%d",
+           getUserLevelDir(""), leveldir[leveldir_nr].filename, level_nr);
+  else
+    sprintf(filename, "%s/%s/%d",
+           options.level_directory, leveldir[leveldir_nr].filename, level_nr);
 
   if (!(file = fopen(filename, "w")))
   {
@@ -401,13 +397,13 @@ void SaveTape(int level_nr)
   FILE *file;
   boolean new_tape = TRUE;
 
+  InitTapeDirectory(leveldir[leveldir_nr].filename);
+
   sprintf(filename, "%s/%d.%s",
          getTapeDir(leveldir[leveldir_nr].filename),
          level_nr, TAPEFILE_EXTENSION);
 
-  InitTapeDirectory(leveldir[leveldir_nr].filename);
-
-  /* Testen, ob bereits eine Aufnahme existiert */
+  /* if a tape still exists, ask to overwrite it */
   if ((file = fopen(filename, "r")))
   {
     new_tape = FALSE;
@@ -521,12 +517,12 @@ void SaveScore(int level_nr)
   char filename[MAX_FILENAME_LEN];
   FILE *file;
 
+  InitScoreDirectory(leveldir[leveldir_nr].filename);
+
   sprintf(filename, "%s/%d.%s",
          getScoreDir(leveldir[leveldir_nr].filename),
          level_nr, SCOREFILE_EXTENSION);
 
-  InitScoreDirectory(leveldir[leveldir_nr].filename);
-
   if (!(file = fopen(filename, "w")))
   {
     Error(ERR_WARN, "cannot save score for level %d", level_nr);
@@ -549,20 +545,22 @@ void SaveScore(int level_nr)
 
 #define TOKEN_VALUE_POSITION           30
 
-#define SETUP_TOKEN_SOUND              0
-#define SETUP_TOKEN_SOUND_LOOPS                1
-#define SETUP_TOKEN_SOUND_MUSIC                2
-#define SETUP_TOKEN_SOUND_SIMPLE       3
-#define SETUP_TOKEN_TOONS              4
-#define SETUP_TOKEN_DOUBLE_BUFFERING   5
-#define SETUP_TOKEN_SCROLL_DELAY       6
-#define SETUP_TOKEN_SOFT_SCROLLING     7
-#define SETUP_TOKEN_FADING             8
-#define SETUP_TOKEN_AUTORECORD         9
-#define SETUP_TOKEN_QUICK_DOORS                10
-#define SETUP_TOKEN_TEAM_MODE          11
-#define SETUP_TOKEN_ALIAS_NAME         12
-
+/* global setup */
+#define SETUP_TOKEN_PLAYER_NAME                0
+#define SETUP_TOKEN_SOUND              1
+#define SETUP_TOKEN_SOUND_LOOPS                2
+#define SETUP_TOKEN_SOUND_MUSIC                3
+#define SETUP_TOKEN_SOUND_SIMPLE       4
+#define SETUP_TOKEN_TOONS              5
+#define SETUP_TOKEN_DOUBLE_BUFFERING   6
+#define SETUP_TOKEN_SCROLL_DELAY       7
+#define SETUP_TOKEN_SOFT_SCROLLING     8
+#define SETUP_TOKEN_FADING             9
+#define SETUP_TOKEN_AUTORECORD         10
+#define SETUP_TOKEN_QUICK_DOORS                11
+#define SETUP_TOKEN_TEAM_MODE          12
+
+/* player setup */
 #define SETUP_TOKEN_USE_JOYSTICK       13
 #define SETUP_TOKEN_JOY_DEVICE_NAME    14
 #define SETUP_TOKEN_JOY_XLEFT          15
@@ -580,14 +578,21 @@ void SaveScore(int level_nr)
 #define SETUP_TOKEN_KEY_SNAP           27
 #define SETUP_TOKEN_KEY_BOMB           28
 
-#define NUM_SETUP_TOKENS               29
+/* level directory info */
+#define LEVELINFO_TOKEN_NAME           29
+#define LEVELINFO_TOKEN_LEVELS         30
+#define LEVELINFO_TOKEN_SORT_PRIORITY  31
+#define LEVELINFO_TOKEN_READONLY       32
 
-#define FIRST_GLOBAL_SETUP_TOKEN       SETUP_TOKEN_SOUND
-#define LAST_GLOBAL_SETUP_TOKEN                SETUP_TOKEN_ALIAS_NAME
+#define FIRST_GLOBAL_SETUP_TOKEN       SETUP_TOKEN_PLAYER_NAME
+#define LAST_GLOBAL_SETUP_TOKEN                SETUP_TOKEN_TEAM_MODE
 
 #define FIRST_PLAYER_SETUP_TOKEN       SETUP_TOKEN_USE_JOYSTICK
 #define LAST_PLAYER_SETUP_TOKEN                SETUP_TOKEN_KEY_BOMB
 
+#define FIRST_LEVELINFO_TOKEN          LEVELINFO_TOKEN_NAME
+#define LAST_LEVELINFO_TOKEN           LEVELINFO_TOKEN_READONLY
+
 #define TYPE_BOOLEAN                   1
 #define TYPE_SWITCH                    2
 #define TYPE_KEYSYM                    3
@@ -596,6 +601,7 @@ void SaveScore(int level_nr)
 
 static struct SetupInfo si;
 static struct SetupInputInfo sii;
+static struct LevelDirInfo ldi;
 static struct
 {
   int type;
@@ -603,6 +609,8 @@ static struct
   char *text;
 } token_info[] =
 {
+  /* global setup */
+  { TYPE_STRING,  &si.player_name,     "player_name"                   },
   { TYPE_SWITCH,  &si.sound,           "sound"                         },
   { TYPE_SWITCH,  &si.sound_loops,     "repeating_sound_loops"         },
   { TYPE_SWITCH,  &si.sound_music,     "background_music"              },
@@ -615,9 +623,8 @@ static struct
   { TYPE_SWITCH,  &si.autorecord,      "automatic_tape_recording"      },
   { TYPE_SWITCH,  &si.quick_doors,     "quick_doors"                   },
   { TYPE_SWITCH,  &si.team_mode,       "team_mode"                     },
-  { TYPE_STRING,  &si.alias_name,      "alias_name"                    },
 
-  /* for each player: */
+  /* player setup */
   { TYPE_BOOLEAN, &sii.use_joystick,   ".use_joystick"                 },
   { TYPE_STRING,  &sii.joy.device_name,        ".joy.device_name"              },
   { TYPE_INTEGER, &sii.joy.xleft,      ".joy.xleft"                    },
@@ -633,7 +640,13 @@ static struct
   { TYPE_KEYSYM,  &sii.key.up,         ".key.move_up"                  },
   { TYPE_KEYSYM,  &sii.key.down,       ".key.move_down"                },
   { TYPE_KEYSYM,  &sii.key.snap,       ".key.snap_field"               },
-  { TYPE_KEYSYM,  &sii.key.bomb,       ".key.place_bomb"               }
+  { TYPE_KEYSYM,  &sii.key.bomb,       ".key.place_bomb"               },
+
+  /* level directory info */
+  { TYPE_STRING,  &ldi.name,           "name"                          },
+  { TYPE_INTEGER, &ldi.levels,         "levels"                        },
+  { TYPE_INTEGER, &ldi.sort_priority,  "sort_priority"                 },
+  { TYPE_BOOLEAN, &ldi.readonly,       "readonly"                      }
 };
 
 static char *string_tolower(char *s)
@@ -791,7 +804,7 @@ static struct SetupFileList *loadSetupFileList(char *filename)
 
   if (!(file = fopen(filename, "r")))
   {
-    Error(ERR_WARN, "cannot open setup file '%s'", filename);
+    Error(ERR_WARN, "cannot open setup/info file '%s'", filename);
     return NULL;
   }
 
@@ -859,8 +872,8 @@ static struct SetupFileList *loadSetupFileList(char *filename)
   setup_file_list->next = NULL;
   freeSetupFileList(setup_file_list);
 
-  if (!first_valid_list_entry)
-    Error(ERR_WARN, "setup file is empty");
+  if (first_valid_list_entry == NULL)
+    Error(ERR_WARN, "setup/info file '%s' is empty", filename);
 
   return first_valid_list_entry;
 }
@@ -875,7 +888,7 @@ static void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list,
   {
     if (strcmp(setup_file_list->value, identifier) != 0)
     {
-      Error(ERR_WARN, "setup file has wrong version");
+      Error(ERR_WARN, "setup/info file has wrong version");
       return;
     }
     else
@@ -886,15 +899,25 @@ static void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list,
     checkSetupFileListIdentifier(setup_file_list->next, identifier);
   else
   {
-    Error(ERR_WARN, "setup file has no version information");
+    Error(ERR_WARN, "setup/info file has no version information");
     return;
   }
 }
 
+static void setLevelDirInfoToDefaults(struct LevelDirInfo *ldi)
+{
+  ldi->name = getStringCopy("non-existing");
+  ldi->levels = 0;
+  ldi->sort_priority = 999;    /* default: least priority */
+  ldi->readonly = TRUE;
+}
+
 static void setSetupInfoToDefaults(struct SetupInfo *si)
 {
   int i;
 
+  si->player_name = getStringCopy(getLoginName());
+
   si->sound = TRUE;
   si->sound_loops = FALSE;
   si->sound_music = FALSE;
@@ -908,15 +931,10 @@ static void setSetupInfoToDefaults(struct SetupInfo *si)
   si->autorecord = FALSE;
   si->quick_doors = FALSE;
 
-  strncpy(si->login_name, getLoginName(), MAX_NAMELEN-1);
-  si->login_name[MAX_NAMELEN-1] = '\0';
-  strncpy(si->alias_name, getLoginName(), MAX_NAMELEN-1);
-  si->alias_name[MAX_NAMELEN-1] = '\0';
-
   for (i=0; i<MAX_PLAYERS; i++)
   {
     si->input[i].use_joystick = FALSE;
-    strcpy(si->input[i].joy.device_name, joystick_device_name[i]);
+    si->input[i].joy.device_name = getStringCopy(joystick_device_name[i]);
     si->input[i].joy.xleft   = JOYSTICK_XLEFT;
     si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
     si->input[i].joy.xright  = JOYSTICK_XRIGHT;
@@ -959,7 +977,9 @@ static void setSetupInfo(int token_nr, char *token_value)
       break;
 
     case TYPE_STRING:
-      strcpy((char *)setup_value, token_value);
+      if (*(char **)setup_value != NULL)
+       free(*(char **)setup_value);
+      *(char **)setup_value = getStringCopy(token_value);
       break;
 
     default:
@@ -1039,6 +1059,154 @@ int getLastPlayedLevelOfLevelSeries(char *level_series_name)
   return last_level_nr;
 }
 
+static int compareLevelDirInfoEntries(const void *object1, const void *object2)
+{
+  const struct LevelDirInfo *entry1 = object1;
+  const struct LevelDirInfo *entry2 = object2;
+  int compare_result;
+
+  if (entry1->sort_priority != entry2->sort_priority)
+    compare_result = entry1->sort_priority - entry2->sort_priority;
+  else
+  {
+    char *name1 = getStringToLower(entry1->name);
+    char *name2 = getStringToLower(entry2->name);
+
+    compare_result = strcmp(name1, name2);
+
+    free(name1);
+    free(name2);
+  }
+
+  return compare_result;
+}
+
+static int LoadLevelInfoFromLevelDir(char *level_directory, int start_entry)
+{
+  DIR *dir;
+  struct stat file_status;
+  char *directory = NULL;
+  char *filename = NULL;
+  struct SetupFileList *setup_file_list = NULL;
+  struct dirent *dir_entry;
+  int i, current_entry = start_entry;
+
+  if ((dir = opendir(level_directory)) == NULL)
+    Error(ERR_EXIT, "cannot read level directory '%s'", level_directory);
+
+  while (current_entry < MAX_LEVDIR_ENTRIES)
+  {
+    if ((dir_entry = readdir(dir)) == NULL)    /* last directory entry */
+      break;
+
+    /* skip entries for current and parent directory */
+    if (strcmp(dir_entry->d_name, ".")  == 0 ||
+       strcmp(dir_entry->d_name, "..") == 0)
+      continue;
+
+    /* find out if directory entry is itself a directory */
+    directory = getPath2(level_directory, dir_entry->d_name);
+    if (stat(directory, &file_status) != 0 ||          /* cannot stat file */
+       (file_status.st_mode & S_IFMT) != S_IFDIR)      /* not a directory */
+    {
+      free(directory);
+      continue;
+    }
+
+    if (strlen(dir_entry->d_name) >= MAX_LEVDIR_FILENAME)
+    {
+      Error(ERR_WARN, "filename of level directory '%s' too long -- ignoring",
+           dir_entry->d_name);
+      continue;
+    }
+
+    filename = getPath2(directory, LEVELINFO_FILENAME);
+    setup_file_list = loadSetupFileList(filename);
+
+    if (setup_file_list)
+    {
+      checkSetupFileListIdentifier(setup_file_list, LEVELINFO_COOKIE);
+      setLevelDirInfoToDefaults(&leveldir[current_entry]);
+
+      ldi = leveldir[current_entry];
+      for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++)
+       setSetupInfo(i, getTokenValue(setup_file_list, token_info[i].text));
+      leveldir[current_entry] = ldi;
+
+      leveldir[current_entry].filename = getStringCopy(dir_entry->d_name);
+      leveldir[current_entry].user_defined =
+       (level_directory == options.level_directory ? FALSE : TRUE);
+
+      freeSetupFileList(setup_file_list);
+      current_entry++;
+    }
+    else
+      Error(ERR_WARN, "ignoring level directory '%s'", directory);
+
+    free(directory);
+    free(filename);
+  }
+
+  if (current_entry == MAX_LEVDIR_ENTRIES)
+    Error(ERR_WARN, "using %d level directories -- ignoring the rest",
+         current_entry);
+
+  closedir(dir);
+
+  if (current_entry == start_entry && start_entry != -1)
+    Error(ERR_EXIT, "cannot find any valid level series in directory '%s'",
+         level_directory);
+
+  return current_entry;
+}
+
+void LoadLevelInfo()
+{
+  InitUserLevelDirectory(getLoginName());
+
+  num_leveldirs = 0;
+  leveldir_nr = 0;
+
+  num_leveldirs = LoadLevelInfoFromLevelDir(options.level_directory,
+                                           num_leveldirs);
+  num_leveldirs = LoadLevelInfoFromLevelDir(getUserLevelDir(""),
+                                           num_leveldirs);
+  if (num_leveldirs > 1)
+    qsort(leveldir, num_leveldirs, sizeof(struct LevelDirInfo),
+         compareLevelDirInfoEntries);
+}
+
+static void SaveUserLevelInfo()
+{
+  char filename[MAX_FILENAME_LEN];
+  FILE *file;
+  int i;
+
+  sprintf(filename, "%s/%s",
+         getUserLevelDir(getLoginName()), LEVELINFO_FILENAME);
+
+  if (!(file = fopen(filename, "w")))
+  {
+    Error(ERR_WARN, "cannot write level info file '%s'", filename);
+    return;
+  }
+
+  ldi.name = getLoginName();
+  ldi.levels = 100;
+  ldi.sort_priority = 300;
+  ldi.readonly = FALSE;
+
+  fprintf(file, "%s\n\n",
+         getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER, LEVELINFO_COOKIE));
+
+  for (i=FIRST_LEVELINFO_TOKEN; i<=LAST_LEVELINFO_TOKEN; i++)
+    fprintf(file, "%s\n", getSetupLine("", i));
+
+  fclose(file);
+
+  chmod(filename, SETUP_PERMS);
+}
+
 void LoadSetup()
 {
   char filename[MAX_FILENAME_LEN];
@@ -1059,6 +1227,18 @@ void LoadSetup()
     setup.direct_draw = !setup.double_buffering;
 
     freeSetupFileList(setup_file_list);
+
+    /* needed to work around problems with fixed length strings */
+    if (strlen(setup.player_name) >= MAX_NAMELEN)
+      setup.player_name[MAX_NAMELEN - 1] = '\0';
+    else if (strlen(setup.player_name) < MAX_NAMELEN - 1)
+    {
+      char *new_name = checked_malloc(MAX_NAMELEN);
+
+      strcpy(new_name, setup.player_name);
+      free(setup.player_name);
+      setup.player_name = new_name;
+    }
   }
   else
     Error(ERR_WARN, "using default setup values");
@@ -1117,7 +1297,7 @@ static char *getSetupLine(char *prefix, int token_nr)
       break;
 
     case TYPE_STRING:
-      strcat(entry, (char *)setup_value);
+      strcat(entry, *(char **)setup_value);
       break;
 
     default:
@@ -1133,10 +1313,10 @@ void SaveSetup()
   char filename[MAX_FILENAME_LEN];
   FILE *file;
 
-  sprintf(filename, "%s/%s", getSetupDir(), SETUP_FILENAME);
-
   InitUserDataDirectory();
 
+  sprintf(filename, "%s/%s", getSetupDir(), SETUP_FILENAME);
+
   if (!(file = fopen(filename, "w")))
   {
     Error(ERR_WARN, "cannot write setup file '%s'", filename);
@@ -1151,11 +1331,11 @@ void SaveSetup()
   si = setup;
   for (i=FIRST_GLOBAL_SETUP_TOKEN; i<=LAST_GLOBAL_SETUP_TOKEN; i++)
   {
+    fprintf(file, "%s\n", getSetupLine("", i));
+
     /* just to make things nicer :) */
-    if (i == SETUP_TOKEN_ALIAS_NAME)
+    if (i == SETUP_TOKEN_PLAYER_NAME)
       fprintf(file, "\n");
-
-    fprintf(file, "%s\n", getSetupLine("", i));
   }
 
   /* handle player specific setup values */
@@ -1203,7 +1383,11 @@ void LoadLevelSetup()
     checkSetupFileListIdentifier(level_setup_list, LEVELSETUP_COOKIE);
   }
   else
+  {
+    level_setup_list = newSetupFileList(TOKEN_STR_FILE_IDENTIFIER,
+                                       LEVELSETUP_COOKIE);
     Error(ERR_WARN, "using default setup values");
+  }
 }
 
 void SaveLevelSetup()
@@ -1212,6 +1396,8 @@ void SaveLevelSetup()
   struct SetupFileList *list_entry = level_setup_list;
   FILE *file;
 
+  InitUserDataDirectory();
+
   setTokenValue(level_setup_list,
                TOKEN_STR_LAST_LEVEL_SERIES, leveldir[leveldir_nr].filename);
 
@@ -1220,17 +1406,14 @@ void SaveLevelSetup()
 
   sprintf(filename, "%s/%s", getSetupDir(), LEVELSETUP_FILENAME);
 
-  InitUserDataDirectory();
-
   if (!(file = fopen(filename, "w")))
   {
     Error(ERR_WARN, "cannot write setup file '%s'", filename);
     return;
   }
 
-  fprintf(file, "%s:              %s\n\n",
-         TOKEN_STR_FILE_IDENTIFIER, LEVELSETUP_COOKIE);
-
+  fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
+                                                LEVELSETUP_COOKIE));
   while (list_entry)
   {
     if (strcmp(list_entry->token, TOKEN_STR_FILE_IDENTIFIER) != 0)