fixed invalidating artwork info cache for non-existing artwork config file
[rocksndiamonds.git] / src / libgame / setup.c
index 44d6b722d4719111998a1d7cd7769ab9043280f2..e1840b1d375e92491492ed31752ecaaf59c07b48 100644 (file)
@@ -96,6 +96,7 @@ static SetupFileHash *artworkinfo_cache_old = NULL;
 static SetupFileHash *artworkinfo_cache_new = NULL;
 static SetupFileHash *optional_tokens_hash = NULL;
 static boolean use_artworkinfo_cache = TRUE;
+static boolean update_artworkinfo_cache = FALSE;
 
 
 // ----------------------------------------------------------------------------
@@ -1163,6 +1164,16 @@ void pushTreeInfo(TreeInfo **node_first, TreeInfo *node_new)
   *node_first = node_new;
 }
 
+void removeTreeInfo(TreeInfo **node_first)
+{
+  TreeInfo *node_old = *node_first;
+
+  *node_first = node_old->next;
+  node_old->next = NULL;
+
+  freeTreeInfo(node_old);
+}
+
 int numTreeInfo(TreeInfo *node)
 {
   int num = 0;
@@ -1249,7 +1260,8 @@ TreeInfo *getTreeInfoFromPos(TreeInfo *node, int pos)
   return node_default;
 }
 
-TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier)
+static TreeInfo *getTreeInfoFromIdentifierExt(TreeInfo *node, char *identifier,
+                                             boolean include_node_groups)
 {
   if (identifier == NULL)
     return NULL;
@@ -1258,10 +1270,12 @@ TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier)
   {
     if (node->node_group)
     {
-      TreeInfo *node_group;
-
-      node_group = getTreeInfoFromIdentifier(node->node_group, identifier);
+      if (include_node_groups && strEqual(identifier, node->identifier))
+       return node;
 
+      TreeInfo *node_group = getTreeInfoFromIdentifierExt(node->node_group,
+                                                         identifier,
+                                                         include_node_groups);
       if (node_group)
        return node_group;
     }
@@ -1277,6 +1291,11 @@ TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier)
   return NULL;
 }
 
+TreeInfo *getTreeInfoFromIdentifier(TreeInfo *node, char *identifier)
+{
+  return getTreeInfoFromIdentifierExt(node, identifier, FALSE);
+}
+
 static TreeInfo *cloneTreeNode(TreeInfo **node_top, TreeInfo *node_parent,
                               TreeInfo *node, boolean skip_sets_without_levels)
 {
@@ -1380,16 +1399,23 @@ static boolean adjustTreeSoundsForEMC(TreeInfo *node)
 
 void dumpTreeInfo(TreeInfo *node, int depth)
 {
+  char bullet_list[] = { '-', '*', 'o' };
   int i;
 
-  Debug("tree", "Dumping TreeInfo:");
+  if (depth == 0)
+    Debug("tree", "Dumping TreeInfo:");
 
   while (node)
   {
-    for (i = 0; i < (depth + 1) * 3; i++)
+    char bullet = bullet_list[depth % ARRAY_SIZE(bullet_list)];
+
+    for (i = 0; i < depth * 2; i++)
       DebugContinued("", " ");
 
-    DebugContinued("tree", "'%s' / '%s'\n", node->identifier, node->name);
+    DebugContinued("tree", "%c '%s' ['%s] [PARENT: '%s'] %s\n",
+                  bullet, node->name, node->identifier,
+                  (node->node_parent ? node->node_parent->identifier : "-"),
+                  (node->node_group ? "[GROUP]" : ""));
 
     /*
     // use for dumping artwork info tree
@@ -2857,7 +2883,7 @@ static TreeInfo *createParentTreeInfoNode(TreeInfo *node_parent)
   ti_new->parent_link = TRUE;
 
   setString(&ti_new->identifier, node_parent->identifier);
-  setString(&ti_new->name, ".. (parent directory)");
+  setString(&ti_new->name, BACKLINK_TEXT_PARENT);
   setString(&ti_new->name_sorting, ti_new->name);
 
   setString(&ti_new->subdir, STRING_PARENT_DIRECTORY);
@@ -2875,19 +2901,19 @@ static TreeInfo *createParentTreeInfoNode(TreeInfo *node_parent)
 
 static TreeInfo *createTopTreeInfoNode(TreeInfo *node_first)
 {
-  TreeInfo *ti_new, *ti_new2;
-
   if (node_first == NULL)
     return NULL;
 
-  ti_new = newTreeInfo();
-  setTreeInfoToDefaults(ti_new, TREE_TYPE_LEVEL_DIR);
+  TreeInfo *ti_new = newTreeInfo();
+  int type = node_first->type;
+
+  setTreeInfoToDefaults(ti_new, type);
 
   ti_new->node_parent = NULL;
   ti_new->parent_link = FALSE;
 
   setString(&ti_new->identifier, node_first->identifier);
-  setString(&ti_new->name, "level sets");
+  setString(&ti_new->name, TREE_INFOTEXT(type));
   setString(&ti_new->name_sorting, ti_new->name);
 
   setString(&ti_new->subdir, STRING_TOP_DIRECTORY);
@@ -2896,19 +2922,32 @@ static TreeInfo *createTopTreeInfoNode(TreeInfo *node_first)
   ti_new->sort_priority = node_first->sort_priority;;
   ti_new->latest_engine = node_first->latest_engine;
 
-  setString(&ti_new->class_desc, "level sets");
+  setString(&ti_new->class_desc, TREE_INFOTEXT(type));
 
   ti_new->node_group = node_first;
   ti_new->level_group = TRUE;
 
-  ti_new2 = createParentTreeInfoNode(ti_new);
+  TreeInfo *ti_new2 = createParentTreeInfoNode(ti_new);
 
-  setString(&ti_new2->name, ".. (main menu)");
+  setString(&ti_new2->name, TREE_BACKLINK_TEXT(type));
   setString(&ti_new2->name_sorting, ti_new2->name);
 
   return ti_new;
 }
 
+static void setTreeInfoParentNodes(TreeInfo *node, TreeInfo *node_parent)
+{
+  while (node)
+  {
+    if (node->node_group)
+      setTreeInfoParentNodes(node->node_group, node);
+
+    node->node_parent = node_parent;
+
+    node = node->next;
+  }
+}
+
 
 // ----------------------------------------------------------------------------
 // functions for handling level and custom artwork info cache
@@ -2934,10 +2973,15 @@ static void LoadArtworkInfoCache(void)
 
   if (artworkinfo_cache_new == NULL)
     artworkinfo_cache_new = newSetupFileHash();
+
+  update_artworkinfo_cache = FALSE;
 }
 
 static void SaveArtworkInfoCache(void)
 {
+  if (!update_artworkinfo_cache)
+    return;
+
   char *filename = getPath2(getCacheDir(), ARTWORKINFO_CACHE_FILE);
 
   InitCacheDirectory();
@@ -2982,6 +3026,9 @@ static boolean modifiedFileTimestamp(char *filename, char *timestamp_string)
   if (timestamp_string == NULL)
     return TRUE;
 
+  if (!fileExists(filename))                   // file does not exist
+    return (atoi(timestamp_string) != 0);
+
   if (stat(filename, &file_status) != 0)       // cannot stat file
     return TRUE;
 
@@ -3898,8 +3945,33 @@ void LoadArtworkInfo(void)
 #endif
 }
 
-static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node,
-                                        LevelDirTree *level_node)
+static void MoveArtworkInfoIntoSubTree(ArtworkDirTree **artwork_node)
+{
+  ArtworkDirTree *artwork_new = newTreeInfo();
+  char *top_node_name = "dedicated custom artwork";
+
+  setTreeInfoToDefaults(artwork_new, (*artwork_node)->type);
+
+  artwork_new->level_group = TRUE;
+
+  setString(&artwork_new->identifier,   top_node_name);
+  setString(&artwork_new->name,         top_node_name);
+  setString(&artwork_new->name_sorting, top_node_name);
+
+  // create node to link back to current custom artwork directory
+  createParentTreeInfoNode(artwork_new);
+
+  // move existing custom artwork tree into newly created sub-tree
+  artwork_new->node_group->next = *artwork_node;
+
+  // change custom artwork tree to contain only newly created node
+  *artwork_node = artwork_new;
+}
+
+static void LoadArtworkInfoFromLevelInfoExt(ArtworkDirTree **artwork_node,
+                                           ArtworkDirTree *node_parent,
+                                           LevelDirTree *level_node,
+                                           boolean empty_level_set_mode)
 {
   int type = (*artwork_node)->type;
 
@@ -3907,8 +3979,10 @@ static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node,
 
   while (level_node)
   {
+    boolean empty_level_set = (level_node->levels == 0);
+
     // check all tree entries for artwork, but skip parent link entries
-    if (!level_node->parent_link)
+    if (!level_node->parent_link && empty_level_set == empty_level_set_mode)
     {
       TreeInfo *artwork_new = getArtworkInfoCacheEntry(level_node, type);
       boolean cached = (artwork_new != NULL);
@@ -3935,6 +4009,8 @@ static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node,
 
          artwork_new->sort_priority = level_node->sort_priority;
          artwork_new->color = LEVELCOLOR(artwork_new);
+
+         update_artworkinfo_cache = TRUE;
        }
 
        free(path);
@@ -3948,12 +4024,68 @@ static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node,
     DrawInitText(level_node->name, 150, FC_YELLOW);
 
     if (level_node->node_group != NULL)
-      LoadArtworkInfoFromLevelInfo(artwork_node, level_node->node_group);
+    {
+      TreeInfo *artwork_new = newTreeInfo();
+
+      if (node_parent)
+       setTreeInfoToDefaultsFromParent(artwork_new, node_parent);
+      else
+       setTreeInfoToDefaults(artwork_new, type);
+
+      artwork_new->level_group = TRUE;
+
+      setString(&artwork_new->identifier,   level_node->subdir);
+
+      if (node_parent == NULL)         // check for top tree node
+      {
+       char *top_node_name = (empty_level_set_mode ?
+                              "artwork-only level sets" :
+                              "artwork from level sets");
+
+       setString(&artwork_new->name,         top_node_name);
+       setString(&artwork_new->name_sorting, top_node_name);
+      }
+      else
+      {
+       setString(&artwork_new->name,         level_node->name);
+       setString(&artwork_new->name_sorting, level_node->name_sorting);
+      }
+
+      pushTreeInfo(artwork_node, artwork_new);
+
+      // create node to link back to current custom artwork directory
+      createParentTreeInfoNode(artwork_new);
+
+      // recursively step into sub-directory and look for more custom artwork
+      LoadArtworkInfoFromLevelInfoExt(&artwork_new->node_group, artwork_new,
+                                     level_node->node_group,
+                                     empty_level_set_mode);
+
+      // if sub-tree has no custom artwork at all, remove it
+      if (artwork_new->node_group->next == NULL)
+       removeTreeInfo(artwork_node);
+    }
 
     level_node = level_node->next;
   }
 }
 
+static void LoadArtworkInfoFromLevelInfo(ArtworkDirTree **artwork_node)
+{
+  // move peviously loaded artwork tree into separate sub-tree
+  MoveArtworkInfoIntoSubTree(artwork_node);
+
+  // load artwork from level sets into separate sub-trees
+  LoadArtworkInfoFromLevelInfoExt(artwork_node, NULL, leveldir_first_all, TRUE);
+  LoadArtworkInfoFromLevelInfoExt(artwork_node, NULL, leveldir_first_all, FALSE);
+
+  // add top tree node over all three separate sub-trees
+  *artwork_node = createTopTreeInfoNode(*artwork_node);
+
+  // set all parent links (back links) in complete artwork tree
+  setTreeInfoParentNodes(*artwork_node, NULL);
+}
+
 void LoadLevelArtworkInfo(void)
 {
   print_timestamp_init("LoadLevelArtworkInfo");
@@ -3962,11 +4094,11 @@ void LoadLevelArtworkInfo(void)
 
   print_timestamp_time("DrawTimeText");
 
-  LoadArtworkInfoFromLevelInfo(&artwork.gfx_first, leveldir_first_all);
+  LoadArtworkInfoFromLevelInfo(&artwork.gfx_first);
   print_timestamp_time("LoadArtworkInfoFromLevelInfo (gfx)");
-  LoadArtworkInfoFromLevelInfo(&artwork.snd_first, leveldir_first_all);
+  LoadArtworkInfoFromLevelInfo(&artwork.snd_first);
   print_timestamp_time("LoadArtworkInfoFromLevelInfo (snd)");
-  LoadArtworkInfoFromLevelInfo(&artwork.mus_first, leveldir_first_all);
+  LoadArtworkInfoFromLevelInfo(&artwork.mus_first);
   print_timestamp_time("LoadArtworkInfoFromLevelInfo (mus)");
 
   SaveArtworkInfoCache();
@@ -4392,6 +4524,99 @@ char *getSetupLine(struct TokenInfo *token_info, char *prefix, int token_nr)
   return line;
 }
 
+static void InitLastPlayedLevels_ParentNode(void)
+{
+  LevelDirTree **leveldir_top = &leveldir_first->node_group->next;
+  LevelDirTree *leveldir_new = NULL;
+
+  // check if parent node for last played levels already exists
+  if (strEqual((*leveldir_top)->identifier, TOKEN_STR_LAST_LEVEL_SERIES))
+    return;
+
+  leveldir_new = newTreeInfo();
+
+  setTreeInfoToDefaultsFromParent(leveldir_new, leveldir_first);
+
+  leveldir_new->level_group = TRUE;
+
+  setString(&leveldir_new->identifier, TOKEN_STR_LAST_LEVEL_SERIES);
+  setString(&leveldir_new->name, "<< (last played level sets)");
+
+  pushTreeInfo(leveldir_top, leveldir_new);
+
+  // create node to link back to current level directory
+  createParentTreeInfoNode(leveldir_new);
+}
+
+void UpdateLastPlayedLevels_TreeInfo(void)
+{
+  char **last_level_series = setup.level_setup.last_level_series;
+  boolean reset_leveldir_current = FALSE;
+  LevelDirTree *leveldir_last;
+  TreeInfo **node_new = NULL;
+  int i;
+
+  if (last_level_series[0] == NULL)
+    return;
+
+  InitLastPlayedLevels_ParentNode();
+
+  // check if current level set is from "last played" sub-tree to be rebuilt
+  reset_leveldir_current = strEqual(leveldir_current->node_parent->identifier,
+                                   TOKEN_STR_LAST_LEVEL_SERIES);
+
+  leveldir_last = getTreeInfoFromIdentifierExt(leveldir_first,
+                                              TOKEN_STR_LAST_LEVEL_SERIES,
+                                              TRUE);
+  if (leveldir_last == NULL)
+    return;
+
+  node_new = &leveldir_last->node_group->next;
+
+  freeTreeInfo(*node_new);
+
+  for (i = 0; last_level_series[i] != NULL; i++)
+  {
+    LevelDirTree *node_last = getTreeInfoFromIdentifier(leveldir_first,
+                                                       last_level_series[i]);
+
+    *node_new = getTreeInfoCopy(node_last);    // copy complete node
+
+    (*node_new)->node_top = &leveldir_first;   // correct top node link
+    (*node_new)->node_parent = leveldir_last;  // correct parent node link
+
+    (*node_new)->node_group = NULL;
+    (*node_new)->next = NULL;
+
+    (*node_new)->cl_first = -1;                        // force setting tree cursor
+
+    node_new = &((*node_new)->next);
+  }
+
+  if (reset_leveldir_current)
+    leveldir_current = getTreeInfoFromIdentifier(leveldir_first,
+                                                 last_level_series[0]);
+}
+
+static void UpdateLastPlayedLevels_List(void)
+{
+  char **last_level_series = setup.level_setup.last_level_series;
+  int pos = MAX_LEVELDIR_HISTORY - 1;
+  int i;
+
+  // search for potentially already existing entry in list of level sets
+  for (i = 0; last_level_series[i] != NULL; i++)
+    if (strEqual(last_level_series[i], leveldir_current->identifier))
+      pos = i;
+
+  // move list of level sets one entry down (using potentially free entry)
+  for (i = pos; i > 0; i--)
+    setString(&last_level_series[i], last_level_series[i - 1]);
+
+  // put last played level set at top position
+  setString(&last_level_series[0], leveldir_current->identifier);
+}
+
 void LoadLevelSetup_LastSeries(void)
 {
   // --------------------------------------------------------------------------
@@ -4400,10 +4625,15 @@ void LoadLevelSetup_LastSeries(void)
 
   char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
   SetupFileHash *level_setup_hash = NULL;
+  int pos = 0;
+  int i;
 
   // always start with reliable default values
   leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
 
+  // start with empty history of last played level sets
+  setString(&setup.level_setup.last_level_series[0], NULL);
+
   if (!strEqual(DEFAULT_LEVELSET, UNDEFINED_LEVELSET))
   {
     leveldir_current = getTreeInfoFromIdentifier(leveldir_first,
@@ -4422,6 +4652,24 @@ void LoadLevelSetup_LastSeries(void)
     if (leveldir_current == NULL)
       leveldir_current = getFirstValidTreeInfoEntry(leveldir_first);
 
+    for (i = 0; i < MAX_LEVELDIR_HISTORY; i++)
+    {
+      char token[strlen(TOKEN_STR_LAST_LEVEL_SERIES) + 10];
+      LevelDirTree *leveldir_last;
+
+      sprintf(token, "%s.%03d", TOKEN_STR_LAST_LEVEL_SERIES, i);
+
+      last_level_series = getHashEntry(level_setup_hash, token);
+
+      leveldir_last = getTreeInfoFromIdentifier(leveldir_first,
+                                               last_level_series);
+      if (leveldir_last != NULL)
+       setString(&setup.level_setup.last_level_series[pos++],
+                 last_level_series);
+    }
+
+    setString(&setup.level_setup.last_level_series[pos], NULL);
+
     freeSetupFileHash(level_setup_hash);
   }
   else
@@ -4442,12 +4690,15 @@ static void SaveLevelSetup_LastSeries_Ext(boolean deactivate_last_level_series)
   if (leveldir_current == NULL)
     return;
 
+  char **last_level_series = setup.level_setup.last_level_series;
   char *filename = getPath2(getSetupDir(), LEVELSETUP_FILENAME);
-  char *level_subdir = leveldir_current->subdir;
   FILE *file;
+  int i;
 
   InitUserDataDirectory();
 
+  UpdateLastPlayedLevels_List();
+
   if (!(file = fopen(filename, MODE_WRITE)))
   {
     Warn("cannot write setup file '%s'", filename);
@@ -4462,8 +4713,17 @@ static void SaveLevelSetup_LastSeries_Ext(boolean deactivate_last_level_series)
   if (deactivate_last_level_series)
     fprintf(file, "# %s\n# ", "the following level set may have caused a problem and was deactivated");
 
-  fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_LAST_LEVEL_SERIES,
-                                              level_subdir));
+  fprintf(file, "%s\n\n", getFormattedSetupEntry(TOKEN_STR_LAST_LEVEL_SERIES,
+                                              leveldir_current->identifier));
+
+  for (i = 0; last_level_series[i] != NULL; i++)
+  {
+    char token[strlen(TOKEN_STR_LAST_LEVEL_SERIES) + 10];
+
+    sprintf(token, "%s.%03d", TOKEN_STR_LAST_LEVEL_SERIES, i);
+
+    fprintf(file, "%s\n", getFormattedSetupEntry(token, last_level_series[i]));
+  }
 
   fclose(file);